sdlSymbols.py 36.6 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']
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
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
52
                'SET_TIMER', 'RESET_TIMER', 'VIA', 'ENTRY', 'EXIT',
                'SYNTYPE', 'ENDSYNTYPE', 'CONSTANTS',
Maxime Perrotin's avatar
Maxime Perrotin committed
53
                'NEWTYPE', 'ENDNEWTYPE', 'ARRAY', 'STRUCT', 'SYNONYM')]
Maxime Perrotin's avatar
Maxime Perrotin committed
54
55
56

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


60
61
62
63
64
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
65
66
67
68
69
70
    if not symbol.text:
        return res
    parts = symbol.text.context.split('!')
    if len(parts) == 0:
        return res
    elif len(parts) == 1:
71
72
73
74
75
76
77
78
79
80
81
82
83
84
        # Return the list of variables, possibly filterd by type
        if not type_filter:
            res = set(CONTEXT.variables.keys()
                      + CONTEXT.global_variables.keys()
                      + AST.asn1_constants.keys())
        else:
            constants = {name: (cty.type, None)
                         for name, cty in AST.asn1_constants.viewitems()}
            type_filter_names = [ogParser.type_name(ty) for ty in type_filter]
            for name, (asn1type, _) in chain(CONTEXT.variables.viewitems(),
                                          CONTEXT.global_variables.viewitems(),
                                          constants.viewitems()):
                if ogParser.type_name(asn1type) in type_filter_names:
                    res.add(name)
Maxime Perrotin's avatar
Maxime Perrotin committed
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
    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
118
# pylint: disable=R0904
119
class Input(HorizontalSymbol):
Maxime Perrotin's avatar
Maxime Perrotin committed
120
121
122
    ''' SDL INPUT Symbol '''
    _unique_followers = ['Comment']
    _insertable_followers = ['Task', 'ProcedureCall', 'Output', 'Decision',
123
                             'Input', 'Label', 'Connect']
Maxime Perrotin's avatar
Maxime Perrotin committed
124
125
126
127
128
129
130
131
132
133
134
    _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()
        self.branch_entrypoint = None
Maxime Perrotin's avatar
Maxime Perrotin committed
135
136
137
        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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
        super(Input, self).__init__(parent, text=ast.inputString,
                x=ast.pos_x, y=ast.pos_y, hyperlink=ast.hyperlink)
        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 '''
        # Make sure that parent is a state, not a sibling input
        item_parent = (parent if not isinstance(parent, Input)
                       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
169
170
171
172
    @property
    def completion_list(self):
        ''' Set auto-completion list '''
        if '(' in unicode(self):
173
174
175
176
177
            # Input parameter: return the list of variables of this type
            input_name = unicode(self).split('(')[0].strip().lower()
            asn1_filter = [sig['type'] for sig in CONTEXT.input_signals if
                           sig['name'] == input_name]
            return variables_autocompletion(self, asn1_filter)
Maxime Perrotin's avatar
Maxime Perrotin committed
178
        else:
179
180
181
            # 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
182

Maxime Perrotin's avatar
Maxime Perrotin committed
183

184
185
186
class Connect(Input):
    ''' Connect point below a nested state '''
    common_name = 'connect_part'
Maxime Perrotin's avatar
Maxime Perrotin committed
187
188
189
190
    auto_expand = False
    resizeable = False
    # Symbol must not use antialiasing, otherwise the middle line is too thick
    _antialiasing = False
Maxime Perrotin's avatar
Maxime Perrotin committed
191

Maxime Perrotin's avatar
Maxime Perrotin committed
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
    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

208

Maxime Perrotin's avatar
Maxime Perrotin committed
209
# pylint: disable=R0904
210
class Output(VerticalSymbol):
Maxime Perrotin's avatar
Maxime Perrotin committed
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
    ''' 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()
        super(Output, self).__init__(parent=parent,
                text=ast.inputString, x=ast.pos_x, y=ast.pos_y,
                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
245
246
247
248
249
250
    @property
    def completion_list(self):
        ''' Set auto-completion list '''
        return chain(variables_autocompletion(self),
                    (sig['name'] for sig in CONTEXT.output_signals))

Maxime Perrotin's avatar
Maxime Perrotin committed
251
252

# pylint: disable=R0904
253
class Decision(VerticalSymbol):
Maxime Perrotin's avatar
Maxime Perrotin committed
254
255
    ''' SDL DECISION Symbol '''
    _unique_followers = ['Comment']
Maxime Perrotin's avatar
Maxime Perrotin committed
256
257
    _insertable_followers = ['DecisionAnswer', 'Task', 'ProcedureCall',
                             'Output', 'Decision', 'Label']
Maxime Perrotin's avatar
Maxime Perrotin committed
258
259
260
261
262
263
    _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
Maxime Perrotin's avatar
Maxime Perrotin committed
264
    #completion_list = {'length', 'present'}
Maxime Perrotin's avatar
Maxime Perrotin committed
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288

    def __init__(self, parent=None, ast=None):
        ast = ast or ogAST.Decision()
        # 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,
                x=ast.pos_x, y=ast.pos_y, hyperlink=ast.hyperlink)
        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
