opengeode.py 95.5 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
71
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

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

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

#from PySide import phonon

from PySide import QtGui, QtCore
86
from PySide.QtCore import Qt, QSize, QFile, QIODevice, QRectF, QTimer, QPoint
Maxime Perrotin's avatar
Maxime Perrotin committed
87
88
89
90

from PySide.QtUiTools import QUiLoader
from PySide import QtSvg

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

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

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

Maxime Perrotin's avatar
Maxime Perrotin committed
123
124
try:
    import LlvmGenerator
Maxime Perrotin's avatar
Maxime Perrotin committed
125
    MODULES.append(LlvmGenerator)
Maxime Perrotin's avatar
Maxime Perrotin committed
126
except ImportError:
Maxime Perrotin's avatar
Maxime Perrotin committed
127
    pass
Maxime Perrotin's avatar
Maxime Perrotin committed
128

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


Maxime Perrotin's avatar
Maxime Perrotin committed
136
__all__ = ['opengeode', 'SDL_Scene', 'SDL_View', 'parse']
137
__version__ = '1.4.1'
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
169
170
171
172

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 = {
173
    'block': [Process, Comment, TextSymbol],
174
175
176
    'process': [Start, State, Input, Connect, ContinuousSignal, Task, Decision,
                DecisionAnswer, Output, ProcedureCall, TextSymbol, Comment,
                Label, Join, Procedure],
Maxime Perrotin's avatar
Maxime Perrotin committed
177
178
179
    'procedure': [ProcedureStart, Task, Decision,
                  DecisionAnswer, Output, ProcedureCall, TextSymbol,
                  Comment, Label, Join, ProcedureStop],
180
    'statechart': [],
181
182
183
    'state': [StateStart, State, Input, Connect, ContinuousSignal, Task,
              Decision, DecisionAnswer, Output, ProcedureCall, TextSymbol,
              Comment, Label, Join, ProcedureStop, Procedure],
Maxime Perrotin's avatar
Maxime Perrotin committed
184
185
    'clipboard': [Start, State, Input, Connect, Task, Decision, DecisionAnswer,
                  Output, ProcedureCall, TextSymbol, Comment, Label,
186
187
                  Join, Procedure, Process, StateStart, ProcedureStop,
                  ContinuousSignal],
Maxime Perrotin's avatar
Maxime Perrotin committed
188
189
    'lander': [],
    'asn1': []
Maxime Perrotin's avatar
Maxime Perrotin committed
190
191
192
}


193
194
195
196
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
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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
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__()

    def keyPressEvent(self, key_event):
        ''' Handle key press - in particular Escape '''
        super(Vi_bar, self).keyPressEvent(key_event)
        if key_event.key() == Qt.Key_Escape:
            self.clearFocus()


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):
        ''' Set the acons and actions on the toolbar '''
        self.actions = {}
        self.clear()
        for item in bar_items:
            item_name = item.__name__
            self.actions[item_name] = self.addAction(
                           QtGui.QIcon(':icons/{icon}'.format(
                           icon=item_name.lower() + '.png')), item_name)
        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
300
            selection = list(scene.selected_symbols)
Maxime Perrotin's avatar
Maxime Perrotin committed
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
        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
322
                for item in scene.visible_symb:
Maxime Perrotin's avatar
Maxime Perrotin committed
323
                    try:
324
                        if item.is_singleton:
Maxime Perrotin's avatar
Maxime Perrotin committed
325
326
327
328
329
330
331
332
333
334
335
                            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)
336
            for action in getattr(selection, 'allowed_followers', []):
Maxime Perrotin's avatar
Maxime Perrotin committed
337
338
339
340
341
342
343
344
345
346
347
348
                try:
                    self.actions[action].setEnabled(True)
                except KeyError:
                    LOG.debug('No menu item for symbol "' + action + '"')


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

    def __init__(self, context='process'):
349
350
351
352
        '''
            Create an SDL Scene for a given context:
            process, procedure or composite state
        '''
Maxime Perrotin's avatar
Maxime Perrotin committed
353
        super(SDL_Scene, self).__init__()
Maxime Perrotin's avatar
Maxime Perrotin committed
354
355
        # Reference to the parent scene
        self.parent_scene = None
Maxime Perrotin's avatar
Maxime Perrotin committed
356
357
        self.mode = 'idle'
        self.context = context
Maxime Perrotin's avatar
Maxime Perrotin committed
358
        self.allowed_symbols = ACTIONS[context]
Maxime Perrotin's avatar
Maxime Perrotin committed
359
360
361
362
363
364
365
366
367
368
369
370
371
        # 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
372
373
        self.setBackgroundBrush(QtGui.QBrush(
                                           QtGui.QImage(':icons/texture.png')))
Maxime Perrotin's avatar
Maxime Perrotin committed
374
375
        self.messages_window = None
        self.click_coordinates = None
376
        self.orig_pos = None
Maxime Perrotin's avatar
Maxime Perrotin committed
377
        self.process_name = 'opengeode'
Maxime Perrotin's avatar
Maxime Perrotin committed
378
379
        # Scene name is used to update the tab window name when scene changes
        self.name = ''
Maxime Perrotin's avatar
Maxime Perrotin committed
380
381
382
383
384
        # 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
385
386
        # Keep a list of composite states: {'stateName': SDL_Scene}
        self._composite_states = {}
387
388
        # Keep a track of highlighted symbols: { symbol: brush }
        self.highlighted = {}
Maxime Perrotin's avatar
Maxime Perrotin committed
389

390

391
392
393
394
395
396
397
398
399
400
    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
401
            if any(child for child in each.childSymbols()
402
403
404
405
406
                    if isinstance(child, (Input, ContinuousSignal))):
                return False
        return True


