ogAST.py 27.4 KB
Newer Older
Maxime Perrotin's avatar
Maxime Perrotin 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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
#!/usr/bin/env python
# -*- coding: utf-8 -*-

"""

    OpenGEODE - A tiny SDL Editor for TASTE

    AST that can be used to write SDL backends (code generators, etc.)
    In all classes the 'inputString' field corresponds to the exact
    text from the PR file; line and charPositionInLine refer to the
    location of the string in the input PR stream.
    The 'coordinates' field corresponds to the CIF information.
    To use the AST, you must import ogAST and ogParser
    Example of code:

    import ogParser
    import ogAST

    ast = ogParser.parse_pr(files=['file1.pr', ...], string='...')

    -> ast is of type AST (see below)

    Design note:
        classes are used here only for the purpose of convenient
        reading of the AST. There is no object-orientation needed or
        used here.

    See AdaGenerator.py for an example of use.

    Copyright (c) 2012-2013 European Space Agency

    Designed and implemented by Maxime Perrotin

    Contact: maxime.perrotin@esa.int
"""

import logging
LOG = logging.getLogger(__name__)


class Expression(object):
    ''' AST Entry for expressions - Always use subtype '''
    is_raw = False
Maxime Perrotin's avatar
Maxime Perrotin committed
44

Maxime Perrotin's avatar
Maxime Perrotin committed
45
46
47
48
49
    def __init__(self, inputString='', line=-1, charPositionInLine=-1):
        ''' Initialize Expression attributes '''
        self.inputString = inputString
        self.line = line
        self.charPositionInLine = charPositionInLine
dbarbera's avatar
dbarbera committed
50

Maxime Perrotin's avatar
Maxime Perrotin committed
51
52
53
54
55
        # exprType is an ASN.1 type (as exported by asn1scc)
        self.exprType = None
        # Hint for code generators: intermediate storage identifier
        self.tmpVar = -1

