Skip to content

Commit

Permalink
keysyms: Update using latest xorgproto
Browse files Browse the repository at this point in the history 
This fixes a typo and improves comments.

xorgproto commit: cd33097fc779f280925c6d6bbfbd5150f93ca5bc
Relevant MR: https://gitlab.freedesktop.org/xorg/proto/xorgproto/-/merge_requests/84
  • Loading branch information
@wismill
wismill committed Feb 8, 2024
1 parent dd3e214 commit ed2dc97
Show file tree
Hide file tree
Showing 2 changed files with 357 additions and 324 deletions.
87 changes: 64 additions & 23 deletions include/xkbcommon/xkbcommon-keysyms.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,14 +102,52 @@ SOFTWARE.
* existing legacy keysym values in the range 0x0100 to 0x20ff.
*
* Where several mnemonic names are defined for the same keysym in this
* file, all but the first one listed should be considered deprecated,
* unless the comment explicitly states the alias, e.g.:
* file, the first one listed is considered the "canonical" name. This
* is the name that should be used when retrieving a keysym name from
* its code. The next names are considered "aliases" to the canonical
* name.
*
* Aliases are made explicit by writing in their comment "alias for",
* followed by the corresponding canonical name. Example:
*
* #define XKB_KEY_dead_tilde 0xfe53
* #define XKB_KEY_dead_perispomeni 0xfe53 // alias for dead_tilde
*
* Additionally, a keysym can be explicitly deprecated by starting the
* comment with "deprecated".
* The rules to consider a keysym mnemonic name deprecated are:
*
* 1. A legacy keysym with its Unicode mapping in parentheses is
* deprecated (see above).
*
* 2. A keysym name is *explicitly* deprecated by starting its comment
* with "deprecated". Examples:
*
* #define XKB_KEY_L1 0xffc8 // deprecated alias for F11
* #define XKB_KEY_quoteleft 0x0060 // deprecated
*
* 3. A keysym name is *explicitly* *not* deprecated by starting its
* comment with "non-deprecated alias". Examples:
*
* #define XKB_KEY_dead_tilde 0xfe53
* #define XKB_KEY_dead_perispomeni 0xfe53 // non-deprecated alias for dead_tilde
*
* 4. If none of the previous rules apply, an alias is *implicitly*
* deprecated if there is at least one previous name for the
* corresponding keysym that is *not* explicitly deprecated.
*
* Examples:
*
* // SingleCandidate is the canonical name
* #define XKB_KEY_SingleCandidate 0xff3c
* // Hangul_SingleCandidate is deprecated because it is an alias
* // and it does not start with "non-deprecated alias"
* #define XKB_KEY_Hangul_SingleCandidate 0xff3c // Single candidate
*
* // guillemotleft is the canonical name, but it is deprecated
* #define XKB_KEY_guillemotleft 0x00ab // deprecated alias for guillemetleft (misspelling)
* // guillemetleft is not deprecated, because the keysym has no endorsed name before it.
* #define XKB_KEY_guillemetleft 0x00ab // U+00AB LEFT-POINTING DOUBLE ANGLE QUOTATION MARK
* // The following hypothetical name is deprecated because guillemetleft come before.
* #define XKB_KEY_guillemetleft2 0x00ab
*
* Mnemonic names for keysyms are defined in this file with lines
* that match one of these Perl regular expressions:
Expand Down Expand Up @@ -156,7 +194,10 @@ SOFTWARE.
* e.g. keysyms removals.
*
* Therefore, it is advised to proceed to no removal and to make a new
* name canonical only 10 years after its introduction.
* name canonical only 10 years after its introduction. This means that
* some keysyms may have their first listed name deprecated during the
* period of transition. Once this period is over, the deprecated name
* should be moved after the new canonical name.
*/

