drashna/qmk_firmware
1
0
Fork 0
Code Activity Actions

Improve consistency in UNICODEMAP code and docs, update docs/understanding_qmk (#4774)

Browse source 
* Remove unused UNICODE(n) macro, update docs

* Add note about max length of unicode_map to docs

* QK_UNICODE_MAP → QK_UNICODEMAP

* Refactor process_unicode_map

* process_unicode_map → process_unicodemap

This is done for consistency: UNICODEMAP is the method (hence UNICODEMAP_ENABLE, process_unicodemap), whereas unicode_map is the mapping table itself.

* Update references and ordering in docs/understanding_qmk

* Add additional note to docs/understanding_qmk

* &unicode_map[index] → unicode_map + index

This avoids the issue of the compiler sometimes complaining about the array index being out of range

* Update docs/getting_started_make_guide

* Update method sections in docs/feature_unicode
This commit is contained in:
Konstantin Đorđević 2019-01-07 21:56:57 +01:00 • committed by Drashna Jaelre
parent 6e984a8b5e
commit cd9262d7b2
8 changed files with 88 additions and 93 deletions
Download patch file Download diff file Expand all files Collapse all files

15
quantum/quantum_keycodes.h
View file

@ -86,8 +86,8 @@ enum quantum_keycodes {
QK_UNICODE_MAX = 0xFFFF,
#endif
#ifdef UNICODEMAP_ENABLE
QK_UNICODE_MAP = 0x8000,
QK_UNICODE_MAP_MAX = 0x83FF,
QK_UNICODEMAP = 0x8000,
QK_UNICODEMAP_MAX = 0x83FF,
#endif
// Loose keycodes - to be used directly
@ -679,15 +679,12 @@ enum quantum_keycodes {
#define KC_MEH MEH(KC_NO)
#ifdef UNICODE_ENABLE
// For sending unicode codes.
// You may not send codes over 7FFF -- this supports most of UTF8.
// To have a key that sends out Œ, go UC(0x0152)
#define UNICODE(n) (QK_UNICODE | (n))
#define UC(n) UNICODE(n)
// Allows Unicode input up to 0x7FFF
#define UC(c) (QK_UNICODE | (c))
#endif
#ifdef UNICODEMAP_ENABLE
#define X(n) (QK_UNICODE_MAP | (n))
// Allows Unicode input up to 0x10FFFF, requires unicode_map
#define X(i) (QK_UNICODEMAP | (i))
#endif
#define UC_MOD UNICODE_MODE_FORWARD