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 and event handling
359 // values used for crumbled graphics
360 #define STYLE_ACCURATE_BORDERS (1 << 0)
361 #define STYLE_INNER_CORNERS (1 << 1)
363 // values used for game panel graphics
364 #define STYLE_REVERSE (1 << 2)
365 #define STYLE_LEFTMOST_POSITION (1 << 3)
367 // values used for global animations
368 #define STYLE_BLOCK (1 << 4)
369 #define STYLE_PASSTHROUGH (1 << 5)
370 #define STYLE_MULTIPLE_ACTIONS (1 << 6)
372 #define STYLE_DEFAULT STYLE_NONE
374 // values for special global animation delay types
375 #define ANIM_DELAY_UNDEFINED -1
376 #define ANIM_DELAY_NONE 0
377 #define ANIM_DELAY_INIT 1
378 #define ANIM_DELAY_ANIM 2
379 #define ANIM_DELAY_POST 3
381 // values for special global animation delay actions
382 #define ANIM_DELAY_ACTION_NONE -1
384 // values for special global animation events
385 #define ANIM_EVENT_UNDEFINED -1
386 #define ANIM_EVENT_NONE 0
387 #define ANIM_EVENT_SELF (1 << 16)
388 #define ANIM_EVENT_ANY (1 << 17)
389 #define ANIM_EVENT_CLICK (1 << 18)
390 #define ANIM_EVENT_INIT (1 << 19)
391 #define ANIM_EVENT_START (1 << 20)
392 #define ANIM_EVENT_END (1 << 21)
393 #define ANIM_EVENT_POST (1 << 22)
394 #define ANIM_EVENT_UNCLICK_ANY (1 << 23)
396 // anim number: bits 0-7
397 // part number: bits 8-15
398 #define ANIM_EVENT_ANIM_BIT 0
399 #define ANIM_EVENT_PART_BIT 8
401 #define ANIM_EVENT_ANIM_MASK (0xff << ANIM_EVENT_ANIM_BIT)
402 #define ANIM_EVENT_PART_MASK (0xff << ANIM_EVENT_PART_BIT)
404 #define ANIM_EVENT_DEFAULT ANIM_EVENT_NONE
406 // values for special global animation event actions
407 #define ANIM_EVENT_ACTION_NONE -1
409 // values for fade mode
410 #define FADE_TYPE_NONE 0
411 #define FADE_TYPE_FADE_IN (1 << 0)
412 #define FADE_TYPE_FADE_OUT (1 << 1)
413 #define FADE_TYPE_TRANSFORM (1 << 2)
414 #define FADE_TYPE_CROSSFADE (1 << 3)
415 #define FADE_TYPE_MELT (1 << 4)
416 #define FADE_TYPE_CURTAIN (1 << 5)
417 #define FADE_TYPE_SKIP (1 << 6)
419 #define FADE_MODE_NONE (FADE_TYPE_NONE)
420 #define FADE_MODE_FADE_IN (FADE_TYPE_FADE_IN)
421 #define FADE_MODE_FADE_OUT (FADE_TYPE_FADE_OUT)
422 #define FADE_MODE_FADE (FADE_TYPE_FADE_IN | FADE_TYPE_FADE_OUT)
423 #define FADE_MODE_TRANSFORM (FADE_TYPE_TRANSFORM | FADE_TYPE_FADE_IN)
424 #define FADE_MODE_CROSSFADE (FADE_MODE_TRANSFORM | FADE_TYPE_CROSSFADE)
425 #define FADE_MODE_MELT (FADE_MODE_TRANSFORM | FADE_TYPE_MELT)
426 #define FADE_MODE_CURTAIN (FADE_MODE_TRANSFORM | FADE_TYPE_CURTAIN)
427 #define FADE_MODE_SKIP_FADE_IN (FADE_TYPE_SKIP | FADE_TYPE_FADE_IN)
428 #define FADE_MODE_SKIP_FADE_OUT (FADE_TYPE_SKIP | FADE_TYPE_FADE_OUT)
430 #define FADE_MODE_DEFAULT FADE_MODE_FADE
432 #define AUTO_DELAY_UNIT_MS 0
433 #define AUTO_DELAY_UNIT_FRAMES 1
435 #define AUTO_DELAY_UNIT_DEFAULT AUTO_DELAY_UNIT_MS
437 // values for toon positions
438 #define POS_UNDEFINED -1
449 // values for text alignment
450 #define ALIGN_LEFT (1 << 0)
451 #define ALIGN_RIGHT (1 << 1)
452 #define ALIGN_CENTER (1 << 2)
453 #define ALIGN_DEFAULT ALIGN_LEFT
455 #define VALIGN_TOP (1 << 0)
456 #define VALIGN_BOTTOM (1 << 1)
457 #define VALIGN_MIDDLE (1 << 2)
458 #define VALIGN_DEFAULT VALIGN_TOP
460 #define ALIGNED_XPOS(x,w,a) ((a) == ALIGN_CENTER ? (x) - (w) / 2 : \
461 (a) == ALIGN_RIGHT ? (x) - (w) : (x))
462 #define ALIGNED_YPOS(y,h,v) ((v) == VALIGN_MIDDLE ? (y) - (h) / 2 : \
463 (v) == VALIGN_BOTTOM ? (y) - (h) : (y))
464 #define ALIGNED_TEXT_XPOS(p) ALIGNED_XPOS((p)->x, (p)->width, (p)->align)
465 #define ALIGNED_TEXT_YPOS(p) ALIGNED_YPOS((p)->y, (p)->height, (p)->valign)
466 #define ALIGNED_VP_XPOS(p) ALIGNED_TEXT_XPOS(p)
467 #define ALIGNED_VP_YPOS(p) ALIGNED_TEXT_YPOS(p)
469 // values for redraw_mask
470 #define REDRAW_NONE (0)
471 #define REDRAW_ALL (1 << 0)
472 #define REDRAW_FIELD (1 << 1)
473 #define REDRAW_DOOR_1 (1 << 2)
474 #define REDRAW_DOOR_2 (1 << 3)
475 #define REDRAW_DOOR_3 (1 << 4)
476 #define REDRAW_FPS (1 << 5)
478 #define REDRAW_DOORS (REDRAW_DOOR_1 | \
482 #define IN_GFX_FIELD_PLAY(x, y) (x >= gfx.sx && x < gfx.sx + gfx.sxsize && \
483 y >= gfx.sy && y < gfx.sy + gfx.sysize)
484 #define IN_GFX_FIELD_FULL(x, y) (x >= gfx.real_sx && \
485 x < gfx.real_sx + gfx.full_sxsize && \
486 y >= gfx.real_sy && \
487 y < gfx.real_sy + gfx.full_sysize)
488 #define IN_GFX_DOOR_1(x, y) (x >= gfx.dx && x < gfx.dx + gfx.dxsize && \
489 y >= gfx.dy && y < gfx.dy + gfx.dysize)
490 #define IN_GFX_DOOR_2(x, y) (x >= gfx.vx && x < gfx.vx + gfx.vxsize && \
491 y >= gfx.vy && y < gfx.vy + gfx.vysize)
492 #define IN_GFX_DOOR_3(x, y) (x >= gfx.ex && x < gfx.ex + gfx.exsize && \
493 y >= gfx.ey && y < gfx.ey + gfx.eysize)
495 // values for mouse cursor
496 #define CURSOR_UNDEFINED -1
497 #define CURSOR_DEFAULT 0
498 #define CURSOR_NONE 1
499 #define CURSOR_PLAYFIELD 2
501 // fundamental game speed values
502 #define ONE_SECOND_DELAY 1000 // delay value for one second
503 #define MENU_FRAME_DELAY 20 // frame delay in milliseconds
504 #define GAME_FRAME_DELAY 20 // frame delay in milliseconds
505 #define FFWD_FRAME_DELAY 10 // 200% speed for fast forward
506 #define MIN_VSYNC_FRAME_DELAY 15 // minimum value for vsync to keep
507 #define MAX_VSYNC_FRAME_DELAY 16 // maximum value for vsync to work
508 #define FRAMES_PER_SECOND (ONE_SECOND_DELAY / GAME_FRAME_DELAY)
509 #define FRAMES_PER_SECOND_SP 35
511 // maximum playfield size supported by libgame functions
512 #define MAX_PLAYFIELD_WIDTH 128
513 #define MAX_PLAYFIELD_HEIGHT 128
515 // maximum number of parallel players supported by libgame functions
516 #define MAX_PLAYERS 4
518 // maximum number of player names
519 #define MAX_PLAYER_NAMES 12
521 // maximum allowed length of player name
522 #define MAX_PLAYER_NAME_LEN 10
524 // maximum number of levels in a level set
525 #define MAX_LEVELS 1000
527 // maximum number of global animation and parts
528 #define MAX_GLOBAL_ANIMS 32
529 #define MAX_GLOBAL_ANIM_PARTS 32
531 // minimum/maximum/default x/y grid size for virtual buttons
532 #define MIN_GRID_XSIZE 3
533 #define MIN_GRID_YSIZE 3
534 #define MAX_GRID_XSIZE 32
535 #define MAX_GRID_YSIZE 32
536 #define GRID_REAL_WIDTH MAX(1, MAX(video.screen_width, \
537 video.screen_height))
538 #define GRID_REAL_HEIGHT MAX(1, MIN(video.screen_width, \
539 video.screen_height))
540 #define DEFAULT_GRID_XSIZE_0 18
541 #define DEFAULT_GRID_YSIZE_0 MIN(MAX(MIN_GRID_YSIZE, \
542 DEFAULT_GRID_XSIZE_0 * \
546 #define DEFAULT_GRID_XSIZE_1 13
547 #define DEFAULT_GRID_YSIZE_1 MIN(MAX(MIN_GRID_YSIZE, \
548 DEFAULT_GRID_XSIZE_1 * \
553 #define DEFAULT_GRID_XSIZE(n) ((n) == 0 ? DEFAULT_GRID_XSIZE_0 : \
554 DEFAULT_GRID_XSIZE_1)
555 #define DEFAULT_GRID_YSIZE(n) ((n) == 0 ? DEFAULT_GRID_YSIZE_0 : \
556 DEFAULT_GRID_YSIZE_1)
558 #define GRID_ACTIVE_NR() (video.screen_width > \
559 video.screen_height ? 0 : 1)
561 // values for grid button characters for virtual buttons
562 #define CHAR_GRID_BUTTON_NONE ' '
563 #define CHAR_GRID_BUTTON_LEFT '<'
564 #define CHAR_GRID_BUTTON_RIGHT '>'
565 #define CHAR_GRID_BUTTON_UP '^'
566 #define CHAR_GRID_BUTTON_DOWN 'v'
567 #define CHAR_GRID_BUTTON_SNAP '1'
568 #define CHAR_GRID_BUTTON_DROP '2'
570 #define GET_ACTION_FROM_GRID_BUTTON(c) ((c) == CHAR_GRID_BUTTON_LEFT ? \
572 (c) == CHAR_GRID_BUTTON_RIGHT ? \
574 (c) == CHAR_GRID_BUTTON_UP ? \
576 (c) == CHAR_GRID_BUTTON_DOWN ? \
578 (c) == CHAR_GRID_BUTTON_SNAP ? \
580 (c) == CHAR_GRID_BUTTON_DROP ? \
584 // default name for empty highscore entry
585 #define EMPTY_PLAYER_NAME "no name"
587 // default name for unknown player names
588 #define ANONYMOUS_NAME "anonymous"
590 // default for other unknown names
591 #define UNKNOWN_NAME "unknown"
593 // default name for new levels
594 #define NAMELESS_LEVEL_NAME "nameless level"
596 // default text for non-existant artwork
597 #define NOT_AVAILABLE "(not available)"
599 // default value for undefined filename
600 #define UNDEFINED_FILENAME "[NONE]"
602 // default value for undefined levelset
603 #define UNDEFINED_LEVELSET "[NONE]"
605 // default value for undefined parameter
606 #define ARG_DEFAULT "[DEFAULT]"
608 // default values for undefined configuration file parameters
609 #define ARG_UNDEFINED "-1000000"
610 #define ARG_UNDEFINED_VALUE (-1000000)
612 // default value for off-screen positions
613 #define POS_OFFSCREEN (-1000000)
615 // definitions for game sub-directories
617 #define RO_GAME_DIR "."
621 #define RW_GAME_DIR "."
624 #define RO_BASE_PATH RO_GAME_DIR
625 #define RW_BASE_PATH RW_GAME_DIR
628 #define GRAPHICS_DIRECTORY "graphics"
629 #define SOUNDS_DIRECTORY "sounds"
630 #define MUSIC_DIRECTORY "music"
631 #define LEVELS_DIRECTORY "levels"
632 #define TAPES_DIRECTORY "tapes"
633 #define SCORES_DIRECTORY "scores"
634 #define DOCS_DIRECTORY "docs"
635 #define CACHE_DIRECTORY "cache"
636 #define CONF_DIRECTORY "conf"
637 #define NETWORK_DIRECTORY "network"
638 #define USERS_DIRECTORY "users"
640 #define GFX_CLASSIC_SUBDIR "gfx_classic"
641 #define SND_CLASSIC_SUBDIR "snd_classic"
642 #define MUS_CLASSIC_SUBDIR "mus_classic"
644 #define GFX_DEFAULT_SUBDIR (setup.internal.default_graphics_set)
645 #define SND_DEFAULT_SUBDIR (setup.internal.default_sounds_set)
646 #define MUS_DEFAULT_SUBDIR (setup.internal.default_music_set)
648 #define GFX_FALLBACK_FILENAME (setup.internal.fallback_graphics_file)
649 #define SND_FALLBACK_FILENAME (setup.internal.fallback_sounds_file)
650 #define MUS_FALLBACK_FILENAME (setup.internal.fallback_music_file)
652 #define DEFAULT_LEVELSET (setup.internal.default_level_series)
654 // file names and filename extensions
655 #define LEVELSETUP_DIRECTORY "levelsetup"
656 #define SETUP_FILENAME "setup.conf"
657 #define USERSETUP_FILENAME "usersetup.conf"
658 #define AUTOSETUP_FILENAME "autosetup.conf"
659 #define LEVELSETUP_FILENAME "levelsetup.conf"
660 #define EDITORSETUP_FILENAME "editorsetup.conf"
661 #define EDITORCASCADE_FILENAME "editorcascade.conf"
662 #define HELPANIM_FILENAME "helpanim.conf"
663 #define HELPTEXT_FILENAME "helptext.conf"
664 #define LEVELINFO_FILENAME "levelinfo.conf"
665 #define GRAPHICSINFO_FILENAME "graphicsinfo.conf"
666 #define SOUNDSINFO_FILENAME "soundsinfo.conf"
667 #define MUSICINFO_FILENAME "musicinfo.conf"
668 #define ARTWORKINFO_CACHE_FILE "artworkinfo.cache"
669 #define LEVELTEMPLATE_FILENAME "template.level"
670 #define LEVELFILE_EXTENSION "level"
671 #define TAPEFILE_EXTENSION "tape"
672 #define SCOREFILE_EXTENSION "score"
674 #define GAMECONTROLLER_BASENAME "gamecontrollerdb.txt"
676 #define LOG_OUT_BASENAME "stdout.txt"
677 #define LOG_ERR_BASENAME "stderr.txt"
683 #define STRING_PARENT_DIRECTORY ".."
684 #define STRING_TOP_DIRECTORY "/"
686 #define CHAR_PATH_SEPARATOR_UNIX '/'
687 #define CHAR_PATH_SEPARATOR_DOS '\\'
689 #define STRING_PATH_SEPARATOR_UNIX "/"
690 #define STRING_PATH_SEPARATOR_DOS "\\"
692 #define STRING_NEWLINE_UNIX "\n"
693 #define STRING_NEWLINE_DOS "\r\n"
695 #if defined(PLATFORM_WIN32)
696 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_DOS
697 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_DOS
698 #define STRING_NEWLINE STRING_NEWLINE_DOS
700 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_UNIX
701 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_UNIX
702 #define STRING_NEWLINE STRING_NEWLINE_UNIX
706 // areas in bitmap PIX_DOOR
707 // meaning in PIX_DB_DOOR: (3 PAGEs)
708 // PAGEX1: 1. buffer for DOOR_1
709 // PAGEX2: 2. buffer for DOOR_1
710 // PAGEX3: buffer for animations
712 // these values are hard-coded to be able to use them in initialization
713 #define DOOR_GFX_PAGE_WIDTH 100 // should be set to "gfx.dxsize"
714 #define DOOR_GFX_PAGE_HEIGHT 280 // should be set to "gfx.dysize"
716 #define DOOR_GFX_PAGESIZE (DOOR_GFX_PAGE_WIDTH)
717 #define DOOR_GFX_PAGEX1 (0 * DOOR_GFX_PAGESIZE)
718 #define DOOR_GFX_PAGEX2 (1 * DOOR_GFX_PAGESIZE)
719 #define DOOR_GFX_PAGEX3 (2 * DOOR_GFX_PAGESIZE)
720 #define DOOR_GFX_PAGEX4 (3 * DOOR_GFX_PAGESIZE)
721 #define DOOR_GFX_PAGEX5 (4 * DOOR_GFX_PAGESIZE)
722 #define DOOR_GFX_PAGEX6 (5 * DOOR_GFX_PAGESIZE)
723 #define DOOR_GFX_PAGEX7 (6 * DOOR_GFX_PAGESIZE)
724 #define DOOR_GFX_PAGEX8 (7 * DOOR_GFX_PAGESIZE)
725 #define DOOR_GFX_PAGEY1 (0)
726 #define DOOR_GFX_PAGEY2 (DOOR_GFX_PAGE_HEIGHT)
729 // macros for version handling
730 #define VERSION_PART_1(x) ((x) / 1000000)
731 #define VERSION_PART_2(x) (((x) % 1000000) / 10000)
732 #define VERSION_PART_3(x) (((x) % 10000) / 100)
733 #define VERSION_PART_4(x) ((x) % 100)
735 #define VERSION_SUPER(x) VERSION_PART_1(x)
736 #define VERSION_MAJOR(x) VERSION_PART_2(x)
737 #define VERSION_MINOR(x) VERSION_PART_3(x)
738 #define VERSION_PATCH(x) VERSION_PART_4(x)
739 #define VERSION_IDENT(a,b,c,d) ((a) * 1000000 + (b) * 10000 + (c) * 100 + (d))
742 // macros for parent/child process identification
743 #if defined(PLATFORM_UNIX)
744 #define IS_PARENT_PROCESS() (audio.mixer_pid != getpid())
745 #define IS_CHILD_PROCESS() (audio.mixer_pid == getpid())
746 #define HAS_CHILD_PROCESS() (audio.mixer_pid > 0)
748 #define IS_PARENT_PROCESS() TRUE
749 #define IS_CHILD_PROCESS() FALSE
750 #define HAS_CHILD_PROCESS() FALSE
754 // values for artwork type
755 #define ARTWORK_TYPE_GRAPHICS 0
756 #define ARTWORK_TYPE_SOUNDS 1
757 #define ARTWORK_TYPE_MUSIC 2
759 #define NUM_ARTWORK_TYPES 3
762 // values for tree type (chosen to match artwork type)
763 #define TREE_TYPE_UNDEFINED -1
764 #define TREE_TYPE_GRAPHICS_DIR ARTWORK_TYPE_GRAPHICS
765 #define TREE_TYPE_SOUNDS_DIR ARTWORK_TYPE_SOUNDS
766 #define TREE_TYPE_MUSIC_DIR ARTWORK_TYPE_MUSIC
767 #define TREE_TYPE_LEVEL_DIR 3
768 #define TREE_TYPE_LEVEL_NR 4
769 #define TREE_TYPE_PLAYER_NAME 5
771 #define NUM_BASE_TREE_TYPES 4
772 #define NUM_TREE_TYPES 6
774 #define INFOTEXT_UNDEFINED ""
775 #define INFOTEXT_GRAPHICS_DIR "Custom Graphics"
776 #define INFOTEXT_SOUNDS_DIR "Custom Sounds"
777 #define INFOTEXT_MUSIC_DIR "Custom Music"
778 #define INFOTEXT_LEVEL_DIR "Level Sets"
779 #define INFOTEXT_LEVEL_NR "Levels"
780 #define INFOTEXT_PLAYER_NAME "Players & Teams"
782 #define TREE_INFOTEXT(t) ((t) == TREE_TYPE_PLAYER_NAME ? \
783 INFOTEXT_PLAYER_NAME : \
784 (t) == TREE_TYPE_LEVEL_NR ? \
785 INFOTEXT_LEVEL_NR : \
786 (t) == TREE_TYPE_LEVEL_DIR ? \
787 INFOTEXT_LEVEL_DIR : \
788 (t) == TREE_TYPE_GRAPHICS_DIR ? \
789 INFOTEXT_GRAPHICS_DIR : \
790 (t) == TREE_TYPE_SOUNDS_DIR ? \
791 INFOTEXT_SOUNDS_DIR : \
792 (t) == TREE_TYPE_MUSIC_DIR ? \
793 INFOTEXT_MUSIC_DIR : \
796 #define TREE_USERDIR(t) ((t) == TREE_TYPE_LEVEL_DIR ? \
797 getUserLevelDir(NULL) : \
798 (t) == TREE_TYPE_GRAPHICS_DIR ? \
799 getUserGraphicsDir() : \
800 (t) == TREE_TYPE_SOUNDS_DIR ? \
801 getUserSoundsDir() : \
802 (t) == TREE_TYPE_MUSIC_DIR ? \
803 getUserMusicDir() : \
806 #define TREE_FIRST_NODE_PTR(t) ((t) == TREE_TYPE_LEVEL_DIR ? \
808 (t) == TREE_TYPE_GRAPHICS_DIR ? \
809 &artwork.gfx_first : \
810 (t) == TREE_TYPE_SOUNDS_DIR ? \
811 &artwork.snd_first : \
812 (t) == TREE_TYPE_MUSIC_DIR ? \
813 &artwork.mus_first : \
816 #define TREE_FIRST_NODE(t) ((t) == TREE_TYPE_LEVEL_DIR ? \
818 (t) == TREE_TYPE_GRAPHICS_DIR ? \
819 artwork.gfx_first : \
820 (t) == TREE_TYPE_SOUNDS_DIR ? \
821 artwork.snd_first : \
822 (t) == TREE_TYPE_MUSIC_DIR ? \
823 artwork.mus_first : \
826 // values for artwork handling
827 #define LEVELDIR_ARTWORK_SET_PTR(leveldir, type) \
828 ((type) == ARTWORK_TYPE_GRAPHICS ? \
829 &(leveldir)->graphics_set : \
830 (type) == ARTWORK_TYPE_SOUNDS ? \
831 &(leveldir)->sounds_set : \
832 &(leveldir)->music_set)
834 #define LEVELDIR_ARTWORK_SET(leveldir, type) \
835 ((type) == ARTWORK_TYPE_GRAPHICS ? \
836 (leveldir)->graphics_set : \
837 (type) == ARTWORK_TYPE_SOUNDS ? \
838 (leveldir)->sounds_set : \
839 (leveldir)->music_set)
841 #define LEVELDIR_ARTWORK_PATH_PTR(leveldir, type) \
842 ((type) == ARTWORK_TYPE_GRAPHICS ? \
843 &(leveldir)->graphics_path : \
844 (type) == ARTWORK_TYPE_SOUNDS ? \
845 &(leveldir)->sounds_path : \
846 &(leveldir)->music_path)
848 #define LEVELDIR_ARTWORK_PATH(leveldir, type) \
849 ((type) == ARTWORK_TYPE_GRAPHICS ? \
850 (leveldir)->graphics_path : \
851 (type) == ARTWORK_TYPE_SOUNDS ? \
852 (leveldir)->sounds_path : \
853 (leveldir)->music_path)
855 #define SETUP_ARTWORK_SET(setup, type) \
856 ((type) == ARTWORK_TYPE_GRAPHICS ? \
857 (setup).graphics_set : \
858 (type) == ARTWORK_TYPE_SOUNDS ? \
859 (setup).sounds_set : \
862 #define SETUP_OVERRIDE_ARTWORK(setup, type) \
863 ((type) == ARTWORK_TYPE_GRAPHICS ? \
864 (setup).override_level_graphics : \
865 (type) == ARTWORK_TYPE_SOUNDS ? \
866 (setup).override_level_sounds : \
867 (setup).override_level_music)
869 #define GFX_OVERRIDE_ARTWORK(type) \
870 ((type) == ARTWORK_TYPE_GRAPHICS ? \
871 gfx.override_level_graphics : \
872 (type) == ARTWORK_TYPE_SOUNDS ? \
873 gfx.override_level_sounds : \
874 gfx.override_level_music)
876 #define ARTWORK_FIRST_NODE(artwork, type) \
877 ((type) == ARTWORK_TYPE_GRAPHICS ? \
878 (artwork).gfx_first : \
879 (type) == ARTWORK_TYPE_SOUNDS ? \
880 (artwork).snd_first : \
883 #define ARTWORK_CURRENT_PTR(artwork, type) \
884 ((type) == ARTWORK_TYPE_GRAPHICS ? \
885 &(artwork).gfx_current : \
886 (type) == ARTWORK_TYPE_SOUNDS ? \
887 &(artwork).snd_current : \
888 &(artwork).mus_current)
890 #define ARTWORK_CURRENT(artwork, type) \
891 ((type) == ARTWORK_TYPE_GRAPHICS ? \
892 (artwork).gfx_current : \
893 (type) == ARTWORK_TYPE_SOUNDS ? \
894 (artwork).snd_current : \
895 (artwork).mus_current)
897 #define ARTWORK_CURRENT_IDENTIFIER_PTR(artwork, type) \
898 ((type) == ARTWORK_TYPE_GRAPHICS ? \
899 &(artwork).gfx_current_identifier : \
900 (type) == ARTWORK_TYPE_SOUNDS ? \
901 &(artwork).snd_current_identifier : \
902 &(artwork).mus_current_identifier)
904 #define ARTWORK_CURRENT_IDENTIFIER(artwork, type) \
905 ((type) == ARTWORK_TYPE_GRAPHICS ? \
906 (artwork).gfx_current_identifier : \
907 (type) == ARTWORK_TYPE_SOUNDS ? \
908 (artwork).snd_current_identifier : \
909 (artwork).mus_current_identifier)
911 #define ARTWORKINFO_FILENAME(type) \
912 ((type) == ARTWORK_TYPE_GRAPHICS ? \
913 GRAPHICSINFO_FILENAME : \
914 (type) == ARTWORK_TYPE_SOUNDS ? \
915 SOUNDSINFO_FILENAME : \
916 (type) == ARTWORK_TYPE_MUSIC ? \
917 MUSICINFO_FILENAME : "")
919 #define ARTWORK_DIRECTORY(type) \
920 ((type) == ARTWORK_TYPE_GRAPHICS ? \
921 GRAPHICS_DIRECTORY : \
922 (type) == ARTWORK_TYPE_SOUNDS ? \
924 (type) == ARTWORK_TYPE_MUSIC ? \
925 MUSIC_DIRECTORY : "")
927 #define OPTIONS_ARTWORK_DIRECTORY(type) \
928 ((type) == ARTWORK_TYPE_GRAPHICS ? \
929 options.graphics_directory : \
930 (type) == ARTWORK_TYPE_SOUNDS ? \
931 options.sounds_directory : \
932 (type) == ARTWORK_TYPE_MUSIC ? \
933 options.music_directory : "")
935 #define USER_ARTWORK_DIRECTORY(type) \
936 ((type) == ARTWORK_TYPE_GRAPHICS ? \
937 getUserGraphicsDir() : \
938 (type) == ARTWORK_TYPE_SOUNDS ? \
939 getUserSoundsDir() : \
940 (type) == ARTWORK_TYPE_MUSIC ? \
941 getUserMusicDir() : "")
943 #define ARTWORK_DEFAULT_SUBDIR(type) \
944 ((type) == ARTWORK_TYPE_GRAPHICS ? \
945 GFX_DEFAULT_SUBDIR : \
946 (type) == ARTWORK_TYPE_SOUNDS ? \
947 SND_DEFAULT_SUBDIR : \
950 #define UPDATE_BUSY_STATE() \
952 if (gfx.draw_busy_anim_function != NULL) \
953 gfx.draw_busy_anim_function(); \
957 // structure definitions
961 char *command_basepath; // path to the program binary
962 char *command_basename; // base filename of the program binary
964 char *config_filename; // optional global program config filename
966 char *maindata_path; // main game data (installation) directory
968 char *userdata_subdir; // personal user game data directory
969 char *userdata_path; // resulting full path to game data directory
979 char *log_filename[NUM_LOGS]; // log filenames for out/err messages
980 FILE *log_file[NUM_LOGS]; // log file handles for out/err files
981 FILE *log_file_default[NUM_LOGS]; // default log file handles (out/err)
989 char *version_string;
991 char *(*window_title_function)(void);
992 void (*exit_message_function)(char *, va_list);
993 void (*exit_function)(int);
995 boolean global_scores;
996 boolean many_scores_per_name;
1010 SDL_Thread *server_thread;
1011 boolean is_server_thread;
1016 boolean uses_touch_device;
1024 char *ro_base_directory;
1025 char *rw_base_directory;
1026 char *level_directory;
1027 char *graphics_directory;
1028 char *sounds_directory;
1029 char *music_directory;
1030 char *docs_directory;
1031 char *conf_directory;
1033 char *execute_command;
1035 char *special_flags;
1045 struct VideoSystemInfo
1048 int width, height, depth;
1049 int window_width, window_height;
1050 int display_width, display_height;
1051 int screen_width, screen_height;
1052 int screen_xoffset, screen_yoffset;
1054 boolean fullscreen_available;
1055 boolean fullscreen_enabled;
1056 boolean fullscreen_initial;
1058 boolean window_scaling_available;
1059 int window_scaling_percent;
1060 char *window_scaling_quality;
1061 int screen_rendering_mode;
1064 unsigned int frame_counter;
1065 unsigned int frame_delay;
1066 unsigned int frame_delay_value;
1070 int shifted_up_pos_last;
1071 unsigned int shifted_up_delay;
1072 unsigned int shifted_up_delay_value;
1074 boolean initialized;
1077 struct AudioSystemInfo
1079 boolean sound_available;
1080 boolean loops_available;
1081 boolean music_available;
1083 boolean sound_enabled;
1084 boolean sound_deactivated; // for temporarily disabling sound
1093 int first_sound_channel;
1096 struct FontBitmapInfo
1100 int src_x, src_y; // start position of font characters
1101 int width, height; // width / height of font characters
1103 int offset_x; // offset to next font character
1104 int offset_y; // offset to next font character
1106 int draw_xoffset; // offset for drawing font characters
1107 int draw_yoffset; // offset for drawing font characters
1110 int num_chars_per_line;
1117 int real_sx, real_sy;
1118 int full_sxsize, full_sysize;
1119 int scrollbuffer_width, scrollbuffer_height;
1121 int game_tile_size, standard_tile_size;
1132 int win_xsize, win_ysize;
1134 int draw_deactivation_mask;
1135 int draw_background_mask;
1137 Bitmap *field_save_buffer;
1139 Bitmap *background_bitmap;
1140 int background_bitmap_mask;
1142 Bitmap *fade_bitmap_backup;
1143 Bitmap *fade_bitmap_source;
1144 Bitmap *fade_bitmap_target;
1145 Bitmap *fade_bitmap_black;
1147 int fade_border_source_status;
1148 int fade_border_target_status;
1149 Bitmap *masked_border_bitmap_ptr;
1151 Bitmap *final_screen_bitmap;
1153 boolean clipping_enabled;
1155 int clip_width, clip_height;
1157 boolean override_level_graphics;
1158 boolean override_level_sounds;
1159 boolean override_level_music;
1161 boolean draw_init_text;
1164 struct FontBitmapInfo *font_bitmap_info;
1165 int (*select_font_function)(int);
1166 int (*get_font_from_token_function)(char *);
1168 int anim_random_frame;
1170 void (*draw_busy_anim_function)(void);
1171 void (*draw_global_anim_function)(int, int);
1172 void (*draw_global_border_function)(int);
1173 void (*draw_tile_cursor_function)(int);
1176 int cursor_mode_override;
1177 int cursor_mode_final;
1178 int mouse_x, mouse_y;
1181 struct TileCursorInfo
1183 boolean enabled; // tile cursor generally enabled or disabled
1184 boolean active; // tile cursor activated (depending on game)
1185 boolean moving; // tile cursor moving to target position
1187 int xpos, ypos; // tile cursor level playfield position
1188 int x, y; // tile cursor current screen position
1189 int target_x, target_y; // tile cursor target screen position
1191 int sx, sy; // tile cursor screen start position
1193 boolean xsn_debug; // enable or disable XSN debugging
1198 boolean enabled; // overlay generally enabled or disabled
1199 boolean active; // overlay activated (depending on game mode)
1206 char grid_button[MAX_GRID_XSIZE][MAX_GRID_YSIZE];
1207 char grid_button_highlight;
1209 int grid_button_action;
1215 int nr[MAX_PLAYERS]; // joystick number for each player
1218 struct SetupJoystickInfo
1220 char *device_name; // device name of player's joystick
1222 int xleft, xmiddle, xright;
1223 int yupper, ymiddle, ylower;
1227 struct SetupKeyboardInfo
1229 Key left, right, up, down;
1233 struct SetupTouchInfo
1242 char grid_button[2][MAX_GRID_XSIZE][MAX_GRID_YSIZE];
1244 int transparency; // in percent (0 == opaque, 100 == invisible)
1245 boolean draw_outlined;
1246 boolean draw_pressed;
1248 boolean grid_initialized;
1251 struct SetupInputInfo
1253 boolean use_joystick;
1254 struct SetupJoystickInfo joy;
1255 struct SetupKeyboardInfo key;
1258 struct SetupEditorInfo
1260 boolean el_boulderdash;
1261 boolean el_emerald_mine;
1262 boolean el_emerald_mine_club;
1265 boolean el_supaplex;
1266 boolean el_diamond_caves;
1267 boolean el_dx_boulderdash;
1269 boolean el_mirror_magic;
1270 boolean el_deflektor;
1273 boolean el_steel_chars;
1277 boolean el_user_defined;
1280 boolean el_headlines;
1285 boolean show_element_token;
1287 boolean show_read_only_warning;
1289 boolean use_template_for_new_levels;
1292 struct SetupAutoSetupInfo
1294 int editor_zoom_tilesize;
1297 struct SetupEditorCascadeInfo
1310 boolean el_steel_chars;
1318 struct SetupShortcutInfo
1324 Key focus_player[MAX_PLAYERS];
1325 Key focus_player_all;
1344 struct SetupSystemInfo
1346 char *sdl_renderdriver;
1347 char *sdl_videodriver;
1348 char *sdl_audiodriver;
1349 int audio_fragment_size;
1352 struct SetupInternalInfo
1354 char *program_title;
1355 char *program_version;
1356 char *program_author;
1357 char *program_email;
1358 char *program_website;
1359 char *program_copyright;
1360 char *program_company;
1362 char *program_icon_file;
1364 char *default_graphics_set;
1365 char *default_sounds_set;
1366 char *default_music_set;
1368 char *fallback_graphics_file;
1369 char *fallback_sounds_file;
1370 char *fallback_music_file;
1372 char *default_level_series;
1374 int default_window_width;
1375 int default_window_height;
1377 boolean choose_from_top_leveldir;
1378 boolean show_scaling_in_title;
1379 boolean create_user_levelset;
1382 boolean menu_engines;
1383 boolean menu_editor;
1384 boolean menu_graphics;
1386 boolean menu_artwork;
1389 boolean menu_shortcuts;
1391 boolean menu_save_and_exit;
1394 struct SetupDebugInfo
1396 int frame_delay[10];
1397 Key frame_delay_key[10];
1398 boolean frame_delay_use_mod_key;
1399 boolean frame_delay_game_only;
1400 boolean show_frames_per_second;
1409 boolean multiple_users;
1412 boolean sound_loops;
1413 boolean sound_music;
1414 boolean sound_simple;
1416 boolean scroll_delay;
1417 boolean forced_scroll_delay;
1418 int scroll_delay_value;
1419 char *engine_snapshot_mode;
1420 int engine_snapshot_memory;
1421 boolean fade_screens;
1423 boolean show_titlescreen;
1424 boolean quick_doors;
1427 boolean skip_levels;
1428 boolean increment_levels;
1429 boolean auto_play_next_level;
1430 boolean skip_scores_after_game;
1433 int window_scaling_percent;
1434 char *window_scaling_quality;
1435 char *screen_rendering_mode;
1437 boolean ask_on_escape;
1438 boolean ask_on_escape_editor;
1439 boolean ask_on_game_over;
1440 boolean quick_switch;
1441 boolean input_on_focus;
1442 boolean prefer_aga_graphics;
1443 boolean prefer_lowpass_sounds;
1444 boolean prefer_extra_panel_items;
1445 boolean game_speed_extended;
1446 int game_frame_delay;
1447 boolean sp_show_border_elements;
1448 boolean small_game_graphics;
1449 boolean show_snapshot_buttons;
1454 int override_level_graphics; // not boolean -- can also be "AUTO"
1455 int override_level_sounds; // not boolean -- can also be "AUTO"
1456 int override_level_music; // not boolean -- can also be "AUTO"
1462 boolean network_mode;
1463 int network_player_nr;
1464 char *network_server_hostname;
1466 struct SetupAutoSetupInfo auto_setup;
1467 struct SetupEditorInfo editor;
1468 struct SetupEditorCascadeInfo editor_cascade;
1469 struct SetupShortcutInfo shortcut;
1470 struct SetupInputInfo input[MAX_PLAYERS];
1471 struct SetupTouchInfo touch;
1472 struct SetupSystemInfo system;
1473 struct SetupInternalInfo internal;
1474 struct SetupDebugInfo debug;
1476 struct OptionInfo options;
1486 struct TreeInfo **node_top; // topmost node in tree
1487 struct TreeInfo *node_parent; // parent level directory info
1488 struct TreeInfo *node_group; // level group sub-directory info
1489 struct TreeInfo *next; // next level series structure node
1491 int cl_first; // internal control field for setup screen
1492 int cl_cursor; // internal control field for setup screen
1494 int type; // type of tree content
1496 // fields for "type == TREE_TYPE_LEVEL_DIR"
1498 char *subdir; // tree info sub-directory basename (may be ".")
1499 char *fullpath; // complete path relative to tree base directory
1500 char *basepath; // absolute base path of tree base directory
1501 char *identifier; // identifier string for configuration files
1502 char *name; // tree info name, as displayed in selection menues
1503 char *name_sorting; // optional sorting name for correct name sorting
1504 char *author; // level or artwork author name
1505 char *year; // optional year of creation for levels or artwork
1507 char *program_title; // optional alternative text for program title
1508 char *program_copyright; // optional alternative text for program copyright
1509 char *program_company; // optional alternative text for program company
1511 char *imported_from; // optional comment for imported levels or artwork
1512 char *imported_by; // optional comment for imported levels or artwork
1513 char *tested_by; // optional comment to name people who tested a set
1515 char *graphics_set_ecs; // special EMC custom graphics set (ECS graphics)
1516 char *graphics_set_aga; // special EMC custom graphics set (AGA graphics)
1517 char *graphics_set; // optional custom graphics set (level tree only)
1518 char *sounds_set_default; // default EMC custom sounds set
1519 char *sounds_set_lowpass; // special EMC custom sounds set (lowpass filter)
1520 char *sounds_set; // optional custom sounds set (level tree only)
1521 char *music_set; // optional custom music set (level tree only)
1522 char *graphics_path; // path to optional custom graphics set (level only)
1523 char *sounds_path; // path to optional custom sounds set (level only)
1524 char *music_path; // path to optional custom music set (level only)
1526 char *level_filename; // filename of level file (for packed level file)
1527 char *level_filetype; // type of levels in level directory or level file
1529 char *special_flags; // flags for special actions performed on level file
1531 int levels; // number of levels in level series
1532 int first_level; // first level number (to allow start with 0 or 1)
1533 int last_level; // last level number (automatically calculated)
1534 int sort_priority; // sort levels by 'sort_priority' and then by name
1536 boolean latest_engine;// force level set to use the latest game engine
1538 boolean level_group; // directory contains more level series directories
1539 boolean parent_link; // entry links back to parent directory
1540 boolean in_user_dir; // user defined levels are stored in home directory
1541 boolean user_defined; // levels in user directory and marked as "private"
1542 boolean readonly; // readonly levels can not be changed with editor
1543 boolean handicap; // level set has no handicap when set to "false"
1544 boolean skip_levels; // levels can be skipped when set to "true"
1546 boolean use_emc_tiles;// use (swapped) V5/V6 EMC tiles when set to "true"
1548 int color; // color to use on selection screen for this level
1549 char *class_desc; // description of level series class
1550 int handicap_level; // number of the lowest unsolved level
1552 char *infotext; // optional text to describe the tree type (headline)
1555 typedef struct TreeInfo TreeInfo;
1556 typedef struct TreeInfo LevelDirTree;
1557 typedef struct TreeInfo ArtworkDirTree;
1558 typedef struct TreeInfo GraphicsDirTree;
1559 typedef struct TreeInfo SoundsDirTree;
1560 typedef struct TreeInfo MusicDirTree;
1564 GraphicsDirTree *gfx_first;
1565 GraphicsDirTree *gfx_current;
1566 SoundsDirTree *snd_first;
1567 SoundsDirTree *snd_current;
1568 MusicDirTree *mus_first;
1569 MusicDirTree *mus_current;
1571 char *gfx_current_identifier;
1572 char *snd_current_identifier;
1573 char *mus_current_identifier;
1576 struct ValueTextInfo
1582 struct StringValueTextInfo
1594 struct ConfigTypeInfo
1601 struct TokenIntPtrInfo
1611 char *default_filename;
1614 char **default_parameter; // array of file parameters
1615 char **parameter; // array of file parameters
1618 boolean fallback_to_default;
1619 boolean default_is_cloned;
1622 struct SetupFileList
1627 struct SetupFileList *next;
1632 char *source_filename; // primary key for node list
1636 struct PropertyMapping
1646 struct ArtworkListInfo
1648 int type; // type of artwork
1650 int num_file_list_entries;
1651 int num_dynamic_file_list_entries;
1652 struct FileInfo *file_list; // static artwork file array
1653 struct FileInfo *dynamic_file_list; // dynamic artwrk file array
1655 int num_suffix_list_entries;
1656 struct ConfigTypeInfo *suffix_list; // parameter suffixes array
1658 int num_base_prefixes;
1659 int num_ext1_suffixes;
1660 int num_ext2_suffixes;
1661 int num_ext3_suffixes;
1662 char **base_prefixes; // base token prefixes array
1663 char **ext1_suffixes; // property suffixes array 1
1664 char **ext2_suffixes; // property suffixes array 2
1665 char **ext3_suffixes; // property suffixes array 3
1667 int num_ignore_tokens;
1668 char **ignore_tokens; // file tokens to be ignored
1670 int num_property_mapping_entries;
1671 struct PropertyMapping *property_mapping; // mapping token -> artwork
1673 int sizeof_artwork_list_entry;
1675 struct ListNodeInfo **artwork_list; // static artwork node array
1676 struct ListNodeInfo **dynamic_artwork_list; // dynamic artwrk node array
1677 struct ListNode *content_list; // dynamic artwork node list
1679 void *(*load_artwork)(char *); // constructor function
1680 void (*free_artwork)(void *); // destructor function
1700 struct RectWithBorder
1704 int min_width, min_height;
1705 int max_width, max_height;
1726 struct DoorPartPosInfo
1733 int start_step_opening;
1734 int start_step_closing;
1735 boolean draw_masked;
1742 int xoffset; // special case for tape date and time
1743 int xoffset2; // special case for tape date
1744 int yoffset; // special case for list of preview players
1747 int size; // also used for suffix ".digits"
1749 boolean draw_masked;
1750 boolean draw_player; // special case for network player buttons
1751 int sort_priority; // also used for suffix ".draw_order"
1754 int direction; // needed for panel time/health graphics
1755 int class; // needed for panel time/health graphics
1756 int style; // needed for panel time/health graphics
1758 int tile_size; // special case for list of network players
1759 int border_size; // special case for list of preview players
1760 int vertical; // special case for list of preview players
1762 boolean redefined; // redefined by custom artwork
1765 struct MouseActionInfo
1774 int music[MAX_LEVELS];
1787 // ============================================================================
1788 // exported variables
1789 // ============================================================================
1791 extern struct ProgramInfo program;
1792 extern struct NetworkInfo network;
1793 extern struct RuntimeInfo runtime;
1794 extern struct OptionInfo options;
1795 extern struct VideoSystemInfo video;
1796 extern struct AudioSystemInfo audio;
1797 extern struct GfxInfo gfx;
1798 extern struct TileCursorInfo tile_cursor;
1799 extern struct OverlayInfo overlay;
1800 extern struct AnimInfo anim;
1801 extern struct ArtworkInfo artwork;
1802 extern struct JoystickInfo joystick;
1803 extern struct SetupInfo setup;
1804 extern struct UserInfo user;
1806 extern LevelDirTree *leveldir_first_all;
1807 extern LevelDirTree *leveldir_first;
1808 extern LevelDirTree *leveldir_current;
1809 extern int level_nr;
1811 extern struct LevelSetInfo levelset;
1812 extern struct LevelStats level_stats[];
1814 extern DrawWindow *window;
1815 extern DrawBuffer *backbuffer;
1816 extern DrawBuffer *drawto;
1818 extern int button_status;
1819 extern boolean motion_status;
1820 extern int wheel_steps;
1821 extern boolean keyrepeat_status;
1822 extern boolean textinput_status;
1824 extern int redraw_mask;
1826 extern int FrameCounter;
1829 // function definitions
1831 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
1833 void InitNetworkInfo(boolean, boolean, boolean, char *, int);
1834 void InitRuntimeInfo(void);
1836 void InitScoresInfo(void);
1837 void SetWindowTitle(void);
1839 void InitWindowTitleFunction(char *(*window_title_function)(void));
1840 void InitExitMessageFunction(void (*exit_message_function)(char *, va_list));
1841 void InitExitFunction(void (*exit_function)(int));
1842 void InitPlatformDependentStuff(void);
1843 void ClosePlatformDependentStuff(void);
1845 void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
1846 void InitGfxTileSizeInfo(int, int);
1847 void InitGfxDoor1Info(int, int, int, int);
1848 void InitGfxDoor2Info(int, int, int, int);
1849 void InitGfxDoor3Info(int, int, int, int);
1850 void InitGfxWindowInfo(int, int);
1851 void InitGfxScrollbufferInfo(int, int);
1852 void InitGfxClipRegion(boolean, int, int, int, int);
1853 void InitGfxDrawBusyAnimFunction(void (*draw_busy_anim_function)(void));
1854 void InitGfxDrawGlobalAnimFunction(void (*draw_global_anim_function)(int, int));
1855 void InitGfxDrawGlobalBorderFunction(void (*draw_global_border_function)(int));
1856 void InitGfxDrawTileCursorFunction(void (*draw_tile_cursor_function)(int));
1857 void InitGfxCustomArtworkInfo(void);
1858 void InitGfxOtherSettings(void);
1859 void InitTileCursorInfo(void);
1860 void InitOverlayInfo(void);
1861 void SetOverlayGridSizeAndButtons(void);
1862 void SetTileCursorEnabled(boolean);
1863 void SetTileCursorActive(boolean);
1864 void SetTileCursorTargetXY(int, int);
1865 void SetTileCursorXY(int, int);
1866 void SetTileCursorSXSY(int, int);
1867 void SetOverlayEnabled(boolean);
1868 void SetOverlayActive(boolean);
1869 void SetOverlayShowGrid(boolean);
1870 boolean GetOverlayEnabled(void);
1871 boolean GetOverlayActive(void);
1872 void SetDrawDeactivationMask(int);
1873 int GetDrawDeactivationMask(void);
1874 void SetDrawBackgroundMask(int);
1875 void SetWindowBackgroundBitmap(Bitmap *);
1876 void SetMainBackgroundBitmap(Bitmap *);
1877 void SetDoorBackgroundBitmap(Bitmap *);
1878 void SetRedrawMaskFromArea(int, int, int, int);
1880 void LimitScreenUpdates(boolean);
1882 void InitVideoDefaults(void);
1883 void InitVideoDisplay(void);
1884 void CloseVideoDisplay(void);
1885 void InitVideoBuffer(int, int, int, boolean);
1886 Bitmap *CreateBitmapStruct(void);
1887 Bitmap *CreateBitmap(int, int, int);
1888 void ReCreateBitmap(Bitmap **, int, int);
1889 void FreeBitmap(Bitmap *);
1890 void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
1891 void BlitBitmapTiled(Bitmap *, Bitmap *, int, int, int, int, int, int, int,int);
1892 void FadeRectangle(int, int, int, int, int, int, int,
1893 void (*draw_border_function)(void));
1894 void FillRectangle(Bitmap *, int, int, int, int, Pixel);
1895 void ClearRectangle(Bitmap *, int, int, int, int);
1896 void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
1897 void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
1898 boolean DrawingDeactivatedField(void);
1899 boolean DrawingDeactivated(int, int, int, int);
1900 boolean DrawingOnBackground(int, int);
1901 boolean DrawingAreaChanged(void);
1902 void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int, int);
1903 void BlitTexture(Bitmap *, int, int, int, int, int, int);
1904 void BlitTextureMasked(Bitmap *, int, int, int, int, int, int);
1905 void BlitToScreen(Bitmap *, int, int, int, int, int, int);
1906 void BlitToScreenMasked(Bitmap *, int, int, int, int, int, int);
1907 void DrawSimpleBlackLine(Bitmap *, int, int, int, int);
1908 void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
1909 void DrawLines(Bitmap *, struct XY *, int, Pixel);
1910 Pixel GetPixel(Bitmap *, int, int);
1911 Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
1912 Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
1914 void KeyboardAutoRepeatOn(void);
1915 void KeyboardAutoRepeatOff(void);
1916 boolean SetVideoMode(boolean);
1917 void SetVideoFrameDelay(unsigned int);
1918 unsigned int GetVideoFrameDelay(void);
1919 boolean ChangeVideoModeIfNeeded(boolean);
1921 Bitmap *LoadImage(char *);
1922 Bitmap *LoadCustomImage(char *);
1923 void ReloadCustomImage(Bitmap *, char *);
1925 void ReCreateGameTileSizeBitmap(Bitmap **);
1926 void CreateBitmapWithSmallBitmaps(Bitmap **, int, int);
1927 void CreateBitmapTextures(Bitmap **);
1928 void FreeBitmapTextures(Bitmap **);
1929 void ScaleBitmap(Bitmap **, int);
1931 void SetMouseCursor(int);
1932 void UpdateRawMousePosition(int, int);
1933 void UpdateMousePosition(void);
1935 void OpenAudio(void);
1936 void CloseAudio(void);
1937 void SetAudioMode(boolean);
1939 void InitEventFilter(EventFilter);
1940 boolean PendingEvent(void);
1941 void WaitEvent(Event *event);
1942 void PeekEvent(Event *event);
1943 void PumpEvents(void);
1944 void CheckQuitEvent(void);
1945 Key GetEventKey(KeyEvent *, boolean);
1946 KeyMod HandleKeyModState(Key, int);
1947 KeyMod GetKeyModState(void);
1948 KeyMod GetKeyModStateFromEvents(void);
1949 void StartTextInput(int, int, int, int);
1950 void StopTextInput(void);
1951 void PushUserEvent(int, int, int);
1953 void InitJoysticks(void);
1954 boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
1955 boolean CheckJoystickOpened(int);
1956 void ClearJoystickState(void);