Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Format unicode_common #13

Merged
merged 12 commits into from
Nov 3, 2018
Merged

Format unicode_common #13

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
ae25652
case alignment
vomindoraan Nov 3, 2018
bcafc3b
process_record_unicode_common → process_unicode_common
vomindoraan Nov 3, 2018
e6d9692
Move song arrays into function where they're used, align preprocessor…
vomindoraan Nov 3, 2018
871169a
Swap the order of UC_WIN and UC_BSD
vomindoraan Nov 3, 2018
415d12a
Update Unicode docs
vomindoraan Nov 3, 2018
fdded5c
Reorder Unicode mode stuff to match the order of input mode constants
vomindoraan Nov 3, 2018
09dbc0c
Merge remote-tracking branch 'drashna/make_unicode_init' into format_…
vomindoraan Nov 3, 2018
3e22b6a
Fix capitalization in doc subtitle
vomindoraan Nov 3, 2018
2c9cfc4
Readd BSD and OSX_RALT songs
vomindoraan Nov 3, 2018
3f7cd36
Reword BSD note in docs
vomindoraan Nov 3, 2018
b55f059
Readd BSD keycode description
vomindoraan Nov 3, 2018
408ec5f
Reword explanation of input on different platforms
vomindoraan Nov 3, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 32 additions & 36 deletions docs/feature_unicode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Unicode Support

There are three Unicode keymap definition method available in QMK:
There are three Unicode keymap definition methods available in QMK:

## UNICODE_ENABLE

Expand All @@ -14,15 +14,15 @@ And you may want to have an enum to make reference easier. So you'd want to add

```c
enum unicode_names {
BANG, // ‽
IRONY, // ⸮
SNEK // snke 🐍
BANG,
IRONY,
SNEK,
};

const uint32_t PROGMEM unicode_map[] = {
[BANG] = 0x0203D, // ‽
[IRONY] = 0x02E2E, // ⸮
[SNEK] = 0x1F40D // snke 🐍
[BANG] = 0x203D, // ‽
[IRONY] = 0x2E2E, // ⸮
[SNEK] = 0x1F40D, // 🐍
vomindoraan marked this conversation as resolved.
Show resolved Hide resolved
}:
```

