Archived
1
0
This repo is archived. You can view files and clone it, but cannot push or open issues or pull requests.
kll/common/id.py
Jacob Alexander f610d0fb15 KLL Compiler Re-Write
This was many months of efforts in re-designing how the KLL compiler should work.
The major problem with the original compiler was how difficult it was to extend language wise.
This lead to many delays in KLL 0.4 and 0.5 being implemented.

The new design is a multi-staged compiler, where even tokenization occurs over multiple stages.
This allows individual parsing and token regexes to be expressed more simply without affect other expressions.

Another area of change is the concept of Contexts.
In the original KLL compiler the idea of a cache assigned was "hacked" on when I realized the language was "broken" (after nearly finishing the compiler).
Since assignment order is generally considered not to matter for keymappings, I created a "cached" assignment where the whole file is read into a sub-datastructure, then apply to the master datastructure.
Unfortunately, this wasn't really all that clear, so it was annoying to work with.
To remedy this, I created KLL Contexts, which contain information about a group of expressions.
Not only can these groups can be merged with other Contexts, they have historical data about how they were generated allowing for errors very late in processing to be pin-pointed back to the offending kll file.

Backends work nearly the same as they did before.
However, all call-backs for capability evaluations have been removed.
This makes the interface much cleaner as Contexts can only be symbolically merged now.
(Previously datastructures did evaluation merges where the ScanCode or Capability was looked up right before passing to the backend, but this required additional information from the backend).

Many of the old parsing and tokenization rules have been reused, along with the hid_dict.py code.

The new design takes advantage of processor pools to handle multithreading where it makes sense.
For example, all specified files are loaded into ram simulatenously rather than sparingly reading from.
The reason for this is so that each Context always has all the information it requires at all times.

kll
- Program entry point (previously kll.py)
- Very small now, does some setting up of command-line args
- Most command-line args are specified by the corresponding processing stage

common/channel.py
- Pixel Channel container classes

common/context.py
- Context container classes
- As is usual with other files, blank classes inherit a base class
- These blank classes are identified by the class name itself to handle special behaviour
- And if/when necessary functions are re-implemented
- MergeConext class facilitates merging of contexts while maintaining lineage

common/expression.py
- Expression container classes
  * Expression base class
  * AssignmentExpression
  * NameAssociationExpression
  * DataAssociationExpression
  * MapExpression
- These classes are used to store expressions after they have finished parsing and tokenization

common/file.py
- Container class for files being read by the KLL compiler

common/emitter.py
- Base class for all KLL emitters
- TextEmitter for dealing with text file templates

common/hid_dict.py
- Slightly modified version of kll_lib/hid_dict.py

common/id.py
- Identification container classes
- Used to indentify different types of elements used within the KLL language

common/modifier.py
- Container classes for animation and pixel change functions

common/organization.py
- Data structure merging container classes
- Contains all the sub-datastructure classes as well
- The Organization class handles the merge orchestration and expression insertion

common/parse.py
- Parsing rules for funcparserlib
- Much of this file was taken from the original kll.py
- Many changes to support the multi-stage processing and support KLL 0.5

common/position.py
- Container class dealing with physical positions

common/schedule.py
- Container class dealing with scheduling and timing events

common/stage.py
- Contains ControlStage and main Stage classes
  * CompilerConfigurationStage
  * FileImportStage
  * PreprocessorStage
  * OperationClassificationStage
  * OperationSpecificsStage
  * OperationOrganizationStage
  * DataOrganziationStage
  * DataFinalizationStage
  * DataAnalysisStage
  * CodeGenerationStage
  * ReportGenerationStage
- Each of these classes controls the life-cycle of each stage
- If multi-threading is desired, it must be handled within the class
  * The next stage will not start until the current stage is finished
- Errors are handled such that as many errors as possible are recorded before forcing an exit
  * The exit is handled at the end of each stage if necessary
- Command-line arguments for each stage can be defined if necessary (they are given their own grouping)
- Each stage can pull variables and functions from other stages if necessary using a name lookup
  * This means you don't have to worry about over-arching datastructures

emitters/emitters.py
- Container class for KLL emitters
- Handles emitter setup and selection

emitters/kiibohd/kiibohd.py
- kiibohd .h file KLL emitter
- Re-uses some backend code from the original KLL compiler

funcparserlib/parser.py
- Added debug mode control

examples/assignment.kll
examples/defaultMapExample.kll
examples/example.kll
examples/hhkbpro2.kll
examples/leds.kll
examples/mapping.kll
examples/simple1.kll
examples/simple2.kll
examples/simpleExample.kll
examples/state_scheduling.kll
- Updating/Adding rules for new compiler and KLL 0.4 + KLL 0.5 support
2016-09-01 23:48:13 -07:00

281 lines
6.5 KiB
Python

