-
Notifications
You must be signed in to change notification settings - Fork 153
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.
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
Adds layer implementations to examples.md #804
Open
ck-tom
wants to merge
3
commits into
sezanzeb:main
Choose a base branch
from
ck-tom:cheynetom-patch-1
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
@@ -177,3 +177,41 @@ xmodmap keyboard_layout | |||||||||||||||||
|
||||||||||||||||||
again for the injection to use that xmodmap as well. It should be possible | ||||||||||||||||||
to write "ヤ" now when pressing the key. | ||||||||||||||||||
|
||||||||||||||||||
## Implementing Layers | ||||||||||||||||||
|
||||||||||||||||||
We can implement layer functionality (similar to QMK) using the `set` and `if_eq` macros. | ||||||||||||||||||
|
||||||||||||||||||
- `A`: `set(foo, 0)` | ||||||||||||||||||
- `B`: `set(foo, 1)` | ||||||||||||||||||
- `X`: `if_eq(foo, 1, hold_keys(Y), hold_keys(X))` | ||||||||||||||||||
|
||||||||||||||||||
Pressing `A` sets `$foo=0`, pressing `B` sets `$foo=1`. `X` is `Y` if `$foo=1`, otherwise `X` is `X`. Pressing `A` > `X` > `B` > `X` will output `XY`. | ||||||||||||||||||
|
||||||||||||||||||
|
||||||||||||||||||
|
||||||||||||||||||
We can implement a single macro to toggle back and forth betwixt layers. | ||||||||||||||||||
|
||||||||||||||||||
- `A`:`if_eq(foo, 1, set(foo, 0), set(foo, 1))` | ||||||||||||||||||
- `X`:`if_eq(foo, 1, hold_keys(Y), hold_keys(X))` | ||||||||||||||||||
Comment on lines
+195
to
+196
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||
|
||||||||||||||||||
Pressing `A` toggles between `$foo=0` and `$foo=1`. So pressing `X` > `A` > `X` will output `XY` (or `YX` if you start from `$foo=1`). | ||||||||||||||||||
|
||||||||||||||||||
|
||||||||||||||||||
We can create layer-shift macros that will enable the layer only while being held. | ||||||||||||||||||
|
||||||||||||||||||
- `A`:`set(foo, 1).hold().set(foo, 0)` | ||||||||||||||||||
- `X`:`if_eq(foo, 1, hold_keys(Y), hold_keys(X))` | ||||||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||
|
||||||||||||||||||
This will set `$foo=1` only while `A` is held down. Pressing `X` will output `X` but holding `A` while pressing `X` will output `Y`. | ||||||||||||||||||
|
||||||||||||||||||
We can extend this further to create second (and third, fourth, etc...) layer macros for the entire keyboard. | ||||||||||||||||||
|
||||||||||||||||||
For example creating a Vim HJKL movement layer when `left Alt` is held down. | ||||||||||||||||||
|
||||||||||||||||||
- `Alt_L`:`set(layer, 1).hold().set(layer, 0)` | ||||||||||||||||||
- `H`:`ifeq(layer, 1, hold_keys(Left), hold_keys(H))` | ||||||||||||||||||
- `J`:`ifeq(layer, 1, hold_keys(Down), hold_keys(J))` | ||||||||||||||||||
- `K`:`ifeq(layer, 1, hold_keys(Up), hold_keys(K))` | ||||||||||||||||||
- `L`:`ifeq(layer, 1, hold_keys(Right), hold_keys(L))` | ||||||||||||||||||
Comment on lines
+213
to
+216
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.