289
        return True
Maxime Perrotin's avatar
Maxime Perrotin committed
290

Maxime Perrotin's avatar
Maxime Perrotin committed
291
292
293
294
295
    @property
    def completion_list(self):
        ''' Set auto-completion list '''
        return chain(variables_autocompletion(self), ('length', 'present'))

Maxime Perrotin's avatar
Maxime Perrotin committed
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
    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 '''
329
        LOG.debug('UpdateConnectionPointPosition of {}'.format(unicode(self)))
Maxime Perrotin's avatar
Maxime Perrotin committed
330
331
332
333
334
335
336
337
338
339
340
341
342
        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)))
343
344
                # Don't set parent item to None to avoid Qt segfault
                last_cnx.setParentItem(self)
Maxime Perrotin's avatar
Maxime Perrotin committed
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
            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:
                child.moveBy(0, delta)
            except AttributeError:
                pass
        self.update_connections()


# pylint: disable=R0904
379
class DecisionAnswer(HorizontalSymbol):
Maxime Perrotin's avatar
Maxime Perrotin committed
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
    ''' 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
    completion_list = set()

    def __init__(self, parent=None, ast=None):
        ast = ast or ogAST.Answer()
        # temp, FIXME
        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,
                text=ast.inputString,
                x=ast.pos_x, y=ast.pos_y, hyperlink=ast.hyperlink)
        self.set_shape(ast.width, ast.height)
        #self.setPen(QColor(0, 0, 0, 0))
        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
        # Make sure that parent is a state, not a sibling input
        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
414
415
        self.last_branch_item.connectionBelow = \
                JoinConnection(self.last_branch_item, item_parent)
Maxime Perrotin's avatar
Maxime Perrotin committed
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436

    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
        point = width / 2.85
        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)


# pylint: disable=R0904
437
class Join(VerticalSymbol):
Maxime Perrotin's avatar
Maxime Perrotin committed
438
439
    ''' JOIN symbol (GOTO) '''
    auto_expand = False
Maxime Perrotin's avatar
Maxime Perrotin committed
440
    arrow_head = 'simple'
Maxime Perrotin's avatar
Maxime Perrotin committed
441
442
443
444
445
446
447
448
    common_name = 'terminator_statement'
    # Define reserved keywords for the syntax highlighter
    blackbold = SDL_BLACKBOLD
    redbold = SDL_REDBOLD
    completion_list = set()

    def __init__(self, parent=None, ast=None):
        if not ast:
449
            ast = ogAST.Terminator(defName='')
Maxime Perrotin's avatar
Maxime Perrotin committed
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
            ast.pos_y = 0
            ast.width = 35
            ast.height = 35
        super(Join, self).__init__(parent, text=ast.inputString,
                x=ast.pos_x, y=ast.pos_y, hyperlink=ast.hyperlink)
        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
465
        super(Join, self).resize_item(rect)
Maxime Perrotin's avatar
Maxime Perrotin committed
466
467
468
469
470
471
472
473
474
475

    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)


