1 // ============================================================================
2 // Artsoft Retro-Game Library
3 // ----------------------------------------------------------------------------
4 // (c) 1995-2014 by Artsoft Entertainment
7 // http://www.artsoft.org/
8 // ----------------------------------------------------------------------------
10 // ============================================================================
19 #if defined(PLATFORM_MACOSX)
21 #elif defined(PLATFORM_WIN32)
23 #elif defined(PLATFORM_ANDROID)
30 /* the additional 'b' is needed for Win32 to open files in binary mode */
31 #define MODE_READ "rb"
32 #define MODE_WRITE "wb"
33 #define MODE_APPEND "ab"
35 #define DEFAULT_DEPTH 0
39 #define BLIT_INVERSE 2
40 #define BLIT_ON_BACKGROUND 3
42 /* values for fullscreen status */
43 #define FULLSCREEN_NOT_AVAILABLE FALSE
44 #define FULLSCREEN_AVAILABLE TRUE
46 /* values for window scaling */
47 #define WINDOW_SCALING_NOT_AVAILABLE FALSE
48 #define WINDOW_SCALING_AVAILABLE TRUE
50 #define MIN_WINDOW_SCALING_PERCENT 30
51 #define STD_WINDOW_SCALING_PERCENT 100
52 #define MAX_WINDOW_SCALING_PERCENT 400
53 #define STEP_WINDOW_SCALING_PERCENT 10
55 /* values for window scaling quality */
56 #define SCALING_QUALITY_NEAREST "nearest"
57 #define SCALING_QUALITY_LINEAR "linear"
58 #define SCALING_QUALITY_BEST "best"
60 #define SCALING_QUALITY_DEFAULT SCALING_QUALITY_LINEAR
62 /* values for screen rendering mode */
63 #define STR_SPECIAL_RENDERING_OFF "stream_texture_only"
64 #define STR_SPECIAL_RENDERING_BITMAP "bitmap_and_stream_texture"
65 #define STR_SPECIAL_RENDERING_TARGET "target_texture_only"
66 #define STR_SPECIAL_RENDERING_DOUBLE "stream_and_target_texture"
68 #if defined(TARGET_SDL2)
69 #define STR_SPECIAL_RENDERING_DEFAULT STR_SPECIAL_RENDERING_DOUBLE
71 #define STR_SPECIAL_RENDERING_DEFAULT STR_SPECIAL_RENDERING_BITMAP
74 #define SPECIAL_RENDERING_OFF 0
75 #define SPECIAL_RENDERING_BITMAP 1
76 #define SPECIAL_RENDERING_TARGET 2
77 #define SPECIAL_RENDERING_DOUBLE 3
79 #if defined(TARGET_SDL2)
80 #define SPECIAL_RENDERING_DEFAULT SPECIAL_RENDERING_DOUBLE
82 #define SPECIAL_RENDERING_DEFAULT SPECIAL_RENDERING_BITMAP
85 /* values for touch control */
86 #define TOUCH_CONTROL_OFF "off"
87 #define TOUCH_CONTROL_VIRTUAL_BUTTONS "virtual_buttons"
88 #define TOUCH_CONTROL_WIPE_GESTURES "wipe_gestures"
89 #define TOUCH_CONTROL_FOLLOW_FINGER "follow_finger"
91 #if defined(PLATFORM_ANDROID)
92 #define TOUCH_CONTROL_DEFAULT TOUCH_CONTROL_VIRTUAL_BUTTONS
94 #define TOUCH_CONTROL_DEFAULT TOUCH_CONTROL_OFF
97 #define TOUCH_MOVE_DISTANCE_DEFAULT 2
98 #define TOUCH_DROP_DISTANCE_DEFAULT 5
101 /* values for special settings for mobile devices */
102 #if defined(PLATFORM_ANDROID)
103 #define USE_TOUCH_INPUT_OVERLAY
104 #define USE_COMPLETE_DISPLAY
105 #define HAS_SCREEN_KEYBOARD
106 #define SCREEN_KEYBOARD_POS(h) ((h) / 2)
109 /* default input keys */
110 #define DEFAULT_KEY_LEFT KSYM_Left
111 #define DEFAULT_KEY_RIGHT KSYM_Right
112 #define DEFAULT_KEY_UP KSYM_Up
113 #define DEFAULT_KEY_DOWN KSYM_Down
114 #if defined(PLATFORM_MACOSX)
115 #define DEFAULT_KEY_SNAP KSYM_Control_L
116 #define DEFAULT_KEY_DROP KSYM_KP_Enter
118 #define DEFAULT_KEY_SNAP KSYM_Control_L
119 #define DEFAULT_KEY_DROP KSYM_Control_R
121 #define DEFAULT_KEY_OKAY KSYM_Return
122 #define DEFAULT_KEY_CANCEL KSYM_Escape
124 /* default shortcut keys */
125 #define DEFAULT_KEY_SAVE_GAME KSYM_F1
126 #define DEFAULT_KEY_LOAD_GAME KSYM_F2
127 #define DEFAULT_KEY_TOGGLE_PAUSE KSYM_space
128 #define DEFAULT_KEY_FOCUS_PLAYER_1 KSYM_F5
129 #define DEFAULT_KEY_FOCUS_PLAYER_2 KSYM_F6
130 #define DEFAULT_KEY_FOCUS_PLAYER_3 KSYM_F7
131 #define DEFAULT_KEY_FOCUS_PLAYER_4 KSYM_F8
132 #define DEFAULT_KEY_FOCUS_PLAYER_ALL KSYM_F9
133 #define DEFAULT_KEY_TAPE_EJECT KSYM_UNDEFINED
134 #define DEFAULT_KEY_TAPE_EXTRA KSYM_UNDEFINED
135 #define DEFAULT_KEY_TAPE_STOP KSYM_UNDEFINED
136 #define DEFAULT_KEY_TAPE_PAUSE KSYM_UNDEFINED
137 #define DEFAULT_KEY_TAPE_RECORD KSYM_UNDEFINED
138 #define DEFAULT_KEY_TAPE_PLAY KSYM_UNDEFINED
139 #define DEFAULT_KEY_SOUND_SIMPLE KSYM_UNDEFINED
140 #define DEFAULT_KEY_SOUND_LOOPS KSYM_UNDEFINED
141 #define DEFAULT_KEY_SOUND_MUSIC KSYM_UNDEFINED
142 #define DEFAULT_KEY_SNAP_LEFT KSYM_UNDEFINED
143 #define DEFAULT_KEY_SNAP_RIGHT KSYM_UNDEFINED
144 #define DEFAULT_KEY_SNAP_UP KSYM_UNDEFINED
145 #define DEFAULT_KEY_SNAP_DOWN KSYM_UNDEFINED
147 /* default debug setup keys and values */
148 #define DEFAULT_FRAME_DELAY_0 20 // 100 % speed
149 #define DEFAULT_FRAME_DELAY_1 500 // 4 % speed
150 #define DEFAULT_FRAME_DELAY_2 250 // 8 % speed
151 #define DEFAULT_FRAME_DELAY_3 125 // 16 % speed
152 #define DEFAULT_FRAME_DELAY_4 60 // 33 % speed
153 #define DEFAULT_FRAME_DELAY_5 40 // 50 % speed
154 #define DEFAULT_FRAME_DELAY_6 30 // 66 % speed
155 #define DEFAULT_FRAME_DELAY_7 10 // 200 % speed
156 #define DEFAULT_FRAME_DELAY_8 5 // 400 % speed
157 #define DEFAULT_FRAME_DELAY_9 0 // maximum speed
159 #define DEFAULT_KEY_FRAME_DELAY_0 KSYM_0
160 #define DEFAULT_KEY_FRAME_DELAY_1 KSYM_1
161 #define DEFAULT_KEY_FRAME_DELAY_2 KSYM_2
162 #define DEFAULT_KEY_FRAME_DELAY_3 KSYM_3
163 #define DEFAULT_KEY_FRAME_DELAY_4 KSYM_4
164 #define DEFAULT_KEY_FRAME_DELAY_5 KSYM_5
165 #define DEFAULT_KEY_FRAME_DELAY_6 KSYM_6
166 #define DEFAULT_KEY_FRAME_DELAY_7 KSYM_7
167 #define DEFAULT_KEY_FRAME_DELAY_8 KSYM_8
168 #define DEFAULT_KEY_FRAME_DELAY_9 KSYM_9
170 #define NUM_DEBUG_FRAME_DELAY_KEYS 10
172 #define DEFAULT_FRAME_DELAY_USE_MOD_KEY FALSE
173 #define DEFAULT_FRAME_DELAY_GAME_ONLY TRUE
175 /* values for key_status */
176 #define KEY_NOT_PRESSED FALSE
177 #define KEY_RELEASED FALSE
178 #define KEY_PRESSED TRUE
180 /* values for button status */
181 #define MB_NOT_PRESSED FALSE
182 #define MB_NOT_RELEASED TRUE
183 #define MB_RELEASED FALSE
184 #define MB_PRESSED TRUE
185 #define MB_MENU_CHOICE FALSE
186 #define MB_MENU_MARK TRUE
187 #define MB_MENU_INITIALIZE (-1)
188 #define MB_MENU_LEAVE (-2)
189 #define MB_LEFTBUTTON 1
190 #define MB_MIDDLEBUTTON 2
191 #define MB_RIGHTBUTTON 3
192 #define MB_WHEEL_UP 4
193 #define MB_WHEEL_DOWN 5
194 #define MB_WHEEL_LEFT 6
195 #define MB_WHEEL_RIGHT 7
196 #define IS_WHEEL_BUTTON_VERTICAL(b) ((b) == MB_WHEEL_UP || \
197 (b) == MB_WHEEL_DOWN)
198 #define IS_WHEEL_BUTTON_HORIZONTAL(b) ((b) == MB_WHEEL_LEFT || \
199 (b) == MB_WHEEL_RIGHT)
200 #define IS_WHEEL_BUTTON(b) (IS_WHEEL_BUTTON_VERTICAL(b) || \
201 IS_WHEEL_BUTTON_HORIZONTAL(b))
202 #define DEFAULT_WHEEL_STEPS 3
204 #define BUTTON_STEPSIZE(b) ((b) == MB_LEFTBUTTON ? 1 : \
205 (b) == MB_MIDDLEBUTTON ? 5 : \
206 (b) == MB_RIGHTBUTTON ? 10 : 1)
208 /* values for move directions */
209 #define MV_BIT_LEFT 0
210 #define MV_BIT_RIGHT 1
212 #define MV_BIT_DOWN 3
214 #define NUM_DIRECTIONS 4
216 /* diagonal movement directions are used in a different contect than buttons */
217 #define MV_BIT_UPLEFT 4
218 #define MV_BIT_UPRIGHT 5
219 #define MV_BIT_DOWNLEFT 6
220 #define MV_BIT_DOWNRIGHT 7
222 #define NUM_DIRECTIONS_FULL 8
224 /* values for special "button" bitmasks */
228 #define NUM_PLAYER_ACTIONS 6
230 /* values for special "focus player" bitmasks */
231 #define BIT_SET_FOCUS 6
233 /* values for drawing stages for global animations */
234 #define DRAW_GLOBAL_ANIM_STAGE_1 1
235 #define DRAW_GLOBAL_ANIM_STAGE_2 2
237 /* values for drawing target (various functions) */
238 #define DRAW_TO_BACKBUFFER 0
239 #define DRAW_TO_FIELDBUFFER 1
240 #define DRAW_TO_SCREEN 2
241 #define DRAW_TO_FADE_SOURCE 3
242 #define DRAW_TO_FADE_TARGET 4
244 /* values for move directions and special "button" key bitmasks */
246 #define MV_LEFT (1 << MV_BIT_LEFT)
247 #define MV_RIGHT (1 << MV_BIT_RIGHT)
248 #define MV_UP (1 << MV_BIT_UP)
249 #define MV_DOWN (1 << MV_BIT_DOWN)
251 #define MV_UPLEFT (MV_UP | MV_LEFT)
252 #define MV_UPRIGHT (MV_UP | MV_RIGHT)
253 #define MV_DOWNLEFT (MV_DOWN | MV_LEFT)
254 #define MV_DOWNRIGHT (MV_DOWN | MV_RIGHT)
256 #define MV_HORIZONTAL (MV_LEFT | MV_RIGHT)
257 #define MV_VERTICAL (MV_UP | MV_DOWN)
258 #define MV_ALL_DIRECTIONS (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
259 #define MV_ANY_DIRECTION (MV_ALL_DIRECTIONS)
260 #define MV_NO_DIRECTION (MV_NONE)
262 #define KEY_BUTTON_1 (1 << BUTTON_1)
263 #define KEY_BUTTON_2 (1 << BUTTON_2)
264 #define KEY_BUTTON_SNAP KEY_BUTTON_1
265 #define KEY_BUTTON_DROP KEY_BUTTON_2
266 #define KEY_MOTION (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
267 #define KEY_BUTTON (KEY_BUTTON_1 | KEY_BUTTON_2)
268 #define KEY_ACTION (KEY_MOTION | KEY_BUTTON)
270 #define KEY_SET_FOCUS (1 << BIT_SET_FOCUS)
272 #define MV_DIR_FROM_BIT(x) ((x) < NUM_DIRECTIONS ? 1 << (x) : \
273 (x) == MV_BIT_UPLEFT ? MV_UPLEFT : \
274 (x) == MV_BIT_UPRIGHT ? MV_UPRIGHT : \
275 (x) == MV_BIT_DOWNLEFT ? MV_DOWNLEFT : \
276 (x) == MV_BIT_DOWNRIGHT ? MV_DOWNRIGHT : \
279 #define MV_DIR_TO_BIT(x) ((x) == MV_LEFT ? MV_BIT_LEFT : \
280 (x) == MV_RIGHT ? MV_BIT_RIGHT : \
281 (x) == MV_UP ? MV_BIT_UP : \
282 (x) == MV_DOWN ? MV_BIT_DOWN : \
283 (x) == MV_UPLEFT ? MV_BIT_UPLEFT : \
284 (x) == MV_UPRIGHT ? MV_BIT_UPRIGHT : \
285 (x) == MV_DOWNLEFT ? MV_BIT_DOWNLEFT : \
286 (x) == MV_DOWNRIGHT ? MV_BIT_DOWNRIGHT : \
289 #define MV_DIR_OPPOSITE(x) ((x) == MV_LEFT ? MV_RIGHT : \
290 (x) == MV_RIGHT ? MV_LEFT : \
291 (x) == MV_UP ? MV_DOWN : \
292 (x) == MV_DOWN ? MV_UP : \
293 (x) == MV_UPLEFT ? MV_DOWNRIGHT : \
294 (x) == MV_UPRIGHT ? MV_DOWNLEFT : \
295 (x) == MV_DOWNLEFT ? MV_UPRIGHT : \
296 (x) == MV_DOWNRIGHT ? MV_UPLEFT : \
299 /* values for animation mode (frame order and direction) */
300 /* (stored in level files -- never change existing values) */
302 #define ANIM_LOOP (1 << 0)
303 #define ANIM_LINEAR (1 << 1)
304 #define ANIM_PINGPONG (1 << 2)
305 #define ANIM_PINGPONG2 (1 << 3)
306 #define ANIM_RANDOM (1 << 4)
307 #define ANIM_CE_VALUE (1 << 5)
308 #define ANIM_CE_SCORE (1 << 6)
309 #define ANIM_CE_DELAY (1 << 7)
310 #define ANIM_REVERSE (1 << 8)
311 #define ANIM_OPAQUE_PLAYER (1 << 9)
313 /* values for special (non game element) animation modes */
314 /* (not stored in level files -- can be changed, if needed) */
315 #define ANIM_HORIZONTAL (1 << 10)
316 #define ANIM_VERTICAL (1 << 11)
317 #define ANIM_CENTERED (1 << 12)
318 #define ANIM_STATIC_PANEL (1 << 13)
319 #define ANIM_ALL (1 << 14)
320 #define ANIM_ONCE (1 << 15)
322 #define ANIM_DEFAULT ANIM_LOOP
324 /* values for special drawing styles (currently only for crumbled graphics) */
326 #define STYLE_ACCURATE_BORDERS (1 << 0)
327 #define STYLE_INNER_CORNERS (1 << 1)
328 #define STYLE_REVERSE (1 << 2)
330 #define STYLE_DEFAULT STYLE_NONE
332 /* values for special global animation events */
333 #define ANIM_EVENT_NONE 0
334 #define ANIM_EVENT_SELF (1 << 16)
335 #define ANIM_EVENT_ANY (1 << 17)
337 #define ANIM_EVENT_ANIM_BIT 0
338 #define ANIM_EVENT_PART_BIT 8
340 #define ANIM_EVENT_ANIM_MASK (0xff << ANIM_EVENT_ANIM_BIT)
341 #define ANIM_EVENT_PART_MASK (0xff << ANIM_EVENT_PART_BIT)
343 #define ANIM_EVENT_DEFAULT ANIM_EVENT_NONE
345 /* values for fade mode */
346 #define FADE_TYPE_NONE 0
347 #define FADE_TYPE_FADE_IN (1 << 0)
348 #define FADE_TYPE_FADE_OUT (1 << 1)
349 #define FADE_TYPE_TRANSFORM (1 << 2)
350 #define FADE_TYPE_CROSSFADE (1 << 3)
351 #define FADE_TYPE_MELT (1 << 4)
352 #define FADE_TYPE_CURTAIN (1 << 5)
353 #define FADE_TYPE_SKIP (1 << 6)
355 #define FADE_MODE_NONE (FADE_TYPE_NONE)
356 #define FADE_MODE_FADE_IN (FADE_TYPE_FADE_IN)
357 #define FADE_MODE_FADE_OUT (FADE_TYPE_FADE_OUT)
358 #define FADE_MODE_FADE (FADE_TYPE_FADE_IN | FADE_TYPE_FADE_OUT)
359 #define FADE_MODE_TRANSFORM (FADE_TYPE_TRANSFORM | FADE_TYPE_FADE_IN)
360 #define FADE_MODE_CROSSFADE (FADE_MODE_TRANSFORM | FADE_TYPE_CROSSFADE)
361 #define FADE_MODE_MELT (FADE_MODE_TRANSFORM | FADE_TYPE_MELT)
362 #define FADE_MODE_CURTAIN (FADE_MODE_TRANSFORM | FADE_TYPE_CURTAIN)
363 #define FADE_MODE_SKIP_FADE_IN (FADE_TYPE_SKIP | FADE_TYPE_FADE_IN)
364 #define FADE_MODE_SKIP_FADE_OUT (FADE_TYPE_SKIP | FADE_TYPE_FADE_OUT)
366 #define FADE_MODE_DEFAULT FADE_MODE_FADE
368 /* values for toon positions */
369 #define POS_UNDEFINED -1
380 /* values for text alignment */
381 #define ALIGN_LEFT (1 << 0)
382 #define ALIGN_RIGHT (1 << 1)
383 #define ALIGN_CENTER (1 << 2)
384 #define ALIGN_DEFAULT ALIGN_LEFT
386 #define VALIGN_TOP (1 << 0)
387 #define VALIGN_BOTTOM (1 << 1)
388 #define VALIGN_MIDDLE (1 << 2)
389 #define VALIGN_DEFAULT VALIGN_TOP
391 #define ALIGNED_XPOS(x,w,a) ((a) == ALIGN_CENTER ? (x) - (w) / 2 : \
392 (a) == ALIGN_RIGHT ? (x) - (w) : (x))
393 #define ALIGNED_YPOS(y,h,v) ((v) == VALIGN_MIDDLE ? (y) - (h) / 2 : \
394 (v) == VALIGN_BOTTOM ? (y) - (h) : (y))
395 #define ALIGNED_TEXT_XPOS(p) ALIGNED_XPOS((p)->x, (p)->width, (p)->align)
396 #define ALIGNED_TEXT_YPOS(p) ALIGNED_YPOS((p)->y, (p)->height, (p)->valign)
398 /* values for redraw_mask */
399 #define REDRAW_NONE (0)
400 #define REDRAW_ALL (1 << 0)
401 #define REDRAW_FIELD (1 << 1)
402 #define REDRAW_DOOR_1 (1 << 2)
403 #define REDRAW_DOOR_2 (1 << 3)
404 #define REDRAW_DOOR_3 (1 << 4)
405 #define REDRAW_FPS (1 << 5)
407 #define REDRAW_DOORS (REDRAW_DOOR_1 | \
411 #define IN_GFX_FIELD_PLAY(x, y) (x >= gfx.sx && x < gfx.sx + gfx.sxsize && \
412 y >= gfx.sy && y < gfx.sy + gfx.sysize)
413 #define IN_GFX_FIELD_FULL(x, y) (x >= gfx.real_sx && \
414 x < gfx.real_sx + gfx.full_sxsize && \
415 y >= gfx.real_sy && \
416 y < gfx.real_sy + gfx.full_sysize)
417 #define IN_GFX_DOOR_1(x, y) (x >= gfx.dx && x < gfx.dx + gfx.dxsize && \
418 y >= gfx.dy && y < gfx.dy + gfx.dysize)
419 #define IN_GFX_DOOR_2(x, y) (x >= gfx.vx && x < gfx.vx + gfx.vxsize && \
420 y >= gfx.vy && y < gfx.vy + gfx.vysize)
421 #define IN_GFX_DOOR_3(x, y) (x >= gfx.ex && x < gfx.ex + gfx.exsize && \
422 y >= gfx.ey && y < gfx.ey + gfx.eysize)
424 /* values for mouse cursor */
425 #define CURSOR_DEFAULT 0
426 #define CURSOR_NONE 1
427 #define CURSOR_PLAYFIELD 2
429 /* fundamental game speed values */
430 #define ONE_SECOND_DELAY 1000 /* delay value for one second */
431 #define MENU_FRAME_DELAY 20 /* frame delay in milliseconds */
432 #define GAME_FRAME_DELAY 20 /* frame delay in milliseconds */
433 #define FFWD_FRAME_DELAY 10 /* 200% speed for fast forward */
434 #define FRAMES_PER_SECOND (ONE_SECOND_DELAY / GAME_FRAME_DELAY)
435 #define FRAMES_PER_SECOND_SP 35
437 /* maximum playfield size supported by libgame functions */
438 #define MAX_PLAYFIELD_WIDTH 128
439 #define MAX_PLAYFIELD_HEIGHT 128
441 /* maximum number of parallel players supported by libgame functions */
442 #define MAX_PLAYERS 4
444 /* maximum allowed length of player name */
445 #define MAX_PLAYER_NAME_LEN 10
447 /* maximum number of levels in a level set */
448 #define MAX_LEVELS 1000
450 /* maximum number of global animation and parts */
451 #define MAX_GLOBAL_ANIMS 32
452 #define MAX_GLOBAL_ANIM_PARTS 32
454 /* minimum/maximum/default x/y grid size for virtual buttons */
455 #define MIN_GRID_XSIZE 3
456 #define MIN_GRID_YSIZE 3
457 #define MAX_GRID_XSIZE 32
458 #define MAX_GRID_YSIZE 32
459 #define GRID_REAL_WIDTH MAX(video.screen_width, \
461 #define GRID_REAL_HEIGHT MIN(video.screen_width, \
463 #define DEFAULT_GRID_XSIZE_0 18
464 #define DEFAULT_GRID_YSIZE_0 MIN(MAX(MIN_GRID_YSIZE, \
465 DEFAULT_GRID_XSIZE_0 * \
469 #define DEFAULT_GRID_XSIZE_1 13
470 #define DEFAULT_GRID_YSIZE_1 MIN(MAX(MIN_GRID_YSIZE, \
471 DEFAULT_GRID_XSIZE_1 * \
476 #define DEFAULT_GRID_XSIZE(n) (n == 0 ? DEFAULT_GRID_XSIZE_0 : \
477 DEFAULT_GRID_XSIZE_1)
478 #define DEFAULT_GRID_YSIZE(n) (n == 0 ? DEFAULT_GRID_YSIZE_0 : \
479 DEFAULT_GRID_YSIZE_1)
481 #define GRID_ACTIVE_NR() (video.screen_width > \
482 video.screen_height ? 0 : 1)
484 /* values for grid button characters for virtual buttons */
485 #define CHAR_GRID_BUTTON_NONE ' '
486 #define CHAR_GRID_BUTTON_LEFT '<'
487 #define CHAR_GRID_BUTTON_RIGHT '>'
488 #define CHAR_GRID_BUTTON_UP '^'
489 #define CHAR_GRID_BUTTON_DOWN 'v'
490 #define CHAR_GRID_BUTTON_SNAP '1'
491 #define CHAR_GRID_BUTTON_DROP '2'
493 /* default name for empty highscore entry */
494 #define EMPTY_PLAYER_NAME "no name"
496 /* default name for unknown player names */
497 #define ANONYMOUS_NAME "anonymous"
499 /* default for other unknown names */
500 #define UNKNOWN_NAME "unknown"
502 /* default name for new levels */
503 #define NAMELESS_LEVEL_NAME "nameless level"
505 /* default text for non-existant artwork */
506 #define NOT_AVAILABLE "(not available)"
508 /* default value for undefined filename */
509 #define UNDEFINED_FILENAME "[NONE]"
511 /* default value for undefined levelset */
512 #define UNDEFINED_LEVELSET "[NONE]"
514 /* default value for undefined parameter */
515 #define ARG_DEFAULT "[DEFAULT]"
517 /* default values for undefined configuration file parameters */
518 #define ARG_UNDEFINED "-1000000"
519 #define ARG_UNDEFINED_VALUE (-1000000)
521 /* default value for off-screen positions */
522 #define POS_OFFSCREEN (-1000000)
524 /* definitions for game sub-directories */
526 #define RO_GAME_DIR "."
530 #define RW_GAME_DIR "."
533 #define RO_BASE_PATH RO_GAME_DIR
534 #define RW_BASE_PATH RW_GAME_DIR
536 /* directory names */
537 #define GRAPHICS_DIRECTORY "graphics"
538 #define SOUNDS_DIRECTORY "sounds"
539 #define MUSIC_DIRECTORY "music"
540 #define LEVELS_DIRECTORY "levels"
541 #define TAPES_DIRECTORY "tapes"
542 #define SCORES_DIRECTORY "scores"
543 #define DOCS_DIRECTORY "docs"
544 #define CACHE_DIRECTORY "cache"
545 #define CONF_DIRECTORY "conf"
547 #define GFX_CLASSIC_SUBDIR "gfx_classic"
548 #define SND_CLASSIC_SUBDIR "snd_classic"
549 #define MUS_CLASSIC_SUBDIR "mus_classic"
551 #define GFX_DEFAULT_SUBDIR (setup.internal.default_graphics_set)
552 #define SND_DEFAULT_SUBDIR (setup.internal.default_sounds_set)
553 #define MUS_DEFAULT_SUBDIR (setup.internal.default_music_set)
555 #define GFX_FALLBACK_FILENAME (setup.internal.fallback_graphics_file)
556 #define SND_FALLBACK_FILENAME (setup.internal.fallback_sounds_file)
557 #define MUS_FALLBACK_FILENAME (setup.internal.fallback_music_file)
559 #define DEFAULT_LEVELSET (setup.internal.default_level_series)
561 /* file names and filename extensions */
562 #define LEVELSETUP_DIRECTORY "levelsetup"
563 #define SETUP_FILENAME "setup.conf"
564 #define AUTOSETUP_FILENAME "autosetup.conf"
565 #define LEVELSETUP_FILENAME "levelsetup.conf"
566 #define EDITORSETUP_FILENAME "editorsetup.conf"
567 #define EDITORCASCADE_FILENAME "editorcascade.conf"
568 #define HELPANIM_FILENAME "helpanim.conf"
569 #define HELPTEXT_FILENAME "helptext.conf"
570 #define LEVELINFO_FILENAME "levelinfo.conf"
571 #define GRAPHICSINFO_FILENAME "graphicsinfo.conf"
572 #define SOUNDSINFO_FILENAME "soundsinfo.conf"
573 #define MUSICINFO_FILENAME "musicinfo.conf"
574 #define ARTWORKINFO_CACHE_FILE "artworkinfo.cache"
575 #define LEVELTEMPLATE_FILENAME "template.level"
576 #define LEVELFILE_EXTENSION "level"
577 #define TAPEFILE_EXTENSION "tape"
578 #define SCOREFILE_EXTENSION "score"
580 #define GAMECONTROLLER_BASENAME "gamecontrollerdb.txt"
582 #define LOG_OUT_BASENAME "stdout.txt"
583 #define LOG_ERR_BASENAME "stderr.txt"
589 #define STRING_PARENT_DIRECTORY ".."
590 #define STRING_TOP_DIRECTORY "/"
592 #define CHAR_PATH_SEPARATOR_UNIX '/'
593 #define CHAR_PATH_SEPARATOR_DOS '\\'
595 #define STRING_PATH_SEPARATOR_UNIX "/"
596 #define STRING_PATH_SEPARATOR_DOS "\\"
598 #define STRING_NEWLINE_UNIX "\n"
599 #define STRING_NEWLINE_DOS "\r\n"
601 #if defined(PLATFORM_WIN32)
602 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_DOS
603 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_DOS
604 #define STRING_NEWLINE STRING_NEWLINE_DOS
606 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_UNIX
607 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_UNIX
608 #define STRING_NEWLINE STRING_NEWLINE_UNIX
612 /* areas in bitmap PIX_DOOR */
613 /* meaning in PIX_DB_DOOR: (3 PAGEs)
614 PAGEX1: 1. buffer for DOOR_1
615 PAGEX2: 2. buffer for DOOR_1
616 PAGEX3: buffer for animations
619 /* these values are hard-coded to be able to use them in initialization */
620 #define DOOR_GFX_PAGE_WIDTH 100 /* should be set to "gfx.dxsize" */
621 #define DOOR_GFX_PAGE_HEIGHT 280 /* should be set to "gfx.dysize" */
623 #define DOOR_GFX_PAGESIZE (DOOR_GFX_PAGE_WIDTH)
624 #define DOOR_GFX_PAGEX1 (0 * DOOR_GFX_PAGESIZE)
625 #define DOOR_GFX_PAGEX2 (1 * DOOR_GFX_PAGESIZE)
626 #define DOOR_GFX_PAGEX3 (2 * DOOR_GFX_PAGESIZE)
627 #define DOOR_GFX_PAGEX4 (3 * DOOR_GFX_PAGESIZE)
628 #define DOOR_GFX_PAGEX5 (4 * DOOR_GFX_PAGESIZE)
629 #define DOOR_GFX_PAGEX6 (5 * DOOR_GFX_PAGESIZE)
630 #define DOOR_GFX_PAGEX7 (6 * DOOR_GFX_PAGESIZE)
631 #define DOOR_GFX_PAGEX8 (7 * DOOR_GFX_PAGESIZE)
632 #define DOOR_GFX_PAGEY1 (0)
633 #define DOOR_GFX_PAGEY2 (DOOR_GFX_PAGE_HEIGHT)
636 /* macros for version handling */
637 #define VERSION_PART_1(x) ((x) / 1000000)
638 #define VERSION_PART_2(x) (((x) % 1000000) / 10000)
639 #define VERSION_PART_3(x) (((x) % 10000) / 100)
640 #define VERSION_PART_4(x) ((x) % 100)
642 #define VERSION_SUPER(x) VERSION_PART_1(x)
643 #define VERSION_MAJOR(x) VERSION_PART_2(x)
644 #define VERSION_MINOR(x) VERSION_PART_3(x)
645 #define VERSION_PATCH(x) VERSION_PART_4(x)
646 #define VERSION_IDENT(a,b,c,d) ((a) * 1000000 + (b) * 10000 + (c) * 100 + (d))
649 /* macros for parent/child process identification */
650 #if defined(PLATFORM_UNIX)
651 #define IS_PARENT_PROCESS() (audio.mixer_pid != getpid())
652 #define IS_CHILD_PROCESS() (audio.mixer_pid == getpid())
653 #define HAS_CHILD_PROCESS() (audio.mixer_pid > 0)
655 #define IS_PARENT_PROCESS() TRUE
656 #define IS_CHILD_PROCESS() FALSE
657 #define HAS_CHILD_PROCESS() FALSE
661 /* values for artwork type */
662 #define ARTWORK_TYPE_GRAPHICS 0
663 #define ARTWORK_TYPE_SOUNDS 1
664 #define ARTWORK_TYPE_MUSIC 2
666 #define NUM_ARTWORK_TYPES 3
669 /* values for tree type (chosen to match artwork type) */
670 #define TREE_TYPE_UNDEFINED -1
671 #define TREE_TYPE_GRAPHICS_DIR ARTWORK_TYPE_GRAPHICS
672 #define TREE_TYPE_SOUNDS_DIR ARTWORK_TYPE_SOUNDS
673 #define TREE_TYPE_MUSIC_DIR ARTWORK_TYPE_MUSIC
674 #define TREE_TYPE_LEVEL_DIR 3
675 #define TREE_TYPE_LEVEL_NR 4
677 #define NUM_TREE_TYPES 5
679 #define INFOTEXT_UNDEFINED ""
680 #define INFOTEXT_GRAPHICS_DIR "Custom Graphics"
681 #define INFOTEXT_SOUNDS_DIR "Custom Sounds"
682 #define INFOTEXT_MUSIC_DIR "Custom Music"
683 #define INFOTEXT_LEVEL_DIR "Level Sets"
684 #define INFOTEXT_LEVEL_NR "Levels"
686 #define TREE_INFOTEXT(t) ((t) == TREE_TYPE_LEVEL_NR ? \
687 INFOTEXT_LEVEL_NR : \
688 (t) == TREE_TYPE_LEVEL_DIR ? \
689 INFOTEXT_LEVEL_DIR : \
690 (t) == TREE_TYPE_GRAPHICS_DIR ? \
691 INFOTEXT_GRAPHICS_DIR : \
692 (t) == TREE_TYPE_SOUNDS_DIR ? \
693 INFOTEXT_SOUNDS_DIR : \
694 (t) == TREE_TYPE_MUSIC_DIR ? \
695 INFOTEXT_MUSIC_DIR : \
698 /* values for artwork handling */
699 #define LEVELDIR_ARTWORK_SET_PTR(leveldir, type) \
700 ((type) == ARTWORK_TYPE_GRAPHICS ? \
701 &(leveldir)->graphics_set : \
702 (type) == ARTWORK_TYPE_SOUNDS ? \
703 &(leveldir)->sounds_set : \
704 &(leveldir)->music_set)
706 #define LEVELDIR_ARTWORK_SET(leveldir, type) \
707 ((type) == ARTWORK_TYPE_GRAPHICS ? \
708 (leveldir)->graphics_set : \
709 (type) == ARTWORK_TYPE_SOUNDS ? \
710 (leveldir)->sounds_set : \
711 (leveldir)->music_set)
713 #define LEVELDIR_ARTWORK_PATH_PTR(leveldir, type) \
714 ((type) == ARTWORK_TYPE_GRAPHICS ? \
715 &(leveldir)->graphics_path : \
716 (type) == ARTWORK_TYPE_SOUNDS ? \
717 &(leveldir)->sounds_path : \
718 &(leveldir)->music_path)
720 #define LEVELDIR_ARTWORK_PATH(leveldir, type) \
721 ((type) == ARTWORK_TYPE_GRAPHICS ? \
722 (leveldir)->graphics_path : \
723 (type) == ARTWORK_TYPE_SOUNDS ? \
724 (leveldir)->sounds_path : \
725 (leveldir)->music_path)
727 #define SETUP_ARTWORK_SET(setup, type) \
728 ((type) == ARTWORK_TYPE_GRAPHICS ? \
729 (setup).graphics_set : \
730 (type) == ARTWORK_TYPE_SOUNDS ? \
731 (setup).sounds_set : \
734 #define SETUP_OVERRIDE_ARTWORK(setup, type) \
735 ((type) == ARTWORK_TYPE_GRAPHICS ? \
736 (setup).override_level_graphics : \
737 (type) == ARTWORK_TYPE_SOUNDS ? \
738 (setup).override_level_sounds : \
739 (setup).override_level_music)
741 #define GFX_OVERRIDE_ARTWORK(type) \
742 ((type) == ARTWORK_TYPE_GRAPHICS ? \
743 gfx.override_level_graphics : \
744 (type) == ARTWORK_TYPE_SOUNDS ? \
745 gfx.override_level_sounds : \
746 gfx.override_level_music)
748 #define ARTWORK_FIRST_NODE(artwork, type) \
749 ((type) == ARTWORK_TYPE_GRAPHICS ? \
750 (artwork).gfx_first : \
751 (type) == ARTWORK_TYPE_SOUNDS ? \
752 (artwork).snd_first : \
755 #define ARTWORK_CURRENT_IDENTIFIER_PTR(artwork, type) \
756 ((type) == ARTWORK_TYPE_GRAPHICS ? \
757 &(artwork).gfx_current_identifier : \
758 (type) == ARTWORK_TYPE_SOUNDS ? \
759 &(artwork).snd_current_identifier : \
760 &(artwork).mus_current_identifier)
762 #define ARTWORK_CURRENT_IDENTIFIER(artwork, type) \
763 ((type) == ARTWORK_TYPE_GRAPHICS ? \
764 (artwork).gfx_current_identifier : \
765 (type) == ARTWORK_TYPE_SOUNDS ? \
766 (artwork).snd_current_identifier : \
767 (artwork).mus_current_identifier)
769 #define ARTWORKINFO_FILENAME(type) \
770 ((type) == ARTWORK_TYPE_GRAPHICS ? \
771 GRAPHICSINFO_FILENAME : \
772 (type) == ARTWORK_TYPE_SOUNDS ? \
773 SOUNDSINFO_FILENAME : \
774 (type) == ARTWORK_TYPE_MUSIC ? \
775 MUSICINFO_FILENAME : "")
777 #define ARTWORK_DIRECTORY(type) \
778 ((type) == ARTWORK_TYPE_GRAPHICS ? \
779 GRAPHICS_DIRECTORY : \
780 (type) == ARTWORK_TYPE_SOUNDS ? \
782 (type) == ARTWORK_TYPE_MUSIC ? \
783 MUSIC_DIRECTORY : "")
785 #define OPTIONS_ARTWORK_DIRECTORY(type) \
786 ((type) == ARTWORK_TYPE_GRAPHICS ? \
787 options.graphics_directory : \
788 (type) == ARTWORK_TYPE_SOUNDS ? \
789 options.sounds_directory : \
790 (type) == ARTWORK_TYPE_MUSIC ? \
791 options.music_directory : "")
793 #define UPDATE_BUSY_STATE() \
795 if (gfx.draw_busy_anim_function != NULL) \
796 gfx.draw_busy_anim_function(); \
800 /* structure definitions */
804 char *command_basepath; /* path to the program binary */
805 char *command_basename; /* base filename of the program binary */
807 char *config_filename; /* optional global program config filename */
809 char *maindata_path; /* main game data (installation) directory */
811 char *userdata_subdir; /* personal user game data directory */
812 char *userdata_path; /* resulting full path to game data directory */
822 char *log_filename[NUM_LOGS]; /* log filenames for out/err messages */
823 FILE *log_file[NUM_LOGS]; /* log file handles for out/err files */
824 FILE *log_file_default[NUM_LOGS]; /* default log file handles (out/err) */
832 char *version_string;
834 char *(*window_title_function)(void);
835 void (*exit_message_function)(char *, va_list);
836 void (*exit_function)(int);
838 boolean global_scores;
839 boolean many_scores_per_name;
849 char *ro_base_directory;
850 char *rw_base_directory;
851 char *level_directory;
852 char *graphics_directory;
853 char *sounds_directory;
854 char *music_directory;
855 char *docs_directory;
856 char *conf_directory;
858 char *execute_command;
869 struct VideoSystemInfo
872 int width, height, depth;
873 int window_width, window_height;
874 int display_width, display_height;
875 int screen_width, screen_height;
876 int screen_xoffset, screen_yoffset;
878 boolean fullscreen_available;
879 boolean fullscreen_enabled;
880 boolean fullscreen_initial;
882 boolean window_scaling_available;
883 int window_scaling_percent;
884 char *window_scaling_quality;
885 int screen_rendering_mode;
887 unsigned int frame_delay;
888 unsigned int frame_delay_value;
892 int shifted_up_pos_last;
893 unsigned int shifted_up_delay;
894 unsigned int shifted_up_delay_value;
899 struct AudioSystemInfo
901 boolean sound_available;
902 boolean loops_available;
903 boolean music_available;
905 boolean sound_enabled;
906 boolean sound_deactivated; /* for temporarily disabling sound */
915 int first_sound_channel;
918 struct FontBitmapInfo
922 int src_x, src_y; /* start position of font characters */
923 int width, height; /* width / height of font characters */
925 int offset_x; /* offset to next font character */
926 int offset_y; /* offset to next font character */
928 int draw_xoffset; /* offset for drawing font characters */
929 int draw_yoffset; /* offset for drawing font characters */
932 int num_chars_per_line;
939 int real_sx, real_sy;
940 int full_sxsize, full_sysize;
941 int scrollbuffer_width, scrollbuffer_height;
943 int game_tile_size, standard_tile_size;
954 int win_xsize, win_ysize;
956 int draw_deactivation_mask;
957 int draw_background_mask;
959 Bitmap *field_save_buffer;
961 Bitmap *background_bitmap;
962 int background_bitmap_mask;
964 Bitmap *fade_bitmap_backup;
965 Bitmap *fade_bitmap_source;
966 Bitmap *fade_bitmap_target;
967 Bitmap *fade_bitmap_black;
969 int fade_border_source_status;
970 int fade_border_target_status;
971 Bitmap *masked_border_bitmap_ptr;
973 Bitmap *final_screen_bitmap;
975 boolean clipping_enabled;
977 int clip_width, clip_height;
979 boolean override_level_graphics;
980 boolean override_level_sounds;
981 boolean override_level_music;
983 boolean draw_init_text;
986 struct FontBitmapInfo *font_bitmap_info;
987 int (*select_font_function)(int);
988 int (*get_font_from_token_function)(char *);
990 int anim_random_frame;
992 void (*draw_busy_anim_function)(void);
993 void (*draw_global_anim_function)(int, int);
994 void (*draw_global_border_function)(int);
995 void (*draw_tile_cursor_function)(int);
1000 struct TileCursorInfo
1002 boolean enabled; /* tile cursor generally enabled or disabled */
1003 boolean active; /* tile cursor activated (depending on game) */
1004 boolean moving; /* tile cursor moving to target position */
1006 int xpos, ypos; /* tile cursor level playfield position */
1007 int x, y; /* tile cursor current screen position */
1008 int target_x, target_y; /* tile cursor target screen position */
1010 int sx, sy; /* tile cursor screen start position */
1015 boolean enabled; /* overlay generally enabled or disabled */
1016 boolean active; /* overlay activated (depending on game mode) */
1020 int grid_xsize_all[2];
1021 int grid_ysize_all[2];
1025 char grid_button_all[2][MAX_GRID_XSIZE][MAX_GRID_YSIZE];
1026 char grid_button[MAX_GRID_XSIZE][MAX_GRID_YSIZE];
1027 char grid_button_highlight;
1033 int nr[MAX_PLAYERS]; /* joystick number for each player */
1036 struct SetupJoystickInfo
1038 char *device_name; /* device name of player's joystick */
1040 int xleft, xmiddle, xright;
1041 int yupper, ymiddle, ylower;
1045 struct SetupKeyboardInfo
1047 Key left, right, up, down;
1051 struct SetupTouchInfo
1058 struct SetupInputInfo
1060 boolean use_joystick;
1061 struct SetupJoystickInfo joy;
1062 struct SetupKeyboardInfo key;
1065 struct SetupEditorInfo
1067 boolean el_boulderdash;
1068 boolean el_emerald_mine;
1069 boolean el_emerald_mine_club;
1072 boolean el_supaplex;
1073 boolean el_diamond_caves;
1074 boolean el_dx_boulderdash;
1076 boolean el_mirror_magic;
1077 boolean el_deflektor;
1080 boolean el_steel_chars;
1084 boolean el_user_defined;
1087 boolean el_headlines;
1092 boolean show_element_token;
1094 boolean use_template_for_new_levels;
1097 struct SetupAutoSetupInfo
1099 int editor_zoom_tilesize;
1102 struct SetupEditorCascadeInfo
1115 boolean el_steel_chars;
1123 struct SetupShortcutInfo
1129 Key focus_player[MAX_PLAYERS];
1130 Key focus_player_all;
1149 struct SetupSystemInfo
1151 char *sdl_videodriver;
1152 char *sdl_audiodriver;
1153 int audio_fragment_size;
1156 struct SetupInternalInfo
1158 char *program_title;
1159 char *program_version;
1160 char *program_author;
1161 char *program_email;
1162 char *program_website;
1163 char *program_copyright;
1164 char *program_company;
1166 char *program_icon_file;
1168 char *default_graphics_set;
1169 char *default_sounds_set;
1170 char *default_music_set;
1172 char *fallback_graphics_file;
1173 char *fallback_sounds_file;
1174 char *fallback_music_file;
1176 char *default_level_series;
1178 int default_window_width;
1179 int default_window_height;
1181 boolean choose_from_top_leveldir;
1182 boolean show_scaling_in_title;
1185 struct SetupDebugInfo
1187 int frame_delay[10];
1188 Key frame_delay_key[10];
1189 boolean frame_delay_use_mod_key;
1190 boolean frame_delay_game_only;
1191 boolean show_frames_per_second;
1199 boolean sound_loops;
1200 boolean sound_music;
1201 boolean sound_simple;
1203 boolean scroll_delay;
1204 boolean scroll_delay_value;
1205 char *engine_snapshot_mode;
1206 int engine_snapshot_memory;
1207 boolean fade_screens;
1209 boolean show_titlescreen;
1210 boolean quick_doors;
1213 boolean skip_levels;
1214 boolean increment_levels;
1217 int window_scaling_percent;
1218 char *window_scaling_quality;
1219 char *screen_rendering_mode;
1220 boolean ask_on_escape;
1221 boolean ask_on_escape_editor;
1222 boolean quick_switch;
1223 boolean input_on_focus;
1224 boolean prefer_aga_graphics;
1225 int game_frame_delay;
1226 boolean sp_show_border_elements;
1227 boolean small_game_graphics;
1228 boolean show_snapshot_buttons;
1233 int override_level_graphics; /* not boolean -- can also be "AUTO" */
1234 int override_level_sounds; /* not boolean -- can also be "AUTO" */
1235 int override_level_music; /* not boolean -- can also be "AUTO" */
1241 struct SetupAutoSetupInfo auto_setup;
1242 struct SetupEditorInfo editor;
1243 struct SetupEditorCascadeInfo editor_cascade;
1244 struct SetupShortcutInfo shortcut;
1245 struct SetupInputInfo input[MAX_PLAYERS];
1246 struct SetupTouchInfo touch;
1247 struct SetupSystemInfo system;
1248 struct SetupInternalInfo internal;
1249 struct SetupDebugInfo debug;
1251 struct OptionInfo options;
1256 struct TreeInfo **node_top; /* topmost node in tree */
1257 struct TreeInfo *node_parent; /* parent level directory info */
1258 struct TreeInfo *node_group; /* level group sub-directory info */
1259 struct TreeInfo *next; /* next level series structure node */
1261 int cl_first; /* internal control field for setup screen */
1262 int cl_cursor; /* internal control field for setup screen */
1264 int type; /* type of tree content */
1266 /* fields for "type == TREE_TYPE_LEVEL_DIR" */
1268 char *subdir; /* tree info sub-directory basename (may be ".") */
1269 char *fullpath; /* complete path relative to tree base directory */
1270 char *basepath; /* absolute base path of tree base directory */
1271 char *identifier; /* identifier string for configuration files */
1272 char *name; /* tree info name, as displayed in selection menues */
1273 char *name_sorting; /* optional sorting name for correct name sorting */
1274 char *author; /* level or artwork author name */
1275 char *year; /* optional year of creation for levels or artwork */
1277 char *program_title; /* optional alternative text for program title */
1278 char *program_copyright; /* optional alternative text for program copyright */
1279 char *program_company; /* optional alternative text for program company */
1281 char *imported_from; /* optional comment for imported levels or artwork */
1282 char *imported_by; /* optional comment for imported levels or artwork */
1283 char *tested_by; /* optional comment to name people who tested a set */
1285 char *graphics_set_ecs; /* special EMC custom graphics set (ECS graphics) */
1286 char *graphics_set_aga; /* special EMC custom graphics set (AGA graphics) */
1287 char *graphics_set; /* optional custom graphics set (level tree only) */
1288 char *sounds_set; /* optional custom sounds set (level tree only) */
1289 char *music_set; /* optional custom music set (level tree only) */
1290 char *graphics_path; /* path to optional custom graphics set (level only) */
1291 char *sounds_path; /* path to optional custom sounds set (level only) */
1292 char *music_path; /* path to optional custom music set (level only) */
1294 char *level_filename; /* filename of level file (for packed level file) */
1295 char *level_filetype; /* type of levels in level directory or level file */
1297 char *special_flags; /* flags for special actions performed on level file */
1299 int levels; /* number of levels in level series */
1300 int first_level; /* first level number (to allow start with 0 or 1) */
1301 int last_level; /* last level number (automatically calculated) */
1302 int sort_priority; /* sort levels by 'sort_priority' and then by name */
1304 boolean latest_engine;/* force level set to use the latest game engine */
1306 boolean level_group; /* directory contains more level series directories */
1307 boolean parent_link; /* entry links back to parent directory */
1308 boolean in_user_dir; /* user defined levels are stored in home directory */
1309 boolean user_defined; /* levels in user directory and marked as "private" */
1310 boolean readonly; /* readonly levels can not be changed with editor */
1311 boolean handicap; /* level set has no handicap when set to "false" */
1312 boolean skip_levels; /* levels can be skipped when set to "true" */
1314 int color; /* color to use on selection screen for this level */
1315 char *class_desc; /* description of level series class */
1316 int handicap_level; /* number of the lowest unsolved level */
1318 char *infotext; /* optional text to describe the tree type (headline) */
1321 typedef struct TreeInfo TreeInfo;
1322 typedef struct TreeInfo LevelDirTree;
1323 typedef struct TreeInfo ArtworkDirTree;
1324 typedef struct TreeInfo GraphicsDirTree;
1325 typedef struct TreeInfo SoundsDirTree;
1326 typedef struct TreeInfo MusicDirTree;
1330 GraphicsDirTree *gfx_first;
1331 GraphicsDirTree *gfx_current;
1332 SoundsDirTree *snd_first;
1333 SoundsDirTree *snd_current;
1334 MusicDirTree *mus_first;
1335 MusicDirTree *mus_current;
1337 char *gfx_current_identifier;
1338 char *snd_current_identifier;
1339 char *mus_current_identifier;
1342 struct ValueTextInfo
1354 struct ConfigTypeInfo
1361 struct TokenIntPtrInfo
1371 char *default_filename;
1374 char **default_parameter; /* array of file parameters */
1375 char **parameter; /* array of file parameters */
1378 boolean fallback_to_default;
1379 boolean default_is_cloned;
1382 struct SetupFileList
1387 struct SetupFileList *next;
1392 char *source_filename; /* primary key for node list */
1396 struct PropertyMapping
1406 struct ArtworkListInfo
1408 int type; /* type of artwork */
1410 int num_file_list_entries;
1411 int num_dynamic_file_list_entries;
1412 struct FileInfo *file_list; /* static artwork file array */
1413 struct FileInfo *dynamic_file_list; /* dynamic artwrk file array */
1415 int num_suffix_list_entries;
1416 struct ConfigTypeInfo *suffix_list; /* parameter suffixes array */
1418 int num_base_prefixes;
1419 int num_ext1_suffixes;
1420 int num_ext2_suffixes;
1421 int num_ext3_suffixes;
1422 char **base_prefixes; /* base token prefixes array */
1423 char **ext1_suffixes; /* property suffixes array 1 */
1424 char **ext2_suffixes; /* property suffixes array 2 */
1425 char **ext3_suffixes; /* property suffixes array 3 */
1427 int num_ignore_tokens;
1428 char **ignore_tokens; /* file tokens to be ignored */
1430 int num_property_mapping_entries;
1431 struct PropertyMapping *property_mapping; /* mapping token -> artwork */
1433 int sizeof_artwork_list_entry;
1435 struct ListNodeInfo **artwork_list; /* static artwork node array */
1436 struct ListNodeInfo **dynamic_artwork_list; /* dynamic artwrk node array */
1437 struct ListNode *content_list; /* dynamic artwork node list */
1439 void *(*load_artwork)(char *); /* constructor function */
1440 void (*free_artwork)(void *); /* destructor function */
1460 struct RectWithBorder
1474 struct DoorPartPosInfo
1481 int start_step_opening;
1482 int start_step_closing;
1483 boolean draw_masked;
1490 int xoffset; /* special case for tape date and time */
1491 int xoffset2; /* special case for tape date */
1494 int size; /* also used for suffix ".digits" */
1496 boolean draw_masked;
1497 boolean draw_player; /* special case for network player buttons */
1498 int sort_priority; /* also used for suffix ".draw_order" */
1501 int direction; /* needed for panel time/health graphics */
1502 int class; /* needed for panel time/health graphics */
1503 int style; /* needed for panel time/health graphics */
1506 struct MouseActionInfo
1520 /* ========================================================================= */
1521 /* exported variables */
1522 /* ========================================================================= */
1524 extern struct ProgramInfo program;
1525 extern struct OptionInfo options;
1526 extern struct VideoSystemInfo video;
1527 extern struct AudioSystemInfo audio;
1528 extern struct GfxInfo gfx;
1529 extern struct TileCursorInfo tile_cursor;
1530 extern struct OverlayInfo overlay;
1531 extern struct AnimInfo anim;
1532 extern struct ArtworkInfo artwork;
1533 extern struct JoystickInfo joystick;
1534 extern struct SetupInfo setup;
1536 extern LevelDirTree *leveldir_first_all;
1537 extern LevelDirTree *leveldir_first;
1538 extern LevelDirTree *leveldir_current;
1539 extern int level_nr;
1541 extern struct LevelStats level_stats[];
1543 extern DrawWindow *window;
1544 extern DrawBuffer *backbuffer;
1545 extern DrawBuffer *drawto;
1547 extern int button_status;
1548 extern boolean motion_status;
1549 extern int wheel_steps;
1550 #if defined(TARGET_SDL2)
1551 extern boolean keyrepeat_status;
1554 extern int redraw_mask;
1556 extern int FrameCounter;
1559 /* function definitions */
1561 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
1564 void InitScoresInfo();
1565 void SetWindowTitle();
1567 void InitWindowTitleFunction(char *(*window_title_function)(void));
1568 void InitExitMessageFunction(void (*exit_message_function)(char *, va_list));
1569 void InitExitFunction(void (*exit_function)(int));
1570 void InitPlatformDependentStuff(void);
1571 void ClosePlatformDependentStuff(void);
1573 void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
1574 void InitGfxTileSizeInfo(int, int);
1575 void InitGfxDoor1Info(int, int, int, int);
1576 void InitGfxDoor2Info(int, int, int, int);
1577 void InitGfxDoor3Info(int, int, int, int);
1578 void InitGfxWindowInfo(int, int);
1579 void InitGfxScrollbufferInfo(int, int);
1580 void InitGfxClipRegion(boolean, int, int, int, int);
1581 void InitGfxDrawBusyAnimFunction(void (*draw_busy_anim_function)(void));
1582 void InitGfxDrawGlobalAnimFunction(void (*draw_global_anim_function)(int, int));
1583 void InitGfxDrawGlobalBorderFunction(void (*draw_global_border_function)(int));
1584 void InitGfxDrawTileCursorFunction(void (*draw_tile_cursor_function)(int));
1585 void InitGfxCustomArtworkInfo();
1586 void InitGfxOtherSettings();
1587 void InitTileCursorInfo();
1588 void InitOverlayInfo();
1589 void SetTileCursorEnabled(boolean);
1590 void SetTileCursorActive(boolean);
1591 void SetTileCursorTargetXY(int, int);
1592 void SetTileCursorXY(int, int);
1593 void SetTileCursorSXSY(int, int);
1594 void SetOverlayEnabled(boolean);
1595 void SetOverlayActive(boolean);
1596 void SetOverlayShowGrid(boolean);
1597 boolean GetOverlayActive();
1598 void SetDrawDeactivationMask(int);
1599 int GetDrawDeactivationMask(void);
1600 void SetDrawBackgroundMask(int);
1601 void SetWindowBackgroundBitmap(Bitmap *);
1602 void SetMainBackgroundBitmap(Bitmap *);
1603 void SetDoorBackgroundBitmap(Bitmap *);
1604 void SetRedrawMaskFromArea(int, int, int, int);
1606 void LimitScreenUpdates(boolean);
1608 void InitVideoDefaults(void);
1609 void InitVideoDisplay(void);
1610 void CloseVideoDisplay(void);
1611 void InitVideoBuffer(int, int, int, boolean);
1612 Bitmap *CreateBitmapStruct(void);
1613 Bitmap *CreateBitmap(int, int, int);
1614 void ReCreateBitmap(Bitmap **, int, int);
1615 void FreeBitmap(Bitmap *);
1616 void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
1617 void BlitBitmapTiled(Bitmap *, Bitmap *, int, int, int, int, int, int, int,int);
1618 void FadeRectangle(int, int, int, int, int, int, int,
1619 void (*draw_border_function)(void));
1620 void FillRectangle(Bitmap *, int, int, int, int, Pixel);
1621 void ClearRectangle(Bitmap *, int, int, int, int);
1622 void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
1623 void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
1624 boolean DrawingDeactivatedField(void);
1625 boolean DrawingDeactivated(int, int, int, int);
1626 boolean DrawingOnBackground(int, int);
1627 boolean DrawingAreaChanged();
1628 void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int, int);
1629 void BlitTexture(Bitmap *, int, int, int, int, int, int);
1630 void BlitTextureMasked(Bitmap *, int, int, int, int, int, int);
1631 void BlitToScreen(Bitmap *, int, int, int, int, int, int);
1632 void BlitToScreenMasked(Bitmap *, int, int, int, int, int, int);
1633 void DrawSimpleBlackLine(Bitmap *, int, int, int, int);
1634 void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
1635 void DrawLines(Bitmap *, struct XY *, int, Pixel);
1636 Pixel GetPixel(Bitmap *, int, int);
1637 Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
1638 Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
1640 void KeyboardAutoRepeatOn(void);
1641 void KeyboardAutoRepeatOff(void);
1642 boolean SetVideoMode(boolean);
1643 void SetVideoFrameDelay(unsigned int);
1644 unsigned int GetVideoFrameDelay();
1645 boolean ChangeVideoModeIfNeeded(boolean);
1647 Bitmap *LoadImage(char *);
1648 Bitmap *LoadCustomImage(char *);
1649 void ReloadCustomImage(Bitmap *, char *);
1651 void ReCreateGameTileSizeBitmap(Bitmap **);
1652 void CreateBitmapWithSmallBitmaps(Bitmap **, int, int);
1653 void CreateBitmapTextures(Bitmap **);
1654 void FreeBitmapTextures(Bitmap **);
1655 void ScaleBitmap(Bitmap **, int);
1657 void SetMouseCursor(int);
1659 void OpenAudio(void);
1660 void CloseAudio(void);
1661 void SetAudioMode(boolean);
1663 boolean PendingEvent(void);
1664 void WaitEvent(Event *event);
1665 void PeekEvent(Event *event);
1666 void CheckQuitEvent(void);
1667 Key GetEventKey(KeyEvent *, boolean);
1668 KeyMod HandleKeyModState(Key, int);
1669 KeyMod GetKeyModState();
1670 KeyMod GetKeyModStateFromEvents();
1671 void StartTextInput(int, int, int, int);
1672 void StopTextInput();
1673 boolean CheckCloseWindowEvent(ClientMessageEvent *);
1675 void InitJoysticks();
1676 boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
1677 boolean CheckJoystickOpened(int);
1678 void ClearJoystickState();
1680 #endif /* SYSTEM_H */