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 50
51 #define STD_WINDOW_SCALING_PERCENT 100
52 #define MAX_WINDOW_SCALING_PERCENT 300
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 touch control */
63 #define TOUCH_CONTROL_VIRTUAL_BUTTONS "virtual_buttons"
64 #define TOUCH_CONTROL_WIPE_GESTURES "wipe_gestures"
66 #define TOUCH_CONTROL_DEFAULT TOUCH_CONTROL_VIRTUAL_BUTTONS
68 #define TOUCH_MOVE_DISTANCE_DEFAULT 2
69 #define TOUCH_DROP_DISTANCE_DEFAULT 5
72 /* default input keys */
73 #define DEFAULT_KEY_LEFT KSYM_Left
74 #define DEFAULT_KEY_RIGHT KSYM_Right
75 #define DEFAULT_KEY_UP KSYM_Up
76 #define DEFAULT_KEY_DOWN KSYM_Down
77 #if defined(PLATFORM_MACOSX)
78 #define DEFAULT_KEY_SNAP KSYM_Control_L
79 #define DEFAULT_KEY_DROP KSYM_KP_Enter
81 #define DEFAULT_KEY_SNAP KSYM_Control_L
82 #define DEFAULT_KEY_DROP KSYM_Control_R
84 #define DEFAULT_KEY_OKAY KSYM_Return
85 #define DEFAULT_KEY_CANCEL KSYM_Escape
87 /* default shortcut keys */
88 #define DEFAULT_KEY_SAVE_GAME KSYM_F1
89 #define DEFAULT_KEY_LOAD_GAME KSYM_F2
90 #define DEFAULT_KEY_TOGGLE_PAUSE KSYM_space
91 #define DEFAULT_KEY_FOCUS_PLAYER_1 KSYM_F5
92 #define DEFAULT_KEY_FOCUS_PLAYER_2 KSYM_F6
93 #define DEFAULT_KEY_FOCUS_PLAYER_3 KSYM_F7
94 #define DEFAULT_KEY_FOCUS_PLAYER_4 KSYM_F8
95 #define DEFAULT_KEY_FOCUS_PLAYER_ALL KSYM_F9
96 #define DEFAULT_KEY_TAPE_EJECT KSYM_UNDEFINED
97 #define DEFAULT_KEY_TAPE_EXTRA KSYM_UNDEFINED
98 #define DEFAULT_KEY_TAPE_STOP KSYM_UNDEFINED
99 #define DEFAULT_KEY_TAPE_PAUSE KSYM_UNDEFINED
100 #define DEFAULT_KEY_TAPE_RECORD KSYM_UNDEFINED
101 #define DEFAULT_KEY_TAPE_PLAY KSYM_UNDEFINED
102 #define DEFAULT_KEY_SOUND_SIMPLE KSYM_UNDEFINED
103 #define DEFAULT_KEY_SOUND_LOOPS KSYM_UNDEFINED
104 #define DEFAULT_KEY_SOUND_MUSIC KSYM_UNDEFINED
105 #define DEFAULT_KEY_SNAP_LEFT KSYM_UNDEFINED
106 #define DEFAULT_KEY_SNAP_RIGHT KSYM_UNDEFINED
107 #define DEFAULT_KEY_SNAP_UP KSYM_UNDEFINED
108 #define DEFAULT_KEY_SNAP_DOWN KSYM_UNDEFINED
110 /* values for key_status */
111 #define KEY_NOT_PRESSED FALSE
112 #define KEY_RELEASED FALSE
113 #define KEY_PRESSED TRUE
115 /* values for button status */
116 #define MB_NOT_PRESSED FALSE
117 #define MB_NOT_RELEASED TRUE
118 #define MB_RELEASED FALSE
119 #define MB_PRESSED TRUE
120 #define MB_MENU_CHOICE FALSE
121 #define MB_MENU_MARK TRUE
122 #define MB_MENU_INITIALIZE (-1)
123 #define MB_MENU_LEAVE (-2)
124 #define MB_LEFTBUTTON 1
125 #define MB_MIDDLEBUTTON 2
126 #define MB_RIGHTBUTTON 3
127 #define MB_WHEEL_UP 4
128 #define MB_WHEEL_DOWN 5
129 #define MB_WHEEL_LEFT 6
130 #define MB_WHEEL_RIGHT 7
131 #define IS_WHEEL_BUTTON_VERTICAL(b) ((b) >= MB_WHEEL_UP && \
132 (b) <= MB_WHEEL_DOWN)
133 #define IS_WHEEL_BUTTON_HORIZONTAL(b) ((b) >= MB_WHEEL_LEFT && \
134 (b) <= MB_WHEEL_RIGHT)
135 #define IS_WHEEL_BUTTON(b) ((b) >= MB_WHEEL_UP && \
136 (b) <= MB_WHEEL_DOWN)
137 #define DEFAULT_WHEEL_STEPS 3
139 #define BUTTON_STEPSIZE(b) ((b) == MB_LEFTBUTTON ? 1 : \
140 (b) == MB_MIDDLEBUTTON ? 5 : \
141 (b) == MB_RIGHTBUTTON ? 10 : 1)
143 /* values for move directions */
144 #define MV_BIT_LEFT 0
145 #define MV_BIT_RIGHT 1
147 #define MV_BIT_DOWN 3
149 #define NUM_DIRECTIONS 4
151 /* diagonal movement directions are used in a different contect than buttons */
152 #define MV_BIT_UPLEFT 4
153 #define MV_BIT_UPRIGHT 5
154 #define MV_BIT_DOWNLEFT 6
155 #define MV_BIT_DOWNRIGHT 7
157 #define NUM_DIRECTIONS_FULL 8
159 /* values for special "button" bitmasks */
163 #define NUM_PLAYER_ACTIONS 6
165 /* values for special "focus player" bitmasks */
166 #define BIT_SET_FOCUS 6
168 /* values for move directions and special "button" key bitmasks */
170 #define MV_LEFT (1 << MV_BIT_LEFT)
171 #define MV_RIGHT (1 << MV_BIT_RIGHT)
172 #define MV_UP (1 << MV_BIT_UP)
173 #define MV_DOWN (1 << MV_BIT_DOWN)
175 #define MV_UPLEFT (MV_UP | MV_LEFT)
176 #define MV_UPRIGHT (MV_UP | MV_RIGHT)
177 #define MV_DOWNLEFT (MV_DOWN | MV_LEFT)
178 #define MV_DOWNRIGHT (MV_DOWN | MV_RIGHT)
180 #define MV_HORIZONTAL (MV_LEFT | MV_RIGHT)
181 #define MV_VERTICAL (MV_UP | MV_DOWN)
182 #define MV_ALL_DIRECTIONS (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
183 #define MV_ANY_DIRECTION (MV_ALL_DIRECTIONS)
184 #define MV_NO_DIRECTION (MV_NONE)
186 #define KEY_BUTTON_1 (1 << BUTTON_1)
187 #define KEY_BUTTON_2 (1 << BUTTON_2)
188 #define KEY_BUTTON_SNAP KEY_BUTTON_1
189 #define KEY_BUTTON_DROP KEY_BUTTON_2
190 #define KEY_MOTION (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
191 #define KEY_BUTTON (KEY_BUTTON_1 | KEY_BUTTON_2)
192 #define KEY_ACTION (KEY_MOTION | KEY_BUTTON)
194 #define KEY_SET_FOCUS (1 << BIT_SET_FOCUS)
196 #define MV_DIR_FROM_BIT(x) ((x) < NUM_DIRECTIONS ? 1 << (x) : \
197 (x) == MV_BIT_UPLEFT ? MV_UPLEFT : \
198 (x) == MV_BIT_UPRIGHT ? MV_UPRIGHT : \
199 (x) == MV_BIT_DOWNLEFT ? MV_DOWNLEFT : \
200 (x) == MV_BIT_DOWNRIGHT ? MV_DOWNRIGHT : \
203 #define MV_DIR_TO_BIT(x) ((x) == MV_LEFT ? MV_BIT_LEFT : \
204 (x) == MV_RIGHT ? MV_BIT_RIGHT : \
205 (x) == MV_UP ? MV_BIT_UP : \
206 (x) == MV_DOWN ? MV_BIT_DOWN : \
207 (x) == MV_UPLEFT ? MV_BIT_UPLEFT : \
208 (x) == MV_UPRIGHT ? MV_BIT_UPRIGHT : \
209 (x) == MV_DOWNLEFT ? MV_BIT_DOWNLEFT : \
210 (x) == MV_DOWNRIGHT ? MV_BIT_DOWNRIGHT : \
213 #define MV_DIR_OPPOSITE(x) ((x) == MV_LEFT ? MV_RIGHT : \
214 (x) == MV_RIGHT ? MV_LEFT : \
215 (x) == MV_UP ? MV_DOWN : \
216 (x) == MV_DOWN ? MV_UP : \
217 (x) == MV_UPLEFT ? MV_DOWNRIGHT : \
218 (x) == MV_UPRIGHT ? MV_DOWNLEFT : \
219 (x) == MV_DOWNLEFT ? MV_UPRIGHT : \
220 (x) == MV_DOWNRIGHT ? MV_UPLEFT : \
223 /* values for animation mode (frame order and direction) */
225 #define ANIM_LOOP (1 << 0)
226 #define ANIM_LINEAR (1 << 1)
227 #define ANIM_PINGPONG (1 << 2)
228 #define ANIM_PINGPONG2 (1 << 3)
229 #define ANIM_RANDOM (1 << 4)
230 #define ANIM_CE_VALUE (1 << 5)
231 #define ANIM_CE_SCORE (1 << 6)
232 #define ANIM_CE_DELAY (1 << 7)
233 #define ANIM_REVERSE (1 << 8)
234 #define ANIM_OPAQUE_PLAYER (1 << 9)
236 /* values for special (non game element) animation modes */
237 #define ANIM_HORIZONTAL (1 << 10)
238 #define ANIM_VERTICAL (1 << 11)
239 #define ANIM_CENTERED (1 << 12)
240 #define ANIM_STATIC_PANEL (1 << 13)
241 #define ANIM_ALL (1 << 14)
243 #define ANIM_DEFAULT ANIM_LOOP
245 /* values for special drawing styles (currently only for crumbled graphics) */
247 #define STYLE_ACCURATE_BORDERS (1 << 0)
248 #define STYLE_INNER_CORNERS (1 << 1)
250 #define STYLE_DEFAULT STYLE_NONE
252 /* values for fade mode */
253 #define FADE_TYPE_NONE 0
254 #define FADE_TYPE_FADE_IN (1 << 0)
255 #define FADE_TYPE_FADE_OUT (1 << 1)
256 #define FADE_TYPE_TRANSFORM (1 << 2)
257 #define FADE_TYPE_CROSSFADE (1 << 3)
258 #define FADE_TYPE_MELT (1 << 4)
259 #define FADE_TYPE_CURTAIN (1 << 5)
260 #define FADE_TYPE_SKIP (1 << 6)
262 #define FADE_MODE_NONE (FADE_TYPE_NONE)
263 #define FADE_MODE_FADE_IN (FADE_TYPE_FADE_IN)
264 #define FADE_MODE_FADE_OUT (FADE_TYPE_FADE_OUT)
265 #define FADE_MODE_FADE (FADE_TYPE_FADE_IN | FADE_TYPE_FADE_OUT)
266 #define FADE_MODE_TRANSFORM (FADE_TYPE_TRANSFORM | FADE_TYPE_FADE_IN)
267 #define FADE_MODE_CROSSFADE (FADE_MODE_TRANSFORM | FADE_TYPE_CROSSFADE)
268 #define FADE_MODE_MELT (FADE_MODE_TRANSFORM | FADE_TYPE_MELT)
269 #define FADE_MODE_CURTAIN (FADE_MODE_TRANSFORM | FADE_TYPE_CURTAIN)
270 #define FADE_MODE_SKIP_FADE_IN (FADE_TYPE_SKIP | FADE_TYPE_FADE_IN)
271 #define FADE_MODE_SKIP_FADE_OUT (FADE_TYPE_SKIP | FADE_TYPE_FADE_OUT)
273 #define FADE_MODE_DEFAULT FADE_MODE_FADE
275 /* values for toon positions */
276 #define POS_UNDEFINED -1
286 /* values for text alignment */
287 #define ALIGN_LEFT (1 << 0)
288 #define ALIGN_RIGHT (1 << 1)
289 #define ALIGN_CENTER (1 << 2)
290 #define ALIGN_DEFAULT ALIGN_LEFT
292 #define VALIGN_TOP (1 << 0)
293 #define VALIGN_BOTTOM (1 << 1)
294 #define VALIGN_MIDDLE (1 << 2)
295 #define VALIGN_DEFAULT VALIGN_TOP
297 #define ALIGNED_XPOS(x,w,a) ((a) == ALIGN_CENTER ? (x) - (w) / 2 : \
298 (a) == ALIGN_RIGHT ? (x) - (w) : (x))
299 #define ALIGNED_YPOS(y,h,v) ((v) == VALIGN_MIDDLE ? (y) - (h) / 2 : \
300 (v) == VALIGN_BOTTOM ? (y) - (h) : (y))
301 #define ALIGNED_TEXT_XPOS(p) ALIGNED_XPOS((p)->x, (p)->width, (p)->align)
302 #define ALIGNED_TEXT_YPOS(p) ALIGNED_YPOS((p)->y, (p)->height, (p)->valign)
304 /* values for redraw_mask */
305 #define REDRAW_NONE (0)
306 #define REDRAW_ALL (1 << 0)
307 #define REDRAW_FIELD (1 << 1)
308 #define REDRAW_DOOR_1 (1 << 2)
309 #define REDRAW_DOOR_2 (1 << 3)
310 #define REDRAW_DOOR_3 (1 << 4)
311 #define REDRAW_FPS (1 << 5)
313 #define REDRAW_DOORS (REDRAW_DOOR_1 | \
317 #define IN_GFX_FIELD_PLAY(x, y) (x >= gfx.sx && x < gfx.sx + gfx.sxsize && \
318 y >= gfx.sy && y < gfx.sy + gfx.sysize)
319 #define IN_GFX_FIELD_FULL(x, y) (x >= gfx.real_sx && \
320 x < gfx.real_sx + gfx.full_sxsize && \
321 y >= gfx.real_sy && \
322 y < gfx.real_sy + gfx.full_sysize)
323 #define IN_GFX_DOOR_1(x, y) (x >= gfx.dx && x < gfx.dx + gfx.dxsize && \
324 y >= gfx.dy && y < gfx.dy + gfx.dysize)
325 #define IN_GFX_DOOR_2(x, y) (x >= gfx.vx && x < gfx.vx + gfx.vxsize && \
326 y >= gfx.vy && y < gfx.vy + gfx.vysize)
327 #define IN_GFX_DOOR_3(x, y) (x >= gfx.ex && x < gfx.ex + gfx.exsize && \
328 y >= gfx.ey && y < gfx.ey + gfx.eysize)
330 /* values for mouse cursor */
331 #define CURSOR_DEFAULT 0
332 #define CURSOR_NONE 1
333 #define CURSOR_PLAYFIELD 2
335 /* fundamental game speed values */
336 #define ONE_SECOND_DELAY 1000 /* delay value for one second */
337 #define GAME_FRAME_DELAY 20 /* frame delay in milliseconds */
338 #define FFWD_FRAME_DELAY 10 /* 200% speed for fast forward */
339 #define FRAMES_PER_SECOND (ONE_SECOND_DELAY / GAME_FRAME_DELAY)
340 #define FRAMES_PER_SECOND_SP 35
342 /* maximum playfield size supported by libgame functions */
343 #define MAX_PLAYFIELD_WIDTH 128
344 #define MAX_PLAYFIELD_HEIGHT 128
346 /* maximum number of parallel players supported by libgame functions */
347 #define MAX_PLAYERS 4
349 /* maximum allowed length of player name */
350 #define MAX_PLAYER_NAME_LEN 10
352 /* maximum number of levels in a level set */
353 #define MAX_LEVELS 1000
355 /* default name for empty highscore entry */
356 #define EMPTY_PLAYER_NAME "no name"
358 /* default name for unknown player names */
359 #define ANONYMOUS_NAME "anonymous"
361 /* default for other unknown names */
362 #define UNKNOWN_NAME "unknown"
364 /* default name for new levels */
365 #define NAMELESS_LEVEL_NAME "nameless level"
367 /* default text for non-existant artwork */
368 #define NOT_AVAILABLE "(not available)"
370 /* default value for undefined filename */
371 #define UNDEFINED_FILENAME "[NONE]"
373 /* default value for undefined levelset */
374 #define UNDEFINED_LEVELSET "[NONE]"
376 /* default value for undefined parameter */
377 #define ARG_DEFAULT "[DEFAULT]"
379 /* default values for undefined configuration file parameters */
380 #define ARG_UNDEFINED "-1000000"
381 #define ARG_UNDEFINED_VALUE (-1000000)
383 /* default value for off-screen positions */
384 #define POS_OFFSCREEN (-1000000)
386 /* definitions for game sub-directories */
388 #define RO_GAME_DIR "."
392 #define RW_GAME_DIR "."
395 #define RO_BASE_PATH RO_GAME_DIR
396 #define RW_BASE_PATH RW_GAME_DIR
398 /* directory names */
399 #define GRAPHICS_DIRECTORY "graphics"
400 #define SOUNDS_DIRECTORY "sounds"
401 #define MUSIC_DIRECTORY "music"
402 #define LEVELS_DIRECTORY "levels"
403 #define TAPES_DIRECTORY "tapes"
404 #define SCORES_DIRECTORY "scores"
405 #define DOCS_DIRECTORY "docs"
406 #define CACHE_DIRECTORY "cache"
408 #define GFX_CLASSIC_SUBDIR "gfx_classic"
409 #define SND_CLASSIC_SUBDIR "snd_classic"
410 #define MUS_CLASSIC_SUBDIR "mus_classic"
412 #define GFX_DEFAULT_SUBDIR (setup.internal.default_graphics_set)
413 #define SND_DEFAULT_SUBDIR (setup.internal.default_sounds_set)
414 #define MUS_DEFAULT_SUBDIR (setup.internal.default_music_set)
416 #define GFX_FALLBACK_FILENAME (setup.internal.fallback_graphics_file)
417 #define SND_FALLBACK_FILENAME (setup.internal.fallback_sounds_file)
418 #define MUS_FALLBACK_FILENAME (setup.internal.fallback_music_file)
420 #define DEFAULT_LEVELSET (setup.internal.default_level_series)
422 /* file names and filename extensions */
423 #define LEVELSETUP_DIRECTORY "levelsetup"
424 #define SETUP_FILENAME "setup.conf"
425 #define LEVELSETUP_FILENAME "levelsetup.conf"
426 #define EDITORSETUP_FILENAME "editorsetup.conf"
427 #define EDITORCASCADE_FILENAME "editorcascade.conf"
428 #define HELPANIM_FILENAME "helpanim.conf"
429 #define HELPTEXT_FILENAME "helptext.conf"
430 #define LEVELINFO_FILENAME "levelinfo.conf"
431 #define GRAPHICSINFO_FILENAME "graphicsinfo.conf"
432 #define SOUNDSINFO_FILENAME "soundsinfo.conf"
433 #define MUSICINFO_FILENAME "musicinfo.conf"
434 #define ARTWORKINFO_CACHE_FILE "artworkinfo.cache"
435 #define LEVELFILE_EXTENSION "level"
436 #define TAPEFILE_EXTENSION "tape"
437 #define SCOREFILE_EXTENSION "score"
439 #define LOG_OUT_BASENAME "stdout.txt"
440 #define LOG_ERR_BASENAME "stderr.txt"
446 #define STRING_PARENT_DIRECTORY ".."
447 #define STRING_TOP_DIRECTORY "/"
449 #define CHAR_PATH_SEPARATOR_UNIX '/'
450 #define CHAR_PATH_SEPARATOR_DOS '\\'
452 #define STRING_PATH_SEPARATOR_UNIX "/"
453 #define STRING_PATH_SEPARATOR_DOS "\\"
455 #define STRING_NEWLINE_UNIX "\n"
456 #define STRING_NEWLINE_DOS "\r\n"
458 #if defined(PLATFORM_WIN32)
459 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_DOS
460 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_DOS
461 #define STRING_NEWLINE STRING_NEWLINE_DOS
463 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_UNIX
464 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_UNIX
465 #define STRING_NEWLINE STRING_NEWLINE_UNIX
469 /* areas in bitmap PIX_DOOR */
470 /* meaning in PIX_DB_DOOR: (3 PAGEs)
471 PAGEX1: 1. buffer for DOOR_1
472 PAGEX2: 2. buffer for DOOR_1
473 PAGEX3: buffer for animations
476 /* these values are hard-coded to be able to use them in initialization */
477 #define DOOR_GFX_PAGE_WIDTH 100 /* should be set to "gfx.dxsize" */
478 #define DOOR_GFX_PAGE_HEIGHT 280 /* should be set to "gfx.dysize" */
480 #define DOOR_GFX_PAGESIZE (DOOR_GFX_PAGE_WIDTH)
481 #define DOOR_GFX_PAGEX1 (0 * DOOR_GFX_PAGESIZE)
482 #define DOOR_GFX_PAGEX2 (1 * DOOR_GFX_PAGESIZE)
483 #define DOOR_GFX_PAGEX3 (2 * DOOR_GFX_PAGESIZE)
484 #define DOOR_GFX_PAGEX4 (3 * DOOR_GFX_PAGESIZE)
485 #define DOOR_GFX_PAGEX5 (4 * DOOR_GFX_PAGESIZE)
486 #define DOOR_GFX_PAGEX6 (5 * DOOR_GFX_PAGESIZE)
487 #define DOOR_GFX_PAGEX7 (6 * DOOR_GFX_PAGESIZE)
488 #define DOOR_GFX_PAGEX8 (7 * DOOR_GFX_PAGESIZE)
489 #define DOOR_GFX_PAGEY1 (0)
490 #define DOOR_GFX_PAGEY2 (DOOR_GFX_PAGE_HEIGHT)
493 /* macros for version handling */
494 #define VERSION_MAJOR(x) ((x) / 1000000)
495 #define VERSION_MINOR(x) (((x) % 1000000) / 10000)
496 #define VERSION_PATCH(x) (((x) % 10000) / 100)
497 #define VERSION_BUILD(x) ((x) % 100)
498 #define VERSION_IDENT(a,b,c,d) ((a) * 1000000 + (b) * 10000 + (c) * 100 + (d))
501 /* macros for parent/child process identification */
502 #if defined(PLATFORM_UNIX)
503 #define IS_PARENT_PROCESS() (audio.mixer_pid != getpid())
504 #define IS_CHILD_PROCESS() (audio.mixer_pid == getpid())
505 #define HAS_CHILD_PROCESS() (audio.mixer_pid > 0)
507 #define IS_PARENT_PROCESS() TRUE
508 #define IS_CHILD_PROCESS() FALSE
509 #define HAS_CHILD_PROCESS() FALSE
513 /* values for artwork type */
514 #define ARTWORK_TYPE_GRAPHICS 0
515 #define ARTWORK_TYPE_SOUNDS 1
516 #define ARTWORK_TYPE_MUSIC 2
518 #define NUM_ARTWORK_TYPES 3
521 /* values for tree type (chosen to match artwork type) */
522 #define TREE_TYPE_UNDEFINED -1
523 #define TREE_TYPE_GRAPHICS_DIR ARTWORK_TYPE_GRAPHICS
524 #define TREE_TYPE_SOUNDS_DIR ARTWORK_TYPE_SOUNDS
525 #define TREE_TYPE_MUSIC_DIR ARTWORK_TYPE_MUSIC
526 #define TREE_TYPE_LEVEL_DIR 3
527 #define TREE_TYPE_LEVEL_NR 4
529 #define NUM_TREE_TYPES 5
531 #define INFOTEXT_UNDEFINED ""
532 #define INFOTEXT_GRAPHICS_DIR "Custom Graphics"
533 #define INFOTEXT_SOUNDS_DIR "Custom Sounds"
534 #define INFOTEXT_MUSIC_DIR "Custom Music"
535 #define INFOTEXT_LEVEL_DIR "Level Sets"
536 #define INFOTEXT_LEVEL_NR "Levels"
538 #define TREE_INFOTEXT(t) ((t) == TREE_TYPE_LEVEL_NR ? \
539 INFOTEXT_LEVEL_NR : \
540 (t) == TREE_TYPE_LEVEL_DIR ? \
541 INFOTEXT_LEVEL_DIR : \
542 (t) == TREE_TYPE_GRAPHICS_DIR ? \
543 INFOTEXT_GRAPHICS_DIR : \
544 (t) == TREE_TYPE_SOUNDS_DIR ? \
545 INFOTEXT_SOUNDS_DIR : \
546 (t) == TREE_TYPE_MUSIC_DIR ? \
547 INFOTEXT_MUSIC_DIR : \
550 /* values for artwork handling */
551 #define LEVELDIR_ARTWORK_SET_PTR(leveldir, type) \
552 ((type) == ARTWORK_TYPE_GRAPHICS ? \
553 &(leveldir)->graphics_set : \
554 (type) == ARTWORK_TYPE_SOUNDS ? \
555 &(leveldir)->sounds_set : \
556 &(leveldir)->music_set)
558 #define LEVELDIR_ARTWORK_SET(leveldir, type) \
559 ((type) == ARTWORK_TYPE_GRAPHICS ? \
560 (leveldir)->graphics_set : \
561 (type) == ARTWORK_TYPE_SOUNDS ? \
562 (leveldir)->sounds_set : \
563 (leveldir)->music_set)
565 #define LEVELDIR_ARTWORK_PATH_PTR(leveldir, type) \
566 ((type) == ARTWORK_TYPE_GRAPHICS ? \
567 &(leveldir)->graphics_path : \
568 (type) == ARTWORK_TYPE_SOUNDS ? \
569 &(leveldir)->sounds_path : \
570 &(leveldir)->music_path)
572 #define LEVELDIR_ARTWORK_PATH(leveldir, type) \
573 ((type) == ARTWORK_TYPE_GRAPHICS ? \
574 (leveldir)->graphics_path : \
575 (type) == ARTWORK_TYPE_SOUNDS ? \
576 (leveldir)->sounds_path : \
577 (leveldir)->music_path)
579 #define SETUP_ARTWORK_SET(setup, type) \
580 ((type) == ARTWORK_TYPE_GRAPHICS ? \
581 (setup).graphics_set : \
582 (type) == ARTWORK_TYPE_SOUNDS ? \
583 (setup).sounds_set : \
586 #define SETUP_OVERRIDE_ARTWORK(setup, type) \
587 ((type) == ARTWORK_TYPE_GRAPHICS ? \
588 (setup).override_level_graphics : \
589 (type) == ARTWORK_TYPE_SOUNDS ? \
590 (setup).override_level_sounds : \
591 (setup).override_level_music)
593 #define GFX_OVERRIDE_ARTWORK(type) \
594 ((type) == ARTWORK_TYPE_GRAPHICS ? \
595 gfx.override_level_graphics : \
596 (type) == ARTWORK_TYPE_SOUNDS ? \
597 gfx.override_level_sounds : \
598 gfx.override_level_music)
600 #define ARTWORK_FIRST_NODE(artwork, type) \
601 ((type) == ARTWORK_TYPE_GRAPHICS ? \
602 (artwork).gfx_first : \
603 (type) == ARTWORK_TYPE_SOUNDS ? \
604 (artwork).snd_first : \
607 #define ARTWORK_CURRENT_IDENTIFIER_PTR(artwork, type) \
608 ((type) == ARTWORK_TYPE_GRAPHICS ? \
609 &(artwork).gfx_current_identifier : \
610 (type) == ARTWORK_TYPE_SOUNDS ? \
611 &(artwork).snd_current_identifier : \
612 &(artwork).mus_current_identifier)
614 #define ARTWORK_CURRENT_IDENTIFIER(artwork, type) \
615 ((type) == ARTWORK_TYPE_GRAPHICS ? \
616 (artwork).gfx_current_identifier : \
617 (type) == ARTWORK_TYPE_SOUNDS ? \
618 (artwork).snd_current_identifier : \
619 (artwork).mus_current_identifier)
621 #define ARTWORKINFO_FILENAME(type) \
622 ((type) == ARTWORK_TYPE_GRAPHICS ? \
623 GRAPHICSINFO_FILENAME : \
624 (type) == ARTWORK_TYPE_SOUNDS ? \
625 SOUNDSINFO_FILENAME : \
626 (type) == ARTWORK_TYPE_MUSIC ? \
627 MUSICINFO_FILENAME : "")
629 #define ARTWORK_DIRECTORY(type) \
630 ((type) == ARTWORK_TYPE_GRAPHICS ? \
631 GRAPHICS_DIRECTORY : \
632 (type) == ARTWORK_TYPE_SOUNDS ? \
634 (type) == ARTWORK_TYPE_MUSIC ? \
635 MUSIC_DIRECTORY : "")
637 #define OPTIONS_ARTWORK_DIRECTORY(type) \
638 ((type) == ARTWORK_TYPE_GRAPHICS ? \
639 options.graphics_directory : \
640 (type) == ARTWORK_TYPE_SOUNDS ? \
641 options.sounds_directory : \
642 (type) == ARTWORK_TYPE_MUSIC ? \
643 options.music_directory : "")
645 #define UPDATE_BUSY_STATE() \
647 if (gfx.draw_busy_anim_function != NULL) \
648 gfx.draw_busy_anim_function(); \
652 /* type definitions */
653 #if defined(TARGET_SDL2)
654 typedef int (*EventFilter)(void *, Event *);
656 typedef int (*EventFilter)(const Event *);
660 /* structure definitions */
664 char *command_basepath; /* path to the program binary */
665 char *command_basename; /* base filename of the program binary */
667 char *config_filename; /* optional global program config filename */
669 char *maindata_path; /* main game data (installation) directory */
671 char *userdata_subdir; /* personal user game data directory */
672 char *userdata_path; /* resulting full path to game data directory */
682 char *log_filename[NUM_LOGS]; /* log filenames for out/err messages */
683 FILE *log_file[NUM_LOGS]; /* log file handles for out/err files */
684 FILE *log_file_default[NUM_LOGS]; /* default log file handles (out/err) */
692 char *(*window_title_function)(void);
693 void (*exit_message_function)(char *, va_list);
694 void (*exit_function)(int);
703 char *ro_base_directory;
704 char *rw_base_directory;
705 char *level_directory;
706 char *graphics_directory;
707 char *sounds_directory;
708 char *music_directory;
709 char *docs_directory;
711 char *execute_command;
721 struct ScreenModeInfo
726 struct VideoSystemInfo
729 int width, height, depth;
730 int window_width, window_height;
732 boolean fullscreen_available;
733 boolean fullscreen_enabled;
734 boolean fullscreen_initial;
735 struct ScreenModeInfo *fullscreen_modes;
736 char *fullscreen_mode_current;
738 boolean window_scaling_available;
739 int window_scaling_percent;
740 char *window_scaling_quality;
745 struct AudioSystemInfo
747 boolean sound_available;
748 boolean loops_available;
749 boolean music_available;
751 boolean sound_enabled;
752 boolean sound_deactivated; /* for temporarily disabling sound */
761 int first_sound_channel;
764 struct FontBitmapInfo
768 int src_x, src_y; /* start position of animation frames */
769 int width, height; /* width/height of each animation frame */
771 int draw_xoffset; /* offset for drawing font characters */
772 int draw_yoffset; /* offset for drawing font characters */
775 int num_chars_per_line;
782 int real_sx, real_sy;
783 int full_sxsize, full_sysize;
784 int scrollbuffer_width, scrollbuffer_height;
786 int game_tile_size, standard_tile_size;
797 int win_xsize, win_ysize;
799 int draw_deactivation_mask;
800 int draw_background_mask;
802 Bitmap *field_save_buffer;
804 Bitmap *background_bitmap;
805 int background_bitmap_mask;
807 #if USE_FINAL_SCREEN_BITMAP
808 Bitmap *final_screen_bitmap;
811 boolean clipping_enabled;
813 int clip_width, clip_height;
815 boolean override_level_graphics;
816 boolean override_level_sounds;
817 boolean override_level_music;
819 boolean draw_init_text;
822 struct FontBitmapInfo *font_bitmap_info;
823 int (*select_font_function)(int);
824 int (*get_font_from_token_function)(char *);
826 int anim_random_frame;
828 void (*draw_busy_anim_function)(void);
829 void (*draw_global_anim_function)(void);
837 int fd[MAX_PLAYERS]; /* file descriptor of player's joystick */
840 struct SetupJoystickInfo
842 char *device_name; /* device name of player's joystick */
844 int xleft, xmiddle, xright;
845 int yupper, ymiddle, ylower;
849 struct SetupKeyboardInfo
851 Key left, right, up, down;
855 struct SetupTouchInfo
862 struct SetupInputInfo
864 boolean use_joystick;
865 struct SetupJoystickInfo joy;
866 struct SetupKeyboardInfo key;
869 struct SetupEditorInfo
871 boolean el_boulderdash;
872 boolean el_emerald_mine;
873 boolean el_emerald_mine_club;
877 boolean el_diamond_caves;
878 boolean el_dx_boulderdash;
880 boolean el_steel_chars;
882 boolean el_user_defined;
885 boolean el_headlines;
890 boolean show_element_token;
893 struct SetupEditorCascadeInfo
904 boolean el_steel_chars;
912 struct SetupShortcutInfo
918 Key focus_player[MAX_PLAYERS];
919 Key focus_player_all;
938 struct SetupSystemInfo
940 char *sdl_videodriver;
941 char *sdl_audiodriver;
942 int audio_fragment_size;
945 struct SetupInternalInfo
948 char *program_author;
950 char *program_website;
951 char *program_copyright;
952 char *program_company;
954 char *program_icon_file;
956 char *default_graphics_set;
957 char *default_sounds_set;
958 char *default_music_set;
960 char *fallback_graphics_file;
961 char *fallback_sounds_file;
962 char *fallback_music_file;
964 char *default_level_series;
966 boolean choose_from_top_leveldir;
976 boolean sound_simple;
978 boolean scroll_delay;
979 boolean scroll_delay_value;
980 char *engine_snapshot_mode;
981 boolean fade_screens;
983 boolean show_titlescreen;
990 char *fullscreen_mode;
991 int window_scaling_percent;
992 char *window_scaling_quality;
993 boolean ask_on_escape;
994 boolean ask_on_escape_editor;
995 boolean quick_switch;
996 boolean input_on_focus;
997 boolean prefer_aga_graphics;
998 int game_frame_delay;
999 boolean sp_show_border_elements;
1000 boolean small_game_graphics;
1001 boolean show_snapshot_buttons;
1006 int override_level_graphics; /* not boolean -- can also be "AUTO" */
1007 int override_level_sounds; /* not boolean -- can also be "AUTO" */
1008 int override_level_music; /* not boolean -- can also be "AUTO" */
1014 struct SetupEditorInfo editor;
1015 struct SetupEditorCascadeInfo editor_cascade;
1016 struct SetupShortcutInfo shortcut;
1017 struct SetupInputInfo input[MAX_PLAYERS];
1018 struct SetupTouchInfo touch;
1019 struct SetupSystemInfo system;
1020 struct SetupInternalInfo internal;
1021 struct OptionInfo options;
1026 struct TreeInfo **node_top; /* topmost node in tree */
1027 struct TreeInfo *node_parent; /* parent level directory info */
1028 struct TreeInfo *node_group; /* level group sub-directory info */
1029 struct TreeInfo *next; /* next level series structure node */
1031 int cl_first; /* internal control field for setup screen */
1032 int cl_cursor; /* internal control field for setup screen */
1034 int type; /* type of tree content */
1036 /* fields for "type == TREE_TYPE_LEVEL_DIR" */
1038 char *subdir; /* tree info sub-directory basename (may be ".") */
1039 char *fullpath; /* complete path relative to tree base directory */
1040 char *basepath; /* absolute base path of tree base directory */
1041 char *identifier; /* identifier string for configuration files */
1042 char *name; /* tree info name, as displayed in selection menues */
1043 char *name_sorting; /* optional sorting name for correct name sorting */
1044 char *author; /* level or artwork author name */
1045 char *year; /* optional year of creation for levels or artwork */
1046 char *imported_from; /* optional comment for imported levels or artwork */
1047 char *imported_by; /* optional comment for imported levels or artwork */
1048 char *tested_by; /* optional comment to name people who tested a set */
1050 char *graphics_set_ecs; /* special EMC custom graphics set (ECS graphics) */
1051 char *graphics_set_aga; /* special EMC custom graphics set (AGA graphics) */
1052 char *graphics_set; /* optional custom graphics set (level tree only) */
1053 char *sounds_set; /* optional custom sounds set (level tree only) */
1054 char *music_set; /* optional custom music set (level tree only) */
1055 char *graphics_path; /* path to optional custom graphics set (level only) */
1056 char *sounds_path; /* path to optional custom sounds set (level only) */
1057 char *music_path; /* path to optional custom music set (level only) */
1059 char *level_filename; /* filename of level file (for packed level file) */
1060 char *level_filetype; /* type of levels in level directory or level file */
1062 char *special_flags; /* flags for special actions performed on level file */
1064 int levels; /* number of levels in level series */
1065 int first_level; /* first level number (to allow start with 0 or 1) */
1066 int last_level; /* last level number (automatically calculated) */
1067 int sort_priority; /* sort levels by 'sort_priority' and then by name */
1069 boolean latest_engine;/* force level set to use the latest game engine */
1071 boolean level_group; /* directory contains more level series directories */
1072 boolean parent_link; /* entry links back to parent directory */
1073 boolean in_user_dir; /* user defined levels are stored in home directory */
1074 boolean user_defined; /* levels in user directory and marked as "private" */
1075 boolean readonly; /* readonly levels can not be changed with editor */
1076 boolean handicap; /* level set has no handicap when set to "false" */
1077 boolean skip_levels; /* levels can be skipped when set to "true" */
1079 int color; /* color to use on selection screen for this level */
1080 char *class_desc; /* description of level series class */
1081 int handicap_level; /* number of the lowest unsolved level */
1083 char *infotext; /* optional text to describe the tree type (headline) */
1086 typedef struct TreeInfo TreeInfo;
1087 typedef struct TreeInfo LevelDirTree;
1088 typedef struct TreeInfo ArtworkDirTree;
1089 typedef struct TreeInfo GraphicsDirTree;
1090 typedef struct TreeInfo SoundsDirTree;
1091 typedef struct TreeInfo MusicDirTree;
1095 GraphicsDirTree *gfx_first;
1096 GraphicsDirTree *gfx_current;
1097 SoundsDirTree *snd_first;
1098 SoundsDirTree *snd_current;
1099 MusicDirTree *mus_first;
1100 MusicDirTree *mus_current;
1102 char *gfx_current_identifier;
1103 char *snd_current_identifier;
1104 char *mus_current_identifier;
1107 struct ValueTextInfo
1119 struct ConfigTypeInfo
1126 struct TokenIntPtrInfo
1136 char *default_filename;
1139 char **default_parameter; /* array of file parameters */
1140 char **parameter; /* array of file parameters */
1143 boolean fallback_to_default;
1144 boolean default_is_cloned;
1147 struct SetupFileList
1152 struct SetupFileList *next;
1157 char *source_filename; /* primary key for node list */
1161 struct PropertyMapping
1171 struct ArtworkListInfo
1173 int type; /* type of artwork */
1175 int num_file_list_entries;
1176 int num_dynamic_file_list_entries;
1177 struct FileInfo *file_list; /* static artwork file array */
1178 struct FileInfo *dynamic_file_list; /* dynamic artwrk file array */
1180 int num_suffix_list_entries;
1181 struct ConfigTypeInfo *suffix_list; /* parameter suffixes array */
1183 int num_base_prefixes;
1184 int num_ext1_suffixes;
1185 int num_ext2_suffixes;
1186 int num_ext3_suffixes;
1187 char **base_prefixes; /* base token prefixes array */
1188 char **ext1_suffixes; /* property suffixes array 1 */
1189 char **ext2_suffixes; /* property suffixes array 2 */
1190 char **ext3_suffixes; /* property suffixes array 3 */
1192 int num_ignore_tokens;
1193 char **ignore_tokens; /* file tokens to be ignored */
1195 int num_property_mapping_entries;
1196 struct PropertyMapping *property_mapping; /* mapping token -> artwork */
1198 int sizeof_artwork_list_entry;
1200 struct ListNodeInfo **artwork_list; /* static artwork node array */
1201 struct ListNodeInfo **dynamic_artwork_list; /* dynamic artwrk node array */
1202 struct ListNode *content_list; /* dynamic artwork node list */
1204 void *(*load_artwork)(char *); /* constructor function */
1205 void (*free_artwork)(void *); /* destructor function */
1219 struct RectWithBorder
1233 struct DoorPartPosInfo
1240 int start_step_opening;
1241 int start_step_closing;
1242 boolean draw_masked;
1249 int xoffset; /* special case for tape date and time */
1250 int xoffset2; /* special case for tape date */
1253 int size; /* also used for suffix ".digits" */
1255 boolean draw_masked;
1256 boolean draw_player; /* special case for network player buttons */
1257 int sort_priority; /* also used for suffix ".draw_order" */
1268 /* ========================================================================= */
1269 /* exported variables */
1270 /* ========================================================================= */
1272 extern struct ProgramInfo program;
1273 extern struct OptionInfo options;
1274 extern struct VideoSystemInfo video;
1275 extern struct AudioSystemInfo audio;
1276 extern struct GfxInfo gfx;
1277 extern struct AnimInfo anim;
1278 extern struct ArtworkInfo artwork;
1279 extern struct JoystickInfo joystick;
1280 extern struct SetupInfo setup;
1282 extern LevelDirTree *leveldir_first_all;
1283 extern LevelDirTree *leveldir_first;
1284 extern LevelDirTree *leveldir_current;
1285 extern int level_nr;
1287 extern struct LevelStats level_stats[];
1289 extern DrawWindow *window;
1290 extern DrawBuffer *backbuffer;
1291 extern DrawBuffer *drawto;
1293 extern int button_status;
1294 extern boolean motion_status;
1295 #if defined(TARGET_SDL2)
1296 extern boolean keyrepeat_status;
1299 extern int redraw_mask;
1301 extern int FrameCounter;
1304 /* function definitions */
1306 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
1309 void SetWindowTitle();
1311 void InitWindowTitleFunction(char *(*window_title_function)(void));
1312 void InitExitMessageFunction(void (*exit_message_function)(char *, va_list));
1313 void InitExitFunction(void (*exit_function)(int));
1314 void InitPlatformDependentStuff(void);
1315 void ClosePlatformDependentStuff(void);
1317 void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
1318 void InitGfxTileSizeInfo(int, int);
1319 void InitGfxDoor1Info(int, int, int, int);
1320 void InitGfxDoor2Info(int, int, int, int);
1321 void InitGfxDoor3Info(int, int, int, int);
1322 void InitGfxWindowInfo(int, int);
1323 void InitGfxScrollbufferInfo(int, int);
1324 void InitGfxClipRegion(boolean, int, int, int, int);
1325 void InitGfxDrawBusyAnimFunction(void (*draw_busy_anim_function)(void));
1326 void InitGfxDrawGlobalAnimFunction(void (*draw_global_anim_function)(void));
1327 void InitGfxCustomArtworkInfo();
1328 void InitGfxOtherSettings();
1329 void SetDrawDeactivationMask(int);
1330 void SetDrawBackgroundMask(int);
1331 void SetWindowBackgroundBitmap(Bitmap *);
1332 void SetMainBackgroundBitmap(Bitmap *);
1333 void SetDoorBackgroundBitmap(Bitmap *);
1334 void SetRedrawMaskFromArea(int, int, int, int);
1336 void LimitScreenUpdates(boolean);
1338 void InitVideoDisplay(void);
1339 void CloseVideoDisplay(void);
1340 void InitVideoBuffer(int, int, int, boolean);
1341 Bitmap *CreateBitmapStruct(void);
1342 Bitmap *CreateBitmap(int, int, int);
1343 void ReCreateBitmap(Bitmap **, int, int, int);
1344 void FreeBitmap(Bitmap *);
1345 void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
1346 void BlitBitmapTiled(Bitmap *, Bitmap *, int, int, int, int, int, int, int,int);
1347 void FadeRectangle(Bitmap *bitmap, int, int, int, int, int, int, int,
1348 void (*draw_border_function)(void));
1349 void FillRectangle(Bitmap *, int, int, int, int, Pixel);
1350 void ClearRectangle(Bitmap *, int, int, int, int);
1351 void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
1352 void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
1353 boolean DrawingOnBackground(int, int);
1354 boolean DrawingAreaChanged();
1355 void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int, int);
1356 void BlitTexture(Bitmap *, int, int, int, int, int, int);
1357 void BlitTextureMasked(Bitmap *, int, int, int, int, int, int);
1358 void BlitToScreen(Bitmap *, int, int, int, int, int, int);
1359 void BlitToScreenMasked(Bitmap *, int, int, int, int, int, int);
1360 void DrawSimpleBlackLine(Bitmap *, int, int, int, int);
1361 void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
1362 void DrawLines(Bitmap *, struct XY *, int, Pixel);
1363 Pixel GetPixel(Bitmap *, int, int);
1364 Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
1365 Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
1367 void KeyboardAutoRepeatOn(void);
1368 void KeyboardAutoRepeatOff(void);
1369 boolean SetVideoMode(boolean);
1370 boolean ChangeVideoModeIfNeeded(boolean);
1372 Bitmap *LoadImage(char *);
1373 Bitmap *LoadCustomImage(char *);
1374 void ReloadCustomImage(Bitmap *, char *);
1376 Bitmap *ZoomBitmap(Bitmap *, int, int);
1377 void ReCreateGameTileSizeBitmap(Bitmap **);
1378 void CreateBitmapWithSmallBitmaps(Bitmap **, int, int);
1379 void CreateBitmapTextures(Bitmap **);
1380 void FreeBitmapTextures(Bitmap **);
1381 void ScaleBitmap(Bitmap **, int);
1383 void SetMouseCursor(int);
1385 void OpenAudio(void);
1386 void CloseAudio(void);
1387 void SetAudioMode(boolean);
1389 void InitEventFilter(EventFilter);
1390 boolean PendingEvent(void);
1391 void NextEvent(Event *event);
1392 void PeekEvent(Event *event);
1393 Key GetEventKey(KeyEvent *, boolean);
1394 KeyMod HandleKeyModState(Key, int);
1395 KeyMod GetKeyModState();
1396 KeyMod GetKeyModStateFromEvents();
1397 boolean CheckCloseWindowEvent(ClientMessageEvent *);
1399 void InitJoysticks();
1400 boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
1402 #endif /* SYSTEM_H */