Mercurial > molko
annotate src/event.h @ 22:5519ad48822e
doc: add Doxygen documentation, closes #2450
author | David Demelier <markand@malikania.fr> |
---|---|
date | Thu, 09 Jan 2020 20:48:01 +0100 |
parents | bc1fdff76775 |
children | 2a087210c0b8 |
rev | line source |
---|---|
19
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
1 /* |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
2 * event.h -- event management |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
3 * |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
4 * Copyright (c) 2020 David Demelier <markand@malikania.fr> |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
5 * |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
6 * Permission to use, copy, modify, and/or distribute this software for any |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
7 * purpose with or without fee is hereby granted, provided that the above |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
8 * copyright notice and this permission notice appear in all copies. |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
9 * |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
17 */ |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
18 |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
19 #ifndef MOLKO_EVENT_H |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
20 #define MOLKO_EVENT_H |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
21 |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
22 /** |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
23 * \file event.h |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
24 * \brief Event management. |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
25 */ |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
26 |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
27 #include <stdbool.h> |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
28 #include <stdint.h> |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
29 |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
30 #include "key.h" |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
31 #include "mouse.h" |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
32 |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
33 /** |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
34 * \brief Kind of event. |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
35 */ |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
36 enum event_type { |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
37 EVENT_CLICKDOWN, /*!< Mouse click down */ |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
38 EVENT_CLICKUP, /*!< Mouse click released */ |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
39 EVENT_KEYDOWN, /*!< Single key down */ |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
40 EVENT_KEYUP, /*!< Single key released */ |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
41 EVENT_MOUSE, /*!< Mouse moved */ |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
42 EVENT_QUIT, /*!< Quit request */ |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
43 }; |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
44 |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
45 /** |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
46 * \brief Store events. |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
47 */ |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
48 union event { |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
49 enum event_type type; /*!< Which kind of event */ |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
50 |
22
5519ad48822e
doc: add Doxygen documentation, closes #2450
David Demelier <markand@malikania.fr>
parents:
19
diff
changeset
|
51 /** |
5519ad48822e
doc: add Doxygen documentation, closes #2450
David Demelier <markand@malikania.fr>
parents:
19
diff
changeset
|
52 * Store key down/up event. |
5519ad48822e
doc: add Doxygen documentation, closes #2450
David Demelier <markand@malikania.fr>
parents:
19
diff
changeset
|
53 */ |
19
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
54 struct { |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
55 enum event_type type; /*!< EVENT_KEYDOWN or EVENT_KEYUP */ |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
56 enum key key; /*!< Which key */ |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
57 } key; |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
58 |
22
5519ad48822e
doc: add Doxygen documentation, closes #2450
David Demelier <markand@malikania.fr>
parents:
19
diff
changeset
|
59 /** |
5519ad48822e
doc: add Doxygen documentation, closes #2450
David Demelier <markand@malikania.fr>
parents:
19
diff
changeset
|
60 * Store mouse motion event. |
5519ad48822e
doc: add Doxygen documentation, closes #2450
David Demelier <markand@malikania.fr>
parents:
19
diff
changeset
|
61 */ |
19
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
62 struct { |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
63 enum event_type type; /*!< EVENT_MOUSE */ |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
64 enum mouse_button buttons; /*!< OR'ed buttons that are pressed */ |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
65 int32_t x; /*!< Mouse position in x */ |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
66 int32_t y; /*!< Mouse position in y */ |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
67 } mouse; |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
68 |
22
5519ad48822e
doc: add Doxygen documentation, closes #2450
David Demelier <markand@malikania.fr>
parents:
19
diff
changeset
|
69 /** |
5519ad48822e
doc: add Doxygen documentation, closes #2450
David Demelier <markand@malikania.fr>
parents:
19
diff
changeset
|
70 * Store mouse click event. |
5519ad48822e
doc: add Doxygen documentation, closes #2450
David Demelier <markand@malikania.fr>
parents:
19
diff
changeset
|
71 */ |
19
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
72 struct { |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
73 enum event_type type; /*!< EVENT_CLICKDOWN or EVENT_CLICKUP */ |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
74 enum mouse_button button; /*!< Unique button that was pressed */ |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
75 int32_t x; /*!< Mouse position in x */ |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
76 int32_t y; /*!< Mouse position in y */ |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
77 } click; |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
78 }; |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
79 |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
80 /** |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
81 * Fetch the next event or return false if there are not. |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
82 * |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
83 * \param ev the event |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
84 * \return true if the event was filled or false otherwise |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
85 */ |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
86 bool |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
87 event_poll(union event *ev); |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
88 |
bc1fdff76775
core: implement most useful events, closes #2445
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
89 #endif /* !MOLKO_EVENT_H */ |