gitbot/qmk_firmware
0
0
Fork 0
mirror of https://github.com/qmk/qmk_firmware.git synced 2024-11-22 03:19:24 +00:00
Code Issues Packages Projects Releases Wiki Activity
9632360caa
qmk_firmware/users/jonavin
History
Jeff Epler 9632360caa
Use a macro to compute the size of arrays at compile time (#18044) 
* Add ARRAY_SIZE and CEILING utility macros

* Apply a coccinelle patch to use ARRAY_SIZE

* fix up some straggling items

* Fix 'make test:secure'

* Enhance ARRAY_SIZE macro to reject acting on pointers

The previous definition would not produce a diagnostic for
```
int *p;
size_t num_elem = ARRAY_SIZE(p)
```
but the new one will.

* explicitly get definition of ARRAY_SIZE

* Convert to ARRAY_SIZE when const is involved

The following spatch finds additional instances where the array is
const and the division is by the size of the type, not the size of
the first element:
```
@ rule5a using "empty.iso" @
type T;
const T[] E;
@@

- (sizeof(E)/sizeof(T))
+ ARRAY_SIZE(E)

@ rule6a using "empty.iso" @
type T;
const T[] E;
@@

- sizeof(E)/sizeof(T)
+ ARRAY_SIZE(E)
```

* New instances of ARRAY_SIZE added since initial spatch run

* Use `ARRAY_SIZE` in docs (found by grep)

* Manually use ARRAY_SIZE

hs_set is expected to be the same size as uint16_t, though it's made
of two 8-bit integers

* Just like char, sizeof(uint8_t) is guaranteed to be 1

This is at least true on any plausible system where qmk is actually used.

Per my understanding it's universally true, assuming that uint8_t exists:
https://stackoverflow.com/questions/48655310/can-i-assume-that-sizeofuint8-t-1

* Run qmk-format on core C files touched in this branch

Co-authored-by: Stefan Kerkmann <karlk90@pm.me>
2022-08-30 10:20:04 +02:00
..
config.h [Keymap] Jonavin kbd 67 keymap with advance RGB functions (#15527) 2021-12-24 17:23:24 -08:00
jonavin_encoder.c [Keymap] Jonavin userspace encoder alt tab scrolling (#14979) 2021-10-30 11:53:58 -07:00
jonavin.c [Keymap] Jonavin userspace encoder alt tab scrolling (#14979) 2021-10-30 11:53:58 -07:00
jonavin.h Use a macro to compute the size of arrays at compile time (#18044) 2022-08-30 10:20:04 +02:00
readme.md [Keymap] Jonavin keymap kastenwagen48 (#15825) 2022-01-11 09:56:01 -08:00
rules.mk [Keymap] Jonavin userspace encoder alt tab scrolling (#14979) 2021-10-30 11:53:58 -07:00

readme.md

Copyright 2021 Jonavin Eng @Jonavin

This program 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 program 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, see http://www.gnu.org/licenses/.

LAYERS:

  • 0 = _BASE
  • 1 = _FN1
  • 2 = _LOWER
  • 3 = _RAISE

KEYCODES:

  • KC_CAD Ctrl-Alt-Del
  • KC_AF4 Alt-F4
  • KC_TASK Windows Task Manager (Ctrl-Shift-Esc)
  • LSFT_CAPSLOCK When LSFT_CAPSLOCK_ENABLE is defined, hold for Shift double tap for CAPSLOCK; otherwise, just Shift
  • KC_00 double zero "00"
  • KC_WINLCK toggles LGui/Win key lock
  • RGB_TOI Increase Timeout idle time threshold
  • RGB_TOD Decrease Timeout idle time threshold
  • CT_PGUP Ctrl-PgUp
  • CT_PGDN Ctrl-PgDn
  • CT_HOME Ctrl-HOme
  • CT_END Ctrl-End
  • KC_SFTUP RShift when held, Up arrow when tapped
  • KC_RAISESPC _RAISE layer mod when held, space when tapped
  • KC_LOWERSPC _LOWER layer mod when held, space when tapped
  • KC_TSTOG toggles between volume and Alt-Tab encoder control

When EMOTICON_ENABLE = yes

  • EMO_SHRUG \_("/)_/
  • EMO_CONFUSE (_)
  • EMD_TEARS (T_T)
  • EMO_NERVOUS (~_~;)
  • EMO_JOY (^o^)
  • EMO_SAD :'-(

AVAILABLE ENCODER ACTIONS:

  • void encoder_action_volume(bool clockwise);
  • void encoder_action_mediatrack(bool clockwise);
  • void encoder_action_navword(bool clockwise);
  • void encoder_action_navpage(bool clockwise);
  • uint8_t get_selected_layer(void);
  • void encoder_action_layerchange(bool clockwise);
  • void encoder_action_rgb_speed(bool clockwise);
  • void encoder_action_rgb_hue(bool clockwise);
  • void encoder_action_rgb_saturation(bool clockwise);
  • void encoder_action_rgb_brightness(bool clockwise);
  • void encoder_action_rgb_mode(bool clockwise);
  • void encoder_action_alttabscroll(bool clockwise)
  • void encoder_toggle_alttabscroll(void);

ENABLE FEATURES your keymap rules.mk

STARTUP_NUMLOCK_ON = yes

  • turns on NUMLOCK by default

ENCODER_DEFAULTACTIONS_ENABLE = yes

  • Enabled default encoder funtions
  • When enabled, use this in the keymap for an additional encoder processing
  • bool encoder_update_keymap(uint8_t index, bool clockwise)

OPTION: set ENCODER_DEFAULTACTIONS_INDEX to the encoder number if the encoder is not index 0

TD_LSFT_CAPSLOCK_ENABLE = yes

  • This will enable double tap on Left Shift to toggle CAPSLOCK
  • KC_LSFTCAPS to bind to left Shift to enable feature
  • KC_LSFTCAPSWIN does the same thing but will not turn on CAPS when Win Lkey is disabled

IDLE_TIMEOUT_ENABLE = yes

  • Enables Timer functionality; for RGB idle timeouts that can be changed dynamically
  • When enabled, use this in the keymap for an additional matrix processing: void matrix_scan_keymap(void)

EMOTICON_ENABLE

  • adds EMO_ keycodes for text emojis

INVERT_NUMLOCK_INDICATOR

  • inverts the Num lock indicator, LED is on when num lock is off

ALTTAB_SCROLL_ENABLE

  • When ENCODER_DEFAULTACTIONS_ENABLE = yes, Enables Alt-Tab scrolling functions in default encoder, bind KS_TSTOG to a key to enable/disable Alt-Tab vs Volume control
  • When defining your own encoder functions use encoder_action_alttabscroll(bool clockwise) to assign the encodr action

FUNCTIONS

  • u16int_t get_timeout_threshold(void) // returns the current timeout threshold
  • void timeout_update_threshold(bool increase) // change threshold: true = increase, false = decrease
  • void timeout_reset_timer(void) // resets timer (put in process_record_user if you override it)
  • void timeout_tick_timer(void) // registers time ticks (put in maxtrix_scan_user if you override it)

Other Functions:

  • activate_numlock(bool turn_on) // true = turn on NUM LOCK, false = off

KEYMAP LEVEL ADDITIONAL PROCESSING FUNCTIONS

  • bool process_record_keymap(uint16_t keycode, keyrecord_t *record)
  • void keyboard_post_init_keymap(void)

LIST OF COMPATIBLE KEYMAPS

  • gmmk/pro/ansi
  • keebio/quefrency/rev3
  • mechwild/mercutio
  • mechwild/murphpad
  • mechwild/OBE
  • kbdfans/kdb67
  • nopunin10did/kastenwagen48