Maxime Perrotin's avatar
Maxime Perrotin committed
56
    def trace(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
57
        ''' Debug output for an expression '''
Maxime Perrotin's avatar
Maxime Perrotin committed
58
        return u'{exp} ({l},{c})'.format(exp=self.inputString,
Maxime Perrotin's avatar
Maxime Perrotin committed
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
                                        l=self.line,
                                        c=self.charPositionInLine)


class ExprPlus(Expression):
    operand = '+'


class ExprMul(Expression):
    operand = '*'


class ExprMinus(Expression):
    operand = '-'


class ExprOr(Expression):
    operand = 'or'
77
78
    # Indicate that short circuit form is used ("or else")
    shortcircuit = ''
Maxime Perrotin's avatar
Maxime Perrotin committed
79
80
81
82


class ExprAnd(Expression):
    operand = 'and'
83
84
    # Indicate that short circuit form is used ("and then")
    shortcircuit = ''
Maxime Perrotin's avatar
Maxime Perrotin committed
85
86
87
88


class ExprXor(Expression):
    operand = 'xor'
89
    shortcircuit = ''
Maxime Perrotin's avatar
Maxime Perrotin committed
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


class ExprEq(Expression):
    operand = '='


class ExprNeq(Expression):
    operand = '/='


class ExprGt(Expression):
    operand = '>'


class ExprGe(Expression):
    operand = '>='


class ExprLt(Expression):
    operand = '<'


class ExprLe(Expression):
    operand = '<='


class ExprDiv(Expression):
    operand = '/'


class ExprMod(Expression):
    operand = 'mod'


class ExprRem(Expression):
dbarbera's avatar
dbarbera committed
125
    operand = 'rem'
Maxime Perrotin's avatar
Maxime Perrotin committed
126
127


dbarbera's avatar
dbarbera committed
128
129
130
131
132
133
134
135
class ExprNot(Expression):
    operand = 'not'


class ExprNeg(Expression):
    operand = '-'


Maxime Perrotin's avatar
Maxime Perrotin committed
136
137
138
139
class ExprAssign(Expression):
    operand = ':='


Maxime Perrotin's avatar
Maxime Perrotin committed
140
141
142
143
144
145
146
147
148
149
150
class ExprAppend(Expression):
    pass


class ExprIn(Expression):
    pass


class ExprImplies(Expression):
    pass

Maxime Perrotin's avatar
Maxime Perrotin committed
151
152
153
154
155
156
157

class Primary(Expression):
    '''
        AST entry for a primary construction (that is a terminal expression)
        Abstract class, never used directly, see subtypes below
    '''
    is_raw = True
Maxime Perrotin's avatar
Maxime Perrotin committed
158

Maxime Perrotin's avatar
Maxime Perrotin committed
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
    def __init__(self, inputString='', line=-1, charPositionInLine=-1,
                 primary=None):
        ''' Initialize common primary attributes '''
        if primary:
            self.inputString = primary.inputString
            self.line = primary.line
            self.charPositionInLine = primary.charPositionInLine
            self.value = primary.value
            self.exprType = primary.exprType
        else:
            self.inputString = inputString
            self.line = line
            self.charPositionInLine = charPositionInLine
            self.value = None
            self.exprType = None

Maxime Perrotin's avatar
Maxime Perrotin committed
175
    def trace(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
176
        ''' Debug output for a primary '''
Maxime Perrotin's avatar
Maxime Perrotin committed
177
        return u'PRIMARY : {exp} ({l},{c})'.format(exp=self.inputString,
Maxime Perrotin's avatar
Maxime Perrotin committed
178
179
                l=self.line, c=self.charPositionInLine)

Maxime Perrotin's avatar
Maxime Perrotin committed
180

dbarbera's avatar
dbarbera committed
181
class PrimCall(Primary):
Maxime Perrotin's avatar
Maxime Perrotin committed
182
183
    is_raw = False

Maxime Perrotin's avatar
Maxime Perrotin committed
184

dbarbera's avatar
dbarbera committed
185
186
class PrimIndex(Primary):
    is_raw = False
187
188


dbarbera's avatar
dbarbera committed
189
190
class PrimSubstring(Primary):
    is_raw = False
191
192


dbarbera's avatar
dbarbera committed
193
194
class PrimSelector(Primary):
    is_raw = False
195
196


dbarbera's avatar
dbarbera committed
197
198
class PrimVariable(Primary):
    is_raw = False
Maxime Perrotin's avatar
Maxime Perrotin committed
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


class PrimFPAR(PrimVariable):
    pass


class PrimEnumeratedValue(Primary):
    pass


class PrimInteger(Primary):
    pass


class PrimReal(Primary):
    pass


class PrimBoolean(Primary):
    pass


class PrimConstant(Primary):
    is_raw = False


class PrimBitStringLiteral(Primary):
    ''' Not supported yet '''
    pass


class PrimOctetStringLiteral(Primary):
    ''' Not supported yet '''
    pass
Maxime Perrotin's avatar
Maxime Perrotin committed
233
234


235
class PrimConditional(Primary):
Maxime Perrotin's avatar
Maxime Perrotin committed
236
237
238
239
240
241
    ''' value is a dictionnary:
        { 'if': Expression, 'then': Expression,
        'else': Expression, 'tmpVar': integer}
        tmpVar can be used if the backend needs a temporary variable
        to process the ifThenElse
    '''
242
    is_raw = False
Maxime Perrotin's avatar
Maxime Perrotin committed
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
    pass


class PrimStringLiteral(Primary):
    ''' Value is a string with quotes '''
    @property
    def exprType(self):
        return self._exprType

    @exprType.setter
    def exprType(self, val):
#       name = getattr(self, 'value', self.inputString)
#       import traceback
#       traceback.print_stack()
#       print 'SET type of', name, 'to', val
        self._exprType = val


class PrimMantissaBaseExp(Primary):
    ''' Value is a dict: {'mantissa': int, 'base': int, 'exponent': int} '''
    pass


Maxime Perrotin's avatar
Maxime Perrotin committed
266
267
class PrimEmptyString(Primary):
    pass
Maxime Perrotin's avatar
Maxime Perrotin committed
268
269
270
271
272
273
274


class PrimChoiceItem(Primary):
    ''' Value is a dict : {'choice': string, 'value': Expression} '''
    pass


Maxime Perrotin's avatar
Maxime Perrotin committed
275
276
class PrimChoiceDeterminant(Primary):
    pass
Maxime Perrotin's avatar
Maxime Perrotin committed
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


class PrimSequenceOf(Primary):
    ''' Value is a list of Primary '''


class PrimSequence(Primary):
    ''' Value is a dict : { field1: Expression, field2: Expression } '''
    pass


class Decision(object):
    ''' AST Entry for a decision '''
    def __init__(self):
        ''' A DECISION statement '''
        self.inputString = ''
        self.line = None
        self.charPositionInLine = None
        self.pos_x = 0
        self.pos_y = 0
        self.width = 70
        self.height = 50
        # kind can be 'any', 'informal_text', or 'question'
        self.kind = None
        # question is an Expression
        self.question = None
        # informalText is a string (when kind == 'informal_text')
        self.informalText = None
        # list of type Answer
        self.answers = []
        # optional comment symbol
        self.comment = None
        # optional hyperlink
        self.hyperlink = None
        # hint for backends needing a temporary variable to hold the question
        self.tmpVar = -1

Maxime Perrotin's avatar
Maxime Perrotin committed
314
    def trace(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
315
        ''' Debug output for a decision '''
Maxime Perrotin's avatar
Maxime Perrotin committed
316
        return u'DECISION {exp} ({l},{c})'.format(exp=self.inputString,
Maxime Perrotin's avatar
Maxime Perrotin committed
317
318
319
320
321
322
323
                l=self.line, c=self.charPositionInLine)


class Answer(object):
    ''' AST Entry for a decision answer '''
    def __init__(self):
        ''' One ANSWER of a DECISION '''
324
        self.inputString = ''
Maxime Perrotin's avatar
Maxime Perrotin committed
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
        self.line = None
        self.charPositionInLine = None
        self.pos_x = 0
        self.pos_y = 0
        self.width = 70
        self.height = 10.5
        # one of 'closed_range' 'constant' 'open_range' 'else' 'informal_text'
        self.kind = None
        # informalText is a string, when kind == 'informal_text'
        self.informalText = None
        # closedRange is a set of two numbers
        self.closedRange = []
        # constant is an Expression
        #    (contains 'open_range' and 'constant' kinds corresponding value)
        self.constant = None
        # one of ExprEq, ExprNeq, ExprGt, ExprGe, ExprLt, ExprLe (types)
        self.openRangeOp = None
        # transition is of type Transition
        self.transition = None
        # optional comment symbol
        self.comment = None
        # optional hyperlink
        self.hyperlink = None

Maxime Perrotin's avatar
Maxime Perrotin committed
349
    def trace(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
350
        ''' Debug output for an answer '''
Maxime Perrotin's avatar
Maxime Perrotin committed
351
        return u'ANSWER {exp} ({l},{c})'.format(exp=self.inputString,
Maxime Perrotin's avatar
Maxime Perrotin committed
352
353
354
355
356
357
358
                l=self.line, c=self.charPositionInLine)


class Task(object):
    ''' AST Entry for TASKS '''
    def __init__(self):
        ''' Initialize TASK attributes (set of ASSIGN statements) '''
359
        self.inputString = ''
Maxime Perrotin's avatar
Maxime Perrotin committed
360
361
362
363
364
365
366
367
368
369
370
371
        self.line = None
        self.charPositionInLine = None
        self.pos_x = 0
        self.pos_y = 0
        self.width = 70
        self.height = 35
        # optional comment symbol
        self.comment = None
        # optional hyperlink
        self.hyperlink = None
        self.elems = []

Maxime Perrotin's avatar
Maxime Perrotin committed
372
    def trace(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
373
        ''' Debug output for a task '''
Maxime Perrotin's avatar
Maxime Perrotin committed
374
        return u'TASK {exp} ({l},{c})'.format(exp=self.inputString,
Maxime Perrotin's avatar
Maxime Perrotin committed
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
                l=self.line, c=self.charPositionInLine)


class TaskAssign(Task):
    ''' 'elems' contains a list of ExprAssign expressions '''
    pass


class TaskInformalText(Task):
    ''' 'elems' contains a list of strings '''
    pass


class TaskForLoop(Task):
    '''
        'elems' is a list of for-loops:{'var': string, 'type': Asn1SccType,
        'list': Primary, 'range': {'start': expression, 'stop': expression,
        'step' : int}, 'transition': Transition }
    '''
    pass

Maxime Perrotin's avatar
Maxime Perrotin committed
396

Maxime Perrotin's avatar
Maxime Perrotin committed
397
398
class Output(object):
    ''' AST Entry for OUTPUT statements '''
399
    def __init__(self, defName=''):
Maxime Perrotin's avatar
Maxime Perrotin committed
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
        ''' Set of OUTPUT statements '''
        self.inputString = defName
        self.pos_x = 0
        self.pos_y = 0
        self.width = 70
        self.height = 35
        self.line = None
        self.charPositionInLine = None
        # list of {'outputName':ID, 'params':list of Expression, 'tmpVars':[]}
        self.output = []
        # optional comment symbol
        self.comment = None
        # optional hyperlink
        self.hyperlink = None

Maxime Perrotin's avatar
Maxime Perrotin committed
415
    def trace(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
416
        ''' Debug output for an Output symbol '''
Maxime Perrotin's avatar
Maxime Perrotin committed
417
        return u'{exp} ({l},{c})'.format(exp=self.inputString,
Maxime Perrotin's avatar
Maxime Perrotin committed
418
419
420
421
422
423
424
425
426
427
                l=self.line, c=self.charPositionInLine)


class ProcedureCall(Output):
    ''' Procedure calls content is identical to Outputs '''
    pass


class Terminator(object):
    ''' Terminator elements (join, nextstate, stop) '''
428
    def __init__(self, defName=''):
Maxime Perrotin's avatar
Maxime Perrotin committed
429
430
431
432
433
434
435
436
        ''' Initialize terminator attributes '''
        self.inputString = defName
        self.pos_x = None
        self.pos_y = None
        self.width = 70
        self.height = 35
        self.line = None
        self.charPositionInLine = None
437
        # one of 'next_state' 'join' 'stop', 'return'
Maxime Perrotin's avatar
Maxime Perrotin committed
438
439
440
441
442
443
444
        self.kind = None
        # optional comment symbol
        self.comment = None
        # optional hyperlink
        self.hyperlink = None
        # optional Label instance (to be placed just before the terminator)
        self.label = None
445
446
447
        # Return expression
        self.return_expr = None
        # via clause, used for entering nested state with an entry point
Maxime Perrotin's avatar
Maxime Perrotin committed
448
        # 'via' is the string for the renderer (e.g. "via foo")
449
        self.via = None
Maxime Perrotin's avatar
Maxime Perrotin committed
450
451
        # 'entrypoint' is the string of the entry point (e.g. "foo")
        self.entrypoint = None
452
453
        # some transitions can be chained, when entering/leaving nested states
        self.next_id = -1
454
455
456
        # Pointer to the next transition, when using return/connect
        self.next_trans = None
        # List of State that can lead to this terminator
457
        # There can be several if terminator follows a floating label
458
        # Note, this field is updated by the Helper.flatten function
459
        self.possible_states = []
Maxime Perrotin's avatar
Maxime Perrotin committed
460
461
        # optional composite state content (type CompositeState)
        self.composite = None
Maxime Perrotin's avatar
Maxime Perrotin committed
462

Maxime Perrotin's avatar
Maxime Perrotin committed
463
    def trace(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
464
        ''' Debug output for terminators '''
Maxime Perrotin's avatar
Maxime Perrotin committed
465
        return u'{kind} {exp} ({l},{c}) at {x}, {y}'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
466
467
468
469
470
471
472
473
474
475
                exp=self.inputString,
                kind=self.kind.upper(), l=self.line, c=self.charPositionInLine,
                x=self.pos_x, y=self.pos_y)


class Label(object):
    ''' AST Entry for a Label '''
    def __init__(self):
        ''' Initialize the label attributes '''
        # inputString holds the label name
476
        self.inputString = ''
Maxime Perrotin's avatar
Maxime Perrotin committed
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
        self.pos_x = 0
        self.pos_y = 0
        self.width = 70
        self.height = 35
        self.line = None
        self.charPositionInLine = None
        # optional hyperlink
        self.hyperlink = None
        # No comment for labels - keep to None
        self.comment = None
        # List of terminators following this label
        self.terminators = []
        # Transition is used for floating labels (see AST entry)
        self.transition = None

Maxime Perrotin's avatar
Maxime Perrotin committed
492
    def trace(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
493
        ''' Debug output for a label '''
Maxime Perrotin's avatar
Maxime Perrotin committed
494
        return u'LABEL {label} ({l},{c})'.format(label=self.inputString,
Maxime Perrotin's avatar
Maxime Perrotin committed
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
                l=self.line, c=self.charPositionInLine)


class Floating_label(Label, object):
    ''' AST Entry for a floating label '''
    def __init__(self, label=None):
        ''' Initialize the floating label attributes '''
        super(Floating_label, self).__init__()
        if label:
            self.inputString = label.inputString
            self.pos_x = label.pos_x
            self.pos_y = label.pos_y
            self.width = label.width
            self.height = label.height
            self.line = label.line
            self.charPositionInLine = label.charPositionInLine
            self.terminators = label.terminators
            self.transition = label.transition

Maxime Perrotin's avatar
Maxime Perrotin committed
514
    def trace(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
515
        ''' Debug output for a label (used by code generator) '''
Maxime Perrotin's avatar
Maxime Perrotin committed
516
        return u'CONNECTION {label} ({l},{c})'.format(label=self.inputString,
Maxime Perrotin's avatar
Maxime Perrotin committed
517
518
519
520
521
522
523
524
525
526
527
528
529
                l=self.line, c=self.charPositionInLine)


class Transition(object):
    ''' AST Entry for a complete transition '''
    def __init__(self):
        ''' Initialize the transition attributes '''
        # list of either Label, Output, Task, Decision
        self.actions = []
        # terminator is of type Terminator (it is optional)
        self.terminator = None
        # All Terminators of this transition
        self.terminators = []
530
531
532
533
534
535
        # List of State that can lead to this transition
        # There can be several if state has multiple names (e.g. STATE a, b)
        # Note, this field is updated by the Helper.flatten function
        # and is needed to properly know when to call a nested state exit
        # procedure when the model is flattened.
        self.possible_states = []
Maxime Perrotin's avatar
Maxime Perrotin committed
536

Maxime Perrotin's avatar
Maxime Perrotin committed
537
    def trace(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
538
        ''' Debug output: display all actions '''
Maxime Perrotin's avatar
Maxime Perrotin committed
539
        data = [action.trace() for action in self.actions]
Maxime Perrotin's avatar
Maxime Perrotin committed
540
        if self.terminator:
Maxime Perrotin's avatar
Maxime Perrotin committed
541
            data.append(self.terminator.trace())
Maxime Perrotin's avatar
Maxime Perrotin committed
542
        return u'\n'.join(data)
Maxime Perrotin's avatar
Maxime Perrotin committed
543
544
545
546
547
548
549


class Input(object):
    ''' AST Entry for the INPUT symbol '''
    def __init__(self):
        ''' Initialize the Input attributes '''
        # inputString is the user text, it can contain several inputs
550
        self.inputString = ''
Maxime Perrotin's avatar
Maxime Perrotin committed
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
        self.pos_x = 0
        self.pos_y = 0
        self.width = 70
        self.height = 35
        self.line = None
        self.charPositionInLine = None
        # provided clause (not supported yet)
        self.provided = None
        # transition is of type Transition
        self.transition = None
        # List of input parameters (strings: each param is a variable)
        # (If there are several inputs in the symbol, there are no parameters)
        self.parameters = []
        # list of input signal names
        self.inputlist = []
        # transition_id is an index of the process.transitions list
        self.transition_id = -1
        # optional comment symbol
        self.comment = None
        # optional hyperlink
        self.hyperlink = None
        # list of terminators following the input symbol
        self.terminators = []

Maxime Perrotin's avatar
Maxime Perrotin committed
575
    def trace(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
576
        ''' Debug output for an INPUT symbol '''
Maxime Perrotin's avatar
Maxime Perrotin committed
577
        return u'INPUT {exp} ({l},{c})'.format(exp=self.inputString,
Maxime Perrotin's avatar
Maxime Perrotin committed
578
579
580
                l=self.line, c=self.charPositionInLine)


Maxime Perrotin's avatar
Maxime Perrotin committed
581
582
583
584
585
586
587
588
589
class Connect(Input):
    ''' AST Entry for the CONNECT part (transition below a nested state) '''
    def __init__(self):
        ''' Only one difference with INPUT: the connect_list attribute '''
        super(Connect, self).__init__()
        # List of strings
        self.connect_list = []
        self.width = 1

Maxime Perrotin's avatar
Maxime Perrotin committed
590
    def trace(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
591
        ''' Debug output for a CONNECT symbol '''
Maxime Perrotin's avatar
Maxime Perrotin committed
592
        return u'CONNECT {exp} ({l},{c})'.format(exp=self.inputString,
Maxime Perrotin's avatar
Maxime Perrotin committed
593
594
595
                l=self.line, c=self.charPositionInLine)


Maxime Perrotin's avatar
Maxime Perrotin committed
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
class Start(object):
    ''' AST Entry for the START symbol '''
    def __init__(self):
        ''' Initialize the Start symbol attributes '''
        self.inputString = ''
        self.pos_x = 0
        self.pos_y = 0
        self.width = 70
        self.height = 35
        # start transition is of type Transition
        self.transition = None
        # optional comment symbol
        self.comment = None
        # optional hyperlink
        self.hyperlink = None
        # list of terminators following the start symbol
        self.terminators = []

Maxime Perrotin's avatar
Maxime Perrotin committed
614
    def trace(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
615
        ''' Debug output for a START symbol '''
Maxime Perrotin's avatar
Maxime Perrotin committed
616
        return u'START {}'.format(self.inputString)
Maxime Perrotin's avatar
Maxime Perrotin committed
617
618
619
620
621
622
623


class Procedure_start(Start):
    ''' Procedure start symbol - inherits from Start '''
    pass


624
625
626
627
628
class CompositeState_start(Start):
    ''' Composite state start symbol - inherits from Start, can have a name '''
    pass


Maxime Perrotin's avatar
Maxime Perrotin committed
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
class Comment(object):
    ''' AST Entry for COMMENT symbols '''
    def __init__(self):
        ''' Comment symbol '''
        # inputString is the comment value itself
        self.inputString = ''
        self.pos_x = 0
        self.pos_y = 0
        self.width = 70
        self.height = 35
        self.line = None
        self.charPositionInLine = None
        # optional hyperlink
        self.hyperlink = None

Maxime Perrotin's avatar
Maxime Perrotin committed
644
    def trace(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
645
        ''' Debug output for a COMMENT symbol '''
Maxime Perrotin's avatar
Maxime Perrotin committed
646
647
        return u'COMMENT {exp} ({l},{c})'.format(
                exp=self.inputString,
Maxime Perrotin's avatar
Maxime Perrotin committed
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
                l=self.line, c=self.charPositionInLine)


class State(object):
    ''' AST Entry for STATE symbols '''
    def __init__(self, defName=''):
        ''' Used only for rendering backends - not for code generation '''
        # inputString contains possibly several states (and asterisk)
        self.inputString = defName
        # List of state names contained in the symbol
        self.statelist = []
        self.line = None
        self.charPositionInLine = None
        self.pos_x = 0
        self.pos_y = 0
        self.width = 70
        self.height = 35
        # list of type Input
        self.inputs = []
Maxime Perrotin's avatar
Maxime Perrotin committed
667
668
        # list of type Connect (connection below a nested state)
        self.connects = []
Maxime Perrotin's avatar
Maxime Perrotin committed
669
670
671
672
        # optional comment symbol
        self.comment = None
        # optional hyperlink
        self.hyperlink = None
673
674
        # optional composite state content (type CompositeState)
        self.composite = None
Maxime Perrotin's avatar
Maxime Perrotin committed
675

Maxime Perrotin's avatar
Maxime Perrotin committed
676
    def trace(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
677
        ''' Debug output for a STATE symbol '''
Maxime Perrotin's avatar
Maxime Perrotin committed
678
        return u'STATE {exp} ({l},{c}) at {x},{y}'.format(exp=self.inputString,
Maxime Perrotin's avatar
Maxime Perrotin committed
679
680
681
682
683
684
685
686
687
                l=self.line, c=self.charPositionInLine,
                x=self.pos_x, y=self.pos_y)


class TextArea(object):
    ''' AST Entry for text areas (containing declarations/comments) '''
    def __init__(self):
        ''' Text area (raw content for rendering only) '''
        self.inputString = '-- Declare your variables\n\n' \
688
                           '-- Syntax: DCL <variable name> <type name>;\n\n'
Maxime Perrotin's avatar
Maxime Perrotin committed
689
690
691
692
693
694
695
696
697
698
699
700
        # DCL variables in the text area {name: (sort, default_value), ...}
        self.variables = {}
        self.line = None
        self.charPositionInLine = None
        # Set default coordinates and width/height
        self.pos_x = 0
        self.pos_y = 0
        self.width = 170
        self.height = 140
        # optional hyperlink
        self.hyperlink = None

Maxime Perrotin's avatar
Maxime Perrotin committed
701
    def trace(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
702
        ''' Debug output for a text area '''
Maxime Perrotin's avatar
Maxime Perrotin committed
703
        return u'TEXTAREA {exp} ({l},{c})'.format(exp=self.inputString,
Maxime Perrotin's avatar
Maxime Perrotin committed
704
705
706
707
708
709
710
711
712
713
714
715
716
                l=self.line, c=self.charPositionInLine)


class Automaton(object):
    ''' Elements contained in a process or a procedure '''
    def __init__(self, parent=None):
        ''' AST grouping the elements that can be rendered graphically '''
        self.parent = parent
        self.textAreas = []
        self.inner_procedures = []
        self.start = None
        self.floating_labels = []
        self.states = []
717
        self.named_start = []
Maxime Perrotin's avatar
Maxime Perrotin committed
718
719
720
721
722
723


class Procedure(object):
    ''' Internal procedure definition '''
    def __init__(self):
        ''' Procedure AST default value '''
724
        self.inputString = ''
Maxime Perrotin's avatar
Maxime Perrotin committed
725
726
727
728
729
730
731
732
733
734
        self.line = None
        self.charPositionInLine = None
        # Set default coordinates and width/height
        self.pos_x = self.pos_y = 0
        self.width = 70
        self.height = 35
        # Optional hyperlink
        self.hyperlink = None
        # Local variables dictionnary (see Process)
        self.variables = {}
Maxime Perrotin's avatar
Maxime Perrotin committed
735
736
        self.timers = []
        # Inherited variables and timers from all levels above
Maxime Perrotin's avatar
Maxime Perrotin committed
737
        self.global_variables = {}
Maxime Perrotin's avatar
Maxime Perrotin committed
738
        self.global_timers = []
Maxime Perrotin's avatar
Maxime Perrotin committed
739
740
741
        # Formal parameters - list of dict:
        # [{'name': str, 'direction': 'in'/'out', 'type': str}]
        self.fpar = []
742
743
744
        # return type (ASN.1)
        self.return_type = None
        # start, terminators, text areas, floating_labels (see Process)
Maxime Perrotin's avatar
Maxime Perrotin committed
745
746
747
748
749
750
751
        #self.start = None
        #self.states = []
        self.terminators = []
        #self.textAreas = []
        # Keep a list of labels and floating labels - useful for backends
        self.labels = []
        #self.floating_labels = []
752
753
754
        # Inherited procedures and operators
        self.procedures = []
        self.operators = []
Maxime Perrotin's avatar
Maxime Perrotin committed
755
756
757
758
759
760
761
762
763
764
765
766
        # inner procedures and operators (see Process for format)
        #self.inner_procedures = []
        self.inner_operators = []
        # mapping, transitions: see Process
        self.mapping = {}
        self.transitions = []
        # Determine if a procedure is externally defined
        self.external = False
        # Optional comment
        self.comment = None
        # Set of symbols contained in the procedure (type Automaton)
        self.content = Automaton(parent=self)
767
768
769
        # input/output signal lists - unused but for context information
        self.input_signals = []
        self.output_signals = []
Maxime Perrotin's avatar
Maxime Perrotin committed
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784


class Process(object):
    ''' SDL Process entry point '''
    def __init__(self):
        ''' Process AST default values '''
        self.processName = None
        # Optional filename containing this process (PR file)
        self.filename = None
        # Process parent context (Block or AST if defined at root level)
        self.parent = None
        # A process can be referenced (externally defined)
        self.referenced = False
        # variables: dictionnary: {variable1Name: (asn1SccType, default value)}
        self.variables = {}
Maxime Perrotin's avatar
Maxime Perrotin committed
785
        # global variables and timers can be used to inherit from a level above
Maxime Perrotin's avatar
Maxime Perrotin committed
786
        self.global_variables = {}
Maxime Perrotin's avatar
Maxime Perrotin committed
787
        self.global_timers = []
788
        # Set default coordinates and width/height
789
790
        self.pos_x = 250
        self.pos_y = 150
791
792
793
794
795
796
        self.width = 150
        self.height = 75
        # Optional hyperlink
        self.hyperlink = None
        # Optional comment
        self.comment = None
Maxime Perrotin's avatar
Maxime Perrotin committed
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815

        # dataview: complete AST of the ASN.1 types
        self.asn1Modules = None
        self.dataview = None

        # input and output signal lists:
        # [{'name': str, 'type': str, 'direction':'in'/'out'}]
        self.input_signals = []
        self.output_signals = []

        # terminators are useful for rendering backends
        self.terminators = []

        # Keep a list of labels and floating labels - useful for backends
        # List of Label
        self.labels = []

        # list of operators (not supported) and procedures
        self.operators = {}
816
        # list of Procedure (external and inner procedures)
Maxime Perrotin's avatar
Maxime Perrotin committed
817
818
819
820
821
822
823
824
825
826
        self.procedures = []

        # The Mapping structure should be used for code generation backends
        # dictionnary: {'stateName': [class Input1, Input2,...], ...}
        # then Input contains the inputs list and corresponding transition
        self.mapping = {}

        # list of type Transition - use 'mapping' to map index to inputs/states
        self.transitions = []

827
828
829
        # list of type CompositeState
        self.composite_states = []

Maxime Perrotin's avatar
Maxime Perrotin committed
830
831
832
833
834
835
836
837
        # Set of symbols contained in the process (type Automaton)
        # (Includes inner procedures)
        self.content = Automaton(parent=self)

        # List of timers (strings) declared in the process
        self.timers = []


838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
class CompositeState(Process):
    '''
        Composite states: the difference with Process is that they can have:
        - several START elements, that correspond to state entry points,
        - state exit points (with RETURN terminators)
        - entry and exit procedures
    '''
    def __init__(self):
        super(CompositeState, self).__init__()
        self.statename = ''
        self.state_entrypoints = []
        self.state_exitpoints = []
        # Special entry and exit procedures (named "entry" and "exit")
        self.entry_procedure = None
        self.exit_procedure = None
        # Body can contain text areas, procedures, composite states,
        # one nameless START, named START (one per entrypoint), states,
Maxime Perrotin's avatar
Maxime Perrotin committed
855
856
        # amd floating labels

Maxime Perrotin's avatar
Maxime Perrotin committed
857
    def trace(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
858
        ''' Debug output for composite state '''
Maxime Perrotin's avatar
Maxime Perrotin committed
859
        return u'COMPOSITE STATE {exp} ({l},{c})'.format(exp=self.statename,
Maxime Perrotin's avatar
Maxime Perrotin committed
860
                l=self.line, c=self.charPositionInLine)
861
862


Maxime Perrotin's avatar
Maxime Perrotin committed
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
class Block(object):
    ''' AST for a BLOCK entity '''
    def __init__(self):
        '''
            Blocks can contain signal declarations, signalroutes,
            connections, inner block definitions, and process
            definitions.
        '''
        # Block name
        self.name = ''
        # Parent block or system
        self.parent = None
        # list of signal declarations - see class System for the structure
        self.signals = []
        # signalroutes: see self.channels in class System for the structure
        self.signalroutes = []
        # connections are between a channel and signalroute
        # [{'channel': str, 'signalroute': str}]
        self.connections = []
        # list of class Block
        self.blocks = []
        # list of class Process
        self.processes = []


class System(object):
    ''' AST for a SYSTEM entity '''
    def __init__(self):
        '''
            Create system default values
            contains blocks, procedures, channels and signal declarations
        '''
        # System name
        self.name = ''
        # Optional filename containing this system (PR file)
        self.filename = None
        # Reference to top-level AST
        self.ast = None
        # list of SIGNAL declarations: [{'name': str, 'type': str}]
        # (Supporting only one parameter)
        self.signals = []
        # list of ogAST.Procedure
        self.procedures = []
Maxime Perrotin's avatar
Maxime Perrotin committed
906
        # channels: [{'name':str, 'routes':[{'source': str, 'dest': str,
Maxime Perrotin's avatar
Maxime Perrotin committed
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
        # 'signals': ['sig1', .. ]}]
        self.channels = []
        self.blocks = []


class AST(object):
    ''' Top-level AST entry point '''
    def __init__(self):
        '''
            AST entries are systems, processes, and USE clauses
            (cf. ANTLR grammar, production "pr_file")
        '''
        # Set of input files the AST was created from
        self.pr_files = set()
        # USE clauses: list of strings (eg. "DataView")
        self.use_clauses = []
        # Optional list of ASN.1 filenames (defined in CIF of USE clauses)
        self.asn1_filenames = []
        # Refs to the ASN.1 dataview AST (set with USE clauses)
        self.dataview = None
        self.asn1Modules = None
        # Constants stored in the ASN.1 modules (type is unknown/unchecked)
        self.asn1_constants = []

        # List of System
        self.systems = []
        # List of Process
        self.processes = []