476
class ProcedureStop(Join):
Maxime Perrotin's avatar
Maxime Perrotin committed
477
478
479
480
    ''' 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
481

Maxime Perrotin's avatar
Maxime Perrotin committed
482
483
    def __init__(self, parent=None, ast=None):
        if not ast:
484
            ast = ogAST.Terminator(defName='')
Maxime Perrotin's avatar
Maxime Perrotin committed
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
            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)
502
        path.lineTo(point4)
Maxime Perrotin's avatar
Maxime Perrotin committed
503
504
505
506
        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
507
508
509
510
511
    @property
    def completion_list(self):
        ''' Set auto-completion list '''
        return variables_autocompletion(self)

Maxime Perrotin's avatar
Maxime Perrotin committed
512
513

# pylint: disable=R0904
514
class Label(VerticalSymbol):
Maxime Perrotin's avatar
Maxime Perrotin committed
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
    ''' 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
    completion_list = set()

    def __init__(self, parent=None, ast=None):
        ast = ast or ogAST.Label()
        super(Label, self).__init__(parent, text=ast.inputString,
                x=ast.pos_x, y=ast.pos_y, hyperlink=ast.hyperlink)
        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 '''
        #print traceback.print_stack()
        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)


# pylint: disable=R0904
562
class Task(VerticalSymbol):
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
587
588
589
590
591
592
593
594
595
    ''' 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()
        super(Task, self).__init__(parent, text=ast.inputString,
                x=ast.pos_x, y=ast.pos_y, 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, 0)
        path.lineTo(width, height)
        path.lineTo(0, height)
        path.lineTo(0, 0)
        self.setPath(path)
        super(Task, self).set_shape(width, height)

596
597
    @property
    def completion_list(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
598
599
600
        ''' Set auto-completion list '''
        return chain(variables_autocompletion(self),
                    ogParser.SPECIAL_OPERATORS.viewkeys())
601

Maxime Perrotin's avatar
Maxime Perrotin committed
602
603

# pylint: disable=R0904
604
class ProcedureCall(VerticalSymbol):
Maxime Perrotin's avatar
Maxime Perrotin committed
605
606
607
608
609
610
611
612
613
614
615
616
    ''' 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):
617
        ast = ast or ogAST.Output(defName='')
Maxime Perrotin's avatar
Maxime Perrotin committed
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
        super(ProcedureCall, self).__init__(parent,
                text=ast.inputString, x=ast.pos_x, y=ast.pos_y,
                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.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
639
640
641
642
643
644
645
    @property
    def completion_list(self):
        ''' Set auto-completion list '''
        return chain((proc.inputString for proc in CONTEXT.procedures),
                     variables_autocompletion(self),
                     ('set_timer', 'reset_timer', 'write', 'writeln'))

Maxime Perrotin's avatar
Maxime Perrotin committed
646
647

# pylint: disable=R0904
648
class TextSymbol(HorizontalSymbol):
Maxime Perrotin's avatar
Maxime Perrotin committed
649
650
651
652
653
654
    ''' 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
Maxime Perrotin's avatar
Maxime Perrotin committed
655
    #completion_list = set()
Maxime Perrotin's avatar
Maxime Perrotin committed
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672

    def __init__(self, ast=None):
        ''' Create a Text Symbol '''
        ast = ast or ogAST.TextArea()
        super(TextSymbol, self).__init__(parent=None,
                text=ast.inputString,
                x=ast.pos_x, y=ast.pos_y, hyperlink=ast.hyperlink)
        self.set_shape(ast.width, ast.height)
        self.setBrush(QBrush(QColor(249, 249, 249)))
        self.terminal_symbol = False
        self.setPos(ast.pos_x, ast.pos_y)
        # 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
673
    def update_completion_list(self, pr_text):
Maxime Perrotin's avatar
Maxime Perrotin committed
674
675
        ''' When text was entered, update TASK completion list '''
        # Get AST for the symbol
Maxime Perrotin's avatar
Maxime Perrotin committed
676
        ast, _, _, _, _ = self.parser.parseSingleElement('text_area', pr_text)
677
        #Task.completion_list |= {dcl for dcl in ast.variables.keys()}
Maxime Perrotin's avatar
Maxime Perrotin committed
678

Maxime Perrotin's avatar
Maxime Perrotin committed
679
680
681
    @property
    def completion_list(self):
        ''' Set auto-completion list '''
682
683
684
685
686
687
688
        res = set(CONTEXT.global_timers + CONTEXT.timers)
        try:
            res = res.union(AST.dataview.keys())
        except AttributeError:
            # No Dataview
            pass
        return res
Maxime Perrotin's avatar
Maxime Perrotin committed
689

Maxime Perrotin's avatar
Maxime Perrotin committed
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
    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',
                 'IMPORTS', 'FROM', 'SIZE', 'CHOICE', 'BOOLEAN')]