Maxime Perrotin's avatar
Maxime Perrotin committed
407
408
409
    @property
    def visible_symb(self):
        ''' Return the visible items of a scene '''
Maxime Perrotin's avatar
Maxime Perrotin committed
410
411
412
        return (it for it in self.items() if it.isVisible() and
                isinstance(it, Symbol))

413

Maxime Perrotin's avatar
Maxime Perrotin committed
414
415
416
417
418
    @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
419

420

Maxime Perrotin's avatar
Maxime Perrotin committed
421
422
423
424
    @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
425

426

427
428
429
430
431
432
    @property
    def processes(self):
        ''' Return visible processes components of the scene '''
        return (it for it in self.visible_symb if isinstance(it, Process) and
                not isinstance(it, Procedure))

433

434
435
436
437
438
    @property
    def procedures(self):
        ''' Return visible procedures components of the scene '''
        return (it for it in self.visible_symb if isinstance(it, Procedure))

439

Maxime Perrotin's avatar
Maxime Perrotin committed
440
441
442
443
444
    @property
    def states(self):
        ''' Return visible state components of the scene '''
        return (it for it in self.visible_symb if isinstance(it, State))

445

Maxime Perrotin's avatar
Maxime Perrotin committed
446
447
448
449
450
    @property
    def texts(self):
        ''' Return visible text areas components of the scene '''
        return (it for it in self.visible_symb if isinstance(it, TextSymbol))

451

Maxime Perrotin's avatar
Maxime Perrotin committed
452
453
454
455
456
    @property
    def procs(self):
        ''' Return visible procedure declaration components of the scene '''
        return (it for it in self.visible_symb if isinstance(it, Procedure))

457

Maxime Perrotin's avatar
Maxime Perrotin committed
458
459
460
461
462
    @property
    def start(self):
        ''' Return visible start components of the scene '''
        return (it for it in self.visible_symb if isinstance(it, Start))

463

Maxime Perrotin's avatar
Maxime Perrotin committed
464
465
466
    @property
    def floating_labels(self):
        ''' Return visible floating label components of the scene '''
Maxime Perrotin's avatar
Maxime Perrotin committed
467
        return (it for it in self.floating_symb if isinstance(it, Label))
Maxime Perrotin's avatar
Maxime Perrotin committed
468

469

Maxime Perrotin's avatar
Maxime Perrotin committed
470
471
472
473
474
475
    @property
    def returns(self):
        ''' Return visible return components of the scene '''
        return (it for it in self.visible_symb if isinstance(it,
                                                              ProcedureStop))

476

Maxime Perrotin's avatar
Maxime Perrotin committed
477
478
479
    @property
    def composite_states(self):
        ''' Return states that contain a composite part '''
Maxime Perrotin's avatar
Maxime Perrotin committed
480
481
482
483
        # 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
484
                self._composite_states[unicode(each).split()[0].lower()] = \
Maxime Perrotin's avatar
Maxime Perrotin committed
485
                                                            each.nested_scene
Maxime Perrotin's avatar
Maxime Perrotin committed
486
487
        return self._composite_states

488

Maxime Perrotin's avatar
Maxime Perrotin committed
489
490
    @composite_states.setter
    def composite_states(self, value):
491
        ''' Attribute setter '''
Maxime Perrotin's avatar
Maxime Perrotin committed
492
493
        self._composite_states = value

494

Maxime Perrotin's avatar
Maxime Perrotin committed
495
496
497
498
    @property
    def all_nested_scenes(self):
        ''' Return all nested scenes, recursively '''
        for each in self.visible_symb:
499
            if each.nested_scene and isinstance(each.nested_scene, SDL_Scene):
Maxime Perrotin's avatar
Maxime Perrotin committed
500
501
502
                yield each.nested_scene
                for sub in each.nested_scene.all_nested_scenes:
                    yield sub
Maxime Perrotin's avatar
Maxime Perrotin committed
503

504

505
506
507
508
509
510
511
512
513
514
    @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
515
516
517
518
519
520
521
522
523
    @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

524

Maxime Perrotin's avatar
Maxime Perrotin committed
525
526
527
528
    def quit_scene(self):
        ''' Called in case of scene switch (e.g. UP button) '''
        pass

529

530
    def render_everything(self, ast):
Maxime Perrotin's avatar
Maxime Perrotin committed
531
        ''' Render a process and its children scenes, recursively '''
Maxime Perrotin's avatar
Maxime Perrotin committed
532
        already_created = []
533

Maxime Perrotin's avatar
Maxime Perrotin committed
534
        def recursive_render(content, dest_scene):
