annotate src/libmlk-core/core/action-stack.h @ 369:1e06f871dc63

core: split action and action_stack
author David Demelier <markand@malikania.fr>
date Sun, 24 Oct 2021 17:33:12 +0200
parents
children 460c78706989
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 *
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 * Copyright (c) 2020-2021 David Demelier <markand@malikania.fr>
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
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 #include "core.h"
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
23
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 #define ACTION_STACK_MAX (128)
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
25
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 union event;
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
27
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 struct action_stack {
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 struct action *actions[ACTION_STACK_MAX];
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 };
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 CORE_BEGIN_DECLS
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
33
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 void
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 action_stack_init(struct action_stack *);
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
36
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 int
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 action_stack_add(struct action_stack *, struct action *);
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 void
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 action_stack_handle(struct action_stack *, const union event *);
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
42
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 int
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 action_stack_update(struct action_stack *, unsigned int);
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
45
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 void
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 action_stack_draw(const struct action_stack *);
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
48
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 int
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 action_stack_completed(const struct action_stack *);
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 void
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 action_stack_finish(struct action_stack *);
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
54
1e06f871dc63 core: split action and action_stack
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 CORE_END_DECLS
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 #endif /* !MLK_CORE_ACTION_STACK_H */