Renamed SDLKey and SDLMod for consistency

libsdl-org · Feb 7, 2011 · 8317baa · 8317baa
1 parent d86cf56
commit 8317baa
Show file tree

Hide file tree

Showing 12 changed files with 35 additions and 33 deletions.
diff --git a/include/SDL_compat.h b/include/SDL_compat.h
@@ -219,6 +219,8 @@ struct SDL_SysWMinfo;
 #define SDL_KeySym		SDL_Keysym
 #define SDL_scancode	SDL_Scancode
 #define SDL_ScanCode	SDL_Scancode
+#define SDLKey          SDL_Key
+#define SDLMod          SDL_Mod
 
 /** 
  *  \name Renamed keys

diff --git a/include/SDL_keyboard.h b/include/SDL_keyboard.h
@@ -48,7 +48,7 @@ extern "C" {
 typedef struct SDL_Keysym
 {
     SDL_Scancode scancode;      /**< SDL physical key code - see ::SDL_Scancode for details */
-    SDLKey sym;                 /**< SDL virtual key code - see ::SDLKey for details */
+    SDL_Key sym;                /**< SDL virtual key code - see ::SDL_Key for details */
     Uint16 mod;                 /**< current key modifiers */
     Uint32 unicode;             /**< \deprecated use SDL_TextInputEvent instead */
 } SDL_Keysym;
@@ -80,24 +80,24 @@ extern DECLSPEC Uint8 *SDLCALL SDL_GetKeyboardState(int *numkeys);
 /**
  *  \brief Get the current key modifier state for the keyboard.
  */
-extern DECLSPEC SDLMod SDLCALL SDL_GetModState(void);
+extern DECLSPEC SDL_Mod SDLCALL SDL_GetModState(void);
 
 /**
  *  \brief Set the current key modifier state for the keyboard.
  *  
  *  \note This does not change the keyboard state, only the key modifier flags.
  */
-extern DECLSPEC void SDLCALL SDL_SetModState(SDLMod modstate);
+extern DECLSPEC void SDLCALL SDL_SetModState(SDL_Mod modstate);
 
 /**
  *  \brief Get the key code corresponding to the given scancode according
  *         to the current keyboard layout.
  *  
- *  See ::SDLKey for details.
+ *  See ::SDL_Key for details.
  *  
  *  \sa SDL_GetKeyName()
  */
-extern DECLSPEC SDLKey SDLCALL SDL_GetKeyFromScancode(SDL_Scancode scancode);
+extern DECLSPEC SDL_Key SDLCALL SDL_GetKeyFromScancode(SDL_Scancode scancode);
 
 /**
  *  \brief Get the scancode corresponding to the given key code according to the
@@ -107,7 +107,7 @@ extern DECLSPEC SDLKey SDLCALL SDL_GetKeyFromScancode(SDL_Scancode scancode);
  *  
  *  \sa SDL_GetScancodeName()
  */
-extern DECLSPEC SDL_Scancode SDLCALL SDL_GetScancodeFromKey(SDLKey key);
+extern DECLSPEC SDL_Scancode SDLCALL SDL_GetScancodeFromKey(SDL_Key key);
 
 /**
  *  \brief Get a human-readable name for a scancode.
@@ -130,9 +130,9 @@ extern DECLSPEC const char *SDLCALL SDL_GetScancodeName(SDL_Scancode
  *          copy it.  If the key doesn't have a name, this function returns an 
  *          empty string ("").
  *  
- *  \sa SDLKey
+ *  \sa SDL_Key
  */
-extern DECLSPEC const char *SDLCALL SDL_GetKeyName(SDLKey key);
+extern DECLSPEC const char *SDLCALL SDL_GetKeyName(SDL_Key key);
 
 /**
  *  \brief Start accepting Unicode text input events.

diff --git a/include/SDL_keysym.h b/include/SDL_keysym.h
@@ -40,7 +40,7 @@
  *  the unmodified character that would be generated by pressing the key, or
  *  an SDLK_* constant for those keys that do not generate characters.
  */
-typedef Sint32 SDLKey;
+typedef Sint32 SDL_Key;
 
 #define SDLK_SCANCODE_MASK (1<<30)
 #define SDL_SCANCODE_TO_KEYCODE(X)	(X | SDLK_SCANCODE_MASK)
@@ -330,7 +330,7 @@ typedef enum
     KMOD_CAPS = 0x2000,
     KMOD_MODE = 0x4000,
     KMOD_RESERVED = 0x8000