#define XKB_KEY_VoidSymbol 0xffffff /* Void symbol */
Expand Down Expand Up @@ -193,7 +234,7 @@ SOFTWARE.
#define XKB_KEY_Kanji 0xff21 /* Kanji, Kanji convert */
#define XKB_KEY_Muhenkan 0xff22 /* Cancel Conversion */
#define XKB_KEY_Henkan_Mode 0xff23 /* Start/Stop Conversion */
#define XKB_KEY_Henkan 0xff23 /* Alias for Henkan_Mode */
#define XKB_KEY_Henkan 0xff23 /* non-deprecated alias for Henkan_Mode */
#define XKB_KEY_Romaji 0xff24 /* to Romaji */
#define XKB_KEY_Hiragana 0xff25 /* to Hiragana */
#define XKB_KEY_Katakana 0xff26 /* to Katakana */
Expand Down Expand Up @@ -242,7 +283,7 @@ SOFTWARE.
#define XKB_KEY_Help 0xff6a /* Help */
#define XKB_KEY_Break 0xff6b
#define XKB_KEY_Mode_switch 0xff7e /* Character set switch */
#define XKB_KEY_script_switch 0xff7e /* Alias for Mode_switch */
#define XKB_KEY_script_switch 0xff7e /* non-deprecated alias for Mode_switch */
#define XKB_KEY_Num_Lock 0xff7f

/* Keypad functions, keypad numbers cleverly chosen to map to ASCII */
Expand Down Expand Up @@ -388,7 +429,7 @@ SOFTWARE.
#define XKB_KEY_ISO_Level5_Shift 0xfe11
#define XKB_KEY_ISO_Level5_Latch 0xfe12
#define XKB_KEY_ISO_Level5_Lock 0xfe13
#define XKB_KEY_ISO_Group_Shift 0xff7e /* Alias for Mode_switch */
#define XKB_KEY_ISO_Group_Shift 0xff7e /* non-deprecated alias for Mode_switch */
#define XKB_KEY_ISO_Group_Latch 0xfe06
#define XKB_KEY_ISO_Group_Lock 0xfe07
#define XKB_KEY_ISO_Next_Group 0xfe08
Expand Down Expand Up @@ -426,7 +467,7 @@ SOFTWARE.
#define XKB_KEY_dead_acute 0xfe51
#define XKB_KEY_dead_circumflex 0xfe52
#define XKB_KEY_dead_tilde 0xfe53
#define XKB_KEY_dead_perispomeni 0xfe53 /* alias for dead_tilde */
#define XKB_KEY_dead_perispomeni 0xfe53 /* non-deprecated alias for dead_tilde */
#define XKB_KEY_dead_macron 0xfe54
#define XKB_KEY_dead_breve 0xfe55
#define XKB_KEY_dead_abovedot 0xfe56
Expand All @@ -444,9 +485,9 @@ SOFTWARE.
#define XKB_KEY_dead_horn 0xfe62
#define XKB_KEY_dead_stroke 0xfe63
#define XKB_KEY_dead_abovecomma 0xfe64
#define XKB_KEY_dead_psili 0xfe64 /* alias for dead_abovecomma */
#define XKB_KEY_dead_psili 0xfe64 /* non-deprecated alias for dead_abovecomma */
#define XKB_KEY_dead_abovereversedcomma 0xfe65
#define XKB_KEY_dead_dasia 0xfe65 /* alias for dead_abovereversedcomma */
#define XKB_KEY_dead_dasia 0xfe65 /* non-deprecated alias for dead_abovereversedcomma */
#define XKB_KEY_dead_doublegrave 0xfe66
#define XKB_KEY_dead_belowring 0xfe67
#define XKB_KEY_dead_belowmacron 0xfe68
Expand Down Expand Up @@ -475,9 +516,9 @@ SOFTWARE.
#define XKB_KEY_dead_O 0xfe87
#define XKB_KEY_dead_u 0xfe88
#define XKB_KEY_dead_U 0xfe89
#define XKB_KEY_dead_small_schwa 0xfe8a /* deprecated, use dead_schwa instead */
#define XKB_KEY_dead_capital_schwa 0xfe8b /* deprecated, use dead_SCHWA instead */
#define XKB_KEY_dead_small_schwa 0xfe8a /* deprecated alias for dead_schwa */
#define XKB_KEY_dead_schwa 0xfe8a
#define XKB_KEY_dead_capital_schwa 0xfe8b /* deprecated alias for dead_SCHWA */
#define XKB_KEY_dead_SCHWA 0xfe8b

