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