Expand Down Expand Up @@ -77,18 +77,9 @@ void qk_ucis_symbol_fallback (void) { // falls back to manual unicode entry

## Input Modes

Unicode input in QMK works by inputting a sequence of characters to the OS, sort of like a macro. Unfortunately, each OS has different ideas on how Unicode is input. Specifically, each OS has one (or more) key sequences that it requires to input unicode characters.
Unicode input in QMK works by inputting a sequence of characters to the OS, sort of like a macro. Unfortunately, the way this is done differs for each platform. Specifically, each platform has a key sequence that it requires to input Unicode characters. Therefore, a corresponding input mode has to be set in QMK.
vomindoraan marked this conversation as resolved.
Show resolved Hide resolved

There are two ways to set the input mode for Unicode, by keycode or by function.

Keep in mind that both methods write to persistant storage (EEPROM), and are loaded each time the keyboard starts. So once you've set it once, you do not need to set it again unless you need to change it or you've reset the EEPROM settings.

!> There are options for BSD here, but it is not implemented at this time. If you use BSD and want to help in adding support for this, please [open an issue on GitHub](https://github.com/qmk/qmk_firmware/issues)


### Functions

You can also switch the input mode by calling `set_unicode_input_mode(x)` in your code, and this works the same way as the keycodes below.
The following input modes are available:

* __UC_OSX__: MacOS Unicode Hex Input support. Works only up to 0xFFFF. Disabled by default. To enable: go to System Preferences -> Keyboard -> Input Sources, and enable Unicode Hex.
* __UC_OSX_RALT__: Same as UC_OSX, but sends the Right Alt key for unicode input
Expand All @@ -97,41 +88,46 @@ You can also switch the input mode by calling `set_unicode_input_mode(x)` in you
* __UC_WIN__: (not recommended) Windows built-in Unicode input. To enable: create registry key under `HKEY_CURRENT_USER\Control Panel\Input Method\EnableHexNumpad` of type `REG_SZ` called `EnableHexNumpad`, set its value to 1, and reboot. This method is not recommended because of reliability and compatibility issue, use WinCompose method below instead.
* __UC_WINC__: Windows Unicode input using WinCompose. Requires [WinCompose](https://github.com/samhocevar/wincompose). Works reliably under many (all?) variations of Windows.

### Keycodes
!> There is an input mode option for BSD, but it's not currently implemented. If you use BSD and would like support for this, please [open an issue on GitHub](https://github.com/qmk/qmk_firmware/issues).
vomindoraan marked this conversation as resolved.
Show resolved Hide resolved

### Switching input modes
vomindoraan marked this conversation as resolved.
Show resolved Hide resolved

|Key |Aliases |Input Method |Description |
|--------------------------|---------|--------------|---------------------------------------------------|
|`UNICODE_MODE_OSX` |`UC_M_OS`|`UC_OSX` |Sets the input method for MacOS X |
|`UNICODE_MODE_LNX` |`UC_M_LN`|`UC_LNX` |Sets the input method for Linux |
|`UNICODE_MODE_BSD` |`UC_M_BS`|`UC_BSD` |Sets the input method for BSD (Non-Operational) |
vomindoraan marked this conversation as resolved.
Show resolved Hide resolved
|`UNICODE_MODE_WIN` |`UC_M_WI`|`UC_WIN` |Sets the input method for Windows |
|`UNICODE_MODE_WINC` |`UC_M_WC`|`UC_WINC` |Sets the input method for Windows using WinCompose |
|`UNICODE_MODE_OSX_RALT` |`UC_M_OR`|`UC_OSX_RALT` |Sets the input method for MacOS X using RAlt/AltGr |
### Audio Feedback for Input Mode keycodes
There are two ways to set the input mode for Unicode: by keycode or by function. Keep in mind that both methods write to persistent storage (EEPROM), and are loaded each time the keyboard starts. So once you've set it once, you don't need to set it again unless you want to change it, or you've reset the EEPROM settings.

You can switch the input mode at any time by using one of the following keycodes. The easiest way is to add the ones you use to your keymap.

|Keycode |Alias |Input mode |Description |
|-----------------------|---------|-------------|-----------------------------------------|
|`UNICODE_MODE_OSX` |`UC_M_OS`|`UC_OSX` |Switch to Mac OS X input. |
|`UNICODE_MODE_LNX` |`UC_M_LN`|`UC_LNX` |Switch to Linux input. |
|`UNICODE_MODE_WIN` |`UC_M_WI`|`UC_WIN` |Switch to Windows input. |
vomindoraan marked this conversation as resolved.
Show resolved Hide resolved
|`UNICODE_MODE_WINC` |`UC_M_WC`|`UC_WINC` |Switch to Windows input using WinCompose.|
|`UNICODE_MODE_OSX_RALT`|`UC_M_OR`|`UC_OSX_RALT`|Switch to Mac OS X input using Right Alt.|

You can also switch the input mode by calling `set_unicode_input_mode(x)` in your code, and this works the same way as the above keycodes.

### Audio Feedback

If you have the [Audio feature](feature_audio.md) enabled on the board, you can set melodies to be played when you press the above keys. That way you can have some audio feedback when switching input modes.

For instance, you can add these to your `config.h` file.
For instance, you can add these definitions to your `config.h` file:

```c
#define UNICODE_SONG_OSX COIN_SOUND
#define UNICODE_SONG_LNX UNICODE_LINUX
#define UNICODE_SONG_BSD MARIO_GAMEOVER
vomindoraan marked this conversation as resolved.
Show resolved Hide resolved
#define UNICODE_SONG_WIN UNICODE_WINDOWS
#define UNICODE_SONG_WINC UNICODE_WINDOWS
#define UNICODE_SONG_OSX_RALT COIN_SOUND
```

### Unicode Input Method Customization
### Additional Customization

The "start" and "finish" functions for unicode method can be customized locally. A great use for this is to customize the input methods if you don't use the default keys. Or to add visual, or audio feedback when inputting unicode characters.
The functions for starting and finishing Unicode input on your platform can be overridden locally. Possible uses include customizing input mode behavior if you don't use the default keys, or adding extra visual/audio feedback to Unicode input.

* `void unicode_input_start(void)` - This sends the initial sequence that tells your platform to enter Unicode input mode. For example, it presses Ctrl+Shift+U on Linux and holds the Option key on Mac.
* `void unicode_input_finish (void)` - his is called to exit Unicode input mode, for example by pressing Space or releasing the Option key.
* `void unicode_input_start(void)` – This sends the initial sequence that tells your platform to enter Unicode input mode. For example, it presses Ctrl+Shift+U on Linux and holds the Option key on Mac.
* `void unicode_input_finish(void)` – This is called to exit Unicode input mode, for example by pressing Space or releasing the Option key.

You can find the default implementations of these functions in [`process_unicode_common.c`](https://github.com/qmk/qmk_firmware/blob/master/quantum/process_keycode/process_unicode_common.c).


## `send_unicode_hex_string`

To type multiple characters for things like (ノಠ痊ಠ)ノ彡┻━┻, you can use `send_unicode_hex_string()` much like `SEND_STRING()` except you would use hex values separate by spaces.
Expand Down
134 changes: 59 additions & 75 deletions quantum/process_keycode/process_unicode_common.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,27 +21,6 @@

unicode_config_t unicode_config;
static uint8_t saved_mods;
#ifdef AUDIO_ENABLE
#ifdef UNICODE_SONG_OSX
float osx_song[][2] = UNICODE_SONG_OSX;
#endif
#ifdef UNICODE_SONG_LNX
float song_lnx[][2] = UNICODE_SONG_LNX;
#endif
#ifdef UNICODE_SONG_WIN
float windows_song[][2] = UNICODE_SONG_WIN;
#endif
#ifdef UNICODE_SONG_BSD
float song_bsd[][2] = UNICODE_SONG_BSD;
#endif
#ifdef UNICODE_SONG_WINC
float win_compose_song[][2] = UNICODE_SONG_WINC;
#endif
#ifdef UNICODE_SONG_OSX_RALT
float osx_ralt_song[][2] = UNICODE_SONG_OSX_RALT;
#endif
#endif


void set_unicode_input_mode(uint8_t os_target) {
unicode_config.input_mode = os_target;
Expand Down Expand Up @@ -92,16 +71,16 @@ void unicode_input_start(void) {
__attribute__((weak))
void unicode_input_finish(void) {
switch (unicode_config.input_mode) {
case UC_OSX:
case UC_WIN:
unregister_code(KC_LALT);
break;
case UC_OSX_RALT:
unregister_code(KC_RALT);
break;
case UC_LNX:
tap_code(KC_SPC);
break;
case UC_OSX:
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know this is proper, but I hate it because of the readability (lack thereof)

Copy link
Author

@vomindoraan vomindoraan Nov 3, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(Assuming you're referring to the case indentation) I actually disagree 😄 In QMK's case we have 2-space indents, but in projects where indentation is the standard 4 spaces or a tab, the extra indentation from cases (which bears no semantic meaning, as cases are just jump labels) can harm readability by adding another indentation level and shifting code horizontally.

To quote Linus Torvalds: “If you need more than 3 levels of indentation, you're screwed anyway, and should fix your program.”
And I'd rather not waste one of those levels on case labels 😄

But regardless of what we agree to go with, we should make sure we're consistent with it across all Unicode files: process_unicode_common.c, process_unicode.c, process_unicodemap.c, process_ucis.c.

case UC_WIN:
unregister_code(KC_LALT);
break;
case UC_OSX_RALT:
unregister_code(KC_RALT);
break;
case UC_LNX:
tap_code(KC_SPC);
break;
}

set_mods(saved_mods); // Reregister previously set mods
Expand Down Expand Up @@ -153,52 +132,57 @@ void send_unicode_hex_string(const char *str) {
bool process_unicode_common(uint16_t keycode, keyrecord_t *record) {
if (record->event.pressed) {
switch (keycode) {
case UNICODE_MODE_OSX:
case UNICODE_MODE_OSX:
set_unicode_input_mode(UC_OSX);
#if defined(AUDIO_ENABLE) && defined(UNICODE_SONG_OSX)
PLAY_SONG(osx_song);
#endif
break;
case UNICODE_MODE_LNX:
set_unicode_input_mode(UC_LNX);
#if defined(AUDIO_ENABLE) && defined(UNICODE_SONG_LNX)
PLAY_SONG(song_lnx);
#endif
break;
case UNICODE_MODE_WIN:
set_unicode_input_mode(UC_WIN);
#if defined(AUDIO_ENABLE) && defined(UNICODE_SONG_WIN)
PLAY_SONG(windows_song);
#endif
break;
case UNICODE_MODE_BSD:
set_unicode_input_mode(UC_BSD);
#if defined(AUDIO_ENABLE) && defined(UNICODE_SONG_BSD)
PLAY_SONG(song_bsd);
#endif
break;
case UNICODE_MODE_WINC:
set_unicode_input_mode(UC_WINC);
#if defined(AUDIO_ENABLE) && defined(UNICODE_SONG_WINC)
PLAY_SONG(win_compose_song);
#endif
break;
case UNICODE_MODE_OSX_RALT:
set_unicode_input_mode(UC_OSX_RALT);
#if defined(AUDIO_ENABLE) && defined(UNICODE_SONG_OSX_RALT)
PLAY_SONG(osx_ralt_song);
#endif
break;
#if defined(AUDIO_ENABLE) && defined(UNICODE_SONG_OSX)
Copy link
Author

@vomindoraan vomindoraan Nov 3, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The reason why I prefer preprocessor ifs (and preprocessor directives in general) to have their own separate indentation levels is that they aren't part of the program logic. They just pick & choose which parts of the code get compiled and which don't; they aren't runtime checks. Therefore, they shouldn't affect the indentation of the actual code.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I definitely understand that. However, .... I think we need a clear and concise rule about this, because you can see three different formats throughout the code.

Also, this looks cleaner.

Copy link
Author

@vomindoraan vomindoraan Nov 3, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right now the tally for preprocessor directives before code in core QMK is:

  • 1209 matches across 154 files for directives at start of line (grepped for ^#.+\n +[^#]);
  • 651 matches across 45 files for indented directives (grepped for ^ +#.+\n +[^#]).

I agree that there should be a hard rule for it for any new code, as well as for the case indentation stuff (that's also done both ways in the codebase).

static float song_osx[][2] = UNICODE_SONG_OSX;
PLAY_SONG(song_osx);
#endif
break;
case UNICODE_MODE_LNX:
set_unicode_input_mode(UC_LNX);
#if defined(AUDIO_ENABLE) && defined(UNICODE_SONG_LNX)
static float song_lnx[][2] = UNICODE_SONG_LNX;
PLAY_SONG(song_lnx);
#endif
break;
case UNICODE_MODE_WIN:
set_unicode_input_mode(UC_WIN);
#if defined(AUDIO_ENABLE) && defined(UNICODE_SONG_WIN)
static float song_win[][2] = UNICODE_SONG_WIN;
PLAY_SONG(song_win);
#endif
break;
case UNICODE_MODE_BSD:
set_unicode_input_mode(UC_BSD);
#if defined(AUDIO_ENABLE) && defined(UNICODE_SONG_BSD)
static float song_bsd[][2] = UNICODE_SONG_BSD;
PLAY_SONG(song_bsd);
#endif
break;
case UNICODE_MODE_WINC:
set_unicode_input_mode(UC_WINC);
#if defined(AUDIO_ENABLE) && defined(UNICODE_SONG_WINC)
static float song_winc[][2] = UNICODE_SONG_WINC;
PLAY_SONG(song_winc);
#endif
break;
case UNICODE_MODE_OSX_RALT:
set_unicode_input_mode(UC_OSX_RALT);
#if defined(AUDIO_ENABLE) && defined(UNICODE_SONG_OSX_RALT)
static float song_osx_ralt[][2] = UNICODE_SONG_OSX_RALT;
PLAY_SONG(song_osx_ralt);
#endif
break;
}
}
#ifdef UNICODE_ENABLE
return process_unicode(keycode, record);
#endif
#ifdef UCIS_ENABLE
return process_ucis(keycode, record);
#endif
#ifdef UNICODEMAP_ENABLE
return process_unicode_map(keycode, record);
#endif
#if defined(UNICODE_ENABLE)
return process_unicode(keycode, record);
#elif defined(UNICODEMAP_ENABLE)
return process_unicode_map(keycode, record);
#elif defined(UCIS_ENABLE)
return process_ucis(keycode, record);
#else
return true;
#endif
}
4 changes: 2 additions & 2 deletions quantum/process_keycode/process_unicode_common.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@
#include "quantum.h"

#if defined(UNICODE_ENABLE) + defined(UNICODEMAP_ENABLE) + defined(UCIS_ENABLE) > 1
#error "Cannot enable more than one unicode method (UNICODE, UNICODEMAP, UCIS) at the same time"
#error "Cannot enable more than one Unicode method (UNICODE, UNICODEMAP, UCIS) at the same time"
#endif

#ifndef UNICODE_TYPE_DELAY
#define UNICODE_TYPE_DELAY 10
#define UNICODE_TYPE_DELAY 10
#endif

typedef union {
Expand Down
6 changes: 3 additions & 3 deletions quantum/quantum.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ bool process_record_quantum(keyrecord_t *record) {
process_key_lock(&keycode, record) &&
#endif
#if defined(AUDIO_ENABLE) && defined(AUDIO_CLICKY)
process_clicky(keycode, record) &&
process_clicky(keycode, record) &&
#endif //AUDIO_CLICKY
process_record_kb(keycode, record) &&
#if defined(RGB_MATRIX_ENABLE) && defined(RGB_MATRIX_KEYPRESSES)
Expand All @@ -250,13 +250,13 @@ bool process_record_quantum(keyrecord_t *record) {
#ifdef STENO_ENABLE
process_steno(keycode, record) &&
#endif
#if ( defined(AUDIO_ENABLE) || (defined(MIDI_ENABLE) && defined(MIDI_BASIC))) && !defined(NO_MUSIC_MODE)
#if (defined(AUDIO_ENABLE) || (defined(MIDI_ENABLE) && defined(MIDI_BASIC))) && !defined(NO_MUSIC_MODE)
process_music(keycode, record) &&
#endif
#ifdef TAP_DANCE_ENABLE
process_tap_dance(keycode, record) &&
#endif
#if (defined(UNICODE_ENABLE) || defined(UNICODEMAP_ENABLE) || defined(UCIS_ENABLE))
#if defined(UNICODE_ENABLE) || defined(UNICODEMAP_ENABLE) || defined(UCIS_ENABLE)
process_unicode_common(keycode, record) &&
#endif
#ifdef LEADER_ENABLE
Expand Down