#!/usr/bin/env python3
-# KLL Compiler - Kiibohd Backend
-#
-# Backend code generator for the Kiibohd Controller firmware.
-#
-# Copyright (C) 2014-2015 by Jacob Alexander
+'''
+KLL Compiler - Kiibohd Backend
+
+Backend code generator for the Kiibohd Controller firmware.
+'''
+# Copyright (C) 2014-2016 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
# 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 *
+from kll_lib.hid_dict import *
-### Decorators ###
-
- ## Print Decorator Variables
-ERROR = '\033[5;1;31mERROR\033[0m:'
-WARNING = '\033[5;1;33mWARNING\033[0m:'
+### Classes ###
+class Backend( BackendBase ):
+ '''
+ Kiibohd Code-Generation Backend
+ Kiibohd specific code generation.
+ '''
+ # Default templates and output files
+ templatePaths = ["templates/kiibohdKeymap.h", "templates/kiibohdDefs.h"]
+ outputPaths = ["generatedKeymap.h", "kll_defs.h"]
-### Classes ###
+ requiredCapabilities = {
+ 'CONS' : 'consCtrlOut',
+ 'NONE' : 'noneOut',
+ 'SYS' : 'sysCtrlOut',
+ 'USB' : 'usbKeyOut',
+ }
-class Backend:
- # Initializes backend
- # Looks for template file and builds list of fill tags
- def __init__( self, templatePath, definesTemplatePath ):
- # Does template exist?
- if not os.path.isfile( templatePath ):
- print ( "{0} '{1}' does not exist...".format( ERROR, templatePath ) )
- sys.exit( 1 )
-
- self.definesTemplatePath = definesTemplatePath
- self.templatePath = templatePath
- self.fill_dict = dict()
-
- # 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 )
- with open( definesTemplatePath, 'r' ) as openFile:
- for line in openFile:
- match = re.findall( '<\|([^|>]+)\|>', line )
- for item in match:
- self.tagList.append( item )
-
-
- # USB Code Capability Name
- def usbCodeCapability( self ):
- return "usbKeyOut";
+ # Capability Lookup
+ def capabilityLookup( self, type ):
+ return self.requiredCapabilities[ type ];
# TODO
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( date.today() )
self.fill_dict['Information'] += "// KLL Backend: {0}\n".format( "kiibohd" )
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 ##
## Defines ##
self.fill_dict['Defines'] = ""
+ stateWordSize = ""
# 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 ] )
+ self.fill_dict['Defines'] += "\n#define {0} {1}".format( variables.defines[ define ], variables.overallVariables[ define ].replace( '\n', ' \\\n' ) )
+ if define == "stateWordSize":
+ stateWordSize = variables.overallVariables[ define ]
else:
print( "{0} '{1}' not defined...".format( WARNING, define ) )
## Capabilities ##
+ self.fill_dict['CapabilitiesFuncDecl'] = ""
self.fill_dict['CapabilitiesList'] = "const Capability CapabilitiesList[] = {\n"
+ self.fill_dict['CapabilitiesIndices'] = "typedef enum CapabilityIndex {\n"
# Keys are pre-sorted
for key in capabilities.keys():
funcName = capabilities.funcName( key )
argByteWidth = capabilities.totalArgBytes( key )
self.fill_dict['CapabilitiesList'] += "\t{{ {0}, {1} }},\n".format( funcName, argByteWidth )
+ self.fill_dict['CapabilitiesFuncDecl'] += "void {0}( uint8_t state, uint8_t stateType, uint8_t *args );\n".format( funcName )
+ self.fill_dict['CapabilitiesIndices'] += "\t{0}_index,\n".format( funcName )
self.fill_dict['CapabilitiesList'] += "};"
+ self.fill_dict['CapabilitiesIndices'] += "} CapabilityIndex;"
+
+ # Define for total number of capabilities
+ self.fill_dict['Defines'] += "\n#define CapabilitiesNum_KLL {0}".format( len( capabilities.keys() ) )
## Results Macros ##
# 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
+ # AC_ and AL_ are other sections of consumer control
+ if re.match( '^(CONSUMER|AC|AL)_', resultItem[1][ arg ] ):
+ tag = resultItem[1][ arg ].split( '_', 1 )[1]
+ if '_' in tag:
+ tag = tag.replace( '_', '' )
+ try:
+ lookupNum = kll_hid_lookup_dictionary['ConsCode'][ tag ][1]
+ except KeyError as err:
+ print ( "{0} {1} Consumer HID kll bug...please report.".format( ERROR, err ) )
+ raise
+ 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"
self.fill_dict['ResultMacroList'] += "\tDefine_RM( {0} ),\n".format( result )
self.fill_dict['ResultMacroList'] += "};"
+ results_count = len( macros.resultsIndexSorted )
+
## Result Macro Record ##
self.fill_dict['ResultMacroRecord'] = "ResultMacroRecord ResultMacroRecordList[ ResultMacroNum ];"
+ # Define for total number of Result Macros
+ self.fill_dict['Defines'] += "\n#define ResultMacroNum_KLL {0}".format( len( macros.resultsIndexSorted ) )
+
## Trigger Macros ##
self.fill_dict['TriggerMacros'] = ""
# Iterate through each of the trigger macros
+ triggers_count = len( macros.triggersIndexSorted );
for trigger in range( 0, len( macros.triggersIndexSorted ) ):
self.fill_dict['TriggerMacros'] += "Guide_TM( {0} ) = {{ ".format( trigger )
# Add the trigger macro scan code guide
# See kiibohd controller Macros/PartialMap/kll.h for exact formatting details
- for sequence in range( 0, len( macros.triggersIndexSorted[ trigger ][ 0 ] ) ):
+ for sequence in range( 0, len( macros.triggersIndexSorted[ trigger ][0] ) ):
# For each combo in the sequence, add the length of the combo
self.fill_dict['TriggerMacros'] += "{0}, ".format( len( macros.triggersIndexSorted[ trigger ][0][ sequence ] ) )
# For each combo, add the key type, key state and scan code
- for combo in range( 0, len( macros.triggersIndexSorted[ trigger ][ 0 ][ sequence ] ) ):
- triggerItem = macros.triggersIndexSorted[ trigger ][ 0 ][ sequence ][ combo ]
+ for combo in range( 0, len( macros.triggersIndexSorted[ trigger ][0][ sequence ] ) ):
+ triggerItemId = macros.triggersIndexSorted[ trigger ][0][ sequence ][ combo ]
+
+ # Lookup triggerItem in ScanCodeStore
+ triggerItemObj = macros.scanCodeStore[ triggerItemId ]
+ triggerItem = triggerItemObj.offset( macros.interconnectOffset )
# TODO Add support for Analog keys
# TODO Add support for LED states
self.fill_dict['TriggerMacros'] += "0 };\n"
self.fill_dict['TriggerMacros'] = self.fill_dict['TriggerMacros'][ :-1 ] # Remove last newline
+ # check for too small stateWordSize
+ if stateWordSize == "8" and (triggers_count > 255 or results_count > 255):
+ print ("{0} Over 255 trigger or result macros, changing stateWordSize from {1} to 16.".format( WARNING, stateWordSize ) )
+ print( "Results count: ", results_count )
+ print( "Triggers count: ", triggers_count )
+ stateWordSize == "16"
+ self.fill_dict['Defines'] = self.fill_dict['Defines'].replace("StateWordSize_define 8", "StateWordSize_define 16")
## Trigger Macro List ##
self.fill_dict['TriggerMacroList'] = "const TriggerMacro TriggerMacroList[] = {\n"
## Trigger Macro Record ##
self.fill_dict['TriggerMacroRecord'] = "TriggerMacroRecord TriggerMacroRecordList[ TriggerMacroNum ];"
+ # Define for total number of Trigger Macros
+ self.fill_dict['Defines'] += "\n#define TriggerMacroNum_KLL {0}".format( len( macros.triggersIndexSorted ) )
+
## Max Scan Code ##
self.fill_dict['MaxScanCode'] = "#define MaxScanCode 0x{0:X}".format( macros.overallMaxScanCode )
+ ## Interconnect ScanCode Offset List ##
+ self.fill_dict['ScanCodeInterconnectOffsetList'] = "const uint8_t InterconnectOffsetList[] = {\n"
+ for offset in range( 0, len( macros.interconnectOffset ) ):
+ self.fill_dict['ScanCodeInterconnectOffsetList'] += "\t0x{0:02X},\n".format( macros.interconnectOffset[ offset ] )
+ self.fill_dict['ScanCodeInterconnectOffsetList'] += "};"
+
+
+ ## Max Interconnect Nodes ##
+ self.fill_dict['InterconnectNodeMax'] = "#define InterconnectNodeMax 0x{0:X}\n".format( len( macros.interconnectOffset ) )
+
+
## Default Layer and Default Layer Scan Map ##
self.fill_dict['DefaultLayerTriggerList'] = ""
self.fill_dict['DefaultLayerScanMap'] = "const nat_ptr_t *default_scanMap[] = {\n"
# Iterate over triggerList and generate a C trigger array for the default map and default map array
- for triggerList in range( macros.firstScanCode[ 0 ], len( macros.triggerList[ 0 ] ) ):
+ for triggerList in range( macros.firstScanCode[0], len( macros.triggerList[0] ) ):
# Generate ScanCode index and triggerList length
- self.fill_dict['DefaultLayerTriggerList'] += "Define_TL( default, 0x{0:02X} ) = {{ {1}".format( triggerList, len( macros.triggerList[ 0 ][ triggerList ] ) )
+ self.fill_dict['DefaultLayerTriggerList'] += "Define_TL( default, 0x{0:02X} ) = {{ {1}".format( triggerList, len( macros.triggerList[0][ triggerList ] ) )
# Add scanCode trigger list to Default Layer Scan Map
self.fill_dict['DefaultLayerScanMap'] += "default_tl_0x{0:02X}, ".format( triggerList )
# Add each item of the trigger list
- for trigger in macros.triggerList[ 0 ][ triggerList ]:
- self.fill_dict['DefaultLayerTriggerList'] += ", {0}".format( trigger )
+ for triggerItem in macros.triggerList[0][ triggerList ]:
+ self.fill_dict['DefaultLayerTriggerList'] += ", {0}".format( triggerItem )
self.fill_dict['DefaultLayerTriggerList'] += " };\n"
self.fill_dict['DefaultLayerTriggerList'] = self.fill_dict['DefaultLayerTriggerList'][:-1] # Remove last newline
# 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'] += "};"
+ # Define for total number of Trigger Macros
+ self.fill_dict['Defines'] += "\n#define LayerNum_KLL {0}".format( len( macros.triggerList ) )
+
## Layer State ##
self.fill_dict['LayerState'] = "uint8_t LayerState[ LayerNum ];"
-
- # Generates the output keymap with fill tags filled
- def generate( self, outputPath, definesOutputPath ):
- # Process each line of the template, outputting to the target path
- with open( outputPath, '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 )
-
- # Process each line of the defines template, outputting to the target path
- with open( definesOutputPath, 'w' ) as outputFile:
- with open( self.definesTemplatePath, '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 )
-