Ast.py 13.9 KB
Newer Older
Fabrice Salvaire's avatar
Fabrice Salvaire committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
####################################################################################################
#
# PythonicGcodeMachine - @licence_header_description@
# Copyright (C) 2018 Fabrice Salvaire
#
# This program 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 program 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 program.  If not, see <http://www.gnu.org/licenses/>.
#
####################################################################################################

"""Module to implement an AST for RS-274 G-code.
"""

####################################################################################################

__all__ = [
    'Program',
Fabrice Salvaire's avatar
Fabrice Salvaire committed
28
    # 'LineItem',
Fabrice Salvaire's avatar
Fabrice Salvaire committed
29 30 31
    'Line',
    'Comment',
    'Word',
Fabrice Salvaire's avatar
Fabrice Salvaire committed
32
    # 'RealValue',
Fabrice Salvaire's avatar
Fabrice Salvaire committed
33 34 35
    'ParameterMixin',
    'ParameterSetting',
    'Parameter',
Fabrice Salvaire's avatar
Fabrice Salvaire committed
36 37

    # 'UnaryOperation',
Fabrice Salvaire's avatar
Fabrice Salvaire committed
38 39 40 41 42 43 44 45 46 47 48 49 50
    'AbsoluteValue',
    'ArcCosine',
    'ArcSine',
    'ArcTangent',
    'Cosine',
    'ERaisedTo',
    'FixDown',
    'FixUp',
    'NaturalLogOf',
    'Round',
    'Sine',
    'SquareRoot',
    'Tangent',
Fabrice Salvaire's avatar
Fabrice Salvaire committed
51 52

    # 'BinaryOperation',
Fabrice Salvaire's avatar
Fabrice Salvaire committed
53 54 55 56 57 58
    'Power',
    'DividedBy',
    'Modulo',
    'Times',
    'And',
    'ExclusiveOr',
Fabrice Salvaire's avatar
Fabrice Salvaire committed
59 60 61
    'Subtraction',
    'Or',
    'Addition',
Fabrice Salvaire's avatar
Fabrice Salvaire committed
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
]

####################################################################################################

import math

####################################################################################################

class Program:

    """Class to implement a G-code program

    Usage::

        program = Program()
        program += line
        str(program)

    """

    ##############################################

    def __init__(self):
        self._lines = []

    ##############################################

    def push(self, line):
        self._lines.append(line)

    def __iadd__(self, item):
        self.push(item)
        return self

    ##############################################

    def __len__(self):
        return len(self._lines)

    def __iter__(self):
        return iter(self._lines)

    def __getitem__(self, _slice):
        return self._lines[_slice]

    def iter_on_not_deleted(self):
        for line in self._lines:
            if line:
                yield line

    ##############################################

    def __repr__(self):

        text = 'Program(\n'
        for line in self:
            text += repr(line) + '\n'
        text += ')\n'

        return text

    ##############################################

    def __str__(self):
        return '\n'.join(map(str, self))

####################################################################################################

class LineItem:
    pass

####################################################################################################

class Line:

    """Class to implement a G-code line

    Usage::

        line = Line(def=False, line_number=1, comment='a comment')
        line += Word('G', 0)
        line += Comment('move')
        line += Word('X', 10)
        line += Comment('Y value')
        line += Word('Y', 20)
        line += ParameterSetting('1', 1.2)
        str(line)

    """

    ##############################################

    def __init__(self, deleted=False, line_number=None, comment=None):

        self.deleted = deleted
        self.line_number = line_number
        self.comment = comment

        self._items = []

    ##############################################

    @property
    def deleted(self):
        return self._deleted

    @deleted.setter
    def deleted(self, value):
        self._deleted = bool(value)

    @property
    def line_number(self):
        return self._line_number

    @line_number.setter
    def line_number(self, value):
        if value is not None:
            value = float(value)
            if value.is_integer():
                value = int(value)
        self._line_number = value

    @property
    def comment(self):
        return self._comment

    @comment.setter
    def comment(self, value):
        if value is not None:
            self._comment = str(value)
        else:
            self._comment = None

    ##############################################

    def push(self, item):
        if isinstance(item, LineItem):
            self._items.append(item)
        else:
            raise ValueError

    def __iadd__(self, item):
        self.push(item)
        return self

    ##############################################

    def __bool__(self):
        return not self._deleted

    ##############################################

    def __len__(self):
        return len(self._items)

    def __iter__(self):
        return iter(self._items)

    def __getitem__(self, _slice):
        return self._items[_slice]

    ##############################################

    def __repr__(self):

        items = []
        if not self:
            items.append('Deleted')
        items += list(map(repr, self))
        if self._comment:
            items.append(self._comment)

        return 'Line{}'.format(self, items)

    ##############################################

    def __str__(self):

        line = ''
        if not self:
