Statechart.py 20.6 KB
Newer Older
Maxime Perrotin's avatar
Maxime Perrotin committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
#!/usr/bin/env python

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

    This module is responsible for the rendering of statecharts using
    the graphviz library.

    Credits:
    Rendering algorithm to transform graphviz b-splines to to Qt bezier curves
    was developed by Steve Dodier-Lazaro (www.mupuf.org)

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

22
import os
Maxime Perrotin's avatar
Maxime Perrotin committed
23
import logging
24
from collections import defaultdict
25
import re
Maxime Perrotin's avatar
Maxime Perrotin committed
26
27
28
29
30
31
32
33
34
35
from PySide import QtGui, QtCore

try:
    import pygraphviz as dotgraph
except ImportError:
    print('pygraphviz not found. Statechart module will not work\n'
          'If you are using Debian (or Ubuntu) you can install it from\n'
          'the official repos: sudo apt-get install python-pygraphviz')

import genericSymbols
Maxime Perrotin's avatar
Maxime Perrotin committed
36
from Connectors import Edge
Maxime Perrotin's avatar
Maxime Perrotin committed
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

RENDER_DPI = {'X': 93.0, 'Y': 95.0}
G_SYMBOLS = set()
EDGES = []

LOG = logging.getLogger(__name__)


# pylint: disable=R0904
class Record(genericSymbols.HorizontalSymbol, object):
    ''' Graphviz node - it is floating and has no parent'''
    _unique_followers = []
    _insertable_followers = ['Record', 'Diamond']
    _terminal_followers = []
    textbox_alignment = (QtCore.Qt.AlignTop
                         | QtCore.Qt.AlignHCenter)

    def __init__(self, node, graph):
        ''' Initialization: compute the polygon shape '''
        self.name = node['name']
        super(Record, self).__init__(x=node['pos'][0],
                y=node['pos'][1], text=self.name)
        self.set_shape(node['width'], node['height'])
        self.setBrush(QtGui.QBrush(QtGui.QColor(255, 255, 202)))
        self.graph = graph
        if 'properties' in node:
            property_box = QtGui.QGraphicsTextItem(self)
            property_box.setPos(5, 30)
            property_box.setPlainText(node['properties'])
Maxime Perrotin's avatar
Maxime Perrotin committed
66
67
        # Text in statecharts is read-only:
        self.text.setTextInteractionFlags(QtCore.Qt.TextBrowserInteraction)
Maxime Perrotin's avatar
Maxime Perrotin committed
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

    def set_shape(self, width, height):
        ''' Define the polygon shape from width and height '''
        path = QtGui.QPainterPath()
        path.moveTo(0, 25)
        path.lineTo(width, 25)
        path.addRoundedRect(0, 0, width, height, 15, 15)
        self.setPath(path)
        super(Record, self).set_shape(width, height)

    def resize_item(self, _):
        ''' Redefine the resizing function - forbid resizing '''
        pass

    def __str__(self):
        ''' User-friendly information about the node '''
        return('Record ' + self.name + ' at pos ' + str(self.pos()) +
               ' bounding rect = ' + str(self.boundingRect()))

    def mouse_release(self, _):
        ''' After moving item, ask dot to recompute the edges '''
        # Discard mouse release default action (CAM, UndoCommand)
        pass


# pylint: disable=R0904
class Point(genericSymbols.HorizontalSymbol, object):
    ''' Graphviz point node - used for START transition'''
    _unique_followers = []
    _insertable_followers = ['Record', 'Diamond']
    _terminal_followers = []
    textbox_alignment = (QtCore.Qt.AlignTop
                         | QtCore.Qt.AlignHCenter)
Maxime Perrotin's avatar
Maxime Perrotin committed
101
    has_text_area = False
Maxime Perrotin's avatar
Maxime Perrotin committed
102
103
104
105

    def __init__(self, node, graph):
        ''' Initialization: compute the polygon shape '''
        self.name = node['name']