535
536
537
538
            ''' 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
539

540
541
542
543
            try:
                # Render top-level items and their children:
                for each in Renderer.render(content, dest_scene):
                    G_SYMBOLS.add(each)
544
545
546
547
548
549
550
551
552
553
554
                # Refreshing the scene may result in resizing some symbols
                dest_scene.refresh()
                for each in dest_scene.floating_symb:
                    # 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:
                            if symbol.ast.pos_x and symbol.ast.pos_y:
                                relpos = symbol.mapFromScene(symbol.ast.pos_x,
                                                           symbol.ast.pos_y)
555
556
                                symbol.pos_x += relpos.x()
                                symbol.pos_y += relpos.y()
557
                                symbol.update_connections()
Maxime Perrotin's avatar
Maxime Perrotin committed
558
559
560
561
562
563
564
                                # 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()
565
566
                            else:
                                # No CIF coordinates: (1) fix COMMENT position
567
                                # and (2) if floating call CAM
568
569
570
571
572
                                if isinstance(symbol, genericSymbols.Comment):
                                    symbol.pos_x = \
                                      symbol.parent.boundingRect().width() + 15
                                    symbol.pos_y = 0
                                if not symbol.hasParent:
573
574
575
576
577
578
579
580
                                    #print 'Positionning', unicode(symbol)[slice(0,20)]
                                    sc_br = dest_scene.itemsBoundingRect()
                                    sy_br = symbol.mapRectToScene(
                                                symbol.boundingRect() |
                                                symbol.childrenBoundingRect())
                                    symbol.pos_x += (sc_br.width() - sy_br.x())
#                                   symbol.cam(symbol.position,
#                                              symbol.position)
581
                        except AttributeError:
Maxime Perrotin's avatar
Maxime Perrotin committed
582
                            # no AST, ignore (e.g. Connections, Cornergrabbers)
583
                            pass
Maxime Perrotin's avatar
Maxime Perrotin committed
584
                        else:
585
586
587
588
589
                            # 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)
Maxime Perrotin's avatar
Maxime Perrotin committed
590
591
                            fix_pos_from_ast(symbol.next_aligned_symbol())
                            fix_pos_from_ast(symbol.comment)
592
                    fix_pos_from_ast(each)
593
            except TypeError:
594
                LOG.error(traceback.format_exc())
Maxime Perrotin's avatar
Maxime Perrotin committed
595
596
597
598

            # Render nested scenes, recursively:
            for each in (item for item in dest_scene.visible_symb
                         if item.nested_scene):
599
                LOG.debug(u'Recursive scene: ' + unicode(each))
Maxime Perrotin's avatar
Maxime Perrotin committed
600
601
602
603
                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
604
                    LOG.debug('Subscene "{}" ignored'.format(unicode(each)))
Maxime Perrotin's avatar
Maxime Perrotin committed
605
                    continue
606
                subscene = \
607
608
                        self.create_subscene(each.__class__.__name__.lower(),
                                             dest_scene)
Maxime Perrotin's avatar
Maxime Perrotin committed
609
                already_created.append(each.nested_scene)
610
                subscene.name = unicode(each)
Maxime Perrotin's avatar
Maxime Perrotin committed
611
                LOG.debug('Created scene: {}'.format(subscene.name))
Maxime Perrotin's avatar
Maxime Perrotin committed
612
613
614
615
616
617
                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
618
                if unicode(each).lower() in \
Maxime Perrotin's avatar
Maxime Perrotin committed
619
                        dest_scene.composite_states.viewkeys():
Maxime Perrotin's avatar
Maxime Perrotin committed
620
                    each.nested_scene = dest_scene.composite_states[
Maxime Perrotin's avatar
Maxime Perrotin committed
621
                                                         unicode(each).lower()]
Maxime Perrotin's avatar
Maxime Perrotin committed
622

623
        recursive_render(ast, self)
Maxime Perrotin's avatar
Maxime Perrotin committed
624

625

Maxime Perrotin's avatar
Maxime Perrotin committed
626
627
    def refresh(self):
        ''' Refresh the symbols and connections in the scene '''
Maxime Perrotin's avatar
Maxime Perrotin committed
628
        LOG.debug('scene refresh')
Maxime Perrotin's avatar
Maxime Perrotin committed
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
        for symbol in self.visible_symb:
            symbol.updateConnectionPointPosition()
            symbol.updateConnectionPoints()
        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)
            symbol.set_textbox_position()
            symbol.try_resize()
            symbol.set_text_alignment()
        for symbol in self.visible_symb:
            symbol.update_connections()
Maxime Perrotin's avatar
Maxime Perrotin committed
656

657

Maxime Perrotin's avatar
Maxime Perrotin committed
658
659
660
661
662
663
664
665
666
667
668
669
    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

670

Maxime Perrotin's avatar
Maxime Perrotin committed
671
672
673
674
675
676
677
678
    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

679

Maxime Perrotin's avatar
Maxime Perrotin committed
680
681
682
683
684
685
686
687
688
689
    def translate_to_origin(self):
        '''
            Translate all items to coordinate system starting at (0,0),
            in order to avoid negative coordinates
        '''
        try:
            min_x = min(item.x() for item in self.floating_symb)
            min_y = min(item.y() for item in self.floating_symb)
        except ValueError:
            # No item in the scene
690
            return 0, 0
Maxime Perrotin's avatar
Maxime Perrotin committed
691
692
693
        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:
694
695
            item.pos_x += delta_x
            item.pos_y += delta_y
Maxime Perrotin's avatar
Maxime Perrotin committed
696
697
        return delta_x, delta_y

698

Maxime Perrotin's avatar
Maxime Perrotin committed
699
700
701
    def set_selection(self, toolbar):
        ''' When the selection has changed, update menu, etc '''
        toolbar.update_menu(self)
Maxime Perrotin's avatar
Maxime Perrotin committed
702
        for item in self.selected_symbols:
Maxime Perrotin's avatar
Maxime Perrotin committed
703
704
            item.grabber.display()

705
706
707
708
709
710
711
712
713
714

    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
715
716
        if not errors:
            return
717

Maxime Perrotin's avatar
Maxime Perrotin committed
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
        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_()

742

743
    def global_syntax_check(self, ignore=set()):
744
        ''' Parse each visible symbol in the current scene and its children
