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)
30 // the additional 'b' is needed for Win32 to open files in binary mode
31 #define MODE_READ "rb"
32 #define MODE_WRITE "wb"
33 #define MODE_APPEND "ab"
35 #define DEFAULT_DEPTH 0
39 #define BLIT_INVERSE 2
40 #define BLIT_ON_BACKGROUND 3
42 // values for fullscreen status
43 #define FULLSCREEN_NOT_AVAILABLE FALSE
44 #define FULLSCREEN_AVAILABLE TRUE
46 // values for window scaling
47 #define WINDOW_SCALING_NOT_AVAILABLE FALSE
48 #define WINDOW_SCALING_AVAILABLE TRUE
50 #define MIN_WINDOW_SCALING_PERCENT 30
51 #define STD_WINDOW_SCALING_PERCENT 100
52 #define MAX_WINDOW_SCALING_PERCENT 400
53 #define STEP_WINDOW_SCALING_PERCENT 10
55 // values for window scaling quality
56 #define SCALING_QUALITY_NEAREST "nearest"
57 #define SCALING_QUALITY_LINEAR "linear"
58 #define SCALING_QUALITY_BEST "best"
60 #define SCALING_QUALITY_DEFAULT SCALING_QUALITY_LINEAR
62 // values for screen rendering mode
63 #define STR_SPECIAL_RENDERING_OFF "stream_texture_only"
64 #define STR_SPECIAL_RENDERING_BITMAP "bitmap_and_stream_texture"
65 #define STR_SPECIAL_RENDERING_TARGET "target_texture_only"
66 #define STR_SPECIAL_RENDERING_DOUBLE "stream_and_target_texture"
68 #if defined(PLATFORM_EMSCRIPTEN)
69 #define STR_SPECIAL_RENDERING_DEFAULT STR_SPECIAL_RENDERING_BITMAP
71 #define STR_SPECIAL_RENDERING_DEFAULT STR_SPECIAL_RENDERING_DOUBLE
74 #define SPECIAL_RENDERING_OFF 0
75 #define SPECIAL_RENDERING_BITMAP 1
76 #define SPECIAL_RENDERING_TARGET 2
77 #define SPECIAL_RENDERING_DOUBLE 3
79 // values for vertical screen retrace synchronization (vsync)
80 #define STR_VSYNC_MODE_OFF "off"
81 #define STR_VSYNC_MODE_NORMAL "normal"
82 #define STR_VSYNC_MODE_ADAPTIVE "adaptive"
84 #define STR_VSYNC_MODE_DEFAULT STR_VSYNC_MODE_OFF
86 #define VSYNC_MODE_OFF 0
87 #define VSYNC_MODE_NORMAL 1
88 #define VSYNC_MODE_ADAPTIVE -1
90 #define VSYNC_MODE_DEFAULT VSYNC_MODE_OFF
92 #define VSYNC_MODE_STR_TO_INT(s) \
93 (strEqual((s), STR_VSYNC_MODE_NORMAL) ? VSYNC_MODE_NORMAL : \
94 strEqual((s), STR_VSYNC_MODE_ADAPTIVE) ? VSYNC_MODE_ADAPTIVE : \
97 #define VSYNC_MODE_INT_TO_STR(i) \
98 ((i) == VSYNC_MODE_NORMAL ? STR_VSYNC_MODE_NORMAL : \
99 (i) == VSYNC_MODE_ADAPTIVE ? STR_VSYNC_MODE_ADAPTIVE : \
102 // values for network server settings
103 #define STR_NETWORK_AUTO_DETECT "auto_detect_network_server"
104 #define STR_NETWORK_AUTO_DETECT_SETUP "(auto detect network server)"
106 // values for touch control
107 #define TOUCH_CONTROL_OFF "off"
108 #define TOUCH_CONTROL_VIRTUAL_BUTTONS "virtual_buttons"
109 #define TOUCH_CONTROL_WIPE_GESTURES "wipe_gestures"
110 #define TOUCH_CONTROL_FOLLOW_FINGER "follow_finger"
112 #if defined(PLATFORM_ANDROID)
113 #define TOUCH_CONTROL_DEFAULT TOUCH_CONTROL_VIRTUAL_BUTTONS
115 #define TOUCH_CONTROL_DEFAULT TOUCH_CONTROL_OFF
118 #define TOUCH_MOVE_DISTANCE_DEFAULT 2
119 #define TOUCH_DROP_DISTANCE_DEFAULT 5
120 #define TOUCH_TRANSPARENCY_DEFAULT 50
122 #define ALPHA_FROM_TRANSPARENCY(x) ((100 - x) * SDL_ALPHA_OPAQUE / 100)
123 #define ALPHA_FADING_STEPSIZE(x) ((x) / 25)
125 // values for special settings for mobile devices
126 #if defined(PLATFORM_ANDROID)
127 #define HAS_TOUCH_DEVICE
128 #define USE_TOUCH_INPUT_OVERLAY
129 #define USE_COMPLETE_DISPLAY
130 #define HAS_SCREEN_KEYBOARD
131 #define SCREEN_KEYBOARD_POS(h) ((h) / 2)
134 // values for drag-and-drop support (some parts not added before SDL 2.0.5)
135 #if !SDL_VERSION_ATLEAST(2,0,5)
136 #define SDL_DROPTEXT (SDL_DROPFILE + 1)
137 #define SDL_DROPBEGIN (SDL_DROPFILE + 2)
138 #define SDL_DROPCOMPLETE (SDL_DROPFILE + 3)
141 // default input keys
142 #define DEFAULT_KEY_LEFT KSYM_Left
143 #define DEFAULT_KEY_RIGHT KSYM_Right
144 #define DEFAULT_KEY_UP KSYM_Up
145 #define DEFAULT_KEY_DOWN KSYM_Down
146 #if defined(PLATFORM_MACOSX)
147 #define DEFAULT_KEY_SNAP KSYM_Control_L
148 #define DEFAULT_KEY_DROP KSYM_KP_Enter
150 #define DEFAULT_KEY_SNAP KSYM_Control_L
151 #define DEFAULT_KEY_DROP KSYM_Control_R
153 #define DEFAULT_KEY_OKAY KSYM_Return
154 #define DEFAULT_KEY_CANCEL KSYM_Escape
156 // default shortcut keys
157 #define DEFAULT_KEY_SAVE_GAME KSYM_F1
158 #define DEFAULT_KEY_LOAD_GAME KSYM_F2
159 #define DEFAULT_KEY_TOGGLE_PAUSE KSYM_space
160 #define DEFAULT_KEY_FOCUS_PLAYER_1 KSYM_F5
161 #define DEFAULT_KEY_FOCUS_PLAYER_2 KSYM_F6
162 #define DEFAULT_KEY_FOCUS_PLAYER_3 KSYM_F7
163 #define DEFAULT_KEY_FOCUS_PLAYER_4 KSYM_F8
164 #define DEFAULT_KEY_FOCUS_PLAYER_ALL KSYM_F9
165 #define DEFAULT_KEY_TAPE_EJECT KSYM_UNDEFINED
166 #define DEFAULT_KEY_TAPE_EXTRA KSYM_UNDEFINED
167 #define DEFAULT_KEY_TAPE_STOP KSYM_UNDEFINED
168 #define DEFAULT_KEY_TAPE_PAUSE KSYM_UNDEFINED
169 #define DEFAULT_KEY_TAPE_RECORD KSYM_UNDEFINED
170 #define DEFAULT_KEY_TAPE_PLAY KSYM_UNDEFINED
171 #define DEFAULT_KEY_SOUND_SIMPLE KSYM_UNDEFINED
172 #define DEFAULT_KEY_SOUND_LOOPS KSYM_UNDEFINED
173 #define DEFAULT_KEY_SOUND_MUSIC KSYM_UNDEFINED
174 #define DEFAULT_KEY_SNAP_LEFT KSYM_UNDEFINED
175 #define DEFAULT_KEY_SNAP_RIGHT KSYM_UNDEFINED
176 #define DEFAULT_KEY_SNAP_UP KSYM_UNDEFINED
177 #define DEFAULT_KEY_SNAP_DOWN KSYM_UNDEFINED
179 // default debug setup keys and values
180 #define DEFAULT_FRAME_DELAY_0 20 // 100 % speed
181 #define DEFAULT_FRAME_DELAY_1 500 // 4 % speed
182 #define DEFAULT_FRAME_DELAY_2 250 // 8 % speed
183 #define DEFAULT_FRAME_DELAY_3 125 // 16 % speed
184 #define DEFAULT_FRAME_DELAY_4 60 // 33 % speed
185 #define DEFAULT_FRAME_DELAY_5 40 // 50 % speed
186 #define DEFAULT_FRAME_DELAY_6 30 // 66 % speed
187 #define DEFAULT_FRAME_DELAY_7 10 // 200 % speed
188 #define DEFAULT_FRAME_DELAY_8 5 // 400 % speed
189 #define DEFAULT_FRAME_DELAY_9 0 // maximum speed
191 #define DEFAULT_KEY_FRAME_DELAY_0 KSYM_0
192 #define DEFAULT_KEY_FRAME_DELAY_1 KSYM_1
193 #define DEFAULT_KEY_FRAME_DELAY_2 KSYM_2
194 #define DEFAULT_KEY_FRAME_DELAY_3 KSYM_3
195 #define DEFAULT_KEY_FRAME_DELAY_4 KSYM_4
196 #define DEFAULT_KEY_FRAME_DELAY_5 KSYM_5
197 #define DEFAULT_KEY_FRAME_DELAY_6 KSYM_6
198 #define DEFAULT_KEY_FRAME_DELAY_7 KSYM_7
199 #define DEFAULT_KEY_FRAME_DELAY_8 KSYM_8
200 #define DEFAULT_KEY_FRAME_DELAY_9 KSYM_9
202 #define NUM_DEBUG_FRAME_DELAY_KEYS 10
204 #define DEFAULT_FRAME_DELAY_USE_MOD_KEY FALSE
205 #define DEFAULT_FRAME_DELAY_GAME_ONLY TRUE
207 // values for key_status
208 #define KEY_NOT_PRESSED FALSE
209 #define KEY_RELEASED FALSE
210 #define KEY_PRESSED TRUE
212 // values for button status
213 #define MB_NOT_PRESSED FALSE
214 #define MB_NOT_RELEASED TRUE
215 #define MB_RELEASED FALSE
216 #define MB_PRESSED TRUE
217 #define MB_MENU_CHOICE FALSE
218 #define MB_MENU_MARK TRUE
219 #define MB_MENU_INITIALIZE (-1)
220 #define MB_MENU_LEAVE (-2)
221 #define MB_LEFTBUTTON 1
222 #define MB_MIDDLEBUTTON 2
223 #define MB_RIGHTBUTTON 3
224 #define MB_WHEEL_UP 4
225 #define MB_WHEEL_DOWN 5
226 #define MB_WHEEL_LEFT 6
227 #define MB_WHEEL_RIGHT 7
228 #define IS_WHEEL_BUTTON_VERTICAL(b) ((b) == MB_WHEEL_UP || \
229 (b) == MB_WHEEL_DOWN)
230 #define IS_WHEEL_BUTTON_HORIZONTAL(b) ((b) == MB_WHEEL_LEFT || \
231 (b) == MB_WHEEL_RIGHT)
232 #define IS_WHEEL_BUTTON(b) (IS_WHEEL_BUTTON_VERTICAL(b) || \
233 IS_WHEEL_BUTTON_HORIZONTAL(b))
234 #define DEFAULT_WHEEL_STEPS 3
236 #define BUTTON_STEPSIZE(b) ((b) == MB_LEFTBUTTON ? 1 : \
237 (b) == MB_MIDDLEBUTTON ? 5 : \
238 (b) == MB_RIGHTBUTTON ? 10 : 1)
240 // values for move directions
241 #define MV_BIT_LEFT 0
242 #define MV_BIT_RIGHT 1
244 #define MV_BIT_DOWN 3
246 #define NUM_DIRECTIONS 4
248 // diagonal movement directions are used in a different contect than buttons
249 #define MV_BIT_UPLEFT 4
250 #define MV_BIT_UPRIGHT 5
251 #define MV_BIT_DOWNLEFT 6
252 #define MV_BIT_DOWNRIGHT 7
254 #define NUM_DIRECTIONS_FULL 8
256 // values for special "button" bitmasks
260 #define NUM_PLAYER_ACTIONS 6
262 // values for special "focus player" bitmasks
263 #define BIT_SET_FOCUS 6
265 // values for drawing stages for global animations
266 #define DRAW_GLOBAL_ANIM_STAGE_1 1
267 #define DRAW_GLOBAL_ANIM_STAGE_2 2
269 // values for drawing target (various functions)
270 #define DRAW_TO_BACKBUFFER 0
271 #define DRAW_TO_FIELDBUFFER 1
272 #define DRAW_TO_SCREEN 2
273 #define DRAW_TO_FADE_SOURCE 3
274 #define DRAW_TO_FADE_TARGET 4
276 // values for move directions and special "button" key bitmasks
278 #define MV_LEFT (1 << MV_BIT_LEFT)
279 #define MV_RIGHT (1 << MV_BIT_RIGHT)
280 #define MV_UP (1 << MV_BIT_UP)
281 #define MV_DOWN (1 << MV_BIT_DOWN)
283 #define MV_UPLEFT (MV_UP | MV_LEFT)
284 #define MV_UPRIGHT (MV_UP | MV_RIGHT)
285 #define MV_DOWNLEFT (MV_DOWN | MV_LEFT)
286 #define MV_DOWNRIGHT (MV_DOWN | MV_RIGHT)
288 #define MV_HORIZONTAL (MV_LEFT | MV_RIGHT)
289 #define MV_VERTICAL (MV_UP | MV_DOWN)
290 #define MV_ALL_DIRECTIONS (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
291 #define MV_ANY_DIRECTION (MV_ALL_DIRECTIONS)
292 #define MV_NO_DIRECTION (MV_NONE)
294 #define KEY_BUTTON_1 (1 << BUTTON_1)
295 #define KEY_BUTTON_2 (1 << BUTTON_2)
296 #define KEY_BUTTON_SNAP KEY_BUTTON_1
297 #define KEY_BUTTON_DROP KEY_BUTTON_2
298 #define KEY_MOTION (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
299 #define KEY_BUTTON (KEY_BUTTON_1 | KEY_BUTTON_2)
300 #define KEY_ACTION (KEY_MOTION | KEY_BUTTON)
302 #define KEY_SET_FOCUS (1 << BIT_SET_FOCUS)
304 #define MV_DIR_FROM_BIT(x) ((x) < NUM_DIRECTIONS ? 1 << (x) : \
305 (x) == MV_BIT_UPLEFT ? MV_UPLEFT : \
306 (x) == MV_BIT_UPRIGHT ? MV_UPRIGHT : \
307 (x) == MV_BIT_DOWNLEFT ? MV_DOWNLEFT : \
308 (x) == MV_BIT_DOWNRIGHT ? MV_DOWNRIGHT : \
311 #define MV_DIR_TO_BIT(x) ((x) == MV_LEFT ? MV_BIT_LEFT : \
312 (x) == MV_RIGHT ? MV_BIT_RIGHT : \
313 (x) == MV_UP ? MV_BIT_UP : \
314 (x) == MV_DOWN ? MV_BIT_DOWN : \
315 (x) == MV_UPLEFT ? MV_BIT_UPLEFT : \
316 (x) == MV_UPRIGHT ? MV_BIT_UPRIGHT : \
317 (x) == MV_DOWNLEFT ? MV_BIT_DOWNLEFT : \
318 (x) == MV_DOWNRIGHT ? MV_BIT_DOWNRIGHT : \
321 #define MV_DIR_OPPOSITE(x) ((x) == MV_LEFT ? MV_RIGHT : \
322 (x) == MV_RIGHT ? MV_LEFT : \
323 (x) == MV_UP ? MV_DOWN : \
324 (x) == MV_DOWN ? MV_UP : \
325 (x) == MV_UPLEFT ? MV_DOWNRIGHT : \
326 (x) == MV_UPRIGHT ? MV_DOWNLEFT : \
327 (x) == MV_DOWNLEFT ? MV_UPRIGHT : \
328 (x) == MV_DOWNRIGHT ? MV_UPLEFT : \
331 // values for animation mode (frame order and direction)
332 // (stored in level files -- never change existing values)
334 #define ANIM_LOOP (1 << 0)
335 #define ANIM_LINEAR (1 << 1)
336 #define ANIM_PINGPONG (1 << 2)
337 #define ANIM_PINGPONG2 (1 << 3)
338 #define ANIM_RANDOM (1 << 4)
339 #define ANIM_CE_VALUE (1 << 5)
340 #define ANIM_CE_SCORE (1 << 6)
341 #define ANIM_CE_DELAY (1 << 7)
342 #define ANIM_REVERSE (1 << 8)
343 #define ANIM_OPAQUE_PLAYER (1 << 9)
345 // values for special (non game element) animation modes
346 // (not stored in level files -- can be changed, if needed)
347 #define ANIM_HORIZONTAL (1 << 10)
348 #define ANIM_VERTICAL (1 << 11)
349 #define ANIM_CENTERED (1 << 12)
350 #define ANIM_STATIC_PANEL (1 << 13)
351 #define ANIM_ALL (1 << 14)
352 #define ANIM_ONCE (1 << 15)
354 #define ANIM_DEFAULT ANIM_LOOP
356 // values for special drawing styles (currently only for crumbled graphics)
358 #define STYLE_ACCURATE_BORDERS (1 << 0)
359 #define STYLE_INNER_CORNERS (1 << 1)
360 #define STYLE_REVERSE (1 << 2)
362 // values for special event handling style (used for global animation)
363 #define STYLE_BLOCK (1 << 3)
364 #define STYLE_PASSTHROUGH (1 << 4)
365 #define STYLE_MULTIPLE_ACTIONS (1 << 5)
367 #define STYLE_DEFAULT STYLE_NONE
369 // values for special global animation delay types
370 #define ANIM_DELAY_UNDEFINED -1
371 #define ANIM_DELAY_NONE 0
372 #define ANIM_DELAY_INIT 1
373 #define ANIM_DELAY_ANIM 2
374 #define ANIM_DELAY_POST 3
376 // values for special global animation delay actions
377 #define ANIM_DELAY_ACTION_NONE -1
379 // values for special global animation events
380 #define ANIM_EVENT_UNDEFINED -1
381 #define ANIM_EVENT_NONE 0
382 #define ANIM_EVENT_SELF (1 << 16)
383 #define ANIM_EVENT_ANY (1 << 17)
384 #define ANIM_EVENT_CLICK (1 << 18)
385 #define ANIM_EVENT_INIT (1 << 19)
386 #define ANIM_EVENT_START (1 << 20)
387 #define ANIM_EVENT_END (1 << 21)
388 #define ANIM_EVENT_POST (1 << 22)
389 #define ANIM_EVENT_UNCLICK_ANY (1 << 23)
391 // anim number: bits 0-7
392 // part number: bits 8-15
393 #define ANIM_EVENT_ANIM_BIT 0
394 #define ANIM_EVENT_PART_BIT 8
396 #define ANIM_EVENT_ANIM_MASK (0xff << ANIM_EVENT_ANIM_BIT)
397 #define ANIM_EVENT_PART_MASK (0xff << ANIM_EVENT_PART_BIT)
399 #define ANIM_EVENT_DEFAULT ANIM_EVENT_NONE
401 // values for special global animation event actions
402 #define ANIM_EVENT_ACTION_NONE -1
404 // values for fade mode
405 #define FADE_TYPE_NONE 0
406 #define FADE_TYPE_FADE_IN (1 << 0)
407 #define FADE_TYPE_FADE_OUT (1 << 1)
408 #define FADE_TYPE_TRANSFORM (1 << 2)
409 #define FADE_TYPE_CROSSFADE (1 << 3)
410 #define FADE_TYPE_MELT (1 << 4)
411 #define FADE_TYPE_CURTAIN (1 << 5)
412 #define FADE_TYPE_SKIP (1 << 6)
414 #define FADE_MODE_NONE (FADE_TYPE_NONE)
415 #define FADE_MODE_FADE_IN (FADE_TYPE_FADE_IN)
416 #define FADE_MODE_FADE_OUT (FADE_TYPE_FADE_OUT)
417 #define FADE_MODE_FADE (FADE_TYPE_FADE_IN | FADE_TYPE_FADE_OUT)
418 #define FADE_MODE_TRANSFORM (FADE_TYPE_TRANSFORM | FADE_TYPE_FADE_IN)
419 #define FADE_MODE_CROSSFADE (FADE_MODE_TRANSFORM | FADE_TYPE_CROSSFADE)
420 #define FADE_MODE_MELT (FADE_MODE_TRANSFORM | FADE_TYPE_MELT)
421 #define FADE_MODE_CURTAIN (FADE_MODE_TRANSFORM | FADE_TYPE_CURTAIN)
422 #define FADE_MODE_SKIP_FADE_IN (FADE_TYPE_SKIP | FADE_TYPE_FADE_IN)
423 #define FADE_MODE_SKIP_FADE_OUT (FADE_TYPE_SKIP | FADE_TYPE_FADE_OUT)
425 #define FADE_MODE_DEFAULT FADE_MODE_FADE
427 #define AUTO_DELAY_UNIT_MS 0
428 #define AUTO_DELAY_UNIT_FRAMES 1
430 #define AUTO_DELAY_UNIT_DEFAULT AUTO_DELAY_UNIT_MS
432 // values for toon positions
433 #define POS_UNDEFINED -1
444 // values for text alignment
445 #define ALIGN_LEFT (1 << 0)
446 #define ALIGN_RIGHT (1 << 1)
447 #define ALIGN_CENTER (1 << 2)
448 #define ALIGN_DEFAULT ALIGN_LEFT
450 #define VALIGN_TOP (1 << 0)
451 #define VALIGN_BOTTOM (1 << 1)
452 #define VALIGN_MIDDLE (1 << 2)
453 #define VALIGN_DEFAULT VALIGN_TOP
455 #define ALIGNED_XPOS(x,w,a) ((a) == ALIGN_CENTER ? (x) - (w) / 2 : \
456 (a) == ALIGN_RIGHT ? (x) - (w) : (x))
457 #define ALIGNED_YPOS(y,h,v) ((v) == VALIGN_MIDDLE ? (y) - (h) / 2 : \
458 (v) == VALIGN_BOTTOM ? (y) - (h) : (y))
459 #define ALIGNED_TEXT_XPOS(p) ALIGNED_XPOS((p)->x, (p)->width, (p)->align)
460 #define ALIGNED_TEXT_YPOS(p) ALIGNED_YPOS((p)->y, (p)->height, (p)->valign)
461 #define ALIGNED_VP_XPOS(p) ALIGNED_TEXT_XPOS(p)
462 #define ALIGNED_VP_YPOS(p) ALIGNED_TEXT_YPOS(p)
464 // values for redraw_mask
465 #define REDRAW_NONE (0)
466 #define REDRAW_ALL (1 << 0)
467 #define REDRAW_FIELD (1 << 1)
468 #define REDRAW_DOOR_1 (1 << 2)
469 #define REDRAW_DOOR_2 (1 << 3)
470 #define REDRAW_DOOR_3 (1 << 4)
471 #define REDRAW_FPS (1 << 5)
473 #define REDRAW_DOORS (REDRAW_DOOR_1 | \
477 #define IN_GFX_FIELD_PLAY(x, y) (x >= gfx.sx && x < gfx.sx + gfx.sxsize && \
478 y >= gfx.sy && y < gfx.sy + gfx.sysize)
479 #define IN_GFX_FIELD_FULL(x, y) (x >= gfx.real_sx && \
480 x < gfx.real_sx + gfx.full_sxsize && \
481 y >= gfx.real_sy && \
482 y < gfx.real_sy + gfx.full_sysize)
483 #define IN_GFX_DOOR_1(x, y) (x >= gfx.dx && x < gfx.dx + gfx.dxsize && \
484 y >= gfx.dy && y < gfx.dy + gfx.dysize)
485 #define IN_GFX_DOOR_2(x, y) (x >= gfx.vx && x < gfx.vx + gfx.vxsize && \
486 y >= gfx.vy && y < gfx.vy + gfx.vysize)
487 #define IN_GFX_DOOR_3(x, y) (x >= gfx.ex && x < gfx.ex + gfx.exsize && \
488 y >= gfx.ey && y < gfx.ey + gfx.eysize)
490 // values for mouse cursor
491 #define CURSOR_UNDEFINED -1
492 #define CURSOR_DEFAULT 0
493 #define CURSOR_NONE 1
494 #define CURSOR_PLAYFIELD 2
496 // fundamental game speed values
497 #define ONE_SECOND_DELAY 1000 // delay value for one second
498 #define MENU_FRAME_DELAY 20 // frame delay in milliseconds
499 #define GAME_FRAME_DELAY 20 // frame delay in milliseconds
500 #define FFWD_FRAME_DELAY 10 // 200% speed for fast forward
501 #define MIN_VSYNC_FRAME_DELAY 15 // minimum value for vsync to keep
502 #define MAX_VSYNC_FRAME_DELAY 16 // maximum value for vsync to work
503 #define FRAMES_PER_SECOND (ONE_SECOND_DELAY / GAME_FRAME_DELAY)
504 #define FRAMES_PER_SECOND_SP 35
506 // maximum playfield size supported by libgame functions
507 #define MAX_PLAYFIELD_WIDTH 128
508 #define MAX_PLAYFIELD_HEIGHT 128
510 // maximum number of parallel players supported by libgame functions
511 #define MAX_PLAYERS 4
513 // maximum allowed length of player name
514 #define MAX_PLAYER_NAME_LEN 10
516 // maximum number of levels in a level set
517 #define MAX_LEVELS 1000
519 // maximum number of global animation and parts
520 #define MAX_GLOBAL_ANIMS 32
521 #define MAX_GLOBAL_ANIM_PARTS 32
523 // minimum/maximum/default x/y grid size for virtual buttons
524 #define MIN_GRID_XSIZE 3
525 #define MIN_GRID_YSIZE 3
526 #define MAX_GRID_XSIZE 32
527 #define MAX_GRID_YSIZE 32
528 #define GRID_REAL_WIDTH MAX(1, MAX(video.screen_width, \
529 video.screen_height))
530 #define GRID_REAL_HEIGHT MAX(1, MIN(video.screen_width, \
531 video.screen_height))
532 #define DEFAULT_GRID_XSIZE_0 18
533 #define DEFAULT_GRID_YSIZE_0 MIN(MAX(MIN_GRID_YSIZE, \
534 DEFAULT_GRID_XSIZE_0 * \
538 #define DEFAULT_GRID_XSIZE_1 13
539 #define DEFAULT_GRID_YSIZE_1 MIN(MAX(MIN_GRID_YSIZE, \
540 DEFAULT_GRID_XSIZE_1 * \
545 #define DEFAULT_GRID_XSIZE(n) ((n) == 0 ? DEFAULT_GRID_XSIZE_0 : \
546 DEFAULT_GRID_XSIZE_1)
547 #define DEFAULT_GRID_YSIZE(n) ((n) == 0 ? DEFAULT_GRID_YSIZE_0 : \
548 DEFAULT_GRID_YSIZE_1)
550 #define GRID_ACTIVE_NR() (video.screen_width > \
551 video.screen_height ? 0 : 1)
553 // values for grid button characters for virtual buttons
554 #define CHAR_GRID_BUTTON_NONE ' '
555 #define CHAR_GRID_BUTTON_LEFT '<'
556 #define CHAR_GRID_BUTTON_RIGHT '>'
557 #define CHAR_GRID_BUTTON_UP '^'
558 #define CHAR_GRID_BUTTON_DOWN 'v'
559 #define CHAR_GRID_BUTTON_SNAP '1'
560 #define CHAR_GRID_BUTTON_DROP '2'
562 #define GET_ACTION_FROM_GRID_BUTTON(c) ((c) == CHAR_GRID_BUTTON_LEFT ? \
564 (c) == CHAR_GRID_BUTTON_RIGHT ? \
566 (c) == CHAR_GRID_BUTTON_UP ? \
568 (c) == CHAR_GRID_BUTTON_DOWN ? \
570 (c) == CHAR_GRID_BUTTON_SNAP ? \
572 (c) == CHAR_GRID_BUTTON_DROP ? \
576 // default name for empty highscore entry
577 #define EMPTY_PLAYER_NAME "no name"
579 // default name for unknown player names
580 #define ANONYMOUS_NAME "anonymous"
582 // default for other unknown names
583 #define UNKNOWN_NAME "unknown"
585 // default name for new levels
586 #define NAMELESS_LEVEL_NAME "nameless level"
588 // default text for non-existant artwork
589 #define NOT_AVAILABLE "(not available)"
591 // default value for undefined filename
592 #define UNDEFINED_FILENAME "[NONE]"
594 // default value for undefined levelset
595 #define UNDEFINED_LEVELSET "[NONE]"
597 // default value for undefined parameter
598 #define ARG_DEFAULT "[DEFAULT]"
600 // default values for undefined configuration file parameters
601 #define ARG_UNDEFINED "-1000000"
602 #define ARG_UNDEFINED_VALUE (-1000000)
604 // default value for off-screen positions
605 #define POS_OFFSCREEN (-1000000)
607 // definitions for game sub-directories
609 #define RO_GAME_DIR "."
613 #define RW_GAME_DIR "."
616 #define RO_BASE_PATH RO_GAME_DIR
617 #define RW_BASE_PATH RW_GAME_DIR
620 #define GRAPHICS_DIRECTORY "graphics"
621 #define SOUNDS_DIRECTORY "sounds"
622 #define MUSIC_DIRECTORY "music"
623 #define LEVELS_DIRECTORY "levels"
624 #define TAPES_DIRECTORY "tapes"
625 #define SCORES_DIRECTORY "scores"
626 #define DOCS_DIRECTORY "docs"
627 #define CACHE_DIRECTORY "cache"
628 #define CONF_DIRECTORY "conf"
629 #define NETWORK_DIRECTORY "network"
631 #define GFX_CLASSIC_SUBDIR "gfx_classic"
632 #define SND_CLASSIC_SUBDIR "snd_classic"
633 #define MUS_CLASSIC_SUBDIR "mus_classic"
635 #define GFX_DEFAULT_SUBDIR (setup.internal.default_graphics_set)
636 #define SND_DEFAULT_SUBDIR (setup.internal.default_sounds_set)
637 #define MUS_DEFAULT_SUBDIR (setup.internal.default_music_set)
639 #define GFX_FALLBACK_FILENAME (setup.internal.fallback_graphics_file)
640 #define SND_FALLBACK_FILENAME (setup.internal.fallback_sounds_file)
641 #define MUS_FALLBACK_FILENAME (setup.internal.fallback_music_file)
643 #define DEFAULT_LEVELSET (setup.internal.default_level_series)
645 // file names and filename extensions
646 #define LEVELSETUP_DIRECTORY "levelsetup"
647 #define SETUP_FILENAME "setup.conf"
648 #define AUTOSETUP_FILENAME "autosetup.conf"
649 #define LEVELSETUP_FILENAME "levelsetup.conf"
650 #define EDITORSETUP_FILENAME "editorsetup.conf"
651 #define EDITORCASCADE_FILENAME "editorcascade.conf"
652 #define HELPANIM_FILENAME "helpanim.conf"
653 #define HELPTEXT_FILENAME "helptext.conf"
654 #define LEVELINFO_FILENAME "levelinfo.conf"
655 #define GRAPHICSINFO_FILENAME "graphicsinfo.conf"
656 #define SOUNDSINFO_FILENAME "soundsinfo.conf"
657 #define MUSICINFO_FILENAME "musicinfo.conf"
658 #define ARTWORKINFO_CACHE_FILE "artworkinfo.cache"
659 #define LEVELTEMPLATE_FILENAME "template.level"
660 #define LEVELFILE_EXTENSION "level"
661 #define TAPEFILE_EXTENSION "tape"
662 #define SCOREFILE_EXTENSION "score"
664 #define GAMECONTROLLER_BASENAME "gamecontrollerdb.txt"
666 #define LOG_OUT_BASENAME "stdout.txt"
667 #define LOG_ERR_BASENAME "stderr.txt"
673 #define STRING_PARENT_DIRECTORY ".."
674 #define STRING_TOP_DIRECTORY "/"
676 #define CHAR_PATH_SEPARATOR_UNIX '/'
677 #define CHAR_PATH_SEPARATOR_DOS '\\'
679 #define STRING_PATH_SEPARATOR_UNIX "/"
680 #define STRING_PATH_SEPARATOR_DOS "\\"
682 #define STRING_NEWLINE_UNIX "\n"
683 #define STRING_NEWLINE_DOS "\r\n"
685 #if defined(PLATFORM_WIN32)
686 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_DOS
687 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_DOS
688 #define STRING_NEWLINE STRING_NEWLINE_DOS
690 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_UNIX
691 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_UNIX
692 #define STRING_NEWLINE STRING_NEWLINE_UNIX
696 // areas in bitmap PIX_DOOR
697 // meaning in PIX_DB_DOOR: (3 PAGEs)
698 // PAGEX1: 1. buffer for DOOR_1
699 // PAGEX2: 2. buffer for DOOR_1
700 // PAGEX3: buffer for animations
702 // these values are hard-coded to be able to use them in initialization
703 #define DOOR_GFX_PAGE_WIDTH 100 // should be set to "gfx.dxsize"
704 #define DOOR_GFX_PAGE_HEIGHT 280 // should be set to "gfx.dysize"
706 #define DOOR_GFX_PAGESIZE (DOOR_GFX_PAGE_WIDTH)
707 #define DOOR_GFX_PAGEX1 (0 * DOOR_GFX_PAGESIZE)
708 #define DOOR_GFX_PAGEX2 (1 * DOOR_GFX_PAGESIZE)
709 #define DOOR_GFX_PAGEX3 (2 * DOOR_GFX_PAGESIZE)
710 #define DOOR_GFX_PAGEX4 (3 * DOOR_GFX_PAGESIZE)
711 #define DOOR_GFX_PAGEX5 (4 * DOOR_GFX_PAGESIZE)
712 #define DOOR_GFX_PAGEX6 (5 * DOOR_GFX_PAGESIZE)
713 #define DOOR_GFX_PAGEX7 (6 * DOOR_GFX_PAGESIZE)
714 #define DOOR_GFX_PAGEX8 (7 * DOOR_GFX_PAGESIZE)
715 #define DOOR_GFX_PAGEY1 (0)
716 #define DOOR_GFX_PAGEY2 (DOOR_GFX_PAGE_HEIGHT)
719 // macros for version handling
720 #define VERSION_PART_1(x) ((x) / 1000000)
721 #define VERSION_PART_2(x) (((x) % 1000000) / 10000)
722 #define VERSION_PART_3(x) (((x) % 10000) / 100)
723 #define VERSION_PART_4(x) ((x) % 100)
725 #define VERSION_SUPER(x) VERSION_PART_1(x)
726 #define VERSION_MAJOR(x) VERSION_PART_2(x)
727 #define VERSION_MINOR(x) VERSION_PART_3(x)
728 #define VERSION_PATCH(x) VERSION_PART_4(x)
729 #define VERSION_IDENT(a,b,c,d) ((a) * 1000000 + (b) * 10000 + (c) * 100 + (d))
732 // macros for parent/child process identification
733 #if defined(PLATFORM_UNIX)
734 #define IS_PARENT_PROCESS() (audio.mixer_pid != getpid())
735 #define IS_CHILD_PROCESS() (audio.mixer_pid == getpid())
736 #define HAS_CHILD_PROCESS() (audio.mixer_pid > 0)
738 #define IS_PARENT_PROCESS() TRUE
739 #define IS_CHILD_PROCESS() FALSE
740 #define HAS_CHILD_PROCESS() FALSE
744 // values for artwork type
745 #define ARTWORK_TYPE_GRAPHICS 0
746 #define ARTWORK_TYPE_SOUNDS 1
747 #define ARTWORK_TYPE_MUSIC 2
749 #define NUM_ARTWORK_TYPES 3
752 // values for tree type (chosen to match artwork type)
753 #define TREE_TYPE_UNDEFINED -1
754 #define TREE_TYPE_GRAPHICS_DIR ARTWORK_TYPE_GRAPHICS
755 #define TREE_TYPE_SOUNDS_DIR ARTWORK_TYPE_SOUNDS
756 #define TREE_TYPE_MUSIC_DIR ARTWORK_TYPE_MUSIC
757 #define TREE_TYPE_LEVEL_DIR 3
758 #define TREE_TYPE_LEVEL_NR 4
760 #define NUM_BASE_TREE_TYPES 4
761 #define NUM_TREE_TYPES 5
763 #define INFOTEXT_UNDEFINED ""
764 #define INFOTEXT_GRAPHICS_DIR "Custom Graphics"
765 #define INFOTEXT_SOUNDS_DIR "Custom Sounds"
766 #define INFOTEXT_MUSIC_DIR "Custom Music"
767 #define INFOTEXT_LEVEL_DIR "Level Sets"
768 #define INFOTEXT_LEVEL_NR "Levels"
770 #define TREE_INFOTEXT(t) ((t) == TREE_TYPE_LEVEL_NR ? \
771 INFOTEXT_LEVEL_NR : \
772 (t) == TREE_TYPE_LEVEL_DIR ? \
773 INFOTEXT_LEVEL_DIR : \
774 (t) == TREE_TYPE_GRAPHICS_DIR ? \
775 INFOTEXT_GRAPHICS_DIR : \
776 (t) == TREE_TYPE_SOUNDS_DIR ? \
777 INFOTEXT_SOUNDS_DIR : \
778 (t) == TREE_TYPE_MUSIC_DIR ? \
779 INFOTEXT_MUSIC_DIR : \
782 #define TREE_USERDIR(t) ((t) == TREE_TYPE_LEVEL_DIR ? \
783 getUserLevelDir(NULL) : \
784 (t) == TREE_TYPE_GRAPHICS_DIR ? \
785 getUserGraphicsDir() : \
786 (t) == TREE_TYPE_SOUNDS_DIR ? \
787 getUserSoundsDir() : \
788 (t) == TREE_TYPE_MUSIC_DIR ? \
789 getUserMusicDir() : \
792 #define TREE_FIRST_NODE_PTR(t) ((t) == TREE_TYPE_LEVEL_DIR ? \
794 (t) == TREE_TYPE_GRAPHICS_DIR ? \
795 &artwork.gfx_first : \
796 (t) == TREE_TYPE_SOUNDS_DIR ? \
797 &artwork.snd_first : \
798 (t) == TREE_TYPE_MUSIC_DIR ? \
799 &artwork.mus_first : \
802 #define TREE_FIRST_NODE(t) ((t) == TREE_TYPE_LEVEL_DIR ? \
804 (t) == TREE_TYPE_GRAPHICS_DIR ? \
805 artwork.gfx_first : \
806 (t) == TREE_TYPE_SOUNDS_DIR ? \
807 artwork.snd_first : \
808 (t) == TREE_TYPE_MUSIC_DIR ? \
809 artwork.mus_first : \
812 // values for artwork handling
813 #define LEVELDIR_ARTWORK_SET_PTR(leveldir, type) \
814 ((type) == ARTWORK_TYPE_GRAPHICS ? \
815 &(leveldir)->graphics_set : \
816 (type) == ARTWORK_TYPE_SOUNDS ? \
817 &(leveldir)->sounds_set : \
818 &(leveldir)->music_set)
820 #define LEVELDIR_ARTWORK_SET(leveldir, type) \
821 ((type) == ARTWORK_TYPE_GRAPHICS ? \
822 (leveldir)->graphics_set : \
823 (type) == ARTWORK_TYPE_SOUNDS ? \
824 (leveldir)->sounds_set : \
825 (leveldir)->music_set)
827 #define LEVELDIR_ARTWORK_PATH_PTR(leveldir, type) \
828 ((type) == ARTWORK_TYPE_GRAPHICS ? \
829 &(leveldir)->graphics_path : \
830 (type) == ARTWORK_TYPE_SOUNDS ? \
831 &(leveldir)->sounds_path : \
832 &(leveldir)->music_path)
834 #define LEVELDIR_ARTWORK_PATH(leveldir, type) \
835 ((type) == ARTWORK_TYPE_GRAPHICS ? \
836 (leveldir)->graphics_path : \
837 (type) == ARTWORK_TYPE_SOUNDS ? \
838 (leveldir)->sounds_path : \
839 (leveldir)->music_path)
841 #define SETUP_ARTWORK_SET(setup, type) \
842 ((type) == ARTWORK_TYPE_GRAPHICS ? \
843 (setup).graphics_set : \
844 (type) == ARTWORK_TYPE_SOUNDS ? \
845 (setup).sounds_set : \
848 #define SETUP_OVERRIDE_ARTWORK(setup, type) \
849 ((type) == ARTWORK_TYPE_GRAPHICS ? \
850 (setup).override_level_graphics : \
851 (type) == ARTWORK_TYPE_SOUNDS ? \
852 (setup).override_level_sounds : \
853 (setup).override_level_music)
855 #define GFX_OVERRIDE_ARTWORK(type) \
856 ((type) == ARTWORK_TYPE_GRAPHICS ? \
857 gfx.override_level_graphics : \
858 (type) == ARTWORK_TYPE_SOUNDS ? \
859 gfx.override_level_sounds : \
860 gfx.override_level_music)
862 #define ARTWORK_FIRST_NODE(artwork, type) \
863 ((type) == ARTWORK_TYPE_GRAPHICS ? \
864 (artwork).gfx_first : \
865 (type) == ARTWORK_TYPE_SOUNDS ? \
866 (artwork).snd_first : \
869 #define ARTWORK_CURRENT_IDENTIFIER_PTR(artwork, type) \
870 ((type) == ARTWORK_TYPE_GRAPHICS ? \
871 &(artwork).gfx_current_identifier : \
872 (type) == ARTWORK_TYPE_SOUNDS ? \
873 &(artwork).snd_current_identifier : \
874 &(artwork).mus_current_identifier)
876 #define ARTWORK_CURRENT_IDENTIFIER(artwork, type) \
877 ((type) == ARTWORK_TYPE_GRAPHICS ? \
878 (artwork).gfx_current_identifier : \
879 (type) == ARTWORK_TYPE_SOUNDS ? \
880 (artwork).snd_current_identifier : \
881 (artwork).mus_current_identifier)
883 #define ARTWORKINFO_FILENAME(type) \
884 ((type) == ARTWORK_TYPE_GRAPHICS ? \
885 GRAPHICSINFO_FILENAME : \
886 (type) == ARTWORK_TYPE_SOUNDS ? \
887 SOUNDSINFO_FILENAME : \
888 (type) == ARTWORK_TYPE_MUSIC ? \
889 MUSICINFO_FILENAME : "")
891 #define ARTWORK_DIRECTORY(type) \
892 ((type) == ARTWORK_TYPE_GRAPHICS ? \
893 GRAPHICS_DIRECTORY : \
894 (type) == ARTWORK_TYPE_SOUNDS ? \
896 (type) == ARTWORK_TYPE_MUSIC ? \
897 MUSIC_DIRECTORY : "")
899 #define OPTIONS_ARTWORK_DIRECTORY(type) \
900 ((type) == ARTWORK_TYPE_GRAPHICS ? \
901 options.graphics_directory : \
902 (type) == ARTWORK_TYPE_SOUNDS ? \
903 options.sounds_directory : \
904 (type) == ARTWORK_TYPE_MUSIC ? \
905 options.music_directory : "")
907 #define USER_ARTWORK_DIRECTORY(type) \
908 ((type) == ARTWORK_TYPE_GRAPHICS ? \
909 getUserGraphicsDir() : \
910 (type) == ARTWORK_TYPE_SOUNDS ? \
911 getUserSoundsDir() : \
912 (type) == ARTWORK_TYPE_MUSIC ? \
913 getUserMusicDir() : "")
915 #define ARTWORK_DEFAULT_SUBDIR(type) \
916 ((type) == ARTWORK_TYPE_GRAPHICS ? \
917 GFX_DEFAULT_SUBDIR : \
918 (type) == ARTWORK_TYPE_SOUNDS ? \
919 SND_DEFAULT_SUBDIR : \
922 #define UPDATE_BUSY_STATE() \
924 if (gfx.draw_busy_anim_function != NULL) \
925 gfx.draw_busy_anim_function(); \
929 // structure definitions
933 char *command_basepath; // path to the program binary
934 char *command_basename; // base filename of the program binary
936 char *config_filename; // optional global program config filename
938 char *maindata_path; // main game data (installation) directory
940 char *userdata_subdir; // personal user game data directory
941 char *userdata_path; // resulting full path to game data directory
951 char *log_filename[NUM_LOGS]; // log filenames for out/err messages
952 FILE *log_file[NUM_LOGS]; // log file handles for out/err files
953 FILE *log_file_default[NUM_LOGS]; // default log file handles (out/err)
961 char *version_string;
963 char *(*window_title_function)(void);
964 void (*exit_message_function)(char *, va_list);
965 void (*exit_function)(int);
967 boolean global_scores;
968 boolean many_scores_per_name;
982 SDL_Thread *server_thread;
983 boolean is_server_thread;
988 boolean uses_touch_device;
996 char *ro_base_directory;
997 char *rw_base_directory;
998 char *level_directory;
999 char *graphics_directory;
1000 char *sounds_directory;
1001 char *music_directory;
1002 char *docs_directory;
1003 char *conf_directory;
1005 char *execute_command;
1007 char *special_flags;
1017 struct VideoSystemInfo
1020 int width, height, depth;
1021 int window_width, window_height;
1022 int display_width, display_height;
1023 int screen_width, screen_height;
1024 int screen_xoffset, screen_yoffset;
1026 boolean fullscreen_available;
1027 boolean fullscreen_enabled;
1028 boolean fullscreen_initial;
1030 boolean window_scaling_available;
1031 int window_scaling_percent;
1032 char *window_scaling_quality;
1033 int screen_rendering_mode;
1036 unsigned int frame_counter;
1037 unsigned int frame_delay;
1038 unsigned int frame_delay_value;
1042 int shifted_up_pos_last;
1043 unsigned int shifted_up_delay;
1044 unsigned int shifted_up_delay_value;
1046 boolean initialized;
1049 struct AudioSystemInfo
1051 boolean sound_available;
1052 boolean loops_available;
1053 boolean music_available;
1055 boolean sound_enabled;
1056 boolean sound_deactivated; // for temporarily disabling sound
1065 int first_sound_channel;
1068 struct FontBitmapInfo
1072 int src_x, src_y; // start position of font characters
1073 int width, height; // width / height of font characters
1075 int offset_x; // offset to next font character
1076 int offset_y; // offset to next font character
1078 int draw_xoffset; // offset for drawing font characters
1079 int draw_yoffset; // offset for drawing font characters
1082 int num_chars_per_line;
1089 int real_sx, real_sy;
1090 int full_sxsize, full_sysize;
1091 int scrollbuffer_width, scrollbuffer_height;
1093 int game_tile_size, standard_tile_size;
1104 int win_xsize, win_ysize;
1106 int draw_deactivation_mask;
1107 int draw_background_mask;
1109 Bitmap *field_save_buffer;
1111 Bitmap *background_bitmap;
1112 int background_bitmap_mask;
1114 Bitmap *fade_bitmap_backup;
1115 Bitmap *fade_bitmap_source;
1116 Bitmap *fade_bitmap_target;
1117 Bitmap *fade_bitmap_black;
1119 int fade_border_source_status;
1120 int fade_border_target_status;
1121 Bitmap *masked_border_bitmap_ptr;
1123 Bitmap *final_screen_bitmap;
1125 boolean clipping_enabled;
1127 int clip_width, clip_height;
1129 boolean override_level_graphics;
1130 boolean override_level_sounds;
1131 boolean override_level_music;
1133 boolean draw_init_text;
1136 struct FontBitmapInfo *font_bitmap_info;
1137 int (*select_font_function)(int);
1138 int (*get_font_from_token_function)(char *);
1140 int anim_random_frame;
1142 void (*draw_busy_anim_function)(void);
1143 void (*draw_global_anim_function)(int, int);
1144 void (*draw_global_border_function)(int);
1145 void (*draw_tile_cursor_function)(int);
1148 int cursor_mode_override;
1149 int cursor_mode_final;
1150 int mouse_x, mouse_y;
1153 struct TileCursorInfo
1155 boolean enabled; // tile cursor generally enabled or disabled
1156 boolean active; // tile cursor activated (depending on game)
1157 boolean moving; // tile cursor moving to target position
1159 int xpos, ypos; // tile cursor level playfield position
1160 int x, y; // tile cursor current screen position
1161 int target_x, target_y; // tile cursor target screen position
1163 int sx, sy; // tile cursor screen start position
1168 boolean enabled; // overlay generally enabled or disabled
1169 boolean active; // overlay activated (depending on game mode)
1176 char grid_button[MAX_GRID_XSIZE][MAX_GRID_YSIZE];
1177 char grid_button_highlight;
1179 int grid_button_action;
1185 int nr[MAX_PLAYERS]; // joystick number for each player
1188 struct SetupJoystickInfo
1190 char *device_name; // device name of player's joystick
1192 int xleft, xmiddle, xright;
1193 int yupper, ymiddle, ylower;
1197 struct SetupKeyboardInfo
1199 Key left, right, up, down;
1203 struct SetupTouchInfo
1212 char grid_button[2][MAX_GRID_XSIZE][MAX_GRID_YSIZE];
1214 int transparency; // in percent (0 == opaque, 100 == invisible)
1215 boolean draw_outlined;
1216 boolean draw_pressed;
1218 boolean grid_initialized;
1221 struct SetupInputInfo
1223 boolean use_joystick;
1224 struct SetupJoystickInfo joy;
1225 struct SetupKeyboardInfo key;
1228 struct SetupEditorInfo
1230 boolean el_boulderdash;
1231 boolean el_emerald_mine;
1232 boolean el_emerald_mine_club;
1235 boolean el_supaplex;
1236 boolean el_diamond_caves;
1237 boolean el_dx_boulderdash;
1239 boolean el_mirror_magic;
1240 boolean el_deflektor;
1243 boolean el_steel_chars;
1247 boolean el_user_defined;
1250 boolean el_headlines;
1255 boolean show_element_token;
1257 boolean use_template_for_new_levels;
1260 struct SetupAutoSetupInfo
1262 int editor_zoom_tilesize;
1265 struct SetupEditorCascadeInfo
1278 boolean el_steel_chars;
1286 struct SetupShortcutInfo
1292 Key focus_player[MAX_PLAYERS];
1293 Key focus_player_all;
1312 struct SetupSystemInfo
1314 char *sdl_renderdriver;
1315 char *sdl_videodriver;
1316 char *sdl_audiodriver;
1317 int audio_fragment_size;
1320 struct SetupInternalInfo
1322 char *program_title;
1323 char *program_version;
1324 char *program_author;
1325 char *program_email;
1326 char *program_website;
1327 char *program_copyright;
1328 char *program_company;
1330 char *program_icon_file;
1332 char *default_graphics_set;
1333 char *default_sounds_set;
1334 char *default_music_set;
1336 char *fallback_graphics_file;
1337 char *fallback_sounds_file;
1338 char *fallback_music_file;
1340 char *default_level_series;
1342 int default_window_width;
1343 int default_window_height;
1345 boolean choose_from_top_leveldir;
1346 boolean show_scaling_in_title;
1347 boolean create_user_levelset;
1350 boolean menu_engines;
1351 boolean menu_editor;
1352 boolean menu_graphics;
1354 boolean menu_artwork;
1357 boolean menu_shortcuts;
1359 boolean menu_save_and_exit;
1362 struct SetupDebugInfo
1364 int frame_delay[10];
1365 Key frame_delay_key[10];
1366 boolean frame_delay_use_mod_key;
1367 boolean frame_delay_game_only;
1368 boolean show_frames_per_second;
1376 boolean sound_loops;
1377 boolean sound_music;
1378 boolean sound_simple;
1380 boolean scroll_delay;
1381 boolean forced_scroll_delay;
1382 int scroll_delay_value;
1383 char *engine_snapshot_mode;
1384 int engine_snapshot_memory;
1385 boolean fade_screens;
1387 boolean show_titlescreen;
1388 boolean quick_doors;
1391 boolean skip_levels;
1392 boolean increment_levels;
1393 boolean auto_play_next_level;
1394 boolean skip_scores_after_game;
1397 int window_scaling_percent;
1398 char *window_scaling_quality;
1399 char *screen_rendering_mode;
1401 boolean ask_on_escape;
1402 boolean ask_on_escape_editor;
1403 boolean ask_on_game_over;
1404 boolean quick_switch;
1405 boolean input_on_focus;
1406 boolean prefer_aga_graphics;
1407 boolean prefer_lowpass_sounds;
1408 boolean game_speed_extended;
1409 int game_frame_delay;
1410 boolean sp_show_border_elements;
1411 boolean small_game_graphics;
1412 boolean show_snapshot_buttons;
1417 int override_level_graphics; // not boolean -- can also be "AUTO"
1418 int override_level_sounds; // not boolean -- can also be "AUTO"
1419 int override_level_music; // not boolean -- can also be "AUTO"
1425 boolean network_mode;
1426 int network_player_nr;
1427 char *network_server_hostname;
1429 struct SetupAutoSetupInfo auto_setup;
1430 struct SetupEditorInfo editor;
1431 struct SetupEditorCascadeInfo editor_cascade;
1432 struct SetupShortcutInfo shortcut;
1433 struct SetupInputInfo input[MAX_PLAYERS];
1434 struct SetupTouchInfo touch;
1435 struct SetupSystemInfo system;
1436 struct SetupInternalInfo internal;
1437 struct SetupDebugInfo debug;
1439 struct OptionInfo options;
1444 struct TreeInfo **node_top; // topmost node in tree
1445 struct TreeInfo *node_parent; // parent level directory info
1446 struct TreeInfo *node_group; // level group sub-directory info
1447 struct TreeInfo *next; // next level series structure node
1449 int cl_first; // internal control field for setup screen
1450 int cl_cursor; // internal control field for setup screen
1452 int type; // type of tree content
1454 // fields for "type == TREE_TYPE_LEVEL_DIR"
1456 char *subdir; // tree info sub-directory basename (may be ".")
1457 char *fullpath; // complete path relative to tree base directory
1458 char *basepath; // absolute base path of tree base directory
1459 char *identifier; // identifier string for configuration files
1460 char *name; // tree info name, as displayed in selection menues
1461 char *name_sorting; // optional sorting name for correct name sorting
1462 char *author; // level or artwork author name
1463 char *year; // optional year of creation for levels or artwork
1465 char *program_title; // optional alternative text for program title
1466 char *program_copyright; // optional alternative text for program copyright
1467 char *program_company; // optional alternative text for program company
1469 char *imported_from; // optional comment for imported levels or artwork
1470 char *imported_by; // optional comment for imported levels or artwork
1471 char *tested_by; // optional comment to name people who tested a set
1473 char *graphics_set_ecs; // special EMC custom graphics set (ECS graphics)
1474 char *graphics_set_aga; // special EMC custom graphics set (AGA graphics)
1475 char *graphics_set; // optional custom graphics set (level tree only)
1476 char *sounds_set_default; // default EMC custom sounds set
1477 char *sounds_set_lowpass; // special EMC custom sounds set (lowpass filter)
1478 char *sounds_set; // optional custom sounds set (level tree only)
1479 char *music_set; // optional custom music set (level tree only)
1480 char *graphics_path; // path to optional custom graphics set (level only)
1481 char *sounds_path; // path to optional custom sounds set (level only)
1482 char *music_path; // path to optional custom music set (level only)
1484 char *level_filename; // filename of level file (for packed level file)
1485 char *level_filetype; // type of levels in level directory or level file
1487 char *special_flags; // flags for special actions performed on level file
1489 int levels; // number of levels in level series
1490 int first_level; // first level number (to allow start with 0 or 1)
1491 int last_level; // last level number (automatically calculated)
1492 int sort_priority; // sort levels by 'sort_priority' and then by name
1494 boolean latest_engine;// force level set to use the latest game engine
1496 boolean level_group; // directory contains more level series directories
1497 boolean parent_link; // entry links back to parent directory
1498 boolean in_user_dir; // user defined levels are stored in home directory
1499 boolean user_defined; // levels in user directory and marked as "private"
1500 boolean readonly; // readonly levels can not be changed with editor
1501 boolean handicap; // level set has no handicap when set to "false"
1502 boolean skip_levels; // levels can be skipped when set to "true"
1504 boolean use_emc_tiles;// use (swapped) V5/V6 EMC tiles when set to "true"
1506 int color; // color to use on selection screen for this level
1507 char *class_desc; // description of level series class
1508 int handicap_level; // number of the lowest unsolved level
1510 char *infotext; // optional text to describe the tree type (headline)
1513 typedef struct TreeInfo TreeInfo;
1514 typedef struct TreeInfo LevelDirTree;
1515 typedef struct TreeInfo ArtworkDirTree;
1516 typedef struct TreeInfo GraphicsDirTree;
1517 typedef struct TreeInfo SoundsDirTree;
1518 typedef struct TreeInfo MusicDirTree;
1522 GraphicsDirTree *gfx_first;
1523 GraphicsDirTree *gfx_current;
1524 SoundsDirTree *snd_first;
1525 SoundsDirTree *snd_current;
1526 MusicDirTree *mus_first;
1527 MusicDirTree *mus_current;
1529 char *gfx_current_identifier;
1530 char *snd_current_identifier;
1531 char *mus_current_identifier;
1534 struct ValueTextInfo
1540 struct StringValueTextInfo
1552 struct ConfigTypeInfo
1559 struct TokenIntPtrInfo
1569 char *default_filename;
1572 char **default_parameter; // array of file parameters
1573 char **parameter; // array of file parameters
1576 boolean fallback_to_default;
1577 boolean default_is_cloned;
1580 struct SetupFileList
1585 struct SetupFileList *next;
1590 char *source_filename; // primary key for node list
1594 struct PropertyMapping
1604 struct ArtworkListInfo
1606 int type; // type of artwork
1608 int num_file_list_entries;
1609 int num_dynamic_file_list_entries;
1610 struct FileInfo *file_list; // static artwork file array
1611 struct FileInfo *dynamic_file_list; // dynamic artwrk file array
1613 int num_suffix_list_entries;
1614 struct ConfigTypeInfo *suffix_list; // parameter suffixes array
1616 int num_base_prefixes;
1617 int num_ext1_suffixes;
1618 int num_ext2_suffixes;
1619 int num_ext3_suffixes;
1620 char **base_prefixes; // base token prefixes array
1621 char **ext1_suffixes; // property suffixes array 1
1622 char **ext2_suffixes; // property suffixes array 2
1623 char **ext3_suffixes; // property suffixes array 3
1625 int num_ignore_tokens;
1626 char **ignore_tokens; // file tokens to be ignored
1628 int num_property_mapping_entries;
1629 struct PropertyMapping *property_mapping; // mapping token -> artwork
1631 int sizeof_artwork_list_entry;
1633 struct ListNodeInfo **artwork_list; // static artwork node array
1634 struct ListNodeInfo **dynamic_artwork_list; // dynamic artwrk node array
1635 struct ListNode *content_list; // dynamic artwork node list
1637 void *(*load_artwork)(char *); // constructor function
1638 void (*free_artwork)(void *); // destructor function
1658 struct RectWithBorder
1662 int min_width, min_height;
1663 int max_width, max_height;
1684 struct DoorPartPosInfo
1691 int start_step_opening;
1692 int start_step_closing;
1693 boolean draw_masked;
1700 int xoffset; // special case for tape date and time
1701 int xoffset2; // special case for tape date
1702 int yoffset; // special case for list of preview players
1705 int size; // also used for suffix ".digits"
1707 boolean draw_masked;
1708 boolean draw_player; // special case for network player buttons
1709 int sort_priority; // also used for suffix ".draw_order"
1712 int direction; // needed for panel time/health graphics
1713 int class; // needed for panel time/health graphics
1714 int style; // needed for panel time/health graphics
1716 int tile_size; // special case for list of network players
1717 int border_size; // special case for list of preview players
1718 int vertical; // special case for list of preview players
1720 boolean redefined; // redefined by custom artwork
1723 struct MouseActionInfo
1732 int music[MAX_LEVELS];
1745 // ============================================================================
1746 // exported variables
1747 // ============================================================================
1749 extern struct ProgramInfo program;
1750 extern struct NetworkInfo network;
1751 extern struct RuntimeInfo runtime;
1752 extern struct OptionInfo options;
1753 extern struct VideoSystemInfo video;
1754 extern struct AudioSystemInfo audio;
1755 extern struct GfxInfo gfx;
1756 extern struct TileCursorInfo tile_cursor;
1757 extern struct OverlayInfo overlay;
1758 extern struct AnimInfo anim;
1759 extern struct ArtworkInfo artwork;
1760 extern struct JoystickInfo joystick;
1761 extern struct SetupInfo setup;
1763 extern LevelDirTree *leveldir_first_all;
1764 extern LevelDirTree *leveldir_first;
1765 extern LevelDirTree *leveldir_current;
1766 extern int level_nr;
1768 extern struct LevelSetInfo levelset;
1769 extern struct LevelStats level_stats[];
1771 extern DrawWindow *window;
1772 extern DrawBuffer *backbuffer;
1773 extern DrawBuffer *drawto;
1775 extern int button_status;
1776 extern boolean motion_status;
1777 extern int wheel_steps;
1778 extern boolean keyrepeat_status;
1779 extern boolean textinput_status;
1781 extern int redraw_mask;
1783 extern int FrameCounter;
1786 // function definitions
1788 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
1790 void InitNetworkInfo(boolean, boolean, boolean, char *, int);
1791 void InitRuntimeInfo(void);
1793 void InitScoresInfo(void);
1794 void SetWindowTitle(void);
1796 void InitWindowTitleFunction(char *(*window_title_function)(void));
1797 void InitExitMessageFunction(void (*exit_message_function)(char *, va_list));
1798 void InitExitFunction(void (*exit_function)(int));
1799 void InitPlatformDependentStuff(void);
1800 void ClosePlatformDependentStuff(void);
1802 void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
1803 void InitGfxTileSizeInfo(int, int);
1804 void InitGfxDoor1Info(int, int, int, int);
1805 void InitGfxDoor2Info(int, int, int, int);
1806 void InitGfxDoor3Info(int, int, int, int);
1807 void InitGfxWindowInfo(int, int);
1808 void InitGfxScrollbufferInfo(int, int);
1809 void InitGfxClipRegion(boolean, int, int, int, int);
1810 void InitGfxDrawBusyAnimFunction(void (*draw_busy_anim_function)(void));
1811 void InitGfxDrawGlobalAnimFunction(void (*draw_global_anim_function)(int, int));
1812 void InitGfxDrawGlobalBorderFunction(void (*draw_global_border_function)(int));
1813 void InitGfxDrawTileCursorFunction(void (*draw_tile_cursor_function)(int));
1814 void InitGfxCustomArtworkInfo(void);
1815 void InitGfxOtherSettings(void);
1816 void InitTileCursorInfo(void);
1817 void InitOverlayInfo(void);
1818 void SetOverlayGridSizeAndButtons(void);
1819 void SetTileCursorEnabled(boolean);
1820 void SetTileCursorActive(boolean);
1821 void SetTileCursorTargetXY(int, int);
1822 void SetTileCursorXY(int, int);
1823 void SetTileCursorSXSY(int, int);
1824 void SetOverlayEnabled(boolean);
1825 void SetOverlayActive(boolean);
1826 void SetOverlayShowGrid(boolean);
1827 boolean GetOverlayEnabled(void);
1828 boolean GetOverlayActive(void);
1829 void SetDrawDeactivationMask(int);
1830 int GetDrawDeactivationMask(void);
1831 void SetDrawBackgroundMask(int);
1832 void SetWindowBackgroundBitmap(Bitmap *);
1833 void SetMainBackgroundBitmap(Bitmap *);
1834 void SetDoorBackgroundBitmap(Bitmap *);
1835 void SetRedrawMaskFromArea(int, int, int, int);
1837 void LimitScreenUpdates(boolean);
1839 void InitVideoDefaults(void);
1840 void InitVideoDisplay(void);
1841 void CloseVideoDisplay(void);
1842 void InitVideoBuffer(int, int, int, boolean);
1843 Bitmap *CreateBitmapStruct(void);
1844 Bitmap *CreateBitmap(int, int, int);
1845 void ReCreateBitmap(Bitmap **, int, int);
1846 void FreeBitmap(Bitmap *);
1847 void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
1848 void BlitBitmapTiled(Bitmap *, Bitmap *, int, int, int, int, int, int, int,int);
1849 void FadeRectangle(int, int, int, int, int, int, int,
1850 void (*draw_border_function)(void));
1851 void FillRectangle(Bitmap *, int, int, int, int, Pixel);
1852 void ClearRectangle(Bitmap *, int, int, int, int);
1853 void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
1854 void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
1855 boolean DrawingDeactivatedField(void);
1856 boolean DrawingDeactivated(int, int, int, int);
1857 boolean DrawingOnBackground(int, int);
1858 boolean DrawingAreaChanged(void);
1859 void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int, int);
1860 void BlitTexture(Bitmap *, int, int, int, int, int, int);
1861 void BlitTextureMasked(Bitmap *, int, int, int, int, int, int);
1862 void BlitToScreen(Bitmap *, int, int, int, int, int, int);
1863 void BlitToScreenMasked(Bitmap *, int, int, int, int, int, int);
1864 void DrawSimpleBlackLine(Bitmap *, int, int, int, int);
1865 void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
1866 void DrawLines(Bitmap *, struct XY *, int, Pixel);
1867 Pixel GetPixel(Bitmap *, int, int);
1868 Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
1869 Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
1871 void KeyboardAutoRepeatOn(void);
1872 void KeyboardAutoRepeatOff(void);
1873 boolean SetVideoMode(boolean);
1874 void SetVideoFrameDelay(unsigned int);
1875 unsigned int GetVideoFrameDelay(void);
1876 boolean ChangeVideoModeIfNeeded(boolean);
1878 Bitmap *LoadImage(char *);
1879 Bitmap *LoadCustomImage(char *);
1880 void ReloadCustomImage(Bitmap *, char *);
1882 void ReCreateGameTileSizeBitmap(Bitmap **);
1883 void CreateBitmapWithSmallBitmaps(Bitmap **, int, int);
1884 void CreateBitmapTextures(Bitmap **);
1885 void FreeBitmapTextures(Bitmap **);
1886 void ScaleBitmap(Bitmap **, int);
1888 void SetMouseCursor(int);
1889 void UpdateRawMousePosition(int, int);
1890 void UpdateMousePosition(void);
1892 void OpenAudio(void);
1893 void CloseAudio(void);
1894 void SetAudioMode(boolean);
1896 void InitEventFilter(EventFilter);
1897 boolean PendingEvent(void);
1898 void WaitEvent(Event *event);
1899 void PeekEvent(Event *event);
1900 void PumpEvents(void);
1901 void CheckQuitEvent(void);
1902 Key GetEventKey(KeyEvent *, boolean);
1903 KeyMod HandleKeyModState(Key, int);
1904 KeyMod GetKeyModState(void);
1905 KeyMod GetKeyModStateFromEvents(void);
1906 void StartTextInput(int, int, int, int);
1907 void StopTextInput(void);
1908 void PushUserEvent(int, int, int);
1910 void InitJoysticks(void);
1911 boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
1912 boolean CheckJoystickOpened(int);
1913 void ClearJoystickState(void);