templates/kiibohdKeymap.h

   1 /* Copyright (C) 2014 by Jacob Alexander
   2  *
   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.
   7  *
   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.
  12  *
  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/>.
  15  */
  16
  17 <|Information|>
  18
  19
  20 #ifndef __generatedKeymap_h
  21 #define __generatedKeymap_h
  22
  23 // ----- Includes -----
  24
  25 // KLL Include
  26 #include <kll.h>
  27
  28
  29
  30 // ----- Capabilities -----
  31
  32 // Indexed Capabilities Table
  33 <|CapabilitiesList|>
  34
  35
  36 // -- Result Macros
  37
  38 // Result Macro Guides
  39 <|ResultMacros|>
  40
  41
  42 // -- Result Macro List
  43
  44 // Indexed Table of Result Macros
  45 <|ResultMacroList|>
  46
  47
  48 // -- Trigger Macro Record
  49
  50 // Keeps a record/state of each result macro
  51 <|ResultMacroRecord|>
  52
  53
  54 // -- Trigger Macros
  55
  56 // Trigger Macro Guides
  57 <|TriggerMacros|>
  58
  59
  60 // -- Trigger Macro List
  61
  62 // Indexed Table of Trigger Macros
  63 <|TriggerMacroList|>
  64
  65
  66 // -- Trigger Macro Record List
  67
  68 // Keeps a record/state of each trigger macro
  69 <|TriggerMacroRecord|>
  70
  71
  72
  73 // ----- Trigger Maps -----
  74
  75 // MaxScanCode
  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|>
  81
  82 // -- Trigger Lists
  83 //
  84 // Index 0: # of triggers in list
  85 // Index n: pointer to trigger macro - use tm() macro
  86
  87 // - Default Layer -
  88 <|DefaultLayerTriggerList|>
  89
  90
  91 // - Partial Layers -
  92 <|PartialLayerTriggerLists|>
  93
  94
  95 // -- ScanCode Indexed Maps
  96 // Maps to a trigger list of macro pointers
  97 //                 _
  98 // <scan code> -> |T|
  99 //                |r| -> <trigger macro pointer 1>
 100 //                |i|
 101 //                |g| -> <trigger macro pointer 2>
 102 //                |g|
 103 //                |e| -> <trigger macro pointer 3>
 104 //                |r|
 105 //                |s| -> <trigger macro pointer n>
 106 //                 -
 107
 108 // - Default Map for ScanCode Lookup -
 109 <|DefaultLayerScanMap|>
 110
 111
 112 // - Partial Layer ScanCode Lookup Maps -
 113 <|PartialLayerScanMaps|>
 114
 115
 116
 117 // ----- Layer Index -----
 118
 119 // -- Layer Index List
 120 //
 121 // Index 0: Default map
 122 // Index n: Additional layers
 123 <|LayerIndexList|>
 124
 125
 126 // - Layer State
 127 <|LayerState|>
 128
 129
 130
 131 #endif // __generatedKeymap_h
 132