#define XKB_KEY_dead_greek 0xfe8c
Expand Down Expand Up @@ -693,7 +734,7 @@ SOFTWARE.
#define XKB_KEY_diaeresis 0x00a8 /* U+00A8 DIAERESIS */
#define XKB_KEY_copyright 0x00a9 /* U+00A9 COPYRIGHT SIGN */
#define XKB_KEY_ordfeminine 0x00aa /* U+00AA FEMININE ORDINAL INDICATOR */
#define XKB_KEY_guillemotleft 0x00ab /* deprecated misspelling. Use guillemetleft instead. */
#define XKB_KEY_guillemotleft 0x00ab /* deprecated alias for guillemetleft (misspelling) */
#define XKB_KEY_guillemetleft 0x00ab /* U+00AB LEFT-POINTING DOUBLE ANGLE QUOTATION MARK */
#define XKB_KEY_notsign 0x00ac /* U+00AC NOT SIGN */
#define XKB_KEY_hyphen 0x00ad /* U+00AD SOFT HYPHEN */
Expand All @@ -709,9 +750,9 @@ SOFTWARE.
#define XKB_KEY_periodcentered 0x00b7 /* U+00B7 MIDDLE DOT */
#define XKB_KEY_cedilla 0x00b8 /* U+00B8 CEDILLA */
#define XKB_KEY_onesuperior 0x00b9 /* U+00B9 SUPERSCRIPT ONE */
#define XKB_KEY_masculine 0x00ba /* deprecated inconsistent name (see ordfeminine), use ordmasculine instead */
#define XKB_KEY_masculine 0x00ba /* deprecated alias for ordmasculine (inconsistent name) */
#define XKB_KEY_ordmasculine 0x00ba /* U+00BA MASCULINE ORDINAL INDICATOR */
#define XKB_KEY_guillemotright 0x00bb /* deprecated misspelling. Use guillemotright instead. */
#define XKB_KEY_guillemotright 0x00bb /* deprecated alias for guillemetright (misspelling) */
#define XKB_KEY_guillemetright 0x00bb /* U+00BB RIGHT-POINTING DOUBLE ANGLE QUOTATION MARK */
#define XKB_KEY_onequarter 0x00bc /* U+00BC VULGAR FRACTION ONE QUARTER */
#define XKB_KEY_onehalf 0x00bd /* U+00BD VULGAR FRACTION ONE HALF */
Expand Down Expand Up @@ -1033,7 +1074,7 @@ SOFTWARE.
#define XKB_KEY_kana_N 0x04dd /* U+30F3 KATAKANA LETTER N */
#define XKB_KEY_voicedsound 0x04de /* U+309B KATAKANA-HIRAGANA VOICED SOUND MARK */
#define XKB_KEY_semivoicedsound 0x04df /* U+309C KATAKANA-HIRAGANA SEMI-VOICED SOUND MARK */
#define XKB_KEY_kana_switch 0xff7e /* Alias for Mode_switch */
#define XKB_KEY_kana_switch 0xff7e /* non-deprecated alias for Mode_switch */

/*
* Arabic
Expand Down Expand Up @@ -1130,7 +1171,7 @@ SOFTWARE.
#define XKB_KEY_Arabic_farsi_yeh 0x10006cc /* deprecated alias for Farsi_yeh */
#define XKB_KEY_Arabic_yeh_baree 0x10006d2 /* U+06D2 ARABIC LETTER YEH BARREE */
#define XKB_KEY_Arabic_heh_goal 0x10006c1 /* U+06C1 ARABIC LETTER HEH GOAL */
#define XKB_KEY_Arabic_switch 0xff7e /* Alias for Mode_switch */
#define XKB_KEY_Arabic_switch 0xff7e /* non-deprecated alias for Mode_switch */