# pylint: disable=R0904
721
class State(VerticalSymbol):
Maxime Perrotin's avatar
Maxime Perrotin committed
722
723
    ''' SDL STATE Symbol '''
    _unique_followers = ['Comment']
Maxime Perrotin's avatar
Maxime Perrotin committed
724
    _insertable_followers = ['Input', 'Connect']
Maxime Perrotin's avatar
Maxime Perrotin committed
725
    arrow_head = 'simple'
Maxime Perrotin's avatar
Maxime Perrotin committed
726
727
728
729
730
731
732
733
    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()
Maxime Perrotin's avatar
Maxime Perrotin committed
734
        ast.inputString = getattr(ast, 'via', None) or ast.inputString
Maxime Perrotin's avatar
Maxime Perrotin committed
735
736
737
738
739
740
741
742
743
744
        # Note: ast coordinates are in scene coordinates
        super(State, self).__init__(parent=parent,
                text=ast.inputString, x=ast.pos_x, y=ast.pos_y,
                hyperlink=ast.hyperlink)
        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
Maxime Perrotin's avatar
Maxime Perrotin committed
745
746
                self.setPos(self.pos()
                            + self.mapFromScene(ast.pos_x, ast.pos_y))
Maxime Perrotin's avatar
Maxime Perrotin committed
747
748
749
750
751
752
753
754
755
            except TypeError:
                self.update_position()
        else:
            # Use scene coordinates to position
            self.setPos(ast.pos_x, ast.pos_y)
        self.parser = ogParser
        if ast.comment:
            Comment(parent=self, ast=ast.comment)

756
757
758
    @property
    def allow_nesting(self):
        ''' Redefinition - must be checked according to context '''
Maxime Perrotin's avatar
Maxime Perrotin committed
759
        result = not any(elem in unicode(self).lower().strip()
Maxime Perrotin's avatar
Maxime Perrotin committed
760
                       for elem in ('-', ',', '*'))
761
762
763
764
765
766
767
        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
768
769
770
    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
771
            if unicode(self).split()[0].lower() == unicode(each):
Maxime Perrotin's avatar
Maxime Perrotin committed
772
773
774
775
776
                self.nested_scene = value
                break
        else:
            self.nested_scene = None

777
778
779
780
781
    @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
782
    def update_completion_list(self, pr_text):
Maxime Perrotin's avatar
Maxime Perrotin committed
783
        ''' When text was entered, update state completion list '''
784
        # Get AST for the symbol and update the context dictionnary
Maxime Perrotin's avatar
Maxime Perrotin committed
785
        ast, _, _, _, _ = self.parser.parseSingleElement('state', pr_text)
786
787
        for each in ast.statelist:
            CONTEXT.mapping[each] = None
Maxime Perrotin's avatar
Maxime Perrotin committed
788

Maxime Perrotin's avatar
Maxime Perrotin committed
789
790
791
    @property
    def completion_list(self):
        ''' Set auto-completion list '''
792
        return set(state for state in CONTEXT.mapping if state != 'START')
Maxime Perrotin's avatar
Maxime Perrotin committed
793
794
795
796
797

    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
798
799
800
801

        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
802
        else:
Maxime Perrotin's avatar
Maxime Perrotin committed
803
            self.setPen(QPen(Qt.SolidLine))
Maxime Perrotin's avatar
Maxime Perrotin committed
804
805
806
        self.setPath(path)
        super(State, self).set_shape(width, height)

Maxime Perrotin's avatar
Maxime Perrotin committed
807
    def get_ast(self, pr_text):
Maxime Perrotin's avatar
Maxime Perrotin committed
808
        ''' Redefinition of the get_ast function for the state '''
Maxime Perrotin's avatar
Maxime Perrotin committed
809
810
811
        ast, _, _, _, terminators = self.parser.parseSingleElement('state',
                                                                   pr_text)
        return ast, terminators
812

813
814
815
816
817
818
    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
819
820


