Skip to content

Better layout docs and source #52

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

Merged
merged 19 commits into from
Jun 13, 2025
Merged

Better layout docs and source #52

Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
0b6c451
Move docs into lib.rs
thejpster Jun 1, 2025
393e223
Use Unicode literals
thejpster Jun 2, 2025
5676c98
Add diagrams, and tool to generate them, plus helper functions.
thejpster Jun 2, 2025
329b71e
Clean up Azerty
thejpster Jun 3, 2025
9418a6b
Print all keyboard types (except JIS)
thejpster Jun 4, 2025
f37e52d
Update De105Key
thejpster Jun 4, 2025
bb50357
Update Dvorak and Programmer's Dvorak
thejpster Jun 4, 2025
f99aed8
Update FiSe105
thejpster Jun 4, 2025
4a06354
Update No105
thejpster Jun 4, 2025
02f9296
Add missing diagrams.
thejpster Jun 5, 2025
4339cdf
Rename handler functions.
thejpster Jun 5, 2025
8a6539c
Update Jis109 layout
thejpster Jun 5, 2025
74c87f1
Update CHANGELOG
thejpster Jun 12, 2025
e035de7
Set rust-version to match our MSRV.
thejpster Jun 12, 2025
21abaf8
People on Github might want to see docs for the version in Github.
thejpster Jun 12, 2025
e353a27
Remove weird leftovers in lib.rs docs
thejpster Jun 12, 2025
e2ba180
Move code block where it belongs
thejpster Jun 12, 2025
b7f14c2
Remove leftover header
thejpster Jun 12, 2025
11b597a
Merge branch 'main' into more-layout-docs
thejpster Jun 12, 2025
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
290 changes: 1 addition & 289 deletions README.md
View file
Open in desktop

Large diffs are not rendered by default.

506 changes: 506 additions & 0 deletions examples/print_keyboard.rs
View file
Open in desktop

Large diffs are not rendered by default.

668 changes: 171 additions & 497 deletions src/layouts/azerty.rs
View file
Open in desktop

Large diffs are not rendered by default.

626 changes: 158 additions & 468 deletions src/layouts/colemak.rs
View file
Open in desktop

Large diffs are not rendered by default.

398 changes: 165 additions & 233 deletions src/layouts/de105.rs
View file
Open in desktop

Large diffs are not rendered by default.

457 changes: 172 additions & 285 deletions src/layouts/dvorak104.rs
View file
Open in desktop

Large diffs are not rendered by default.

654 changes: 188 additions & 466 deletions src/layouts/dvorak_programmer104.rs
View file
Open in desktop

Large diffs are not rendered by default.

363 changes: 161 additions & 202 deletions src/layouts/fi_se105.rs
View file
Open in desktop

Large diffs are not rendered by default.

321 changes: 165 additions & 156 deletions src/layouts/jis109.rs
View file
Open in desktop

Large diffs are not rendered by default.

32 changes: 32 additions & 0 deletions src/layouts/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
//! see [`Uk105Key`] and [`Us104Key`] as an example of that.

mod dvorak_programmer104;
use crate::PhysicalKeyboard;

pub use self::dvorak_programmer104::DVP104Key;

mod dvorak104;
Expand Down Expand Up @@ -68,6 +70,21 @@ impl super::KeyboardLayout for AnyLayout {
AnyLayout::FiSe105Key(inner) => inner.map_keycode(keycode, modifiers, handle_ctrl),
}
}

fn get_physical(&self) -> PhysicalKeyboard {
match self {
AnyLayout::DVP104Key(inner) => inner.get_physical(),
AnyLayout::Dvorak104Key(inner) => inner.get_physical(),
AnyLayout::Us104Key(inner) => inner.get_physical(),
AnyLayout::Uk105Key(inner) => inner.get_physical(),
AnyLayout::Jis109Key(inner) => inner.get_physical(),
AnyLayout::Azerty(inner) => inner.get_physical(),
AnyLayout::Colemak(inner) => inner.get_physical(),
AnyLayout::De105Key(inner) => inner.get_physical(),
AnyLayout::No105Key(inner) => inner.get_physical(),
AnyLayout::FiSe105Key(inner) => inner.get_physical(),
}
}
}

impl super::KeyboardLayout for &AnyLayout {
Expand All @@ -90,6 +107,21 @@ impl super::KeyboardLayout for &AnyLayout {
AnyLayout::FiSe105Key(inner) => inner.map_keycode(keycode, modifiers, handle_ctrl),
}
}

fn get_physical(&self) -> PhysicalKeyboard {
match self {
AnyLayout::DVP104Key(inner) => inner.get_physical(),
AnyLayout::Dvorak104Key(inner) => inner.get_physical(),
AnyLayout::Us104Key(inner) => inner.get_physical(),
AnyLayout::Uk105Key(inner) => inner.get_physical(),
AnyLayout::Jis109Key(inner) => inner.get_physical(),
AnyLayout::Azerty(inner) => inner.get_physical(),
AnyLayout::Colemak(inner) => inner.get_physical(),
AnyLayout::De105Key(inner) => inner.get_physical(),
AnyLayout::No105Key(inner) => inner.get_physical(),
AnyLayout::FiSe105Key(inner) => inner.get_physical(),
}
}
}

#[cfg(test)]
Expand Down
379 changes: 166 additions & 213 deletions src/layouts/no105.rs
View file
Open in desktop

Large diffs are not rendered by default.

208 changes: 150 additions & 58 deletions src/layouts/uk105.rs
View file
Open in desktop

Large diffs are not rendered by default.

776 changes: 308 additions & 468 deletions src/layouts/us104.rs
View file
Open in desktop

Large diffs are not rendered by default.

482 changes: 474 additions & 8 deletions src/lib.rs
View file
Open in desktop

Large diffs are not rendered by default.

Loading