Fabrice Salvaire's avatar
Fabrice Salvaire committed
242
            line += '/ '
Fabrice Salvaire's avatar
Fabrice Salvaire committed
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
        if self._line_number:
            line += 'N{} '.format(self._line_number)
        line += ' '.join(map(str, self))
        if self._comment:
            line += ' ; ' + self._comment

        return line

####################################################################################################

class Comment(LineItem):

    ##############################################

    def __init__(self, text):
        self.set(text)

    ##############################################

    def set(self, text):
        if '(' in text:
            raise ValueError('Comment cannot contains a "("')
        self._text = str(text)

    ##############################################

    @property
    def text(self):
        return self._text

    @text.setter
    def text(self, value):
        self.set(value)

    ##############################################

    def __repr__(self):
        return 'Comment({0._text})'.format(self)

    def __str__(self):
        return '({0._text})'.format(self)

####################################################################################################

class Word(LineItem):

    LETTERS = (
        'A', 'B', 'C', 'D',
        'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', # 'N',
        'P', 'Q', 'R', 'S', 'T',
        'X', 'Y', 'Z',
    )

    ##############################################

    def __init__(self, letter, value):
        self.letter = letter
        self.value = value

    ##############################################

    @property
    def letter(self):
        return self._letter

    @letter.setter
    def letter(self, value):
        value = str(value).upper()
        if value not in self.LETTERS:
            raise ValueError
        self._letter = value

    @property
    def value(self):
        return self._value

    @value.setter
    def value(self, value):
        # float expression ...
        self._value = value

    ##############################################

    def __repr__(self):
        return 'Word({0._letter} {0._value})'.format(self)

    def __str__(self):
        return '{0._letter}{0._value}'.format(self)

####################################################################################################

class RealValue:
    pass

####################################################################################################

class ParameterMixin:

    ##############################################

    def __init__(self, parameter):
        self.parameter = parameter

    ##############################################

    @property
    def parameter(self):
        return self._parameter

    @parameter.setter
    def parameter(self, value):
        try:
            value = int(value)
        except ValueError:
            value = str(value)
        self._parameter = value

####################################################################################################

class ParameterSetting(LineItem, ParameterMixin):

    ##############################################

    def __init__(self, parameter, value):
        ParameterMixin.__init__(self, parameter)
        self.value = value

    ##############################################
    @property
    def value(self):
        return self._value

    @value.setter
    def value(self, value):
        # float expression ...
        self._value = value

    ##############################################

    def __repr__(self):
        return 'ParameterSetting({0._parameter} = {0._value})'.format(self)

    def __str__(self):
        return '#{0._parameter}={0._value}'.format(self)

####################################################################################################

class Parameter(RealValue, ParameterMixin):

    ##############################################

    def __init__(self, parameter):
        ParameterMixin.__init__(self, parameter)

    ##############################################

    def __repr__(self):
        return 'Parameter({0._parameter})'.format(self)

    def __str__(self):
        return '#{0._parameter}'.format(self)

####################################################################################################

class UnaryOperation(RealValue):

    __function__ = None
    __gcode__ = None

    ##############################################

    def __init__(self, arg):
        self.arg = arg

    ##############################################

    @property
    def arg(self):
        return self._arg

    @arg.setter
    def arg(self, value):
        self._arg = value

    ##############################################

