Kaleidoscope

Commit Graph

Author	SHA1	Message	Date
Michael Richters	56c12996ad	Replace `astyle` comments with `clang-format` equivalents in examples This applies to turning off formatting of keymaps. There were a few files that were missing these comments, so those were added where necessary, as well. Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>	3 years ago
Florian Fleissner	ba79eef4b2	Key union converted to a proper class Unions are a C-reminiscense that are better avoided in modern C++. They cause specific problems due to their nature of representing independent types. The way they are used in Kaleidoscope, they can easily be replaced by a class. This enables it to properly work with Key objects in constexpr context where with the old union-based implementation the compiler reported errors when one Key was constructed based on a key_code/flags pair and another one through raw-data. In such a case, the compiler assumes that both Key instances represent something entirely different. This is because unions were never meant for type conversions and the C++ standard considers their use for that purpose as undefined behavior. The new class provides accessor methods for raw-data access and for key_code/flags-data access. This is a breaking change as it is is not possible to replace direct member access patterns like key.raw = 0xFFFF; based on the raw-accessors. For the .keyCode and .flags members, proxy objects are used to enable the generation of suitable deprecations warnings. All direct access via .raw, .keyCode and .flags have been replaced throughout Kaleidoscope. Information on how to upgrade is provided in UPGRADING.md Signed-off-by: Florian Fleissner <florian.fleissner@inpartik.de>	5 years ago
Jesse Vincent	50a6f5e1b1	Reorganize our examples directory to try to make it easier to work with Signed-off-by: Jesse Vincent <jesse@keyboard.io>	6 years ago

Author

SHA1

Message

Date

Michael Richters

56c12996ad

Replace `astyle` comments with `clang-format` equivalents in examples

This applies to turning off formatting of keymaps.  There were a few files that
were missing these comments, so those were added where necessary, as well.

Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>

Florian Fleissner

ba79eef4b2

Key union converted to a proper class

Unions are a C-reminiscense that are better avoided in modern C++.
They cause specific problems due to their nature of representing
independent types. The way they are used in Kaleidoscope, they
can easily be replaced by a class.

This enables it to properly work with Key objects in constexpr context
where with the old union-based implementation the compiler reported
errors when one Key was constructed based on a key_code/flags pair and
another one through raw-data. In such a case, the compiler assumes that
both Key instances represent something entirely different. This is
because unions were never meant for type conversions and the C++
standard considers their use for that purpose as undefined behavior.

The new class provides accessor methods for raw-data access and for
key_code/flags-data access.

This is a breaking change as it is is not possible to replace direct
member access patterns like

key.raw = 0xFFFF;

based on the raw-accessors.

For the .keyCode and .flags members, proxy objects are used
to enable the generation of suitable deprecations warnings.

All direct access via .raw, .keyCode and .flags have been replaced
throughout Kaleidoscope.

Information on how to upgrade is provided in UPGRADING.md

Signed-off-by: Florian Fleissner <florian.fleissner@inpartik.de>

Jesse Vincent

50a6f5e1b1

Reorganize our examples directory to try to make it easier to work with

Signed-off-by: Jesse Vincent <jesse@keyboard.io>

3 Commits (9e1c9e35f4897a308276120b66bcf6998b3a6b90)