templateKeymap.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 // Generated MSG /w timestamp and compiler information
  18
  19 #ifndef __generatedKeymap_h
  20 #define __generatedKeymap_h
  21
  22 // ----- Includes -----
  23
  24 // KLL Include
  25 #include <kll.h>
  26
  27
  28
  29 // ----- Capabilities -----
  30
  31 // Indexed Capabilities Table
  32 <|CapabilitiesList|>
  33
  34
  35 // -- Result Macros
  36
  37 // Result Macro Guides
  38 <|ResultMacros|>
  39
  40
  41 // -- Result Macro List
  42
  43 // Indexed Table of Result Macros
  44 <|ResultMacroList|>
  45
  46
  47 // -- Trigger Macros
  48
  49 // Trigger Macro Guides
  50 <|TriggerMacros|>
  51
  52
  53 // -- Trigger Macro List
  54
  55 // Indexed Table of Trigger Macros
  56 <|TriggerMacroList|>
  57
  58
  59
  60 // ----- Trigger Maps -----
  61
  62 // MaxScanCode
  63 // - This is retrieved from the KLL configuration
  64 // - Should be corollated with the max scan code in the scan module
  65 // - Maximum value is 0x100 (0x0 to 0xFF)
  66 // - Increasing it beyond the keyboard's capabilities is just a waste of ram...
  67 #define MaxScanCode <MaxScanCode>
  68
  69 // -- Trigger Lists
  70 //
  71 // Index 0: # of triggers in list
  72 // Index n: pointer to trigger macro - use tm() macro
  73
  74 // - Default Layer -
  75 <|DefaultLayerTriggerList|>
  76
  77
  78 // - Partial Layers -
  79 <|PartialLayerTriggerLists|>
  80
  81
  82 // -- ScanCode Indexed Maps
  83 // Maps to a trigger list of macro pointers
  84 //                 _
  85 // <scan code> -> |T|
  86 //                |r| -> <trigger macro pointer 1>
  87 //                |i|
  88 //                |g| -> <trigger macro pointer 2>
  89 //                |g|
  90 //                |e| -> <trigger macro pointer 3>
  91 //                |r|
  92 //                |s| -> <trigger macro pointer n>
  93 //                 -
  94
  95 // - Default Map for ScanCode Lookup -
  96 <|DefaultLayerScanMap|>
  97
  98 // - Partial Layer ScanCode Lookup Maps -
  99 <|PartialLayerScanMaps|>
 100
 101
 102
 103 // ----- Layer Index -----
 104
 105 // -- Layer Index List
 106 //
 107 // Index 0: Default map
 108 // Index n: Additional layers
 109 <|LayerIndexList|>
 110
 111
 112
 113 #endif // __generatedKeymap_h
 114