X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=kll.py;h=1ad024496bf7f1563978dbf85f5d2c40222caffa;hb=refs%2Fheads%2Fdonlayout;hp=57fd37aa37ce39783f7ae4d442601782d009fbdf;hpb=923e623c7465e03c792c7093cd21f3eea86f5f28;p=kiibohd-kll.git diff --git a/kll.py b/kll.py index 57fd37a..1ad0244 100755 --- a/kll.py +++ b/kll.py @@ -1,8 +1,10 @@ #!/usr/bin/env python3 -# KLL Compiler -# Keyboard Layout Langauge -# -# Copyright (C) 2014 by Jacob Alexander +''' +KLL Compiler +Keyboard Layout Langauge +''' + +# Copyright (C) 2014-2016 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,33 +22,28 @@ ### Imports ### import argparse -import io +import importlib import os -import re import sys -import token -import importlib -from tokenize import generate_tokens from re import VERBOSE -from pprint import pformat -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) +from funcparserlib.parser import (some, a, many, oneplus, finished, maybe, skip, NoParseError) ### Decorators ### - ## Print Decorator Variables +## Print Decorator Variables ERROR = '\033[5;1;31mERROR\033[0m:' - ## Python Text Formatting Fixer... - ## Because the creators of Python are averse to proper capitalization. +## Python Text Formatting Fixer... +## Because the creators of Python are averse to proper capitalization. textFormatter_lookup = { "usage: " : "Usage: ", "optional arguments" : "Optional Arguments", @@ -69,12 +66,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 +80,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 +120,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,17 +135,24 @@ 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'=>|:\+|:-|::|:|=', ) ), + ( 'Number', ( r'(-[ \t]*)?((0x[0-9a-fA-F]+)|(0|([1-9][0-9]*)))', VERBOSE ) ), ( 'Comma', ( r',', ) ), ( 'Dash', ( r'-', ) ), ( 'Plus', ( r'\+', ) ), ( 'Parenthesis', ( r'\(|\)', ) ), - ( 'Number', ( r'-?(0x[0-9a-fA-F]+)|(0|([1-9][0-9]*))', VERBOSE ) ), + ( 'None', ( r'None', ) ), ( 'Name', ( r'[A-Za-z_][A-Za-z_0-9]*', ) ), ( 'VariableContents', ( r'''[^"' ;:=>()]+''', ) ), ( 'EndOfLine', ( r';', ) ), @@ -169,42 +168,95 @@ def tokenize( string ): ### Parsing ### - ## Map Arrays +## Map Arrays macros_map = Macros() variables_dict = Variables() capabilities_dict = Capabilities() - ## Parsing Functions +## Parsing Functions 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 +265,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 +297,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 = [] @@ -267,7 +319,7 @@ def make_unseqString( token ): def make_number( token ): return int( token, 0 ) - # Range can go from high to low or low to high +# Range can go from high to low or low to high def make_scanCode_range( rangeVals ): start = rangeVals[0] end = rangeVals[1] @@ -279,31 +331,44 @@ def make_scanCode_range( rangeVals ): # Iterate from start to end, and generate the range 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 - # Lookup USB HID tags and convert to a number -def make_usbCode_range( rangeVals ): +# Range can go from high to low or low to high +# 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_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 - ## Base Rules +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 const = lambda x: lambda _: x unarg = lambda f: lambda x: f(*x) @@ -321,7 +386,7 @@ def listElem( item ): def listToTuple( items ): return tuple( items ) - # Flatten only the top layer (list of lists of ...) +# Flatten only the top layer (list of lists of ...) def oneLayerFlatten( items ): mainList = [] for sublist in items: @@ -330,14 +395,27 @@ def oneLayerFlatten( items ): return mainList - # Capability arguments may need to be expanded (e.g. 1 16 bit argument needs to be 2 8 bit arguments for the state machine) def capArgExpander( items ): + ''' + Capability arguments may need to be expanded + (e.g. 1 16 bit argument needs to be 2 8 bit arguments for the state machine) + + If the number is negative, determine width of the final value, mask to max, subtract, + then convert to multiple bytes + ''' newArgs = [] # For each defined argument in the capability definition for arg in range( 0, len( capabilities_dict[ items[0] ][1] ) ): argLen = capabilities_dict[ items[0] ][1][ arg ][1] num = items[1][ arg ] - byteForm = num.to_bytes( argLen, byteorder='little' ) # XXX Yes, little endian from how the uC structs work + + # Set last bit if value is negative + if num < 0: + max_val = 2 ** (argLen * 8) + num += max_val + + # XXX Yes, little endian from how the uC structs work + byteForm = num.to_bytes( argLen, byteorder='little' ) # For each sub-argument, split into byte-sized chunks for byte in range( 0, argLen ): @@ -345,8 +423,8 @@ def capArgExpander( items ): return tuple( [ items[0], tuple( newArgs ) ] ) - # Expand ranges of values in the 3rd dimension of the list, to a list of 2nd lists - # i.e. [ sequence, [ combo, [ range ] ] ] --> [ [ sequence, [ combo ] ],