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"
630 #define USERS_DIRECTORY "users"
632 #define GFX_CLASSIC_SUBDIR "gfx_classic"
633 #define SND_CLASSIC_SUBDIR "snd_classic"
634 #define MUS_CLASSIC_SUBDIR "mus_classic"
636 #define GFX_DEFAULT_SUBDIR (setup.internal.default_graphics_set)
637 #define SND_DEFAULT_SUBDIR (setup.internal.default_sounds_set)
638 #define MUS_DEFAULT_SUBDIR (setup.internal.default_music_set)
640 #define GFX_FALLBACK_FILENAME (setup.internal.fallback_graphics_file)
641 #define SND_FALLBACK_FILENAME (setup.internal.fallback_sounds_file)
642 #define MUS_FALLBACK_FILENAME (setup.internal.fallback_music_file)
644 #define DEFAULT_LEVELSET (setup.internal.default_level_series)
646 // file names and filename extensions
647 #define LEVELSETUP_DIRECTORY "levelsetup"
648 #define SETUP_FILENAME "setup.conf"
649 #define AUTOSETUP_FILENAME "autosetup.conf"
650 #define LEVELSETUP_FILENAME "levelsetup.conf"
651 #define EDITORSETUP_FILENAME "editorsetup.conf"
652 #define EDITORCASCADE_FILENAME "editorcascade.conf"
653 #define HELPANIM_FILENAME "helpanim.conf"
654 #define HELPTEXT_FILENAME "helptext.conf"
655 #define LEVELINFO_FILENAME "levelinfo.conf"
656 #define GRAPHICSINFO_FILENAME "graphicsinfo.conf"
657 #define SOUNDSINFO_FILENAME "soundsinfo.conf"
658 #define MUSICINFO_FILENAME "musicinfo.conf"
659 #define ARTWORKINFO_CACHE_FILE "artworkinfo.cache"
660 #define LEVELTEMPLATE_FILENAME "template.level"
661 #define LEVELFILE_EXTENSION "level"
662 #define TAPEFILE_EXTENSION "tape"
663 #define SCOREFILE_EXTENSION "score"
665 #define GAMECONTROLLER_BASENAME "gamecontrollerdb.txt"
667 #define LOG_OUT_BASENAME "stdout.txt"
668 #define LOG_ERR_BASENAME "stderr.txt"
674 #define STRING_PARENT_DIRECTORY ".."
675 #define STRING_TOP_DIRECTORY "/"
677 #define CHAR_PATH_SEPARATOR_UNIX '/'
678 #define CHAR_PATH_SEPARATOR_DOS '\\'
680 #define STRING_PATH_SEPARATOR_UNIX "/"
681 #define STRING_PATH_SEPARATOR_DOS "\\"
683 #define STRING_NEWLINE_UNIX "\n"
684 #define STRING_NEWLINE_DOS "\r\n"
686 #if defined(PLATFORM_WIN32)
687 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_DOS
688 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_DOS
689 #define STRING_NEWLINE STRING_NEWLINE_DOS
691 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_UNIX
692 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_UNIX
693 #define STRING_NEWLINE STRING_NEWLINE_UNIX
697 // areas in bitmap PIX_DOOR
698 // meaning in PIX_DB_DOOR: (3 PAGEs)
699 // PAGEX1: 1. buffer for DOOR_1
700 // PAGEX2: 2. buffer for DOOR_1
701 // PAGEX3: buffer for animations
703 // these values are hard-coded to be able to use them in initialization
704 #define DOOR_GFX_PAGE_WIDTH 100 // should be set to "gfx.dxsize"
705 #define DOOR_GFX_PAGE_HEIGHT 280 // should be set to "gfx.dysize"
707 #define DOOR_GFX_PAGESIZE (DOOR_GFX_PAGE_WIDTH)
708 #define DOOR_GFX_PAGEX1 (0 * DOOR_GFX_PAGESIZE)
709 #define DOOR_GFX_PAGEX2 (1 * DOOR_GFX_PAGESIZE)
710 #define DOOR_GFX_PAGEX3 (2 * DOOR_GFX_PAGESIZE)
711 #define DOOR_GFX_PAGEX4 (3 * DOOR_GFX_PAGESIZE)
712 #define DOOR_GFX_PAGEX5 (4 * DOOR_GFX_PAGESIZE)
713 #define DOOR_GFX_PAGEX6 (5 * DOOR_GFX_PAGESIZE)
714 #define DOOR_GFX_PAGEX7 (6 * DOOR_GFX_PAGESIZE)
715 #define DOOR_GFX_PAGEX8 (7 * DOOR_GFX_PAGESIZE)
716 #define DOOR_GFX_PAGEY1 (0)
717 #define DOOR_GFX_PAGEY2 (DOOR_GFX_PAGE_HEIGHT)
720 // macros for version handling
721 #define VERSION_PART_1(x) ((x) / 1000000)
722 #define VERSION_PART_2(x) (((x) % 1000000) / 10000)
723 #define VERSION_PART_3(x) (((x) % 10000) / 100)
724 #define VERSION_PART_4(x) ((x) % 100)
726 #define VERSION_SUPER(x) VERSION_PART_1(x)
727 #define VERSION_MAJOR(x) VERSION_PART_2(x)
728 #define VERSION_MINOR(x) VERSION_PART_3(x)
729 #define VERSION_PATCH(x) VERSION_PART_4(x)
730 #define VERSION_IDENT(a,b,c,d) ((a) * 1000000 + (b) * 10000 + (c) * 100 + (d))
733 // macros for parent/child process identification
734 #if defined(PLATFORM_UNIX)
735 #define IS_PARENT_PROCESS() (audio.mixer_pid != getpid())
736 #define IS_CHILD_PROCESS() (audio.mixer_pid == getpid())
737 #define HAS_CHILD_PROCESS() (audio.mixer_pid > 0)
739 #define IS_PARENT_PROCESS() TRUE
740 #define IS_CHILD_PROCESS() FALSE
741 #define HAS_CHILD_PROCESS() FALSE
745 // values for artwork type
746 #define ARTWORK_TYPE_GRAPHICS 0
747 #define ARTWORK_TYPE_SOUNDS 1
748 #define ARTWORK_TYPE_MUSIC 2
750 #define NUM_ARTWORK_TYPES 3
753 // values for tree type (chosen to match artwork type)
754 #define TREE_TYPE_UNDEFINED -1
755 #define TREE_TYPE_GRAPHICS_DIR ARTWORK_TYPE_GRAPHICS
756 #define TREE_TYPE_SOUNDS_DIR ARTWORK_TYPE_SOUNDS
757 #define TREE_TYPE_MUSIC_DIR ARTWORK_TYPE_MUSIC
758 #define TREE_TYPE_LEVEL_DIR 3
759 #define TREE_TYPE_LEVEL_NR 4
761 #define NUM_BASE_TREE_TYPES 4
762 #define NUM_TREE_TYPES 5
764 #define INFOTEXT_UNDEFINED ""
765 #define INFOTEXT_GRAPHICS_DIR "Custom Graphics"
766 #define INFOTEXT_SOUNDS_DIR "Custom Sounds"
767 #define INFOTEXT_MUSIC_DIR "Custom Music"
768 #define INFOTEXT_LEVEL_DIR "Level Sets"
769 #define INFOTEXT_LEVEL_NR "Levels"
771 #define TREE_INFOTEXT(t) ((t) == TREE_TYPE_LEVEL_NR ? \
772 INFOTEXT_LEVEL_NR : \
773 (t) == TREE_TYPE_LEVEL_DIR ? \
774 INFOTEXT_LEVEL_DIR : \
775 (t) == TREE_TYPE_GRAPHICS_DIR ? \
776 INFOTEXT_GRAPHICS_DIR : \
777 (t) == TREE_TYPE_SOUNDS_DIR ? \
778 INFOTEXT_SOUNDS_DIR : \
779 (t) == TREE_TYPE_MUSIC_DIR ? \
780 INFOTEXT_MUSIC_DIR : \
783 #define TREE_USERDIR(t) ((t) == TREE_TYPE_LEVEL_DIR ? \
784 getUserLevelDir(NULL) : \
785 (t) == TREE_TYPE_GRAPHICS_DIR ? \
786 getUserGraphicsDir() : \
787 (t) == TREE_TYPE_SOUNDS_DIR ? \
788 getUserSoundsDir() : \
789 (t) == TREE_TYPE_MUSIC_DIR ? \
790 getUserMusicDir() : \
793 #define TREE_FIRST_NODE_PTR(t) ((t) == TREE_TYPE_LEVEL_DIR ? \
795 (t) == TREE_TYPE_GRAPHICS_DIR ? \
796 &artwork.gfx_first : \
797 (t) == TREE_TYPE_SOUNDS_DIR ? \
798 &artwork.snd_first : \
799 (t) == TREE_TYPE_MUSIC_DIR ? \
800 &artwork.mus_first : \
803 #define TREE_FIRST_NODE(t) ((t) == TREE_TYPE_LEVEL_DIR ? \
805 (t) == TREE_TYPE_GRAPHICS_DIR ? \
806 artwork.gfx_first : \
807 (t) == TREE_TYPE_SOUNDS_DIR ? \
808 artwork.snd_first : \
809 (t) == TREE_TYPE_MUSIC_DIR ? \
810 artwork.mus_first : \
813 // values for artwork handling
814 #define LEVELDIR_ARTWORK_SET_PTR(leveldir, type) \
815 ((type) == ARTWORK_TYPE_GRAPHICS ? \
816 &(leveldir)->graphics_set : \
817 (type) == ARTWORK_TYPE_SOUNDS ? \
818 &(leveldir)->sounds_set : \
819 &(leveldir)->music_set)
821 #define LEVELDIR_ARTWORK_SET(leveldir, type) \
822 ((type) == ARTWORK_TYPE_GRAPHICS ? \
823 (leveldir)->graphics_set : \
824 (type) == ARTWORK_TYPE_SOUNDS ? \
825 (leveldir)->sounds_set : \
826 (leveldir)->music_set)
828 #define LEVELDIR_ARTWORK_PATH_PTR(leveldir, type) \
829 ((type) == ARTWORK_TYPE_GRAPHICS ? \
830 &(leveldir)->graphics_path : \
831 (type) == ARTWORK_TYPE_SOUNDS ? \
832 &(leveldir)->sounds_path : \
833 &(leveldir)->music_path)
835 #define LEVELDIR_ARTWORK_PATH(leveldir, type) \
836 ((type) == ARTWORK_TYPE_GRAPHICS ? \
837 (leveldir)->graphics_path : \
838 (type) == ARTWORK_TYPE_SOUNDS ? \
839 (leveldir)->sounds_path : \
840 (leveldir)->music_path)
842 #define SETUP_ARTWORK_SET(setup, type) \
843 ((type) == ARTWORK_TYPE_GRAPHICS ? \
844 (setup).graphics_set : \
845 (type) == ARTWORK_TYPE_SOUNDS ? \
846 (setup).sounds_set : \
849 #define SETUP_OVERRIDE_ARTWORK(setup, type) \
850 ((type) == ARTWORK_TYPE_GRAPHICS ? \
851 (setup).override_level_graphics : \
852 (type) == ARTWORK_TYPE_SOUNDS ? \
853 (setup).override_level_sounds : \
854 (setup).override_level_music)
856 #define GFX_OVERRIDE_ARTWORK(type) \
857 ((type) == ARTWORK_TYPE_GRAPHICS ? \
858 gfx.override_level_graphics : \
859 (type) == ARTWORK_TYPE_SOUNDS ? \
860 gfx.override_level_sounds : \
861 gfx.override_level_music)
863 #define ARTWORK_FIRST_NODE(artwork, type) \
864 ((type) == ARTWORK_TYPE_GRAPHICS ? \
865 (artwork).gfx_first : \
866 (type) == ARTWORK_TYPE_SOUNDS ? \
867 (artwork).snd_first : \
870 #define ARTWORK_CURRENT_PTR(artwork, type) \
871 ((type) == ARTWORK_TYPE_GRAPHICS ? \
872 &(artwork).gfx_current : \
873 (type) == ARTWORK_TYPE_SOUNDS ? \
874 &(artwork).snd_current : \
875 &(artwork).mus_current)
877 #define ARTWORK_CURRENT(artwork, type) \
878 ((type) == ARTWORK_TYPE_GRAPHICS ? \
879 (artwork).gfx_current : \
880 (type) == ARTWORK_TYPE_SOUNDS ? \
881 (artwork).snd_current : \
882 (artwork).mus_current)
884 #define ARTWORK_CURRENT_IDENTIFIER_PTR(artwork, type) \
885 ((type) == ARTWORK_TYPE_GRAPHICS ? \
886 &(artwork).gfx_current_identifier : \
887 (type) == ARTWORK_TYPE_SOUNDS ? \
888 &(artwork).snd_current_identifier : \
889 &(artwork).mus_current_identifier)
891 #define ARTWORK_CURRENT_IDENTIFIER(artwork, type) \
892 ((type) == ARTWORK_TYPE_GRAPHICS ? \
893 (artwork).gfx_current_identifier : \
894 (type) == ARTWORK_TYPE_SOUNDS ? \
895 (artwork).snd_current_identifier : \
896 (artwork).mus_current_identifier)
898 #define ARTWORKINFO_FILENAME(type) \
899 ((type) == ARTWORK_TYPE_GRAPHICS ? \
900 GRAPHICSINFO_FILENAME : \
901 (type) == ARTWORK_TYPE_SOUNDS ? \
902 SOUNDSINFO_FILENAME : \
903 (type) == ARTWORK_TYPE_MUSIC ? \
904 MUSICINFO_FILENAME : "")
906 #define ARTWORK_DIRECTORY(type) \
907 ((type) == ARTWORK_TYPE_GRAPHICS ? \
908 GRAPHICS_DIRECTORY : \
909 (type) == ARTWORK_TYPE_SOUNDS ? \
911 (type) == ARTWORK_TYPE_MUSIC ? \
912 MUSIC_DIRECTORY : "")
914 #define OPTIONS_ARTWORK_DIRECTORY(type) \
915 ((type) == ARTWORK_TYPE_GRAPHICS ? \
916 options.graphics_directory : \
917 (type) == ARTWORK_TYPE_SOUNDS ? \
918 options.sounds_directory : \
919 (type) == ARTWORK_TYPE_MUSIC ? \
920 options.music_directory : "")
922 #define USER_ARTWORK_DIRECTORY(type) \
923 ((type) == ARTWORK_TYPE_GRAPHICS ? \
924 getUserGraphicsDir() : \
925 (type) == ARTWORK_TYPE_SOUNDS ? \
926 getUserSoundsDir() : \
927 (type) == ARTWORK_TYPE_MUSIC ? \
928 getUserMusicDir() : "")
930 #define ARTWORK_DEFAULT_SUBDIR(type) \
931 ((type) == ARTWORK_TYPE_GRAPHICS ? \
932 GFX_DEFAULT_SUBDIR : \
933 (type) == ARTWORK_TYPE_SOUNDS ? \
934 SND_DEFAULT_SUBDIR : \
937 #define UPDATE_BUSY_STATE() \
939 if (gfx.draw_busy_anim_function != NULL) \
940 gfx.draw_busy_anim_function(); \
944 // structure definitions
948 char *command_basepath; // path to the program binary
949 char *command_basename; // base filename of the program binary
951 char *config_filename; // optional global program config filename
953 char *maindata_path; // main game data (installation) directory
955 char *userdata_subdir; // personal user game data directory
956 char *userdata_path; // resulting full path to game data directory
966 char *log_filename[NUM_LOGS]; // log filenames for out/err messages
967 FILE *log_file[NUM_LOGS]; // log file handles for out/err files
968 FILE *log_file_default[NUM_LOGS]; // default log file handles (out/err)
976 char *version_string;
978 char *(*window_title_function)(void);
979 void (*exit_message_function)(char *, va_list);
980 void (*exit_function)(int);
982 boolean global_scores;
983 boolean many_scores_per_name;
997 SDL_Thread *server_thread;
998 boolean is_server_thread;
1003 boolean uses_touch_device;
1011 char *ro_base_directory;
1012 char *rw_base_directory;
1013 char *level_directory;
1014 char *graphics_directory;
1015 char *sounds_directory;
1016 char *music_directory;
1017 char *docs_directory;
1018 char *conf_directory;
1020 char *execute_command;
1022 char *special_flags;
1032 struct VideoSystemInfo
1035 int width, height, depth;
1036 int window_width, window_height;
1037 int display_width, display_height;
1038 int screen_width, screen_height;
1039 int screen_xoffset, screen_yoffset;
1041 boolean fullscreen_available;
1042 boolean fullscreen_enabled;
1043 boolean fullscreen_initial;
1045 boolean window_scaling_available;
1046 int window_scaling_percent;
1047 char *window_scaling_quality;
1048 int screen_rendering_mode;
1051 unsigned int frame_counter;
1052 unsigned int frame_delay;
1053 unsigned int frame_delay_value;
1057 int shifted_up_pos_last;
1058 unsigned int shifted_up_delay;
1059 unsigned int shifted_up_delay_value;
1061 boolean initialized;
1064 struct AudioSystemInfo
1066 boolean sound_available;
1067 boolean loops_available;
1068 boolean music_available;
1070 boolean sound_enabled;
1071 boolean sound_deactivated; // for temporarily disabling sound
1080 int first_sound_channel;
1083 struct FontBitmapInfo
1087 int src_x, src_y; // start position of font characters
1088 int width, height; // width / height of font characters
1090 int offset_x; // offset to next font character
1091 int offset_y; // offset to next font character
1093 int draw_xoffset; // offset for drawing font characters
1094 int draw_yoffset; // offset for drawing font characters
1097 int num_chars_per_line;
1104 int real_sx, real_sy;
1105 int full_sxsize, full_sysize;
1106 int scrollbuffer_width, scrollbuffer_height;
1108 int game_tile_size, standard_tile_size;
1119 int win_xsize, win_ysize;
1121 int draw_deactivation_mask;
1122 int draw_background_mask;
1124 Bitmap *field_save_buffer;
1126 Bitmap *background_bitmap;
1127 int background_bitmap_mask;
1129 Bitmap *fade_bitmap_backup;
1130 Bitmap *fade_bitmap_source;
1131 Bitmap *fade_bitmap_target;
1132 Bitmap *fade_bitmap_black;
1134 int fade_border_source_status;
1135 int fade_border_target_status;
1136 Bitmap *masked_border_bitmap_ptr;
1138 Bitmap *final_screen_bitmap;
1140 boolean clipping_enabled;
1142 int clip_width, clip_height;
1144 boolean override_level_graphics;
1145 boolean override_level_sounds;
1146 boolean override_level_music;
1148 boolean draw_init_text;
1151 struct FontBitmapInfo *font_bitmap_info;
1152 int (*select_font_function)(int);
1153 int (*get_font_from_token_function)(char *);
1155 int anim_random_frame;
1157 void (*draw_busy_anim_function)(void);
1158 void (*draw_global_anim_function)(int, int);
1159 void (*draw_global_border_function)(int);
1160 void (*draw_tile_cursor_function)(int);
1163 int cursor_mode_override;
1164 int cursor_mode_final;
1165 int mouse_x, mouse_y;
1168 struct TileCursorInfo
1170 boolean enabled; // tile cursor generally enabled or disabled
1171 boolean active; // tile cursor activated (depending on game)
1172 boolean moving; // tile cursor moving to target position
1174 int xpos, ypos; // tile cursor level playfield position
1175 int x, y; // tile cursor current screen position
1176 int target_x, target_y; // tile cursor target screen position
1178 int sx, sy; // tile cursor screen start position
1180 boolean xsn_debug; // enable or disable XSN debugging
1185 boolean enabled; // overlay generally enabled or disabled
1186 boolean active; // overlay activated (depending on game mode)
1193 char grid_button[MAX_GRID_XSIZE][MAX_GRID_YSIZE];
1194 char grid_button_highlight;
1196 int grid_button_action;
1202 int nr[MAX_PLAYERS]; // joystick number for each player
1205 struct SetupJoystickInfo
1207 char *device_name; // device name of player's joystick
1209 int xleft, xmiddle, xright;
1210 int yupper, ymiddle, ylower;
1214 struct SetupKeyboardInfo
1216 Key left, right, up, down;
1220 struct SetupTouchInfo
1229 char grid_button[2][MAX_GRID_XSIZE][MAX_GRID_YSIZE];
1231 int transparency; // in percent (0 == opaque, 100 == invisible)
1232 boolean draw_outlined;
1233 boolean draw_pressed;
1235 boolean grid_initialized;
1238 struct SetupInputInfo
1240 boolean use_joystick;
1241 struct SetupJoystickInfo joy;
1242 struct SetupKeyboardInfo key;
1245 struct SetupEditorInfo
1247 boolean el_boulderdash;
1248 boolean el_emerald_mine;
1249 boolean el_emerald_mine_club;
1252 boolean el_supaplex;
1253 boolean el_diamond_caves;
1254 boolean el_dx_boulderdash;
1256 boolean el_mirror_magic;
1257 boolean el_deflektor;
1260 boolean el_steel_chars;
1264 boolean el_user_defined;
1267 boolean el_headlines;
1272 boolean show_element_token;
1274 boolean use_template_for_new_levels;
1277 struct SetupAutoSetupInfo
1279 int editor_zoom_tilesize;
1282 struct SetupEditorCascadeInfo
1295 boolean el_steel_chars;
1303 struct SetupShortcutInfo
1309 Key focus_player[MAX_PLAYERS];
1310 Key focus_player_all;
1329 struct SetupSystemInfo
1331 char *sdl_renderdriver;
1332 char *sdl_videodriver;
1333 char *sdl_audiodriver;
1334 int audio_fragment_size;
1337 struct SetupInternalInfo
1339 char *program_title;
1340 char *program_version;
1341 char *program_author;
1342 char *program_email;
1343 char *program_website;
1344 char *program_copyright;
1345 char *program_company;
1347 char *program_icon_file;
1349 char *default_graphics_set;
1350 char *default_sounds_set;
1351 char *default_music_set;
1353 char *fallback_graphics_file;
1354 char *fallback_sounds_file;
1355 char *fallback_music_file;
1357 char *default_level_series;
1359 int default_window_width;
1360 int default_window_height;
1362 boolean choose_from_top_leveldir;
1363 boolean show_scaling_in_title;
1364 boolean create_user_levelset;
1367 boolean menu_engines;
1368 boolean menu_editor;
1369 boolean menu_graphics;
1371 boolean menu_artwork;
1374 boolean menu_shortcuts;
1376 boolean menu_save_and_exit;
1379 struct SetupDebugInfo
1381 int frame_delay[10];
1382 Key frame_delay_key[10];
1383 boolean frame_delay_use_mod_key;
1384 boolean frame_delay_game_only;
1385 boolean show_frames_per_second;
1394 boolean multiple_users;
1397 boolean sound_loops;
1398 boolean sound_music;
1399 boolean sound_simple;
1401 boolean scroll_delay;
1402 boolean forced_scroll_delay;
1403 int scroll_delay_value;
1404 char *engine_snapshot_mode;
1405 int engine_snapshot_memory;
1406 boolean fade_screens;
1408 boolean show_titlescreen;
1409 boolean quick_doors;
1412 boolean skip_levels;
1413 boolean increment_levels;
1414 boolean auto_play_next_level;
1415 boolean skip_scores_after_game;
1418 int window_scaling_percent;
1419 char *window_scaling_quality;
1420 char *screen_rendering_mode;
1422 boolean ask_on_escape;
1423 boolean ask_on_escape_editor;
1424 boolean ask_on_game_over;
1425 boolean quick_switch;
1426 boolean input_on_focus;
1427 boolean prefer_aga_graphics;
1428 boolean prefer_lowpass_sounds;
1429 boolean game_speed_extended;
1430 int game_frame_delay;
1431 boolean sp_show_border_elements;
1432 boolean small_game_graphics;
1433 boolean show_snapshot_buttons;
1438 int override_level_graphics; // not boolean -- can also be "AUTO"
1439 int override_level_sounds; // not boolean -- can also be "AUTO"
1440 int override_level_music; // not boolean -- can also be "AUTO"
1446 boolean network_mode;
1447 int network_player_nr;
1448 char *network_server_hostname;
1450 struct SetupAutoSetupInfo auto_setup;
1451 struct SetupEditorInfo editor;
1452 struct SetupEditorCascadeInfo editor_cascade;
1453 struct SetupShortcutInfo shortcut;
1454 struct SetupInputInfo input[MAX_PLAYERS];
1455 struct SetupTouchInfo touch;
1456 struct SetupSystemInfo system;
1457 struct SetupInternalInfo internal;
1458 struct SetupDebugInfo debug;
1460 struct OptionInfo options;
1470 struct TreeInfo **node_top; // topmost node in tree
1471 struct TreeInfo *node_parent; // parent level directory info
1472 struct TreeInfo *node_group; // level group sub-directory info
1473 struct TreeInfo *next; // next level series structure node
1475 int cl_first; // internal control field for setup screen
1476 int cl_cursor; // internal control field for setup screen
1478 int type; // type of tree content
1480 // fields for "type == TREE_TYPE_LEVEL_DIR"
1482 char *subdir; // tree info sub-directory basename (may be ".")
1483 char *fullpath; // complete path relative to tree base directory
1484 char *basepath; // absolute base path of tree base directory
1485 char *identifier; // identifier string for configuration files
1486 char *name; // tree info name, as displayed in selection menues
1487 char *name_sorting; // optional sorting name for correct name sorting
1488 char *author; // level or artwork author name
1489 char *year; // optional year of creation for levels or artwork
1491 char *program_title; // optional alternative text for program title
1492 char *program_copyright; // optional alternative text for program copyright
1493 char *program_company; // optional alternative text for program company
1495 char *imported_from; // optional comment for imported levels or artwork
1496 char *imported_by; // optional comment for imported levels or artwork
1497 char *tested_by; // optional comment to name people who tested a set
1499 char *graphics_set_ecs; // special EMC custom graphics set (ECS graphics)
1500 char *graphics_set_aga; // special EMC custom graphics set (AGA graphics)
1501 char *graphics_set; // optional custom graphics set (level tree only)
1502 char *sounds_set_default; // default EMC custom sounds set
1503 char *sounds_set_lowpass; // special EMC custom sounds set (lowpass filter)
1504 char *sounds_set; // optional custom sounds set (level tree only)
1505 char *music_set; // optional custom music set (level tree only)
1506 char *graphics_path; // path to optional custom graphics set (level only)
1507 char *sounds_path; // path to optional custom sounds set (level only)
1508 char *music_path; // path to optional custom music set (level only)
1510 char *level_filename; // filename of level file (for packed level file)
1511 char *level_filetype; // type of levels in level directory or level file
1513 char *special_flags; // flags for special actions performed on level file
1515 int levels; // number of levels in level series
1516 int first_level; // first level number (to allow start with 0 or 1)
1517 int last_level; // last level number (automatically calculated)
1518 int sort_priority; // sort levels by 'sort_priority' and then by name
1520 boolean latest_engine;// force level set to use the latest game engine
1522 boolean level_group; // directory contains more level series directories
1523 boolean parent_link; // entry links back to parent directory
1524 boolean in_user_dir; // user defined levels are stored in home directory
1525 boolean user_defined; // levels in user directory and marked as "private"
1526 boolean readonly; // readonly levels can not be changed with editor
1527 boolean handicap; // level set has no handicap when set to "false"
1528 boolean skip_levels; // levels can be skipped when set to "true"
1530 boolean use_emc_tiles;// use (swapped) V5/V6 EMC tiles when set to "true"
1532 int color; // color to use on selection screen for this level
1533 char *class_desc; // description of level series class
1534 int handicap_level; // number of the lowest unsolved level
1536 char *infotext; // optional text to describe the tree type (headline)
1539 typedef struct TreeInfo TreeInfo;
1540 typedef struct TreeInfo LevelDirTree;
1541 typedef struct TreeInfo ArtworkDirTree;
1542 typedef struct TreeInfo GraphicsDirTree;
1543 typedef struct TreeInfo SoundsDirTree;
1544 typedef struct TreeInfo MusicDirTree;
1548 GraphicsDirTree *gfx_first;
1549 GraphicsDirTree *gfx_current;
1550 SoundsDirTree *snd_first;
1551 SoundsDirTree *snd_current;
1552 MusicDirTree *mus_first;
1553 MusicDirTree *mus_current;
1555 char *gfx_current_identifier;
1556 char *snd_current_identifier;
1557 char *mus_current_identifier;
1560 struct ValueTextInfo
1566 struct StringValueTextInfo
1578 struct ConfigTypeInfo
1585 struct TokenIntPtrInfo
1595 char *default_filename;
1598 char **default_parameter; // array of file parameters
1599 char **parameter; // array of file parameters
1602 boolean fallback_to_default;
1603 boolean default_is_cloned;
1606 struct SetupFileList
1611 struct SetupFileList *next;
1616 char *source_filename; // primary key for node list
1620 struct PropertyMapping
1630 struct ArtworkListInfo
1632 int type; // type of artwork
1634 int num_file_list_entries;
1635 int num_dynamic_file_list_entries;
1636 struct FileInfo *file_list; // static artwork file array
1637 struct FileInfo *dynamic_file_list; // dynamic artwrk file array
1639 int num_suffix_list_entries;
1640 struct ConfigTypeInfo *suffix_list; // parameter suffixes array
1642 int num_base_prefixes;
1643 int num_ext1_suffixes;
1644 int num_ext2_suffixes;
1645 int num_ext3_suffixes;
1646 char **base_prefixes; // base token prefixes array
1647 char **ext1_suffixes; // property suffixes array 1
1648 char **ext2_suffixes; // property suffixes array 2
1649 char **ext3_suffixes; // property suffixes array 3
1651 int num_ignore_tokens;
1652 char **ignore_tokens; // file tokens to be ignored
1654 int num_property_mapping_entries;
1655 struct PropertyMapping *property_mapping; // mapping token -> artwork
1657 int sizeof_artwork_list_entry;
1659 struct ListNodeInfo **artwork_list; // static artwork node array
1660 struct ListNodeInfo **dynamic_artwork_list; // dynamic artwrk node array
1661 struct ListNode *content_list; // dynamic artwork node list
1663 void *(*load_artwork)(char *); // constructor function
1664 void (*free_artwork)(void *); // destructor function
1684 struct RectWithBorder
1688 int min_width, min_height;
1689 int max_width, max_height;
1710 struct DoorPartPosInfo
1717 int start_step_opening;
1718 int start_step_closing;
1719 boolean draw_masked;
1726 int xoffset; // special case for tape date and time
1727 int xoffset2; // special case for tape date
1728 int yoffset; // special case for list of preview players
1731 int size; // also used for suffix ".digits"
1733 boolean draw_masked;
1734 boolean draw_player; // special case for network player buttons
1735 int sort_priority; // also used for suffix ".draw_order"
1738 int direction; // needed for panel time/health graphics
1739 int class; // needed for panel time/health graphics
1740 int style; // needed for panel time/health graphics
1742 int tile_size; // special case for list of network players
1743 int border_size; // special case for list of preview players
1744 int vertical; // special case for list of preview players
1746 boolean redefined; // redefined by custom artwork
1749 struct MouseActionInfo
1758 int music[MAX_LEVELS];
1771 // ============================================================================
1772 // exported variables
1773 // ============================================================================
1775 extern struct ProgramInfo program;
1776 extern struct NetworkInfo network;
1777 extern struct RuntimeInfo runtime;
1778 extern struct OptionInfo options;
1779 extern struct VideoSystemInfo video;
1780 extern struct AudioSystemInfo audio;
1781 extern struct GfxInfo gfx;
1782 extern struct TileCursorInfo tile_cursor;
1783 extern struct OverlayInfo overlay;
1784 extern struct AnimInfo anim;
1785 extern struct ArtworkInfo artwork;
1786 extern struct JoystickInfo joystick;
1787 extern struct SetupInfo setup;
1788 extern struct UserInfo user;
1790 extern LevelDirTree *leveldir_first_all;
1791 extern LevelDirTree *leveldir_first;
1792 extern LevelDirTree *leveldir_current;
1793 extern int level_nr;
1795 extern struct LevelSetInfo levelset;
1796 extern struct LevelStats level_stats[];
1798 extern DrawWindow *window;
1799 extern DrawBuffer *backbuffer;
1800 extern DrawBuffer *drawto;
1802 extern int button_status;
1803 extern boolean motion_status;
1804 extern int wheel_steps;
1805 extern boolean keyrepeat_status;
1806 extern boolean textinput_status;
1808 extern int redraw_mask;
1810 extern int FrameCounter;
1813 // function definitions
1815 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
1817 void InitNetworkInfo(boolean, boolean, boolean, char *, int);
1818 void InitRuntimeInfo(void);
1820 void InitScoresInfo(void);
1821 void SetWindowTitle(void);
1823 void InitWindowTitleFunction(char *(*window_title_function)(void));
1824 void InitExitMessageFunction(void (*exit_message_function)(char *, va_list));
1825 void InitExitFunction(void (*exit_function)(int));
1826 void InitPlatformDependentStuff(void);
1827 void ClosePlatformDependentStuff(void);
1829 void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
1830 void InitGfxTileSizeInfo(int, int);
1831 void InitGfxDoor1Info(int, int, int, int);
1832 void InitGfxDoor2Info(int, int, int, int);
1833 void InitGfxDoor3Info(int, int, int, int);
1834 void InitGfxWindowInfo(int, int);
1835 void InitGfxScrollbufferInfo(int, int);
1836 void InitGfxClipRegion(boolean, int, int, int, int);
1837 void InitGfxDrawBusyAnimFunction(void (*draw_busy_anim_function)(void));
1838 void InitGfxDrawGlobalAnimFunction(void (*draw_global_anim_function)(int, int));
1839 void InitGfxDrawGlobalBorderFunction(void (*draw_global_border_function)(int));
1840 void InitGfxDrawTileCursorFunction(void (*draw_tile_cursor_function)(int));
1841 void InitGfxCustomArtworkInfo(void);
1842 void InitGfxOtherSettings(void);
1843 void InitTileCursorInfo(void);
1844 void InitOverlayInfo(void);
1845 void SetOverlayGridSizeAndButtons(void);
1846 void SetTileCursorEnabled(boolean);
1847 void SetTileCursorActive(boolean);
1848 void SetTileCursorTargetXY(int, int);
1849 void SetTileCursorXY(int, int);
1850 void SetTileCursorSXSY(int, int);
1851 void SetOverlayEnabled(boolean);
1852 void SetOverlayActive(boolean);
1853 void SetOverlayShowGrid(boolean);
1854 boolean GetOverlayEnabled(void);
1855 boolean GetOverlayActive(void);
1856 void SetDrawDeactivationMask(int);
1857 int GetDrawDeactivationMask(void);
1858 void SetDrawBackgroundMask(int);
1859 void SetWindowBackgroundBitmap(Bitmap *);
1860 void SetMainBackgroundBitmap(Bitmap *);
1861 void SetDoorBackgroundBitmap(Bitmap *);
1862 void SetRedrawMaskFromArea(int, int, int, int);
1864 void LimitScreenUpdates(boolean);
1866 void InitVideoDefaults(void);
1867 void InitVideoDisplay(void);
1868 void CloseVideoDisplay(void);
1869 void InitVideoBuffer(int, int, int, boolean);
1870 Bitmap *CreateBitmapStruct(void);
1871 Bitmap *CreateBitmap(int, int, int);
1872 void ReCreateBitmap(Bitmap **, int, int);
1873 void FreeBitmap(Bitmap *);
1874 void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
1875 void BlitBitmapTiled(Bitmap *, Bitmap *, int, int, int, int, int, int, int,int);
1876 void FadeRectangle(int, int, int, int, int, int, int,
1877 void (*draw_border_function)(void));
1878 void FillRectangle(Bitmap *, int, int, int, int, Pixel);
1879 void ClearRectangle(Bitmap *, int, int, int, int);
1880 void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
1881 void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
1882 boolean DrawingDeactivatedField(void);
1883 boolean DrawingDeactivated(int, int, int, int);
1884 boolean DrawingOnBackground(int, int);
1885 boolean DrawingAreaChanged(void);
1886 void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int, int);
1887 void BlitTexture(Bitmap *, int, int, int, int, int, int);
1888 void BlitTextureMasked(Bitmap *, int, int, int, int, int, int);
1889 void BlitToScreen(Bitmap *, int, int, int, int, int, int);
1890 void BlitToScreenMasked(Bitmap *, int, int, int, int, int, int);
1891 void DrawSimpleBlackLine(Bitmap *, int, int, int, int);
1892 void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
1893 void DrawLines(Bitmap *, struct XY *, int, Pixel);
1894 Pixel GetPixel(Bitmap *, int, int);
1895 Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
1896 Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
1898 void KeyboardAutoRepeatOn(void);
1899 void KeyboardAutoRepeatOff(void);
1900 boolean SetVideoMode(boolean);
1901 void SetVideoFrameDelay(unsigned int);
1902 unsigned int GetVideoFrameDelay(void);
1903 boolean ChangeVideoModeIfNeeded(boolean);
1905 Bitmap *LoadImage(char *);
1906 Bitmap *LoadCustomImage(char *);
1907 void ReloadCustomImage(Bitmap *, char *);
1909 void ReCreateGameTileSizeBitmap(Bitmap **);
1910 void CreateBitmapWithSmallBitmaps(Bitmap **, int, int);
1911 void CreateBitmapTextures(Bitmap **);
1912 void FreeBitmapTextures(Bitmap **);
1913 void ScaleBitmap(Bitmap **, int);
1915 void SetMouseCursor(int);
1916 void UpdateRawMousePosition(int, int);
1917 void UpdateMousePosition(void);
1919 void OpenAudio(void);
1920 void CloseAudio(void);
1921 void SetAudioMode(boolean);
1923 void InitEventFilter(EventFilter);
1924 boolean PendingEvent(void);
1925 void WaitEvent(Event *event);
1926 void PeekEvent(Event *event);
1927 void PumpEvents(void);
1928 void CheckQuitEvent(void);
1929 Key GetEventKey(KeyEvent *, boolean);
1930 KeyMod HandleKeyModState(Key, int);
1931 KeyMod GetKeyModState(void);
1932 KeyMod GetKeyModStateFromEvents(void);
1933 void StartTextInput(int, int, int, int);
1934 void StopTextInput(void);
1935 void PushUserEvent(int, int, int);
1937 void InitJoysticks(void);
1938 boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
1939 boolean CheckJoystickOpened(int);
1940 void ClearJoystickState(void);