3 # Keyboard Layout Langauge
5 # Copyright (C) 2014-2015 by Jacob Alexander
7 # This file is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
12 # This file is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this file. If not, see <http://www.gnu.org/licenses/>.
30 from pprint import pformat
31 from re import VERBOSE
32 from tokenize import generate_tokens
34 from kll_lib.containers import *
35 from kll_lib.hid_dict import *
37 from funcparserlib.lexer import make_tokenizer, Token, LexerError
38 from funcparserlib.parser import (some, a, many, oneplus, skip, finished, maybe, skip, forward_decl, NoParseError)
44 ## Print Decorator Variables
45 ERROR = '\033[5;1;31mERROR\033[0m:'
48 ## Python Text Formatting Fixer...
49 ## Because the creators of Python are averse to proper capitalization.
50 textFormatter_lookup = {
51 "usage: " : "Usage: ",
52 "optional arguments" : "Optional Arguments",
55 def textFormatter_gettext( s ):
56 return textFormatter_lookup.get( s, s )
58 argparse._ = textFormatter_gettext
62 ### Argument Parsing ###
64 def checkFileExists( filename ):
65 if not os.path.isfile( filename ):
66 print ( "{0} {1} does not exist...".format( ERROR, filename ) )
69 def processCommandLineArgs():
70 # Setup argument processor
71 pArgs = argparse.ArgumentParser(
72 usage="%(prog)s [options] <file1>...",
73 description="Generates .h file state tables and pointer indices from KLL .kll files.",
74 epilog="Example: {0} mykeyboard.kll -d colemak.kll -p hhkbpro2.kll -p symbols.kll".format( os.path.basename( sys.argv[0] ) ),
75 formatter_class=argparse.RawTextHelpFormatter,
79 # Positional Arguments
80 pArgs.add_argument( 'files', type=str, nargs='+',
81 help=argparse.SUPPRESS ) # Suppressed help output, because Python output is verbosely ugly
84 pArgs.add_argument( '-b', '--backend', type=str, default="kiibohd",
85 help="Specify target backend for the KLL compiler.\n"
87 "Options: kiibohd, json" )
88 pArgs.add_argument( '-d', '--default', type=str, nargs='+',
89 help="Specify .kll files to layer on top of the default map to create a combined map." )
90 pArgs.add_argument( '-p', '--partial', type=str, nargs='+', action='append',
91 help="Specify .kll files to generate partial map, multiple files per flag.\n"
92 "Each -p defines another partial map.\n"
93 "Base .kll files (that define the scan code maps) must be defined for each partial map." )
94 pArgs.add_argument( '-t', '--templates', type=str, nargs='+',
95 help="Specify template used to generate the keymap.\n"
96 "Default: <backend specific>" )
97 pArgs.add_argument( '-o', '--outputs', type=str, nargs='+',
98 help="Specify output file. Writes to current working directory by default.\n"
99 "Default: <backend specific>" )
100 pArgs.add_argument( '-h', '--help', action="help",
101 help="This message." )
104 args = pArgs.parse_args()
107 baseFiles = args.files
108 defaultFiles = args.default
109 partialFileSets = args.partial
110 if defaultFiles is None:
112 if partialFileSets is None:
113 partialFileSets = [[]]
115 # Check file existance
116 for filename in baseFiles:
117 checkFileExists( filename )
119 for filename in defaultFiles:
120 checkFileExists( filename )
122 for partial in partialFileSets:
123 for filename in partial:
124 checkFileExists( filename )
126 return (baseFiles, defaultFiles, partialFileSets, args.backend, args.templates, args.outputs)
132 def tokenize( string ):
133 """str -> Sequence(Token)"""
137 ( 'Comment', ( r' *#.*', ) ),
138 ( 'Space', ( r'[ \t\r\n]+', ) ),
139 ( 'USBCode', ( r'U(("[^"]+")|(0x[0-9a-fA-F]+)|([0-9]+))', ) ),
140 ( 'USBCodeStart', ( r'U\[', ) ),
141 ( 'ConsCode', ( r'CONS(("[^"]+")|(0x[0-9a-fA-F]+)|([0-9]+))', ) ),
142 ( 'ConsCodeStart', ( r'CONS\[', ) ),
143 ( 'SysCode', ( r'SYS(("[^"]+")|(0x[0-9a-fA-F]+)|([0-9]+))', ) ),
144 ( 'SysCodeStart', ( r'SYS\[', ) ),
145 ( 'LedCode', ( r'LED(("[^"]+")|(0x[0-9a-fA-F]+)|([0-9]+))', ) ),
146 ( 'LedCodeStart', ( r'LED\[', ) ),
147 ( 'ScanCode', ( r'S((0x[0-9a-fA-F]+)|([0-9]+))', ) ),
148 ( 'ScanCodeStart', ( r'S\[', ) ),
149 ( 'CodeEnd', ( r'\]', ) ),
150 ( 'String', ( r'"[^"]*"', VERBOSE ) ),
151 ( 'SequenceString', ( r"'[^']*'", ) ),
152 ( 'Operator', ( r'=>|:\+|:-|:|=', ) ),
153 ( 'Comma', ( r',', ) ),
154 ( 'Dash', ( r'-', ) ),
155 ( 'Plus', ( r'\+', ) ),
156 ( 'Parenthesis', ( r'\(|\)', ) ),
157 ( 'None', ( r'None', ) ),
158 ( 'Number', ( r'-?(0x[0-9a-fA-F]+)|(0|([1-9][0-9]*))', VERBOSE ) ),
159 ( 'Name', ( r'[A-Za-z_][A-Za-z_0-9]*', ) ),
160 ( 'VariableContents', ( r'''[^"' ;:=>()]+''', ) ),
161 ( 'EndOfLine', ( r';', ) ),
164 # Tokens to filter out of the token stream
165 useless = ['Space', 'Comment']
167 tokens = make_tokenizer( specs )
168 return [x for x in tokens( string ) if x.type not in useless]
175 macros_map = Macros()
176 variables_dict = Variables()
177 capabilities_dict = Capabilities()
182 def make_scanCode( token ):
183 scanCode = int( token[1:], 0 )
184 # Check size, to make sure it's valid
186 print ( "{0} ScanCode value {1} is larger than 255".format( ERROR, scanCode ) )
190 def make_hidCode( type, token ):
191 # If first character is a U, strip
195 elif 'CONS' in token:
201 # If using string representation of USB Code, do lookup, case-insensitive
204 hidCode = kll_hid_lookup_dictionary[ type ][ token[1:-1].upper() ][1]
205 except LookupError as err:
206 print ( "{0} {1} is an invalid USB HID Code Lookup...".format( ERROR, err ) )
210 if type == 'USBCode' and token[0] == 'USB' or type == 'SysCode' and token[0] == 'SYS' or type == 'ConsCode' and token[0] == 'CONS':
214 hidCode = int( token, 0 )
216 # Check size if a USB Code, to make sure it's valid
217 if type == 'USBCode' and hidCode > 0xFF:
218 print ( "{0} USBCode value {1} is larger than 255".format( ERROR, hidCode ) )
221 # Return a tuple, identifying which type it is
222 if type == 'USBCode':
223 return make_usbCode_number( hidCode )
224 elif type == 'ConsCode':
225 return make_consCode_number( hidCode )
226 elif type == 'SysCode':
227 return make_sysCode_number( hidCode )
229 print ( "{0} Unknown HID Specifier '{1}'".format( ERROR, type ) )
232 def make_usbCode( token ):
233 return make_hidCode( 'USBCode', token )
235 def make_consCode( token ):
236 return make_hidCode( 'ConsCode', token )
238 def make_sysCode( token ):
239 return make_hidCode( 'SysCode', token )
241 def make_hidCode_number( type, token ):
247 return ( lookup[ type ], token )
249 def make_usbCode_number( token ):
250 return make_hidCode_number( 'USBCode', token )
252 def make_consCode_number( token ):
253 return make_hidCode_number( 'ConsCode', token )
255 def make_sysCode_number( token ):
256 return make_hidCode_number( 'SysCode', token )
258 # Replace key-word with None specifier (which indicates a noneOut capability)
259 def make_none( token ):
260 return [[[('NONE', 0)]]]
262 def make_seqString( token ):
263 # Shifted Characters, and amount to move by to get non-shifted version
266 ( "ABCDEFGHIJKLMNOPQRSTUVWXYZ", 0x20 ),
283 shiftKey = kll_hid_lookup_dictionary['USBCode']["SHIFT"]
285 # Creates a list of USB codes from the string: sequence (list) of combos (lists)
286 for char in token[1:-1]:
289 # Whether or not to create a combo for this sequence with a shift
292 # Depending on the ASCII character, convert to single character or Shift + character
293 for pair in shiftCharacters:
296 processedChar = chr( ord( char ) + pair[1] )
299 # Do KLL HID Lookup on non-shifted character
300 # NOTE: Case-insensitive, which is why the shift must be pre-computed
301 usbCode = kll_hid_lookup_dictionary['USBCode'][ processedChar.upper() ]
303 # Create Combo for this character, add shift key if shifted
306 charCombo = [ [ shiftKey ] ]
307 charCombo.append( [ usbCode ] )
309 # Add to list of lists
310 listOfLists.append( charCombo )
314 def make_string( token ):
317 def make_unseqString( token ):
320 def make_number( token ):
321 return int( token, 0 )
323 # Range can go from high to low or low to high
324 def make_scanCode_range( rangeVals ):
328 # Swap start, end if start is greater than end
330 start, end = end, start
332 # Iterate from start to end, and generate the range
333 return list( range( start, end + 1 ) )
335 # Range can go from high to low or low to high
336 # Warn on 0-9 for USBCodes (as this does not do what one would expect) TODO
337 # Lookup USB HID tags and convert to a number
338 def make_hidCode_range( type, rangeVals ):
339 # Check if already integers
340 if isinstance( rangeVals[0], int ):
343 start = make_hidCode( type, rangeVals[0] )[1]
345 if isinstance( rangeVals[1], int ):
348 end = make_hidCode( type, rangeVals[1] )[1]
350 # Swap start, end if start is greater than end
352 start, end = end, start
354 # Iterate from start to end, and generate the range
355 listRange = list( range( start, end + 1 ) )
357 # Convert each item in the list to a tuple
358 for item in range( len( listRange ) ):
359 listRange[ item ] = make_hidCode_number( type, listRange[ item ] )
362 def make_usbCode_range( rangeVals ):
363 return make_hidCode_range( 'USBCode', rangeVals )
365 def make_sysCode_range( rangeVals ):
366 return make_hidCode_range( 'SysCode', rangeVals )
368 def make_consCode_range( rangeVals ):
369 return make_hidCode_range( 'ConsCode', rangeVals )
374 const = lambda x: lambda _: x
375 unarg = lambda f: lambda x: f(*x)
376 flatten = lambda list: sum( list, [] )
378 tokenValue = lambda x: x.value
379 tokenType = lambda t: some( lambda x: x.type == t ) >> tokenValue
380 operator = lambda s: a( Token( 'Operator', s ) ) >> tokenValue
381 parenthesis = lambda s: a( Token( 'Parenthesis', s ) ) >> tokenValue
382 eol = a( Token( 'EndOfLine', ';' ) )
384 def listElem( item ):
387 def listToTuple( items ):
388 return tuple( items )
390 # Flatten only the top layer (list of lists of ...)
391 def oneLayerFlatten( items ):
393 for sublist in items:
395 mainList.append( item )
399 # Capability arguments may need to be expanded (e.g. 1 16 bit argument needs to be 2 8 bit arguments for the state machine)
400 def capArgExpander( items ):
402 # For each defined argument in the capability definition
403 for arg in range( 0, len( capabilities_dict[ items[0] ][1] ) ):
404 argLen = capabilities_dict[ items[0] ][1][ arg ][1]
405 num = items[1][ arg ]
406 byteForm = num.to_bytes( argLen, byteorder='little' ) # XXX Yes, little endian from how the uC structs work
408 # For each sub-argument, split into byte-sized chunks
409 for byte in range( 0, argLen ):
410 newArgs.append( byteForm[ byte ] )
412 return tuple( [ items[0], tuple( newArgs ) ] )
414 # Expand ranges of values in the 3rd dimension of the list, to a list of 2nd lists
415 # i.e. [ sequence, [ combo, [ range ] ] ] --> [ [ sequence, [ combo ] ], <option 2>, <option 3> ]
416 def optionExpansion( sequences ):
417 expandedSequences = []
419 # Total number of combinations of the sequence of combos that needs to be generated
420 totalCombinations = 1
422 # List of leaf lists, with number of leaves
425 # Traverse to the leaf nodes, and count the items in each leaf list
426 for sequence in sequences:
427 for combo in sequence:
428 rangeLen = len( combo )
429 totalCombinations *= rangeLen
430 maxLeafList.append( rangeLen )
432 # Counter list to keep track of which combination is being generated
433 curLeafList = [0] * len( maxLeafList )
435 # Generate a list of permuations of the sequence of combos
436 for count in range( 0, totalCombinations ):
437 expandedSequences.append( [] ) # Prepare list for adding the new combination
440 # Traverse sequence of combos to generate permuation
441 for sequence in sequences:
442 expandedSequences[ -1 ].append( [] )
443 for combo in sequence:
444 expandedSequences[ -1 ][ -1 ].append( combo[ curLeafList[ position ] ] )
447 # Increment combination tracker
448 for leaf in range( 0, len( curLeafList ) ):
449 curLeafList[ leaf ] += 1
451 # Reset this position, increment next position (if it exists), then stop
452 if curLeafList[ leaf ] >= maxLeafList[ leaf ]:
453 curLeafList[ leaf ] = 0
454 if leaf + 1 < len( curLeafList ):
455 curLeafList[ leaf + 1 ] += 1
457 return expandedSequences
460 # Converts USB Codes into Capabilities
461 # These are tuples (<type>, <integer>)
462 def hidCodeToCapability( items ):
463 # Items already converted to variants using optionExpansion
464 for variant in range( 0, len( items ) ):
466 for sequence in range( 0, len( items[ variant ] ) ):
467 for combo in range( 0, len( items[ variant ][ sequence ] ) ):
468 if items[ variant ][ sequence ][ combo ][0] in backend.requiredCapabilities.keys():
470 # Use backend capability name and a single argument
471 items[ variant ][ sequence ][ combo ] = tuple(
472 [ backend.capabilityLookup( items[ variant ][ sequence ][ combo ][0] ),
473 tuple( [ hid_lookup_dictionary[ items[ variant ][ sequence ][ combo ] ] ] ) ]
476 print ( "{0} {1} is an invalid HID lookup value".format( ERROR, items[ variant ][ sequence ][ combo ] ) )
481 # Convert tuple of tuples to list of lists
483 return list( map( listit, t ) ) if isinstance( t, ( list, tuple ) ) else t
485 # Convert list of lists to tuple of tuples
487 return tuple( map( tupleit, t ) ) if isinstance( t, ( tuple, list ) ) else t
492 def eval_scanCode( triggers, operator, results ):
493 # Convert to lists of lists of lists to tuples of tuples of tuples
494 # Tuples are non-mutable, and can be used has index items
495 triggers = tuple( tuple( tuple( sequence ) for sequence in variant ) for variant in triggers )
496 results = tuple( tuple( tuple( sequence ) for sequence in variant ) for variant in results )
498 # Lookup interconnect id (Current file scope)
499 # Default to 0 if not specified
500 if 'ConnectId' not in variables_dict.overallVariables.keys():
503 id_num = int( variables_dict.overallVariables['ConnectId'] )
505 # Iterate over all combinations of triggers and results
506 for sequence in triggers:
507 # Convert tuple of tuples to list of lists so each element can be modified
508 trigger = listit( sequence )
510 # Create ScanCode entries for trigger
511 for seq_index, combo in enumerate( sequence ):
512 for com_index, scancode in enumerate( combo ):
513 trigger[ seq_index ][ com_index ] = macros_map.scanCodeStore.append( ScanCode( scancode, id_num ) )
515 # Convert back to a tuple of tuples
516 trigger = tupleit( trigger )
518 for result in results:
521 macros_map.appendScanCode( trigger, result )
524 elif operator == ":-":
525 macros_map.removeScanCode( trigger, result )
528 elif operator == ":":
529 macros_map.replaceScanCode( trigger, result )
531 def eval_usbCode( triggers, operator, results ):
532 # Convert to lists of lists of lists to tuples of tuples of tuples
533 # Tuples are non-mutable, and can be used has index items
534 triggers = tuple( tuple( tuple( sequence ) for sequence in variant ) for variant in triggers )
535 results = tuple( tuple( tuple( sequence ) for sequence in variant ) for variant in results )
537 # Iterate over all combinations of triggers and results
538 for trigger in triggers:
539 scanCodes = macros_map.lookupUSBCodes( trigger )
540 for scanCode in scanCodes:
541 for result in results:
542 # Cache assignment until file finishes processing
543 macros_map.cacheAssignment( operator, scanCode, result )
545 def eval_variable( name, content ):
546 # Content might be a concatenation of multiple data types, convert everything into a single string
547 assigned_content = ""
549 assigned_content += str( item )
551 variables_dict.assignVariable( name, assigned_content )
553 def eval_capability( name, function, args ):
554 capabilities_dict[ name ] = [ function, args ]
556 def eval_define( name, cdefine_name ):
557 variables_dict.defines[ name ] = cdefine_name
559 map_scanCode = unarg( eval_scanCode )
560 map_usbCode = unarg( eval_usbCode )
562 set_variable = unarg( eval_variable )
563 set_capability = unarg( eval_capability )
564 set_define = unarg( eval_define )
569 usbCode = tokenType('USBCode') >> make_usbCode
570 scanCode = tokenType('ScanCode') >> make_scanCode
571 consCode = tokenType('ConsCode') >> make_consCode
572 sysCode = tokenType('SysCode') >> make_sysCode
573 none = tokenType('None') >> make_none
574 name = tokenType('Name')
575 number = tokenType('Number') >> make_number
576 comma = tokenType('Comma')
577 dash = tokenType('Dash')
578 plus = tokenType('Plus')
579 content = tokenType('VariableContents')
580 string = tokenType('String') >> make_string
581 unString = tokenType('String') # When the double quotes are still needed for internal processing
582 seqString = tokenType('SequenceString') >> make_seqString
583 unseqString = tokenType('SequenceString') >> make_unseqString # For use with variables
586 code_end = tokenType('CodeEnd')
589 scanCode_start = tokenType('ScanCodeStart')
590 scanCode_range = number + skip( dash ) + number >> make_scanCode_range
591 scanCode_listElem = number >> listElem
592 scanCode_innerList = oneplus( ( scanCode_range | scanCode_listElem ) + skip( maybe( comma ) ) ) >> flatten
593 scanCode_expanded = skip( scanCode_start ) + scanCode_innerList + skip( code_end )
594 scanCode_elem = scanCode >> listElem
595 scanCode_combo = oneplus( ( scanCode_expanded | scanCode_elem ) + skip( maybe( plus ) ) )
596 scanCode_sequence = oneplus( scanCode_combo + skip( maybe( comma ) ) )
599 usbCode_start = tokenType('USBCodeStart')
600 usbCode_number = number >> make_usbCode_number
601 usbCode_range = ( usbCode_number | unString ) + skip( dash ) + ( number | unString ) >> make_usbCode_range
602 usbCode_listElemTag = unString >> make_usbCode
603 usbCode_listElem = ( usbCode_number | usbCode_listElemTag ) >> listElem
604 usbCode_innerList = oneplus( ( usbCode_range | usbCode_listElem ) + skip( maybe( comma ) ) ) >> flatten
605 usbCode_expanded = skip( usbCode_start ) + usbCode_innerList + skip( code_end )
606 usbCode_elem = usbCode >> listElem
607 usbCode_combo = oneplus( ( usbCode_expanded | usbCode_elem ) + skip( maybe( plus ) ) ) >> listElem
608 usbCode_sequence = oneplus( ( usbCode_combo | seqString ) + skip( maybe( comma ) ) ) >> oneLayerFlatten
611 consCode_start = tokenType('ConsCodeStart')
612 consCode_number = number >> make_consCode_number
613 consCode_range = ( consCode_number | unString ) + skip( dash ) + ( number | unString ) >> make_consCode_range
614 consCode_listElemTag = unString >> make_consCode
615 consCode_listElem = ( consCode_number | consCode_listElemTag ) >> listElem
616 consCode_innerList = oneplus( ( consCode_range | consCode_listElem ) + skip( maybe( comma ) ) ) >> flatten
617 consCode_expanded = skip( consCode_start ) + consCode_innerList + skip( code_end )
618 consCode_elem = consCode >> listElem
621 sysCode_start = tokenType('SysCodeStart')
622 sysCode_number = number >> make_sysCode_number
623 sysCode_range = ( sysCode_number | unString ) + skip( dash ) + ( number | unString ) >> make_sysCode_range
624 sysCode_listElemTag = unString >> make_sysCode
625 sysCode_listElem = ( sysCode_number | sysCode_listElemTag ) >> listElem
626 sysCode_innerList = oneplus( ( sysCode_range | sysCode_listElem ) + skip( maybe( comma ) ) ) >> flatten
627 sysCode_expanded = skip( sysCode_start ) + sysCode_innerList + skip( code_end )
628 sysCode_elem = sysCode >> listElem
631 hidCode_elem = usbCode_expanded | usbCode_elem | sysCode_expanded | sysCode_elem | consCode_expanded | consCode_elem
634 capFunc_arguments = many( number + skip( maybe( comma ) ) ) >> listToTuple
635 capFunc_elem = name + skip( parenthesis('(') ) + capFunc_arguments + skip( parenthesis(')') ) >> capArgExpander >> listElem
636 capFunc_combo = oneplus( ( hidCode_elem | capFunc_elem ) + skip( maybe( plus ) ) ) >> listElem
637 capFunc_sequence = oneplus( ( capFunc_combo | seqString ) + skip( maybe( comma ) ) ) >> oneLayerFlatten
639 # Trigger / Result Codes
640 triggerCode_outerList = scanCode_sequence >> optionExpansion
641 triggerUSBCode_outerList = usbCode_sequence >> optionExpansion >> hidCodeToCapability
642 resultCode_outerList = ( ( capFunc_sequence >> optionExpansion ) | none ) >> hidCodeToCapability
647 #| <variable> = <variable contents>;
648 variable_contents = name | content | string | number | comma | dash | unseqString
649 variable_expression = name + skip( operator('=') ) + oneplus( variable_contents ) + skip( eol ) >> set_variable
651 #| <capability name> => <c function>;
652 capability_arguments = name + skip( operator(':') ) + number + skip( maybe( comma ) )
653 capability_expression = name + skip( operator('=>') ) + name + skip( parenthesis('(') ) + many( capability_arguments ) + skip( parenthesis(')') ) + skip( eol ) >> set_capability
655 #| <define name> => <c define>;
656 define_expression = name + skip( operator('=>') ) + name + skip( eol ) >> set_define
658 #| <trigger> : <result>;
659 operatorTriggerResult = operator(':') | operator(':+') | operator(':-')
660 scanCode_expression = triggerCode_outerList + operatorTriggerResult + resultCode_outerList + skip( eol ) >> map_scanCode
661 usbCode_expression = triggerUSBCode_outerList + operatorTriggerResult + resultCode_outerList + skip( eol ) >> map_usbCode
663 def parse( tokenSequence ):
664 """Sequence(Token) -> object"""
667 expression = scanCode_expression | usbCode_expression | variable_expression | capability_expression | define_expression
669 kll_text = many( expression )
670 kll_file = maybe( kll_text ) + skip( finished )
672 return kll_file.parse( tokenSequence )
676 def processKLLFile( filename ):
677 with open( filename ) as file:
679 tokenSequence = tokenize( data )
680 #print ( pformat( tokenSequence ) ) # Display tokenization
682 tree = parse( tokenSequence )
683 except NoParseError as e:
684 print("Error parsing %s. %s" % (filename, e.msg), file=sys.stderr)
688 ### Misc Utility Functions ###
690 def gitRevision( kllPath ):
693 # Change the path to where kll.py is
694 origPath = os.getcwd()
697 # Just in case git can't be found
699 # Get hash of the latest git commit
700 revision = subprocess.check_output( ['git', 'rev-parse', 'HEAD'] ).decode()[:-1]
702 # Get list of files that have changed since the commit
703 changed = subprocess.check_output( ['git', 'diff-index', '--name-only', 'HEAD', '--'] ).decode().splitlines()
705 revision = "<no git>"
708 # Change back to the old working directory
711 return revision, changed
714 ### Main Entry Point ###
716 if __name__ == '__main__':
717 (baseFiles, defaultFiles, partialFileSets, backend_name, templates, outputs) = processCommandLineArgs()
719 # Look up git information on the compiler
720 gitRev, gitChanges = gitRevision( os.path.dirname( os.path.realpath( __file__ ) ) )
722 # Load backend module
724 backend_import = importlib.import_module( "backends.{0}".format( backend_name ) )
725 backend = backend_import.Backend( templates )
727 # Process base layout files
728 for filename in baseFiles:
729 variables_dict.setCurrentFile( filename )
730 processKLLFile( filename )
731 macros_map.completeBaseLayout() # Indicates to macros_map that the base layout is complete
732 variables_dict.baseLayoutFinished()
734 # Default combined layer
735 for filename in defaultFiles:
736 variables_dict.setCurrentFile( filename )
737 processKLLFile( filename )
738 # Apply assignment cache, see 5.1.2 USB Codes for why this is necessary
739 macros_map.replayCachedAssignments()
741 # Iterate through additional layers
742 for partial in partialFileSets:
743 # Increment layer for each -p option
744 macros_map.addLayer()
745 variables_dict.incrementLayer() # DefaultLayer is layer 0
747 # Iterate and process each of the file in the layer
748 for filename in partial:
749 variables_dict.setCurrentFile( filename )
750 processKLLFile( filename )
752 # Apply assignment cache, see 5.1.2 USB Codes for why this is necessary
753 macros_map.replayCachedAssignments()
754 # Remove un-marked keys to complete the partial layer
755 macros_map.removeUnmarked()
757 # Do macro correlation and transformation
758 macros_map.generate()
760 # Process needed templating variables using backend
769 # Generate output file using template and backend
770 backend.generate( outputs )
772 # Successful Execution