annotate examples/example-action/dialog.c @ 531:593703440a05

core: doxygenize music
author David Demelier <markand@malikania.fr>
date Sat, 04 Mar 2023 20:32:49 +0100
parents f14b8290b3ce
children 88e9bd420a28
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
484
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * dialog.c -- convenient message wrapper
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 * Copyright (c) 2020-2023 David Demelier <markand@malikania.fr>
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #include <assert.h>
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
20
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 #include <mlk/example/example.h>
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
22
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 #include "dialog.h"
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
24
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 /* Message width is 80% of window width and height is auto computed. */
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 #define QMW (MLK_EXAMPLE_W * 0.8)
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
27
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 /* Position of each message. */
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 #define QMX ((MLK_EXAMPLE_W - QMW) / 2)
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 #define QMY (MLK_EXAMPLE_H * 0.2)
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
31
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 /* Fading time and spacing. */
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 #define QMD 250
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 #define QMS 10
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
35
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 static void
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 handle(struct mlk_action *act, const union mlk_event *ev)
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 {
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 struct dialog *dlg = act->data;
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
40
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 message_handle(&dlg->msg, ev);
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 }
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
43
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 static int
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 update(struct mlk_action *act, unsigned int ticks)
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 {
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 struct dialog *dlg = act->data;
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
48
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 return message_update(&dlg->msg, ticks);
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 }
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
51
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 static void
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 draw(struct mlk_action *act)
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 {
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 struct dialog *dlg = act->data;
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
56
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 message_draw(&dlg->msg);
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 }
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
59
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 static void
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
61 end(struct mlk_action *act)
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
62 {
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
63 struct dialog *dlg = act->data;
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
64
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 if ((dlg->msg.flags & MESSAGE_FLAGS_QUESTION) && dlg->response)
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
66 dlg->response(dlg, dlg->msg.index);
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
67 }
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
68
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
69 struct mlk_action *
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
70 dialog_init(struct dialog *dlg)
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
71 {
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
72 assert(dlg);
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
73
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
74 dlg->msg.x = QMX;
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
75 dlg->msg.y = QMY;
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
76 dlg->msg.w = QMW;
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
77 dlg->msg.delay = QMD;
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
78 dlg->msg.spacing = QMS;
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
79
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
80 message_start(&dlg->msg);
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
81 message_query(&dlg->msg, NULL, &dlg->msg.h);
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
82
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
83 dlg->action.data = dlg;
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
84 dlg->action.handle = handle;
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
85 dlg->action.update = update;
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
86 dlg->action.draw = draw;
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
87 dlg->action.end = end;
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
88
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
89 return &dlg->action;
f14b8290b3ce examples: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
90 }