#!/usr/bin/env python3
'''
KLL Id Containers
'''
# Copyright (C) 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
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This file is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this file. If not, see <http://www.gnu.org/licenses/>.
### Imports ###
from common.hid_dict import hid_lookup_dictionary
from common.channel import ChannelList
from common.modifier import AnimationModifierList, PixelModifierList
from common.position import Position
from common.schedule import Schedule
### Decorators ###
## Print Decorator Variables
ERROR = '\033[5;1;31mERROR\033[0m:'
WARNING = '\033[5;1;33mWARNING\033[0m:'
### Classes ###
class Id:
'''
Base container class for various KLL types
'''
def __init__( self ):
self.type = None
self.uid = None
class HIDId( Id, Schedule ):
'''
HID/USB identifier container class
'''
secondary_types = {
'USBCode' : 'USB',
'SysCode' : 'SYS',
'ConsCode' : 'CONS',
'IndCode' : 'IND',
}
def __init__( self, type, uid ):
'''
@param type: String type of the Id
@param uid: Unique integer identifier for the Id
'''
Id.__init__( self )
Schedule.__init__( self )
self.type = type
self.uid = uid
# Set secondary type
self.second_type = self.secondary_types[ self.type ]
# TODO Validate uid to make sure it's in the lookup dictionary
# TODO Validate HID specifier
#print ( "{0} Unknown HID Specifier '{1}'".format( ERROR, type ) )
#raise
def __repr__( self ):
'''
Use string name instead of integer, easier to debug
'''
uid = hid_lookup_dictionary[ ( self.second_type, self.uid ) ]
schedule = self.strSchedule()
if len( schedule ) > 0:
schedule = "({0})".format( schedule )
output = 'HID({0})"{1}"{2}'.format( self.type, uid, schedule )
return output
class ScanCodeId( Id, Schedule, Position ):
'''
Scan Code identifier container class
'''
def __init__( self, uid ):
Id.__init__( self )
Schedule.__init__( self )
Position.__init__( self )
self.type = 'ScanCode'
self.uid = uid
# By default, interconnect_id of 0
# Will be set during the merge process if it needs to change
self.interconnect_id = 0
def unique_key( self ):
'''
Returns the key string used for datastructure sorting
'''
# Positions are a special case
if self.positionSet():
return "P{0}".format( self.uid )
def __repr__( self ):
# Positions are a special case
if self.positionSet():
return "{0} <= {1}".format( self.unique_key(), self.strPosition() )
schedule = self.strSchedule()
if len( schedule ) > 0:
return "S{0}({1})".format( self.uid, schedule )
else:
return "S{0}".format( self.uid )
class AnimationId( Id, AnimationModifierList ):
'''
Animation identifier container class
'''
name = None
def __init__( self, name ):
Id.__init__( self )
AnimationModifierList.__init__( self )
self.name = name
self.type = 'Animation'
def __repr__( self ):
if len( self.modifiers ) > 0:
return "A[{0}]({1})".format( self.name, self.strModifiers() )
return "A[{0}]".format( self.name )
class AnimationFrameId( Id, AnimationModifierList ):
'''
Animation Frame identifier container class
'''
def __init__( self, name, index ):
Id.__init__( self )
AnimationModifierList.__init__( self )
self.name = name
self.index = index
self.type = 'AnimationFrame'
def __repr__( self ):
return "AF[{0}, {1}]".format( self.name, self.index )
class PixelId( Id, Position, PixelModifierList, ChannelList ):
'''
Pixel identifier container class
'''
def __init__( self, uid ):
Id.__init__( self )
Position.__init__( self )
PixelModifierList.__init__( self )
ChannelList.__init__( self )
self.uid = uid
self.type = 'Pixel'
def unique_key( self ):
'''
Returns the key string used for datastructure sorting
'''
return "P{0}".format( self.uid )
def __repr__( self ):
# Positions are a special case
if self.positionSet():
return "{0} <= {1}".format( self.unique_key(), self.strPosition() )
extra = ""
if len( self.modifiers ) > 0:
extra += "({0})".format( self.strModifiers() )
if len( self.channels ) > 0:
extra += "({0})".format( self.strChannels() )
return "{0}{1}".format( self.unique_key(), extra )
class PixelLayerId( Id, PixelModifierList ):
'''
Pixel Layer identifier container class
'''
def __init__( self, uid ):
Id.__init__( self )
PixelModifierList.__init__( self )
self.uid = uid
self.type = 'PixelLayer'
def __repr__( self ):
if len( self.modifiers ) > 0:
return "PL{0}({1})".format( self.uid, self.strModifiers() )
return "PL{0}".format( self.uid )
class CapId( Id ):
'''
Capability identifier
'''
def __init__( self, name, type, arg_list=[] ):
'''
@param name: Name of capability
@param type: Type of capability definition, string
@param arg_list: List of CapArgIds, empty list if there are none
'''
Id.__init__( self )
self.name = name
self.type = type
self.arg_list = arg_list
def __repr__( self ):
# Generate prettified argument list
arg_string = ""
for arg in self.arg_list:
arg_string += "{0},".format( arg )
if len( arg_string ) > 0:
arg_string = arg_string[:-1]
return "{0}({1})".format( self.name, arg_string )
def total_arg_bytes( self ):
'''
Calculate the total number of bytes needed for the args
return: Number of bytes
'''
# Zero if no args
total_bytes = 0
for arg in self.arg_list:
total_bytes += arg.width
return total_bytes
class NoneId( CapId ):
'''
None identifier
It's just a capability...that does nothing (instead of infering to do something else)
'''
def __init__( self ):
super().__init__( 'None', 'None' )
def __repr__( self ):
return "None"
class CapArgId( Id ):
'''
Capability Argument identifier
'''
def __init__( self, name, width=None ):
'''
@param name: Name of argument
@param width: Byte-width of the argument, if None, this is not port of a capability definition
'''
Id.__init__( self )
self.name = name
self.width = width
self.type = 'CapArg'
def __repr__( self ):
if self.width is None:
return "{0}".format( self.name )
else:
return "{0}:{1}".format( self.name, self.width )