821
822
823
824
825
826
827
828
829
830
831
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
    blackbold = SDL_BLACKBOLD
    redbold = SDL_REDBOLD
    completion_list = set()
    is_singleton = True
Maxime Perrotin's avatar
Maxime Perrotin committed
832
833
    arrow_head = 'angle'
    arrow_tail = 'angle'
834
835
836
837
838
839
840
841
842
843
844
845
846
847

    def __init__(self, ast=None, subscene=None):
        ast = ast or ogAST.Process()
        super(Process, self).__init__(parent=None,
                                      text=ast.processName,
                                      x=ast.pos_x,
                                      y=ast.pos_y,
                                      hyperlink=ast.hyperlink)
        self.set_shape(ast.width, ast.height)
        self.setBrush(QBrush(QColor(255, 255, 202)))
        self.parser = ogParser
        if ast.comment:
            Comment(parent=self, ast=ast.comment)
        self.nested_scene = subscene
848
849
850
        self.input_signals = ast.input_signals
        self.output_signals = ast.output_signals
        self.insert_symbol(None, self.x(), self.y())
851

Maxime Perrotin's avatar
Maxime Perrotin committed
852
853
854
    def insert_symbol(self, parent, x, y):
        ''' Redefinition - adds connection line to env '''
        super(Process, self).insert_symbol(parent, x, y)
855
856
        if not self.connection:
            self.connection = self.connect_to_parent()
Maxime Perrotin's avatar
Maxime Perrotin committed
857
858

    def connect_to_parent(self):
859
860
        ''' Redefinition: creates connection to env with a signalroute '''
        return Signalroute(self)
Maxime Perrotin's avatar
Maxime Perrotin committed
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):
        ''' Compute the polygon to fit in width, height '''
        path = QPainterPath()
        path.moveTo(7, 0)
        path.lineTo(0, 7)
        path.lineTo(0, height - 7)
        path.lineTo(7, height)
        path.lineTo(width - 7, height)
        path.lineTo(width, height - 7)
        path.lineTo(width, 7)
        path.lineTo(width - 7, 0)
        path.lineTo(7, 0)
        self.setPath(path)
        super(Process, self).set_shape(width, height)


class Procedure(Process):
    ''' Procedure declaration symbol - Very similar to Process '''
Maxime Perrotin's avatar
Maxime Perrotin committed
880
    _unique_followers = ['Comment']
881
    _allow_nesting = True
Maxime Perrotin's avatar
Maxime Perrotin committed
882
883
884
885
886
887
    common_name = 'procedure'
    needs_parent = False
    # Define reserved keywords for the syntax highlighter
    blackbold = SDL_BLACKBOLD
    redbold = SDL_REDBOLD
    completion_list = set()
888
    is_singleton = False
Maxime Perrotin's avatar
Maxime Perrotin committed
889
890
891

    def __init__(self, ast=None, subscene=None):
        ast = ast or ogAST.Procedure()
892
        super(Process, self).__init__(parent=None,
Maxime Perrotin's avatar
Maxime Perrotin committed
893
894
895
896
897
898
899
900
                text=ast.inputString,
                x=ast.pos_x, y=ast.pos_y, hyperlink=ast.hyperlink)
        self.set_shape(ast.width, ast.height)
        self.setBrush(QBrush(QColor(255, 255, 202)))
        self.parser = ogParser
        if ast.comment:
            Comment(parent=self, ast=ast.comment)
        self.nested_scene = subscene
Maxime Perrotin's avatar
Maxime Perrotin committed
901

Maxime Perrotin's avatar
Maxime Perrotin committed
902
903
904
    def insert_symbol(self, parent, x, y):
        ''' Redefinition - no connection line to env '''
        super(Process, self).insert_symbol(parent, x, y)
Maxime Perrotin's avatar
Maxime Perrotin committed
905
906
907
908
909
910
911
912
913
914
915
916
917
918

    def set_shape(self, width, height):
        ''' Compute the polygon to fit in width, height '''
        path = QPainterPath()
        path.addRect(7, 0, width - 14, height)
        path.moveTo(7, 0)
        path.lineTo(0, 7)
        path.lineTo(0, height - 7)
        path.lineTo(7, height)
        path.moveTo(width - 7, 0)
        path.lineTo(width, 7)
        path.lineTo(width, height - 7)
        path.lineTo(width - 7, height)
        self.setPath(path)
