#
# Backend code generator for the Kiibohd Controller firmware.
#
-# Copyright (C) 2014 by Jacob Alexander
+# Copyright (C) 2014-2015 by Jacob Alexander
#
# This file is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
import sys
import re
+from datetime import date
+
# Modifying Python Path, which is dumb, but the only way to import up one directory...
sys.path.append( os.path.expanduser('..') )
+from kll_lib.backends import *
from kll_lib.containers import *
-
-
-### Decorators ###
-
- ## Print Decorator Variables
-ERROR = '\033[5;1;31mERROR\033[0m:'
-
+from kll_lib.hid_dict import *
### Classes ###
-class Backend:
- # Initializes backend
- # Looks for template file and builds list of fill tags
- def __init__( self, templatePath ):
- # Does template exist?
- if not os.path.isfile( templatePath ):
- print ( "{0} '{1}' does not exist...".format( ERROR, templatePath ) )
- sys.exit( 1 )
-
- self.templatePath = templatePath
- self.fill_dict = dict()
+class Backend( BackendBase ):
+ # Default templates and output files
+ templatePaths = ["templates/kiibohdKeymap.h", "templates/kiibohdDefs.h"]
+ outputPaths = ["generatedKeymap.h", "kll_defs.h"]
- # Generate list of fill tags
- self.tagList = []
- with open( templatePath, 'r' ) as openFile:
- for line in openFile:
- match = re.findall( '<\|([^|>]+)\|>', line )
- for item in match:
- self.tagList.append( item )
+ requiredCapabilities = {
+ 'CONS' : 'consCtrlOut',
+ 'NONE' : 'noneOut',
+ 'SYS' : 'sysCtrlOut',
+ 'USB' : 'usbKeyOut',
+ }
-
- # USB Code Capability Name
- def usbCodeCapability( self ):
- return "usbKeyOut";
+ # Capability Lookup
+ def capabilityLookup( self, type ):
+ return self.requiredCapabilities[ type ];
+ # TODO
def layerInformation( self, name, date, author ):
self.fill_dict['Information'] += "// Name: {0}\n".format( "TODO" )
self.fill_dict['Information'] += "// Version: {0}\n".format( "TODO" )
# Processes content for fill tags and does any needed dataset calculations
- def process( self, capabilities, macros ):
+ def process( self, capabilities, macros, variables, gitRev, gitChanges ):
+ # Build string list of compiler arguments
+ compilerArgs = ""
+ for arg in sys.argv:
+ if "--" in arg or ".py" in arg:
+ compilerArgs += "// {0}\n".format( arg )
+ else:
+ compilerArgs += "// {0}\n".format( arg )
+
+ # Build a string of modified files, if any
+ gitChangesStr = "\n"
+ if len( gitChanges ) > 0:
+ for gitFile in gitChanges:
+ gitChangesStr += "// {0}\n".format( gitFile )
+ else:
+ gitChangesStr = " None\n"
+
+ # Prepare BaseLayout and Layer Info
+ baseLayoutInfo = ""
+ defaultLayerInfo = ""
+ partialLayersInfo = ""
+ for file, name in zip( variables.baseLayout['*LayerFiles'], variables.baseLayout['*NameStack'] ):
+ baseLayoutInfo += "// {0}\n// {1}\n".format( name, file )
+ if '*LayerFiles' in variables.layerVariables[0].keys():
+ for file, name in zip( variables.layerVariables[0]['*LayerFiles'], variables.layerVariables[0]['*NameStack'] ):
+ defaultLayerInfo += "// {0}\n// {1}\n".format( name, file )
+ if '*LayerFiles' in variables.layerVariables[1].keys():
+ for layer in range( 1, len( variables.layerVariables ) ):
+ partialLayersInfo += "// Layer {0}\n".format( layer )
+ if len( variables.layerVariables[ layer ]['*LayerFiles'] ) > 0:
+ for file, name in zip( variables.layerVariables[ layer ]['*LayerFiles'], variables.layerVariables[ layer ]['*NameStack'] ):
+ partialLayersInfo += "// {0}\n// {1}\n".format( name, file )
+
+
## Information ##
- # TODO
self.fill_dict['Information'] = "// This file was generated by the kll compiler, DO NOT EDIT.\n"
- self.fill_dict['Information'] += "// Generation Date: {0}\n".format( "TODO" )
- self.fill_dict['Information'] += "// Compiler arguments: {0}\n".format( "TODO" )
- self.fill_dict['Information'] += "// KLL Backend: {0}\n".format( "TODO" )
- self.fill_dict['Information'] += "// KLL Git Rev: {0}\n".format( "TODO" )
+ self.fill_dict['Information'] += "// Generation Date: {0}\n".format( date.today() )
+ self.fill_dict['Information'] += "// KLL Backend: {0}\n".format( "kiibohd" )
+ self.fill_dict['Information'] += "// KLL Git Rev: {0}\n".format( gitRev )
+ self.fill_dict['Information'] += "// KLL Git Changes:{0}".format( gitChangesStr )
+ self.fill_dict['Information'] += "// Compiler arguments:\n{0}".format( compilerArgs )
self.fill_dict['Information'] += "//\n"
- self.fill_dict['Information'] += "// - Base Layer -\n"
- self.fill_dict['Information'] += "// - Default Layer -\n"
- self.fill_dict['Information'] += "// - Partial Layers -\n"
+ self.fill_dict['Information'] += "// - Base Layer -\n{0}".format( baseLayoutInfo )
+ self.fill_dict['Information'] += "// - Default Layer -\n{0}".format( defaultLayerInfo )
+ self.fill_dict['Information'] += "// - Partial Layers -\n{0}".format( partialLayersInfo )
+
+
+ ## Variable Information ##
+ self.fill_dict['VariableInformation'] = ""
+
+ # Iterate through the variables, output, and indicate the last file that modified it's value
+ # Output separate tables per file, per table and overall
+ # TODO
+
+
+ ## Defines ##
+ self.fill_dict['Defines'] = ""
+
+ # Iterate through defines and lookup the variables
+ for define in variables.defines.keys():
+ if define in variables.overallVariables.keys():
+ self.fill_dict['Defines'] += "\n#define {0} {1}".format( variables.defines[ define ], variables.overallVariables[ define ].replace( '\n', ' \\\n' ) )
+ else:
+ print( "{0} '{1}' not defined...".format( WARNING, define ) )
## Capabilities ##
# Needed for USB behaviour, otherwise, repeated keys will not work
if sequence > 0:
# <single element>, <usbCodeSend capability>, <USB Code 0x00>
- self.fill_dict['ResultMacros'] += "1, {0}, 0x00, ".format( capabilities.getIndex( self.usbCodeCapability() ) )
+ self.fill_dict['ResultMacros'] += "1, {0}, 0x00, ".format( capabilities.getIndex( self.capabilityLookup('USB') ) )
# For each combo in the sequence, add the length of the combo
self.fill_dict['ResultMacros'] += "{0}, ".format( len( macros.resultsIndexSorted[ result ][ sequence ] ) )
# Add each of the arguments of the capability
for arg in range( 0, len( resultItem[1] ) ):
- self.fill_dict['ResultMacros'] += "0x{0:02X}, ".format( resultItem[1][ arg ] )
+ # Special cases
+ if isinstance( resultItem[1][ arg ], str ):
+ # If this is a CONSUMER_ element, needs to be split into 2 elements
+ if re.match( '^CONSUMER_', resultItem[1][ arg ] ):
+ tag = resultItem[1][ arg ].split( '_', 1 )[1]
+ if '_' in tag:
+ tag = tag.replace( '_', '' )
+ lookupNum = kll_hid_lookup_dictionary['ConsCode'][ tag ][1]
+ byteForm = lookupNum.to_bytes( 2, byteorder='little' ) # XXX Yes, little endian from how the uC structs work
+ self.fill_dict['ResultMacros'] += "{0}, {1}, ".format( *byteForm )
+ continue
+
+ # None, fall-through disable
+ elif resultItem[0] is self.capabilityLookup('NONE'):
+ continue
+
+ self.fill_dict['ResultMacros'] += "{0}, ".format( resultItem[1][ arg ] )
# If sequence is longer than 1, append a sequence spacer at the end of the sequence
# Required by USB to end at sequence without holding the key down
if len( macros.resultsIndexSorted[ result ] ) > 1:
# <single element>, <usbCodeSend capability>, <USB Code 0x00>
- self.fill_dict['ResultMacros'] += "1, {0}, 0x00, ".format( capabilities.getIndex( self.usbCodeCapability() ) )
+ self.fill_dict['ResultMacros'] += "1, {0}, 0x00, ".format( capabilities.getIndex( self.capabilityLookup('USB') ) )
# Add list ending 0 and end of list
self.fill_dict['ResultMacros'] += "0 };\n"
# Lookup first scancode in map
firstScanCode = macros.firstScanCode[ layer ]
+ # Generate stacked name
+ stackName = ""
+ if '*NameStack' in variables.layerVariables[ layer ].keys():
+ for name in range( 0, len( variables.layerVariables[ layer ]['*NameStack'] ) ):
+ stackName += "{0} + ".format( variables.layerVariables[ layer ]['*NameStack'][ name ] )
+ stackName = stackName[:-3]
+
# Default map is a special case, always the first index
- # TODO Fix names
if layer == 0:
- self.fill_dict['LayerIndexList'] += '\tLayer_IN( default_scanMap, "DefaultMap", 0x{0:02X} ),\n'.format( firstScanCode )
+ self.fill_dict['LayerIndexList'] += '\tLayer_IN( default_scanMap, "D: {1}", 0x{0:02X} ),\n'.format( firstScanCode, stackName )
else:
- self.fill_dict['LayerIndexList'] += '\tLayer_IN( layer{0}_scanMap, "Layer {0}", 0x{1:02X} ),\n'.format( layer, firstScanCode )
+ self.fill_dict['LayerIndexList'] += '\tLayer_IN( layer{0}_scanMap, "{0}: {2}", 0x{1:02X} ),\n'.format( layer, firstScanCode, stackName )
self.fill_dict['LayerIndexList'] += "};"
## Layer State ##
self.fill_dict['LayerState'] = "uint8_t LayerState[ LayerNum ];"
-
- # Generates the output keymap with fill tags filled
- def generate( self, filepath ):
- # Process each line of the template, outputting to the target path
- with open( filepath, 'w' ) as outputFile:
- with open( self.templatePath, 'r' ) as templateFile:
- for line in templateFile:
- # TODO Support multiple replacements per line
- # TODO Support replacement with other text inline
- match = re.findall( '<\|([^|>]+)\|>', line )
-
- # If match, replace with processed variable
- if match:
- outputFile.write( self.fill_dict[ match[ 0 ] ] )
- outputFile.write("\n")
-
- # Otherwise, just append template to output file
- else:
- outputFile.write( line )
-
projects / kiibohd-kll.git / blobdiff