sdlSymbols.py 47.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
#!/usr/bin/env python
# -*- coding: utf-8 -*-

"""
    OpenGEODE - A tiny SDL Editor for TASTE

    This module contains the definition of the SDL symbols,
    including geometry and specific symbol behaviour when needed.

    All symbols inherit the generic Vertical- and Horizontal-
    Symbol classes defined in the "genericSymbols.py" module.

    Copyright (c) 2012-2013 European Space Agency

    Designed and implemented by Maxime Perrotin

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

__all__ = ['Input', 'Output', 'State', 'Task', 'ProcedureCall', 'Label',
           'Decision', 'DecisionAnswer', 'Join', 'Start', 'TextSymbol',
22
           'Procedure', 'ProcedureStart', 'ProcedureStop', 'ASN1Viewer',
23
           'StateStart', 'Process', 'ContinuousSignal']
Maxime Perrotin's avatar
Maxime Perrotin committed
24

Maxime Perrotin's avatar
Maxime Perrotin committed
25
#import traceback
26
import logging
Maxime Perrotin's avatar
Maxime Perrotin committed
27
from itertools import chain
Maxime Perrotin's avatar
Maxime Perrotin committed
28

29
from PySide.QtCore import Qt, QPoint, QRect, QRectF, QPointF
30
from PySide.QtGui import(QPainterPath, QBrush, QColor, QRadialGradient, QPen)
Maxime Perrotin's avatar
Maxime Perrotin committed
31

Maxime Perrotin's avatar
Maxime Perrotin committed
32
from genericSymbols import HorizontalSymbol, VerticalSymbol, Comment
33
from Connectors import Connection, JoinConnection, Signalroute
34

Maxime Perrotin's avatar
Maxime Perrotin committed
35
36
37
38
39
40
import ogParser
import ogAST


LOG = logging.getLogger('sdlSymbols')

41
AST = ogAST.AST()
42
CONTEXT = ogAST.Process()
Maxime Perrotin's avatar
Maxime Perrotin committed
43
44
45
46
47
48
49
50

# SDL-specific: reserved keywords, to be highlighted in textboxes
# Two kind of formatting are possible: black bold, and red bold
SDL_BLACKBOLD = ['\\b{word}\\b'.format(word=word) for word in (
                'DCL', 'CALL', 'ELSE', 'IF', 'THEN', 'MANTISSA', 'BASE',
                'EXPONENT', 'TRUE', 'FALSE', 'MOD', 'FI', 'WRITE', 'WRITELN',
                'LENGTH', 'PRESENT', 'FPAR', 'TODO', 'FIXME', 'XXX',
                'CHECKME', 'PROCEDURE', 'EXTERNAL', 'IN', 'OUT', 'TIMER',
51
                'SET_TIMER', 'RESET_TIMER', 'VIA', 'ENTRY', 'EXIT', 'ANY',
52
                'SYNTYPE', 'ENDSYNTYPE', 'CONSTANTS', 'ENDPROCEDURE',
53
                'COMMENT', 'SIGNAL', 'SIGNALLIST', 'USE', 'RETURNS'
Maxime Perrotin's avatar
Maxime Perrotin committed
54
                'NEWTYPE', 'ENDNEWTYPE', 'ARRAY', 'STRUCT', 'SYNONYM')]
Maxime Perrotin's avatar
Maxime Perrotin committed
55
56
57

SDL_REDBOLD = ['\\b{word}\\b'.format(word=word) for word in (
              'INPUT', 'OUTPUT', 'STATE', 'DECISION', 'NEXTSTATE',
58
              'TASK', 'PROCESS', 'LABEL', 'JOIN', 'CONNECTION', 'CONNECT')]
Maxime Perrotin's avatar
Maxime Perrotin committed
59
60


61
62
63
64
65
def variables_autocompletion(symbol, type_filter=None):
    ''' Intelligent autocompletion for variables - including struct fields
        Optional: only variables of a type listed in type_filter are kept
    '''
    res = set()
Maxime Perrotin's avatar
Maxime Perrotin committed
66
67
68
69
70
71
    if not symbol.text:
        return res
    parts = symbol.text.context.split('!')
    if len(parts) == 0:
        return res
    elif len(parts) == 1:
72
73
74
75
76
        try:
            fpar = {fp['name']: (fp['type'], None) for fp in CONTEXT.fpar}
        except AttributeError:
            # not in the context of a procedure
            fpar = {}
77
78
79
80
        # Return the list of variables, possibly filterd by type
        if not type_filter:
            res = set(CONTEXT.variables.keys()
                      + CONTEXT.global_variables.keys()
81
82
                      + AST.asn1_constants.keys()
                      + fpar.keys())
83
84
85
        else:
            constants = {name: (cty.type, None)
                         for name, cty in AST.asn1_constants.viewitems()}
Maxime Perrotin's avatar
Maxime Perrotin committed
86
87
88
89
90
91
92
93
94
95
            try:
                type_filter_names = [ogParser.type_name(ty)
                                     for ty in type_filter]
            except AttributeError as err:
                # This would need to be investigated: it can happen when
                # using a parameter in an input just after the parameter was
                # added to the signal in the block view, and before any
                # variable has been declared....
                LOG.debug(str(err))
                return res
96
97
            for name, (asn1type, _) in chain(CONTEXT.variables.viewitems(),
                                          CONTEXT.global_variables.viewitems(),
98
99
                                          constants.viewitems(),
                                          fpar.viewitems()):
100
101
                if ogParser.type_name(asn1type) in type_filter_names:
                    res.add(name)
Maxime Perrotin's avatar
Maxime Perrotin committed
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
    else:
        var = parts[0].lower()
        try:
            var_t = ogParser.find_variable_type(var, CONTEXT)
            basic = ogParser.find_basic_type(var_t, AST.dataview)
            res = (field.replace('-', '_') for field in basic.Children.keys())
        except (AttributeError, TypeError):
            res = []
        else:
            for each in parts[1:-1]:
                try:
                    for child, childtype in basic.Children.viewitems():
                        if child.lower() == each.lower().replace('_', '-'):
                            basic = ogParser.find_basic_type(childtype.type,
                                                             AST.dataview)
                            break
                    else:
                        res = ()
                        break
                except (AttributeError, TypeError):
                    res = ()
                    break
            else:
                try:
                    res = (field.replace('-', '_')
                           for field in basic.Children.keys())
                except AttributeError:
                    res = ()
    return res




Maxime Perrotin's avatar
Maxime Perrotin committed
135
# pylint: disable=R0904
136
class Input(HorizontalSymbol):
Maxime Perrotin's avatar
Maxime Perrotin committed
137
138
139
    ''' SDL INPUT Symbol '''
    _unique_followers = ['Comment']
    _insertable_followers = ['Task', 'ProcedureCall', 'Output', 'Decision',
140
                             'Input', 'Label', 'Connect', 'ContinuousSignal']
Maxime Perrotin's avatar
Maxime Perrotin committed
141
142
143
144
145
146
147
148
149
150
    _terminal_followers = ['Join', 'State', 'ProcedureStop']

    common_name = 'input_part'
    # Define reserved keywords for the syntax highlighter
    blackbold = SDL_BLACKBOLD
    redbold = SDL_REDBOLD

    def __init__(self, parent=None, ast=None):
        ''' Create the INPUT symbol '''
        ast = ast or ogAST.Input()
151
        self.ast = ast
Maxime Perrotin's avatar
Maxime Perrotin committed
152
        self.branch_entrypoint = None
Maxime Perrotin's avatar
Maxime Perrotin committed
153
154
155
        if not ast.pos_y and parent:
            # Make sure the item is placed below its parent
            ast.pos_y = parent.y() + parent.boundingRect().height() + 10
Maxime Perrotin's avatar
Maxime Perrotin committed
156
        super(Input, self).__init__(parent, text=ast.inputString,
157
                x=ast.pos_x or 0, y=ast.pos_y or 0, hyperlink=ast.hyperlink)
Maxime Perrotin's avatar
Maxime Perrotin committed
158
159
160
161
162
163
164
165
166
167
168
169
        self.set_shape(ast.width, ast.height)
        gradient = QRadialGradient(50, 50, 50, 50, 50)
        gradient.setColorAt(0, QColor(255, 240, 170))
        gradient.setColorAt(1, Qt.white)
        self.setBrush(QBrush(gradient))
        self.terminal_symbol = False
        self.parser = ogParser
        if ast.comment:
            Comment(parent=self, ast=ast.comment)

    def insert_symbol(self, parent, x, y):
        ''' Insert Input symbol - propagate branch Entry point '''
170
171
172
        # Make sure that parent is a state, not a sibling symbol
        item_parent = (parent if not isinstance(parent, (Input,
                                                         ContinuousSignal))
Maxime Perrotin's avatar
Maxime Perrotin committed
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
                       else parent.parentItem())
        self.branch_entrypoint = item_parent.branch_entrypoint
        super(Input, self).insert_symbol(item_parent, x, y)

    def set_shape(self, width, height):
        ''' Compute the polygon to fit in width, height '''
        path = QPainterPath()
        path.lineTo(width, 0)
        path.lineTo(width - 11, height / 2)
        path.lineTo(width, height)
        path.lineTo(0, height)
        path.lineTo(0, 0)
        self.setPath(path)
        super(Input, self).set_shape(width, height)

Maxime Perrotin's avatar
Maxime Perrotin committed
188
189
190
191
    @property
    def completion_list(self):
        ''' Set auto-completion list '''
        if '(' in unicode(self):
192
193
            # Input parameter: return the list of variables of this type
            input_name = unicode(self).split('(')[0].strip().lower()
Maxime Perrotin's avatar
Maxime Perrotin committed
194
            asn1_filter = [sig.get('type') for sig in CONTEXT.input_signals if
195
196
                           sig['name'] == input_name]
            return variables_autocompletion(self, asn1_filter)
Maxime Perrotin's avatar
Maxime Perrotin committed
197
        else:
198
199
200
            # Return the list of input signals and timers
            return (set(sig['name'] for sig in CONTEXT.input_signals).union(
                    CONTEXT.global_timers + CONTEXT.timers))
Maxime Perrotin's avatar
Maxime Perrotin committed
201

Maxime Perrotin's avatar
Maxime Perrotin committed
202

203
204
205
class Connect(Input):
    ''' Connect point below a nested state '''
    common_name = 'connect_part'
206
    auto_expand = True
Maxime Perrotin's avatar
Maxime Perrotin committed
207
208
209
    resizeable = False
    # Symbol must not use antialiasing, otherwise the middle line is too thick
    _antialiasing = False
Maxime Perrotin's avatar
Maxime Perrotin committed
210

Maxime Perrotin's avatar
Maxime Perrotin committed
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
    def set_shape(self, width, height):
        ''' Compute the polygon to fit in width, height '''
        self.setPen(QPen(Qt.blue))
        self.textbox_alignment = Qt.AlignLeft | Qt.AlignTop
        path = QPainterPath()
        path.moveTo(0, 0)
        path.lineTo(0, height)
        #path.moveTo(0, height / 2)
        #path.lineTo(width, height / 2)
        self.setPath(path)
        super(Input, self).set_shape(width, height)

    def resize_item(self, rect):
        ''' Symbol cannot be resized '''
        return

227
228
229
230
231
232
233
234
235
236
    @property
    def completion_list(self):
        ''' Set auto-completion list: list of exit points of nested state '''
        parent_state = unicode(self.parentItem()).lower()
        for each in CONTEXT.composite_states:
            if each.statename == parent_state:
                return each.state_exitpoints
        else:
            return set()

237

Maxime Perrotin's avatar
Maxime Perrotin committed
238
# pylint: disable=R0904
239
class Output(VerticalSymbol):
Maxime Perrotin's avatar
Maxime Perrotin committed
240
241
242
243
244
245
246
247
248
249
250
251
    ''' SDL OUTPUT Symbol '''
    _unique_followers = ['Comment']
    _insertable_followers = [
            'Task', 'ProcedureCall', 'Output', 'Decision', 'Label']
    _terminal_followers = ['Join', 'State', 'ProcedureStop']
    common_name = 'output'
    # Define reserved keywords for the syntax highlighter
    blackbold = SDL_BLACKBOLD
    redbold = SDL_REDBOLD

    def __init__(self, parent=None, ast=None):
        ast = ast or ogAST.Output()
252
        self.ast = ast
Maxime Perrotin's avatar
Maxime Perrotin committed
253
        super(Output, self).__init__(parent=parent,
254
                text=ast.inputString, x=ast.pos_x or 0, y=ast.pos_y or 0,
Maxime Perrotin's avatar
Maxime Perrotin committed
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
                hyperlink=ast.hyperlink)
        self.set_shape(ast.width, ast.height)

        self.setBrush(QBrush(QColor(255, 255, 202)))
        self.terminal_symbol = False
        self.parser = ogParser
        if ast.comment:
            Comment(parent=self, ast=ast.comment)

    def set_shape(self, width, height):
        ''' Compute the polygon to fit in width, height '''
        path = QPainterPath()
        path.lineTo(width - 11, 0)
        path.lineTo(width, height / 2)
        path.lineTo(width - 11, height)
        path.lineTo(0, height)
        path.lineTo(0, 0)
        self.setPath(path)
        super(Output, self).set_shape(width, height)

Maxime Perrotin's avatar
Maxime Perrotin committed
275
276
277
    @property
    def completion_list(self):
        ''' Set auto-completion list '''
278
279
280
281
        if '(' in unicode(self):
            # Output parameter: return the list of variables of this type
            output_name = unicode(self).split('(')[0].strip().lower()
            asn1_filter = [sig['type'] for sig in CONTEXT.output_signals if
282
                           hasattr(sig, 'type') and sig['name'] == output_name]
283
284
285
286
            return variables_autocompletion(self, asn1_filter)
        else:
            # Return the list of output signals
            return (set(sig['name'] for sig in CONTEXT.output_signals))
Maxime Perrotin's avatar
Maxime Perrotin committed
287

Maxime Perrotin's avatar
Maxime Perrotin committed
288
289

# pylint: disable=R0904
290
class Decision(VerticalSymbol):
Maxime Perrotin's avatar
Maxime Perrotin committed
291
292
    ''' SDL DECISION Symbol '''
    _unique_followers = ['Comment']
Maxime Perrotin's avatar
Maxime Perrotin committed
293
294
    _insertable_followers = ['DecisionAnswer', 'Task', 'ProcedureCall',
                             'Output', 'Decision', 'Label']
Maxime Perrotin's avatar
Maxime Perrotin committed
295
296
297
298
299
300
301
302
303
    _terminal_followers = ['Join', 'State', 'ProcedureStop']
    common_name = 'decision'
    # Define reserved keywords for the syntax highlighter
    blackbold = SDL_BLACKBOLD + ['\\b{}\\b'.format(word)
                                   for word in ('AND', 'OR')]
    redbold = SDL_REDBOLD

    def __init__(self, parent=None, ast=None):
        ast = ast or ogAST.Decision()
304
        self.ast = ast
Maxime Perrotin's avatar
Maxime Perrotin committed
305
306
307
        # Define the point where all branches of the decision can join again
        self.connectionPoint = QPoint(ast.width / 2, ast.height + 30)
        super(Decision, self).__init__(parent, text=ast.inputString,
308
                x=ast.pos_x or 0, y=ast.pos_y or 0, hyperlink=ast.hyperlink)
Maxime Perrotin's avatar
Maxime Perrotin committed
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
        self.set_shape(ast.width, ast.height)
        self.setBrush(QColor(255, 255, 202))
        self.minDistanceToSymbolAbove = 0
        self.parser = ogParser
        self.text_alignment = Qt.AlignHCenter
        if ast.comment:
            Comment(parent=self, ast=ast.comment)

    @property
    def terminal_symbol(self):
        '''
            Compute dynamically if the item is terminal by checking
            if all its branches end with a terminator
        '''
        for branch in self.branches():
            if not branch.last_branch_item.terminal_symbol:
                return False
326
        return True
Maxime Perrotin's avatar
Maxime Perrotin committed
327

Maxime Perrotin's avatar
Maxime Perrotin committed
328
329
330
331
332
    @property
    def completion_list(self):
        ''' Set auto-completion list '''
        return chain(variables_autocompletion(self), ('length', 'present'))

Maxime Perrotin's avatar
Maxime Perrotin committed
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
    def branches(self):
        ''' Return the list of decision answers (as a generator) '''
        return (branch for branch in self.childSymbols()
                if isinstance(branch, DecisionAnswer))

    def set_shape(self, width, height):
        ''' Define polygon points to draw the symbol '''
        path = QPainterPath()
        path.moveTo(width / 2, 0)
        path.lineTo(width, height / 2)
        path.lineTo(width / 2, height)
        path.lineTo(0, height / 2)
        path.lineTo(width / 2, 0)
        self.setPath(path)
        super(Decision, self).set_shape(width, height)

    def resize_item(self, rect):
        ''' On resize event, make sure connection points are updated '''
        delta_y = self.boundingRect().height() - rect.height()
        super(Decision, self).resize_item(rect)
        self.connectionPoint.setX(self.boundingRect().center().x())
        self.connectionPoint.setY(self.connectionPoint.y() - delta_y)
        self.update_connections()

    def update_connections(self):
        ''' Redefined - update arrows shape below connection point '''
        super(Decision, self).update_connections()
        for branch in self.branches():
            for cnx in branch.last_branch_item.connections():
                cnx.reshape()

    def updateConnectionPointPosition(self):
        ''' Compute the joining point of decision branches '''
        new_y = 0
        new_x = self.boundingRect().width() / 2.0
        answers = False
        for branch in self.branches():
            answers = True
            last_cnx = None
            last = branch.last_branch_item
            try:
                # To compute the branch length, we must keep only the symbols,
                # so we must remove the last connection (if any)
                last_cnx, = (c for c in last.childItems() if
                    isinstance(c, Connection) and not
                    isinstance(c.child, (Comment, HorizontalSymbol)))
379
380
                # Don't set parent item to None to avoid Qt segfault
                last_cnx.setParentItem(self)
Maxime Perrotin's avatar
Maxime Perrotin committed
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
            except ValueError:
                pass
            branch_len = branch.y() + (
                    branch.boundingRect() |
                    branch.childrenBoundingRect()).height()
            try:
                last_cnx.setParentItem(last)
            except AttributeError:
                pass
            # If last item was a decision, use its connection point
            # position to get the length of the branch:
            try:
                branch_len = (last.connectionPoint.y() +
                        self.mapFromScene(0, last.scenePos().y()).y())
            except AttributeError:
                pass
            # Rounded with int() -> mandatory when view scale has changed
            new_y = int(max(new_y, branch_len))
        if not answers:
            new_y = int(self.boundingRect().height())
        new_y += 15
        delta = new_y - self.connectionPoint.y()
        self.connectionPoint.setY(new_y)
        self.connectionPoint.setX(new_x)
        if delta != 0:
            child = self.next_aligned_symbol()
            try:
408
                child.pos_y += delta
Maxime Perrotin's avatar
Maxime Perrotin committed
409
410
411
412
413
414
            except AttributeError:
                pass
        self.update_connections()


# pylint: disable=R0904
415
class DecisionAnswer(HorizontalSymbol):
Maxime Perrotin's avatar
Maxime Perrotin committed
416
417
418
419
420
421
422
423
424
425
426
    ''' If Decision is a "switch", DecisionAnswer is a "case" '''
    _insertable_followers = ['DecisionAnswer', 'Task', 'ProcedureCall',
                        'Output', 'Decision', 'Label']
    _terminal_followers = ['Join', 'State', 'ProcedureStop']
    common_name = 'alternative_part'
    # Define reserved keywords for the syntax highlighter
    blackbold = SDL_BLACKBOLD
    redbold = SDL_REDBOLD

    def __init__(self, parent=None, ast=None):
        ast = ast or ogAST.Answer()
427
        self.ast = ast
Maxime Perrotin's avatar
Maxime Perrotin committed
428
429
430
431
432
433
        self.width, self.height = ast.width, ast.height
        self.terminal_symbol = False
        # last_branch_item is used to compute branch length
        # for the connection point positionning
        self.last_branch_item = self
        super(DecisionAnswer, self).__init__(parent,
434
435
436
437
                                             text=ast.inputString,
                                             x=ast.pos_x or 0,
                                             y=ast.pos_y or 0,
                                             hyperlink=ast.hyperlink)
Maxime Perrotin's avatar
Maxime Perrotin committed
438
439
440
441
442
443
444
445
        self.set_shape(ast.width, ast.height)
        self.branch_entrypoint = self
        self.parser = ogParser

    def insert_symbol(self, parent, x, y):
        ''' ANSWER-specific insersion behaviour: link to connection point '''
        if not parent:
            return
Maxime Perrotin's avatar
Maxime Perrotin committed
446
        # Make sure that parent is not a sibling answer
Maxime Perrotin's avatar
Maxime Perrotin committed
447
448
449
        item_parent = (parent if not isinstance(parent, DecisionAnswer)
                       else parent.parentItem())
        super(DecisionAnswer, self).insert_symbol(item_parent, x, y)
Maxime Perrotin's avatar
Maxime Perrotin committed
450
451
        self.last_branch_item.connectionBelow = \
                JoinConnection(self.last_branch_item, item_parent)
Maxime Perrotin's avatar
Maxime Perrotin committed
452
453
454
455
456
457
458

    def boundingRect(self):
        return QRectF(0, 0, self.width, self.height)

    def set_shape(self, width, height):
        ''' ANSWER has round, disjoint sides - does not fit in a polygon '''
        self.width, self.height = width, height
459
        point = 20 #width / 2.85
Maxime Perrotin's avatar
Maxime Perrotin committed
460
461
462
463
464
465
466
467
468
469
470
        path = QPainterPath()
        left = QRect(0, 0, point, height)
        right = QRect(width - point, 0, point, height)
        path.arcMoveTo(left, 125)
        path.arcTo(left, 125, 110)
        path.arcMoveTo(right, -55)
        path.arcTo(right, -55, 110)
        path.moveTo(width, height)
        self.setPath(path)
        super(DecisionAnswer, self).set_shape(width, height)

471
472
473
474
475
    @property
    def completion_list(self):
        ''' Set auto-completion list '''
        return ['ELSE']

Maxime Perrotin's avatar
Maxime Perrotin committed
476
477

# pylint: disable=R0904
478
class Join(VerticalSymbol):
Maxime Perrotin's avatar
Maxime Perrotin committed
479
    ''' JOIN symbol (GOTO) '''
480
    auto_expand = True
Maxime Perrotin's avatar
Maxime Perrotin committed
481
    arrow_head = 'simple'
Maxime Perrotin's avatar
Maxime Perrotin committed
482
483
484
485
486
487
    common_name = 'terminator_statement'
    # Define reserved keywords for the syntax highlighter
    blackbold = SDL_BLACKBOLD
    redbold = SDL_REDBOLD

    def __init__(self, parent=None, ast=None):
488
        self.ast = ast
Maxime Perrotin's avatar
Maxime Perrotin committed
489
        if not ast:
490
            ast = ogAST.Terminator(defName='')
Maxime Perrotin's avatar
Maxime Perrotin committed
491
492
493
            ast.pos_y = 0
            ast.width = 35
            ast.height = 35
494
495
496
497
498
        super(Join, self).__init__(parent,
                                   text=ast.inputString,
                                   x=ast.pos_x,
                                   y=ast.pos_y,
                                   hyperlink=ast.hyperlink)
Maxime Perrotin's avatar
Maxime Perrotin committed
499
500
501
502
503
504
505
506
507
508
        self.set_shape(ast.width, ast.height)
        self.setPen(QPen(Qt.blue))
        self.terminal_symbol = True
        self.parser = ogParser

    def resize_item(self, rect):
        ''' Redefinition of the resize item (block is a square) '''
        size = min(rect.width(), rect.height())
        rect.setWidth(size)
        rect.setHeight(size)
Maxime Perrotin's avatar
Maxime Perrotin committed
509
        super(Join, self).resize_item(rect)
Maxime Perrotin's avatar
Maxime Perrotin committed
510
511
512
513
514
515
516
517
518

    def set_shape(self, width, height):
        ''' Define the bouding rectangle of the JOIN symbol '''
        circ = min(width, height)
        path = QPainterPath()
        path.addEllipse(0, 0, circ, circ)
        self.setPath(path)
        super(Join, self).set_shape(width, height)

519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
    @property
    def completion_list(self):
        ''' Set auto-completion list - list of labels '''
        return (label.inputString for label in CONTEXT.labels)

    def update_completion_list(self, pr_text):
        ''' When text was entered, update list of join terminators '''
        ast, _, _, _, _ = self.parser.parseSingleElement(self.common_name,
                                                         pr_text)
        for each in (t for t in CONTEXT.terminators if t.kind == 'join'):
            if each.inputString == unicode(self):
                # Ignore if already defined
                break
        else:
            CONTEXT.terminators.append(ast)

Maxime Perrotin's avatar
Maxime Perrotin committed
535

536
class ProcedureStop(Join):
Maxime Perrotin's avatar
Maxime Perrotin committed
537
538
539
540
    ''' Procedure STOP symbol - very similar to JOIN '''
    # Define reserved keywords for the syntax highlighter
    blackbold = SDL_BLACKBOLD
    redbold = SDL_REDBOLD
Maxime Perrotin's avatar
Maxime Perrotin committed
541

Maxime Perrotin's avatar
Maxime Perrotin committed
542
    def __init__(self, parent=None, ast=None):
543
        self.ast = ast
Maxime Perrotin's avatar
Maxime Perrotin committed
544
        if not ast:
545
            ast = ogAST.Terminator(defName='')
Maxime Perrotin's avatar
Maxime Perrotin committed
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
            ast.pos_y = 0
            ast.width = 35
            ast.height = 35
        super(ProcedureStop, self).__init__(parent, ast)

    def set_shape(self, width, height):
        ''' Define the symbol shape '''
        circ = min(width, height)
        path = QPainterPath()
        path.addEllipse(0, 0, circ, circ)
        point1 = path.pointAtPercent(0.625)
        point2 = path.pointAtPercent(0.125)
        point3 = path.pointAtPercent(0.875)
        point4 = path.pointAtPercent(0.375)
        path.moveTo(point1)
        path.lineTo(point2)
        path.moveTo(point3)
563
        path.lineTo(point4)
Maxime Perrotin's avatar
Maxime Perrotin committed
564
565
566
567
        self.setPath(path)
        # call Join superclass, otherwise symbol will take Join shape
        super(Join, self).set_shape(circ, circ)

Maxime Perrotin's avatar
Maxime Perrotin committed
568
569
570
    @property
    def completion_list(self):
        ''' Set auto-completion list '''
571
572
573
574
575
576
577
578
579
580
581
        try:
            return CONTEXT.state_exitpoints
        except AttributeError:
            # Not in a state but in a procedure
            return set()

    def update_completion_list(self, pr_text):
        ''' When text was entered, if in a nested state update exit points '''
        ast, _, _, _, _ = self.parser.parseSingleElement(self.common_name,
                                                         pr_text)
        try:
582
583
            CONTEXT.state_exitpoints = \
                    set(CONTEXT.state_exitpoints) | set(unicode(self))
584
585
586
        except AttributeError:
            # No state exit points in a procedure
            pass
Maxime Perrotin's avatar
Maxime Perrotin committed
587

Maxime Perrotin's avatar
Maxime Perrotin committed
588
589

# pylint: disable=R0904
590
class Label(VerticalSymbol):
Maxime Perrotin's avatar
Maxime Perrotin committed
591
592
593
594
595
596
597
598
599
600
601
602
603
    ''' LABEL symbol '''
    _insertable_followers = [
            'Task', 'ProcedureCall', 'Output', 'Decision', 'Label']
    _terminal_followers = ['Join', 'State', 'ProcedureStop']
    needs_parent = False
    # Define reserved keywords for the syntax highlighter
    blackbold = SDL_BLACKBOLD
    redbold = SDL_REDBOLD
    # Symbol must not use antialiasing, otherwise the middle line is too thick
    _antialiasing = False

    def __init__(self, parent=None, ast=None):
        ast = ast or ogAST.Label()
604
605
606
607
608
609
        self.ast = ast
        super(Label, self).__init__(parent,
                                    text=ast.inputString,
                                    x=ast.pos_x or 0,
                                    y=ast.pos_y or 0,
                                    hyperlink=ast.hyperlink)
Maxime Perrotin's avatar
Maxime Perrotin committed
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
        self.set_shape(ast.width, ast.height)
        self.setPen(QPen(Qt.blue))
        self.terminal_symbol = False
        self.textbox_alignment = Qt.AlignLeft | Qt.AlignTop
        self.parser = ogParser

    @property
    def common_name(self):
        return 'label' if self.hasParent else 'floating_label'

    def set_shape(self, width, height):
        ''' Define the shape of the LABEL symbol '''
        path = QPainterPath()
        path.addEllipse(0, height / 2, width / 4, height / 2)
        path.moveTo(width / 4, height * 3 / 4)
        path.lineTo(width / 2, height * 3 / 4)
        # Add arrow head
        path.moveTo(width / 2 - 5, height * 3 / 4 - 5)
        path.lineTo(width / 2, height * 3 / 4)
        path.lineTo(width / 2 - 5, height * 3 / 4 + 5)
        # Add vertical line in the middle of the symbol
        path.moveTo(width / 2, 0)
        path.lineTo(width / 2, height)
        # Make sure the bounding rect is withing specifications
        path.moveTo(width, height)
        self.setPath(path)
        super(Label, self).set_shape(width, height)

638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
    @property
    def completion_list(self):
        ''' Set auto-completion list - list of JOIN '''
        return (term.inputString
                for term in CONTEXT.terminators if term.kind == 'join')

    def update_completion_list(self, pr_text):
        ''' When text was entered, update list of labels in current context '''
        ast, _, _, _, _ = self.parser.parseSingleElement(self.common_name,
                                                         pr_text)
        for each in CONTEXT.labels:
            if each.inputString == unicode(self):
                # Ignore if already defined
                break
        else:
            CONTEXT.labels.append(ast)

Maxime Perrotin's avatar
Maxime Perrotin committed
655
656

# pylint: disable=R0904
657
class Task(VerticalSymbol):
Maxime Perrotin's avatar
Maxime Perrotin committed
658
659
660
661
662
663
664
665
666
667
668
669
670
    ''' TASK symbol '''
    _unique_followers = ['Comment']
    _insertable_followers = [
            'Task', 'ProcedureCall', 'Output', 'Decision', 'Label']
    _terminal_followers = ['Join', 'State', 'ProcedureStop']
    common_name = 'task'
    # Define reserved keywords for the syntax highlighter
    blackbold = SDL_BLACKBOLD
    redbold = SDL_REDBOLD

    def __init__(self, parent=None, ast=None):
        ''' Initializes the TASK symbol '''
        ast = ast or ogAST.Task()
671
672
673
674
675
676
        self.ast = ast
        super(Task, self).__init__(parent,
                                   text=ast.inputString,
                                   x=ast.pos_x or 0,
                                   y=ast.pos_y or 0,
                                   hyperlink=ast.hyperlink)
Maxime Perrotin's avatar
Maxime Perrotin committed
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
        self.set_shape(ast.width, ast.height)
        self.setBrush(QBrush(QColor(255, 255, 202)))
        self.terminal_symbol = False
        self.parser = ogParser
        if ast.comment:
            Comment(parent=self, ast=ast.comment)

    def set_shape(self, width, height):
        ''' Compute the polygon to fit in width, height '''
        path = QPainterPath()
        path.lineTo(width, 0)
        path.lineTo(width, height)
        path.lineTo(0, height)
        path.lineTo(0, 0)
        self.setPath(path)
        super(Task, self).set_shape(width, height)

694
695
    @property
    def completion_list(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
696
        ''' Set auto-completion list '''
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
        elems = unicode(self).lower().strip().split()
        asn1_filter = []
        if len(elems) == 2 and elems[1] == ':=':
            # Find type of variable on the left and filter accordingly
            varname = elems[0]
            try:
                fpar = {fp['name']: (fp['type'], None) for fp in CONTEXT.fpar}
            except AttributeError:
                # not in the context of a procedure
                fpar = {}
            constants = {name: (cty.type, None)
                         for name, cty in AST.asn1_constants.viewitems()}
            for name, (asn1ty, _) in chain (CONTEXT.variables.viewitems(),
                                          CONTEXT.global_variables.viewitems(),
                                          constants.viewitems(),
                                          fpar.viewitems()):
                if name == varname:
                    asn1_filter = [asn1ty]
                    break
        return chain(variables_autocompletion(self, asn1_filter),
                     ogParser.SPECIAL_OPERATORS.viewkeys())
Maxime Perrotin's avatar
Maxime Perrotin committed
718
719

# pylint: disable=R0904
720
class ProcedureCall(VerticalSymbol):
Maxime Perrotin's avatar
Maxime Perrotin committed
721
722
723
724
725
726
727
728
729
730
731
732
    ''' PROCEDURE CALL symbol '''
    _unique_followers = ['Comment']
    _insertable_followers = [
            'Task', 'ProcedureCall', 'Output', 'Decision', 'Label']
    _terminal_followers = ['Join', 'State', 'ProcedureStop']
    common_name = 'procedure_call'
    # Define reserved keywords for the syntax highlighter
    blackbold = ['\\bWRITELN\\b', '\\bWRITE\\b',
                 '\\bSET_TIMER\\b', '\\bRESET_TIMER\\b']
    redbold = SDL_REDBOLD

    def __init__(self, parent=None, ast=None):
733
        ast = ast or ogAST.Output(defName='')
734
        self.ast = ast
Maxime Perrotin's avatar
Maxime Perrotin committed
735
        super(ProcedureCall, self).__init__(parent,
736
737
738
739
                                            text=ast.inputString,
                                            x=ast.pos_x or 0,
                                            y=ast.pos_y or 0,
                                            hyperlink=ast.hyperlink)
Maxime Perrotin's avatar
Maxime Perrotin committed
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
        self.set_shape(ast.width, ast.height)
        self.setBrush(QBrush(QColor(255, 255, 202)))
        self.terminal_symbol = False
        self.parser = ogParser
        if ast.comment:
            Comment(parent=self, ast=ast.comment)

    def set_shape(self, width, height):
        ''' Compute the polygon to fit in width, height '''
        path = QPainterPath()
        path.addRect(0, 0, width, height)
        path.moveTo(7, 0)
        path.lineTo(7, height)
        path.moveTo(width - 7, 0)
        path.lineTo(width - 7, height)
        self.setPath(path)
        super(ProcedureCall, self).set_shape(width, height)

Maxime Perrotin's avatar
Maxime Perrotin committed
758
759
760
    @property
    def completion_list(self):
        ''' Set auto-completion list '''
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
        if '(' in unicode(self):
            # Get the variables of the type of the current parameter
            count = unicode(self).count(',')
            procname = unicode(self).split('(')[0].strip().lower()
            for each in (proc for proc in CONTEXT.procedures
                         if proc.inputString.lower() == procname):
                param_types = [p['type'] for p in each.fpar]
                break
            else:
                # Procedure not defined, check special operators
                if (procname == 'set_timer' and count == 1) or (
                        procname == 'reset_timer' and count == 0):
                    return chain(CONTEXT.timers, CONTEXT.global_timers)
                elif procname in ('write', 'writeln'):
                    # Could filter for OCTET STRINGS/Strings/Integer/Booleans
                    return variables_autocompletion(self)
                else:
                    return ()
            if count + 1 > len(param_types):
                # User tries to set more parameters than defined
                return ()
            else:
                # Return variables of the type of the parameter
                asn1_filter = param_types[slice(count, count + 1)]
                return variables_autocompletion(self, asn1_filter)
        else:
            return chain((proc.inputString for proc in CONTEXT.procedures),
                         ('set_timer', 'reset_timer', 'write', 'writeln'))
Maxime Perrotin's avatar
Maxime Perrotin committed
789

Maxime Perrotin's avatar
Maxime Perrotin committed
790
791

# pylint: disable=R0904
792
class TextSymbol(HorizontalSymbol):
Maxime Perrotin's avatar
Maxime Perrotin committed
793
794
795
796
797
798
799
800
801
802
    ''' Text symbol - used to declare variables, etc. '''
    common_name = 'text_area'
    needs_parent = False
    # Define reserved keywords for the syntax highlighter
    blackbold = SDL_BLACKBOLD
    redbold = SDL_REDBOLD

    def __init__(self, ast=None):
        ''' Create a Text Symbol '''
        ast = ast or ogAST.TextArea()
803
        self.ast = ast
Maxime Perrotin's avatar
Maxime Perrotin committed
804
        super(TextSymbol, self).__init__(parent=None,
805
806
807
808
                                         text=ast.inputString,
                                         x=ast.pos_x or 0,
                                         y=ast.pos_y or 0,
                                         hyperlink=ast.hyperlink)
Maxime Perrotin's avatar
Maxime Perrotin committed
809
810
811
        self.set_shape(ast.width, ast.height)
        self.setBrush(QBrush(QColor(249, 249, 249)))
        self.terminal_symbol = False
812
        self.position = QPointF(ast.pos_x or 0, ast.pos_y or 0)
Maxime Perrotin's avatar
Maxime Perrotin committed
813
814
815
816
817
818
        # Disable hyperlinks for Text symbols
        self._no_hyperlink = True
        # Text is not centered in the box - change default alignment:
        self.textbox_alignment = Qt.AlignLeft | Qt.AlignTop
        self.parser = ogParser

Maxime Perrotin's avatar
Maxime Perrotin committed
819
    def update_completion_list(self, pr_text):
820
        ''' When text was entered, update list of variables/FPAR/Timers '''
Maxime Perrotin's avatar
Maxime Perrotin committed
821
        # Get AST for the symbol
Maxime Perrotin's avatar
Maxime Perrotin committed
822
        ast, _, _, _, _ = self.parser.parseSingleElement('text_area', pr_text)
823
824
825
826
        try:
            CONTEXT.variables.update(ast.variables)
            CONTEXT.timers = list(set(CONTEXT.timers + ast.timers))
        except AttributeError:
827
            # context may not have variables/timers (eg if context = block)
828
            pass
829
        try:
830
831
832
833
            existing = {proc.inputString.lower()
                       for proc in CONTEXT.procedures}
            CONTEXT.procedures += [proc for proc in ast.procedures
                                   if proc.inputString.lower() not in existing]
834
835
836
            CONTEXT.fpar.extend(ast.fpar)
        except AttributeError:
            pass
837
        # Update completion list of Signalroutes
838
839
840
841
        try:
            Signalroute.completion_list |= set(sig['name']
                                               for sig in ast.signals)
        except AttributeError:
842
            # no AST, e.g. in case of syntax errors in the text area
843
            pass
Maxime Perrotin's avatar
Maxime Perrotin committed
844

Maxime Perrotin's avatar
Maxime Perrotin committed
845
846
847
    @property
    def completion_list(self):
        ''' Set auto-completion list '''
848
        try:
849
            return set(AST.dataview.keys())
850
        except AttributeError:
851
            return [] # No Dataview
Maxime Perrotin's avatar
Maxime Perrotin committed
852

Maxime Perrotin's avatar
Maxime Perrotin committed
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
    def set_shape(self, width, height):
        ''' Define the polygon of the text symbol '''
        path = QPainterPath()
        path.moveTo(width - 10, 0)
        path.lineTo(0, 0)
        path.lineTo(0, height)
        path.lineTo(width, height)
        path.lineTo(width, 10)
        path.lineTo(width - 10, 10)
        path.lineTo(width - 10, 0)
        path.lineTo(width, 10)
        self.setPath(path)
        super(TextSymbol, self).set_shape(width, height)

    def resize_item(self, rect):
        ''' Text Symbol only resizes down or right '''
        if self.grabber.resize_mode.endswith('left'):
            return
        self.prepareGeometryChange()
        self.set_shape(rect.width(), rect.height())


class ASN1Viewer(TextSymbol):
    ''' Text symbol with dedicated text highlighting set of words for ASN.1 '''
    blackbold = ['\\b{}\\b'.format(word) for word in (
                 'DEFINITIONS', 'AUTOMATIC', 'TAGS', 'BEGIN', 'END', 'INTEGER',
                 'OCTET', 'STRING', 'BIT', 'REAL', 'SEQUENCE', 'OF', 'WITH',
880
                 'IMPORTS', 'FROM', 'SIZE', 'CHOICE', 'BOOLEAN', 'ENUMERATED')]
Maxime Perrotin's avatar
Maxime Perrotin committed
881
882
883


# pylint: disable=R0904
884
class State(VerticalSymbol):
Maxime Perrotin's avatar
Maxime Perrotin committed
885
886
    ''' SDL STATE Symbol '''
    _unique_followers = ['Comment']
887
    _insertable_followers = ['Input', 'Connect', 'ContinuousSignal']
Maxime Perrotin's avatar
Maxime Perrotin committed
888
    arrow_head = 'simple'
Maxime Perrotin's avatar
Maxime Perrotin committed
889
890
891
892
893
894
895
896
    common_name = 'terminator_statement'
    needs_parent = False
    # Define reserved keywords for the syntax highlighter
    blackbold = SDL_BLACKBOLD
    redbold = SDL_REDBOLD

    def __init__(self, parent=None, ast=None):
        ast = ast or ogAST.State()
897
        self.ast = ast
Maxime Perrotin's avatar
Maxime Perrotin committed
898
        ast.inputString = getattr(ast, 'via', None) or ast.inputString
Maxime Perrotin's avatar
Maxime Perrotin committed
899
        super(State, self).__init__(parent=parent,
900
901
902
903
                                    text=ast.inputString,
                                    x=ast.pos_x or 0,
                                    y=ast.pos_y or 0,
                                    hyperlink=ast.hyperlink)
Maxime Perrotin's avatar
Maxime Perrotin committed
904
905
906
907
908
909
        self.set_shape(ast.width, ast.height)
        self.setBrush(QBrush(QColor(255, 228, 213)))
        self.terminal_symbol = True
        if parent:
            try:
                # Map AST scene coordinates to get actual position
910
911
                self.position += self.mapFromScene(ast.pos_x or 0,
                                                   ast.pos_y or 0)
Maxime Perrotin's avatar
Maxime Perrotin committed
912
913
914
915
            except TypeError:
                self.update_position()
        else:
            # Use scene coordinates to position
916
            self.position = QPointF(ast.pos_x or 0, ast.pos_y or 0)
Maxime Perrotin's avatar
Maxime Perrotin committed
917
918
919
920
        self.parser = ogParser
        if ast.comment:
            Comment(parent=self, ast=ast.comment)

921
922
923
    @property
    def allow_nesting(self):
        ''' Redefinition - must be checked according to context '''
Maxime Perrotin's avatar
Maxime Perrotin committed
924
        result = not any(elem in unicode(self).lower().strip()
Maxime Perrotin's avatar
Maxime Perrotin committed
925
                       for elem in ('-', ',', '*'))
926
927
928
929
930
931
932
        return result

    @property
    def nested_scene(self):
        ''' Redefined - nested scene per state must be unique '''
        return self._nested_scene

Maxime Perrotin's avatar
Maxime Perrotin committed
933
934
935
    def double_click(self):
        ''' Catch a double click - Set nested scene '''
        for each, value in self.scene().composite_states.viewitems():
Maxime Perrotin's avatar
Maxime Perrotin committed
936
            if unicode(self).split()[0].lower() == unicode(each):
Maxime Perrotin's avatar
Maxime Perrotin committed
937
938
939
940
941
                self.nested_scene = value
                break
        else:
            self.nested_scene = None

942
943
944
945
946
    @nested_scene.setter
    def nested_scene(self, value):
        ''' Set the value of the nested scene '''
        self._nested_scene = value

Maxime Perrotin's avatar
Maxime Perrotin committed
947
    def update_completion_list(self, pr_text):
Maxime Perrotin's avatar
Maxime Perrotin committed
948
        ''' When text was entered, update state completion list '''
949
        # Get AST for the symbol and update the context dictionnary
Maxime Perrotin's avatar
Maxime Perrotin committed
950
        ast, _, _, _, _ = self.parser.parseSingleElement('state', pr_text)
951
        for each in ast.statelist:
952
            CONTEXT.mapping[each.lower()] = None
Maxime Perrotin's avatar
Maxime Perrotin committed
953

Maxime Perrotin's avatar
Maxime Perrotin committed
954
955
956
    @property
    def completion_list(self):
        ''' Set auto-completion list '''
957
958
959
960
961
962
963
964
965
        elems = unicode(self).lower().strip().split()
        if len(elems) == 2 and elems[1] == 'via':
            # Get list of entry point of the nested state
            statename = elems[0]
            for each in CONTEXT.composite_states:
                if each.statename == statename:
                    return each.state_entrypoints
        else:
            return set(state for state in CONTEXT.mapping if state != 'START')
Maxime Perrotin's avatar
Maxime Perrotin committed
966
967
968
969
970

    def set_shape(self, width, height):
        ''' Compute the polygon to fit in width, height '''
        path = QPainterPath()
        path.addRoundedRect(0, 0, width, height, height / 4, height)
Maxime Perrotin's avatar
Maxime Perrotin committed
971
972
973
974

        if self.nested_scene and self.is_composite():
            # Distinguish composite states with dash line
            self.setPen(QPen(Qt.DashLine))
Maxime Perrotin's avatar
Maxime Perrotin committed
975
        else:
Maxime Perrotin's avatar
Maxime Perrotin committed
976
            self.setPen(QPen(Qt.SolidLine))
Maxime Perrotin's avatar
Maxime Perrotin committed
977
978
979
        self.setPath(path)
        super(State, self).set_shape(width, height)

Maxime Perrotin's avatar
Maxime Perrotin committed
980
    def get_ast(self, pr_text):
Maxime Perrotin's avatar
Maxime Perrotin committed
981
        ''' Redefinition of the get_ast function for the state '''
Maxime Perrotin's avatar
Maxime Perrotin committed
982
983
984
        ast, _, _, _, terminators = self.parser.parseSingleElement('state',
                                                                   pr_text)
        return ast, terminators
985

986
987
988
989
990
991
    def check_syntax(self, pr_text):
        ''' Redefinition of the check syntax function for the state '''
        name = self.common_name if self.hasParent else 'state'
        _, err, _, _, _ = \
                self.parser.parseSingleElement(name, pr_text)
        return err
Maxime Perrotin's avatar
Maxime Perrotin committed
992
993


994
995
996
997
998
999
1000
class Process(HorizontalSymbol):
    ''' Process symbol '''
    _unique_followers = ['Comment']
    _allow_nesting = True
    common_name = 'process_definition'
    needs_parent = False
    # Define reserved keywords for the syntax highlighter