opengeode.py 128 KB
Newer Older
Maxime Perrotin's avatar
Maxime Perrotin committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
#!/usr/bin/env python
# -*- coding: utf-8 -*-

# pylint: disable=C0302
"""
    OpenGEODE - A tiny, free SDL Editor for TASTE

    SDL is the Specification and Description Language (Z100 standard from ITU)

    Copyright (c) 2012-2013 European Space Agency

    Designed and implemented by Maxime Perrotin

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

import signal
import sys
import os
import argparse
import logging
import traceback
import re
import code
import pprint
26
import random
Maxime Perrotin's avatar
Maxime Perrotin committed
27
from functools import partial
Maxime Perrotin's avatar
Maxime Perrotin committed
28
from itertools import chain
Maxime Perrotin's avatar
Maxime Perrotin committed
29

Maxime Perrotin's avatar
Maxime Perrotin committed
30
31
32
# To freeze the application on Windows, all modules must be imported even
# when they are not directly used from this module (py2exe bug)
# NOQA makes flake8 ignore locally-ununsed modules
Maxime Perrotin's avatar
Maxime Perrotin committed
33
# pylint: disable=W0611
34
import enum  # NOQA
35
import string  # NOQA
36
import fnmatch  # NOQA
37
import operator  # NOQA
38
import subprocess  # NOQA
Maxime Perrotin's avatar
Maxime Perrotin committed
39
import distutils  # NOQA
40
41
42
import tempfile  # NOQA
import uuid  # NOQA
import importlib  # NOQA
Maxime Perrotin's avatar
Maxime Perrotin committed
43
44
45
46
47
48
49
50
51
52
53
54
import antlr3  # NOQA
import antlr3.tree  # NOQA
import importlib  # NOQA
import PySide  # NOQA
import PySide.QtCore  # NOQA
import PySide.QtGui  # NOQA
import PySide.QtUiTools  # NOQA
import undoCommands  # NOQA
import sdl92Lexer  # NOQA
import sdl92Parser  # NOQA
import genericSymbols  # NOQA
import PySide.QtXml  # NOQA
55
56
import singledispatch  # NOQA
import Asn1scc  # NOQA
Maxime Perrotin's avatar
Maxime Perrotin committed
57
import Connectors  # NOQA
58
import TextInteraction  # NOQA
Maxime Perrotin's avatar
Maxime Perrotin committed
59
60
61
62
63
64
65
66
67
68
69
70
import pygraphviz  # NOQA
import sdlSymbols
import AdaGenerator
import ogParser
import ogAST
import Renderer
import Clipboard
import Statechart
import Lander
import Helper
import Pr
import CGenerator
71
import QGenSDL
Maxime Perrotin's avatar
Maxime Perrotin committed
72

Maxime Perrotin's avatar
Maxime Perrotin committed
73
74
# Enable mypy type checking
try:
Maxime Perrotin's avatar
Maxime Perrotin committed
75
    from typing import List, Union, Dict, Set, Any, Tuple
Maxime Perrotin's avatar
Maxime Perrotin committed
76
77
78
except ImportError:
    pass

Maxime Perrotin's avatar
Maxime Perrotin committed
79
80
81
82
try:
    import stringtemplate3  # NOQA
except ImportError:
    pass
Maxime Perrotin's avatar
Maxime Perrotin committed
83
84
85
86

#from PySide import phonon

from PySide import QtGui, QtCore
87
from PySide.QtCore import (Qt, QSize, QFile, QIODevice, QRectF, QTimer, QPoint,
Maxime Perrotin's avatar
Maxime Perrotin committed
88
                           QPointF, QLineF, QFileInfo)
Maxime Perrotin's avatar
Maxime Perrotin committed
89
90
91
92

from PySide.QtUiTools import QUiLoader
from PySide import QtSvg

Maxime Perrotin's avatar
Maxime Perrotin committed
93
from genericSymbols import(Symbol, Comment, Cornergrabber, Connection, Channel)
Maxime Perrotin's avatar
Maxime Perrotin committed
94
95
from sdlSymbols import(Input, Output, Decision, DecisionAnswer, Task,
        ProcedureCall, TextSymbol, State, Start, Join, Label, Procedure,
96
        ProcedureStart, ProcedureStop, StateStart, Connect, Process,
97
        ContinuousSignal, ProcessType)
98
from TextInteraction import EditableText
Maxime Perrotin's avatar
Maxime Perrotin committed
99
100
101
102

# Icons and png files generated from the resource file:
import icons  # NOQA

Maxime Perrotin's avatar
Maxime Perrotin committed
103
# Logging: ist of properly loaded modules that will use it
Maxime Perrotin's avatar
Maxime Perrotin committed
104
LOG = logging.getLogger(__name__)
Maxime Perrotin's avatar
Maxime Perrotin committed
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
MODULES = [
    sdlSymbols,
    genericSymbols,
    ogAST,
    ogParser,
    Lander,
    AdaGenerator,
    undoCommands,
    Renderer,
    Clipboard,
    Statechart,
    Helper,
    Asn1scc,
    Connectors,
    Pr,
    TextInteraction,
    Connectors,
    CGenerator,
123
    QGenSDL,
Maxime Perrotin's avatar
Maxime Perrotin committed
124
] # type: List[module]
125

126
127
128
# Define custom UserRoles
ANCHOR = Qt.UserRole + 1

129

Maxime Perrotin's avatar
Maxime Perrotin committed
130
131
try:
    import LlvmGenerator
Maxime Perrotin's avatar
Maxime Perrotin committed
132
    MODULES.append(LlvmGenerator)
Maxime Perrotin's avatar
Maxime Perrotin committed
133
except ImportError:
Maxime Perrotin's avatar
Maxime Perrotin committed
134
    pass
Maxime Perrotin's avatar
Maxime Perrotin committed
135

Maxime Perrotin's avatar
Maxime Perrotin committed
136
137
try:
    import StgBackend
Maxime Perrotin's avatar
Maxime Perrotin committed
138
    MODULES.append(StgBackend)
Maxime Perrotin's avatar
Maxime Perrotin committed
139
except ImportError:
Maxime Perrotin's avatar
Maxime Perrotin committed
140
    pass
Maxime Perrotin's avatar
Maxime Perrotin committed
141
142


Maxime Perrotin's avatar
Maxime Perrotin committed
143
__all__ = ['opengeode', 'SDL_Scene', 'SDL_View', 'parse']
Maxime Perrotin's avatar
Maxime Perrotin committed
144
__version__ = '2.0.22'
Maxime Perrotin's avatar
Maxime Perrotin committed
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179

if hasattr(sys, 'frozen'):
    # Detect if we are running on Windows (py2exe-generated)
    try:
        CUR_DIR = os.path.dirname(unicode
                (sys.executable, sys.getfilesystemencoding()))
    except TypeError:
        CUR_DIR = os.path.dirname(os.path.realpath(__file__))
    else:
        # Redirect stderr to a log file - to avoid py2exe error message
        # that pops up at application closure when app logs errors
        sys.stdout = open('opengeode_stdout.log', 'w')
        sys.stderr = open('opengeode_stderr.log', 'w')
else:
    CUR_DIR = os.path.dirname(os.path.realpath(__file__))


# Global handling all top-level elements
# It seems that if we don't keep a global list of these elements
# (START, STATE, and Text symbols)
# they sometimes get destroyed and disappear from the scene.
# As if a GC was deleting these object *even if they belong to the scene*
# (but have no parentItem). Most likely a Qt/Pyside bug.
G_SYMBOLS = set()


# Other Qt bug:
# QGraphicsTextItem don't stand that their parent item (usually an
# SDL symbol) is removed from the scene (scene.removeItem()). It
# provokes segfault when application exits.
# Workaround is to use hide()/show() to make items disappear
# from the scene (when deleted). Seems OK (MP 2013-03-26)

# Lookup table used to configure the context-dependent toolbars
ACTIONS = {
180
    'block': [Process, ProcessType, Comment, TextSymbol],
181
182
183
    'process': [Start, State, Input, Connect, ContinuousSignal, Task, Decision,
                DecisionAnswer, Output, ProcedureCall, TextSymbol, Comment,
                Label, Join, Procedure],
Maxime Perrotin's avatar
Maxime Perrotin committed
184
185
186
    'procedure': [ProcedureStart, Task, Decision,
                  DecisionAnswer, Output, ProcedureCall, TextSymbol,
                  Comment, Label, Join, ProcedureStop],
187
    'statechart': [],
188
189
190
    'state': [StateStart, State, Input, Connect, ContinuousSignal, Task,
              Decision, DecisionAnswer, Output, ProcedureCall, TextSymbol,
              Comment, Label, Join, ProcedureStop, Procedure],
Maxime Perrotin's avatar
Maxime Perrotin committed
191
192
    'clipboard': [Start, State, Input, Connect, Task, Decision, DecisionAnswer,
                  Output, ProcedureCall, TextSymbol, Comment, Label,
193
194
                  Join, Procedure, Process, StateStart, ProcedureStop,
                  ContinuousSignal],
Maxime Perrotin's avatar
Maxime Perrotin committed
195
196
    'lander': [],
    'asn1': []
Maxime Perrotin's avatar
Maxime Perrotin committed
197
198
199
}


200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
def log_errors(window, errors, warnings, clearfirst=True):
    ''' Report Error and Warnings on the console and in the log window '''
    if window and clearfirst:
        window.clear()
    for error in errors:
        if type(error[0]) == list:
            # should be fixed now, CHECKME - NO, NOT FULLY FIXED
            # problem is in decision answers branches
            error[0] = 'Internal error - ' + str(error[0])
        LOG.error(error[0])
        item = QtGui.QListWidgetItem(u'[ERROR] ' + error[0])
        if len(error) == 3:
            item.setData(Qt.UserRole, error[1])
            #found = self.scene().symbol_near(QPoint(*error[1]), 1)
            # Pyside bug: setData cannot store 'found' directly
            #item.setData(Qt.UserRole + 1, id(found))
            item.setData(Qt.UserRole + 1, error[2])
        if window:
            window.addItem(item)
    for warning in warnings:
        LOG.warning(warning[0])
        item = QtGui.QListWidgetItem(u'[WARNING] ' + str(warning[0]))
        if len(warning) == 3:
            item.setData(Qt.UserRole, warning[1])
            item.setData(Qt.UserRole + 1, warning[2])
        if window:
            window.addItem(item)
    if not errors and not warnings and window:
        window.addItem('No errors, no warnings!')



Maxime Perrotin's avatar
Maxime Perrotin committed
232
233
234
235
236
class Vi_bar(QtGui.QLineEdit, object):
    ''' Line editor for the Vi-like command mode '''
    def __init__(self):
        ''' Create the bar - no need for parent '''
        super(Vi_bar, self).__init__()
237
238
        self.history = []
        self.pointer = 0
Maxime Perrotin's avatar
Maxime Perrotin committed
239
240

    def keyPressEvent(self, key_event):
241
        ''' Handle key press - Escape, command history '''
Maxime Perrotin's avatar
Maxime Perrotin committed
242
243
244
        super(Vi_bar, self).keyPressEvent(key_event)
        if key_event.key() == Qt.Key_Escape:
            self.clearFocus()
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
            self.pointer = len(self.history)
        elif key_event.key() == Qt.Key_Return:
            self.history.append(self.text())
            self.pointer = len(self.history)
        elif key_event.key() == Qt.Key_Up:
            if self.text() and self.text() not in self.history:
                self.history.insert(self.pointer + 1, self.text())
            self.pointer = max(0, self.pointer - 1)
            try:
                self.setText(self.history[self.pointer])
            except IndexError as err:
                pass
        elif key_event.key() == Qt.Key_Down:
            self.pointer = min(len(self.history), self.pointer + 1)
            try:
                self.setText(self.history[self.pointer])
            except IndexError:
                pass
            pass
Maxime Perrotin's avatar
Maxime Perrotin committed
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304


class File_toolbar(QtGui.QToolBar, object):
    ''' Toolbar with file open, save, etc '''
    def __init__(self, parent):
        ''' Create the toolbar using standard icons '''
        super(File_toolbar, self).__init__(parent)
        self.setMovable(False)
        self.setFloatable(False)
        self.new_button = self.addAction(self.style().standardIcon(
            QtGui.QStyle.SP_FileIcon), 'New model')
        self.open_button = self.addAction(self.style().standardIcon(
            QtGui.QStyle.SP_DialogOpenButton), 'Open model')
        self.save_button = self.addAction(self.style().standardIcon(
            QtGui.QStyle.SP_DialogSaveButton), 'Save model')
        self.check_button = self.addAction(self.style().standardIcon(
            QtGui.QStyle.SP_DialogApplyButton), 'Check model')
        self.addSeparator()
        # Up arrow to come back from a subscene (e.g. procedure)
        self.up_button = self.addAction(self.style().standardIcon(
            QtGui.QStyle.SP_ArrowUp), 'Go one level above')
        self.up_button.setEnabled(False)


class Sdl_toolbar(QtGui.QToolBar, object):
    '''
        Toolbar with SDL symbols
        The list of symbols is passed as paramters at creation time ; the class
        looks for icons for the name of the symbols and .png extension.
        The buttons activation is context dependent. Configuration is done
        directly at symbol leval (using the "allowed_followers" property)
    '''
    def __init__(self, parent):
        ''' Create the toolbar, get icons and link actions '''
        super(Sdl_toolbar, self).__init__(parent)
        self.setMovable(False)
        self.setFloatable(False)
        self.setIconSize(QSize(35, 35))
        self.actions = {}

    def set_actions(self, bar_items):
Maxime Perrotin's avatar
Maxime Perrotin committed
305
        ''' Set the icons and actions on the toolbar '''
Maxime Perrotin's avatar
Maxime Perrotin committed
306
307
308
309
310
        self.actions = {}
        self.clear()
        for item in bar_items:
            item_name = item.__name__
            self.actions[item_name] = self.addAction(
Maxime Perrotin's avatar
Maxime Perrotin committed
311
312
                           QtGui.QIcon(':icons/{}.png'
                                       .format(item_name.lower())), item_name)
Maxime Perrotin's avatar
Maxime Perrotin committed
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
        self.update_menu()

    def enable_action(self, action):
        ''' Used as a slot to allow a scene to enable a menu action,
            e.g. if the Start symbol is deleted, the Start button
            shall be activated '''
        self.actions[action].setEnabled(True)

    def disable_action(self, action):
        ''' See description in enable_action '''
        self.actions[action].setEnabled(False)

    def update_menu(self, scene=None):
        ''' Context-dependent enabling/disabling of menu buttons '''
        try:
Maxime Perrotin's avatar
Maxime Perrotin committed
328
            selection = list(scene.selected_symbols)
Maxime Perrotin's avatar
Maxime Perrotin committed
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
        except AttributeError:
            selection = []
        if not selection:
            # Second chance, check if an item has focus (editable text)
            try:
                selection.append(scene.focusItem().parentItem())
            except AttributeError:
                pass
        if len(selection) > 1:
            # When several items are selected, disable all menu entries
            for _, action in self.actions.viewitems():
                action.setEnabled(False)
        elif not selection:
            # When nothing is selected:
            # activate everything, and when user selects an icon,
            # keep the action on hold until he clicks on the scene
            for action in self.actions.viewkeys():
                self.actions[action].setEnabled(True)

            # Check for singletons (e.g. START symbol)
            try:
Maxime Perrotin's avatar
Maxime Perrotin committed
350
                for item in scene.visible_symb:
Maxime Perrotin's avatar
Maxime Perrotin committed
351
                    try:
352
                        if item.is_singleton:
Maxime Perrotin's avatar
Maxime Perrotin committed
353
354
355
356
357
358
359
360
361
362
363
                            self.actions[
                                    item.__class__.__name__].setEnabled(False)
                    except (AttributeError, KeyError) as error:
                        LOG.debug(str(error))
            except AttributeError:
                pass
        else:
            # Only one selected item
            selection, = selection
            for action in self.actions.viewkeys():
                self.actions[action].setEnabled(False)
364
            for action in getattr(selection, 'allowed_followers', []):
Maxime Perrotin's avatar
Maxime Perrotin committed
365
366
367
                try:
                    self.actions[action].setEnabled(True)
                except KeyError:
368
369
                    pass
                    #LOG.debug('No menu item for symbol "' + action + '"')
Maxime Perrotin's avatar
Maxime Perrotin committed
370
371
372
373
374
375


class SDL_Scene(QtGui.QGraphicsScene, object):
    ''' Main graphic scene (canvas) where the user can place SDL symbols '''
    # Signal to be emitted when the scene is left (e.g. UP button)
    scene_left = QtCore.Signal()
376
    context_change = QtCore.Signal()
Maxime Perrotin's avatar
Maxime Perrotin committed
377

378
    def __init__(self, context='process', readonly=False):
379
380
381
382
383
        ''' Create a Scene for a given context:
            process, procedure, composite state, clipboard, etc.
            Design note: creating subclasses per context was evaluated but
            rejected - there are too few behavioural differences between them
            Creating tons of files / classes is not right. Keep it simple.
384
385
            "readonly" is a command line argument that allows to prevent some
            scenes to be modified by the user.
386
        '''
Maxime Perrotin's avatar
Maxime Perrotin committed
387
        super(SDL_Scene, self).__init__()
Maxime Perrotin's avatar
Maxime Perrotin committed
388
389
        # Reference to the parent scene
        self.parent_scene = None
390
391
        # mode can be "idle", "wait_connection_source", "select_items",
        # "wait_next_connection_point", "wait_placement"
Maxime Perrotin's avatar
Maxime Perrotin committed
392
393
        self.mode = 'idle'
        self.context = context
Maxime Perrotin's avatar
Maxime Perrotin committed
394
        self.allowed_symbols = ACTIONS[context]
395
396
        self.readonly = readonly
        self.set_readonly(readonly)
Maxime Perrotin's avatar
Maxime Perrotin committed
397
398
399
400
401
402
403
404
405
406
407
408
409
        # Configure the action menu
        all_possible_actions = set()
        for action in ACTIONS.viewvalues():
            all_possible_actions |= set(action)
        self.actions = {action.__name__: partial(self.add_symbol, action)
                for action in all_possible_actions}

        # Create a stack for handling undo/redo commands
        # (defined in undoCommands.py)
        self.undo_stack = QtGui.QUndoStack(self)
        # buttonSelected is used to set which symbol to draw
        # on next scene click (see mousePressEvent)
        self.button_selected = None
410
411
        self.setBackgroundBrush(QtGui.QBrush(
                                           QtGui.QImage(':icons/texture.png')))
412
        self.messages_window = QtGui.QListWidget()  # default
Maxime Perrotin's avatar
Maxime Perrotin committed
413
        self.click_coordinates = None
414
        self.orig_pos = None
415
        # When connecting symbols, store list of intermediate points
416
        self.edge_points = []   # type: List[QPointF] in scene coordinates
417
        self.temp_lines = []    # type: List[QGraphicsLineItem]
Maxime Perrotin's avatar
Maxime Perrotin committed
418
        self.process_name = 'opengeode'
Maxime Perrotin's avatar
Maxime Perrotin committed
419
420
        # Scene name is used to update the tab window name when scene changes
        self.name = ''
Maxime Perrotin's avatar
Maxime Perrotin committed
421
422
423
424
425
        # search_item/search_pattern are used for search/replace function
        self.search_item = None
        self.search_pattern = None
        # Selection rectangle when user clicks on the scene and moves mouse
        self.select_rect = None
Maxime Perrotin's avatar
Maxime Perrotin committed
426
427
        # Keep a list of composite states: {'stateName': SDL_Scene}
        self._composite_states = {}
428
429
        # Keep a track of highlighted symbols: { symbol: brush }
        self.highlighted = {}
430
        self.refresh_requested = False
431
432
        # Flag indicating the presence of unsolved semantic errors in the model
        self.semantic_errors = False
Maxime Perrotin's avatar
Maxime Perrotin committed
433

434
435
436
437
    def close(self):
        ''' close function is needed by py.test-qt '''
        pass

438
439
    def set_readonly(self, readonly=True):
        ''' Set the current scene as read-only, discard all new actions '''
Maxime Perrotin's avatar
Maxime Perrotin committed
440
        if self.context == 'process' and readonly:
441
442
443
444
            # only applies to 1st level hierarchy (process) allowing to have
            # unmodifiable list of DCL and STATES at the 1st level of hierarchy
            ACTIONS[self.context] = []
            #self.allowed_symbols = [] if readonly else ACTIONS[self.context]
445

446
447
448
449
450
451
452
453
454
455
    def is_aggregation(self):
        ''' Determine if the current scene is a state aggregation, i.e. if
        if contains only floating states without children
        '''
        for each in self.visible_symb:
            if each.hasParent:
                return False
            if not isinstance(each, State):
                # At the moment do not support Text Areas
                return False
Maxime Perrotin's avatar
Maxime Perrotin committed
456
            if any(child for child in each.childSymbols()
457
458
459
460
461
                    if isinstance(child, (Input, ContinuousSignal))):
                return False
        return True


Maxime Perrotin's avatar
Maxime Perrotin committed
462
463
464
    @property
    def visible_symb(self):
        ''' Return the visible items of a scene '''
Maxime Perrotin's avatar
Maxime Perrotin committed
465
466
467
        return (it for it in self.items() if it.isVisible() and
                isinstance(it, Symbol))

468

Maxime Perrotin's avatar
Maxime Perrotin committed
469
470
471
472
473
    @property
    def editable_texts(self):
        ''' Return all EditableText areas of a scene '''
        return (it for it in self.items() if it.isVisible() and
                isinstance(it, EditableText))
Maxime Perrotin's avatar
Maxime Perrotin committed
474

475

Maxime Perrotin's avatar
Maxime Perrotin committed
476
477
478
479
    @property
    def floating_symb(self):
        ''' Return the top level floating items of a scene '''
        return (it for it in self.visible_symb if not it.hasParent)
Maxime Perrotin's avatar
Maxime Perrotin committed
480

481

482
483
484
    @property
    def processes(self):
        ''' Return visible processes components of the scene '''
485
486
487
        return (it for it in self.visible_symb
                if (isinstance(it, Process) and not isinstance(it, Procedure))
                or isinstance(it, ProcessType))
488

489

490
491
492
493
494
    @property
    def procedures(self):
        ''' Return visible procedures components of the scene '''
        return (it for it in self.visible_symb if isinstance(it, Procedure))

495

Maxime Perrotin's avatar
Maxime Perrotin committed
496
497
498
499
500
    @property
    def states(self):
        ''' Return visible state components of the scene '''
        return (it for it in self.visible_symb if isinstance(it, State))

501

Maxime Perrotin's avatar
Maxime Perrotin committed
502
503
504
505
506
    @property
    def texts(self):
        ''' Return visible text areas components of the scene '''
        return (it for it in self.visible_symb if isinstance(it, TextSymbol))

507

Maxime Perrotin's avatar
Maxime Perrotin committed
508
509
510
511
512
    @property
    def procs(self):
        ''' Return visible procedure declaration components of the scene '''
        return (it for it in self.visible_symb if isinstance(it, Procedure))

513

Maxime Perrotin's avatar
Maxime Perrotin committed
514
515
516
517
518
    @property
    def start(self):
        ''' Return visible start components of the scene '''
        return (it for it in self.visible_symb if isinstance(it, Start))

519

Maxime Perrotin's avatar
Maxime Perrotin committed
520
521
522
    @property
    def floating_labels(self):
        ''' Return visible floating label components of the scene '''
Maxime Perrotin's avatar
Maxime Perrotin committed
523
        return (it for it in self.floating_symb if isinstance(it, Label))
Maxime Perrotin's avatar
Maxime Perrotin committed
524

525

Maxime Perrotin's avatar
Maxime Perrotin committed
526
527
528
529
530
531
    @property
    def returns(self):
        ''' Return visible return components of the scene '''
        return (it for it in self.visible_symb if isinstance(it,
                                                              ProcedureStop))

532

Maxime Perrotin's avatar
Maxime Perrotin committed
533
534
535
    @property
    def composite_states(self):
        ''' Return states that contain a composite part '''
Maxime Perrotin's avatar
Maxime Perrotin committed
536
537
538
539
        # Update the list first
        for each in self.states:
            if each.is_composite() and \
                  each.nested_scene not in self._composite_states.viewvalues():
Maxime Perrotin's avatar
Maxime Perrotin committed
540
                self._composite_states[unicode(each).split()[0].lower()] = \
Maxime Perrotin's avatar
Maxime Perrotin committed
541
                                                            each.nested_scene
Maxime Perrotin's avatar
Maxime Perrotin committed
542
543
        return self._composite_states

544

Maxime Perrotin's avatar
Maxime Perrotin committed
545
546
    @composite_states.setter
    def composite_states(self, value):
547
        ''' Attribute setter '''
Maxime Perrotin's avatar
Maxime Perrotin committed
548
549
        self._composite_states = value

550

Maxime Perrotin's avatar
Maxime Perrotin committed
551
552
553
554
    @property
    def all_nested_scenes(self):
        ''' Return all nested scenes, recursively '''
        for each in self.visible_symb:
555
            if each.nested_scene and isinstance(each.nested_scene, SDL_Scene):
Maxime Perrotin's avatar
Maxime Perrotin committed
556
557
558
                yield each.nested_scene
                for sub in each.nested_scene.all_nested_scenes:
                    yield sub
Maxime Perrotin's avatar
Maxime Perrotin committed
559

560

561
562
563
564
565
566
567
568
569
570
    @property
    def path(self):
        ''' Get the path to the current scene as a list
        e.g. ['BLOCK a', 'PROCESS b', ...]
        '''
        if not self.parent_scene:
            return [self.name[0:-3]]
        return self.parent_scene.path + [self.name[0:-3]]


Maxime Perrotin's avatar
Maxime Perrotin committed
571
572
573
574
575
576
577
578
579
    @property
    def selected_symbols(self):
        ''' Generate the list of selected symbols (excluding grabbers) '''
        for selection in self.selectedItems():
            if isinstance(selection, Symbol):
                yield selection
            elif isinstance(selection, Cornergrabber):
                yield selection.parent

580

Maxime Perrotin's avatar
Maxime Perrotin committed
581
582
583
584
    def quit_scene(self):
        ''' Called in case of scene switch (e.g. UP button) '''
        pass

585

586
    def render_everything(self, ast):
Maxime Perrotin's avatar
Maxime Perrotin committed
587
        ''' Render a process and its children scenes, recursively '''
Maxime Perrotin's avatar
Maxime Perrotin committed
588
        already_created = []
589

Maxime Perrotin's avatar
Maxime Perrotin committed
590
        def recursive_render(content, dest_scene):
591
592
593
594
            ''' Process the rendering in scenes and nested scenes '''
            if isinstance(content, ogAST.Process):
                # XXX - should be set when entering the process
                self.process_name = ast.processName
Maxime Perrotin's avatar
Maxime Perrotin committed
595

596
597
598
599
            try:
                # Render top-level items and their children:
                for each in Renderer.render(content, dest_scene):
                    G_SYMBOLS.add(each)
600
601
                # Refreshing the scene may result in resizing some symbols
                dest_scene.refresh()
602
603
604
605
606
                # Once everything is rendered, adjust position of each
                # symbol to the value from the AST (positions may be
                # slightly altered by the reshaping functions)
                def fix_pos_from_ast(symbol):
                    try:
607
608
                        if(symbol.ast.pos_x is not None
                                and symbol.ast.pos_y is not None):
609
610
611
612
613
                            relpos = symbol.mapFromScene(symbol.ast.pos_x,
                                                         symbol.ast.pos_y)
                            if not symbol.hasParent:
                                symbol.pos_x = symbol.ast.pos_x
                                symbol.pos_y = symbol.ast.pos_y
614
                            else:
615
616
617
618
619
620
621
622
623
                                symbol.position += relpos
                            symbol.update_connections()
                            # Update_position is called here because it
                            # is not possible to be sure that the
                            # positionning stored in the file will be
                            # rendered correctly on the host plaform.
                            # Font rendering may cause slight differences
                            # between Linux and Windows for example.
                            symbol.update_position()
Maxime Perrotin's avatar
Maxime Perrotin committed
624
                        else:
625
626
627
628
629
630
631
632
633
634
635
                            # No CIF coordinates: fix COMMENT position
                            if isinstance(symbol, genericSymbols.Comment):
                                symbol.pos_x = \
                                  symbol.parent.boundingRect().width() + 15
                                symbol.pos_y = 0
                            if not symbol.hasParent:
                                sc_br = dest_scene.itemsBoundingRect()
                                sy_br = symbol.mapRectToScene(
                                            symbol.boundingRect() |
                                            symbol.childrenBoundingRect())
                                symbol.pos_x += (sc_br.width() - sy_br.x())
636
                    except AttributeError as err:
637
638
                        # no AST, ignore (e.g. Connections, Cornergrabbers)
                        pass
639
                        #LOG.debug("[render everything] " + str(err))
640
641
642
643
644
645
646
647
648
                    else:
                        # Recursively fix pos of sub branches and followers
                        for branch in (elm for elm in symbol.childSymbols()
                                   if isinstance(elm,
                                         genericSymbols.HorizontalSymbol)):
                            fix_pos_from_ast(branch)
                        fix_pos_from_ast(symbol.next_aligned_symbol())
                        fix_pos_from_ast(symbol.comment)
                map(fix_pos_from_ast, dest_scene.floating_symb)
649
            except TypeError:
650
                LOG.error(traceback.format_exc())
Maxime Perrotin's avatar
Maxime Perrotin committed
651
652
653
654

            # Render nested scenes, recursively:
            for each in (item for item in dest_scene.visible_symb
                         if item.nested_scene):
655
                LOG.debug(u'Recursive scene: ' + unicode(each))
Maxime Perrotin's avatar
Maxime Perrotin committed
656
657
658
659
                if isinstance(each.nested_scene, ogAST.CompositeState) \
                        and (not each.nested_scene.statename
                             or each.nested_scene in already_created):
                    # Ignore nested state scenes that already exist
660
                    LOG.debug('Subscene "{}" ignored'.format(unicode(each)))
Maxime Perrotin's avatar
Maxime Perrotin committed
661
                    continue
662
                subscene = \
663
                        self.create_subscene(each.context_name,
664
                                             dest_scene)
665

Maxime Perrotin's avatar
Maxime Perrotin committed
666
                already_created.append(each.nested_scene)
667
                subscene.name = unicode(each)
Maxime Perrotin's avatar
Maxime Perrotin committed
668
                LOG.debug('Created scene: {}'.format(subscene.name))
Maxime Perrotin's avatar
Maxime Perrotin committed
669
670
671
672
673
674
                recursive_render(each.nested_scene.content, subscene)
                each.nested_scene = subscene

            # Make sure all composite states are initially up to date
            # (Needed for the symbol shape to have dashed lines)
            for each in dest_scene.states:
Maxime Perrotin's avatar
Maxime Perrotin committed
675
                if unicode(each).lower() in \
Maxime Perrotin's avatar
Maxime Perrotin committed
676
                        dest_scene.composite_states.viewkeys():
Maxime Perrotin's avatar
Maxime Perrotin committed
677
                    each.nested_scene = dest_scene.composite_states[
Maxime Perrotin's avatar
Maxime Perrotin committed
678
                                                         unicode(each).lower()]
Maxime Perrotin's avatar
Maxime Perrotin committed
679

680
681
682
683
684
            # Readonly user flag
            if dest_scene.context == 'process' and dest_scene.readonly:
                for each in dest_scene.editable_texts:
                    each.setTextInteractionFlags(Qt.NoTextInteraction)

685
        recursive_render(ast, self)
Maxime Perrotin's avatar
Maxime Perrotin committed
686

687

Maxime Perrotin's avatar
Maxime Perrotin committed
688
    def refresh(self):
689
        ''' Scene refresh - make sure it happens only once per cycle '''
Maxime Perrotin's avatar
Maxime Perrotin committed
690
691
        #LOG.debug('scene refresh requested by '
        #          + str(traceback.extract_stack(limit=2)[-2][1:3]))
692
693
694
695
696
        if not self.refresh_requested:
            self.refresh_requested = True
            QTimer.singleShot(0, self.scene_refresh)

    def scene_refresh(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
697
        ''' Refresh the symbols and connections in the scene '''
698
        self.refresh_requested = False
Maxime Perrotin's avatar
Maxime Perrotin committed
699
700
701
702
        #LOG.debug('scene refresh done')
#       for symbol in self.visible_symb:
#           symbol.updateConnectionPointPosition()
#           symbol.updateConnectionPoints()
Maxime Perrotin's avatar
Maxime Perrotin committed
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
        for symbol in self.editable_texts:
            # EditableText refreshing - design explanation:
            # The first one is tricky: at symbol initialization,
            # the bounding rect of the text is computed from the raw
            # text value, without any formatting. However, it can
            # happen that text (especially when a model is loaded)
            # contains highlighted data (bold), which has the effect
            # of making the width of the text in fact wider than
            # the bounding rect. The set_text_alignment function,
            # that is applying the aligment of the text within its
            # bounding rect, can work only if the text width is fixed.
            # It has to set it according to the bounding rect, which,
            # therefore can be too small, and this has the effect of
            # pushing the exceeding character to the next line.
            # The only way to avoid this is to call setTextWidth
            # with the value -1 before the aligment is computed.
            # This has the effect of re-computing the bounding rect
            # and fixing the width issue.
            symbol.setTextWidth(-1)
Maxime Perrotin's avatar
Maxime Perrotin committed
722
            #symbol.set_textbox_position()
Maxime Perrotin's avatar
Maxime Perrotin committed
723
724
725
726
            symbol.try_resize()
            symbol.set_text_alignment()
        for symbol in self.visible_symb:
            symbol.update_connections()
Maxime Perrotin's avatar
Maxime Perrotin committed
727

728

Maxime Perrotin's avatar
Maxime Perrotin committed
729
730
731
732
733
734
735
736
737
738
739
740
    def set_cursor(self, follower):
        ''' Set the cursor shape depending on the selected menu item '''
        for item in self.items():
            try:
                if follower.__name__ not in item.allowed_followers:
                    item.setCursor(Qt.ForbiddenCursor)
                else:
                    item.setCursor(Qt.PointingHandCursor)
            except AttributeError:
                # if there are items not having allowed_followers
                pass

741

Maxime Perrotin's avatar
Maxime Perrotin committed
742
743
744
745
746
747
748
749
    def reset_cursor(self):
        ''' Reset the default cursor of an item '''
        for item in self.items():
            try:
                item.setCursor(item.default_cursor)
            except AttributeError:
                pass

750

Maxime Perrotin's avatar
Maxime Perrotin committed
751
752
753
754
755
756
    def translate_to_origin(self):
        '''
            Translate all items to coordinate system starting at (0,0),
            in order to avoid negative coordinates
        '''
        try:
757
758
            min_x = min(item.scenePos().x() for item in self.visible_symb)
            min_y = min(item.scenePos().y() for item in self.visible_symb)
Maxime Perrotin's avatar
Maxime Perrotin committed
759
760
        except ValueError:
            # No item in the scene
761
            return 0, 0
Maxime Perrotin's avatar
Maxime Perrotin committed
762
763
764
        delta_x = -min_x if min_x < 0 else 0
        delta_y = -min_y if min_y < 0 else 0
        for item in self.floating_symb:
765
766
            item.pos_x += delta_x
            item.pos_y += delta_y
Maxime Perrotin's avatar
Maxime Perrotin committed
767
768
        return delta_x, delta_y

769

Maxime Perrotin's avatar
Maxime Perrotin committed
770
771
772
    def set_selection(self, toolbar):
        ''' When the selection has changed, update menu, etc '''
        toolbar.update_menu(self)
Maxime Perrotin's avatar
Maxime Perrotin committed
773
        for item in self.selected_symbols:
Maxime Perrotin's avatar
Maxime Perrotin committed
774
775
            item.grabber.display()

776
777
778
779
780
781
782
783
784
785

    def syntax_errors(self, symb):
        ''' Parse a symbol and return a list of syntax errors '''
        return symb.check_syntax('\n'.join(Pr.generate(symb, recursive=False)))


    def check_syntax(self, symbol):
        ''' Check syntax of a symbol and display a pop-up in case of errors '''
        errors = self.syntax_errors(symbol)

Maxime Perrotin's avatar
Maxime Perrotin committed
786
787
        if not errors:
            return
788

Maxime Perrotin's avatar
Maxime Perrotin committed
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
        for view in self.views():
            errs = []
            for error in errors:
                split = error.split()
                if split[0] == 'line' and len(split) > 1:
                    line_col = split[1].split(':')
                    if len(line_col) == 2:
                        # Get line number and column..to locate error
                        # line_nb, col = line_col
                        errs.append(' '.join(split[2:]))
                    else:
                        errs.append(error)
                else:
                    errs.append(error)
            self.clear_focus()
            msg_box = QtGui.QMessageBox(view)
            msg_box.setIcon(QtGui.QMessageBox.Warning)
            msg_box.setWindowTitle('OpenGEODE - Syntax Error')
            msg_box.setInformativeText('\n'.join(errs))
            msg_box.setText("Syntax error!")
            msg_box.setStandardButtons(QtGui.QMessageBox.Discard)
            msg_box.setDefaultButton(QtGui.QMessageBox.Discard)
            msg_box.exec_()

813

814
    def global_syntax_check(self, ignore=set()):
815
        ''' Parse each visible symbol in the current scene and its children
816
817
818
819
            and check syntax using the parser
            Use a mutable parameter to avoid recursion on already visited
            scenes
        '''
820
        res = True
821
822
        reset = not ignore
        ignore.add(self)
823
        for each in self.visible_symb:
824
825
826
827
828
829
830
831
832
833
834
835
836
            errors = self.syntax_errors(each)
            if errors:
                res = False
            for err in errors:
                split = err.split()
                if split[0] == 'line' and len(split) > 1:
                    line_col = split[1].split(':')
                    if len(line_col) == 2:
                        # get line and col. line must be decremented because
                        # line 1 is the CIF comment which is not visible
                        line_nb, col = line_col
                        line_nb = int(line_nb) - 1
                        split[1] = '{}:{}'.format(line_nb, col)
837
                pos = each.scenePos()
838
                split.append (u'in "{}"'.format(unicode(each)))
839
                fmt = [[' '.join(split), [pos.x(), pos.y()], self.path]]
840
841
842
                log_errors(self.messages_window, fmt, [], clearfirst=False)

        for each in self.all_nested_scenes:
843
844
845
846
847
            if each not in ignore:
                if not each.global_syntax_check():
                    res = False
        if reset:
            ignore.clear()
848
        return res
849

Maxime Perrotin's avatar
Maxime Perrotin committed
850
851
852
853
854

    def update_completion_list(self, symbol):
        ''' When text has changed on a symbol, update the data dictionnary '''
        pr_text = '\n'.join(Pr.generate(symbol,
                                        recursive=False,
855
                                        nextstate=False, cpy=True))
Maxime Perrotin's avatar
Maxime Perrotin committed
856
        symbol.update_completion_list(pr_text=pr_text)
857
        self.context_change.emit()
Maxime Perrotin's avatar
Maxime Perrotin committed
858

859

860
861
862
863
864
    def highlight(self, item):
        ''' Highlight a symbol '''
        if item in self.highlighted:
            return
        bound = item.boundingRect()
865
        center = bound.center().x()
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
        gradient = QtGui.QLinearGradient(center, 0, center, bound.height())
        gradient.setColorAt(0, Qt.cyan)
        gradient.setColorAt(1, Qt.white)
        self.highlighted[item] = item.brush()
        item.setBrush(QtGui.QBrush(gradient))

    def clear_highlight(self, item=None, reset=True):
        ''' Remove the highlighting of one item or all items on the scene '''
        if item in self.highlighted:
            self.setBrush(self.highlighted.pop(item))
        if reset:
            for item, brush in self.highlighted.viewitems():
                item.setBrush(brush)
            self.highlighted = {}

881

Maxime Perrotin's avatar
Maxime Perrotin committed
882
883
884
885
886
    def find_text(self, pattern):
        ''' Return all symbols with matching text '''
        for item in (symbol for symbol in self.items()
                     if isinstance(symbol, EditableText)
                     and symbol.isVisible()):
887
888
889
890
891
892
            try:
                res = re.search(pattern, unicode(item), flags=re.IGNORECASE)
            except re.error:
                # invalid pattern
                raise StopIteration
            if res:
893
                yield item
Maxime Perrotin's avatar
Maxime Perrotin committed
894

895

896
897
898
899
900
    def search(self, pattern, replace_with=None, cmd=None):
        ''' Search and replace function ; get next search result with key n
        cmd is a user string from the vi bar that by default for a replace
        is "s" (substittute string) but that can be a different command,
        e.g. "state" to limit the substitution to State components'''
Maxime Perrotin's avatar
Maxime Perrotin committed
901
        self.clearSelection()
902
        self.clear_highlight()
Maxime Perrotin's avatar
Maxime Perrotin committed
903
904
905
906
907
908
909
910
911
        self.clear_focus()
        if pattern.endswith('\\'):
            # Avoid buggy pattern ending with a single backslash
            pattern += '\\'
        self.search_item = self.find_text(pattern)
        self.search_pattern = pattern
        if replace_with:
            with undoCommands.UndoMacro(self.undo_stack, 'Search and Replace'):
                for item in self.search_item:
912
913
914
915
916
                    if(cmd and cmd != "s" and
                        item.parentItem().__class__.__name__.lower()
                                                               != cmd.lower()):
                        # filter symbols based on the user command
                        continue
Maxime Perrotin's avatar
Maxime Perrotin committed
917
918
                    new_string = re.sub(pattern,
                                        replace_with,
919
                                        unicode(item),
Maxime Perrotin's avatar
Maxime Perrotin committed
920
921
                                        flags=re.IGNORECASE)
                    undo_cmd = undoCommands.ReplaceText(
922
                                     item, unicode(item), new_string)
Maxime Perrotin's avatar
Maxime Perrotin committed
923
                    self.undo_stack.push(undo_cmd)
924
925
                    item.try_resize()
                    item.parentItem().select()
926
                    self.update_completion_list(item.parent)
Maxime Perrotin's avatar
Maxime Perrotin committed
927
928
929
930
            self.refresh()
        else:
            try:
                item = self.search_item.next()
931
                item = item.parentItem()
Maxime Perrotin's avatar
Maxime Perrotin committed
932
                item.select()
933
                self.highlight(item)
Maxime Perrotin's avatar
Maxime Perrotin committed
934
935
936
937
                item.ensureVisible()
            except StopIteration:
                LOG.info('Pattern not found')

938

Maxime Perrotin's avatar
Maxime Perrotin committed
939
940
941
942
    def delete_selected_symbols(self):
        '''
            Remove selected symbols from the scene, with proper re-connections
        '''
943
944
945
        if self.context == 'process' and self.readonly:
            # with readonly flag, forbid item delettion
            return
Maxime Perrotin's avatar
Maxime Perrotin committed
946
        self.undo_stack.beginMacro('Delete items')
Maxime Perrotin's avatar
Maxime Perrotin committed
947
        for item in self.selected_symbols:
Maxime Perrotin's avatar
Maxime Perrotin committed
948
949
950
951
952
953
954
955
956
957
958
959
960
            if not item.scene():
                # Ignore if item has already been deleted
                # (in case of multiple selection)
                continue
            undo_cmd = undoCommands.DeleteSymbol(item)
            self.undo_stack.push(undo_cmd)
            try:
                item.branchEntryPoint.parent.updateConnectionPointPosition()
                item.branchEntryPoint.parent.updateConnectionPoints()
            except AttributeError:
                pass
        self.undo_stack.endMacro()

961

Maxime Perrotin's avatar
Maxime Perrotin committed
962
963
964
965
966
967
968
    def copy_selected_symbols(self):
        '''
            Create a copy of selected symbols to a buffer (in AST form)
            Called when user presses Ctrl-C
        '''
        self.click_coordinates = None
        try:
Maxime Perrotin's avatar
Maxime Perrotin committed
969
            Clipboard.copy(self.selected_symbols)
Maxime Perrotin's avatar
Maxime Perrotin committed
970
971
        except TypeError as error_msg:
            try:
972
                self.messages_window.addItem(unicode(error_msg))
Maxime Perrotin's avatar
Maxime Perrotin committed
973
            except AttributeError:
974
                LOG.error(unicode(error_msg))
Maxime Perrotin's avatar
Maxime Perrotin committed
975
976
            raise

977

Maxime Perrotin's avatar
Maxime Perrotin committed
978
979
980
981
982
983
984
985
986
987
988
    def cut_selected_symbols(self):
        '''
            Create a copy of selected symbols, then delete them
        '''
        try:
            self.copy_selected_symbols()
        except TypeError:
            LOG.error('Copy error - Cannot cut')
        else:
            self.delete_selected_symbols()

989

Maxime Perrotin's avatar
Maxime Perrotin committed
990
991
992
993
    def paste_symbols(self):
        '''
            Paste previously copied symbols at selection point
        '''
994
        if self.context == 'process' and self.readonly:
995
            # with readonly flag, forbid item deletion
996
            return
Maxime Perrotin's avatar
Maxime Perrotin committed
997
        parent = list(self.selected_symbols)
Maxime Perrotin's avatar
Maxime Perrotin committed
998
999
1000
        if len(parent) > 1:
            self.messages_window.addItem(
                    'Cannot paste when several items are selected')
For faster browsing, not all history is shown. View entire blame