Maxime Perrotin's avatar
Maxime Perrotin committed
106
        super(Point, self).__init__(x=node['pos'][0], y=node['pos'][1])
Maxime Perrotin's avatar
Maxime Perrotin committed
107
108
109
        self.set_shape(node['width'], node['height'])
        self.setBrush(QtGui.QBrush(QtCore.Qt.black))
        self.graph = graph
110
        # Text is read only
Maxime Perrotin's avatar
Maxime Perrotin committed
111
        #self.text.setTextInteractionFlags(QtCore.Qt.TextBrowserInteraction)
Maxime Perrotin's avatar
Maxime Perrotin committed
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142

    def set_shape(self, width, height):
        ''' Define the polygon shape from width and height '''
        path = QtGui.QPainterPath()
        path.addEllipse(0, 0, width, height)
        self.setPath(path)
        super(Point, self).set_shape(width, height)

    def resize_item(self, _):
        ''' Redefine the resizing function - forbid resizing '''
        pass

    def __str__(self):
        ''' User-friendly information about the node '''
        return('Point ' + self.name + ' at pos ' + str(self.pos()) +
                ' bounding rect = ' + str(self.boundingRect()))

    def mouse_release(self, _):
        ''' After moving item, ask dot to recompute the edges '''
        #self.scene().refresh()
        update(self.scene())


# pylint: disable=R0904
class Diamond(genericSymbols.HorizontalSymbol, object):
    ''' Graphviz node - it is floating and has no parent'''
    _unique_followers = []
    _insertable_followers = ['Record']
    _terminal_followers = []
    textbox_alignment = (QtCore.Qt.AlignTop
                         | QtCore.Qt.AlignHCenter)
Maxime Perrotin's avatar
Maxime Perrotin committed
143
    has_text_area = False
Maxime Perrotin's avatar
Maxime Perrotin committed
144
145
146
147

    def __init__(self, node, graph):
        ''' Initialization: compute the polygon shape '''
        self.name = node['name']
Maxime Perrotin's avatar
Maxime Perrotin committed
148
        super(Diamond, self).__init__(x=node['pos'][0], y=node['pos'][1])
Maxime Perrotin's avatar
Maxime Perrotin committed
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
        self.set_shape(node['width'], node['height'])
        self.graph = graph

    def set_shape(self, width, height):
        ''' Define the polygon shape from width and height '''
        path = QtGui.QPainterPath()
        path.moveTo(width / 2, 0)
        path.lineTo(width, height / 2)
        path.lineTo(width / 2, height)
        path.lineTo(0, height / 2)
        path.lineTo(width / 2, 0)
        self.setPath(path)
        super(Diamond, self).set_shape(width, height)

    def resize_item(self, _):
        ''' Redefine the resizing function - forbid resizing '''
        pass

    def __str__(self):
        ''' User-friendly information about the node '''
        return('Node ' + self.name + ' at pos ' + str(self.pos()) +
                ' bounding rect = ' + str(self.boundingRect()))

    def mouse_release(self, _):
        ''' After moving item, ask dot to recompute the edges '''
        #update(self.scene())
        pass

Maxime Perrotin's avatar
Maxime Perrotin committed
177

Maxime Perrotin's avatar
Maxime Perrotin committed
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
def edges(scene, node):
    ''' Return all edges of a given node '''
    for item in scene.items():
        if isinstance(item, Edge) and node in (
                item.edge['source'], item.edge['target']):
            yield item


# Front end part - use Graphviz to parse the input file and transform it
# pylint: disable=R0914
def preprocess_edges(my_graph, nodes, bounding_rect, dpi):
    ''' Parse edges and put them in a clean datastructure '''
    edges = []
    bb_height = bounding_rect[3]
    for edge in my_graph.edges_iter():
        new_edge = {}
        source, target = edge
        for node in nodes:
            if node.name == source:
                new_edge['source'] = node
            if node.name == target:
                new_edge['target'] = node
        new_edge['label'] = edge.attr.get('label')
        try:
            new_edge['lp'] = [float(val) for val in edge.attr['lp'].split(',')]
        except (ValueError, AttributeError):
            pass
        else:
            # translate the label position from dot-coordinates to Qt