-} SDLMod;
+} SDL_Mod;
 
 #define KMOD_CTRL	(KMOD_LCTRL|KMOD_RCTRL)
 #define KMOD_SHIFT	(KMOD_LSHIFT|KMOD_RSHIFT)

diff --git a/src/events/SDL_keyboard.c b/src/events/SDL_keyboard.c
@@ -39,12 +39,12 @@ struct SDL_Keyboard
     SDL_Window *focus;
     Uint16 modstate;
     Uint8 keystate[SDL_NUM_SCANCODES];
-    SDLKey keymap[SDL_NUM_SCANCODES];
+    SDL_Key keymap[SDL_NUM_SCANCODES];
 };
 
 static SDL_Keyboard SDL_keyboard;
 
-static const SDLKey SDL_default_keymap[SDL_NUM_SCANCODES] = {
+static const SDL_Key SDL_default_keymap[SDL_NUM_SCANCODES] = {
     0, 0, 0, 0,
     'a',
     'b',
@@ -572,13 +572,13 @@ SDL_ResetKeyboard(void)
 }
 
 void
-SDL_GetDefaultKeymap(SDLKey * keymap)
+SDL_GetDefaultKeymap(SDL_Key * keymap)
 {
     SDL_memcpy(keymap, SDL_default_keymap, sizeof(SDL_default_keymap));
 }
 
 void
-SDL_SetKeymap(int start, SDLKey * keys, int length)
+SDL_SetKeymap(int start, SDL_Key * keys, int length)
 {
     SDL_Keyboard *keyboard = &SDL_keyboard;
 
@@ -832,7 +832,7 @@ SDL_GetKeyboardState(int *numkeys)
     return keyboard->keystate;
 }
 
-SDLMod
+SDL_Mod
 SDL_GetModState(void)
 {
     SDL_Keyboard *keyboard = &SDL_keyboard;
@@ -841,14 +841,14 @@ SDL_GetModState(void)
 }
 
 void
-SDL_SetModState(SDLMod modstate)
+SDL_SetModState(SDL_Mod modstate)
 {
     SDL_Keyboard *keyboard = &SDL_keyboard;
 
     keyboard->modstate = modstate;
 }
 
-SDLKey
+SDL_Key
 SDL_GetKeyFromScancode(SDL_Scancode scancode)
 {
     SDL_Keyboard *keyboard = &SDL_keyboard;
@@ -857,7 +857,7 @@ SDL_GetKeyFromScancode(SDL_Scancode scancode)
 }
 
 SDL_Scancode
-SDL_GetScancodeFromKey(SDLKey key)
+SDL_GetScancodeFromKey(SDL_Key key)
 {
     SDL_Keyboard *keyboard = &SDL_keyboard;
     SDL_Scancode scancode;
@@ -883,7 +883,7 @@ SDL_GetScancodeName(SDL_Scancode scancode)
 }
 
 const char *
-SDL_GetKeyName(SDLKey key)
+SDL_GetKeyName(SDL_Key key)
 {
     static char name[8];
     char *end;

diff --git a/src/events/SDL_keyboard_c.h b/src/events/SDL_keyboard_c.h
@@ -34,10 +34,10 @@ extern int SDL_KeyboardInit(void);
 extern void SDL_ResetKeyboard(void);
 
 /* Get the default keymap */
-extern void SDL_GetDefaultKeymap(SDLKey * keymap);
+extern void SDL_GetDefaultKeymap(SDL_Key * keymap);
 
 /* Set the mapping of scancode to key codes */
-extern void SDL_SetKeymap(int start, SDLKey * keys, int length);
+extern void SDL_SetKeymap(int start, SDL_Key * keys, int length);
 
 /* Set a platform-dependent key name, overriding the default platform-agnostic
    name. Encoded as UTF-8. The string is not copied, thus the pointer given to

diff --git a/src/events/scancodes_linux.h b/src/events/scancodes_linux.h
@@ -21,7 +21,7 @@
 */
 #include "../../include/SDL_scancode.h"
 
-/* Linux virtual key code to SDLKey mapping table
+/* Linux virtual key code to SDL_Key mapping table
    Sources:
    - Linux kernel source input.h
 */

diff --git a/src/video/android/SDL_androidkeyboard.c b/src/video/android/SDL_androidkeyboard.c
@@ -30,7 +30,7 @@
 
 void Android_InitKeyboard()
 {
-    SDLKey keymap[SDL_NUM_SCANCODES];
+    SDL_Key keymap[SDL_NUM_SCANCODES];
 
     /* Add default scancode to key mapping */
     SDL_GetDefaultKeymap(keymap);

diff --git a/src/video/bwindow/SDL_BWin.h b/src/video/bwindow/SDL_BWin.h
@@ -586,7 +586,7 @@ class SDL_BWin:public BDirectWindow
     bool inhibit_resize;
 
     int32 last_buttons;
-    SDLKey keymap[128];
+    SDL_Key keymap[128];
 };
 
 #endif /* _SDL_BWin_h */

diff --git a/src/video/cocoa/SDL_cocoakeyboard.m b/src/video/cocoa/SDL_cocoakeyboard.m
@@ -490,7 +490,7 @@ - (NSArray *) validAttributesForMarkedText
     const void *chr_data;
     int i;
     SDL_Scancode scancode;
-    SDLKey keymap[SDL_NUM_SCANCODES];
+    SDL_Key keymap[SDL_NUM_SCANCODES];
 
     /* See if the keymap needs to be updated */
 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5

diff --git a/src/video/directfb/SDL_DirectFB_events.c b/src/video/directfb/SDL_DirectFB_events.c
@@ -659,7 +659,7 @@ EnumKeyboards(DFBInputDeviceID device_id,
 #if USE_MULTI_API
     SDL_Keyboard keyboard;
 #endif
-    SDLKey keymap[SDL_NUM_SCANCODES];
+    SDL_Key keymap[SDL_NUM_SCANCODES];
 
 	if (!cb->sys_kbd) {
 		if (cb->sys_ids) {

diff --git a/src/video/windows/SDL_windowskeyboard.c b/src/video/windows/SDL_windowskeyboard.c
@@ -151,7 +151,7 @@ WIN_UpdateKeymap()
 {
     int i;
     SDL_Scancode scancode;
-    SDLKey keymap[SDL_NUM_SCANCODES];
+    SDL_Key keymap[SDL_NUM_SCANCODES];
 
     SDL_GetDefaultKeymap(keymap);
 

diff --git a/src/video/x11/SDL_x11keyboard.c b/src/video/x11/SDL_x11keyboard.c
@@ -34,7 +34,7 @@
 /* *INDENT-OFF* */
 static const struct {
     KeySym keysym;
-    SDLKey sdlkey;
+    SDL_Key sdlkey;
 } KeySymToSDLKey[] = {
     { XK_Return, SDLK_RETURN },
     { XK_Escape, SDLK_ESCAPE },
@@ -143,7 +143,7 @@ static const struct
 };
 /* *INDENT-OFF* */
 
-static SDLKey
+static SDL_Key
 X11_KeyCodeToSDLKey(Display *display, KeyCode keycode)
 {
     KeySym keysym;
@@ -157,7 +157,7 @@ X11_KeyCodeToSDLKey(Display *display, KeyCode keycode)
 
     ucs4 = X11_KeySymToUcs4(keysym);
     if (ucs4) {
-        return (SDLKey) ucs4;
+        return (SDL_Key) ucs4;
     }
 
     for (i = 0; i < SDL_arraysize(KeySymToSDLKey); ++i) {
@@ -222,7 +222,7 @@ X11_InitKeyboard(_THIS)
     }
 
     if (!fingerprint_detected) {
-        SDLKey keymap[SDL_NUM_SCANCODES];
+        SDL_Key keymap[SDL_NUM_SCANCODES];
 
         printf
             ("Keyboard layout unknown, please send the following to the SDL mailing list (sdl@libsdl.org):\n");
@@ -233,7 +233,7 @@ X11_InitKeyboard(_THIS)
             KeySym sym;
             sym = XKeycodeToKeysym(data->display, i, 0);
             if (sym != NoSymbol) {
-                SDLKey key;
+                SDL_Key key;
                 printf("code = %d, sym = 0x%X (%s) ", i - min_keycode,
                        (unsigned int) sym, XKeysymToString(sym));
                 key = X11_KeyCodeToSDLKey(data->display, i);
@@ -265,7 +265,7 @@ X11_UpdateKeymap(_THIS)
     SDL_VideoData *data = (SDL_VideoData *) _this->driverdata;
     int i;
     SDL_Scancode scancode;
-    SDLKey keymap[SDL_NUM_SCANCODES];
+    SDL_Key keymap[SDL_NUM_SCANCODES];
 
     SDL_zero(keymap);