keyboard--short-names.h

00001 /* ----------------------------------------------------------------------------
00002  * USB Keyboard Key Codes : short names
00003  *
00004  * These are for convenience (and to help with formatting, keeping stuff from
00005  * getting too long).  See "keyboard-usage-page.h" for definitions and
00006  * everything.
00007  * ----------------------------------------------------------------------------
00008  * Copyright (c) 2012 Ben Blazak <benblazak.dev@gmail.com>
00009  * Released under The MIT License (MIT) (see "license.md")
00010  * Project located at <https://github.com/benblazak/ergodox-firmware>
00011  * ------------------------------------------------------------------------- */
00012 
00013 
00014 #ifndef USB_USAGE_PAGE_KEYBOARD_SHORT_NAMES_h
00015     #define USB_USAGE_PAGE_KEYBOARD_SHORT_NAMES_h
00016 // ----------------------------------------------------------------------------
00017 // ----------------------------------------------------------------------------
00018 
00019 
00020 #include "./keyboard.h"
00021 
00022 
00023 // ----------------------------------------------------------------------------
00024 // protocol
00025 // ----------------------------------------------------------------------------
00026 
00027 // error
00028 #define _ErrRollover        KEY_ErrorRollOver
00029 #define _PostFail           KEY_POSTFail
00030 #define _ErrUndef           KEY_ErrorUndefined
00031 
00032 
00033 // ----------------------------------------------------------------------------
00034 // main keyboard
00035 // ----------------------------------------------------------------------------
00036 
00037 // letters
00038 #define _A                  KEY_a_A
00039 #define _B                  KEY_b_B
00040 #define _C                  KEY_c_C
00041 #define _D                  KEY_d_D
00042 #define _E                  KEY_e_E
00043 #define _F                  KEY_f_F
00044 #define _G                  KEY_g_G
00045 #define _H                  KEY_h_H
00046 #define _I                  KEY_i_I
00047 #define _J                  KEY_j_J
00048 #define _K                  KEY_k_K
00049 #define _L                  KEY_l_L
00050 #define _M                  KEY_m_M
00051 #define _N                  KEY_n_N
00052 #define _O                  KEY_o_O
00053 #define _P                  KEY_p_P
00054 #define _Q                  KEY_q_Q
00055 #define _R                  KEY_r_R
00056 #define _S                  KEY_s_S
00057 #define _T                  KEY_t_T
00058 #define _U                  KEY_u_U
00059 #define _V                  KEY_v_V
00060 #define _W                  KEY_w_W
00061 #define _X                  KEY_x_X
00062 #define _Y                  KEY_y_Y
00063 #define _Z                  KEY_z_Z
00064 
00065 // numbers
00066 #define _0                  KEY_0_RightParenthesis
00067 #define _1                  KEY_1_Exclamation
00068 #define _2                  KEY_2_At
00069 #define _3                  KEY_3_Pound
00070 #define _4                  KEY_4_Dollar
00071 #define _5                  KEY_5_Percent
00072 #define _6                  KEY_6_Caret
00073 #define _7                  KEY_7_Ampersand
00074 #define _8                  KEY_8_Asterisk
00075 #define _9                  KEY_9_LeftParenthesis
00076 
00077 // function
00078 #define _F1                 KEY_F1
00079 #define _F2                 KEY_F2
00080 #define _F3                 KEY_F3
00081 #define _F4                 KEY_F4
00082 #define _F5                 KEY_F5
00083 #define _F6                 KEY_F6
00084 #define _F7                 KEY_F7
00085 #define _F8                 KEY_F8
00086 #define _F9                 KEY_F9
00087 #define _F10                KEY_F10
00088 #define _F11                KEY_F11
00089 #define _F12                KEY_F12
00090 #define _F13                KEY_F13
00091 #define _F14                KEY_F14
00092 #define _F15                KEY_F15
00093 #define _F16                KEY_F16
00094 #define _F17                KEY_F17
00095 #define _F18                KEY_F18
00096 #define _F19                KEY_F19
00097 #define _F20                KEY_F20
00098 #define _F21                KEY_F21
00099 #define _F22                KEY_F22
00100 #define _F23                KEY_F23
00101 #define _F24                KEY_F24
00102 
00103 // whitespace and symbols
00104 #define _enter              KEY_ReturnEnter
00105 #define _space              KEY_Spacebar
00106 #define _tab                KEY_Tab
00107 // ---
00108 #define _backslash          KEY_Backslash_Pipe
00109 #define _bracketL           KEY_LeftBracket_LeftBrace
00110 #define _bracketR           KEY_RightBracket_RightBrace
00111 #define _comma              KEY_Comma_LessThan
00112 #define _dash               KEY_Dash_Underscore
00113 #define _equal              KEY_Equal_Plus
00114 #define _grave              KEY_GraveAccent_Tilde
00115 #define _period             KEY_Period_GreaterThan
00116 #define _quote              KEY_SingleQuote_DoubleQuote
00117 #define _semicolon          KEY_Semicolon_Colon
00118 #define _slash              KEY_Slash_Question
00119 // ---
00120 #define _sep_dec            KEY_DecimalSeparator
00121 #define _sep_thousands      KEY_ThousandsSeparator
00122 #define _currencyUnit       KEY_CurrencyUnit
00123 #define _currencySubunit    KEY_CurrencySubunit
00124 
00125 // international and language
00126 #define _int1               KEY_International1
00127 #define _int2               KEY_International2
00128 #define _int3               KEY_International3
00129 #define _int4               KEY_International4
00130 #define _int5               KEY_International5
00131 #define _int6               KEY_International6
00132 #define _int7               KEY_International7
00133 #define _int8               KEY_International8
00134 #define _int9               KEY_International9
00135 // ---
00136 #define _lang1              KEY_LANG1
00137 #define _lang2              KEY_LANG2
00138 #define _lang3              KEY_LANG3
00139 #define _lang4              KEY_LANG4
00140 #define _lang5              KEY_LANG5
00141 #define _lang6              KEY_LANG6
00142 #define _lang7              KEY_LANG7
00143 #define _lang8              KEY_LANG8
00144 #define _lang9              KEY_LANG9
00145 // ---
00146 #define _backslash_nonUS    KEY_NonUS_Backslash_Pipe
00147 #define _pound_nonUS        KEY_NonUS_Pound_Tilde
00148 
00149 // text control
00150 #define _bs                 KEY_DeleteBackspace
00151 #define _del                KEY_DeleteForward
00152 #define _home               KEY_Home
00153 #define _end                KEY_End
00154 #define _pageU              KEY_PageUp
00155 #define _pageD              KEY_PageDown
00156 #define _arrowU             KEY_UpArrow
00157 #define _arrowD             KEY_DownArrow
00158 #define _arrowL             KEY_LeftArrow
00159 #define _arrowR             KEY_RightArrow
00160 #define _esc                KEY_Escape
00161 #define _insert             KEY_Insert
00162 
00163 // modifier
00164 #define _altL               KEY_LeftAlt
00165 #define _altR               KEY_RightAlt
00166 #define _ctrlL              KEY_LeftControl
00167 #define _ctrlR              KEY_RightControl
00168 #define _guiL               KEY_LeftGUI
00169 #define _guiR               KEY_RightGUI
00170 #define _shiftL             KEY_LeftShift
00171 #define _shiftR             KEY_RightShift
00172 
00173 // lock
00174 #define _capsLock           KEY_CapsLock
00175 #define _scrollLock         KEY_ScrollLock
00176 // (numlock is under keypad)
00177 // --- not generally used
00178 #define _capsLock_locking   KEY_LockingCapsLock
00179 #define _numLock_locking    KEY_LockingNumLock
00180 #define _scrollLock_locking KEY_LockingScrollLock
00181 
00182 // special function
00183 #define _pause              KEY_Pause
00184 #define _print              KEY_PrintScreen
00185 // ---
00186 #define _application        KEY_Application
00187 #define _execute            KEY_Execute
00188 #define _power              KEY_Power
00189 // ---
00190 #define _help               KEY_Help
00191 #define _menu               KEY_Menu
00192 // ---
00193 #define _cut                KEY_Cut
00194 #define _copy               KEY_Copy
00195 #define _paste              KEY_Paste
00196 #define _find               KEY_Find
00197 #define _select             KEY_Select
00198 #define _stop               KEY_Stop
00199 #define _undo               KEY_Undo
00200 // ---
00201 #define _mute               KEY_Mute
00202 #define _volumeU            KEY_VolumeUp
00203 #define _volumeD            KEY_VolumeDown
00204 // ---
00205 #define _altErase           KEY_AlternateErase
00206 // ---
00207 #define _again              KEY_Again
00208 #define _cancel             KEY_Cancel
00209 #define _clear_again        KEY_Clear_Again
00210 #define _clear              KEY_Clear
00211 #define _oper               KEY_Oper
00212 #define _out                KEY_Out
00213 #define _prior              KEY_Prior
00214 #define _return             KEY_Return
00215 #define _separator          KEY_Separator
00216 // ---
00217 #define _crSel              KEY_CrSel_Props
00218 #define _exSel              KEY_ExSel
00219 #define _sysReq             KEY_SysReq_Attention
00220 
00221 
00222 // ----------------------------------------------------------------------------
00223 // keypad
00224 // ----------------------------------------------------------------------------
00225 
00226 // numbers and hex letters
00227 #define _1_kp               KEYPAD_1_End
00228 #define _2_kp               KEYPAD_2_DownArrow
00229 #define _3_kp               KEYPAD_3_PageDown
00230 #define _4_kp               KEYPAD_4_LeftArrow
00231 #define _5_kp               KEYPAD_5
00232 #define _6_kp               KEYPAD_6_RightArrow
00233 #define _7_kp               KEYPAD_7_Home
00234 #define _8_kp               KEYPAD_8_UpArrow
00235 #define _9_kp               KEYPAD_9_PageUp
00236 #define _0_kp               KEYPAD_0_Insert
00237 #define _A_kp               KEYPAD_A
00238 #define _B_kp               KEYPAD_B
00239 #define _C_kp               KEYPAD_C
00240 #define _D_kp               KEYPAD_D
00241 #define _E_kp               KEYPAD_E
00242 #define _F_kp               KEYPAD_F
00243 // ---
00244 #define _00_kp              KEYPAD_00
00245 #define _000_kp             KEYPAD_000
00246 
00247 // whitespace and symbols
00248 #define _tab_kp             KEYPAD_Tab
00249 #define _space_kp           KEYPAD_Space
00250 #define _enter_kp           KEYPAD_ENTER
00251 // ---
00252 #define _dec_del_kp         KEYPAD_Period_Delete
00253 #define _comma_kp           KEYPAD_Comma
00254 #define _equal_kp           KEYPAD_Equal
00255 #define _equalSign_kp       KEYPAD_EqualSign
00256 #define _parenL_kp          KEYPAD_LeftParenthesis
00257 #define _parenR_kp          KEYPAD_RightParenthesis
00258 #define _braceL_kp          KEYPAD_LeftBrace
00259 #define _braceR_kp          KEYPAD_RightBrace
00260 
00261 // operations
00262 // --- basic
00263 #define _add_kp             KEYPAD_Plus
00264 #define _sub_kp             KEYPAD_Minus
00265 #define _mul_kp             KEYPAD_Asterisk
00266 #define _div_kp             KEYPAD_Slash
00267 #define _plusMinus_kp       KEYPAD_PlusMinus
00268 // --- logical
00269 #define _lt_kp              KEYPAD_LessThan
00270 #define _gt_kp              KEYPAD_GreaterThan
00271 #define _xor_kp             KEYPAD_XOR
00272 #define _and_kp             KEYPAD_Ampersand
00273 #define _andand_kp          KEYPAD_AmpersandAmpersand
00274 #define _pipe_kp            KEYPAD_Pipe
00275 #define _pipepipe_kp        KEYPAD_PipePipe
00276 #define _caret_kp           KEYPAD_Caret
00277 #define _exclamation_kp     KEYPAD_Exclamation
00278 // --- other
00279 #define _at_kp              KEYPAD_At
00280 #define _colon_kp           KEYPAD_Colon
00281 #define _percent_kp         KEYPAD_Percent
00282 #define _pound_kp           KEYPAD_Pound
00283 
00284 // radix
00285 #define _bin_kp             KEYPAD_Binary
00286 #define _oct_kp             KEYPAD_Octal
00287 #define _dec_kp             KEYPAD_Decimal
00288 #define _hex_kp             KEYPAD_Hexadecimal
00289 
00290 // text control
00291 #define _bs_kp              KEYPAD_Backspace
00292 #define _clear_kp           KEYPAD_Clear
00293 #define _clearEntry_kp      KEYPAD_ClearEntry
00294 
00295 // lock
00296 #define _numLock_kp         KEYPAD_NumLock_Clear
00297 
00298 // memory control
00299 #define _memStore_kp        KEYPAD_MemoryStore
00300 #define _memRecall_kp       KEYPAD_MemoryRecall
00301 #define _memClear_kp        KEYPAD_MemoryClear
00302 #define _memAdd_kp          KEYPAD_MemoryAdd
00303 #define _memSub_kp          KEYPAD_MemorySubtract
00304 #define _memMul_kp          KEYPAD_MemoryMultiply
00305 #define _memDiv_kp          KEYPAD_MemoryDivide
00306 
00307 
00308 // ----------------------------------------------------------------------------
00309 // ----------------------------------------------------------------------------
00310 #endif
00311