annotate libmlk-core/mlk/core/action-stack.c @ 445:773a082f0b91

misc: update copyright years
author David Demelier <markand@malikania.fr>
date Wed, 01 Feb 2023 13:08:54 +0100
parents 9c3b3935f0aa
children b26dd49f69ff
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 #include <assert.h>
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #include <string.h>
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
422
b0579ae033ed core: use err.h in (action|drawable)-stack
David Demelier <markand@malikania.fr>
parents: 392
diff changeset
22 #include "action-stack.h"
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 #include "action.h"
422
b0579ae033ed core: use err.h in (action|drawable)-stack
David Demelier <markand@malikania.fr>
parents: 392
diff changeset
24 #include "err.h"
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
25
442
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents: 441
diff changeset
26 #define FOREACH(st, iter) \
392
e6d7ebad33cc core: don't use fixed arrays in action_stack
David Demelier <markand@malikania.fr>
parents: 378
diff changeset
27 for (size_t i = 0; i < (st)->actionsz && ((iter) = (st)->actions[i], 1); ++i)
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
28
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 void
442
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents: 441
diff changeset
30 mlk_action_stack_init(struct mlk_action_stack *st, struct mlk_action **actions, size_t actionsz)
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 {
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 assert(st);
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
33
392
e6d7ebad33cc core: don't use fixed arrays in action_stack
David Demelier <markand@malikania.fr>
parents: 378
diff changeset
34 st->actions = actions;
e6d7ebad33cc core: don't use fixed arrays in action_stack
David Demelier <markand@malikania.fr>
parents: 378
diff changeset
35 st->actionsz = actionsz;
e6d7ebad33cc core: don't use fixed arrays in action_stack
David Demelier <markand@malikania.fr>
parents: 378
diff changeset
36
e6d7ebad33cc core: don't use fixed arrays in action_stack
David Demelier <markand@malikania.fr>
parents: 378
diff changeset
37 for (size_t i = 0; i < st->actionsz; ++i)
e6d7ebad33cc core: don't use fixed arrays in action_stack
David Demelier <markand@malikania.fr>
parents: 378
diff changeset
38 st->actions[i] = NULL;
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 }
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
40
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 int
442
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents: 441
diff changeset
42 mlk_action_stack_add(struct mlk_action_stack *st, struct mlk_action *act)
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 {
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 assert(st);
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 assert(act);
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
46
392
e6d7ebad33cc core: don't use fixed arrays in action_stack
David Demelier <markand@malikania.fr>
parents: 378
diff changeset
47 for (size_t i = 0; i < st->actionsz; ++i) {
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 if (!st->actions[i]) {
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 st->actions[i] = act;
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 return 0;
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 }
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 }
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
53
437
e1eebc6bf25d man: initial import
David Demelier <markand@malikania.fr>
parents: 431
diff changeset
54 return MLK_ERR_NO_MEM;
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 }
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
56
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 void
442
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents: 441
diff changeset
58 mlk_action_stack_handle(struct mlk_action_stack *st, const union event *ev)
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 {
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 assert(st);
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
61 assert(ev);
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
62
441
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents: 437
diff changeset
63 struct mlk_action *act;
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
64
442
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents: 441
diff changeset
65 FOREACH(st, act)
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
66 if (act)
441
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents: 437
diff changeset
67 mlk_action_handle(act, ev);
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
68 }
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
69
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
70 int
442
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents: 441
diff changeset
71 mlk_action_stack_update(struct mlk_action_stack *st, unsigned int ticks)
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
72 {
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
73 assert(st);
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
74
441
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents: 437
diff changeset
75 struct mlk_action *act;
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
76
392
e6d7ebad33cc core: don't use fixed arrays in action_stack
David Demelier <markand@malikania.fr>
parents: 378
diff changeset
77 for (size_t i = 0; i < st->actionsz; ++i) {
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
78 act = st->actions[i];
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
79
441
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents: 437
diff changeset
80 if (act && mlk_action_update(act, ticks)) {
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents: 437
diff changeset
81 mlk_action_end(act);
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents: 437
diff changeset
82 mlk_action_finish(act);
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
83 st->actions[i] = NULL;
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
84 }
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
85 }
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
86
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
87 /*
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
88 * We process all actions again in case the user modified the stack
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
89 * within their update function.
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
90 */
442
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents: 441
diff changeset
91 return mlk_action_stack_completed(st);
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
92 }
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
93
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
94 void
442
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents: 441
diff changeset
95 mlk_action_stack_draw(const struct mlk_action_stack *st)
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
96 {
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
97 assert(st);
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
98
441
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents: 437
diff changeset
99 struct mlk_action *act;
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
100
442
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents: 441
diff changeset
101 FOREACH(st, act)
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
102 if (act)
441
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents: 437
diff changeset
103 mlk_action_draw(act);
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
104 }
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
105
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
106 int
442
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents: 441
diff changeset
107 mlk_action_stack_completed(const struct mlk_action_stack *st)
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
108 {
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
109 assert(st);
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
110
441
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents: 437
diff changeset
111 struct mlk_action *act;
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
112
442
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents: 441
diff changeset
113 FOREACH(st, act)
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
114 if (act)
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
115 return 0;
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
116
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
117 return 1;
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
118 }
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
119
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
120 void
442
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents: 441
diff changeset
121 mlk_action_stack_finish(struct mlk_action_stack *st)
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
122 {
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
123 assert(st);
422
b0579ae033ed core: use err.h in (action|drawable)-stack
David Demelier <markand@malikania.fr>
parents: 392
diff changeset
124
441
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents: 437
diff changeset
125 struct mlk_action *act;
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
126
442
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents: 441
diff changeset
127 FOREACH(st, act) {
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
128 if (act) {
441
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents: 437
diff changeset
129 mlk_action_end(act);
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents: 437
diff changeset
130 mlk_action_finish(act);
369
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
131 }
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
132 }
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
133
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
134 memset(st, 0, sizeof (*st));
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
135 }