207
            # Note: lp is the position of the CENTER of the label
Maxime Perrotin's avatar
Maxime Perrotin committed
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
            new_edge['lp'][0] *= RENDER_DPI['X'] / dpi
            new_edge['lp'][1] = (
                    bb_height - new_edge['lp'][1]) * (RENDER_DPI['Y'] / dpi)

        pos = edge.attr['pos'].split()

        if pos[0].startswith('e'):
            new_edge['end'] = [float(val)
                    for val in pos.pop(0).split(',')[1:]]
            # And translate position
            new_edge['end'][0] *= (RENDER_DPI['X'] / dpi)
            new_edge['end'][1] = (
                    bb_height - new_edge['end'][1]) * (RENDER_DPI['Y'] / dpi)

        elif pos[0].startswith('s'):
            new_edge['start'] = [float(val)
                    for val in pos.pop(0).split(',')[1:]]
            # And translate position
            new_edge['start'][0] *= (RENDER_DPI['X'] / dpi)
            new_edge['start'][1] = (
                    bb_height - new_edge['start'][1]) * (RENDER_DPI['Y'] / dpi)

        spline = []
        for entry in pos:
            point = [float(val) for val in entry.split(',')]
            point[0] *= (RENDER_DPI['X'] / dpi)
            point[1] = (bb_height - point[1]) * (RENDER_DPI['Y'] / dpi)

            spline.append(point)
        new_edge['spline'] = spline
        edges.append(new_edge)
    return edges


def preprocess_nodes(my_graph, bounding_rect, dpi):
    ''' Parse the nodes from the graph and create a clean datastructure '''
    # Graphviz calculates coordinates starting on the bottom-left corner,
    # while Qt uses the top-left corner, so we must translate all y-coord.
    bb_height = bounding_rect[3]
    nodes = []
248
249
250
251
252
253
254
255
256
257
258
259
260
    attrs = []
    for each in my_graph.subgraphs():
        # Transform cluster nodes into nodes (attributes differ)
        llx, lly, urx, ury = each.graph_attr['bb'].split(',')
        wid = float(urx) - float(llx)
        hei = float(ury) - float(lly)
        attr = {}
        attr.update(pos='{0},{1}'.format(llx, lly),
                         width=wid,
                         height=hei,
                         shape=each.graph_attr['shape'],
                         label=each.graph_attr['label'],
                         style=each.graph_attr['style'],
Maxime Perrotin's avatar
Maxime Perrotin committed
261
                         name='cluster_' + each.graph_attr['label'],
262
263
                         kind='cluster')
        attrs.append(attr)
Maxime Perrotin's avatar
Maxime Perrotin committed
264
    for node in my_graph.nodes_iter():
265
266
267
268
269
        if not node.attr:
            continue
        node.attr.update(name=node.name)
        attrs.append(node.attr)
    for node in attrs:
Maxime Perrotin's avatar
Maxime Perrotin committed
270
271
        new_node = {}
        # Get the node shape attribute - default is record
272
        new_node['shape'] = node.get('shape') or 'record'
Maxime Perrotin's avatar
Maxime Perrotin committed
273
        # node main name
274
        new_node['name'] = node['name']
Maxime Perrotin's avatar
Maxime Perrotin committed
275
276
277
        try:
            # node complete label (can contain several compartments)
            properties = (
278
279
                    node['label'][1:-2].split('|')[1].replace('\\', '\n'))
            new_node['properties'] = properties
Maxime Perrotin's avatar
Maxime Perrotin committed
280
281
282
        except IndexError:
            pass
        # transform width and height from inches to pixels
283
284
285
286
287
288
        if node.get('kind', '') == 'cluster':
            new_node['width'] = node['width']
            new_node['height'] = node['height']
        else:
            new_node['width'] = float(node['width']) * RENDER_DPI['X']
            new_node['height'] = float(node['height']) * RENDER_DPI['Y']
