annotate libmlk-core/mlk/core/action-script.c @ 646:7e1eb7f6c049 default tip @

misc: remove .clang
author David Demelier <markand@malikania.fr>
date Sun, 04 Feb 2024 15:24:37 +0100
parents 4349b591c3ac
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
65
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 499
diff changeset
2 * action-script.c -- convenient sequence of actions
65
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
445
773a082f0b91 misc: update copyright years
David Demelier <markand@malikania.fr>
parents: 441
diff changeset
4 * Copyright (c) 2020-2023 David Demelier <markand@malikania.fr>
65
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #include <assert.h>
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #include <stdlib.h>
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 #include <string.h>
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
22
466
39dd7c66ebfd core: script -> mlk_action_script
David Demelier <markand@malikania.fr>
parents: 450
diff changeset
23 #include "action-script.h"
586
4349b591c3ac cmake: put NLS back
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
24 #include "core_p.h"
136
30b68089ae70 core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
25 #include "action.h"
425
bf20b77968fd core: use err.h in script
David Demelier <markand@malikania.fr>
parents: 378
diff changeset
26 #include "err.h"
65
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
27
466
39dd7c66ebfd core: script -> mlk_action_script
David Demelier <markand@malikania.fr>
parents: 450
diff changeset
28 static inline struct mlk_action *
39dd7c66ebfd core: script -> mlk_action_script
David Demelier <markand@malikania.fr>
parents: 450
diff changeset
29 current(struct mlk_action_script *s)
65
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 {
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 499
diff changeset
31 if (s->current >= s->length)
136
30b68089ae70 core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
32 return NULL;
65
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
33
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 499
diff changeset
34 return s->actions[s->current];
65
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 }
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
36
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 void
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 499
diff changeset
38 mlk_action_script_init(struct mlk_action_script *s)
65
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 {
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 assert(s);
484
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
41
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 499
diff changeset
42 for (size_t i = 0; i < s->actionsz; ++i)
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 499
diff changeset
43 s->actions[i] = NULL;
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 499
diff changeset
44 }
484
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents: 480
diff changeset
45
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 499
diff changeset
46 int
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 499
diff changeset
47 mlk_action_script_append(struct mlk_action_script *s, struct mlk_action *a)
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 499
diff changeset
48 {
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 499
diff changeset
49 assert(s);
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 499
diff changeset
50 assert(a);
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 499
diff changeset
51
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 499
diff changeset
52 if (s->length >= s->actionsz)
586
4349b591c3ac cmake: put NLS back
David Demelier <markand@malikania.fr>
parents: 547
diff changeset
53 return mlk_errf(_("no space in action script"));
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 499
diff changeset
54
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 499
diff changeset
55 s->actions[s->length++] = a;
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 499
diff changeset
56
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 499
diff changeset
57 return 0;
65
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 }
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
59
480
c1f64d451230 core: mlk_action has a start callback
David Demelier <markand@malikania.fr>
parents: 476
diff changeset
60 void
c1f64d451230 core: mlk_action has a start callback
David Demelier <markand@malikania.fr>
parents: 476
diff changeset
61 mlk_action_script_start(struct mlk_action_script *s)
c1f64d451230 core: mlk_action has a start callback
David Demelier <markand@malikania.fr>
parents: 476
diff changeset
62 {
c1f64d451230 core: mlk_action has a start callback
David Demelier <markand@malikania.fr>
parents: 476
diff changeset
63 assert(s);
c1f64d451230 core: mlk_action has a start callback
David Demelier <markand@malikania.fr>
parents: 476
diff changeset
64
c1f64d451230 core: mlk_action has a start callback
David Demelier <markand@malikania.fr>
parents: 476
diff changeset
65 struct mlk_action *a;
c1f64d451230 core: mlk_action has a start callback
David Demelier <markand@malikania.fr>
parents: 476
diff changeset
66
c1f64d451230 core: mlk_action has a start callback
David Demelier <markand@malikania.fr>
parents: 476
diff changeset
67 if ((a = current(s)))
c1f64d451230 core: mlk_action has a start callback
David Demelier <markand@malikania.fr>
parents: 476
diff changeset
68 mlk_action_start(a);
c1f64d451230 core: mlk_action has a start callback
David Demelier <markand@malikania.fr>
parents: 476
diff changeset
69 }
c1f64d451230 core: mlk_action has a start callback
David Demelier <markand@malikania.fr>
parents: 476
diff changeset
70
65
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
71 void
466
39dd7c66ebfd core: script -> mlk_action_script
David Demelier <markand@malikania.fr>
parents: 450
diff changeset
72 mlk_action_script_handle(struct mlk_action_script *s, const union mlk_event *ev)
65
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
73 {
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
74 assert(s);
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
75 assert(ev);
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
76
476
00b30f899548 core: make sure mlk_action_script is zero'ed on finalization
David Demelier <markand@malikania.fr>
parents: 466
diff changeset
77 struct mlk_action *a;
425
bf20b77968fd core: use err.h in script
David Demelier <markand@malikania.fr>
parents: 378
diff changeset
78
476
00b30f899548 core: make sure mlk_action_script is zero'ed on finalization
David Demelier <markand@malikania.fr>
parents: 466
diff changeset
79 if ((a = current(s)))
441
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents: 437
diff changeset
80 mlk_action_handle(a, ev);
65
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
81 }
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
82
298
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
83 int
466
39dd7c66ebfd core: script -> mlk_action_script
David Demelier <markand@malikania.fr>
parents: 450
diff changeset
84 mlk_action_script_update(struct mlk_action_script *s, unsigned int ticks)
65
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
85 {
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
86 assert(s);
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
87
466
39dd7c66ebfd core: script -> mlk_action_script
David Demelier <markand@malikania.fr>
parents: 450
diff changeset
88 struct mlk_action *a;
136
30b68089ae70 core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
89
466
39dd7c66ebfd core: script -> mlk_action_script
David Demelier <markand@malikania.fr>
parents: 450
diff changeset
90 /* No action left means completed. */
39dd7c66ebfd core: script -> mlk_action_script
David Demelier <markand@malikania.fr>
parents: 450
diff changeset
91 if (!(a = current(s)))
298
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
92 return 1;
69
5da49274e5fb core: add new action.end callback for user
David Demelier <markand@malikania.fr>
parents: 65
diff changeset
93
441
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents: 437
diff changeset
94 if (mlk_action_update(a, ticks)) {
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents: 437
diff changeset
95 mlk_action_end(a);
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 499
diff changeset
96 s->current++;
480
c1f64d451230 core: mlk_action has a start callback
David Demelier <markand@malikania.fr>
parents: 476
diff changeset
97
c1f64d451230 core: mlk_action has a start callback
David Demelier <markand@malikania.fr>
parents: 476
diff changeset
98 /* Start this action now. */
c1f64d451230 core: mlk_action has a start callback
David Demelier <markand@malikania.fr>
parents: 476
diff changeset
99 if ((a = current(s)))
c1f64d451230 core: mlk_action has a start callback
David Demelier <markand@malikania.fr>
parents: 476
diff changeset
100 mlk_action_start(a);
65
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
101 }
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
102
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 499
diff changeset
103 return s->current >= s->length;
65
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
104 }
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
105
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
106 void
466
39dd7c66ebfd core: script -> mlk_action_script
David Demelier <markand@malikania.fr>
parents: 450
diff changeset
107 mlk_action_script_draw(struct mlk_action_script *s)
65
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
108 {
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
109 assert(s);
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
110
466
39dd7c66ebfd core: script -> mlk_action_script
David Demelier <markand@malikania.fr>
parents: 450
diff changeset
111 struct mlk_action *a;
136
30b68089ae70 core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
112
466
39dd7c66ebfd core: script -> mlk_action_script
David Demelier <markand@malikania.fr>
parents: 450
diff changeset
113 if ((a = current(s)))
441
31c1bbc33813 man: document mlk-action
David Demelier <markand@malikania.fr>
parents: 437
diff changeset
114 mlk_action_draw(a);
65
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
115 }
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
116
298
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
117 int
466
39dd7c66ebfd core: script -> mlk_action_script
David Demelier <markand@malikania.fr>
parents: 450
diff changeset
118 mlk_action_script_completed(const struct mlk_action_script *s)
65
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
119 {
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
120 assert(s);
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
121
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 499
diff changeset
122 return s->current >= s->length;
136
30b68089ae70 core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
123 }
65
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
124
136
30b68089ae70 core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
125 void
466
39dd7c66ebfd core: script -> mlk_action_script
David Demelier <markand@malikania.fr>
parents: 450
diff changeset
126 mlk_action_script_finish(struct mlk_action_script *s)
136
30b68089ae70 core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
127 {
30b68089ae70 core: rework actions and a bit of drawables, closes #2492
David Demelier <markand@malikania.fr>
parents: 121
diff changeset
128 assert(s);
65
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
129
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 499
diff changeset
130 for (size_t i = 0; i < s->actionsz; ++i) {
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 499
diff changeset
131 if (i < s->length)
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 499
diff changeset
132 mlk_action_finish(s->actions[i]);
476
00b30f899548 core: make sure mlk_action_script is zero'ed on finalization
David Demelier <markand@malikania.fr>
parents: 466
diff changeset
133
509
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 499
diff changeset
134 s->actions[i] = NULL;
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 499
diff changeset
135 }
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 499
diff changeset
136
a11cd7ea3a37 core: doxygenize action
David Demelier <markand@malikania.fr>
parents: 499
diff changeset
137 s->length = s->current = 0;
65
80a913d25aa9 core: implement script, closes #2465 @2h
David Demelier <markand@malikania.fr>
parents:
diff changeset
138 }