src/libgame/sdl.h

   1 /***********************************************************
   2 * Artsoft Retro-Game Library                               *
   3 *----------------------------------------------------------*
   4 * (c) 1994-2006 Artsoft Entertainment                      *
   5 *               Holger Schemel                             *
   6 *               Detmolder Strasse 189                      *
   7 *               33604 Bielefeld                            *
   8 *               Germany                                    *
   9 *               e-mail: info@artsoft.org                   *
  10 *----------------------------------------------------------*
  11 * sdl.h                                                    *
  12 ***********************************************************/
  13
  14 #ifndef SDL_H
  15 #define SDL_H
  16
  17 #include <SDL.h>
  18 #include <SDL_image.h>
  19 #include <SDL_mixer.h>
  20 #include <SDL_net.h>
  21 #include <SDL_thread.h>
  22 #if defined(PLATFORM_WIN32)
  23 #include <SDL_syswm.h>
  24 #endif
  25
  26 /* definitions needed for "system.c" */
  27
  28 #if defined(TARGET_SDL2)
  29 #define SURFACE_FLAGS           (0)
  30 #else
  31 #define SURFACE_FLAGS           (SDL_SWSURFACE)
  32 #endif
  33
  34 #if defined(TARGET_SDL2)
  35 #define SET_TRANSPARENT_PIXEL   (SDL_TRUE)
  36 #define UNSET_TRANSPARENT_PIXEL (SDL_FALSE)
  37 #else
  38 #define SET_TRANSPARENT_PIXEL   (SDL_SRCCOLORKEY)
  39 #define UNSET_TRANSPARENT_PIXEL (0)
  40 #endif
  41
  42 /* system dependent definitions */
  43
  44 #if defined(TARGET_SDL2)
  45 #define TARGET_STRING           "SDL2"
  46 #else
  47 #define TARGET_STRING           "SDL"
  48 #endif
  49
  50 #if defined(PLATFORM_ANDROID)
  51 #define WINDOW_SCALING_STATUS   WINDOW_SCALING_NOT_AVAILABLE
  52 #define FULLSCREEN_STATUS       FULLSCREEN_NOT_AVAILABLE
  53 #elif defined(TARGET_SDL2)
  54 #define WINDOW_SCALING_STATUS   WINDOW_SCALING_AVAILABLE
  55 #define FULLSCREEN_STATUS       FULLSCREEN_AVAILABLE
  56 #define USE_DESKTOP_FULLSCREEN  TRUE
  57 #else   // SDL 1.2
  58 #define WINDOW_SCALING_STATUS   WINDOW_SCALING_NOT_AVAILABLE
  59 #define FULLSCREEN_STATUS       FULLSCREEN_AVAILABLE
  60 #endif
  61
  62 #define CURSOR_MAX_WIDTH        32
  63 #define CURSOR_MAX_HEIGHT       32
  64
  65
  66 /* SDL type definitions */
  67
  68 typedef struct SDLSurfaceInfo   Bitmap;
  69 typedef struct SDLSurfaceInfo   DrawBuffer;
  70 typedef struct SDLSurfaceInfo   DrawWindow;
  71 typedef Uint32                  Pixel;
  72 typedef SDL_Cursor             *Cursor;
  73
  74 #if defined(TARGET_SDL2)
  75 typedef SDL_Keycode             Key;
  76 typedef SDL_Keymod              KeyMod;
  77 #else
  78 typedef SDLKey                  Key;
  79 typedef unsigned int            KeyMod;
  80 #endif
  81
  82 typedef SDL_Event               Event;
  83 typedef SDL_MouseButtonEvent    ButtonEvent;
  84 typedef SDL_MouseMotionEvent    MotionEvent;
  85 #if defined(TARGET_SDL2)
  86 typedef SDL_TouchFingerEvent    FingerEvent;
  87 typedef SDL_TextInputEvent      TextEvent;
  88 #endif
  89 typedef SDL_KeyboardEvent       KeyEvent;
  90 typedef SDL_Event               ExposeEvent;
  91 typedef SDL_Event               FocusChangeEvent;
  92 typedef SDL_Event               ClientMessageEvent;
  93
  94 typedef int                     GC;
  95 typedef int                     Pixmap;
  96 typedef int                     Display;
  97 typedef int                     Visual;
  98 typedef int                     Colormap;
  99
 100
 101 /* structure definitions */
 102
 103 struct SDLSurfaceInfo
 104 {
 105   char *source_filename;
 106
 107   int width, height;
 108   SDL_Surface *surface;
 109   SDL_Surface *surface_masked;
 110   GC gc;
 111   GC stored_clip_gc;
 112 };
 113
 114 struct MouseCursorInfo
 115 {
 116   int width, height;
 117   int hot_x, hot_y;
 118
 119   byte data[CURSOR_MAX_WIDTH * CURSOR_MAX_HEIGHT / 8];
 120   byte mask[CURSOR_MAX_WIDTH * CURSOR_MAX_HEIGHT / 8];
 121 };
 122
 123
 124 /* SDL symbol definitions */
 125
 126 #define None                    0L
 127
 128 #define BLACK_PIXEL             0x000000
 129 #define WHITE_PIXEL             0xffffff
 130
 131 #define EVENT_BUTTONPRESS       SDL_MOUSEBUTTONDOWN
 132 #define EVENT_BUTTONRELEASE     SDL_MOUSEBUTTONUP
 133 #define EVENT_MOTIONNOTIFY      SDL_MOUSEMOTION
 134 #if defined(TARGET_SDL2)
 135 #define EVENT_FINGERPRESS       SDL_FINGERDOWN
 136 #define EVENT_FINGERRELEASE     SDL_FINGERUP
 137 #define EVENT_FINGERMOTION      SDL_FINGERMOTION
 138 #define EVENT_TEXTINPUT         SDL_TEXTINPUT
 139 #endif
 140 #define EVENT_KEYPRESS          SDL_KEYDOWN
 141 #define EVENT_KEYRELEASE        SDL_KEYUP
 142 #define EVENT_EXPOSE            SDL_USEREVENT + 0
 143 #define EVENT_FOCUSIN           SDL_USEREVENT + 1
 144 #define EVENT_FOCUSOUT          SDL_USEREVENT + 2
 145 #define EVENT_CLIENTMESSAGE     SDL_QUIT
 146 #define EVENT_MAPNOTIFY         SDL_USEREVENT + 4
 147 #define EVENT_UNMAPNOTIFY       SDL_USEREVENT + 5
 148
 149 #define KSYM_UNDEFINED          SDLK_UNKNOWN
 150
 151 #define KSYM_Return             SDLK_RETURN
 152 #define KSYM_Escape             SDLK_ESCAPE
 153
 154 #define KSYM_Left               SDLK_LEFT
 155 #define KSYM_Right              SDLK_RIGHT
 156 #define KSYM_Up                 SDLK_UP
 157 #define KSYM_Down               SDLK_DOWN
 158
 159 #ifdef SDLK_KP_LEFT
 160 #define KSYM_KP_Left            SDLK_KP_LEFT
 161 #define KSYM_KP_Right           SDLK_KP_RIGHT
 162 #define KSYM_KP_Up              SDLK_KP_UP
 163 #define KSYM_KP_Down            SDLK_KP_DOWN
 164 #endif
 165
 166 #define KSYM_KP_Enter           SDLK_KP_ENTER
 167 #define KSYM_KP_Add             SDLK_KP_PLUS
 168 #define KSYM_KP_Subtract        SDLK_KP_MINUS
 169 #define KSYM_KP_Multiply        SDLK_KP_MULTIPLY
 170 #define KSYM_KP_Divide          SDLK_KP_DIVIDE
 171 #define KSYM_KP_Separator       SDLK_KP_PERIOD
 172
 173 #define KSYM_Shift_L            SDLK_LSHIFT
 174 #define KSYM_Shift_R            SDLK_RSHIFT
 175 #define KSYM_Control_L          SDLK_LCTRL
 176 #define KSYM_Control_R          SDLK_RCTRL
 177
 178 #if defined(TARGET_SDL2)
 179 #define KSYM_Meta_L             SDLK_LGUI
 180 #define KSYM_Meta_R             SDLK_RGUI
 181 #else
 182 #define KSYM_Meta_L             SDLK_LMETA
 183 #define KSYM_Meta_R             SDLK_RMETA
 184 #endif
 185
 186 #define KSYM_Alt_L              SDLK_LALT
 187 #define KSYM_Alt_R              SDLK_RALT
 188 #if !defined(TARGET_SDL2)
 189 #define KSYM_Super_L            SDLK_LSUPER
 190 #define KSYM_Super_R            SDLK_RSUPER
 191 #endif
 192 #define KSYM_Mode_switch        SDLK_MODE
 193 #define KSYM_Multi_key          SDLK_RCTRL
 194
 195 #define KSYM_BackSpace          SDLK_BACKSPACE
 196 #define KSYM_Delete             SDLK_DELETE
 197 #define KSYM_Insert             SDLK_INSERT
 198 #define KSYM_Tab                SDLK_TAB
 199 #define KSYM_Home               SDLK_HOME
 200 #define KSYM_End                SDLK_END
 201 #define KSYM_Page_Up            SDLK_PAGEUP
 202 #define KSYM_Page_Down          SDLK_PAGEDOWN
 203
 204 #if defined(TARGET_SDL2)
 205 #define KSYM_Menu               SDLK_MENU
 206 #define KSYM_Back               SDLK_AC_BACK
 207 #endif
 208
 209 #define KSYM_space              SDLK_SPACE
 210 #define KSYM_exclam             SDLK_EXCLAIM
 211 #define KSYM_quotedbl           SDLK_QUOTEDBL
 212 #define KSYM_numbersign         SDLK_HASH
 213 #define KSYM_dollar             SDLK_DOLLAR
 214
 215 #if defined(TARGET_SDL2)
 216 #define KSYM_percent            SDLK_PERCENT
 217 #else
 218 #define KSYM_percent            37                      /* undefined in SDL */
 219 #endif
 220
 221 #define KSYM_ampersand          SDLK_AMPERSAND
 222 #define KSYM_apostrophe         SDLK_QUOTE
 223 #define KSYM_parenleft          SDLK_LEFTPAREN
 224 #define KSYM_parenright         SDLK_RIGHTPAREN
 225 #define KSYM_asterisk           SDLK_ASTERISK
 226 #define KSYM_plus               SDLK_PLUS
 227 #define KSYM_comma              SDLK_COMMA
 228 #define KSYM_minus              SDLK_MINUS
 229 #define KSYM_period             SDLK_PERIOD
 230 #define KSYM_slash              SDLK_SLASH
 231
 232 #define KSYM_colon              SDLK_COLON
 233 #define KSYM_semicolon          SDLK_SEMICOLON
 234 #define KSYM_less               SDLK_LESS
 235 #define KSYM_equal              SDLK_EQUALS
 236 #define KSYM_greater            SDLK_GREATER
 237 #define KSYM_question           SDLK_QUESTION
 238 #define KSYM_at                 SDLK_AT
 239
 240 #define KSYM_bracketleft        SDLK_LEFTBRACKET
 241 #define KSYM_backslash          SDLK_BACKSLASH
 242 #define KSYM_bracketright       SDLK_RIGHTBRACKET
 243 #define KSYM_asciicircum        SDLK_CARET
 244 #define KSYM_underscore         SDLK_UNDERSCORE
 245 #define KSYM_grave              SDLK_BACKQUOTE
 246
 247 #define KSYM_quoteleft          KSYM_UNDEFINED          /* undefined */
 248 #define KSYM_braceleft          KSYM_UNDEFINED          /* undefined */
 249 #define KSYM_bar                KSYM_UNDEFINED          /* undefined */
 250 #define KSYM_braceright         KSYM_UNDEFINED          /* undefined */
 251 #define KSYM_asciitilde         KSYM_UNDEFINED          /* undefined */
 252
 253 #if defined(TARGET_SDL2)
 254 #define KSYM_degree             176
 255 #define KSYM_Adiaeresis         196
 256 #define KSYM_Odiaeresis         214
 257 #define KSYM_Udiaeresis         220
 258 #define KSYM_adiaeresis         228
 259 #define KSYM_odiaeresis         246
 260 #define KSYM_udiaeresis         252
 261 #define KSYM_ssharp             223
 262 #else
 263 #define KSYM_degree             SDLK_WORLD_16
 264 #define KSYM_Adiaeresis         SDLK_WORLD_36
 265 #define KSYM_Odiaeresis         SDLK_WORLD_54
 266 #define KSYM_Udiaeresis         SDLK_WORLD_60
 267 #define KSYM_adiaeresis         SDLK_WORLD_68
 268 #define KSYM_odiaeresis         SDLK_WORLD_86
 269 #define KSYM_udiaeresis         SDLK_WORLD_92
 270 #define KSYM_ssharp             SDLK_WORLD_63
 271 #endif
 272
 273 #ifndef SDLK_A
 274 #define SDLK_A                  65
 275 #define SDLK_B                  66
 276 #define SDLK_C                  67
 277 #define SDLK_D                  68
 278 #define SDLK_E                  69
 279 #define SDLK_F                  70
 280 #define SDLK_G                  71
 281 #define SDLK_H                  72
 282 #define SDLK_I                  73
 283 #define SDLK_J                  74
 284 #define SDLK_K                  75
 285 #define SDLK_L                  76
 286 #define SDLK_M                  77
 287 #define SDLK_N                  78
 288 #define SDLK_O                  79
 289 #define SDLK_P                  80
 290 #define SDLK_Q                  81
 291 #define SDLK_R                  82
 292 #define SDLK_S                  83
 293 #define SDLK_T                  84
 294 #define SDLK_U                  85
 295 #define SDLK_V                  86
 296 #define SDLK_W                  87
 297 #define SDLK_X                  88
 298 #define SDLK_Y                  89
 299 #define SDLK_Z                  90
 300 #endif
 301
 302 #define KSYM_A                  SDLK_A
 303 #define KSYM_B                  SDLK_B
 304 #define KSYM_C                  SDLK_C
 305 #define KSYM_D                  SDLK_D
 306 #define KSYM_E                  SDLK_E
 307 #define KSYM_F                  SDLK_F
 308 #define KSYM_G                  SDLK_G
 309 #define KSYM_H                  SDLK_H
 310 #define KSYM_I                  SDLK_I
 311 #define KSYM_J                  SDLK_J
 312 #define KSYM_K                  SDLK_K
 313 #define KSYM_L                  SDLK_L
 314 #define KSYM_M                  SDLK_M
 315 #define KSYM_N                  SDLK_N
 316 #define KSYM_O                  SDLK_O
 317 #define KSYM_P                  SDLK_P
 318 #define KSYM_Q                  SDLK_Q
 319 #define KSYM_R                  SDLK_R
 320 #define KSYM_S                  SDLK_S
 321 #define KSYM_T                  SDLK_T
 322 #define KSYM_U                  SDLK_U
 323 #define KSYM_V                  SDLK_V
 324 #define KSYM_W                  SDLK_W
 325 #define KSYM_X                  SDLK_X
 326 #define KSYM_Y                  SDLK_Y
 327 #define KSYM_Z                  SDLK_Z
 328
 329 #define KSYM_a                  SDLK_a
 330 #define KSYM_b                  SDLK_b
 331 #define KSYM_c                  SDLK_c
 332 #define KSYM_d                  SDLK_d
 333 #define KSYM_e                  SDLK_e
 334 #define KSYM_f                  SDLK_f
 335 #define KSYM_g                  SDLK_g
 336 #define KSYM_h                  SDLK_h
 337 #define KSYM_i                  SDLK_i
 338 #define KSYM_j                  SDLK_j
 339 #define KSYM_k                  SDLK_k
 340 #define KSYM_l                  SDLK_l
 341 #define KSYM_m                  SDLK_m
 342 #define KSYM_n                  SDLK_n
 343 #define KSYM_o                  SDLK_o
 344 #define KSYM_p                  SDLK_p
 345 #define KSYM_q                  SDLK_q
 346 #define KSYM_r                  SDLK_r
 347 #define KSYM_s                  SDLK_s
 348 #define KSYM_t                  SDLK_t
 349 #define KSYM_u                  SDLK_u
 350 #define KSYM_v                  SDLK_v
 351 #define KSYM_w                  SDLK_w
 352 #define KSYM_x                  SDLK_x
 353 #define KSYM_y                  SDLK_y
 354 #define KSYM_z                  SDLK_z
 355
 356 #define KSYM_0                  SDLK_0
 357 #define KSYM_1                  SDLK_1
 358 #define KSYM_2                  SDLK_2
 359 #define KSYM_3                  SDLK_3
 360 #define KSYM_4                  SDLK_4
 361 #define KSYM_5                  SDLK_5
 362 #define KSYM_6                  SDLK_6
 363 #define KSYM_7                  SDLK_7
 364 #define KSYM_8                  SDLK_8
 365 #define KSYM_9                  SDLK_9
 366
 367 #if defined(TARGET_SDL2)
 368 #define KSYM_KP_0               SDLK_KP_0
 369 #define KSYM_KP_1               SDLK_KP_1
 370 #define KSYM_KP_2               SDLK_KP_2
 371 #define KSYM_KP_3               SDLK_KP_3
 372 #define KSYM_KP_4               SDLK_KP_4
 373 #define KSYM_KP_5               SDLK_KP_5
 374 #define KSYM_KP_6               SDLK_KP_6
 375 #define KSYM_KP_7               SDLK_KP_7
 376 #define KSYM_KP_8               SDLK_KP_8
 377 #define KSYM_KP_9               SDLK_KP_9
 378 #else
 379 #define KSYM_KP_0               SDLK_KP0
 380 #define KSYM_KP_1               SDLK_KP1
 381 #define KSYM_KP_2               SDLK_KP2
 382 #define KSYM_KP_3               SDLK_KP3
 383 #define KSYM_KP_4               SDLK_KP4
 384 #define KSYM_KP_5               SDLK_KP5
 385 #define KSYM_KP_6               SDLK_KP6
 386 #define KSYM_KP_7               SDLK_KP7
 387 #define KSYM_KP_8               SDLK_KP8
 388 #define KSYM_KP_9               SDLK_KP9
 389 #endif
 390
 391 #define KSYM_F1                 SDLK_F1
 392 #define KSYM_F2                 SDLK_F2
 393 #define KSYM_F3                 SDLK_F3
 394 #define KSYM_F4                 SDLK_F4
 395 #define KSYM_F5                 SDLK_F5
 396 #define KSYM_F6                 SDLK_F6
 397 #define KSYM_F7                 SDLK_F7
 398 #define KSYM_F8                 SDLK_F8
 399 #define KSYM_F9                 SDLK_F9
 400 #define KSYM_F10                SDLK_F10
 401 #define KSYM_F11                SDLK_F11
 402 #define KSYM_F12                SDLK_F12
 403
 404 #define KSYM_FKEY_FIRST         KSYM_F1
 405 #define KSYM_FKEY_LAST          KSYM_F12
 406 #define KSYM_NUM_FKEYS          (KSYM_FKEY_LAST - KSYM_FKEY_FIRST + 1)
 407
 408 #define KMOD_None               KMOD_NONE
 409 #define KMOD_Shift_L            KMOD_LSHIFT
 410 #define KMOD_Shift_R            KMOD_RSHIFT
 411 #define KMOD_Control_L          KMOD_LCTRL
 412 #define KMOD_Control_R          KMOD_RCTRL
 413
 414 #if defined(TARGET_SDL2)
 415 #define KMOD_Meta_L             KMOD_LGUI
 416 #define KMOD_Meta_R             KMOD_RGUI
 417 #else
 418 #define KMOD_Meta_L             KMOD_LMETA
 419 #define KMOD_Meta_R             KMOD_RMETA
 420 #endif
 421
 422 #define KMOD_Alt_L              KMOD_LALT
 423 #define KMOD_Alt_R              KMOD_RALT
 424
 425 #define KMOD_Shift              (KMOD_Shift_L   | KMOD_Shift_R)
 426 #define KMOD_Control            (KMOD_Control_L | KMOD_Control_R)
 427 #define KMOD_Meta               (KMOD_Meta_L    | KMOD_Meta_R)
 428 #define KMOD_Alt                (KMOD_Alt_L     | KMOD_Alt_R)
 429
 430 #if defined(TARGET_SDL2)
 431 #define KMOD_TextInput          (KMOD_Shift | KMOD_Alt_R)
 432 #endif
 433
 434 /* SDL function definitions */
 435
 436 #if defined(TARGET_SDL2)
 437 SDL_Surface *SDL_DisplayFormat(SDL_Surface *);
 438 #endif
 439
 440 void SDLInitVideoDisplay(void);
 441 void SDLInitVideoBuffer(DrawBuffer **, DrawWindow **, boolean);
 442 boolean SDLSetVideoMode(DrawBuffer **, boolean);
 443 void SDLCreateBitmapContent(Bitmap *, int, int, int);
 444 void SDLFreeBitmapPointers(Bitmap *);
 445 void SDLCopyArea(Bitmap *, Bitmap *, int, int, int, int, int, int, int);
 446 void SDLFillRectangle(Bitmap *, int, int, int, int, Uint32);
 447 void SDLFadeRectangle(Bitmap *, int, int, int, int, int, int, int,
 448                       void (*draw_border_function)(void));
 449 void SDLDrawSimpleLine(Bitmap *, int, int, int, int, Uint32);
 450 void SDLDrawLine(Bitmap *, int, int, int, int, Uint32);
 451 Pixel SDLGetPixel(Bitmap *, int, int);
 452 void SDLPutPixel(Bitmap *, int, int, Pixel);
 453
 454 void SDLInvertArea(Bitmap *, int, int, int, int, Uint32);
 455 void SDLCopyInverseMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
 456
 457 void SDLZoomBitmap(Bitmap *, Bitmap *);
 458
 459 Bitmap *SDLLoadImage(char *);
 460
 461 void SDLSetMouseCursor(struct MouseCursorInfo *);
 462
 463 void SDLOpenAudio(void);
 464 void SDLCloseAudio(void);
 465
 466 void SDLNextEvent(Event *);
 467 void SDLHandleWindowManagerEvent(Event *);
 468
 469 void HandleJoystickEvent(Event *);
 470 void SDLInitJoysticks(void);
 471 boolean SDLReadJoystick(int, int *, int *, boolean *, boolean *);
 472
 473 #endif /* SDL_H */