Maxime Perrotin's avatar
Maxime Perrotin committed
289
        # get the position of the CENTER of the node
290
        center_pos = [float(val) for val in node['pos'].split(',')]
Maxime Perrotin's avatar
Maxime Perrotin committed
291
292
293
294
        # apply dpi-conversion from 72 to 96
        center_pos[0] *= (RENDER_DPI['X'] / dpi)

        # translate y-coord from bottom-left to top-left corner
295
        center_pos[1] = (bb_height - center_pos[1]) * (RENDER_DPI['Y'] / dpi)
Maxime Perrotin's avatar
Maxime Perrotin committed
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
        new_node['pos'] = [center_pos[0] - (new_node['width'] / 2.0),
                           center_pos[1] - (new_node['height'] / 2.0)]
        nodes.append(new_node)
    return nodes


def update(scene):
    '''
        Parse the graph symbols and create a graphviz graph
        Used to update the edges in case user moves nodes.
    '''
    nodes = [{'name':node.name, 'pos':
        node.mapToScene(node.boundingRect().center()),
        'shape': type(node), 'width': node.boundingRect().width(),
        'height': node.boundingRect().height()}
        for node in scene.items() if isinstance(node,
                                               (Point, Diamond, Record))]
    graph = dotgraph.AGraph(
            strict=False, directed=True, splines='spline', start='rand')

    lookup = {Point: 'point', Record: 'record', Diamond: 'diamond'}
    for node in nodes:
        center_pos = node['pos']
        bb_height = scene.itemsBoundingRect().height()

        dpi = 72.0

        # Convert to graphviz coordinates / adapt DPI
        center_x = center_pos.x() * (dpi / RENDER_DPI['X'])
        center_y = (bb_height - center_pos.y()) * (dpi / RENDER_DPI['Y'])

327
328
        #pos = unicode('{x},{y}'.format(x=int(center_x), y=int(center_y)))
        pos = unicode('{x},{y}'.format(x=float(center_x), y=float(center_y)))
Maxime Perrotin's avatar
Maxime Perrotin committed
329
330
331
332

        if node['shape'] in (Point, Diamond):
            graph.add_node(node['name'], pos=pos, shape=lookup[node['shape']],
                fixedsize='true', width=node['width'] / RENDER_DPI['X'],
333
                height=node['height'] / RENDER_DPI['Y'], pin=True)
Maxime Perrotin's avatar
Maxime Perrotin committed
334
        else:
335
336
            graph.add_node(node['name'], pos=pos, pin=True,
                           shape=lookup[node['shape']])
Maxime Perrotin's avatar
Maxime Perrotin committed
337
338
339
340
341
342
343

    # Keep edges from the previous graph
    for edge in EDGES:
        graph.add_edge(edge, label=edge.attr.get('label') or '')

    #print graph.to_string()
    if nodes:
344
        before = scene.itemsBoundingRect().center()
Maxime Perrotin's avatar
Maxime Perrotin committed
345
        #before_pos = graph.get_node(nodes[0]['name']).attr['pos']
Maxime Perrotin's avatar
Maxime Perrotin committed
346
        render_statechart(scene, graph, keep_pos=True)
Maxime Perrotin's avatar
Maxime Perrotin committed
347
        #after_pos = graph.get_node(nodes[0]['name']).attr['pos']
348
349
        #print before_pos,after_pos
        delta = scene.itemsBoundingRect().center() - before
Maxime Perrotin's avatar
Maxime Perrotin committed
350
351
        # graphviz translates the graph to pos (0, 0) -> move it back
        # to the exact graphical position where the user clicked
352
        for item in scene.visible_symb:
353
            item.position = QtCore.QPointF(item.position - delta)
Maxime Perrotin's avatar
Maxime Perrotin committed
354
355


