src/events/SDL_keyboard_c.h
author Sam Lantinga <slouken@libsdl.org>
Sun, 19 Aug 2007 14:52:52 +0000
changeset 2268 4baee598306d
parent 2129 047245361002
child 2300 c97ad1abe05b
permissions -rw-r--r--
Date: Thu, 05 Jul 2007 14:02:33 -0700
From: Sam Lantinga
Subject: SDL 1.3 keyboard plan

After lots of discussion with Christian, this is what we came up with:

> So, to sum up...
> SDLK_* become the physical keys, starting at > (1<<21)
> We create a macro SDLK_INDEX(X)
> We have two functions SDL_GetLayoutKey(SDLKey) and SDL_GetKeyName()
> SDL_GetLayoutKey maps to UCS4 for printable characters, and SDLK* for
non-printable characters
> and does so based on the OS's current keyboard layout
> SDL_GetKeyName() handles both SDLK_* and UCS4, converting UCS4 to UTF-8 and
converting SDLK_* into our names, which are UTF-8 for printable characters.
> WASD folks use SDLK_*, and 'I' folks use SDL_GetLayoutKey(SDLK_*)

Here is the patch he came up with, and his e-mail about it:

Date: Fri, 17 Aug 2007 19:50:28 +0200
From: Christian Walther
Subject: Re: SDL 1.3 keyboard plan

> Sounds great, go ahead and send me a patch.

Here goes! Thanks for having a look. Don't hesitate to comment if
anything does not conform to your ideas.

One caveat: Committing this now may break compilability of some video
drivers - specifically, if they use any of the SDLK_* codes that were
obsoleted and moved into SDL_compat.h. I only tried Cocoa (which did
break, but is already fixed) and X11 (which didn't, but then its key
handling is #iffed out). If that's a problem, it may need to go into
a branch.

-Christian
slouken@1895
     1
/*
slouken@1895
     2
    SDL - Simple DirectMedia Layer
slouken@1895
     3
    Copyright (C) 1997-2006 Sam Lantinga
slouken@1895
     4
slouken@1895
     5
    This library is free software; you can redistribute it and/or
slouken@1895
     6
    modify it under the terms of the GNU Lesser General Public
slouken@1895
     7
    License as published by the Free Software Foundation; either
slouken@1895
     8
    version 2.1 of the License, or (at your option) any later version.
slouken@1895
     9
slouken@1895
    10
    This library is distributed in the hope that it will be useful,
slouken@1895
    11
    but WITHOUT ANY WARRANTY; without even the implied warranty of
slouken@1895
    12
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
slouken@1895
    13
    Lesser General Public License for more details.
slouken@1895
    14
slouken@1895
    15
    You should have received a copy of the GNU Lesser General Public
slouken@1895
    16
    License along with this library; if not, write to the Free Software
slouken@1895
    17
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
slouken@1895
    18
slouken@1895
    19
    Sam Lantinga
slouken@1895
    20
    slouken@libsdl.org
slouken@1895
    21
*/
slouken@1895
    22
#include "SDL_config.h"
slouken@1895
    23
slouken@1895
    24
#ifndef _SDL_keyboard_c_h
slouken@1895
    25
#define _SDL_keyboard_c_h
slouken@1895
    26
slouken@1895
    27
#include "SDL_keysym.h"
slouken@1895
    28
#include "SDL_events.h"
slouken@1895
    29
slouken@1895
    30
typedef struct SDL_Keyboard SDL_Keyboard;
slouken@1895
    31
slouken@1895
    32
struct SDL_Keyboard
slouken@1895
    33
{
slouken@1895
    34
    /* Free the keyboard when it's time */
slouken@1895
    35
    void (*FreeKeyboard) (SDL_Keyboard * keyboard);
slouken@1895
    36
slouken@1895
    37
    /* Data common to all keyboards */
slouken@1895
    38
    SDL_WindowID focus;
slouken@1895
    39
    Uint16 modstate;
slouken@1895
    40
    Uint8 keystate[SDLK_LAST];
slouken@1895
    41
slouken@1895
    42
    void *driverdata;
slouken@1895
    43
};
slouken@1895
    44
slouken@1895
    45
/* Used by the OS keyboard code to detect whether or not to do UNICODE */
slouken@1895
    46
#ifndef DEFAULT_UNICODE_TRANSLATION
slouken@1895
    47
#define DEFAULT_UNICODE_TRANSLATION 0   /* Default off because of overhead */
slouken@1895
    48
#endif
slouken@1895
    49
extern int SDL_TranslateUNICODE;
slouken@1895
    50
slouken@1895
    51
/* Initialize the keyboard subsystem */
slouken@1895
    52
extern int SDL_KeyboardInit(void);
slouken@1895
    53
slouken@1895
    54
/* Get the keyboard at an index */
slouken@1895
    55
extern SDL_Keyboard *SDL_GetKeyboard(int index);
slouken@1895
    56
slouken@1895
    57
/* Add a keyboard, possibly reattaching at a particular index (or -1),
slouken@1895
    58
   returning the index of the keyboard, or -1 if there was an error.
slouken@1895
    59
 */
slouken@1895
    60
extern int SDL_AddKeyboard(const SDL_Keyboard * keyboard, int index);
slouken@1895
    61
slouken@1895
    62
/* Remove a keyboard at an index, clearing the slot for later */
slouken@1895
    63
extern void SDL_DelKeyboard(int index);
slouken@1895
    64
slouken@1895
    65
/* Clear the state of a keyboard at an index */
slouken@1895
    66
extern void SDL_ResetKeyboard(int index);
slouken@1895
    67
slouken@2268
    68
/* Set a platform-dependent key name, overriding the default platform-agnostic
slouken@2268
    69
   name. Encoded as UTF-8. The string is not copied, thus the pointer given to
slouken@2268
    70
   this function must stay valid forever (or at least until the call to
slouken@2268
    71
   VideoQuit()). */
slouken@2268
    72
extern void SDL_SetKeyName(SDLKey physicalKey, const char *name);
slouken@2268
    73
slouken@1895
    74
/* Set the keyboard focus window */
slouken@1895
    75
extern void SDL_SetKeyboardFocus(int index, SDL_WindowID windowID);
slouken@1895
    76
slouken@1895
    77
/* Send a keyboard event for a keyboard at an index */
slouken@1895
    78
extern int SDL_SendKeyboardKey(int index, Uint8 state, Uint8 scancode,
slouken@1895
    79
                               SDLKey key);
slouken@1895
    80
slouken@1895
    81
/* Send keyboard text input for a keyboard at an index */
slouken@1895
    82
extern int SDL_SendKeyboardText(int index, const char *text);
slouken@1895
    83
slouken@1895
    84
/* Shutdown the keyboard subsystem */
slouken@1895
    85
extern void SDL_KeyboardQuit(void);
slouken@1895
    86
slouken@1895
    87
#endif /* _SDL_keyboard_c_h */
slouken@1895
    88
slouken@1895
    89
/* vi: set ts=4 sw=4 expandtab: */