Mercurial > molko
annotate src/core/action.h @ 69:5da49274e5fb
core: add new action.end callback for user
author | David Demelier <markand@malikania.fr> |
---|---|
date | Mon, 27 Jan 2020 13:31:24 +0100 |
parents | 52792b863ff7 |
children | 53b217afe122 |
rev | line source |
---|---|
57
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
1 /* |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
2 * action.h -- action states |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
3 * |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
4 * Copyright (c) 2020 David Demelier <markand@malikania.fr> |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
5 * |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
6 * Permission to use, copy, modify, and/or distribute this software for any |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
7 * purpose with or without fee is hereby granted, provided that the above |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
8 * copyright notice and this permission notice appear in all copies. |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
9 * |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
17 */ |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
18 |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
19 #ifndef ACTION_H |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
20 #define ACTION_H |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
21 |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
22 /** |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
23 * \file action.h |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
24 * \brief Action states. |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
25 */ |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
26 |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
27 #include <stdbool.h> |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
28 |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
29 union event; |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
30 |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
31 /** |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
32 * \brief Action flags. |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
33 */ |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
34 enum action_flags { |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
35 ACTION_NONE, /*!< No flags */ |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
36 ACTION_AUTO_LEAVE = (1 << 0) /*!< Action is removed on state change */ |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
37 }; |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
38 |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
39 /** |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
40 * \brief Action structure. |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
41 */ |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
42 struct action { |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
43 /** |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
44 * (RW) |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
45 * |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
46 * Optional flags. |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
47 */ |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
48 enum action_flags flags; |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
49 |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
50 /** |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
51 * (RW) |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
52 * |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
53 * Arbitrary user data. |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
54 */ |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
55 void *data; |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
56 |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
57 /** |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
58 * (RW) |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
59 * |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
60 * Handle event. |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
61 */ |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
62 void (*handle)(struct action *, const union event *event); |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
63 |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
64 /** |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
65 * (RW) |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
66 * |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
67 * Update the action. |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
68 * |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
69 * If returns true, the action is removed. |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
70 */ |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
71 bool (*update)(struct action *, unsigned int); |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
72 |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
73 /** |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
74 * (RW) |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
75 * |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
76 * Draw the aciton. |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
77 */ |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
78 void (*draw)(struct action *); |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
79 |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
80 /** |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
81 * (RW) |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
82 * |
69
5da49274e5fb
core: add new action.end callback for user
David Demelier <markand@malikania.fr>
parents:
59
diff
changeset
|
83 * Called when the action was completed. |
5da49274e5fb
core: add new action.end callback for user
David Demelier <markand@malikania.fr>
parents:
59
diff
changeset
|
84 * |
5da49274e5fb
core: add new action.end callback for user
David Demelier <markand@malikania.fr>
parents:
59
diff
changeset
|
85 * This callback is mostly provided to allow the user doing something |
5da49274e5fb
core: add new action.end callback for user
David Demelier <markand@malikania.fr>
parents:
59
diff
changeset
|
86 * else once an action is complete. Predefined actions should not use |
5da49274e5fb
core: add new action.end callback for user
David Demelier <markand@malikania.fr>
parents:
59
diff
changeset
|
87 * this callback by themselves. |
5da49274e5fb
core: add new action.end callback for user
David Demelier <markand@malikania.fr>
parents:
59
diff
changeset
|
88 */ |
5da49274e5fb
core: add new action.end callback for user
David Demelier <markand@malikania.fr>
parents:
59
diff
changeset
|
89 void (*end)(struct action *a); |
5da49274e5fb
core: add new action.end callback for user
David Demelier <markand@malikania.fr>
parents:
59
diff
changeset
|
90 |
5da49274e5fb
core: add new action.end callback for user
David Demelier <markand@malikania.fr>
parents:
59
diff
changeset
|
91 /** |
5da49274e5fb
core: add new action.end callback for user
David Demelier <markand@malikania.fr>
parents:
59
diff
changeset
|
92 * (RW) |
5da49274e5fb
core: add new action.end callback for user
David Demelier <markand@malikania.fr>
parents:
59
diff
changeset
|
93 * |
57
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
94 * Close the action before removal. |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
95 */ |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
96 void (*finish)(struct action *); |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
97 }; |
9f6267843815
core: implement basic actions, closes #2463 @1h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
98 |
69
5da49274e5fb
core: add new action.end callback for user
David Demelier <markand@malikania.fr>
parents:
59
diff
changeset
|
99 #endif /* !ACTION_H */ |