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