1 // ============================================================================
2 // Artsoft Retro-Game Library
3 // ----------------------------------------------------------------------------
4 // (c) 1995-2014 by Artsoft Entertainment
7 // https://www.artsoft.org/
8 // ----------------------------------------------------------------------------
10 // ============================================================================
19 #if defined(PLATFORM_MACOSX)
21 #elif defined(PLATFORM_WIN32)
23 #elif defined(PLATFORM_ANDROID)
25 #elif defined(PLATFORM_EMSCRIPTEN)
26 #include "emscripten.h"
32 // the additional 'b' is needed for Win32 to open files in binary mode
33 #define MODE_READ "rb"
34 #define MODE_WRITE "wb"
35 #define MODE_APPEND "ab"
37 #define DEFAULT_DEPTH 0
41 #define BLIT_INVERSE 2
42 #define BLIT_ON_BACKGROUND 3
44 // values for fullscreen status
45 #define FULLSCREEN_NOT_AVAILABLE FALSE
46 #define FULLSCREEN_AVAILABLE TRUE
48 // values for window scaling
49 #define WINDOW_SCALING_NOT_AVAILABLE FALSE
50 #define WINDOW_SCALING_AVAILABLE TRUE
52 #define MIN_WINDOW_SCALING_PERCENT 30
53 #define STD_WINDOW_SCALING_PERCENT 100
54 #define MAX_WINDOW_SCALING_PERCENT 400
55 #define STEP_WINDOW_SCALING_PERCENT 10
57 // values for window scaling quality
58 #define SCALING_QUALITY_NEAREST "nearest"
59 #define SCALING_QUALITY_LINEAR "linear"
60 #define SCALING_QUALITY_BEST "best"
62 #define SCALING_QUALITY_DEFAULT SCALING_QUALITY_LINEAR
64 // values for screen rendering mode
65 #define STR_SPECIAL_RENDERING_OFF "stream_texture_only"
66 #define STR_SPECIAL_RENDERING_BITMAP "bitmap_and_stream_texture"
67 #define STR_SPECIAL_RENDERING_TARGET "target_texture_only"
68 #define STR_SPECIAL_RENDERING_DOUBLE "stream_and_target_texture"
70 #if defined(PLATFORM_EMSCRIPTEN)
71 #define STR_SPECIAL_RENDERING_DEFAULT STR_SPECIAL_RENDERING_BITMAP
73 #define STR_SPECIAL_RENDERING_DEFAULT STR_SPECIAL_RENDERING_DOUBLE
76 #define SPECIAL_RENDERING_OFF 0
77 #define SPECIAL_RENDERING_BITMAP 1
78 #define SPECIAL_RENDERING_TARGET 2
79 #define SPECIAL_RENDERING_DOUBLE 3
81 // values for vertical screen retrace synchronization (vsync)
82 #define STR_VSYNC_MODE_OFF "off"
83 #define STR_VSYNC_MODE_NORMAL "normal"
84 #define STR_VSYNC_MODE_ADAPTIVE "adaptive"
86 #define STR_VSYNC_MODE_DEFAULT STR_VSYNC_MODE_OFF
88 #define VSYNC_MODE_OFF 0
89 #define VSYNC_MODE_NORMAL 1
90 #define VSYNC_MODE_ADAPTIVE -1
92 #define VSYNC_MODE_DEFAULT VSYNC_MODE_OFF
94 #define VSYNC_MODE_STR_TO_INT(s) \
95 (strEqual((s), STR_VSYNC_MODE_NORMAL) ? VSYNC_MODE_NORMAL : \
96 strEqual((s), STR_VSYNC_MODE_ADAPTIVE) ? VSYNC_MODE_ADAPTIVE : \
99 #define VSYNC_MODE_INT_TO_STR(i) \
100 ((i) == VSYNC_MODE_NORMAL ? STR_VSYNC_MODE_NORMAL : \
101 (i) == VSYNC_MODE_ADAPTIVE ? STR_VSYNC_MODE_ADAPTIVE : \
104 // values for network server settings
105 #define STR_NETWORK_AUTO_DETECT "auto_detect_network_server"
106 #define STR_NETWORK_AUTO_DETECT_SETUP "(auto detect network server)"
108 // values for touch control
109 #define TOUCH_CONTROL_OFF "off"
110 #define TOUCH_CONTROL_VIRTUAL_BUTTONS "virtual_buttons"
111 #define TOUCH_CONTROL_WIPE_GESTURES "wipe_gestures"
112 #define TOUCH_CONTROL_FOLLOW_FINGER "follow_finger"
114 #if defined(PLATFORM_ANDROID)
115 #define TOUCH_CONTROL_DEFAULT TOUCH_CONTROL_VIRTUAL_BUTTONS
117 #define TOUCH_CONTROL_DEFAULT TOUCH_CONTROL_OFF
120 #define TOUCH_MOVE_DISTANCE_DEFAULT 2
121 #define TOUCH_DROP_DISTANCE_DEFAULT 5
122 #define TOUCH_TRANSPARENCY_DEFAULT 50
124 #define ALPHA_FROM_TRANSPARENCY(x) ((100 - x) * SDL_ALPHA_OPAQUE / 100)
125 #define ALPHA_FADING_STEPSIZE(x) ((x) / 25)
127 // values for special settings for mobile devices
128 #if defined(PLATFORM_ANDROID)
129 #define HAS_TOUCH_DEVICE
130 #define USE_TOUCH_INPUT_OVERLAY
131 #define USE_COMPLETE_DISPLAY
132 #define HAS_SCREEN_KEYBOARD
133 #define SCREEN_KEYBOARD_POS(h) ((h) / 2)
136 // values for drag-and-drop support (some parts not added before SDL 2.0.5)
137 #if !SDL_VERSION_ATLEAST(2,0,5)
138 #define SDL_DROPTEXT (SDL_DROPFILE + 1)
139 #define SDL_DROPBEGIN (SDL_DROPFILE + 2)
140 #define SDL_DROPCOMPLETE (SDL_DROPFILE + 3)
143 // default input keys
144 #define DEFAULT_KEY_LEFT KSYM_Left
145 #define DEFAULT_KEY_RIGHT KSYM_Right
146 #define DEFAULT_KEY_UP KSYM_Up
147 #define DEFAULT_KEY_DOWN KSYM_Down
148 #if defined(PLATFORM_MACOSX)
149 #define DEFAULT_KEY_SNAP KSYM_Control_L
150 #define DEFAULT_KEY_DROP KSYM_KP_Enter
152 #define DEFAULT_KEY_SNAP KSYM_Control_L
153 #define DEFAULT_KEY_DROP KSYM_Control_R
155 #define DEFAULT_KEY_OKAY KSYM_Return
156 #define DEFAULT_KEY_CANCEL KSYM_Escape
158 // default shortcut keys
159 #define DEFAULT_KEY_SAVE_GAME KSYM_F1
160 #define DEFAULT_KEY_LOAD_GAME KSYM_F2
161 #define DEFAULT_KEY_TOGGLE_PAUSE KSYM_space
162 #define DEFAULT_KEY_FOCUS_PLAYER_1 KSYM_F5
163 #define DEFAULT_KEY_FOCUS_PLAYER_2 KSYM_F6
164 #define DEFAULT_KEY_FOCUS_PLAYER_3 KSYM_F7
165 #define DEFAULT_KEY_FOCUS_PLAYER_4 KSYM_F8
166 #define DEFAULT_KEY_FOCUS_PLAYER_ALL KSYM_F9
167 #define DEFAULT_KEY_TAPE_EJECT KSYM_UNDEFINED
168 #define DEFAULT_KEY_TAPE_EXTRA KSYM_UNDEFINED
169 #define DEFAULT_KEY_TAPE_STOP KSYM_UNDEFINED
170 #define DEFAULT_KEY_TAPE_PAUSE KSYM_UNDEFINED
171 #define DEFAULT_KEY_TAPE_RECORD KSYM_UNDEFINED
172 #define DEFAULT_KEY_TAPE_PLAY KSYM_UNDEFINED
173 #define DEFAULT_KEY_SOUND_SIMPLE KSYM_UNDEFINED
174 #define DEFAULT_KEY_SOUND_LOOPS KSYM_UNDEFINED
175 #define DEFAULT_KEY_SOUND_MUSIC KSYM_UNDEFINED
176 #define DEFAULT_KEY_SNAP_LEFT KSYM_UNDEFINED
177 #define DEFAULT_KEY_SNAP_RIGHT KSYM_UNDEFINED
178 #define DEFAULT_KEY_SNAP_UP KSYM_UNDEFINED
179 #define DEFAULT_KEY_SNAP_DOWN KSYM_UNDEFINED
181 // default debug setup keys and values
182 #define DEFAULT_FRAME_DELAY_0 20 // 100 % speed
183 #define DEFAULT_FRAME_DELAY_1 500 // 4 % speed
184 #define DEFAULT_FRAME_DELAY_2 250 // 8 % speed
185 #define DEFAULT_FRAME_DELAY_3 125 // 16 % speed
186 #define DEFAULT_FRAME_DELAY_4 60 // 33 % speed
187 #define DEFAULT_FRAME_DELAY_5 40 // 50 % speed
188 #define DEFAULT_FRAME_DELAY_6 30 // 66 % speed
189 #define DEFAULT_FRAME_DELAY_7 10 // 200 % speed
190 #define DEFAULT_FRAME_DELAY_8 5 // 400 % speed
191 #define DEFAULT_FRAME_DELAY_9 0 // maximum speed
193 #define DEFAULT_KEY_FRAME_DELAY_0 KSYM_0
194 #define DEFAULT_KEY_FRAME_DELAY_1 KSYM_1
195 #define DEFAULT_KEY_FRAME_DELAY_2 KSYM_2
196 #define DEFAULT_KEY_FRAME_DELAY_3 KSYM_3
197 #define DEFAULT_KEY_FRAME_DELAY_4 KSYM_4
198 #define DEFAULT_KEY_FRAME_DELAY_5 KSYM_5
199 #define DEFAULT_KEY_FRAME_DELAY_6 KSYM_6
200 #define DEFAULT_KEY_FRAME_DELAY_7 KSYM_7
201 #define DEFAULT_KEY_FRAME_DELAY_8 KSYM_8
202 #define DEFAULT_KEY_FRAME_DELAY_9 KSYM_9
204 #define NUM_DEBUG_FRAME_DELAY_KEYS 10
206 #define DEFAULT_FRAME_DELAY_USE_MOD_KEY FALSE
207 #define DEFAULT_FRAME_DELAY_GAME_ONLY TRUE
209 // values for key_status
210 #define KEY_NOT_PRESSED FALSE
211 #define KEY_RELEASED FALSE
212 #define KEY_PRESSED TRUE
214 // values for button status
215 #define MB_NOT_PRESSED FALSE
216 #define MB_NOT_RELEASED TRUE
217 #define MB_RELEASED FALSE
218 #define MB_PRESSED TRUE
219 #define MB_MENU_CHOICE FALSE
220 #define MB_MENU_MARK TRUE
221 #define MB_MENU_INITIALIZE (-1)
222 #define MB_MENU_LEAVE (-2)
223 #define MB_LEFTBUTTON 1
224 #define MB_MIDDLEBUTTON 2
225 #define MB_RIGHTBUTTON 3
226 #define MB_WHEEL_UP 4
227 #define MB_WHEEL_DOWN 5
228 #define MB_WHEEL_LEFT 6
229 #define MB_WHEEL_RIGHT 7
230 #define IS_WHEEL_BUTTON_VERTICAL(b) ((b) == MB_WHEEL_UP || \
231 (b) == MB_WHEEL_DOWN)
232 #define IS_WHEEL_BUTTON_HORIZONTAL(b) ((b) == MB_WHEEL_LEFT || \
233 (b) == MB_WHEEL_RIGHT)
234 #define IS_WHEEL_BUTTON(b) (IS_WHEEL_BUTTON_VERTICAL(b) || \
235 IS_WHEEL_BUTTON_HORIZONTAL(b))
236 #define DEFAULT_WHEEL_STEPS 3
238 #define BUTTON_STEPSIZE(b) ((b) == MB_LEFTBUTTON ? 1 : \
239 (b) == MB_MIDDLEBUTTON ? 5 : \
240 (b) == MB_RIGHTBUTTON ? 10 : 1)
242 // values for move directions
243 #define MV_BIT_LEFT 0
244 #define MV_BIT_RIGHT 1
246 #define MV_BIT_DOWN 3
248 #define NUM_DIRECTIONS 4
250 // diagonal movement directions are used in a different contect than buttons
251 #define MV_BIT_UPLEFT 4
252 #define MV_BIT_UPRIGHT 5
253 #define MV_BIT_DOWNLEFT 6
254 #define MV_BIT_DOWNRIGHT 7
256 #define NUM_DIRECTIONS_FULL 8
258 // values for special "button" bitmasks
262 #define NUM_PLAYER_ACTIONS 6
264 // values for special "focus player" bitmasks
265 #define BIT_SET_FOCUS 6
267 // values for drawing stages for global animations
268 #define DRAW_GLOBAL_ANIM_STAGE_1 1
269 #define DRAW_GLOBAL_ANIM_STAGE_2 2
271 // values for drawing target (various functions)
272 #define DRAW_TO_BACKBUFFER 0
273 #define DRAW_TO_FIELDBUFFER 1
274 #define DRAW_TO_SCREEN 2
275 #define DRAW_TO_FADE_SOURCE 3
276 #define DRAW_TO_FADE_TARGET 4
278 // values for move directions and special "button" key bitmasks
280 #define MV_LEFT (1 << MV_BIT_LEFT)
281 #define MV_RIGHT (1 << MV_BIT_RIGHT)
282 #define MV_UP (1 << MV_BIT_UP)
283 #define MV_DOWN (1 << MV_BIT_DOWN)
285 #define MV_UPLEFT (MV_UP | MV_LEFT)
286 #define MV_UPRIGHT (MV_UP | MV_RIGHT)
287 #define MV_DOWNLEFT (MV_DOWN | MV_LEFT)
288 #define MV_DOWNRIGHT (MV_DOWN | MV_RIGHT)
290 #define MV_HORIZONTAL (MV_LEFT | MV_RIGHT)
291 #define MV_VERTICAL (MV_UP | MV_DOWN)
292 #define MV_ALL_DIRECTIONS (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
293 #define MV_ANY_DIRECTION (MV_ALL_DIRECTIONS)
294 #define MV_NO_DIRECTION (MV_NONE)
296 #define KEY_BUTTON_1 (1 << BUTTON_1)
297 #define KEY_BUTTON_2 (1 << BUTTON_2)
298 #define KEY_BUTTON_SNAP KEY_BUTTON_1
299 #define KEY_BUTTON_DROP KEY_BUTTON_2
300 #define KEY_MOTION (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
301 #define KEY_BUTTON (KEY_BUTTON_1 | KEY_BUTTON_2)
302 #define KEY_ACTION (KEY_MOTION | KEY_BUTTON)
304 #define KEY_SET_FOCUS (1 << BIT_SET_FOCUS)
306 #define MV_DIR_FROM_BIT(x) ((x) < NUM_DIRECTIONS ? 1 << (x) : \
307 (x) == MV_BIT_UPLEFT ? MV_UPLEFT : \
308 (x) == MV_BIT_UPRIGHT ? MV_UPRIGHT : \
309 (x) == MV_BIT_DOWNLEFT ? MV_DOWNLEFT : \
310 (x) == MV_BIT_DOWNRIGHT ? MV_DOWNRIGHT : \
313 #define MV_DIR_TO_BIT(x) ((x) == MV_LEFT ? MV_BIT_LEFT : \
314 (x) == MV_RIGHT ? MV_BIT_RIGHT : \
315 (x) == MV_UP ? MV_BIT_UP : \
316 (x) == MV_DOWN ? MV_BIT_DOWN : \
317 (x) == MV_UPLEFT ? MV_BIT_UPLEFT : \
318 (x) == MV_UPRIGHT ? MV_BIT_UPRIGHT : \
319 (x) == MV_DOWNLEFT ? MV_BIT_DOWNLEFT : \
320 (x) == MV_DOWNRIGHT ? MV_BIT_DOWNRIGHT : \
323 #define MV_DIR_OPPOSITE(x) ((x) == MV_LEFT ? MV_RIGHT : \
324 (x) == MV_RIGHT ? MV_LEFT : \
325 (x) == MV_UP ? MV_DOWN : \
326 (x) == MV_DOWN ? MV_UP : \
327 (x) == MV_UPLEFT ? MV_DOWNRIGHT : \
328 (x) == MV_UPRIGHT ? MV_DOWNLEFT : \
329 (x) == MV_DOWNLEFT ? MV_UPRIGHT : \
330 (x) == MV_DOWNRIGHT ? MV_UPLEFT : \
333 // values for animation mode (frame order and direction)
334 // (stored in level files -- never change existing values)
336 #define ANIM_LOOP (1 << 0)
337 #define ANIM_LINEAR (1 << 1)
338 #define ANIM_PINGPONG (1 << 2)
339 #define ANIM_PINGPONG2 (1 << 3)
340 #define ANIM_RANDOM (1 << 4)
341 #define ANIM_CE_VALUE (1 << 5)
342 #define ANIM_CE_SCORE (1 << 6)
343 #define ANIM_CE_DELAY (1 << 7)
344 #define ANIM_REVERSE (1 << 8)
345 #define ANIM_OPAQUE_PLAYER (1 << 9)
347 // values for special (non game element) animation modes
348 // (not stored in level files -- can be changed, if needed)
349 #define ANIM_HORIZONTAL (1 << 10)
350 #define ANIM_VERTICAL (1 << 11)
351 #define ANIM_CENTERED (1 << 12)
352 #define ANIM_STATIC_PANEL (1 << 13)
353 #define ANIM_ALL (1 << 14)
354 #define ANIM_ONCE (1 << 15)
356 #define ANIM_DEFAULT ANIM_LOOP
358 // values for special drawing styles and event handling
361 // values used for crumbled graphics
362 #define STYLE_ACCURATE_BORDERS (1 << 0)
363 #define STYLE_INNER_CORNERS (1 << 1)
365 // values used for game panel graphics
366 #define STYLE_REVERSE (1 << 2)
367 #define STYLE_LEFTMOST_POSITION (1 << 3)
369 // values used for global animations
370 #define STYLE_BLOCK (1 << 4)
371 #define STYLE_PASSTHROUGH (1 << 5)
372 #define STYLE_MULTIPLE_ACTIONS (1 << 6)
374 #define STYLE_DEFAULT STYLE_NONE
376 // values for special global animation delay types
377 #define ANIM_DELAY_UNDEFINED -1
378 #define ANIM_DELAY_NONE 0
379 #define ANIM_DELAY_INIT 1
380 #define ANIM_DELAY_ANIM 2
381 #define ANIM_DELAY_POST 3
383 // values for special global animation delay actions
384 #define ANIM_DELAY_ACTION_NONE -1
386 // values for special global animation events
387 #define ANIM_EVENT_UNDEFINED -1
388 #define ANIM_EVENT_NONE 0
389 #define ANIM_EVENT_SELF (1 << 16)
390 #define ANIM_EVENT_ANY (1 << 17)
391 #define ANIM_EVENT_CLICK (1 << 18)
392 #define ANIM_EVENT_INIT (1 << 19)
393 #define ANIM_EVENT_START (1 << 20)
394 #define ANIM_EVENT_END (1 << 21)
395 #define ANIM_EVENT_POST (1 << 22)
396 #define ANIM_EVENT_UNCLICK_ANY (1 << 23)
398 // anim number: bits 0-7
399 // part number: bits 8-15
400 #define ANIM_EVENT_ANIM_BIT 0
401 #define ANIM_EVENT_PART_BIT 8
403 #define ANIM_EVENT_ANIM_MASK (0xff << ANIM_EVENT_ANIM_BIT)
404 #define ANIM_EVENT_PART_MASK (0xff << ANIM_EVENT_PART_BIT)
406 #define ANIM_EVENT_DEFAULT ANIM_EVENT_NONE
408 // values for special global animation event actions
409 #define ANIM_EVENT_ACTION_NONE -1
411 // values for fade mode
412 #define FADE_TYPE_NONE 0
413 #define FADE_TYPE_FADE_IN (1 << 0)
414 #define FADE_TYPE_FADE_OUT (1 << 1)
415 #define FADE_TYPE_TRANSFORM (1 << 2)
416 #define FADE_TYPE_CROSSFADE (1 << 3)
417 #define FADE_TYPE_MELT (1 << 4)
418 #define FADE_TYPE_CURTAIN (1 << 5)
419 #define FADE_TYPE_SKIP (1 << 6)
421 #define FADE_MODE_NONE (FADE_TYPE_NONE)
422 #define FADE_MODE_FADE_IN (FADE_TYPE_FADE_IN)
423 #define FADE_MODE_FADE_OUT (FADE_TYPE_FADE_OUT)
424 #define FADE_MODE_FADE (FADE_TYPE_FADE_IN | FADE_TYPE_FADE_OUT)
425 #define FADE_MODE_TRANSFORM (FADE_TYPE_TRANSFORM | FADE_TYPE_FADE_IN)
426 #define FADE_MODE_CROSSFADE (FADE_MODE_TRANSFORM | FADE_TYPE_CROSSFADE)
427 #define FADE_MODE_MELT (FADE_MODE_TRANSFORM | FADE_TYPE_MELT)
428 #define FADE_MODE_CURTAIN (FADE_MODE_TRANSFORM | FADE_TYPE_CURTAIN)
429 #define FADE_MODE_SKIP_FADE_IN (FADE_TYPE_SKIP | FADE_TYPE_FADE_IN)
430 #define FADE_MODE_SKIP_FADE_OUT (FADE_TYPE_SKIP | FADE_TYPE_FADE_OUT)
432 #define FADE_MODE_DEFAULT FADE_MODE_FADE
434 #define AUTO_DELAY_UNIT_MS 0
435 #define AUTO_DELAY_UNIT_FRAMES 1
437 #define AUTO_DELAY_UNIT_DEFAULT AUTO_DELAY_UNIT_MS
439 // values for toon positions
440 #define POS_UNDEFINED -1
451 // values for text alignment
452 #define ALIGN_LEFT (1 << 0)
453 #define ALIGN_RIGHT (1 << 1)
454 #define ALIGN_CENTER (1 << 2)
455 #define ALIGN_DEFAULT ALIGN_LEFT
457 #define VALIGN_TOP (1 << 0)
458 #define VALIGN_BOTTOM (1 << 1)
459 #define VALIGN_MIDDLE (1 << 2)
460 #define VALIGN_DEFAULT VALIGN_TOP
462 #define ALIGNED_XPOS(x,w,a) ((a) == ALIGN_CENTER ? (x) - (w) / 2 : \
463 (a) == ALIGN_RIGHT ? (x) - (w) : (x))
464 #define ALIGNED_YPOS(y,h,v) ((v) == VALIGN_MIDDLE ? (y) - (h) / 2 : \
465 (v) == VALIGN_BOTTOM ? (y) - (h) : (y))
466 #define ALIGNED_TEXT_XPOS(p) ALIGNED_XPOS((p)->x, (p)->width, (p)->align)
467 #define ALIGNED_TEXT_YPOS(p) ALIGNED_YPOS((p)->y, (p)->height, (p)->valign)
468 #define ALIGNED_VP_XPOS(p) ALIGNED_TEXT_XPOS(p)
469 #define ALIGNED_VP_YPOS(p) ALIGNED_TEXT_YPOS(p)
471 // values for redraw_mask
472 #define REDRAW_NONE (0)
473 #define REDRAW_ALL (1 << 0)
474 #define REDRAW_FIELD (1 << 1)
475 #define REDRAW_DOOR_1 (1 << 2)
476 #define REDRAW_DOOR_2 (1 << 3)
477 #define REDRAW_DOOR_3 (1 << 4)
478 #define REDRAW_FPS (1 << 5)
480 #define REDRAW_DOORS (REDRAW_DOOR_1 | \
484 #define IN_GFX_FIELD_PLAY(x, y) (x >= gfx.sx && x < gfx.sx + gfx.sxsize && \
485 y >= gfx.sy && y < gfx.sy + gfx.sysize)
486 #define IN_GFX_FIELD_FULL(x, y) (x >= gfx.real_sx && \
487 x < gfx.real_sx + gfx.full_sxsize && \
488 y >= gfx.real_sy && \
489 y < gfx.real_sy + gfx.full_sysize)
490 #define IN_GFX_DOOR_1(x, y) (x >= gfx.dx && x < gfx.dx + gfx.dxsize && \
491 y >= gfx.dy && y < gfx.dy + gfx.dysize)
492 #define IN_GFX_DOOR_2(x, y) (x >= gfx.vx && x < gfx.vx + gfx.vxsize && \
493 y >= gfx.vy && y < gfx.vy + gfx.vysize)
494 #define IN_GFX_DOOR_3(x, y) (x >= gfx.ex && x < gfx.ex + gfx.exsize && \
495 y >= gfx.ey && y < gfx.ey + gfx.eysize)
497 // values for mouse cursor
498 #define CURSOR_UNDEFINED -1
499 #define CURSOR_DEFAULT 0
500 #define CURSOR_NONE 1
501 #define CURSOR_PLAYFIELD 2
503 // fundamental game speed values
504 #define ONE_SECOND_DELAY 1000 // delay value for one second
505 #define MENU_FRAME_DELAY 20 // frame delay in milliseconds
506 #define GAME_FRAME_DELAY 20 // frame delay in milliseconds
507 #define FFWD_FRAME_DELAY 10 // 200% speed for fast forward
508 #define MIN_VSYNC_FRAME_DELAY 15 // minimum value for vsync to keep
509 #define MAX_VSYNC_FRAME_DELAY 16 // maximum value for vsync to work
510 #define FRAMES_PER_SECOND (ONE_SECOND_DELAY / GAME_FRAME_DELAY)
511 #define FRAMES_PER_SECOND_SP 35
513 // maximum playfield size supported by libgame functions
514 #define MAX_PLAYFIELD_WIDTH 128
515 #define MAX_PLAYFIELD_HEIGHT 128
517 // maximum number of parallel players supported by libgame functions
518 #define MAX_PLAYERS 4
520 // maximum number of player names
521 #define MAX_PLAYER_NAMES 12
523 // maximum allowed length of player name
524 #define MAX_PLAYER_NAME_LEN 10
526 // maximum number of levels in a level set
527 #define MAX_LEVELS 1000
529 // maximum number of global animation and parts
530 #define MAX_GLOBAL_ANIMS 32
531 #define MAX_GLOBAL_ANIM_PARTS 32
533 // minimum/maximum/default x/y grid size for virtual buttons
534 #define MIN_GRID_XSIZE 3
535 #define MIN_GRID_YSIZE 3
536 #define MAX_GRID_XSIZE 32
537 #define MAX_GRID_YSIZE 32
538 #define GRID_REAL_WIDTH MAX(1, MAX(video.screen_width, \
539 video.screen_height))
540 #define GRID_REAL_HEIGHT MAX(1, MIN(video.screen_width, \
541 video.screen_height))
542 #define DEFAULT_GRID_XSIZE_0 18
543 #define DEFAULT_GRID_YSIZE_0 MIN(MAX(MIN_GRID_YSIZE, \
544 DEFAULT_GRID_XSIZE_0 * \
548 #define DEFAULT_GRID_XSIZE_1 13
549 #define DEFAULT_GRID_YSIZE_1 MIN(MAX(MIN_GRID_YSIZE, \
550 DEFAULT_GRID_XSIZE_1 * \
555 #define DEFAULT_GRID_XSIZE(n) ((n) == 0 ? DEFAULT_GRID_XSIZE_0 : \
556 DEFAULT_GRID_XSIZE_1)
557 #define DEFAULT_GRID_YSIZE(n) ((n) == 0 ? DEFAULT_GRID_YSIZE_0 : \
558 DEFAULT_GRID_YSIZE_1)
560 #define GRID_ACTIVE_NR() (video.screen_width > \
561 video.screen_height ? 0 : 1)
563 // values for grid button characters for virtual buttons
564 #define CHAR_GRID_BUTTON_NONE ' '
565 #define CHAR_GRID_BUTTON_LEFT '<'
566 #define CHAR_GRID_BUTTON_RIGHT '>'
567 #define CHAR_GRID_BUTTON_UP '^'
568 #define CHAR_GRID_BUTTON_DOWN 'v'
569 #define CHAR_GRID_BUTTON_SNAP '1'
570 #define CHAR_GRID_BUTTON_DROP '2'
572 #define GET_ACTION_FROM_GRID_BUTTON(c) ((c) == CHAR_GRID_BUTTON_LEFT ? \
574 (c) == CHAR_GRID_BUTTON_RIGHT ? \
576 (c) == CHAR_GRID_BUTTON_UP ? \
578 (c) == CHAR_GRID_BUTTON_DOWN ? \
580 (c) == CHAR_GRID_BUTTON_SNAP ? \
582 (c) == CHAR_GRID_BUTTON_DROP ? \
586 // maximum number of level sets in the level set history
587 #define MAX_LEVELDIR_HISTORY 12
589 // default name for empty highscore entry
590 #define EMPTY_PLAYER_NAME "no name"
592 // default name for unknown player names
593 #define ANONYMOUS_NAME "anonymous"
595 // default for other unknown names
596 #define UNKNOWN_NAME "unknown"
598 // default name for new levels
599 #define NAMELESS_LEVEL_NAME "nameless level"
601 // default text for non-existant artwork
602 #define NOT_AVAILABLE "(not available)"
604 // default value for undefined filename
605 #define UNDEFINED_FILENAME "[NONE]"
607 // default value for undefined levelset
608 #define UNDEFINED_LEVELSET "[NONE]"
610 // default value for undefined parameter
611 #define ARG_DEFAULT "[DEFAULT]"
613 // default values for undefined configuration file parameters
614 #define ARG_UNDEFINED "-1000000"
615 #define ARG_UNDEFINED_VALUE (-1000000)
617 // default value for off-screen positions
618 #define POS_OFFSCREEN (-1000000)
620 // definitions for game sub-directories
622 #define RO_GAME_DIR "."
626 #define RW_GAME_DIR "."
629 #define RO_BASE_PATH RO_GAME_DIR
630 #define RW_BASE_PATH RW_GAME_DIR
633 #define GRAPHICS_DIRECTORY "graphics"
634 #define SOUNDS_DIRECTORY "sounds"
635 #define MUSIC_DIRECTORY "music"
636 #define LEVELS_DIRECTORY "levels"
637 #define TAPES_DIRECTORY "tapes"
638 #define SCORES_DIRECTORY "scores"
639 #define DOCS_DIRECTORY "docs"
640 #define CACHE_DIRECTORY "cache"
641 #define CONF_DIRECTORY "conf"
642 #define NETWORK_DIRECTORY "network"
643 #define USERS_DIRECTORY "users"
645 #define GFX_CLASSIC_SUBDIR "gfx_classic"
646 #define SND_CLASSIC_SUBDIR "snd_classic"
647 #define MUS_CLASSIC_SUBDIR "mus_classic"
649 #define GFX_DEFAULT_SUBDIR (setup.internal.default_graphics_set)
650 #define SND_DEFAULT_SUBDIR (setup.internal.default_sounds_set)
651 #define MUS_DEFAULT_SUBDIR (setup.internal.default_music_set)
653 #define GFX_FALLBACK_FILENAME (setup.internal.fallback_graphics_file)
654 #define SND_FALLBACK_FILENAME (setup.internal.fallback_sounds_file)
655 #define MUS_FALLBACK_FILENAME (setup.internal.fallback_music_file)
657 #define DEFAULT_LEVELSET (setup.internal.default_level_series)
659 // file names and filename extensions
660 #define LEVELSETUP_DIRECTORY "levelsetup"
661 #define SETUP_FILENAME "setup.conf"
662 #define USERSETUP_FILENAME "usersetup.conf"
663 #define AUTOSETUP_FILENAME "autosetup.conf"
664 #define LEVELSETUP_FILENAME "levelsetup.conf"
665 #define EDITORSETUP_FILENAME "editorsetup.conf"
666 #define EDITORCASCADE_FILENAME "editorcascade.conf"
667 #define HELPANIM_FILENAME "helpanim.conf"
668 #define HELPTEXT_FILENAME "helptext.conf"
669 #define LEVELINFO_FILENAME "levelinfo.conf"
670 #define GRAPHICSINFO_FILENAME "graphicsinfo.conf"
671 #define SOUNDSINFO_FILENAME "soundsinfo.conf"
672 #define MUSICINFO_FILENAME "musicinfo.conf"
673 #define ARTWORKINFO_CACHE_FILE "artworkinfo.cache"
674 #define LEVELTEMPLATE_FILENAME "template.level"
675 #define LEVELFILE_EXTENSION "level"
676 #define TAPEFILE_EXTENSION "tape"
677 #define SCOREFILE_EXTENSION "score"
679 #define GAMECONTROLLER_BASENAME "gamecontrollerdb.txt"
681 #define LOG_OUT_BASENAME "stdout.txt"
682 #define LOG_ERR_BASENAME "stderr.txt"
688 #define STRING_PARENT_DIRECTORY ".."
689 #define STRING_TOP_DIRECTORY "/"
691 #define CHAR_PATH_SEPARATOR_UNIX '/'
692 #define CHAR_PATH_SEPARATOR_DOS '\\'
694 #define STRING_PATH_SEPARATOR_UNIX "/"
695 #define STRING_PATH_SEPARATOR_DOS "\\"
697 #define STRING_NEWLINE_UNIX "\n"
698 #define STRING_NEWLINE_DOS "\r\n"
700 #if defined(PLATFORM_WIN32)
701 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_DOS
702 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_DOS
703 #define STRING_NEWLINE STRING_NEWLINE_DOS
705 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_UNIX
706 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_UNIX
707 #define STRING_NEWLINE STRING_NEWLINE_UNIX
711 // areas in bitmap PIX_DOOR
712 // meaning in PIX_DB_DOOR: (3 PAGEs)
713 // PAGEX1: 1. buffer for DOOR_1
714 // PAGEX2: 2. buffer for DOOR_1
715 // PAGEX3: buffer for animations
717 // these values are hard-coded to be able to use them in initialization
718 #define DOOR_GFX_PAGE_WIDTH 100 // should be set to "gfx.dxsize"
719 #define DOOR_GFX_PAGE_HEIGHT 280 // should be set to "gfx.dysize"
721 #define DOOR_GFX_PAGESIZE (DOOR_GFX_PAGE_WIDTH)
722 #define DOOR_GFX_PAGEX1 (0 * DOOR_GFX_PAGESIZE)
723 #define DOOR_GFX_PAGEX2 (1 * DOOR_GFX_PAGESIZE)
724 #define DOOR_GFX_PAGEX3 (2 * DOOR_GFX_PAGESIZE)
725 #define DOOR_GFX_PAGEX4 (3 * DOOR_GFX_PAGESIZE)
726 #define DOOR_GFX_PAGEX5 (4 * DOOR_GFX_PAGESIZE)
727 #define DOOR_GFX_PAGEX6 (5 * DOOR_GFX_PAGESIZE)
728 #define DOOR_GFX_PAGEX7 (6 * DOOR_GFX_PAGESIZE)
729 #define DOOR_GFX_PAGEX8 (7 * DOOR_GFX_PAGESIZE)
730 #define DOOR_GFX_PAGEY1 (0)
731 #define DOOR_GFX_PAGEY2 (DOOR_GFX_PAGE_HEIGHT)
734 // macros for version handling
735 #define VERSION_PART_1(x) ((x) / 1000000)
736 #define VERSION_PART_2(x) (((x) % 1000000) / 10000)
737 #define VERSION_PART_3(x) (((x) % 10000) / 100)
738 #define VERSION_PART_4(x) ((x) % 100)
740 #define VERSION_SUPER(x) VERSION_PART_1(x)
741 #define VERSION_MAJOR(x) VERSION_PART_2(x)
742 #define VERSION_MINOR(x) VERSION_PART_3(x)
743 #define VERSION_PATCH(x) VERSION_PART_4(x)
744 #define VERSION_IDENT(a,b,c,d) ((a) * 1000000 + (b) * 10000 + (c) * 100 + (d))
747 // macros for parent/child process identification
748 #if defined(PLATFORM_UNIX)
749 #define IS_PARENT_PROCESS() (audio.mixer_pid != getpid())
750 #define IS_CHILD_PROCESS() (audio.mixer_pid == getpid())
751 #define HAS_CHILD_PROCESS() (audio.mixer_pid > 0)
753 #define IS_PARENT_PROCESS() TRUE
754 #define IS_CHILD_PROCESS() FALSE
755 #define HAS_CHILD_PROCESS() FALSE
759 // values for artwork type
760 #define ARTWORK_TYPE_GRAPHICS 0
761 #define ARTWORK_TYPE_SOUNDS 1
762 #define ARTWORK_TYPE_MUSIC 2
764 #define NUM_ARTWORK_TYPES 3
767 // values for tree type (chosen to match artwork type)
768 #define TREE_TYPE_UNDEFINED -1
769 #define TREE_TYPE_GRAPHICS_DIR ARTWORK_TYPE_GRAPHICS
770 #define TREE_TYPE_SOUNDS_DIR ARTWORK_TYPE_SOUNDS
771 #define TREE_TYPE_MUSIC_DIR ARTWORK_TYPE_MUSIC
772 #define TREE_TYPE_LEVEL_DIR 3
773 #define TREE_TYPE_LEVEL_NR 4
774 #define TREE_TYPE_PLAYER_NAME 5
776 #define NUM_BASE_TREE_TYPES 4
777 #define NUM_TREE_TYPES 6
779 #define TREE_TYPE_IS_DIR(type) ((type) == TREE_TYPE_GRAPHICS_DIR || \
780 (type) == TREE_TYPE_SOUNDS_DIR || \
781 (type) == TREE_TYPE_MUSIC_DIR || \
782 (type) == TREE_TYPE_LEVEL_DIR)
784 #define INFOTEXT_UNDEFINED ""
785 #define INFOTEXT_GRAPHICS_DIR "Custom Graphics"
786 #define INFOTEXT_SOUNDS_DIR "Custom Sounds"
787 #define INFOTEXT_MUSIC_DIR "Custom Music"
788 #define INFOTEXT_LEVEL_DIR "Level Sets"
789 #define INFOTEXT_LEVEL_NR "Levels"
790 #define INFOTEXT_PLAYER_NAME "Players & Teams"
792 #define BACKLINK_TEXT_MAIN ".. (main menu)"
793 #define BACKLINK_TEXT_SETUP ".. (setup menu)"
794 #define BACKLINK_TEXT_PARENT ".. (parent directory)"
796 #define TREE_INFOTEXT(t) ((t) == TREE_TYPE_PLAYER_NAME ? \
797 INFOTEXT_PLAYER_NAME : \
798 (t) == TREE_TYPE_LEVEL_NR ? \
799 INFOTEXT_LEVEL_NR : \
800 (t) == TREE_TYPE_LEVEL_DIR ? \
801 INFOTEXT_LEVEL_DIR : \
802 (t) == TREE_TYPE_GRAPHICS_DIR ? \
803 INFOTEXT_GRAPHICS_DIR : \
804 (t) == TREE_TYPE_SOUNDS_DIR ? \
805 INFOTEXT_SOUNDS_DIR : \
806 (t) == TREE_TYPE_MUSIC_DIR ? \
807 INFOTEXT_MUSIC_DIR : \
810 #define TREE_BACKLINK_TEXT(t) ((t) == TREE_TYPE_LEVEL_DIR ? \
811 BACKLINK_TEXT_MAIN : \
814 #define TREE_USERDIR(t) ((t) == TREE_TYPE_LEVEL_DIR ? \
815 getUserLevelDir(NULL) : \
816 (t) == TREE_TYPE_GRAPHICS_DIR ? \
817 getUserGraphicsDir() : \
818 (t) == TREE_TYPE_SOUNDS_DIR ? \
819 getUserSoundsDir() : \
820 (t) == TREE_TYPE_MUSIC_DIR ? \
821 getUserMusicDir() : \
824 #define TREE_FIRST_NODE_PTR(t) ((t) == TREE_TYPE_LEVEL_DIR ? \
826 (t) == TREE_TYPE_GRAPHICS_DIR ? \
827 &artwork.gfx_first : \
828 (t) == TREE_TYPE_SOUNDS_DIR ? \
829 &artwork.snd_first : \
830 (t) == TREE_TYPE_MUSIC_DIR ? \
831 &artwork.mus_first : \
834 #define TREE_FIRST_NODE(t) ((t) == TREE_TYPE_LEVEL_DIR ? \
836 (t) == TREE_TYPE_GRAPHICS_DIR ? \
837 artwork.gfx_first : \
838 (t) == TREE_TYPE_SOUNDS_DIR ? \
839 artwork.snd_first : \
840 (t) == TREE_TYPE_MUSIC_DIR ? \
841 artwork.mus_first : \
844 // values for artwork handling
845 #define LEVELDIR_ARTWORK_SET_PTR(leveldir, type) \
846 ((type) == ARTWORK_TYPE_GRAPHICS ? \
847 &(leveldir)->graphics_set : \
848 (type) == ARTWORK_TYPE_SOUNDS ? \
849 &(leveldir)->sounds_set : \
850 &(leveldir)->music_set)
852 #define LEVELDIR_ARTWORK_SET(leveldir, type) \
853 ((type) == ARTWORK_TYPE_GRAPHICS ? \
854 (leveldir)->graphics_set : \
855 (type) == ARTWORK_TYPE_SOUNDS ? \
856 (leveldir)->sounds_set : \
857 (leveldir)->music_set)
859 #define LEVELDIR_ARTWORK_PATH_PTR(leveldir, type) \
860 ((type) == ARTWORK_TYPE_GRAPHICS ? \
861 &(leveldir)->graphics_path : \
862 (type) == ARTWORK_TYPE_SOUNDS ? \
863 &(leveldir)->sounds_path : \
864 &(leveldir)->music_path)
866 #define LEVELDIR_ARTWORK_PATH(leveldir, type) \
867 ((type) == ARTWORK_TYPE_GRAPHICS ? \
868 (leveldir)->graphics_path : \
869 (type) == ARTWORK_TYPE_SOUNDS ? \
870 (leveldir)->sounds_path : \
871 (leveldir)->music_path)
873 #define SETUP_ARTWORK_SET(setup, type) \
874 ((type) == ARTWORK_TYPE_GRAPHICS ? \
875 (setup).graphics_set : \
876 (type) == ARTWORK_TYPE_SOUNDS ? \
877 (setup).sounds_set : \
880 #define SETUP_OVERRIDE_ARTWORK(setup, type) \
881 ((type) == ARTWORK_TYPE_GRAPHICS ? \
882 (setup).override_level_graphics : \
883 (type) == ARTWORK_TYPE_SOUNDS ? \
884 (setup).override_level_sounds : \
885 (setup).override_level_music)
887 #define GFX_OVERRIDE_ARTWORK(type) \
888 ((type) == ARTWORK_TYPE_GRAPHICS ? \
889 gfx.override_level_graphics : \
890 (type) == ARTWORK_TYPE_SOUNDS ? \
891 gfx.override_level_sounds : \
892 gfx.override_level_music)
894 #define ARTWORK_FIRST_NODE(artwork, type) \
895 ((type) == ARTWORK_TYPE_GRAPHICS ? \
896 (artwork).gfx_first : \
897 (type) == ARTWORK_TYPE_SOUNDS ? \
898 (artwork).snd_first : \
901 #define ARTWORK_CURRENT_PTR(artwork, type) \
902 ((type) == ARTWORK_TYPE_GRAPHICS ? \
903 &(artwork).gfx_current : \
904 (type) == ARTWORK_TYPE_SOUNDS ? \
905 &(artwork).snd_current : \
906 &(artwork).mus_current)
908 #define ARTWORK_CURRENT(artwork, type) \
909 ((type) == ARTWORK_TYPE_GRAPHICS ? \
910 (artwork).gfx_current : \
911 (type) == ARTWORK_TYPE_SOUNDS ? \
912 (artwork).snd_current : \
913 (artwork).mus_current)
915 #define ARTWORK_CURRENT_IDENTIFIER_PTR(artwork, type) \
916 ((type) == ARTWORK_TYPE_GRAPHICS ? \
917 &(artwork).gfx_current_identifier : \
918 (type) == ARTWORK_TYPE_SOUNDS ? \
919 &(artwork).snd_current_identifier : \
920 &(artwork).mus_current_identifier)
922 #define ARTWORK_CURRENT_IDENTIFIER(artwork, type) \
923 ((type) == ARTWORK_TYPE_GRAPHICS ? \
924 (artwork).gfx_current_identifier : \
925 (type) == ARTWORK_TYPE_SOUNDS ? \
926 (artwork).snd_current_identifier : \
927 (artwork).mus_current_identifier)
929 #define ARTWORKINFO_FILENAME(type) \
930 ((type) == ARTWORK_TYPE_GRAPHICS ? \
931 GRAPHICSINFO_FILENAME : \
932 (type) == ARTWORK_TYPE_SOUNDS ? \
933 SOUNDSINFO_FILENAME : \
934 (type) == ARTWORK_TYPE_MUSIC ? \
935 MUSICINFO_FILENAME : "")
937 #define ARTWORK_DIRECTORY(type) \
938 ((type) == ARTWORK_TYPE_GRAPHICS ? \
939 GRAPHICS_DIRECTORY : \
940 (type) == ARTWORK_TYPE_SOUNDS ? \
942 (type) == ARTWORK_TYPE_MUSIC ? \
943 MUSIC_DIRECTORY : "")
945 #define OPTIONS_ARTWORK_DIRECTORY(type) \
946 ((type) == ARTWORK_TYPE_GRAPHICS ? \
947 options.graphics_directory : \
948 (type) == ARTWORK_TYPE_SOUNDS ? \
949 options.sounds_directory : \
950 (type) == ARTWORK_TYPE_MUSIC ? \
951 options.music_directory : "")
953 #define USER_ARTWORK_DIRECTORY(type) \
954 ((type) == ARTWORK_TYPE_GRAPHICS ? \
955 getUserGraphicsDir() : \
956 (type) == ARTWORK_TYPE_SOUNDS ? \
957 getUserSoundsDir() : \
958 (type) == ARTWORK_TYPE_MUSIC ? \
959 getUserMusicDir() : "")
961 #define ARTWORK_DEFAULT_SUBDIR(type) \
962 ((type) == ARTWORK_TYPE_GRAPHICS ? \
963 GFX_DEFAULT_SUBDIR : \
964 (type) == ARTWORK_TYPE_SOUNDS ? \
965 SND_DEFAULT_SUBDIR : \
968 #define UPDATE_BUSY_STATE() \
970 if (gfx.draw_busy_anim_function != NULL) \
971 gfx.draw_busy_anim_function(); \
975 // structure definitions
979 char *command_basepath; // path to the program binary
980 char *command_basename; // base filename of the program binary
982 char *config_filename; // optional global program config filename
984 char *maindata_path; // main game data (installation) directory
986 char *userdata_subdir; // personal user game data directory
987 char *userdata_path; // resulting full path to game data directory
997 char *log_filename[NUM_LOGS]; // log filenames for out/err messages
998 FILE *log_file[NUM_LOGS]; // log file handles for out/err files
999 FILE *log_file_default[NUM_LOGS]; // default log file handles (out/err)
1007 char *version_string;
1009 char *(*window_title_function)(void);
1010 void (*exit_message_function)(char *, va_list);
1011 void (*exit_function)(int);
1013 boolean global_scores;
1014 boolean many_scores_per_name;
1028 SDL_Thread *server_thread;
1029 boolean is_server_thread;
1034 boolean uses_touch_device;
1042 char *ro_base_directory;
1043 char *rw_base_directory;
1044 char *level_directory;
1045 char *graphics_directory;
1046 char *sounds_directory;
1047 char *music_directory;
1048 char *docs_directory;
1049 char *conf_directory;
1051 char *execute_command;
1053 char *special_flags;
1063 struct VideoSystemInfo
1066 int width, height, depth;
1067 int window_width, window_height;
1068 int display_width, display_height;
1069 int screen_width, screen_height;
1070 int screen_xoffset, screen_yoffset;
1072 boolean fullscreen_available;
1073 boolean fullscreen_enabled;
1074 boolean fullscreen_initial;
1076 boolean window_scaling_available;
1077 int window_scaling_percent;
1078 char *window_scaling_quality;
1079 int screen_rendering_mode;
1082 unsigned int frame_counter;
1083 unsigned int frame_delay;
1084 unsigned int frame_delay_value;
1088 int shifted_up_pos_last;
1089 unsigned int shifted_up_delay;
1090 unsigned int shifted_up_delay_value;
1092 boolean initialized;
1095 struct AudioSystemInfo
1097 boolean sound_available;
1098 boolean loops_available;
1099 boolean music_available;
1101 boolean sound_enabled;
1102 boolean sound_deactivated; // for temporarily disabling sound
1111 int first_sound_channel;
1114 struct FontBitmapInfo
1118 int src_x, src_y; // start position of font characters
1119 int width, height; // width / height of font characters
1121 int offset_x; // offset to next font character
1122 int offset_y; // offset to next font character
1124 int draw_xoffset; // offset for drawing font characters
1125 int draw_yoffset; // offset for drawing font characters
1128 int num_chars_per_line;
1135 int real_sx, real_sy;
1136 int full_sxsize, full_sysize;
1137 int scrollbuffer_width, scrollbuffer_height;
1139 int game_tile_size, standard_tile_size;
1150 int win_xsize, win_ysize;
1152 int draw_deactivation_mask;
1153 int draw_background_mask;
1155 Bitmap *field_save_buffer;
1157 Bitmap *background_bitmap;
1158 int background_bitmap_mask;
1160 Bitmap *fade_bitmap_backup;
1161 Bitmap *fade_bitmap_source;
1162 Bitmap *fade_bitmap_target;
1163 Bitmap *fade_bitmap_black;
1165 int fade_border_source_status;
1166 int fade_border_target_status;
1167 Bitmap *masked_border_bitmap_ptr;
1169 Bitmap *final_screen_bitmap;
1171 boolean clipping_enabled;
1173 int clip_width, clip_height;
1175 boolean override_level_graphics;
1176 boolean override_level_sounds;
1177 boolean override_level_music;
1179 boolean draw_init_text;
1182 struct FontBitmapInfo *font_bitmap_info;
1183 int (*select_font_function)(int);
1184 int (*get_font_from_token_function)(char *);
1186 int anim_random_frame;
1188 void (*draw_busy_anim_function)(void);
1189 void (*draw_global_anim_function)(int, int);
1190 void (*draw_global_border_function)(int);
1191 void (*draw_tile_cursor_function)(int);
1194 int cursor_mode_override;
1195 int cursor_mode_final;
1196 int mouse_x, mouse_y;
1199 struct TileCursorInfo
1201 boolean enabled; // tile cursor generally enabled or disabled
1202 boolean active; // tile cursor activated (depending on game)
1203 boolean moving; // tile cursor moving to target position
1205 int xpos, ypos; // tile cursor level playfield position
1206 int x, y; // tile cursor current screen position
1207 int target_x, target_y; // tile cursor target screen position
1209 int sx, sy; // tile cursor screen start position
1211 boolean xsn_debug; // enable or disable XSN debugging
1216 boolean enabled; // overlay generally enabled or disabled
1217 boolean active; // overlay activated (depending on game mode)
1224 char grid_button[MAX_GRID_XSIZE][MAX_GRID_YSIZE];
1225 char grid_button_highlight;
1227 int grid_button_action;
1233 int nr[MAX_PLAYERS]; // joystick number for each player
1236 struct SetupJoystickInfo
1238 char *device_name; // device name of player's joystick
1240 int xleft, xmiddle, xright;
1241 int yupper, ymiddle, ylower;
1245 struct SetupKeyboardInfo
1247 Key left, right, up, down;
1251 struct SetupTouchInfo
1260 char grid_button[2][MAX_GRID_XSIZE][MAX_GRID_YSIZE];
1262 int transparency; // in percent (0 == opaque, 100 == invisible)
1263 boolean draw_outlined;
1264 boolean draw_pressed;
1266 boolean grid_initialized;
1269 struct SetupInputInfo
1271 boolean use_joystick;
1272 struct SetupJoystickInfo joy;
1273 struct SetupKeyboardInfo key;
1276 struct SetupEditorInfo
1278 boolean el_boulderdash;
1279 boolean el_emerald_mine;
1280 boolean el_emerald_mine_club;
1283 boolean el_supaplex;
1284 boolean el_diamond_caves;
1285 boolean el_dx_boulderdash;
1287 boolean el_mirror_magic;
1288 boolean el_deflektor;
1291 boolean el_steel_chars;
1295 boolean el_user_defined;
1298 boolean el_headlines;
1303 boolean show_element_token;
1305 boolean show_read_only_warning;
1307 boolean use_template_for_new_levels;
1310 struct SetupAutoSetupInfo
1312 int editor_zoom_tilesize;
1315 struct SetupLevelSetupInfo
1317 char *last_level_series[MAX_LEVELDIR_HISTORY + 1];
1320 struct SetupEditorCascadeInfo
1333 boolean el_steel_chars;
1341 struct SetupShortcutInfo
1347 Key focus_player[MAX_PLAYERS];
1348 Key focus_player_all;
1367 struct SetupSystemInfo
1369 char *sdl_renderdriver;
1370 char *sdl_videodriver;
1371 char *sdl_audiodriver;
1372 int audio_fragment_size;
1375 struct SetupInternalInfo
1377 char *program_title;
1378 char *program_version;
1379 char *program_author;
1380 char *program_email;
1381 char *program_website;
1382 char *program_copyright;
1383 char *program_company;
1385 char *program_icon_file;
1387 char *default_graphics_set;
1388 char *default_sounds_set;
1389 char *default_music_set;
1391 char *fallback_graphics_file;
1392 char *fallback_sounds_file;
1393 char *fallback_music_file;
1395 char *default_level_series;
1397 int default_window_width;
1398 int default_window_height;
1400 boolean choose_from_top_leveldir;
1401 boolean show_scaling_in_title;
1402 boolean create_user_levelset;
1405 boolean menu_engines;
1406 boolean menu_editor;
1407 boolean menu_graphics;
1409 boolean menu_artwork;
1412 boolean menu_shortcuts;
1414 boolean menu_save_and_exit;
1417 struct SetupDebugInfo
1419 int frame_delay[10];
1420 Key frame_delay_key[10];
1421 boolean frame_delay_use_mod_key;
1422 boolean frame_delay_game_only;
1423 boolean show_frames_per_second;
1432 boolean multiple_users;
1435 boolean sound_loops;
1436 boolean sound_music;
1437 boolean sound_simple;
1439 boolean scroll_delay;
1440 boolean forced_scroll_delay;
1441 int scroll_delay_value;
1442 char *engine_snapshot_mode;
1443 int engine_snapshot_memory;
1444 boolean fade_screens;
1446 boolean show_titlescreen;
1447 boolean quick_doors;
1450 boolean skip_levels;
1451 boolean increment_levels;
1452 boolean auto_play_next_level;
1453 boolean count_score_after_game;
1454 boolean show_scores_after_game;
1457 int window_scaling_percent;
1458 char *window_scaling_quality;
1459 char *screen_rendering_mode;
1461 boolean ask_on_escape;
1462 boolean ask_on_escape_editor;
1463 boolean ask_on_game_over;
1464 boolean ask_on_quit_game;
1465 boolean ask_on_quit_program;
1466 boolean quick_switch;
1467 boolean input_on_focus;
1468 boolean prefer_aga_graphics;
1469 boolean prefer_lowpass_sounds;
1470 boolean prefer_extra_panel_items;
1471 boolean game_speed_extended;
1472 int game_frame_delay;
1473 boolean sp_show_border_elements;
1474 boolean small_game_graphics;
1475 boolean show_snapshot_buttons;
1480 int override_level_graphics; // not boolean -- can also be "AUTO"
1481 int override_level_sounds; // not boolean -- can also be "AUTO"
1482 int override_level_music; // not boolean -- can also be "AUTO"
1488 boolean network_mode;
1489 int network_player_nr;
1490 char *network_server_hostname;
1492 struct SetupAutoSetupInfo auto_setup;
1493 struct SetupLevelSetupInfo level_setup;
1495 struct SetupEditorInfo editor;
1496 struct SetupEditorCascadeInfo editor_cascade;
1497 struct SetupShortcutInfo shortcut;
1498 struct SetupInputInfo input[MAX_PLAYERS];
1499 struct SetupTouchInfo touch;
1500 struct SetupSystemInfo system;
1501 struct SetupInternalInfo internal;
1502 struct SetupDebugInfo debug;
1504 struct OptionInfo options;
1514 struct TreeInfo **node_top; // topmost node in tree
1515 struct TreeInfo *node_parent; // parent level directory info
1516 struct TreeInfo *node_group; // level group sub-directory info
1517 struct TreeInfo *next; // next level series structure node
1519 int cl_first; // internal control field for setup screen
1520 int cl_cursor; // internal control field for setup screen
1522 int type; // type of tree content
1524 // fields for "type == TREE_TYPE_LEVEL_DIR"
1526 char *subdir; // tree info sub-directory basename (may be ".")
1527 char *fullpath; // complete path relative to tree base directory
1528 char *basepath; // absolute base path of tree base directory
1529 char *identifier; // identifier string for configuration files
1530 char *name; // tree info name, as displayed in selection menues
1531 char *name_sorting; // optional sorting name for correct name sorting
1532 char *author; // level or artwork author name
1533 char *year; // optional year of creation for levels or artwork
1535 char *program_title; // optional alternative text for program title
1536 char *program_copyright; // optional alternative text for program copyright
1537 char *program_company; // optional alternative text for program company
1539 char *imported_from; // optional comment for imported levels or artwork
1540 char *imported_by; // optional comment for imported levels or artwork
1541 char *tested_by; // optional comment to name people who tested a set
1543 char *graphics_set_ecs; // special EMC custom graphics set (ECS graphics)
1544 char *graphics_set_aga; // special EMC custom graphics set (AGA graphics)
1545 char *graphics_set; // optional custom graphics set (level tree only)
1546 char *sounds_set_default; // default EMC custom sounds set
1547 char *sounds_set_lowpass; // special EMC custom sounds set (lowpass filter)
1548 char *sounds_set; // optional custom sounds set (level tree only)
1549 char *music_set; // optional custom music set (level tree only)
1550 char *graphics_path; // path to optional custom graphics set (level only)
1551 char *sounds_path; // path to optional custom sounds set (level only)
1552 char *music_path; // path to optional custom music set (level only)
1554 char *level_filename; // filename of level file (for packed level file)
1555 char *level_filetype; // type of levels in level directory or level file
1557 char *special_flags; // flags for special actions performed on level file
1559 int levels; // number of levels in level series
1560 int first_level; // first level number (to allow start with 0 or 1)
1561 int last_level; // last level number (automatically calculated)
1562 int sort_priority; // sort levels by 'sort_priority' and then by name
1564 boolean latest_engine;// force level set to use the latest game engine
1566 boolean level_group; // directory contains more level series directories
1567 boolean parent_link; // entry links back to parent directory
1568 boolean in_user_dir; // user defined levels are stored in home directory
1569 boolean user_defined; // levels in user directory and marked as "private"
1570 boolean readonly; // readonly levels can not be changed with editor
1571 boolean handicap; // level set has no handicap when set to "false"
1572 boolean skip_levels; // levels can be skipped when set to "true"
1574 boolean use_emc_tiles;// use (swapped) V5/V6 EMC tiles when set to "true"
1576 int color; // color to use on selection screen for this level
1577 char *class_desc; // description of level series class
1578 int handicap_level; // number of the lowest unsolved level
1580 char *infotext; // optional text to describe the tree type (headline)
1583 typedef struct TreeInfo TreeInfo;
1584 typedef struct TreeInfo LevelDirTree;
1585 typedef struct TreeInfo ArtworkDirTree;
1586 typedef struct TreeInfo GraphicsDirTree;
1587 typedef struct TreeInfo SoundsDirTree;
1588 typedef struct TreeInfo MusicDirTree;
1592 GraphicsDirTree *gfx_first;
1593 GraphicsDirTree *gfx_current;
1594 SoundsDirTree *snd_first;
1595 SoundsDirTree *snd_current;
1596 MusicDirTree *mus_first;
1597 MusicDirTree *mus_current;
1599 char *gfx_current_identifier;
1600 char *snd_current_identifier;
1601 char *mus_current_identifier;
1604 struct ValueTextInfo
1610 struct StringValueTextInfo
1622 struct ConfigTypeInfo
1629 struct TokenIntPtrInfo
1639 char *default_filename;
1642 char **default_parameter; // array of file parameters
1643 char **parameter; // array of file parameters
1646 boolean fallback_to_default;
1647 boolean default_is_cloned;
1650 struct SetupFileList
1655 struct SetupFileList *next;
1660 char *source_filename; // primary key for node list
1664 struct PropertyMapping
1674 struct ArtworkListInfo
1676 int type; // type of artwork
1678 int num_file_list_entries;
1679 int num_dynamic_file_list_entries;
1680 struct FileInfo *file_list; // static artwork file array
1681 struct FileInfo *dynamic_file_list; // dynamic artwrk file array
1683 int num_suffix_list_entries;
1684 struct ConfigTypeInfo *suffix_list; // parameter suffixes array
1686 int num_base_prefixes;
1687 int num_ext1_suffixes;
1688 int num_ext2_suffixes;
1689 int num_ext3_suffixes;
1690 char **base_prefixes; // base token prefixes array
1691 char **ext1_suffixes; // property suffixes array 1
1692 char **ext2_suffixes; // property suffixes array 2
1693 char **ext3_suffixes; // property suffixes array 3
1695 int num_ignore_tokens;
1696 char **ignore_tokens; // file tokens to be ignored
1698 int num_property_mapping_entries;
1699 struct PropertyMapping *property_mapping; // mapping token -> artwork
1701 int sizeof_artwork_list_entry;
1703 struct ListNodeInfo **artwork_list; // static artwork node array
1704 struct ListNodeInfo **dynamic_artwork_list; // dynamic artwrk node array
1705 struct ListNode *content_list; // dynamic artwork node list
1707 void *(*load_artwork)(char *); // constructor function
1708 void (*free_artwork)(void *); // destructor function
1728 struct RectWithBorder
1732 int min_width, min_height;
1733 int max_width, max_height;
1754 struct DoorPartPosInfo
1761 int start_step_opening;
1762 int start_step_closing;
1763 boolean draw_masked;
1770 int xoffset; // special case for tape date and time
1771 int xoffset2; // special case for tape date
1772 int yoffset; // special case for list of preview players
1775 int size; // also used for suffix ".digits"
1777 boolean draw_masked;
1778 boolean draw_player; // special case for network player buttons
1779 int sort_priority; // also used for suffix ".draw_order"
1782 int direction; // needed for panel time/health graphics
1783 int class; // needed for panel time/health graphics
1784 int style; // needed for panel time/health graphics
1786 int tile_size; // special case for list of network players
1787 int border_size; // special case for list of preview players
1788 int vertical; // special case for list of preview players
1790 boolean redefined; // redefined by custom artwork
1793 struct MouseActionInfo
1802 int music[MAX_LEVELS];
1815 // ============================================================================
1816 // exported variables
1817 // ============================================================================
1819 extern struct ProgramInfo program;
1820 extern struct NetworkInfo network;
1821 extern struct RuntimeInfo runtime;
1822 extern struct OptionInfo options;
1823 extern struct VideoSystemInfo video;
1824 extern struct AudioSystemInfo audio;
1825 extern struct GfxInfo gfx;
1826 extern struct TileCursorInfo tile_cursor;
1827 extern struct OverlayInfo overlay;
1828 extern struct AnimInfo anim;
1829 extern struct ArtworkInfo artwork;
1830 extern struct JoystickInfo joystick;
1831 extern struct SetupInfo setup;
1832 extern struct UserInfo user;
1834 extern LevelDirTree *leveldir_first_all;
1835 extern LevelDirTree *leveldir_first;
1836 extern LevelDirTree *leveldir_current;
1837 extern int level_nr;
1839 extern struct LevelSetInfo levelset;
1840 extern struct LevelStats level_stats[];
1842 extern DrawWindow *window;
1843 extern DrawBuffer *backbuffer;
1844 extern DrawBuffer *drawto;
1846 extern int button_status;
1847 extern boolean motion_status;
1848 extern int wheel_steps;
1849 extern boolean keyrepeat_status;
1850 extern boolean textinput_status;
1852 extern int redraw_mask;
1854 extern int FrameCounter;
1857 // function definitions
1859 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
1861 void InitNetworkInfo(boolean, boolean, boolean, char *, int);
1862 void InitRuntimeInfo(void);
1864 void InitScoresInfo(void);
1865 void SetWindowTitle(void);
1867 void InitWindowTitleFunction(char *(*window_title_function)(void));
1868 void InitExitMessageFunction(void (*exit_message_function)(char *, va_list));
1869 void InitExitFunction(void (*exit_function)(int));
1870 void InitPlatformDependentStuff(void);
1871 void ClosePlatformDependentStuff(void);
1873 void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
1874 void InitGfxTileSizeInfo(int, int);
1875 void InitGfxDoor1Info(int, int, int, int);
1876 void InitGfxDoor2Info(int, int, int, int);
1877 void InitGfxDoor3Info(int, int, int, int);
1878 void InitGfxWindowInfo(int, int);
1879 void InitGfxScrollbufferInfo(int, int);
1880 void InitGfxClipRegion(boolean, int, int, int, int);
1881 void InitGfxDrawBusyAnimFunction(void (*draw_busy_anim_function)(void));
1882 void InitGfxDrawGlobalAnimFunction(void (*draw_global_anim_function)(int, int));
1883 void InitGfxDrawGlobalBorderFunction(void (*draw_global_border_function)(int));
1884 void InitGfxDrawTileCursorFunction(void (*draw_tile_cursor_function)(int));
1885 void InitGfxCustomArtworkInfo(void);
1886 void InitGfxOtherSettings(void);
1887 void InitTileCursorInfo(void);
1888 void InitOverlayInfo(void);
1889 void SetOverlayGridSizeAndButtons(void);
1890 void SetTileCursorEnabled(boolean);
1891 void SetTileCursorActive(boolean);
1892 void SetTileCursorTargetXY(int, int);
1893 void SetTileCursorXY(int, int);
1894 void SetTileCursorSXSY(int, int);
1895 void SetOverlayEnabled(boolean);
1896 void SetOverlayActive(boolean);
1897 void SetOverlayShowGrid(boolean);
1898 boolean GetOverlayEnabled(void);
1899 boolean GetOverlayActive(void);
1900 void SetDrawDeactivationMask(int);
1901 int GetDrawDeactivationMask(void);
1902 void SetDrawBackgroundMask(int);
1903 void SetWindowBackgroundBitmap(Bitmap *);
1904 void SetMainBackgroundBitmap(Bitmap *);
1905 void SetDoorBackgroundBitmap(Bitmap *);
1906 void SetRedrawMaskFromArea(int, int, int, int);
1908 void LimitScreenUpdates(boolean);
1910 void InitVideoDefaults(void);
1911 void InitVideoDisplay(void);
1912 void CloseVideoDisplay(void);
1913 void InitVideoBuffer(int, int, int, boolean);
1914 Bitmap *CreateBitmapStruct(void);
1915 Bitmap *CreateBitmap(int, int, int);
1916 void ReCreateBitmap(Bitmap **, int, int);
1917 void FreeBitmap(Bitmap *);
1918 void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
1919 void BlitBitmapTiled(Bitmap *, Bitmap *, int, int, int, int, int, int, int,int);
1920 void FadeRectangle(int, int, int, int, int, int, int,
1921 void (*draw_border_function)(void));
1922 void FillRectangle(Bitmap *, int, int, int, int, Pixel);
1923 void ClearRectangle(Bitmap *, int, int, int, int);
1924 void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
1925 void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
1926 boolean DrawingDeactivatedField(void);
1927 boolean DrawingDeactivated(int, int, int, int);
1928 boolean DrawingOnBackground(int, int);
1929 boolean DrawingAreaChanged(void);
1930 void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int, int);
1931 void BlitTexture(Bitmap *, int, int, int, int, int, int);
1932 void BlitTextureMasked(Bitmap *, int, int, int, int, int, int);
1933 void BlitToScreen(Bitmap *, int, int, int, int, int, int);
1934 void BlitToScreenMasked(Bitmap *, int, int, int, int, int, int);
1935 void DrawSimpleBlackLine(Bitmap *, int, int, int, int);
1936 void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
1937 void DrawLines(Bitmap *, struct XY *, int, Pixel);
1938 Pixel GetPixel(Bitmap *, int, int);
1939 Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
1940 Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
1942 void KeyboardAutoRepeatOn(void);
1943 void KeyboardAutoRepeatOff(void);
1944 boolean SetVideoMode(boolean);
1945 void SetVideoFrameDelay(unsigned int);
1946 unsigned int GetVideoFrameDelay(void);
1947 boolean ChangeVideoModeIfNeeded(boolean);
1949 Bitmap *LoadImage(char *);
1950 Bitmap *LoadCustomImage(char *);
1951 void ReloadCustomImage(Bitmap *, char *);
1953 void ReCreateGameTileSizeBitmap(Bitmap **);
1954 void CreateBitmapWithSmallBitmaps(Bitmap **, int, int);
1955 void CreateBitmapTextures(Bitmap **);
1956 void FreeBitmapTextures(Bitmap **);
1957 void ScaleBitmap(Bitmap **, int);
1959 void SetMouseCursor(int);
1960 void UpdateRawMousePosition(int, int);
1961 void UpdateMousePosition(void);
1963 void OpenAudio(void);
1964 void CloseAudio(void);
1965 void SetAudioMode(boolean);
1967 void InitEventFilter(EventFilter);
1968 boolean PendingEvent(void);
1969 void WaitEvent(Event *event);
1970 void PeekEvent(Event *event);
1971 void PumpEvents(void);
1972 void CheckQuitEvent(void);
1973 Key GetEventKey(KeyEvent *, boolean);
1974 KeyMod HandleKeyModState(Key, int);
1975 KeyMod GetKeyModState(void);
1976 KeyMod GetKeyModStateFromEvents(void);
1977 void StartTextInput(int, int, int, int);
1978 void StopTextInput(void);
1979 void PushUserEvent(int, int, int);
1981 void InitJoysticks(void);
1982 boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
1983 boolean CheckJoystickOpened(int);
1984 void ClearJoystickState(void);