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 #define STR_SPECIAL_RENDERING_DEFAULT STR_SPECIAL_RENDERING_DOUBLE
70 #define SPECIAL_RENDERING_OFF 0
71 #define SPECIAL_RENDERING_BITMAP 1
72 #define SPECIAL_RENDERING_TARGET 2
73 #define SPECIAL_RENDERING_DOUBLE 3
75 #define SPECIAL_RENDERING_DEFAULT SPECIAL_RENDERING_DOUBLE
77 // values for vertical screen retrace synchronization (vsync)
78 #define STR_VSYNC_MODE_OFF "off"
79 #define STR_VSYNC_MODE_NORMAL "normal"
80 #define STR_VSYNC_MODE_ADAPTIVE "adaptive"
82 #define STR_VSYNC_MODE_DEFAULT STR_VSYNC_MODE_OFF
84 #define VSYNC_MODE_OFF 0
85 #define VSYNC_MODE_NORMAL 1
86 #define VSYNC_MODE_ADAPTIVE -1
88 #define VSYNC_MODE_DEFAULT VSYNC_MODE_OFF
90 // values for network server settings
91 #define STR_NETWORK_AUTO_DETECT "auto_detect_network_server"
92 #define STR_NETWORK_AUTO_DETECT_SETUP "(auto detect network server)"
94 // values for touch control
95 #define TOUCH_CONTROL_OFF "off"
96 #define TOUCH_CONTROL_VIRTUAL_BUTTONS "virtual_buttons"
97 #define TOUCH_CONTROL_WIPE_GESTURES "wipe_gestures"
98 #define TOUCH_CONTROL_FOLLOW_FINGER "follow_finger"
100 #if defined(PLATFORM_ANDROID)
101 #define TOUCH_CONTROL_DEFAULT TOUCH_CONTROL_VIRTUAL_BUTTONS
103 #define TOUCH_CONTROL_DEFAULT TOUCH_CONTROL_OFF
106 #define TOUCH_MOVE_DISTANCE_DEFAULT 2
107 #define TOUCH_DROP_DISTANCE_DEFAULT 5
108 #define TOUCH_TRANSPARENCY_DEFAULT 50
110 #define ALPHA_FROM_TRANSPARENCY(x) ((100 - x) * SDL_ALPHA_OPAQUE / 100)
111 #define ALPHA_FADING_STEPSIZE(x) ((x) / 25)
113 // values for special settings for mobile devices
114 #if defined(PLATFORM_ANDROID)
115 #define USE_TOUCH_INPUT_OVERLAY
116 #define USE_COMPLETE_DISPLAY
117 #define HAS_SCREEN_KEYBOARD
118 #define SCREEN_KEYBOARD_POS(h) ((h) / 2)
121 // default input keys
122 #define DEFAULT_KEY_LEFT KSYM_Left
123 #define DEFAULT_KEY_RIGHT KSYM_Right
124 #define DEFAULT_KEY_UP KSYM_Up
125 #define DEFAULT_KEY_DOWN KSYM_Down
126 #if defined(PLATFORM_MACOSX)
127 #define DEFAULT_KEY_SNAP KSYM_Control_L
128 #define DEFAULT_KEY_DROP KSYM_KP_Enter
130 #define DEFAULT_KEY_SNAP KSYM_Control_L
131 #define DEFAULT_KEY_DROP KSYM_Control_R
133 #define DEFAULT_KEY_OKAY KSYM_Return
134 #define DEFAULT_KEY_CANCEL KSYM_Escape
136 // default shortcut keys
137 #define DEFAULT_KEY_SAVE_GAME KSYM_F1
138 #define DEFAULT_KEY_LOAD_GAME KSYM_F2
139 #define DEFAULT_KEY_TOGGLE_PAUSE KSYM_space
140 #define DEFAULT_KEY_FOCUS_PLAYER_1 KSYM_F5
141 #define DEFAULT_KEY_FOCUS_PLAYER_2 KSYM_F6
142 #define DEFAULT_KEY_FOCUS_PLAYER_3 KSYM_F7
143 #define DEFAULT_KEY_FOCUS_PLAYER_4 KSYM_F8
144 #define DEFAULT_KEY_FOCUS_PLAYER_ALL KSYM_F9
145 #define DEFAULT_KEY_TAPE_EJECT KSYM_UNDEFINED
146 #define DEFAULT_KEY_TAPE_EXTRA KSYM_UNDEFINED
147 #define DEFAULT_KEY_TAPE_STOP KSYM_UNDEFINED
148 #define DEFAULT_KEY_TAPE_PAUSE KSYM_UNDEFINED
149 #define DEFAULT_KEY_TAPE_RECORD KSYM_UNDEFINED
150 #define DEFAULT_KEY_TAPE_PLAY KSYM_UNDEFINED
151 #define DEFAULT_KEY_SOUND_SIMPLE KSYM_UNDEFINED
152 #define DEFAULT_KEY_SOUND_LOOPS KSYM_UNDEFINED
153 #define DEFAULT_KEY_SOUND_MUSIC KSYM_UNDEFINED
154 #define DEFAULT_KEY_SNAP_LEFT KSYM_UNDEFINED
155 #define DEFAULT_KEY_SNAP_RIGHT KSYM_UNDEFINED
156 #define DEFAULT_KEY_SNAP_UP KSYM_UNDEFINED
157 #define DEFAULT_KEY_SNAP_DOWN KSYM_UNDEFINED
159 // default debug setup keys and values
160 #define DEFAULT_FRAME_DELAY_0 20 // 100 % speed
161 #define DEFAULT_FRAME_DELAY_1 500 // 4 % speed
162 #define DEFAULT_FRAME_DELAY_2 250 // 8 % speed
163 #define DEFAULT_FRAME_DELAY_3 125 // 16 % speed
164 #define DEFAULT_FRAME_DELAY_4 60 // 33 % speed
165 #define DEFAULT_FRAME_DELAY_5 40 // 50 % speed
166 #define DEFAULT_FRAME_DELAY_6 30 // 66 % speed
167 #define DEFAULT_FRAME_DELAY_7 10 // 200 % speed
168 #define DEFAULT_FRAME_DELAY_8 5 // 400 % speed
169 #define DEFAULT_FRAME_DELAY_9 0 // maximum speed
171 #define DEFAULT_KEY_FRAME_DELAY_0 KSYM_0
172 #define DEFAULT_KEY_FRAME_DELAY_1 KSYM_1
173 #define DEFAULT_KEY_FRAME_DELAY_2 KSYM_2
174 #define DEFAULT_KEY_FRAME_DELAY_3 KSYM_3
175 #define DEFAULT_KEY_FRAME_DELAY_4 KSYM_4
176 #define DEFAULT_KEY_FRAME_DELAY_5 KSYM_5
177 #define DEFAULT_KEY_FRAME_DELAY_6 KSYM_6
178 #define DEFAULT_KEY_FRAME_DELAY_7 KSYM_7
179 #define DEFAULT_KEY_FRAME_DELAY_8 KSYM_8
180 #define DEFAULT_KEY_FRAME_DELAY_9 KSYM_9
182 #define NUM_DEBUG_FRAME_DELAY_KEYS 10
184 #define DEFAULT_FRAME_DELAY_USE_MOD_KEY FALSE
185 #define DEFAULT_FRAME_DELAY_GAME_ONLY TRUE
187 // values for key_status
188 #define KEY_NOT_PRESSED FALSE
189 #define KEY_RELEASED FALSE
190 #define KEY_PRESSED TRUE
192 // values for button status
193 #define MB_NOT_PRESSED FALSE
194 #define MB_NOT_RELEASED TRUE
195 #define MB_RELEASED FALSE
196 #define MB_PRESSED TRUE
197 #define MB_MENU_CHOICE FALSE
198 #define MB_MENU_MARK TRUE
199 #define MB_MENU_INITIALIZE (-1)
200 #define MB_MENU_LEAVE (-2)
201 #define MB_LEFTBUTTON 1
202 #define MB_MIDDLEBUTTON 2
203 #define MB_RIGHTBUTTON 3
204 #define MB_WHEEL_UP 4
205 #define MB_WHEEL_DOWN 5
206 #define MB_WHEEL_LEFT 6
207 #define MB_WHEEL_RIGHT 7
208 #define IS_WHEEL_BUTTON_VERTICAL(b) ((b) == MB_WHEEL_UP || \
209 (b) == MB_WHEEL_DOWN)
210 #define IS_WHEEL_BUTTON_HORIZONTAL(b) ((b) == MB_WHEEL_LEFT || \
211 (b) == MB_WHEEL_RIGHT)
212 #define IS_WHEEL_BUTTON(b) (IS_WHEEL_BUTTON_VERTICAL(b) || \
213 IS_WHEEL_BUTTON_HORIZONTAL(b))
214 #define DEFAULT_WHEEL_STEPS 3
216 #define BUTTON_STEPSIZE(b) ((b) == MB_LEFTBUTTON ? 1 : \
217 (b) == MB_MIDDLEBUTTON ? 5 : \
218 (b) == MB_RIGHTBUTTON ? 10 : 1)
220 // values for move directions
221 #define MV_BIT_LEFT 0
222 #define MV_BIT_RIGHT 1
224 #define MV_BIT_DOWN 3
226 #define NUM_DIRECTIONS 4
228 // diagonal movement directions are used in a different contect than buttons
229 #define MV_BIT_UPLEFT 4
230 #define MV_BIT_UPRIGHT 5
231 #define MV_BIT_DOWNLEFT 6
232 #define MV_BIT_DOWNRIGHT 7
234 #define NUM_DIRECTIONS_FULL 8
236 // values for special "button" bitmasks
240 #define NUM_PLAYER_ACTIONS 6
242 // values for special "focus player" bitmasks
243 #define BIT_SET_FOCUS 6
245 // values for drawing stages for global animations
246 #define DRAW_GLOBAL_ANIM_STAGE_1 1
247 #define DRAW_GLOBAL_ANIM_STAGE_2 2
249 // values for drawing target (various functions)
250 #define DRAW_TO_BACKBUFFER 0
251 #define DRAW_TO_FIELDBUFFER 1
252 #define DRAW_TO_SCREEN 2
253 #define DRAW_TO_FADE_SOURCE 3
254 #define DRAW_TO_FADE_TARGET 4
256 // values for move directions and special "button" key bitmasks
258 #define MV_LEFT (1 << MV_BIT_LEFT)
259 #define MV_RIGHT (1 << MV_BIT_RIGHT)
260 #define MV_UP (1 << MV_BIT_UP)
261 #define MV_DOWN (1 << MV_BIT_DOWN)
263 #define MV_UPLEFT (MV_UP | MV_LEFT)
264 #define MV_UPRIGHT (MV_UP | MV_RIGHT)
265 #define MV_DOWNLEFT (MV_DOWN | MV_LEFT)
266 #define MV_DOWNRIGHT (MV_DOWN | MV_RIGHT)
268 #define MV_HORIZONTAL (MV_LEFT | MV_RIGHT)
269 #define MV_VERTICAL (MV_UP | MV_DOWN)
270 #define MV_ALL_DIRECTIONS (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
271 #define MV_ANY_DIRECTION (MV_ALL_DIRECTIONS)
272 #define MV_NO_DIRECTION (MV_NONE)
274 #define KEY_BUTTON_1 (1 << BUTTON_1)
275 #define KEY_BUTTON_2 (1 << BUTTON_2)
276 #define KEY_BUTTON_SNAP KEY_BUTTON_1
277 #define KEY_BUTTON_DROP KEY_BUTTON_2
278 #define KEY_MOTION (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
279 #define KEY_BUTTON (KEY_BUTTON_1 | KEY_BUTTON_2)
280 #define KEY_ACTION (KEY_MOTION | KEY_BUTTON)
282 #define KEY_SET_FOCUS (1 << BIT_SET_FOCUS)
284 #define MV_DIR_FROM_BIT(x) ((x) < NUM_DIRECTIONS ? 1 << (x) : \
285 (x) == MV_BIT_UPLEFT ? MV_UPLEFT : \
286 (x) == MV_BIT_UPRIGHT ? MV_UPRIGHT : \
287 (x) == MV_BIT_DOWNLEFT ? MV_DOWNLEFT : \
288 (x) == MV_BIT_DOWNRIGHT ? MV_DOWNRIGHT : \
291 #define MV_DIR_TO_BIT(x) ((x) == MV_LEFT ? MV_BIT_LEFT : \
292 (x) == MV_RIGHT ? MV_BIT_RIGHT : \
293 (x) == MV_UP ? MV_BIT_UP : \
294 (x) == MV_DOWN ? MV_BIT_DOWN : \
295 (x) == MV_UPLEFT ? MV_BIT_UPLEFT : \
296 (x) == MV_UPRIGHT ? MV_BIT_UPRIGHT : \
297 (x) == MV_DOWNLEFT ? MV_BIT_DOWNLEFT : \
298 (x) == MV_DOWNRIGHT ? MV_BIT_DOWNRIGHT : \
301 #define MV_DIR_OPPOSITE(x) ((x) == MV_LEFT ? MV_RIGHT : \
302 (x) == MV_RIGHT ? MV_LEFT : \
303 (x) == MV_UP ? MV_DOWN : \
304 (x) == MV_DOWN ? MV_UP : \
305 (x) == MV_UPLEFT ? MV_DOWNRIGHT : \
306 (x) == MV_UPRIGHT ? MV_DOWNLEFT : \
307 (x) == MV_DOWNLEFT ? MV_UPRIGHT : \
308 (x) == MV_DOWNRIGHT ? MV_UPLEFT : \
311 // values for animation mode (frame order and direction)
312 // (stored in level files -- never change existing values)
314 #define ANIM_LOOP (1 << 0)
315 #define ANIM_LINEAR (1 << 1)
316 #define ANIM_PINGPONG (1 << 2)
317 #define ANIM_PINGPONG2 (1 << 3)
318 #define ANIM_RANDOM (1 << 4)
319 #define ANIM_CE_VALUE (1 << 5)
320 #define ANIM_CE_SCORE (1 << 6)
321 #define ANIM_CE_DELAY (1 << 7)
322 #define ANIM_REVERSE (1 << 8)
323 #define ANIM_OPAQUE_PLAYER (1 << 9)
325 // values for special (non game element) animation modes
326 // (not stored in level files -- can be changed, if needed)
327 #define ANIM_HORIZONTAL (1 << 10)
328 #define ANIM_VERTICAL (1 << 11)
329 #define ANIM_CENTERED (1 << 12)
330 #define ANIM_STATIC_PANEL (1 << 13)
331 #define ANIM_ALL (1 << 14)
332 #define ANIM_ONCE (1 << 15)
334 #define ANIM_DEFAULT ANIM_LOOP
336 // values for special drawing styles (currently only for crumbled graphics)
338 #define STYLE_ACCURATE_BORDERS (1 << 0)
339 #define STYLE_INNER_CORNERS (1 << 1)
340 #define STYLE_REVERSE (1 << 2)
342 // values for special event handling style (used for global animation)
343 #define STYLE_PASSTHROUGH (1 << 3)
344 #define STYLE_MULTIPLE_ACTIONS (1 << 4)
346 #define STYLE_DEFAULT STYLE_NONE
348 // values for special global animation events
349 #define ANIM_EVENT_NONE 0
350 #define ANIM_EVENT_SELF (1 << 16)
351 #define ANIM_EVENT_ANY (1 << 17)
353 #define ANIM_EVENT_ANIM_BIT 0
354 #define ANIM_EVENT_PART_BIT 8
356 #define ANIM_EVENT_ANIM_MASK (0xff << ANIM_EVENT_ANIM_BIT)
357 #define ANIM_EVENT_PART_MASK (0xff << ANIM_EVENT_PART_BIT)
359 #define ANIM_EVENT_DEFAULT ANIM_EVENT_NONE
361 // values for special global animation event actions
362 #define ANIM_EVENT_ACTION_NONE -1
364 // values for fade mode
365 #define FADE_TYPE_NONE 0
366 #define FADE_TYPE_FADE_IN (1 << 0)
367 #define FADE_TYPE_FADE_OUT (1 << 1)
368 #define FADE_TYPE_TRANSFORM (1 << 2)
369 #define FADE_TYPE_CROSSFADE (1 << 3)
370 #define FADE_TYPE_MELT (1 << 4)
371 #define FADE_TYPE_CURTAIN (1 << 5)
372 #define FADE_TYPE_SKIP (1 << 6)
374 #define FADE_MODE_NONE (FADE_TYPE_NONE)
375 #define FADE_MODE_FADE_IN (FADE_TYPE_FADE_IN)
376 #define FADE_MODE_FADE_OUT (FADE_TYPE_FADE_OUT)
377 #define FADE_MODE_FADE (FADE_TYPE_FADE_IN | FADE_TYPE_FADE_OUT)
378 #define FADE_MODE_TRANSFORM (FADE_TYPE_TRANSFORM | FADE_TYPE_FADE_IN)
379 #define FADE_MODE_CROSSFADE (FADE_MODE_TRANSFORM | FADE_TYPE_CROSSFADE)
380 #define FADE_MODE_MELT (FADE_MODE_TRANSFORM | FADE_TYPE_MELT)
381 #define FADE_MODE_CURTAIN (FADE_MODE_TRANSFORM | FADE_TYPE_CURTAIN)
382 #define FADE_MODE_SKIP_FADE_IN (FADE_TYPE_SKIP | FADE_TYPE_FADE_IN)
383 #define FADE_MODE_SKIP_FADE_OUT (FADE_TYPE_SKIP | FADE_TYPE_FADE_OUT)
385 #define FADE_MODE_DEFAULT FADE_MODE_FADE
387 // values for toon positions
388 #define POS_UNDEFINED -1
399 // values for text alignment
400 #define ALIGN_LEFT (1 << 0)
401 #define ALIGN_RIGHT (1 << 1)
402 #define ALIGN_CENTER (1 << 2)
403 #define ALIGN_DEFAULT ALIGN_LEFT
405 #define VALIGN_TOP (1 << 0)
406 #define VALIGN_BOTTOM (1 << 1)
407 #define VALIGN_MIDDLE (1 << 2)
408 #define VALIGN_DEFAULT VALIGN_TOP
410 #define ALIGNED_XPOS(x,w,a) ((a) == ALIGN_CENTER ? (x) - (w) / 2 : \
411 (a) == ALIGN_RIGHT ? (x) - (w) : (x))
412 #define ALIGNED_YPOS(y,h,v) ((v) == VALIGN_MIDDLE ? (y) - (h) / 2 : \
413 (v) == VALIGN_BOTTOM ? (y) - (h) : (y))
414 #define ALIGNED_TEXT_XPOS(p) ALIGNED_XPOS((p)->x, (p)->width, (p)->align)
415 #define ALIGNED_TEXT_YPOS(p) ALIGNED_YPOS((p)->y, (p)->height, (p)->valign)
416 #define ALIGNED_VP_XPOS(p) ALIGNED_TEXT_XPOS(p)
417 #define ALIGNED_VP_YPOS(p) ALIGNED_TEXT_YPOS(p)
419 // values for redraw_mask
420 #define REDRAW_NONE (0)
421 #define REDRAW_ALL (1 << 0)
422 #define REDRAW_FIELD (1 << 1)
423 #define REDRAW_DOOR_1 (1 << 2)
424 #define REDRAW_DOOR_2 (1 << 3)
425 #define REDRAW_DOOR_3 (1 << 4)
426 #define REDRAW_FPS (1 << 5)
428 #define REDRAW_DOORS (REDRAW_DOOR_1 | \
432 #define IN_GFX_FIELD_PLAY(x, y) (x >= gfx.sx && x < gfx.sx + gfx.sxsize && \
433 y >= gfx.sy && y < gfx.sy + gfx.sysize)
434 #define IN_GFX_FIELD_FULL(x, y) (x >= gfx.real_sx && \
435 x < gfx.real_sx + gfx.full_sxsize && \
436 y >= gfx.real_sy && \
437 y < gfx.real_sy + gfx.full_sysize)
438 #define IN_GFX_DOOR_1(x, y) (x >= gfx.dx && x < gfx.dx + gfx.dxsize && \
439 y >= gfx.dy && y < gfx.dy + gfx.dysize)
440 #define IN_GFX_DOOR_2(x, y) (x >= gfx.vx && x < gfx.vx + gfx.vxsize && \
441 y >= gfx.vy && y < gfx.vy + gfx.vysize)
442 #define IN_GFX_DOOR_3(x, y) (x >= gfx.ex && x < gfx.ex + gfx.exsize && \
443 y >= gfx.ey && y < gfx.ey + gfx.eysize)
445 // values for mouse cursor
446 #define CURSOR_DEFAULT 0
447 #define CURSOR_NONE 1
448 #define CURSOR_PLAYFIELD 2
450 // fundamental game speed values
451 #define ONE_SECOND_DELAY 1000 // delay value for one second
452 #define MENU_FRAME_DELAY 20 // frame delay in milliseconds
453 #define GAME_FRAME_DELAY 20 // frame delay in milliseconds
454 #define FFWD_FRAME_DELAY 10 // 200% speed for fast forward
455 #define MIN_VSYNC_FRAME_DELAY 15 // minimum value for vsync to keep
456 #define MAX_VSYNC_FRAME_DELAY 16 // maximum value for vsync to work
457 #define FRAMES_PER_SECOND (ONE_SECOND_DELAY / GAME_FRAME_DELAY)
458 #define FRAMES_PER_SECOND_SP 35
460 // maximum playfield size supported by libgame functions
461 #define MAX_PLAYFIELD_WIDTH 128
462 #define MAX_PLAYFIELD_HEIGHT 128
464 // maximum number of parallel players supported by libgame functions
465 #define MAX_PLAYERS 4
467 // maximum allowed length of player name
468 #define MAX_PLAYER_NAME_LEN 10
470 // maximum number of levels in a level set
471 #define MAX_LEVELS 1000
473 // maximum number of global animation and parts
474 #define MAX_GLOBAL_ANIMS 32
475 #define MAX_GLOBAL_ANIM_PARTS 32
477 // minimum/maximum/default x/y grid size for virtual buttons
478 #define MIN_GRID_XSIZE 3
479 #define MIN_GRID_YSIZE 3
480 #define MAX_GRID_XSIZE 32
481 #define MAX_GRID_YSIZE 32
482 #define GRID_REAL_WIDTH MAX(1, MAX(video.screen_width, \
483 video.screen_height))
484 #define GRID_REAL_HEIGHT MAX(1, MIN(video.screen_width, \
485 video.screen_height))
486 #define DEFAULT_GRID_XSIZE_0 18
487 #define DEFAULT_GRID_YSIZE_0 MIN(MAX(MIN_GRID_YSIZE, \
488 DEFAULT_GRID_XSIZE_0 * \
492 #define DEFAULT_GRID_XSIZE_1 13
493 #define DEFAULT_GRID_YSIZE_1 MIN(MAX(MIN_GRID_YSIZE, \
494 DEFAULT_GRID_XSIZE_1 * \
499 #define DEFAULT_GRID_XSIZE(n) ((n) == 0 ? DEFAULT_GRID_XSIZE_0 : \
500 DEFAULT_GRID_XSIZE_1)
501 #define DEFAULT_GRID_YSIZE(n) ((n) == 0 ? DEFAULT_GRID_YSIZE_0 : \
502 DEFAULT_GRID_YSIZE_1)
504 #define GRID_ACTIVE_NR() (video.screen_width > \
505 video.screen_height ? 0 : 1)
507 // values for grid button characters for virtual buttons
508 #define CHAR_GRID_BUTTON_NONE ' '
509 #define CHAR_GRID_BUTTON_LEFT '<'
510 #define CHAR_GRID_BUTTON_RIGHT '>'
511 #define CHAR_GRID_BUTTON_UP '^'
512 #define CHAR_GRID_BUTTON_DOWN 'v'
513 #define CHAR_GRID_BUTTON_SNAP '1'
514 #define CHAR_GRID_BUTTON_DROP '2'
516 #define GET_ACTION_FROM_GRID_BUTTON(c) ((c) == CHAR_GRID_BUTTON_LEFT ? \
518 (c) == CHAR_GRID_BUTTON_RIGHT ? \
520 (c) == CHAR_GRID_BUTTON_UP ? \
522 (c) == CHAR_GRID_BUTTON_DOWN ? \
524 (c) == CHAR_GRID_BUTTON_SNAP ? \
526 (c) == CHAR_GRID_BUTTON_DROP ? \
530 // default name for empty highscore entry
531 #define EMPTY_PLAYER_NAME "no name"
533 // default name for unknown player names
534 #define ANONYMOUS_NAME "anonymous"
536 // default for other unknown names
537 #define UNKNOWN_NAME "unknown"
539 // default name for new levels
540 #define NAMELESS_LEVEL_NAME "nameless level"
542 // default text for non-existant artwork
543 #define NOT_AVAILABLE "(not available)"
545 // default value for undefined filename
546 #define UNDEFINED_FILENAME "[NONE]"
548 // default value for undefined levelset
549 #define UNDEFINED_LEVELSET "[NONE]"
551 // default value for undefined parameter
552 #define ARG_DEFAULT "[DEFAULT]"
554 // default values for undefined configuration file parameters
555 #define ARG_UNDEFINED "-1000000"
556 #define ARG_UNDEFINED_VALUE (-1000000)
558 // default value for off-screen positions
559 #define POS_OFFSCREEN (-1000000)
561 // definitions for game sub-directories
563 #define RO_GAME_DIR "."
567 #define RW_GAME_DIR "."
570 #define RO_BASE_PATH RO_GAME_DIR
571 #define RW_BASE_PATH RW_GAME_DIR
574 #define GRAPHICS_DIRECTORY "graphics"
575 #define SOUNDS_DIRECTORY "sounds"
576 #define MUSIC_DIRECTORY "music"
577 #define LEVELS_DIRECTORY "levels"
578 #define TAPES_DIRECTORY "tapes"
579 #define SCORES_DIRECTORY "scores"
580 #define DOCS_DIRECTORY "docs"
581 #define CACHE_DIRECTORY "cache"
582 #define CONF_DIRECTORY "conf"
583 #define NETWORK_DIRECTORY "network"
585 #define GFX_CLASSIC_SUBDIR "gfx_classic"
586 #define SND_CLASSIC_SUBDIR "snd_classic"
587 #define MUS_CLASSIC_SUBDIR "mus_classic"
589 #define GFX_DEFAULT_SUBDIR (setup.internal.default_graphics_set)
590 #define SND_DEFAULT_SUBDIR (setup.internal.default_sounds_set)
591 #define MUS_DEFAULT_SUBDIR (setup.internal.default_music_set)
593 #define GFX_FALLBACK_FILENAME (setup.internal.fallback_graphics_file)
594 #define SND_FALLBACK_FILENAME (setup.internal.fallback_sounds_file)
595 #define MUS_FALLBACK_FILENAME (setup.internal.fallback_music_file)
597 #define DEFAULT_LEVELSET (setup.internal.default_level_series)
599 // file names and filename extensions
600 #define LEVELSETUP_DIRECTORY "levelsetup"
601 #define SETUP_FILENAME "setup.conf"
602 #define AUTOSETUP_FILENAME "autosetup.conf"
603 #define LEVELSETUP_FILENAME "levelsetup.conf"
604 #define EDITORSETUP_FILENAME "editorsetup.conf"
605 #define EDITORCASCADE_FILENAME "editorcascade.conf"
606 #define HELPANIM_FILENAME "helpanim.conf"
607 #define HELPTEXT_FILENAME "helptext.conf"
608 #define LEVELINFO_FILENAME "levelinfo.conf"
609 #define GRAPHICSINFO_FILENAME "graphicsinfo.conf"
610 #define SOUNDSINFO_FILENAME "soundsinfo.conf"
611 #define MUSICINFO_FILENAME "musicinfo.conf"
612 #define ARTWORKINFO_CACHE_FILE "artworkinfo.cache"
613 #define LEVELTEMPLATE_FILENAME "template.level"
614 #define LEVELFILE_EXTENSION "level"
615 #define TAPEFILE_EXTENSION "tape"
616 #define SCOREFILE_EXTENSION "score"
618 #define GAMECONTROLLER_BASENAME "gamecontrollerdb.txt"
620 #define LOG_OUT_BASENAME "stdout.txt"
621 #define LOG_ERR_BASENAME "stderr.txt"
627 #define STRING_PARENT_DIRECTORY ".."
628 #define STRING_TOP_DIRECTORY "/"
630 #define CHAR_PATH_SEPARATOR_UNIX '/'
631 #define CHAR_PATH_SEPARATOR_DOS '\\'
633 #define STRING_PATH_SEPARATOR_UNIX "/"
634 #define STRING_PATH_SEPARATOR_DOS "\\"
636 #define STRING_NEWLINE_UNIX "\n"
637 #define STRING_NEWLINE_DOS "\r\n"
639 #if defined(PLATFORM_WIN32)
640 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_DOS
641 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_DOS
642 #define STRING_NEWLINE STRING_NEWLINE_DOS
644 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_UNIX
645 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_UNIX
646 #define STRING_NEWLINE STRING_NEWLINE_UNIX
650 // areas in bitmap PIX_DOOR
651 // meaning in PIX_DB_DOOR: (3 PAGEs)
652 // PAGEX1: 1. buffer for DOOR_1
653 // PAGEX2: 2. buffer for DOOR_1
654 // PAGEX3: buffer for animations
656 // these values are hard-coded to be able to use them in initialization
657 #define DOOR_GFX_PAGE_WIDTH 100 // should be set to "gfx.dxsize"
658 #define DOOR_GFX_PAGE_HEIGHT 280 // should be set to "gfx.dysize"
660 #define DOOR_GFX_PAGESIZE (DOOR_GFX_PAGE_WIDTH)
661 #define DOOR_GFX_PAGEX1 (0 * DOOR_GFX_PAGESIZE)
662 #define DOOR_GFX_PAGEX2 (1 * DOOR_GFX_PAGESIZE)
663 #define DOOR_GFX_PAGEX3 (2 * DOOR_GFX_PAGESIZE)
664 #define DOOR_GFX_PAGEX4 (3 * DOOR_GFX_PAGESIZE)
665 #define DOOR_GFX_PAGEX5 (4 * DOOR_GFX_PAGESIZE)
666 #define DOOR_GFX_PAGEX6 (5 * DOOR_GFX_PAGESIZE)
667 #define DOOR_GFX_PAGEX7 (6 * DOOR_GFX_PAGESIZE)
668 #define DOOR_GFX_PAGEX8 (7 * DOOR_GFX_PAGESIZE)
669 #define DOOR_GFX_PAGEY1 (0)
670 #define DOOR_GFX_PAGEY2 (DOOR_GFX_PAGE_HEIGHT)
673 // macros for version handling
674 #define VERSION_PART_1(x) ((x) / 1000000)
675 #define VERSION_PART_2(x) (((x) % 1000000) / 10000)
676 #define VERSION_PART_3(x) (((x) % 10000) / 100)
677 #define VERSION_PART_4(x) ((x) % 100)
679 #define VERSION_SUPER(x) VERSION_PART_1(x)
680 #define VERSION_MAJOR(x) VERSION_PART_2(x)
681 #define VERSION_MINOR(x) VERSION_PART_3(x)
682 #define VERSION_PATCH(x) VERSION_PART_4(x)
683 #define VERSION_IDENT(a,b,c,d) ((a) * 1000000 + (b) * 10000 + (c) * 100 + (d))
686 // macros for parent/child process identification
687 #if defined(PLATFORM_UNIX)
688 #define IS_PARENT_PROCESS() (audio.mixer_pid != getpid())
689 #define IS_CHILD_PROCESS() (audio.mixer_pid == getpid())
690 #define HAS_CHILD_PROCESS() (audio.mixer_pid > 0)
692 #define IS_PARENT_PROCESS() TRUE
693 #define IS_CHILD_PROCESS() FALSE
694 #define HAS_CHILD_PROCESS() FALSE
698 // values for artwork type
699 #define ARTWORK_TYPE_GRAPHICS 0
700 #define ARTWORK_TYPE_SOUNDS 1
701 #define ARTWORK_TYPE_MUSIC 2
703 #define NUM_ARTWORK_TYPES 3
706 // values for tree type (chosen to match artwork type)
707 #define TREE_TYPE_UNDEFINED -1
708 #define TREE_TYPE_GRAPHICS_DIR ARTWORK_TYPE_GRAPHICS
709 #define TREE_TYPE_SOUNDS_DIR ARTWORK_TYPE_SOUNDS
710 #define TREE_TYPE_MUSIC_DIR ARTWORK_TYPE_MUSIC
711 #define TREE_TYPE_LEVEL_DIR 3
712 #define TREE_TYPE_LEVEL_NR 4
714 #define NUM_TREE_TYPES 5
716 #define INFOTEXT_UNDEFINED ""
717 #define INFOTEXT_GRAPHICS_DIR "Custom Graphics"
718 #define INFOTEXT_SOUNDS_DIR "Custom Sounds"
719 #define INFOTEXT_MUSIC_DIR "Custom Music"
720 #define INFOTEXT_LEVEL_DIR "Level Sets"
721 #define INFOTEXT_LEVEL_NR "Levels"
723 #define TREE_INFOTEXT(t) ((t) == TREE_TYPE_LEVEL_NR ? \
724 INFOTEXT_LEVEL_NR : \
725 (t) == TREE_TYPE_LEVEL_DIR ? \
726 INFOTEXT_LEVEL_DIR : \
727 (t) == TREE_TYPE_GRAPHICS_DIR ? \
728 INFOTEXT_GRAPHICS_DIR : \
729 (t) == TREE_TYPE_SOUNDS_DIR ? \
730 INFOTEXT_SOUNDS_DIR : \
731 (t) == TREE_TYPE_MUSIC_DIR ? \
732 INFOTEXT_MUSIC_DIR : \
735 // values for artwork handling
736 #define LEVELDIR_ARTWORK_SET_PTR(leveldir, type) \
737 ((type) == ARTWORK_TYPE_GRAPHICS ? \
738 &(leveldir)->graphics_set : \
739 (type) == ARTWORK_TYPE_SOUNDS ? \
740 &(leveldir)->sounds_set : \
741 &(leveldir)->music_set)
743 #define LEVELDIR_ARTWORK_SET(leveldir, type) \
744 ((type) == ARTWORK_TYPE_GRAPHICS ? \
745 (leveldir)->graphics_set : \
746 (type) == ARTWORK_TYPE_SOUNDS ? \
747 (leveldir)->sounds_set : \
748 (leveldir)->music_set)
750 #define LEVELDIR_ARTWORK_PATH_PTR(leveldir, type) \
751 ((type) == ARTWORK_TYPE_GRAPHICS ? \
752 &(leveldir)->graphics_path : \
753 (type) == ARTWORK_TYPE_SOUNDS ? \
754 &(leveldir)->sounds_path : \
755 &(leveldir)->music_path)
757 #define LEVELDIR_ARTWORK_PATH(leveldir, type) \
758 ((type) == ARTWORK_TYPE_GRAPHICS ? \
759 (leveldir)->graphics_path : \
760 (type) == ARTWORK_TYPE_SOUNDS ? \
761 (leveldir)->sounds_path : \
762 (leveldir)->music_path)
764 #define SETUP_ARTWORK_SET(setup, type) \
765 ((type) == ARTWORK_TYPE_GRAPHICS ? \
766 (setup).graphics_set : \
767 (type) == ARTWORK_TYPE_SOUNDS ? \
768 (setup).sounds_set : \
771 #define SETUP_OVERRIDE_ARTWORK(setup, type) \
772 ((type) == ARTWORK_TYPE_GRAPHICS ? \
773 (setup).override_level_graphics : \
774 (type) == ARTWORK_TYPE_SOUNDS ? \
775 (setup).override_level_sounds : \
776 (setup).override_level_music)
778 #define GFX_OVERRIDE_ARTWORK(type) \
779 ((type) == ARTWORK_TYPE_GRAPHICS ? \
780 gfx.override_level_graphics : \
781 (type) == ARTWORK_TYPE_SOUNDS ? \
782 gfx.override_level_sounds : \
783 gfx.override_level_music)
785 #define ARTWORK_FIRST_NODE(artwork, type) \
786 ((type) == ARTWORK_TYPE_GRAPHICS ? \
787 (artwork).gfx_first : \
788 (type) == ARTWORK_TYPE_SOUNDS ? \
789 (artwork).snd_first : \
792 #define ARTWORK_CURRENT_IDENTIFIER_PTR(artwork, type) \
793 ((type) == ARTWORK_TYPE_GRAPHICS ? \
794 &(artwork).gfx_current_identifier : \
795 (type) == ARTWORK_TYPE_SOUNDS ? \
796 &(artwork).snd_current_identifier : \
797 &(artwork).mus_current_identifier)
799 #define ARTWORK_CURRENT_IDENTIFIER(artwork, type) \
800 ((type) == ARTWORK_TYPE_GRAPHICS ? \
801 (artwork).gfx_current_identifier : \
802 (type) == ARTWORK_TYPE_SOUNDS ? \
803 (artwork).snd_current_identifier : \
804 (artwork).mus_current_identifier)
806 #define ARTWORKINFO_FILENAME(type) \
807 ((type) == ARTWORK_TYPE_GRAPHICS ? \
808 GRAPHICSINFO_FILENAME : \
809 (type) == ARTWORK_TYPE_SOUNDS ? \
810 SOUNDSINFO_FILENAME : \
811 (type) == ARTWORK_TYPE_MUSIC ? \
812 MUSICINFO_FILENAME : "")
814 #define ARTWORK_DIRECTORY(type) \
815 ((type) == ARTWORK_TYPE_GRAPHICS ? \
816 GRAPHICS_DIRECTORY : \
817 (type) == ARTWORK_TYPE_SOUNDS ? \
819 (type) == ARTWORK_TYPE_MUSIC ? \
820 MUSIC_DIRECTORY : "")
822 #define OPTIONS_ARTWORK_DIRECTORY(type) \
823 ((type) == ARTWORK_TYPE_GRAPHICS ? \
824 options.graphics_directory : \
825 (type) == ARTWORK_TYPE_SOUNDS ? \
826 options.sounds_directory : \
827 (type) == ARTWORK_TYPE_MUSIC ? \
828 options.music_directory : "")
830 #define UPDATE_BUSY_STATE() \
832 if (gfx.draw_busy_anim_function != NULL) \
833 gfx.draw_busy_anim_function(); \
837 // structure definitions
841 char *command_basepath; // path to the program binary
842 char *command_basename; // base filename of the program binary
844 char *config_filename; // optional global program config filename
846 char *maindata_path; // main game data (installation) directory
848 char *userdata_subdir; // personal user game data directory
849 char *userdata_path; // resulting full path to game data directory
859 char *log_filename[NUM_LOGS]; // log filenames for out/err messages
860 FILE *log_file[NUM_LOGS]; // log file handles for out/err files
861 FILE *log_file_default[NUM_LOGS]; // default log file handles (out/err)
869 char *version_string;
871 char *(*window_title_function)(void);
872 void (*exit_message_function)(char *, va_list);
873 void (*exit_function)(int);
875 boolean global_scores;
876 boolean many_scores_per_name;
897 char *ro_base_directory;
898 char *rw_base_directory;
899 char *level_directory;
900 char *graphics_directory;
901 char *sounds_directory;
902 char *music_directory;
903 char *docs_directory;
904 char *conf_directory;
906 char *execute_command;
917 struct VideoSystemInfo
920 int width, height, depth;
921 int window_width, window_height;
922 int display_width, display_height;
923 int screen_width, screen_height;
924 int screen_xoffset, screen_yoffset;
926 boolean fullscreen_available;
927 boolean fullscreen_enabled;
928 boolean fullscreen_initial;
930 boolean window_scaling_available;
931 int window_scaling_percent;
932 char *window_scaling_quality;
933 int screen_rendering_mode;
936 unsigned int frame_delay;
937 unsigned int frame_delay_value;
941 int shifted_up_pos_last;
942 unsigned int shifted_up_delay;
943 unsigned int shifted_up_delay_value;
948 struct AudioSystemInfo
950 boolean sound_available;
951 boolean loops_available;
952 boolean music_available;
954 boolean sound_enabled;
955 boolean sound_deactivated; // for temporarily disabling sound
964 int first_sound_channel;
967 struct FontBitmapInfo
971 int src_x, src_y; // start position of font characters
972 int width, height; // width / height of font characters
974 int offset_x; // offset to next font character
975 int offset_y; // offset to next font character
977 int draw_xoffset; // offset for drawing font characters
978 int draw_yoffset; // offset for drawing font characters
981 int num_chars_per_line;
988 int real_sx, real_sy;
989 int full_sxsize, full_sysize;
990 int scrollbuffer_width, scrollbuffer_height;
992 int game_tile_size, standard_tile_size;
1003 int win_xsize, win_ysize;
1005 int draw_deactivation_mask;
1006 int draw_background_mask;
1008 Bitmap *field_save_buffer;
1010 Bitmap *background_bitmap;
1011 int background_bitmap_mask;
1013 Bitmap *fade_bitmap_backup;
1014 Bitmap *fade_bitmap_source;
1015 Bitmap *fade_bitmap_target;
1016 Bitmap *fade_bitmap_black;
1018 int fade_border_source_status;
1019 int fade_border_target_status;
1020 Bitmap *masked_border_bitmap_ptr;
1022 Bitmap *final_screen_bitmap;
1024 boolean clipping_enabled;
1026 int clip_width, clip_height;
1028 boolean override_level_graphics;
1029 boolean override_level_sounds;
1030 boolean override_level_music;
1032 boolean draw_init_text;
1035 struct FontBitmapInfo *font_bitmap_info;
1036 int (*select_font_function)(int);
1037 int (*get_font_from_token_function)(char *);
1039 int anim_random_frame;
1041 void (*draw_busy_anim_function)(void);
1042 void (*draw_global_anim_function)(int, int);
1043 void (*draw_global_border_function)(int);
1044 void (*draw_tile_cursor_function)(int);
1049 struct TileCursorInfo
1051 boolean enabled; // tile cursor generally enabled or disabled
1052 boolean active; // tile cursor activated (depending on game)
1053 boolean moving; // tile cursor moving to target position
1055 int xpos, ypos; // tile cursor level playfield position
1056 int x, y; // tile cursor current screen position
1057 int target_x, target_y; // tile cursor target screen position
1059 int sx, sy; // tile cursor screen start position
1064 boolean enabled; // overlay generally enabled or disabled
1065 boolean active; // overlay activated (depending on game mode)
1072 char grid_button[MAX_GRID_XSIZE][MAX_GRID_YSIZE];
1073 char grid_button_highlight;
1075 int grid_button_action;
1081 int nr[MAX_PLAYERS]; // joystick number for each player
1084 struct SetupJoystickInfo
1086 char *device_name; // device name of player's joystick
1088 int xleft, xmiddle, xright;
1089 int yupper, ymiddle, ylower;
1093 struct SetupKeyboardInfo
1095 Key left, right, up, down;
1099 struct SetupTouchInfo
1108 char grid_button[2][MAX_GRID_XSIZE][MAX_GRID_YSIZE];
1110 int transparency; // in percent (0 == opaque, 100 == invisible)
1111 boolean draw_outlined;
1112 boolean draw_pressed;
1114 boolean grid_initialized;
1117 struct SetupInputInfo
1119 boolean use_joystick;
1120 struct SetupJoystickInfo joy;
1121 struct SetupKeyboardInfo key;
1124 struct SetupEditorInfo
1126 boolean el_boulderdash;
1127 boolean el_emerald_mine;
1128 boolean el_emerald_mine_club;
1131 boolean el_supaplex;
1132 boolean el_diamond_caves;
1133 boolean el_dx_boulderdash;
1135 boolean el_mirror_magic;
1136 boolean el_deflektor;
1139 boolean el_steel_chars;
1143 boolean el_user_defined;
1146 boolean el_headlines;
1151 boolean show_element_token;
1153 boolean use_template_for_new_levels;
1156 struct SetupAutoSetupInfo
1158 int editor_zoom_tilesize;
1161 struct SetupEditorCascadeInfo
1174 boolean el_steel_chars;
1182 struct SetupShortcutInfo
1188 Key focus_player[MAX_PLAYERS];
1189 Key focus_player_all;
1208 struct SetupSystemInfo
1210 char *sdl_videodriver;
1211 char *sdl_audiodriver;
1212 int audio_fragment_size;
1215 struct SetupInternalInfo
1217 char *program_title;
1218 char *program_version;
1219 char *program_author;
1220 char *program_email;
1221 char *program_website;
1222 char *program_copyright;
1223 char *program_company;
1225 char *program_icon_file;
1227 char *default_graphics_set;
1228 char *default_sounds_set;
1229 char *default_music_set;
1231 char *fallback_graphics_file;
1232 char *fallback_sounds_file;
1233 char *fallback_music_file;
1235 char *default_level_series;
1237 int default_window_width;
1238 int default_window_height;
1240 boolean choose_from_top_leveldir;
1241 boolean show_scaling_in_title;
1244 struct SetupDebugInfo
1246 int frame_delay[10];
1247 Key frame_delay_key[10];
1248 boolean frame_delay_use_mod_key;
1249 boolean frame_delay_game_only;
1250 boolean show_frames_per_second;
1258 boolean sound_loops;
1259 boolean sound_music;
1260 boolean sound_simple;
1262 boolean scroll_delay;
1263 boolean scroll_delay_value;
1264 char *engine_snapshot_mode;
1265 int engine_snapshot_memory;
1266 boolean fade_screens;
1268 boolean show_titlescreen;
1269 boolean quick_doors;
1272 boolean skip_levels;
1273 boolean increment_levels;
1274 boolean auto_play_next_level;
1275 boolean skip_scores_after_game;
1278 int window_scaling_percent;
1279 char *window_scaling_quality;
1280 char *screen_rendering_mode;
1282 boolean ask_on_escape;
1283 boolean ask_on_escape_editor;
1284 boolean ask_on_game_over;
1285 boolean quick_switch;
1286 boolean input_on_focus;
1287 boolean prefer_aga_graphics;
1288 boolean game_speed_extended;
1289 int game_frame_delay;
1290 boolean sp_show_border_elements;
1291 boolean small_game_graphics;
1292 boolean show_snapshot_buttons;
1297 int override_level_graphics; // not boolean -- can also be "AUTO"
1298 int override_level_sounds; // not boolean -- can also be "AUTO"
1299 int override_level_music; // not boolean -- can also be "AUTO"
1305 boolean network_mode;
1306 int network_player_nr;
1307 char *network_server_hostname;
1309 struct SetupAutoSetupInfo auto_setup;
1310 struct SetupEditorInfo editor;
1311 struct SetupEditorCascadeInfo editor_cascade;
1312 struct SetupShortcutInfo shortcut;
1313 struct SetupInputInfo input[MAX_PLAYERS];
1314 struct SetupTouchInfo touch;
1315 struct SetupSystemInfo system;
1316 struct SetupInternalInfo internal;
1317 struct SetupDebugInfo debug;
1319 struct OptionInfo options;
1324 struct TreeInfo **node_top; // topmost node in tree
1325 struct TreeInfo *node_parent; // parent level directory info
1326 struct TreeInfo *node_group; // level group sub-directory info
1327 struct TreeInfo *next; // next level series structure node
1329 int cl_first; // internal control field for setup screen
1330 int cl_cursor; // internal control field for setup screen
1332 int type; // type of tree content
1334 // fields for "type == TREE_TYPE_LEVEL_DIR"
1336 char *subdir; // tree info sub-directory basename (may be ".")
1337 char *fullpath; // complete path relative to tree base directory
1338 char *basepath; // absolute base path of tree base directory
1339 char *identifier; // identifier string for configuration files
1340 char *name; // tree info name, as displayed in selection menues
1341 char *name_sorting; // optional sorting name for correct name sorting
1342 char *author; // level or artwork author name
1343 char *year; // optional year of creation for levels or artwork
1345 char *program_title; // optional alternative text for program title
1346 char *program_copyright; // optional alternative text for program copyright
1347 char *program_company; // optional alternative text for program company
1349 char *imported_from; // optional comment for imported levels or artwork
1350 char *imported_by; // optional comment for imported levels or artwork
1351 char *tested_by; // optional comment to name people who tested a set
1353 char *graphics_set_ecs; // special EMC custom graphics set (ECS graphics)
1354 char *graphics_set_aga; // special EMC custom graphics set (AGA graphics)
1355 char *graphics_set; // optional custom graphics set (level tree only)
1356 char *sounds_set; // optional custom sounds set (level tree only)
1357 char *music_set; // optional custom music set (level tree only)
1358 char *graphics_path; // path to optional custom graphics set (level only)
1359 char *sounds_path; // path to optional custom sounds set (level only)
1360 char *music_path; // path to optional custom music set (level only)
1362 char *level_filename; // filename of level file (for packed level file)
1363 char *level_filetype; // type of levels in level directory or level file
1365 char *special_flags; // flags for special actions performed on level file
1367 int levels; // number of levels in level series
1368 int first_level; // first level number (to allow start with 0 or 1)
1369 int last_level; // last level number (automatically calculated)
1370 int sort_priority; // sort levels by 'sort_priority' and then by name
1372 boolean latest_engine;// force level set to use the latest game engine
1374 boolean level_group; // directory contains more level series directories
1375 boolean parent_link; // entry links back to parent directory
1376 boolean in_user_dir; // user defined levels are stored in home directory
1377 boolean user_defined; // levels in user directory and marked as "private"
1378 boolean readonly; // readonly levels can not be changed with editor
1379 boolean handicap; // level set has no handicap when set to "false"
1380 boolean skip_levels; // levels can be skipped when set to "true"
1382 int color; // color to use on selection screen for this level
1383 char *class_desc; // description of level series class
1384 int handicap_level; // number of the lowest unsolved level
1386 char *infotext; // optional text to describe the tree type (headline)
1389 typedef struct TreeInfo TreeInfo;
1390 typedef struct TreeInfo LevelDirTree;
1391 typedef struct TreeInfo ArtworkDirTree;
1392 typedef struct TreeInfo GraphicsDirTree;
1393 typedef struct TreeInfo SoundsDirTree;
1394 typedef struct TreeInfo MusicDirTree;
1398 GraphicsDirTree *gfx_first;
1399 GraphicsDirTree *gfx_current;
1400 SoundsDirTree *snd_first;
1401 SoundsDirTree *snd_current;
1402 MusicDirTree *mus_first;
1403 MusicDirTree *mus_current;
1405 char *gfx_current_identifier;
1406 char *snd_current_identifier;
1407 char *mus_current_identifier;
1410 struct ValueTextInfo
1416 struct StringValueTextInfo
1428 struct ConfigTypeInfo
1435 struct TokenIntPtrInfo
1445 char *default_filename;
1448 char **default_parameter; // array of file parameters
1449 char **parameter; // array of file parameters
1452 boolean fallback_to_default;
1453 boolean default_is_cloned;
1456 struct SetupFileList
1461 struct SetupFileList *next;
1466 char *source_filename; // primary key for node list
1470 struct PropertyMapping
1480 struct ArtworkListInfo
1482 int type; // type of artwork
1484 int num_file_list_entries;
1485 int num_dynamic_file_list_entries;
1486 struct FileInfo *file_list; // static artwork file array
1487 struct FileInfo *dynamic_file_list; // dynamic artwrk file array
1489 int num_suffix_list_entries;
1490 struct ConfigTypeInfo *suffix_list; // parameter suffixes array
1492 int num_base_prefixes;
1493 int num_ext1_suffixes;
1494 int num_ext2_suffixes;
1495 int num_ext3_suffixes;
1496 char **base_prefixes; // base token prefixes array
1497 char **ext1_suffixes; // property suffixes array 1
1498 char **ext2_suffixes; // property suffixes array 2
1499 char **ext3_suffixes; // property suffixes array 3
1501 int num_ignore_tokens;
1502 char **ignore_tokens; // file tokens to be ignored
1504 int num_property_mapping_entries;
1505 struct PropertyMapping *property_mapping; // mapping token -> artwork
1507 int sizeof_artwork_list_entry;
1509 struct ListNodeInfo **artwork_list; // static artwork node array
1510 struct ListNodeInfo **dynamic_artwork_list; // dynamic artwrk node array
1511 struct ListNode *content_list; // dynamic artwork node list
1513 void *(*load_artwork)(char *); // constructor function
1514 void (*free_artwork)(void *); // destructor function
1534 struct RectWithBorder
1538 int min_width, min_height;
1539 int max_width, max_height;
1560 struct DoorPartPosInfo
1567 int start_step_opening;
1568 int start_step_closing;
1569 boolean draw_masked;
1576 int xoffset; // special case for tape date and time
1577 int xoffset2; // special case for tape date
1578 int yoffset; // special case for list of preview players
1581 int size; // also used for suffix ".digits"
1583 boolean draw_masked;
1584 boolean draw_player; // special case for network player buttons
1585 int sort_priority; // also used for suffix ".draw_order"
1588 int direction; // needed for panel time/health graphics
1589 int class; // needed for panel time/health graphics
1590 int style; // needed for panel time/health graphics
1592 int tile_size; // special case for list of network players
1593 int border_size; // special case for list of preview players
1594 int vertical; // special case for list of preview players
1597 struct MouseActionInfo
1606 int music[MAX_LEVELS];
1619 // ============================================================================
1620 // exported variables
1621 // ============================================================================
1623 extern struct ProgramInfo program;
1624 extern struct NetworkInfo network;
1625 extern struct OptionInfo options;
1626 extern struct VideoSystemInfo video;
1627 extern struct AudioSystemInfo audio;
1628 extern struct GfxInfo gfx;
1629 extern struct TileCursorInfo tile_cursor;
1630 extern struct OverlayInfo overlay;
1631 extern struct AnimInfo anim;
1632 extern struct ArtworkInfo artwork;
1633 extern struct JoystickInfo joystick;
1634 extern struct SetupInfo setup;
1636 extern LevelDirTree *leveldir_first_all;
1637 extern LevelDirTree *leveldir_first;
1638 extern LevelDirTree *leveldir_current;
1639 extern int level_nr;
1641 extern struct LevelSetInfo levelset;
1642 extern struct LevelStats level_stats[];
1644 extern DrawWindow *window;
1645 extern DrawBuffer *backbuffer;
1646 extern DrawBuffer *drawto;
1648 extern int button_status;
1649 extern boolean motion_status;
1650 extern int wheel_steps;
1651 extern boolean keyrepeat_status;
1653 extern int redraw_mask;
1655 extern int FrameCounter;
1658 // function definitions
1660 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
1662 void InitNetworkInfo(boolean, boolean, boolean, char *, int);
1664 void InitScoresInfo(void);
1665 void SetWindowTitle(void);
1667 void InitWindowTitleFunction(char *(*window_title_function)(void));
1668 void InitExitMessageFunction(void (*exit_message_function)(char *, va_list));
1669 void InitExitFunction(void (*exit_function)(int));
1670 void InitPlatformDependentStuff(void);
1671 void ClosePlatformDependentStuff(void);
1673 void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
1674 void InitGfxTileSizeInfo(int, int);
1675 void InitGfxDoor1Info(int, int, int, int);
1676 void InitGfxDoor2Info(int, int, int, int);
1677 void InitGfxDoor3Info(int, int, int, int);
1678 void InitGfxWindowInfo(int, int);
1679 void InitGfxScrollbufferInfo(int, int);
1680 void InitGfxClipRegion(boolean, int, int, int, int);
1681 void InitGfxDrawBusyAnimFunction(void (*draw_busy_anim_function)(void));
1682 void InitGfxDrawGlobalAnimFunction(void (*draw_global_anim_function)(int, int));
1683 void InitGfxDrawGlobalBorderFunction(void (*draw_global_border_function)(int));
1684 void InitGfxDrawTileCursorFunction(void (*draw_tile_cursor_function)(int));
1685 void InitGfxCustomArtworkInfo(void);
1686 void InitGfxOtherSettings(void);
1687 void InitTileCursorInfo(void);
1688 void InitOverlayInfo(void);
1689 void SetTileCursorEnabled(boolean);
1690 void SetTileCursorActive(boolean);
1691 void SetTileCursorTargetXY(int, int);
1692 void SetTileCursorXY(int, int);
1693 void SetTileCursorSXSY(int, int);
1694 void SetOverlayEnabled(boolean);
1695 void SetOverlayActive(boolean);
1696 void SetOverlayShowGrid(boolean);
1697 boolean GetOverlayEnabled(void);
1698 boolean GetOverlayActive(void);
1699 void SetDrawDeactivationMask(int);
1700 int GetDrawDeactivationMask(void);
1701 void SetDrawBackgroundMask(int);
1702 void SetWindowBackgroundBitmap(Bitmap *);
1703 void SetMainBackgroundBitmap(Bitmap *);
1704 void SetDoorBackgroundBitmap(Bitmap *);
1705 void SetRedrawMaskFromArea(int, int, int, int);
1707 void LimitScreenUpdates(boolean);
1709 void InitVideoDefaults(void);
1710 void InitVideoDisplay(void);
1711 void CloseVideoDisplay(void);
1712 void InitVideoBuffer(int, int, int, boolean);
1713 Bitmap *CreateBitmapStruct(void);
1714 Bitmap *CreateBitmap(int, int, int);
1715 void ReCreateBitmap(Bitmap **, int, int);
1716 void FreeBitmap(Bitmap *);
1717 void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
1718 void BlitBitmapTiled(Bitmap *, Bitmap *, int, int, int, int, int, int, int,int);
1719 void FadeRectangle(int, int, int, int, int, int, int,
1720 void (*draw_border_function)(void));
1721 void FillRectangle(Bitmap *, int, int, int, int, Pixel);
1722 void ClearRectangle(Bitmap *, int, int, int, int);
1723 void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
1724 void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
1725 boolean DrawingDeactivatedField(void);
1726 boolean DrawingDeactivated(int, int, int, int);
1727 boolean DrawingOnBackground(int, int);
1728 boolean DrawingAreaChanged(void);
1729 void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int, int);
1730 void BlitTexture(Bitmap *, int, int, int, int, int, int);
1731 void BlitTextureMasked(Bitmap *, int, int, int, int, int, int);
1732 void BlitToScreen(Bitmap *, int, int, int, int, int, int);
1733 void BlitToScreenMasked(Bitmap *, int, int, int, int, int, int);
1734 void DrawSimpleBlackLine(Bitmap *, int, int, int, int);
1735 void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
1736 void DrawLines(Bitmap *, struct XY *, int, Pixel);
1737 Pixel GetPixel(Bitmap *, int, int);
1738 Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
1739 Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
1741 void KeyboardAutoRepeatOn(void);
1742 void KeyboardAutoRepeatOff(void);
1743 boolean SetVideoMode(boolean);
1744 void SetVideoFrameDelay(unsigned int);
1745 unsigned int GetVideoFrameDelay(void);
1746 boolean ChangeVideoModeIfNeeded(boolean);
1748 Bitmap *LoadImage(char *);
1749 Bitmap *LoadCustomImage(char *);
1750 void ReloadCustomImage(Bitmap *, char *);
1752 void ReCreateGameTileSizeBitmap(Bitmap **);
1753 void CreateBitmapWithSmallBitmaps(Bitmap **, int, int);
1754 void CreateBitmapTextures(Bitmap **);
1755 void FreeBitmapTextures(Bitmap **);
1756 void ScaleBitmap(Bitmap **, int);
1758 void SetMouseCursor(int);
1760 void OpenAudio(void);
1761 void CloseAudio(void);
1762 void SetAudioMode(boolean);
1764 boolean PendingEvent(void);
1765 void WaitEvent(Event *event);
1766 void PeekEvent(Event *event);
1767 void CheckQuitEvent(void);
1768 Key GetEventKey(KeyEvent *, boolean);
1769 KeyMod HandleKeyModState(Key, int);
1770 KeyMod GetKeyModState(void);
1771 KeyMod GetKeyModStateFromEvents(void);
1772 void StartTextInput(int, int, int, int);
1773 void StopTextInput(void);
1774 boolean CheckCloseWindowEvent(ClientMessageEvent *);
1776 void InitJoysticks(void);
1777 boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
1778 boolean CheckJoystickOpened(int);
1779 void ClearJoystickState(void);