2 # KLL Compiler Containers
4 # Copyright (C) 2014 by Jacob Alexander
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.
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.
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/>.
27 ## Print Decorator Variables
28 ERROR = '\033[5;1;31mERROR\033[0m:'
38 # Container for capabilities dictionary and convenience functions
40 self.capabilities = dict()
42 def __getitem__( self, name ):
43 return self.capabilities[ name ]
45 def __setitem__( self, name, contents ):
46 self.capabilities[ name ] = contents
49 return "Capabilities => {0}\nIndexed Capabilities => {1}".format( self.capabilities, sorted( self.capabilities, key = self.capabilities.get ) )
52 # Total bytes needed to store arguments
53 def totalArgBytes( self, name ):
56 # Iterate over the arguments, summing the total bytes
57 for arg in self.capabilities[ name ][ 1 ]:
58 totalBytes += int( arg[ 1 ] )
62 # Name of the capability function
63 def funcName( self, name ):
64 return self.capabilities[ name ][ 0 ]
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 )
71 def getName( self, index ):
72 return sorted( self.capabilities, key = self.capabilities.get )[ index ]
75 return sorted( self.capabilities, key = self.capabilities.get )
79 # Container for Trigger Macro : Result Macro correlation
80 # Layer selection for generating TriggerLists
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)
91 self.macros = [ dict() ]
94 self.baseLayout = None
95 self.layerLayoutMarkers = []
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 = []
106 # USBCode Assignment Cache
107 self.assignmentCache = []
109 def __repr__( self ):
110 return "{0}".format( self.macros )
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
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 ]
122 def addLayer( self ):
123 # Increment layer count, and append another macros dictionary
125 self.macros.append( copy.deepcopy( self.baseLayout ) )
127 # Add a layout marker for each layer
128 self.layerLayoutMarkers.append( copy.deepcopy( self.baseLayout ) )
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 )
135 self.macros[ self.layer ][ trigger ].append( result )
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 )
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 ]
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 ]
153 # Return a list of ScanCode triggers with the given USB Code trigger
154 def lookupUSBCodes( self, usbCode ):
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 )
164 # Cache USBCode Assignment
165 def cacheAssignment( self, operator, scanCode, result ):
166 self.assignmentCache.append( [ operator, scanCode, result ] )
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
175 self.appendScanCode( item[1], item[2] )
178 elif item[0] == ":-":
179 self.removeScanCode( item[1], item[2] )
183 self.replaceScanCode( item[1], item[2] )
185 # Clear assignment cache
186 self.assignmentCache = []
188 # Generate/Correlate Layers
189 def generate( self ):
190 self.generateIndices()
191 self.sortIndexLists()
192 self.generateTriggerLists()
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 )
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 )
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
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
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 )
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 ] ]
236 # Identify trigger index
237 triggerIndex = self.triggersIndex[ tuple( [ trigger, resultIndex ] ) ]
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 ]
250 self.triggerList[ layer ][ combo ].append( triggerIndex )
252 # Look for max Scan Code
253 if combo > self.maxScanCode[ layer ]:
254 self.maxScanCode[ layer ] = combo
256 # Shrink triggerList to actual max size
257 self.triggerList[ layer ] = self.triggerList[ layer ][ : self.maxScanCode[ layer ] + 1 ]
259 # Calculate first scan code for layer, useful for uC implementations trying to save RAM
261 for triggerList in range( 0, len( self.triggerList[ layer ] ) ):
262 firstScanCode = triggerList
264 # Break if triggerList has items
265 if len( self.triggerList[ layer ][ triggerList ] ) > 0:
267 self.firstScanCode.append( firstScanCode )
269 # Determine overall maxScanCode
270 self.overallMaxScanCode = 0x00
271 for maxVal in self.maxScanCode:
272 if maxVal > self.overallMaxScanCode:
273 self.overallMaxScanCode = maxVal
277 # Container for variables
278 # Stores three sets of variables, the overall combined set, per layer, and per file
279 def __init__( self ):
280 # Dictionaries of variables
281 self.baseLayout = dict()
282 self.fileVariables = dict()
283 self.layerVariables = [ dict() ]
284 self.overallVariables = dict()
285 self.defines = dict()
287 self.currentFile = ""
288 self.currentLayer = 0
289 self.baseLayoutEnabled = True
291 def baseLayoutFinished( self ):
292 self.baseLayoutEnabled = False
294 def setCurrentFile( self, name ):
295 # Store using filename and current layer
296 self.currentFile = name
297 self.fileVariables[ name ] = dict()
299 # If still processing BaseLayout
300 if self.baseLayoutEnabled:
301 self.baseLayout['*LayerFiles'] = name
302 # Set for the current layer
304 self.layerVariables[ self.currentLayer ]['*LayerFiles'] = name
306 def incrementLayer( self ):
307 # Store using layer index
308 self.currentLayer += 1
309 self.layerVariables.append( dict() )
311 def assignVariable( self, key, value ):
312 # Overall set of variables
313 self.overallVariables[ key ] = value
315 # If still processing BaseLayout
316 if self.baseLayoutEnabled:
317 self.baseLayout[ key ] = value
318 # Set for the current layer
320 self.layerVariables[ self.currentLayer ][ key ] = value
322 # File context variables
323 self.fileVariables[ self.currentFile ][ key ] = value