added hiding info screen sub-menus marked with '.hide'
[rocksndiamonds.git] / src / libgame / system.h
1 // ============================================================================
2 // Artsoft Retro-Game Library
3 // ----------------------------------------------------------------------------
4 // (c) 1995-2014 by Artsoft Entertainment
5 //                  Holger Schemel
6 //                  info@artsoft.org
7 //                  https://www.artsoft.org/
8 // ----------------------------------------------------------------------------
9 // system.h
10 // ============================================================================
11
12 #ifndef SYSTEM_H
13 #define SYSTEM_H
14
15 #include "platform.h"
16 #include "types.h"
17
18
19 #if defined(PLATFORM_MACOSX)
20 #include "macosx.h"
21 #elif defined(PLATFORM_WIN32)
22 #include "windows.h"
23 #elif defined(PLATFORM_ANDROID)
24 #include "android.h"
25 #elif defined(PLATFORM_EMSCRIPTEN)
26 #include "emscripten.h"
27 #endif
28
29 #include "sdl.h"
30
31
32 // the additional 'b' is needed for Win32 to open files in binary mode
33 #define MODE_READ                       "rb"
34 #define MODE_WRITE                      "wb"
35 #define MODE_APPEND                     "ab"
36
37 #define DEFAULT_DEPTH                   0
38
39 #define BLIT_OPAQUE                     0
40 #define BLIT_MASKED                     1
41 #define BLIT_INVERSE                    2
42 #define BLIT_ON_BACKGROUND              3
43
44 // values for fullscreen status
45 #define FULLSCREEN_NOT_AVAILABLE        FALSE
46 #define FULLSCREEN_AVAILABLE            TRUE
47
48 // values for window scaling
49 #define WINDOW_SCALING_NOT_AVAILABLE    FALSE
50 #define WINDOW_SCALING_AVAILABLE        TRUE
51
52 #define MIN_WINDOW_SCALING_PERCENT      30
53 #define STD_WINDOW_SCALING_PERCENT      100
54 #define MAX_WINDOW_SCALING_PERCENT      400
55 #define STEP_WINDOW_SCALING_PERCENT     10
56
57 // values for window scaling quality
58 #define SCALING_QUALITY_NEAREST         "nearest"
59 #define SCALING_QUALITY_LINEAR          "linear"
60 #define SCALING_QUALITY_BEST            "best"
61
62 #define SCALING_QUALITY_DEFAULT         SCALING_QUALITY_LINEAR
63
64 // values for screen rendering mode
65 #define STR_SPECIAL_RENDERING_OFF       "stream_texture_only"
66 #define STR_SPECIAL_RENDERING_BITMAP    "bitmap_and_stream_texture"
67 #define STR_SPECIAL_RENDERING_TARGET    "target_texture_only"
68 #define STR_SPECIAL_RENDERING_DOUBLE    "stream_and_target_texture"
69
70 #if defined(PLATFORM_EMSCRIPTEN)
71 #define STR_SPECIAL_RENDERING_DEFAULT   STR_SPECIAL_RENDERING_BITMAP
72 #else
73 #define STR_SPECIAL_RENDERING_DEFAULT   STR_SPECIAL_RENDERING_DOUBLE
74 #endif
75
76 #define SPECIAL_RENDERING_OFF           0
77 #define SPECIAL_RENDERING_BITMAP        1
78 #define SPECIAL_RENDERING_TARGET        2
79 #define SPECIAL_RENDERING_DOUBLE        3
80
81 // values for vertical screen retrace synchronization (vsync)
82 #define STR_VSYNC_MODE_OFF              "off"
83 #define STR_VSYNC_MODE_NORMAL           "normal"
84 #define STR_VSYNC_MODE_ADAPTIVE         "adaptive"
85
86 #define STR_VSYNC_MODE_DEFAULT          STR_VSYNC_MODE_OFF
87
88 #define VSYNC_MODE_OFF                  0
89 #define VSYNC_MODE_NORMAL               1
90 #define VSYNC_MODE_ADAPTIVE             -1
91
92 #define VSYNC_MODE_DEFAULT              VSYNC_MODE_OFF
93
94 #define VSYNC_MODE_STR_TO_INT(s)                                        \
95   (strEqual((s), STR_VSYNC_MODE_NORMAL)         ? VSYNC_MODE_NORMAL :   \
96    strEqual((s), STR_VSYNC_MODE_ADAPTIVE)       ? VSYNC_MODE_ADAPTIVE : \
97    VSYNC_MODE_OFF)
98
99 #define VSYNC_MODE_INT_TO_STR(i)                                        \
100   ((i) == VSYNC_MODE_NORMAL             ? STR_VSYNC_MODE_NORMAL :       \
101    (i) == VSYNC_MODE_ADAPTIVE           ? STR_VSYNC_MODE_ADAPTIVE :     \
102    STR_VSYNC_MODE_OFF)
103
104 // values for network server settings
105 #define STR_NETWORK_AUTO_DETECT         "auto_detect_network_server"
106 #define STR_NETWORK_AUTO_DETECT_SETUP   "(auto detect network server)"
107
108 // values for API server settings
109 #define API_SERVER_HOSTNAME             "api.artsoft.org"
110 #define API_SERVER_PORT                 80
111 #define API_SERVER_METHOD               "POST"
112 #define API_SERVER_URI_ADD              "/api/scores/add"
113 #define API_SERVER_URI_GET              "/api/scores/get"
114 #define API_SERVER_URI_GETTAPE          "/api/scores/gettape"
115 #define API_SERVER_URI_RENAME           "/api/players/rename"
116 #define API_SERVER_URI_RESETUUID        "/api/players/resetuuid"
117
118 #if defined(TESTING)
119 #undef API_SERVER_HOSTNAME
120 #define API_SERVER_HOSTNAME             "api-test.artsoft.org"
121 #define TEST_PREFIX                     "test."
122 #else
123 #define TEST_PREFIX                     ""
124 #endif
125
126 // values for touch control
127 #define TOUCH_CONTROL_OFF               "off"
128 #define TOUCH_CONTROL_VIRTUAL_BUTTONS   "virtual_buttons"
129 #define TOUCH_CONTROL_WIPE_GESTURES     "wipe_gestures"
130 #define TOUCH_CONTROL_FOLLOW_FINGER     "follow_finger"
131
132 #if defined(PLATFORM_ANDROID)
133 #define TOUCH_CONTROL_DEFAULT           TOUCH_CONTROL_VIRTUAL_BUTTONS
134 #else
135 #define TOUCH_CONTROL_DEFAULT           TOUCH_CONTROL_OFF
136 #endif
137
138 #define TOUCH_MOVE_DISTANCE_DEFAULT     2
139 #define TOUCH_DROP_DISTANCE_DEFAULT     5
140 #define TOUCH_TRANSPARENCY_DEFAULT      50
141
142 #define ALPHA_FROM_TRANSPARENCY(x)      ((100 - x) * SDL_ALPHA_OPAQUE / 100)
143 #define ALPHA_FADING_STEPSIZE(x)        ((x) / 25)
144
145 // values for special settings for mobile devices
146 #if defined(PLATFORM_ANDROID)
147 #define HAS_TOUCH_DEVICE
148 #define USE_TOUCH_INPUT_OVERLAY
149 #define USE_COMPLETE_DISPLAY
150 #define HAS_SCREEN_KEYBOARD
151 #define SCREEN_KEYBOARD_POS(h)          ((h) / 2)
152 #endif
153
154 // values for drag-and-drop support (some parts not added before SDL 2.0.5)
155 #if !SDL_VERSION_ATLEAST(2,0,5)
156 #define SDL_DROPTEXT                    (SDL_DROPFILE + 1)
157 #define SDL_DROPBEGIN                   (SDL_DROPFILE + 2)
158 #define SDL_DROPCOMPLETE                (SDL_DROPFILE + 3)
159 #endif
160
161 // default input keys
162 #define DEFAULT_KEY_LEFT                KSYM_Left
163 #define DEFAULT_KEY_RIGHT               KSYM_Right
164 #define DEFAULT_KEY_UP                  KSYM_Up
165 #define DEFAULT_KEY_DOWN                KSYM_Down
166 #if defined(PLATFORM_MACOSX)
167 #define DEFAULT_KEY_SNAP                KSYM_Control_L
168 #define DEFAULT_KEY_DROP                KSYM_KP_Enter
169 #else
170 #define DEFAULT_KEY_SNAP                KSYM_Control_L
171 #define DEFAULT_KEY_DROP                KSYM_Control_R
172 #endif
173 #define DEFAULT_KEY_OKAY                KSYM_Return
174 #define DEFAULT_KEY_CANCEL              KSYM_Escape
175
176 // default shortcut keys
177 #define DEFAULT_KEY_SAVE_GAME           KSYM_F1
178 #define DEFAULT_KEY_LOAD_GAME           KSYM_F2
179 #define DEFAULT_KEY_RESTART_GAME        KSYM_F3
180 #define DEFAULT_KEY_PAUSE_BEFORE_END    KSYM_F4
181 #define DEFAULT_KEY_TOGGLE_PAUSE        KSYM_space
182 #define DEFAULT_KEY_FOCUS_PLAYER_1      KSYM_F5
183 #define DEFAULT_KEY_FOCUS_PLAYER_2      KSYM_F6
184 #define DEFAULT_KEY_FOCUS_PLAYER_3      KSYM_F7
185 #define DEFAULT_KEY_FOCUS_PLAYER_4      KSYM_F8
186 #define DEFAULT_KEY_FOCUS_PLAYER_ALL    KSYM_F9
187 #define DEFAULT_KEY_TAPE_EJECT          KSYM_UNDEFINED
188 #define DEFAULT_KEY_TAPE_EXTRA          KSYM_UNDEFINED
189 #define DEFAULT_KEY_TAPE_STOP           KSYM_UNDEFINED
190 #define DEFAULT_KEY_TAPE_PAUSE          KSYM_UNDEFINED
191 #define DEFAULT_KEY_TAPE_RECORD         KSYM_UNDEFINED
192 #define DEFAULT_KEY_TAPE_PLAY           KSYM_UNDEFINED
193 #define DEFAULT_KEY_SOUND_SIMPLE        KSYM_UNDEFINED
194 #define DEFAULT_KEY_SOUND_LOOPS         KSYM_UNDEFINED
195 #define DEFAULT_KEY_SOUND_MUSIC         KSYM_UNDEFINED
196 #define DEFAULT_KEY_SNAP_LEFT           KSYM_UNDEFINED
197 #define DEFAULT_KEY_SNAP_RIGHT          KSYM_UNDEFINED
198 #define DEFAULT_KEY_SNAP_UP             KSYM_UNDEFINED
199 #define DEFAULT_KEY_SNAP_DOWN           KSYM_UNDEFINED
200
201 // default debug setup keys and values
202 #define DEFAULT_FRAME_DELAY_0           20              // 100 % speed
203 #define DEFAULT_FRAME_DELAY_1           500             // 4 % speed
204 #define DEFAULT_FRAME_DELAY_2           250             // 8 % speed
205 #define DEFAULT_FRAME_DELAY_3           125             // 16 % speed
206 #define DEFAULT_FRAME_DELAY_4           60              // 33 % speed
207 #define DEFAULT_FRAME_DELAY_5           40              // 50 % speed
208 #define DEFAULT_FRAME_DELAY_6           30              // 66 % speed
209 #define DEFAULT_FRAME_DELAY_7           10              // 200 % speed
210 #define DEFAULT_FRAME_DELAY_8           5               // 400 % speed
211 #define DEFAULT_FRAME_DELAY_9           0               // maximum speed
212
213 #define DEFAULT_KEY_FRAME_DELAY_0       KSYM_0
214 #define DEFAULT_KEY_FRAME_DELAY_1       KSYM_1
215 #define DEFAULT_KEY_FRAME_DELAY_2       KSYM_2
216 #define DEFAULT_KEY_FRAME_DELAY_3       KSYM_3
217 #define DEFAULT_KEY_FRAME_DELAY_4       KSYM_4
218 #define DEFAULT_KEY_FRAME_DELAY_5       KSYM_5
219 #define DEFAULT_KEY_FRAME_DELAY_6       KSYM_6
220 #define DEFAULT_KEY_FRAME_DELAY_7       KSYM_7
221 #define DEFAULT_KEY_FRAME_DELAY_8       KSYM_8
222 #define DEFAULT_KEY_FRAME_DELAY_9       KSYM_9
223
224 #define NUM_DEBUG_FRAME_DELAY_KEYS      10
225
226 #define DEFAULT_FRAME_DELAY_USE_MOD_KEY FALSE
227 #define DEFAULT_FRAME_DELAY_GAME_ONLY   TRUE
228
229 // values for key_status
230 #define KEY_NOT_PRESSED                 FALSE
231 #define KEY_RELEASED                    FALSE
232 #define KEY_PRESSED                     TRUE
233
234 // values for button status
235 #define MB_NOT_PRESSED                  FALSE
236 #define MB_NOT_RELEASED                 TRUE
237 #define MB_RELEASED                     FALSE
238 #define MB_PRESSED                      TRUE
239 #define MB_MENU_CHOICE                  FALSE
240 #define MB_MENU_MARK                    TRUE
241 #define MB_MENU_INITIALIZE              (-1)
242 #define MB_MENU_LEAVE                   (-2)
243 #define MB_LEFTBUTTON                   1
244 #define MB_MIDDLEBUTTON                 2
245 #define MB_RIGHTBUTTON                  3
246 #define MB_WHEEL_UP                     4
247 #define MB_WHEEL_DOWN                   5
248 #define MB_WHEEL_LEFT                   6
249 #define MB_WHEEL_RIGHT                  7
250 #define IS_WHEEL_BUTTON_VERTICAL(b)     ((b) == MB_WHEEL_UP ||          \
251                                          (b) == MB_WHEEL_DOWN)
252 #define IS_WHEEL_BUTTON_HORIZONTAL(b)   ((b) == MB_WHEEL_LEFT ||        \
253                                          (b) == MB_WHEEL_RIGHT)
254 #define IS_WHEEL_BUTTON(b)              (IS_WHEEL_BUTTON_VERTICAL(b) || \
255                                          IS_WHEEL_BUTTON_HORIZONTAL(b))
256 #define DEFAULT_WHEEL_STEPS             3
257
258 #define BUTTON_STEPSIZE(b)              ((b) == MB_LEFTBUTTON   ?  1 :  \
259                                          (b) == MB_MIDDLEBUTTON ?  5 :  \
260                                          (b) == MB_RIGHTBUTTON  ? 10 : 1)
261
262 // values for move directions
263 #define MV_BIT_LEFT                     0
264 #define MV_BIT_RIGHT                    1
265 #define MV_BIT_UP                       2
266 #define MV_BIT_DOWN                     3
267
268 #define NUM_DIRECTIONS                  4
269
270 // diagonal movement directions are used in a different contect than buttons
271 #define MV_BIT_UPLEFT                   4
272 #define MV_BIT_UPRIGHT                  5
273 #define MV_BIT_DOWNLEFT                 6
274 #define MV_BIT_DOWNRIGHT                7
275
276 #define NUM_DIRECTIONS_FULL             8
277
278 // values for special "button" bitmasks
279 #define BUTTON_1                        4
280 #define BUTTON_2                        5
281
282 #define NUM_PLAYER_ACTIONS              6
283
284 // values for special "focus player" bitmasks
285 #define BIT_SET_FOCUS                   6
286
287 // values for drawing stages for global animations
288 #define DRAW_GLOBAL_ANIM_STAGE_1        1
289 #define DRAW_GLOBAL_ANIM_STAGE_2        2
290
291 // values for drawing target (various functions)
292 #define DRAW_TO_BACKBUFFER              0
293 #define DRAW_TO_FIELDBUFFER             1
294 #define DRAW_TO_SCREEN                  2
295 #define DRAW_TO_FADE_SOURCE             3
296 #define DRAW_TO_FADE_TARGET             4
297
298 // values for move directions and special "button" key bitmasks
299 #define MV_NONE                 0
300 #define MV_LEFT                 (1 << MV_BIT_LEFT)
301 #define MV_RIGHT                (1 << MV_BIT_RIGHT)
302 #define MV_UP                   (1 << MV_BIT_UP)
303 #define MV_DOWN                 (1 << MV_BIT_DOWN)
304
305 #define MV_UPLEFT               (MV_UP   | MV_LEFT)
306 #define MV_UPRIGHT              (MV_UP   | MV_RIGHT)
307 #define MV_DOWNLEFT             (MV_DOWN | MV_LEFT)
308 #define MV_DOWNRIGHT            (MV_DOWN | MV_RIGHT)
309
310 #define MV_HORIZONTAL           (MV_LEFT | MV_RIGHT)
311 #define MV_VERTICAL             (MV_UP   | MV_DOWN)
312 #define MV_ALL_DIRECTIONS       (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
313 #define MV_ANY_DIRECTION        (MV_ALL_DIRECTIONS)
314 #define MV_NO_DIRECTION         (MV_NONE)
315
316 #define KEY_BUTTON_1            (1 << BUTTON_1)
317 #define KEY_BUTTON_2            (1 << BUTTON_2)
318 #define KEY_BUTTON_SNAP         KEY_BUTTON_1
319 #define KEY_BUTTON_DROP         KEY_BUTTON_2
320 #define KEY_MOTION              (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
321 #define KEY_BUTTON              (KEY_BUTTON_1 | KEY_BUTTON_2)
322 #define KEY_ACTION              (KEY_MOTION | KEY_BUTTON)
323
324 #define KEY_SET_FOCUS           (1 << BIT_SET_FOCUS)
325
326 #define MV_DIR_FROM_BIT(x)      ((x) < NUM_DIRECTIONS ? 1 << (x) :        \
327                                  (x) == MV_BIT_UPLEFT    ? MV_UPLEFT    : \
328                                  (x) == MV_BIT_UPRIGHT   ? MV_UPRIGHT   : \
329                                  (x) == MV_BIT_DOWNLEFT  ? MV_DOWNLEFT  : \
330                                  (x) == MV_BIT_DOWNRIGHT ? MV_DOWNRIGHT : \
331                                  MV_NONE)
332
333 #define MV_DIR_TO_BIT(x)        ((x) == MV_LEFT      ? MV_BIT_LEFT      : \
334                                  (x) == MV_RIGHT     ? MV_BIT_RIGHT     : \
335                                  (x) == MV_UP        ? MV_BIT_UP        : \
336                                  (x) == MV_DOWN      ? MV_BIT_DOWN      : \
337                                  (x) == MV_UPLEFT    ? MV_BIT_UPLEFT    : \
338                                  (x) == MV_UPRIGHT   ? MV_BIT_UPRIGHT   : \
339                                  (x) == MV_DOWNLEFT  ? MV_BIT_DOWNLEFT  : \
340                                  (x) == MV_DOWNRIGHT ? MV_BIT_DOWNRIGHT : \
341                                  MV_BIT_DOWN)
342
343 #define MV_DIR_OPPOSITE(x)      ((x) == MV_LEFT      ? MV_RIGHT     : \
344                                  (x) == MV_RIGHT     ? MV_LEFT      : \
345                                  (x) == MV_UP        ? MV_DOWN      : \
346                                  (x) == MV_DOWN      ? MV_UP        : \
347                                  (x) == MV_UPLEFT    ? MV_DOWNRIGHT : \
348                                  (x) == MV_UPRIGHT   ? MV_DOWNLEFT  : \
349                                  (x) == MV_DOWNLEFT  ? MV_UPRIGHT   : \
350                                  (x) == MV_DOWNRIGHT ? MV_UPLEFT    : \
351                                  MV_NONE)
352
353 // values for animation mode (frame order and direction)
354 // (stored in level files -- never change existing values)
355 #define ANIM_NONE               0
356 #define ANIM_LOOP               (1 << 0)
357 #define ANIM_LINEAR             (1 << 1)
358 #define ANIM_PINGPONG           (1 << 2)
359 #define ANIM_PINGPONG2          (1 << 3)
360 #define ANIM_RANDOM             (1 << 4)
361 #define ANIM_CE_VALUE           (1 << 5)
362 #define ANIM_CE_SCORE           (1 << 6)
363 #define ANIM_CE_DELAY           (1 << 7)
364 #define ANIM_REVERSE            (1 << 8)
365 #define ANIM_OPAQUE_PLAYER      (1 << 9)
366
367 // values for special (non game element) animation modes
368 // (not stored in level files -- can be changed, if needed)
369 #define ANIM_HORIZONTAL         (1 << 10)
370 #define ANIM_VERTICAL           (1 << 11)
371 #define ANIM_CENTERED           (1 << 12)
372 #define ANIM_STATIC_PANEL       (1 << 13)
373 #define ANIM_ALL                (1 << 14)
374 #define ANIM_ONCE               (1 << 15)
375 #define ANIM_TILED              (1 << 16)
376 #define ANIM_RANDOM_STATIC      (1 << 17)
377
378 #define ANIM_DEFAULT            ANIM_LOOP
379
380 // values for special drawing styles and event handling
381 #define STYLE_NONE              0
382
383 // values used for crumbled graphics
384 #define STYLE_ACCURATE_BORDERS  (1 << 0)
385 #define STYLE_INNER_CORNERS     (1 << 1)
386
387 // values used for game panel graphics
388 #define STYLE_REVERSE           (1 << 2)
389 #define STYLE_LEFTMOST_POSITION (1 << 3)
390
391 // values used for global animations
392 #define STYLE_BLOCK             (1 << 4)
393 #define STYLE_PASSTHROUGH       (1 << 5)
394 #define STYLE_MULTIPLE_ACTIONS  (1 << 6)
395
396 #define STYLE_DEFAULT           STYLE_NONE
397
398 // values for special global animation delay types
399 #define ANIM_DELAY_UNDEFINED    -1
400 #define ANIM_DELAY_NONE         0
401 #define ANIM_DELAY_INIT         1
402 #define ANIM_DELAY_ANIM         2
403 #define ANIM_DELAY_POST         3
404
405 // values for special global animation delay actions
406 #define ANIM_DELAY_ACTION_NONE  -1
407
408 // values for special global animation events
409 #define ANIM_EVENT_UNDEFINED    -1
410 #define ANIM_EVENT_NONE         0
411 #define ANIM_EVENT_SELF         (1 << 16)
412 #define ANIM_EVENT_ANY          (1 << 17)
413 #define ANIM_EVENT_CLICK        (1 << 18)
414 #define ANIM_EVENT_INIT         (1 << 19)
415 #define ANIM_EVENT_START        (1 << 20)
416 #define ANIM_EVENT_END          (1 << 21)
417 #define ANIM_EVENT_POST         (1 << 22)
418 #define ANIM_EVENT_UNCLICK_ANY  (1 << 23)
419
420 // anim number: bits 0-7
421 // part number: bits 8-15
422 #define ANIM_EVENT_ANIM_BIT     0
423 #define ANIM_EVENT_PART_BIT     8
424
425 #define ANIM_EVENT_ANIM_MASK    (0xff << ANIM_EVENT_ANIM_BIT)
426 #define ANIM_EVENT_PART_MASK    (0xff << ANIM_EVENT_PART_BIT)
427
428 #define ANIM_EVENT_DEFAULT      ANIM_EVENT_NONE
429
430 // values for special global animation event actions
431 #define ANIM_EVENT_ACTION_NONE  -1
432
433 // values for fade mode
434 #define FADE_TYPE_NONE          0
435 #define FADE_TYPE_FADE_IN       (1 << 0)
436 #define FADE_TYPE_FADE_OUT      (1 << 1)
437 #define FADE_TYPE_TRANSFORM     (1 << 2)
438 #define FADE_TYPE_CROSSFADE     (1 << 3)
439 #define FADE_TYPE_MELT          (1 << 4)
440 #define FADE_TYPE_CURTAIN       (1 << 5)
441 #define FADE_TYPE_SKIP          (1 << 6)
442
443 #define FADE_MODE_NONE          (FADE_TYPE_NONE)
444 #define FADE_MODE_FADE_IN       (FADE_TYPE_FADE_IN)
445 #define FADE_MODE_FADE_OUT      (FADE_TYPE_FADE_OUT)
446 #define FADE_MODE_FADE          (FADE_TYPE_FADE_IN | FADE_TYPE_FADE_OUT)
447 #define FADE_MODE_TRANSFORM     (FADE_TYPE_TRANSFORM | FADE_TYPE_FADE_IN)
448 #define FADE_MODE_CROSSFADE     (FADE_MODE_TRANSFORM | FADE_TYPE_CROSSFADE)
449 #define FADE_MODE_MELT          (FADE_MODE_TRANSFORM | FADE_TYPE_MELT)
450 #define FADE_MODE_CURTAIN       (FADE_MODE_TRANSFORM | FADE_TYPE_CURTAIN)
451 #define FADE_MODE_SKIP_FADE_IN  (FADE_TYPE_SKIP | FADE_TYPE_FADE_IN)
452 #define FADE_MODE_SKIP_FADE_OUT (FADE_TYPE_SKIP | FADE_TYPE_FADE_OUT)
453
454 #define FADE_MODE_DEFAULT       FADE_MODE_FADE
455
456 #define AUTO_DELAY_UNIT_MS      0
457 #define AUTO_DELAY_UNIT_FRAMES  1
458
459 #define AUTO_DELAY_UNIT_DEFAULT AUTO_DELAY_UNIT_MS
460
461 // values for toon positions
462 #define POS_UNDEFINED           -1
463 #define POS_LEFT                0
464 #define POS_RIGHT               1
465 #define POS_TOP                 2
466 #define POS_UPPER               3
467 #define POS_MIDDLE              4
468 #define POS_LOWER               5
469 #define POS_BOTTOM              6
470 #define POS_ANY                 7
471 #define POS_LAST                8
472
473 // values for text alignment
474 #define ALIGN_LEFT              (1 << 0)
475 #define ALIGN_RIGHT             (1 << 1)
476 #define ALIGN_CENTER            (1 << 2)
477 #define ALIGN_DEFAULT           ALIGN_LEFT
478
479 #define VALIGN_TOP              (1 << 0)
480 #define VALIGN_BOTTOM           (1 << 1)
481 #define VALIGN_MIDDLE           (1 << 2)
482 #define VALIGN_DEFAULT          VALIGN_TOP
483
484 #define ALIGNED_XPOS(x,w,a)     ((a) == ALIGN_CENTER  ? (x) - (w) / 2 : \
485                                  (a) == ALIGN_RIGHT   ? (x) - (w) : (x))
486 #define ALIGNED_YPOS(y,h,v)     ((v) == VALIGN_MIDDLE ? (y) - (h) / 2 : \
487                                  (v) == VALIGN_BOTTOM ? (y) - (h) : (y))
488 #define ALIGNED_TEXT_XPOS(p)    ALIGNED_XPOS((p)->x, (p)->width,  (p)->align)
489 #define ALIGNED_TEXT_YPOS(p)    ALIGNED_YPOS((p)->y, (p)->height, (p)->valign)
490 #define ALIGNED_VP_XPOS(p)      ALIGNED_TEXT_XPOS(p)
491 #define ALIGNED_VP_YPOS(p)      ALIGNED_TEXT_YPOS(p)
492
493 // values for redraw_mask
494 #define REDRAW_NONE             (0)
495 #define REDRAW_ALL              (1 << 0)
496 #define REDRAW_FIELD            (1 << 1)
497 #define REDRAW_DOOR_1           (1 << 2)
498 #define REDRAW_DOOR_2           (1 << 3)
499 #define REDRAW_DOOR_3           (1 << 4)
500 #define REDRAW_FPS              (1 << 5)
501
502 #define REDRAW_DOORS            (REDRAW_DOOR_1 | \
503                                  REDRAW_DOOR_2 | \
504                                  REDRAW_DOOR_3)
505
506 #define IN_GFX_FIELD_PLAY(x, y) (x >= gfx.sx && x < gfx.sx + gfx.sxsize && \
507                                  y >= gfx.sy && y < gfx.sy + gfx.sysize)
508 #define IN_GFX_FIELD_FULL(x, y) (x >= gfx.real_sx && \
509                                  x <  gfx.real_sx + gfx.full_sxsize && \
510                                  y >= gfx.real_sy && \
511                                  y <  gfx.real_sy + gfx.full_sysize)
512 #define IN_GFX_DOOR_1(x, y)     (x >= gfx.dx && x < gfx.dx + gfx.dxsize && \
513                                  y >= gfx.dy && y < gfx.dy + gfx.dysize)
514 #define IN_GFX_DOOR_2(x, y)     (x >= gfx.vx && x < gfx.vx + gfx.vxsize && \
515                                  y >= gfx.vy && y < gfx.vy + gfx.vysize)
516 #define IN_GFX_DOOR_3(x, y)     (x >= gfx.ex && x < gfx.ex + gfx.exsize && \
517                                  y >= gfx.ey && y < gfx.ey + gfx.eysize)
518
519 // values for mouse cursor
520 #define CURSOR_UNDEFINED        -1
521 #define CURSOR_DEFAULT          0
522 #define CURSOR_NONE             1
523 #define CURSOR_PLAYFIELD        2
524
525 // fundamental game speed values
526 #define ONE_SECOND_DELAY        1000    // delay value for one second
527 #define MENU_FRAME_DELAY        20      // frame delay in milliseconds
528 #define GAME_FRAME_DELAY        20      // frame delay in milliseconds
529 #define FFWD_FRAME_DELAY        10      // 200% speed for fast forward
530 #define MIN_VSYNC_FRAME_DELAY   15      // minimum value for vsync to keep
531 #define MAX_VSYNC_FRAME_DELAY   16      // maximum value for vsync to work
532 #define FRAMES_PER_SECOND       (ONE_SECOND_DELAY / GAME_FRAME_DELAY)
533 #define FRAMES_PER_SECOND_SP    35
534
535 // maximum playfield size supported by libgame functions
536 #define MAX_PLAYFIELD_WIDTH     128
537 #define MAX_PLAYFIELD_HEIGHT    128
538
539 // maximum number of parallel players supported by libgame functions
540 #define MAX_PLAYERS             4
541
542 // maximum number of player names
543 #define MAX_PLAYER_NAMES        12
544
545 // maximum allowed length of player name
546 #define MAX_PLAYER_NAME_LEN     10
547
548 // maximum number of levels in a level set
549 #define MAX_LEVELS              1000
550
551 // maximum number of global animation and parts
552 #define MAX_GLOBAL_ANIMS                32
553 #define MAX_GLOBAL_ANIM_PARTS           32
554
555 // minimum/maximum/default x/y grid size for virtual buttons
556 #define MIN_GRID_XSIZE                  3
557 #define MIN_GRID_YSIZE                  3
558 #define MAX_GRID_XSIZE                  32
559 #define MAX_GRID_YSIZE                  32
560 #define GRID_REAL_WIDTH                 MAX(1, MAX(video.screen_width,  \
561                                                    video.screen_height))
562 #define GRID_REAL_HEIGHT                MAX(1, MIN(video.screen_width,  \
563                                                    video.screen_height))
564 #define DEFAULT_GRID_XSIZE_0            18
565 #define DEFAULT_GRID_YSIZE_0            MIN(MAX(MIN_GRID_YSIZE,         \
566                                                 DEFAULT_GRID_XSIZE_0 *  \
567                                                 GRID_REAL_HEIGHT /      \
568                                                 GRID_REAL_WIDTH),       \
569                                             MAX_GRID_YSIZE)
570 #define DEFAULT_GRID_XSIZE_1            13
571 #define DEFAULT_GRID_YSIZE_1            MIN(MAX(MIN_GRID_YSIZE,         \
572                                                 DEFAULT_GRID_XSIZE_1 *  \
573                                                 GRID_REAL_WIDTH /       \
574                                                 GRID_REAL_HEIGHT),      \
575                                             MAX_GRID_YSIZE)
576
577 #define DEFAULT_GRID_XSIZE(n)           ((n) == 0 ? DEFAULT_GRID_XSIZE_0 : \
578                                          DEFAULT_GRID_XSIZE_1)
579 #define DEFAULT_GRID_YSIZE(n)           ((n) == 0 ? DEFAULT_GRID_YSIZE_0 : \
580                                          DEFAULT_GRID_YSIZE_1)
581
582 #define GRID_ACTIVE_NR()                (video.screen_width >   \
583                                          video.screen_height ? 0 : 1)
584
585 // values for grid button characters for virtual buttons
586 #define CHAR_GRID_BUTTON_NONE           ' '
587 #define CHAR_GRID_BUTTON_LEFT           '<'
588 #define CHAR_GRID_BUTTON_RIGHT          '>'
589 #define CHAR_GRID_BUTTON_UP             '^'
590 #define CHAR_GRID_BUTTON_DOWN           'v'
591 #define CHAR_GRID_BUTTON_SNAP           '1'
592 #define CHAR_GRID_BUTTON_DROP           '2'
593
594 #define GET_ACTION_FROM_GRID_BUTTON(c)  ((c) == CHAR_GRID_BUTTON_LEFT ?  \
595                                          JOY_LEFT :                      \
596                                          (c) == CHAR_GRID_BUTTON_RIGHT ? \
597                                          JOY_RIGHT :                     \
598                                          (c) == CHAR_GRID_BUTTON_UP ?    \
599                                          JOY_UP :                        \
600                                          (c) == CHAR_GRID_BUTTON_DOWN ?  \
601                                          JOY_DOWN :                      \
602                                          (c) == CHAR_GRID_BUTTON_SNAP ?  \
603                                          JOY_BUTTON_1 :                  \
604                                          (c) == CHAR_GRID_BUTTON_DROP ?  \
605                                          JOY_BUTTON_2 :                  \
606                                          JOY_NO_ACTION)
607
608 // maximum number of level sets in the level set history
609 #define MAX_LEVELDIR_HISTORY    12
610
611 // default name for empty highscore entry
612 #define EMPTY_PLAYER_NAME       "no name"
613
614 // default name for unknown player names
615 #define ANONYMOUS_NAME          "anonymous"
616
617 // default for other unknown names
618 #define UNKNOWN_NAME            "unknown"
619
620 // default name for new levels
621 #define NAMELESS_LEVEL_NAME     "nameless level"
622
623 // default text for non-existant artwork
624 #define NOT_AVAILABLE           "(not available)"
625
626 // default value for undefined filename
627 #define UNDEFINED_FILENAME      "[NONE]"
628
629 // default value for undefined levelset
630 #define UNDEFINED_LEVELSET      "[NONE]"
631
632 // default value for undefined password
633 #define UNDEFINED_PASSWORD      "[undefined]"
634
635 // default value for undefined parameter
636 #define ARG_DEFAULT             "[DEFAULT]"
637
638 // default values for undefined configuration file parameters
639 #define ARG_UNDEFINED           "-1000000"
640 #define ARG_UNDEFINED_VALUE     (-1000000)
641
642 // default value for off-screen positions
643 #define POS_OFFSCREEN           (-1000000)
644
645 // definitions for game base path and sub-directories
646 #ifndef BASE_PATH
647 #define BASE_PATH               "."
648 #endif
649
650 // directory names
651 #define GRAPHICS_DIRECTORY      "graphics"
652 #define SOUNDS_DIRECTORY        "sounds"
653 #define MUSIC_DIRECTORY         "music"
654 #define LEVELS_DIRECTORY        "levels"
655 #define TAPES_DIRECTORY         "tapes"
656 #define SCORES_DIRECTORY        "scores"
657 #define DOCS_DIRECTORY          "docs"
658 #define ELEMENTS_DIRECTORY      "elements"
659 #define CREDITS_DIRECTORY       "credits"
660 #define INFO_DIRECTORY          "info"
661 #define CACHE_DIRECTORY         "cache"
662 #define CONF_DIRECTORY          "conf"
663 #define NETWORK_DIRECTORY       "network"
664 #define USERS_DIRECTORY         "users"
665 #define PERSISTENT_DIRECTORY    "/persistent"
666
667 #define GFX_CLASSIC_SUBDIR      "gfx_classic"
668 #define SND_CLASSIC_SUBDIR      "snd_classic"
669 #define MUS_CLASSIC_SUBDIR      "mus_classic"
670
671 #define GFX_DEFAULT_SUBDIR      (setup.internal.default_graphics_set)
672 #define SND_DEFAULT_SUBDIR      (setup.internal.default_sounds_set)
673 #define MUS_DEFAULT_SUBDIR      (setup.internal.default_music_set)
674
675 #define GFX_FALLBACK_FILENAME   (setup.internal.fallback_graphics_file)
676 #define SND_FALLBACK_FILENAME   (setup.internal.fallback_sounds_file)
677 #define MUS_FALLBACK_FILENAME   (setup.internal.fallback_music_file)
678
679 #define DEFAULT_LEVELSET        (setup.internal.default_level_series)
680
681 // file names and filename extensions
682 #define LEVELSETUP_DIRECTORY    "levelsetup"
683 #define SETUP_FILENAME          "setup.conf"
684 #define USERSETUP_FILENAME      "usersetup.conf"
685 #define AUTOSETUP_FILENAME      "autosetup.conf"
686 #define LEVELSETUP_FILENAME     "levelsetup.conf"
687 #define SERVERSETUP_FILENAME    "serversetup.conf"
688 #define EDITORSETUP_FILENAME    "editorsetup.conf"
689 #define EDITORCASCADE_FILENAME  "editorcascade.conf"
690 #define HELPANIM_FILENAME       "helpanim.conf"
691 #define HELPTEXT_FILENAME       "helptext.conf"
692 #define LEVELINFO_FILENAME      "levelinfo.conf"
693 #define GRAPHICSINFO_FILENAME   "graphicsinfo.conf"
694 #define SOUNDSINFO_FILENAME     "soundsinfo.conf"
695 #define MUSICINFO_FILENAME      "musicinfo.conf"
696 #define ARTWORKINFO_CACHE_FILE  "artworkinfo.cache"
697 #define LEVELTEMPLATE_FILENAME  "template.level"
698 #define UPLOADED_FILENAME       ".uploaded"
699 #define LEVELFILE_EXTENSION     "level"
700 #define TAPEFILE_EXTENSION      "tape"
701 #define SCOREFILE_EXTENSION     "score"
702
703 #define GAMECONTROLLER_BASENAME "gamecontrollerdb.txt"
704
705 #define LOG_OUT_BASENAME        "stdout.txt"
706 #define LOG_ERR_BASENAME        "stderr.txt"
707
708 #define LOG_OUT_ID              0
709 #define LOG_ERR_ID              1
710 #define NUM_LOGS                2
711
712 #define STRING_PARENT_DIRECTORY         ".."
713 #define STRING_TOP_DIRECTORY            "/"
714
715 #define CHAR_PATH_SEPARATOR_UNIX        '/'
716 #define CHAR_PATH_SEPARATOR_DOS         '\\'
717
718 #define STRING_PATH_SEPARATOR_UNIX      "/"
719 #define STRING_PATH_SEPARATOR_DOS       "\\"
720
721 #define STRING_NEWLINE_UNIX             "\n"
722 #define STRING_NEWLINE_DOS              "\r\n"
723
724 #if defined(PLATFORM_WIN32)
725 #define CHAR_PATH_SEPARATOR     CHAR_PATH_SEPARATOR_DOS
726 #define STRING_PATH_SEPARATOR   STRING_PATH_SEPARATOR_DOS
727 #define STRING_NEWLINE          STRING_NEWLINE_DOS
728 #else
729 #define CHAR_PATH_SEPARATOR     CHAR_PATH_SEPARATOR_UNIX
730 #define STRING_PATH_SEPARATOR   STRING_PATH_SEPARATOR_UNIX
731 #define STRING_NEWLINE          STRING_NEWLINE_UNIX
732 #endif
733
734
735 // areas in bitmap PIX_DOOR
736 // meaning in PIX_DB_DOOR: (3 PAGEs)
737 // PAGEX1: 1. buffer for DOOR_1
738 // PAGEX2: 2. buffer for DOOR_1
739 // PAGEX3: buffer for animations
740
741 // these values are hard-coded to be able to use them in initialization
742 #define DOOR_GFX_PAGE_WIDTH     100     // should be set to "gfx.dxsize"
743 #define DOOR_GFX_PAGE_HEIGHT    280     // should be set to "gfx.dysize"
744
745 #define DOOR_GFX_PAGESIZE       (DOOR_GFX_PAGE_WIDTH)
746 #define DOOR_GFX_PAGEX1         (0 * DOOR_GFX_PAGESIZE)
747 #define DOOR_GFX_PAGEX2         (1 * DOOR_GFX_PAGESIZE)
748 #define DOOR_GFX_PAGEX3         (2 * DOOR_GFX_PAGESIZE)
749 #define DOOR_GFX_PAGEX4         (3 * DOOR_GFX_PAGESIZE)
750 #define DOOR_GFX_PAGEX5         (4 * DOOR_GFX_PAGESIZE)
751 #define DOOR_GFX_PAGEX6         (5 * DOOR_GFX_PAGESIZE)
752 #define DOOR_GFX_PAGEX7         (6 * DOOR_GFX_PAGESIZE)
753 #define DOOR_GFX_PAGEX8         (7 * DOOR_GFX_PAGESIZE)
754 #define DOOR_GFX_PAGEY1         (0)
755 #define DOOR_GFX_PAGEY2         (DOOR_GFX_PAGE_HEIGHT)
756
757
758 // macros for version handling
759 #define VERSION_PART_1(x)       ((x) / 1000000)
760 #define VERSION_PART_2(x)       (((x) % 1000000) / 10000)
761 #define VERSION_PART_3(x)       (((x) % 10000) / 100)
762 #define VERSION_PART_4(x)       ((x) % 100)
763
764 #define VERSION_SUPER(x)        VERSION_PART_1(x)
765 #define VERSION_MAJOR(x)        VERSION_PART_2(x)
766 #define VERSION_MINOR(x)        VERSION_PART_3(x)
767 #define VERSION_PATCH(x)        VERSION_PART_4(x)
768 #define VERSION_IDENT(a,b,c,d)  ((a) * 1000000 + (b) * 10000 + (c) * 100 + (d))
769
770
771 // macros for parent/child process identification
772 #if defined(PLATFORM_UNIX)
773 #define IS_PARENT_PROCESS()     (audio.mixer_pid != getpid())
774 #define IS_CHILD_PROCESS()      (audio.mixer_pid == getpid())
775 #define HAS_CHILD_PROCESS()     (audio.mixer_pid > 0)
776 #else
777 #define IS_PARENT_PROCESS()     TRUE
778 #define IS_CHILD_PROCESS()      FALSE
779 #define HAS_CHILD_PROCESS()     FALSE
780 #endif
781
782
783 // values for artwork type
784 #define ARTWORK_TYPE_GRAPHICS   0
785 #define ARTWORK_TYPE_SOUNDS     1
786 #define ARTWORK_TYPE_MUSIC      2
787
788 #define NUM_ARTWORK_TYPES       3
789
790
791 // values for tree type (chosen to match artwork type)
792 #define TREE_TYPE_UNDEFINED     -1
793 #define TREE_TYPE_GRAPHICS_DIR  ARTWORK_TYPE_GRAPHICS
794 #define TREE_TYPE_SOUNDS_DIR    ARTWORK_TYPE_SOUNDS
795 #define TREE_TYPE_MUSIC_DIR     ARTWORK_TYPE_MUSIC
796 #define TREE_TYPE_LEVEL_DIR     3
797 #define TREE_TYPE_LEVEL_NR      4
798 #define TREE_TYPE_PLAYER_NAME   5
799 #define TREE_TYPE_SCORE_ENTRY   6
800
801 #define NUM_BASE_TREE_TYPES     4
802 #define NUM_TREE_TYPES          7
803
804 #define TREE_TYPE_IS_DIR(type)  ((type) == TREE_TYPE_GRAPHICS_DIR ||    \
805                                  (type) == TREE_TYPE_SOUNDS_DIR ||      \
806                                  (type) == TREE_TYPE_MUSIC_DIR ||       \
807                                  (type) == TREE_TYPE_LEVEL_DIR)
808
809 #define INFOTEXT_UNDEFINED      ""
810 #define INFOTEXT_GRAPHICS_DIR   "Custom Graphics"
811 #define INFOTEXT_SOUNDS_DIR     "Custom Sounds"
812 #define INFOTEXT_MUSIC_DIR      "Custom Music"
813 #define INFOTEXT_LEVEL_DIR      "Level Sets"
814 #define INFOTEXT_LEVEL_NR       "Levels"
815 #define INFOTEXT_PLAYER_NAME    "Players & Teams"
816 #define INFOTEXT_SCORE_ENTRY    "Hall of Fame"
817
818 #define BACKLINK_TEXT_MAIN      ".. (main menu)"
819 #define BACKLINK_TEXT_SETUP     ".. (setup menu)"
820 #define BACKLINK_TEXT_PARENT    ".. (parent directory)"
821 #define BACKLINK_TEXT_SCORES    "back"
822
823 #define TREE_INFOTEXT(t)        ((t) == TREE_TYPE_SCORE_ENTRY ?         \
824                                  INFOTEXT_SCORE_ENTRY :                 \
825                                  (t) == TREE_TYPE_PLAYER_NAME ?         \
826                                  INFOTEXT_PLAYER_NAME :                 \
827                                  (t) == TREE_TYPE_LEVEL_NR ?            \
828                                  INFOTEXT_LEVEL_NR :                    \
829                                  (t) == TREE_TYPE_LEVEL_DIR ?           \
830                                  INFOTEXT_LEVEL_DIR :                   \
831                                  (t) == TREE_TYPE_GRAPHICS_DIR ?        \
832                                  INFOTEXT_GRAPHICS_DIR :                \
833                                  (t) == TREE_TYPE_SOUNDS_DIR ?          \
834                                  INFOTEXT_SOUNDS_DIR :                  \
835                                  (t) == TREE_TYPE_MUSIC_DIR ?           \
836                                  INFOTEXT_MUSIC_DIR :                   \
837                                  INFOTEXT_UNDEFINED)
838
839 #define TREE_BACKLINK_TEXT(t)   ((t) == TREE_TYPE_SCORE_ENTRY ?         \
840                                  BACKLINK_TEXT_SCORES :                 \
841                                  (t) == TREE_TYPE_LEVEL_DIR ?           \
842                                  BACKLINK_TEXT_MAIN :                   \
843                                  BACKLINK_TEXT_SETUP)
844
845 #define TREE_USERDIR(t)         ((t) == TREE_TYPE_LEVEL_DIR ?           \
846                                  getUserLevelDir(NULL) :                \
847                                  (t) == TREE_TYPE_GRAPHICS_DIR ?        \
848                                  getUserGraphicsDir() :                 \
849                                  (t) == TREE_TYPE_SOUNDS_DIR ?          \
850                                  getUserSoundsDir() :                   \
851                                  (t) == TREE_TYPE_MUSIC_DIR ?           \
852                                  getUserMusicDir() :                    \
853                                  NULL)
854
855 #define TREE_FIRST_NODE_PTR(t)  ((t) == TREE_TYPE_LEVEL_DIR ?           \
856                                  &leveldir_first :                      \
857                                  (t) == TREE_TYPE_GRAPHICS_DIR ?        \
858                                  &artwork.gfx_first :                   \
859                                  (t) == TREE_TYPE_SOUNDS_DIR ?          \
860                                  &artwork.snd_first :                   \
861                                  (t) == TREE_TYPE_MUSIC_DIR ?           \
862                                  &artwork.mus_first :                   \
863                                  NULL)
864
865 #define TREE_FIRST_NODE(t)      ((t) == TREE_TYPE_LEVEL_DIR ?           \
866                                  leveldir_first :                       \
867                                  (t) == TREE_TYPE_GRAPHICS_DIR ?        \
868                                  artwork.gfx_first :                    \
869                                  (t) == TREE_TYPE_SOUNDS_DIR ?          \
870                                  artwork.snd_first :                    \
871                                  (t) == TREE_TYPE_MUSIC_DIR ?           \
872                                  artwork.mus_first :                    \
873                                  NULL)
874
875 // values for artwork handling
876 #define LEVELDIR_ARTWORK_SET_PTR(leveldir, type)                        \
877                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
878                                  &(leveldir)->graphics_set :            \
879                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
880                                  &(leveldir)->sounds_set :              \
881                                  &(leveldir)->music_set)
882
883 #define LEVELDIR_ARTWORK_SET(leveldir, type)                            \
884                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
885                                  (leveldir)->graphics_set :             \
886                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
887                                  (leveldir)->sounds_set :               \
888                                  (leveldir)->music_set)
889
890 #define LEVELDIR_ARTWORK_PATH_PTR(leveldir, type)                       \
891                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
892                                  &(leveldir)->graphics_path :           \
893                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
894                                  &(leveldir)->sounds_path :             \
895                                  &(leveldir)->music_path)
896
897 #define LEVELDIR_ARTWORK_PATH(leveldir, type)                           \
898                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
899                                  (leveldir)->graphics_path :            \
900                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
901                                  (leveldir)->sounds_path :              \
902                                  (leveldir)->music_path)
903
904 #define SETUP_ARTWORK_SET(setup, type)                                  \
905                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
906                                  (setup).graphics_set :                 \
907                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
908                                  (setup).sounds_set :                   \
909                                  (setup).music_set)
910
911 #define SETUP_OVERRIDE_ARTWORK(setup, type)                             \
912                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
913                                  (setup).override_level_graphics :      \
914                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
915                                  (setup).override_level_sounds :        \
916                                  (setup).override_level_music)
917
918 #define GFX_OVERRIDE_ARTWORK(type)                                      \
919                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
920                                  gfx.override_level_graphics :          \
921                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
922                                  gfx.override_level_sounds :            \
923                                  gfx.override_level_music)
924
925 #define ARTWORK_FIRST_NODE(artwork, type)                               \
926                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
927                                  (artwork).gfx_first :                  \
928                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
929                                  (artwork).snd_first :                  \
930                                  (artwork).mus_first)
931
932 #define ARTWORK_CURRENT_PTR(artwork, type)                              \
933                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
934                                  &(artwork).gfx_current :               \
935                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
936                                  &(artwork).snd_current :               \
937                                  &(artwork).mus_current)
938
939 #define ARTWORK_CURRENT(artwork, type)                                  \
940                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
941                                  (artwork).gfx_current :                \
942                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
943                                  (artwork).snd_current :                \
944                                  (artwork).mus_current)
945
946 #define ARTWORK_CURRENT_IDENTIFIER_PTR(artwork, type)                   \
947                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
948                                  &(artwork).gfx_current_identifier :    \
949                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
950                                  &(artwork).snd_current_identifier :    \
951                                  &(artwork).mus_current_identifier)
952
953 #define ARTWORK_CURRENT_IDENTIFIER(artwork, type)                       \
954                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
955                                  (artwork).gfx_current_identifier :     \
956                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
957                                  (artwork).snd_current_identifier :     \
958                                  (artwork).mus_current_identifier)
959
960 #define ARTWORKINFO_FILENAME(type)                                      \
961                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
962                                  GRAPHICSINFO_FILENAME :                \
963                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
964                                  SOUNDSINFO_FILENAME :                  \
965                                  (type) == ARTWORK_TYPE_MUSIC ?         \
966                                  MUSICINFO_FILENAME : "")
967
968 #define ARTWORK_DIRECTORY(type)                                         \
969                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
970                                  GRAPHICS_DIRECTORY :                   \
971                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
972                                  SOUNDS_DIRECTORY :                     \
973                                  (type) == ARTWORK_TYPE_MUSIC ?         \
974                                  MUSIC_DIRECTORY : "")
975
976 #define OPTIONS_ARTWORK_DIRECTORY(type)                                 \
977                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
978                                  options.graphics_directory :           \
979                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
980                                  options.sounds_directory :             \
981                                  (type) == ARTWORK_TYPE_MUSIC ?         \
982                                  options.music_directory : "")
983
984 #define USER_ARTWORK_DIRECTORY(type)                                    \
985                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
986                                  getUserGraphicsDir() :                 \
987                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
988                                  getUserSoundsDir() :                   \
989                                  (type) == ARTWORK_TYPE_MUSIC ?         \
990                                  getUserMusicDir() : "")
991
992 #define ARTWORK_DEFAULT_SUBDIR(type)                                    \
993                                 ((type) == ARTWORK_TYPE_GRAPHICS ?      \
994                                  GFX_DEFAULT_SUBDIR :                   \
995                                  (type) == ARTWORK_TYPE_SOUNDS ?        \
996                                  SND_DEFAULT_SUBDIR :                   \
997                                  MUS_DEFAULT_SUBDIR)
998
999 #define UPDATE_BUSY_STATE()                     \
1000 {                                               \
1001   if (gfx.draw_busy_anim_function != NULL)      \
1002     gfx.draw_busy_anim_function(TRUE);          \
1003 }
1004 #define UPDATE_BUSY_STATE_NOT_LOADING()         \
1005 {                                               \
1006   if (gfx.draw_busy_anim_function != NULL)      \
1007     gfx.draw_busy_anim_function(FALSE);         \
1008 }
1009
1010
1011 // structure definitions
1012
1013 struct ProgramInfo
1014 {
1015   char *command_basepath;       // path to the program binary
1016   char *command_basename;       // base filename of the program binary
1017
1018   char *config_filename;        // optional global program config filename
1019
1020   char *maindata_path;          // main game data (installation) directory
1021
1022   char *userdata_subdir;        // personal user game data directory
1023   char *userdata_path;          // resulting full path to game data directory
1024
1025   char *program_title;
1026   char *window_title;
1027   char *icon_title;
1028
1029   char *icon_filename;
1030
1031   char *cookie_prefix;
1032
1033   char *log_filename[NUM_LOGS];         // log filenames for out/err messages
1034   FILE *log_file[NUM_LOGS];             // log file handles for out/err files
1035   FILE *log_file_default[NUM_LOGS];     // default log file handles (out/err)
1036
1037   int version_super;
1038   int version_major;
1039   int version_minor;
1040   int version_patch;
1041   int version_ident;
1042
1043   char *version_string;
1044
1045   char *(*window_title_function)(void);
1046   void (*exit_message_function)(char *, va_list);
1047   void (*exit_function)(int);
1048
1049   int api_thread_count;
1050
1051   boolean headless;
1052 };
1053
1054 struct NetworkInfo
1055 {
1056   boolean enabled;
1057   boolean connected;
1058   boolean serveronly;
1059
1060   char *server_host;
1061   int server_port;
1062
1063   SDL_Thread *server_thread;
1064   boolean is_server_thread;
1065 };
1066
1067 struct RuntimeInfo
1068 {
1069   boolean uses_touch_device;
1070
1071   boolean use_api_server;
1072 };
1073
1074 struct OptionInfo
1075 {
1076   char *server_host;
1077   int server_port;
1078
1079   char *base_directory;
1080   char *level_directory;
1081   char *graphics_directory;
1082   char *sounds_directory;
1083   char *music_directory;
1084   char *docs_directory;
1085   char *conf_directory;
1086
1087   char *execute_command;
1088   char *tape_log_filename;
1089
1090   char *special_flags;
1091   char *debug_mode;
1092
1093   char *player_name;
1094   char *identifier;
1095   char *level_nr;
1096
1097   boolean mytapes;
1098   boolean serveronly;
1099   boolean network;
1100   boolean verbose;
1101   boolean debug;
1102 };
1103
1104 struct VideoSystemInfo
1105 {
1106   int default_depth;
1107   int width, height, depth;
1108   int window_width, window_height;
1109   int display_width, display_height;
1110   int screen_width, screen_height;
1111   int screen_xoffset, screen_yoffset;
1112
1113   boolean fullscreen_available;
1114   boolean fullscreen_enabled;
1115   boolean fullscreen_initial;
1116
1117   boolean window_scaling_available;
1118   int window_scaling_percent;
1119   char *window_scaling_quality;
1120   int screen_rendering_mode;
1121   int vsync_mode;
1122
1123   unsigned int frame_counter;
1124   unsigned int frame_delay;
1125   unsigned int frame_delay_value;
1126
1127   boolean shifted_up;
1128   int shifted_up_pos;
1129   int shifted_up_pos_last;
1130   unsigned int shifted_up_delay;
1131   unsigned int shifted_up_delay_value;
1132
1133   boolean initialized;
1134 };
1135
1136 struct AudioSystemInfo
1137 {
1138   boolean sound_available;
1139   boolean loops_available;
1140   boolean music_available;
1141
1142   boolean sound_enabled;
1143   boolean sound_deactivated;    // for temporarily disabling sound
1144
1145   int mixer_pipe[2];
1146   int mixer_pid;
1147   char *device_name;
1148   int device_fd;
1149
1150   int num_channels;
1151   int music_channel;
1152   int first_sound_channel;
1153 };
1154
1155 struct FontBitmapInfo
1156 {
1157   Bitmap *bitmap;
1158
1159   int src_x, src_y;             // start position of font characters
1160   int width, height;            // width / height of font characters
1161
1162   int offset_x;                 // offset to next font character
1163   int offset_y;                 // offset to next font character
1164
1165   int draw_xoffset;             // offset for drawing font characters
1166   int draw_yoffset;             // offset for drawing font characters
1167
1168   int num_chars;
1169   int num_chars_per_line;
1170 };
1171
1172 struct GfxInfo
1173 {
1174   int sx, sy;
1175   int sxsize, sysize;
1176   int real_sx, real_sy;
1177   int full_sxsize, full_sysize;
1178   int scrollbuffer_width, scrollbuffer_height;
1179
1180   int game_tile_size, standard_tile_size;
1181
1182   int dx, dy;
1183   int dxsize, dysize;
1184
1185   int vx, vy;
1186   int vxsize, vysize;
1187
1188   int ex, ey;
1189   int exsize, eysize;
1190
1191   int win_xsize, win_ysize;
1192
1193   int draw_deactivation_mask;
1194   int draw_background_mask;
1195
1196   Bitmap *field_save_buffer;
1197
1198   Bitmap *background_bitmap;
1199   int background_bitmap_mask;
1200
1201   Bitmap *fade_bitmap_backup;
1202   Bitmap *fade_bitmap_source;
1203   Bitmap *fade_bitmap_target;
1204   Bitmap *fade_bitmap_black;
1205
1206   int fade_border_source_status;
1207   int fade_border_target_status;
1208   Bitmap *masked_border_bitmap_ptr;
1209
1210   Bitmap *final_screen_bitmap;
1211
1212   boolean clipping_enabled;
1213   int clip_x, clip_y;
1214   int clip_width, clip_height;
1215
1216   boolean override_level_graphics;
1217   boolean override_level_sounds;
1218   boolean override_level_music;
1219
1220   boolean draw_init_text;
1221
1222   int num_fonts;
1223   struct FontBitmapInfo *font_bitmap_info;
1224   int (*select_font_function)(int);
1225   int (*get_font_from_token_function)(char *);
1226
1227   int anim_random_frame;
1228
1229   void (*draw_busy_anim_function)(boolean);
1230   void (*draw_global_anim_function)(int, int);
1231   void (*draw_global_border_function)(int);
1232   void (*draw_tile_cursor_function)(int);
1233
1234   int cursor_mode;
1235   int cursor_mode_override;
1236   int cursor_mode_final;
1237   int mouse_x, mouse_y;
1238 };
1239
1240 struct TileCursorInfo
1241 {
1242   boolean enabled;              // tile cursor generally enabled or disabled
1243   boolean active;               // tile cursor activated (depending on game)
1244   boolean moving;               // tile cursor moving to target position
1245
1246   int xpos, ypos;               // tile cursor level playfield position
1247   int x, y;                     // tile cursor current screen position
1248   int target_x, target_y;       // tile cursor target screen position
1249
1250   int sx, sy;                   // tile cursor screen start position
1251
1252   boolean xsn_debug;            // enable or disable XSN debugging
1253 };
1254
1255 struct OverlayInfo
1256 {
1257   boolean enabled;              // overlay generally enabled or disabled
1258   boolean active;               // overlay activated (depending on game mode)
1259
1260   boolean show_grid;
1261
1262   int grid_xsize;
1263   int grid_ysize;
1264
1265   char grid_button[MAX_GRID_XSIZE][MAX_GRID_YSIZE];
1266   char grid_button_highlight;
1267
1268   int grid_button_action;
1269 };
1270
1271 struct JoystickInfo
1272 {
1273   int status;
1274   int nr[MAX_PLAYERS];          // joystick number for each player
1275 };
1276
1277 struct SetupJoystickInfo
1278 {
1279   char *device_name;            // device name of player's joystick
1280
1281   int xleft, xmiddle, xright;
1282   int yupper, ymiddle, ylower;
1283   int snap, drop;
1284 };
1285
1286 struct SetupKeyboardInfo
1287 {
1288   Key left, right, up, down;
1289   Key snap, drop;
1290 };
1291
1292 struct SetupTouchInfo
1293 {
1294   char *control_type;
1295   int move_distance;
1296   int drop_distance;
1297
1298   int grid_xsize[2];
1299   int grid_ysize[2];
1300
1301   char grid_button[2][MAX_GRID_XSIZE][MAX_GRID_YSIZE];
1302
1303   int transparency;             // in percent (0 == opaque, 100 == invisible)
1304   boolean draw_outlined;
1305   boolean draw_pressed;
1306
1307   boolean grid_initialized;
1308 };
1309
1310 struct SetupInputInfo
1311 {
1312   boolean use_joystick;
1313   struct SetupJoystickInfo joy;
1314   struct SetupKeyboardInfo key;
1315 };
1316
1317 struct SetupEditorInfo
1318 {
1319   boolean el_boulderdash;
1320   boolean el_emerald_mine;
1321   boolean el_emerald_mine_club;
1322   boolean el_more;
1323   boolean el_sokoban;
1324   boolean el_supaplex;
1325   boolean el_diamond_caves;
1326   boolean el_dx_boulderdash;
1327
1328   boolean el_mirror_magic;
1329   boolean el_deflektor;
1330
1331   boolean el_chars;
1332   boolean el_steel_chars;
1333
1334   boolean el_classic;
1335   boolean el_custom;
1336   boolean el_user_defined;
1337   boolean el_dynamic;
1338
1339   boolean el_headlines;
1340
1341   boolean el_by_game;
1342   boolean el_by_type;
1343
1344   boolean show_element_token;
1345
1346   boolean show_read_only_warning;
1347
1348   boolean use_template_for_new_levels;
1349 };
1350
1351 struct SetupAutoSetupInfo
1352 {
1353   int editor_zoom_tilesize;
1354 };
1355
1356 struct SetupLevelSetupInfo
1357 {
1358   char *last_level_series[MAX_LEVELDIR_HISTORY + 1];
1359 };
1360
1361 struct SetupEditorCascadeInfo
1362 {
1363   boolean el_bd;
1364   boolean el_em;
1365   boolean el_emc;
1366   boolean el_rnd;
1367   boolean el_sb;
1368   boolean el_sp;
1369   boolean el_dc;
1370   boolean el_dx;
1371   boolean el_mm;
1372   boolean el_df;
1373   boolean el_chars;
1374   boolean el_steel_chars;
1375   boolean el_ce;
1376   boolean el_ge;
1377   boolean el_es;
1378   boolean el_ref;
1379   boolean el_user;
1380   boolean el_dynamic;
1381 };
1382
1383 struct SetupShortcutInfo
1384 {
1385   Key save_game;
1386   Key load_game;
1387   Key restart_game;
1388   Key pause_before_end;
1389   Key toggle_pause;
1390
1391   Key focus_player[MAX_PLAYERS];
1392   Key focus_player_all;
1393
1394   Key tape_eject;
1395   Key tape_extra;
1396   Key tape_stop;
1397   Key tape_pause;
1398   Key tape_record;
1399   Key tape_play;
1400
1401   Key sound_simple;
1402   Key sound_loops;
1403   Key sound_music;
1404
1405   Key snap_left;
1406   Key snap_right;
1407   Key snap_up;
1408   Key snap_down;
1409 };
1410
1411 struct SetupSystemInfo
1412 {
1413   char *sdl_renderdriver;
1414   char *sdl_videodriver;
1415   char *sdl_audiodriver;
1416   int audio_fragment_size;
1417 };
1418
1419 struct SetupInternalInfo
1420 {
1421   char *program_title;
1422   char *program_version;
1423   char *program_author;
1424   char *program_email;
1425   char *program_website;
1426   char *program_copyright;
1427   char *program_company;
1428
1429   char *program_icon_file;
1430
1431   char *default_graphics_set;
1432   char *default_sounds_set;
1433   char *default_music_set;
1434
1435   char *fallback_graphics_file;
1436   char *fallback_sounds_file;
1437   char *fallback_music_file;
1438
1439   char *default_level_series;
1440
1441   int default_window_width;
1442   int default_window_height;
1443
1444   boolean choose_from_top_leveldir;
1445   boolean show_scaling_in_title;
1446   boolean create_user_levelset;
1447
1448   boolean menu_game;
1449   boolean menu_engines;
1450   boolean menu_editor;
1451   boolean menu_graphics;
1452   boolean menu_sound;
1453   boolean menu_artwork;
1454   boolean menu_input;
1455   boolean menu_touch;
1456   boolean menu_shortcuts;
1457   boolean menu_exit;
1458   boolean menu_save_and_exit;
1459
1460   boolean info_title;
1461   boolean info_elements;
1462   boolean info_music;
1463   boolean info_credits;
1464   boolean info_program;
1465   boolean info_version;
1466   boolean info_levelset;
1467   boolean info_exit;
1468 };
1469
1470 struct SetupDebugInfo
1471 {
1472   int frame_delay[10];
1473   Key frame_delay_key[10];
1474   boolean frame_delay_use_mod_key;
1475   boolean frame_delay_game_only;
1476   boolean show_frames_per_second;
1477   int xsn_mode;
1478   int xsn_percent;
1479 };
1480
1481 struct SetupInfo
1482 {
1483   char *player_name;
1484   char *player_uuid;
1485   int player_version;
1486
1487   boolean multiple_users;
1488
1489   boolean sound;
1490   boolean sound_loops;
1491   boolean sound_music;
1492   boolean sound_simple;
1493   boolean toons;
1494   boolean scroll_delay;
1495   boolean forced_scroll_delay;
1496   int scroll_delay_value;
1497   char *engine_snapshot_mode;
1498   int engine_snapshot_memory;
1499   boolean fade_screens;
1500   boolean autorecord;
1501   boolean auto_pause_on_start;
1502   boolean show_titlescreen;
1503   boolean quick_doors;
1504   boolean team_mode;
1505   boolean handicap;
1506   boolean skip_levels;
1507   boolean increment_levels;
1508   boolean auto_play_next_level;
1509   boolean count_score_after_game;
1510   boolean show_scores_after_game;
1511   boolean time_limit;
1512   boolean fullscreen;
1513   int window_scaling_percent;
1514   char *window_scaling_quality;
1515   char *screen_rendering_mode;
1516   char *vsync_mode;
1517   boolean ask_on_escape;
1518   boolean ask_on_escape_editor;
1519   boolean ask_on_game_over;
1520   boolean ask_on_quit_game;
1521   boolean ask_on_quit_program;
1522   boolean quick_switch;
1523   boolean input_on_focus;
1524   boolean prefer_aga_graphics;
1525   boolean prefer_lowpass_sounds;
1526   boolean prefer_extra_panel_items;
1527   boolean game_speed_extended;
1528   int game_frame_delay;
1529   boolean sp_show_border_elements;
1530   boolean small_game_graphics;
1531   boolean show_load_save_buttons;
1532   boolean show_undo_redo_buttons;
1533   char *scores_in_highscore_list;
1534
1535   char *graphics_set;
1536   char *sounds_set;
1537   char *music_set;
1538   int override_level_graphics;          // not boolean -- can also be "AUTO"
1539   int override_level_sounds;            // not boolean -- can also be "AUTO"
1540   int override_level_music;             // not boolean -- can also be "AUTO"
1541
1542   int volume_simple;
1543   int volume_loops;
1544   int volume_music;
1545
1546   boolean network_mode;
1547   int network_player_nr;
1548   char *network_server_hostname;
1549
1550   boolean use_api_server;
1551   char *api_server_hostname;
1552   char *api_server_password;
1553   boolean ask_for_uploading_tapes;
1554   boolean ask_for_remaining_tapes;
1555   boolean provide_uploading_tapes;
1556   boolean ask_for_using_api_server;
1557   boolean has_remaining_tapes;
1558
1559   struct SetupAutoSetupInfo auto_setup;
1560   struct SetupLevelSetupInfo level_setup;
1561
1562   struct SetupEditorInfo editor;
1563   struct SetupEditorCascadeInfo editor_cascade;
1564   struct SetupShortcutInfo shortcut;
1565   struct SetupInputInfo input[MAX_PLAYERS];
1566   struct SetupTouchInfo touch;
1567   struct SetupSystemInfo system;
1568   struct SetupInternalInfo internal;
1569   struct SetupDebugInfo debug;
1570
1571   struct OptionInfo options;
1572 };
1573
1574 struct UserInfo
1575 {
1576   int nr;
1577 };
1578
1579 struct TreeInfo
1580 {
1581   struct TreeInfo **node_top;           // topmost node in tree
1582   struct TreeInfo *node_parent;         // parent level directory info
1583   struct TreeInfo *node_group;          // level group sub-directory info
1584   struct TreeInfo *next;                // next level series structure node
1585
1586   int cl_first;         // internal control field for setup screen
1587   int cl_cursor;        // internal control field for setup screen
1588
1589   int type;             // type of tree content
1590
1591   // fields for "type == TREE_TYPE_LEVEL_DIR"
1592
1593   char *subdir;         // tree info sub-directory basename (may be ".")
1594   char *fullpath;       // complete path relative to tree base directory
1595   char *basepath;       // absolute base path of tree base directory
1596   char *identifier;     // identifier string for configuration files
1597   char *name;           // tree info name, as displayed in selection menues
1598   char *name_sorting;   // optional sorting name for correct name sorting
1599   char *author;         // level or artwork author name
1600   char *year;           // optional year of creation for levels or artwork
1601
1602   char *program_title;     // optional alternative text for program title
1603   char *program_copyright; // optional alternative text for program copyright
1604   char *program_company;   // optional alternative text for program company
1605
1606   char *imported_from;  // optional comment for imported levels or artwork
1607   char *imported_by;    // optional comment for imported levels or artwork
1608   char *tested_by;      // optional comment to name people who tested a set
1609
1610   char *graphics_set_ecs; // special EMC custom graphics set (ECS graphics)
1611   char *graphics_set_aga; // special EMC custom graphics set (AGA graphics)
1612   char *graphics_set;   // optional custom graphics set (level tree only)
1613   char *sounds_set_default; // default EMC custom sounds set
1614   char *sounds_set_lowpass; // special EMC custom sounds set (lowpass filter)
1615   char *sounds_set;     // optional custom sounds set (level tree only)
1616   char *music_set;      // optional custom music set (level tree only)
1617   char *graphics_path;  // path to optional custom graphics set (level only)
1618   char *sounds_path;    // path to optional custom sounds set (level only)
1619   char *music_path;     // path to optional custom music set (level only)
1620
1621   char *level_filename; // filename of level file (for packed level file)
1622   char *level_filetype; // type of levels in level directory or level file
1623
1624   char *special_flags;  // flags for special actions performed on level file
1625
1626   int levels;           // number of levels in level series
1627   int first_level;      // first level number (to allow start with 0 or 1)
1628   int last_level;       // last level number (automatically calculated)
1629   int sort_priority;    // sort levels by 'sort_priority' and then by name
1630   int pos;              // custom position information of node in tree
1631
1632   boolean latest_engine;// force level set to use the latest game engine
1633
1634   boolean level_group;  // directory contains more level series directories
1635   boolean parent_link;  // entry links back to parent directory
1636   boolean is_copy;      // this entry is a copy of another entry in the tree
1637   boolean in_user_dir;  // user defined levels are stored in home directory
1638   boolean user_defined; // levels in user directory and marked as "private"
1639   boolean readonly;     // readonly levels can not be changed with editor
1640   boolean handicap;     // level set has no handicap when set to "false"
1641   boolean skip_levels;  // levels can be skipped when set to "true"
1642
1643   boolean use_emc_tiles;// use (swapped) V5/V6 EMC tiles when set to "true"
1644
1645   int color;            // color to use on selection screen for this level
1646   char *class_desc;     // description of level series class
1647   int handicap_level;   // number of the lowest unsolved level
1648
1649   char *infotext;       // optional text to describe the tree type (headline)
1650 };
1651
1652 typedef struct TreeInfo TreeInfo;
1653 typedef struct TreeInfo LevelDirTree;
1654 typedef struct TreeInfo ArtworkDirTree;
1655 typedef struct TreeInfo GraphicsDirTree;
1656 typedef struct TreeInfo SoundsDirTree;
1657 typedef struct TreeInfo MusicDirTree;
1658
1659 struct ArtworkInfo
1660 {
1661   GraphicsDirTree *gfx_first;
1662   GraphicsDirTree *gfx_current;
1663   SoundsDirTree *snd_first;
1664   SoundsDirTree *snd_current;
1665   MusicDirTree *mus_first;
1666   MusicDirTree *mus_current;
1667
1668   char *gfx_current_identifier;
1669   char *snd_current_identifier;
1670   char *mus_current_identifier;
1671 };
1672
1673 struct ValueTextInfo
1674 {
1675   int value;
1676   char *text;
1677 };
1678
1679 struct StringValueTextInfo
1680 {
1681   char *value;
1682   char *text;
1683 };
1684
1685 struct ConfigInfo
1686 {
1687   char *token;
1688   char *value;
1689 };
1690
1691 struct ConfigTypeInfo
1692 {
1693   char *token;
1694   char *value;
1695   int type;
1696 };
1697
1698 struct TokenIntPtrInfo
1699 {
1700   char *token;
1701   int *value;
1702 };
1703
1704 struct FileInfo
1705 {
1706   char *token;
1707
1708   char *default_filename;
1709   char *filename;
1710
1711   char **default_parameter;                     // array of file parameters
1712   char **parameter;                             // array of file parameters
1713
1714   boolean redefined;
1715   boolean fallback_to_default;
1716   boolean default_is_cloned;
1717 };
1718
1719 struct SetupFileList
1720 {
1721   char *token;
1722   char *value;
1723
1724   struct SetupFileList *next;
1725 };
1726
1727 struct ListNodeInfo
1728 {
1729   char *source_filename;                        // primary key for node list
1730   int num_references;
1731 };
1732
1733 struct PropertyMapping
1734 {
1735   int base_index;
1736   int ext1_index;
1737   int ext2_index;
1738   int ext3_index;
1739
1740   int artwork_index;
1741 };
1742
1743 struct ArtworkListInfo
1744 {
1745   int type;                                     // type of artwork
1746
1747   int num_file_list_entries;
1748   int num_dynamic_file_list_entries;
1749   struct FileInfo *file_list;                   // static artwork file array
1750   struct FileInfo *dynamic_file_list;           // dynamic artwrk file array
1751
1752   int num_suffix_list_entries;
1753   struct ConfigTypeInfo *suffix_list;           // parameter suffixes array
1754
1755   int num_base_prefixes;
1756   int num_ext1_suffixes;
1757   int num_ext2_suffixes;
1758   int num_ext3_suffixes;
1759   char **base_prefixes;                         // base token prefixes array
1760   char **ext1_suffixes;                         // property suffixes array 1
1761   char **ext2_suffixes;                         // property suffixes array 2
1762   char **ext3_suffixes;                         // property suffixes array 3
1763
1764   int num_ignore_tokens;
1765   char **ignore_tokens;                         // file tokens to be ignored
1766
1767   int num_property_mapping_entries;
1768   struct PropertyMapping *property_mapping;     // mapping token -> artwork
1769
1770   int sizeof_artwork_list_entry;
1771
1772   struct ListNodeInfo **artwork_list;           // static artwork node array
1773   struct ListNodeInfo **dynamic_artwork_list;   // dynamic artwrk node array
1774   struct ListNode *content_list;                // dynamic artwork node list
1775
1776   void *(*load_artwork)(char *);                // constructor function
1777   void (*free_artwork)(void *);                 // destructor function
1778 };
1779
1780 struct XY
1781 {
1782   int x, y;
1783 };
1784
1785 struct XYTileSize
1786 {
1787   int x, y;
1788   int tile_size;
1789 };
1790
1791 struct Rect
1792 {
1793   int x, y;
1794   int width, height;
1795 };
1796
1797 struct RectWithBorder
1798 {
1799   int x, y;
1800   int width, height;
1801   int min_width, min_height;
1802   int max_width, max_height;
1803   int margin_left;
1804   int margin_right;
1805   int margin_top;
1806   int margin_bottom;
1807   int border_left;
1808   int border_right;
1809   int border_top;
1810   int border_bottom;
1811   int border_size;
1812   int align_size;
1813   int align, valign;
1814 };
1815
1816 struct MenuPosInfo
1817 {
1818   int x, y;
1819   int width, height;
1820   int align, valign;
1821 };
1822
1823 struct DoorPartPosInfo
1824 {
1825   int x, y;
1826   int step_xoffset;
1827   int step_yoffset;
1828   int step_delay;
1829   int start_step;
1830   int start_step_opening;
1831   int start_step_closing;
1832   boolean draw_masked;
1833   int sort_priority;
1834 };
1835
1836 struct TextPosInfo
1837 {
1838   int x, y;
1839   int xoffset;                  // special case for tape date and time
1840   int xoffset2;                 // special case for tape date
1841   int yoffset;                  // special case for list of preview players
1842   int width, height;
1843   int align, valign;
1844   int size;                     // also used for suffix ".digits"
1845   int font, font_alt;
1846   boolean draw_masked;
1847   boolean draw_player;          // special case for network player buttons
1848   int sort_priority;            // also used for suffix ".draw_order"
1849   int id;
1850
1851   int direction;                // needed for panel time/health graphics
1852   int class;                    // needed for panel time/health graphics
1853   int style;                    // needed for panel time/health graphics
1854
1855   int tile_size;                // special case for list of network players
1856   int border_size;              // special case for list of preview players
1857   int vertical;                 // special case for list of preview players
1858
1859   boolean redefined;            // redefined by custom artwork
1860 };
1861
1862 struct MouseActionInfo
1863 {
1864   int lx, ly;
1865   int button;
1866   int button_hint;
1867 };
1868
1869 struct LevelSetInfo
1870 {
1871   int music[MAX_LEVELS];
1872
1873   char *identifier;
1874   int level_nr;
1875 };
1876
1877 struct LevelStats
1878 {
1879   int played;
1880   int solved;
1881 };
1882
1883
1884 // ============================================================================
1885 // exported variables
1886 // ============================================================================
1887
1888 extern struct ProgramInfo       program;
1889 extern struct NetworkInfo       network;
1890 extern struct RuntimeInfo       runtime;
1891 extern struct OptionInfo        options;
1892 extern struct VideoSystemInfo   video;
1893 extern struct AudioSystemInfo   audio;
1894 extern struct GfxInfo           gfx;
1895 extern struct TileCursorInfo    tile_cursor;
1896 extern struct OverlayInfo       overlay;
1897 extern struct AnimInfo          anim;
1898 extern struct ArtworkInfo       artwork;
1899 extern struct JoystickInfo      joystick;
1900 extern struct SetupInfo         setup;
1901 extern struct UserInfo          user;
1902
1903 extern LevelDirTree            *leveldir_first_all;
1904 extern LevelDirTree            *leveldir_first;
1905 extern LevelDirTree            *leveldir_current;
1906 extern int                      level_nr;
1907
1908 extern struct LevelSetInfo      levelset;
1909 extern struct LevelStats        level_stats[];
1910
1911 extern DrawWindow              *window;
1912 extern DrawBuffer              *backbuffer;
1913 extern DrawBuffer              *drawto;
1914
1915 extern int                      button_status;
1916 extern boolean                  motion_status;
1917 extern int                      wheel_steps;
1918 extern boolean                  keyrepeat_status;
1919 extern boolean                  textinput_status;
1920
1921 extern int                      redraw_mask;
1922
1923 extern int                      FrameCounter;
1924
1925
1926 // function definitions
1927
1928 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
1929                      char *, int);
1930 void InitNetworkInfo(boolean, boolean, boolean, char *, int);
1931 void InitRuntimeInfo(void);
1932
1933 void SetWindowTitle(void);
1934
1935 void InitWindowTitleFunction(char *(*window_title_function)(void));
1936 void InitExitMessageFunction(void (*exit_message_function)(char *, va_list));
1937 void InitExitFunction(void (*exit_function)(int));
1938 void InitPlatformDependentStuff(void);
1939 void ClosePlatformDependentStuff(void);
1940
1941 void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
1942 void InitGfxTileSizeInfo(int, int);
1943 void InitGfxDoor1Info(int, int, int, int);
1944 void InitGfxDoor2Info(int, int, int, int);
1945 void InitGfxDoor3Info(int, int, int, int);
1946 void InitGfxWindowInfo(int, int);
1947 void InitGfxScrollbufferInfo(int, int);
1948 void InitGfxClipRegion(boolean, int, int, int, int);
1949 void InitGfxDrawBusyAnimFunction(void (*draw_busy_anim_function)(boolean));
1950 void InitGfxDrawGlobalAnimFunction(void (*draw_global_anim_function)(int, int));
1951 void InitGfxDrawGlobalBorderFunction(void (*draw_global_border_function)(int));
1952 void InitGfxDrawTileCursorFunction(void (*draw_tile_cursor_function)(int));
1953 void InitGfxCustomArtworkInfo(void);
1954 void InitGfxOtherSettings(void);
1955 void InitTileCursorInfo(void);
1956 void InitOverlayInfo(void);
1957 void SetOverlayGridSizeAndButtons(void);
1958 void SetTileCursorEnabled(boolean);
1959 void SetTileCursorActive(boolean);
1960 void SetTileCursorTargetXY(int, int);
1961 void SetTileCursorXY(int, int);
1962 void SetTileCursorSXSY(int, int);
1963 void SetOverlayEnabled(boolean);
1964 void SetOverlayActive(boolean);
1965 void SetOverlayShowGrid(boolean);
1966 boolean GetOverlayEnabled(void);
1967 boolean GetOverlayActive(void);
1968 void SetDrawDeactivationMask(int);
1969 int GetDrawDeactivationMask(void);
1970 void SetDrawBackgroundMask(int);
1971 void SetWindowBackgroundBitmap(Bitmap *);
1972 void SetMainBackgroundBitmap(Bitmap *);
1973 void SetDoorBackgroundBitmap(Bitmap *);
1974 void SetRedrawMaskFromArea(int, int, int, int);
1975
1976 void LimitScreenUpdates(boolean);
1977
1978 void InitVideoDefaults(void);
1979 void InitVideoDisplay(void);
1980 void CloseVideoDisplay(void);
1981 void InitVideoBuffer(int, int, int, boolean);
1982 Bitmap *CreateBitmapStruct(void);
1983 Bitmap *CreateBitmap(int, int, int);
1984 void ReCreateBitmap(Bitmap **, int, int);
1985 void FreeBitmap(Bitmap *);
1986 void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
1987 void BlitBitmapTiled(Bitmap *, Bitmap *, int, int, int, int, int, int, int,int);
1988 void FadeRectangle(int, int, int, int, int, int, int,
1989                    void (*draw_border_function)(void));
1990 void FillRectangle(Bitmap *, int, int, int, int, Pixel);
1991 void ClearRectangle(Bitmap *, int, int, int, int);
1992 void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
1993 void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
1994 boolean DrawingDeactivatedField(void);
1995 boolean DrawingDeactivated(int, int, int, int);
1996 boolean DrawingOnBackground(int, int);
1997 boolean DrawingAreaChanged(void);
1998 void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int, int);
1999 void BlitTexture(Bitmap *, int, int, int, int, int, int);
2000 void BlitTextureMasked(Bitmap *, int, int, int, int, int, int);
2001 void BlitToScreen(Bitmap *, int, int, int, int, int, int);
2002 void BlitToScreenMasked(Bitmap *, int, int, int, int, int, int);
2003 void DrawSimpleBlackLine(Bitmap *, int, int, int, int);
2004 void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
2005 void DrawLines(Bitmap *, struct XY *, int, Pixel);
2006 Pixel GetPixel(Bitmap *, int, int);
2007 Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
2008 Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
2009
2010 void KeyboardAutoRepeatOn(void);
2011 void KeyboardAutoRepeatOff(void);
2012 boolean SetVideoMode(boolean);
2013 void SetVideoFrameDelay(unsigned int);
2014 unsigned int GetVideoFrameDelay(void);
2015 boolean ChangeVideoModeIfNeeded(boolean);
2016
2017 Bitmap *LoadImage(char *);
2018 Bitmap *LoadCustomImage(char *);
2019 void ReloadCustomImage(Bitmap *, char *);
2020
2021 Bitmap *ZoomBitmap(Bitmap *, int, int);
2022 void ReCreateGameTileSizeBitmap(Bitmap **);
2023 void CreateBitmapWithSmallBitmaps(Bitmap **, int, int);
2024 void CreateBitmapTextures(Bitmap **);
2025 void FreeBitmapTextures(Bitmap **);
2026 void ScaleBitmap(Bitmap **, int);
2027
2028 void SetMouseCursor(int);
2029 void UpdateRawMousePosition(int, int);
2030 void UpdateMousePosition(void);
2031
2032 void OpenAudio(void);
2033 void CloseAudio(void);
2034 void SetAudioMode(boolean);
2035
2036 void InitEventFilter(EventFilter);
2037 boolean PendingEvent(void);
2038 void WaitEvent(Event *event);
2039 void PeekEvent(Event *event);
2040 void PumpEvents(void);
2041 void CheckQuitEvent(void);
2042 Key GetEventKey(KeyEvent *, boolean);
2043 KeyMod HandleKeyModState(Key, int);
2044 KeyMod GetKeyModState(void);
2045 KeyMod GetKeyModStateFromEvents(void);
2046 void StartTextInput(int, int, int, int);
2047 void StopTextInput(void);
2048 void PushUserEvent(int, int, int);
2049 boolean PendingEscapeKeyEvent(void);
2050
2051 void InitJoysticks(void);
2052 boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
2053 boolean CheckJoystickOpened(int);
2054 void ClearJoystickState(void);
2055
2056 void InitEmscriptenFilesystem(void);
2057 void SyncEmscriptenFilesystem(void);
2058
2059 #endif // SYSTEM_H