1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
|
/*
* This file is subject to the terms of the GFX License. If a copy of
* the license was not distributed with this file, you can obtain one at:
*
* http://ugfx.org/license.html
*/
/**
* @file gfx.h
* @brief GFX system header file.
*
* @addtogroup GFX
*
* @brief Main module to glue all the others together
*
* @{
*/
#ifndef _GFX_H
#define _GFX_H
// Everything here is C, not C++
#ifdef __cplusplus
extern "C" {
#endif
// ------------------------------ Initial preparation ---------------------------------
// ------------------------------ Load the user configuration ---------------------------------
// Definitions for option configuration
#define GFXOFF (0)
#define GFXON (-1)
// gfxconf.h is the user's project configuration for the GFX system.
#include "gfxconf.h"
// ------------------------------ Determine build environment info - COMPILER, CPU etc ---------------------------------
/**
* @name GFX compatibility options
* @{
*/
/**
* @brief Include the uGFX V2.x API
* @details Defaults to GFXON
*/
#ifndef GFX_COMPAT_V2
#define GFX_COMPAT_V2 GFXON
#endif
/** @} */
#if GFX_COMPAT_V2
// These need to be defined here for compatibility with V2.x user config files
#if !defined(FALSE)
#define FALSE 0
#endif
#if !defined(TRUE)
#define TRUE -1
#endif
#endif
// Macro concatination and strify - not API documented
#define GFXCAT(a, b) a ## b
#define GFXCATX(a, b) GFXCAT(a, b)
#define GFXSTR(a) #a
#define GFXSTRX(a) GFXSTR(a)
// Include Compiler and CPU support
#include "src/gfx_compilers.h"
// ------------------------------ Enumerate all options ---------------------------------
/**
* @name GFX sub-systems that can be turned on
* @{
*/
/**
* @brief GFX Driver API
* @details Defaults to GFXON
* @note Not much useful can be done without a driver
*/
#ifndef GFX_USE_GDRIVER
#define GFX_USE_GDRIVER GFXON
#endif
/**
* @brief GFX Graphics Display Basic API
* @details Defaults to GFXOFF
* @note Also add the specific hardware driver to your makefile.
* Eg. include $(GFXLIB)/drivers/gdisp/Nokia6610/driver.mk
*/
#ifndef GFX_USE_GDISP
#define GFX_USE_GDISP GFXOFF
#endif
/**
* @brief GFX Graphics Windowing API
* @details Defaults to GFXOFF
* @details Extends the GDISP API to add the concept of graphic windows.
* @note Also supports high-level "window" objects such as console windows,
* buttons, graphing etc
*/
#ifndef GFX_USE_GWIN
#define GFX_USE_GWIN GFXOFF
#endif
/**
* @brief GFX Event API
* @details Defaults to GFXOFF
* @details Defines the concept of a "Source" that can send "Events" to "Listeners".
*/
#ifndef GFX_USE_GEVENT
#define GFX_USE_GEVENT GFXOFF
#endif
/**
* @brief GFX Timer API
* @details Defaults to GFXOFF
* @details Provides thread context timers - both one-shot and periodic.
*/
#ifndef GFX_USE_GTIMER
#define GFX_USE_GTIMER GFXOFF
#endif
/**
* @brief GFX Queue API
* @details Defaults to GFXOFF
* @details Provides queue management.
*/
#ifndef GFX_USE_GQUEUE
#define GFX_USE_GQUEUE GFXOFF
#endif
/**
* @brief GFX Input Device API
* @details Defaults to GFXOFF
* @note Also add the specific hardware drivers to your makefile.
* Eg.
* include $(GFXLIB)/drivers/ginput/toggle/Pal/driver.mk
* and...
* include $(GFXLIB)/drivers/ginput/touch/MCU/driver.mk
*/
#ifndef GFX_USE_GINPUT
#define GFX_USE_GINPUT GFXOFF
#endif
/**
* @brief GFX Generic Periodic ADC API
* @details Defaults to GFXOFF
*/
#ifndef GFX_USE_GADC
#define GFX_USE_GADC GFXOFF
#endif
/**
* @brief GFX Audio API
* @details Defaults to GFXOFF
* @note Also add the specific hardware drivers to your makefile.
* Eg.
* include $(GFXLIB)/drivers/gaudio/GADC/driver.mk
*/
#ifndef GFX_USE_GAUDIO
#define GFX_USE_GAUDIO GFXOFF
#endif
/**
* @brief GFX Miscellaneous Routines API
* @details Defaults to GFXOFF
* @note Turning this on without turning on any GMISC_NEED_xxx macros will result
* in no extra code being compiled in. GMISC is made up from the sum of its
* parts.
*/
#ifndef GFX_USE_GMISC
#define GFX_USE_GMISC GFXOFF
#endif
/**
* @brief GFX File API
* @details Defaults to GFXOFF
*/
#ifndef GFX_USE_GFILE
#define GFX_USE_GFILE GFXOFF
#endif
/**
* @brief GFX Translation Support API
* @details Defaults to GFXOFF
*/
#ifndef GFX_USE_GTRANS
#define GFX_USE_GTRANS GFXOFF
#endif
/** @} */
/**
* @name GFX compatibility options
* @{
*/
/**
* @brief Include the uGFX V2.x Old Colors
* @details Defaults to GFXON
* @pre Requires GFX_COMPAT_V2 to be GFXON
* @note The old color definitions (particularly Red, Green & Blue) can
* cause symbol conflicts with many platforms eg Win32, STM32 HAL etc.
* Although officially these symbols are part of the V2.x API, this
* option allows them to be turned off even when the rest of the V2.x
* API is turned on.
*/
#ifndef GFX_COMPAT_OLDCOLORS
#define GFX_COMPAT_OLDCOLORS GFXON
#endif
/** @} */
/**
* Get all the options for each sub-system.
*
*/
#include "src/gos/gos_options.h"
#include "src/gdriver/gdriver_options.h"
#include "src/gfile/gfile_options.h"
#include "src/gmisc/gmisc_options.h"
#include "src/gtrans/gtrans_options.h"
#include "src/gqueue/gqueue_options.h"
#include "src/gevent/gevent_options.h"
#include "src/gtimer/gtimer_options.h"
#include "src/gdisp/gdisp_options.h"
#include "src/gwin/gwin_options.h"
#include "src/ginput/ginput_options.h"
#include "src/gadc/gadc_options.h"
#include "src/gaudio/gaudio_options.h"
// ------------------------------ Load driver configuration ---------------------------------
// ------------------------------ Apply configuration rules ---------------------------------
/**
* Interdependency safety checks on the sub-systems.
* These must be in dependency order.
*
*/
#ifndef GFX_DISPLAY_RULE_WARNINGS
#define GFX_DISPLAY_RULE_WARNINGS GFXOFF
#endif
#include "src/gwin/gwin_rules.h"
#include "src/ginput/ginput_rules.h"
#include "src/gdisp/gdisp_rules.h"
#include "src/gaudio/gaudio_rules.h"
#include "src/gadc/gadc_rules.h"
#include "src/gevent/gevent_rules.h"
#include "src/gtimer/gtimer_rules.h"
#include "src/gqueue/gqueue_rules.h"
#include "src/gmisc/gmisc_rules.h"
#include "src/gtrans/gtrans_rules.h"
#include "src/gfile/gfile_rules.h"
#include "src/gdriver/gdriver_rules.h"
#include "src/gos/gos_rules.h"
// ------------------------------ Define API definitions ---------------------------------
/**
* Include the sub-system header files
*/
#include "src/gos/gos.h"
//#include "src/gdriver/gdriver.h" // This module is only included by source that needs it.
#include "src/gfile/gfile.h"
#include "src/gmisc/gmisc.h"
#include "src/gtrans/gtrans.h"
#include "src/gqueue/gqueue.h"
#include "src/gevent/gevent.h"
#include "src/gtimer/gtimer.h"
#include "src/gdisp/gdisp.h"
#include "src/gwin/gwin.h"
#include "src/ginput/ginput.h"
#include "src/gadc/gadc.h"
#include "src/gaudio/gaudio.h"
/**
* @brief The one call to start it all
*
* @note This will initialise each sub-system that has been turned on.
* For example, if GFX_USE_GDISP is defined then display will be initialised
* and cleared to black.
* @note If you define GFX_OS_NO_INIT as GFXON in your gfxconf.h file then ugfx doesn't try to
* initialise the operating system for you when you call @p gfxInit().
* @note If you define GFX_OS_EXTRA_INIT_FUNCTION in your gfxconf.h file the macro is the
* name of a void function with no parameters that is called immediately after
* operating system initialisation (whether or not GFX_OS_NO_INIT is set).
* @note If you define GFX_OS_EXTRA_DEINIT_FUNCTION in your gfxconf.h file the macro is the
* name of a void function with no parameters that is called immediately before
* operating system de-initialisation (as ugfx is exiting).
* @note If GFX_OS_CALL_UGFXMAIN is set uGFXMain() is called after all initialisation is complete.
*
* @api
*/
void gfxInit(void);
/**
* @brief The one call to end it all
*
* @note This will de-initialise each sub-system that has been turned on.
*
* @api
*/
void gfxDeinit(void);
#if GFX_OS_CALL_UGFXMAIN || defined(__DOXYGEN__)
/**
* @brief The function containing all the user uGFX application code.
*
* @note This is called by gfxInit() and is expected to never return.
* It is defined by the user.
*
* @pre GFX_OS_CALL_UGFXMAIN is GFXON
*/
void uGFXMain(void);
#endif
#ifdef __cplusplus
}
#endif
#endif /* _GFX_H */
/** @} */
|
