Mercurial > molko

annotate libmlk-core/mlk/core/action-stack.h @ 623:20b818193ce0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
ui: remove useless stuff
author David Demelier <markand@malikania.fr>
date Wed, 23 Aug 2023 20:01:00 +0200
parents 75944708c55c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * action-stack.h -- convenient stack of actions
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
445
773a082f0b91 misc: update copyright years
David Demelier <markand@malikania.fr>
parents: 442
diff changeset
4 * Copyright (c) 2020-2023 David Demelier <markand@malikania.fr>
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #ifndef MLK_CORE_ACTION_STACK_H
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define MLK_CORE_ACTION_STACK_H
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
22 /**
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
23 * \file mlk/core/action-stack.h
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
24 * \brief Convenient stack of actions.
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
25 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
26 * Stack of actions.
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
27 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
28 * The purpose of this module is to help managing several actions at once.
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
29 * Actions are automatically removed from the stack if the corresponding update
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
30 * member function returns non-zero after completion.
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
31 */
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
32
392
e6d7ebad33cc core: don't use fixed arrays in action_stack
David Demelier <markand@malikania.fr>
parents: 378
diff changeset
33 #include <stddef.h>
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
34
441
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents: 431
diff changeset
35 struct mlk_action;
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents: 431
diff changeset
36
450
b26dd49f69ff core: event -> mlk_event (and friends)
David Demelier <markand@malikania.fr>
parents: 445
diff changeset
37 union mlk_event;
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
38
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
39 /**
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
40 * \struct mlk_action_stack
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
41 * \brief Action stack structure
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
42 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
43 * This structure holds references to actions to be executed.
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
44 */
442
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents: 441
diff changeset
45 struct mlk_action_stack {
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
46 /**
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
47 * (read-write, borrowed)
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
48 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
49 * Array of non-owning actions to run.
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
50 */
441
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents: 431
diff changeset
51 struct mlk_action **actions;
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
52
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
53 /**
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
54 * (read-write)
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
55 *
518
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
56 * Number of actions in array ::mlk_action_stack::actions
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
57 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
58 * \warning changing this value must be kept in sync with the array
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
59 * dimension.
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
60 */
392
e6d7ebad33cc core: don't use fixed arrays in action_stack
David Demelier <markand@malikania.fr>
parents: 378
diff changeset
61 size_t actionsz;
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
62 };
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
63
517
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 509
diff changeset
64 #if defined(__cplusplus)
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 509
diff changeset
65 extern "C" {
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 509
diff changeset
66 #endif
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
67
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
68 /**
518
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
69 * Initialize the action stack structure.
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
70 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
71 * This function will set all pointers in the ::mlk_action_stack::actions to
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
72 * NULL.
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
73 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
74 * \pre stack != NULL
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
75 * \param stack the action stack
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
76 */
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
77 void
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
78 mlk_action_stack_init(struct mlk_action_stack *stack);
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
79
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
80 /**
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
81 * Try to append a new action into the stack if one slot in the
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
82 * ::mlk_action_stack::actions is NULL
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
83 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
84 * The action is inserted as-is and ownership is left to the caller.
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
85 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
86 * \pre stack != NULL
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
87 * \param stack the action stack
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
88 * \param action the action to append
548
75944708c55c core: doxygenize panic
David Demelier <markand@malikania.fr>
parents: 518
diff changeset
89 * \return 0 on success or -1 on error
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
90 */
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
91 int
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
92 mlk_action_stack_add(struct mlk_action_stack *stack,
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
93 struct mlk_action *action);
480
c1f64d451230 core: mlk_action has a start callback
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
94
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
95 /**
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
96 * Tells if there are still at least one action in the stack.
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
97 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
98 * \pre stack != NULL
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
99 * \param stack the action stack
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
100 * \return non-zero if completed
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
101 */
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
102 int
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
103 mlk_action_stack_completed(const struct mlk_action_stack *stack);
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
104
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
105
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
106 /**
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
107 * Invoke ::mlk_action_start on all actions.
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
108 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
109 * \pre stack != NULL
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
110 * \param stack the action stack
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
111 */
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
112 void
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
113 mlk_action_stack_start(struct mlk_action_stack *stack);
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
114
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
115 /**
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
116 * Invoke ::mlk_action_handle on all actions.
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
117 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
118 * \pre stack != NULL
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
119 * \param stack the action stack
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
120 * \param event the event
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
121 */
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
122 void
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
123 mlk_action_stack_handle(struct mlk_action_stack *stack,
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
124 const union mlk_event *event);
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
125
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
126 /**
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
127 * Invoke ::mlk_action_update on all actions.
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
128 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
129 * \pre stack != NULL
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
130 * \param stack the action stack
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
131 * \param ticks frame ticks
518
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
132 * \return non-zero if completed
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
133 */
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
134 int
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
135 mlk_action_stack_update(struct mlk_action_stack *stack,
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
136 unsigned int ticks);
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
137
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
138 /**
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
139 * Invoke ::mlk_action_draw on all actions.
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
140 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
141 * \pre stack != NULL
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
142 * \param stack the action stack
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
143 */
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
144 void
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
145 mlk_action_stack_draw(const struct mlk_action_stack *stack);
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
146
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
147 /**
518
47f0fe6f6581 core: doxygenize drawable-stack
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
148 * Invoke ::mlk_action_finish on all actions left.
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
149 *
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
150 * \pre stack != NULL
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
151 * \param stack the action stack
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
152 */
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
153 void
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
154 mlk_action_stack_finish(struct mlk_action_stack *stack);
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
155
517
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 509
diff changeset
156 #if defined(__cplusplus)
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 509
diff changeset
157 }
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 509
diff changeset
158 #endif
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
159
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
160 #endif /* !MLK_CORE_ACTION_STACK_H */