PhxKeyboard.h

//  This file is free software; you can redistribute it and/or
//  modify it under the terms of the GNU General Public License
//  as published by the Free Software Foundation; either version 2
//  of the License, or (at your option) any later version.
//
//  This file is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with this program; if not, write to the Free Software
//  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
//
//  To view the licence online, go to: http://www.gnu.org/copyleft/gpl.html

#if !defined( PHXKEYBOARD_H )
#define PHXKEYBOARD_H

// Note: These code values are copied from SDL (SDL_keysym.h) and renamed.
//       On quick inspection, the SDL definitions match those used by OI.
// From SDL:
/* What we really want is a mapping of every raw key on the keyboard.
   To support international keyboards, we use the range 0xA1 - 0xFF
   as international virtual keycodes.  We'll follow in the footsteps of X11...
   The names of the keys
 */
 
namespace Phx
{
        typedef enum {
                /* The keyboard syms have been cleverly chosen to map to ASCII */
                PHXK_UNKNOWN      = 0,
                PHXK_BACKSPACE    = 8,
                PHXK_TAB          = 9,
                PHXK_CLEAR        = 12,
                PHXK_RETURN       = 13,
                PHXK_PAUSE        = 19,
                PHXK_ESCAPE       = 27,
                PHXK_SPACE        = 32,
                PHXK_EXCLAIM      = 33,
                PHXK_QUOTEDBL     = 34,
                PHXK_HASH         = 35,
                PHXK_DOLLAR       = 36,
                PHXK_AMPERSAND    = 38,
                PHXK_QUOTE        = 39,
                PHXK_LEFTPAREN    = 40,
                PHXK_RIGHTPAREN   = 41,
                PHXK_ASTERISK     = 42,
                PHXK_PLUS         = 43,
                PHXK_COMMA        = 44,
                PHXK_MINUS        = 45,
                PHXK_PERIOD       = 46,
                PHXK_SLASH        = 47,
                PHXK_0            = 48,
                PHXK_1            = 49,
                PHXK_2            = 50,
                PHXK_3            = 51,
                PHXK_4            = 52,
                PHXK_5            = 53,
                PHXK_6            = 54,
                PHXK_7            = 55,
                PHXK_8            = 56,
                PHXK_9            = 57,
                PHXK_COLON        = 58,
                PHXK_SEMICOLON    = 59,
                PHXK_LESS         = 60,
                PHXK_EQUALS       = 61,
                PHXK_GREATER      = 62,
                PHXK_QUESTION     = 63,
                PHXK_AT           = 64,

                // Skip uppercase letters

                PHXK_LEFTBRACKET  = 91,
                PHXK_BACKSLASH    = 92,
                PHXK_RIGHTBRACKET = 93,
                PHXK_CARET        = 94,
                PHXK_UNDERSCORE   = 95,
                PHXK_BACKQUOTE    = 96,
                PHXK_A            = 97,
                PHXK_B            = 98,
                PHXK_C            = 99,
                PHXK_D            = 100,
                PHXK_E            = 101,
                PHXK_F            = 102,
                PHXK_G            = 103,
                PHXK_H            = 104,
                PHXK_I            = 105,
                PHXK_J            = 106,
                PHXK_K            = 107,
                PHXK_L            = 108,
                PHXK_M            = 109,
                PHXK_N            = 110,
                PHXK_O            = 111,
                PHXK_P            = 112,
                PHXK_Q            = 113,
                PHXK_R            = 114,
                PHXK_S            = 115,
                PHXK_T            = 116,
                PHXK_U            = 117,
                PHXK_V            = 118,
                PHXK_W            = 119,
                PHXK_X            = 120,
                PHXK_Y            = 121,
                PHXK_Z            = 122,
                PHXK_DELETE       = 127,
                
                // End of ASCII mapped key symbols

                // International keyboard symbols

                PHXK_WORLD_0      = 160, /* 0xA0 */
                PHXK_WORLD_1      = 161,
                PHXK_WORLD_2      = 162,
                PHXK_WORLD_3      = 163,
                PHXK_WORLD_4      = 164,
                PHXK_WORLD_5      = 165,
                PHXK_WORLD_6      = 166,
                PHXK_WORLD_7      = 167,
                PHXK_WORLD_8      = 168,
                PHXK_WORLD_9      = 169,
                PHXK_WORLD_10     = 170,
                PHXK_WORLD_11     = 171,
                PHXK_WORLD_12     = 172,
                PHXK_WORLD_13     = 173,
                PHXK_WORLD_14     = 174,
                PHXK_WORLD_15     = 175,
                PHXK_WORLD_16     = 176,
                PHXK_WORLD_17     = 177,
                PHXK_WORLD_18     = 178,
                PHXK_WORLD_19     = 179,
                PHXK_WORLD_20     = 180,
                PHXK_WORLD_21     = 181,
                PHXK_WORLD_22     = 182,
                PHXK_WORLD_23     = 183,
                PHXK_WORLD_24     = 184,
                PHXK_WORLD_25     = 185,
                PHXK_WORLD_26     = 186,
                PHXK_WORLD_27     = 187,
                PHXK_WORLD_28     = 188,
                PHXK_WORLD_29     = 189,
                PHXK_WORLD_30     = 190,
                PHXK_WORLD_31     = 191,
                PHXK_WORLD_32     = 192,
                PHXK_WORLD_33     = 193,
                PHXK_WORLD_34     = 194,
                PHXK_WORLD_35     = 195,
                PHXK_WORLD_36     = 196,
                PHXK_WORLD_37     = 197,
                PHXK_WORLD_38     = 198,
                PHXK_WORLD_39     = 199,
                PHXK_WORLD_40     = 200,
                PHXK_WORLD_41     = 201,
                PHXK_WORLD_42     = 202,
                PHXK_WORLD_43     = 203,
                PHXK_WORLD_44     = 204,
                PHXK_WORLD_45     = 205,
                PHXK_WORLD_46     = 206,
                PHXK_WORLD_47     = 207,
                PHXK_WORLD_48     = 208,
                PHXK_WORLD_49     = 209,
                PHXK_WORLD_50     = 210,
                PHXK_WORLD_51     = 211,
                PHXK_WORLD_52     = 212,
                PHXK_WORLD_53     = 213,
                PHXK_WORLD_54     = 214,
                PHXK_WORLD_55     = 215,
                PHXK_WORLD_56     = 216,
                PHXK_WORLD_57     = 217,
                PHXK_WORLD_58     = 218,
                PHXK_WORLD_59     = 219,
                PHXK_WORLD_60     = 220,
                PHXK_WORLD_61     = 221,
                PHXK_WORLD_62     = 222,
                PHXK_WORLD_63     = 223,
                PHXK_WORLD_64     = 224,
                PHXK_WORLD_65     = 225,
                PHXK_WORLD_66     = 226,
                PHXK_WORLD_67     = 227,
                PHXK_WORLD_68     = 228,
                PHXK_WORLD_69     = 229,
                PHXK_WORLD_70     = 230,
                PHXK_WORLD_71     = 231,
                PHXK_WORLD_72     = 232,
                PHXK_WORLD_73     = 233,
                PHXK_WORLD_74     = 234,
                PHXK_WORLD_75     = 235,
                PHXK_WORLD_76     = 236,
                PHXK_WORLD_77     = 237,
                PHXK_WORLD_78     = 238,
                PHXK_WORLD_79     = 239,
                PHXK_WORLD_80     = 240,
                PHXK_WORLD_81     = 241,
                PHXK_WORLD_82     = 242,
                PHXK_WORLD_83     = 243,
                PHXK_WORLD_84     = 244,
                PHXK_WORLD_85     = 245,
                PHXK_WORLD_86     = 246,
                PHXK_WORLD_87     = 247,
                PHXK_WORLD_88     = 248,
                PHXK_WORLD_89     = 249,
                PHXK_WORLD_90     = 250,
                PHXK_WORLD_91     = 251,
                PHXK_WORLD_92     = 252,
                PHXK_WORLD_93     = 253,
                PHXK_WORLD_94     = 254,
                PHXK_WORLD_95     = 255, /* 0xFF */

                // Numeric keypad

                PHXK_KP0          = 256,
                PHXK_KP1          = 257,
                PHXK_KP2          = 258,
                PHXK_KP3          = 259,
                PHXK_KP4          = 260,
                PHXK_KP5          = 261,
                PHXK_KP6          = 262,
                PHXK_KP7          = 263,
                PHXK_KP8          = 264,
                PHXK_KP9          = 265,
                PHXK_KP_PERIOD    = 266,
                PHXK_KP_DIVIDE    = 267,
                PHXK_KP_MULTIPLY  = 268,
                PHXK_KP_MINUS     = 269,
                PHXK_KP_PLUS      = 270,
                PHXK_KP_ENTER     = 271,
                PHXK_KP_EQUALS    = 272,

                // Arrows + Home/End pad

                PHXK_UP           = 273,
                PHXK_DOWN         = 274,
                PHXK_RIGHT        = 275,
                PHXK_LEFT         = 276,
                PHXK_INSERT       = 277,
                PHXK_HOME         = 278,
                PHXK_END          = 279,
                PHXK_PAGEUP       = 280,
                PHXK_PAGEDOWN     = 281,

                // Function keys

                PHXK_F1           = 282,
                PHXK_F2           = 283,
                PHXK_F3           = 284,
                PHXK_F4           = 285,
                PHXK_F5           = 286,
                PHXK_F6           = 287,
                PHXK_F7           = 288,
                PHXK_F8           = 289,
                PHXK_F9           = 290,
                PHXK_F10          = 291,
                PHXK_F11          = 292,
                PHXK_F12          = 293,
                PHXK_F13          = 294,
                PHXK_F14          = 295,
                PHXK_F15          = 296,

                // Key state modifier keys

                PHXK_NUMLOCK      = 300,
                PHXK_CAPSLOCK     = 301,
                PHXK_SCROLLOCK    = 302,
                PHXK_RSHIFT       = 303,
                PHXK_LSHIFT       = 304,
                PHXK_RCTRL        = 305,
                PHXK_LCTRL        = 306,
                PHXK_RALT         = 307,
                PHXK_LALT         = 308,
                PHXK_RMETA        = 309,
                PHXK_LMETA        = 310,
                PHXK_LSUPER       = 311, // Left "Windows" key
                PHXK_RSUPER       = 312, // Right "Windows" key
                PHXK_MODE         = 313, // "Alt Gr" key
                PHXK_COMPOSE      = 314, // Multi-key compose key

                // Miscellaneous function keys

                PHXK_HELP         = 315,
                PHXK_PRINT        = 316,
                PHXK_SYSREQ       = 317,
                PHXK_BREAK        = 318,
                PHXK_MENU         = 319,
                PHXK_POWER        = 320, // Power Macintosh power key
                PHXK_EURO         = 321, // Some european keyboards
                PHXK_UNDO         = 322, // Atari keyboard has Undo

                // Add any other keys here
        } PhxKey;
}; // namespace Phx

#endif // !defined( PHXKEYBOARD_H )

---