1 /* Copyright (C) 2014 by Jacob Alexander
3 * This file is free software: you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation, either version 3 of the License, or
6 * (at your option) any later version.
8 * This file is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this file. If not, see <http://www.gnu.org/licenses/>.
20 #ifndef __kiibohdKeymap_h
21 #define __kiibohdKeymap_h
23 // ----- Includes -----
30 // ----- Capabilities -----
32 // Indexed Capabilities Table
38 // Result Macro Guides
42 // -- Result Macro List
44 // Indexed Table of Result Macros
48 // -- Trigger Macro Record
50 // Keeps a record/state of each result macro
56 // Trigger Macro Guides
60 // -- Trigger Macro List
62 // Indexed Table of Trigger Macros
66 // -- Trigger Macro Record List
68 // Keeps a record/state of each trigger macro
69 <|TriggerMacroRecord|>
73 // ----- Trigger Maps -----
76 // - This is retrieved from the KLL configuration
77 // - Should be corollated with the max scan code in the scan module
78 // - Maximum value is 0x100 (0x0 to 0xFF)
79 // - Increasing it beyond the keyboard's capabilities is just a waste of ram...
80 #define MaxScanCode <|MaxScanCode|>
84 // Index 0: # of triggers in list
85 // Index n: pointer to trigger macro - use tm() macro
88 <|DefaultLayerTriggerList|>
92 <|PartialLayerTriggerLists|>
95 // -- ScanCode Indexed Maps
96 // Maps to a trigger list of macro pointers
99 // |r| -> <trigger macro pointer 1>
101 // |g| -> <trigger macro pointer 2>
103 // |e| -> <trigger macro pointer 3>
105 // |s| -> <trigger macro pointer n>
108 // - Default Map for ScanCode Lookup -
109 <|DefaultLayerScanMap|>
112 // - Partial Layer ScanCode Lookup Maps -
113 <|PartialLayerScanMaps|>
117 // ----- Layer Index -----
119 // -- Layer Index List
121 // Index 0: Default map
122 // Index n: Additional layers
131 #endif // __generatedKeymap_h