2 # KLL Compiler - Kiibohd Backend
4 # Backend code generator for the Kiibohd Controller firmware.
6 # Copyright (C) 2014-2015 by Jacob Alexander
8 # This file is free software: you can redistribute it and/or modify
9 # it under the terms of the GNU General Public License as published by
10 # the Free Software Foundation, either version 3 of the License, or
11 # (at your option) any later version.
13 # This file is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with this file. If not, see <http://www.gnu.org/licenses/>.
27 from datetime import date
29 # Modifying Python Path, which is dumb, but the only way to import up one directory...
30 sys.path.append( os.path.expanduser('..') )
32 from kll_lib.containers import *
37 ## Print Decorator Variables
38 ERROR = '\033[5;1;31mERROR\033[0m:'
39 WARNING = '\033[5;1;33mWARNING\033[0m:'
47 # Looks for template file and builds list of fill tags
48 def __init__( self, templatePath, definesTemplatePath ):
49 # Does template exist?
50 if not os.path.isfile( templatePath ):
51 print ( "{0} '{1}' does not exist...".format( ERROR, templatePath ) )
54 self.definesTemplatePath = definesTemplatePath
55 self.templatePath = templatePath
56 self.fill_dict = dict()
58 # Generate list of fill tags
60 with open( templatePath, 'r' ) as openFile:
62 match = re.findall( '<\|([^|>]+)\|>', line )
64 self.tagList.append( item )
65 with open( definesTemplatePath, 'r' ) as openFile:
67 match = re.findall( '<\|([^|>]+)\|>', line )
69 self.tagList.append( item )
72 # USB Code Capability Name
73 def usbCodeCapability( self ):
78 def layerInformation( self, name, date, author ):
79 self.fill_dict['Information'] += "// Name: {0}\n".format( "TODO" )
80 self.fill_dict['Information'] += "// Version: {0}\n".format( "TODO" )
81 self.fill_dict['Information'] += "// Date: {0}\n".format( "TODO" )
82 self.fill_dict['Information'] += "// Author: {0}\n".format( "TODO" )
85 # Processes content for fill tags and does any needed dataset calculations
86 def process( self, capabilities, macros, variables, gitRev, gitChanges ):
87 # Build string list of compiler arguments
90 if "--" in arg or ".py" in arg:
91 compilerArgs += "// {0}\n".format( arg )
93 compilerArgs += "// {0}\n".format( arg )
95 # Build a string of modified files, if any
97 if len( gitChanges ) > 0:
98 for gitFile in gitChanges:
99 gitChangesStr += "// {0}\n".format( gitFile )
101 gitChangesStr = " None\n"
103 # Prepare BaseLayout and Layer Info
105 defaultLayerInfo = ""
106 partialLayersInfo = ""
107 for file, name in zip( variables.baseLayout['*LayerFiles'], variables.baseLayout['*NameStack'] ):
108 baseLayoutInfo += "// {0}\n// {1}\n".format( name, file )
109 if '*LayerFiles' in variables.layerVariables[0].keys():
110 for file, name in zip( variables.layerVariables[0]['*LayerFiles'], variables.layerVariables[0]['*NameStack'] ):
111 defaultLayerInfo += "// {0}\n// {1}\n".format( name, file )
112 if '*LayerFiles' in variables.layerVariables[1].keys():
113 for layer in range( 1, len( variables.layerVariables ) ):
114 partialLayersInfo += "// Layer {0}\n".format( layer )
115 if len( variables.layerVariables[ layer ]['*LayerFiles'] ) > 0:
116 for file, name in zip( variables.layerVariables[ layer ]['*LayerFiles'], variables.layerVariables[ layer ]['*NameStack'] ):
117 partialLayersInfo += "// {0}\n// {1}\n".format( name, file )
121 self.fill_dict['Information'] = "// This file was generated by the kll compiler, DO NOT EDIT.\n"
122 self.fill_dict['Information'] += "// Generation Date: {0}\n".format( date.today() )
123 self.fill_dict['Information'] += "// KLL Backend: {0}\n".format( "kiibohd" )
124 self.fill_dict['Information'] += "// KLL Git Rev: {0}\n".format( gitRev )
125 self.fill_dict['Information'] += "// KLL Git Changes:{0}".format( gitChangesStr )
126 self.fill_dict['Information'] += "// Compiler arguments:\n{0}".format( compilerArgs )
127 self.fill_dict['Information'] += "//\n"
128 self.fill_dict['Information'] += "// - Base Layer -\n{0}".format( baseLayoutInfo )
129 self.fill_dict['Information'] += "// - Default Layer -\n{0}".format( defaultLayerInfo )
130 self.fill_dict['Information'] += "// - Partial Layers -\n{0}".format( partialLayersInfo )
133 ## Variable Information ##
134 self.fill_dict['VariableInformation'] = ""
136 # Iterate through the variables, output, and indicate the last file that modified it's value
137 # Output separate tables per file, per table and overall
142 self.fill_dict['Defines'] = ""
144 # Iterate through defines and lookup the variables
145 for define in variables.defines.keys():
146 if define in variables.overallVariables.keys():
147 self.fill_dict['Defines'] += "\n#define {0} {1}".format( variables.defines[ define ], variables.overallVariables[ define ] )
149 print( "{0} '{1}' not defined...".format( WARNING, define ) )
153 self.fill_dict['CapabilitiesList'] = "const Capability CapabilitiesList[] = {\n"
155 # Keys are pre-sorted
156 for key in capabilities.keys():
157 funcName = capabilities.funcName( key )
158 argByteWidth = capabilities.totalArgBytes( key )
159 self.fill_dict['CapabilitiesList'] += "\t{{ {0}, {1} }},\n".format( funcName, argByteWidth )
161 self.fill_dict['CapabilitiesList'] += "};"
165 self.fill_dict['ResultMacros'] = ""
167 # Iterate through each of the result macros
168 for result in range( 0, len( macros.resultsIndexSorted ) ):
169 self.fill_dict['ResultMacros'] += "Guide_RM( {0} ) = {{ ".format( result )
171 # Add the result macro capability index guide (including capability arguments)
172 # See kiibohd controller Macros/PartialMap/kll.h for exact formatting details
173 for sequence in range( 0, len( macros.resultsIndexSorted[ result ] ) ):
174 # If the sequence is longer than 1, prepend a sequence spacer
175 # Needed for USB behaviour, otherwise, repeated keys will not work
177 # <single element>, <usbCodeSend capability>, <USB Code 0x00>
178 self.fill_dict['ResultMacros'] += "1, {0}, 0x00, ".format( capabilities.getIndex( self.usbCodeCapability() ) )
180 # For each combo in the sequence, add the length of the combo
181 self.fill_dict['ResultMacros'] += "{0}, ".format( len( macros.resultsIndexSorted[ result ][ sequence ] ) )
183 # For each combo, add each of the capabilities used and their arguments
184 for combo in range( 0, len( macros.resultsIndexSorted[ result ][ sequence ] ) ):
185 resultItem = macros.resultsIndexSorted[ result ][ sequence ][ combo ]
187 # Add the capability index
188 self.fill_dict['ResultMacros'] += "{0}, ".format( capabilities.getIndex( resultItem[0] ) )
190 # Add each of the arguments of the capability
191 for arg in range( 0, len( resultItem[1] ) ):
192 self.fill_dict['ResultMacros'] += "{0}, ".format( resultItem[1][ arg ] )
194 # If sequence is longer than 1, append a sequence spacer at the end of the sequence
195 # Required by USB to end at sequence without holding the key down
196 if len( macros.resultsIndexSorted[ result ] ) > 1:
197 # <single element>, <usbCodeSend capability>, <USB Code 0x00>
198 self.fill_dict['ResultMacros'] += "1, {0}, 0x00, ".format( capabilities.getIndex( self.usbCodeCapability() ) )
200 # Add list ending 0 and end of list
201 self.fill_dict['ResultMacros'] += "0 };\n"
202 self.fill_dict['ResultMacros'] = self.fill_dict['ResultMacros'][:-1] # Remove last newline
205 ## Result Macro List ##
206 self.fill_dict['ResultMacroList'] = "const ResultMacro ResultMacroList[] = {\n"
208 # Iterate through each of the result macros
209 for result in range( 0, len( macros.resultsIndexSorted ) ):
210 self.fill_dict['ResultMacroList'] += "\tDefine_RM( {0} ),\n".format( result )
211 self.fill_dict['ResultMacroList'] += "};"
214 ## Result Macro Record ##
215 self.fill_dict['ResultMacroRecord'] = "ResultMacroRecord ResultMacroRecordList[ ResultMacroNum ];"
219 self.fill_dict['TriggerMacros'] = ""
221 # Iterate through each of the trigger macros
222 for trigger in range( 0, len( macros.triggersIndexSorted ) ):
223 self.fill_dict['TriggerMacros'] += "Guide_TM( {0} ) = {{ ".format( trigger )
225 # Add the trigger macro scan code guide
226 # See kiibohd controller Macros/PartialMap/kll.h for exact formatting details
227 for sequence in range( 0, len( macros.triggersIndexSorted[ trigger ][ 0 ] ) ):
228 # For each combo in the sequence, add the length of the combo
229 self.fill_dict['TriggerMacros'] += "{0}, ".format( len( macros.triggersIndexSorted[ trigger ][0][ sequence ] ) )
231 # For each combo, add the key type, key state and scan code
232 for combo in range( 0, len( macros.triggersIndexSorted[ trigger ][ 0 ][ sequence ] ) ):
233 triggerItem = macros.triggersIndexSorted[ trigger ][ 0 ][ sequence ][ combo ]
235 # TODO Add support for Analog keys
236 # TODO Add support for LED states
237 self.fill_dict['TriggerMacros'] += "0x00, 0x01, 0x{0:02X}, ".format( triggerItem )
239 # Add list ending 0 and end of list
240 self.fill_dict['TriggerMacros'] += "0 };\n"
241 self.fill_dict['TriggerMacros'] = self.fill_dict['TriggerMacros'][ :-1 ] # Remove last newline
244 ## Trigger Macro List ##
245 self.fill_dict['TriggerMacroList'] = "const TriggerMacro TriggerMacroList[] = {\n"
247 # Iterate through each of the trigger macros
248 for trigger in range( 0, len( macros.triggersIndexSorted ) ):
249 # Use TriggerMacro Index, and the corresponding ResultMacro Index
250 self.fill_dict['TriggerMacroList'] += "\tDefine_TM( {0}, {1} ),\n".format( trigger, macros.triggersIndexSorted[ trigger ][1] )
251 self.fill_dict['TriggerMacroList'] += "};"
254 ## Trigger Macro Record ##
255 self.fill_dict['TriggerMacroRecord'] = "TriggerMacroRecord TriggerMacroRecordList[ TriggerMacroNum ];"
259 self.fill_dict['MaxScanCode'] = "#define MaxScanCode 0x{0:X}".format( macros.overallMaxScanCode )
262 ## Default Layer and Default Layer Scan Map ##
263 self.fill_dict['DefaultLayerTriggerList'] = ""
264 self.fill_dict['DefaultLayerScanMap'] = "const nat_ptr_t *default_scanMap[] = {\n"
266 # Iterate over triggerList and generate a C trigger array for the default map and default map array
267 for triggerList in range( macros.firstScanCode[ 0 ], len( macros.triggerList[ 0 ] ) ):
268 # Generate ScanCode index and triggerList length
269 self.fill_dict['DefaultLayerTriggerList'] += "Define_TL( default, 0x{0:02X} ) = {{ {1}".format( triggerList, len( macros.triggerList[ 0 ][ triggerList ] ) )
271 # Add scanCode trigger list to Default Layer Scan Map
272 self.fill_dict['DefaultLayerScanMap'] += "default_tl_0x{0:02X}, ".format( triggerList )
274 # Add each item of the trigger list
275 for trigger in macros.triggerList[ 0 ][ triggerList ]:
276 self.fill_dict['DefaultLayerTriggerList'] += ", {0}".format( trigger )
278 self.fill_dict['DefaultLayerTriggerList'] += " };\n"
279 self.fill_dict['DefaultLayerTriggerList'] = self.fill_dict['DefaultLayerTriggerList'][:-1] # Remove last newline
280 self.fill_dict['DefaultLayerScanMap'] = self.fill_dict['DefaultLayerScanMap'][:-2] # Remove last comma and space
281 self.fill_dict['DefaultLayerScanMap'] += "\n};"
284 ## Partial Layers and Partial Layer Scan Maps ##
285 self.fill_dict['PartialLayerTriggerLists'] = ""
286 self.fill_dict['PartialLayerScanMaps'] = ""
288 # Iterate over each of the layers, excluding the default layer
289 for layer in range( 1, len( macros.triggerList ) ):
291 self.fill_dict['PartialLayerScanMaps'] += "// Partial Layer {0}\n".format( layer )
292 self.fill_dict['PartialLayerScanMaps'] += "const nat_ptr_t *layer{0}_scanMap[] = {{\n".format( layer )
293 self.fill_dict['PartialLayerTriggerLists'] += "// Partial Layer {0}\n".format( layer )
295 # Iterate over triggerList and generate a C trigger array for the layer
296 for triggerList in range( macros.firstScanCode[ layer ], len( macros.triggerList[ layer ] ) ):
297 # Generate ScanCode index and triggerList length
298 self.fill_dict['PartialLayerTriggerLists'] += "Define_TL( layer{0}, 0x{1:02X} ) = {{ {2}".format( layer, triggerList, len( macros.triggerList[ layer ][ triggerList ] ) )
300 # Add scanCode trigger list to Default Layer Scan Map
301 self.fill_dict['PartialLayerScanMaps'] += "layer{0}_tl_0x{1:02X}, ".format( layer, triggerList )
303 # Add each item of the trigger list
304 for trigger in macros.triggerList[ layer ][ triggerList ]:
305 self.fill_dict['PartialLayerTriggerLists'] += ", {0}".format( trigger )
307 self.fill_dict['PartialLayerTriggerLists'] += " };\n"
308 self.fill_dict['PartialLayerTriggerLists'] += "\n"
309 self.fill_dict['PartialLayerScanMaps'] = self.fill_dict['PartialLayerScanMaps'][:-2] # Remove last comma and space
310 self.fill_dict['PartialLayerScanMaps'] += "\n};\n\n"
311 self.fill_dict['PartialLayerTriggerLists'] = self.fill_dict['PartialLayerTriggerLists'][:-2] # Remove last 2 newlines
312 self.fill_dict['PartialLayerScanMaps'] = self.fill_dict['PartialLayerScanMaps'][:-2] # Remove last 2 newlines
315 ## Layer Index List ##
316 self.fill_dict['LayerIndexList'] = "const Layer LayerIndex[] = {\n"
318 # Iterate over each layer, adding it to the list
319 for layer in range( 0, len( macros.triggerList ) ):
320 # Lookup first scancode in map
321 firstScanCode = macros.firstScanCode[ layer ]
323 # Generate stacked name
325 if '*NameStack' in variables.layerVariables[ layer ].keys():
326 for name in range( 0, len( variables.layerVariables[ layer ]['*NameStack'] ) ):
327 stackName += "{0} + ".format( variables.layerVariables[ layer ]['*NameStack'][ name ] )
328 stackName = stackName[:-3]
330 # Default map is a special case, always the first index
332 self.fill_dict['LayerIndexList'] += '\tLayer_IN( default_scanMap, "D: {1}", 0x{0:02X} ),\n'.format( firstScanCode, stackName )
334 self.fill_dict['LayerIndexList'] += '\tLayer_IN( layer{0}_scanMap, "{0}: {2}", 0x{1:02X} ),\n'.format( layer, firstScanCode, stackName )
335 self.fill_dict['LayerIndexList'] += "};"
339 self.fill_dict['LayerState'] = "uint8_t LayerState[ LayerNum ];"
342 # Generates the output keymap with fill tags filled
343 def generate( self, outputPath, definesOutputPath ):
344 # Process each line of the template, outputting to the target path
345 with open( outputPath, 'w' ) as outputFile:
346 with open( self.templatePath, 'r' ) as templateFile:
347 for line in templateFile:
348 # TODO Support multiple replacements per line
349 # TODO Support replacement with other text inline
350 match = re.findall( '<\|([^|>]+)\|>', line )
352 # If match, replace with processed variable
354 outputFile.write( self.fill_dict[ match[ 0 ] ] )
355 outputFile.write("\n")
357 # Otherwise, just append template to output file
359 outputFile.write( line )
361 # Process each line of the defines template, outputting to the target path
362 with open( definesOutputPath, 'w' ) as outputFile:
363 with open( self.definesTemplatePath, 'r' ) as templateFile:
364 for line in templateFile:
365 # TODO Support multiple replacements per line
366 # TODO Support replacement with other text inline
367 match = re.findall( '<\|([^|>]+)\|>', line )
369 # If match, replace with processed variable
371 outputFile.write( self.fill_dict[ match[ 0 ] ] )
372 outputFile.write("\n")
374 # Otherwise, just append template to output file
376 outputFile.write( line )