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 HAS_TOUCH_DEVICE
116 #define USE_TOUCH_INPUT_OVERLAY
117 #define USE_COMPLETE_DISPLAY
118 #define HAS_SCREEN_KEYBOARD
119 #define SCREEN_KEYBOARD_POS(h) ((h) / 2)
122 // values for drag-and-drop support (some parts not added before SDL 2.0.5)
123 #if !SDL_VERSION_ATLEAST(2,0,5)
124 #define SDL_DROPTEXT (SDL_DROPFILE + 1)
125 #define SDL_DROPBEGIN (SDL_DROPFILE + 2)
126 #define SDL_DROPCOMPLETE (SDL_DROPFILE + 3)
129 // default input keys
130 #define DEFAULT_KEY_LEFT KSYM_Left
131 #define DEFAULT_KEY_RIGHT KSYM_Right
132 #define DEFAULT_KEY_UP KSYM_Up
133 #define DEFAULT_KEY_DOWN KSYM_Down
134 #if defined(PLATFORM_MACOSX)
135 #define DEFAULT_KEY_SNAP KSYM_Control_L
136 #define DEFAULT_KEY_DROP KSYM_KP_Enter
138 #define DEFAULT_KEY_SNAP KSYM_Control_L
139 #define DEFAULT_KEY_DROP KSYM_Control_R
141 #define DEFAULT_KEY_OKAY KSYM_Return
142 #define DEFAULT_KEY_CANCEL KSYM_Escape
144 // default shortcut keys
145 #define DEFAULT_KEY_SAVE_GAME KSYM_F1
146 #define DEFAULT_KEY_LOAD_GAME KSYM_F2
147 #define DEFAULT_KEY_TOGGLE_PAUSE KSYM_space
148 #define DEFAULT_KEY_FOCUS_PLAYER_1 KSYM_F5
149 #define DEFAULT_KEY_FOCUS_PLAYER_2 KSYM_F6
150 #define DEFAULT_KEY_FOCUS_PLAYER_3 KSYM_F7
151 #define DEFAULT_KEY_FOCUS_PLAYER_4 KSYM_F8
152 #define DEFAULT_KEY_FOCUS_PLAYER_ALL KSYM_F9
153 #define DEFAULT_KEY_TAPE_EJECT KSYM_UNDEFINED
154 #define DEFAULT_KEY_TAPE_EXTRA KSYM_UNDEFINED
155 #define DEFAULT_KEY_TAPE_STOP KSYM_UNDEFINED
156 #define DEFAULT_KEY_TAPE_PAUSE KSYM_UNDEFINED
157 #define DEFAULT_KEY_TAPE_RECORD KSYM_UNDEFINED
158 #define DEFAULT_KEY_TAPE_PLAY KSYM_UNDEFINED
159 #define DEFAULT_KEY_SOUND_SIMPLE KSYM_UNDEFINED
160 #define DEFAULT_KEY_SOUND_LOOPS KSYM_UNDEFINED
161 #define DEFAULT_KEY_SOUND_MUSIC KSYM_UNDEFINED
162 #define DEFAULT_KEY_SNAP_LEFT KSYM_UNDEFINED
163 #define DEFAULT_KEY_SNAP_RIGHT KSYM_UNDEFINED
164 #define DEFAULT_KEY_SNAP_UP KSYM_UNDEFINED
165 #define DEFAULT_KEY_SNAP_DOWN KSYM_UNDEFINED
167 // default debug setup keys and values
168 #define DEFAULT_FRAME_DELAY_0 20 // 100 % speed
169 #define DEFAULT_FRAME_DELAY_1 500 // 4 % speed
170 #define DEFAULT_FRAME_DELAY_2 250 // 8 % speed
171 #define DEFAULT_FRAME_DELAY_3 125 // 16 % speed
172 #define DEFAULT_FRAME_DELAY_4 60 // 33 % speed
173 #define DEFAULT_FRAME_DELAY_5 40 // 50 % speed
174 #define DEFAULT_FRAME_DELAY_6 30 // 66 % speed
175 #define DEFAULT_FRAME_DELAY_7 10 // 200 % speed
176 #define DEFAULT_FRAME_DELAY_8 5 // 400 % speed
177 #define DEFAULT_FRAME_DELAY_9 0 // maximum speed
179 #define DEFAULT_KEY_FRAME_DELAY_0 KSYM_0
180 #define DEFAULT_KEY_FRAME_DELAY_1 KSYM_1
181 #define DEFAULT_KEY_FRAME_DELAY_2 KSYM_2
182 #define DEFAULT_KEY_FRAME_DELAY_3 KSYM_3
183 #define DEFAULT_KEY_FRAME_DELAY_4 KSYM_4
184 #define DEFAULT_KEY_FRAME_DELAY_5 KSYM_5
185 #define DEFAULT_KEY_FRAME_DELAY_6 KSYM_6
186 #define DEFAULT_KEY_FRAME_DELAY_7 KSYM_7
187 #define DEFAULT_KEY_FRAME_DELAY_8 KSYM_8
188 #define DEFAULT_KEY_FRAME_DELAY_9 KSYM_9
190 #define NUM_DEBUG_FRAME_DELAY_KEYS 10
192 #define DEFAULT_FRAME_DELAY_USE_MOD_KEY FALSE
193 #define DEFAULT_FRAME_DELAY_GAME_ONLY TRUE
195 // values for key_status
196 #define KEY_NOT_PRESSED FALSE
197 #define KEY_RELEASED FALSE
198 #define KEY_PRESSED TRUE
200 // values for button status
201 #define MB_NOT_PRESSED FALSE
202 #define MB_NOT_RELEASED TRUE
203 #define MB_RELEASED FALSE
204 #define MB_PRESSED TRUE
205 #define MB_MENU_CHOICE FALSE
206 #define MB_MENU_MARK TRUE
207 #define MB_MENU_INITIALIZE (-1)
208 #define MB_MENU_LEAVE (-2)
209 #define MB_LEFTBUTTON 1
210 #define MB_MIDDLEBUTTON 2
211 #define MB_RIGHTBUTTON 3
212 #define MB_WHEEL_UP 4
213 #define MB_WHEEL_DOWN 5
214 #define MB_WHEEL_LEFT 6
215 #define MB_WHEEL_RIGHT 7
216 #define IS_WHEEL_BUTTON_VERTICAL(b) ((b) == MB_WHEEL_UP || \
217 (b) == MB_WHEEL_DOWN)
218 #define IS_WHEEL_BUTTON_HORIZONTAL(b) ((b) == MB_WHEEL_LEFT || \
219 (b) == MB_WHEEL_RIGHT)
220 #define IS_WHEEL_BUTTON(b) (IS_WHEEL_BUTTON_VERTICAL(b) || \
221 IS_WHEEL_BUTTON_HORIZONTAL(b))
222 #define DEFAULT_WHEEL_STEPS 3
224 #define BUTTON_STEPSIZE(b) ((b) == MB_LEFTBUTTON ? 1 : \
225 (b) == MB_MIDDLEBUTTON ? 5 : \
226 (b) == MB_RIGHTBUTTON ? 10 : 1)
228 // values for move directions
229 #define MV_BIT_LEFT 0
230 #define MV_BIT_RIGHT 1
232 #define MV_BIT_DOWN 3
234 #define NUM_DIRECTIONS 4
236 // diagonal movement directions are used in a different contect than buttons
237 #define MV_BIT_UPLEFT 4
238 #define MV_BIT_UPRIGHT 5
239 #define MV_BIT_DOWNLEFT 6
240 #define MV_BIT_DOWNRIGHT 7
242 #define NUM_DIRECTIONS_FULL 8
244 // values for special "button" bitmasks
248 #define NUM_PLAYER_ACTIONS 6
250 // values for special "focus player" bitmasks
251 #define BIT_SET_FOCUS 6
253 // values for drawing stages for global animations
254 #define DRAW_GLOBAL_ANIM_STAGE_1 1
255 #define DRAW_GLOBAL_ANIM_STAGE_2 2
257 // values for drawing target (various functions)
258 #define DRAW_TO_BACKBUFFER 0
259 #define DRAW_TO_FIELDBUFFER 1
260 #define DRAW_TO_SCREEN 2
261 #define DRAW_TO_FADE_SOURCE 3
262 #define DRAW_TO_FADE_TARGET 4
264 // values for move directions and special "button" key bitmasks
266 #define MV_LEFT (1 << MV_BIT_LEFT)
267 #define MV_RIGHT (1 << MV_BIT_RIGHT)
268 #define MV_UP (1 << MV_BIT_UP)
269 #define MV_DOWN (1 << MV_BIT_DOWN)
271 #define MV_UPLEFT (MV_UP | MV_LEFT)
272 #define MV_UPRIGHT (MV_UP | MV_RIGHT)
273 #define MV_DOWNLEFT (MV_DOWN | MV_LEFT)
274 #define MV_DOWNRIGHT (MV_DOWN | MV_RIGHT)
276 #define MV_HORIZONTAL (MV_LEFT | MV_RIGHT)
277 #define MV_VERTICAL (MV_UP | MV_DOWN)
278 #define MV_ALL_DIRECTIONS (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
279 #define MV_ANY_DIRECTION (MV_ALL_DIRECTIONS)
280 #define MV_NO_DIRECTION (MV_NONE)
282 #define KEY_BUTTON_1 (1 << BUTTON_1)
283 #define KEY_BUTTON_2 (1 << BUTTON_2)
284 #define KEY_BUTTON_SNAP KEY_BUTTON_1
285 #define KEY_BUTTON_DROP KEY_BUTTON_2
286 #define KEY_MOTION (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
287 #define KEY_BUTTON (KEY_BUTTON_1 | KEY_BUTTON_2)
288 #define KEY_ACTION (KEY_MOTION | KEY_BUTTON)
290 #define KEY_SET_FOCUS (1 << BIT_SET_FOCUS)
292 #define MV_DIR_FROM_BIT(x) ((x) < NUM_DIRECTIONS ? 1 << (x) : \
293 (x) == MV_BIT_UPLEFT ? MV_UPLEFT : \
294 (x) == MV_BIT_UPRIGHT ? MV_UPRIGHT : \
295 (x) == MV_BIT_DOWNLEFT ? MV_DOWNLEFT : \
296 (x) == MV_BIT_DOWNRIGHT ? MV_DOWNRIGHT : \
299 #define MV_DIR_TO_BIT(x) ((x) == MV_LEFT ? MV_BIT_LEFT : \
300 (x) == MV_RIGHT ? MV_BIT_RIGHT : \
301 (x) == MV_UP ? MV_BIT_UP : \
302 (x) == MV_DOWN ? MV_BIT_DOWN : \
303 (x) == MV_UPLEFT ? MV_BIT_UPLEFT : \
304 (x) == MV_UPRIGHT ? MV_BIT_UPRIGHT : \
305 (x) == MV_DOWNLEFT ? MV_BIT_DOWNLEFT : \
306 (x) == MV_DOWNRIGHT ? MV_BIT_DOWNRIGHT : \
309 #define MV_DIR_OPPOSITE(x) ((x) == MV_LEFT ? MV_RIGHT : \
310 (x) == MV_RIGHT ? MV_LEFT : \
311 (x) == MV_UP ? MV_DOWN : \
312 (x) == MV_DOWN ? MV_UP : \
313 (x) == MV_UPLEFT ? MV_DOWNRIGHT : \
314 (x) == MV_UPRIGHT ? MV_DOWNLEFT : \
315 (x) == MV_DOWNLEFT ? MV_UPRIGHT : \
316 (x) == MV_DOWNRIGHT ? MV_UPLEFT : \
319 // values for animation mode (frame order and direction)
320 // (stored in level files -- never change existing values)
322 #define ANIM_LOOP (1 << 0)
323 #define ANIM_LINEAR (1 << 1)
324 #define ANIM_PINGPONG (1 << 2)
325 #define ANIM_PINGPONG2 (1 << 3)
326 #define ANIM_RANDOM (1 << 4)
327 #define ANIM_CE_VALUE (1 << 5)
328 #define ANIM_CE_SCORE (1 << 6)
329 #define ANIM_CE_DELAY (1 << 7)
330 #define ANIM_REVERSE (1 << 8)
331 #define ANIM_OPAQUE_PLAYER (1 << 9)
333 // values for special (non game element) animation modes
334 // (not stored in level files -- can be changed, if needed)
335 #define ANIM_HORIZONTAL (1 << 10)
336 #define ANIM_VERTICAL (1 << 11)
337 #define ANIM_CENTERED (1 << 12)
338 #define ANIM_STATIC_PANEL (1 << 13)
339 #define ANIM_ALL (1 << 14)
340 #define ANIM_ONCE (1 << 15)
342 #define ANIM_DEFAULT ANIM_LOOP
344 // values for special drawing styles (currently only for crumbled graphics)
346 #define STYLE_ACCURATE_BORDERS (1 << 0)
347 #define STYLE_INNER_CORNERS (1 << 1)
348 #define STYLE_REVERSE (1 << 2)
350 // values for special event handling style (used for global animation)
351 #define STYLE_BLOCK (1 << 3)
352 #define STYLE_PASSTHROUGH (1 << 4)
353 #define STYLE_MULTIPLE_ACTIONS (1 << 5)
355 #define STYLE_DEFAULT STYLE_NONE
357 // values for special global animation delay types
358 #define ANIM_DELAY_UNDEFINED -1
359 #define ANIM_DELAY_NONE 0
360 #define ANIM_DELAY_INIT 1
361 #define ANIM_DELAY_ANIM 2
362 #define ANIM_DELAY_POST 3
364 // values for special global animation delay actions
365 #define ANIM_DELAY_ACTION_NONE -1
367 // values for special global animation events
368 #define ANIM_EVENT_UNDEFINED -1
369 #define ANIM_EVENT_NONE 0
370 #define ANIM_EVENT_SELF (1 << 16)
371 #define ANIM_EVENT_ANY (1 << 17)
372 #define ANIM_EVENT_CLICK (1 << 18)
373 #define ANIM_EVENT_INIT (1 << 19)
374 #define ANIM_EVENT_START (1 << 20)
375 #define ANIM_EVENT_END (1 << 21)
376 #define ANIM_EVENT_POST (1 << 22)
377 #define ANIM_EVENT_UNCLICK_ANY (1 << 23)
379 // anim number: bits 0-7
380 // part number: bits 8-15
381 #define ANIM_EVENT_ANIM_BIT 0
382 #define ANIM_EVENT_PART_BIT 8
384 #define ANIM_EVENT_ANIM_MASK (0xff << ANIM_EVENT_ANIM_BIT)
385 #define ANIM_EVENT_PART_MASK (0xff << ANIM_EVENT_PART_BIT)
387 #define ANIM_EVENT_DEFAULT ANIM_EVENT_NONE
389 // values for special global animation event actions
390 #define ANIM_EVENT_ACTION_NONE -1
392 // values for fade mode
393 #define FADE_TYPE_NONE 0
394 #define FADE_TYPE_FADE_IN (1 << 0)
395 #define FADE_TYPE_FADE_OUT (1 << 1)
396 #define FADE_TYPE_TRANSFORM (1 << 2)
397 #define FADE_TYPE_CROSSFADE (1 << 3)
398 #define FADE_TYPE_MELT (1 << 4)
399 #define FADE_TYPE_CURTAIN (1 << 5)
400 #define FADE_TYPE_SKIP (1 << 6)
402 #define FADE_MODE_NONE (FADE_TYPE_NONE)
403 #define FADE_MODE_FADE_IN (FADE_TYPE_FADE_IN)
404 #define FADE_MODE_FADE_OUT (FADE_TYPE_FADE_OUT)
405 #define FADE_MODE_FADE (FADE_TYPE_FADE_IN | FADE_TYPE_FADE_OUT)
406 #define FADE_MODE_TRANSFORM (FADE_TYPE_TRANSFORM | FADE_TYPE_FADE_IN)
407 #define FADE_MODE_CROSSFADE (FADE_MODE_TRANSFORM | FADE_TYPE_CROSSFADE)
408 #define FADE_MODE_MELT (FADE_MODE_TRANSFORM | FADE_TYPE_MELT)
409 #define FADE_MODE_CURTAIN (FADE_MODE_TRANSFORM | FADE_TYPE_CURTAIN)
410 #define FADE_MODE_SKIP_FADE_IN (FADE_TYPE_SKIP | FADE_TYPE_FADE_IN)
411 #define FADE_MODE_SKIP_FADE_OUT (FADE_TYPE_SKIP | FADE_TYPE_FADE_OUT)
413 #define FADE_MODE_DEFAULT FADE_MODE_FADE
415 #define AUTO_DELAY_UNIT_MS 0
416 #define AUTO_DELAY_UNIT_FRAMES 1
418 #define AUTO_DELAY_UNIT_DEFAULT AUTO_DELAY_UNIT_MS
420 // values for toon positions
421 #define POS_UNDEFINED -1
432 // values for text alignment
433 #define ALIGN_LEFT (1 << 0)
434 #define ALIGN_RIGHT (1 << 1)
435 #define ALIGN_CENTER (1 << 2)
436 #define ALIGN_DEFAULT ALIGN_LEFT
438 #define VALIGN_TOP (1 << 0)
439 #define VALIGN_BOTTOM (1 << 1)
440 #define VALIGN_MIDDLE (1 << 2)
441 #define VALIGN_DEFAULT VALIGN_TOP
443 #define ALIGNED_XPOS(x,w,a) ((a) == ALIGN_CENTER ? (x) - (w) / 2 : \
444 (a) == ALIGN_RIGHT ? (x) - (w) : (x))
445 #define ALIGNED_YPOS(y,h,v) ((v) == VALIGN_MIDDLE ? (y) - (h) / 2 : \
446 (v) == VALIGN_BOTTOM ? (y) - (h) : (y))
447 #define ALIGNED_TEXT_XPOS(p) ALIGNED_XPOS((p)->x, (p)->width, (p)->align)
448 #define ALIGNED_TEXT_YPOS(p) ALIGNED_YPOS((p)->y, (p)->height, (p)->valign)
449 #define ALIGNED_VP_XPOS(p) ALIGNED_TEXT_XPOS(p)
450 #define ALIGNED_VP_YPOS(p) ALIGNED_TEXT_YPOS(p)
452 // values for redraw_mask
453 #define REDRAW_NONE (0)
454 #define REDRAW_ALL (1 << 0)
455 #define REDRAW_FIELD (1 << 1)
456 #define REDRAW_DOOR_1 (1 << 2)
457 #define REDRAW_DOOR_2 (1 << 3)
458 #define REDRAW_DOOR_3 (1 << 4)
459 #define REDRAW_FPS (1 << 5)
461 #define REDRAW_DOORS (REDRAW_DOOR_1 | \
465 #define IN_GFX_FIELD_PLAY(x, y) (x >= gfx.sx && x < gfx.sx + gfx.sxsize && \
466 y >= gfx.sy && y < gfx.sy + gfx.sysize)
467 #define IN_GFX_FIELD_FULL(x, y) (x >= gfx.real_sx && \
468 x < gfx.real_sx + gfx.full_sxsize && \
469 y >= gfx.real_sy && \
470 y < gfx.real_sy + gfx.full_sysize)
471 #define IN_GFX_DOOR_1(x, y) (x >= gfx.dx && x < gfx.dx + gfx.dxsize && \
472 y >= gfx.dy && y < gfx.dy + gfx.dysize)
473 #define IN_GFX_DOOR_2(x, y) (x >= gfx.vx && x < gfx.vx + gfx.vxsize && \
474 y >= gfx.vy && y < gfx.vy + gfx.vysize)
475 #define IN_GFX_DOOR_3(x, y) (x >= gfx.ex && x < gfx.ex + gfx.exsize && \
476 y >= gfx.ey && y < gfx.ey + gfx.eysize)
478 // values for mouse cursor
479 #define CURSOR_UNDEFINED -1
480 #define CURSOR_DEFAULT 0
481 #define CURSOR_NONE 1
482 #define CURSOR_PLAYFIELD 2
484 // fundamental game speed values
485 #define ONE_SECOND_DELAY 1000 // delay value for one second
486 #define MENU_FRAME_DELAY 20 // frame delay in milliseconds
487 #define GAME_FRAME_DELAY 20 // frame delay in milliseconds
488 #define FFWD_FRAME_DELAY 10 // 200% speed for fast forward
489 #define MIN_VSYNC_FRAME_DELAY 15 // minimum value for vsync to keep
490 #define MAX_VSYNC_FRAME_DELAY 16 // maximum value for vsync to work
491 #define FRAMES_PER_SECOND (ONE_SECOND_DELAY / GAME_FRAME_DELAY)
492 #define FRAMES_PER_SECOND_SP 35
494 // maximum playfield size supported by libgame functions
495 #define MAX_PLAYFIELD_WIDTH 128
496 #define MAX_PLAYFIELD_HEIGHT 128
498 // maximum number of parallel players supported by libgame functions
499 #define MAX_PLAYERS 4
501 // maximum allowed length of player name
502 #define MAX_PLAYER_NAME_LEN 10
504 // maximum number of levels in a level set
505 #define MAX_LEVELS 1000
507 // maximum number of global animation and parts
508 #define MAX_GLOBAL_ANIMS 32
509 #define MAX_GLOBAL_ANIM_PARTS 32
511 // minimum/maximum/default x/y grid size for virtual buttons
512 #define MIN_GRID_XSIZE 3
513 #define MIN_GRID_YSIZE 3
514 #define MAX_GRID_XSIZE 32
515 #define MAX_GRID_YSIZE 32
516 #define GRID_REAL_WIDTH MAX(1, MAX(video.screen_width, \
517 video.screen_height))
518 #define GRID_REAL_HEIGHT MAX(1, MIN(video.screen_width, \
519 video.screen_height))
520 #define DEFAULT_GRID_XSIZE_0 18
521 #define DEFAULT_GRID_YSIZE_0 MIN(MAX(MIN_GRID_YSIZE, \
522 DEFAULT_GRID_XSIZE_0 * \
526 #define DEFAULT_GRID_XSIZE_1 13
527 #define DEFAULT_GRID_YSIZE_1 MIN(MAX(MIN_GRID_YSIZE, \
528 DEFAULT_GRID_XSIZE_1 * \
533 #define DEFAULT_GRID_XSIZE(n) ((n) == 0 ? DEFAULT_GRID_XSIZE_0 : \
534 DEFAULT_GRID_XSIZE_1)
535 #define DEFAULT_GRID_YSIZE(n) ((n) == 0 ? DEFAULT_GRID_YSIZE_0 : \
536 DEFAULT_GRID_YSIZE_1)
538 #define GRID_ACTIVE_NR() (video.screen_width > \
539 video.screen_height ? 0 : 1)
541 // values for grid button characters for virtual buttons
542 #define CHAR_GRID_BUTTON_NONE ' '
543 #define CHAR_GRID_BUTTON_LEFT '<'
544 #define CHAR_GRID_BUTTON_RIGHT '>'
545 #define CHAR_GRID_BUTTON_UP '^'
546 #define CHAR_GRID_BUTTON_DOWN 'v'
547 #define CHAR_GRID_BUTTON_SNAP '1'
548 #define CHAR_GRID_BUTTON_DROP '2'
550 #define GET_ACTION_FROM_GRID_BUTTON(c) ((c) == CHAR_GRID_BUTTON_LEFT ? \
552 (c) == CHAR_GRID_BUTTON_RIGHT ? \
554 (c) == CHAR_GRID_BUTTON_UP ? \
556 (c) == CHAR_GRID_BUTTON_DOWN ? \
558 (c) == CHAR_GRID_BUTTON_SNAP ? \
560 (c) == CHAR_GRID_BUTTON_DROP ? \
564 // default name for empty highscore entry
565 #define EMPTY_PLAYER_NAME "no name"
567 // default name for unknown player names
568 #define ANONYMOUS_NAME "anonymous"
570 // default for other unknown names
571 #define UNKNOWN_NAME "unknown"
573 // default name for new levels
574 #define NAMELESS_LEVEL_NAME "nameless level"
576 // default text for non-existant artwork
577 #define NOT_AVAILABLE "(not available)"
579 // default value for undefined filename
580 #define UNDEFINED_FILENAME "[NONE]"
582 // default value for undefined levelset
583 #define UNDEFINED_LEVELSET "[NONE]"
585 // default value for undefined parameter
586 #define ARG_DEFAULT "[DEFAULT]"
588 // default values for undefined configuration file parameters
589 #define ARG_UNDEFINED "-1000000"
590 #define ARG_UNDEFINED_VALUE (-1000000)
592 // default value for off-screen positions
593 #define POS_OFFSCREEN (-1000000)
595 // definitions for game sub-directories
597 #define RO_GAME_DIR "."
601 #define RW_GAME_DIR "."
604 #define RO_BASE_PATH RO_GAME_DIR
605 #define RW_BASE_PATH RW_GAME_DIR
608 #define GRAPHICS_DIRECTORY "graphics"
609 #define SOUNDS_DIRECTORY "sounds"
610 #define MUSIC_DIRECTORY "music"
611 #define LEVELS_DIRECTORY "levels"
612 #define TAPES_DIRECTORY "tapes"
613 #define SCORES_DIRECTORY "scores"
614 #define DOCS_DIRECTORY "docs"
615 #define CACHE_DIRECTORY "cache"
616 #define CONF_DIRECTORY "conf"
617 #define NETWORK_DIRECTORY "network"
619 #define GFX_CLASSIC_SUBDIR "gfx_classic"
620 #define SND_CLASSIC_SUBDIR "snd_classic"
621 #define MUS_CLASSIC_SUBDIR "mus_classic"
623 #define GFX_DEFAULT_SUBDIR (setup.internal.default_graphics_set)
624 #define SND_DEFAULT_SUBDIR (setup.internal.default_sounds_set)
625 #define MUS_DEFAULT_SUBDIR (setup.internal.default_music_set)
627 #define GFX_FALLBACK_FILENAME (setup.internal.fallback_graphics_file)
628 #define SND_FALLBACK_FILENAME (setup.internal.fallback_sounds_file)
629 #define MUS_FALLBACK_FILENAME (setup.internal.fallback_music_file)
631 #define DEFAULT_LEVELSET (setup.internal.default_level_series)
633 // file names and filename extensions
634 #define LEVELSETUP_DIRECTORY "levelsetup"
635 #define SETUP_FILENAME "setup.conf"
636 #define AUTOSETUP_FILENAME "autosetup.conf"
637 #define LEVELSETUP_FILENAME "levelsetup.conf"
638 #define EDITORSETUP_FILENAME "editorsetup.conf"
639 #define EDITORCASCADE_FILENAME "editorcascade.conf"
640 #define HELPANIM_FILENAME "helpanim.conf"
641 #define HELPTEXT_FILENAME "helptext.conf"
642 #define LEVELINFO_FILENAME "levelinfo.conf"
643 #define GRAPHICSINFO_FILENAME "graphicsinfo.conf"
644 #define SOUNDSINFO_FILENAME "soundsinfo.conf"
645 #define MUSICINFO_FILENAME "musicinfo.conf"
646 #define ARTWORKINFO_CACHE_FILE "artworkinfo.cache"
647 #define LEVELTEMPLATE_FILENAME "template.level"
648 #define LEVELFILE_EXTENSION "level"
649 #define TAPEFILE_EXTENSION "tape"
650 #define SCOREFILE_EXTENSION "score"
652 #define GAMECONTROLLER_BASENAME "gamecontrollerdb.txt"
654 #define LOG_OUT_BASENAME "stdout.txt"
655 #define LOG_ERR_BASENAME "stderr.txt"
661 #define STRING_PARENT_DIRECTORY ".."
662 #define STRING_TOP_DIRECTORY "/"
664 #define CHAR_PATH_SEPARATOR_UNIX '/'
665 #define CHAR_PATH_SEPARATOR_DOS '\\'
667 #define STRING_PATH_SEPARATOR_UNIX "/"
668 #define STRING_PATH_SEPARATOR_DOS "\\"
670 #define STRING_NEWLINE_UNIX "\n"
671 #define STRING_NEWLINE_DOS "\r\n"
673 #if defined(PLATFORM_WIN32)
674 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_DOS
675 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_DOS
676 #define STRING_NEWLINE STRING_NEWLINE_DOS
678 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_UNIX
679 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_UNIX
680 #define STRING_NEWLINE STRING_NEWLINE_UNIX
684 // areas in bitmap PIX_DOOR
685 // meaning in PIX_DB_DOOR: (3 PAGEs)
686 // PAGEX1: 1. buffer for DOOR_1
687 // PAGEX2: 2. buffer for DOOR_1
688 // PAGEX3: buffer for animations
690 // these values are hard-coded to be able to use them in initialization
691 #define DOOR_GFX_PAGE_WIDTH 100 // should be set to "gfx.dxsize"
692 #define DOOR_GFX_PAGE_HEIGHT 280 // should be set to "gfx.dysize"
694 #define DOOR_GFX_PAGESIZE (DOOR_GFX_PAGE_WIDTH)
695 #define DOOR_GFX_PAGEX1 (0 * DOOR_GFX_PAGESIZE)
696 #define DOOR_GFX_PAGEX2 (1 * DOOR_GFX_PAGESIZE)
697 #define DOOR_GFX_PAGEX3 (2 * DOOR_GFX_PAGESIZE)
698 #define DOOR_GFX_PAGEX4 (3 * DOOR_GFX_PAGESIZE)
699 #define DOOR_GFX_PAGEX5 (4 * DOOR_GFX_PAGESIZE)
700 #define DOOR_GFX_PAGEX6 (5 * DOOR_GFX_PAGESIZE)
701 #define DOOR_GFX_PAGEX7 (6 * DOOR_GFX_PAGESIZE)
702 #define DOOR_GFX_PAGEX8 (7 * DOOR_GFX_PAGESIZE)
703 #define DOOR_GFX_PAGEY1 (0)
704 #define DOOR_GFX_PAGEY2 (DOOR_GFX_PAGE_HEIGHT)
707 // macros for version handling
708 #define VERSION_PART_1(x) ((x) / 1000000)
709 #define VERSION_PART_2(x) (((x) % 1000000) / 10000)
710 #define VERSION_PART_3(x) (((x) % 10000) / 100)
711 #define VERSION_PART_4(x) ((x) % 100)
713 #define VERSION_SUPER(x) VERSION_PART_1(x)
714 #define VERSION_MAJOR(x) VERSION_PART_2(x)
715 #define VERSION_MINOR(x) VERSION_PART_3(x)
716 #define VERSION_PATCH(x) VERSION_PART_4(x)
717 #define VERSION_IDENT(a,b,c,d) ((a) * 1000000 + (b) * 10000 + (c) * 100 + (d))
720 // macros for parent/child process identification
721 #if defined(PLATFORM_UNIX)
722 #define IS_PARENT_PROCESS() (audio.mixer_pid != getpid())
723 #define IS_CHILD_PROCESS() (audio.mixer_pid == getpid())
724 #define HAS_CHILD_PROCESS() (audio.mixer_pid > 0)
726 #define IS_PARENT_PROCESS() TRUE
727 #define IS_CHILD_PROCESS() FALSE
728 #define HAS_CHILD_PROCESS() FALSE
732 // values for artwork type
733 #define ARTWORK_TYPE_GRAPHICS 0
734 #define ARTWORK_TYPE_SOUNDS 1
735 #define ARTWORK_TYPE_MUSIC 2
737 #define NUM_ARTWORK_TYPES 3
740 // values for tree type (chosen to match artwork type)
741 #define TREE_TYPE_UNDEFINED -1
742 #define TREE_TYPE_GRAPHICS_DIR ARTWORK_TYPE_GRAPHICS
743 #define TREE_TYPE_SOUNDS_DIR ARTWORK_TYPE_SOUNDS
744 #define TREE_TYPE_MUSIC_DIR ARTWORK_TYPE_MUSIC
745 #define TREE_TYPE_LEVEL_DIR 3
746 #define TREE_TYPE_LEVEL_NR 4
748 #define NUM_BASE_TREE_TYPES 4
749 #define NUM_TREE_TYPES 5
751 #define INFOTEXT_UNDEFINED ""
752 #define INFOTEXT_GRAPHICS_DIR "Custom Graphics"
753 #define INFOTEXT_SOUNDS_DIR "Custom Sounds"
754 #define INFOTEXT_MUSIC_DIR "Custom Music"
755 #define INFOTEXT_LEVEL_DIR "Level Sets"
756 #define INFOTEXT_LEVEL_NR "Levels"
758 #define TREE_INFOTEXT(t) ((t) == TREE_TYPE_LEVEL_NR ? \
759 INFOTEXT_LEVEL_NR : \
760 (t) == TREE_TYPE_LEVEL_DIR ? \
761 INFOTEXT_LEVEL_DIR : \
762 (t) == TREE_TYPE_GRAPHICS_DIR ? \
763 INFOTEXT_GRAPHICS_DIR : \
764 (t) == TREE_TYPE_SOUNDS_DIR ? \
765 INFOTEXT_SOUNDS_DIR : \
766 (t) == TREE_TYPE_MUSIC_DIR ? \
767 INFOTEXT_MUSIC_DIR : \
770 #define TREE_USERDIR(t) ((t) == TREE_TYPE_LEVEL_DIR ? \
771 getUserLevelDir(NULL) : \
772 (t) == TREE_TYPE_GRAPHICS_DIR ? \
773 getUserGraphicsDir() : \
774 (t) == TREE_TYPE_SOUNDS_DIR ? \
775 getUserSoundsDir() : \
776 (t) == TREE_TYPE_MUSIC_DIR ? \
777 getUserMusicDir() : \
780 #define TREE_FIRST_NODE_PTR(t) ((t) == TREE_TYPE_LEVEL_DIR ? \
782 (t) == TREE_TYPE_GRAPHICS_DIR ? \
783 &artwork.gfx_first : \
784 (t) == TREE_TYPE_SOUNDS_DIR ? \
785 &artwork.snd_first : \
786 (t) == TREE_TYPE_MUSIC_DIR ? \
787 &artwork.mus_first : \
790 #define TREE_FIRST_NODE(t) ((t) == TREE_TYPE_LEVEL_DIR ? \
792 (t) == TREE_TYPE_GRAPHICS_DIR ? \
793 artwork.gfx_first : \
794 (t) == TREE_TYPE_SOUNDS_DIR ? \
795 artwork.snd_first : \
796 (t) == TREE_TYPE_MUSIC_DIR ? \
797 artwork.mus_first : \
800 // values for artwork handling
801 #define LEVELDIR_ARTWORK_SET_PTR(leveldir, type) \
802 ((type) == ARTWORK_TYPE_GRAPHICS ? \
803 &(leveldir)->graphics_set : \
804 (type) == ARTWORK_TYPE_SOUNDS ? \
805 &(leveldir)->sounds_set : \
806 &(leveldir)->music_set)
808 #define LEVELDIR_ARTWORK_SET(leveldir, type) \
809 ((type) == ARTWORK_TYPE_GRAPHICS ? \
810 (leveldir)->graphics_set : \
811 (type) == ARTWORK_TYPE_SOUNDS ? \
812 (leveldir)->sounds_set : \
813 (leveldir)->music_set)
815 #define LEVELDIR_ARTWORK_PATH_PTR(leveldir, type) \
816 ((type) == ARTWORK_TYPE_GRAPHICS ? \
817 &(leveldir)->graphics_path : \
818 (type) == ARTWORK_TYPE_SOUNDS ? \
819 &(leveldir)->sounds_path : \
820 &(leveldir)->music_path)
822 #define LEVELDIR_ARTWORK_PATH(leveldir, type) \
823 ((type) == ARTWORK_TYPE_GRAPHICS ? \
824 (leveldir)->graphics_path : \
825 (type) == ARTWORK_TYPE_SOUNDS ? \
826 (leveldir)->sounds_path : \
827 (leveldir)->music_path)
829 #define SETUP_ARTWORK_SET(setup, type) \
830 ((type) == ARTWORK_TYPE_GRAPHICS ? \
831 (setup).graphics_set : \
832 (type) == ARTWORK_TYPE_SOUNDS ? \
833 (setup).sounds_set : \
836 #define SETUP_OVERRIDE_ARTWORK(setup, type) \
837 ((type) == ARTWORK_TYPE_GRAPHICS ? \
838 (setup).override_level_graphics : \
839 (type) == ARTWORK_TYPE_SOUNDS ? \
840 (setup).override_level_sounds : \
841 (setup).override_level_music)
843 #define GFX_OVERRIDE_ARTWORK(type) \
844 ((type) == ARTWORK_TYPE_GRAPHICS ? \
845 gfx.override_level_graphics : \
846 (type) == ARTWORK_TYPE_SOUNDS ? \
847 gfx.override_level_sounds : \
848 gfx.override_level_music)
850 #define ARTWORK_FIRST_NODE(artwork, type) \
851 ((type) == ARTWORK_TYPE_GRAPHICS ? \
852 (artwork).gfx_first : \
853 (type) == ARTWORK_TYPE_SOUNDS ? \
854 (artwork).snd_first : \
857 #define ARTWORK_CURRENT_IDENTIFIER_PTR(artwork, type) \
858 ((type) == ARTWORK_TYPE_GRAPHICS ? \
859 &(artwork).gfx_current_identifier : \
860 (type) == ARTWORK_TYPE_SOUNDS ? \
861 &(artwork).snd_current_identifier : \
862 &(artwork).mus_current_identifier)
864 #define ARTWORK_CURRENT_IDENTIFIER(artwork, type) \
865 ((type) == ARTWORK_TYPE_GRAPHICS ? \
866 (artwork).gfx_current_identifier : \
867 (type) == ARTWORK_TYPE_SOUNDS ? \
868 (artwork).snd_current_identifier : \
869 (artwork).mus_current_identifier)
871 #define ARTWORKINFO_FILENAME(type) \
872 ((type) == ARTWORK_TYPE_GRAPHICS ? \
873 GRAPHICSINFO_FILENAME : \
874 (type) == ARTWORK_TYPE_SOUNDS ? \
875 SOUNDSINFO_FILENAME : \
876 (type) == ARTWORK_TYPE_MUSIC ? \
877 MUSICINFO_FILENAME : "")
879 #define ARTWORK_DIRECTORY(type) \
880 ((type) == ARTWORK_TYPE_GRAPHICS ? \
881 GRAPHICS_DIRECTORY : \
882 (type) == ARTWORK_TYPE_SOUNDS ? \
884 (type) == ARTWORK_TYPE_MUSIC ? \
885 MUSIC_DIRECTORY : "")
887 #define OPTIONS_ARTWORK_DIRECTORY(type) \
888 ((type) == ARTWORK_TYPE_GRAPHICS ? \
889 options.graphics_directory : \
890 (type) == ARTWORK_TYPE_SOUNDS ? \
891 options.sounds_directory : \
892 (type) == ARTWORK_TYPE_MUSIC ? \
893 options.music_directory : "")
895 #define USER_ARTWORK_DIRECTORY(type) \
896 ((type) == ARTWORK_TYPE_GRAPHICS ? \
897 getUserGraphicsDir() : \
898 (type) == ARTWORK_TYPE_SOUNDS ? \
899 getUserSoundsDir() : \
900 (type) == ARTWORK_TYPE_MUSIC ? \
901 getUserMusicDir() : "")
903 #define ARTWORK_DEFAULT_SUBDIR(type) \
904 ((type) == ARTWORK_TYPE_GRAPHICS ? \
905 GFX_DEFAULT_SUBDIR : \
906 (type) == ARTWORK_TYPE_SOUNDS ? \
907 SND_DEFAULT_SUBDIR : \
910 #define UPDATE_BUSY_STATE() \
912 if (gfx.draw_busy_anim_function != NULL) \
913 gfx.draw_busy_anim_function(); \
917 // structure definitions
921 char *command_basepath; // path to the program binary
922 char *command_basename; // base filename of the program binary
924 char *config_filename; // optional global program config filename
926 char *maindata_path; // main game data (installation) directory
928 char *userdata_subdir; // personal user game data directory
929 char *userdata_path; // resulting full path to game data directory
939 char *log_filename[NUM_LOGS]; // log filenames for out/err messages
940 FILE *log_file[NUM_LOGS]; // log file handles for out/err files
941 FILE *log_file_default[NUM_LOGS]; // default log file handles (out/err)
949 char *version_string;
951 char *(*window_title_function)(void);
952 void (*exit_message_function)(char *, va_list);
953 void (*exit_function)(int);
955 boolean global_scores;
956 boolean many_scores_per_name;
974 boolean uses_touch_device;
982 char *ro_base_directory;
983 char *rw_base_directory;
984 char *level_directory;
985 char *graphics_directory;
986 char *sounds_directory;
987 char *music_directory;
988 char *docs_directory;
989 char *conf_directory;
991 char *execute_command;
1002 struct VideoSystemInfo
1005 int width, height, depth;
1006 int window_width, window_height;
1007 int display_width, display_height;
1008 int screen_width, screen_height;
1009 int screen_xoffset, screen_yoffset;
1011 boolean fullscreen_available;
1012 boolean fullscreen_enabled;
1013 boolean fullscreen_initial;
1015 boolean window_scaling_available;
1016 int window_scaling_percent;
1017 char *window_scaling_quality;
1018 int screen_rendering_mode;
1021 unsigned int frame_counter;
1022 unsigned int frame_delay;
1023 unsigned int frame_delay_value;
1027 int shifted_up_pos_last;
1028 unsigned int shifted_up_delay;
1029 unsigned int shifted_up_delay_value;
1031 boolean initialized;
1034 struct AudioSystemInfo
1036 boolean sound_available;
1037 boolean loops_available;
1038 boolean music_available;
1040 boolean sound_enabled;
1041 boolean sound_deactivated; // for temporarily disabling sound
1050 int first_sound_channel;
1053 struct FontBitmapInfo
1057 int src_x, src_y; // start position of font characters
1058 int width, height; // width / height of font characters
1060 int offset_x; // offset to next font character
1061 int offset_y; // offset to next font character
1063 int draw_xoffset; // offset for drawing font characters
1064 int draw_yoffset; // offset for drawing font characters
1067 int num_chars_per_line;
1074 int real_sx, real_sy;
1075 int full_sxsize, full_sysize;
1076 int scrollbuffer_width, scrollbuffer_height;
1078 int game_tile_size, standard_tile_size;
1089 int win_xsize, win_ysize;
1091 int draw_deactivation_mask;
1092 int draw_background_mask;
1094 Bitmap *field_save_buffer;
1096 Bitmap *background_bitmap;
1097 int background_bitmap_mask;
1099 Bitmap *fade_bitmap_backup;
1100 Bitmap *fade_bitmap_source;
1101 Bitmap *fade_bitmap_target;
1102 Bitmap *fade_bitmap_black;
1104 int fade_border_source_status;
1105 int fade_border_target_status;
1106 Bitmap *masked_border_bitmap_ptr;
1108 Bitmap *final_screen_bitmap;
1110 boolean clipping_enabled;
1112 int clip_width, clip_height;
1114 boolean override_level_graphics;
1115 boolean override_level_sounds;
1116 boolean override_level_music;
1118 boolean draw_init_text;
1121 struct FontBitmapInfo *font_bitmap_info;
1122 int (*select_font_function)(int);
1123 int (*get_font_from_token_function)(char *);
1125 int anim_random_frame;
1127 void (*draw_busy_anim_function)(void);
1128 void (*draw_global_anim_function)(int, int);
1129 void (*draw_global_border_function)(int);
1130 void (*draw_tile_cursor_function)(int);
1133 int cursor_mode_override;
1134 int cursor_mode_final;
1135 int mouse_x, mouse_y;
1138 struct TileCursorInfo
1140 boolean enabled; // tile cursor generally enabled or disabled
1141 boolean active; // tile cursor activated (depending on game)
1142 boolean moving; // tile cursor moving to target position
1144 int xpos, ypos; // tile cursor level playfield position
1145 int x, y; // tile cursor current screen position
1146 int target_x, target_y; // tile cursor target screen position
1148 int sx, sy; // tile cursor screen start position
1153 boolean enabled; // overlay generally enabled or disabled
1154 boolean active; // overlay activated (depending on game mode)
1161 char grid_button[MAX_GRID_XSIZE][MAX_GRID_YSIZE];
1162 char grid_button_highlight;
1164 int grid_button_action;
1170 int nr[MAX_PLAYERS]; // joystick number for each player
1173 struct SetupJoystickInfo
1175 char *device_name; // device name of player's joystick
1177 int xleft, xmiddle, xright;
1178 int yupper, ymiddle, ylower;
1182 struct SetupKeyboardInfo
1184 Key left, right, up, down;
1188 struct SetupTouchInfo
1197 char grid_button[2][MAX_GRID_XSIZE][MAX_GRID_YSIZE];
1199 int transparency; // in percent (0 == opaque, 100 == invisible)
1200 boolean draw_outlined;
1201 boolean draw_pressed;
1203 boolean grid_initialized;
1206 struct SetupInputInfo
1208 boolean use_joystick;
1209 struct SetupJoystickInfo joy;
1210 struct SetupKeyboardInfo key;
1213 struct SetupEditorInfo
1215 boolean el_boulderdash;
1216 boolean el_emerald_mine;
1217 boolean el_emerald_mine_club;
1220 boolean el_supaplex;
1221 boolean el_diamond_caves;
1222 boolean el_dx_boulderdash;
1224 boolean el_mirror_magic;
1225 boolean el_deflektor;
1228 boolean el_steel_chars;
1232 boolean el_user_defined;
1235 boolean el_headlines;
1240 boolean show_element_token;
1242 boolean use_template_for_new_levels;
1245 struct SetupAutoSetupInfo
1247 int editor_zoom_tilesize;
1250 struct SetupEditorCascadeInfo
1263 boolean el_steel_chars;
1271 struct SetupShortcutInfo
1277 Key focus_player[MAX_PLAYERS];
1278 Key focus_player_all;
1297 struct SetupSystemInfo
1299 char *sdl_videodriver;
1300 char *sdl_audiodriver;
1301 int audio_fragment_size;
1304 struct SetupInternalInfo
1306 char *program_title;
1307 char *program_version;
1308 char *program_author;
1309 char *program_email;
1310 char *program_website;
1311 char *program_copyright;
1312 char *program_company;
1314 char *program_icon_file;
1316 char *default_graphics_set;
1317 char *default_sounds_set;
1318 char *default_music_set;
1320 char *fallback_graphics_file;
1321 char *fallback_sounds_file;
1322 char *fallback_music_file;
1324 char *default_level_series;
1326 int default_window_width;
1327 int default_window_height;
1329 boolean choose_from_top_leveldir;
1330 boolean show_scaling_in_title;
1331 boolean create_user_levelset;
1334 boolean menu_engines;
1335 boolean menu_editor;
1336 boolean menu_graphics;
1338 boolean menu_artwork;
1341 boolean menu_shortcuts;
1343 boolean menu_save_and_exit;
1346 struct SetupDebugInfo
1348 int frame_delay[10];
1349 Key frame_delay_key[10];
1350 boolean frame_delay_use_mod_key;
1351 boolean frame_delay_game_only;
1352 boolean show_frames_per_second;
1360 boolean sound_loops;
1361 boolean sound_music;
1362 boolean sound_simple;
1364 boolean scroll_delay;
1365 boolean forced_scroll_delay;
1366 int scroll_delay_value;
1367 char *engine_snapshot_mode;
1368 int engine_snapshot_memory;
1369 boolean fade_screens;
1371 boolean show_titlescreen;
1372 boolean quick_doors;
1375 boolean skip_levels;
1376 boolean increment_levels;
1377 boolean auto_play_next_level;
1378 boolean skip_scores_after_game;
1381 int window_scaling_percent;
1382 char *window_scaling_quality;
1383 char *screen_rendering_mode;
1385 boolean ask_on_escape;
1386 boolean ask_on_escape_editor;
1387 boolean ask_on_game_over;
1388 boolean quick_switch;
1389 boolean input_on_focus;
1390 boolean prefer_aga_graphics;
1391 boolean prefer_lowpass_sounds;
1392 boolean game_speed_extended;
1393 int game_frame_delay;
1394 boolean sp_show_border_elements;
1395 boolean small_game_graphics;
1396 boolean show_snapshot_buttons;
1401 int override_level_graphics; // not boolean -- can also be "AUTO"
1402 int override_level_sounds; // not boolean -- can also be "AUTO"
1403 int override_level_music; // not boolean -- can also be "AUTO"
1409 boolean network_mode;
1410 int network_player_nr;
1411 char *network_server_hostname;
1413 struct SetupAutoSetupInfo auto_setup;
1414 struct SetupEditorInfo editor;
1415 struct SetupEditorCascadeInfo editor_cascade;
1416 struct SetupShortcutInfo shortcut;
1417 struct SetupInputInfo input[MAX_PLAYERS];
1418 struct SetupTouchInfo touch;
1419 struct SetupSystemInfo system;
1420 struct SetupInternalInfo internal;
1421 struct SetupDebugInfo debug;
1423 struct OptionInfo options;
1428 struct TreeInfo **node_top; // topmost node in tree
1429 struct TreeInfo *node_parent; // parent level directory info
1430 struct TreeInfo *node_group; // level group sub-directory info
1431 struct TreeInfo *next; // next level series structure node
1433 int cl_first; // internal control field for setup screen
1434 int cl_cursor; // internal control field for setup screen
1436 int type; // type of tree content
1438 // fields for "type == TREE_TYPE_LEVEL_DIR"
1440 char *subdir; // tree info sub-directory basename (may be ".")
1441 char *fullpath; // complete path relative to tree base directory
1442 char *basepath; // absolute base path of tree base directory
1443 char *identifier; // identifier string for configuration files
1444 char *name; // tree info name, as displayed in selection menues
1445 char *name_sorting; // optional sorting name for correct name sorting
1446 char *author; // level or artwork author name
1447 char *year; // optional year of creation for levels or artwork
1449 char *program_title; // optional alternative text for program title
1450 char *program_copyright; // optional alternative text for program copyright
1451 char *program_company; // optional alternative text for program company
1453 char *imported_from; // optional comment for imported levels or artwork
1454 char *imported_by; // optional comment for imported levels or artwork
1455 char *tested_by; // optional comment to name people who tested a set
1457 char *graphics_set_ecs; // special EMC custom graphics set (ECS graphics)
1458 char *graphics_set_aga; // special EMC custom graphics set (AGA graphics)
1459 char *graphics_set; // optional custom graphics set (level tree only)
1460 char *sounds_set_default; // default EMC custom sounds set
1461 char *sounds_set_lowpass; // special EMC custom sounds set (lowpass filter)
1462 char *sounds_set; // optional custom sounds set (level tree only)
1463 char *music_set; // optional custom music set (level tree only)
1464 char *graphics_path; // path to optional custom graphics set (level only)
1465 char *sounds_path; // path to optional custom sounds set (level only)
1466 char *music_path; // path to optional custom music set (level only)
1468 char *level_filename; // filename of level file (for packed level file)
1469 char *level_filetype; // type of levels in level directory or level file
1471 char *special_flags; // flags for special actions performed on level file
1473 int levels; // number of levels in level series
1474 int first_level; // first level number (to allow start with 0 or 1)
1475 int last_level; // last level number (automatically calculated)
1476 int sort_priority; // sort levels by 'sort_priority' and then by name
1478 boolean latest_engine;// force level set to use the latest game engine
1480 boolean level_group; // directory contains more level series directories
1481 boolean parent_link; // entry links back to parent directory
1482 boolean in_user_dir; // user defined levels are stored in home directory
1483 boolean user_defined; // levels in user directory and marked as "private"
1484 boolean readonly; // readonly levels can not be changed with editor
1485 boolean handicap; // level set has no handicap when set to "false"
1486 boolean skip_levels; // levels can be skipped when set to "true"
1488 boolean use_emc_tiles;// use (swapped) V5/V6 EMC tiles when set to "true"
1490 int color; // color to use on selection screen for this level
1491 char *class_desc; // description of level series class
1492 int handicap_level; // number of the lowest unsolved level
1494 char *infotext; // optional text to describe the tree type (headline)
1497 typedef struct TreeInfo TreeInfo;
1498 typedef struct TreeInfo LevelDirTree;
1499 typedef struct TreeInfo ArtworkDirTree;
1500 typedef struct TreeInfo GraphicsDirTree;
1501 typedef struct TreeInfo SoundsDirTree;
1502 typedef struct TreeInfo MusicDirTree;
1506 GraphicsDirTree *gfx_first;
1507 GraphicsDirTree *gfx_current;
1508 SoundsDirTree *snd_first;
1509 SoundsDirTree *snd_current;
1510 MusicDirTree *mus_first;
1511 MusicDirTree *mus_current;
1513 char *gfx_current_identifier;
1514 char *snd_current_identifier;
1515 char *mus_current_identifier;
1518 struct ValueTextInfo
1524 struct StringValueTextInfo
1536 struct ConfigTypeInfo
1543 struct TokenIntPtrInfo
1553 char *default_filename;
1556 char **default_parameter; // array of file parameters
1557 char **parameter; // array of file parameters
1560 boolean fallback_to_default;
1561 boolean default_is_cloned;
1564 struct SetupFileList
1569 struct SetupFileList *next;
1574 char *source_filename; // primary key for node list
1578 struct PropertyMapping
1588 struct ArtworkListInfo
1590 int type; // type of artwork
1592 int num_file_list_entries;
1593 int num_dynamic_file_list_entries;
1594 struct FileInfo *file_list; // static artwork file array
1595 struct FileInfo *dynamic_file_list; // dynamic artwrk file array
1597 int num_suffix_list_entries;
1598 struct ConfigTypeInfo *suffix_list; // parameter suffixes array
1600 int num_base_prefixes;
1601 int num_ext1_suffixes;
1602 int num_ext2_suffixes;
1603 int num_ext3_suffixes;
1604 char **base_prefixes; // base token prefixes array
1605 char **ext1_suffixes; // property suffixes array 1
1606 char **ext2_suffixes; // property suffixes array 2
1607 char **ext3_suffixes; // property suffixes array 3
1609 int num_ignore_tokens;
1610 char **ignore_tokens; // file tokens to be ignored
1612 int num_property_mapping_entries;
1613 struct PropertyMapping *property_mapping; // mapping token -> artwork
1615 int sizeof_artwork_list_entry;
1617 struct ListNodeInfo **artwork_list; // static artwork node array
1618 struct ListNodeInfo **dynamic_artwork_list; // dynamic artwrk node array
1619 struct ListNode *content_list; // dynamic artwork node list
1621 void *(*load_artwork)(char *); // constructor function
1622 void (*free_artwork)(void *); // destructor function
1642 struct RectWithBorder
1646 int min_width, min_height;
1647 int max_width, max_height;
1668 struct DoorPartPosInfo
1675 int start_step_opening;
1676 int start_step_closing;
1677 boolean draw_masked;
1684 int xoffset; // special case for tape date and time
1685 int xoffset2; // special case for tape date
1686 int yoffset; // special case for list of preview players
1689 int size; // also used for suffix ".digits"
1691 boolean draw_masked;
1692 boolean draw_player; // special case for network player buttons
1693 int sort_priority; // also used for suffix ".draw_order"
1696 int direction; // needed for panel time/health graphics
1697 int class; // needed for panel time/health graphics
1698 int style; // needed for panel time/health graphics
1700 int tile_size; // special case for list of network players
1701 int border_size; // special case for list of preview players
1702 int vertical; // special case for list of preview players
1704 boolean redefined; // redefined by custom artwork
1707 struct MouseActionInfo
1716 int music[MAX_LEVELS];
1729 // ============================================================================
1730 // exported variables
1731 // ============================================================================
1733 extern struct ProgramInfo program;
1734 extern struct NetworkInfo network;
1735 extern struct RuntimeInfo runtime;
1736 extern struct OptionInfo options;
1737 extern struct VideoSystemInfo video;
1738 extern struct AudioSystemInfo audio;
1739 extern struct GfxInfo gfx;
1740 extern struct TileCursorInfo tile_cursor;
1741 extern struct OverlayInfo overlay;
1742 extern struct AnimInfo anim;
1743 extern struct ArtworkInfo artwork;
1744 extern struct JoystickInfo joystick;
1745 extern struct SetupInfo setup;
1747 extern LevelDirTree *leveldir_first_all;
1748 extern LevelDirTree *leveldir_first;
1749 extern LevelDirTree *leveldir_current;
1750 extern int level_nr;
1752 extern struct LevelSetInfo levelset;
1753 extern struct LevelStats level_stats[];
1755 extern DrawWindow *window;
1756 extern DrawBuffer *backbuffer;
1757 extern DrawBuffer *drawto;
1759 extern int button_status;
1760 extern boolean motion_status;
1761 extern int wheel_steps;
1762 extern boolean keyrepeat_status;
1763 extern boolean textinput_status;
1765 extern int redraw_mask;
1767 extern int FrameCounter;
1770 // function definitions
1772 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
1774 void InitNetworkInfo(boolean, boolean, boolean, char *, int);
1775 void InitRuntimeInfo(void);
1777 void InitScoresInfo(void);
1778 void SetWindowTitle(void);
1780 void InitWindowTitleFunction(char *(*window_title_function)(void));
1781 void InitExitMessageFunction(void (*exit_message_function)(char *, va_list));
1782 void InitExitFunction(void (*exit_function)(int));
1783 void InitPlatformDependentStuff(void);
1784 void ClosePlatformDependentStuff(void);
1786 void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
1787 void InitGfxTileSizeInfo(int, int);
1788 void InitGfxDoor1Info(int, int, int, int);
1789 void InitGfxDoor2Info(int, int, int, int);
1790 void InitGfxDoor3Info(int, int, int, int);
1791 void InitGfxWindowInfo(int, int);
1792 void InitGfxScrollbufferInfo(int, int);
1793 void InitGfxClipRegion(boolean, int, int, int, int);
1794 void InitGfxDrawBusyAnimFunction(void (*draw_busy_anim_function)(void));
1795 void InitGfxDrawGlobalAnimFunction(void (*draw_global_anim_function)(int, int));
1796 void InitGfxDrawGlobalBorderFunction(void (*draw_global_border_function)(int));
1797 void InitGfxDrawTileCursorFunction(void (*draw_tile_cursor_function)(int));
1798 void InitGfxCustomArtworkInfo(void);
1799 void InitGfxOtherSettings(void);
1800 void InitTileCursorInfo(void);
1801 void InitOverlayInfo(void);
1802 void SetTileCursorEnabled(boolean);
1803 void SetTileCursorActive(boolean);
1804 void SetTileCursorTargetXY(int, int);
1805 void SetTileCursorXY(int, int);
1806 void SetTileCursorSXSY(int, int);
1807 void SetOverlayEnabled(boolean);
1808 void SetOverlayActive(boolean);
1809 void SetOverlayShowGrid(boolean);
1810 boolean GetOverlayEnabled(void);
1811 boolean GetOverlayActive(void);
1812 void SetDrawDeactivationMask(int);
1813 int GetDrawDeactivationMask(void);
1814 void SetDrawBackgroundMask(int);
1815 void SetWindowBackgroundBitmap(Bitmap *);
1816 void SetMainBackgroundBitmap(Bitmap *);
1817 void SetDoorBackgroundBitmap(Bitmap *);
1818 void SetRedrawMaskFromArea(int, int, int, int);
1820 void LimitScreenUpdates(boolean);
1822 void InitVideoDefaults(void);
1823 void InitVideoDisplay(void);
1824 void CloseVideoDisplay(void);
1825 void InitVideoBuffer(int, int, int, boolean);
1826 Bitmap *CreateBitmapStruct(void);
1827 Bitmap *CreateBitmap(int, int, int);
1828 void ReCreateBitmap(Bitmap **, int, int);
1829 void FreeBitmap(Bitmap *);
1830 void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
1831 void BlitBitmapTiled(Bitmap *, Bitmap *, int, int, int, int, int, int, int,int);
1832 void FadeRectangle(int, int, int, int, int, int, int,
1833 void (*draw_border_function)(void));
1834 void FillRectangle(Bitmap *, int, int, int, int, Pixel);
1835 void ClearRectangle(Bitmap *, int, int, int, int);
1836 void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
1837 void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
1838 boolean DrawingDeactivatedField(void);
1839 boolean DrawingDeactivated(int, int, int, int);
1840 boolean DrawingOnBackground(int, int);
1841 boolean DrawingAreaChanged(void);
1842 void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int, int);
1843 void BlitTexture(Bitmap *, int, int, int, int, int, int);
1844 void BlitTextureMasked(Bitmap *, int, int, int, int, int, int);
1845 void BlitToScreen(Bitmap *, int, int, int, int, int, int);
1846 void BlitToScreenMasked(Bitmap *, int, int, int, int, int, int);
1847 void DrawSimpleBlackLine(Bitmap *, int, int, int, int);
1848 void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
1849 void DrawLines(Bitmap *, struct XY *, int, Pixel);
1850 Pixel GetPixel(Bitmap *, int, int);
1851 Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
1852 Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
1854 void KeyboardAutoRepeatOn(void);
1855 void KeyboardAutoRepeatOff(void);
1856 boolean SetVideoMode(boolean);
1857 void SetVideoFrameDelay(unsigned int);
1858 unsigned int GetVideoFrameDelay(void);
1859 boolean ChangeVideoModeIfNeeded(boolean);
1861 Bitmap *LoadImage(char *);
1862 Bitmap *LoadCustomImage(char *);
1863 void ReloadCustomImage(Bitmap *, char *);
1865 void ReCreateGameTileSizeBitmap(Bitmap **);
1866 void CreateBitmapWithSmallBitmaps(Bitmap **, int, int);
1867 void CreateBitmapTextures(Bitmap **);
1868 void FreeBitmapTextures(Bitmap **);
1869 void ScaleBitmap(Bitmap **, int);
1871 void SetMouseCursor(int);
1872 void UpdateRawMousePosition(int, int);
1873 void UpdateMousePosition(void);
1875 void OpenAudio(void);
1876 void CloseAudio(void);
1877 void SetAudioMode(boolean);
1879 void InitEventFilter(EventFilter);
1880 boolean PendingEvent(void);
1881 void WaitEvent(Event *event);
1882 void PeekEvent(Event *event);
1883 void PumpEvents(void);
1884 void CheckQuitEvent(void);
1885 Key GetEventKey(KeyEvent *, boolean);
1886 KeyMod HandleKeyModState(Key, int);
1887 KeyMod GetKeyModState(void);
1888 KeyMod GetKeyModStateFromEvents(void);
1889 void StartTextInput(int, int, int, int);
1890 void StopTextInput(void);
1891 void PushUserEvent(int, int, int);
1893 void InitJoysticks(void);
1894 boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
1895 boolean CheckJoystickOpened(int);
1896 void ClearJoystickState(void);