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
99 #define TOUCH_TRANSPARENCY_DEFAULT 50
101 #define ALPHA_FROM_TRANSPARENCY(x) ((100 - x) * SDL_ALPHA_OPAQUE / 100)
102 #define ALPHA_FADING_STEPSIZE(x) ((x) / 25)
104 /* values for special settings for mobile devices */
105 #if defined(PLATFORM_ANDROID)
106 #define USE_TOUCH_INPUT_OVERLAY
107 #define USE_COMPLETE_DISPLAY
108 #define HAS_SCREEN_KEYBOARD
109 #define SCREEN_KEYBOARD_POS(h) ((h) / 2)
112 /* default input keys */
113 #define DEFAULT_KEY_LEFT KSYM_Left
114 #define DEFAULT_KEY_RIGHT KSYM_Right
115 #define DEFAULT_KEY_UP KSYM_Up
116 #define DEFAULT_KEY_DOWN KSYM_Down
117 #if defined(PLATFORM_MACOSX)
118 #define DEFAULT_KEY_SNAP KSYM_Control_L
119 #define DEFAULT_KEY_DROP KSYM_KP_Enter
121 #define DEFAULT_KEY_SNAP KSYM_Control_L
122 #define DEFAULT_KEY_DROP KSYM_Control_R
124 #define DEFAULT_KEY_OKAY KSYM_Return
125 #define DEFAULT_KEY_CANCEL KSYM_Escape
127 /* default shortcut keys */
128 #define DEFAULT_KEY_SAVE_GAME KSYM_F1
129 #define DEFAULT_KEY_LOAD_GAME KSYM_F2
130 #define DEFAULT_KEY_TOGGLE_PAUSE KSYM_space
131 #define DEFAULT_KEY_FOCUS_PLAYER_1 KSYM_F5
132 #define DEFAULT_KEY_FOCUS_PLAYER_2 KSYM_F6
133 #define DEFAULT_KEY_FOCUS_PLAYER_3 KSYM_F7
134 #define DEFAULT_KEY_FOCUS_PLAYER_4 KSYM_F8
135 #define DEFAULT_KEY_FOCUS_PLAYER_ALL KSYM_F9
136 #define DEFAULT_KEY_TAPE_EJECT KSYM_UNDEFINED
137 #define DEFAULT_KEY_TAPE_EXTRA KSYM_UNDEFINED
138 #define DEFAULT_KEY_TAPE_STOP KSYM_UNDEFINED
139 #define DEFAULT_KEY_TAPE_PAUSE KSYM_UNDEFINED
140 #define DEFAULT_KEY_TAPE_RECORD KSYM_UNDEFINED
141 #define DEFAULT_KEY_TAPE_PLAY KSYM_UNDEFINED
142 #define DEFAULT_KEY_SOUND_SIMPLE KSYM_UNDEFINED
143 #define DEFAULT_KEY_SOUND_LOOPS KSYM_UNDEFINED
144 #define DEFAULT_KEY_SOUND_MUSIC KSYM_UNDEFINED
145 #define DEFAULT_KEY_SNAP_LEFT KSYM_UNDEFINED
146 #define DEFAULT_KEY_SNAP_RIGHT KSYM_UNDEFINED
147 #define DEFAULT_KEY_SNAP_UP KSYM_UNDEFINED
148 #define DEFAULT_KEY_SNAP_DOWN KSYM_UNDEFINED
150 /* default debug setup keys and values */
151 #define DEFAULT_FRAME_DELAY_0 20 // 100 % speed
152 #define DEFAULT_FRAME_DELAY_1 500 // 4 % speed
153 #define DEFAULT_FRAME_DELAY_2 250 // 8 % speed
154 #define DEFAULT_FRAME_DELAY_3 125 // 16 % speed
155 #define DEFAULT_FRAME_DELAY_4 60 // 33 % speed
156 #define DEFAULT_FRAME_DELAY_5 40 // 50 % speed
157 #define DEFAULT_FRAME_DELAY_6 30 // 66 % speed
158 #define DEFAULT_FRAME_DELAY_7 10 // 200 % speed
159 #define DEFAULT_FRAME_DELAY_8 5 // 400 % speed
160 #define DEFAULT_FRAME_DELAY_9 0 // maximum speed
162 #define DEFAULT_KEY_FRAME_DELAY_0 KSYM_0
163 #define DEFAULT_KEY_FRAME_DELAY_1 KSYM_1
164 #define DEFAULT_KEY_FRAME_DELAY_2 KSYM_2
165 #define DEFAULT_KEY_FRAME_DELAY_3 KSYM_3
166 #define DEFAULT_KEY_FRAME_DELAY_4 KSYM_4
167 #define DEFAULT_KEY_FRAME_DELAY_5 KSYM_5
168 #define DEFAULT_KEY_FRAME_DELAY_6 KSYM_6
169 #define DEFAULT_KEY_FRAME_DELAY_7 KSYM_7
170 #define DEFAULT_KEY_FRAME_DELAY_8 KSYM_8
171 #define DEFAULT_KEY_FRAME_DELAY_9 KSYM_9
173 #define NUM_DEBUG_FRAME_DELAY_KEYS 10
175 #define DEFAULT_FRAME_DELAY_USE_MOD_KEY FALSE
176 #define DEFAULT_FRAME_DELAY_GAME_ONLY TRUE
178 /* values for key_status */
179 #define KEY_NOT_PRESSED FALSE
180 #define KEY_RELEASED FALSE
181 #define KEY_PRESSED TRUE
183 /* values for button status */
184 #define MB_NOT_PRESSED FALSE
185 #define MB_NOT_RELEASED TRUE
186 #define MB_RELEASED FALSE
187 #define MB_PRESSED TRUE
188 #define MB_MENU_CHOICE FALSE
189 #define MB_MENU_MARK TRUE
190 #define MB_MENU_INITIALIZE (-1)
191 #define MB_MENU_LEAVE (-2)
192 #define MB_LEFTBUTTON 1
193 #define MB_MIDDLEBUTTON 2
194 #define MB_RIGHTBUTTON 3
195 #define MB_WHEEL_UP 4
196 #define MB_WHEEL_DOWN 5
197 #define MB_WHEEL_LEFT 6
198 #define MB_WHEEL_RIGHT 7
199 #define IS_WHEEL_BUTTON_VERTICAL(b) ((b) == MB_WHEEL_UP || \
200 (b) == MB_WHEEL_DOWN)
201 #define IS_WHEEL_BUTTON_HORIZONTAL(b) ((b) == MB_WHEEL_LEFT || \
202 (b) == MB_WHEEL_RIGHT)
203 #define IS_WHEEL_BUTTON(b) (IS_WHEEL_BUTTON_VERTICAL(b) || \
204 IS_WHEEL_BUTTON_HORIZONTAL(b))
205 #define DEFAULT_WHEEL_STEPS 3
207 #define BUTTON_STEPSIZE(b) ((b) == MB_LEFTBUTTON ? 1 : \
208 (b) == MB_MIDDLEBUTTON ? 5 : \
209 (b) == MB_RIGHTBUTTON ? 10 : 1)
211 /* values for move directions */
212 #define MV_BIT_LEFT 0
213 #define MV_BIT_RIGHT 1
215 #define MV_BIT_DOWN 3
217 #define NUM_DIRECTIONS 4
219 /* diagonal movement directions are used in a different contect than buttons */
220 #define MV_BIT_UPLEFT 4
221 #define MV_BIT_UPRIGHT 5
222 #define MV_BIT_DOWNLEFT 6
223 #define MV_BIT_DOWNRIGHT 7
225 #define NUM_DIRECTIONS_FULL 8
227 /* values for special "button" bitmasks */
231 #define NUM_PLAYER_ACTIONS 6
233 /* values for special "focus player" bitmasks */
234 #define BIT_SET_FOCUS 6
236 /* values for drawing stages for global animations */
237 #define DRAW_GLOBAL_ANIM_STAGE_1 1
238 #define DRAW_GLOBAL_ANIM_STAGE_2 2
240 /* values for drawing target (various functions) */
241 #define DRAW_TO_BACKBUFFER 0
242 #define DRAW_TO_FIELDBUFFER 1
243 #define DRAW_TO_SCREEN 2
244 #define DRAW_TO_FADE_SOURCE 3
245 #define DRAW_TO_FADE_TARGET 4
247 /* values for move directions and special "button" key bitmasks */
249 #define MV_LEFT (1 << MV_BIT_LEFT)
250 #define MV_RIGHT (1 << MV_BIT_RIGHT)
251 #define MV_UP (1 << MV_BIT_UP)
252 #define MV_DOWN (1 << MV_BIT_DOWN)
254 #define MV_UPLEFT (MV_UP | MV_LEFT)
255 #define MV_UPRIGHT (MV_UP | MV_RIGHT)
256 #define MV_DOWNLEFT (MV_DOWN | MV_LEFT)
257 #define MV_DOWNRIGHT (MV_DOWN | MV_RIGHT)
259 #define MV_HORIZONTAL (MV_LEFT | MV_RIGHT)
260 #define MV_VERTICAL (MV_UP | MV_DOWN)
261 #define MV_ALL_DIRECTIONS (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
262 #define MV_ANY_DIRECTION (MV_ALL_DIRECTIONS)
263 #define MV_NO_DIRECTION (MV_NONE)
265 #define KEY_BUTTON_1 (1 << BUTTON_1)
266 #define KEY_BUTTON_2 (1 << BUTTON_2)
267 #define KEY_BUTTON_SNAP KEY_BUTTON_1
268 #define KEY_BUTTON_DROP KEY_BUTTON_2
269 #define KEY_MOTION (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
270 #define KEY_BUTTON (KEY_BUTTON_1 | KEY_BUTTON_2)
271 #define KEY_ACTION (KEY_MOTION | KEY_BUTTON)
273 #define KEY_SET_FOCUS (1 << BIT_SET_FOCUS)
275 #define MV_DIR_FROM_BIT(x) ((x) < NUM_DIRECTIONS ? 1 << (x) : \
276 (x) == MV_BIT_UPLEFT ? MV_UPLEFT : \
277 (x) == MV_BIT_UPRIGHT ? MV_UPRIGHT : \
278 (x) == MV_BIT_DOWNLEFT ? MV_DOWNLEFT : \
279 (x) == MV_BIT_DOWNRIGHT ? MV_DOWNRIGHT : \
282 #define MV_DIR_TO_BIT(x) ((x) == MV_LEFT ? MV_BIT_LEFT : \
283 (x) == MV_RIGHT ? MV_BIT_RIGHT : \
284 (x) == MV_UP ? MV_BIT_UP : \
285 (x) == MV_DOWN ? MV_BIT_DOWN : \
286 (x) == MV_UPLEFT ? MV_BIT_UPLEFT : \
287 (x) == MV_UPRIGHT ? MV_BIT_UPRIGHT : \
288 (x) == MV_DOWNLEFT ? MV_BIT_DOWNLEFT : \
289 (x) == MV_DOWNRIGHT ? MV_BIT_DOWNRIGHT : \
292 #define MV_DIR_OPPOSITE(x) ((x) == MV_LEFT ? MV_RIGHT : \
293 (x) == MV_RIGHT ? MV_LEFT : \
294 (x) == MV_UP ? MV_DOWN : \
295 (x) == MV_DOWN ? MV_UP : \
296 (x) == MV_UPLEFT ? MV_DOWNRIGHT : \
297 (x) == MV_UPRIGHT ? MV_DOWNLEFT : \
298 (x) == MV_DOWNLEFT ? MV_UPRIGHT : \
299 (x) == MV_DOWNRIGHT ? MV_UPLEFT : \
302 /* values for animation mode (frame order and direction) */
303 /* (stored in level files -- never change existing values) */
305 #define ANIM_LOOP (1 << 0)
306 #define ANIM_LINEAR (1 << 1)
307 #define ANIM_PINGPONG (1 << 2)
308 #define ANIM_PINGPONG2 (1 << 3)
309 #define ANIM_RANDOM (1 << 4)
310 #define ANIM_CE_VALUE (1 << 5)
311 #define ANIM_CE_SCORE (1 << 6)
312 #define ANIM_CE_DELAY (1 << 7)
313 #define ANIM_REVERSE (1 << 8)
314 #define ANIM_OPAQUE_PLAYER (1 << 9)
316 /* values for special (non game element) animation modes */
317 /* (not stored in level files -- can be changed, if needed) */
318 #define ANIM_HORIZONTAL (1 << 10)
319 #define ANIM_VERTICAL (1 << 11)
320 #define ANIM_CENTERED (1 << 12)
321 #define ANIM_STATIC_PANEL (1 << 13)
322 #define ANIM_ALL (1 << 14)
323 #define ANIM_ONCE (1 << 15)
325 #define ANIM_DEFAULT ANIM_LOOP
327 /* values for special drawing styles (currently only for crumbled graphics) */
329 #define STYLE_ACCURATE_BORDERS (1 << 0)
330 #define STYLE_INNER_CORNERS (1 << 1)
331 #define STYLE_REVERSE (1 << 2)
333 /* values for special event handling style (used for global animation) */
334 #define STYLE_PASSTHROUGH (1 << 3)
335 #define STYLE_MULTIPLE_ACTIONS (1 << 4)
337 #define STYLE_DEFAULT STYLE_NONE
339 /* values for special global animation events */
340 #define ANIM_EVENT_NONE 0
341 #define ANIM_EVENT_SELF (1 << 16)
342 #define ANIM_EVENT_ANY (1 << 17)
344 #define ANIM_EVENT_ANIM_BIT 0
345 #define ANIM_EVENT_PART_BIT 8
347 #define ANIM_EVENT_ANIM_MASK (0xff << ANIM_EVENT_ANIM_BIT)
348 #define ANIM_EVENT_PART_MASK (0xff << ANIM_EVENT_PART_BIT)
350 #define ANIM_EVENT_DEFAULT ANIM_EVENT_NONE
352 /* values for special global animation event actions */
353 #define ANIM_EVENT_ACTION_NONE -1
355 /* values for fade mode */
356 #define FADE_TYPE_NONE 0
357 #define FADE_TYPE_FADE_IN (1 << 0)
358 #define FADE_TYPE_FADE_OUT (1 << 1)
359 #define FADE_TYPE_TRANSFORM (1 << 2)
360 #define FADE_TYPE_CROSSFADE (1 << 3)
361 #define FADE_TYPE_MELT (1 << 4)
362 #define FADE_TYPE_CURTAIN (1 << 5)
363 #define FADE_TYPE_SKIP (1 << 6)
365 #define FADE_MODE_NONE (FADE_TYPE_NONE)
366 #define FADE_MODE_FADE_IN (FADE_TYPE_FADE_IN)
367 #define FADE_MODE_FADE_OUT (FADE_TYPE_FADE_OUT)
368 #define FADE_MODE_FADE (FADE_TYPE_FADE_IN | FADE_TYPE_FADE_OUT)
369 #define FADE_MODE_TRANSFORM (FADE_TYPE_TRANSFORM | FADE_TYPE_FADE_IN)
370 #define FADE_MODE_CROSSFADE (FADE_MODE_TRANSFORM | FADE_TYPE_CROSSFADE)
371 #define FADE_MODE_MELT (FADE_MODE_TRANSFORM | FADE_TYPE_MELT)
372 #define FADE_MODE_CURTAIN (FADE_MODE_TRANSFORM | FADE_TYPE_CURTAIN)
373 #define FADE_MODE_SKIP_FADE_IN (FADE_TYPE_SKIP | FADE_TYPE_FADE_IN)
374 #define FADE_MODE_SKIP_FADE_OUT (FADE_TYPE_SKIP | FADE_TYPE_FADE_OUT)
376 #define FADE_MODE_DEFAULT FADE_MODE_FADE
378 /* values for toon positions */
379 #define POS_UNDEFINED -1
390 /* values for text alignment */
391 #define ALIGN_LEFT (1 << 0)
392 #define ALIGN_RIGHT (1 << 1)
393 #define ALIGN_CENTER (1 << 2)
394 #define ALIGN_DEFAULT ALIGN_LEFT
396 #define VALIGN_TOP (1 << 0)
397 #define VALIGN_BOTTOM (1 << 1)
398 #define VALIGN_MIDDLE (1 << 2)
399 #define VALIGN_DEFAULT VALIGN_TOP
401 #define ALIGNED_XPOS(x,w,a) ((a) == ALIGN_CENTER ? (x) - (w) / 2 : \
402 (a) == ALIGN_RIGHT ? (x) - (w) : (x))
403 #define ALIGNED_YPOS(y,h,v) ((v) == VALIGN_MIDDLE ? (y) - (h) / 2 : \
404 (v) == VALIGN_BOTTOM ? (y) - (h) : (y))
405 #define ALIGNED_TEXT_XPOS(p) ALIGNED_XPOS((p)->x, (p)->width, (p)->align)
406 #define ALIGNED_TEXT_YPOS(p) ALIGNED_YPOS((p)->y, (p)->height, (p)->valign)
408 /* values for redraw_mask */
409 #define REDRAW_NONE (0)
410 #define REDRAW_ALL (1 << 0)
411 #define REDRAW_FIELD (1 << 1)
412 #define REDRAW_DOOR_1 (1 << 2)
413 #define REDRAW_DOOR_2 (1 << 3)
414 #define REDRAW_DOOR_3 (1 << 4)
415 #define REDRAW_FPS (1 << 5)
417 #define REDRAW_DOORS (REDRAW_DOOR_1 | \
421 #define IN_GFX_FIELD_PLAY(x, y) (x >= gfx.sx && x < gfx.sx + gfx.sxsize && \
422 y >= gfx.sy && y < gfx.sy + gfx.sysize)
423 #define IN_GFX_FIELD_FULL(x, y) (x >= gfx.real_sx && \
424 x < gfx.real_sx + gfx.full_sxsize && \
425 y >= gfx.real_sy && \
426 y < gfx.real_sy + gfx.full_sysize)
427 #define IN_GFX_DOOR_1(x, y) (x >= gfx.dx && x < gfx.dx + gfx.dxsize && \
428 y >= gfx.dy && y < gfx.dy + gfx.dysize)
429 #define IN_GFX_DOOR_2(x, y) (x >= gfx.vx && x < gfx.vx + gfx.vxsize && \
430 y >= gfx.vy && y < gfx.vy + gfx.vysize)
431 #define IN_GFX_DOOR_3(x, y) (x >= gfx.ex && x < gfx.ex + gfx.exsize && \
432 y >= gfx.ey && y < gfx.ey + gfx.eysize)
434 /* values for mouse cursor */
435 #define CURSOR_DEFAULT 0
436 #define CURSOR_NONE 1
437 #define CURSOR_PLAYFIELD 2
439 /* fundamental game speed values */
440 #define ONE_SECOND_DELAY 1000 /* delay value for one second */
441 #define MENU_FRAME_DELAY 20 /* frame delay in milliseconds */
442 #define GAME_FRAME_DELAY 20 /* frame delay in milliseconds */
443 #define FFWD_FRAME_DELAY 10 /* 200% speed for fast forward */
444 #define FRAMES_PER_SECOND (ONE_SECOND_DELAY / GAME_FRAME_DELAY)
445 #define FRAMES_PER_SECOND_SP 35
447 /* maximum playfield size supported by libgame functions */
448 #define MAX_PLAYFIELD_WIDTH 128
449 #define MAX_PLAYFIELD_HEIGHT 128
451 /* maximum number of parallel players supported by libgame functions */
452 #define MAX_PLAYERS 4
454 /* maximum allowed length of player name */
455 #define MAX_PLAYER_NAME_LEN 10
457 /* maximum number of levels in a level set */
458 #define MAX_LEVELS 1000
460 /* maximum number of global animation and parts */
461 #define MAX_GLOBAL_ANIMS 32
462 #define MAX_GLOBAL_ANIM_PARTS 32
464 /* minimum/maximum/default x/y grid size for virtual buttons */
465 #define MIN_GRID_XSIZE 3
466 #define MIN_GRID_YSIZE 3
467 #define MAX_GRID_XSIZE 32
468 #define MAX_GRID_YSIZE 32
469 #define GRID_REAL_WIDTH MAX(1, MAX(video.screen_width, \
470 video.screen_height))
471 #define GRID_REAL_HEIGHT MAX(1, MIN(video.screen_width, \
472 video.screen_height))
473 #define DEFAULT_GRID_XSIZE_0 18
474 #define DEFAULT_GRID_YSIZE_0 MIN(MAX(MIN_GRID_YSIZE, \
475 DEFAULT_GRID_XSIZE_0 * \
479 #define DEFAULT_GRID_XSIZE_1 13
480 #define DEFAULT_GRID_YSIZE_1 MIN(MAX(MIN_GRID_YSIZE, \
481 DEFAULT_GRID_XSIZE_1 * \
486 #define DEFAULT_GRID_XSIZE(n) ((n) == 0 ? DEFAULT_GRID_XSIZE_0 : \
487 DEFAULT_GRID_XSIZE_1)
488 #define DEFAULT_GRID_YSIZE(n) ((n) == 0 ? DEFAULT_GRID_YSIZE_0 : \
489 DEFAULT_GRID_YSIZE_1)
491 #define GRID_ACTIVE_NR() (video.screen_width > \
492 video.screen_height ? 0 : 1)
494 /* values for grid button characters for virtual buttons */
495 #define CHAR_GRID_BUTTON_NONE ' '
496 #define CHAR_GRID_BUTTON_LEFT '<'
497 #define CHAR_GRID_BUTTON_RIGHT '>'
498 #define CHAR_GRID_BUTTON_UP '^'
499 #define CHAR_GRID_BUTTON_DOWN 'v'
500 #define CHAR_GRID_BUTTON_SNAP '1'
501 #define CHAR_GRID_BUTTON_DROP '2'
503 #define GET_ACTION_FROM_GRID_BUTTON(c) ((c) == CHAR_GRID_BUTTON_LEFT ? \
505 (c) == CHAR_GRID_BUTTON_RIGHT ? \
507 (c) == CHAR_GRID_BUTTON_UP ? \
509 (c) == CHAR_GRID_BUTTON_DOWN ? \
511 (c) == CHAR_GRID_BUTTON_SNAP ? \
513 (c) == CHAR_GRID_BUTTON_DROP ? \
517 /* default name for empty highscore entry */
518 #define EMPTY_PLAYER_NAME "no name"
520 /* default name for unknown player names */
521 #define ANONYMOUS_NAME "anonymous"
523 /* default for other unknown names */
524 #define UNKNOWN_NAME "unknown"
526 /* default name for new levels */
527 #define NAMELESS_LEVEL_NAME "nameless level"
529 /* default text for non-existant artwork */
530 #define NOT_AVAILABLE "(not available)"
532 /* default value for undefined filename */
533 #define UNDEFINED_FILENAME "[NONE]"
535 /* default value for undefined levelset */
536 #define UNDEFINED_LEVELSET "[NONE]"
538 /* default value for undefined parameter */
539 #define ARG_DEFAULT "[DEFAULT]"
541 /* default values for undefined configuration file parameters */
542 #define ARG_UNDEFINED "-1000000"
543 #define ARG_UNDEFINED_VALUE (-1000000)
545 /* default value for off-screen positions */
546 #define POS_OFFSCREEN (-1000000)
548 /* definitions for game sub-directories */
550 #define RO_GAME_DIR "."
554 #define RW_GAME_DIR "."
557 #define RO_BASE_PATH RO_GAME_DIR
558 #define RW_BASE_PATH RW_GAME_DIR
560 /* directory names */
561 #define GRAPHICS_DIRECTORY "graphics"
562 #define SOUNDS_DIRECTORY "sounds"
563 #define MUSIC_DIRECTORY "music"
564 #define LEVELS_DIRECTORY "levels"
565 #define TAPES_DIRECTORY "tapes"
566 #define SCORES_DIRECTORY "scores"
567 #define DOCS_DIRECTORY "docs"
568 #define CACHE_DIRECTORY "cache"
569 #define CONF_DIRECTORY "conf"
571 #define GFX_CLASSIC_SUBDIR "gfx_classic"
572 #define SND_CLASSIC_SUBDIR "snd_classic"
573 #define MUS_CLASSIC_SUBDIR "mus_classic"
575 #define GFX_DEFAULT_SUBDIR (setup.internal.default_graphics_set)
576 #define SND_DEFAULT_SUBDIR (setup.internal.default_sounds_set)
577 #define MUS_DEFAULT_SUBDIR (setup.internal.default_music_set)
579 #define GFX_FALLBACK_FILENAME (setup.internal.fallback_graphics_file)
580 #define SND_FALLBACK_FILENAME (setup.internal.fallback_sounds_file)
581 #define MUS_FALLBACK_FILENAME (setup.internal.fallback_music_file)
583 #define DEFAULT_LEVELSET (setup.internal.default_level_series)
585 /* file names and filename extensions */
586 #define LEVELSETUP_DIRECTORY "levelsetup"
587 #define SETUP_FILENAME "setup.conf"
588 #define AUTOSETUP_FILENAME "autosetup.conf"
589 #define LEVELSETUP_FILENAME "levelsetup.conf"
590 #define EDITORSETUP_FILENAME "editorsetup.conf"
591 #define EDITORCASCADE_FILENAME "editorcascade.conf"
592 #define HELPANIM_FILENAME "helpanim.conf"
593 #define HELPTEXT_FILENAME "helptext.conf"
594 #define LEVELINFO_FILENAME "levelinfo.conf"
595 #define GRAPHICSINFO_FILENAME "graphicsinfo.conf"
596 #define SOUNDSINFO_FILENAME "soundsinfo.conf"
597 #define MUSICINFO_FILENAME "musicinfo.conf"
598 #define ARTWORKINFO_CACHE_FILE "artworkinfo.cache"
599 #define LEVELTEMPLATE_FILENAME "template.level"
600 #define LEVELFILE_EXTENSION "level"
601 #define TAPEFILE_EXTENSION "tape"
602 #define SCOREFILE_EXTENSION "score"
604 #define GAMECONTROLLER_BASENAME "gamecontrollerdb.txt"
606 #define LOG_OUT_BASENAME "stdout.txt"
607 #define LOG_ERR_BASENAME "stderr.txt"
613 #define STRING_PARENT_DIRECTORY ".."
614 #define STRING_TOP_DIRECTORY "/"
616 #define CHAR_PATH_SEPARATOR_UNIX '/'
617 #define CHAR_PATH_SEPARATOR_DOS '\\'
619 #define STRING_PATH_SEPARATOR_UNIX "/"
620 #define STRING_PATH_SEPARATOR_DOS "\\"
622 #define STRING_NEWLINE_UNIX "\n"
623 #define STRING_NEWLINE_DOS "\r\n"
625 #if defined(PLATFORM_WIN32)
626 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_DOS
627 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_DOS
628 #define STRING_NEWLINE STRING_NEWLINE_DOS
630 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_UNIX
631 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_UNIX
632 #define STRING_NEWLINE STRING_NEWLINE_UNIX
636 /* areas in bitmap PIX_DOOR */
637 /* meaning in PIX_DB_DOOR: (3 PAGEs)
638 PAGEX1: 1. buffer for DOOR_1
639 PAGEX2: 2. buffer for DOOR_1
640 PAGEX3: buffer for animations
643 /* these values are hard-coded to be able to use them in initialization */
644 #define DOOR_GFX_PAGE_WIDTH 100 /* should be set to "gfx.dxsize" */
645 #define DOOR_GFX_PAGE_HEIGHT 280 /* should be set to "gfx.dysize" */
647 #define DOOR_GFX_PAGESIZE (DOOR_GFX_PAGE_WIDTH)
648 #define DOOR_GFX_PAGEX1 (0 * DOOR_GFX_PAGESIZE)
649 #define DOOR_GFX_PAGEX2 (1 * DOOR_GFX_PAGESIZE)
650 #define DOOR_GFX_PAGEX3 (2 * DOOR_GFX_PAGESIZE)
651 #define DOOR_GFX_PAGEX4 (3 * DOOR_GFX_PAGESIZE)
652 #define DOOR_GFX_PAGEX5 (4 * DOOR_GFX_PAGESIZE)
653 #define DOOR_GFX_PAGEX6 (5 * DOOR_GFX_PAGESIZE)
654 #define DOOR_GFX_PAGEX7 (6 * DOOR_GFX_PAGESIZE)
655 #define DOOR_GFX_PAGEX8 (7 * DOOR_GFX_PAGESIZE)
656 #define DOOR_GFX_PAGEY1 (0)
657 #define DOOR_GFX_PAGEY2 (DOOR_GFX_PAGE_HEIGHT)
660 /* macros for version handling */
661 #define VERSION_PART_1(x) ((x) / 1000000)
662 #define VERSION_PART_2(x) (((x) % 1000000) / 10000)
663 #define VERSION_PART_3(x) (((x) % 10000) / 100)
664 #define VERSION_PART_4(x) ((x) % 100)
666 #define VERSION_SUPER(x) VERSION_PART_1(x)
667 #define VERSION_MAJOR(x) VERSION_PART_2(x)
668 #define VERSION_MINOR(x) VERSION_PART_3(x)
669 #define VERSION_PATCH(x) VERSION_PART_4(x)
670 #define VERSION_IDENT(a,b,c,d) ((a) * 1000000 + (b) * 10000 + (c) * 100 + (d))
673 /* macros for parent/child process identification */
674 #if defined(PLATFORM_UNIX)
675 #define IS_PARENT_PROCESS() (audio.mixer_pid != getpid())
676 #define IS_CHILD_PROCESS() (audio.mixer_pid == getpid())
677 #define HAS_CHILD_PROCESS() (audio.mixer_pid > 0)
679 #define IS_PARENT_PROCESS() TRUE
680 #define IS_CHILD_PROCESS() FALSE
681 #define HAS_CHILD_PROCESS() FALSE
685 /* values for artwork type */
686 #define ARTWORK_TYPE_GRAPHICS 0
687 #define ARTWORK_TYPE_SOUNDS 1
688 #define ARTWORK_TYPE_MUSIC 2
690 #define NUM_ARTWORK_TYPES 3
693 /* values for tree type (chosen to match artwork type) */
694 #define TREE_TYPE_UNDEFINED -1
695 #define TREE_TYPE_GRAPHICS_DIR ARTWORK_TYPE_GRAPHICS
696 #define TREE_TYPE_SOUNDS_DIR ARTWORK_TYPE_SOUNDS
697 #define TREE_TYPE_MUSIC_DIR ARTWORK_TYPE_MUSIC
698 #define TREE_TYPE_LEVEL_DIR 3
699 #define TREE_TYPE_LEVEL_NR 4
701 #define NUM_TREE_TYPES 5
703 #define INFOTEXT_UNDEFINED ""
704 #define INFOTEXT_GRAPHICS_DIR "Custom Graphics"
705 #define INFOTEXT_SOUNDS_DIR "Custom Sounds"
706 #define INFOTEXT_MUSIC_DIR "Custom Music"
707 #define INFOTEXT_LEVEL_DIR "Level Sets"
708 #define INFOTEXT_LEVEL_NR "Levels"
710 #define TREE_INFOTEXT(t) ((t) == TREE_TYPE_LEVEL_NR ? \
711 INFOTEXT_LEVEL_NR : \
712 (t) == TREE_TYPE_LEVEL_DIR ? \
713 INFOTEXT_LEVEL_DIR : \
714 (t) == TREE_TYPE_GRAPHICS_DIR ? \
715 INFOTEXT_GRAPHICS_DIR : \
716 (t) == TREE_TYPE_SOUNDS_DIR ? \
717 INFOTEXT_SOUNDS_DIR : \
718 (t) == TREE_TYPE_MUSIC_DIR ? \
719 INFOTEXT_MUSIC_DIR : \
722 /* values for artwork handling */
723 #define LEVELDIR_ARTWORK_SET_PTR(leveldir, type) \
724 ((type) == ARTWORK_TYPE_GRAPHICS ? \
725 &(leveldir)->graphics_set : \
726 (type) == ARTWORK_TYPE_SOUNDS ? \
727 &(leveldir)->sounds_set : \
728 &(leveldir)->music_set)
730 #define LEVELDIR_ARTWORK_SET(leveldir, type) \
731 ((type) == ARTWORK_TYPE_GRAPHICS ? \
732 (leveldir)->graphics_set : \
733 (type) == ARTWORK_TYPE_SOUNDS ? \
734 (leveldir)->sounds_set : \
735 (leveldir)->music_set)
737 #define LEVELDIR_ARTWORK_PATH_PTR(leveldir, type) \
738 ((type) == ARTWORK_TYPE_GRAPHICS ? \
739 &(leveldir)->graphics_path : \
740 (type) == ARTWORK_TYPE_SOUNDS ? \
741 &(leveldir)->sounds_path : \
742 &(leveldir)->music_path)
744 #define LEVELDIR_ARTWORK_PATH(leveldir, type) \
745 ((type) == ARTWORK_TYPE_GRAPHICS ? \
746 (leveldir)->graphics_path : \
747 (type) == ARTWORK_TYPE_SOUNDS ? \
748 (leveldir)->sounds_path : \
749 (leveldir)->music_path)
751 #define SETUP_ARTWORK_SET(setup, type) \
752 ((type) == ARTWORK_TYPE_GRAPHICS ? \
753 (setup).graphics_set : \
754 (type) == ARTWORK_TYPE_SOUNDS ? \
755 (setup).sounds_set : \
758 #define SETUP_OVERRIDE_ARTWORK(setup, type) \
759 ((type) == ARTWORK_TYPE_GRAPHICS ? \
760 (setup).override_level_graphics : \
761 (type) == ARTWORK_TYPE_SOUNDS ? \
762 (setup).override_level_sounds : \
763 (setup).override_level_music)
765 #define GFX_OVERRIDE_ARTWORK(type) \
766 ((type) == ARTWORK_TYPE_GRAPHICS ? \
767 gfx.override_level_graphics : \
768 (type) == ARTWORK_TYPE_SOUNDS ? \
769 gfx.override_level_sounds : \
770 gfx.override_level_music)
772 #define ARTWORK_FIRST_NODE(artwork, type) \
773 ((type) == ARTWORK_TYPE_GRAPHICS ? \
774 (artwork).gfx_first : \
775 (type) == ARTWORK_TYPE_SOUNDS ? \
776 (artwork).snd_first : \
779 #define ARTWORK_CURRENT_IDENTIFIER_PTR(artwork, type) \
780 ((type) == ARTWORK_TYPE_GRAPHICS ? \
781 &(artwork).gfx_current_identifier : \
782 (type) == ARTWORK_TYPE_SOUNDS ? \
783 &(artwork).snd_current_identifier : \
784 &(artwork).mus_current_identifier)
786 #define ARTWORK_CURRENT_IDENTIFIER(artwork, type) \
787 ((type) == ARTWORK_TYPE_GRAPHICS ? \
788 (artwork).gfx_current_identifier : \
789 (type) == ARTWORK_TYPE_SOUNDS ? \
790 (artwork).snd_current_identifier : \
791 (artwork).mus_current_identifier)
793 #define ARTWORKINFO_FILENAME(type) \
794 ((type) == ARTWORK_TYPE_GRAPHICS ? \
795 GRAPHICSINFO_FILENAME : \
796 (type) == ARTWORK_TYPE_SOUNDS ? \
797 SOUNDSINFO_FILENAME : \
798 (type) == ARTWORK_TYPE_MUSIC ? \
799 MUSICINFO_FILENAME : "")
801 #define ARTWORK_DIRECTORY(type) \
802 ((type) == ARTWORK_TYPE_GRAPHICS ? \
803 GRAPHICS_DIRECTORY : \
804 (type) == ARTWORK_TYPE_SOUNDS ? \
806 (type) == ARTWORK_TYPE_MUSIC ? \
807 MUSIC_DIRECTORY : "")
809 #define OPTIONS_ARTWORK_DIRECTORY(type) \
810 ((type) == ARTWORK_TYPE_GRAPHICS ? \
811 options.graphics_directory : \
812 (type) == ARTWORK_TYPE_SOUNDS ? \
813 options.sounds_directory : \
814 (type) == ARTWORK_TYPE_MUSIC ? \
815 options.music_directory : "")
817 #define UPDATE_BUSY_STATE() \
819 if (gfx.draw_busy_anim_function != NULL) \
820 gfx.draw_busy_anim_function(); \
824 /* structure definitions */
828 char *command_basepath; /* path to the program binary */
829 char *command_basename; /* base filename of the program binary */
831 char *config_filename; /* optional global program config filename */
833 char *maindata_path; /* main game data (installation) directory */
835 char *userdata_subdir; /* personal user game data directory */
836 char *userdata_path; /* resulting full path to game data directory */
846 char *log_filename[NUM_LOGS]; /* log filenames for out/err messages */
847 FILE *log_file[NUM_LOGS]; /* log file handles for out/err files */
848 FILE *log_file_default[NUM_LOGS]; /* default log file handles (out/err) */
856 char *version_string;
858 char *(*window_title_function)(void);
859 void (*exit_message_function)(char *, va_list);
860 void (*exit_function)(int);
862 boolean global_scores;
863 boolean many_scores_per_name;
884 char *ro_base_directory;
885 char *rw_base_directory;
886 char *level_directory;
887 char *graphics_directory;
888 char *sounds_directory;
889 char *music_directory;
890 char *docs_directory;
891 char *conf_directory;
893 char *execute_command;
904 struct VideoSystemInfo
907 int width, height, depth;
908 int window_width, window_height;
909 int display_width, display_height;
910 int screen_width, screen_height;
911 int screen_xoffset, screen_yoffset;
913 boolean fullscreen_available;
914 boolean fullscreen_enabled;
915 boolean fullscreen_initial;
917 boolean window_scaling_available;
918 int window_scaling_percent;
919 char *window_scaling_quality;
920 int screen_rendering_mode;
922 unsigned int frame_delay;
923 unsigned int frame_delay_value;
927 int shifted_up_pos_last;
928 unsigned int shifted_up_delay;
929 unsigned int shifted_up_delay_value;
934 struct AudioSystemInfo
936 boolean sound_available;
937 boolean loops_available;
938 boolean music_available;
940 boolean sound_enabled;
941 boolean sound_deactivated; /* for temporarily disabling sound */
950 int first_sound_channel;
953 struct FontBitmapInfo
957 int src_x, src_y; /* start position of font characters */
958 int width, height; /* width / height of font characters */
960 int offset_x; /* offset to next font character */
961 int offset_y; /* offset to next font character */
963 int draw_xoffset; /* offset for drawing font characters */
964 int draw_yoffset; /* offset for drawing font characters */
967 int num_chars_per_line;
974 int real_sx, real_sy;
975 int full_sxsize, full_sysize;
976 int scrollbuffer_width, scrollbuffer_height;
978 int game_tile_size, standard_tile_size;
989 int win_xsize, win_ysize;
991 int draw_deactivation_mask;
992 int draw_background_mask;
994 Bitmap *field_save_buffer;
996 Bitmap *background_bitmap;
997 int background_bitmap_mask;
999 Bitmap *fade_bitmap_backup;
1000 Bitmap *fade_bitmap_source;
1001 Bitmap *fade_bitmap_target;
1002 Bitmap *fade_bitmap_black;
1004 int fade_border_source_status;
1005 int fade_border_target_status;
1006 Bitmap *masked_border_bitmap_ptr;
1008 Bitmap *final_screen_bitmap;
1010 boolean clipping_enabled;
1012 int clip_width, clip_height;
1014 boolean override_level_graphics;
1015 boolean override_level_sounds;
1016 boolean override_level_music;
1018 boolean draw_init_text;
1021 struct FontBitmapInfo *font_bitmap_info;
1022 int (*select_font_function)(int);
1023 int (*get_font_from_token_function)(char *);
1025 int anim_random_frame;
1027 void (*draw_busy_anim_function)(void);
1028 void (*draw_global_anim_function)(int, int);
1029 void (*draw_global_border_function)(int);
1030 void (*draw_tile_cursor_function)(int);
1035 struct TileCursorInfo
1037 boolean enabled; /* tile cursor generally enabled or disabled */
1038 boolean active; /* tile cursor activated (depending on game) */
1039 boolean moving; /* tile cursor moving to target position */
1041 int xpos, ypos; /* tile cursor level playfield position */
1042 int x, y; /* tile cursor current screen position */
1043 int target_x, target_y; /* tile cursor target screen position */
1045 int sx, sy; /* tile cursor screen start position */
1050 boolean enabled; /* overlay generally enabled or disabled */
1051 boolean active; /* overlay activated (depending on game mode) */
1058 char grid_button[MAX_GRID_XSIZE][MAX_GRID_YSIZE];
1059 char grid_button_highlight;
1061 int grid_button_action;
1067 int nr[MAX_PLAYERS]; /* joystick number for each player */
1070 struct SetupJoystickInfo
1072 char *device_name; /* device name of player's joystick */
1074 int xleft, xmiddle, xright;
1075 int yupper, ymiddle, ylower;
1079 struct SetupKeyboardInfo
1081 Key left, right, up, down;
1085 struct SetupTouchInfo
1094 char grid_button[2][MAX_GRID_XSIZE][MAX_GRID_YSIZE];
1096 int transparency; /* in percent (0 == opaque, 100 == invisible) */
1097 boolean draw_outlined;
1098 boolean draw_pressed;
1100 boolean grid_initialized;
1103 struct SetupInputInfo
1105 boolean use_joystick;
1106 struct SetupJoystickInfo joy;
1107 struct SetupKeyboardInfo key;
1110 struct SetupEditorInfo
1112 boolean el_boulderdash;
1113 boolean el_emerald_mine;
1114 boolean el_emerald_mine_club;
1117 boolean el_supaplex;
1118 boolean el_diamond_caves;
1119 boolean el_dx_boulderdash;
1121 boolean el_mirror_magic;
1122 boolean el_deflektor;
1125 boolean el_steel_chars;
1129 boolean el_user_defined;
1132 boolean el_headlines;
1137 boolean show_element_token;
1139 boolean use_template_for_new_levels;
1142 struct SetupAutoSetupInfo
1144 int editor_zoom_tilesize;
1147 struct SetupEditorCascadeInfo
1160 boolean el_steel_chars;
1168 struct SetupShortcutInfo
1174 Key focus_player[MAX_PLAYERS];
1175 Key focus_player_all;
1194 struct SetupSystemInfo
1196 char *sdl_videodriver;
1197 char *sdl_audiodriver;
1198 int audio_fragment_size;
1201 struct SetupInternalInfo
1203 char *program_title;
1204 char *program_version;
1205 char *program_author;
1206 char *program_email;
1207 char *program_website;
1208 char *program_copyright;
1209 char *program_company;
1211 char *program_icon_file;
1213 char *default_graphics_set;
1214 char *default_sounds_set;
1215 char *default_music_set;
1217 char *fallback_graphics_file;
1218 char *fallback_sounds_file;
1219 char *fallback_music_file;
1221 char *default_level_series;
1223 int default_window_width;
1224 int default_window_height;
1226 boolean choose_from_top_leveldir;
1227 boolean show_scaling_in_title;
1230 struct SetupDebugInfo
1232 int frame_delay[10];
1233 Key frame_delay_key[10];
1234 boolean frame_delay_use_mod_key;
1235 boolean frame_delay_game_only;
1236 boolean show_frames_per_second;
1244 boolean sound_loops;
1245 boolean sound_music;
1246 boolean sound_simple;
1248 boolean scroll_delay;
1249 boolean scroll_delay_value;
1250 char *engine_snapshot_mode;
1251 int engine_snapshot_memory;
1252 boolean fade_screens;
1254 boolean show_titlescreen;
1255 boolean quick_doors;
1258 boolean skip_levels;
1259 boolean increment_levels;
1260 boolean auto_play_next_level;
1261 boolean skip_scores_after_game;
1264 int window_scaling_percent;
1265 char *window_scaling_quality;
1266 char *screen_rendering_mode;
1267 boolean ask_on_escape;
1268 boolean ask_on_escape_editor;
1269 boolean quick_switch;
1270 boolean input_on_focus;
1271 boolean prefer_aga_graphics;
1272 int game_frame_delay;
1273 boolean sp_show_border_elements;
1274 boolean small_game_graphics;
1275 boolean show_snapshot_buttons;
1280 int override_level_graphics; /* not boolean -- can also be "AUTO" */
1281 int override_level_sounds; /* not boolean -- can also be "AUTO" */
1282 int override_level_music; /* not boolean -- can also be "AUTO" */
1288 boolean network_mode;
1289 int network_player_nr;
1291 struct SetupAutoSetupInfo auto_setup;
1292 struct SetupEditorInfo editor;
1293 struct SetupEditorCascadeInfo editor_cascade;
1294 struct SetupShortcutInfo shortcut;
1295 struct SetupInputInfo input[MAX_PLAYERS];
1296 struct SetupTouchInfo touch;
1297 struct SetupSystemInfo system;
1298 struct SetupInternalInfo internal;
1299 struct SetupDebugInfo debug;
1301 struct OptionInfo options;
1306 struct TreeInfo **node_top; /* topmost node in tree */
1307 struct TreeInfo *node_parent; /* parent level directory info */
1308 struct TreeInfo *node_group; /* level group sub-directory info */
1309 struct TreeInfo *next; /* next level series structure node */
1311 int cl_first; /* internal control field for setup screen */
1312 int cl_cursor; /* internal control field for setup screen */
1314 int type; /* type of tree content */
1316 /* fields for "type == TREE_TYPE_LEVEL_DIR" */
1318 char *subdir; /* tree info sub-directory basename (may be ".") */
1319 char *fullpath; /* complete path relative to tree base directory */
1320 char *basepath; /* absolute base path of tree base directory */
1321 char *identifier; /* identifier string for configuration files */
1322 char *name; /* tree info name, as displayed in selection menues */
1323 char *name_sorting; /* optional sorting name for correct name sorting */
1324 char *author; /* level or artwork author name */
1325 char *year; /* optional year of creation for levels or artwork */
1327 char *program_title; /* optional alternative text for program title */
1328 char *program_copyright; /* optional alternative text for program copyright */
1329 char *program_company; /* optional alternative text for program company */
1331 char *imported_from; /* optional comment for imported levels or artwork */
1332 char *imported_by; /* optional comment for imported levels or artwork */
1333 char *tested_by; /* optional comment to name people who tested a set */
1335 char *graphics_set_ecs; /* special EMC custom graphics set (ECS graphics) */
1336 char *graphics_set_aga; /* special EMC custom graphics set (AGA graphics) */
1337 char *graphics_set; /* optional custom graphics set (level tree only) */
1338 char *sounds_set; /* optional custom sounds set (level tree only) */
1339 char *music_set; /* optional custom music set (level tree only) */
1340 char *graphics_path; /* path to optional custom graphics set (level only) */
1341 char *sounds_path; /* path to optional custom sounds set (level only) */
1342 char *music_path; /* path to optional custom music set (level only) */
1344 char *level_filename; /* filename of level file (for packed level file) */
1345 char *level_filetype; /* type of levels in level directory or level file */
1347 char *special_flags; /* flags for special actions performed on level file */
1349 int levels; /* number of levels in level series */
1350 int first_level; /* first level number (to allow start with 0 or 1) */
1351 int last_level; /* last level number (automatically calculated) */
1352 int sort_priority; /* sort levels by 'sort_priority' and then by name */
1354 boolean latest_engine;/* force level set to use the latest game engine */
1356 boolean level_group; /* directory contains more level series directories */
1357 boolean parent_link; /* entry links back to parent directory */
1358 boolean in_user_dir; /* user defined levels are stored in home directory */
1359 boolean user_defined; /* levels in user directory and marked as "private" */
1360 boolean readonly; /* readonly levels can not be changed with editor */
1361 boolean handicap; /* level set has no handicap when set to "false" */
1362 boolean skip_levels; /* levels can be skipped when set to "true" */
1364 int color; /* color to use on selection screen for this level */
1365 char *class_desc; /* description of level series class */
1366 int handicap_level; /* number of the lowest unsolved level */
1368 char *infotext; /* optional text to describe the tree type (headline) */
1371 typedef struct TreeInfo TreeInfo;
1372 typedef struct TreeInfo LevelDirTree;
1373 typedef struct TreeInfo ArtworkDirTree;
1374 typedef struct TreeInfo GraphicsDirTree;
1375 typedef struct TreeInfo SoundsDirTree;
1376 typedef struct TreeInfo MusicDirTree;
1380 GraphicsDirTree *gfx_first;
1381 GraphicsDirTree *gfx_current;
1382 SoundsDirTree *snd_first;
1383 SoundsDirTree *snd_current;
1384 MusicDirTree *mus_first;
1385 MusicDirTree *mus_current;
1387 char *gfx_current_identifier;
1388 char *snd_current_identifier;
1389 char *mus_current_identifier;
1392 struct ValueTextInfo
1404 struct ConfigTypeInfo
1411 struct TokenIntPtrInfo
1421 char *default_filename;
1424 char **default_parameter; /* array of file parameters */
1425 char **parameter; /* array of file parameters */
1428 boolean fallback_to_default;
1429 boolean default_is_cloned;
1432 struct SetupFileList
1437 struct SetupFileList *next;
1442 char *source_filename; /* primary key for node list */
1446 struct PropertyMapping
1456 struct ArtworkListInfo
1458 int type; /* type of artwork */
1460 int num_file_list_entries;
1461 int num_dynamic_file_list_entries;
1462 struct FileInfo *file_list; /* static artwork file array */
1463 struct FileInfo *dynamic_file_list; /* dynamic artwrk file array */
1465 int num_suffix_list_entries;
1466 struct ConfigTypeInfo *suffix_list; /* parameter suffixes array */
1468 int num_base_prefixes;
1469 int num_ext1_suffixes;
1470 int num_ext2_suffixes;
1471 int num_ext3_suffixes;
1472 char **base_prefixes; /* base token prefixes array */
1473 char **ext1_suffixes; /* property suffixes array 1 */
1474 char **ext2_suffixes; /* property suffixes array 2 */
1475 char **ext3_suffixes; /* property suffixes array 3 */
1477 int num_ignore_tokens;
1478 char **ignore_tokens; /* file tokens to be ignored */
1480 int num_property_mapping_entries;
1481 struct PropertyMapping *property_mapping; /* mapping token -> artwork */
1483 int sizeof_artwork_list_entry;
1485 struct ListNodeInfo **artwork_list; /* static artwork node array */
1486 struct ListNodeInfo **dynamic_artwork_list; /* dynamic artwrk node array */
1487 struct ListNode *content_list; /* dynamic artwork node list */
1489 void *(*load_artwork)(char *); /* constructor function */
1490 void (*free_artwork)(void *); /* destructor function */
1510 struct RectWithBorder
1524 struct DoorPartPosInfo
1531 int start_step_opening;
1532 int start_step_closing;
1533 boolean draw_masked;
1540 int xoffset; /* special case for tape date and time */
1541 int xoffset2; /* special case for tape date */
1544 int size; /* also used for suffix ".digits" */
1546 boolean draw_masked;
1547 boolean draw_player; /* special case for network player buttons */
1548 int sort_priority; /* also used for suffix ".draw_order" */
1551 int direction; /* needed for panel time/health graphics */
1552 int class; /* needed for panel time/health graphics */
1553 int style; /* needed for panel time/health graphics */
1555 int tile_size; /* special case for list of network players */
1558 struct MouseActionInfo
1572 /* ========================================================================= */
1573 /* exported variables */
1574 /* ========================================================================= */
1576 extern struct ProgramInfo program;
1577 extern struct NetworkInfo network;
1578 extern struct OptionInfo options;
1579 extern struct VideoSystemInfo video;
1580 extern struct AudioSystemInfo audio;
1581 extern struct GfxInfo gfx;
1582 extern struct TileCursorInfo tile_cursor;
1583 extern struct OverlayInfo overlay;
1584 extern struct AnimInfo anim;
1585 extern struct ArtworkInfo artwork;
1586 extern struct JoystickInfo joystick;
1587 extern struct SetupInfo setup;
1589 extern LevelDirTree *leveldir_first_all;
1590 extern LevelDirTree *leveldir_first;
1591 extern LevelDirTree *leveldir_current;
1592 extern int level_nr;
1594 extern struct LevelStats level_stats[];
1596 extern DrawWindow *window;
1597 extern DrawBuffer *backbuffer;
1598 extern DrawBuffer *drawto;
1600 extern int button_status;
1601 extern boolean motion_status;
1602 extern int wheel_steps;
1603 #if defined(TARGET_SDL2)
1604 extern boolean keyrepeat_status;
1607 extern int redraw_mask;
1609 extern int FrameCounter;
1612 /* function definitions */
1614 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
1616 void InitNetworkInfo(boolean, boolean, boolean, char *, int);
1618 void InitScoresInfo();
1619 void SetWindowTitle();
1621 void InitWindowTitleFunction(char *(*window_title_function)(void));
1622 void InitExitMessageFunction(void (*exit_message_function)(char *, va_list));
1623 void InitExitFunction(void (*exit_function)(int));
1624 void InitPlatformDependentStuff(void);
1625 void ClosePlatformDependentStuff(void);
1627 void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
1628 void InitGfxTileSizeInfo(int, int);
1629 void InitGfxDoor1Info(int, int, int, int);
1630 void InitGfxDoor2Info(int, int, int, int);
1631 void InitGfxDoor3Info(int, int, int, int);
1632 void InitGfxWindowInfo(int, int);
1633 void InitGfxScrollbufferInfo(int, int);
1634 void InitGfxClipRegion(boolean, int, int, int, int);
1635 void InitGfxDrawBusyAnimFunction(void (*draw_busy_anim_function)(void));
1636 void InitGfxDrawGlobalAnimFunction(void (*draw_global_anim_function)(int, int));
1637 void InitGfxDrawGlobalBorderFunction(void (*draw_global_border_function)(int));
1638 void InitGfxDrawTileCursorFunction(void (*draw_tile_cursor_function)(int));
1639 void InitGfxCustomArtworkInfo();
1640 void InitGfxOtherSettings();
1641 void InitTileCursorInfo();
1642 void InitOverlayInfo();
1643 void SetTileCursorEnabled(boolean);
1644 void SetTileCursorActive(boolean);
1645 void SetTileCursorTargetXY(int, int);
1646 void SetTileCursorXY(int, int);
1647 void SetTileCursorSXSY(int, int);
1648 void SetOverlayEnabled(boolean);
1649 void SetOverlayActive(boolean);
1650 void SetOverlayShowGrid(boolean);
1651 boolean GetOverlayActive();
1652 void SetDrawDeactivationMask(int);
1653 int GetDrawDeactivationMask(void);
1654 void SetDrawBackgroundMask(int);
1655 void SetWindowBackgroundBitmap(Bitmap *);
1656 void SetMainBackgroundBitmap(Bitmap *);
1657 void SetDoorBackgroundBitmap(Bitmap *);
1658 void SetRedrawMaskFromArea(int, int, int, int);
1660 void LimitScreenUpdates(boolean);
1662 void InitVideoDefaults(void);
1663 void InitVideoDisplay(void);
1664 void CloseVideoDisplay(void);
1665 void InitVideoBuffer(int, int, int, boolean);
1666 Bitmap *CreateBitmapStruct(void);
1667 Bitmap *CreateBitmap(int, int, int);
1668 void ReCreateBitmap(Bitmap **, int, int);
1669 void FreeBitmap(Bitmap *);
1670 void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
1671 void BlitBitmapTiled(Bitmap *, Bitmap *, int, int, int, int, int, int, int,int);
1672 void FadeRectangle(int, int, int, int, int, int, int,
1673 void (*draw_border_function)(void));
1674 void FillRectangle(Bitmap *, int, int, int, int, Pixel);
1675 void ClearRectangle(Bitmap *, int, int, int, int);
1676 void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
1677 void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
1678 boolean DrawingDeactivatedField(void);
1679 boolean DrawingDeactivated(int, int, int, int);
1680 boolean DrawingOnBackground(int, int);
1681 boolean DrawingAreaChanged();
1682 void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int, int);
1683 void BlitTexture(Bitmap *, int, int, int, int, int, int);
1684 void BlitTextureMasked(Bitmap *, int, int, int, int, int, int);
1685 void BlitToScreen(Bitmap *, int, int, int, int, int, int);
1686 void BlitToScreenMasked(Bitmap *, int, int, int, int, int, int);
1687 void DrawSimpleBlackLine(Bitmap *, int, int, int, int);
1688 void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
1689 void DrawLines(Bitmap *, struct XY *, int, Pixel);
1690 Pixel GetPixel(Bitmap *, int, int);
1691 Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
1692 Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
1694 void KeyboardAutoRepeatOn(void);
1695 void KeyboardAutoRepeatOff(void);
1696 boolean SetVideoMode(boolean);
1697 void SetVideoFrameDelay(unsigned int);
1698 unsigned int GetVideoFrameDelay();
1699 boolean ChangeVideoModeIfNeeded(boolean);
1701 Bitmap *LoadImage(char *);
1702 Bitmap *LoadCustomImage(char *);
1703 void ReloadCustomImage(Bitmap *, char *);
1705 void ReCreateGameTileSizeBitmap(Bitmap **);
1706 void CreateBitmapWithSmallBitmaps(Bitmap **, int, int);
1707 void CreateBitmapTextures(Bitmap **);
1708 void FreeBitmapTextures(Bitmap **);
1709 void ScaleBitmap(Bitmap **, int);
1711 void SetMouseCursor(int);
1713 void OpenAudio(void);
1714 void CloseAudio(void);
1715 void SetAudioMode(boolean);
1717 boolean PendingEvent(void);
1718 void WaitEvent(Event *event);
1719 void PeekEvent(Event *event);
1720 void CheckQuitEvent(void);
1721 Key GetEventKey(KeyEvent *, boolean);
1722 KeyMod HandleKeyModState(Key, int);
1723 KeyMod GetKeyModState();
1724 KeyMod GetKeyModStateFromEvents();
1725 void StartTextInput(int, int, int, int);
1726 void StopTextInput();
1727 boolean CheckCloseWindowEvent(ClientMessageEvent *);
1729 void InitJoysticks();
1730 boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
1731 boolean CheckJoystickOpened(int);
1732 void ClearJoystickState();
1734 #endif /* SYSTEM_H */