356
357
358
def render_statechart(scene, graph=None, keep_pos=False, dump_gfx=''):
    ''' Render a graphviz/dot statechart on the QGraphicsScene
        set a filename to "dump_gfx" parameter to create a PNG of the graph
359
360
        input is resulting from sdl_to_statechart, it contains a tree of graphs
        in case of composite states.
361
    '''
Maxime Perrotin's avatar
Maxime Perrotin committed
362
363
364
365
    # Statechart symbols lookup table
    lookup = {'point': Point, 'record': Record, 'diamond': Diamond}
    try:
        # Bonus: the tool can render any dot graph...
366
        graph = graph.get('graph', None) or dotgraph.AGraph('taste.dot')
Maxime Perrotin's avatar
Maxime Perrotin committed
367
368
369
370
371
372
    except IOError:
        LOG.info('No statechart to display....')
        raise
    graph.graph_attr.update(dpi='72.0')
    EDGES[:] = graph.edges()

373
374
375
376
    for each in scene.visible_symb:
        each.setVisible(False)
    #scene.clear()
    #G_SYMBOLS.clear()
Maxime Perrotin's avatar
Maxime Perrotin committed
377
378
379

    # Compute all the coordinates (self-modifying function)
    # Force the fontsize of the nodes to be 12, as in OpenGEODE
380
    # use -n1 below to keep user-specified node coordinates
381
382
383
384
385
386
    if dump_gfx:
        dump_name = 'sc_' + os.path.basename(dump_gfx)
        dump_gfx = os.path.dirname(dump_gfx) or '.' + os.sep + dump_name
        if dump_gfx.split('.')[-1].lower() != 'png':
            dump_gfx += '.png'

387
388
389
    graph.layout(prog='neato', args='-Nfontsize=12, -Efontsize=8 '
                 '-Gsplines=curved -Gsep=1 '
                 '-Gstart=random10 -Goverlap=false '
390
391
392
            '-Nstyle=rounded -Nshape=record -Elen=1 {kp} {dump}'
            .format(kp='-n1' if keep_pos else '',
                    dump=('-Tpng -o' + dump_gfx) if dump_gfx else ''))
Maxime Perrotin's avatar
Maxime Perrotin committed
393
394
395
396
397
398
399
400
401
402
403
404
    # bb is not visible directly - extract it from the low level api:
    bounding_rect = [float(val) for val in
            dotgraph.graphviz.agget(graph.handle, 'bb').split(',')]
    dot_dpi = float(dotgraph.graphviz.agget(graph.handle, 'dpi'))
    # dot uses a 72 dpi value for converting its position coordinates
    # Get actual rendering DPI from Qt view
    for view in scene.views():
        RENDER_DPI['X'] = view.physicalDpiX()
        RENDER_DPI['Y'] = view.physicalDpiY()

    #fontname = graph.graph_attr.get('fontname')
    #fontsize = graph.graph_attr.get('fontsize')
405
406
    #with open('statechart.dot', 'w') as output:
    #    output.write(graph.to_string())
Maxime Perrotin's avatar
Maxime Perrotin committed
407
408
409
410

    nodes = preprocess_nodes(graph, bounding_rect, dot_dpi)
    node_symbols = []
    for node in nodes:
411
        #print node
Maxime Perrotin's avatar
Maxime Perrotin committed
412
413
414
        shape = node.get('shape')
        try:
            node_symbol = lookup[shape](node, graph)
415
416
417
            G_SYMBOLS.add(node_symbol)
            node_symbols.append(node_symbol)
            scene.addItem(node_symbol)
Maxime Perrotin's avatar
Maxime Perrotin committed
418
419
420
421
422
423
424
425
        except KeyError:
            raise TypeError('Statechart - unsupported shape: ' + shape)
    edges = preprocess_edges(graph, node_symbols, bounding_rect, dot_dpi)

    for edge in edges:
        Edge(edge, graph)


