kll.py

   1 #!/usr/bin/env python3
   2 # KLL Compiler
   3 # Keyboard Layout Langauge
   4 #
   5 # Copyright (C) 2014 by Jacob Alexander
   6 #
   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.
  11 #
  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.
  16 #
  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/>.
  19
  20 ### Imports ###
  21
  22 import argparse
  23 import io
  24 import os
  25 import re
  26 import sys
  27 import token
  28 import importlib
  29
  30 from tokenize import generate_tokens
  31 from re       import VERBOSE
  32 from pprint   import pformat
  33
  34 from kll_lib.hid_dict   import *
  35 from kll_lib.containers import *
  36
  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)
  39
  40
  41
  42 ### Decorators ###
  43
  44  ## Print Decorator Variables
  45 ERROR = '\033[5;1;31mERROR\033[0m:'
  46
  47
  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",
  53 }
  54
  55 def textFormatter_gettext( s ):
  56         return textFormatter_lookup.get( s, s )
  57
  58 argparse._ = textFormatter_gettext
  59
  60
  61
  62 ### Argument Parsing ###
  63
  64 def checkFileExists( filename ):
  65         if not os.path.isfile( filename ):
  66                 print ( "{0} {1} does not exist...".format( ERROR, filename ) )
  67                 sys.exit( 1 )
  68
  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,
  76                 add_help=False,
  77 )
  78
  79         # Positional Arguments
  80         pArgs.add_argument( 'files', type=str, nargs='+',
  81                 help=argparse.SUPPRESS ) # Suppressed help output, because Python output is verbosely ugly
  82
  83         # Optional Arguments
  84         pArgs.add_argument( '-b', '--backend', type=str, default="kiibohd",
  85                 help="Specify target backend for the KLL compiler.\n"
  86                 "Default: kiibohd" )
  87         pArgs.add_argument( '-d', '--default', type=str, nargs='+',
  88                 help="Specify .kll files to layer on top of the default map to create a combined map." )
  89         pArgs.add_argument( '-p', '--partial', type=str, nargs='+', action='append',
  90                 help="Specify .kll files to generate partial map, multiple files per flag.\n"
  91                 "Each -p defines another partial map.\n"
  92                 "Base .kll files (that define the scan code maps) must be defined for each partial map." )
  93         pArgs.add_argument( '-t', '--template', type=str, default="templates/kiibohdKeymap.h",
  94                 help="Specify template used to generate the keymap.\n"
  95                 "Default: templates/kiibohdKeymap.h" )
  96         pArgs.add_argument( '-o', '--output', type=str, default="templateKeymap.h",
  97                 help="Specify output file. Writes to current working directory by default.\n"
  98                 "Default: generatedKeymap.h" )
  99         pArgs.add_argument( '-h', '--help', action="help",
 100                 help="This message." )
 101
 102         # Process Arguments
 103         args = pArgs.parse_args()
 104
 105         # Parameters
 106         baseFiles = args.files
 107         defaultFiles = args.default
 108         partialFileSets = args.partial
 109         if defaultFiles is None:
 110                 partialFileSets = []
 111         if partialFileSets is None:
 112                 partialFileSets = [[]]
 113
 114         # Check file existance
 115         for filename in baseFiles:
 116                 checkFileExists( filename )
 117
 118         for filename in defaultFiles:
 119                 checkFileExists( filename )
 120
 121         for partial in partialFileSets:
 122                 for filename in partial:
 123                         checkFileExists( filename )
 124
 125         return (baseFiles, defaultFiles, partialFileSets, args.backend, args.template, args.output)
 126
 127
 128
 129 ### Tokenizer ###
 130
 131 def tokenize( string ):
 132         """str -> Sequence(Token)"""
 133
 134         # Basic Tokens Spec
 135         specs = [
 136                 ( 'Comment',          ( r' *#.*', ) ),
 137                 ( 'Space',            ( r'[ \t\r\n]+', ) ),
 138                 ( 'USBCode',          ( r'U(("[^"]+")|(0x[0-9a-fA-F]+)|([0-9]+))', ) ),
 139                 ( 'USBCodeStart',     ( r'U\[', ) ),
 140                 ( 'ScanCode',         ( r'S((0x[0-9a-fA-F]+)|([0-9]+))', ) ),
 141                 ( 'ScanCodeStart',    ( r'S\[', ) ),
 142                 ( 'CodeEnd',          ( r'\]', ) ),
 143                 ( 'String',           ( r'"[^"]*"', VERBOSE ) ),
 144                 ( 'SequenceString',   ( r"'[^']*'", ) ),
 145                 ( 'Operator',         ( r'=>|:\+|:-|:|=', ) ),
 146                 ( 'Comma',            ( r',', ) ),
 147                 ( 'Dash',             ( r'-', ) ),
 148                 ( 'Plus',             ( r'\+', ) ),
 149                 ( 'Parenthesis',      ( r'\(|\)', ) ),
 150                 ( 'Number',           ( r'-?(0x[0-9a-fA-F]+)|(0|([1-9][0-9]*))', VERBOSE ) ),
 151                 ( 'Name',             ( r'[A-Za-z_][A-Za-z_0-9]*', ) ),
 152                 ( 'VariableContents', ( r'''[^"' ;:=>()]+''', ) ),
 153                 ( 'EndOfLine',        ( r';', ) ),
 154         ]
 155
 156         # Tokens to filter out of the token stream
 157         useless = ['Space', 'Comment']
 158
 159         tokens = make_tokenizer( specs )
 160         return [x for x in tokens( string ) if x.type not in useless]
 161
 162
 163
 164 ### Parsing ###
 165
 166  ## Map Arrays
 167 macros_map        = Macros()
 168 variable_dict     = dict()
 169 capabilities_dict = Capabilities()
 170
 171
 172  ## Parsing Functions
 173
 174 def make_scanCode( token ):
 175         scanCode = int( token[1:], 0 )
 176         # Check size, to make sure it's valid
 177         if scanCode > 0xFF:
 178                 print ( "{0} ScanCode value {1} is larger than 255".format( ERROR, scanCode ) )
 179                 raise
 180         return scanCode
 181
 182 def make_usbCode( token ):
 183         # If first character is a U, strip
 184         if token[0] == "U":
 185                 token = token[1:]
 186
 187         # If using string representation of USB Code, do lookup, case-insensitive
 188         if '"' in token:
 189                 try:
 190                         usbCode = kll_hid_lookup_dictionary[ token[1:-1].upper() ]
 191                 except LookupError as err:
 192                         print ( "{0} {1} is an invalid USB Code Lookup...".format( ERROR, err ) )
 193                         raise
 194         else:
 195                 usbCode = int( token, 0 )
 196
 197         # Check size, to make sure it's valid
 198         if usbCode > 0xFF:
 199                 print ( "{0} USBCode value {1} is larger than 255".format( ERROR, usbCode ) )
 200                 raise
 201         return usbCode
 202
 203 def make_seqString( token ):
 204         # Shifted Characters, and amount to move by to get non-shifted version
 205         # US ANSI
 206         shiftCharacters = (
 207                 ( "ABCDEFGHIJKLMNOPQRSTUVWXYZ", 0x20 ),
 208                 ( "+",       0x12 ),
 209                 ( "&(",      0x11 ),
 210                 ( "!#$%<>",  0x10 ),
 211                 ( "*",       0x0E ),
 212                 ( ")",       0x07 ),
 213                 ( '"',       0x05 ),
 214                 ( ":",       0x01 ),
 215                 ( "^",      -0x10 ),
 216                 ( "_",      -0x18 ),
 217                 ( "{}|",    -0x1E ),
 218                 ( "~",      -0x20 ),
 219                 ( "@",      -0x32 ),
 220                 ( "?",      -0x38 ),
 221         )
 222
 223         listOfLists = []
 224         shiftKey = kll_hid_lookup_dictionary["SHIFT"]
 225
 226         # Creates a list of USB codes from the string: sequence (list) of combos (lists)
 227         for char in token[1:-1]:
 228                 processedChar = char
 229
 230                 # Whether or not to create a combo for this sequence with a shift
 231                 shiftCombo = False
 232
 233                 # Depending on the ASCII character, convert to single character or Shift + character
 234                 for pair in shiftCharacters:
 235                         if char in pair[0]:
 236                                 shiftCombo = True
 237                                 processedChar = chr( ord( char ) + pair[1] )
 238                                 break
 239
 240                 # Do KLL HID Lookup on non-shifted character
 241                 # NOTE: Case-insensitive, which is why the shift must be pre-computed
 242                 usbCode = kll_hid_lookup_dictionary[ processedChar.upper() ]
 243
 244                 # Create Combo for this character, add shift key if shifted
 245                 charCombo = []
 246                 if shiftCombo:
 247                         charCombo = [ [ shiftKey ] ]
 248                 charCombo.append( [ usbCode ] )
 249
 250                 # Add to list of lists
 251                 listOfLists.append( charCombo )
 252
 253         return listOfLists
 254
 255 def make_string( token ):
 256         return token[1:-1]
 257
 258 def make_number( token ):
 259         return int( token, 0 )
 260
 261   # Range can go from high to low or low to high
 262 def make_scanCode_range( rangeVals ):
 263         start = rangeVals[0]
 264         end   = rangeVals[1]
 265
 266         # Swap start, end if start is greater than end
 267         if start > end:
 268                 start, end = end, start
 269
 270         # Iterate from start to end, and generate the range
 271         return list( range( start, end + 1 ) )
 272
 273   # Range can go from high to low or low to high
 274   # Warn on 0-9 (as this does not do what one would expect) TODO
 275   # Lookup USB HID tags and convert to a number
 276 def make_usbCode_range( rangeVals ):
 277         # Check if already integers
 278         if isinstance( rangeVals[0], int ):
 279                 start = rangeVals[0]
 280         else:
 281                 start = make_usbCode( rangeVals[0] )
 282
 283         if isinstance( rangeVals[1], int ):
 284                 end = rangeVals[1]
 285         else:
 286                 end = make_usbCode( rangeVals[1] )
 287
 288         # Swap start, end if start is greater than end
 289         if start > end:
 290                 start, end = end, start
 291
 292         # Iterate from start to end, and generate the range
 293         return list( range( start, end + 1 ) )
 294         pass
 295
 296
 297  ## Base Rules
 298
 299 const       = lambda x: lambda _: x
 300 unarg       = lambda f: lambda x: f(*x)
 301 flatten     = lambda list: sum( list, [] )
 302
 303 tokenValue  = lambda x: x.value
 304 tokenType   = lambda t: some( lambda x: x.type == t ) >> tokenValue
 305 operator    = lambda s: a( Token( 'Operator', s ) ) >> tokenValue
 306 parenthesis = lambda s: a( Token( 'Parenthesis', s ) ) >> tokenValue
 307 eol         = a( Token( 'EndOfLine', ';' ) )
 308
 309 def listElem( item ):
 310         return [ item ]
 311
 312 def listToTuple( items ):
 313         return tuple( items )
 314
 315   # Flatten only the top layer (list of lists of ...)
 316 def oneLayerFlatten( items ):
 317         mainList = []
 318         for sublist in items:
 319                 for item in sublist:
 320                         mainList.append( item )
 321
 322         return mainList
 323
 324   # Expand ranges of values in the 3rd dimension of the list, to a list of 2nd lists
 325   # i.e. [ sequence, [ combo, [ range ] ] ] --> [ [ sequence, [ combo ] ], <option 2>, <option 3> ]
 326 def optionExpansion( sequences ):
 327         expandedSequences = []
 328
 329         # Total number of combinations of the sequence of combos that needs to be generated
 330         totalCombinations = 1
 331
 332         # List of leaf lists, with number of leaves
 333         maxLeafList = []
 334
 335         # Traverse to the leaf nodes, and count the items in each leaf list
 336         for sequence in sequences:
 337                 for combo in sequence:
 338                         rangeLen = len( combo )
 339                         totalCombinations *= rangeLen
 340                         maxLeafList.append( rangeLen )
 341
 342         # Counter list to keep track of which combination is being generated
 343         curLeafList = [0] * len( maxLeafList )
 344
 345         # Generate a list of permuations of the sequence of combos
 346         for count in range( 0, totalCombinations ):
 347                 expandedSequences.append( [] ) # Prepare list for adding the new combination
 348                 position = 0
 349
 350                 # Traverse sequence of combos to generate permuation
 351                 for sequence in sequences:
 352                         expandedSequences[ -1 ].append( [] )
 353                         for combo in sequence:
 354                                 expandedSequences[ -1 ][ -1 ].append( combo[ curLeafList[ position ] ] )
 355                                 position += 1
 356
 357                 # Increment combination tracker
 358                 for leaf in range( 0, len( curLeafList ) ):
 359                         curLeafList[ leaf ] += 1
 360
 361                         # Reset this position, increment next position (if it exists), then stop
 362                         if curLeafList[ leaf ] >= maxLeafList[ leaf ]:
 363                                 curLeafList[ leaf ] = 0
 364                                 if leaf + 1 < len( curLeafList ):
 365                                         curLeafList[ leaf + 1 ] += 1
 366                                 break
 367
 368         return expandedSequences
 369
 370
 371 # Converts USB Codes into Capabilities
 372 def usbCodeToCapability( items ):
 373         # Items already converted to variants using optionExpansion
 374         for variant in range( 0, len( items ) ):
 375                 # Sequence of Combos
 376                 for sequence in range( 0, len( items[ variant ] ) ):
 377                         for combo in range( 0, len( items[ variant ][ sequence ] ) ):
 378                                 # Only convert if an integer, otherwise USB Code doesn't need converting
 379                                 if isinstance( items[ variant ][ sequence ][ combo ], int ):
 380                                         # Use backend capability name and a single argument
 381                                         items[ variant ][ sequence ][ combo ] = tuple( [ backend.usbCodeCapability(), tuple( [ items[ variant ][ sequence ][ combo ] ] ) ] )
 382
 383         return items
 384
 385
 386  ## Evaluation Rules
 387
 388 def eval_scanCode( triggers, operator, results ):
 389         # Convert to lists of lists of lists to tuples of tuples of tuples
 390         # Tuples are non-mutable, and can be used has index items
 391         triggers = tuple( tuple( tuple( sequence ) for sequence in variant ) for variant in triggers )
 392         results  = tuple( tuple( tuple( sequence ) for sequence in variant ) for variant in results )
 393
 394         # Iterate over all combinations of triggers and results
 395         for trigger in triggers:
 396                 for result in results:
 397                         # Append Case
 398                         if operator == ":+":
 399                                 macros_map.appendScanCode( trigger, result )
 400
 401                         # Remove Case
 402                         elif operator == ":-":
 403                                 macros_map.removeScanCode( trigger, result )
 404
 405                         # Replace Case
 406                         elif operator == ":":
 407                                 macros_map.replaceScanCode( trigger, result )
 408
 409 def eval_usbCode( triggers, operator, results ):
 410         # Convert to lists of lists of lists to tuples of tuples of tuples
 411         # Tuples are non-mutable, and can be used has index items
 412         triggers = tuple( tuple( tuple( sequence ) for sequence in variant ) for variant in triggers )
 413         results  = tuple( tuple( tuple( sequence ) for sequence in variant ) for variant in results )
 414
 415         # Iterate over all combinations of triggers and results
 416         for trigger in triggers:
 417                 scanCodes = macros_map.lookupUSBCodes( trigger )
 418                 for scanCode in scanCodes:
 419                         for result in results:
 420                                 # Cache assignment until file finishes processing
 421                                 macros_map.cacheAssignment( operator, scanCode, result )
 422
 423 def eval_variable( name, content ):
 424         # Content might be a concatenation of multiple data types, convert everything into a single string
 425         assigned_content = ""
 426         for item in content:
 427                 assigned_content += str( item )
 428
 429         variable_dict[ name ] = assigned_content
 430
 431 def eval_capability( name, function, args ):
 432         capabilities_dict[ name ] = [ function, args ]
 433
 434 map_scanCode   = unarg( eval_scanCode )
 435 map_usbCode    = unarg( eval_usbCode )
 436
 437 set_variable   = unarg( eval_variable )
 438 set_capability = unarg( eval_capability )
 439
 440
 441  ## Sub Rules
 442
 443 usbCode   = tokenType('USBCode') >> make_usbCode
 444 scanCode  = tokenType('ScanCode') >> make_scanCode
 445 name      = tokenType('Name')
 446 number    = tokenType('Number') >> make_number
 447 comma     = tokenType('Comma')
 448 dash      = tokenType('Dash')
 449 plus      = tokenType('Plus')
 450 content   = tokenType('VariableContents')
 451 string    = tokenType('String') >> make_string
 452 unString  = tokenType('String') # When the double quotes are still needed for internal processing
 453 seqString = tokenType('SequenceString') >> make_seqString
 454
 455   # Code variants
 456 code_end = tokenType('CodeEnd')
 457
 458   # Scan Codes
 459 scanCode_start     = tokenType('ScanCodeStart')
 460 scanCode_range     = number + skip( dash ) + number >> make_scanCode_range
 461 scanCode_listElem  = number >> listElem
 462 scanCode_innerList = oneplus( ( scanCode_range | scanCode_listElem ) + skip( maybe( comma ) ) ) >> flatten
 463 scanCode_expanded  = skip( scanCode_start ) + scanCode_innerList + skip( code_end )
 464 scanCode_elem      = scanCode >> listElem
 465 scanCode_combo     = oneplus( ( scanCode_expanded | scanCode_elem ) + skip( maybe( plus ) ) )
 466 scanCode_sequence  = oneplus( scanCode_combo + skip( maybe( comma ) ) )
 467
 468   # USB Codes
 469 usbCode_start       = tokenType('USBCodeStart')
 470 usbCode_range       = ( number | unString ) + skip( dash ) + ( number | unString ) >> make_usbCode_range
 471 usbCode_listElemTag = unString >> make_usbCode
 472 usbCode_listElem    = ( number | usbCode_listElemTag ) >> listElem
 473 usbCode_innerList   = oneplus( ( usbCode_range | usbCode_listElem ) + skip( maybe( comma ) ) ) >> flatten
 474 usbCode_expanded    = skip( usbCode_start ) + usbCode_innerList + skip( code_end )
 475 usbCode_elem        = usbCode >> listElem
 476 usbCode_combo       = oneplus( ( usbCode_expanded | usbCode_elem ) + skip( maybe( plus ) ) ) >> listElem
 477 usbCode_sequence    = oneplus( ( usbCode_combo | seqString ) + skip( maybe( comma ) ) ) >> oneLayerFlatten
 478
 479   # Capabilities
 480 capFunc_arguments = many( number + skip( maybe( comma ) ) ) >> listToTuple
 481 capFunc_elem      = name + skip( parenthesis('(') ) + capFunc_arguments + skip( parenthesis(')') ) >> listElem
 482 capFunc_combo     = oneplus( ( usbCode_expanded | usbCode_elem | capFunc_elem ) + skip( maybe( plus ) ) ) >> listElem
 483 capFunc_sequence  = oneplus( ( capFunc_combo | seqString ) + skip( maybe( comma ) ) ) >> oneLayerFlatten
 484
 485   # Trigger / Result Codes
 486 triggerCode_outerList    = scanCode_sequence >> optionExpansion
 487 triggerUSBCode_outerList = usbCode_sequence >> optionExpansion >> usbCodeToCapability
 488 resultCode_outerList     = capFunc_sequence >> optionExpansion >> usbCodeToCapability
 489
 490
 491  ## Main Rules
 492
 493 #| <variable> = <variable contents>;
 494 variable_contents   = name | content | string | number | comma | dash
 495 variable_expression = name + skip( operator('=') ) + oneplus( variable_contents ) + skip( eol ) >> set_variable
 496
 497 #| <capability name> => <c function>;
 498 capability_arguments  = name + skip( operator(':') ) + number + skip( maybe( comma ) )
 499 capability_expression = name + skip( operator('=>') ) + name + skip( parenthesis('(') ) + many( capability_arguments ) + skip( parenthesis(')') ) + skip( eol ) >> set_capability
 500
 501 #| <trigger> : <result>;
 502 operatorTriggerResult = operator(':') | operator(':+') | operator(':-')
 503 scanCode_expression   = triggerCode_outerList + operatorTriggerResult + resultCode_outerList + skip( eol ) >> map_scanCode
 504 usbCode_expression    = triggerUSBCode_outerList + operatorTriggerResult + resultCode_outerList + skip( eol ) >> map_usbCode
 505
 506 def parse( tokenSequence ):
 507         """Sequence(Token) -> object"""
 508
 509         # Top-level Parser
 510         expression = scanCode_expression | usbCode_expression | variable_expression | capability_expression
 511
 512         kll_text = many( expression )
 513         kll_file = maybe( kll_text ) + skip( finished )
 514
 515         return kll_file.parse( tokenSequence )
 516
 517
 518
 519 def processKLLFile( filename ):
 520         with open( filename ) as file:
 521                 data = file.read()
 522                 tokenSequence = tokenize( data )
 523                 #print ( pformat( tokenSequence ) ) # Display tokenization
 524                 tree = parse( tokenSequence )
 525
 526
 527
 528 ### Main Entry Point ###
 529
 530 if __name__ == '__main__':
 531         (baseFiles, defaultFiles, partialFileSets, backend_name, template, output) = processCommandLineArgs()
 532
 533         # Load backend module
 534         global backend
 535         backend_import = importlib.import_module( "backends.{0}".format( backend_name ) )
 536         backend = backend_import.Backend( template )
 537
 538         # Process base layout files
 539         for filename in baseFiles:
 540                 processKLLFile( filename )
 541         macros_map.completeBaseLayout() # Indicates to macros_map that the base layout is complete
 542
 543         # Default combined layer
 544         for filename in defaultFiles:
 545                 processKLLFile( filename )
 546         # Apply assignment cache, see 5.1.2 USB Codes for why this is necessary
 547         macros_map.replayCachedAssignments()
 548
 549         # Iterate through additional layers
 550         for partial in partialFileSets:
 551                 # Increment layer for each -p option
 552                 macros_map.addLayer()
 553                 # Iterate and process each of the file in the layer
 554                 for filename in partial:
 555                         processKLLFile( filename )
 556                 # Apply assignment cache, see 5.1.2 USB Codes for why this is necessary
 557                 macros_map.replayCachedAssignments()
 558                 # Remove un-marked keys to complete the partial layer
 559                 macros_map.removeUnmarked()
 560
 561         # Do macro correlation and transformation
 562         macros_map.generate()
 563
 564         # Process needed templating variables using backend
 565         backend.process( capabilities_dict, macros_map )
 566
 567         # Generate output file using template and backend
 568         backend.generate( output )
 569
 570         # Successful Execution
 571         sys.exit( 0 )
 572