1 // ============================================================================
2 // Artsoft Retro-Game Library
3 // ----------------------------------------------------------------------------
4 // (c) 1995-2014 by Artsoft Entertainment
7 // https://www.artsoft.org/
8 // ----------------------------------------------------------------------------
10 // ============================================================================
19 #if defined(PLATFORM_MACOSX)
21 #elif defined(PLATFORM_WIN32)
23 #elif defined(PLATFORM_ANDROID)
25 #elif defined(PLATFORM_EMSCRIPTEN)
26 #include "emscripten.h"
32 // the additional 'b' is needed for Win32 to open files in binary mode
33 #define MODE_READ "rb"
34 #define MODE_WRITE "wb"
35 #define MODE_APPEND "ab"
37 #define DEFAULT_DEPTH 0
41 #define BLIT_INVERSE 2
42 #define BLIT_ON_BACKGROUND 3
44 // values for fullscreen status
45 #define FULLSCREEN_NOT_AVAILABLE FALSE
46 #define FULLSCREEN_AVAILABLE TRUE
48 // values for window scaling
49 #define WINDOW_SCALING_NOT_AVAILABLE FALSE
50 #define WINDOW_SCALING_AVAILABLE TRUE
52 #define MIN_WINDOW_SCALING_PERCENT 30
53 #define STD_WINDOW_SCALING_PERCENT 100
54 #define MAX_WINDOW_SCALING_PERCENT 400
55 #define STEP_WINDOW_SCALING_PERCENT 10
57 // values for window scaling quality
58 #define SCALING_QUALITY_NEAREST "nearest"
59 #define SCALING_QUALITY_LINEAR "linear"
60 #define SCALING_QUALITY_BEST "best"
62 #define SCALING_QUALITY_DEFAULT SCALING_QUALITY_LINEAR
64 // values for screen rendering mode
65 #define STR_SPECIAL_RENDERING_OFF "stream_texture_only"
66 #define STR_SPECIAL_RENDERING_BITMAP "bitmap_and_stream_texture"
67 #define STR_SPECIAL_RENDERING_TARGET "target_texture_only"
68 #define STR_SPECIAL_RENDERING_DOUBLE "stream_and_target_texture"
70 #if defined(PLATFORM_EMSCRIPTEN)
71 #define STR_SPECIAL_RENDERING_DEFAULT STR_SPECIAL_RENDERING_BITMAP
73 #define STR_SPECIAL_RENDERING_DEFAULT STR_SPECIAL_RENDERING_DOUBLE
76 #define SPECIAL_RENDERING_OFF 0
77 #define SPECIAL_RENDERING_BITMAP 1
78 #define SPECIAL_RENDERING_TARGET 2
79 #define SPECIAL_RENDERING_DOUBLE 3
81 // values for vertical screen retrace synchronization (vsync)
82 #define STR_VSYNC_MODE_OFF "off"
83 #define STR_VSYNC_MODE_NORMAL "normal"
84 #define STR_VSYNC_MODE_ADAPTIVE "adaptive"
86 #define STR_VSYNC_MODE_DEFAULT STR_VSYNC_MODE_OFF
88 #define VSYNC_MODE_OFF 0
89 #define VSYNC_MODE_NORMAL 1
90 #define VSYNC_MODE_ADAPTIVE -1
92 #define VSYNC_MODE_DEFAULT VSYNC_MODE_OFF
94 #define VSYNC_MODE_STR_TO_INT(s) \
95 (strEqual((s), STR_VSYNC_MODE_NORMAL) ? VSYNC_MODE_NORMAL : \
96 strEqual((s), STR_VSYNC_MODE_ADAPTIVE) ? VSYNC_MODE_ADAPTIVE : \
99 #define VSYNC_MODE_INT_TO_STR(i) \
100 ((i) == VSYNC_MODE_NORMAL ? STR_VSYNC_MODE_NORMAL : \
101 (i) == VSYNC_MODE_ADAPTIVE ? STR_VSYNC_MODE_ADAPTIVE : \
104 // values for network server settings
105 #define STR_NETWORK_AUTO_DETECT "auto_detect_network_server"
106 #define STR_NETWORK_AUTO_DETECT_SETUP "(auto detect network server)"
108 // values for API server settings
109 #define API_SERVER_HOSTNAME "api.artsoft.org"
110 #define API_SERVER_PORT 80
111 #define API_SERVER_METHOD "POST"
112 #define API_SERVER_URI_ADD "/api/scores/add"
113 #define API_SERVER_URI_GET "/api/scores/get"
114 #define API_SERVER_URI_RENAME "/api/players/rename"
115 #define API_SERVER_URI_RESETUUID "/api/players/resetuuid"
118 #undef API_SERVER_HOSTNAME
119 #define API_SERVER_HOSTNAME "api-test.artsoft.org"
120 #define TEST_PREFIX "test."
122 #define TEST_PREFIX ""
125 // values for touch control
126 #define TOUCH_CONTROL_OFF "off"
127 #define TOUCH_CONTROL_VIRTUAL_BUTTONS "virtual_buttons"
128 #define TOUCH_CONTROL_WIPE_GESTURES "wipe_gestures"
129 #define TOUCH_CONTROL_FOLLOW_FINGER "follow_finger"
131 #if defined(PLATFORM_ANDROID)
132 #define TOUCH_CONTROL_DEFAULT TOUCH_CONTROL_VIRTUAL_BUTTONS
134 #define TOUCH_CONTROL_DEFAULT TOUCH_CONTROL_OFF
137 #define TOUCH_MOVE_DISTANCE_DEFAULT 2
138 #define TOUCH_DROP_DISTANCE_DEFAULT 5
139 #define TOUCH_TRANSPARENCY_DEFAULT 50
141 #define ALPHA_FROM_TRANSPARENCY(x) ((100 - x) * SDL_ALPHA_OPAQUE / 100)
142 #define ALPHA_FADING_STEPSIZE(x) ((x) / 25)
144 // values for special settings for mobile devices
145 #if defined(PLATFORM_ANDROID)
146 #define HAS_TOUCH_DEVICE
147 #define USE_TOUCH_INPUT_OVERLAY
148 #define USE_COMPLETE_DISPLAY
149 #define HAS_SCREEN_KEYBOARD
150 #define SCREEN_KEYBOARD_POS(h) ((h) / 2)
153 // values for drag-and-drop support (some parts not added before SDL 2.0.5)
154 #if !SDL_VERSION_ATLEAST(2,0,5)
155 #define SDL_DROPTEXT (SDL_DROPFILE + 1)
156 #define SDL_DROPBEGIN (SDL_DROPFILE + 2)
157 #define SDL_DROPCOMPLETE (SDL_DROPFILE + 3)
160 // default input keys
161 #define DEFAULT_KEY_LEFT KSYM_Left
162 #define DEFAULT_KEY_RIGHT KSYM_Right
163 #define DEFAULT_KEY_UP KSYM_Up
164 #define DEFAULT_KEY_DOWN KSYM_Down
165 #if defined(PLATFORM_MACOSX)
166 #define DEFAULT_KEY_SNAP KSYM_Control_L
167 #define DEFAULT_KEY_DROP KSYM_KP_Enter
169 #define DEFAULT_KEY_SNAP KSYM_Control_L
170 #define DEFAULT_KEY_DROP KSYM_Control_R
172 #define DEFAULT_KEY_OKAY KSYM_Return
173 #define DEFAULT_KEY_CANCEL KSYM_Escape
175 // default shortcut keys
176 #define DEFAULT_KEY_SAVE_GAME KSYM_F1
177 #define DEFAULT_KEY_LOAD_GAME KSYM_F2
178 #define DEFAULT_KEY_RESTART_GAME KSYM_F3
179 #define DEFAULT_KEY_PAUSE_BEFORE_END KSYM_F4
180 #define DEFAULT_KEY_TOGGLE_PAUSE KSYM_space
181 #define DEFAULT_KEY_FOCUS_PLAYER_1 KSYM_F5
182 #define DEFAULT_KEY_FOCUS_PLAYER_2 KSYM_F6
183 #define DEFAULT_KEY_FOCUS_PLAYER_3 KSYM_F7
184 #define DEFAULT_KEY_FOCUS_PLAYER_4 KSYM_F8
185 #define DEFAULT_KEY_FOCUS_PLAYER_ALL KSYM_F9
186 #define DEFAULT_KEY_TAPE_EJECT KSYM_UNDEFINED
187 #define DEFAULT_KEY_TAPE_EXTRA KSYM_UNDEFINED
188 #define DEFAULT_KEY_TAPE_STOP KSYM_UNDEFINED
189 #define DEFAULT_KEY_TAPE_PAUSE KSYM_UNDEFINED
190 #define DEFAULT_KEY_TAPE_RECORD KSYM_UNDEFINED
191 #define DEFAULT_KEY_TAPE_PLAY KSYM_UNDEFINED
192 #define DEFAULT_KEY_SOUND_SIMPLE KSYM_UNDEFINED
193 #define DEFAULT_KEY_SOUND_LOOPS KSYM_UNDEFINED
194 #define DEFAULT_KEY_SOUND_MUSIC KSYM_UNDEFINED
195 #define DEFAULT_KEY_SNAP_LEFT KSYM_UNDEFINED
196 #define DEFAULT_KEY_SNAP_RIGHT KSYM_UNDEFINED
197 #define DEFAULT_KEY_SNAP_UP KSYM_UNDEFINED
198 #define DEFAULT_KEY_SNAP_DOWN KSYM_UNDEFINED
200 // default debug setup keys and values
201 #define DEFAULT_FRAME_DELAY_0 20 // 100 % speed
202 #define DEFAULT_FRAME_DELAY_1 500 // 4 % speed
203 #define DEFAULT_FRAME_DELAY_2 250 // 8 % speed
204 #define DEFAULT_FRAME_DELAY_3 125 // 16 % speed
205 #define DEFAULT_FRAME_DELAY_4 60 // 33 % speed
206 #define DEFAULT_FRAME_DELAY_5 40 // 50 % speed
207 #define DEFAULT_FRAME_DELAY_6 30 // 66 % speed
208 #define DEFAULT_FRAME_DELAY_7 10 // 200 % speed
209 #define DEFAULT_FRAME_DELAY_8 5 // 400 % speed
210 #define DEFAULT_FRAME_DELAY_9 0 // maximum speed
212 #define DEFAULT_KEY_FRAME_DELAY_0 KSYM_0
213 #define DEFAULT_KEY_FRAME_DELAY_1 KSYM_1
214 #define DEFAULT_KEY_FRAME_DELAY_2 KSYM_2
215 #define DEFAULT_KEY_FRAME_DELAY_3 KSYM_3
216 #define DEFAULT_KEY_FRAME_DELAY_4 KSYM_4
217 #define DEFAULT_KEY_FRAME_DELAY_5 KSYM_5
218 #define DEFAULT_KEY_FRAME_DELAY_6 KSYM_6
219 #define DEFAULT_KEY_FRAME_DELAY_7 KSYM_7
220 #define DEFAULT_KEY_FRAME_DELAY_8 KSYM_8
221 #define DEFAULT_KEY_FRAME_DELAY_9 KSYM_9
223 #define NUM_DEBUG_FRAME_DELAY_KEYS 10
225 #define DEFAULT_FRAME_DELAY_USE_MOD_KEY FALSE
226 #define DEFAULT_FRAME_DELAY_GAME_ONLY TRUE
228 // values for key_status
229 #define KEY_NOT_PRESSED FALSE
230 #define KEY_RELEASED FALSE
231 #define KEY_PRESSED TRUE
233 // values for button status
234 #define MB_NOT_PRESSED FALSE
235 #define MB_NOT_RELEASED TRUE
236 #define MB_RELEASED FALSE
237 #define MB_PRESSED TRUE
238 #define MB_MENU_CHOICE FALSE
239 #define MB_MENU_MARK TRUE
240 #define MB_MENU_INITIALIZE (-1)
241 #define MB_MENU_LEAVE (-2)
242 #define MB_LEFTBUTTON 1
243 #define MB_MIDDLEBUTTON 2
244 #define MB_RIGHTBUTTON 3
245 #define MB_WHEEL_UP 4
246 #define MB_WHEEL_DOWN 5
247 #define MB_WHEEL_LEFT 6
248 #define MB_WHEEL_RIGHT 7
249 #define IS_WHEEL_BUTTON_VERTICAL(b) ((b) == MB_WHEEL_UP || \
250 (b) == MB_WHEEL_DOWN)
251 #define IS_WHEEL_BUTTON_HORIZONTAL(b) ((b) == MB_WHEEL_LEFT || \
252 (b) == MB_WHEEL_RIGHT)
253 #define IS_WHEEL_BUTTON(b) (IS_WHEEL_BUTTON_VERTICAL(b) || \
254 IS_WHEEL_BUTTON_HORIZONTAL(b))
255 #define DEFAULT_WHEEL_STEPS 3
257 #define BUTTON_STEPSIZE(b) ((b) == MB_LEFTBUTTON ? 1 : \
258 (b) == MB_MIDDLEBUTTON ? 5 : \
259 (b) == MB_RIGHTBUTTON ? 10 : 1)
261 // values for move directions
262 #define MV_BIT_LEFT 0
263 #define MV_BIT_RIGHT 1
265 #define MV_BIT_DOWN 3
267 #define NUM_DIRECTIONS 4
269 // diagonal movement directions are used in a different contect than buttons
270 #define MV_BIT_UPLEFT 4
271 #define MV_BIT_UPRIGHT 5
272 #define MV_BIT_DOWNLEFT 6
273 #define MV_BIT_DOWNRIGHT 7
275 #define NUM_DIRECTIONS_FULL 8
277 // values for special "button" bitmasks
281 #define NUM_PLAYER_ACTIONS 6
283 // values for special "focus player" bitmasks
284 #define BIT_SET_FOCUS 6
286 // values for drawing stages for global animations
287 #define DRAW_GLOBAL_ANIM_STAGE_1 1
288 #define DRAW_GLOBAL_ANIM_STAGE_2 2
290 // values for drawing target (various functions)
291 #define DRAW_TO_BACKBUFFER 0
292 #define DRAW_TO_FIELDBUFFER 1
293 #define DRAW_TO_SCREEN 2
294 #define DRAW_TO_FADE_SOURCE 3
295 #define DRAW_TO_FADE_TARGET 4
297 // values for move directions and special "button" key bitmasks
299 #define MV_LEFT (1 << MV_BIT_LEFT)
300 #define MV_RIGHT (1 << MV_BIT_RIGHT)
301 #define MV_UP (1 << MV_BIT_UP)
302 #define MV_DOWN (1 << MV_BIT_DOWN)
304 #define MV_UPLEFT (MV_UP | MV_LEFT)
305 #define MV_UPRIGHT (MV_UP | MV_RIGHT)
306 #define MV_DOWNLEFT (MV_DOWN | MV_LEFT)
307 #define MV_DOWNRIGHT (MV_DOWN | MV_RIGHT)
309 #define MV_HORIZONTAL (MV_LEFT | MV_RIGHT)
310 #define MV_VERTICAL (MV_UP | MV_DOWN)
311 #define MV_ALL_DIRECTIONS (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
312 #define MV_ANY_DIRECTION (MV_ALL_DIRECTIONS)
313 #define MV_NO_DIRECTION (MV_NONE)
315 #define KEY_BUTTON_1 (1 << BUTTON_1)
316 #define KEY_BUTTON_2 (1 << BUTTON_2)
317 #define KEY_BUTTON_SNAP KEY_BUTTON_1
318 #define KEY_BUTTON_DROP KEY_BUTTON_2
319 #define KEY_MOTION (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
320 #define KEY_BUTTON (KEY_BUTTON_1 | KEY_BUTTON_2)
321 #define KEY_ACTION (KEY_MOTION | KEY_BUTTON)
323 #define KEY_SET_FOCUS (1 << BIT_SET_FOCUS)
325 #define MV_DIR_FROM_BIT(x) ((x) < NUM_DIRECTIONS ? 1 << (x) : \
326 (x) == MV_BIT_UPLEFT ? MV_UPLEFT : \
327 (x) == MV_BIT_UPRIGHT ? MV_UPRIGHT : \
328 (x) == MV_BIT_DOWNLEFT ? MV_DOWNLEFT : \
329 (x) == MV_BIT_DOWNRIGHT ? MV_DOWNRIGHT : \
332 #define MV_DIR_TO_BIT(x) ((x) == MV_LEFT ? MV_BIT_LEFT : \
333 (x) == MV_RIGHT ? MV_BIT_RIGHT : \
334 (x) == MV_UP ? MV_BIT_UP : \
335 (x) == MV_DOWN ? MV_BIT_DOWN : \
336 (x) == MV_UPLEFT ? MV_BIT_UPLEFT : \
337 (x) == MV_UPRIGHT ? MV_BIT_UPRIGHT : \
338 (x) == MV_DOWNLEFT ? MV_BIT_DOWNLEFT : \
339 (x) == MV_DOWNRIGHT ? MV_BIT_DOWNRIGHT : \
342 #define MV_DIR_OPPOSITE(x) ((x) == MV_LEFT ? MV_RIGHT : \
343 (x) == MV_RIGHT ? MV_LEFT : \
344 (x) == MV_UP ? MV_DOWN : \
345 (x) == MV_DOWN ? MV_UP : \
346 (x) == MV_UPLEFT ? MV_DOWNRIGHT : \
347 (x) == MV_UPRIGHT ? MV_DOWNLEFT : \
348 (x) == MV_DOWNLEFT ? MV_UPRIGHT : \
349 (x) == MV_DOWNRIGHT ? MV_UPLEFT : \
352 // values for animation mode (frame order and direction)
353 // (stored in level files -- never change existing values)
355 #define ANIM_LOOP (1 << 0)
356 #define ANIM_LINEAR (1 << 1)
357 #define ANIM_PINGPONG (1 << 2)
358 #define ANIM_PINGPONG2 (1 << 3)
359 #define ANIM_RANDOM (1 << 4)
360 #define ANIM_CE_VALUE (1 << 5)
361 #define ANIM_CE_SCORE (1 << 6)
362 #define ANIM_CE_DELAY (1 << 7)
363 #define ANIM_REVERSE (1 << 8)
364 #define ANIM_OPAQUE_PLAYER (1 << 9)
366 // values for special (non game element) animation modes
367 // (not stored in level files -- can be changed, if needed)
368 #define ANIM_HORIZONTAL (1 << 10)
369 #define ANIM_VERTICAL (1 << 11)
370 #define ANIM_CENTERED (1 << 12)
371 #define ANIM_STATIC_PANEL (1 << 13)
372 #define ANIM_ALL (1 << 14)
373 #define ANIM_ONCE (1 << 15)
374 #define ANIM_TILED (1 << 16)
375 #define ANIM_RANDOM_STATIC (1 << 17)
377 #define ANIM_DEFAULT ANIM_LOOP
379 // values for special drawing styles and event handling
382 // values used for crumbled graphics
383 #define STYLE_ACCURATE_BORDERS (1 << 0)
384 #define STYLE_INNER_CORNERS (1 << 1)
386 // values used for game panel graphics
387 #define STYLE_REVERSE (1 << 2)
388 #define STYLE_LEFTMOST_POSITION (1 << 3)
390 // values used for global animations
391 #define STYLE_BLOCK (1 << 4)
392 #define STYLE_PASSTHROUGH (1 << 5)
393 #define STYLE_MULTIPLE_ACTIONS (1 << 6)
395 #define STYLE_DEFAULT STYLE_NONE
397 // values for special global animation delay types
398 #define ANIM_DELAY_UNDEFINED -1
399 #define ANIM_DELAY_NONE 0
400 #define ANIM_DELAY_INIT 1
401 #define ANIM_DELAY_ANIM 2
402 #define ANIM_DELAY_POST 3
404 // values for special global animation delay actions
405 #define ANIM_DELAY_ACTION_NONE -1
407 // values for special global animation events
408 #define ANIM_EVENT_UNDEFINED -1
409 #define ANIM_EVENT_NONE 0
410 #define ANIM_EVENT_SELF (1 << 16)
411 #define ANIM_EVENT_ANY (1 << 17)
412 #define ANIM_EVENT_CLICK (1 << 18)
413 #define ANIM_EVENT_INIT (1 << 19)
414 #define ANIM_EVENT_START (1 << 20)
415 #define ANIM_EVENT_END (1 << 21)
416 #define ANIM_EVENT_POST (1 << 22)
417 #define ANIM_EVENT_UNCLICK_ANY (1 << 23)
419 // anim number: bits 0-7
420 // part number: bits 8-15
421 #define ANIM_EVENT_ANIM_BIT 0
422 #define ANIM_EVENT_PART_BIT 8
424 #define ANIM_EVENT_ANIM_MASK (0xff << ANIM_EVENT_ANIM_BIT)
425 #define ANIM_EVENT_PART_MASK (0xff << ANIM_EVENT_PART_BIT)
427 #define ANIM_EVENT_DEFAULT ANIM_EVENT_NONE
429 // values for special global animation event actions
430 #define ANIM_EVENT_ACTION_NONE -1
432 // values for fade mode
433 #define FADE_TYPE_NONE 0
434 #define FADE_TYPE_FADE_IN (1 << 0)
435 #define FADE_TYPE_FADE_OUT (1 << 1)
436 #define FADE_TYPE_TRANSFORM (1 << 2)
437 #define FADE_TYPE_CROSSFADE (1 << 3)
438 #define FADE_TYPE_MELT (1 << 4)
439 #define FADE_TYPE_CURTAIN (1 << 5)
440 #define FADE_TYPE_SKIP (1 << 6)
442 #define FADE_MODE_NONE (FADE_TYPE_NONE)
443 #define FADE_MODE_FADE_IN (FADE_TYPE_FADE_IN)
444 #define FADE_MODE_FADE_OUT (FADE_TYPE_FADE_OUT)
445 #define FADE_MODE_FADE (FADE_TYPE_FADE_IN | FADE_TYPE_FADE_OUT)
446 #define FADE_MODE_TRANSFORM (FADE_TYPE_TRANSFORM | FADE_TYPE_FADE_IN)
447 #define FADE_MODE_CROSSFADE (FADE_MODE_TRANSFORM | FADE_TYPE_CROSSFADE)
448 #define FADE_MODE_MELT (FADE_MODE_TRANSFORM | FADE_TYPE_MELT)
449 #define FADE_MODE_CURTAIN (FADE_MODE_TRANSFORM | FADE_TYPE_CURTAIN)
450 #define FADE_MODE_SKIP_FADE_IN (FADE_TYPE_SKIP | FADE_TYPE_FADE_IN)
451 #define FADE_MODE_SKIP_FADE_OUT (FADE_TYPE_SKIP | FADE_TYPE_FADE_OUT)
453 #define FADE_MODE_DEFAULT FADE_MODE_FADE
455 #define AUTO_DELAY_UNIT_MS 0
456 #define AUTO_DELAY_UNIT_FRAMES 1
458 #define AUTO_DELAY_UNIT_DEFAULT AUTO_DELAY_UNIT_MS
460 // values for toon positions
461 #define POS_UNDEFINED -1
472 // values for text alignment
473 #define ALIGN_LEFT (1 << 0)
474 #define ALIGN_RIGHT (1 << 1)
475 #define ALIGN_CENTER (1 << 2)
476 #define ALIGN_DEFAULT ALIGN_LEFT
478 #define VALIGN_TOP (1 << 0)
479 #define VALIGN_BOTTOM (1 << 1)
480 #define VALIGN_MIDDLE (1 << 2)
481 #define VALIGN_DEFAULT VALIGN_TOP
483 #define ALIGNED_XPOS(x,w,a) ((a) == ALIGN_CENTER ? (x) - (w) / 2 : \
484 (a) == ALIGN_RIGHT ? (x) - (w) : (x))
485 #define ALIGNED_YPOS(y,h,v) ((v) == VALIGN_MIDDLE ? (y) - (h) / 2 : \
486 (v) == VALIGN_BOTTOM ? (y) - (h) : (y))
487 #define ALIGNED_TEXT_XPOS(p) ALIGNED_XPOS((p)->x, (p)->width, (p)->align)
488 #define ALIGNED_TEXT_YPOS(p) ALIGNED_YPOS((p)->y, (p)->height, (p)->valign)
489 #define ALIGNED_VP_XPOS(p) ALIGNED_TEXT_XPOS(p)
490 #define ALIGNED_VP_YPOS(p) ALIGNED_TEXT_YPOS(p)
492 // values for redraw_mask
493 #define REDRAW_NONE (0)
494 #define REDRAW_ALL (1 << 0)
495 #define REDRAW_FIELD (1 << 1)
496 #define REDRAW_DOOR_1 (1 << 2)
497 #define REDRAW_DOOR_2 (1 << 3)
498 #define REDRAW_DOOR_3 (1 << 4)
499 #define REDRAW_FPS (1 << 5)
501 #define REDRAW_DOORS (REDRAW_DOOR_1 | \
505 #define IN_GFX_FIELD_PLAY(x, y) (x >= gfx.sx && x < gfx.sx + gfx.sxsize && \
506 y >= gfx.sy && y < gfx.sy + gfx.sysize)
507 #define IN_GFX_FIELD_FULL(x, y) (x >= gfx.real_sx && \
508 x < gfx.real_sx + gfx.full_sxsize && \
509 y >= gfx.real_sy && \
510 y < gfx.real_sy + gfx.full_sysize)
511 #define IN_GFX_DOOR_1(x, y) (x >= gfx.dx && x < gfx.dx + gfx.dxsize && \
512 y >= gfx.dy && y < gfx.dy + gfx.dysize)
513 #define IN_GFX_DOOR_2(x, y) (x >= gfx.vx && x < gfx.vx + gfx.vxsize && \
514 y >= gfx.vy && y < gfx.vy + gfx.vysize)
515 #define IN_GFX_DOOR_3(x, y) (x >= gfx.ex && x < gfx.ex + gfx.exsize && \
516 y >= gfx.ey && y < gfx.ey + gfx.eysize)
518 // values for mouse cursor
519 #define CURSOR_UNDEFINED -1
520 #define CURSOR_DEFAULT 0
521 #define CURSOR_NONE 1
522 #define CURSOR_PLAYFIELD 2
524 // fundamental game speed values
525 #define ONE_SECOND_DELAY 1000 // delay value for one second
526 #define MENU_FRAME_DELAY 20 // frame delay in milliseconds
527 #define GAME_FRAME_DELAY 20 // frame delay in milliseconds
528 #define FFWD_FRAME_DELAY 10 // 200% speed for fast forward
529 #define MIN_VSYNC_FRAME_DELAY 15 // minimum value for vsync to keep
530 #define MAX_VSYNC_FRAME_DELAY 16 // maximum value for vsync to work
531 #define FRAMES_PER_SECOND (ONE_SECOND_DELAY / GAME_FRAME_DELAY)
532 #define FRAMES_PER_SECOND_SP 35
534 // maximum playfield size supported by libgame functions
535 #define MAX_PLAYFIELD_WIDTH 128
536 #define MAX_PLAYFIELD_HEIGHT 128
538 // maximum number of parallel players supported by libgame functions
539 #define MAX_PLAYERS 4
541 // maximum number of player names
542 #define MAX_PLAYER_NAMES 12
544 // maximum allowed length of player name
545 #define MAX_PLAYER_NAME_LEN 10
547 // maximum number of levels in a level set
548 #define MAX_LEVELS 1000
550 // maximum number of global animation and parts
551 #define MAX_GLOBAL_ANIMS 32
552 #define MAX_GLOBAL_ANIM_PARTS 32
554 // minimum/maximum/default x/y grid size for virtual buttons
555 #define MIN_GRID_XSIZE 3
556 #define MIN_GRID_YSIZE 3
557 #define MAX_GRID_XSIZE 32
558 #define MAX_GRID_YSIZE 32
559 #define GRID_REAL_WIDTH MAX(1, MAX(video.screen_width, \
560 video.screen_height))
561 #define GRID_REAL_HEIGHT MAX(1, MIN(video.screen_width, \
562 video.screen_height))
563 #define DEFAULT_GRID_XSIZE_0 18
564 #define DEFAULT_GRID_YSIZE_0 MIN(MAX(MIN_GRID_YSIZE, \
565 DEFAULT_GRID_XSIZE_0 * \
569 #define DEFAULT_GRID_XSIZE_1 13
570 #define DEFAULT_GRID_YSIZE_1 MIN(MAX(MIN_GRID_YSIZE, \
571 DEFAULT_GRID_XSIZE_1 * \
576 #define DEFAULT_GRID_XSIZE(n) ((n) == 0 ? DEFAULT_GRID_XSIZE_0 : \
577 DEFAULT_GRID_XSIZE_1)
578 #define DEFAULT_GRID_YSIZE(n) ((n) == 0 ? DEFAULT_GRID_YSIZE_0 : \
579 DEFAULT_GRID_YSIZE_1)
581 #define GRID_ACTIVE_NR() (video.screen_width > \
582 video.screen_height ? 0 : 1)
584 // values for grid button characters for virtual buttons
585 #define CHAR_GRID_BUTTON_NONE ' '
586 #define CHAR_GRID_BUTTON_LEFT '<'
587 #define CHAR_GRID_BUTTON_RIGHT '>'
588 #define CHAR_GRID_BUTTON_UP '^'
589 #define CHAR_GRID_BUTTON_DOWN 'v'
590 #define CHAR_GRID_BUTTON_SNAP '1'
591 #define CHAR_GRID_BUTTON_DROP '2'
593 #define GET_ACTION_FROM_GRID_BUTTON(c) ((c) == CHAR_GRID_BUTTON_LEFT ? \
595 (c) == CHAR_GRID_BUTTON_RIGHT ? \
597 (c) == CHAR_GRID_BUTTON_UP ? \
599 (c) == CHAR_GRID_BUTTON_DOWN ? \
601 (c) == CHAR_GRID_BUTTON_SNAP ? \
603 (c) == CHAR_GRID_BUTTON_DROP ? \
607 // maximum number of level sets in the level set history
608 #define MAX_LEVELDIR_HISTORY 12
610 // default name for empty highscore entry
611 #define EMPTY_PLAYER_NAME "no name"
613 // default name for unknown player names
614 #define ANONYMOUS_NAME "anonymous"
616 // default for other unknown names
617 #define UNKNOWN_NAME "unknown"
619 // default name for new levels
620 #define NAMELESS_LEVEL_NAME "nameless level"
622 // default text for non-existant artwork
623 #define NOT_AVAILABLE "(not available)"
625 // default value for undefined filename
626 #define UNDEFINED_FILENAME "[NONE]"
628 // default value for undefined levelset
629 #define UNDEFINED_LEVELSET "[NONE]"
631 // default value for undefined password
632 #define UNDEFINED_PASSWORD "[undefined]"
634 // default value for undefined parameter
635 #define ARG_DEFAULT "[DEFAULT]"
637 // default values for undefined configuration file parameters
638 #define ARG_UNDEFINED "-1000000"
639 #define ARG_UNDEFINED_VALUE (-1000000)
641 // default value for off-screen positions
642 #define POS_OFFSCREEN (-1000000)
644 // definitions for game base path and sub-directories
646 #define BASE_PATH "."
650 #define GRAPHICS_DIRECTORY "graphics"
651 #define SOUNDS_DIRECTORY "sounds"
652 #define MUSIC_DIRECTORY "music"
653 #define LEVELS_DIRECTORY "levels"
654 #define TAPES_DIRECTORY "tapes"
655 #define SCORES_DIRECTORY "scores"
656 #define DOCS_DIRECTORY "docs"
657 #define CACHE_DIRECTORY "cache"
658 #define CONF_DIRECTORY "conf"
659 #define NETWORK_DIRECTORY "network"
660 #define USERS_DIRECTORY "users"
662 #define GFX_CLASSIC_SUBDIR "gfx_classic"
663 #define SND_CLASSIC_SUBDIR "snd_classic"
664 #define MUS_CLASSIC_SUBDIR "mus_classic"
666 #define GFX_DEFAULT_SUBDIR (setup.internal.default_graphics_set)
667 #define SND_DEFAULT_SUBDIR (setup.internal.default_sounds_set)
668 #define MUS_DEFAULT_SUBDIR (setup.internal.default_music_set)
670 #define GFX_FALLBACK_FILENAME (setup.internal.fallback_graphics_file)
671 #define SND_FALLBACK_FILENAME (setup.internal.fallback_sounds_file)
672 #define MUS_FALLBACK_FILENAME (setup.internal.fallback_music_file)
674 #define DEFAULT_LEVELSET (setup.internal.default_level_series)
676 // file names and filename extensions
677 #define LEVELSETUP_DIRECTORY "levelsetup"
678 #define SETUP_FILENAME "setup.conf"
679 #define USERSETUP_FILENAME "usersetup.conf"
680 #define AUTOSETUP_FILENAME "autosetup.conf"
681 #define LEVELSETUP_FILENAME "levelsetup.conf"
682 #define SERVERSETUP_FILENAME "serversetup.conf"
683 #define EDITORSETUP_FILENAME "editorsetup.conf"
684 #define EDITORCASCADE_FILENAME "editorcascade.conf"
685 #define HELPANIM_FILENAME "helpanim.conf"
686 #define HELPTEXT_FILENAME "helptext.conf"
687 #define LEVELINFO_FILENAME "levelinfo.conf"
688 #define GRAPHICSINFO_FILENAME "graphicsinfo.conf"
689 #define SOUNDSINFO_FILENAME "soundsinfo.conf"
690 #define MUSICINFO_FILENAME "musicinfo.conf"
691 #define ARTWORKINFO_CACHE_FILE "artworkinfo.cache"
692 #define LEVELTEMPLATE_FILENAME "template.level"
693 #define UPLOADED_FILENAME ".uploaded"
694 #define LEVELFILE_EXTENSION "level"
695 #define TAPEFILE_EXTENSION "tape"
696 #define SCOREFILE_EXTENSION "score"
698 #define GAMECONTROLLER_BASENAME "gamecontrollerdb.txt"
700 #define LOG_OUT_BASENAME "stdout.txt"
701 #define LOG_ERR_BASENAME "stderr.txt"
707 #define STRING_PARENT_DIRECTORY ".."
708 #define STRING_TOP_DIRECTORY "/"
710 #define CHAR_PATH_SEPARATOR_UNIX '/'
711 #define CHAR_PATH_SEPARATOR_DOS '\\'
713 #define STRING_PATH_SEPARATOR_UNIX "/"
714 #define STRING_PATH_SEPARATOR_DOS "\\"
716 #define STRING_NEWLINE_UNIX "\n"
717 #define STRING_NEWLINE_DOS "\r\n"
719 #if defined(PLATFORM_WIN32)
720 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_DOS
721 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_DOS
722 #define STRING_NEWLINE STRING_NEWLINE_DOS
724 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_UNIX
725 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_UNIX
726 #define STRING_NEWLINE STRING_NEWLINE_UNIX
730 // areas in bitmap PIX_DOOR
731 // meaning in PIX_DB_DOOR: (3 PAGEs)
732 // PAGEX1: 1. buffer for DOOR_1
733 // PAGEX2: 2. buffer for DOOR_1
734 // PAGEX3: buffer for animations
736 // these values are hard-coded to be able to use them in initialization
737 #define DOOR_GFX_PAGE_WIDTH 100 // should be set to "gfx.dxsize"
738 #define DOOR_GFX_PAGE_HEIGHT 280 // should be set to "gfx.dysize"
740 #define DOOR_GFX_PAGESIZE (DOOR_GFX_PAGE_WIDTH)
741 #define DOOR_GFX_PAGEX1 (0 * DOOR_GFX_PAGESIZE)
742 #define DOOR_GFX_PAGEX2 (1 * DOOR_GFX_PAGESIZE)
743 #define DOOR_GFX_PAGEX3 (2 * DOOR_GFX_PAGESIZE)
744 #define DOOR_GFX_PAGEX4 (3 * DOOR_GFX_PAGESIZE)
745 #define DOOR_GFX_PAGEX5 (4 * DOOR_GFX_PAGESIZE)
746 #define DOOR_GFX_PAGEX6 (5 * DOOR_GFX_PAGESIZE)
747 #define DOOR_GFX_PAGEX7 (6 * DOOR_GFX_PAGESIZE)
748 #define DOOR_GFX_PAGEX8 (7 * DOOR_GFX_PAGESIZE)
749 #define DOOR_GFX_PAGEY1 (0)
750 #define DOOR_GFX_PAGEY2 (DOOR_GFX_PAGE_HEIGHT)
753 // macros for version handling
754 #define VERSION_PART_1(x) ((x) / 1000000)
755 #define VERSION_PART_2(x) (((x) % 1000000) / 10000)
756 #define VERSION_PART_3(x) (((x) % 10000) / 100)
757 #define VERSION_PART_4(x) ((x) % 100)
759 #define VERSION_SUPER(x) VERSION_PART_1(x)
760 #define VERSION_MAJOR(x) VERSION_PART_2(x)
761 #define VERSION_MINOR(x) VERSION_PART_3(x)
762 #define VERSION_PATCH(x) VERSION_PART_4(x)
763 #define VERSION_IDENT(a,b,c,d) ((a) * 1000000 + (b) * 10000 + (c) * 100 + (d))
766 // macros for parent/child process identification
767 #if defined(PLATFORM_UNIX)
768 #define IS_PARENT_PROCESS() (audio.mixer_pid != getpid())
769 #define IS_CHILD_PROCESS() (audio.mixer_pid == getpid())
770 #define HAS_CHILD_PROCESS() (audio.mixer_pid > 0)
772 #define IS_PARENT_PROCESS() TRUE
773 #define IS_CHILD_PROCESS() FALSE
774 #define HAS_CHILD_PROCESS() FALSE
778 // values for artwork type
779 #define ARTWORK_TYPE_GRAPHICS 0
780 #define ARTWORK_TYPE_SOUNDS 1
781 #define ARTWORK_TYPE_MUSIC 2
783 #define NUM_ARTWORK_TYPES 3
786 // values for tree type (chosen to match artwork type)
787 #define TREE_TYPE_UNDEFINED -1
788 #define TREE_TYPE_GRAPHICS_DIR ARTWORK_TYPE_GRAPHICS
789 #define TREE_TYPE_SOUNDS_DIR ARTWORK_TYPE_SOUNDS
790 #define TREE_TYPE_MUSIC_DIR ARTWORK_TYPE_MUSIC
791 #define TREE_TYPE_LEVEL_DIR 3
792 #define TREE_TYPE_LEVEL_NR 4
793 #define TREE_TYPE_PLAYER_NAME 5
794 #define TREE_TYPE_SCORE_ENTRY 6
796 #define NUM_BASE_TREE_TYPES 4
797 #define NUM_TREE_TYPES 7
799 #define TREE_TYPE_IS_DIR(type) ((type) == TREE_TYPE_GRAPHICS_DIR || \
800 (type) == TREE_TYPE_SOUNDS_DIR || \
801 (type) == TREE_TYPE_MUSIC_DIR || \
802 (type) == TREE_TYPE_LEVEL_DIR)
804 #define INFOTEXT_UNDEFINED ""
805 #define INFOTEXT_GRAPHICS_DIR "Custom Graphics"
806 #define INFOTEXT_SOUNDS_DIR "Custom Sounds"
807 #define INFOTEXT_MUSIC_DIR "Custom Music"
808 #define INFOTEXT_LEVEL_DIR "Level Sets"
809 #define INFOTEXT_LEVEL_NR "Levels"
810 #define INFOTEXT_PLAYER_NAME "Players & Teams"
811 #define INFOTEXT_SCORE_ENTRY "Hall of Fame"
813 #define BACKLINK_TEXT_MAIN ".. (main menu)"
814 #define BACKLINK_TEXT_SETUP ".. (setup menu)"
815 #define BACKLINK_TEXT_PARENT ".. (parent directory)"
816 #define BACKLINK_TEXT_SCORES "back"
818 #define TREE_INFOTEXT(t) ((t) == TREE_TYPE_SCORE_ENTRY ? \
819 INFOTEXT_SCORE_ENTRY : \
820 (t) == TREE_TYPE_PLAYER_NAME ? \
821 INFOTEXT_PLAYER_NAME : \
822 (t) == TREE_TYPE_LEVEL_NR ? \
823 INFOTEXT_LEVEL_NR : \
824 (t) == TREE_TYPE_LEVEL_DIR ? \
825 INFOTEXT_LEVEL_DIR : \
826 (t) == TREE_TYPE_GRAPHICS_DIR ? \
827 INFOTEXT_GRAPHICS_DIR : \
828 (t) == TREE_TYPE_SOUNDS_DIR ? \
829 INFOTEXT_SOUNDS_DIR : \
830 (t) == TREE_TYPE_MUSIC_DIR ? \
831 INFOTEXT_MUSIC_DIR : \
834 #define TREE_BACKLINK_TEXT(t) ((t) == TREE_TYPE_SCORE_ENTRY ? \
835 BACKLINK_TEXT_SCORES : \
836 (t) == TREE_TYPE_LEVEL_DIR ? \
837 BACKLINK_TEXT_MAIN : \
840 #define TREE_USERDIR(t) ((t) == TREE_TYPE_LEVEL_DIR ? \
841 getUserLevelDir(NULL) : \
842 (t) == TREE_TYPE_GRAPHICS_DIR ? \
843 getUserGraphicsDir() : \
844 (t) == TREE_TYPE_SOUNDS_DIR ? \
845 getUserSoundsDir() : \
846 (t) == TREE_TYPE_MUSIC_DIR ? \
847 getUserMusicDir() : \
850 #define TREE_FIRST_NODE_PTR(t) ((t) == TREE_TYPE_LEVEL_DIR ? \
852 (t) == TREE_TYPE_GRAPHICS_DIR ? \
853 &artwork.gfx_first : \
854 (t) == TREE_TYPE_SOUNDS_DIR ? \
855 &artwork.snd_first : \
856 (t) == TREE_TYPE_MUSIC_DIR ? \
857 &artwork.mus_first : \
860 #define TREE_FIRST_NODE(t) ((t) == TREE_TYPE_LEVEL_DIR ? \
862 (t) == TREE_TYPE_GRAPHICS_DIR ? \
863 artwork.gfx_first : \
864 (t) == TREE_TYPE_SOUNDS_DIR ? \
865 artwork.snd_first : \
866 (t) == TREE_TYPE_MUSIC_DIR ? \
867 artwork.mus_first : \
870 // values for artwork handling
871 #define LEVELDIR_ARTWORK_SET_PTR(leveldir, type) \
872 ((type) == ARTWORK_TYPE_GRAPHICS ? \
873 &(leveldir)->graphics_set : \
874 (type) == ARTWORK_TYPE_SOUNDS ? \
875 &(leveldir)->sounds_set : \
876 &(leveldir)->music_set)
878 #define LEVELDIR_ARTWORK_SET(leveldir, type) \
879 ((type) == ARTWORK_TYPE_GRAPHICS ? \
880 (leveldir)->graphics_set : \
881 (type) == ARTWORK_TYPE_SOUNDS ? \
882 (leveldir)->sounds_set : \
883 (leveldir)->music_set)
885 #define LEVELDIR_ARTWORK_PATH_PTR(leveldir, type) \
886 ((type) == ARTWORK_TYPE_GRAPHICS ? \
887 &(leveldir)->graphics_path : \
888 (type) == ARTWORK_TYPE_SOUNDS ? \
889 &(leveldir)->sounds_path : \
890 &(leveldir)->music_path)
892 #define LEVELDIR_ARTWORK_PATH(leveldir, type) \
893 ((type) == ARTWORK_TYPE_GRAPHICS ? \
894 (leveldir)->graphics_path : \
895 (type) == ARTWORK_TYPE_SOUNDS ? \
896 (leveldir)->sounds_path : \
897 (leveldir)->music_path)
899 #define SETUP_ARTWORK_SET(setup, type) \
900 ((type) == ARTWORK_TYPE_GRAPHICS ? \
901 (setup).graphics_set : \
902 (type) == ARTWORK_TYPE_SOUNDS ? \
903 (setup).sounds_set : \
906 #define SETUP_OVERRIDE_ARTWORK(setup, type) \
907 ((type) == ARTWORK_TYPE_GRAPHICS ? \
908 (setup).override_level_graphics : \
909 (type) == ARTWORK_TYPE_SOUNDS ? \
910 (setup).override_level_sounds : \
911 (setup).override_level_music)
913 #define GFX_OVERRIDE_ARTWORK(type) \
914 ((type) == ARTWORK_TYPE_GRAPHICS ? \
915 gfx.override_level_graphics : \
916 (type) == ARTWORK_TYPE_SOUNDS ? \
917 gfx.override_level_sounds : \
918 gfx.override_level_music)
920 #define ARTWORK_FIRST_NODE(artwork, type) \
921 ((type) == ARTWORK_TYPE_GRAPHICS ? \
922 (artwork).gfx_first : \
923 (type) == ARTWORK_TYPE_SOUNDS ? \
924 (artwork).snd_first : \
927 #define ARTWORK_CURRENT_PTR(artwork, type) \
928 ((type) == ARTWORK_TYPE_GRAPHICS ? \
929 &(artwork).gfx_current : \
930 (type) == ARTWORK_TYPE_SOUNDS ? \
931 &(artwork).snd_current : \
932 &(artwork).mus_current)
934 #define ARTWORK_CURRENT(artwork, type) \
935 ((type) == ARTWORK_TYPE_GRAPHICS ? \
936 (artwork).gfx_current : \
937 (type) == ARTWORK_TYPE_SOUNDS ? \
938 (artwork).snd_current : \
939 (artwork).mus_current)
941 #define ARTWORK_CURRENT_IDENTIFIER_PTR(artwork, type) \
942 ((type) == ARTWORK_TYPE_GRAPHICS ? \
943 &(artwork).gfx_current_identifier : \
944 (type) == ARTWORK_TYPE_SOUNDS ? \
945 &(artwork).snd_current_identifier : \
946 &(artwork).mus_current_identifier)
948 #define ARTWORK_CURRENT_IDENTIFIER(artwork, type) \
949 ((type) == ARTWORK_TYPE_GRAPHICS ? \
950 (artwork).gfx_current_identifier : \
951 (type) == ARTWORK_TYPE_SOUNDS ? \
952 (artwork).snd_current_identifier : \
953 (artwork).mus_current_identifier)
955 #define ARTWORKINFO_FILENAME(type) \
956 ((type) == ARTWORK_TYPE_GRAPHICS ? \
957 GRAPHICSINFO_FILENAME : \
958 (type) == ARTWORK_TYPE_SOUNDS ? \
959 SOUNDSINFO_FILENAME : \
960 (type) == ARTWORK_TYPE_MUSIC ? \
961 MUSICINFO_FILENAME : "")
963 #define ARTWORK_DIRECTORY(type) \
964 ((type) == ARTWORK_TYPE_GRAPHICS ? \
965 GRAPHICS_DIRECTORY : \
966 (type) == ARTWORK_TYPE_SOUNDS ? \
968 (type) == ARTWORK_TYPE_MUSIC ? \
969 MUSIC_DIRECTORY : "")
971 #define OPTIONS_ARTWORK_DIRECTORY(type) \
972 ((type) == ARTWORK_TYPE_GRAPHICS ? \
973 options.graphics_directory : \
974 (type) == ARTWORK_TYPE_SOUNDS ? \
975 options.sounds_directory : \
976 (type) == ARTWORK_TYPE_MUSIC ? \
977 options.music_directory : "")
979 #define USER_ARTWORK_DIRECTORY(type) \
980 ((type) == ARTWORK_TYPE_GRAPHICS ? \
981 getUserGraphicsDir() : \
982 (type) == ARTWORK_TYPE_SOUNDS ? \
983 getUserSoundsDir() : \
984 (type) == ARTWORK_TYPE_MUSIC ? \
985 getUserMusicDir() : "")
987 #define ARTWORK_DEFAULT_SUBDIR(type) \
988 ((type) == ARTWORK_TYPE_GRAPHICS ? \
989 GFX_DEFAULT_SUBDIR : \
990 (type) == ARTWORK_TYPE_SOUNDS ? \
991 SND_DEFAULT_SUBDIR : \
994 #define UPDATE_BUSY_STATE() \
996 if (gfx.draw_busy_anim_function != NULL) \
997 gfx.draw_busy_anim_function(); \
1001 // structure definitions
1005 char *command_basepath; // path to the program binary
1006 char *command_basename; // base filename of the program binary
1008 char *config_filename; // optional global program config filename
1010 char *maindata_path; // main game data (installation) directory
1012 char *userdata_subdir; // personal user game data directory
1013 char *userdata_path; // resulting full path to game data directory
1015 char *program_title;
1019 char *icon_filename;
1021 char *cookie_prefix;
1023 char *log_filename[NUM_LOGS]; // log filenames for out/err messages
1024 FILE *log_file[NUM_LOGS]; // log file handles for out/err files
1025 FILE *log_file_default[NUM_LOGS]; // default log file handles (out/err)
1033 char *version_string;
1035 char *(*window_title_function)(void);
1036 void (*exit_message_function)(char *, va_list);
1037 void (*exit_function)(int);
1039 int api_thread_count;
1053 SDL_Thread *server_thread;
1054 boolean is_server_thread;
1059 boolean uses_touch_device;
1061 boolean use_api_server;
1069 char *base_directory;
1070 char *level_directory;
1071 char *graphics_directory;
1072 char *sounds_directory;
1073 char *music_directory;
1074 char *docs_directory;
1075 char *conf_directory;
1077 char *execute_command;
1078 char *tape_log_filename;
1080 char *special_flags;
1094 struct VideoSystemInfo
1097 int width, height, depth;
1098 int window_width, window_height;
1099 int display_width, display_height;
1100 int screen_width, screen_height;
1101 int screen_xoffset, screen_yoffset;
1103 boolean fullscreen_available;
1104 boolean fullscreen_enabled;
1105 boolean fullscreen_initial;
1107 boolean window_scaling_available;
1108 int window_scaling_percent;
1109 char *window_scaling_quality;
1110 int screen_rendering_mode;
1113 unsigned int frame_counter;
1114 unsigned int frame_delay;
1115 unsigned int frame_delay_value;
1119 int shifted_up_pos_last;
1120 unsigned int shifted_up_delay;
1121 unsigned int shifted_up_delay_value;
1123 boolean initialized;
1126 struct AudioSystemInfo
1128 boolean sound_available;
1129 boolean loops_available;
1130 boolean music_available;
1132 boolean sound_enabled;
1133 boolean sound_deactivated; // for temporarily disabling sound
1142 int first_sound_channel;
1145 struct FontBitmapInfo
1149 int src_x, src_y; // start position of font characters
1150 int width, height; // width / height of font characters
1152 int offset_x; // offset to next font character
1153 int offset_y; // offset to next font character
1155 int draw_xoffset; // offset for drawing font characters
1156 int draw_yoffset; // offset for drawing font characters
1159 int num_chars_per_line;
1166 int real_sx, real_sy;
1167 int full_sxsize, full_sysize;
1168 int scrollbuffer_width, scrollbuffer_height;
1170 int game_tile_size, standard_tile_size;
1181 int win_xsize, win_ysize;
1183 int draw_deactivation_mask;
1184 int draw_background_mask;
1186 Bitmap *field_save_buffer;
1188 Bitmap *background_bitmap;
1189 int background_bitmap_mask;
1191 Bitmap *fade_bitmap_backup;
1192 Bitmap *fade_bitmap_source;
1193 Bitmap *fade_bitmap_target;
1194 Bitmap *fade_bitmap_black;
1196 int fade_border_source_status;
1197 int fade_border_target_status;
1198 Bitmap *masked_border_bitmap_ptr;
1200 Bitmap *final_screen_bitmap;
1202 boolean clipping_enabled;
1204 int clip_width, clip_height;
1206 boolean override_level_graphics;
1207 boolean override_level_sounds;
1208 boolean override_level_music;
1210 boolean draw_init_text;
1213 struct FontBitmapInfo *font_bitmap_info;
1214 int (*select_font_function)(int);
1215 int (*get_font_from_token_function)(char *);
1217 int anim_random_frame;
1219 void (*draw_busy_anim_function)(void);
1220 void (*draw_global_anim_function)(int, int);
1221 void (*draw_global_border_function)(int);
1222 void (*draw_tile_cursor_function)(int);
1225 int cursor_mode_override;
1226 int cursor_mode_final;
1227 int mouse_x, mouse_y;
1230 struct TileCursorInfo
1232 boolean enabled; // tile cursor generally enabled or disabled
1233 boolean active; // tile cursor activated (depending on game)
1234 boolean moving; // tile cursor moving to target position
1236 int xpos, ypos; // tile cursor level playfield position
1237 int x, y; // tile cursor current screen position
1238 int target_x, target_y; // tile cursor target screen position
1240 int sx, sy; // tile cursor screen start position
1242 boolean xsn_debug; // enable or disable XSN debugging
1247 boolean enabled; // overlay generally enabled or disabled
1248 boolean active; // overlay activated (depending on game mode)
1255 char grid_button[MAX_GRID_XSIZE][MAX_GRID_YSIZE];
1256 char grid_button_highlight;
1258 int grid_button_action;
1264 int nr[MAX_PLAYERS]; // joystick number for each player
1267 struct SetupJoystickInfo
1269 char *device_name; // device name of player's joystick
1271 int xleft, xmiddle, xright;
1272 int yupper, ymiddle, ylower;
1276 struct SetupKeyboardInfo
1278 Key left, right, up, down;
1282 struct SetupTouchInfo
1291 char grid_button[2][MAX_GRID_XSIZE][MAX_GRID_YSIZE];
1293 int transparency; // in percent (0 == opaque, 100 == invisible)
1294 boolean draw_outlined;
1295 boolean draw_pressed;
1297 boolean grid_initialized;
1300 struct SetupInputInfo
1302 boolean use_joystick;
1303 struct SetupJoystickInfo joy;
1304 struct SetupKeyboardInfo key;
1307 struct SetupEditorInfo
1309 boolean el_boulderdash;
1310 boolean el_emerald_mine;
1311 boolean el_emerald_mine_club;
1314 boolean el_supaplex;
1315 boolean el_diamond_caves;
1316 boolean el_dx_boulderdash;
1318 boolean el_mirror_magic;
1319 boolean el_deflektor;
1322 boolean el_steel_chars;
1326 boolean el_user_defined;
1329 boolean el_headlines;
1334 boolean show_element_token;
1336 boolean show_read_only_warning;
1338 boolean use_template_for_new_levels;
1341 struct SetupAutoSetupInfo
1343 int editor_zoom_tilesize;
1346 struct SetupLevelSetupInfo
1348 char *last_level_series[MAX_LEVELDIR_HISTORY + 1];
1351 struct SetupEditorCascadeInfo
1364 boolean el_steel_chars;
1373 struct SetupShortcutInfo
1378 Key pause_before_end;
1381 Key focus_player[MAX_PLAYERS];
1382 Key focus_player_all;
1401 struct SetupSystemInfo
1403 char *sdl_renderdriver;
1404 char *sdl_videodriver;
1405 char *sdl_audiodriver;
1406 int audio_fragment_size;
1409 struct SetupInternalInfo
1411 char *program_title;
1412 char *program_version;
1413 char *program_author;
1414 char *program_email;
1415 char *program_website;
1416 char *program_copyright;
1417 char *program_company;
1419 char *program_icon_file;
1421 char *default_graphics_set;
1422 char *default_sounds_set;
1423 char *default_music_set;
1425 char *fallback_graphics_file;
1426 char *fallback_sounds_file;
1427 char *fallback_music_file;
1429 char *default_level_series;
1431 int default_window_width;
1432 int default_window_height;
1434 boolean choose_from_top_leveldir;
1435 boolean show_scaling_in_title;
1436 boolean create_user_levelset;
1439 boolean menu_engines;
1440 boolean menu_editor;
1441 boolean menu_graphics;
1443 boolean menu_artwork;
1446 boolean menu_shortcuts;
1448 boolean menu_save_and_exit;
1451 struct SetupDebugInfo
1453 int frame_delay[10];
1454 Key frame_delay_key[10];
1455 boolean frame_delay_use_mod_key;
1456 boolean frame_delay_game_only;
1457 boolean show_frames_per_second;
1468 boolean multiple_users;
1471 boolean sound_loops;
1472 boolean sound_music;
1473 boolean sound_simple;
1475 boolean scroll_delay;
1476 boolean forced_scroll_delay;
1477 int scroll_delay_value;
1478 char *engine_snapshot_mode;
1479 int engine_snapshot_memory;
1480 boolean fade_screens;
1482 boolean auto_pause_on_start;
1483 boolean show_titlescreen;
1484 boolean quick_doors;
1487 boolean skip_levels;
1488 boolean increment_levels;
1489 boolean auto_play_next_level;
1490 boolean count_score_after_game;
1491 boolean show_scores_after_game;
1494 int window_scaling_percent;
1495 char *window_scaling_quality;
1496 char *screen_rendering_mode;
1498 boolean ask_on_escape;
1499 boolean ask_on_escape_editor;
1500 boolean ask_on_game_over;
1501 boolean ask_on_quit_game;
1502 boolean ask_on_quit_program;
1503 boolean quick_switch;
1504 boolean input_on_focus;
1505 boolean prefer_aga_graphics;
1506 boolean prefer_lowpass_sounds;
1507 boolean prefer_extra_panel_items;
1508 boolean game_speed_extended;
1509 int game_frame_delay;
1510 boolean sp_show_border_elements;
1511 boolean small_game_graphics;
1512 boolean show_load_save_buttons;
1513 boolean show_undo_redo_buttons;
1514 char *scores_in_highscore_list;
1519 int override_level_graphics; // not boolean -- can also be "AUTO"
1520 int override_level_sounds; // not boolean -- can also be "AUTO"
1521 int override_level_music; // not boolean -- can also be "AUTO"
1527 boolean network_mode;
1528 int network_player_nr;
1529 char *network_server_hostname;
1531 boolean use_api_server;
1532 char *api_server_hostname;
1533 char *api_server_password;
1534 boolean ask_for_uploading_tapes;
1535 boolean ask_for_remaining_tapes;
1536 boolean provide_uploading_tapes;
1537 boolean ask_for_using_api_server;
1538 boolean has_remaining_tapes;
1540 struct SetupAutoSetupInfo auto_setup;
1541 struct SetupLevelSetupInfo level_setup;
1543 struct SetupEditorInfo editor;
1544 struct SetupEditorCascadeInfo editor_cascade;
1545 struct SetupShortcutInfo shortcut;
1546 struct SetupInputInfo input[MAX_PLAYERS];
1547 struct SetupTouchInfo touch;
1548 struct SetupSystemInfo system;
1549 struct SetupInternalInfo internal;
1550 struct SetupDebugInfo debug;
1552 struct OptionInfo options;
1562 struct TreeInfo **node_top; // topmost node in tree
1563 struct TreeInfo *node_parent; // parent level directory info
1564 struct TreeInfo *node_group; // level group sub-directory info
1565 struct TreeInfo *next; // next level series structure node
1567 int cl_first; // internal control field for setup screen
1568 int cl_cursor; // internal control field for setup screen
1570 int type; // type of tree content
1572 // fields for "type == TREE_TYPE_LEVEL_DIR"
1574 char *subdir; // tree info sub-directory basename (may be ".")
1575 char *fullpath; // complete path relative to tree base directory
1576 char *basepath; // absolute base path of tree base directory
1577 char *identifier; // identifier string for configuration files
1578 char *name; // tree info name, as displayed in selection menues
1579 char *name_sorting; // optional sorting name for correct name sorting
1580 char *author; // level or artwork author name
1581 char *year; // optional year of creation for levels or artwork
1583 char *program_title; // optional alternative text for program title
1584 char *program_copyright; // optional alternative text for program copyright
1585 char *program_company; // optional alternative text for program company
1587 char *imported_from; // optional comment for imported levels or artwork
1588 char *imported_by; // optional comment for imported levels or artwork
1589 char *tested_by; // optional comment to name people who tested a set
1591 char *graphics_set_ecs; // special EMC custom graphics set (ECS graphics)
1592 char *graphics_set_aga; // special EMC custom graphics set (AGA graphics)
1593 char *graphics_set; // optional custom graphics set (level tree only)
1594 char *sounds_set_default; // default EMC custom sounds set
1595 char *sounds_set_lowpass; // special EMC custom sounds set (lowpass filter)
1596 char *sounds_set; // optional custom sounds set (level tree only)
1597 char *music_set; // optional custom music set (level tree only)
1598 char *graphics_path; // path to optional custom graphics set (level only)
1599 char *sounds_path; // path to optional custom sounds set (level only)
1600 char *music_path; // path to optional custom music set (level only)
1602 char *level_filename; // filename of level file (for packed level file)
1603 char *level_filetype; // type of levels in level directory or level file
1605 char *special_flags; // flags for special actions performed on level file
1607 int levels; // number of levels in level series
1608 int first_level; // first level number (to allow start with 0 or 1)
1609 int last_level; // last level number (automatically calculated)
1610 int sort_priority; // sort levels by 'sort_priority' and then by name
1611 int pos; // custom position information of node in tree
1613 boolean latest_engine;// force level set to use the latest game engine
1615 boolean level_group; // directory contains more level series directories
1616 boolean parent_link; // entry links back to parent directory
1617 boolean is_copy; // this entry is a copy of another entry in the tree
1618 boolean in_user_dir; // user defined levels are stored in home directory
1619 boolean user_defined; // levels in user directory and marked as "private"
1620 boolean readonly; // readonly levels can not be changed with editor
1621 boolean handicap; // level set has no handicap when set to "false"
1622 boolean skip_levels; // levels can be skipped when set to "true"
1624 boolean use_emc_tiles;// use (swapped) V5/V6 EMC tiles when set to "true"
1626 int color; // color to use on selection screen for this level
1627 char *class_desc; // description of level series class
1628 int handicap_level; // number of the lowest unsolved level
1630 char *infotext; // optional text to describe the tree type (headline)
1633 typedef struct TreeInfo TreeInfo;
1634 typedef struct TreeInfo LevelDirTree;
1635 typedef struct TreeInfo ArtworkDirTree;
1636 typedef struct TreeInfo GraphicsDirTree;
1637 typedef struct TreeInfo SoundsDirTree;
1638 typedef struct TreeInfo MusicDirTree;
1642 GraphicsDirTree *gfx_first;
1643 GraphicsDirTree *gfx_current;
1644 SoundsDirTree *snd_first;
1645 SoundsDirTree *snd_current;
1646 MusicDirTree *mus_first;
1647 MusicDirTree *mus_current;
1649 char *gfx_current_identifier;
1650 char *snd_current_identifier;
1651 char *mus_current_identifier;
1654 struct ValueTextInfo
1660 struct StringValueTextInfo
1672 struct ConfigTypeInfo
1679 struct TokenIntPtrInfo
1689 char *default_filename;
1692 char **default_parameter; // array of file parameters
1693 char **parameter; // array of file parameters
1696 boolean fallback_to_default;
1697 boolean default_is_cloned;
1700 struct SetupFileList
1705 struct SetupFileList *next;
1710 char *source_filename; // primary key for node list
1714 struct PropertyMapping
1724 struct ArtworkListInfo
1726 int type; // type of artwork
1728 int num_file_list_entries;
1729 int num_dynamic_file_list_entries;
1730 struct FileInfo *file_list; // static artwork file array
1731 struct FileInfo *dynamic_file_list; // dynamic artwrk file array
1733 int num_suffix_list_entries;
1734 struct ConfigTypeInfo *suffix_list; // parameter suffixes array
1736 int num_base_prefixes;
1737 int num_ext1_suffixes;
1738 int num_ext2_suffixes;
1739 int num_ext3_suffixes;
1740 char **base_prefixes; // base token prefixes array
1741 char **ext1_suffixes; // property suffixes array 1
1742 char **ext2_suffixes; // property suffixes array 2
1743 char **ext3_suffixes; // property suffixes array 3
1745 int num_ignore_tokens;
1746 char **ignore_tokens; // file tokens to be ignored
1748 int num_property_mapping_entries;
1749 struct PropertyMapping *property_mapping; // mapping token -> artwork
1751 int sizeof_artwork_list_entry;
1753 struct ListNodeInfo **artwork_list; // static artwork node array
1754 struct ListNodeInfo **dynamic_artwork_list; // dynamic artwrk node array
1755 struct ListNode *content_list; // dynamic artwork node list
1757 void *(*load_artwork)(char *); // constructor function
1758 void (*free_artwork)(void *); // destructor function
1778 struct RectWithBorder
1782 int min_width, min_height;
1783 int max_width, max_height;
1804 struct DoorPartPosInfo
1811 int start_step_opening;
1812 int start_step_closing;
1813 boolean draw_masked;
1820 int xoffset; // special case for tape date and time
1821 int xoffset2; // special case for tape date
1822 int yoffset; // special case for list of preview players
1825 int size; // also used for suffix ".digits"
1827 boolean draw_masked;
1828 boolean draw_player; // special case for network player buttons
1829 int sort_priority; // also used for suffix ".draw_order"
1832 int direction; // needed for panel time/health graphics
1833 int class; // needed for panel time/health graphics
1834 int style; // needed for panel time/health graphics
1836 int tile_size; // special case for list of network players
1837 int border_size; // special case for list of preview players
1838 int vertical; // special case for list of preview players
1840 boolean redefined; // redefined by custom artwork
1843 struct MouseActionInfo
1852 int music[MAX_LEVELS];
1865 // ============================================================================
1866 // exported variables
1867 // ============================================================================
1869 extern struct ProgramInfo program;
1870 extern struct NetworkInfo network;
1871 extern struct RuntimeInfo runtime;
1872 extern struct OptionInfo options;
1873 extern struct VideoSystemInfo video;
1874 extern struct AudioSystemInfo audio;
1875 extern struct GfxInfo gfx;
1876 extern struct TileCursorInfo tile_cursor;
1877 extern struct OverlayInfo overlay;
1878 extern struct AnimInfo anim;
1879 extern struct ArtworkInfo artwork;
1880 extern struct JoystickInfo joystick;
1881 extern struct SetupInfo setup;
1882 extern struct UserInfo user;
1884 extern LevelDirTree *leveldir_first_all;
1885 extern LevelDirTree *leveldir_first;
1886 extern LevelDirTree *leveldir_current;
1887 extern int level_nr;
1889 extern struct LevelSetInfo levelset;
1890 extern struct LevelStats level_stats[];
1892 extern DrawWindow *window;
1893 extern DrawBuffer *backbuffer;
1894 extern DrawBuffer *drawto;
1896 extern int button_status;
1897 extern boolean motion_status;
1898 extern int wheel_steps;
1899 extern boolean keyrepeat_status;
1900 extern boolean textinput_status;
1902 extern int redraw_mask;
1904 extern int FrameCounter;
1907 // function definitions
1909 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
1911 void InitNetworkInfo(boolean, boolean, boolean, char *, int);
1912 void InitRuntimeInfo(void);
1914 void SetWindowTitle(void);
1916 void InitWindowTitleFunction(char *(*window_title_function)(void));
1917 void InitExitMessageFunction(void (*exit_message_function)(char *, va_list));
1918 void InitExitFunction(void (*exit_function)(int));
1919 void InitPlatformDependentStuff(void);
1920 void ClosePlatformDependentStuff(void);
1922 void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
1923 void InitGfxTileSizeInfo(int, int);
1924 void InitGfxDoor1Info(int, int, int, int);
1925 void InitGfxDoor2Info(int, int, int, int);
1926 void InitGfxDoor3Info(int, int, int, int);
1927 void InitGfxWindowInfo(int, int);
1928 void InitGfxScrollbufferInfo(int, int);
1929 void InitGfxClipRegion(boolean, int, int, int, int);
1930 void InitGfxDrawBusyAnimFunction(void (*draw_busy_anim_function)(void));
1931 void InitGfxDrawGlobalAnimFunction(void (*draw_global_anim_function)(int, int));
1932 void InitGfxDrawGlobalBorderFunction(void (*draw_global_border_function)(int));
1933 void InitGfxDrawTileCursorFunction(void (*draw_tile_cursor_function)(int));
1934 void InitGfxCustomArtworkInfo(void);
1935 void InitGfxOtherSettings(void);
1936 void InitTileCursorInfo(void);
1937 void InitOverlayInfo(void);
1938 void SetOverlayGridSizeAndButtons(void);
1939 void SetTileCursorEnabled(boolean);
1940 void SetTileCursorActive(boolean);
1941 void SetTileCursorTargetXY(int, int);
1942 void SetTileCursorXY(int, int);
1943 void SetTileCursorSXSY(int, int);
1944 void SetOverlayEnabled(boolean);
1945 void SetOverlayActive(boolean);
1946 void SetOverlayShowGrid(boolean);
1947 boolean GetOverlayEnabled(void);
1948 boolean GetOverlayActive(void);
1949 void SetDrawDeactivationMask(int);
1950 int GetDrawDeactivationMask(void);
1951 void SetDrawBackgroundMask(int);
1952 void SetWindowBackgroundBitmap(Bitmap *);
1953 void SetMainBackgroundBitmap(Bitmap *);
1954 void SetDoorBackgroundBitmap(Bitmap *);
1955 void SetRedrawMaskFromArea(int, int, int, int);
1957 void LimitScreenUpdates(boolean);
1959 void InitVideoDefaults(void);
1960 void InitVideoDisplay(void);
1961 void CloseVideoDisplay(void);
1962 void InitVideoBuffer(int, int, int, boolean);
1963 Bitmap *CreateBitmapStruct(void);
1964 Bitmap *CreateBitmap(int, int, int);
1965 void ReCreateBitmap(Bitmap **, int, int);
1966 void FreeBitmap(Bitmap *);
1967 void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
1968 void BlitBitmapTiled(Bitmap *, Bitmap *, int, int, int, int, int, int, int,int);
1969 void FadeRectangle(int, int, int, int, int, int, int,
1970 void (*draw_border_function)(void));
1971 void FillRectangle(Bitmap *, int, int, int, int, Pixel);
1972 void ClearRectangle(Bitmap *, int, int, int, int);
1973 void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
1974 void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
1975 boolean DrawingDeactivatedField(void);
1976 boolean DrawingDeactivated(int, int, int, int);
1977 boolean DrawingOnBackground(int, int);
1978 boolean DrawingAreaChanged(void);
1979 void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int, int);
1980 void BlitTexture(Bitmap *, int, int, int, int, int, int);
1981 void BlitTextureMasked(Bitmap *, int, int, int, int, int, int);
1982 void BlitToScreen(Bitmap *, int, int, int, int, int, int);
1983 void BlitToScreenMasked(Bitmap *, int, int, int, int, int, int);
1984 void DrawSimpleBlackLine(Bitmap *, int, int, int, int);
1985 void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
1986 void DrawLines(Bitmap *, struct XY *, int, Pixel);
1987 Pixel GetPixel(Bitmap *, int, int);
1988 Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
1989 Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
1991 void KeyboardAutoRepeatOn(void);
1992 void KeyboardAutoRepeatOff(void);
1993 boolean SetVideoMode(boolean);
1994 void SetVideoFrameDelay(unsigned int);
1995 unsigned int GetVideoFrameDelay(void);
1996 boolean ChangeVideoModeIfNeeded(boolean);
1998 Bitmap *LoadImage(char *);
1999 Bitmap *LoadCustomImage(char *);
2000 void ReloadCustomImage(Bitmap *, char *);
2002 Bitmap *ZoomBitmap(Bitmap *, int, int);
2003 void ReCreateGameTileSizeBitmap(Bitmap **);
2004 void CreateBitmapWithSmallBitmaps(Bitmap **, int, int);
2005 void CreateBitmapTextures(Bitmap **);
2006 void FreeBitmapTextures(Bitmap **);
2007 void ScaleBitmap(Bitmap **, int);
2009 void SetMouseCursor(int);
2010 void UpdateRawMousePosition(int, int);
2011 void UpdateMousePosition(void);
2013 void OpenAudio(void);
2014 void CloseAudio(void);
2015 void SetAudioMode(boolean);
2017 void InitEventFilter(EventFilter);
2018 boolean PendingEvent(void);
2019 void WaitEvent(Event *event);
2020 void PeekEvent(Event *event);
2021 void PumpEvents(void);
2022 void CheckQuitEvent(void);
2023 Key GetEventKey(KeyEvent *, boolean);
2024 KeyMod HandleKeyModState(Key, int);
2025 KeyMod GetKeyModState(void);
2026 KeyMod GetKeyModStateFromEvents(void);
2027 void StartTextInput(int, int, int, int);
2028 void StopTextInput(void);
2029 void PushUserEvent(int, int, int);
2030 boolean PendingEscapeKeyEvent(void);
2032 void InitJoysticks(void);
2033 boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
2034 boolean CheckJoystickOpened(int);
2035 void ClearJoystickState(void);
2037 void InitEmscriptenFilesystem(void);
2038 void SyncEmscriptenFilesystem(void);