/*
* Cyrillic
Expand Down Expand Up @@ -1318,7 +1359,7 @@ SOFTWARE.
#define XKB_KEY_Greek_IOTA 0x07c9 /* U+0399 GREEK CAPITAL LETTER IOTA */
#define XKB_KEY_Greek_KAPPA 0x07ca /* U+039A GREEK CAPITAL LETTER KAPPA */
#define XKB_KEY_Greek_LAMDA 0x07cb /* U+039B GREEK CAPITAL LETTER LAMDA */
#define XKB_KEY_Greek_LAMBDA 0x07cb /* alias for Greek_LAMDA */
#define XKB_KEY_Greek_LAMBDA 0x07cb /* non-deprecated alias for Greek_LAMDA */
#define XKB_KEY_Greek_MU 0x07cc /* U+039C GREEK CAPITAL LETTER MU */
#define XKB_KEY_Greek_NU 0x07cd /* U+039D GREEK CAPITAL LETTER NU */
#define XKB_KEY_Greek_XI 0x07ce /* U+039E GREEK CAPITAL LETTER XI */
Expand All @@ -1343,7 +1384,7 @@ SOFTWARE.
#define XKB_KEY_Greek_iota 0x07e9 /* U+03B9 GREEK SMALL LETTER IOTA */
#define XKB_KEY_Greek_kappa 0x07ea /* U+03BA GREEK SMALL LETTER KAPPA */
#define XKB_KEY_Greek_lamda 0x07eb /* U+03BB GREEK SMALL LETTER LAMDA */
#define XKB_KEY_Greek_lambda 0x07eb /* alias for Greek_lamda */
#define XKB_KEY_Greek_lambda 0x07eb /* non-deprecated alias for Greek_lamda */
#define XKB_KEY_Greek_mu 0x07ec /* U+03BC GREEK SMALL LETTER MU */
#define XKB_KEY_Greek_nu 0x07ed /* U+03BD GREEK SMALL LETTER NU */
#define XKB_KEY_Greek_xi 0x07ee /* U+03BE GREEK SMALL LETTER XI */
Expand All @@ -1358,7 +1399,7 @@ SOFTWARE.
#define XKB_KEY_Greek_chi 0x07f7 /* U+03C7 GREEK SMALL LETTER CHI */
#define XKB_KEY_Greek_psi 0x07f8 /* U+03C8 GREEK SMALL LETTER PSI */
#define XKB_KEY_Greek_omega 0x07f9 /* U+03C9 GREEK SMALL LETTER OMEGA */
#define XKB_KEY_Greek_switch 0xff7e /* Alias for Mode_switch */
#define XKB_KEY_Greek_switch 0xff7e /* non-deprecated alias for Mode_switch */

/*
* Technical
Expand Down Expand Up @@ -1608,7 +1649,7 @@ SOFTWARE.
#define XKB_KEY_hebrew_shin 0x0cf9 /* U+05E9 HEBREW LETTER SHIN */
#define XKB_KEY_hebrew_taw 0x0cfa /* U+05EA HEBREW LETTER TAV */
#define XKB_KEY_hebrew_taf 0x0cfa /* deprecated */
#define XKB_KEY_Hebrew_switch 0xff7e /* Alias for Mode_switch */
#define XKB_KEY_Hebrew_switch 0xff7e /* non-deprecated alias for Mode_switch */

/*
* Thai
Expand Down Expand Up @@ -1721,7 +1762,7 @@ SOFTWARE.
#define XKB_KEY_Hangul_MultipleCandidate 0xff3d /* Multiple candidate */
#define XKB_KEY_Hangul_PreviousCandidate 0xff3e /* Previous candidate */
#define XKB_KEY_Hangul_Special 0xff3f /* Special symbols */
#define XKB_KEY_Hangul_switch 0xff7e /* Alias for Mode_switch */
#define XKB_KEY_Hangul_switch 0xff7e /* non-deprecated alias for Mode_switch */

/* Hangul Consonant Characters */
#define XKB_KEY_Hangul_Kiyeog 0x0ea1 /* U+3131 HANGUL LETTER KIYEOK */
Expand Down
Loading

0 comments on commit ed2dc97

Please sign in to comment.