426
427
428
429
430
def create_dot_graph(root_ast, basic=False):
    ''' Return a dot.AGraph item, from an ogAST.Process or child entry
        Set basic=True to generate a simple graph with at most one edge
        between two states and no diamond nodes
    '''
431
    graph = dotgraph.AGraph(strict=False, directed=True)
432
    ret = {'graph': graph, 'children': {}}
433
434
435
436
437
438
439
440
441
    diamond = 0
    for state in root_ast.mapping.viewkeys():
        # create a new node for each state (including nested states)
        if state.endswith('START'):
            graph.add_node(state, label='', shape='point',
                           fixedsize='true', width=10.0 / 72.0)
        else:
            #print 'adding', state
            graph.add_node(state, label=state, shape='record', style='rounded')
442
443
444
445
446
447
448
#   for each in root_ast.composite_states:
#       # this will have to be recursive
#       subnodes = (name for name in graph.iternodes()
#                   if name.startswith(each.statename.lower() + '_'))
#       graph.add_subgraph(subnodes, name='cluster_' + each.statename.lower(),
#                          label=each.statename.lower(),
#                          style='rounded', shape='record')
449
450
451
452
453
    for state, inputs in root_ast.mapping.viewitems():
        # Add edges
        transitions = \
            inputs if not state.endswith('START') \
                   else [root_ast.transitions[inputs]]
454
455
456
        # Allow simplified graph, without diamonds and with at most one
        # transition from a given state to another
        target_states = defaultdict(set)
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
        for trans in transitions:
            source = state
            # transition label - there can be several inputs
            try:
                # Keep only message name, remove params and newlines
                # (newlines are not supported by graphviz)
                label, = re.match(r'([^(]+)', trans.inputString).groups()
                label = label.strip().replace('\n', ' ')
            except AttributeError:
                # START transition may have no inputString
                label = ''

            def find_terminators(trans):
                ''' Recursively find all NEXTSTATES '''
                next_states = [term for term in trans.terminators
                               if term.kind == 'next_state']
                joins = [term for term in trans.terminators
                         if term.kind == 'join']
                for join in joins:
                    # JOIN - Find corresponding label
                    try:
                        corr_label, = [lab for lab in
                                       root_ast.content.floating_labels +
                                       root_ast.labels if
                                       lab.inputString.lower() ==
                                       join.inputString.lower()]
                    except ValueError:
                        LOG.error('Missing label: ' + join.inputString)
                    else:
                        # Don't recurse forever in case of livelock
                        if corr_label.inputString != trans.inputString:
                            next_states.extend(find_terminators(corr_label))
                return set(next_states)

            # Determine the list of terminators in this transition
            next_states = find_terminators(trans)

494
            if len(next_states) > 1 and not basic:
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
                # more than one terminator - add intermediate node
                graph.add_node(str(diamond),
                               shape='diamond',
                               fixedsize='true',
                               width=15.0 / 72.0,
                               height=15.0 / 72.0, label='')
                graph.add_edge(source, str(diamond), label=label)
                source = str(diamond)
                label = ''
                diamond += 1
            for term in next_states:
                if term.inputString.strip() == '-':
                    target = state
                else:
                    target = term.inputString.lower()
510
511
512
513
514
#               for each in root_ast.composite_states:
#                   # check with deeper nesting
#                   if each.statename.lower() == target.lower():
#                       target = 'cluster_' + target
#                       break
515
516
517
518
519
520
521
                if basic:
                    target_states[target].add(label)
                else:
                    graph.add_edge(source, target, label=label)
        for target, labels in target_states.viewitems():
            # Basic mode
            graph.add_edge(source, target, label=',\n'.join(labels))
522
523
524
525
526
527
#   with open('statechart.dot', 'w') as output:
#       output.write(graph.to_string())
    #return graph
    for each in root_ast.composite_states:
        ret['children'][each.statename] = create_dot_graph(each, basic)
    return ret
528
529


Maxime Perrotin's avatar
Maxime Perrotin committed
530
531
if __name__ == '__main__':
    render_statechart(None)