ogAST.py 27.8 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
50
51
52
53
54
55
56
57
    def __init__(self, inputString='', line=-1, charPositionInLine=-1):
        ''' Initialize Expression attributes '''
        self.inputString = inputString
        self.line = line
        self.charPositionInLine = charPositionInLine
        # left and right are of type Expression (absent for primaries)
        self.left = None
        self.right = None
        # 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
58
    def trace(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
59
        ''' Debug output for an expression '''
Maxime Perrotin's avatar
Maxime Perrotin committed
60
        return u'{exp} ({l},{c})'.format(exp=self.inputString,
Maxime Perrotin's avatar
Maxime Perrotin committed
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
                                        l=self.line,
                                        c=self.charPositionInLine)


class ExprPlus(Expression):
    operand = '+'


class ExprMul(Expression):
    operand = '*'


class ExprMinus(Expression):
    operand = '-'


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


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


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


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
127
    operand = 'rem'
Maxime Perrotin's avatar
Maxime Perrotin committed
128
129


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


class ExprNeg(Expression):
    operand = '-'


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


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


class ExprIn(Expression):
    pass


class ExprImplies(Expression):
    pass

Maxime Perrotin's avatar
Maxime Perrotin committed
153
154
155
156
157
158
159

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
160

Maxime Perrotin's avatar
Maxime Perrotin committed
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
    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
177
    def trace(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
178
        ''' Debug output for a primary '''
Maxime Perrotin's avatar
Maxime Perrotin committed
179
        return u'PRIMARY : {exp} ({l},{c})'.format(exp=self.inputString,
Maxime Perrotin's avatar
Maxime Perrotin committed
180
181
                l=self.line, c=self.charPositionInLine)

Maxime Perrotin's avatar
Maxime Perrotin committed
182

Maxime Perrotin's avatar
Maxime Perrotin committed
183
184
185
186
187
188
189
190
191
192
193
194
# Subclasses of Primary - never use Primary directly
class PrimPath(Primary):
    ''' PrimPath is a list of elements needed to identify a value
        For example, "i!j!k(5)" is stored as:
        [ 'i', 'j', 'k', {'index':[Expression list]}]
           (in that case, 5 is an index)
        other example: "hello(world)" ->
             ['hello', {'procParams':[Expression list]'}]
        (in that case, hello is an operator and world is its parameter)
    '''
    is_raw = False

Maxime Perrotin's avatar
Maxime Perrotin committed
195

196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
class PrimCall(PrimPath):
    pass


class PrimIndex(PrimPath):
    pass


class PrimSubstring(PrimPath):
    pass


class PrimSelector(PrimPath):
    pass


Maxime Perrotin's avatar
Maxime Perrotin committed
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
242
243
244
245
246
247
class PrimVariable(PrimPath):
    pass


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
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


class PrimIfThenElse(Primary):
    ''' 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
    '''
    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
280
281
class PrimEmptyString(Primary):
    pass
Maxime Perrotin's avatar
Maxime Perrotin committed
282
283
284
285
286
287
288


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


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


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
328
    def trace(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
329
        ''' Debug output for a decision '''
Maxime Perrotin's avatar
Maxime Perrotin committed
330
        return u'DECISION {exp} ({l},{c})'.format(exp=self.inputString,
Maxime Perrotin's avatar
Maxime Perrotin committed
331
332
333
334
335
336
337
                l=self.line, c=self.charPositionInLine)


class Answer(object):
    ''' AST Entry for a decision answer '''
    def __init__(self):
        ''' One ANSWER of a DECISION '''
338
        self.inputString = ''
Maxime Perrotin's avatar
Maxime Perrotin committed
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
        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
363
    def trace(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
364
        ''' Debug output for an answer '''
Maxime Perrotin's avatar
Maxime Perrotin committed
365
        return u'ANSWER {exp} ({l},{c})'.format(exp=self.inputString,
Maxime Perrotin's avatar
Maxime Perrotin committed
366
367
368
369
370
371
372
                l=self.line, c=self.charPositionInLine)


class Task(object):
    ''' AST Entry for TASKS '''
    def __init__(self):
        ''' Initialize TASK attributes (set of ASSIGN statements) '''
373
        self.inputString = ''
Maxime Perrotin's avatar
Maxime Perrotin committed
374
375
376
377
378
379
380
381
382
383
384
385
        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
386
    def trace(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
387
        ''' Debug output for a task '''
Maxime Perrotin's avatar
Maxime Perrotin committed
388
        return u'TASK {exp} ({l},{c})'.format(exp=self.inputString,
Maxime Perrotin's avatar
Maxime Perrotin committed
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
                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
410

Maxime Perrotin's avatar
Maxime Perrotin committed
411
412
class Output(object):
    ''' AST Entry for OUTPUT statements '''
413
    def __init__(self, defName=''):
Maxime Perrotin's avatar
Maxime Perrotin committed
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
        ''' 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
429
    def trace(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
430
        ''' Debug output for an Output symbol '''
Maxime Perrotin's avatar
Maxime Perrotin committed
431
        return u'{exp} ({l},{c})'.format(exp=self.inputString,
Maxime Perrotin's avatar
Maxime Perrotin committed
432
433
434
435
436
437
438
439
440
441
                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) '''
442
    def __init__(self, defName=''):
Maxime Perrotin's avatar
Maxime Perrotin committed
443
444
445
446
447
448
449
450
        ''' 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
451
        # one of 'next_state' 'join' 'stop', 'return'
Maxime Perrotin's avatar
Maxime Perrotin committed
452
453
454
455
456
457
458
        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
459
460
461
        # Return expression
        self.return_expr = None
        # via clause, used for entering nested state with an entry point
Maxime Perrotin's avatar
Maxime Perrotin committed
462
        # 'via' is the string for the renderer (e.g. "via foo")
463
        self.via = None
Maxime Perrotin's avatar
Maxime Perrotin committed
464
465
        # 'entrypoint' is the string of the entry point (e.g. "foo")
        self.entrypoint = None
466
467
        # some transitions can be chained, when entering/leaving nested states
        self.next_id = -1
468
469
470
        # Pointer to the next transition, when using return/connect
        self.next_trans = None
        # List of State that can lead to this terminator
471
        # There can be several if terminator follows a floating label
472
        # Note, this field is updated by the Helper.flatten function
473
        self.possible_states = []
Maxime Perrotin's avatar
Maxime Perrotin committed
474

Maxime Perrotin's avatar
Maxime Perrotin committed
475
    def trace(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
476
        ''' Debug output for terminators '''
Maxime Perrotin's avatar
Maxime Perrotin committed
477
        return u'{kind} {exp} ({l},{c}) at {x}, {y}'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
478
479
480
481
482
483
484
485
486
487
                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
488
        self.inputString = ''
Maxime Perrotin's avatar
Maxime Perrotin committed
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
        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
504
    def trace(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
505
        ''' Debug output for a label '''
Maxime Perrotin's avatar
Maxime Perrotin committed
506
        return u'LABEL {label} ({l},{c})'.format(label=self.inputString,
Maxime Perrotin's avatar
Maxime Perrotin committed
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
                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
526
    def trace(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
527
        ''' Debug output for a label (used by code generator) '''
Maxime Perrotin's avatar
Maxime Perrotin committed
528
        return u'CONNECTION {label} ({l},{c})'.format(label=self.inputString,
Maxime Perrotin's avatar
Maxime Perrotin committed
529
530
531
532
533
534
535
536
537
538
539
540
541
                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 = []
542
543
544
545
546
547
        # 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
548

Maxime Perrotin's avatar
Maxime Perrotin committed
549
    def trace(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
550
        ''' Debug output: display all actions '''
Maxime Perrotin's avatar
Maxime Perrotin committed
551
        data = [action.trace() for action in self.actions]
Maxime Perrotin's avatar
Maxime Perrotin committed
552
        if self.terminator:
Maxime Perrotin's avatar
Maxime Perrotin committed
553
            data.append(self.terminator.trace())
Maxime Perrotin's avatar
Maxime Perrotin committed
554
        return u'\n'.join(data)
Maxime Perrotin's avatar
Maxime Perrotin committed
555
556
557
558
559
560
561


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
562
        self.inputString = ''
Maxime Perrotin's avatar
Maxime Perrotin committed
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
        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
587
    def trace(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
588
        ''' Debug output for an INPUT symbol '''
Maxime Perrotin's avatar
Maxime Perrotin committed
589
        return u'INPUT {exp} ({l},{c})'.format(exp=self.inputString,
Maxime Perrotin's avatar
Maxime Perrotin committed
590
591
592
                l=self.line, c=self.charPositionInLine)


Maxime Perrotin's avatar
Maxime Perrotin committed
593
594
595
596
597
598
599
600
601
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
602
    def trace(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
603
        ''' Debug output for a CONNECT symbol '''
Maxime Perrotin's avatar
Maxime Perrotin committed
604
        return u'CONNECT {exp} ({l},{c})'.format(exp=self.inputString,
Maxime Perrotin's avatar
Maxime Perrotin committed
605
606
607
                l=self.line, c=self.charPositionInLine)


Maxime Perrotin's avatar
Maxime Perrotin committed
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
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
626
    def trace(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
627
        ''' Debug output for a START symbol '''
Maxime Perrotin's avatar
Maxime Perrotin committed
628
        return u'START {}'.format(self.inputString)
Maxime Perrotin's avatar
Maxime Perrotin committed
629
630
631
632
633
634
635


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


636
637
638
639
640
class CompositeState_start(Start):
    ''' Composite state start symbol - inherits from Start, can have a name '''
    pass


Maxime Perrotin's avatar
Maxime Perrotin committed
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
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
656
    def trace(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
657
        ''' Debug output for a COMMENT symbol '''
Maxime Perrotin's avatar
Maxime Perrotin committed
658
659
        return u'COMMENT {exp} ({l},{c})'.format(
                exp=self.inputString,
Maxime Perrotin's avatar
Maxime Perrotin committed
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
                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
679
680
        # list of type Connect (connection below a nested state)
        self.connects = []
Maxime Perrotin's avatar
Maxime Perrotin committed
681
682
683
684
        # optional comment symbol
        self.comment = None
        # optional hyperlink
        self.hyperlink = None
685
686
        # optional composite state content (type CompositeState)
        self.composite = None
Maxime Perrotin's avatar
Maxime Perrotin committed
687

Maxime Perrotin's avatar
Maxime Perrotin committed
688
    def trace(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
689
        ''' Debug output for a STATE symbol '''
Maxime Perrotin's avatar
Maxime Perrotin committed
690
        return u'STATE {exp} ({l},{c}) at {x},{y}'.format(exp=self.inputString,
Maxime Perrotin's avatar
Maxime Perrotin committed
691
692
693
694
695
696
697
698
699
                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' \
700
                           '-- Syntax: DCL <variable name> <type name>;\n\n'
Maxime Perrotin's avatar
Maxime Perrotin committed
701
702
703
704
705
706
707
708
709
710
711
712
        # 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
713
    def trace(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
714
        ''' Debug output for a text area '''
Maxime Perrotin's avatar
Maxime Perrotin committed
715
        return u'TEXTAREA {exp} ({l},{c})'.format(exp=self.inputString,
Maxime Perrotin's avatar
Maxime Perrotin committed
716
717
718
719
720
721
722
723
724
725
726
727
728
                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 = []
729
        self.named_start = []
Maxime Perrotin's avatar
Maxime Perrotin committed
730
731
732
733
734
735


class Procedure(object):
    ''' Internal procedure definition '''
    def __init__(self):
        ''' Procedure AST default value '''
736
        self.inputString = ''
Maxime Perrotin's avatar
Maxime Perrotin committed
737
738
739
740
741
742
743
744
745
746
        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
747
748
        self.timers = []
        # Inherited variables and timers from all levels above
Maxime Perrotin's avatar
Maxime Perrotin committed
749
        self.global_variables = {}
Maxime Perrotin's avatar
Maxime Perrotin committed
750
        self.global_timers = []
Maxime Perrotin's avatar
Maxime Perrotin committed
751
752
753
        # Formal parameters - list of dict:
        # [{'name': str, 'direction': 'in'/'out', 'type': str}]
        self.fpar = []
754
755
756
        # return type (ASN.1)
        self.return_type = None
        # start, terminators, text areas, floating_labels (see Process)
Maxime Perrotin's avatar
Maxime Perrotin committed
757
758
759
760
761
762
763
        #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 = []
764
765
766
        # Inherited procedures and operators
        self.procedures = []
        self.operators = []
Maxime Perrotin's avatar
Maxime Perrotin committed
767
768
769
770
771
772
773
774
775
776
777
778
        # 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)
779
780
781
        # input/output signal lists - unused but for context information
        self.input_signals = []
        self.output_signals = []
Maxime Perrotin's avatar
Maxime Perrotin committed
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796


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
797
        # global variables and timers can be used to inherit from a level above
Maxime Perrotin's avatar
Maxime Perrotin committed
798
        self.global_variables = {}
Maxime Perrotin's avatar
Maxime Perrotin committed
799
        self.global_timers = []
800
801
802
803
804
805
806
807
        # Set default coordinates and width/height
        self.pos_x = self.pos_y = 150
        self.width = 150
        self.height = 75
        # Optional hyperlink
        self.hyperlink = None
        # Optional comment
        self.comment = None
Maxime Perrotin's avatar
Maxime Perrotin committed
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826

        # 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 = {}
827
        # list of Procedure (external and inner procedures)
Maxime Perrotin's avatar
Maxime Perrotin committed
828
829
830
831
832
833
834
835
836
837
        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 = []

838
839
840
        # list of type CompositeState
        self.composite_states = []

Maxime Perrotin's avatar
Maxime Perrotin committed
841
842
843
844
845
846
847
848
        # 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 = []


849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
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
866
867
        # amd floating labels

Maxime Perrotin's avatar
Maxime Perrotin committed
868
    def trace(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
869
        ''' Debug output for composite state '''
Maxime Perrotin's avatar
Maxime Perrotin committed
870
        return u'COMPOSITE STATE {exp} ({l},{c})'.format(exp=self.statename,
Maxime Perrotin's avatar
Maxime Perrotin committed
871
                l=self.line, c=self.charPositionInLine)
872
873


Maxime Perrotin's avatar
Maxime Perrotin committed
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
906
907
908
909
910
911
912
913
914
915
916
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
917
        # channels: [{'name':str, 'routes':[{'source': str, 'dest': str,
Maxime Perrotin's avatar
Maxime Perrotin committed
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
        # '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 = []