]> git.donarmstrong.com Git - kiibohd-kll.git/blobdiff - backends/kiibohd.py
Adding support for multi-line defines
[kiibohd-kll.git] / backends / kiibohd.py
index 13d19191078723e6fba83bbab6459c8bf452d1ea..9f47150451cb706fae115ac54f31be92d83e190f 100644 (file)
@@ -29,49 +29,28 @@ 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 *
+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 ):
+       # 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
@@ -106,12 +85,15 @@ class Backend:
                partialLayersInfo = ""
                for file, name in zip( variables.baseLayout['*LayerFiles'], variables.baseLayout['*NameStack'] ):
                        baseLayoutInfo += "//    {0}\n//      {1}\n".format( name, file )
-               for file, name in zip( variables.layerVariables[0]['*LayerFiles'], variables.layerVariables[0]['*NameStack'] ):
-                       defaultLayerInfo += "//    {0}\n//      {1}\n".format( name, file )
-               for layer in range( 1, len( variables.layerVariables ) ):
-                       partialLayersInfo += "//    Layer {0}\n".format( layer )
-                       for file, name in zip( variables.layerVariables[ layer ]['*LayerFiles'], variables.layerVariables[ layer ]['*NameStack'] ):
-                               partialLayersInfo += "//     {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 ##
@@ -141,7 +123,7 @@ class Backend:
                # 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' ) )
                        else:
                                print( "{0} '{1}' not defined...".format( WARNING, define ) )
 
@@ -172,7 +154,7 @@ class Backend:
                                # 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 ] ) )
@@ -186,13 +168,29 @@ class Backend:
 
                                        # Add each of the arguments of the capability
                                        for arg in range( 0, len( resultItem[1] ) ):
+                                               # 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"
@@ -319,9 +317,10 @@ class Backend:
 
                        # Generate stacked name
                        stackName = ""
-                       for name in range( 0, len( variables.layerVariables[ layer ]['*NameStack'] ) ):
-                               stackName += "{0} + ".format( variables.layerVariables[ layer ]['*NameStack'][ name ] )
-                       stackName = stackName[:-3]
+                       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
                        if layer == 0:
@@ -334,40 +333,3 @@ class Backend:
                ## 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 )
-