KLL Compiler
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
This repo is archived. You can view files and clone it, but cannot push or open issues/pull-requests.

kll.py 24KB

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