kll_lib/containers.py

   1 #!/usr/bin/env python3
   2 # KLL Compiler Containers
   3 #
   4 # Copyright (C) 2014 by Jacob Alexander
   5 #
   6 # This file is free software: you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation, either version 3 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # This file is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with this file.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 ### Imports ###
  20
  21 import copy
  22
  23
  24
  25 ### Decorators ###
  26
  27  ## Print Decorator Variables
  28 ERROR = '\033[5;1;31mERROR\033[0m:'
  29
  30
  31
  32 ### Parsing ###
  33
  34
  35  ## Containers
  36
  37 class Capabilities:
  38         # Container for capabilities dictionary and convenience functions
  39         def __init__( self ):
  40                 self.capabilities = dict()
  41
  42         def __getitem__( self, name ):
  43                 return self.capabilities[ name ]
  44
  45         def __setitem__( self, name, contents ):
  46                 self.capabilities[ name ] = contents
  47
  48         def __repr__( self ):
  49                 return "Capabilities => {0}\nIndexed Capabilities => {1}".format( self.capabilities, sorted( self.capabilities, key = self.capabilities.get ) )
  50
  51
  52         # Total bytes needed to store arguments
  53         def totalArgBytes( self, name ):
  54                 totalBytes = 0
  55
  56                 # Iterate over the arguments, summing the total bytes
  57                 for arg in self.capabilities[ name ][ 1 ]:
  58                         totalBytes += int( arg[ 1 ] )
  59
  60                 return totalBytes
  61
  62         # Name of the capability function
  63         def funcName( self, name ):
  64                 return self.capabilities[ name ][ 0 ]
  65
  66
  67         # Only valid while dictionary keys are not added/removed
  68         def getIndex( self, name ):
  69                 return sorted( self.capabilities, key = self.capabilities.get ).index( name )
  70
  71         def getName( self, index ):
  72                 return sorted( self.capabilities, key = self.capabilities.get )[ index ]
  73
  74         def keys( self ):
  75                 return sorted( self.capabilities, key = self.capabilities.get )
  76
  77
  78 class Macros:
  79         # Container for Trigger Macro : Result Macro correlation
  80         # Layer selection for generating TriggerLists
  81         #
  82         # Only convert USB Code list once all the ResultMacros have been accumulated (does a macro reduction; not reversible)
  83         # Two staged list for ResultMacros:
  84         #  1) USB Code/Non-converted (may contain capabilities)
  85         #  2) Capabilities
  86         def __init__( self ):
  87                 # Default layer (0)
  88                 self.layer = 0
  89
  90                 # Macro Storage
  91                 self.macros = [ dict() ]
  92
  93                 # Base Layout Storage
  94                 self.baseLayout = None
  95                 self.layerLayoutMarkers = []
  96
  97                 # Correlated Macro Data
  98                 self.resultsIndex = dict()
  99                 self.triggersIndex = dict()
 100                 self.resultsIndexSorted = []
 101                 self.triggersIndexSorted = []
 102                 self.triggerList = []
 103                 self.maxScanCode = []
 104                 self.firstScanCode = []
 105
 106                 # USBCode Assignment Cache
 107                 self.assignmentCache = []
 108
 109         def __repr__( self ):
 110                 return "{0}".format( self.macros )
 111
 112         def completeBaseLayout( self ):
 113                 # Copy base layout for later use when creating partial layers and add marker
 114                 self.baseLayout = copy.deepcopy( self.macros[ 0 ] )
 115                 self.layerLayoutMarkers.append( copy.deepcopy( self.baseLayout ) ) # Not used for default layer, just simplifies coding
 116
 117         def removeUnmarked( self ):
 118                 # Remove all of the unmarked mappings from the partial layer
 119                 for trigger in self.layerLayoutMarkers[ self.layer ].keys():
 120                         del self.macros[ self.layer ][ trigger ]
 121
 122         def addLayer( self ):
 123                 # Increment layer count, and append another macros dictionary
 124                 self.layer += 1
 125                 self.macros.append( copy.deepcopy( self.baseLayout ) )
 126
 127                 # Add a layout marker for each layer
 128                 self.layerLayoutMarkers.append( copy.deepcopy( self.baseLayout ) )
 129
 130         # Use for ScanCode trigger macros
 131         def appendScanCode( self, trigger, result ):
 132                 if not trigger in self.macros[ self.layer ]:
 133                         self.replaceScanCode( trigger, result )
 134                 else:
 135                         self.macros[ self.layer ][ trigger ].append( result )
 136
 137         # Remove the given trigger/result pair
 138         def removeScanCode( self, trigger, result ):
 139                 # Remove all instances of the given trigger/result pair
 140                 while result in self.macros[ self.layer ][ trigger ]:
 141                         self.macros[ self.layer ][ trigger ].remove( result )
 142
 143         # Replaces the given trigger with the given result
 144         # If multiple results for a given trigger, clear, then add
 145         def replaceScanCode( self, trigger, result ):
 146                 self.macros[ self.layer ][ trigger ] = [ result ]
 147
 148                 # Mark layer scan code, so it won't be removed later
 149                 # Also check to see if it hasn't already been removed before
 150                 if not self.baseLayout is None and trigger in self.layerLayoutMarkers[ self.layer ]:
 151                         del self.layerLayoutMarkers[ self.layer ][ trigger ]
 152
 153         # Return a list of ScanCode triggers with the given USB Code trigger
 154         def lookupUSBCodes( self, usbCode ):
 155                 scanCodeList = []
 156
 157                 # Scan current layer for USB Codes
 158                 for macro in self.macros[ self.layer ].keys():
 159                         if usbCode in self.macros[ self.layer ][ macro ]:
 160                                 scanCodeList.append( macro )
 161
 162                 return scanCodeList
 163
 164         # Cache USBCode Assignment
 165         def cacheAssignment( self, operator, scanCode, result ):
 166                 self.assignmentCache.append( [ operator, scanCode, result ] )
 167
 168         # Assign cached USBCode Assignments
 169         def replayCachedAssignments( self ):
 170                 # Iterate over each item in the assignment cache
 171                 for item in self.assignmentCache:
 172                         # Check operator, and choose the specified assignment action
 173                         # Append Case
 174                         if item[0] == ":+":
 175                                 self.appendScanCode( item[1], item[2] )
 176
 177                         # Remove Case
 178                         elif item[0] == ":-":
 179                                 self.removeScanCode( item[1], item[2] )
 180
 181                         # Replace Case
 182                         elif item[0] == ":":
 183                                 self.replaceScanCode( item[1], item[2] )
 184
 185                 # Clear assignment cache
 186                 self.assignmentCache = []
 187
 188         # Generate/Correlate Layers
 189         def generate( self ):
 190                 self.generateIndices()
 191                 self.sortIndexLists()
 192                 self.generateTriggerLists()
 193
 194         # Generates Index of Results and Triggers
 195         def generateIndices( self ):
 196                 # Iterate over every trigger result, and add to the resultsIndex and triggersIndex
 197                 for layer in range( 0, len( self.macros ) ):
 198                         for trigger in self.macros[ layer ].keys():
 199                                 # Each trigger has a list of results
 200                                 for result in self.macros[ layer ][ trigger ]:
 201                                         # Only add, with an index, if result hasn't been added yet
 202                                         if not result in self.resultsIndex:
 203                                                 self.resultsIndex[ result ] = len( self.resultsIndex )
 204
 205                                         # Then add a trigger for each result, if trigger hasn't been added yet
 206                                         triggerItem = tuple( [ trigger, self.resultsIndex[ result ] ] )
 207                                         if not triggerItem in self.triggersIndex:
 208                                                 self.triggersIndex[ triggerItem ] = len( self.triggersIndex )
 209
 210         # Sort Index Lists using the indices rather than triggers/results
 211         def sortIndexLists( self ):
 212                 self.resultsIndexSorted = [ None ] * len( self.resultsIndex )
 213                 # Iterate over the resultsIndex and sort by index
 214                 for result in self.resultsIndex.keys():
 215                         self.resultsIndexSorted[ self.resultsIndex[ result ] ] = result
 216
 217                 self.triggersIndexSorted = [ None ] * len( self.triggersIndex )
 218                 # Iterate over the triggersIndex and sort by index
 219                 for trigger in self.triggersIndex.keys():
 220                         self.triggersIndexSorted[ self.triggersIndex[ trigger ] ] = trigger
 221
 222         # Generates Trigger Lists per layer using index lists
 223         def generateTriggerLists( self ):
 224                 for layer in range( 0, len( self.macros ) ):
 225                         # Set max scancode to 0xFF (255)
 226                         # But keep track of the actual max scancode and reduce the list size
 227                         self.triggerList.append( [ [] ] * 0xFF )
 228                         self.maxScanCode.append( 0x00 )
 229
 230                         # Iterate through trigger macros to locate necessary ScanCodes and corresponding triggerIndex
 231                         for trigger in self.macros[ layer ].keys():
 232                                 for variant in range( 0, len( self.macros[ layer ][ trigger ] ) ):
 233                                         # Identify result index
 234                                         resultIndex = self.resultsIndex[ self.macros[ layer ][ trigger ][ variant ] ]
 235
 236                                         # Identify trigger index
 237                                         triggerIndex = self.triggersIndex[ tuple( [ trigger, resultIndex ] ) ]
 238
 239                                         # Iterate over the trigger to locate the ScanCodes
 240                                         for sequence in trigger:
 241                                                 for combo in sequence:
 242                                                         # Append triggerIndex for each found scanCode of the Trigger List
 243                                                         # Do not re-add if triggerIndex is already in the Trigger List
 244                                                         if not triggerIndex in self.triggerList[ layer ][ combo ]:
 245                                                                 # Append is working strangely with list pre-initialization
 246                                                                 # Doing a 0 check replacement instead -HaaTa
 247                                                                 if len( self.triggerList[ layer ][ combo ] ) == 0:
 248                                                                         self.triggerList[ layer ][ combo ] = [ triggerIndex ]
 249                                                                 else:
 250                                                                         self.triggerList[ layer ][ combo ].append( triggerIndex )
 251
 252                                                         # Look for max Scan Code
 253                                                         if combo > self.maxScanCode[ layer ]:
 254                                                                 self.maxScanCode[ layer ] = combo
 255
 256                         # Shrink triggerList to actual max size
 257                         self.triggerList[ layer ] = self.triggerList[ layer ][ : self.maxScanCode[ layer ] + 1 ]
 258
 259                         # Calculate first scan code for layer, useful for uC implementations trying to save RAM
 260                         firstScanCode = 0
 261                         for triggerList in range( 0, len( self.triggerList[ layer ] ) ):
 262                                 firstScanCode = triggerList
 263
 264                                 # Break if triggerList has items
 265                                 if len( self.triggerList[ layer ][ triggerList ] ) > 0:
 266                                         break;
 267                         self.firstScanCode.append( firstScanCode )
 268
 269                 # Determine overall maxScanCode
 270                 self.overallMaxScanCode = 0x00
 271                 for maxVal in self.maxScanCode:
 272                         if maxVal > self.overallMaxScanCode:
 273                                 self.overallMaxScanCode = maxVal
 274
 275
 276 class Variables:
 277         # Container for variables
 278         # Stores three sets of variables, the overall combined set, per layer, and per file
 279         def __init__( self ):
 280                 pass
 281
 282         def baseLayerFinished( self ):
 283                 pass
 284
 285         def setCurrentFile( self, name ):
 286                 # Store using filename and current layer
 287                 pass
 288
 289         def setCurrentLayer( self, layer ):
 290                 # Store using layer index
 291                 pass
 292
 293         def assignVariable( self, key, value ):
 294                 pass
 295