1 // ============================================================================
2 // Artsoft Retro-Game Library
3 // ----------------------------------------------------------------------------
4 // (c) 1995-2014 by Artsoft Entertainment
7 // http://www.artsoft.org/
8 // ----------------------------------------------------------------------------
10 // ============================================================================
19 #if defined(PLATFORM_MACOSX)
21 #elif defined(PLATFORM_WIN32)
23 #elif defined(PLATFORM_ANDROID)
30 // the additional 'b' is needed for Win32 to open files in binary mode
31 #define MODE_READ "rb"
32 #define MODE_WRITE "wb"
33 #define MODE_APPEND "ab"
35 #define DEFAULT_DEPTH 0
39 #define BLIT_INVERSE 2
40 #define BLIT_ON_BACKGROUND 3
42 // values for fullscreen status
43 #define FULLSCREEN_NOT_AVAILABLE FALSE
44 #define FULLSCREEN_AVAILABLE TRUE
46 // values for window scaling
47 #define WINDOW_SCALING_NOT_AVAILABLE FALSE
48 #define WINDOW_SCALING_AVAILABLE TRUE
50 #define MIN_WINDOW_SCALING_PERCENT 30
51 #define STD_WINDOW_SCALING_PERCENT 100
52 #define MAX_WINDOW_SCALING_PERCENT 400
53 #define STEP_WINDOW_SCALING_PERCENT 10
55 // values for window scaling quality
56 #define SCALING_QUALITY_NEAREST "nearest"
57 #define SCALING_QUALITY_LINEAR "linear"
58 #define SCALING_QUALITY_BEST "best"
60 #define SCALING_QUALITY_DEFAULT SCALING_QUALITY_LINEAR
62 // values for screen rendering mode
63 #define STR_SPECIAL_RENDERING_OFF "stream_texture_only"
64 #define STR_SPECIAL_RENDERING_BITMAP "bitmap_and_stream_texture"
65 #define STR_SPECIAL_RENDERING_TARGET "target_texture_only"
66 #define STR_SPECIAL_RENDERING_DOUBLE "stream_and_target_texture"
68 #define STR_SPECIAL_RENDERING_DEFAULT STR_SPECIAL_RENDERING_DOUBLE
70 #define SPECIAL_RENDERING_OFF 0
71 #define SPECIAL_RENDERING_BITMAP 1
72 #define SPECIAL_RENDERING_TARGET 2
73 #define SPECIAL_RENDERING_DOUBLE 3
75 #define SPECIAL_RENDERING_DEFAULT SPECIAL_RENDERING_DOUBLE
77 // values for vertical screen retrace synchronization (vsync)
78 #define STR_VSYNC_MODE_OFF "off"
79 #define STR_VSYNC_MODE_NORMAL "normal"
80 #define STR_VSYNC_MODE_ADAPTIVE "adaptive"
82 #define STR_VSYNC_MODE_DEFAULT STR_VSYNC_MODE_OFF
84 #define VSYNC_MODE_OFF 0
85 #define VSYNC_MODE_NORMAL 1
86 #define VSYNC_MODE_ADAPTIVE -1
88 #define VSYNC_MODE_DEFAULT VSYNC_MODE_OFF
90 // values for network server settings
91 #define STR_NETWORK_AUTO_DETECT "auto_detect_network_server"
92 #define STR_NETWORK_AUTO_DETECT_SETUP "(auto detect network server)"
94 // values for touch control
95 #define TOUCH_CONTROL_OFF "off"
96 #define TOUCH_CONTROL_VIRTUAL_BUTTONS "virtual_buttons"
97 #define TOUCH_CONTROL_WIPE_GESTURES "wipe_gestures"
98 #define TOUCH_CONTROL_FOLLOW_FINGER "follow_finger"
100 #if defined(PLATFORM_ANDROID)
101 #define TOUCH_CONTROL_DEFAULT TOUCH_CONTROL_VIRTUAL_BUTTONS
103 #define TOUCH_CONTROL_DEFAULT TOUCH_CONTROL_OFF
106 #define TOUCH_MOVE_DISTANCE_DEFAULT 2
107 #define TOUCH_DROP_DISTANCE_DEFAULT 5
108 #define TOUCH_TRANSPARENCY_DEFAULT 50
110 #define ALPHA_FROM_TRANSPARENCY(x) ((100 - x) * SDL_ALPHA_OPAQUE / 100)
111 #define ALPHA_FADING_STEPSIZE(x) ((x) / 25)
113 // values for special settings for mobile devices
114 #if defined(PLATFORM_ANDROID)
115 #define USE_TOUCH_INPUT_OVERLAY
116 #define USE_COMPLETE_DISPLAY
117 #define HAS_SCREEN_KEYBOARD
118 #define SCREEN_KEYBOARD_POS(h) ((h) / 2)
121 // values for drag-and-drop support (some parts not added before SDL 2.0.5)
122 #if !SDL_VERSION_ATLEAST(2,0,5)
123 #define SDL_DROPTEXT (SDL_DROPFILE + 1)
124 #define SDL_DROPBEGIN (SDL_DROPFILE + 2)
125 #define SDL_DROPCOMPLETE (SDL_DROPFILE + 3)
128 // default input keys
129 #define DEFAULT_KEY_LEFT KSYM_Left
130 #define DEFAULT_KEY_RIGHT KSYM_Right
131 #define DEFAULT_KEY_UP KSYM_Up
132 #define DEFAULT_KEY_DOWN KSYM_Down
133 #if defined(PLATFORM_MACOSX)
134 #define DEFAULT_KEY_SNAP KSYM_Control_L
135 #define DEFAULT_KEY_DROP KSYM_KP_Enter
137 #define DEFAULT_KEY_SNAP KSYM_Control_L
138 #define DEFAULT_KEY_DROP KSYM_Control_R
140 #define DEFAULT_KEY_OKAY KSYM_Return
141 #define DEFAULT_KEY_CANCEL KSYM_Escape
143 // default shortcut keys
144 #define DEFAULT_KEY_SAVE_GAME KSYM_F1
145 #define DEFAULT_KEY_LOAD_GAME KSYM_F2
146 #define DEFAULT_KEY_TOGGLE_PAUSE KSYM_space
147 #define DEFAULT_KEY_FOCUS_PLAYER_1 KSYM_F5
148 #define DEFAULT_KEY_FOCUS_PLAYER_2 KSYM_F6
149 #define DEFAULT_KEY_FOCUS_PLAYER_3 KSYM_F7
150 #define DEFAULT_KEY_FOCUS_PLAYER_4 KSYM_F8
151 #define DEFAULT_KEY_FOCUS_PLAYER_ALL KSYM_F9
152 #define DEFAULT_KEY_TAPE_EJECT KSYM_UNDEFINED
153 #define DEFAULT_KEY_TAPE_EXTRA KSYM_UNDEFINED
154 #define DEFAULT_KEY_TAPE_STOP KSYM_UNDEFINED
155 #define DEFAULT_KEY_TAPE_PAUSE KSYM_UNDEFINED
156 #define DEFAULT_KEY_TAPE_RECORD KSYM_UNDEFINED
157 #define DEFAULT_KEY_TAPE_PLAY KSYM_UNDEFINED
158 #define DEFAULT_KEY_SOUND_SIMPLE KSYM_UNDEFINED
159 #define DEFAULT_KEY_SOUND_LOOPS KSYM_UNDEFINED
160 #define DEFAULT_KEY_SOUND_MUSIC KSYM_UNDEFINED
161 #define DEFAULT_KEY_SNAP_LEFT KSYM_UNDEFINED
162 #define DEFAULT_KEY_SNAP_RIGHT KSYM_UNDEFINED
163 #define DEFAULT_KEY_SNAP_UP KSYM_UNDEFINED
164 #define DEFAULT_KEY_SNAP_DOWN KSYM_UNDEFINED
166 // default debug setup keys and values
167 #define DEFAULT_FRAME_DELAY_0 20 // 100 % speed
168 #define DEFAULT_FRAME_DELAY_1 500 // 4 % speed
169 #define DEFAULT_FRAME_DELAY_2 250 // 8 % speed
170 #define DEFAULT_FRAME_DELAY_3 125 // 16 % speed
171 #define DEFAULT_FRAME_DELAY_4 60 // 33 % speed
172 #define DEFAULT_FRAME_DELAY_5 40 // 50 % speed
173 #define DEFAULT_FRAME_DELAY_6 30 // 66 % speed
174 #define DEFAULT_FRAME_DELAY_7 10 // 200 % speed
175 #define DEFAULT_FRAME_DELAY_8 5 // 400 % speed
176 #define DEFAULT_FRAME_DELAY_9 0 // maximum speed
178 #define DEFAULT_KEY_FRAME_DELAY_0 KSYM_0
179 #define DEFAULT_KEY_FRAME_DELAY_1 KSYM_1
180 #define DEFAULT_KEY_FRAME_DELAY_2 KSYM_2
181 #define DEFAULT_KEY_FRAME_DELAY_3 KSYM_3
182 #define DEFAULT_KEY_FRAME_DELAY_4 KSYM_4
183 #define DEFAULT_KEY_FRAME_DELAY_5 KSYM_5
184 #define DEFAULT_KEY_FRAME_DELAY_6 KSYM_6
185 #define DEFAULT_KEY_FRAME_DELAY_7 KSYM_7
186 #define DEFAULT_KEY_FRAME_DELAY_8 KSYM_8
187 #define DEFAULT_KEY_FRAME_DELAY_9 KSYM_9
189 #define NUM_DEBUG_FRAME_DELAY_KEYS 10
191 #define DEFAULT_FRAME_DELAY_USE_MOD_KEY FALSE
192 #define DEFAULT_FRAME_DELAY_GAME_ONLY TRUE
194 // values for key_status
195 #define KEY_NOT_PRESSED FALSE
196 #define KEY_RELEASED FALSE
197 #define KEY_PRESSED TRUE
199 // values for button status
200 #define MB_NOT_PRESSED FALSE
201 #define MB_NOT_RELEASED TRUE
202 #define MB_RELEASED FALSE
203 #define MB_PRESSED TRUE
204 #define MB_MENU_CHOICE FALSE
205 #define MB_MENU_MARK TRUE
206 #define MB_MENU_INITIALIZE (-1)
207 #define MB_MENU_LEAVE (-2)
208 #define MB_LEFTBUTTON 1
209 #define MB_MIDDLEBUTTON 2
210 #define MB_RIGHTBUTTON 3
211 #define MB_WHEEL_UP 4
212 #define MB_WHEEL_DOWN 5
213 #define MB_WHEEL_LEFT 6
214 #define MB_WHEEL_RIGHT 7
215 #define IS_WHEEL_BUTTON_VERTICAL(b) ((b) == MB_WHEEL_UP || \
216 (b) == MB_WHEEL_DOWN)
217 #define IS_WHEEL_BUTTON_HORIZONTAL(b) ((b) == MB_WHEEL_LEFT || \
218 (b) == MB_WHEEL_RIGHT)
219 #define IS_WHEEL_BUTTON(b) (IS_WHEEL_BUTTON_VERTICAL(b) || \
220 IS_WHEEL_BUTTON_HORIZONTAL(b))
221 #define DEFAULT_WHEEL_STEPS 3
223 #define BUTTON_STEPSIZE(b) ((b) == MB_LEFTBUTTON ? 1 : \
224 (b) == MB_MIDDLEBUTTON ? 5 : \
225 (b) == MB_RIGHTBUTTON ? 10 : 1)
227 // values for move directions
228 #define MV_BIT_LEFT 0
229 #define MV_BIT_RIGHT 1
231 #define MV_BIT_DOWN 3
233 #define NUM_DIRECTIONS 4
235 // diagonal movement directions are used in a different contect than buttons
236 #define MV_BIT_UPLEFT 4
237 #define MV_BIT_UPRIGHT 5
238 #define MV_BIT_DOWNLEFT 6
239 #define MV_BIT_DOWNRIGHT 7
241 #define NUM_DIRECTIONS_FULL 8
243 // values for special "button" bitmasks
247 #define NUM_PLAYER_ACTIONS 6
249 // values for special "focus player" bitmasks
250 #define BIT_SET_FOCUS 6
252 // values for drawing stages for global animations
253 #define DRAW_GLOBAL_ANIM_STAGE_1 1
254 #define DRAW_GLOBAL_ANIM_STAGE_2 2
256 // values for drawing target (various functions)
257 #define DRAW_TO_BACKBUFFER 0
258 #define DRAW_TO_FIELDBUFFER 1
259 #define DRAW_TO_SCREEN 2
260 #define DRAW_TO_FADE_SOURCE 3
261 #define DRAW_TO_FADE_TARGET 4
263 // values for move directions and special "button" key bitmasks
265 #define MV_LEFT (1 << MV_BIT_LEFT)
266 #define MV_RIGHT (1 << MV_BIT_RIGHT)
267 #define MV_UP (1 << MV_BIT_UP)
268 #define MV_DOWN (1 << MV_BIT_DOWN)
270 #define MV_UPLEFT (MV_UP | MV_LEFT)
271 #define MV_UPRIGHT (MV_UP | MV_RIGHT)
272 #define MV_DOWNLEFT (MV_DOWN | MV_LEFT)
273 #define MV_DOWNRIGHT (MV_DOWN | MV_RIGHT)
275 #define MV_HORIZONTAL (MV_LEFT | MV_RIGHT)
276 #define MV_VERTICAL (MV_UP | MV_DOWN)
277 #define MV_ALL_DIRECTIONS (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
278 #define MV_ANY_DIRECTION (MV_ALL_DIRECTIONS)
279 #define MV_NO_DIRECTION (MV_NONE)
281 #define KEY_BUTTON_1 (1 << BUTTON_1)
282 #define KEY_BUTTON_2 (1 << BUTTON_2)
283 #define KEY_BUTTON_SNAP KEY_BUTTON_1
284 #define KEY_BUTTON_DROP KEY_BUTTON_2
285 #define KEY_MOTION (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
286 #define KEY_BUTTON (KEY_BUTTON_1 | KEY_BUTTON_2)
287 #define KEY_ACTION (KEY_MOTION | KEY_BUTTON)
289 #define KEY_SET_FOCUS (1 << BIT_SET_FOCUS)
291 #define MV_DIR_FROM_BIT(x) ((x) < NUM_DIRECTIONS ? 1 << (x) : \
292 (x) == MV_BIT_UPLEFT ? MV_UPLEFT : \
293 (x) == MV_BIT_UPRIGHT ? MV_UPRIGHT : \
294 (x) == MV_BIT_DOWNLEFT ? MV_DOWNLEFT : \
295 (x) == MV_BIT_DOWNRIGHT ? MV_DOWNRIGHT : \
298 #define MV_DIR_TO_BIT(x) ((x) == MV_LEFT ? MV_BIT_LEFT : \
299 (x) == MV_RIGHT ? MV_BIT_RIGHT : \
300 (x) == MV_UP ? MV_BIT_UP : \
301 (x) == MV_DOWN ? MV_BIT_DOWN : \
302 (x) == MV_UPLEFT ? MV_BIT_UPLEFT : \
303 (x) == MV_UPRIGHT ? MV_BIT_UPRIGHT : \
304 (x) == MV_DOWNLEFT ? MV_BIT_DOWNLEFT : \
305 (x) == MV_DOWNRIGHT ? MV_BIT_DOWNRIGHT : \
308 #define MV_DIR_OPPOSITE(x) ((x) == MV_LEFT ? MV_RIGHT : \
309 (x) == MV_RIGHT ? MV_LEFT : \
310 (x) == MV_UP ? MV_DOWN : \
311 (x) == MV_DOWN ? MV_UP : \
312 (x) == MV_UPLEFT ? MV_DOWNRIGHT : \
313 (x) == MV_UPRIGHT ? MV_DOWNLEFT : \
314 (x) == MV_DOWNLEFT ? MV_UPRIGHT : \
315 (x) == MV_DOWNRIGHT ? MV_UPLEFT : \
318 // values for animation mode (frame order and direction)
319 // (stored in level files -- never change existing values)
321 #define ANIM_LOOP (1 << 0)
322 #define ANIM_LINEAR (1 << 1)
323 #define ANIM_PINGPONG (1 << 2)
324 #define ANIM_PINGPONG2 (1 << 3)
325 #define ANIM_RANDOM (1 << 4)
326 #define ANIM_CE_VALUE (1 << 5)
327 #define ANIM_CE_SCORE (1 << 6)
328 #define ANIM_CE_DELAY (1 << 7)
329 #define ANIM_REVERSE (1 << 8)
330 #define ANIM_OPAQUE_PLAYER (1 << 9)
332 // values for special (non game element) animation modes
333 // (not stored in level files -- can be changed, if needed)
334 #define ANIM_HORIZONTAL (1 << 10)
335 #define ANIM_VERTICAL (1 << 11)
336 #define ANIM_CENTERED (1 << 12)
337 #define ANIM_STATIC_PANEL (1 << 13)
338 #define ANIM_ALL (1 << 14)
339 #define ANIM_ONCE (1 << 15)
341 #define ANIM_DEFAULT ANIM_LOOP
343 // values for special drawing styles (currently only for crumbled graphics)
345 #define STYLE_ACCURATE_BORDERS (1 << 0)
346 #define STYLE_INNER_CORNERS (1 << 1)
347 #define STYLE_REVERSE (1 << 2)
349 // values for special event handling style (used for global animation)
350 #define STYLE_PASSTHROUGH (1 << 3)
351 #define STYLE_MULTIPLE_ACTIONS (1 << 4)
353 #define STYLE_DEFAULT STYLE_NONE
355 // values for special global animation events
356 #define ANIM_EVENT_UNDEFINED -1
357 #define ANIM_EVENT_NONE 0
358 #define ANIM_EVENT_SELF (1 << 16)
359 #define ANIM_EVENT_ANY (1 << 17)
360 #define ANIM_EVENT_CLICK (1 << 18)
362 // anim number: bits 0-7
363 // part number: bits 8-15
364 #define ANIM_EVENT_ANIM_BIT 0
365 #define ANIM_EVENT_PART_BIT 8
367 #define ANIM_EVENT_ANIM_MASK (0xff << ANIM_EVENT_ANIM_BIT)
368 #define ANIM_EVENT_PART_MASK (0xff << ANIM_EVENT_PART_BIT)
370 #define ANIM_EVENT_DEFAULT ANIM_EVENT_NONE
372 // values for special global animation event actions
373 #define ANIM_EVENT_ACTION_NONE -1
375 // values for fade mode
376 #define FADE_TYPE_NONE 0
377 #define FADE_TYPE_FADE_IN (1 << 0)
378 #define FADE_TYPE_FADE_OUT (1 << 1)
379 #define FADE_TYPE_TRANSFORM (1 << 2)
380 #define FADE_TYPE_CROSSFADE (1 << 3)
381 #define FADE_TYPE_MELT (1 << 4)
382 #define FADE_TYPE_CURTAIN (1 << 5)
383 #define FADE_TYPE_SKIP (1 << 6)
385 #define FADE_MODE_NONE (FADE_TYPE_NONE)
386 #define FADE_MODE_FADE_IN (FADE_TYPE_FADE_IN)
387 #define FADE_MODE_FADE_OUT (FADE_TYPE_FADE_OUT)
388 #define FADE_MODE_FADE (FADE_TYPE_FADE_IN | FADE_TYPE_FADE_OUT)
389 #define FADE_MODE_TRANSFORM (FADE_TYPE_TRANSFORM | FADE_TYPE_FADE_IN)
390 #define FADE_MODE_CROSSFADE (FADE_MODE_TRANSFORM | FADE_TYPE_CROSSFADE)
391 #define FADE_MODE_MELT (FADE_MODE_TRANSFORM | FADE_TYPE_MELT)
392 #define FADE_MODE_CURTAIN (FADE_MODE_TRANSFORM | FADE_TYPE_CURTAIN)
393 #define FADE_MODE_SKIP_FADE_IN (FADE_TYPE_SKIP | FADE_TYPE_FADE_IN)
394 #define FADE_MODE_SKIP_FADE_OUT (FADE_TYPE_SKIP | FADE_TYPE_FADE_OUT)
396 #define FADE_MODE_DEFAULT FADE_MODE_FADE
398 // values for toon positions
399 #define POS_UNDEFINED -1
410 // values for text alignment
411 #define ALIGN_LEFT (1 << 0)
412 #define ALIGN_RIGHT (1 << 1)
413 #define ALIGN_CENTER (1 << 2)
414 #define ALIGN_DEFAULT ALIGN_LEFT
416 #define VALIGN_TOP (1 << 0)
417 #define VALIGN_BOTTOM (1 << 1)
418 #define VALIGN_MIDDLE (1 << 2)
419 #define VALIGN_DEFAULT VALIGN_TOP
421 #define ALIGNED_XPOS(x,w,a) ((a) == ALIGN_CENTER ? (x) - (w) / 2 : \
422 (a) == ALIGN_RIGHT ? (x) - (w) : (x))
423 #define ALIGNED_YPOS(y,h,v) ((v) == VALIGN_MIDDLE ? (y) - (h) / 2 : \
424 (v) == VALIGN_BOTTOM ? (y) - (h) : (y))
425 #define ALIGNED_TEXT_XPOS(p) ALIGNED_XPOS((p)->x, (p)->width, (p)->align)
426 #define ALIGNED_TEXT_YPOS(p) ALIGNED_YPOS((p)->y, (p)->height, (p)->valign)
427 #define ALIGNED_VP_XPOS(p) ALIGNED_TEXT_XPOS(p)
428 #define ALIGNED_VP_YPOS(p) ALIGNED_TEXT_YPOS(p)
430 // values for redraw_mask
431 #define REDRAW_NONE (0)
432 #define REDRAW_ALL (1 << 0)
433 #define REDRAW_FIELD (1 << 1)
434 #define REDRAW_DOOR_1 (1 << 2)
435 #define REDRAW_DOOR_2 (1 << 3)
436 #define REDRAW_DOOR_3 (1 << 4)
437 #define REDRAW_FPS (1 << 5)
439 #define REDRAW_DOORS (REDRAW_DOOR_1 | \
443 #define IN_GFX_FIELD_PLAY(x, y) (x >= gfx.sx && x < gfx.sx + gfx.sxsize && \
444 y >= gfx.sy && y < gfx.sy + gfx.sysize)
445 #define IN_GFX_FIELD_FULL(x, y) (x >= gfx.real_sx && \
446 x < gfx.real_sx + gfx.full_sxsize && \
447 y >= gfx.real_sy && \
448 y < gfx.real_sy + gfx.full_sysize)
449 #define IN_GFX_DOOR_1(x, y) (x >= gfx.dx && x < gfx.dx + gfx.dxsize && \
450 y >= gfx.dy && y < gfx.dy + gfx.dysize)
451 #define IN_GFX_DOOR_2(x, y) (x >= gfx.vx && x < gfx.vx + gfx.vxsize && \
452 y >= gfx.vy && y < gfx.vy + gfx.vysize)
453 #define IN_GFX_DOOR_3(x, y) (x >= gfx.ex && x < gfx.ex + gfx.exsize && \
454 y >= gfx.ey && y < gfx.ey + gfx.eysize)
456 // values for mouse cursor
457 #define CURSOR_DEFAULT 0
458 #define CURSOR_NONE 1
459 #define CURSOR_PLAYFIELD 2
461 // fundamental game speed values
462 #define ONE_SECOND_DELAY 1000 // delay value for one second
463 #define MENU_FRAME_DELAY 20 // frame delay in milliseconds
464 #define GAME_FRAME_DELAY 20 // frame delay in milliseconds
465 #define FFWD_FRAME_DELAY 10 // 200% speed for fast forward
466 #define MIN_VSYNC_FRAME_DELAY 15 // minimum value for vsync to keep
467 #define MAX_VSYNC_FRAME_DELAY 16 // maximum value for vsync to work
468 #define FRAMES_PER_SECOND (ONE_SECOND_DELAY / GAME_FRAME_DELAY)
469 #define FRAMES_PER_SECOND_SP 35
471 // maximum playfield size supported by libgame functions
472 #define MAX_PLAYFIELD_WIDTH 128
473 #define MAX_PLAYFIELD_HEIGHT 128
475 // maximum number of parallel players supported by libgame functions
476 #define MAX_PLAYERS 4
478 // maximum allowed length of player name
479 #define MAX_PLAYER_NAME_LEN 10
481 // maximum number of levels in a level set
482 #define MAX_LEVELS 1000
484 // maximum number of global animation and parts
485 #define MAX_GLOBAL_ANIMS 32
486 #define MAX_GLOBAL_ANIM_PARTS 32
488 // minimum/maximum/default x/y grid size for virtual buttons
489 #define MIN_GRID_XSIZE 3
490 #define MIN_GRID_YSIZE 3
491 #define MAX_GRID_XSIZE 32
492 #define MAX_GRID_YSIZE 32
493 #define GRID_REAL_WIDTH MAX(1, MAX(video.screen_width, \
494 video.screen_height))
495 #define GRID_REAL_HEIGHT MAX(1, MIN(video.screen_width, \
496 video.screen_height))
497 #define DEFAULT_GRID_XSIZE_0 18
498 #define DEFAULT_GRID_YSIZE_0 MIN(MAX(MIN_GRID_YSIZE, \
499 DEFAULT_GRID_XSIZE_0 * \
503 #define DEFAULT_GRID_XSIZE_1 13
504 #define DEFAULT_GRID_YSIZE_1 MIN(MAX(MIN_GRID_YSIZE, \
505 DEFAULT_GRID_XSIZE_1 * \
510 #define DEFAULT_GRID_XSIZE(n) ((n) == 0 ? DEFAULT_GRID_XSIZE_0 : \
511 DEFAULT_GRID_XSIZE_1)
512 #define DEFAULT_GRID_YSIZE(n) ((n) == 0 ? DEFAULT_GRID_YSIZE_0 : \
513 DEFAULT_GRID_YSIZE_1)
515 #define GRID_ACTIVE_NR() (video.screen_width > \
516 video.screen_height ? 0 : 1)
518 // values for grid button characters for virtual buttons
519 #define CHAR_GRID_BUTTON_NONE ' '
520 #define CHAR_GRID_BUTTON_LEFT '<'
521 #define CHAR_GRID_BUTTON_RIGHT '>'
522 #define CHAR_GRID_BUTTON_UP '^'
523 #define CHAR_GRID_BUTTON_DOWN 'v'
524 #define CHAR_GRID_BUTTON_SNAP '1'
525 #define CHAR_GRID_BUTTON_DROP '2'
527 #define GET_ACTION_FROM_GRID_BUTTON(c) ((c) == CHAR_GRID_BUTTON_LEFT ? \
529 (c) == CHAR_GRID_BUTTON_RIGHT ? \
531 (c) == CHAR_GRID_BUTTON_UP ? \
533 (c) == CHAR_GRID_BUTTON_DOWN ? \
535 (c) == CHAR_GRID_BUTTON_SNAP ? \
537 (c) == CHAR_GRID_BUTTON_DROP ? \
541 // default name for empty highscore entry
542 #define EMPTY_PLAYER_NAME "no name"
544 // default name for unknown player names
545 #define ANONYMOUS_NAME "anonymous"
547 // default for other unknown names
548 #define UNKNOWN_NAME "unknown"
550 // default name for new levels
551 #define NAMELESS_LEVEL_NAME "nameless level"
553 // default text for non-existant artwork
554 #define NOT_AVAILABLE "(not available)"
556 // default value for undefined filename
557 #define UNDEFINED_FILENAME "[NONE]"
559 // default value for undefined levelset
560 #define UNDEFINED_LEVELSET "[NONE]"
562 // default value for undefined parameter
563 #define ARG_DEFAULT "[DEFAULT]"
565 // default values for undefined configuration file parameters
566 #define ARG_UNDEFINED "-1000000"
567 #define ARG_UNDEFINED_VALUE (-1000000)
569 // default value for off-screen positions
570 #define POS_OFFSCREEN (-1000000)
572 // definitions for game sub-directories
574 #define RO_GAME_DIR "."
578 #define RW_GAME_DIR "."
581 #define RO_BASE_PATH RO_GAME_DIR
582 #define RW_BASE_PATH RW_GAME_DIR
585 #define GRAPHICS_DIRECTORY "graphics"
586 #define SOUNDS_DIRECTORY "sounds"
587 #define MUSIC_DIRECTORY "music"
588 #define LEVELS_DIRECTORY "levels"
589 #define TAPES_DIRECTORY "tapes"
590 #define SCORES_DIRECTORY "scores"
591 #define DOCS_DIRECTORY "docs"
592 #define CACHE_DIRECTORY "cache"
593 #define CONF_DIRECTORY "conf"
594 #define NETWORK_DIRECTORY "network"
596 #define GFX_CLASSIC_SUBDIR "gfx_classic"
597 #define SND_CLASSIC_SUBDIR "snd_classic"
598 #define MUS_CLASSIC_SUBDIR "mus_classic"
600 #define GFX_DEFAULT_SUBDIR (setup.internal.default_graphics_set)
601 #define SND_DEFAULT_SUBDIR (setup.internal.default_sounds_set)
602 #define MUS_DEFAULT_SUBDIR (setup.internal.default_music_set)
604 #define GFX_FALLBACK_FILENAME (setup.internal.fallback_graphics_file)
605 #define SND_FALLBACK_FILENAME (setup.internal.fallback_sounds_file)
606 #define MUS_FALLBACK_FILENAME (setup.internal.fallback_music_file)
608 #define DEFAULT_LEVELSET (setup.internal.default_level_series)
610 // file names and filename extensions
611 #define LEVELSETUP_DIRECTORY "levelsetup"
612 #define SETUP_FILENAME "setup.conf"
613 #define AUTOSETUP_FILENAME "autosetup.conf"
614 #define LEVELSETUP_FILENAME "levelsetup.conf"
615 #define EDITORSETUP_FILENAME "editorsetup.conf"
616 #define EDITORCASCADE_FILENAME "editorcascade.conf"
617 #define HELPANIM_FILENAME "helpanim.conf"
618 #define HELPTEXT_FILENAME "helptext.conf"
619 #define LEVELINFO_FILENAME "levelinfo.conf"
620 #define GRAPHICSINFO_FILENAME "graphicsinfo.conf"
621 #define SOUNDSINFO_FILENAME "soundsinfo.conf"
622 #define MUSICINFO_FILENAME "musicinfo.conf"
623 #define ARTWORKINFO_CACHE_FILE "artworkinfo.cache"
624 #define LEVELTEMPLATE_FILENAME "template.level"
625 #define LEVELFILE_EXTENSION "level"
626 #define TAPEFILE_EXTENSION "tape"
627 #define SCOREFILE_EXTENSION "score"
629 #define GAMECONTROLLER_BASENAME "gamecontrollerdb.txt"
631 #define LOG_OUT_BASENAME "stdout.txt"
632 #define LOG_ERR_BASENAME "stderr.txt"
638 #define STRING_PARENT_DIRECTORY ".."
639 #define STRING_TOP_DIRECTORY "/"
641 #define CHAR_PATH_SEPARATOR_UNIX '/'
642 #define CHAR_PATH_SEPARATOR_DOS '\\'
644 #define STRING_PATH_SEPARATOR_UNIX "/"
645 #define STRING_PATH_SEPARATOR_DOS "\\"
647 #define STRING_NEWLINE_UNIX "\n"
648 #define STRING_NEWLINE_DOS "\r\n"
650 #if defined(PLATFORM_WIN32)
651 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_DOS
652 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_DOS
653 #define STRING_NEWLINE STRING_NEWLINE_DOS
655 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_UNIX
656 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_UNIX
657 #define STRING_NEWLINE STRING_NEWLINE_UNIX
661 // areas in bitmap PIX_DOOR
662 // meaning in PIX_DB_DOOR: (3 PAGEs)
663 // PAGEX1: 1. buffer for DOOR_1
664 // PAGEX2: 2. buffer for DOOR_1
665 // PAGEX3: buffer for animations
667 // these values are hard-coded to be able to use them in initialization
668 #define DOOR_GFX_PAGE_WIDTH 100 // should be set to "gfx.dxsize"
669 #define DOOR_GFX_PAGE_HEIGHT 280 // should be set to "gfx.dysize"
671 #define DOOR_GFX_PAGESIZE (DOOR_GFX_PAGE_WIDTH)
672 #define DOOR_GFX_PAGEX1 (0 * DOOR_GFX_PAGESIZE)
673 #define DOOR_GFX_PAGEX2 (1 * DOOR_GFX_PAGESIZE)
674 #define DOOR_GFX_PAGEX3 (2 * DOOR_GFX_PAGESIZE)
675 #define DOOR_GFX_PAGEX4 (3 * DOOR_GFX_PAGESIZE)
676 #define DOOR_GFX_PAGEX5 (4 * DOOR_GFX_PAGESIZE)
677 #define DOOR_GFX_PAGEX6 (5 * DOOR_GFX_PAGESIZE)
678 #define DOOR_GFX_PAGEX7 (6 * DOOR_GFX_PAGESIZE)
679 #define DOOR_GFX_PAGEX8 (7 * DOOR_GFX_PAGESIZE)
680 #define DOOR_GFX_PAGEY1 (0)
681 #define DOOR_GFX_PAGEY2 (DOOR_GFX_PAGE_HEIGHT)
684 // macros for version handling
685 #define VERSION_PART_1(x) ((x) / 1000000)
686 #define VERSION_PART_2(x) (((x) % 1000000) / 10000)
687 #define VERSION_PART_3(x) (((x) % 10000) / 100)
688 #define VERSION_PART_4(x) ((x) % 100)
690 #define VERSION_SUPER(x) VERSION_PART_1(x)
691 #define VERSION_MAJOR(x) VERSION_PART_2(x)
692 #define VERSION_MINOR(x) VERSION_PART_3(x)
693 #define VERSION_PATCH(x) VERSION_PART_4(x)
694 #define VERSION_IDENT(a,b,c,d) ((a) * 1000000 + (b) * 10000 + (c) * 100 + (d))
697 // macros for parent/child process identification
698 #if defined(PLATFORM_UNIX)
699 #define IS_PARENT_PROCESS() (audio.mixer_pid != getpid())
700 #define IS_CHILD_PROCESS() (audio.mixer_pid == getpid())
701 #define HAS_CHILD_PROCESS() (audio.mixer_pid > 0)
703 #define IS_PARENT_PROCESS() TRUE
704 #define IS_CHILD_PROCESS() FALSE
705 #define HAS_CHILD_PROCESS() FALSE
709 // values for artwork type
710 #define ARTWORK_TYPE_GRAPHICS 0
711 #define ARTWORK_TYPE_SOUNDS 1
712 #define ARTWORK_TYPE_MUSIC 2
714 #define NUM_ARTWORK_TYPES 3
717 // values for tree type (chosen to match artwork type)
718 #define TREE_TYPE_UNDEFINED -1
719 #define TREE_TYPE_GRAPHICS_DIR ARTWORK_TYPE_GRAPHICS
720 #define TREE_TYPE_SOUNDS_DIR ARTWORK_TYPE_SOUNDS
721 #define TREE_TYPE_MUSIC_DIR ARTWORK_TYPE_MUSIC
722 #define TREE_TYPE_LEVEL_DIR 3
723 #define TREE_TYPE_LEVEL_NR 4
725 #define NUM_BASE_TREE_TYPES 4
726 #define NUM_TREE_TYPES 5
728 #define INFOTEXT_UNDEFINED ""
729 #define INFOTEXT_GRAPHICS_DIR "Custom Graphics"
730 #define INFOTEXT_SOUNDS_DIR "Custom Sounds"
731 #define INFOTEXT_MUSIC_DIR "Custom Music"
732 #define INFOTEXT_LEVEL_DIR "Level Sets"
733 #define INFOTEXT_LEVEL_NR "Levels"
735 #define TREE_INFOTEXT(t) ((t) == TREE_TYPE_LEVEL_NR ? \
736 INFOTEXT_LEVEL_NR : \
737 (t) == TREE_TYPE_LEVEL_DIR ? \
738 INFOTEXT_LEVEL_DIR : \
739 (t) == TREE_TYPE_GRAPHICS_DIR ? \
740 INFOTEXT_GRAPHICS_DIR : \
741 (t) == TREE_TYPE_SOUNDS_DIR ? \
742 INFOTEXT_SOUNDS_DIR : \
743 (t) == TREE_TYPE_MUSIC_DIR ? \
744 INFOTEXT_MUSIC_DIR : \
747 #define TREE_USERDIR(t) ((t) == TREE_TYPE_LEVEL_DIR ? \
748 getUserLevelDir(NULL) : \
749 (t) == TREE_TYPE_GRAPHICS_DIR ? \
750 getUserGraphicsDir() : \
751 (t) == TREE_TYPE_SOUNDS_DIR ? \
752 getUserSoundsDir() : \
753 (t) == TREE_TYPE_MUSIC_DIR ? \
754 getUserMusicDir() : \
757 #define TREE_FIRST_NODE_PTR(t) ((t) == TREE_TYPE_LEVEL_DIR ? \
759 (t) == TREE_TYPE_GRAPHICS_DIR ? \
760 &artwork.gfx_first : \
761 (t) == TREE_TYPE_SOUNDS_DIR ? \
762 &artwork.snd_first : \
763 (t) == TREE_TYPE_MUSIC_DIR ? \
764 &artwork.mus_first : \
767 #define TREE_FIRST_NODE(t) ((t) == TREE_TYPE_LEVEL_DIR ? \
769 (t) == TREE_TYPE_GRAPHICS_DIR ? \
770 artwork.gfx_first : \
771 (t) == TREE_TYPE_SOUNDS_DIR ? \
772 artwork.snd_first : \
773 (t) == TREE_TYPE_MUSIC_DIR ? \
774 artwork.mus_first : \
777 // values for artwork handling
778 #define LEVELDIR_ARTWORK_SET_PTR(leveldir, type) \
779 ((type) == ARTWORK_TYPE_GRAPHICS ? \
780 &(leveldir)->graphics_set : \
781 (type) == ARTWORK_TYPE_SOUNDS ? \
782 &(leveldir)->sounds_set : \
783 &(leveldir)->music_set)
785 #define LEVELDIR_ARTWORK_SET(leveldir, type) \
786 ((type) == ARTWORK_TYPE_GRAPHICS ? \
787 (leveldir)->graphics_set : \
788 (type) == ARTWORK_TYPE_SOUNDS ? \
789 (leveldir)->sounds_set : \
790 (leveldir)->music_set)
792 #define LEVELDIR_ARTWORK_PATH_PTR(leveldir, type) \
793 ((type) == ARTWORK_TYPE_GRAPHICS ? \
794 &(leveldir)->graphics_path : \
795 (type) == ARTWORK_TYPE_SOUNDS ? \
796 &(leveldir)->sounds_path : \
797 &(leveldir)->music_path)
799 #define LEVELDIR_ARTWORK_PATH(leveldir, type) \
800 ((type) == ARTWORK_TYPE_GRAPHICS ? \
801 (leveldir)->graphics_path : \
802 (type) == ARTWORK_TYPE_SOUNDS ? \
803 (leveldir)->sounds_path : \
804 (leveldir)->music_path)
806 #define SETUP_ARTWORK_SET(setup, type) \
807 ((type) == ARTWORK_TYPE_GRAPHICS ? \
808 (setup).graphics_set : \
809 (type) == ARTWORK_TYPE_SOUNDS ? \
810 (setup).sounds_set : \
813 #define SETUP_OVERRIDE_ARTWORK(setup, type) \
814 ((type) == ARTWORK_TYPE_GRAPHICS ? \
815 (setup).override_level_graphics : \
816 (type) == ARTWORK_TYPE_SOUNDS ? \
817 (setup).override_level_sounds : \
818 (setup).override_level_music)
820 #define GFX_OVERRIDE_ARTWORK(type) \
821 ((type) == ARTWORK_TYPE_GRAPHICS ? \
822 gfx.override_level_graphics : \
823 (type) == ARTWORK_TYPE_SOUNDS ? \
824 gfx.override_level_sounds : \
825 gfx.override_level_music)
827 #define ARTWORK_FIRST_NODE(artwork, type) \
828 ((type) == ARTWORK_TYPE_GRAPHICS ? \
829 (artwork).gfx_first : \
830 (type) == ARTWORK_TYPE_SOUNDS ? \
831 (artwork).snd_first : \
834 #define ARTWORK_CURRENT_IDENTIFIER_PTR(artwork, type) \
835 ((type) == ARTWORK_TYPE_GRAPHICS ? \
836 &(artwork).gfx_current_identifier : \
837 (type) == ARTWORK_TYPE_SOUNDS ? \
838 &(artwork).snd_current_identifier : \
839 &(artwork).mus_current_identifier)
841 #define ARTWORK_CURRENT_IDENTIFIER(artwork, type) \
842 ((type) == ARTWORK_TYPE_GRAPHICS ? \
843 (artwork).gfx_current_identifier : \
844 (type) == ARTWORK_TYPE_SOUNDS ? \
845 (artwork).snd_current_identifier : \
846 (artwork).mus_current_identifier)
848 #define ARTWORKINFO_FILENAME(type) \
849 ((type) == ARTWORK_TYPE_GRAPHICS ? \
850 GRAPHICSINFO_FILENAME : \
851 (type) == ARTWORK_TYPE_SOUNDS ? \
852 SOUNDSINFO_FILENAME : \
853 (type) == ARTWORK_TYPE_MUSIC ? \
854 MUSICINFO_FILENAME : "")
856 #define ARTWORK_DIRECTORY(type) \
857 ((type) == ARTWORK_TYPE_GRAPHICS ? \
858 GRAPHICS_DIRECTORY : \
859 (type) == ARTWORK_TYPE_SOUNDS ? \
861 (type) == ARTWORK_TYPE_MUSIC ? \
862 MUSIC_DIRECTORY : "")
864 #define OPTIONS_ARTWORK_DIRECTORY(type) \
865 ((type) == ARTWORK_TYPE_GRAPHICS ? \
866 options.graphics_directory : \
867 (type) == ARTWORK_TYPE_SOUNDS ? \
868 options.sounds_directory : \
869 (type) == ARTWORK_TYPE_MUSIC ? \
870 options.music_directory : "")
872 #define USER_ARTWORK_DIRECTORY(type) \
873 ((type) == ARTWORK_TYPE_GRAPHICS ? \
874 getUserGraphicsDir() : \
875 (type) == ARTWORK_TYPE_SOUNDS ? \
876 getUserSoundsDir() : \
877 (type) == ARTWORK_TYPE_MUSIC ? \
878 getUserMusicDir() : "")
880 #define ARTWORK_DEFAULT_SUBDIR(type) \
881 ((type) == ARTWORK_TYPE_GRAPHICS ? \
882 GFX_DEFAULT_SUBDIR : \
883 (type) == ARTWORK_TYPE_SOUNDS ? \
884 SND_DEFAULT_SUBDIR : \
887 #define UPDATE_BUSY_STATE() \
889 if (gfx.draw_busy_anim_function != NULL) \
890 gfx.draw_busy_anim_function(); \
894 // structure definitions
898 char *command_basepath; // path to the program binary
899 char *command_basename; // base filename of the program binary
901 char *config_filename; // optional global program config filename
903 char *maindata_path; // main game data (installation) directory
905 char *userdata_subdir; // personal user game data directory
906 char *userdata_path; // resulting full path to game data directory
916 char *log_filename[NUM_LOGS]; // log filenames for out/err messages
917 FILE *log_file[NUM_LOGS]; // log file handles for out/err files
918 FILE *log_file_default[NUM_LOGS]; // default log file handles (out/err)
926 char *version_string;
928 char *(*window_title_function)(void);
929 void (*exit_message_function)(char *, va_list);
930 void (*exit_function)(int);
932 boolean global_scores;
933 boolean many_scores_per_name;
951 boolean uses_touch_device;
959 char *ro_base_directory;
960 char *rw_base_directory;
961 char *level_directory;
962 char *graphics_directory;
963 char *sounds_directory;
964 char *music_directory;
965 char *docs_directory;
966 char *conf_directory;
968 char *execute_command;
979 struct VideoSystemInfo
982 int width, height, depth;
983 int window_width, window_height;
984 int display_width, display_height;
985 int screen_width, screen_height;
986 int screen_xoffset, screen_yoffset;
988 boolean fullscreen_available;
989 boolean fullscreen_enabled;
990 boolean fullscreen_initial;
992 boolean window_scaling_available;
993 int window_scaling_percent;
994 char *window_scaling_quality;
995 int screen_rendering_mode;
998 unsigned int frame_delay;
999 unsigned int frame_delay_value;
1003 int shifted_up_pos_last;
1004 unsigned int shifted_up_delay;
1005 unsigned int shifted_up_delay_value;
1007 boolean initialized;
1010 struct AudioSystemInfo
1012 boolean sound_available;
1013 boolean loops_available;
1014 boolean music_available;
1016 boolean sound_enabled;
1017 boolean sound_deactivated; // for temporarily disabling sound
1026 int first_sound_channel;
1029 struct FontBitmapInfo
1033 int src_x, src_y; // start position of font characters
1034 int width, height; // width / height of font characters
1036 int offset_x; // offset to next font character
1037 int offset_y; // offset to next font character
1039 int draw_xoffset; // offset for drawing font characters
1040 int draw_yoffset; // offset for drawing font characters
1043 int num_chars_per_line;
1050 int real_sx, real_sy;
1051 int full_sxsize, full_sysize;
1052 int scrollbuffer_width, scrollbuffer_height;
1054 int game_tile_size, standard_tile_size;
1065 int win_xsize, win_ysize;
1067 int draw_deactivation_mask;
1068 int draw_background_mask;
1070 Bitmap *field_save_buffer;
1072 Bitmap *background_bitmap;
1073 int background_bitmap_mask;
1075 Bitmap *fade_bitmap_backup;
1076 Bitmap *fade_bitmap_source;
1077 Bitmap *fade_bitmap_target;
1078 Bitmap *fade_bitmap_black;
1080 int fade_border_source_status;
1081 int fade_border_target_status;
1082 Bitmap *masked_border_bitmap_ptr;
1084 Bitmap *final_screen_bitmap;
1086 boolean clipping_enabled;
1088 int clip_width, clip_height;
1090 boolean override_level_graphics;
1091 boolean override_level_sounds;
1092 boolean override_level_music;
1094 boolean draw_init_text;
1097 struct FontBitmapInfo *font_bitmap_info;
1098 int (*select_font_function)(int);
1099 int (*get_font_from_token_function)(char *);
1101 int anim_random_frame;
1103 void (*draw_busy_anim_function)(void);
1104 void (*draw_global_anim_function)(int, int);
1105 void (*draw_global_border_function)(int);
1106 void (*draw_tile_cursor_function)(int);
1111 struct TileCursorInfo
1113 boolean enabled; // tile cursor generally enabled or disabled
1114 boolean active; // tile cursor activated (depending on game)
1115 boolean moving; // tile cursor moving to target position
1117 int xpos, ypos; // tile cursor level playfield position
1118 int x, y; // tile cursor current screen position
1119 int target_x, target_y; // tile cursor target screen position
1121 int sx, sy; // tile cursor screen start position
1126 boolean enabled; // overlay generally enabled or disabled
1127 boolean active; // overlay activated (depending on game mode)
1134 char grid_button[MAX_GRID_XSIZE][MAX_GRID_YSIZE];
1135 char grid_button_highlight;
1137 int grid_button_action;
1143 int nr[MAX_PLAYERS]; // joystick number for each player
1146 struct SetupJoystickInfo
1148 char *device_name; // device name of player's joystick
1150 int xleft, xmiddle, xright;
1151 int yupper, ymiddle, ylower;
1155 struct SetupKeyboardInfo
1157 Key left, right, up, down;
1161 struct SetupTouchInfo
1170 char grid_button[2][MAX_GRID_XSIZE][MAX_GRID_YSIZE];
1172 int transparency; // in percent (0 == opaque, 100 == invisible)
1173 boolean draw_outlined;
1174 boolean draw_pressed;
1176 boolean grid_initialized;
1179 struct SetupInputInfo
1181 boolean use_joystick;
1182 struct SetupJoystickInfo joy;
1183 struct SetupKeyboardInfo key;
1186 struct SetupEditorInfo
1188 boolean el_boulderdash;
1189 boolean el_emerald_mine;
1190 boolean el_emerald_mine_club;
1193 boolean el_supaplex;
1194 boolean el_diamond_caves;
1195 boolean el_dx_boulderdash;
1197 boolean el_mirror_magic;
1198 boolean el_deflektor;
1201 boolean el_steel_chars;
1205 boolean el_user_defined;
1208 boolean el_headlines;
1213 boolean show_element_token;
1215 boolean use_template_for_new_levels;
1218 struct SetupAutoSetupInfo
1220 int editor_zoom_tilesize;
1223 struct SetupEditorCascadeInfo
1236 boolean el_steel_chars;
1244 struct SetupShortcutInfo
1250 Key focus_player[MAX_PLAYERS];
1251 Key focus_player_all;
1270 struct SetupSystemInfo
1272 char *sdl_videodriver;
1273 char *sdl_audiodriver;
1274 int audio_fragment_size;
1277 struct SetupInternalInfo
1279 char *program_title;
1280 char *program_version;
1281 char *program_author;
1282 char *program_email;
1283 char *program_website;
1284 char *program_copyright;
1285 char *program_company;
1287 char *program_icon_file;
1289 char *default_graphics_set;
1290 char *default_sounds_set;
1291 char *default_music_set;
1293 char *fallback_graphics_file;
1294 char *fallback_sounds_file;
1295 char *fallback_music_file;
1297 char *default_level_series;
1299 int default_window_width;
1300 int default_window_height;
1302 boolean choose_from_top_leveldir;
1303 boolean show_scaling_in_title;
1306 boolean menu_editor;
1307 boolean menu_graphics;
1309 boolean menu_artwork;
1312 boolean menu_shortcuts;
1314 boolean menu_save_and_exit;
1317 struct SetupDebugInfo
1319 int frame_delay[10];
1320 Key frame_delay_key[10];
1321 boolean frame_delay_use_mod_key;
1322 boolean frame_delay_game_only;
1323 boolean show_frames_per_second;
1331 boolean sound_loops;
1332 boolean sound_music;
1333 boolean sound_simple;
1335 boolean scroll_delay;
1336 boolean scroll_delay_value;
1337 char *engine_snapshot_mode;
1338 int engine_snapshot_memory;
1339 boolean fade_screens;
1341 boolean show_titlescreen;
1342 boolean quick_doors;
1345 boolean skip_levels;
1346 boolean increment_levels;
1347 boolean auto_play_next_level;
1348 boolean skip_scores_after_game;
1351 int window_scaling_percent;
1352 char *window_scaling_quality;
1353 char *screen_rendering_mode;
1355 boolean ask_on_escape;
1356 boolean ask_on_escape_editor;
1357 boolean ask_on_game_over;
1358 boolean quick_switch;
1359 boolean input_on_focus;
1360 boolean prefer_aga_graphics;
1361 boolean game_speed_extended;
1362 int game_frame_delay;
1363 boolean sp_show_border_elements;
1364 boolean small_game_graphics;
1365 boolean show_snapshot_buttons;
1370 int override_level_graphics; // not boolean -- can also be "AUTO"
1371 int override_level_sounds; // not boolean -- can also be "AUTO"
1372 int override_level_music; // not boolean -- can also be "AUTO"
1378 boolean network_mode;
1379 int network_player_nr;
1380 char *network_server_hostname;
1382 struct SetupAutoSetupInfo auto_setup;
1383 struct SetupEditorInfo editor;
1384 struct SetupEditorCascadeInfo editor_cascade;
1385 struct SetupShortcutInfo shortcut;
1386 struct SetupInputInfo input[MAX_PLAYERS];
1387 struct SetupTouchInfo touch;
1388 struct SetupSystemInfo system;
1389 struct SetupInternalInfo internal;
1390 struct SetupDebugInfo debug;
1392 struct OptionInfo options;
1397 struct TreeInfo **node_top; // topmost node in tree
1398 struct TreeInfo *node_parent; // parent level directory info
1399 struct TreeInfo *node_group; // level group sub-directory info
1400 struct TreeInfo *next; // next level series structure node
1402 int cl_first; // internal control field for setup screen
1403 int cl_cursor; // internal control field for setup screen
1405 int type; // type of tree content
1407 // fields for "type == TREE_TYPE_LEVEL_DIR"
1409 char *subdir; // tree info sub-directory basename (may be ".")
1410 char *fullpath; // complete path relative to tree base directory
1411 char *basepath; // absolute base path of tree base directory
1412 char *identifier; // identifier string for configuration files
1413 char *name; // tree info name, as displayed in selection menues
1414 char *name_sorting; // optional sorting name for correct name sorting
1415 char *author; // level or artwork author name
1416 char *year; // optional year of creation for levels or artwork
1418 char *program_title; // optional alternative text for program title
1419 char *program_copyright; // optional alternative text for program copyright
1420 char *program_company; // optional alternative text for program company
1422 char *imported_from; // optional comment for imported levels or artwork
1423 char *imported_by; // optional comment for imported levels or artwork
1424 char *tested_by; // optional comment to name people who tested a set
1426 char *graphics_set_ecs; // special EMC custom graphics set (ECS graphics)
1427 char *graphics_set_aga; // special EMC custom graphics set (AGA graphics)
1428 char *graphics_set; // optional custom graphics set (level tree only)
1429 char *sounds_set; // optional custom sounds set (level tree only)
1430 char *music_set; // optional custom music set (level tree only)
1431 char *graphics_path; // path to optional custom graphics set (level only)
1432 char *sounds_path; // path to optional custom sounds set (level only)
1433 char *music_path; // path to optional custom music set (level only)
1435 char *level_filename; // filename of level file (for packed level file)
1436 char *level_filetype; // type of levels in level directory or level file
1438 char *special_flags; // flags for special actions performed on level file
1440 int levels; // number of levels in level series
1441 int first_level; // first level number (to allow start with 0 or 1)
1442 int last_level; // last level number (automatically calculated)
1443 int sort_priority; // sort levels by 'sort_priority' and then by name
1445 boolean latest_engine;// force level set to use the latest game engine
1447 boolean level_group; // directory contains more level series directories
1448 boolean parent_link; // entry links back to parent directory
1449 boolean in_user_dir; // user defined levels are stored in home directory
1450 boolean user_defined; // levels in user directory and marked as "private"
1451 boolean readonly; // readonly levels can not be changed with editor
1452 boolean handicap; // level set has no handicap when set to "false"
1453 boolean skip_levels; // levels can be skipped when set to "true"
1455 int color; // color to use on selection screen for this level
1456 char *class_desc; // description of level series class
1457 int handicap_level; // number of the lowest unsolved level
1459 char *infotext; // optional text to describe the tree type (headline)
1462 typedef struct TreeInfo TreeInfo;
1463 typedef struct TreeInfo LevelDirTree;
1464 typedef struct TreeInfo ArtworkDirTree;
1465 typedef struct TreeInfo GraphicsDirTree;
1466 typedef struct TreeInfo SoundsDirTree;
1467 typedef struct TreeInfo MusicDirTree;
1471 GraphicsDirTree *gfx_first;
1472 GraphicsDirTree *gfx_current;
1473 SoundsDirTree *snd_first;
1474 SoundsDirTree *snd_current;
1475 MusicDirTree *mus_first;
1476 MusicDirTree *mus_current;
1478 char *gfx_current_identifier;
1479 char *snd_current_identifier;
1480 char *mus_current_identifier;
1483 struct ValueTextInfo
1489 struct StringValueTextInfo
1501 struct ConfigTypeInfo
1508 struct TokenIntPtrInfo
1518 char *default_filename;
1521 char **default_parameter; // array of file parameters
1522 char **parameter; // array of file parameters
1525 boolean fallback_to_default;
1526 boolean default_is_cloned;
1529 struct SetupFileList
1534 struct SetupFileList *next;
1539 char *source_filename; // primary key for node list
1543 struct PropertyMapping
1553 struct ArtworkListInfo
1555 int type; // type of artwork
1557 int num_file_list_entries;
1558 int num_dynamic_file_list_entries;
1559 struct FileInfo *file_list; // static artwork file array
1560 struct FileInfo *dynamic_file_list; // dynamic artwrk file array
1562 int num_suffix_list_entries;
1563 struct ConfigTypeInfo *suffix_list; // parameter suffixes array
1565 int num_base_prefixes;
1566 int num_ext1_suffixes;
1567 int num_ext2_suffixes;
1568 int num_ext3_suffixes;
1569 char **base_prefixes; // base token prefixes array
1570 char **ext1_suffixes; // property suffixes array 1
1571 char **ext2_suffixes; // property suffixes array 2
1572 char **ext3_suffixes; // property suffixes array 3
1574 int num_ignore_tokens;
1575 char **ignore_tokens; // file tokens to be ignored
1577 int num_property_mapping_entries;
1578 struct PropertyMapping *property_mapping; // mapping token -> artwork
1580 int sizeof_artwork_list_entry;
1582 struct ListNodeInfo **artwork_list; // static artwork node array
1583 struct ListNodeInfo **dynamic_artwork_list; // dynamic artwrk node array
1584 struct ListNode *content_list; // dynamic artwork node list
1586 void *(*load_artwork)(char *); // constructor function
1587 void (*free_artwork)(void *); // destructor function
1607 struct RectWithBorder
1611 int min_width, min_height;
1612 int max_width, max_height;
1633 struct DoorPartPosInfo
1640 int start_step_opening;
1641 int start_step_closing;
1642 boolean draw_masked;
1649 int xoffset; // special case for tape date and time
1650 int xoffset2; // special case for tape date
1651 int yoffset; // special case for list of preview players
1654 int size; // also used for suffix ".digits"
1656 boolean draw_masked;
1657 boolean draw_player; // special case for network player buttons
1658 int sort_priority; // also used for suffix ".draw_order"
1661 int direction; // needed for panel time/health graphics
1662 int class; // needed for panel time/health graphics
1663 int style; // needed for panel time/health graphics
1665 int tile_size; // special case for list of network players
1666 int border_size; // special case for list of preview players
1667 int vertical; // special case for list of preview players
1669 boolean redefined; // redefined by custom artwork
1672 struct MouseActionInfo
1681 int music[MAX_LEVELS];
1694 // ============================================================================
1695 // exported variables
1696 // ============================================================================
1698 extern struct ProgramInfo program;
1699 extern struct NetworkInfo network;
1700 extern struct RuntimeInfo runtime;
1701 extern struct OptionInfo options;
1702 extern struct VideoSystemInfo video;
1703 extern struct AudioSystemInfo audio;
1704 extern struct GfxInfo gfx;
1705 extern struct TileCursorInfo tile_cursor;
1706 extern struct OverlayInfo overlay;
1707 extern struct AnimInfo anim;
1708 extern struct ArtworkInfo artwork;
1709 extern struct JoystickInfo joystick;
1710 extern struct SetupInfo setup;
1712 extern LevelDirTree *leveldir_first_all;
1713 extern LevelDirTree *leveldir_first;
1714 extern LevelDirTree *leveldir_current;
1715 extern int level_nr;
1717 extern struct LevelSetInfo levelset;
1718 extern struct LevelStats level_stats[];
1720 extern DrawWindow *window;
1721 extern DrawBuffer *backbuffer;
1722 extern DrawBuffer *drawto;
1724 extern int button_status;
1725 extern boolean motion_status;
1726 extern int wheel_steps;
1727 extern boolean keyrepeat_status;
1729 extern int redraw_mask;
1731 extern int FrameCounter;
1734 // function definitions
1736 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
1738 void InitNetworkInfo(boolean, boolean, boolean, char *, int);
1739 void InitRuntimeInfo(void);
1741 void InitScoresInfo(void);
1742 void SetWindowTitle(void);
1744 void InitWindowTitleFunction(char *(*window_title_function)(void));
1745 void InitExitMessageFunction(void (*exit_message_function)(char *, va_list));
1746 void InitExitFunction(void (*exit_function)(int));
1747 void InitPlatformDependentStuff(void);
1748 void ClosePlatformDependentStuff(void);
1750 void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
1751 void InitGfxTileSizeInfo(int, int);
1752 void InitGfxDoor1Info(int, int, int, int);
1753 void InitGfxDoor2Info(int, int, int, int);
1754 void InitGfxDoor3Info(int, int, int, int);
1755 void InitGfxWindowInfo(int, int);
1756 void InitGfxScrollbufferInfo(int, int);
1757 void InitGfxClipRegion(boolean, int, int, int, int);
1758 void InitGfxDrawBusyAnimFunction(void (*draw_busy_anim_function)(void));
1759 void InitGfxDrawGlobalAnimFunction(void (*draw_global_anim_function)(int, int));
1760 void InitGfxDrawGlobalBorderFunction(void (*draw_global_border_function)(int));
1761 void InitGfxDrawTileCursorFunction(void (*draw_tile_cursor_function)(int));
1762 void InitGfxCustomArtworkInfo(void);
1763 void InitGfxOtherSettings(void);
1764 void InitTileCursorInfo(void);
1765 void InitOverlayInfo(void);
1766 void SetTileCursorEnabled(boolean);
1767 void SetTileCursorActive(boolean);
1768 void SetTileCursorTargetXY(int, int);
1769 void SetTileCursorXY(int, int);
1770 void SetTileCursorSXSY(int, int);
1771 void SetOverlayEnabled(boolean);
1772 void SetOverlayActive(boolean);
1773 void SetOverlayShowGrid(boolean);
1774 boolean GetOverlayEnabled(void);
1775 boolean GetOverlayActive(void);
1776 void SetDrawDeactivationMask(int);
1777 int GetDrawDeactivationMask(void);
1778 void SetDrawBackgroundMask(int);
1779 void SetWindowBackgroundBitmap(Bitmap *);
1780 void SetMainBackgroundBitmap(Bitmap *);
1781 void SetDoorBackgroundBitmap(Bitmap *);
1782 void SetRedrawMaskFromArea(int, int, int, int);
1784 void LimitScreenUpdates(boolean);
1786 void InitVideoDefaults(void);
1787 void InitVideoDisplay(void);
1788 void CloseVideoDisplay(void);
1789 void InitVideoBuffer(int, int, int, boolean);
1790 Bitmap *CreateBitmapStruct(void);
1791 Bitmap *CreateBitmap(int, int, int);
1792 void ReCreateBitmap(Bitmap **, int, int);
1793 void FreeBitmap(Bitmap *);
1794 void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
1795 void BlitBitmapTiled(Bitmap *, Bitmap *, int, int, int, int, int, int, int,int);
1796 void FadeRectangle(int, int, int, int, int, int, int,
1797 void (*draw_border_function)(void));
1798 void FillRectangle(Bitmap *, int, int, int, int, Pixel);
1799 void ClearRectangle(Bitmap *, int, int, int, int);
1800 void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
1801 void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
1802 boolean DrawingDeactivatedField(void);
1803 boolean DrawingDeactivated(int, int, int, int);
1804 boolean DrawingOnBackground(int, int);
1805 boolean DrawingAreaChanged(void);
1806 void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int, int);
1807 void BlitTexture(Bitmap *, int, int, int, int, int, int);
1808 void BlitTextureMasked(Bitmap *, int, int, int, int, int, int);
1809 void BlitToScreen(Bitmap *, int, int, int, int, int, int);
1810 void BlitToScreenMasked(Bitmap *, int, int, int, int, int, int);
1811 void DrawSimpleBlackLine(Bitmap *, int, int, int, int);
1812 void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
1813 void DrawLines(Bitmap *, struct XY *, int, Pixel);
1814 Pixel GetPixel(Bitmap *, int, int);
1815 Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
1816 Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
1818 void KeyboardAutoRepeatOn(void);
1819 void KeyboardAutoRepeatOff(void);
1820 boolean SetVideoMode(boolean);
1821 void SetVideoFrameDelay(unsigned int);
1822 unsigned int GetVideoFrameDelay(void);
1823 boolean ChangeVideoModeIfNeeded(boolean);
1825 Bitmap *LoadImage(char *);
1826 Bitmap *LoadCustomImage(char *);
1827 void ReloadCustomImage(Bitmap *, char *);
1829 void ReCreateGameTileSizeBitmap(Bitmap **);
1830 void CreateBitmapWithSmallBitmaps(Bitmap **, int, int);
1831 void CreateBitmapTextures(Bitmap **);
1832 void FreeBitmapTextures(Bitmap **);
1833 void ScaleBitmap(Bitmap **, int);
1835 void SetMouseCursor(int);
1837 void OpenAudio(void);
1838 void CloseAudio(void);
1839 void SetAudioMode(boolean);
1841 boolean PendingEvent(void);
1842 void WaitEvent(Event *event);
1843 void PeekEvent(Event *event);
1844 void CheckQuitEvent(void);
1845 Key GetEventKey(KeyEvent *, boolean);
1846 KeyMod HandleKeyModState(Key, int);
1847 KeyMod GetKeyModState(void);
1848 KeyMod GetKeyModStateFromEvents(void);
1849 void StartTextInput(int, int, int, int);
1850 void StopTextInput(void);
1851 boolean CheckCloseWindowEvent(ClientMessageEvent *);
1853 void InitJoysticks(void);
1854 boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
1855 boolean CheckJoystickOpened(int);
1856 void ClearJoystickState(void);