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 // values for drag-and-drop support (some parts not added before SDL 2.0.5)
122 #if SDL_VERSION_ATLEAST(2,0,5)
123 #define USE_DRAG_AND_DROP
126 // default input keys
127 #define DEFAULT_KEY_LEFT KSYM_Left
128 #define DEFAULT_KEY_RIGHT KSYM_Right
129 #define DEFAULT_KEY_UP KSYM_Up
130 #define DEFAULT_KEY_DOWN KSYM_Down
131 #if defined(PLATFORM_MACOSX)
132 #define DEFAULT_KEY_SNAP KSYM_Control_L
133 #define DEFAULT_KEY_DROP KSYM_KP_Enter
135 #define DEFAULT_KEY_SNAP KSYM_Control_L
136 #define DEFAULT_KEY_DROP KSYM_Control_R
138 #define DEFAULT_KEY_OKAY KSYM_Return
139 #define DEFAULT_KEY_CANCEL KSYM_Escape
141 // default shortcut keys
142 #define DEFAULT_KEY_SAVE_GAME KSYM_F1
143 #define DEFAULT_KEY_LOAD_GAME KSYM_F2
144 #define DEFAULT_KEY_TOGGLE_PAUSE KSYM_space
145 #define DEFAULT_KEY_FOCUS_PLAYER_1 KSYM_F5
146 #define DEFAULT_KEY_FOCUS_PLAYER_2 KSYM_F6
147 #define DEFAULT_KEY_FOCUS_PLAYER_3 KSYM_F7
148 #define DEFAULT_KEY_FOCUS_PLAYER_4 KSYM_F8
149 #define DEFAULT_KEY_FOCUS_PLAYER_ALL KSYM_F9
150 #define DEFAULT_KEY_TAPE_EJECT KSYM_UNDEFINED
151 #define DEFAULT_KEY_TAPE_EXTRA KSYM_UNDEFINED
152 #define DEFAULT_KEY_TAPE_STOP KSYM_UNDEFINED
153 #define DEFAULT_KEY_TAPE_PAUSE KSYM_UNDEFINED
154 #define DEFAULT_KEY_TAPE_RECORD KSYM_UNDEFINED
155 #define DEFAULT_KEY_TAPE_PLAY KSYM_UNDEFINED
156 #define DEFAULT_KEY_SOUND_SIMPLE KSYM_UNDEFINED
157 #define DEFAULT_KEY_SOUND_LOOPS KSYM_UNDEFINED
158 #define DEFAULT_KEY_SOUND_MUSIC KSYM_UNDEFINED
159 #define DEFAULT_KEY_SNAP_LEFT KSYM_UNDEFINED
160 #define DEFAULT_KEY_SNAP_RIGHT KSYM_UNDEFINED
161 #define DEFAULT_KEY_SNAP_UP KSYM_UNDEFINED
162 #define DEFAULT_KEY_SNAP_DOWN KSYM_UNDEFINED
164 // default debug setup keys and values
165 #define DEFAULT_FRAME_DELAY_0 20 // 100 % speed
166 #define DEFAULT_FRAME_DELAY_1 500 // 4 % speed
167 #define DEFAULT_FRAME_DELAY_2 250 // 8 % speed
168 #define DEFAULT_FRAME_DELAY_3 125 // 16 % speed
169 #define DEFAULT_FRAME_DELAY_4 60 // 33 % speed
170 #define DEFAULT_FRAME_DELAY_5 40 // 50 % speed
171 #define DEFAULT_FRAME_DELAY_6 30 // 66 % speed
172 #define DEFAULT_FRAME_DELAY_7 10 // 200 % speed
173 #define DEFAULT_FRAME_DELAY_8 5 // 400 % speed
174 #define DEFAULT_FRAME_DELAY_9 0 // maximum speed
176 #define DEFAULT_KEY_FRAME_DELAY_0 KSYM_0
177 #define DEFAULT_KEY_FRAME_DELAY_1 KSYM_1
178 #define DEFAULT_KEY_FRAME_DELAY_2 KSYM_2
179 #define DEFAULT_KEY_FRAME_DELAY_3 KSYM_3
180 #define DEFAULT_KEY_FRAME_DELAY_4 KSYM_4
181 #define DEFAULT_KEY_FRAME_DELAY_5 KSYM_5
182 #define DEFAULT_KEY_FRAME_DELAY_6 KSYM_6
183 #define DEFAULT_KEY_FRAME_DELAY_7 KSYM_7
184 #define DEFAULT_KEY_FRAME_DELAY_8 KSYM_8
185 #define DEFAULT_KEY_FRAME_DELAY_9 KSYM_9
187 #define NUM_DEBUG_FRAME_DELAY_KEYS 10
189 #define DEFAULT_FRAME_DELAY_USE_MOD_KEY FALSE
190 #define DEFAULT_FRAME_DELAY_GAME_ONLY TRUE
192 // values for key_status
193 #define KEY_NOT_PRESSED FALSE
194 #define KEY_RELEASED FALSE
195 #define KEY_PRESSED TRUE
197 // values for button status
198 #define MB_NOT_PRESSED FALSE
199 #define MB_NOT_RELEASED TRUE
200 #define MB_RELEASED FALSE
201 #define MB_PRESSED TRUE
202 #define MB_MENU_CHOICE FALSE
203 #define MB_MENU_MARK TRUE
204 #define MB_MENU_INITIALIZE (-1)
205 #define MB_MENU_LEAVE (-2)
206 #define MB_LEFTBUTTON 1
207 #define MB_MIDDLEBUTTON 2
208 #define MB_RIGHTBUTTON 3
209 #define MB_WHEEL_UP 4
210 #define MB_WHEEL_DOWN 5
211 #define MB_WHEEL_LEFT 6
212 #define MB_WHEEL_RIGHT 7
213 #define IS_WHEEL_BUTTON_VERTICAL(b) ((b) == MB_WHEEL_UP || \
214 (b) == MB_WHEEL_DOWN)
215 #define IS_WHEEL_BUTTON_HORIZONTAL(b) ((b) == MB_WHEEL_LEFT || \
216 (b) == MB_WHEEL_RIGHT)
217 #define IS_WHEEL_BUTTON(b) (IS_WHEEL_BUTTON_VERTICAL(b) || \
218 IS_WHEEL_BUTTON_HORIZONTAL(b))
219 #define DEFAULT_WHEEL_STEPS 3
221 #define BUTTON_STEPSIZE(b) ((b) == MB_LEFTBUTTON ? 1 : \
222 (b) == MB_MIDDLEBUTTON ? 5 : \
223 (b) == MB_RIGHTBUTTON ? 10 : 1)
225 // values for move directions
226 #define MV_BIT_LEFT 0
227 #define MV_BIT_RIGHT 1
229 #define MV_BIT_DOWN 3
231 #define NUM_DIRECTIONS 4
233 // diagonal movement directions are used in a different contect than buttons
234 #define MV_BIT_UPLEFT 4
235 #define MV_BIT_UPRIGHT 5
236 #define MV_BIT_DOWNLEFT 6
237 #define MV_BIT_DOWNRIGHT 7
239 #define NUM_DIRECTIONS_FULL 8
241 // values for special "button" bitmasks
245 #define NUM_PLAYER_ACTIONS 6
247 // values for special "focus player" bitmasks
248 #define BIT_SET_FOCUS 6
250 // values for drawing stages for global animations
251 #define DRAW_GLOBAL_ANIM_STAGE_1 1
252 #define DRAW_GLOBAL_ANIM_STAGE_2 2
254 // values for drawing target (various functions)
255 #define DRAW_TO_BACKBUFFER 0
256 #define DRAW_TO_FIELDBUFFER 1
257 #define DRAW_TO_SCREEN 2
258 #define DRAW_TO_FADE_SOURCE 3
259 #define DRAW_TO_FADE_TARGET 4
261 // values for move directions and special "button" key bitmasks
263 #define MV_LEFT (1 << MV_BIT_LEFT)
264 #define MV_RIGHT (1 << MV_BIT_RIGHT)
265 #define MV_UP (1 << MV_BIT_UP)
266 #define MV_DOWN (1 << MV_BIT_DOWN)
268 #define MV_UPLEFT (MV_UP | MV_LEFT)
269 #define MV_UPRIGHT (MV_UP | MV_RIGHT)
270 #define MV_DOWNLEFT (MV_DOWN | MV_LEFT)
271 #define MV_DOWNRIGHT (MV_DOWN | MV_RIGHT)
273 #define MV_HORIZONTAL (MV_LEFT | MV_RIGHT)
274 #define MV_VERTICAL (MV_UP | MV_DOWN)
275 #define MV_ALL_DIRECTIONS (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
276 #define MV_ANY_DIRECTION (MV_ALL_DIRECTIONS)
277 #define MV_NO_DIRECTION (MV_NONE)
279 #define KEY_BUTTON_1 (1 << BUTTON_1)
280 #define KEY_BUTTON_2 (1 << BUTTON_2)
281 #define KEY_BUTTON_SNAP KEY_BUTTON_1
282 #define KEY_BUTTON_DROP KEY_BUTTON_2
283 #define KEY_MOTION (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
284 #define KEY_BUTTON (KEY_BUTTON_1 | KEY_BUTTON_2)
285 #define KEY_ACTION (KEY_MOTION | KEY_BUTTON)
287 #define KEY_SET_FOCUS (1 << BIT_SET_FOCUS)
289 #define MV_DIR_FROM_BIT(x) ((x) < NUM_DIRECTIONS ? 1 << (x) : \
290 (x) == MV_BIT_UPLEFT ? MV_UPLEFT : \
291 (x) == MV_BIT_UPRIGHT ? MV_UPRIGHT : \
292 (x) == MV_BIT_DOWNLEFT ? MV_DOWNLEFT : \
293 (x) == MV_BIT_DOWNRIGHT ? MV_DOWNRIGHT : \
296 #define MV_DIR_TO_BIT(x) ((x) == MV_LEFT ? MV_BIT_LEFT : \
297 (x) == MV_RIGHT ? MV_BIT_RIGHT : \
298 (x) == MV_UP ? MV_BIT_UP : \
299 (x) == MV_DOWN ? MV_BIT_DOWN : \
300 (x) == MV_UPLEFT ? MV_BIT_UPLEFT : \
301 (x) == MV_UPRIGHT ? MV_BIT_UPRIGHT : \
302 (x) == MV_DOWNLEFT ? MV_BIT_DOWNLEFT : \
303 (x) == MV_DOWNRIGHT ? MV_BIT_DOWNRIGHT : \
306 #define MV_DIR_OPPOSITE(x) ((x) == MV_LEFT ? MV_RIGHT : \
307 (x) == MV_RIGHT ? MV_LEFT : \
308 (x) == MV_UP ? MV_DOWN : \
309 (x) == MV_DOWN ? MV_UP : \
310 (x) == MV_UPLEFT ? MV_DOWNRIGHT : \
311 (x) == MV_UPRIGHT ? MV_DOWNLEFT : \
312 (x) == MV_DOWNLEFT ? MV_UPRIGHT : \
313 (x) == MV_DOWNRIGHT ? MV_UPLEFT : \
316 // values for animation mode (frame order and direction)
317 // (stored in level files -- never change existing values)
319 #define ANIM_LOOP (1 << 0)
320 #define ANIM_LINEAR (1 << 1)
321 #define ANIM_PINGPONG (1 << 2)
322 #define ANIM_PINGPONG2 (1 << 3)
323 #define ANIM_RANDOM (1 << 4)
324 #define ANIM_CE_VALUE (1 << 5)
325 #define ANIM_CE_SCORE (1 << 6)
326 #define ANIM_CE_DELAY (1 << 7)
327 #define ANIM_REVERSE (1 << 8)
328 #define ANIM_OPAQUE_PLAYER (1 << 9)
330 // values for special (non game element) animation modes
331 // (not stored in level files -- can be changed, if needed)
332 #define ANIM_HORIZONTAL (1 << 10)
333 #define ANIM_VERTICAL (1 << 11)
334 #define ANIM_CENTERED (1 << 12)
335 #define ANIM_STATIC_PANEL (1 << 13)
336 #define ANIM_ALL (1 << 14)
337 #define ANIM_ONCE (1 << 15)
339 #define ANIM_DEFAULT ANIM_LOOP
341 // values for special drawing styles (currently only for crumbled graphics)
343 #define STYLE_ACCURATE_BORDERS (1 << 0)
344 #define STYLE_INNER_CORNERS (1 << 1)
345 #define STYLE_REVERSE (1 << 2)
347 // values for special event handling style (used for global animation)
348 #define STYLE_PASSTHROUGH (1 << 3)
349 #define STYLE_MULTIPLE_ACTIONS (1 << 4)
351 #define STYLE_DEFAULT STYLE_NONE
353 // values for special global animation events
354 #define ANIM_EVENT_NONE 0
355 #define ANIM_EVENT_SELF (1 << 16)
356 #define ANIM_EVENT_ANY (1 << 17)
358 #define ANIM_EVENT_ANIM_BIT 0
359 #define ANIM_EVENT_PART_BIT 8
361 #define ANIM_EVENT_ANIM_MASK (0xff << ANIM_EVENT_ANIM_BIT)
362 #define ANIM_EVENT_PART_MASK (0xff << ANIM_EVENT_PART_BIT)
364 #define ANIM_EVENT_DEFAULT ANIM_EVENT_NONE
366 // values for special global animation event actions
367 #define ANIM_EVENT_ACTION_NONE -1
369 // values for fade mode
370 #define FADE_TYPE_NONE 0
371 #define FADE_TYPE_FADE_IN (1 << 0)
372 #define FADE_TYPE_FADE_OUT (1 << 1)
373 #define FADE_TYPE_TRANSFORM (1 << 2)
374 #define FADE_TYPE_CROSSFADE (1 << 3)
375 #define FADE_TYPE_MELT (1 << 4)
376 #define FADE_TYPE_CURTAIN (1 << 5)
377 #define FADE_TYPE_SKIP (1 << 6)
379 #define FADE_MODE_NONE (FADE_TYPE_NONE)
380 #define FADE_MODE_FADE_IN (FADE_TYPE_FADE_IN)
381 #define FADE_MODE_FADE_OUT (FADE_TYPE_FADE_OUT)
382 #define FADE_MODE_FADE (FADE_TYPE_FADE_IN | FADE_TYPE_FADE_OUT)
383 #define FADE_MODE_TRANSFORM (FADE_TYPE_TRANSFORM | FADE_TYPE_FADE_IN)
384 #define FADE_MODE_CROSSFADE (FADE_MODE_TRANSFORM | FADE_TYPE_CROSSFADE)
385 #define FADE_MODE_MELT (FADE_MODE_TRANSFORM | FADE_TYPE_MELT)
386 #define FADE_MODE_CURTAIN (FADE_MODE_TRANSFORM | FADE_TYPE_CURTAIN)
387 #define FADE_MODE_SKIP_FADE_IN (FADE_TYPE_SKIP | FADE_TYPE_FADE_IN)
388 #define FADE_MODE_SKIP_FADE_OUT (FADE_TYPE_SKIP | FADE_TYPE_FADE_OUT)
390 #define FADE_MODE_DEFAULT FADE_MODE_FADE
392 // values for toon positions
393 #define POS_UNDEFINED -1
404 // values for text alignment
405 #define ALIGN_LEFT (1 << 0)
406 #define ALIGN_RIGHT (1 << 1)
407 #define ALIGN_CENTER (1 << 2)
408 #define ALIGN_DEFAULT ALIGN_LEFT
410 #define VALIGN_TOP (1 << 0)
411 #define VALIGN_BOTTOM (1 << 1)
412 #define VALIGN_MIDDLE (1 << 2)
413 #define VALIGN_DEFAULT VALIGN_TOP
415 #define ALIGNED_XPOS(x,w,a) ((a) == ALIGN_CENTER ? (x) - (w) / 2 : \
416 (a) == ALIGN_RIGHT ? (x) - (w) : (x))
417 #define ALIGNED_YPOS(y,h,v) ((v) == VALIGN_MIDDLE ? (y) - (h) / 2 : \
418 (v) == VALIGN_BOTTOM ? (y) - (h) : (y))
419 #define ALIGNED_TEXT_XPOS(p) ALIGNED_XPOS((p)->x, (p)->width, (p)->align)
420 #define ALIGNED_TEXT_YPOS(p) ALIGNED_YPOS((p)->y, (p)->height, (p)->valign)
421 #define ALIGNED_VP_XPOS(p) ALIGNED_TEXT_XPOS(p)
422 #define ALIGNED_VP_YPOS(p) ALIGNED_TEXT_YPOS(p)
424 // values for redraw_mask
425 #define REDRAW_NONE (0)
426 #define REDRAW_ALL (1 << 0)
427 #define REDRAW_FIELD (1 << 1)
428 #define REDRAW_DOOR_1 (1 << 2)
429 #define REDRAW_DOOR_2 (1 << 3)
430 #define REDRAW_DOOR_3 (1 << 4)
431 #define REDRAW_FPS (1 << 5)
433 #define REDRAW_DOORS (REDRAW_DOOR_1 | \
437 #define IN_GFX_FIELD_PLAY(x, y) (x >= gfx.sx && x < gfx.sx + gfx.sxsize && \
438 y >= gfx.sy && y < gfx.sy + gfx.sysize)
439 #define IN_GFX_FIELD_FULL(x, y) (x >= gfx.real_sx && \
440 x < gfx.real_sx + gfx.full_sxsize && \
441 y >= gfx.real_sy && \
442 y < gfx.real_sy + gfx.full_sysize)
443 #define IN_GFX_DOOR_1(x, y) (x >= gfx.dx && x < gfx.dx + gfx.dxsize && \
444 y >= gfx.dy && y < gfx.dy + gfx.dysize)
445 #define IN_GFX_DOOR_2(x, y) (x >= gfx.vx && x < gfx.vx + gfx.vxsize && \
446 y >= gfx.vy && y < gfx.vy + gfx.vysize)
447 #define IN_GFX_DOOR_3(x, y) (x >= gfx.ex && x < gfx.ex + gfx.exsize && \
448 y >= gfx.ey && y < gfx.ey + gfx.eysize)
450 // values for mouse cursor
451 #define CURSOR_DEFAULT 0
452 #define CURSOR_NONE 1
453 #define CURSOR_PLAYFIELD 2
455 // fundamental game speed values
456 #define ONE_SECOND_DELAY 1000 // delay value for one second
457 #define MENU_FRAME_DELAY 20 // frame delay in milliseconds
458 #define GAME_FRAME_DELAY 20 // frame delay in milliseconds
459 #define FFWD_FRAME_DELAY 10 // 200% speed for fast forward
460 #define MIN_VSYNC_FRAME_DELAY 15 // minimum value for vsync to keep
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
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
661 // these values are hard-coded to be able to use them in initialization
662 #define DOOR_GFX_PAGE_WIDTH 100 // should be set to "gfx.dxsize"
663 #define DOOR_GFX_PAGE_HEIGHT 280 // should be set to "gfx.dysize"
665 #define DOOR_GFX_PAGESIZE (DOOR_GFX_PAGE_WIDTH)
666 #define DOOR_GFX_PAGEX1 (0 * DOOR_GFX_PAGESIZE)
667 #define DOOR_GFX_PAGEX2 (1 * DOOR_GFX_PAGESIZE)
668 #define DOOR_GFX_PAGEX3 (2 * DOOR_GFX_PAGESIZE)
669 #define DOOR_GFX_PAGEX4 (3 * DOOR_GFX_PAGESIZE)
670 #define DOOR_GFX_PAGEX5 (4 * DOOR_GFX_PAGESIZE)
671 #define DOOR_GFX_PAGEX6 (5 * DOOR_GFX_PAGESIZE)
672 #define DOOR_GFX_PAGEX7 (6 * DOOR_GFX_PAGESIZE)
673 #define DOOR_GFX_PAGEX8 (7 * DOOR_GFX_PAGESIZE)
674 #define DOOR_GFX_PAGEY1 (0)
675 #define DOOR_GFX_PAGEY2 (DOOR_GFX_PAGE_HEIGHT)
678 // macros for version handling
679 #define VERSION_PART_1(x) ((x) / 1000000)
680 #define VERSION_PART_2(x) (((x) % 1000000) / 10000)
681 #define VERSION_PART_3(x) (((x) % 10000) / 100)
682 #define VERSION_PART_4(x) ((x) % 100)
684 #define VERSION_SUPER(x) VERSION_PART_1(x)
685 #define VERSION_MAJOR(x) VERSION_PART_2(x)
686 #define VERSION_MINOR(x) VERSION_PART_3(x)
687 #define VERSION_PATCH(x) VERSION_PART_4(x)
688 #define VERSION_IDENT(a,b,c,d) ((a) * 1000000 + (b) * 10000 + (c) * 100 + (d))
691 // macros for parent/child process identification
692 #if defined(PLATFORM_UNIX)
693 #define IS_PARENT_PROCESS() (audio.mixer_pid != getpid())
694 #define IS_CHILD_PROCESS() (audio.mixer_pid == getpid())
695 #define HAS_CHILD_PROCESS() (audio.mixer_pid > 0)
697 #define IS_PARENT_PROCESS() TRUE
698 #define IS_CHILD_PROCESS() FALSE
699 #define HAS_CHILD_PROCESS() FALSE
703 // values for artwork type
704 #define ARTWORK_TYPE_GRAPHICS 0
705 #define ARTWORK_TYPE_SOUNDS 1
706 #define ARTWORK_TYPE_MUSIC 2
708 #define NUM_ARTWORK_TYPES 3
711 // values for tree type (chosen to match artwork type)
712 #define TREE_TYPE_UNDEFINED -1
713 #define TREE_TYPE_GRAPHICS_DIR ARTWORK_TYPE_GRAPHICS
714 #define TREE_TYPE_SOUNDS_DIR ARTWORK_TYPE_SOUNDS
715 #define TREE_TYPE_MUSIC_DIR ARTWORK_TYPE_MUSIC
716 #define TREE_TYPE_LEVEL_DIR 3
717 #define TREE_TYPE_LEVEL_NR 4
719 #define NUM_BASE_TREE_TYPES 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 #define TREE_USERDIR(t) ((t) == TREE_TYPE_LEVEL_DIR ? \
742 getUserLevelDir(NULL) : \
743 (t) == TREE_TYPE_GRAPHICS_DIR ? \
744 getUserGraphicsDir() : \
745 (t) == TREE_TYPE_SOUNDS_DIR ? \
746 getUserSoundsDir() : \
747 (t) == TREE_TYPE_MUSIC_DIR ? \
748 getUserMusicDir() : \
751 #define TREE_FIRST_NODE_PTR(t) ((t) == TREE_TYPE_LEVEL_DIR ? \
753 (t) == TREE_TYPE_GRAPHICS_DIR ? \
754 &artwork.gfx_first : \
755 (t) == TREE_TYPE_SOUNDS_DIR ? \
756 &artwork.snd_first : \
757 (t) == TREE_TYPE_MUSIC_DIR ? \
758 &artwork.mus_first : \
761 #define TREE_FIRST_NODE(t) ((t) == TREE_TYPE_LEVEL_DIR ? \
763 (t) == TREE_TYPE_GRAPHICS_DIR ? \
764 artwork.gfx_first : \
765 (t) == TREE_TYPE_SOUNDS_DIR ? \
766 artwork.snd_first : \
767 (t) == TREE_TYPE_MUSIC_DIR ? \
768 artwork.mus_first : \
771 // values for artwork handling
772 #define LEVELDIR_ARTWORK_SET_PTR(leveldir, type) \
773 ((type) == ARTWORK_TYPE_GRAPHICS ? \
774 &(leveldir)->graphics_set : \
775 (type) == ARTWORK_TYPE_SOUNDS ? \
776 &(leveldir)->sounds_set : \
777 &(leveldir)->music_set)
779 #define LEVELDIR_ARTWORK_SET(leveldir, type) \
780 ((type) == ARTWORK_TYPE_GRAPHICS ? \
781 (leveldir)->graphics_set : \
782 (type) == ARTWORK_TYPE_SOUNDS ? \
783 (leveldir)->sounds_set : \
784 (leveldir)->music_set)
786 #define LEVELDIR_ARTWORK_PATH_PTR(leveldir, type) \
787 ((type) == ARTWORK_TYPE_GRAPHICS ? \
788 &(leveldir)->graphics_path : \
789 (type) == ARTWORK_TYPE_SOUNDS ? \
790 &(leveldir)->sounds_path : \
791 &(leveldir)->music_path)
793 #define LEVELDIR_ARTWORK_PATH(leveldir, type) \
794 ((type) == ARTWORK_TYPE_GRAPHICS ? \
795 (leveldir)->graphics_path : \
796 (type) == ARTWORK_TYPE_SOUNDS ? \
797 (leveldir)->sounds_path : \
798 (leveldir)->music_path)
800 #define SETUP_ARTWORK_SET(setup, type) \
801 ((type) == ARTWORK_TYPE_GRAPHICS ? \
802 (setup).graphics_set : \
803 (type) == ARTWORK_TYPE_SOUNDS ? \
804 (setup).sounds_set : \
807 #define SETUP_OVERRIDE_ARTWORK(setup, type) \
808 ((type) == ARTWORK_TYPE_GRAPHICS ? \
809 (setup).override_level_graphics : \
810 (type) == ARTWORK_TYPE_SOUNDS ? \
811 (setup).override_level_sounds : \
812 (setup).override_level_music)
814 #define GFX_OVERRIDE_ARTWORK(type) \
815 ((type) == ARTWORK_TYPE_GRAPHICS ? \
816 gfx.override_level_graphics : \
817 (type) == ARTWORK_TYPE_SOUNDS ? \
818 gfx.override_level_sounds : \
819 gfx.override_level_music)
821 #define ARTWORK_FIRST_NODE(artwork, type) \
822 ((type) == ARTWORK_TYPE_GRAPHICS ? \
823 (artwork).gfx_first : \
824 (type) == ARTWORK_TYPE_SOUNDS ? \
825 (artwork).snd_first : \
828 #define ARTWORK_CURRENT_IDENTIFIER_PTR(artwork, type) \
829 ((type) == ARTWORK_TYPE_GRAPHICS ? \
830 &(artwork).gfx_current_identifier : \
831 (type) == ARTWORK_TYPE_SOUNDS ? \
832 &(artwork).snd_current_identifier : \
833 &(artwork).mus_current_identifier)
835 #define ARTWORK_CURRENT_IDENTIFIER(artwork, type) \
836 ((type) == ARTWORK_TYPE_GRAPHICS ? \
837 (artwork).gfx_current_identifier : \
838 (type) == ARTWORK_TYPE_SOUNDS ? \
839 (artwork).snd_current_identifier : \
840 (artwork).mus_current_identifier)
842 #define ARTWORKINFO_FILENAME(type) \
843 ((type) == ARTWORK_TYPE_GRAPHICS ? \
844 GRAPHICSINFO_FILENAME : \
845 (type) == ARTWORK_TYPE_SOUNDS ? \
846 SOUNDSINFO_FILENAME : \
847 (type) == ARTWORK_TYPE_MUSIC ? \
848 MUSICINFO_FILENAME : "")
850 #define ARTWORK_DIRECTORY(type) \
851 ((type) == ARTWORK_TYPE_GRAPHICS ? \
852 GRAPHICS_DIRECTORY : \
853 (type) == ARTWORK_TYPE_SOUNDS ? \
855 (type) == ARTWORK_TYPE_MUSIC ? \
856 MUSIC_DIRECTORY : "")
858 #define OPTIONS_ARTWORK_DIRECTORY(type) \
859 ((type) == ARTWORK_TYPE_GRAPHICS ? \
860 options.graphics_directory : \
861 (type) == ARTWORK_TYPE_SOUNDS ? \
862 options.sounds_directory : \
863 (type) == ARTWORK_TYPE_MUSIC ? \
864 options.music_directory : "")
866 #define USER_ARTWORK_DIRECTORY(type) \
867 ((type) == ARTWORK_TYPE_GRAPHICS ? \
868 getUserGraphicsDir() : \
869 (type) == ARTWORK_TYPE_SOUNDS ? \
870 getUserSoundsDir() : \
871 (type) == ARTWORK_TYPE_MUSIC ? \
872 getUserMusicDir() : "")
874 #define ARTWORK_DEFAULT_SUBDIR(type) \
875 ((type) == ARTWORK_TYPE_GRAPHICS ? \
876 GFX_DEFAULT_SUBDIR : \
877 (type) == ARTWORK_TYPE_SOUNDS ? \
878 SND_DEFAULT_SUBDIR : \
881 #define UPDATE_BUSY_STATE() \
883 if (gfx.draw_busy_anim_function != NULL) \
884 gfx.draw_busy_anim_function(); \
888 // structure definitions
892 char *command_basepath; // path to the program binary
893 char *command_basename; // base filename of the program binary
895 char *config_filename; // optional global program config filename
897 char *maindata_path; // main game data (installation) directory
899 char *userdata_subdir; // personal user game data directory
900 char *userdata_path; // resulting full path to game data directory
910 char *log_filename[NUM_LOGS]; // log filenames for out/err messages
911 FILE *log_file[NUM_LOGS]; // log file handles for out/err files
912 FILE *log_file_default[NUM_LOGS]; // default log file handles (out/err)
920 char *version_string;
922 char *(*window_title_function)(void);
923 void (*exit_message_function)(char *, va_list);
924 void (*exit_function)(int);
926 boolean global_scores;
927 boolean many_scores_per_name;
948 char *ro_base_directory;
949 char *rw_base_directory;
950 char *level_directory;
951 char *graphics_directory;
952 char *sounds_directory;
953 char *music_directory;
954 char *docs_directory;
955 char *conf_directory;
957 char *execute_command;
968 struct VideoSystemInfo
971 int width, height, depth;
972 int window_width, window_height;
973 int display_width, display_height;
974 int screen_width, screen_height;
975 int screen_xoffset, screen_yoffset;
977 boolean fullscreen_available;
978 boolean fullscreen_enabled;
979 boolean fullscreen_initial;
981 boolean window_scaling_available;
982 int window_scaling_percent;
983 char *window_scaling_quality;
984 int screen_rendering_mode;
987 unsigned int frame_delay;
988 unsigned int frame_delay_value;
992 int shifted_up_pos_last;
993 unsigned int shifted_up_delay;
994 unsigned int shifted_up_delay_value;
999 struct AudioSystemInfo
1001 boolean sound_available;
1002 boolean loops_available;
1003 boolean music_available;
1005 boolean sound_enabled;
1006 boolean sound_deactivated; // for temporarily disabling sound
1015 int first_sound_channel;
1018 struct FontBitmapInfo
1022 int src_x, src_y; // start position of font characters
1023 int width, height; // width / height of font characters
1025 int offset_x; // offset to next font character
1026 int offset_y; // offset to next font character
1028 int draw_xoffset; // offset for drawing font characters
1029 int draw_yoffset; // offset for drawing font characters
1032 int num_chars_per_line;
1039 int real_sx, real_sy;
1040 int full_sxsize, full_sysize;
1041 int scrollbuffer_width, scrollbuffer_height;
1043 int game_tile_size, standard_tile_size;
1054 int win_xsize, win_ysize;
1056 int draw_deactivation_mask;
1057 int draw_background_mask;
1059 Bitmap *field_save_buffer;
1061 Bitmap *background_bitmap;
1062 int background_bitmap_mask;
1064 Bitmap *fade_bitmap_backup;
1065 Bitmap *fade_bitmap_source;
1066 Bitmap *fade_bitmap_target;
1067 Bitmap *fade_bitmap_black;
1069 int fade_border_source_status;
1070 int fade_border_target_status;
1071 Bitmap *masked_border_bitmap_ptr;
1073 Bitmap *final_screen_bitmap;
1075 boolean clipping_enabled;
1077 int clip_width, clip_height;
1079 boolean override_level_graphics;
1080 boolean override_level_sounds;
1081 boolean override_level_music;
1083 boolean draw_init_text;
1086 struct FontBitmapInfo *font_bitmap_info;
1087 int (*select_font_function)(int);
1088 int (*get_font_from_token_function)(char *);
1090 int anim_random_frame;
1092 void (*draw_busy_anim_function)(void);
1093 void (*draw_global_anim_function)(int, int);
1094 void (*draw_global_border_function)(int);
1095 void (*draw_tile_cursor_function)(int);
1100 struct TileCursorInfo
1102 boolean enabled; // tile cursor generally enabled or disabled
1103 boolean active; // tile cursor activated (depending on game)
1104 boolean moving; // tile cursor moving to target position
1106 int xpos, ypos; // tile cursor level playfield position
1107 int x, y; // tile cursor current screen position
1108 int target_x, target_y; // tile cursor target screen position
1110 int sx, sy; // tile cursor screen start position
1115 boolean enabled; // overlay generally enabled or disabled
1116 boolean active; // overlay activated (depending on game mode)
1123 char grid_button[MAX_GRID_XSIZE][MAX_GRID_YSIZE];
1124 char grid_button_highlight;
1126 int grid_button_action;
1132 int nr[MAX_PLAYERS]; // joystick number for each player
1135 struct SetupJoystickInfo
1137 char *device_name; // device name of player's joystick
1139 int xleft, xmiddle, xright;
1140 int yupper, ymiddle, ylower;
1144 struct SetupKeyboardInfo
1146 Key left, right, up, down;
1150 struct SetupTouchInfo
1159 char grid_button[2][MAX_GRID_XSIZE][MAX_GRID_YSIZE];
1161 int transparency; // in percent (0 == opaque, 100 == invisible)
1162 boolean draw_outlined;
1163 boolean draw_pressed;
1165 boolean grid_initialized;
1168 struct SetupInputInfo
1170 boolean use_joystick;
1171 struct SetupJoystickInfo joy;
1172 struct SetupKeyboardInfo key;
1175 struct SetupEditorInfo
1177 boolean el_boulderdash;
1178 boolean el_emerald_mine;
1179 boolean el_emerald_mine_club;
1182 boolean el_supaplex;
1183 boolean el_diamond_caves;
1184 boolean el_dx_boulderdash;
1186 boolean el_mirror_magic;
1187 boolean el_deflektor;
1190 boolean el_steel_chars;
1194 boolean el_user_defined;
1197 boolean el_headlines;
1202 boolean show_element_token;
1204 boolean use_template_for_new_levels;
1207 struct SetupAutoSetupInfo
1209 int editor_zoom_tilesize;
1212 struct SetupEditorCascadeInfo
1225 boolean el_steel_chars;
1233 struct SetupShortcutInfo
1239 Key focus_player[MAX_PLAYERS];
1240 Key focus_player_all;
1259 struct SetupSystemInfo
1261 char *sdl_videodriver;
1262 char *sdl_audiodriver;
1263 int audio_fragment_size;
1266 struct SetupInternalInfo
1268 char *program_title;
1269 char *program_version;
1270 char *program_author;
1271 char *program_email;
1272 char *program_website;
1273 char *program_copyright;
1274 char *program_company;
1276 char *program_icon_file;
1278 char *default_graphics_set;
1279 char *default_sounds_set;
1280 char *default_music_set;
1282 char *fallback_graphics_file;
1283 char *fallback_sounds_file;
1284 char *fallback_music_file;
1286 char *default_level_series;
1288 int default_window_width;
1289 int default_window_height;
1291 boolean choose_from_top_leveldir;
1292 boolean show_scaling_in_title;
1295 boolean menu_editor;
1296 boolean menu_graphics;
1298 boolean menu_artwork;
1301 boolean menu_shortcuts;
1303 boolean menu_save_and_exit;
1306 struct SetupDebugInfo
1308 int frame_delay[10];
1309 Key frame_delay_key[10];
1310 boolean frame_delay_use_mod_key;
1311 boolean frame_delay_game_only;
1312 boolean show_frames_per_second;
1320 boolean sound_loops;
1321 boolean sound_music;
1322 boolean sound_simple;
1324 boolean scroll_delay;
1325 boolean scroll_delay_value;
1326 char *engine_snapshot_mode;
1327 int engine_snapshot_memory;
1328 boolean fade_screens;
1330 boolean show_titlescreen;
1331 boolean quick_doors;
1334 boolean skip_levels;
1335 boolean increment_levels;
1336 boolean auto_play_next_level;
1337 boolean skip_scores_after_game;
1340 int window_scaling_percent;
1341 char *window_scaling_quality;
1342 char *screen_rendering_mode;
1344 boolean ask_on_escape;
1345 boolean ask_on_escape_editor;
1346 boolean ask_on_game_over;
1347 boolean quick_switch;
1348 boolean input_on_focus;
1349 boolean prefer_aga_graphics;
1350 boolean game_speed_extended;
1351 int game_frame_delay;
1352 boolean sp_show_border_elements;
1353 boolean small_game_graphics;
1354 boolean show_snapshot_buttons;
1359 int override_level_graphics; // not boolean -- can also be "AUTO"
1360 int override_level_sounds; // not boolean -- can also be "AUTO"
1361 int override_level_music; // not boolean -- can also be "AUTO"
1367 boolean network_mode;
1368 int network_player_nr;
1369 char *network_server_hostname;
1371 struct SetupAutoSetupInfo auto_setup;
1372 struct SetupEditorInfo editor;
1373 struct SetupEditorCascadeInfo editor_cascade;
1374 struct SetupShortcutInfo shortcut;
1375 struct SetupInputInfo input[MAX_PLAYERS];
1376 struct SetupTouchInfo touch;
1377 struct SetupSystemInfo system;
1378 struct SetupInternalInfo internal;
1379 struct SetupDebugInfo debug;
1381 struct OptionInfo options;
1386 struct TreeInfo **node_top; // topmost node in tree
1387 struct TreeInfo *node_parent; // parent level directory info
1388 struct TreeInfo *node_group; // level group sub-directory info
1389 struct TreeInfo *next; // next level series structure node
1391 int cl_first; // internal control field for setup screen
1392 int cl_cursor; // internal control field for setup screen
1394 int type; // type of tree content
1396 // fields for "type == TREE_TYPE_LEVEL_DIR"
1398 char *subdir; // tree info sub-directory basename (may be ".")
1399 char *fullpath; // complete path relative to tree base directory
1400 char *basepath; // absolute base path of tree base directory
1401 char *identifier; // identifier string for configuration files
1402 char *name; // tree info name, as displayed in selection menues
1403 char *name_sorting; // optional sorting name for correct name sorting
1404 char *author; // level or artwork author name
1405 char *year; // optional year of creation for levels or artwork
1407 char *program_title; // optional alternative text for program title
1408 char *program_copyright; // optional alternative text for program copyright
1409 char *program_company; // optional alternative text for program company
1411 char *imported_from; // optional comment for imported levels or artwork
1412 char *imported_by; // optional comment for imported levels or artwork
1413 char *tested_by; // optional comment to name people who tested a set
1415 char *graphics_set_ecs; // special EMC custom graphics set (ECS graphics)
1416 char *graphics_set_aga; // special EMC custom graphics set (AGA graphics)
1417 char *graphics_set; // optional custom graphics set (level tree only)
1418 char *sounds_set; // optional custom sounds set (level tree only)
1419 char *music_set; // optional custom music set (level tree only)
1420 char *graphics_path; // path to optional custom graphics set (level only)
1421 char *sounds_path; // path to optional custom sounds set (level only)
1422 char *music_path; // path to optional custom music set (level only)
1424 char *level_filename; // filename of level file (for packed level file)
1425 char *level_filetype; // type of levels in level directory or level file
1427 char *special_flags; // flags for special actions performed on level file
1429 int levels; // number of levels in level series
1430 int first_level; // first level number (to allow start with 0 or 1)
1431 int last_level; // last level number (automatically calculated)
1432 int sort_priority; // sort levels by 'sort_priority' and then by name
1434 boolean latest_engine;// force level set to use the latest game engine
1436 boolean level_group; // directory contains more level series directories
1437 boolean parent_link; // entry links back to parent directory
1438 boolean in_user_dir; // user defined levels are stored in home directory
1439 boolean user_defined; // levels in user directory and marked as "private"
1440 boolean readonly; // readonly levels can not be changed with editor
1441 boolean handicap; // level set has no handicap when set to "false"
1442 boolean skip_levels; // levels can be skipped when set to "true"
1444 int color; // color to use on selection screen for this level
1445 char *class_desc; // description of level series class
1446 int handicap_level; // number of the lowest unsolved level
1448 char *infotext; // optional text to describe the tree type (headline)
1451 typedef struct TreeInfo TreeInfo;
1452 typedef struct TreeInfo LevelDirTree;
1453 typedef struct TreeInfo ArtworkDirTree;
1454 typedef struct TreeInfo GraphicsDirTree;
1455 typedef struct TreeInfo SoundsDirTree;
1456 typedef struct TreeInfo MusicDirTree;
1460 GraphicsDirTree *gfx_first;
1461 GraphicsDirTree *gfx_current;
1462 SoundsDirTree *snd_first;
1463 SoundsDirTree *snd_current;
1464 MusicDirTree *mus_first;
1465 MusicDirTree *mus_current;
1467 char *gfx_current_identifier;
1468 char *snd_current_identifier;
1469 char *mus_current_identifier;
1472 struct ValueTextInfo
1478 struct StringValueTextInfo
1490 struct ConfigTypeInfo
1497 struct TokenIntPtrInfo
1507 char *default_filename;
1510 char **default_parameter; // array of file parameters
1511 char **parameter; // array of file parameters
1514 boolean fallback_to_default;
1515 boolean default_is_cloned;
1518 struct SetupFileList
1523 struct SetupFileList *next;
1528 char *source_filename; // primary key for node list
1532 struct PropertyMapping
1542 struct ArtworkListInfo
1544 int type; // type of artwork
1546 int num_file_list_entries;
1547 int num_dynamic_file_list_entries;
1548 struct FileInfo *file_list; // static artwork file array
1549 struct FileInfo *dynamic_file_list; // dynamic artwrk file array
1551 int num_suffix_list_entries;
1552 struct ConfigTypeInfo *suffix_list; // parameter suffixes array
1554 int num_base_prefixes;
1555 int num_ext1_suffixes;
1556 int num_ext2_suffixes;
1557 int num_ext3_suffixes;
1558 char **base_prefixes; // base token prefixes array
1559 char **ext1_suffixes; // property suffixes array 1
1560 char **ext2_suffixes; // property suffixes array 2
1561 char **ext3_suffixes; // property suffixes array 3
1563 int num_ignore_tokens;
1564 char **ignore_tokens; // file tokens to be ignored
1566 int num_property_mapping_entries;
1567 struct PropertyMapping *property_mapping; // mapping token -> artwork
1569 int sizeof_artwork_list_entry;
1571 struct ListNodeInfo **artwork_list; // static artwork node array
1572 struct ListNodeInfo **dynamic_artwork_list; // dynamic artwrk node array
1573 struct ListNode *content_list; // dynamic artwork node list
1575 void *(*load_artwork)(char *); // constructor function
1576 void (*free_artwork)(void *); // destructor function
1596 struct RectWithBorder
1600 int min_width, min_height;
1601 int max_width, max_height;
1622 struct DoorPartPosInfo
1629 int start_step_opening;
1630 int start_step_closing;
1631 boolean draw_masked;
1638 int xoffset; // special case for tape date and time
1639 int xoffset2; // special case for tape date
1640 int yoffset; // special case for list of preview players
1643 int size; // also used for suffix ".digits"
1645 boolean draw_masked;
1646 boolean draw_player; // special case for network player buttons
1647 int sort_priority; // also used for suffix ".draw_order"
1650 int direction; // needed for panel time/health graphics
1651 int class; // needed for panel time/health graphics
1652 int style; // needed for panel time/health graphics
1654 int tile_size; // special case for list of network players
1655 int border_size; // special case for list of preview players
1656 int vertical; // special case for list of preview players
1658 boolean redefined; // redefined by custom artwork
1661 struct MouseActionInfo
1670 int music[MAX_LEVELS];
1683 // ============================================================================
1684 // exported variables
1685 // ============================================================================
1687 extern struct ProgramInfo program;
1688 extern struct NetworkInfo network;
1689 extern struct OptionInfo options;
1690 extern struct VideoSystemInfo video;
1691 extern struct AudioSystemInfo audio;
1692 extern struct GfxInfo gfx;
1693 extern struct TileCursorInfo tile_cursor;
1694 extern struct OverlayInfo overlay;
1695 extern struct AnimInfo anim;
1696 extern struct ArtworkInfo artwork;
1697 extern struct JoystickInfo joystick;
1698 extern struct SetupInfo setup;
1700 extern LevelDirTree *leveldir_first_all;
1701 extern LevelDirTree *leveldir_first;
1702 extern LevelDirTree *leveldir_current;
1703 extern int level_nr;
1705 extern struct LevelSetInfo levelset;
1706 extern struct LevelStats level_stats[];
1708 extern DrawWindow *window;
1709 extern DrawBuffer *backbuffer;
1710 extern DrawBuffer *drawto;
1712 extern int button_status;
1713 extern boolean motion_status;
1714 extern int wheel_steps;
1715 extern boolean keyrepeat_status;
1717 extern int redraw_mask;
1719 extern int FrameCounter;
1722 // function definitions
1724 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
1726 void InitNetworkInfo(boolean, boolean, boolean, char *, int);
1728 void InitScoresInfo(void);
1729 void SetWindowTitle(void);
1731 void InitWindowTitleFunction(char *(*window_title_function)(void));
1732 void InitExitMessageFunction(void (*exit_message_function)(char *, va_list));
1733 void InitExitFunction(void (*exit_function)(int));
1734 void InitPlatformDependentStuff(void);
1735 void ClosePlatformDependentStuff(void);
1737 void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
1738 void InitGfxTileSizeInfo(int, int);
1739 void InitGfxDoor1Info(int, int, int, int);
1740 void InitGfxDoor2Info(int, int, int, int);
1741 void InitGfxDoor3Info(int, int, int, int);
1742 void InitGfxWindowInfo(int, int);
1743 void InitGfxScrollbufferInfo(int, int);
1744 void InitGfxClipRegion(boolean, int, int, int, int);
1745 void InitGfxDrawBusyAnimFunction(void (*draw_busy_anim_function)(void));
1746 void InitGfxDrawGlobalAnimFunction(void (*draw_global_anim_function)(int, int));
1747 void InitGfxDrawGlobalBorderFunction(void (*draw_global_border_function)(int));
1748 void InitGfxDrawTileCursorFunction(void (*draw_tile_cursor_function)(int));
1749 void InitGfxCustomArtworkInfo(void);
1750 void InitGfxOtherSettings(void);
1751 void InitTileCursorInfo(void);
1752 void InitOverlayInfo(void);
1753 void SetTileCursorEnabled(boolean);
1754 void SetTileCursorActive(boolean);
1755 void SetTileCursorTargetXY(int, int);
1756 void SetTileCursorXY(int, int);
1757 void SetTileCursorSXSY(int, int);
1758 void SetOverlayEnabled(boolean);
1759 void SetOverlayActive(boolean);
1760 void SetOverlayShowGrid(boolean);
1761 boolean GetOverlayEnabled(void);
1762 boolean GetOverlayActive(void);
1763 void SetDrawDeactivationMask(int);
1764 int GetDrawDeactivationMask(void);
1765 void SetDrawBackgroundMask(int);
1766 void SetWindowBackgroundBitmap(Bitmap *);
1767 void SetMainBackgroundBitmap(Bitmap *);
1768 void SetDoorBackgroundBitmap(Bitmap *);
1769 void SetRedrawMaskFromArea(int, int, int, int);
1771 void LimitScreenUpdates(boolean);
1773 void InitVideoDefaults(void);
1774 void InitVideoDisplay(void);
1775 void CloseVideoDisplay(void);
1776 void InitVideoBuffer(int, int, int, boolean);
1777 Bitmap *CreateBitmapStruct(void);
1778 Bitmap *CreateBitmap(int, int, int);
1779 void ReCreateBitmap(Bitmap **, int, int);
1780 void FreeBitmap(Bitmap *);
1781 void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
1782 void BlitBitmapTiled(Bitmap *, Bitmap *, int, int, int, int, int, int, int,int);
1783 void FadeRectangle(int, int, int, int, int, int, int,
1784 void (*draw_border_function)(void));
1785 void FillRectangle(Bitmap *, int, int, int, int, Pixel);
1786 void ClearRectangle(Bitmap *, int, int, int, int);
1787 void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
1788 void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
1789 boolean DrawingDeactivatedField(void);
1790 boolean DrawingDeactivated(int, int, int, int);
1791 boolean DrawingOnBackground(int, int);
1792 boolean DrawingAreaChanged(void);
1793 void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int, int);
1794 void BlitTexture(Bitmap *, int, int, int, int, int, int);
1795 void BlitTextureMasked(Bitmap *, int, int, int, int, int, int);
1796 void BlitToScreen(Bitmap *, int, int, int, int, int, int);
1797 void BlitToScreenMasked(Bitmap *, int, int, int, int, int, int);
1798 void DrawSimpleBlackLine(Bitmap *, int, int, int, int);
1799 void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
1800 void DrawLines(Bitmap *, struct XY *, int, Pixel);
1801 Pixel GetPixel(Bitmap *, int, int);
1802 Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
1803 Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
1805 void KeyboardAutoRepeatOn(void);
1806 void KeyboardAutoRepeatOff(void);
1807 boolean SetVideoMode(boolean);
1808 void SetVideoFrameDelay(unsigned int);
1809 unsigned int GetVideoFrameDelay(void);
1810 boolean ChangeVideoModeIfNeeded(boolean);
1812 Bitmap *LoadImage(char *);
1813 Bitmap *LoadCustomImage(char *);
1814 void ReloadCustomImage(Bitmap *, char *);
1816 void ReCreateGameTileSizeBitmap(Bitmap **);
1817 void CreateBitmapWithSmallBitmaps(Bitmap **, int, int);
1818 void CreateBitmapTextures(Bitmap **);
1819 void FreeBitmapTextures(Bitmap **);
1820 void ScaleBitmap(Bitmap **, int);
1822 void SetMouseCursor(int);
1824 void OpenAudio(void);
1825 void CloseAudio(void);
1826 void SetAudioMode(boolean);
1828 boolean PendingEvent(void);
1829 void WaitEvent(Event *event);
1830 void PeekEvent(Event *event);
1831 void CheckQuitEvent(void);
1832 Key GetEventKey(KeyEvent *, boolean);
1833 KeyMod HandleKeyModState(Key, int);
1834 KeyMod GetKeyModState(void);
1835 KeyMod GetKeyModStateFromEvents(void);
1836 void StartTextInput(int, int, int, int);
1837 void StopTextInput(void);
1838 boolean CheckCloseWindowEvent(ClientMessageEvent *);
1840 void InitJoysticks(void);
1841 boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
1842 boolean CheckJoystickOpened(int);
1843 void ClearJoystickState(void);