Fabrice Salvaire's avatar
Fabrice Salvaire committed
429
    def __float__(self):
Fabrice Salvaire's avatar
Fabrice Salvaire committed
430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
        return self.__function__(float(self._arg))

    ##############################################

    def __repr__(self):
        return '{}({})'.format(self.__class__.__name__, repr(self._arg))

    ##############################################

    def __str__(self):
        return '{0.__gcode__}[{0._arg}]'.format(self)

####################################################################################################

class AbsoluteValue(UnaryOperation):
Fabrice Salvaire's avatar
Fabrice Salvaire committed
445
    __function__ = staticmethod(abs)
Fabrice Salvaire's avatar
Fabrice Salvaire committed
446 447 448
    __gcode__ = 'abs'

class ArcCosine(UnaryOperation):
Fabrice Salvaire's avatar
Fabrice Salvaire committed
449
    __function__ = staticmethod(lambda x: math.acos(math.radians(x)))
Fabrice Salvaire's avatar
Fabrice Salvaire committed
450 451 452
    __gcode__ = 'acos'

class ArcSine(UnaryOperation):
Fabrice Salvaire's avatar
Fabrice Salvaire committed
453
    __function__ = staticmethod(lambda x: math.degrees(math.asin(x)))
Fabrice Salvaire's avatar
Fabrice Salvaire committed
454 455 456
    __gcode__ = 'asin'

class ArcTangent(UnaryOperation):
Fabrice Salvaire's avatar
Fabrice Salvaire committed
457
    __function__ = staticmethod(lambda x: math.degrees(math.atan(x)))
Fabrice Salvaire's avatar
Fabrice Salvaire committed
458 459 460
    __gcode__ = 'atan'

class Cosine(UnaryOperation):
Fabrice Salvaire's avatar
Fabrice Salvaire committed
461
    __function__ = staticmethod(lambda x: math.cos(math.radians(x)))
Fabrice Salvaire's avatar
Fabrice Salvaire committed
462 463 464
    __gcode__ =  'cos'

class ERaisedTo(UnaryOperation):
Fabrice Salvaire's avatar
Fabrice Salvaire committed
465
    __function__ = staticmethod(math.exp)
Fabrice Salvaire's avatar
Fabrice Salvaire committed
466 467 468
    __gcode__ = 'exp'

class FixDown(UnaryOperation):
Fabrice Salvaire's avatar
Fabrice Salvaire committed
469
    __function__ = staticmethod(math.ceil)
Fabrice Salvaire's avatar
Fabrice Salvaire committed
470 471 472
    __gcode__ = 'fix'

class FixUp(UnaryOperation):
Fabrice Salvaire's avatar
Fabrice Salvaire committed
473
    __function__ = staticmethod(math.floor)
Fabrice Salvaire's avatar
Fabrice Salvaire committed
474 475 476
    __gcode__ = 'fup'

class NaturalLogOf(UnaryOperation):
Fabrice Salvaire's avatar
Fabrice Salvaire committed
477
    __function__ = staticmethod(math.log)
Fabrice Salvaire's avatar
Fabrice Salvaire committed
478 479 480
    __gcode__ = 'ln'

class Round(UnaryOperation):
Fabrice Salvaire's avatar
Fabrice Salvaire committed
481
    __function__ = staticmethod(round)
Fabrice Salvaire's avatar
Fabrice Salvaire committed
482 483 484
    __gcode__ =  'round'

class Sine(UnaryOperation):
Fabrice Salvaire's avatar
Fabrice Salvaire committed
485
    __function__ = staticmethod(lambda x: math.sin(math.radians(x)))
Fabrice Salvaire's avatar
Fabrice Salvaire committed
486 487 488
    __gcode__ = 'sin'

class SquareRoot(UnaryOperation):
Fabrice Salvaire's avatar
Fabrice Salvaire committed
489
    __function__ = staticmethod(math.sqrt)
Fabrice Salvaire's avatar
Fabrice Salvaire committed
490 491 492
    __gcode__ = 'sqrt'

