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/>.
25 ## Print Decorator Variables
26 ERROR = '\033[5;1;31mERROR\033[0m:'
34 # Container for capabilities dictionary and convenience functions
36 self.capabilities = dict()
38 def __getitem__( self, name ):
39 return self.capabilities[ name ]
41 def __setitem__( self, name, contents ):
42 self.capabilities[ name ] = contents
45 return "Capabilities => {0}\nIndexed Capabilities => {1}".format( self.capabilities, sorted( self.capabilities, key = self.capabilities.get ) )
48 # Total bytes needed to store arguments
49 def totalArgBytes( self, name ):
52 # Iterate over the arguments, summing the total bytes
53 for arg in self.capabilities[ name ][ 1 ]:
54 totalBytes += int( arg[ 1 ] )
58 # Name of the capability function
59 def funcName( self, name ):
60 return self.capabilities[ name ][ 0 ]
63 # Only valid while dictionary keys are not added/removed
64 def getIndex( self, name ):
65 return sorted( self.capabilities, key = self.capabilities.get ).index( name )
67 def getName( self, index ):
68 return sorted( self.capabilities, key = self.capabilities.get )[ index ]
71 return sorted( self.capabilities, key = self.capabilities.get )
75 # Container for Trigger Macro : Result Macro correlation
76 # Layer selection for generating TriggerLists
78 # Only convert USB Code list once all the ResultMacros have been accumulated (does a macro reduction; not reversible)
79 # Two staged list for ResultMacros:
80 # 1) USB Code/Non-converted (may contain capabilities)
87 self.macros = [ dict() ]
89 # Correlated Macro Data
90 self.resultsIndex = dict()
91 self.triggersIndex = dict()
92 self.resultsIndexSorted = []
93 self.triggersIndexSorted = []
98 return "{0}".format( self.macros )
100 def setLayer( self, layer ):
103 # Use for ScanCode trigger macros
104 def appendScanCode( self, trigger, result ):
105 if not trigger in self.macros[ self.layer ]:
106 self.replaceScanCode( trigger, result )
108 self.macros[ self.layer ][ trigger ].append( result )
110 # Remove the given trigger/result pair
111 def removeScanCode( self, trigger, result ):
112 # Remove all instances of the given trigger/result pair
113 while result in self.macros[ self.layer ][ trigger ]:
114 self.macros[ self.layer ][ trigger ].remove( result )
116 # Replaces the given trigger with the given result
117 # If multiple results for a given trigger, clear, then add
118 def replaceScanCode( self, trigger, result ):
119 self.macros[ self.layer ][ trigger ] = [ result ]
121 # Return a list of ScanCode triggers with the given USB Code trigger
122 def lookupUSBCodes( self, usbCode ):
125 # Scan current layer for USB Codes
126 for macro in self.macros[ self.layer ].keys():
127 if usbCode == self.macros[ self.layer ][ macro ]:
128 scanCodeList.append( macro )
132 # Generate/Correlate Layers
133 def generate( self ):
134 self.generateIndices()
135 self.sortIndexLists()
136 self.generateTriggerLists()
138 # Generates Index of Results and Triggers
139 def generateIndices( self ):
140 # Iterate over every trigger result, and add to the resultsIndex and triggersIndex
141 for layer in range( 0, len( self.macros ) ):
142 for trigger in self.macros[ layer ].keys():
143 # Each trigger has a list of results
144 for result in self.macros[ layer ][ trigger ]:
145 # Only add, with an index, if result hasn't been added yet
146 if not result in self.resultsIndex:
147 self.resultsIndex[ result ] = len( self.resultsIndex )
149 # Then add a trigger for each result, if trigger hasn't been added yet
150 triggerItem = tuple( [ trigger, self.resultsIndex[ result ] ] )
151 if not triggerItem in self.triggersIndex:
152 self.triggersIndex[ triggerItem ] = len( self.triggersIndex )
154 # Sort Index Lists using the indices rather than triggers/results
155 def sortIndexLists( self ):
156 self.resultsIndexSorted = [ None ] * len( self.resultsIndex )
157 # Iterate over the resultsIndex and sort by index
158 for result in self.resultsIndex.keys():
159 self.resultsIndexSorted[ self.resultsIndex[ result ] ] = result
161 self.triggersIndexSorted = [ None ] * len( self.triggersIndex )
162 # Iterate over the triggersIndex and sort by index
163 for trigger in self.triggersIndex.keys():
164 self.triggersIndexSorted[ self.triggersIndex[ trigger ] ] = trigger
166 # Generates Trigger Lists per layer using index lists
167 def generateTriggerLists( self ):
168 for layer in range( 0, len( self.macros ) ):
169 # Set max scancode to 0xFF (255)
170 # But keep track of the actual max scancode and reduce the list size
171 self.triggerList.append( [ [] ] * 0xFF )
172 self.maxScanCode.append( 0x00 )
174 # Iterate through triggersIndex to locate necessary ScanCodes and corresponding triggerIndex
175 for triggerItem in self.triggersIndex.keys():
176 # Iterate over the trigger portion of the triggerItem (other part is the index)
177 for sequence in triggerItem[ 0 ]:
178 for combo in sequence:
179 # Append triggerIndex for each found scanCode of the Trigger List
180 # Do not re-add if triggerIndex is already in the Trigger List
181 if not triggerItem[1] in self.triggerList[ layer ][ combo ]:
182 # Append is working strangely with list pre-initialization
183 # Doing a 0 check replacement instead -HaaTa
184 if len( self.triggerList[ layer ][ combo ] ) == 0:
185 self.triggerList[ layer ][ combo ] = [ triggerItem[ 1 ] ]
187 self.triggerList[ layer ][ combo ].append( triggerItem[1] )
189 # Look for max Scan Code
190 if combo > self.maxScanCode[ layer ]:
191 self.maxScanCode[ layer ] = combo
193 # Shrink triggerList to actual max size
194 self.triggerList[ layer ] = self.triggerList[ layer ][ : self.maxScanCode[ layer ] + 1 ]
196 # Determine overall maxScanCode
197 self.overallMaxScanCode = 0x00
198 for maxVal in self.maxScanCode:
199 if maxVal > self.overallMaxScanCode:
200 self.overallMaxScanCode = maxVal