## Print Decorator Variables
ERROR = '\033[5;1;31mERROR\033[0m:'
+WARNING = '\033[5;1;33mWARNING\033[0m:'
class Backend:
# Initializes backend
# Looks for template file and builds list of fill tags
- def __init__( self, templatePath ):
+ 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()
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
# Processes content for fill tags and does any needed dataset calculations
- def process( self, capabilities, macros ):
+ def process( self, capabilities, macros, variables ):
## 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 Backend: {0}\n".format( "kiibohd" )
self.fill_dict['Information'] += "// KLL Git Rev: {0}\n".format( "TODO" )
self.fill_dict['Information'] += "//\n"
self.fill_dict['Information'] += "// - Base Layer -\n"
self.fill_dict['Information'] += "// - Partial Layers -\n"
+ ## 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 ] )
+ else:
+ print( "{0} '{1}' not defined...".format( WARNING, define ) )
+
+
## Capabilities ##
self.fill_dict['CapabilitiesList'] = "const Capability CapabilitiesList[] = {\n"
# Generates the output keymap with fill tags filled
- def generate( self, filepath ):
+ def generate( self, outputPath, definesOutputPath ):
# Process each line of the template, outputting to the target path
- with open( filepath, 'w' ) as outputFile:
+ with open( outputPath, 'w' ) as outputFile:
with open( self.templatePath, 'r' ) as templateFile:
for line in templateFile:
# TODO Support multiple replacements per line
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 )
+
pArgs.add_argument( '-t', '--template', type=str, default="templates/kiibohdKeymap.h",
help="Specify template used to generate the keymap.\n"
"Default: templates/kiibohdKeymap.h" )
- pArgs.add_argument( '-o', '--output', type=str, default="templateKeymap.h",
+ pArgs.add_argument( '--defines-template', type=str, default="templates/kiibohdDefs.h",
+ help="Specify template used to generate kll_defs.h.\n"
+ "Default: templates/kiibohdDefs.h" )
+ pArgs.add_argument( '-o', '--output', type=str, default="generatedKeymap.h",
help="Specify output file. Writes to current working directory by default.\n"
"Default: generatedKeymap.h" )
+ pArgs.add_argument( '--defines-output', type=str, default="kll_defs.h",
+ help="Specify output path for kll_defs.h. Writes to current working directory by default.\n"
+ "Default: kll_defs.h" )
pArgs.add_argument( '-h', '--help', action="help",
help="This message." )
for filename in partial:
checkFileExists( filename )
- return (baseFiles, defaultFiles, partialFileSets, args.backend, args.template, args.output)
+ return (baseFiles, defaultFiles, partialFileSets, args.backend, args.template, args.defines_template, args.output, args.defines_output)
## Map Arrays
macros_map = Macros()
-variable_dict = dict()
+variables_dict = Variables()
capabilities_dict = Capabilities()
def make_string( token ):
return token[1:-1]
+def make_unseqString( token ):
+ return token[1:-1]
+
def make_number( token ):
return int( token, 0 )
for item in content:
assigned_content += str( item )
- variable_dict[ name ] = assigned_content
+ variables_dict.assignVariable( name, assigned_content )
def eval_capability( name, function, args ):
capabilities_dict[ name ] = [ function, args ]
+def eval_define( name, cdefine_name ):
+ variables_dict.defines[ name ] = cdefine_name
+
map_scanCode = unarg( eval_scanCode )
map_usbCode = unarg( eval_usbCode )
set_variable = unarg( eval_variable )
set_capability = unarg( eval_capability )
+set_define = unarg( eval_define )
## Sub Rules
-usbCode = tokenType('USBCode') >> make_usbCode
-scanCode = tokenType('ScanCode') >> make_scanCode
-name = tokenType('Name')
-number = tokenType('Number') >> make_number
-comma = tokenType('Comma')
-dash = tokenType('Dash')
-plus = tokenType('Plus')
-content = tokenType('VariableContents')
-string = tokenType('String') >> make_string
-unString = tokenType('String') # When the double quotes are still needed for internal processing
-seqString = tokenType('SequenceString') >> make_seqString
+usbCode = tokenType('USBCode') >> make_usbCode
+scanCode = tokenType('ScanCode') >> make_scanCode
+name = tokenType('Name')
+number = tokenType('Number') >> make_number
+comma = tokenType('Comma')
+dash = tokenType('Dash')
+plus = tokenType('Plus')
+content = tokenType('VariableContents')
+string = tokenType('String') >> make_string
+unString = tokenType('String') # When the double quotes are still needed for internal processing
+seqString = tokenType('SequenceString') >> make_seqString
+unseqString = tokenType('SequenceString') >> make_unseqString # For use with variables
# Code variants
code_end = tokenType('CodeEnd')
## Main Rules
#| <variable> = <variable contents>;
-variable_contents = name | content | string | number | comma | dash
+variable_contents = name | content | string | number | comma | dash | unseqString
variable_expression = name + skip( operator('=') ) + oneplus( variable_contents ) + skip( eol ) >> set_variable
#| <capability name> => <c function>;
capability_arguments = name + skip( operator(':') ) + number + skip( maybe( comma ) )
capability_expression = name + skip( operator('=>') ) + name + skip( parenthesis('(') ) + many( capability_arguments ) + skip( parenthesis(')') ) + skip( eol ) >> set_capability
+#| <define name> => <c define>;
+define_expression = name + skip( operator('=>') ) + name + skip( eol ) >> set_define
+
#| <trigger> : <result>;
operatorTriggerResult = operator(':') | operator(':+') | operator(':-')
scanCode_expression = triggerCode_outerList + operatorTriggerResult + resultCode_outerList + skip( eol ) >> map_scanCode
"""Sequence(Token) -> object"""
# Top-level Parser
- expression = scanCode_expression | usbCode_expression | variable_expression | capability_expression
+ expression = scanCode_expression | usbCode_expression | variable_expression | capability_expression | define_expression
kll_text = many( expression )
kll_file = maybe( kll_text ) + skip( finished )
### Main Entry Point ###
if __name__ == '__main__':
- (baseFiles, defaultFiles, partialFileSets, backend_name, template, output) = processCommandLineArgs()
+ (baseFiles, defaultFiles, partialFileSets, backend_name, template, defines_template, output, defines_output) = processCommandLineArgs()
# Load backend module
global backend
backend_import = importlib.import_module( "backends.{0}".format( backend_name ) )
- backend = backend_import.Backend( template )
+ backend = backend_import.Backend( template, defines_template )
# Process base layout files
for filename in baseFiles:
+ variables_dict.setCurrentFile( filename )
processKLLFile( filename )
macros_map.completeBaseLayout() # Indicates to macros_map that the base layout is complete
+ variables_dict.baseLayoutFinished()
# Default combined layer
for filename in defaultFiles:
+ variables_dict.setCurrentFile( filename )
processKLLFile( filename )
# Apply assignment cache, see 5.1.2 USB Codes for why this is necessary
macros_map.replayCachedAssignments()
for partial in partialFileSets:
# Increment layer for each -p option
macros_map.addLayer()
+ variables_dict.incrementLayer() # DefaultLayer is layer 0
+
# Iterate and process each of the file in the layer
for filename in partial:
+ variables_dict.setCurrentFile( filename )
processKLLFile( filename )
+
# Apply assignment cache, see 5.1.2 USB Codes for why this is necessary
macros_map.replayCachedAssignments()
# Remove un-marked keys to complete the partial layer
macros_map.generate()
# Process needed templating variables using backend
- backend.process( capabilities_dict, macros_map )
+ backend.process( capabilities_dict, macros_map, variables_dict )
# Generate output file using template and backend
- backend.generate( output )
+ backend.generate( output, defines_output )
# Successful Execution
sys.exit( 0 )
# Container for variables
# Stores three sets of variables, the overall combined set, per layer, and per file
def __init__( self ):
- pass
+ # Dictionaries of variables
+ self.baseLayout = dict()
+ self.fileVariables = dict()
+ self.layerVariables = [ dict() ]
+ self.overallVariables = dict()
+ self.defines = dict()
- def baseLayerFinished( self ):
- pass
+ self.currentFile = ""
+ self.currentLayer = 0
+ self.baseLayoutEnabled = True
+
+ def baseLayoutFinished( self ):
+ self.baseLayoutEnabled = False
def setCurrentFile( self, name ):
# Store using filename and current layer
- pass
+ self.currentFile = name
+ self.fileVariables[ name ] = dict()
+
+ # If still processing BaseLayout
+ if self.baseLayoutEnabled:
+ self.baseLayout['*LayerFiles'] = name
+ # Set for the current layer
+ else:
+ self.layerVariables[ self.currentLayer ]['*LayerFiles'] = name
- def setCurrentLayer( self, layer ):
+ def incrementLayer( self ):
# Store using layer index
- pass
+ self.currentLayer += 1
+ self.layerVariables.append( dict() )
def assignVariable( self, key, value ):
- pass
+ # Overall set of variables
+ self.overallVariables[ key ] = value
+
+ # If still processing BaseLayout
+ if self.baseLayoutEnabled:
+ self.baseLayout[ key ] = value
+ # Set for the current layer
+ else:
+ self.layerVariables[ self.currentLayer ][ key ] = value
+
+ # File context variables
+ self.fileVariables[ self.currentFile ][ key ] = value