1 // ============================================================================
2 // Artsoft Retro-Game Library
3 // ----------------------------------------------------------------------------
4 // (c) 1995-2014 by Artsoft Entertainment
7 // http://www.artsoft.org/
8 // ----------------------------------------------------------------------------
10 // ============================================================================
19 #if defined(PLATFORM_MACOSX)
21 #elif defined(PLATFORM_WIN32)
23 #elif defined(PLATFORM_ANDROID)
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"
35 #define DEFAULT_DEPTH 0
39 #define BLIT_INVERSE 2
40 #define BLIT_ON_BACKGROUND 3
42 /* values for fullscreen status */
43 #define FULLSCREEN_NOT_AVAILABLE FALSE
44 #define FULLSCREEN_AVAILABLE TRUE
46 /* values for window scaling */
47 #define WINDOW_SCALING_NOT_AVAILABLE FALSE
48 #define WINDOW_SCALING_AVAILABLE TRUE
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
55 /* values for window scaling quality */
56 #define SCALING_QUALITY_NEAREST "nearest"
57 #define SCALING_QUALITY_LINEAR "linear"
58 #define SCALING_QUALITY_BEST "best"
60 #define SCALING_QUALITY_DEFAULT SCALING_QUALITY_LINEAR
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"
68 #if defined(TARGET_SDL2)
69 #define STR_SPECIAL_RENDERING_DEFAULT STR_SPECIAL_RENDERING_DOUBLE
71 #define STR_SPECIAL_RENDERING_DEFAULT STR_SPECIAL_RENDERING_BITMAP
74 #define SPECIAL_RENDERING_OFF 0
75 #define SPECIAL_RENDERING_BITMAP 1
76 #define SPECIAL_RENDERING_TARGET 2
77 #define SPECIAL_RENDERING_DOUBLE 3
79 #if defined(TARGET_SDL2)
80 #define SPECIAL_RENDERING_DEFAULT SPECIAL_RENDERING_DOUBLE
82 #define SPECIAL_RENDERING_DEFAULT SPECIAL_RENDERING_BITMAP
85 /* values for vertical screen retrace synchronization (vsync) */
86 #define STR_VSYNC_MODE_OFF "off"
87 #define STR_VSYNC_MODE_NORMAL "normal"
88 #define STR_VSYNC_MODE_ADAPTIVE "adaptive"
90 #define STR_VSYNC_MODE_DEFAULT STR_VSYNC_MODE_OFF
92 #define VSYNC_MODE_OFF 0
93 #define VSYNC_MODE_NORMAL 1
94 #define VSYNC_MODE_ADAPTIVE -1
96 #define VSYNC_MODE_DEFAULT VSYNC_MODE_OFF
98 /* values for network server settings */
99 #define STR_NETWORK_AUTO_DETECT "auto_detect_network_server"
100 #define STR_NETWORK_AUTO_DETECT_SETUP "(auto detect network server)"
102 /* values for touch control */
103 #define TOUCH_CONTROL_OFF "off"
104 #define TOUCH_CONTROL_VIRTUAL_BUTTONS "virtual_buttons"
105 #define TOUCH_CONTROL_WIPE_GESTURES "wipe_gestures"
106 #define TOUCH_CONTROL_FOLLOW_FINGER "follow_finger"
108 #if defined(PLATFORM_ANDROID)
109 #define TOUCH_CONTROL_DEFAULT TOUCH_CONTROL_VIRTUAL_BUTTONS
111 #define TOUCH_CONTROL_DEFAULT TOUCH_CONTROL_OFF
114 #define TOUCH_MOVE_DISTANCE_DEFAULT 2
115 #define TOUCH_DROP_DISTANCE_DEFAULT 5
116 #define TOUCH_TRANSPARENCY_DEFAULT 50
118 #define ALPHA_FROM_TRANSPARENCY(x) ((100 - x) * SDL_ALPHA_OPAQUE / 100)
119 #define ALPHA_FADING_STEPSIZE(x) ((x) / 25)
121 /* values for special settings for mobile devices */
122 #if defined(PLATFORM_ANDROID)
123 #define USE_TOUCH_INPUT_OVERLAY
124 #define USE_COMPLETE_DISPLAY
125 #define HAS_SCREEN_KEYBOARD
126 #define SCREEN_KEYBOARD_POS(h) ((h) / 2)
129 /* default input keys */
130 #define DEFAULT_KEY_LEFT KSYM_Left
131 #define DEFAULT_KEY_RIGHT KSYM_Right
132 #define DEFAULT_KEY_UP KSYM_Up
133 #define DEFAULT_KEY_DOWN KSYM_Down
134 #if defined(PLATFORM_MACOSX)
135 #define DEFAULT_KEY_SNAP KSYM_Control_L
136 #define DEFAULT_KEY_DROP KSYM_KP_Enter
138 #define DEFAULT_KEY_SNAP KSYM_Control_L
139 #define DEFAULT_KEY_DROP KSYM_Control_R
141 #define DEFAULT_KEY_OKAY KSYM_Return
142 #define DEFAULT_KEY_CANCEL KSYM_Escape
144 /* default shortcut keys */
145 #define DEFAULT_KEY_SAVE_GAME KSYM_F1
146 #define DEFAULT_KEY_LOAD_GAME KSYM_F2
147 #define DEFAULT_KEY_TOGGLE_PAUSE KSYM_space
148 #define DEFAULT_KEY_FOCUS_PLAYER_1 KSYM_F5
149 #define DEFAULT_KEY_FOCUS_PLAYER_2 KSYM_F6
150 #define DEFAULT_KEY_FOCUS_PLAYER_3 KSYM_F7
151 #define DEFAULT_KEY_FOCUS_PLAYER_4 KSYM_F8
152 #define DEFAULT_KEY_FOCUS_PLAYER_ALL KSYM_F9
153 #define DEFAULT_KEY_TAPE_EJECT KSYM_UNDEFINED
154 #define DEFAULT_KEY_TAPE_EXTRA KSYM_UNDEFINED
155 #define DEFAULT_KEY_TAPE_STOP KSYM_UNDEFINED
156 #define DEFAULT_KEY_TAPE_PAUSE KSYM_UNDEFINED
157 #define DEFAULT_KEY_TAPE_RECORD KSYM_UNDEFINED
158 #define DEFAULT_KEY_TAPE_PLAY KSYM_UNDEFINED
159 #define DEFAULT_KEY_SOUND_SIMPLE KSYM_UNDEFINED
160 #define DEFAULT_KEY_SOUND_LOOPS KSYM_UNDEFINED
161 #define DEFAULT_KEY_SOUND_MUSIC KSYM_UNDEFINED
162 #define DEFAULT_KEY_SNAP_LEFT KSYM_UNDEFINED
163 #define DEFAULT_KEY_SNAP_RIGHT KSYM_UNDEFINED
164 #define DEFAULT_KEY_SNAP_UP KSYM_UNDEFINED
165 #define DEFAULT_KEY_SNAP_DOWN KSYM_UNDEFINED
167 /* default debug setup keys and values */
168 #define DEFAULT_FRAME_DELAY_0 20 // 100 % speed
169 #define DEFAULT_FRAME_DELAY_1 500 // 4 % speed
170 #define DEFAULT_FRAME_DELAY_2 250 // 8 % speed
171 #define DEFAULT_FRAME_DELAY_3 125 // 16 % speed
172 #define DEFAULT_FRAME_DELAY_4 60 // 33 % speed
173 #define DEFAULT_FRAME_DELAY_5 40 // 50 % speed
174 #define DEFAULT_FRAME_DELAY_6 30 // 66 % speed
175 #define DEFAULT_FRAME_DELAY_7 10 // 200 % speed
176 #define DEFAULT_FRAME_DELAY_8 5 // 400 % speed
177 #define DEFAULT_FRAME_DELAY_9 0 // maximum speed
179 #define DEFAULT_KEY_FRAME_DELAY_0 KSYM_0
180 #define DEFAULT_KEY_FRAME_DELAY_1 KSYM_1
181 #define DEFAULT_KEY_FRAME_DELAY_2 KSYM_2
182 #define DEFAULT_KEY_FRAME_DELAY_3 KSYM_3
183 #define DEFAULT_KEY_FRAME_DELAY_4 KSYM_4
184 #define DEFAULT_KEY_FRAME_DELAY_5 KSYM_5
185 #define DEFAULT_KEY_FRAME_DELAY_6 KSYM_6
186 #define DEFAULT_KEY_FRAME_DELAY_7 KSYM_7
187 #define DEFAULT_KEY_FRAME_DELAY_8 KSYM_8
188 #define DEFAULT_KEY_FRAME_DELAY_9 KSYM_9
190 #define NUM_DEBUG_FRAME_DELAY_KEYS 10
192 #define DEFAULT_FRAME_DELAY_USE_MOD_KEY FALSE
193 #define DEFAULT_FRAME_DELAY_GAME_ONLY TRUE
195 /* values for key_status */
196 #define KEY_NOT_PRESSED FALSE
197 #define KEY_RELEASED FALSE
198 #define KEY_PRESSED TRUE
200 /* values for button status */
201 #define MB_NOT_PRESSED FALSE
202 #define MB_NOT_RELEASED TRUE
203 #define MB_RELEASED FALSE
204 #define MB_PRESSED TRUE
205 #define MB_MENU_CHOICE FALSE
206 #define MB_MENU_MARK TRUE
207 #define MB_MENU_INITIALIZE (-1)
208 #define MB_MENU_LEAVE (-2)
209 #define MB_LEFTBUTTON 1
210 #define MB_MIDDLEBUTTON 2
211 #define MB_RIGHTBUTTON 3
212 #define MB_WHEEL_UP 4
213 #define MB_WHEEL_DOWN 5
214 #define MB_WHEEL_LEFT 6
215 #define MB_WHEEL_RIGHT 7
216 #define IS_WHEEL_BUTTON_VERTICAL(b) ((b) == MB_WHEEL_UP || \
217 (b) == MB_WHEEL_DOWN)
218 #define IS_WHEEL_BUTTON_HORIZONTAL(b) ((b) == MB_WHEEL_LEFT || \
219 (b) == MB_WHEEL_RIGHT)
220 #define IS_WHEEL_BUTTON(b) (IS_WHEEL_BUTTON_VERTICAL(b) || \
221 IS_WHEEL_BUTTON_HORIZONTAL(b))
222 #define DEFAULT_WHEEL_STEPS 3
224 #define BUTTON_STEPSIZE(b) ((b) == MB_LEFTBUTTON ? 1 : \
225 (b) == MB_MIDDLEBUTTON ? 5 : \
226 (b) == MB_RIGHTBUTTON ? 10 : 1)
228 /* values for move directions */
229 #define MV_BIT_LEFT 0
230 #define MV_BIT_RIGHT 1
232 #define MV_BIT_DOWN 3
234 #define NUM_DIRECTIONS 4
236 /* diagonal movement directions are used in a different contect than buttons */
237 #define MV_BIT_UPLEFT 4
238 #define MV_BIT_UPRIGHT 5
239 #define MV_BIT_DOWNLEFT 6
240 #define MV_BIT_DOWNRIGHT 7
242 #define NUM_DIRECTIONS_FULL 8
244 /* values for special "button" bitmasks */
248 #define NUM_PLAYER_ACTIONS 6
250 /* values for special "focus player" bitmasks */
251 #define BIT_SET_FOCUS 6
253 /* values for drawing stages for global animations */
254 #define DRAW_GLOBAL_ANIM_STAGE_1 1
255 #define DRAW_GLOBAL_ANIM_STAGE_2 2
257 /* values for drawing target (various functions) */
258 #define DRAW_TO_BACKBUFFER 0
259 #define DRAW_TO_FIELDBUFFER 1
260 #define DRAW_TO_SCREEN 2
261 #define DRAW_TO_FADE_SOURCE 3
262 #define DRAW_TO_FADE_TARGET 4
264 /* values for move directions and special "button" key bitmasks */
266 #define MV_LEFT (1 << MV_BIT_LEFT)
267 #define MV_RIGHT (1 << MV_BIT_RIGHT)
268 #define MV_UP (1 << MV_BIT_UP)
269 #define MV_DOWN (1 << MV_BIT_DOWN)
271 #define MV_UPLEFT (MV_UP | MV_LEFT)
272 #define MV_UPRIGHT (MV_UP | MV_RIGHT)
273 #define MV_DOWNLEFT (MV_DOWN | MV_LEFT)
274 #define MV_DOWNRIGHT (MV_DOWN | MV_RIGHT)
276 #define MV_HORIZONTAL (MV_LEFT | MV_RIGHT)
277 #define MV_VERTICAL (MV_UP | MV_DOWN)
278 #define MV_ALL_DIRECTIONS (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
279 #define MV_ANY_DIRECTION (MV_ALL_DIRECTIONS)
280 #define MV_NO_DIRECTION (MV_NONE)
282 #define KEY_BUTTON_1 (1 << BUTTON_1)
283 #define KEY_BUTTON_2 (1 << BUTTON_2)
284 #define KEY_BUTTON_SNAP KEY_BUTTON_1
285 #define KEY_BUTTON_DROP KEY_BUTTON_2
286 #define KEY_MOTION (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
287 #define KEY_BUTTON (KEY_BUTTON_1 | KEY_BUTTON_2)
288 #define KEY_ACTION (KEY_MOTION | KEY_BUTTON)
290 #define KEY_SET_FOCUS (1 << BIT_SET_FOCUS)
292 #define MV_DIR_FROM_BIT(x) ((x) < NUM_DIRECTIONS ? 1 << (x) : \
293 (x) == MV_BIT_UPLEFT ? MV_UPLEFT : \
294 (x) == MV_BIT_UPRIGHT ? MV_UPRIGHT : \
295 (x) == MV_BIT_DOWNLEFT ? MV_DOWNLEFT : \
296 (x) == MV_BIT_DOWNRIGHT ? MV_DOWNRIGHT : \
299 #define MV_DIR_TO_BIT(x) ((x) == MV_LEFT ? MV_BIT_LEFT : \
300 (x) == MV_RIGHT ? MV_BIT_RIGHT : \
301 (x) == MV_UP ? MV_BIT_UP : \
302 (x) == MV_DOWN ? MV_BIT_DOWN : \
303 (x) == MV_UPLEFT ? MV_BIT_UPLEFT : \
304 (x) == MV_UPRIGHT ? MV_BIT_UPRIGHT : \
305 (x) == MV_DOWNLEFT ? MV_BIT_DOWNLEFT : \
306 (x) == MV_DOWNRIGHT ? MV_BIT_DOWNRIGHT : \
309 #define MV_DIR_OPPOSITE(x) ((x) == MV_LEFT ? MV_RIGHT : \
310 (x) == MV_RIGHT ? MV_LEFT : \
311 (x) == MV_UP ? MV_DOWN : \
312 (x) == MV_DOWN ? MV_UP : \
313 (x) == MV_UPLEFT ? MV_DOWNRIGHT : \
314 (x) == MV_UPRIGHT ? MV_DOWNLEFT : \
315 (x) == MV_DOWNLEFT ? MV_UPRIGHT : \
316 (x) == MV_DOWNRIGHT ? MV_UPLEFT : \
319 /* values for animation mode (frame order and direction) */
320 /* (stored in level files -- never change existing values) */
322 #define ANIM_LOOP (1 << 0)
323 #define ANIM_LINEAR (1 << 1)
324 #define ANIM_PINGPONG (1 << 2)
325 #define ANIM_PINGPONG2 (1 << 3)
326 #define ANIM_RANDOM (1 << 4)
327 #define ANIM_CE_VALUE (1 << 5)
328 #define ANIM_CE_SCORE (1 << 6)
329 #define ANIM_CE_DELAY (1 << 7)
330 #define ANIM_REVERSE (1 << 8)
331 #define ANIM_OPAQUE_PLAYER (1 << 9)
333 /* values for special (non game element) animation modes */
334 /* (not stored in level files -- can be changed, if needed) */
335 #define ANIM_HORIZONTAL (1 << 10)
336 #define ANIM_VERTICAL (1 << 11)
337 #define ANIM_CENTERED (1 << 12)
338 #define ANIM_STATIC_PANEL (1 << 13)
339 #define ANIM_ALL (1 << 14)
340 #define ANIM_ONCE (1 << 15)
342 #define ANIM_DEFAULT ANIM_LOOP
344 /* values for special drawing styles (currently only for crumbled graphics) */
346 #define STYLE_ACCURATE_BORDERS (1 << 0)
347 #define STYLE_INNER_CORNERS (1 << 1)
348 #define STYLE_REVERSE (1 << 2)
350 /* values for special event handling style (used for global animation) */
351 #define STYLE_PASSTHROUGH (1 << 3)
352 #define STYLE_MULTIPLE_ACTIONS (1 << 4)
354 #define STYLE_DEFAULT STYLE_NONE
356 /* values for special global animation events */
357 #define ANIM_EVENT_NONE 0
358 #define ANIM_EVENT_SELF (1 << 16)
359 #define ANIM_EVENT_ANY (1 << 17)
361 #define ANIM_EVENT_ANIM_BIT 0
362 #define ANIM_EVENT_PART_BIT 8
364 #define ANIM_EVENT_ANIM_MASK (0xff << ANIM_EVENT_ANIM_BIT)
365 #define ANIM_EVENT_PART_MASK (0xff << ANIM_EVENT_PART_BIT)
367 #define ANIM_EVENT_DEFAULT ANIM_EVENT_NONE
369 /* values for special global animation event actions */
370 #define ANIM_EVENT_ACTION_NONE -1
372 /* values for fade mode */
373 #define FADE_TYPE_NONE 0
374 #define FADE_TYPE_FADE_IN (1 << 0)
375 #define FADE_TYPE_FADE_OUT (1 << 1)
376 #define FADE_TYPE_TRANSFORM (1 << 2)
377 #define FADE_TYPE_CROSSFADE (1 << 3)
378 #define FADE_TYPE_MELT (1 << 4)
379 #define FADE_TYPE_CURTAIN (1 << 5)
380 #define FADE_TYPE_SKIP (1 << 6)
382 #define FADE_MODE_NONE (FADE_TYPE_NONE)
383 #define FADE_MODE_FADE_IN (FADE_TYPE_FADE_IN)
384 #define FADE_MODE_FADE_OUT (FADE_TYPE_FADE_OUT)
385 #define FADE_MODE_FADE (FADE_TYPE_FADE_IN | FADE_TYPE_FADE_OUT)
386 #define FADE_MODE_TRANSFORM (FADE_TYPE_TRANSFORM | FADE_TYPE_FADE_IN)
387 #define FADE_MODE_CROSSFADE (FADE_MODE_TRANSFORM | FADE_TYPE_CROSSFADE)
388 #define FADE_MODE_MELT (FADE_MODE_TRANSFORM | FADE_TYPE_MELT)
389 #define FADE_MODE_CURTAIN (FADE_MODE_TRANSFORM | FADE_TYPE_CURTAIN)
390 #define FADE_MODE_SKIP_FADE_IN (FADE_TYPE_SKIP | FADE_TYPE_FADE_IN)
391 #define FADE_MODE_SKIP_FADE_OUT (FADE_TYPE_SKIP | FADE_TYPE_FADE_OUT)
393 #define FADE_MODE_DEFAULT FADE_MODE_FADE
395 /* values for toon positions */
396 #define POS_UNDEFINED -1
407 /* values for text alignment */
408 #define ALIGN_LEFT (1 << 0)
409 #define ALIGN_RIGHT (1 << 1)
410 #define ALIGN_CENTER (1 << 2)
411 #define ALIGN_DEFAULT ALIGN_LEFT
413 #define VALIGN_TOP (1 << 0)
414 #define VALIGN_BOTTOM (1 << 1)
415 #define VALIGN_MIDDLE (1 << 2)
416 #define VALIGN_DEFAULT VALIGN_TOP
418 #define ALIGNED_XPOS(x,w,a) ((a) == ALIGN_CENTER ? (x) - (w) / 2 : \
419 (a) == ALIGN_RIGHT ? (x) - (w) : (x))
420 #define ALIGNED_YPOS(y,h,v) ((v) == VALIGN_MIDDLE ? (y) - (h) / 2 : \
421 (v) == VALIGN_BOTTOM ? (y) - (h) : (y))
422 #define ALIGNED_TEXT_XPOS(p) ALIGNED_XPOS((p)->x, (p)->width, (p)->align)
423 #define ALIGNED_TEXT_YPOS(p) ALIGNED_YPOS((p)->y, (p)->height, (p)->valign)
425 /* values for redraw_mask */
426 #define REDRAW_NONE (0)
427 #define REDRAW_ALL (1 << 0)
428 #define REDRAW_FIELD (1 << 1)
429 #define REDRAW_DOOR_1 (1 << 2)
430 #define REDRAW_DOOR_2 (1 << 3)
431 #define REDRAW_DOOR_3 (1 << 4)
432 #define REDRAW_FPS (1 << 5)
434 #define REDRAW_DOORS (REDRAW_DOOR_1 | \
438 #define IN_GFX_FIELD_PLAY(x, y) (x >= gfx.sx && x < gfx.sx + gfx.sxsize && \
439 y >= gfx.sy && y < gfx.sy + gfx.sysize)
440 #define IN_GFX_FIELD_FULL(x, y) (x >= gfx.real_sx && \
441 x < gfx.real_sx + gfx.full_sxsize && \
442 y >= gfx.real_sy && \
443 y < gfx.real_sy + gfx.full_sysize)
444 #define IN_GFX_DOOR_1(x, y) (x >= gfx.dx && x < gfx.dx + gfx.dxsize && \
445 y >= gfx.dy && y < gfx.dy + gfx.dysize)
446 #define IN_GFX_DOOR_2(x, y) (x >= gfx.vx && x < gfx.vx + gfx.vxsize && \
447 y >= gfx.vy && y < gfx.vy + gfx.vysize)
448 #define IN_GFX_DOOR_3(x, y) (x >= gfx.ex && x < gfx.ex + gfx.exsize && \
449 y >= gfx.ey && y < gfx.ey + gfx.eysize)
451 /* values for mouse cursor */
452 #define CURSOR_DEFAULT 0
453 #define CURSOR_NONE 1
454 #define CURSOR_PLAYFIELD 2
456 /* fundamental game speed values */
457 #define ONE_SECOND_DELAY 1000 /* delay value for one second */
458 #define MENU_FRAME_DELAY 20 /* frame delay in milliseconds */
459 #define GAME_FRAME_DELAY 20 /* frame delay in milliseconds */
460 #define FFWD_FRAME_DELAY 10 /* 200% speed for fast forward */
461 #define MAX_VSYNC_FRAME_DELAY 16 /* maximum value for vsync to work */
462 #define FRAMES_PER_SECOND (ONE_SECOND_DELAY / GAME_FRAME_DELAY)
463 #define FRAMES_PER_SECOND_SP 35
465 /* maximum playfield size supported by libgame functions */
466 #define MAX_PLAYFIELD_WIDTH 128
467 #define MAX_PLAYFIELD_HEIGHT 128
469 /* maximum number of parallel players supported by libgame functions */
470 #define MAX_PLAYERS 4
472 /* maximum allowed length of player name */
473 #define MAX_PLAYER_NAME_LEN 10
475 /* maximum number of levels in a level set */
476 #define MAX_LEVELS 1000
478 /* maximum number of global animation and parts */
479 #define MAX_GLOBAL_ANIMS 32
480 #define MAX_GLOBAL_ANIM_PARTS 32
482 /* minimum/maximum/default x/y grid size for virtual buttons */
483 #define MIN_GRID_XSIZE 3
484 #define MIN_GRID_YSIZE 3
485 #define MAX_GRID_XSIZE 32
486 #define MAX_GRID_YSIZE 32
487 #define GRID_REAL_WIDTH MAX(1, MAX(video.screen_width, \
488 video.screen_height))
489 #define GRID_REAL_HEIGHT MAX(1, MIN(video.screen_width, \
490 video.screen_height))
491 #define DEFAULT_GRID_XSIZE_0 18
492 #define DEFAULT_GRID_YSIZE_0 MIN(MAX(MIN_GRID_YSIZE, \
493 DEFAULT_GRID_XSIZE_0 * \
497 #define DEFAULT_GRID_XSIZE_1 13
498 #define DEFAULT_GRID_YSIZE_1 MIN(MAX(MIN_GRID_YSIZE, \
499 DEFAULT_GRID_XSIZE_1 * \
504 #define DEFAULT_GRID_XSIZE(n) ((n) == 0 ? DEFAULT_GRID_XSIZE_0 : \
505 DEFAULT_GRID_XSIZE_1)
506 #define DEFAULT_GRID_YSIZE(n) ((n) == 0 ? DEFAULT_GRID_YSIZE_0 : \
507 DEFAULT_GRID_YSIZE_1)
509 #define GRID_ACTIVE_NR() (video.screen_width > \
510 video.screen_height ? 0 : 1)
512 /* values for grid button characters for virtual buttons */
513 #define CHAR_GRID_BUTTON_NONE ' '
514 #define CHAR_GRID_BUTTON_LEFT '<'
515 #define CHAR_GRID_BUTTON_RIGHT '>'
516 #define CHAR_GRID_BUTTON_UP '^'
517 #define CHAR_GRID_BUTTON_DOWN 'v'
518 #define CHAR_GRID_BUTTON_SNAP '1'
519 #define CHAR_GRID_BUTTON_DROP '2'
521 #define GET_ACTION_FROM_GRID_BUTTON(c) ((c) == CHAR_GRID_BUTTON_LEFT ? \
523 (c) == CHAR_GRID_BUTTON_RIGHT ? \
525 (c) == CHAR_GRID_BUTTON_UP ? \
527 (c) == CHAR_GRID_BUTTON_DOWN ? \
529 (c) == CHAR_GRID_BUTTON_SNAP ? \
531 (c) == CHAR_GRID_BUTTON_DROP ? \
535 /* default name for empty highscore entry */
536 #define EMPTY_PLAYER_NAME "no name"
538 /* default name for unknown player names */
539 #define ANONYMOUS_NAME "anonymous"
541 /* default for other unknown names */
542 #define UNKNOWN_NAME "unknown"
544 /* default name for new levels */
545 #define NAMELESS_LEVEL_NAME "nameless level"
547 /* default text for non-existant artwork */
548 #define NOT_AVAILABLE "(not available)"
550 /* default value for undefined filename */
551 #define UNDEFINED_FILENAME "[NONE]"
553 /* default value for undefined levelset */
554 #define UNDEFINED_LEVELSET "[NONE]"
556 /* default value for undefined parameter */
557 #define ARG_DEFAULT "[DEFAULT]"
559 /* default values for undefined configuration file parameters */
560 #define ARG_UNDEFINED "-1000000"
561 #define ARG_UNDEFINED_VALUE (-1000000)
563 /* default value for off-screen positions */
564 #define POS_OFFSCREEN (-1000000)
566 /* definitions for game sub-directories */
568 #define RO_GAME_DIR "."
572 #define RW_GAME_DIR "."
575 #define RO_BASE_PATH RO_GAME_DIR
576 #define RW_BASE_PATH RW_GAME_DIR
578 /* directory names */
579 #define GRAPHICS_DIRECTORY "graphics"
580 #define SOUNDS_DIRECTORY "sounds"
581 #define MUSIC_DIRECTORY "music"
582 #define LEVELS_DIRECTORY "levels"
583 #define TAPES_DIRECTORY "tapes"
584 #define SCORES_DIRECTORY "scores"
585 #define DOCS_DIRECTORY "docs"
586 #define CACHE_DIRECTORY "cache"
587 #define CONF_DIRECTORY "conf"
588 #define NETWORK_DIRECTORY "network"
590 #define GFX_CLASSIC_SUBDIR "gfx_classic"
591 #define SND_CLASSIC_SUBDIR "snd_classic"
592 #define MUS_CLASSIC_SUBDIR "mus_classic"
594 #define GFX_DEFAULT_SUBDIR (setup.internal.default_graphics_set)
595 #define SND_DEFAULT_SUBDIR (setup.internal.default_sounds_set)
596 #define MUS_DEFAULT_SUBDIR (setup.internal.default_music_set)
598 #define GFX_FALLBACK_FILENAME (setup.internal.fallback_graphics_file)
599 #define SND_FALLBACK_FILENAME (setup.internal.fallback_sounds_file)
600 #define MUS_FALLBACK_FILENAME (setup.internal.fallback_music_file)
602 #define DEFAULT_LEVELSET (setup.internal.default_level_series)
604 /* file names and filename extensions */
605 #define LEVELSETUP_DIRECTORY "levelsetup"
606 #define SETUP_FILENAME "setup.conf"
607 #define AUTOSETUP_FILENAME "autosetup.conf"
608 #define LEVELSETUP_FILENAME "levelsetup.conf"
609 #define EDITORSETUP_FILENAME "editorsetup.conf"
610 #define EDITORCASCADE_FILENAME "editorcascade.conf"
611 #define HELPANIM_FILENAME "helpanim.conf"
612 #define HELPTEXT_FILENAME "helptext.conf"
613 #define LEVELINFO_FILENAME "levelinfo.conf"
614 #define GRAPHICSINFO_FILENAME "graphicsinfo.conf"
615 #define SOUNDSINFO_FILENAME "soundsinfo.conf"
616 #define MUSICINFO_FILENAME "musicinfo.conf"
617 #define ARTWORKINFO_CACHE_FILE "artworkinfo.cache"
618 #define LEVELTEMPLATE_FILENAME "template.level"
619 #define LEVELFILE_EXTENSION "level"
620 #define TAPEFILE_EXTENSION "tape"
621 #define SCOREFILE_EXTENSION "score"
623 #define GAMECONTROLLER_BASENAME "gamecontrollerdb.txt"
625 #define LOG_OUT_BASENAME "stdout.txt"
626 #define LOG_ERR_BASENAME "stderr.txt"
632 #define STRING_PARENT_DIRECTORY ".."
633 #define STRING_TOP_DIRECTORY "/"
635 #define CHAR_PATH_SEPARATOR_UNIX '/'
636 #define CHAR_PATH_SEPARATOR_DOS '\\'
638 #define STRING_PATH_SEPARATOR_UNIX "/"
639 #define STRING_PATH_SEPARATOR_DOS "\\"
641 #define STRING_NEWLINE_UNIX "\n"
642 #define STRING_NEWLINE_DOS "\r\n"
644 #if defined(PLATFORM_WIN32)
645 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_DOS
646 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_DOS
647 #define STRING_NEWLINE STRING_NEWLINE_DOS
649 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_UNIX
650 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_UNIX
651 #define STRING_NEWLINE STRING_NEWLINE_UNIX
655 /* areas in bitmap PIX_DOOR */
656 /* meaning in PIX_DB_DOOR: (3 PAGEs)
657 PAGEX1: 1. buffer for DOOR_1
658 PAGEX2: 2. buffer for DOOR_1
659 PAGEX3: buffer for animations
662 /* these values are hard-coded to be able to use them in initialization */
663 #define DOOR_GFX_PAGE_WIDTH 100 /* should be set to "gfx.dxsize" */
664 #define DOOR_GFX_PAGE_HEIGHT 280 /* should be set to "gfx.dysize" */
666 #define DOOR_GFX_PAGESIZE (DOOR_GFX_PAGE_WIDTH)
667 #define DOOR_GFX_PAGEX1 (0 * DOOR_GFX_PAGESIZE)
668 #define DOOR_GFX_PAGEX2 (1 * DOOR_GFX_PAGESIZE)
669 #define DOOR_GFX_PAGEX3 (2 * DOOR_GFX_PAGESIZE)
670 #define DOOR_GFX_PAGEX4 (3 * DOOR_GFX_PAGESIZE)
671 #define DOOR_GFX_PAGEX5 (4 * DOOR_GFX_PAGESIZE)
672 #define DOOR_GFX_PAGEX6 (5 * DOOR_GFX_PAGESIZE)
673 #define DOOR_GFX_PAGEX7 (6 * DOOR_GFX_PAGESIZE)
674 #define DOOR_GFX_PAGEX8 (7 * DOOR_GFX_PAGESIZE)
675 #define DOOR_GFX_PAGEY1 (0)
676 #define DOOR_GFX_PAGEY2 (DOOR_GFX_PAGE_HEIGHT)
679 /* macros for version handling */
680 #define VERSION_PART_1(x) ((x) / 1000000)
681 #define VERSION_PART_2(x) (((x) % 1000000) / 10000)
682 #define VERSION_PART_3(x) (((x) % 10000) / 100)
683 #define VERSION_PART_4(x) ((x) % 100)
685 #define VERSION_SUPER(x) VERSION_PART_1(x)
686 #define VERSION_MAJOR(x) VERSION_PART_2(x)
687 #define VERSION_MINOR(x) VERSION_PART_3(x)
688 #define VERSION_PATCH(x) VERSION_PART_4(x)
689 #define VERSION_IDENT(a,b,c,d) ((a) * 1000000 + (b) * 10000 + (c) * 100 + (d))
692 /* macros for parent/child process identification */
693 #if defined(PLATFORM_UNIX)
694 #define IS_PARENT_PROCESS() (audio.mixer_pid != getpid())
695 #define IS_CHILD_PROCESS() (audio.mixer_pid == getpid())
696 #define HAS_CHILD_PROCESS() (audio.mixer_pid > 0)
698 #define IS_PARENT_PROCESS() TRUE
699 #define IS_CHILD_PROCESS() FALSE
700 #define HAS_CHILD_PROCESS() FALSE
704 /* values for artwork type */
705 #define ARTWORK_TYPE_GRAPHICS 0
706 #define ARTWORK_TYPE_SOUNDS 1
707 #define ARTWORK_TYPE_MUSIC 2
709 #define NUM_ARTWORK_TYPES 3
712 /* values for tree type (chosen to match artwork type) */
713 #define TREE_TYPE_UNDEFINED -1
714 #define TREE_TYPE_GRAPHICS_DIR ARTWORK_TYPE_GRAPHICS
715 #define TREE_TYPE_SOUNDS_DIR ARTWORK_TYPE_SOUNDS
716 #define TREE_TYPE_MUSIC_DIR ARTWORK_TYPE_MUSIC
717 #define TREE_TYPE_LEVEL_DIR 3
718 #define TREE_TYPE_LEVEL_NR 4
720 #define NUM_TREE_TYPES 5
722 #define INFOTEXT_UNDEFINED ""
723 #define INFOTEXT_GRAPHICS_DIR "Custom Graphics"
724 #define INFOTEXT_SOUNDS_DIR "Custom Sounds"
725 #define INFOTEXT_MUSIC_DIR "Custom Music"
726 #define INFOTEXT_LEVEL_DIR "Level Sets"
727 #define INFOTEXT_LEVEL_NR "Levels"
729 #define TREE_INFOTEXT(t) ((t) == TREE_TYPE_LEVEL_NR ? \
730 INFOTEXT_LEVEL_NR : \
731 (t) == TREE_TYPE_LEVEL_DIR ? \
732 INFOTEXT_LEVEL_DIR : \
733 (t) == TREE_TYPE_GRAPHICS_DIR ? \
734 INFOTEXT_GRAPHICS_DIR : \
735 (t) == TREE_TYPE_SOUNDS_DIR ? \
736 INFOTEXT_SOUNDS_DIR : \
737 (t) == TREE_TYPE_MUSIC_DIR ? \
738 INFOTEXT_MUSIC_DIR : \
741 /* values for artwork handling */
742 #define LEVELDIR_ARTWORK_SET_PTR(leveldir, type) \
743 ((type) == ARTWORK_TYPE_GRAPHICS ? \
744 &(leveldir)->graphics_set : \
745 (type) == ARTWORK_TYPE_SOUNDS ? \
746 &(leveldir)->sounds_set : \
747 &(leveldir)->music_set)
749 #define LEVELDIR_ARTWORK_SET(leveldir, type) \
750 ((type) == ARTWORK_TYPE_GRAPHICS ? \
751 (leveldir)->graphics_set : \
752 (type) == ARTWORK_TYPE_SOUNDS ? \
753 (leveldir)->sounds_set : \
754 (leveldir)->music_set)
756 #define LEVELDIR_ARTWORK_PATH_PTR(leveldir, type) \
757 ((type) == ARTWORK_TYPE_GRAPHICS ? \
758 &(leveldir)->graphics_path : \
759 (type) == ARTWORK_TYPE_SOUNDS ? \
760 &(leveldir)->sounds_path : \
761 &(leveldir)->music_path)
763 #define LEVELDIR_ARTWORK_PATH(leveldir, type) \
764 ((type) == ARTWORK_TYPE_GRAPHICS ? \
765 (leveldir)->graphics_path : \
766 (type) == ARTWORK_TYPE_SOUNDS ? \
767 (leveldir)->sounds_path : \
768 (leveldir)->music_path)
770 #define SETUP_ARTWORK_SET(setup, type) \
771 ((type) == ARTWORK_TYPE_GRAPHICS ? \
772 (setup).graphics_set : \
773 (type) == ARTWORK_TYPE_SOUNDS ? \
774 (setup).sounds_set : \
777 #define SETUP_OVERRIDE_ARTWORK(setup, type) \
778 ((type) == ARTWORK_TYPE_GRAPHICS ? \
779 (setup).override_level_graphics : \
780 (type) == ARTWORK_TYPE_SOUNDS ? \
781 (setup).override_level_sounds : \
782 (setup).override_level_music)
784 #define GFX_OVERRIDE_ARTWORK(type) \
785 ((type) == ARTWORK_TYPE_GRAPHICS ? \
786 gfx.override_level_graphics : \
787 (type) == ARTWORK_TYPE_SOUNDS ? \
788 gfx.override_level_sounds : \
789 gfx.override_level_music)
791 #define ARTWORK_FIRST_NODE(artwork, type) \
792 ((type) == ARTWORK_TYPE_GRAPHICS ? \
793 (artwork).gfx_first : \
794 (type) == ARTWORK_TYPE_SOUNDS ? \
795 (artwork).snd_first : \
798 #define ARTWORK_CURRENT_IDENTIFIER_PTR(artwork, type) \
799 ((type) == ARTWORK_TYPE_GRAPHICS ? \
800 &(artwork).gfx_current_identifier : \
801 (type) == ARTWORK_TYPE_SOUNDS ? \
802 &(artwork).snd_current_identifier : \
803 &(artwork).mus_current_identifier)
805 #define ARTWORK_CURRENT_IDENTIFIER(artwork, type) \
806 ((type) == ARTWORK_TYPE_GRAPHICS ? \
807 (artwork).gfx_current_identifier : \
808 (type) == ARTWORK_TYPE_SOUNDS ? \
809 (artwork).snd_current_identifier : \
810 (artwork).mus_current_identifier)
812 #define ARTWORKINFO_FILENAME(type) \
813 ((type) == ARTWORK_TYPE_GRAPHICS ? \
814 GRAPHICSINFO_FILENAME : \
815 (type) == ARTWORK_TYPE_SOUNDS ? \
816 SOUNDSINFO_FILENAME : \
817 (type) == ARTWORK_TYPE_MUSIC ? \
818 MUSICINFO_FILENAME : "")
820 #define ARTWORK_DIRECTORY(type) \
821 ((type) == ARTWORK_TYPE_GRAPHICS ? \
822 GRAPHICS_DIRECTORY : \
823 (type) == ARTWORK_TYPE_SOUNDS ? \
825 (type) == ARTWORK_TYPE_MUSIC ? \
826 MUSIC_DIRECTORY : "")
828 #define OPTIONS_ARTWORK_DIRECTORY(type) \
829 ((type) == ARTWORK_TYPE_GRAPHICS ? \
830 options.graphics_directory : \
831 (type) == ARTWORK_TYPE_SOUNDS ? \
832 options.sounds_directory : \
833 (type) == ARTWORK_TYPE_MUSIC ? \
834 options.music_directory : "")
836 #define UPDATE_BUSY_STATE() \
838 if (gfx.draw_busy_anim_function != NULL) \
839 gfx.draw_busy_anim_function(); \
843 /* structure definitions */
847 char *command_basepath; /* path to the program binary */
848 char *command_basename; /* base filename of the program binary */
850 char *config_filename; /* optional global program config filename */
852 char *maindata_path; /* main game data (installation) directory */
854 char *userdata_subdir; /* personal user game data directory */
855 char *userdata_path; /* resulting full path to game data directory */
865 char *log_filename[NUM_LOGS]; /* log filenames for out/err messages */
866 FILE *log_file[NUM_LOGS]; /* log file handles for out/err files */
867 FILE *log_file_default[NUM_LOGS]; /* default log file handles (out/err) */
875 char *version_string;
877 char *(*window_title_function)(void);
878 void (*exit_message_function)(char *, va_list);
879 void (*exit_function)(int);
881 boolean global_scores;
882 boolean many_scores_per_name;
903 char *ro_base_directory;
904 char *rw_base_directory;
905 char *level_directory;
906 char *graphics_directory;
907 char *sounds_directory;
908 char *music_directory;
909 char *docs_directory;
910 char *conf_directory;
912 char *execute_command;
923 struct VideoSystemInfo
926 int width, height, depth;
927 int window_width, window_height;
928 int display_width, display_height;
929 int screen_width, screen_height;
930 int screen_xoffset, screen_yoffset;
932 boolean fullscreen_available;
933 boolean fullscreen_enabled;
934 boolean fullscreen_initial;
936 boolean window_scaling_available;
937 int window_scaling_percent;
938 char *window_scaling_quality;
939 int screen_rendering_mode;
942 unsigned int frame_delay;
943 unsigned int frame_delay_value;
947 int shifted_up_pos_last;
948 unsigned int shifted_up_delay;
949 unsigned int shifted_up_delay_value;
954 struct AudioSystemInfo
956 boolean sound_available;
957 boolean loops_available;
958 boolean music_available;
960 boolean sound_enabled;
961 boolean sound_deactivated; /* for temporarily disabling sound */
970 int first_sound_channel;
973 struct FontBitmapInfo
977 int src_x, src_y; /* start position of font characters */
978 int width, height; /* width / height of font characters */
980 int offset_x; /* offset to next font character */
981 int offset_y; /* offset to next font character */
983 int draw_xoffset; /* offset for drawing font characters */
984 int draw_yoffset; /* offset for drawing font characters */
987 int num_chars_per_line;
994 int real_sx, real_sy;
995 int full_sxsize, full_sysize;
996 int scrollbuffer_width, scrollbuffer_height;
998 int game_tile_size, standard_tile_size;
1009 int win_xsize, win_ysize;
1011 int draw_deactivation_mask;
1012 int draw_background_mask;
1014 Bitmap *field_save_buffer;
1016 Bitmap *background_bitmap;
1017 int background_bitmap_mask;
1019 Bitmap *fade_bitmap_backup;
1020 Bitmap *fade_bitmap_source;
1021 Bitmap *fade_bitmap_target;
1022 Bitmap *fade_bitmap_black;
1024 int fade_border_source_status;
1025 int fade_border_target_status;
1026 Bitmap *masked_border_bitmap_ptr;
1028 Bitmap *final_screen_bitmap;
1030 boolean clipping_enabled;
1032 int clip_width, clip_height;
1034 boolean override_level_graphics;
1035 boolean override_level_sounds;
1036 boolean override_level_music;
1038 boolean draw_init_text;
1041 struct FontBitmapInfo *font_bitmap_info;
1042 int (*select_font_function)(int);
1043 int (*get_font_from_token_function)(char *);
1045 int anim_random_frame;
1047 void (*draw_busy_anim_function)(void);
1048 void (*draw_global_anim_function)(int, int);
1049 void (*draw_global_border_function)(int);
1050 void (*draw_tile_cursor_function)(int);
1055 struct TileCursorInfo
1057 boolean enabled; /* tile cursor generally enabled or disabled */
1058 boolean active; /* tile cursor activated (depending on game) */
1059 boolean moving; /* tile cursor moving to target position */
1061 int xpos, ypos; /* tile cursor level playfield position */
1062 int x, y; /* tile cursor current screen position */
1063 int target_x, target_y; /* tile cursor target screen position */
1065 int sx, sy; /* tile cursor screen start position */
1070 boolean enabled; /* overlay generally enabled or disabled */
1071 boolean active; /* overlay activated (depending on game mode) */
1078 char grid_button[MAX_GRID_XSIZE][MAX_GRID_YSIZE];
1079 char grid_button_highlight;
1081 int grid_button_action;
1087 int nr[MAX_PLAYERS]; /* joystick number for each player */
1090 struct SetupJoystickInfo
1092 char *device_name; /* device name of player's joystick */
1094 int xleft, xmiddle, xright;
1095 int yupper, ymiddle, ylower;
1099 struct SetupKeyboardInfo
1101 Key left, right, up, down;
1105 struct SetupTouchInfo
1114 char grid_button[2][MAX_GRID_XSIZE][MAX_GRID_YSIZE];
1116 int transparency; /* in percent (0 == opaque, 100 == invisible) */
1117 boolean draw_outlined;
1118 boolean draw_pressed;
1120 boolean grid_initialized;
1123 struct SetupInputInfo
1125 boolean use_joystick;
1126 struct SetupJoystickInfo joy;
1127 struct SetupKeyboardInfo key;
1130 struct SetupEditorInfo
1132 boolean el_boulderdash;
1133 boolean el_emerald_mine;
1134 boolean el_emerald_mine_club;
1137 boolean el_supaplex;
1138 boolean el_diamond_caves;
1139 boolean el_dx_boulderdash;
1141 boolean el_mirror_magic;
1142 boolean el_deflektor;
1145 boolean el_steel_chars;
1149 boolean el_user_defined;
1152 boolean el_headlines;
1157 boolean show_element_token;
1159 boolean use_template_for_new_levels;
1162 struct SetupAutoSetupInfo
1164 int editor_zoom_tilesize;
1167 struct SetupEditorCascadeInfo
1180 boolean el_steel_chars;
1188 struct SetupShortcutInfo
1194 Key focus_player[MAX_PLAYERS];
1195 Key focus_player_all;
1214 struct SetupSystemInfo
1216 char *sdl_videodriver;
1217 char *sdl_audiodriver;
1218 int audio_fragment_size;
1221 struct SetupInternalInfo
1223 char *program_title;
1224 char *program_version;
1225 char *program_author;
1226 char *program_email;
1227 char *program_website;
1228 char *program_copyright;
1229 char *program_company;
1231 char *program_icon_file;
1233 char *default_graphics_set;
1234 char *default_sounds_set;
1235 char *default_music_set;
1237 char *fallback_graphics_file;
1238 char *fallback_sounds_file;
1239 char *fallback_music_file;
1241 char *default_level_series;
1243 int default_window_width;
1244 int default_window_height;
1246 boolean choose_from_top_leveldir;
1247 boolean show_scaling_in_title;
1250 struct SetupDebugInfo
1252 int frame_delay[10];
1253 Key frame_delay_key[10];
1254 boolean frame_delay_use_mod_key;
1255 boolean frame_delay_game_only;
1256 boolean show_frames_per_second;
1264 boolean sound_loops;
1265 boolean sound_music;
1266 boolean sound_simple;
1268 boolean scroll_delay;
1269 boolean scroll_delay_value;
1270 char *engine_snapshot_mode;
1271 int engine_snapshot_memory;
1272 boolean fade_screens;
1274 boolean show_titlescreen;
1275 boolean quick_doors;
1278 boolean skip_levels;
1279 boolean increment_levels;
1280 boolean auto_play_next_level;
1281 boolean skip_scores_after_game;
1284 int window_scaling_percent;
1285 char *window_scaling_quality;
1286 char *screen_rendering_mode;
1288 boolean ask_on_escape;
1289 boolean ask_on_escape_editor;
1290 boolean quick_switch;
1291 boolean input_on_focus;
1292 boolean prefer_aga_graphics;
1293 int game_frame_delay;
1294 boolean sp_show_border_elements;
1295 boolean small_game_graphics;
1296 boolean show_snapshot_buttons;
1301 int override_level_graphics; /* not boolean -- can also be "AUTO" */
1302 int override_level_sounds; /* not boolean -- can also be "AUTO" */
1303 int override_level_music; /* not boolean -- can also be "AUTO" */
1309 boolean network_mode;
1310 int network_player_nr;
1311 char *network_server_hostname;
1313 struct SetupAutoSetupInfo auto_setup;
1314 struct SetupEditorInfo editor;
1315 struct SetupEditorCascadeInfo editor_cascade;
1316 struct SetupShortcutInfo shortcut;
1317 struct SetupInputInfo input[MAX_PLAYERS];
1318 struct SetupTouchInfo touch;
1319 struct SetupSystemInfo system;
1320 struct SetupInternalInfo internal;
1321 struct SetupDebugInfo debug;
1323 struct OptionInfo options;
1328 struct TreeInfo **node_top; /* topmost node in tree */
1329 struct TreeInfo *node_parent; /* parent level directory info */
1330 struct TreeInfo *node_group; /* level group sub-directory info */
1331 struct TreeInfo *next; /* next level series structure node */
1333 int cl_first; /* internal control field for setup screen */
1334 int cl_cursor; /* internal control field for setup screen */
1336 int type; /* type of tree content */
1338 /* fields for "type == TREE_TYPE_LEVEL_DIR" */
1340 char *subdir; /* tree info sub-directory basename (may be ".") */
1341 char *fullpath; /* complete path relative to tree base directory */
1342 char *basepath; /* absolute base path of tree base directory */
1343 char *identifier; /* identifier string for configuration files */
1344 char *name; /* tree info name, as displayed in selection menues */
1345 char *name_sorting; /* optional sorting name for correct name sorting */
1346 char *author; /* level or artwork author name */
1347 char *year; /* optional year of creation for levels or artwork */
1349 char *program_title; /* optional alternative text for program title */
1350 char *program_copyright; /* optional alternative text for program copyright */
1351 char *program_company; /* optional alternative text for program company */
1353 char *imported_from; /* optional comment for imported levels or artwork */
1354 char *imported_by; /* optional comment for imported levels or artwork */
1355 char *tested_by; /* optional comment to name people who tested a set */
1357 char *graphics_set_ecs; /* special EMC custom graphics set (ECS graphics) */
1358 char *graphics_set_aga; /* special EMC custom graphics set (AGA graphics) */
1359 char *graphics_set; /* optional custom graphics set (level tree only) */
1360 char *sounds_set; /* optional custom sounds set (level tree only) */
1361 char *music_set; /* optional custom music set (level tree only) */
1362 char *graphics_path; /* path to optional custom graphics set (level only) */
1363 char *sounds_path; /* path to optional custom sounds set (level only) */
1364 char *music_path; /* path to optional custom music set (level only) */
1366 char *level_filename; /* filename of level file (for packed level file) */
1367 char *level_filetype; /* type of levels in level directory or level file */
1369 char *special_flags; /* flags for special actions performed on level file */
1371 int levels; /* number of levels in level series */
1372 int first_level; /* first level number (to allow start with 0 or 1) */
1373 int last_level; /* last level number (automatically calculated) */
1374 int sort_priority; /* sort levels by 'sort_priority' and then by name */
1376 boolean latest_engine;/* force level set to use the latest game engine */
1378 boolean level_group; /* directory contains more level series directories */
1379 boolean parent_link; /* entry links back to parent directory */
1380 boolean in_user_dir; /* user defined levels are stored in home directory */
1381 boolean user_defined; /* levels in user directory and marked as "private" */
1382 boolean readonly; /* readonly levels can not be changed with editor */
1383 boolean handicap; /* level set has no handicap when set to "false" */
1384 boolean skip_levels; /* levels can be skipped when set to "true" */
1386 int color; /* color to use on selection screen for this level */
1387 char *class_desc; /* description of level series class */
1388 int handicap_level; /* number of the lowest unsolved level */
1390 char *infotext; /* optional text to describe the tree type (headline) */
1393 typedef struct TreeInfo TreeInfo;
1394 typedef struct TreeInfo LevelDirTree;
1395 typedef struct TreeInfo ArtworkDirTree;
1396 typedef struct TreeInfo GraphicsDirTree;
1397 typedef struct TreeInfo SoundsDirTree;
1398 typedef struct TreeInfo MusicDirTree;
1402 GraphicsDirTree *gfx_first;
1403 GraphicsDirTree *gfx_current;
1404 SoundsDirTree *snd_first;
1405 SoundsDirTree *snd_current;
1406 MusicDirTree *mus_first;
1407 MusicDirTree *mus_current;
1409 char *gfx_current_identifier;
1410 char *snd_current_identifier;
1411 char *mus_current_identifier;
1414 struct ValueTextInfo
1420 struct StringValueTextInfo
1432 struct ConfigTypeInfo
1439 struct TokenIntPtrInfo
1449 char *default_filename;
1452 char **default_parameter; /* array of file parameters */
1453 char **parameter; /* array of file parameters */
1456 boolean fallback_to_default;
1457 boolean default_is_cloned;
1460 struct SetupFileList
1465 struct SetupFileList *next;
1470 char *source_filename; /* primary key for node list */
1474 struct PropertyMapping
1484 struct ArtworkListInfo
1486 int type; /* type of artwork */
1488 int num_file_list_entries;
1489 int num_dynamic_file_list_entries;
1490 struct FileInfo *file_list; /* static artwork file array */
1491 struct FileInfo *dynamic_file_list; /* dynamic artwrk file array */
1493 int num_suffix_list_entries;
1494 struct ConfigTypeInfo *suffix_list; /* parameter suffixes array */
1496 int num_base_prefixes;
1497 int num_ext1_suffixes;
1498 int num_ext2_suffixes;
1499 int num_ext3_suffixes;
1500 char **base_prefixes; /* base token prefixes array */
1501 char **ext1_suffixes; /* property suffixes array 1 */
1502 char **ext2_suffixes; /* property suffixes array 2 */
1503 char **ext3_suffixes; /* property suffixes array 3 */
1505 int num_ignore_tokens;
1506 char **ignore_tokens; /* file tokens to be ignored */
1508 int num_property_mapping_entries;
1509 struct PropertyMapping *property_mapping; /* mapping token -> artwork */
1511 int sizeof_artwork_list_entry;
1513 struct ListNodeInfo **artwork_list; /* static artwork node array */
1514 struct ListNodeInfo **dynamic_artwork_list; /* dynamic artwrk node array */
1515 struct ListNode *content_list; /* dynamic artwork node list */
1517 void *(*load_artwork)(char *); /* constructor function */
1518 void (*free_artwork)(void *); /* destructor function */
1538 struct RectWithBorder
1552 struct DoorPartPosInfo
1559 int start_step_opening;
1560 int start_step_closing;
1561 boolean draw_masked;
1568 int xoffset; /* special case for tape date and time */
1569 int xoffset2; /* special case for tape date */
1570 int yoffset; /* special case for list of preview players */
1573 int size; /* also used for suffix ".digits" */
1575 boolean draw_masked;
1576 boolean draw_player; /* special case for network player buttons */
1577 int sort_priority; /* also used for suffix ".draw_order" */
1580 int direction; /* needed for panel time/health graphics */
1581 int class; /* needed for panel time/health graphics */
1582 int style; /* needed for panel time/health graphics */
1584 int tile_size; /* special case for list of network players */
1585 int border_size; /* special case for list of preview players */
1586 int vertical; /* special case for list of preview players */
1589 struct MouseActionInfo
1598 int music[MAX_LEVELS];
1611 /* ========================================================================= */
1612 /* exported variables */
1613 /* ========================================================================= */
1615 extern struct ProgramInfo program;
1616 extern struct NetworkInfo network;
1617 extern struct OptionInfo options;
1618 extern struct VideoSystemInfo video;
1619 extern struct AudioSystemInfo audio;
1620 extern struct GfxInfo gfx;
1621 extern struct TileCursorInfo tile_cursor;
1622 extern struct OverlayInfo overlay;
1623 extern struct AnimInfo anim;
1624 extern struct ArtworkInfo artwork;
1625 extern struct JoystickInfo joystick;
1626 extern struct SetupInfo setup;
1628 extern LevelDirTree *leveldir_first_all;
1629 extern LevelDirTree *leveldir_first;
1630 extern LevelDirTree *leveldir_current;
1631 extern int level_nr;
1633 extern struct LevelSetInfo levelset;
1634 extern struct LevelStats level_stats[];
1636 extern DrawWindow *window;
1637 extern DrawBuffer *backbuffer;
1638 extern DrawBuffer *drawto;
1640 extern int button_status;
1641 extern boolean motion_status;
1642 extern int wheel_steps;
1643 #if defined(TARGET_SDL2)
1644 extern boolean keyrepeat_status;
1647 extern int redraw_mask;
1649 extern int FrameCounter;
1652 /* function definitions */
1654 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
1656 void InitNetworkInfo(boolean, boolean, boolean, char *, int);
1658 void InitScoresInfo(void);
1659 void SetWindowTitle(void);
1661 void InitWindowTitleFunction(char *(*window_title_function)(void));
1662 void InitExitMessageFunction(void (*exit_message_function)(char *, va_list));
1663 void InitExitFunction(void (*exit_function)(int));
1664 void InitPlatformDependentStuff(void);
1665 void ClosePlatformDependentStuff(void);
1667 void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
1668 void InitGfxTileSizeInfo(int, int);
1669 void InitGfxDoor1Info(int, int, int, int);
1670 void InitGfxDoor2Info(int, int, int, int);
1671 void InitGfxDoor3Info(int, int, int, int);
1672 void InitGfxWindowInfo(int, int);
1673 void InitGfxScrollbufferInfo(int, int);
1674 void InitGfxClipRegion(boolean, int, int, int, int);
1675 void InitGfxDrawBusyAnimFunction(void (*draw_busy_anim_function)(void));
1676 void InitGfxDrawGlobalAnimFunction(void (*draw_global_anim_function)(int, int));
1677 void InitGfxDrawGlobalBorderFunction(void (*draw_global_border_function)(int));
1678 void InitGfxDrawTileCursorFunction(void (*draw_tile_cursor_function)(int));
1679 void InitGfxCustomArtworkInfo(void);
1680 void InitGfxOtherSettings(void);
1681 void InitTileCursorInfo(void);
1682 void InitOverlayInfo(void);
1683 void SetTileCursorEnabled(boolean);
1684 void SetTileCursorActive(boolean);
1685 void SetTileCursorTargetXY(int, int);
1686 void SetTileCursorXY(int, int);
1687 void SetTileCursorSXSY(int, int);
1688 void SetOverlayEnabled(boolean);
1689 void SetOverlayActive(boolean);
1690 void SetOverlayShowGrid(boolean);
1691 boolean GetOverlayActive(void);
1692 void SetDrawDeactivationMask(int);
1693 int GetDrawDeactivationMask(void);
1694 void SetDrawBackgroundMask(int);
1695 void SetWindowBackgroundBitmap(Bitmap *);
1696 void SetMainBackgroundBitmap(Bitmap *);
1697 void SetDoorBackgroundBitmap(Bitmap *);
1698 void SetRedrawMaskFromArea(int, int, int, int);
1700 void LimitScreenUpdates(boolean);
1702 void InitVideoDefaults(void);
1703 void InitVideoDisplay(void);
1704 void CloseVideoDisplay(void);
1705 void InitVideoBuffer(int, int, int, boolean);
1706 Bitmap *CreateBitmapStruct(void);
1707 Bitmap *CreateBitmap(int, int, int);
1708 void ReCreateBitmap(Bitmap **, int, int);
1709 void FreeBitmap(Bitmap *);
1710 void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
1711 void BlitBitmapTiled(Bitmap *, Bitmap *, int, int, int, int, int, int, int,int);
1712 void FadeRectangle(int, int, int, int, int, int, int,
1713 void (*draw_border_function)(void));
1714 void FillRectangle(Bitmap *, int, int, int, int, Pixel);
1715 void ClearRectangle(Bitmap *, int, int, int, int);
1716 void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
1717 void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
1718 boolean DrawingDeactivatedField(void);
1719 boolean DrawingDeactivated(int, int, int, int);
1720 boolean DrawingOnBackground(int, int);
1721 boolean DrawingAreaChanged(void);
1722 void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int, int);
1723 void BlitTexture(Bitmap *, int, int, int, int, int, int);
1724 void BlitTextureMasked(Bitmap *, int, int, int, int, int, int);
1725 void BlitToScreen(Bitmap *, int, int, int, int, int, int);
1726 void BlitToScreenMasked(Bitmap *, int, int, int, int, int, int);
1727 void DrawSimpleBlackLine(Bitmap *, int, int, int, int);
1728 void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
1729 void DrawLines(Bitmap *, struct XY *, int, Pixel);
1730 Pixel GetPixel(Bitmap *, int, int);
1731 Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
1732 Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
1734 void KeyboardAutoRepeatOn(void);
1735 void KeyboardAutoRepeatOff(void);
1736 boolean SetVideoMode(boolean);
1737 void SetVideoFrameDelay(unsigned int);
1738 unsigned int GetVideoFrameDelay(void);
1739 boolean ChangeVideoModeIfNeeded(boolean);
1741 Bitmap *LoadImage(char *);
1742 Bitmap *LoadCustomImage(char *);
1743 void ReloadCustomImage(Bitmap *, char *);
1745 void ReCreateGameTileSizeBitmap(Bitmap **);
1746 void CreateBitmapWithSmallBitmaps(Bitmap **, int, int);
1747 void CreateBitmapTextures(Bitmap **);
1748 void FreeBitmapTextures(Bitmap **);
1749 void ScaleBitmap(Bitmap **, int);
1751 void SetMouseCursor(int);
1753 void OpenAudio(void);
1754 void CloseAudio(void);
1755 void SetAudioMode(boolean);
1757 boolean PendingEvent(void);
1758 void WaitEvent(Event *event);
1759 void PeekEvent(Event *event);
1760 void CheckQuitEvent(void);
1761 Key GetEventKey(KeyEvent *, boolean);
1762 KeyMod HandleKeyModState(Key, int);
1763 KeyMod GetKeyModState(void);
1764 KeyMod GetKeyModStateFromEvents(void);
1765 void StartTextInput(int, int, int, int);
1766 void StopTextInput(void);
1767 boolean CheckCloseWindowEvent(ClientMessageEvent *);
1769 void InitJoysticks(void);
1770 boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
1771 boolean CheckJoystickOpened(int);
1772 void ClearJoystickState(void);
1774 #endif /* SYSTEM_H */