qmk_firmware/users/brandonschlack
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
..
brandonschlack.c
brandonschlack.h
config.h
process_records.c
process_records.h
readme.md
rgb_bs.c Use a macro to compute the size of arrays at compile time (#18044) 2022-08-30 10:20:04 +02:00
rgb_bs.h
rgb_theme.h
rgb_theme_user.inc
rules.mk
tap_dances.c
tap_dances.h

readme.md

Overview

My QMK home. I feel as though I stand on the shoulders of giants, for a lot of my code here is borrowed and adapted from so many contributors here, and that I hope my code here can help or inspire others.

Layers, Handlers, and Macros

Layers

I have some predefined layer names for keyboards:

  • _BASE: Default Layer, QWERTY layout.
  • _FN1: Function Layer for 60% and above, and additional macros and shortcuts on 50% and below.
  • _LOWER and _RAISE: Function layers for 40%

and macropads:

  • _REEDER: Shortcuts for Reeder.app, my RSS feed reader
  • _MEDIA: Media controls
  • _NAVI: Navigation macros, for changing tabs and scrolling
  • _KARABINER: Generic macro keys, meant to be customized per app with Karabiner

Protected Layers

I have some named "protected" layers, meant to be at the end of the layer list for changing keyboard settings and features.

  • KEYMAP_LAYERS: Add additional layers in keymap.
  • _AUDIO: Audio feature controls.
  • _LIGHT: RGB Light/Matrix feature controls.
  • _ADJUST: General keyboard settings and toggles. Can also contain RGB and Audio controls on larger boards that don't need and extra layer for those controls.

EEPROM User Config

I have a custom userspace config implemented to save settings on the board to persist across shutdowns. I currently store:

  • rgb_layer_change - a toggle for using RGB themes for layer indication
  • rgb_theme - a pointer to the currently set RGB Theme

Process Handlers

Keycode Aliases

I am a macOS user and so a lot of my aliases are

Macros

Tap Dances

Tap Dance Trigger Layer

RGB

RGB Theme