GCodeObject.py

"""GCode Objects"""

import functools

def custom_coroutine_wrapper(func):
    """Initialzie automatically."""
    @functools.wraps(func)
    def init(*args, **kwargs):
        """Initialize wrapper"""
        cr_obj = func(*args, **kwargs)
        next(cr_obj)
        return cr_obj
    return init

# G-code element base class
class GCodeElementBase:
    "G-code element base"
    element = None
    def __init__(self, element=None):
        self.element = element
    def __str__(self):
        return self.element
    def __repr__(self):
        return '({}: {})'.format(self.__class__.__name__, repr(self.element))

# G-code parser elements
class GCodeParserElementBase(GCodeElementBase):
    """G-code parser element base"""
    pass

class GCodeParserChar(GCodeParserElementBase):
    """G-code parser char element"""
    pass

class GCodeParserNumberBase(GCodeParserElementBase):
    """G-code parser number element base"""
    pass

class GCodeParserInt(GCodeParserNumberBase):
    """G-code parser int element"""
    def __int__(self):
        return self.element

class GCodeParserFloat(GCodeParserNumberBase):
    """G-code parser float element"""
    def __float__(self):
        return self.element

class GCodeParserSpace(GCodeParserElementBase):
    """G-code parser space element"""
    pass

class GCodeParserMinus(GCodeParserElementBase):
    """G-code parser minus element"""
    pass

class GCodeParserDot(GCodeParserElementBase):
    """G-code parser dot element"""
    pass

class GCodeParserBracketBase(GCodeParserElementBase):
    """G-code parser bracket base"""
    pass

class GCodeParserBracketLeft(GCodeParserBracketBase):
    """G-code parser left bracket element"""
    pass

class GCodeParserBracketRight(GCodeParserBracketBase):
    """G-code parser right bracket element"""
    pass

class GCodeParserSpecialCharacter(GCodeParserElementBase):
    """G-code parser special character element"""
    pass

class GCodeParserDigitAfterDot(GCodeParserElementBase):
    """G-code parser element which shows how many zero(0)s are located after dot(.).
This class is special. It works distinctively."""
    pass

# G-code result elements
class GCodeResultElementBase(GCodeElementBase):
    """G-code result element base"""
    pass

class GCodePrefix(GCodeResultElementBase):
    """G-code prefix element"""
    pass

class GCodeNumberElementBase(GCodeResultElementBase):
    """G-code number element base"""
    pass

class GCodeInt(GCodeNumberElementBase):
    """G-code inteagr element"""
    def __int__(self):
        return self.element

class GCodeFloat(GCodeNumberElementBase):
    """G-code float element"""
    def __float__(self):
        return self.element

class GCode:
    "G-code object"
    element_prefix = None
    element_num = None
    def __init__(self, element_prefix, element_num):
        self.element_prefix = element_prefix
        self.element_num = element_num
    def __str__(self):
        return '{}{}'.format(str(self.element_prefix), str(self.element_num))
    def __repr__(self):
        return '({}: {}, {})'.format \
            (self.__class__.__name__, repr(self.element_prefix), repr(self.element_num))

class GCodeExceptionBase(Exception):
    "Basic exception class for G-code handling"
    pass

class GCodeExceptionForError(GCodeExceptionBase):
    """Basic exception class for G-code error"""

class GCodeSyntaxError(GCodeExceptionForError):
    """G-code syntax error"""
    pass

class GCodeExceptionForLogic(GCodeExceptionBase):
    """Basic exception class for programming logic"""

class GCodeDeliberateException(GCodeExceptionForLogic):
    """Deliberate exception"""