Maxime Perrotin's avatar
Maxime Perrotin committed
919
        super(Process, self).set_shape(width, height)
Maxime Perrotin's avatar
Maxime Perrotin committed
920

Maxime Perrotin's avatar
Maxime Perrotin committed
921
    def update_completion_list(self, **kwargs):
Maxime Perrotin's avatar
Maxime Perrotin committed
922
        ''' When text was entered, update completion list of ProcedureCall '''
Maxime Perrotin's avatar
Maxime Perrotin committed
923
        ProcedureCall.completion_list |= {unicode(self.text)}
Maxime Perrotin's avatar
Maxime Perrotin committed
924
925
926


# pylint: disable=R0904
927
class Start(HorizontalSymbol):
Maxime Perrotin's avatar
Maxime Perrotin committed
928
929
930
931
932
933
934
935
936
937
938
939
    ''' SDL START Symbol '''
    _unique_followers = ['Comment']
    _insertable_followers = [
            'Task', 'ProcedureCall', 'Output', 'Decision', 'Label']
    _terminal_followers = ['Join', 'State', 'ProcedureStop']
    # There cannot be more than one START symbol in a scene
    is_singleton = True
    common_name = 'start'
    needs_parent = False
    # Define reserved keywords for the syntax highlighter
    blackbold = SDL_BLACKBOLD
    redbold = SDL_REDBOLD
Maxime Perrotin's avatar
Maxime Perrotin committed
940
    has_text_area = False
Maxime Perrotin's avatar
Maxime Perrotin committed
941
942
943
944
945

    def __init__(self, ast=None):
        ''' Create the START symbol '''
        ast = ast or ogAST.Start()
        self.terminal_symbol = False
946
        super(Start, self).__init__(parent=None,
947
                                    text=ast.inputString[slice(0, -6)],
948
949
                                    x=ast.pos_x, y=ast.pos_y,
                                    hyperlink=ast.hyperlink)
Maxime Perrotin's avatar
Maxime Perrotin committed
950
951
952
953
954
955
956
957
        self.set_shape(ast.width, ast.height)
        self.setBrush(QBrush(QColor(255, 228, 213)))
        # No hyperlink for START symbol because it has no text
        self._no_hyperlink = True
        self.parser = ogParser
        if ast.comment:
            Comment(parent=self, ast=ast.comment)

Maxime Perrotin's avatar
Maxime Perrotin committed
958
    def __unicode__(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
959
        ''' User cannot enter text in the START symbol - Return dummy text '''
Maxime Perrotin's avatar
Maxime Perrotin committed
960
        return u'START'
Maxime Perrotin's avatar
Maxime Perrotin committed
961
962
963
964
965
966
967
968
969

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


970
class ProcedureStart(Start):
Maxime Perrotin's avatar
Maxime Perrotin committed
971
972
973
974
    ''' Start symbol of a procedure - only shape differs from Start '''
    # Define reserved keywords for the syntax highlighter
    blackbold = SDL_BLACKBOLD
    redbold = SDL_REDBOLD
975
    common_name = 'proc_start'
Maxime Perrotin's avatar
Maxime Perrotin committed
976
977
978
979
980
981
982
983
984
985
986

    def set_shape(self, width, height):
        ''' Compute the polygon to fit in width, height '''
        path = QPainterPath()
        path.addRoundedRect(0, 0, width, height, height / 2, height / 2)
        path.moveTo(min(width / 2, height / 2), 0)
        path.lineTo(min(width / 2, height / 2), height)
        path.moveTo(max(width / 2, width - height / 2), 0)
        path.lineTo(max(width / 2, width - height / 2), height)
        self.setPath(path)
        super(Start, self).set_shape(width, height)
987
988
989
990


class StateStart(Start):
    ''' Composite states can have several named START symbols '''
Maxime Perrotin's avatar
Maxime Perrotin committed
991
992
    has_text_area = True
    is_singleton = False
993
    common_name = 'state_start'
Maxime Perrotin's avatar
Maxime Perrotin committed
994

Maxime Perrotin's avatar
Maxime Perrotin committed
995
    def __unicode__(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
996
        ''' Return the state entry point '''
Maxime Perrotin's avatar
Maxime Perrotin committed
997
        return unicode(self.text)