1 /* Copyright (C) 2014-2016 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/>.
22 // ----- Includes -----
29 // ----- Capabilities -----
31 // Capability function declarations
32 <|CapabilitiesFuncDecl|>
35 // Indexed Capabilities Table
41 // Result Macro Guides
45 // -- Result Macro List
47 // Indexed Table of Result Macros
51 // -- Trigger Macro Record
53 // Keeps a record/state of each result macro
59 // Trigger Macro Guides
63 // -- Trigger Macro List
65 // Indexed Table of Trigger Macros
69 // -- Trigger Macro Record List
71 // Keeps a record/state of each trigger macro
72 <|TriggerMacroRecord|>
76 // ----- Trigger Maps -----
79 // - This is retrieved from the KLL configuration
80 // - Should be corollated with the max scan code in the scan module
81 // - Maximum value is 0x100 (0x0 to 0xFF)
82 // - Increasing it beyond the keyboard's capabilities is just a waste of ram...
83 #define MaxScanCode <|MaxScanCode|>
87 // Index 0: # of triggers in list
88 // Index n: pointer to trigger macro - use tm() macro
91 <|DefaultLayerTriggerList|>
95 <|PartialLayerTriggerLists|>
98 // -- ScanCode Offset Map
99 // Maps interconnect ids to scancode offsets
101 // Only used for keyboards with an interconnect
102 <|ScanCodeInterconnectOffsetList|>
105 // -- ScanCode Indexed Maps
106 // Maps to a trigger list of macro pointers
108 // <scan code> -> |T|
109 // |r| -> <trigger macro pointer 1>
111 // |g| -> <trigger macro pointer 2>
113 // |e| -> <trigger macro pointer 3>
115 // |s| -> <trigger macro pointer n>
118 // - Default Map for ScanCode Lookup -
119 <|DefaultLayerScanMap|>
122 // - Partial Layer ScanCode Lookup Maps -
123 <|PartialLayerScanMaps|>
127 // ----- Layer Index -----
129 // -- Layer Index List
131 // Index 0: Default map
132 // Index n: Additional layers