1 /***********************************************************
2 * Artsoft Retro-Game Library *
3 *----------------------------------------------------------*
4 * (c) 1994-2006 Artsoft Entertainment *
6 * Detmolder Strasse 189 *
9 * e-mail: info@artsoft.org *
10 *----------------------------------------------------------*
12 ***********************************************************/
21 #if defined(PLATFORM_MACOSX)
23 #elif defined(PLATFORM_WIN32)
25 #elif defined(PLATFORM_MSDOS)
27 #elif defined(PLATFORM_ANDROID)
31 #if defined(TARGET_SDL)
33 #elif defined(TARGET_X11)
38 /* the additional 'b' is needed for Win32 to open files in binary mode */
39 #define MODE_READ "rb"
40 #define MODE_WRITE "wb"
41 #define MODE_APPEND "ab"
43 #define DEFAULT_DEPTH 0
47 #define BLIT_INVERSE 2
48 #define BLIT_ON_BACKGROUND 3
50 /* values for fullscreen status */
51 #define FULLSCREEN_NOT_AVAILABLE FALSE
52 #define FULLSCREEN_AVAILABLE TRUE
54 /* values for window scaling */
55 #define WINDOW_SCALING_NOT_AVAILABLE FALSE
56 #define WINDOW_SCALING_AVAILABLE TRUE
58 #define MIN_WINDOW_SCALING_PERCENT 50
59 #define STD_WINDOW_SCALING_PERCENT 100
60 #define MAX_WINDOW_SCALING_PERCENT 300
61 #define STEP_WINDOW_SCALING_PERCENT 10
63 /* values for window scaling quality */
64 #define SCALING_QUALITY_NEAREST "nearest"
65 #define SCALING_QUALITY_LINEAR "linear"
66 #define SCALING_QUALITY_BEST "best"
68 #define SCALING_QUALITY_DEFAULT SCALING_QUALITY_LINEAR
70 /* default input keys */
71 #define DEFAULT_KEY_LEFT KSYM_Left
72 #define DEFAULT_KEY_RIGHT KSYM_Right
73 #define DEFAULT_KEY_UP KSYM_Up
74 #define DEFAULT_KEY_DOWN KSYM_Down
75 #if defined(PLATFORM_MACOSX)
76 #define DEFAULT_KEY_SNAP KSYM_Control_L
77 #define DEFAULT_KEY_DROP KSYM_KP_Enter
79 #define DEFAULT_KEY_SNAP KSYM_Control_L
80 #define DEFAULT_KEY_DROP KSYM_Control_R
82 #define DEFAULT_KEY_OKAY KSYM_Return
83 #define DEFAULT_KEY_CANCEL KSYM_Escape
85 /* default shortcut keys */
86 #define DEFAULT_KEY_SAVE_GAME KSYM_F1
87 #define DEFAULT_KEY_LOAD_GAME KSYM_F2
88 #define DEFAULT_KEY_TOGGLE_PAUSE KSYM_space
89 #define DEFAULT_KEY_FOCUS_PLAYER_1 KSYM_F5
90 #define DEFAULT_KEY_FOCUS_PLAYER_2 KSYM_F6
91 #define DEFAULT_KEY_FOCUS_PLAYER_3 KSYM_F7
92 #define DEFAULT_KEY_FOCUS_PLAYER_4 KSYM_F8
93 #define DEFAULT_KEY_FOCUS_PLAYER_ALL KSYM_F9
94 #define DEFAULT_KEY_TAPE_EJECT KSYM_UNDEFINED
95 #define DEFAULT_KEY_TAPE_EXTRA KSYM_UNDEFINED
96 #define DEFAULT_KEY_TAPE_STOP KSYM_UNDEFINED
97 #define DEFAULT_KEY_TAPE_PAUSE KSYM_UNDEFINED
98 #define DEFAULT_KEY_TAPE_RECORD KSYM_UNDEFINED
99 #define DEFAULT_KEY_TAPE_PLAY KSYM_UNDEFINED
100 #define DEFAULT_KEY_SOUND_SIMPLE KSYM_UNDEFINED
101 #define DEFAULT_KEY_SOUND_LOOPS KSYM_UNDEFINED
102 #define DEFAULT_KEY_SOUND_MUSIC KSYM_UNDEFINED
103 #define DEFAULT_KEY_SNAP_LEFT KSYM_UNDEFINED
104 #define DEFAULT_KEY_SNAP_RIGHT KSYM_UNDEFINED
105 #define DEFAULT_KEY_SNAP_UP KSYM_UNDEFINED
106 #define DEFAULT_KEY_SNAP_DOWN KSYM_UNDEFINED
108 /* values for key_status */
109 #define KEY_NOT_PRESSED FALSE
110 #define KEY_RELEASED FALSE
111 #define KEY_PRESSED TRUE
113 /* values for button status */
114 #define MB_NOT_PRESSED FALSE
115 #define MB_NOT_RELEASED TRUE
116 #define MB_RELEASED FALSE
117 #define MB_PRESSED TRUE
118 #define MB_MENU_CHOICE FALSE
119 #define MB_MENU_MARK TRUE
120 #define MB_MENU_INITIALIZE (-1)
121 #define MB_MENU_LEAVE (-2)
122 #define MB_LEFTBUTTON 1
123 #define MB_MIDDLEBUTTON 2
124 #define MB_RIGHTBUTTON 3
125 #define MB_WHEEL_UP 4
126 #define MB_WHEEL_DOWN 5
127 #define MB_WHEEL_LEFT 6
128 #define MB_WHEEL_RIGHT 7
129 #define IS_WHEEL_BUTTON_VERTICAL(b) ((b) >= MB_WHEEL_UP && \
130 (b) <= MB_WHEEL_DOWN)
131 #define IS_WHEEL_BUTTON_HORIZONTAL(b) ((b) >= MB_WHEEL_LEFT && \
132 (b) <= MB_WHEEL_RIGHT)
133 #define IS_WHEEL_BUTTON(b) ((b) >= MB_WHEEL_UP && \
134 (b) <= MB_WHEEL_DOWN)
135 #define DEFAULT_WHEEL_STEPS 3
137 /* values for move directions */
138 #define MV_BIT_LEFT 0
139 #define MV_BIT_RIGHT 1
141 #define MV_BIT_DOWN 3
143 #define NUM_DIRECTIONS 4
145 /* diagonal movement directions are used in a different contect than buttons */
146 #define MV_BIT_UPLEFT 4
147 #define MV_BIT_UPRIGHT 5
148 #define MV_BIT_DOWNLEFT 6
149 #define MV_BIT_DOWNRIGHT 7
151 #define NUM_DIRECTIONS_FULL 8
153 /* values for special "button" bitmasks */
157 #define NUM_PLAYER_ACTIONS 6
159 /* values for special "focus player" bitmasks */
160 #define BIT_SET_FOCUS 6
162 /* values for move directions and special "button" key bitmasks */
164 #define MV_LEFT (1 << MV_BIT_LEFT)
165 #define MV_RIGHT (1 << MV_BIT_RIGHT)
166 #define MV_UP (1 << MV_BIT_UP)
167 #define MV_DOWN (1 << MV_BIT_DOWN)
169 #define MV_UPLEFT (MV_UP | MV_LEFT)
170 #define MV_UPRIGHT (MV_UP | MV_RIGHT)
171 #define MV_DOWNLEFT (MV_DOWN | MV_LEFT)
172 #define MV_DOWNRIGHT (MV_DOWN | MV_RIGHT)
174 #define MV_HORIZONTAL (MV_LEFT | MV_RIGHT)
175 #define MV_VERTICAL (MV_UP | MV_DOWN)
176 #define MV_ALL_DIRECTIONS (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
177 #define MV_ANY_DIRECTION (MV_ALL_DIRECTIONS)
178 #define MV_NO_DIRECTION (MV_NONE)
180 #define KEY_BUTTON_1 (1 << BUTTON_1)
181 #define KEY_BUTTON_2 (1 << BUTTON_2)
182 #define KEY_BUTTON_SNAP KEY_BUTTON_1
183 #define KEY_BUTTON_DROP KEY_BUTTON_2
184 #define KEY_MOTION (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
185 #define KEY_BUTTON (KEY_BUTTON_1 | KEY_BUTTON_2)
186 #define KEY_ACTION (KEY_MOTION | KEY_BUTTON)
188 #define KEY_SET_FOCUS (1 << BIT_SET_FOCUS)
190 #define MV_DIR_FROM_BIT(x) ((x) < NUM_DIRECTIONS ? 1 << (x) : \
191 (x) == MV_BIT_UPLEFT ? MV_UPLEFT : \
192 (x) == MV_BIT_UPRIGHT ? MV_UPRIGHT : \
193 (x) == MV_BIT_DOWNLEFT ? MV_DOWNLEFT : \
194 (x) == MV_BIT_DOWNRIGHT ? MV_DOWNRIGHT : \
197 #define MV_DIR_TO_BIT(x) ((x) == MV_LEFT ? MV_BIT_LEFT : \
198 (x) == MV_RIGHT ? MV_BIT_RIGHT : \
199 (x) == MV_UP ? MV_BIT_UP : \
200 (x) == MV_DOWN ? MV_BIT_DOWN : \
201 (x) == MV_UPLEFT ? MV_BIT_UPLEFT : \
202 (x) == MV_UPRIGHT ? MV_BIT_UPRIGHT : \
203 (x) == MV_DOWNLEFT ? MV_BIT_DOWNLEFT : \
204 (x) == MV_DOWNRIGHT ? MV_BIT_DOWNRIGHT : \
207 #define MV_DIR_OPPOSITE(x) ((x) == MV_LEFT ? MV_RIGHT : \
208 (x) == MV_RIGHT ? MV_LEFT : \
209 (x) == MV_UP ? MV_DOWN : \
210 (x) == MV_DOWN ? MV_UP : \
211 (x) == MV_UPLEFT ? MV_DOWNRIGHT : \
212 (x) == MV_UPRIGHT ? MV_DOWNLEFT : \
213 (x) == MV_DOWNLEFT ? MV_UPRIGHT : \
214 (x) == MV_DOWNRIGHT ? MV_UPLEFT : \
217 /* values for animation mode (frame order and direction) */
219 #define ANIM_LOOP (1 << 0)
220 #define ANIM_LINEAR (1 << 1)
221 #define ANIM_PINGPONG (1 << 2)
222 #define ANIM_PINGPONG2 (1 << 3)
223 #define ANIM_RANDOM (1 << 4)
224 #define ANIM_CE_VALUE (1 << 5)
225 #define ANIM_CE_SCORE (1 << 6)
226 #define ANIM_CE_DELAY (1 << 7)
227 #define ANIM_REVERSE (1 << 8)
228 #define ANIM_OPAQUE_PLAYER (1 << 9)
230 /* values for special (non game element) animation modes */
231 #define ANIM_HORIZONTAL (1 << 10)
232 #define ANIM_VERTICAL (1 << 11)
233 #define ANIM_CENTERED (1 << 12)
234 #define ANIM_STATIC_PANEL (1 << 13)
236 #define ANIM_DEFAULT ANIM_LOOP
238 /* values for special drawing styles (currently only for crumbled graphics) */
240 #define STYLE_ACCURATE_BORDERS (1 << 0)
241 #define STYLE_INNER_CORNERS (1 << 1)
243 #define STYLE_DEFAULT STYLE_NONE
245 /* values for fade mode */
246 #define FADE_TYPE_NONE 0
247 #define FADE_TYPE_FADE_IN (1 << 0)
248 #define FADE_TYPE_FADE_OUT (1 << 1)
249 #define FADE_TYPE_TRANSFORM (1 << 2)
250 #define FADE_TYPE_CROSSFADE (1 << 3)
251 #define FADE_TYPE_MELT (1 << 4)
252 #define FADE_TYPE_SKIP (1 << 5)
254 #define FADE_MODE_NONE (FADE_TYPE_NONE)
255 #define FADE_MODE_FADE_IN (FADE_TYPE_FADE_IN)
256 #define FADE_MODE_FADE_OUT (FADE_TYPE_FADE_OUT)
257 #define FADE_MODE_FADE (FADE_TYPE_FADE_IN | FADE_TYPE_FADE_OUT)
258 #define FADE_MODE_TRANSFORM (FADE_TYPE_TRANSFORM | FADE_TYPE_FADE_IN)
259 #define FADE_MODE_CROSSFADE (FADE_MODE_TRANSFORM | FADE_TYPE_CROSSFADE)
260 #define FADE_MODE_MELT (FADE_MODE_TRANSFORM | FADE_TYPE_MELT)
261 #define FADE_MODE_SKIP_FADE_IN (FADE_TYPE_SKIP | FADE_TYPE_FADE_IN)
262 #define FADE_MODE_SKIP_FADE_OUT (FADE_TYPE_SKIP | FADE_TYPE_FADE_OUT)
264 #define FADE_MODE_DEFAULT FADE_MODE_FADE
266 /* values for text alignment */
267 #define ALIGN_LEFT (1 << 0)
268 #define ALIGN_RIGHT (1 << 1)
269 #define ALIGN_CENTER (1 << 2)
270 #define ALIGN_DEFAULT ALIGN_LEFT
272 #define VALIGN_TOP (1 << 0)
273 #define VALIGN_BOTTOM (1 << 1)
274 #define VALIGN_MIDDLE (1 << 2)
275 #define VALIGN_DEFAULT VALIGN_TOP
277 #define ALIGNED_XPOS(x,w,a) ((a) == ALIGN_CENTER ? (x) - (w) / 2 : \
278 (a) == ALIGN_RIGHT ? (x) - (w) : (x))
279 #define ALIGNED_YPOS(y,h,v) ((v) == VALIGN_MIDDLE ? (y) - (h) / 2 : \
280 (v) == VALIGN_BOTTOM ? (y) - (h) : (y))
281 #define ALIGNED_TEXT_XPOS(p) ALIGNED_XPOS((p)->x, (p)->width, (p)->align)
282 #define ALIGNED_TEXT_YPOS(p) ALIGNED_YPOS((p)->y, (p)->height, (p)->valign)
284 /* values for redraw_mask */
285 #define REDRAW_NONE (0)
286 #define REDRAW_ALL (1 << 0)
287 #define REDRAW_FIELD (1 << 1)
288 #define REDRAW_TILES (1 << 2)
289 #define REDRAW_DOOR_1 (1 << 3)
290 #define REDRAW_VIDEO_1 (1 << 4)
291 #define REDRAW_VIDEO_2 (1 << 5)
292 #define REDRAW_VIDEO_3 (1 << 6)
293 #define REDRAW_MICROLEVEL (1 << 7)
294 #define REDRAW_MICROLABEL (1 << 8)
295 #define REDRAW_FROM_BACKBUFFER (1 << 9)
296 #define REDRAW_DOOR_2 (REDRAW_VIDEO_1 | \
299 #define REDRAW_DOOR_3 (1 << 10)
300 #define REDRAW_DOORS (REDRAW_DOOR_1 | \
303 #define REDRAW_MAIN (REDRAW_FIELD | \
306 #define REDRAW_FPS (1 << 11)
308 #if defined(TARGET_X11)
309 /* on old-style, classic and potentially slow graphics systems, redraw single
310 tiles instead of the whole playfield unless a certain threshold is reached;
311 when using the X11 target, this method should still be fast on all systems */
312 #define REDRAWTILES_THRESHOLD (SCR_FIELDX * SCR_FIELDY / 2)
314 /* on modern graphics systems and when using the SDL target, this tile redraw
315 optimization can slow things down a lot due to many small blits compared to
316 one single playfield-sized blit (especially observed on Mac OS X with SDL) */
317 #define REDRAWTILES_THRESHOLD 0
320 #define IN_GFX_SCREEN(x, y) (x >= gfx.sx && x < gfx.sx + gfx.sxsize && \
321 y >= gfx.sy && y < gfx.sy + gfx.sysize)
322 #define IN_GFX_DOOR(x, y) (x >= gfx.dx && x < gfx.dx + gfx.dxsize && \
323 y >= gfx.dy && y < gfx.dy + gfx.dysize)
324 #define IN_GFX_VIDEO(x, y) (x >= gfx.vx && x < gfx.vx + gfx.vxsize && \
325 y >= gfx.vy && y < gfx.vy + gfx.vysize)
327 /* values for mouse cursor */
328 #define CURSOR_DEFAULT 0
329 #define CURSOR_NONE 1
330 #define CURSOR_PLAYFIELD 2
332 /* fundamental game speed values */
333 #define ONE_SECOND_DELAY 1000 /* delay value for one second */
334 #define GAME_FRAME_DELAY 20 /* frame delay in milliseconds */
335 #define FFWD_FRAME_DELAY 10 /* 200% speed for fast forward */
336 #define FRAMES_PER_SECOND (ONE_SECOND_DELAY / GAME_FRAME_DELAY)
337 #define FRAMES_PER_SECOND_SP 35
339 /* maximum playfield size supported by libgame functions */
340 #define MAX_PLAYFIELD_WIDTH 128
341 #define MAX_PLAYFIELD_HEIGHT 128
343 /* maximum number of parallel players supported by libgame functions */
344 #define MAX_PLAYERS 4
346 /* maximum allowed length of player name */
347 #define MAX_PLAYER_NAME_LEN 10
349 /* maximum number of levels in a level set */
350 #define MAX_LEVELS 1000
352 /* default name for empty highscore entry */
353 #define EMPTY_PLAYER_NAME "no name"
355 /* default name for unknown player names */
356 #define ANONYMOUS_NAME "anonymous"
358 /* default for other unknown names */
359 #define UNKNOWN_NAME "unknown"
361 /* default name for new levels */
362 #define NAMELESS_LEVEL_NAME "nameless level"
364 /* default text for non-existant artwork */
365 #define NOT_AVAILABLE "(not available)"
367 /* default value for undefined filename */
368 #define UNDEFINED_FILENAME "[NONE]"
370 /* default value for undefined parameter */
371 #define ARG_DEFAULT "[DEFAULT]"
373 /* default values for undefined configuration file parameters */
374 #define ARG_UNDEFINED "-1000000"
375 #define ARG_UNDEFINED_VALUE (atoi(ARG_UNDEFINED))
377 /* definitions for game sub-directories */
379 #define RO_GAME_DIR "."
383 #define RW_GAME_DIR "."
386 #define RO_BASE_PATH RO_GAME_DIR
387 #define RW_BASE_PATH RW_GAME_DIR
389 /* directory names */
390 #define GRAPHICS_DIRECTORY "graphics"
391 #define SOUNDS_DIRECTORY "sounds"
392 #define MUSIC_DIRECTORY "music"
393 #define LEVELS_DIRECTORY "levels"
394 #define TAPES_DIRECTORY "tapes"
395 #define SCORES_DIRECTORY "scores"
396 #define DOCS_DIRECTORY "docs"
397 #define CACHE_DIRECTORY "cache"
399 #if !defined(PLATFORM_MSDOS)
400 #define GFX_CLASSIC_SUBDIR "gfx_classic"
401 #define SND_CLASSIC_SUBDIR "snd_classic"
402 #define MUS_CLASSIC_SUBDIR "mus_classic"
404 #define GFX_CLASSIC_SUBDIR "gfx_orig"
405 #define SND_CLASSIC_SUBDIR "snd_orig"
406 #define MUS_CLASSIC_SUBDIR "mus_orig"
409 #if defined(CREATE_SPECIAL_EDITION_RND_JUE)
410 #define GFX_DEFAULT_SUBDIR "jue0"
411 #define SND_DEFAULT_SUBDIR "jue0"
412 #define MUS_DEFAULT_SUBDIR "jue0"
414 #define GFX_DEFAULT_SUBDIR GFX_CLASSIC_SUBDIR
415 #define SND_DEFAULT_SUBDIR SND_CLASSIC_SUBDIR
416 #define MUS_DEFAULT_SUBDIR MUS_CLASSIC_SUBDIR
419 #if defined(CREATE_SPECIAL_EDITION)
420 #define GFX_FALLBACK_FILENAME "fallback.pcx"
421 #define SND_FALLBACK_FILENAME "fallback.wav"
422 #define MUS_FALLBACK_FILENAME "fallback.wav"
425 /* file names and filename extensions */
426 #if !defined(PLATFORM_MSDOS)
427 #define LEVELSETUP_DIRECTORY "levelsetup"
428 #define SETUP_FILENAME "setup.conf"
429 #define LEVELSETUP_FILENAME "levelsetup.conf"
430 #define EDITORSETUP_FILENAME "editorsetup.conf"
431 #define EDITORCASCADE_FILENAME "editorcascade.conf"
432 #define HELPANIM_FILENAME "helpanim.conf"
433 #define HELPTEXT_FILENAME "helptext.conf"
434 #define LEVELINFO_FILENAME "levelinfo.conf"
435 #define GRAPHICSINFO_FILENAME "graphicsinfo.conf"
436 #define SOUNDSINFO_FILENAME "soundsinfo.conf"
437 #define MUSICINFO_FILENAME "musicinfo.conf"
438 #define ARTWORKINFO_CACHE_FILE "artworkinfo.cache"
439 #define LEVELFILE_EXTENSION "level"
440 #define TAPEFILE_EXTENSION "tape"
441 #define SCOREFILE_EXTENSION "score"
443 #define LEVELSETUP_DIRECTORY "lvlsetup"
444 #define SETUP_FILENAME "setup.cnf"
445 #define LEVELSETUP_FILENAME "lvlsetup.cnf"
446 #define EDITORSETUP_FILENAME "edsetup.cnf"
447 #define EDITORCASCADE_FILENAME "edcascad.conf"
448 #define HELPANIM_FILENAME "helpanim.cnf"
449 #define HELPTEXT_FILENAME "helptext.cnf"
450 #define LEVELINFO_FILENAME "lvlinfo.cnf"
451 #define GRAPHICSINFO_FILENAME "gfxinfo.cnf"
452 #define SOUNDSINFO_FILENAME "sndinfo.cnf"
453 #define MUSICINFO_FILENAME "musinfo.cnf"
454 #define ARTWORKINFO_CACHE_FILE "artinfo.cac"
455 #define LEVELFILE_EXTENSION "lvl"
456 #define TAPEFILE_EXTENSION "tap"
457 #define SCOREFILE_EXTENSION "sco"
460 #define ERROR_BASENAME "stderr.txt"
462 #define CHAR_PATH_SEPARATOR_UNIX '/'
463 #define CHAR_PATH_SEPARATOR_DOS '\\'
465 #define STRING_PATH_SEPARATOR_UNIX "/"
466 #define STRING_PATH_SEPARATOR_DOS "\\"
468 #define STRING_NEWLINE_UNIX "\n"
469 #define STRING_NEWLINE_DOS "\r\n"
471 #if defined(PLATFORM_WIN32) || defined(PLATFORM_MSDOS)
472 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_DOS
473 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_DOS
474 #define STRING_NEWLINE STRING_NEWLINE_DOS
476 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_UNIX
477 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_UNIX
478 #define STRING_NEWLINE STRING_NEWLINE_UNIX
482 /* areas in bitmap PIX_DOOR */
483 /* meaning in PIX_DB_DOOR: (3 PAGEs)
484 PAGEX1: 1. buffer for DOOR_1
485 PAGEX2: 2. buffer for DOOR_1
486 PAGEX3: buffer for animations
489 /* these values are hard-coded to be able to use them in initialization */
490 #define DOOR_GFX_PAGE_WIDTH 100 /* should be set to "gfx.dxsize" */
491 #define DOOR_GFX_PAGE_HEIGHT 280 /* should be set to "gfx.dysize" */
493 #define DOOR_GFX_PAGESIZE (DOOR_GFX_PAGE_WIDTH)
494 #define DOOR_GFX_PAGEX1 (0 * DOOR_GFX_PAGESIZE)
495 #define DOOR_GFX_PAGEX2 (1 * DOOR_GFX_PAGESIZE)
496 #define DOOR_GFX_PAGEX3 (2 * DOOR_GFX_PAGESIZE)
497 #define DOOR_GFX_PAGEX4 (3 * DOOR_GFX_PAGESIZE)
498 #define DOOR_GFX_PAGEX5 (4 * DOOR_GFX_PAGESIZE)
499 #define DOOR_GFX_PAGEX6 (5 * DOOR_GFX_PAGESIZE)
500 #define DOOR_GFX_PAGEX7 (6 * DOOR_GFX_PAGESIZE)
501 #define DOOR_GFX_PAGEX8 (7 * DOOR_GFX_PAGESIZE)
502 #define DOOR_GFX_PAGEY1 (0)
503 #define DOOR_GFX_PAGEY2 (DOOR_GFX_PAGE_HEIGHT)
506 /* macros for version handling */
507 #define VERSION_MAJOR(x) ((x) / 1000000)
508 #define VERSION_MINOR(x) (((x) % 1000000) / 10000)
509 #define VERSION_PATCH(x) (((x) % 10000) / 100)
510 #define VERSION_BUILD(x) ((x) % 100)
511 #define VERSION_IDENT(a,b,c,d) ((a) * 1000000 + (b) * 10000 + (c) * 100 + (d))
514 /* macros for parent/child process identification */
515 #if defined(PLATFORM_UNIX)
516 #define IS_PARENT_PROCESS() (audio.mixer_pid != getpid())
517 #define IS_CHILD_PROCESS() (audio.mixer_pid == getpid())
518 #define HAS_CHILD_PROCESS() (audio.mixer_pid > 0)
520 #define IS_PARENT_PROCESS() TRUE
521 #define IS_CHILD_PROCESS() FALSE
522 #define HAS_CHILD_PROCESS() FALSE
526 /* values for artwork type */
527 #define ARTWORK_TYPE_GRAPHICS 0
528 #define ARTWORK_TYPE_SOUNDS 1
529 #define ARTWORK_TYPE_MUSIC 2
531 #define NUM_ARTWORK_TYPES 3
534 /* values for tree type (chosen to match artwork type) */
535 #define TREE_TYPE_UNDEFINED -1
536 #define TREE_TYPE_GRAPHICS_DIR ARTWORK_TYPE_GRAPHICS
537 #define TREE_TYPE_SOUNDS_DIR ARTWORK_TYPE_SOUNDS
538 #define TREE_TYPE_MUSIC_DIR ARTWORK_TYPE_MUSIC
539 #define TREE_TYPE_LEVEL_DIR 3
540 #define TREE_TYPE_LEVEL_NR 4
542 #define NUM_TREE_TYPES 5
544 #define INFOTEXT_UNDEFINED ""
545 #define INFOTEXT_GRAPHICS_DIR "Custom Graphics"
546 #define INFOTEXT_SOUNDS_DIR "Custom Sounds"
547 #define INFOTEXT_MUSIC_DIR "Custom Music"
548 #define INFOTEXT_LEVEL_DIR "Level Sets"
549 #define INFOTEXT_LEVEL_NR "Levels"
551 #define TREE_INFOTEXT(t) ((t) == TREE_TYPE_LEVEL_NR ? \
552 INFOTEXT_LEVEL_NR : \
553 (t) == TREE_TYPE_LEVEL_DIR ? \
554 INFOTEXT_LEVEL_DIR : \
555 (t) == TREE_TYPE_GRAPHICS_DIR ? \
556 INFOTEXT_GRAPHICS_DIR : \
557 (t) == TREE_TYPE_SOUNDS_DIR ? \
558 INFOTEXT_SOUNDS_DIR : \
559 (t) == TREE_TYPE_MUSIC_DIR ? \
560 INFOTEXT_MUSIC_DIR : \
563 /* values for artwork handling */
564 #define LEVELDIR_ARTWORK_SET_PTR(leveldir, type) \
565 ((type) == ARTWORK_TYPE_GRAPHICS ? \
566 &(leveldir)->graphics_set : \
567 (type) == ARTWORK_TYPE_SOUNDS ? \
568 &(leveldir)->sounds_set : \
569 &(leveldir)->music_set)
571 #define LEVELDIR_ARTWORK_SET(leveldir, type) \
572 ((type) == ARTWORK_TYPE_GRAPHICS ? \
573 (leveldir)->graphics_set : \
574 (type) == ARTWORK_TYPE_SOUNDS ? \
575 (leveldir)->sounds_set : \
576 (leveldir)->music_set)
578 #define LEVELDIR_ARTWORK_PATH_PTR(leveldir, type) \
579 ((type) == ARTWORK_TYPE_GRAPHICS ? \
580 &(leveldir)->graphics_path : \
581 (type) == ARTWORK_TYPE_SOUNDS ? \
582 &(leveldir)->sounds_path : \
583 &(leveldir)->music_path)
585 #define LEVELDIR_ARTWORK_PATH(leveldir, type) \
586 ((type) == ARTWORK_TYPE_GRAPHICS ? \
587 (leveldir)->graphics_path : \
588 (type) == ARTWORK_TYPE_SOUNDS ? \
589 (leveldir)->sounds_path : \
590 (leveldir)->music_path)
592 #define SETUP_ARTWORK_SET(setup, type) \
593 ((type) == ARTWORK_TYPE_GRAPHICS ? \
594 (setup).graphics_set : \
595 (type) == ARTWORK_TYPE_SOUNDS ? \
596 (setup).sounds_set : \
599 #define SETUP_OVERRIDE_ARTWORK(setup, type) \
600 ((type) == ARTWORK_TYPE_GRAPHICS ? \
601 (setup).override_level_graphics : \
602 (type) == ARTWORK_TYPE_SOUNDS ? \
603 (setup).override_level_sounds : \
604 (setup).override_level_music)
606 #define GFX_OVERRIDE_ARTWORK(type) \
607 ((type) == ARTWORK_TYPE_GRAPHICS ? \
608 gfx.override_level_graphics : \
609 (type) == ARTWORK_TYPE_SOUNDS ? \
610 gfx.override_level_sounds : \
611 gfx.override_level_music)
613 #define ARTWORK_FIRST_NODE(artwork, type) \
614 ((type) == ARTWORK_TYPE_GRAPHICS ? \
615 (artwork).gfx_first : \
616 (type) == ARTWORK_TYPE_SOUNDS ? \
617 (artwork).snd_first : \
620 #define ARTWORK_CURRENT_IDENTIFIER_PTR(artwork, type) \
621 ((type) == ARTWORK_TYPE_GRAPHICS ? \
622 &(artwork).gfx_current_identifier : \
623 (type) == ARTWORK_TYPE_SOUNDS ? \
624 &(artwork).snd_current_identifier : \
625 &(artwork).mus_current_identifier)
627 #define ARTWORK_CURRENT_IDENTIFIER(artwork, type) \
628 ((type) == ARTWORK_TYPE_GRAPHICS ? \
629 (artwork).gfx_current_identifier : \
630 (type) == ARTWORK_TYPE_SOUNDS ? \
631 (artwork).snd_current_identifier : \
632 (artwork).mus_current_identifier)
634 #define ARTWORKINFO_FILENAME(type) \
635 ((type) == ARTWORK_TYPE_GRAPHICS ? \
636 GRAPHICSINFO_FILENAME : \
637 (type) == ARTWORK_TYPE_SOUNDS ? \
638 SOUNDSINFO_FILENAME : \
639 (type) == ARTWORK_TYPE_MUSIC ? \
640 MUSICINFO_FILENAME : "")
642 #define ARTWORK_DIRECTORY(type) \
643 ((type) == ARTWORK_TYPE_GRAPHICS ? \
644 GRAPHICS_DIRECTORY : \
645 (type) == ARTWORK_TYPE_SOUNDS ? \
647 (type) == ARTWORK_TYPE_MUSIC ? \
648 MUSIC_DIRECTORY : "")
650 #define OPTIONS_ARTWORK_DIRECTORY(type) \
651 ((type) == ARTWORK_TYPE_GRAPHICS ? \
652 options.graphics_directory : \
653 (type) == ARTWORK_TYPE_SOUNDS ? \
654 options.sounds_directory : \
655 (type) == ARTWORK_TYPE_MUSIC ? \
656 options.music_directory : "")
658 #define UPDATE_BUSY_STATE() \
660 if (gfx.draw_busy_anim_function != NULL) \
661 gfx.draw_busy_anim_function(); \
665 /* type definitions */
666 #if defined(TARGET_SDL2)
667 typedef int (*EventFilter)(void *, Event *);
669 typedef int (*EventFilter)(const Event *);
673 /* structure definitions */
677 char *command_basepath; /* path to the program binary */
678 char *command_basename; /* base filename of the program binary */
680 char *maindata_path; /* main game data (installation) directory */
682 char *userdata_subdir; /* personal user game data directory */
683 char *userdata_subdir_unix; /* personal user game data directory (Unix) */
684 char *userdata_path; /* resulting full path to game data directory */
690 char *x11_icon_filename;
691 char *x11_iconmask_filename;
692 char *sdl_icon_filename;
693 char *msdos_cursor_filename;
696 char *filename_prefix; /* prefix to cut off from DOS filenames */
698 char *error_filename; /* filename where to write error messages to */
699 FILE *error_file; /* (used instead of 'stderr' on some systems) */
705 void (*exit_message_function)(char *, va_list);
706 void (*exit_function)(int);
715 char *ro_base_directory;
716 char *rw_base_directory;
717 char *level_directory;
718 char *graphics_directory;
719 char *sounds_directory;
720 char *music_directory;
721 char *docs_directory;
723 char *execute_command;
731 boolean debug_x11_sync;
734 struct ScreenModeInfo
739 struct VideoSystemInfo
742 int width, height, depth;
743 int window_width, window_height;
745 boolean fullscreen_available;
746 boolean fullscreen_enabled;
747 boolean fullscreen_initial;
748 struct ScreenModeInfo *fullscreen_modes;
749 char *fullscreen_mode_current;
751 boolean window_scaling_available;
752 int window_scaling_percent;
753 char *window_scaling_quality;
756 struct AudioSystemInfo
758 boolean sound_available;
759 boolean loops_available;
760 boolean music_available;
762 boolean sound_enabled;
763 boolean sound_deactivated; /* for temporarily disabling sound */
772 int first_sound_channel;
775 struct FontBitmapInfo
779 int src_x, src_y; /* start position of animation frames */
780 int width, height; /* width/height of each animation frame */
782 int draw_xoffset; /* offset for drawing font characters */
783 int draw_yoffset; /* offset for drawing font characters */
786 int num_chars_per_line;
788 #if defined(TARGET_X11_NATIVE_PERFORMANCE_WORKAROUND)
789 Pixmap *clip_mask; /* single-char-only clip mask array for X11 */
797 int real_sx, real_sy;
798 int full_sxsize, full_sysize;
799 int scrollbuffer_width, scrollbuffer_height;
807 int win_xsize, win_ysize;
809 int draw_deactivation_mask;
810 int draw_background_mask;
812 Bitmap *field_save_buffer;
814 Bitmap *background_bitmap;
815 int background_bitmap_mask;
817 boolean clipping_enabled;
819 int clip_width, clip_height;
821 boolean override_level_graphics;
822 boolean override_level_sounds;
823 boolean override_level_music;
825 boolean draw_init_text;
828 struct FontBitmapInfo *font_bitmap_info;
829 int (*select_font_function)(int);
830 int (*get_font_from_token_function)(char *);
832 int anim_random_frame;
834 void (*draw_busy_anim_function)(void);
840 int fd[MAX_PLAYERS]; /* file descriptor of player's joystick */
843 struct SetupJoystickInfo
845 char *device_name; /* device name of player's joystick */
847 int xleft, xmiddle, xright;
848 int yupper, ymiddle, ylower;
852 struct SetupKeyboardInfo
854 Key left, right, up, down;
858 struct SetupInputInfo
860 boolean use_joystick;
861 struct SetupJoystickInfo joy;
862 struct SetupKeyboardInfo key;
865 struct SetupEditorInfo
867 boolean el_boulderdash;
868 boolean el_emerald_mine;
869 boolean el_emerald_mine_club;
873 boolean el_diamond_caves;
874 boolean el_dx_boulderdash;
876 boolean el_steel_chars;
878 boolean el_user_defined;
881 boolean el_headlines;
886 boolean show_element_token;
889 struct SetupEditorCascadeInfo
900 boolean el_steel_chars;
908 struct SetupShortcutInfo
914 Key focus_player[MAX_PLAYERS];
915 Key focus_player_all;
934 struct SetupSystemInfo
936 char *sdl_videodriver;
937 char *sdl_audiodriver;
938 int audio_fragment_size;
948 boolean sound_simple;
950 boolean scroll_delay;
951 boolean scroll_delay_value;
952 boolean soft_scrolling;
953 boolean fade_screens;
955 boolean show_titlescreen;
962 char *fullscreen_mode;
963 int window_scaling_percent;
964 char *window_scaling_quality;
965 boolean ask_on_escape;
966 boolean ask_on_escape_editor;
967 boolean quick_switch;
968 boolean input_on_focus;
969 boolean prefer_aga_graphics;
970 int game_frame_delay;
971 boolean sp_show_border_elements;
972 boolean small_game_graphics;
977 int override_level_graphics; /* not boolean -- can also be "AUTO" */
978 int override_level_sounds; /* not boolean -- can also be "AUTO" */
979 int override_level_music; /* not boolean -- can also be "AUTO" */
985 struct SetupEditorInfo editor;
986 struct SetupEditorCascadeInfo editor_cascade;
987 struct SetupShortcutInfo shortcut;
988 struct SetupInputInfo input[MAX_PLAYERS];
989 struct SetupSystemInfo system;
990 struct OptionInfo options;
995 struct TreeInfo **node_top; /* topmost node in tree */
996 struct TreeInfo *node_parent; /* parent level directory info */
997 struct TreeInfo *node_group; /* level group sub-directory info */
998 struct TreeInfo *next; /* next level series structure node */
1000 int cl_first; /* internal control field for setup screen */
1001 int cl_cursor; /* internal control field for setup screen */
1003 int type; /* type of tree content */
1005 /* fields for "type == TREE_TYPE_LEVEL_DIR" */
1007 char *subdir; /* tree info sub-directory basename (may be ".") */
1008 char *fullpath; /* complete path relative to tree base directory */
1009 char *basepath; /* absolute base path of tree base directory */
1010 char *identifier; /* identifier string for configuration files */
1011 char *name; /* tree info name, as displayed in selection menues */
1012 char *name_sorting; /* optional sorting name for correct name sorting */
1013 char *author; /* level or artwork author name */
1014 char *year; /* optional year of creation for levels or artwork */
1015 char *imported_from; /* optional comment for imported levels or artwork */
1016 char *imported_by; /* optional comment for imported levels or artwork */
1017 char *tested_by; /* optional comment to name people who tested a set */
1019 char *graphics_set_ecs; /* special EMC custom graphics set (ECS graphics) */
1020 char *graphics_set_aga; /* special EMC custom graphics set (AGA graphics) */
1021 char *graphics_set; /* optional custom graphics set (level tree only) */
1022 char *sounds_set; /* optional custom sounds set (level tree only) */
1023 char *music_set; /* optional custom music set (level tree only) */
1024 char *graphics_path; /* path to optional custom graphics set (level only) */
1025 char *sounds_path; /* path to optional custom sounds set (level only) */
1026 char *music_path; /* path to optional custom music set (level only) */
1028 char *level_filename; /* filename of level file (for packed level file) */
1029 char *level_filetype; /* type of levels in level directory or level file */
1031 char *special_flags; /* flags for special actions performed on level file */
1033 int levels; /* number of levels in level series */
1034 int first_level; /* first level number (to allow start with 0 or 1) */
1035 int last_level; /* last level number (automatically calculated) */
1036 int sort_priority; /* sort levels by 'sort_priority' and then by name */
1038 boolean latest_engine;/* force level set to use the latest game engine */
1040 boolean level_group; /* directory contains more level series directories */
1041 boolean parent_link; /* entry links back to parent directory */
1042 boolean in_user_dir; /* user defined levels are stored in home directory */
1043 boolean user_defined; /* levels in user directory and marked as "private" */
1044 boolean readonly; /* readonly levels can not be changed with editor */
1045 boolean handicap; /* level set has no handicap when set to "false" */
1046 boolean skip_levels; /* levels can be skipped when set to "true" */
1048 int color; /* color to use on selection screen for this level */
1049 char *class_desc; /* description of level series class */
1050 int handicap_level; /* number of the lowest unsolved level */
1052 char *infotext; /* optional text to describe the tree type (headline) */
1055 typedef struct TreeInfo TreeInfo;
1056 typedef struct TreeInfo LevelDirTree;
1057 typedef struct TreeInfo ArtworkDirTree;
1058 typedef struct TreeInfo GraphicsDirTree;
1059 typedef struct TreeInfo SoundsDirTree;
1060 typedef struct TreeInfo MusicDirTree;
1064 GraphicsDirTree *gfx_first;
1065 GraphicsDirTree *gfx_current;
1066 SoundsDirTree *snd_first;
1067 SoundsDirTree *snd_current;
1068 MusicDirTree *mus_first;
1069 MusicDirTree *mus_current;
1071 char *gfx_current_identifier;
1072 char *snd_current_identifier;
1073 char *mus_current_identifier;
1076 struct ValueTextInfo
1088 struct ConfigTypeInfo
1095 struct TokenIntPtrInfo
1105 char *default_filename;
1108 char **default_parameter; /* array of file parameters */
1109 char **parameter; /* array of file parameters */
1112 boolean fallback_to_default;
1113 boolean default_is_cloned;
1116 struct SetupFileList
1121 struct SetupFileList *next;
1126 char *source_filename; /* primary key for node list */
1130 struct PropertyMapping
1140 struct ArtworkListInfo
1142 int type; /* type of artwork */
1144 int num_file_list_entries;
1145 int num_dynamic_file_list_entries;
1146 struct FileInfo *file_list; /* static artwork file array */
1147 struct FileInfo *dynamic_file_list; /* dynamic artwrk file array */
1149 int num_suffix_list_entries;
1150 struct ConfigTypeInfo *suffix_list; /* parameter suffixes array */
1152 int num_base_prefixes;
1153 int num_ext1_suffixes;
1154 int num_ext2_suffixes;
1155 int num_ext3_suffixes;
1156 char **base_prefixes; /* base token prefixes array */
1157 char **ext1_suffixes; /* property suffixes array 1 */
1158 char **ext2_suffixes; /* property suffixes array 2 */
1159 char **ext3_suffixes; /* property suffixes array 3 */
1161 int num_ignore_tokens;
1162 char **ignore_tokens; /* file tokens to be ignored */
1164 int num_property_mapping_entries;
1165 struct PropertyMapping *property_mapping; /* mapping token -> artwork */
1167 int sizeof_artwork_list_entry;
1169 struct ListNodeInfo **artwork_list; /* static artwork node array */
1170 struct ListNodeInfo **dynamic_artwork_list; /* dynamic artwrk node array */
1171 struct ListNode *content_list; /* dynamic artwork node list */
1173 void *(*load_artwork)(char *); /* constructor function */
1174 void (*free_artwork)(void *); /* destructor function */
1188 struct RectWithBorder
1209 boolean draw_masked;
1210 boolean draw_player; /* special case for network player buttons */
1222 /* ========================================================================= */
1223 /* exported variables */
1224 /* ========================================================================= */
1226 extern struct ProgramInfo program;
1227 extern struct OptionInfo options;
1228 extern struct VideoSystemInfo video;
1229 extern struct AudioSystemInfo audio;
1230 extern struct GfxInfo gfx;
1231 extern struct AnimInfo anim;
1232 extern struct ArtworkInfo artwork;
1233 extern struct JoystickInfo joystick;
1234 extern struct SetupInfo setup;
1236 extern LevelDirTree *leveldir_first_all;
1237 extern LevelDirTree *leveldir_first;
1238 extern LevelDirTree *leveldir_current;
1239 extern int level_nr;
1241 extern struct LevelStats level_stats[];
1243 extern Display *display;
1244 extern Visual *visual;
1246 extern Colormap cmap;
1248 extern DrawWindow *window;
1249 extern DrawBuffer *backbuffer;
1250 extern DrawBuffer *drawto;
1252 extern int button_status;
1253 extern boolean motion_status;
1254 #if defined(TARGET_SDL2)
1255 extern boolean keyrepeat_status;
1258 extern int redraw_mask;
1259 extern int redraw_tiles;
1261 extern int FrameCounter;
1264 /* function definitions */
1266 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
1267 char *, char *, char *, char *, char *, int);
1269 void InitExitMessageFunction(void (*exit_message_function)(char *, va_list));
1270 void InitExitFunction(void (*exit_function)(int));
1271 void InitPlatformDependentStuff(void);
1272 void ClosePlatformDependentStuff(void);
1274 void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
1275 void InitGfxDoor1Info(int, int, int, int);
1276 void InitGfxDoor2Info(int, int, int, int);
1277 void InitGfxWindowInfo(int, int);
1278 void InitGfxScrollbufferInfo(int, int);
1279 void InitGfxClipRegion(boolean, int, int, int, int);
1280 void InitGfxDrawBusyAnimFunction(void (*draw_busy_anim_function)(void));
1281 void InitGfxCustomArtworkInfo();
1282 void SetDrawDeactivationMask(int);
1283 void SetDrawBackgroundMask(int);
1284 void SetWindowBackgroundBitmap(Bitmap *);
1285 void SetMainBackgroundBitmap(Bitmap *);
1286 void SetDoorBackgroundBitmap(Bitmap *);
1288 void LimitScreenUpdates(boolean);
1290 void InitVideoDisplay(void);
1291 void CloseVideoDisplay(void);
1292 void InitVideoBuffer(int, int, int, boolean);
1293 Bitmap *CreateBitmapStruct(void);
1294 Bitmap *CreateBitmap(int, int, int);
1295 void ReCreateBitmap(Bitmap **, int, int, int);
1296 void FreeBitmap(Bitmap *);
1297 void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
1298 void BlitBitmapTiled(Bitmap *, Bitmap *, int, int, int, int, int, int, int,int);
1299 void FadeRectangle(Bitmap *bitmap, int, int, int, int, int, int, int,
1300 void (*draw_border_function)(void));
1301 void FillRectangle(Bitmap *, int, int, int, int, Pixel);
1302 void ClearRectangle(Bitmap *, int, int, int, int);
1303 void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
1304 void SetClipMask(Bitmap *, GC, Pixmap);
1305 void SetClipOrigin(Bitmap *, GC, int, int);
1306 void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
1307 boolean DrawingOnBackground(int, int);
1308 void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int, int);
1309 void DrawSimpleBlackLine(Bitmap *, int, int, int, int);
1310 void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
1311 void DrawLines(Bitmap *, struct XY *, int, Pixel);
1312 Pixel GetPixel(Bitmap *, int, int);
1313 Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
1314 Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
1316 void FlushDisplay(void);
1317 void SyncDisplay(void);
1318 void KeyboardAutoRepeatOn(void);
1319 void KeyboardAutoRepeatOff(void);
1320 boolean PointerInWindow(DrawWindow *);
1321 boolean SetVideoMode(boolean);
1322 boolean ChangeVideoModeIfNeeded(boolean);
1324 Bitmap *LoadImage(char *);
1325 Bitmap *LoadCustomImage(char *);
1326 void ReloadCustomImage(Bitmap *, char *);
1328 Bitmap *ZoomBitmap(Bitmap *, int, int);
1329 void CreateBitmapWithSmallBitmaps(Bitmap *, int);
1330 void ScaleBitmap(Bitmap *, int);
1332 void SetMouseCursor(int);
1334 void OpenAudio(void);
1335 void CloseAudio(void);
1336 void SetAudioMode(boolean);
1338 void InitEventFilter(EventFilter);
1339 boolean PendingEvent(void);
1340 void NextEvent(Event *event);
1341 void PeekEvent(Event *event);
1342 Key GetEventKey(KeyEvent *, boolean);
1343 KeyMod HandleKeyModState(Key, int);
1344 KeyMod GetKeyModState();
1345 KeyMod GetKeyModStateFromEvents();
1346 boolean CheckCloseWindowEvent(ClientMessageEvent *);
1348 void InitJoysticks();
1349 boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
1351 #endif /* SYSTEM_H */