X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=kll.py;h=c4386e0bf7cb34bbadfb38da0e7d52dea37602e0;hb=26437c35ad12ac90a94657b3bb5a1ed1b8f5e0db;hp=57fd37aa37ce39783f7ae4d442601782d009fbdf;hpb=923e623c7465e03c792c7093cd21f3eea86f5f28;p=kiibohd-kll.git diff --git a/kll.py b/kll.py index 57fd37a..c4386e0 100755 --- a/kll.py +++ b/kll.py @@ -2,7 +2,7 @@ # KLL Compiler # Keyboard Layout Langauge # -# Copyright (C) 2014 by Jacob Alexander +# Copyright (C) 2014-2015 by Jacob Alexander # # This file is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by @@ -20,19 +20,19 @@ ### Imports ### import argparse +import importlib import io import os import re import sys import token -import importlib -from tokenize import generate_tokens -from re import VERBOSE from pprint import pformat +from re import VERBOSE +from tokenize import generate_tokens -from kll_lib.hid_dict import * from kll_lib.containers import * +from kll_lib.hid_dict import * from funcparserlib.lexer import make_tokenizer, Token, LexerError from funcparserlib.parser import (some, a, many, oneplus, skip, finished, maybe, skip, forward_decl, NoParseError) @@ -69,12 +69,12 @@ def checkFileExists( filename ): def processCommandLineArgs(): # Setup argument processor pArgs = argparse.ArgumentParser( - usage="%(prog)s [options] ...", - description="Generates .h file state tables and pointer indices from KLL .kll files.", - epilog="Example: {0} mykeyboard.kll -d colemak.kll -p hhkbpro2.kll -p symbols.kll".format( os.path.basename( sys.argv[0] ) ), - formatter_class=argparse.RawTextHelpFormatter, - add_help=False, -) + usage="%(prog)s [options] ...", + description="Generates .h file state tables and pointer indices from KLL .kll files.", + epilog="Example: {0} mykeyboard.kll -d colemak.kll -p hhkbpro2.kll -p symbols.kll".format( os.path.basename( sys.argv[0] ) ), + formatter_class=argparse.RawTextHelpFormatter, + add_help=False, + ) # Positional Arguments pArgs.add_argument( 'files', type=str, nargs='+', @@ -83,25 +83,20 @@ def processCommandLineArgs(): # Optional Arguments pArgs.add_argument( '-b', '--backend', type=str, default="kiibohd", help="Specify target backend for the KLL compiler.\n" - "Default: kiibohd" ) + "Default: kiibohd\n" + "Options: kiibohd, json" ) pArgs.add_argument( '-d', '--default', type=str, nargs='+', help="Specify .kll files to layer on top of the default map to create a combined map." ) pArgs.add_argument( '-p', '--partial', type=str, nargs='+', action='append', help="Specify .kll files to generate partial map, multiple files per flag.\n" "Each -p defines another partial map.\n" "Base .kll files (that define the scan code maps) must be defined for each partial map." ) - pArgs.add_argument( '-t', '--template', type=str, default="templates/kiibohdKeymap.h", + pArgs.add_argument( '-t', '--templates', type=str, nargs='+', help="Specify template used to generate the keymap.\n" - "Default: templates/kiibohdKeymap.h" ) - pArgs.add_argument( '--defines-template', type=str, default="templates/kiibohdDefs.h", - help="Specify template used to generate kll_defs.h.\n" - "Default: templates/kiibohdDefs.h" ) - pArgs.add_argument( '-o', '--output', type=str, default="generatedKeymap.h", + "Default: " ) + pArgs.add_argument( '-o', '--outputs', type=str, nargs='+', help="Specify output file. Writes to current working directory by default.\n" - "Default: generatedKeymap.h" ) - pArgs.add_argument( '--defines-output', type=str, default="kll_defs.h", - help="Specify output path for kll_defs.h. Writes to current working directory by default.\n" - "Default: kll_defs.h" ) + "Default: " ) pArgs.add_argument( '-h', '--help', action="help", help="This message." ) @@ -128,7 +123,7 @@ def processCommandLineArgs(): for filename in partial: checkFileExists( filename ) - return (baseFiles, defaultFiles, partialFileSets, args.backend, args.template, args.defines_template, args.output, args.defines_output) + return (baseFiles, defaultFiles, partialFileSets, args.backend, args.templates, args.outputs) @@ -143,16 +138,23 @@ def tokenize( string ): ( 'Space', ( r'[ \t\r\n]+', ) ), ( 'USBCode', ( r'U(("[^"]+")|(0x[0-9a-fA-F]+)|([0-9]+))', ) ), ( 'USBCodeStart', ( r'U\[', ) ), + ( 'ConsCode', ( r'CONS(("[^"]+")|(0x[0-9a-fA-F]+)|([0-9]+))', ) ), + ( 'ConsCodeStart', ( r'CONS\[', ) ), + ( 'SysCode', ( r'SYS(("[^"]+")|(0x[0-9a-fA-F]+)|([0-9]+))', ) ), + ( 'SysCodeStart', ( r'SYS\[', ) ), + ( 'LedCode', ( r'LED(("[^"]+")|(0x[0-9a-fA-F]+)|([0-9]+))', ) ), + ( 'LedCodeStart', ( r'LED\[', ) ), ( 'ScanCode', ( r'S((0x[0-9a-fA-F]+)|([0-9]+))', ) ), ( 'ScanCodeStart', ( r'S\[', ) ), ( 'CodeEnd', ( r'\]', ) ), - ( 'String', ( r'"[^"]*"', VERBOSE ) ), + ( 'String', ( r'"[^"]*"', ) ), ( 'SequenceString', ( r"'[^']*'", ) ), - ( 'Operator', ( r'=>|:\+|:-|:|=', ) ), + ( 'Operator', ( r'=>|:\+|:-|::|:|=', ) ), ( 'Comma', ( r',', ) ), ( 'Dash', ( r'-', ) ), ( 'Plus', ( r'\+', ) ), ( 'Parenthesis', ( r'\(|\)', ) ), + ( 'None', ( r'None', ) ), ( 'Number', ( r'-?(0x[0-9a-fA-F]+)|(0|([1-9][0-9]*))', VERBOSE ) ), ( 'Name', ( r'[A-Za-z_][A-Za-z_0-9]*', ) ), ( 'VariableContents', ( r'''[^"' ;:=>()]+''', ) ), @@ -180,31 +182,84 @@ capabilities_dict = Capabilities() def make_scanCode( token ): scanCode = int( token[1:], 0 ) # Check size, to make sure it's valid - if scanCode > 0xFF: - print ( "{0} ScanCode value {1} is larger than 255".format( ERROR, scanCode ) ) - raise + # XXX Add better check that takes symbolic names into account (i.e. U"Latch5") + #if scanCode > 0xFF: + # print ( "{0} ScanCode value {1} is larger than 255".format( ERROR, scanCode ) ) + # raise return scanCode -def make_usbCode( token ): +def make_hidCode( type, token ): # If first character is a U, strip if token[0] == "U": token = token[1:] + # CONS specifier + elif 'CONS' in token: + token = token[4:] + # SYS specifier + elif 'SYS' in token: + token = token[3:] # If using string representation of USB Code, do lookup, case-insensitive if '"' in token: try: - usbCode = kll_hid_lookup_dictionary[ token[1:-1].upper() ] + hidCode = kll_hid_lookup_dictionary[ type ][ token[1:-1].upper() ][1] except LookupError as err: - print ( "{0} {1} is an invalid USB Code Lookup...".format( ERROR, err ) ) + print ( "{0} {1} is an invalid USB HID Code Lookup...".format( ERROR, err ) ) raise else: - usbCode = int( token, 0 ) + # Already tokenized + if type == 'USBCode' and token[0] == 'USB' or type == 'SysCode' and token[0] == 'SYS' or type == 'ConsCode' and token[0] == 'CONS': + hidCode = token[1] + # Convert + else: + hidCode = int( token, 0 ) + + # Check size if a USB Code, to make sure it's valid + # XXX Add better check that takes symbolic names into account (i.e. U"Latch5") + #if type == 'USBCode' and hidCode > 0xFF: + # print ( "{0} USBCode value {1} is larger than 255".format( ERROR, hidCode ) ) + # raise + + # Return a tuple, identifying which type it is + if type == 'USBCode': + return make_usbCode_number( hidCode ) + elif type == 'ConsCode': + return make_consCode_number( hidCode ) + elif type == 'SysCode': + return make_sysCode_number( hidCode ) + + print ( "{0} Unknown HID Specifier '{1}'".format( ERROR, type ) ) + raise - # Check size, to make sure it's valid - if usbCode > 0xFF: - print ( "{0} USBCode value {1} is larger than 255".format( ERROR, usbCode ) ) - raise - return usbCode +def make_usbCode( token ): + return make_hidCode( 'USBCode', token ) + +def make_consCode( token ): + return make_hidCode( 'ConsCode', token ) + +def make_sysCode( token ): + return make_hidCode( 'SysCode', token ) + +def make_hidCode_number( type, token ): + lookup = { + 'ConsCode' : 'CONS', + 'SysCode' : 'SYS', + 'USBCode' : 'USB', + } + return ( lookup[ type ], token ) + +def make_usbCode_number( token ): + return make_hidCode_number( 'USBCode', token ) + +def make_consCode_number( token ): + return make_hidCode_number( 'ConsCode', token ) + +def make_sysCode_number( token ): + return make_hidCode_number( 'SysCode', token ) + + # Replace key-word with None specifier (which indicates a noneOut capability) +def make_none( token ): + return [[[('NONE', 0)]]] def make_seqString( token ): # Shifted Characters, and amount to move by to get non-shifted version @@ -213,21 +268,21 @@ def make_seqString( token ): ( "ABCDEFGHIJKLMNOPQRSTUVWXYZ", 0x20 ), ( "+", 0x12 ), ( "&(", 0x11 ), - ( "!#$%<>", 0x10 ), + ( "!#$%", 0x10 ), ( "*", 0x0E ), ( ")", 0x07 ), ( '"', 0x05 ), ( ":", 0x01 ), - ( "^", -0x10 ), - ( "_", -0x18 ), - ( "{}|", -0x1E ), - ( "~", -0x20 ), - ( "@", -0x32 ), - ( "?", -0x38 ), + ( "@", -0x0E ), + ( "<>?", -0x10 ), + ( "~", -0x1E ), + ( "{}|", -0x20 ), + ( "^", -0x28 ), + ( "_", -0x32 ), ) listOfLists = [] - shiftKey = kll_hid_lookup_dictionary["SHIFT"] + shiftKey = kll_hid_lookup_dictionary['USBCode']["SHIFT"] # Creates a list of USB codes from the string: sequence (list) of combos (lists) for char in token[1:-1]: @@ -245,7 +300,7 @@ def make_seqString( token ): # Do KLL HID Lookup on non-shifted character # NOTE: Case-insensitive, which is why the shift must be pre-computed - usbCode = kll_hid_lookup_dictionary[ processedChar.upper() ] + usbCode = kll_hid_lookup_dictionary['USBCode'][ processedChar.upper() ] # Create Combo for this character, add shift key if shifted charCombo = [] @@ -280,27 +335,40 @@ def make_scanCode_range( rangeVals ): return list( range( start, end + 1 ) ) # Range can go from high to low or low to high - # Warn on 0-9 (as this does not do what one would expect) TODO + # Warn on 0-9 for USBCodes (as this does not do what one would expect) TODO # Lookup USB HID tags and convert to a number -def make_usbCode_range( rangeVals ): +def make_hidCode_range( type, rangeVals ): # Check if already integers if isinstance( rangeVals[0], int ): start = rangeVals[0] else: - start = make_usbCode( rangeVals[0] ) + start = make_hidCode( type, rangeVals[0] )[1] if isinstance( rangeVals[1], int ): end = rangeVals[1] else: - end = make_usbCode( rangeVals[1] ) + end = make_hidCode( type, rangeVals[1] )[1] # Swap start, end if start is greater than end if start > end: start, end = end, start # Iterate from start to end, and generate the range - return list( range( start, end + 1 ) ) - pass + listRange = list( range( start, end + 1 ) ) + + # Convert each item in the list to a tuple + for item in range( len( listRange ) ): + listRange[ item ] = make_hidCode_number( type, listRange[ item ] ) + return listRange + +def make_usbCode_range( rangeVals ): + return make_hidCode_range( 'USBCode', rangeVals ) + +def make_sysCode_range( rangeVals ): + return make_hidCode_range( 'SysCode', rangeVals ) + +def make_consCode_range( rangeVals ): + return make_hidCode_range( 'ConsCode', rangeVals ) ## Base Rules @@ -392,20 +460,35 @@ def optionExpansion( sequences ): # Converts USB Codes into Capabilities -def usbCodeToCapability( items ): +# These are tuples (, ) +def hidCodeToCapability( items ): # Items already converted to variants using optionExpansion for variant in range( 0, len( items ) ): # Sequence of Combos for sequence in range( 0, len( items[ variant ] ) ): for combo in range( 0, len( items[ variant ][ sequence ] ) ): - # Only convert if an integer, otherwise USB Code doesn't need converting - if isinstance( items[ variant ][ sequence ][ combo ], int ): - # Use backend capability name and a single argument - items[ variant ][ sequence ][ combo ] = tuple( [ backend.usbCodeCapability(), tuple( [ items[ variant ][ sequence ][ combo ] ] ) ] ) - + if items[ variant ][ sequence ][ combo ][0] in backend.requiredCapabilities.keys(): + try: + # Use backend capability name and a single argument + items[ variant ][ sequence ][ combo ] = tuple( + [ backend.capabilityLookup( items[ variant ][ sequence ][ combo ][0] ), + tuple( [ hid_lookup_dictionary[ items[ variant ][ sequence ][ combo ] ] ] ) ] + ) + except KeyError: + print ( "{0} {1} is an invalid HID lookup value".format( ERROR, items[ variant ][ sequence ][ combo ] ) ) + sys.exit( 1 ) return items +# Convert tuple of tuples to list of lists +def listit( t ): + return list( map( listit, t ) ) if isinstance( t, ( list, tuple ) ) else t + +# Convert list of lists to tuple of tuples +def tupleit( t ): + return tuple( map( tupleit, t ) ) if isinstance( t, ( tuple, list ) ) else t + + ## Evaluation Rules def eval_scanCode( triggers, operator, results ): @@ -414,8 +497,26 @@ def eval_scanCode( triggers, operator, results ): triggers = tuple( tuple( tuple( sequence ) for sequence in variant ) for variant in triggers ) results = tuple( tuple( tuple( sequence ) for sequence in variant ) for variant in results ) + # Lookup interconnect id (Current file scope) + # Default to 0 if not specified + if 'ConnectId' not in variables_dict.overallVariables.keys(): + id_num = 0 + else: + id_num = int( variables_dict.overallVariables['ConnectId'] ) + # Iterate over all combinations of triggers and results - for trigger in triggers: + for sequence in triggers: + # Convert tuple of tuples to list of lists so each element can be modified + trigger = listit( sequence ) + + # Create ScanCode entries for trigger + for seq_index, combo in enumerate( sequence ): + for com_index, scancode in enumerate( combo ): + trigger[ seq_index ][ com_index ] = macros_map.scanCodeStore.append( ScanCode( scancode, id_num ) ) + + # Convert back to a tuple of tuples + trigger = tupleit( trigger ) + for result in results: # Append Case if operator == ":+": @@ -426,7 +527,8 @@ def eval_scanCode( triggers, operator, results ): macros_map.removeScanCode( trigger, result ) # Replace Case - elif operator == ":": + # Soft Replace Case is the same for Scan Codes + elif operator == ":" or operator == "::": macros_map.replaceScanCode( trigger, result ) def eval_usbCode( triggers, operator, results ): @@ -440,6 +542,10 @@ def eval_usbCode( triggers, operator, results ): scanCodes = macros_map.lookupUSBCodes( trigger ) for scanCode in scanCodes: for result in results: + # Soft Replace needs additional checking to see if replacement is necessary + if operator == "::" and not macros_map.softReplaceCheck( scanCode ): + continue + # Cache assignment until file finishes processing macros_map.cacheAssignment( operator, scanCode, result ) @@ -469,6 +575,9 @@ set_define = unarg( eval_define ) usbCode = tokenType('USBCode') >> make_usbCode scanCode = tokenType('ScanCode') >> make_scanCode +consCode = tokenType('ConsCode') >> make_consCode +sysCode = tokenType('SysCode') >> make_sysCode +none = tokenType('None') >> make_none name = tokenType('Name') number = tokenType('Number') >> make_number comma = tokenType('Comma') @@ -495,25 +604,49 @@ scanCode_sequence = oneplus( scanCode_combo + skip( maybe( comma ) ) ) # USB Codes usbCode_start = tokenType('USBCodeStart') -usbCode_range = ( number | unString ) + skip( dash ) + ( number | unString ) >> make_usbCode_range +usbCode_number = number >> make_usbCode_number +usbCode_range = ( usbCode_number | unString ) + skip( dash ) + ( number | unString ) >> make_usbCode_range usbCode_listElemTag = unString >> make_usbCode -usbCode_listElem = ( number | usbCode_listElemTag ) >> listElem +usbCode_listElem = ( usbCode_number | usbCode_listElemTag ) >> listElem usbCode_innerList = oneplus( ( usbCode_range | usbCode_listElem ) + skip( maybe( comma ) ) ) >> flatten usbCode_expanded = skip( usbCode_start ) + usbCode_innerList + skip( code_end ) usbCode_elem = usbCode >> listElem usbCode_combo = oneplus( ( usbCode_expanded | usbCode_elem ) + skip( maybe( plus ) ) ) >> listElem usbCode_sequence = oneplus( ( usbCode_combo | seqString ) + skip( maybe( comma ) ) ) >> oneLayerFlatten + # Cons Codes +consCode_start = tokenType('ConsCodeStart') +consCode_number = number >> make_consCode_number +consCode_range = ( consCode_number | unString ) + skip( dash ) + ( number | unString ) >> make_consCode_range +consCode_listElemTag = unString >> make_consCode +consCode_listElem = ( consCode_number | consCode_listElemTag ) >> listElem +consCode_innerList = oneplus( ( consCode_range | consCode_listElem ) + skip( maybe( comma ) ) ) >> flatten +consCode_expanded = skip( consCode_start ) + consCode_innerList + skip( code_end ) +consCode_elem = consCode >> listElem + + # Sys Codes +sysCode_start = tokenType('SysCodeStart') +sysCode_number = number >> make_sysCode_number +sysCode_range = ( sysCode_number | unString ) + skip( dash ) + ( number | unString ) >> make_sysCode_range +sysCode_listElemTag = unString >> make_sysCode +sysCode_listElem = ( sysCode_number | sysCode_listElemTag ) >> listElem +sysCode_innerList = oneplus( ( sysCode_range | sysCode_listElem ) + skip( maybe( comma ) ) ) >> flatten +sysCode_expanded = skip( sysCode_start ) + sysCode_innerList + skip( code_end ) +sysCode_elem = sysCode >> listElem + + # HID Codes +hidCode_elem = usbCode_expanded | usbCode_elem | sysCode_expanded | sysCode_elem | consCode_expanded | consCode_elem + # Capabilities capFunc_arguments = many( number + skip( maybe( comma ) ) ) >> listToTuple capFunc_elem = name + skip( parenthesis('(') ) + capFunc_arguments + skip( parenthesis(')') ) >> capArgExpander >> listElem -capFunc_combo = oneplus( ( usbCode_expanded | usbCode_elem | capFunc_elem ) + skip( maybe( plus ) ) ) >> listElem +capFunc_combo = oneplus( ( hidCode_elem | capFunc_elem ) + skip( maybe( plus ) ) ) >> listElem capFunc_sequence = oneplus( ( capFunc_combo | seqString ) + skip( maybe( comma ) ) ) >> oneLayerFlatten # Trigger / Result Codes triggerCode_outerList = scanCode_sequence >> optionExpansion -triggerUSBCode_outerList = usbCode_sequence >> optionExpansion >> usbCodeToCapability -resultCode_outerList = capFunc_sequence >> optionExpansion >> usbCodeToCapability +triggerUSBCode_outerList = usbCode_sequence >> optionExpansion >> hidCodeToCapability +resultCode_outerList = ( ( capFunc_sequence >> optionExpansion ) | none ) >> hidCodeToCapability ## Main Rules @@ -530,7 +663,7 @@ capability_expression = name + skip( operator('=>') ) + name + skip( parenthesis define_expression = name + skip( operator('=>') ) + name + skip( eol ) >> set_define #| : ; -operatorTriggerResult = operator(':') | operator(':+') | operator(':-') +operatorTriggerResult = operator(':') | operator(':+') | operator(':-') | operator('::') scanCode_expression = triggerCode_outerList + operatorTriggerResult + resultCode_outerList + skip( eol ) >> map_scanCode usbCode_expression = triggerUSBCode_outerList + operatorTriggerResult + resultCode_outerList + skip( eol ) >> map_usbCode @@ -552,19 +685,51 @@ def processKLLFile( filename ): data = file.read() tokenSequence = tokenize( data ) #print ( pformat( tokenSequence ) ) # Display tokenization - tree = parse( tokenSequence ) + try: + tree = parse( tokenSequence ) + except NoParseError as e: + print("Error parsing %s. %s" % (filename, e.msg), file=sys.stderr) + sys.exit(1) + + +### Misc Utility Functions ### + +def gitRevision( kllPath ): + import subprocess + # Change the path to where kll.py is + origPath = os.getcwd() + os.chdir( kllPath ) + + # Just in case git can't be found + try: + # Get hash of the latest git commit + revision = subprocess.check_output( ['git', 'rev-parse', 'HEAD'] ).decode()[:-1] + + # Get list of files that have changed since the commit + changed = subprocess.check_output( ['git', 'diff-index', '--name-only', 'HEAD', '--'] ).decode().splitlines() + except: + revision = "" + changed = [] + + # Change back to the old working directory + os.chdir( origPath ) + + return revision, changed ### Main Entry Point ### if __name__ == '__main__': - (baseFiles, defaultFiles, partialFileSets, backend_name, template, defines_template, output, defines_output) = processCommandLineArgs() + (baseFiles, defaultFiles, partialFileSets, backend_name, templates, outputs) = processCommandLineArgs() + + # Look up git information on the compiler + gitRev, gitChanges = gitRevision( os.path.dirname( os.path.realpath( __file__ ) ) ) # Load backend module global backend backend_import = importlib.import_module( "backends.{0}".format( backend_name ) ) - backend = backend_import.Backend( template, defines_template ) + backend = backend_import.Backend( templates ) # Process base layout files for filename in baseFiles: @@ -600,10 +765,16 @@ if __name__ == '__main__': macros_map.generate() # Process needed templating variables using backend - backend.process( capabilities_dict, macros_map, variables_dict ) + backend.process( + capabilities_dict, + macros_map, + variables_dict, + gitRev, + gitChanges + ) # Generate output file using template and backend - backend.generate( output, defines_output ) + backend.generate( outputs ) # Successful Execution sys.exit( 0 )