745
746
747
748
            and check syntax using the parser
            Use a mutable parameter to avoid recursion on already visited
            scenes
        '''
749
        res = True
750
751
        reset = not ignore
        ignore.add(self)
752
        for each in self.visible_symb:
753
754
755
756
757
758
759
760
761
762
763
764
765
            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)
766
767
                pos = each.scenePos()
                fmt = [[' '.join(split), [pos.x(), pos.y()], self.path]]
768
769
770
                log_errors(self.messages_window, fmt, [], clearfirst=False)

        for each in self.all_nested_scenes:
771
772
773
774
775
            if each not in ignore:
                if not each.global_syntax_check():
                    res = False
        if reset:
            ignore.clear()
776
        return res
777

Maxime Perrotin's avatar
Maxime Perrotin committed
778
779
780
781
782

    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,
783
                                        nextstate=False, cpy=True))
Maxime Perrotin's avatar
Maxime Perrotin committed
784
785
        symbol.update_completion_list(pr_text=pr_text)

786

787
788
789
790
791
    def highlight(self, item):
        ''' Highlight a symbol '''
        if item in self.highlighted:
            return
        bound = item.boundingRect()
792
        center = bound.center().x()
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
        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 = {}

808

Maxime Perrotin's avatar
Maxime Perrotin committed
809
810
811
812
813
    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()):
Maxime Perrotin's avatar
Maxime Perrotin committed
814
            if re.search(pattern, unicode(item), flags=re.IGNORECASE):
Maxime Perrotin's avatar
Maxime Perrotin committed
815
816
                yield item.parentItem()

817

Maxime Perrotin's avatar
Maxime Perrotin committed
818
819
820
821
822
823
824
825
826
827
828
829
830
831
    def search(self, pattern, replace_with=None):
        ''' Search and replace function ; get next search result with key n '''
        self.clearSelection()
        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:
                    new_string = re.sub(pattern,
                                        replace_with,
Maxime Perrotin's avatar
Maxime Perrotin committed
832
                                        unicode(item.text),
Maxime Perrotin's avatar
Maxime Perrotin committed
833
834
                                        flags=re.IGNORECASE)
                    undo_cmd = undoCommands.ReplaceText(
Maxime Perrotin's avatar
Maxime Perrotin committed
835
                                     item.text, unicode(item.text), new_string)
Maxime Perrotin's avatar
Maxime Perrotin committed
836
837
838
839
840
841
842
843
844
845
846
                    self.undo_stack.push(undo_cmd)
                    item.select()
            self.refresh()
        else:
            try:
                item = self.search_item.next()
                item.select()
                item.ensureVisible()
            except StopIteration:
                LOG.info('Pattern not found')

847

Maxime Perrotin's avatar
Maxime Perrotin committed
848
849
850
851
852
    def delete_selected_symbols(self):
        '''
            Remove selected symbols from the scene, with proper re-connections
        '''
        self.undo_stack.beginMacro('Delete items')
Maxime Perrotin's avatar
Maxime Perrotin committed
853
        for item in self.selected_symbols:
Maxime Perrotin's avatar
Maxime Perrotin committed
854
855
856
857
858
859
860
861
862
863
864
865
866
            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()

867

Maxime Perrotin's avatar
Maxime Perrotin committed
868
869
870
871
872
873
874
    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
875
            Clipboard.copy(self.selected_symbols)
Maxime Perrotin's avatar
Maxime Perrotin committed
876
877
        except TypeError as error_msg:
            try:
878
                self.messages_window.addItem(unicode(error_msg))
Maxime Perrotin's avatar
Maxime Perrotin committed
879
            except AttributeError:
880
                LOG.error(unicode(error_msg))
Maxime Perrotin's avatar
Maxime Perrotin committed
881
882
            raise

883

Maxime Perrotin's avatar
Maxime Perrotin committed
884
885
886
887
888
889
890
891
892
893
894
    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()

895

Maxime Perrotin's avatar
Maxime Perrotin committed
896
897
898
899
    def paste_symbols(self):
        '''
            Paste previously copied symbols at selection point
        '''
Maxime Perrotin's avatar
Maxime Perrotin committed
900
        parent = list(self.selected_symbols)
Maxime Perrotin's avatar
Maxime Perrotin committed
901
902
903
904
905
906
907
908
        if len(parent) > 1:
            self.messages_window.addItem(
                    'Cannot paste when several items are selected')
        else:
            parent_item, = parent or [None]
            try:
                new_items = Clipboard.paste(parent_item, self)
            except TypeError as error_msg:
909
910
911
912
913
                LOG.error(str(error_msg))
                try:
                    self.messages_window.addItem(str(error_msg))
                except AttributeError:
                    pass
Maxime Perrotin's avatar
Maxime Perrotin committed
914
915
916
917
            else:
                self.undo_stack.beginMacro('Paste')
                for item in new_items:
                    # Allow pasting inputs when input is selected
Maxime Perrotin's avatar
Maxime Perrotin committed
918
                    # Same for decision answers and connections
Maxime Perrotin's avatar
Maxime Perrotin committed
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
                    if(isinstance(parent_item, genericSymbols.HorizontalSymbol)
                            and type(parent_item) == type(item)):
                        parent_item = parent_item.parentItem()

                    undo_cmd = undoCommands.InsertSymbol(item, parent_item,
                            pos=None if parent_item
                                     else self.click_coordinates or item.pos())

                    self.undo_stack.push(undo_cmd)
                    if parent_item:
                        parent_item = item
                    else:
                        G_SYMBOLS.add(item)
                    item.cam(item.pos(), item.pos())
                self.undo_stack.endMacro()
                self.refresh()

936

937
    def sdl_to_statechart(self, basic=True):
Maxime Perrotin's avatar
Maxime Perrotin committed
938
        ''' Create a graphviz representation of the SDL model '''
Maxime Perrotin's avatar
Maxime Perrotin committed
939
        pr_raw = Pr.parse_scene(self)
Maxime Perrotin's avatar
Maxime Perrotin committed
940
        pr_data = unicode('\n'.join(pr_raw))
941
942
943
944
        ast, _, _ = ogParser.parse_pr(string=pr_data)
        try:
            process_ast, = ast.processes
        except ValueError:
945
            LOG.debug('No statechart to render')
946
            return None
947
948
949
950
        # Flatten nested states (no, because neato does not support it,
        # dot supports only vertically-aligned states, and fdp does not
        # support curved edges and is buggy with pygraphviz anyway)
        # Helper.flatten(process_ast)
951
        return Statechart.create_dot_graph(process_ast, basic)
Maxime Perrotin's avatar
Maxime Perrotin committed
952

953

Maxime Perrotin's avatar
Maxime Perrotin committed
954
955
    def export_branch_to_picture(self, symbol, filename, doc_format):
        ''' Save a symbol and its followers to a file '''
956
        temp_scene = SDL_Scene(context=self.context)
Maxime Perrotin's avatar
Maxime Perrotin committed
957
        temp_scene.messages_window = self.messages_window
Maxime Perrotin's avatar
Maxime Perrotin committed
958
959
960
961
962
963
964
965
966
        self.clearSelection()
        symbol.select()
        try:
            self.copy_selected_symbols()
            temp_scene.paste_symbols()
            temp_scene.export_img(filename, doc_format)
        except AttributeError:
            pass

967

Maxime Perrotin's avatar
Maxime Perrotin committed
968
969
970
971
972
973
974
975
976
977
978
    def export_img(self, filename=None, doc_format='png', split=False):
        ''' Save the scene as a PNG/SVG or PDF document
            If specified, split the diagram in multiple files, one
            per top-level floating item
        '''
        if not filename:
            return

        if split:
            # Save in multiple files
            index = 0
Maxime Perrotin's avatar
Maxime Perrotin committed
979
            for item in self.floating_symb:
980
                name = '{}-{}'.format(filename, str(index))
981
                LOG.info('Saving {ext} file: {name}.{ext}'
982
983
                         .format(ext=doc_format, name=name))
                self.export_branch_to_picture(item, name, doc_format)
Maxime Perrotin's avatar
Maxime Perrotin committed
984
985
986
987
988
989
990
                index += 1

        if filename.split('.')[-1] != doc_format:
            filename += '.' + doc_format

        self.clearSelection()
        self.clear_focus()
Maxime Perrotin's avatar
Maxime Perrotin committed
991
        # Copy in a different scene to get the smallest rectangle
992
        other_scene = SDL_Scene(context=self.context)
Maxime Perrotin's avatar
Maxime Perrotin committed
993
994
995
996
        other_scene.messages_window = self.messages_window
        other_scene.setBackgroundBrush(QtGui.QBrush())
        for each in self.floating_symb:
            each.select()
997
998
999
            try:
                self.copy_selected_symbols()
            except AttributeError as err:
1000
                LOG.debug(str(traceback.format_exc()))
1001
                LOG.error(str(err))
Maxime Perrotin's avatar
Maxime Perrotin committed
1002
1003
1004
1005
            other_scene.paste_symbols()
            each.select(False)
        rect = other_scene.sceneRect()

Maxime Perrotin's avatar
Maxime Perrotin committed
1006
1007
1008
1009
        # enlarge the rect to fit extra pixels due to antialiasing
        rect.adjust(-5, -5, 5, 5)
        if doc_format == 'png':
            device = QtGui.QImage(rect.size().toSize(),
Maxime Perrotin's avatar
Maxime Perrotin committed
1010
                                  QtGui.QImage.Format_ARGB32)
Maxime Perrotin's avatar
Maxime Perrotin committed
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
            device.fill(Qt.transparent)
        elif doc_format == 'svg':
            device = QtSvg.QSvgGenerator()
            device.setFileName(filename)
            device.setTitle('OpenGEODE SDL Diagram')
            device.setSize(rect.size().toSize())
        elif doc_format == 'pdf':
            device = QtGui.QPrinter()
            device.setOutputFormat(QtGui.QPrinter.PdfFormat)
            device.setPaperSize(
                    rect.size().toSize(), QtGui.QPrinter.Point)
            device.setFullPage(True)
            device.setOutputFileName(filename)
        else:
            LOG.error('Output format not supported: ' + doc_format)
        painter = QtGui.QPainter(device)
Maxime Perrotin's avatar
Maxime Perrotin committed
1027
        other_scene.render(painter, source=rect)
Maxime Perrotin's avatar
Maxime Perrotin committed
1028
1029
1030
1031
1032
1033
1034
1035
        try:
            device.save(filename)
        except AttributeError:
            # Due to inconsistencies in Qt API - only QtGui.QImage has the save
            pass
        if painter.isActive():
            painter.end()

1036

Maxime Perrotin's avatar
Maxime Perrotin committed
1037
1038
1039
1040
1041
1042
1043
1044
    def clear_focus(self):
        ''' Clear focus from any item on the scene '''
        try:
            self.focusItem().clearFocus()
        except AttributeError:
            # if no focus item
            pass

1045

Maxime Perrotin's avatar
Maxime Perrotin committed
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
    def symbol_near(self, pos, dist=5, selectable_only=True):
        ''' If any, returns symbol around pos '''
        items = self.items(
                QRectF(pos.x() - dist, pos.y() - dist, 2 * dist, 2 * dist))
        for item in items:
            if((selectable_only and item.flags() &
                    QtGui.QGraphicsItem.ItemIsSelectable)
                    or not selectable_only):
                return item.parent if isinstance(item, Cornergrabber) else item

1056

Maxime Perrotin's avatar
Maxime Perrotin committed
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
    def can_insert(self, pos, item_type):
        ''' Check if we can add an item type at a given position '''
        parent_item = self.symbol_near(pos)
        if not parent_item:
            # No symbol at the given position
            if item_type.needs_parent:
                raise TypeError(str(item_type.__name__) + ' needs a parent')
            else:
                return None
        else:
            # Check if item as pos accepts item type as follower
            if item_type.__name__ in parent_item.allowed_followers:
                return parent_item
            else:
                raise TypeError(parent_item.__class__.__name__ +
                                ' symbol cannot be followed by ' +
                                item_type.__name__)

1075

Maxime Perrotin's avatar
Maxime Perrotin committed
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
    def create_subscene(self, context, parent=None):
        ''' Create a new SDL scene, e.g. for nested symbols '''
        subscene = SDL_Scene(context=context)
        subscene.messages_window = self.messages_window
        subscene.parent_scene = parent
        return subscene


    def place_symbol(self, item_type, parent, pos=None):
        ''' Draw a symbol on the scene '''
        item = item_type()
        # Add the item to the scene
        if item not in self.items():
            self.addItem(item)
        # Create Undo command (makes the call to the insertSymbol function):
        undo_cmd = undoCommands.InsertSymbol(item=item, parent=parent, pos=pos)
        self.undo_stack.push(undo_cmd)
        # If no item is selected (e.g. new STATE), add it to the scene
        if not parent:
            G_SYMBOLS.add(item)

        if item_type == Decision:
            # When creating a new decision, add two default answers
            self.place_symbol(item_type=DecisionAnswer, parent=item)
            self.place_symbol(item_type=DecisionAnswer, parent=item)
        elif item_type in (Procedure, State, Process):
            # Create a sub-scene for clickable symbols
            item.nested_scene = \
                    self.create_subscene(item_type.__name__.lower(), self)

        self.clearSelection()
        self.clear_focus()
        item.select()
        item.cam(item.pos(), item.pos())
        # When item is placed, immediately set focus to input text
        item.edit_text()

        for view in self.views():
            view.refresh()
            view.ensureVisible(item)
        return item



    def add_symbol(self, item_type):
        ''' Add a symbol, or postpone until a parent symbol is selected  '''
        try:
            # If an item is selected or if its text has focus,
            # use it as parent item for the newly inserted item
            selection, = (list(self.selected_symbols) or
                          [self.focusItem().parentItem()])
            with undoCommands.UndoMacro(self.undo_stack, 'Place Symbol'):
                self.place_symbol(item_type=item_type, parent=selection)
        except (ValueError, AttributeError):
            # Menu item clicked but no symbol selected
            # -> store until user clicks on the scene
            self.messages_window.clear()
            self.messages_window.addItem(
                    'Click on the scene to place the symbol')
            self.button_selected = item_type
            if item_type == Connection:
                self.mode = 'wait_connection_source'
            else:
                self.mode = 'wait_placement'
            self.set_cursor(item_type)
            return None



Maxime Perrotin's avatar
Maxime Perrotin committed
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
    # pylint: disable=C0103
    def mousePressEvent(self, event):
        '''
            Handle mouse click on the scene:
            If a symbol was selected in the menu, check if it can be inserted
            Otherwise store the coordinates, in which case if the user does
            a paste action with floating items, they will be placed there.
        '''
        self.reset_cursor()
        # First propagate event to symbols for specific treatment
        super(SDL_Scene, self).mousePressEvent(event)
        # Store mouse coordinates as possible paste position
        self.click_coordinates = event.scenePos()
        # Enter state machine
        if self.mode == 'idle' and event.button() == Qt.LeftButton:
            # Idle mode: click triggers selection square
            nearby_connection = self.symbol_near(event.scenePos(),
                                                 selectable_only=False)
            connection_selected = False
Maxime Perrotin's avatar
Maxime Perrotin committed
1164
            if isinstance(nearby_connection, Connection):
Maxime Perrotin's avatar
Maxime Perrotin committed
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
                # Click near a connection - forward the event to it
                # (some connections like statechart Edges can react)
                nearby_connection.mousePressEvent(event)
                connection_selected = True
            if not self.symbol_near(event.scenePos(), dist=1):
                self.mode = 'select_items'
                self.orig_pos = event.scenePos()
                self.select_rect = self.addRect(
                        QRectF(self.orig_pos, self.orig_pos))
                if self.context == 'statechart' and not connection_selected:
                    # Specific treatment for statecharts - should subclass
                    for item in self.items():
                        # Remove all Edges control points from the scene
                        try:
                            item.bezier_set_visible(False)
                        except AttributeError:
                            pass

        elif self.mode == 'wait_placement':
            try:
1185
1186
                parent = \
                        self.can_insert(event.scenePos(), self.button_selected)
Maxime Perrotin's avatar
Maxime Perrotin committed
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
            except TypeError as err:
                self.messages_window.addItem(str(err))
            else:
                with undoCommands.UndoMacro(self.undo_stack, 'Place Symbol'):
                    item = self.place_symbol(
                            item_type=self.button_selected,
                            parent=parent,
                            pos=event.scenePos() if not parent else None)
            # self.button_selected = None
            self.mode = 'idle'
        elif self.mode == 'wait_connection_source':
            # Check location, and if ok:
            self.mode = 'wait_next_connection_point'
            # if not OK, reset and:
            self.mode = 'idle'

1203

Maxime Perrotin's avatar
Maxime Perrotin committed
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
    # pylint: disable=C0103
    def mouseMoveEvent(self, event):
        ''' Handle Click + Mouse move, based on the mode '''
        if event.buttons() == Qt.NoButton or self.mode == 'idle':
            return super(SDL_Scene, self).mouseMoveEvent(event)
        elif self.mode == 'select_items':
            rect = QRectF(self.orig_pos, event.scenePos())
            self.select_rect.setRect(rect.normalized())
        elif self.mode == 'wait_next_connection_point':
            # Update the line
            pass

1216

Maxime Perrotin's avatar
Maxime Perrotin committed
1217
1218
1219
    # pylint: disable=C0103
    def mouseReleaseEvent(self, event):
        if self.mode == 'select_items':
Maxime Perrotin's avatar
Maxime Perrotin committed
1220
            for item in self.items(self.select_rect.rect(),
Maxime Perrotin's avatar
Maxime Perrotin committed
1221
1222
1223
1224
1225
                    mode=Qt.ContainsItemBoundingRect):
                try:
                    item.select()
                except AttributeError:
                    pass
1226
1227
1228
            #self.removeItem(self.select_rect)
            # XXX stop with removeItem, it provokes segfault
            self.select_rect.hide()
Maxime Perrotin's avatar
Maxime Perrotin committed
1229
1230
1231
        self.mode = 'idle'
        super(SDL_Scene, self).mouseReleaseEvent(event)

1232

Maxime Perrotin's avatar
Maxime Perrotin committed
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
    # pylint: disable=C0103
    def keyPressEvent(self, event):
        ''' Handle keyboard: Delete, Undo/Redo '''
        super(SDL_Scene, self).keyPressEvent(event)
        if event.matches(QtGui.QKeySequence.Delete) and self.selectedItems():
            self.delete_selected_symbols()
            self.clearSelection()
            self.clear_focus()
        elif event.matches(QtGui.QKeySequence.Undo):
            if not isinstance(self.focusItem(), EditableText):
                LOG.debug('UNDO ' + self.undo_stack.undoText())
                self.undo_stack.undo()
                self.clearSelection()
                self.refresh()
                # Emit a selection change to make sure the toolbar is updated
                # (e.g. when Undoing a Place START symbol)
                self.selectionChanged.emit()
                self.clear_focus()
        elif event.matches(QtGui.QKeySequence.Redo):
            if not isinstance(self.focusItem(), EditableText):
                LOG.debug('REDO ' + self.undo_stack.redoText())
                self.undo_stack.redo()
                self.clearSelection()
                self.refresh()
                self.clear_focus()
                # Emit a selection change to make sure the toolbar is updated
                self.selectionChanged.emit()
        elif event.matches(QtGui.QKeySequence.Copy):
            if not isinstance(self.focusItem(), EditableText):
                try:
                    self.copy_selected_symbols()
                except TypeError:
                    LOG.error('Cannot copy')
        elif event.matches(QtGui.QKeySequence.Cut):
            self.cut_selected_symbols()
        elif event.matches(QtGui.QKeySequence.Paste):
            if not isinstance(self.focusItem(), EditableText):
                self.paste_symbols()
                self.refresh()
                self.clear_focus()
        elif event.key() == Qt.Key_N:
            # n to select the next item in a search (vim mode)
            if self.focusItem():
                # Only active when no item has keyboard focus
                return
            try:
                self.clearSelection()
                item = self.search_item.next()
                item.select()
                item.ensureVisible()
            except StopIteration:
                LOG.info('No more matches')
                self.search(self.search_pattern)
            except AttributeError:
                LOG.info('No search pattern set. Use "/<pattern>"')
        elif (event.key() == Qt.Key_J and
                event.modifiers() == Qt.ControlModifier):
            # Debug mode
Maxime Perrotin's avatar
Maxime Perrotin committed
1291
            for selection in self.selected_symbols:
Maxime Perrotin's avatar
Maxime Perrotin committed
1292
                LOG.info(unicode(selection))
Maxime Perrotin's avatar
Maxime Perrotin committed
1293
1294
1295
1296
1297
1298
1299
1300
1301
                LOG.info('Position: ' + str(selection.pos()))
                LOG.info('ScenePos: ' + str(selection.scenePos()))
                LOG.info('BoundingRect: ' + str(selection.boundingRect()))
                #LOG.info('ChildrenList: ' + str(selection.childItems()))
                LOG.info('ChildrenBoundingRect: ' +
                        str(selection.childrenBoundingRect()))
                pprint.pprint(selection.__dict__, None, 2, 1)
            code.interact('type your command:', local=locals())

1302

Maxime Perrotin's avatar
Maxime Perrotin committed
1303
1304
class SDL_View(QtGui.QGraphicsView, object):
    ''' Main graphic view used to display the SDL scene and handle zoom '''
1305
1306
    # signal to ask the main application that a new scene is needed
    need_new_scene = QtCore.Signal()
1307
    update_asn1_dock = QtCore.Signal(ogAST.AST)
Maxime Perrotin's avatar
Maxime Perrotin committed
1308

Maxime Perrotin's avatar
Maxime Perrotin committed
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
    def __init__(self, scene):
        ''' Create the SDL view holding the scene '''
        super(SDL_View, self).__init__(scene)
        self.wrapping_window = None
        self.messages_window = None
        self.mode = ''
        self.phantom_rect = None
        self.filename = ''
        self.orig_pos = None
        # mouse_pos is used to handle screen scrolling with middle mouse button
        self.mouse_pos = None
        # Up button allows to move from one scene to another
        self.up_button = None
        # Toolbar with the icons of the SDL symbols
        self.toolbar = None
        # Scene stack (used for nested symbols)
1325
        self.scene_stack = []
Maxime Perrotin's avatar
Maxime Perrotin committed
1326
1327
        # Set of PR files that are not saved back (e.g. system structure)
        self.readonly_pr = None
1328
1329
1330
1331
        # Context history referencing the AST entry corresponding to the scene
        # Used when navigating between scene with up/down button to update
        # the CONTEXT parameter in sdlSymbols - used for autocompletion
        self.context_history = []
Maxime Perrotin's avatar
Maxime Perrotin committed
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
        # Special scene for the Lander module
        self.lander_scene = SDL_Scene(context='lander')
        # Do not initialize the lander now - only if needed
        self.lander = None

    def set_toolbar(self):
        ''' Define the toolbar depending on the context '''
        self.toolbar.set_actions(
                bar_items=ACTIONS.get(self.scene().context, []))

        # Connect toolbar actions
        self.scene().selectionChanged.connect(partial(
                                    self.scene().set_selection, self.toolbar))
        for item in self.toolbar.actions.viewkeys():
            self.toolbar.actions[item].triggered.connect(
                                                   self.scene().actions[item])
        self.toolbar.update_menu(self.scene())

    # pylint: disable=C0103
    def keyPressEvent(self, event):
        ''' Handle keyboard: Zoom, open/save diagram, etc. '''
        if event.matches(QtGui.QKeySequence.ZoomOut):
            self.scale(0.8, 0.8)
        elif event.matches(QtGui.QKeySequence.ZoomIn):
            self.scale(1.2, 1.2)
1357
1358
1359
        elif event.key() == Qt.Key_Q and event.modifiers() == Qt.ControlModifier:
            # Reset zoom with Ctrl-Q
            self.resetTransform()
Maxime Perrotin's avatar
Maxime Perrotin committed
1360
1361
        elif event.matches(QtGui.QKeySequence.Save):
            self.save_diagram()
Maxime Perrotin's avatar
Maxime Perrotin committed
1362
        elif event.key() == Qt.Key_F3 or (event.key() == Qt.Key_G and
Maxime Perrotin's avatar
Maxime Perrotin committed
1363
                event.modifiers() == Qt.ControlModifier):
Maxime Perrotin's avatar
Maxime Perrotin committed
1364
            # F3 or Ctrl-G to generate Ada code
Maxime Perrotin's avatar
Maxime Perrotin committed
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
            self.generate_ada()
        elif event.key() == Qt.Key_F7:
            self.check_model()
        elif event.key() == Qt.Key_F5:
            self.refresh()
        elif event.matches(QtGui.QKeySequence.Open):
            self.open_diagram()
        elif event.matches(QtGui.QKeySequence.New):
            self.new_diagram()
        elif (event.key() == Qt.Key_F12 and
                event.modifiers() == Qt.ControlModifier and
                self.scene() != self.lander_scene):
            self.lander_scene.setSceneRect(0, 0, self.width(), self.height())
            if not self.lander:
                self.lander = Lander.Lander(self.lander_scene)
1380
1381
            horpos = self.horizontalScrollBar().value()
            verpos = self.verticalScrollBar().value()
1382
            self.scene_stack.append((self.scene(), horpos, verpos))
Maxime Perrotin's avatar
Maxime Perrotin committed
1383
1384
1385
1386
1387
1388
1389
1390
1391
            self.scene().clear_focus()
            self.setScene(self.lander_scene)
            self.up_button.setEnabled(True)
            self.set_toolbar()
            self.lander.play()
        super(SDL_View, self).keyPressEvent(event)

    def refresh(self):
        ''' Refresh the complete view '''
Maxime Perrotin's avatar
Maxime Perrotin committed
1392
        LOG.debug('view refresh')
Maxime Perrotin's avatar
Maxime Perrotin committed
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
        self.scene().refresh()
        self.setSceneRect(self.scene().sceneRect())
        self.viewport().update()

    # pylint: disable=C0103
    def resizeEvent(self, event):
        '''
           Called by Qt when window is resized
           Make sure that the scene that is displayed is at least
           of the size of the view, by drawing a transparent rectangle
           Otherwise, the scene is centered on the view, with the size
           of its bounding rect. This is nice in theory, except when
           the user wants to place a symbol at an exact position - in
           that case, the automatic centering is not appropriate.
        '''
        LOG.debug('resizing view')
        scene_rect = self.scene().itemsBoundingRect()
        view_size = self.size()
        scene_rect.setWidth(max(scene_rect.width(), view_size.width()))
        scene_rect.setHeight(max(scene_rect.height(), view_size.height()))
        if self.phantom_rect and self.phantom_rect in self.scene().items():
1414
1415
1416
            #self.scene().removeItem(self.phantom_rect)
            # XXX stop with removeItem, it provokes segfault
            self.phantom_rect.hide()
Maxime Perrotin's avatar
Maxime Perrotin committed
1417
1418
1419
1420
        self.phantom_rect = self.scene().addRect(scene_rect,
                pen=QtGui.QPen(QtGui.QColor(0, 0, 0, 0)))
        # Hide the rectangle so that it does not collide with the symbols
        self.phantom_rect.hide()
Maxime Perrotin's avatar
Maxime Perrotin committed
1421
        self.refresh()
Maxime Perrotin's avatar
Maxime Perrotin committed
1422
1423
1424
1425
1426
1427
        super(SDL_View, self).resizeEvent(event)

    def about_og(self):
        ''' Display the About dialog '''
        QtGui.QMessageBox.about(self, 'About OpenGEODE',
                'OpenGEODE - a tiny SDL editor for TASTE\n\n'
Maxime Perrotin's avatar
Maxime Perrotin committed
1428
1429
1430
                'Version {}\n\n'
                'Copyright (c) 2012-2015 European Space Agency\n\n'
                'Contact: Maxime.Perrotin@esa.int\n\n'.format(__version__))
Maxime Perrotin's avatar
Maxime Perrotin committed
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445

    # pylint: disable=C0103
    def wheelEvent