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 Macros
  49
  50 // Trigger Macro Guides
  51 <|TriggerMacros|>
  52
  53
  54 // -- Trigger Macro List
  55
  56 // Indexed Table of Trigger Macros
  57 <|TriggerMacroList|>
  58
  59
  60
  61 // ----- Trigger Maps -----
  62
  63 // MaxScanCode
  64 // - This is retrieved from the KLL configuration
  65 // - Should be corollated with the max scan code in the scan module
  66 // - Maximum value is 0x100 (0x0 to 0xFF)
  67 // - Increasing it beyond the keyboard's capabilities is just a waste of ram...
  68 #define MaxScanCode <|MaxScanCode|>
  69
  70 // -- Trigger Lists
  71 //
  72 // Index 0: # of triggers in list
  73 // Index n: pointer to trigger macro - use tm() macro
  74
  75 // - Default Layer -
  76 <|DefaultLayerTriggerList|>
  77
  78
  79 // - Partial Layers -
  80 <|PartialLayerTriggerLists|>
  81
  82
  83 // -- ScanCode Indexed Maps
  84 // Maps to a trigger list of macro pointers
  85 //                 _
  86 // <scan code> -> |T|
  87 //                |r| -> <trigger macro pointer 1>
  88 //                |i|
  89 //                |g| -> <trigger macro pointer 2>
  90 //                |g|
  91 //                |e| -> <trigger macro pointer 3>
  92 //                |r|
  93 //                |s| -> <trigger macro pointer n>
  94 //                 -
  95
  96 // - Default Map for ScanCode Lookup -
  97 <|DefaultLayerScanMap|>
  98
  99
 100 // - Partial Layer ScanCode Lookup Maps -
 101 <|PartialLayerScanMaps|>
 102
 103
 104
 105 // ----- Layer Index -----
 106
 107 // -- Layer Index List
 108 //
 109 // Index 0: Default map
 110 // Index n: Additional layers
 111 <|LayerIndexList|>
 112
 113
 114 // - Layer State
 115 <|LayerState|>
 116
 117
 118
 119 #endif // __generatedKeymap_h
 120