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                 if not self.baseLayout is None:
 150                         del self.layerLayoutMarkers[ self.layer ][ trigger ]
 151
 152         # Return a list of ScanCode triggers with the given USB Code trigger
 153         def lookupUSBCodes( self, usbCode ):
 154                 scanCodeList = []
 155
 156                 # Scan current layer for USB Codes
 157                 for macro in self.macros[ self.layer ].keys():
 158                         if usbCode in self.macros[ self.layer ][ macro ]:
 159                                 scanCodeList.append( macro )
 160
 161                 return scanCodeList
 162
 163         # Cache USBCode Assignment
 164         def cacheAssignment( self, operator, scanCode, result ):
 165                 self.assignmentCache.append( [ operator, scanCode, result ] )
 166
 167         # Assign cached USBCode Assignments
 168         def replayCachedAssignments( self ):
 169                 # Iterate over each item in the assignment cache
 170                 for item in self.assignmentCache:
 171                         # Check operator, and choose the specified assignment action
 172                         # Append Case
 173                         if item[0] == ":+":
 174                                 self.appendScanCode( item[1], item[2] )
 175
 176                         # Remove Case
 177                         elif item[0] == ":-":
 178                                 self.removeScanCode( item[1], item[2] )
 179
 180                         # Replace Case
 181                         elif item[0] == ":":
 182                                 self.replaceScanCode( item[1], item[2] )
 183
 184                 # Clear assignment cache
 185                 self.assignmentCache = []
 186
 187         # Generate/Correlate Layers
 188         def generate( self ):
 189                 self.generateIndices()
 190                 self.sortIndexLists()
 191                 self.generateTriggerLists()
 192
 193         # Generates Index of Results and Triggers
 194         def generateIndices( self ):
 195                 # Iterate over every trigger result, and add to the resultsIndex and triggersIndex
 196                 for layer in range( 0, len( self.macros ) ):
 197                         for trigger in self.macros[ layer ].keys():
 198                                 # Each trigger has a list of results
 199                                 for result in self.macros[ layer ][ trigger ]:
 200                                         # Only add, with an index, if result hasn't been added yet
 201                                         if not result in self.resultsIndex:
 202                                                 self.resultsIndex[ result ] = len( self.resultsIndex )
 203
 204                                         # Then add a trigger for each result, if trigger hasn't been added yet
 205                                         triggerItem = tuple( [ trigger, self.resultsIndex[ result ] ] )
 206                                         if not triggerItem in self.triggersIndex:
 207                                                 self.triggersIndex[ triggerItem ] = len( self.triggersIndex )
 208
 209         # Sort Index Lists using the indices rather than triggers/results
 210         def sortIndexLists( self ):
 211                 self.resultsIndexSorted = [ None ] * len( self.resultsIndex )
 212                 # Iterate over the resultsIndex and sort by index
 213                 for result in self.resultsIndex.keys():
 214                         self.resultsIndexSorted[ self.resultsIndex[ result ] ] = result
 215
 216                 self.triggersIndexSorted = [ None ] * len( self.triggersIndex )
 217                 # Iterate over the triggersIndex and sort by index
 218                 for trigger in self.triggersIndex.keys():
 219                         self.triggersIndexSorted[ self.triggersIndex[ trigger ] ] = trigger
 220
 221         # Generates Trigger Lists per layer using index lists
 222         def generateTriggerLists( self ):
 223                 for layer in range( 0, len( self.macros ) ):
 224                         # Set max scancode to 0xFF (255)
 225                         # But keep track of the actual max scancode and reduce the list size
 226                         self.triggerList.append( [ [] ] * 0xFF )
 227                         self.maxScanCode.append( 0x00 )
 228
 229                         # Iterate through trigger macros to locate necessary ScanCodes and corresponding triggerIndex
 230                         for trigger in self.macros[ layer ].keys():
 231                                 for variant in range( 0, len( self.macros[ layer ][ trigger ] ) ):
 232                                         # Identify result index
 233                                         resultIndex = self.resultsIndex[ self.macros[ layer ][ trigger ][ variant ] ]
 234
 235                                         # Identify trigger index
 236                                         triggerIndex = self.triggersIndex[ tuple( [ trigger, resultIndex ] ) ]
 237
 238                                         # Iterate over the trigger to locate the ScanCodes
 239                                         for sequence in trigger:
 240                                                 for combo in sequence:
 241                                                         # Append triggerIndex for each found scanCode of the Trigger List
 242                                                         # Do not re-add if triggerIndex is already in the Trigger List
 243                                                         if not triggerIndex in self.triggerList[ layer ][ combo ]:
 244                                                                 # Append is working strangely with list pre-initialization
 245                                                                 # Doing a 0 check replacement instead -HaaTa
 246                                                                 if len( self.triggerList[ layer ][ combo ] ) == 0:
 247                                                                         self.triggerList[ layer ][ combo ] = [ triggerIndex ]
 248                                                                 else:
 249                                                                         self.triggerList[ layer ][ combo ].append( triggerIndex )
 250
 251                                                         # Look for max Scan Code
 252                                                         if combo > self.maxScanCode[ layer ]:
 253                                                                 self.maxScanCode[ layer ] = combo
 254
 255                         # Shrink triggerList to actual max size
 256                         self.triggerList[ layer ] = self.triggerList[ layer ][ : self.maxScanCode[ layer ] + 1 ]
 257
 258                         # Calculate first scan code for layer, useful for uC implementations trying to save RAM
 259                         firstScanCode = 0
 260                         for triggerList in range( 0, len( self.triggerList[ layer ] ) ):
 261                                 firstScanCode = triggerList
 262
 263                                 # Break if triggerList has items
 264                                 if len( self.triggerList[ layer ][ triggerList ] ) > 0:
 265                                         break;
 266                         self.firstScanCode.append( firstScanCode )
 267
 268                 # Determine overall maxScanCode
 269                 self.overallMaxScanCode = 0x00
 270                 for maxVal in self.maxScanCode:
 271                         if maxVal > self.overallMaxScanCode:
 272                                 self.overallMaxScanCode = maxVal
 273
 274
 275 class Variables:
 276         # Container for variables
 277         # Stores three sets of variables, the overall combined set, per layer, and per file
 278         def __init__( self ):
 279                 pass
 280
 281         def baseLayerFinished( self ):
 282                 pass
 283
 284         def setCurrentFile( self, name ):
 285                 # Store using filename and current layer
 286                 pass
 287
 288         def setCurrentLayer( self, layer ):
 289                 # Store using layer index
 290                 pass
 291
 292         def assignVariable( self, key, value ):
 293                 pass
 294