class Tangent(UnaryOperation):
Fabrice Salvaire's avatar
Fabrice Salvaire committed
493
    __function__ = staticmethod(lambda x: ath.tan(math.radians(x)))
Fabrice Salvaire's avatar
Fabrice Salvaire committed
494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528
    __gcode__ = 'tan'

####################################################################################################

class BinaryOperation(RealValue):

    __function__ = None
    __gcode__ = None

    ##############################################

    def __init__(self, arg1, arg2):
        self.arg1 = arg1
        self.arg2 = arg2

    ##############################################

    @property
    def arg1(self):
        return self._arg1

    @arg1.setter
    def arg1(self, value):
        self._arg1 = value

    @property
    def arg2(self):
        return self._arg2

    @arg2.setter
    def arg2(self, value):
        self._arg2 = value

    ##############################################

Fabrice Salvaire's avatar
Fabrice Salvaire committed
529
    def __float__(self):
Fabrice Salvaire's avatar
Fabrice Salvaire committed
530 531 532 533 534 535 536 537 538 539 540 541 542 543 544
        return self.__function__(float(self._arg1), float(self._arg2))

    ##############################################

    def __repr__(self):
        return '{}({})'.format(self.__class__.__name__, repr(self._arg))

    ##############################################

    def __str__(self):
        return '[{0._arg1} {0.__gcode__} {0._arg2}]'.format(self)

####################################################################################################

class Power(BinaryOperation):
Fabrice Salvaire's avatar
Fabrice Salvaire committed
545
    __function__ = staticmethod(lambda a, b: a**b)
Fabrice Salvaire's avatar
Fabrice Salvaire committed
546 547 548
    __gcode__ = '**'

class DividedBy(BinaryOperation):
Fabrice Salvaire's avatar
Fabrice Salvaire committed
549
    __function__ = staticmethod(lambda a, b: a / b)
Fabrice Salvaire's avatar
Fabrice Salvaire committed
550 551 552
    __gcode__ = '/'

class Modulo(BinaryOperation):
Fabrice Salvaire's avatar
Fabrice Salvaire committed
553
    __function__ = staticmethod(lambda a, b: a % b)
Fabrice Salvaire's avatar
Fabrice Salvaire committed
554 555 556
    __gcode__ = 'mod'

class Times(BinaryOperation):
Fabrice Salvaire's avatar
Fabrice Salvaire committed
557
    __function__ = staticmethod(lambda a, b: a * b)
Fabrice Salvaire's avatar
Fabrice Salvaire committed
558 559 560
    __gcode__ =  '*'

class And(BinaryOperation):
Fabrice Salvaire's avatar
Fabrice Salvaire committed
561
    __function__ = staticmethod(lambda a, b: a & b)
Fabrice Salvaire's avatar
Fabrice Salvaire committed
562 563 564
    __gcode__ = 'and'

class ExclusiveOr(BinaryOperation):
Fabrice Salvaire's avatar
Fabrice Salvaire committed
565
    __function__ = staticmethod(lambda a, b: a ^ b)
Fabrice Salvaire's avatar
Fabrice Salvaire committed
566 567
    __gcode__ = 'xor'

Fabrice Salvaire's avatar
Fabrice Salvaire committed
568 569
class Subtraction(BinaryOperation):
    __function__ = staticmethod(lambda a, b: a - b)
Fabrice Salvaire's avatar
Fabrice Salvaire committed
570 571
    __gcode__ = '-'

Fabrice Salvaire's avatar
Fabrice Salvaire committed
572 573
class Or(BinaryOperation):
    __function__ = staticmethod(lambda a, b: a | b)
Fabrice Salvaire's avatar
Fabrice Salvaire committed
574 575
    __gcode__ = 'or'

Fabrice Salvaire's avatar
Fabrice Salvaire committed
576 577
class Addition(BinaryOperation):
    __function__ = staticmethod(lambda a, b: a + b)
Fabrice Salvaire's avatar
Fabrice Salvaire committed
578
    __gcode__ = '+'