Renderer.py 12.4 KB
Newer Older
Maxime Perrotin's avatar
Maxime Perrotin committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
#!/usr/bin/env python
# -*- coding: utf-8 -*-

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

    This module is responsible for transforming AST elements to actual symbols

    It is separated from the main SDL_Scene class as the rendering can
    be done on any scene (e.g. clipboard).

    There is a single rendering function for all SDL construct, and a dispatch
    machanism (using the Python3-backported feature called singledispatch).

    Rendering can be done for single elements (returns the symbol) or for
    complete diagrams.

    This rendering capability is separated from the AST definition (ogAST.py)
    so that the AST module is kept independent from any graphical backend and
    is not related to Pyside.

    When rendering a (set of) symbol(s), update text autocompletion list(s).
"""

import ogAST
import sdlSymbols
import genericSymbols
import logging
Maxime Perrotin's avatar
Maxime Perrotin committed
37
from itertools import chain
Maxime Perrotin's avatar
Maxime Perrotin committed
38
39
40
41
from singledispatch import singledispatch

LOG = logging.getLogger(__name__)

Maxime Perrotin's avatar
Maxime Perrotin committed
42
43
44
45
46
47
48
49
50
__all__ = ['render', 'add_to_scene']


def add_to_scene(item, scene):
    ''' Add item to a scene after verifying that the scene allows it '''
    if type(item) in scene.allowed_symbols:
        scene.addItem(item)
    else:
        raise TypeError('This symbol does not fit the current scene')
Maxime Perrotin's avatar
Maxime Perrotin committed
51

Maxime Perrotin's avatar
Maxime Perrotin committed
52

Maxime Perrotin's avatar
Maxime Perrotin committed
53
54
55
56
57
58
59
60
61
62
@singledispatch
def render(ast, scene, parent, states, terminators=None):
    ''' Render a transition action symbol on the scene '''
    _, _, _, _ = scene, parent, states, terminators
    # Default behaviour is to raise an exception, if there is no
    # rendering function for a given symbol. Otherwise the dispatch
    # mechanism forwards the call to a registered function (see below)
    raise TypeError('[Renderer] Unsupported symbol in branch: ' + repr(ast))


63
64
65
66
67
68
69
70
71
72
@render.register(ogAST.Block)
def _block(ast, scene):
    ''' Render a block, containing a set of process symbols '''
    # TODO = Add text areas with signal lists, external procedures defs...
    top_level = []
    for each in ast.processes:
        top_level.append(render(each, scene))
    return top_level


Maxime Perrotin's avatar
Maxime Perrotin committed
73
@render.register(ogAST.Process)
Maxime Perrotin's avatar
Maxime Perrotin committed
74
def _process(ast, scene, **_):
75
    ''' Render a Process symbol (in a BLOCK diagram) '''
Maxime Perrotin's avatar
Maxime Perrotin committed
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
    # Set autocompletion lists for input, output, state, types, variables:
    try:
        sdlSymbols.TextSymbol.completion_list = {
                t.replace('-', '_') for t in ast.dataview}
    except (AttributeError, TypeError):
        LOG.debug('No dataview for filling types autocompletion list')
    sdlSymbols.State.completion_list = {
            state for state in ast.mapping if state != 'START'}
    sdlSymbols.Input.completion_list = {
            signal['name'] for signal in ast.input_signals}
    sdlSymbols.Output.completion_list = {
            signal['name'] for signal in ast.output_signals}
    sdlSymbols.Task.completion_list = set(ast.variables.keys())

    sdlSymbols.ProcedureCall.completion_list = {
            proc.inputString for proc in ast.procedures}

93
    symbol = sdlSymbols.Process(ast, ast)
Maxime Perrotin's avatar
Maxime Perrotin committed
94
    add_to_scene(symbol, scene)
95
    return symbol
Maxime Perrotin's avatar
Maxime Perrotin committed
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115


@render.register(ogAST.Automaton)
def _automaton(ast, scene):
    ''' Render graphical elements of a process or procedure '''
    top_level_symbols = []
    # Render text areas (DCL declarations, etc.)
    for text in ast.textAreas:
        top_level_symbols.append(render(text, scene))

    # Render procedures symbols
    top_level_symbols.extend(
            [render(proc, scene)
                            for proc in ast.inner_procedures
                            if not proc.external])

    # Render the start symbol
    if ast.start:
        top_level_symbols.append(render(ast.start, scene, ast.states))

116
117
118
119
    # Render named start symbols in nested states
    for each in ast.named_start:
        top_level_symbols.append(render(each, scene, ast.states))

Maxime Perrotin's avatar
Maxime Perrotin committed
120
121
122
123
124
    # Render floating labels
    for label in ast.floating_labels:
        top_level_symbols.append(render(label, scene, ast.states))

    # Render floating states
Maxime Perrotin's avatar
Maxime Perrotin committed
125
    nested_states = []
Maxime Perrotin's avatar
Maxime Perrotin committed
126
127
128
129
130
    for state in ast.states:
        # Create only floating states
        try:
            new_state = render(state, scene=scene, states=ast.states,
                               terminators=ast.parent.terminators)
131
            if new_state.nested_scene:
Maxime Perrotin's avatar
Maxime Perrotin committed
132
                if str(new_state).lower() in nested_states:
133
134
                    new_state.nested_scene = None
                else:
Maxime Perrotin's avatar
Maxime Perrotin committed
135
                    nested_states.append(str(new_state).lower())
Maxime Perrotin's avatar
Maxime Perrotin committed
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
        except TypeError:
            # Discard terminators (see _state function for explanation)
            pass
        else:
            top_level_symbols.append(new_state)
    return top_level_symbols


@render.register(ogAST.State)
def _state(ast, scene, states, terminators, parent=None):
    ''' Render a floating state and its inputs '''
    _ = parent
    # Discard the state if it is a terminator too as it is not a floating
    # state in that case: it will be rendered together with all its (possible)
    # INPUT children in the render_terminator function.
    for term in terminators:
        if(term.kind == 'next_state' and
                term.pos_x == ast.pos_x and
                term.pos_y == ast.pos_y and
                term.inputString == ast.inputString):
            raise TypeError('This state is a terminator')
    new_state = sdlSymbols.State(parent=None, ast=ast)
    if new_state not in scene.items():
Maxime Perrotin's avatar
Maxime Perrotin committed
159
        add_to_scene(new_state, scene)
Maxime Perrotin's avatar
Maxime Perrotin committed
160

Maxime Perrotin's avatar
Maxime Perrotin committed
161
162
    for exit in chain(ast.inputs, ast.connects):
        render(exit, scene=scene, parent=new_state, states=states)
163
164
165

    new_state.nested_scene = ast.composite or ogAST.CompositeState()

Maxime Perrotin's avatar
Maxime Perrotin committed
166
167
168
169
170
171
172
173
    return new_state


@render.register(ogAST.Procedure)
def _procedure(ast, scene, parent=None, states=None):
    ''' Add a procedure symbol to the scene '''
    _, _ = parent, states
    proc_symbol = sdlSymbols.Procedure(ast, ast)
Maxime Perrotin's avatar
Maxime Perrotin committed
174
    add_to_scene(proc_symbol, scene)
Maxime Perrotin's avatar
Maxime Perrotin committed
175
176
177
178
179
180
181
182
    return proc_symbol


@render.register(ogAST.TextArea)
def _text_area(ast, scene, parent=None, states=None):
    ''' Render a text area from the AST '''
    _, _ = parent, states
    text = sdlSymbols.TextSymbol(ast)
Maxime Perrotin's avatar
Maxime Perrotin committed
183
    add_to_scene(text, scene)
Maxime Perrotin's avatar
Maxime Perrotin committed
184
185
186
187
188
189
190
191
    return text


@render.register(ogAST.Start)
def _start(ast, scene, states, parent=None):
    ''' Add the start symbol to a scene '''
    _ = parent
    start_symbol = sdlSymbols.Start(ast)
Maxime Perrotin's avatar
Maxime Perrotin committed
192
    add_to_scene(start_symbol, scene)
Maxime Perrotin's avatar
Maxime Perrotin committed
193
    if ast.transition:
Maxime Perrotin's avatar
Maxime Perrotin committed
194
        render(ast.transition, scene=scene, parent=start_symbol, states=states)
195
196
197
198
    return start_symbol


@render.register(ogAST.CompositeState_start)
Maxime Perrotin's avatar
Maxime Perrotin committed
199
def _composite_start(ast, scene, states, parent=None):
200
201
202
    ''' Add an editable start symbol to a scene (in composite states) '''
    _ = parent
    start_symbol = sdlSymbols.StateStart(ast)
Maxime Perrotin's avatar
Maxime Perrotin committed
203
    add_to_scene(start_symbol, scene)
204
205
206
    if ast.transition:
        render(ast.transition,
                      scene=scene, parent=start_symbol, states=states)
Maxime Perrotin's avatar
Maxime Perrotin committed
207
208
209
210
211
212
213
214
    return start_symbol


@render.register(ogAST.Procedure_start)
def _procedure_start(ast, scene, states, parent=None):
    ''' Add the procedure start symbol to a scene '''
    _ = parent
    start_symbol = sdlSymbols.ProcedureStart(ast)
Maxime Perrotin's avatar
Maxime Perrotin committed
215
    add_to_scene(start_symbol, scene)
Maxime Perrotin's avatar
Maxime Perrotin committed
216
    if ast.transition:
Maxime Perrotin's avatar
Maxime Perrotin committed
217
        render(ast.transition, scene=scene, parent=start_symbol, states=states)
Maxime Perrotin's avatar
Maxime Perrotin committed
218
219
220
221
222
223
224
225
226
    return start_symbol


@render.register(ogAST.Floating_label)
def _floating_label(ast, scene, states, parent=None):
    ''' Add a Floating label from the AST to the scene '''
    _ = parent
    lab = sdlSymbols.Label(parent=None, ast=ast)
    if lab not in scene.items():
Maxime Perrotin's avatar
Maxime Perrotin committed
227
        add_to_scene(lab, scene)
Maxime Perrotin's avatar
Maxime Perrotin committed
228
229
    lab.setPos(ast.pos_x, ast.pos_y)
    if ast.transition:
Maxime Perrotin's avatar
Maxime Perrotin committed
230
        render(ast.transition, scene=scene, parent=lab, states=states)
Maxime Perrotin's avatar
Maxime Perrotin committed
231
232
233
234
235
236
    return lab


@render.register(ogAST.Transition)
def _transition(ast, scene, parent, states):
    ''' Add a transition to a scene '''
Maxime Perrotin's avatar
Maxime Perrotin committed
237
    for each in ast.actions:
Maxime Perrotin's avatar
Maxime Perrotin committed
238
        # pylint: disable=E1111
Maxime Perrotin's avatar
Maxime Perrotin committed
239
        parent = render(each, scene=scene, parent=parent, states=states)
Maxime Perrotin's avatar
Maxime Perrotin committed
240
241

    if ast.terminator:
Maxime Perrotin's avatar
Maxime Perrotin committed
242
        render(ast.terminator, scene=scene, parent=parent, states=states)
Maxime Perrotin's avatar
Maxime Perrotin committed
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266


@render.register(ogAST.Comment)
def _comment(ast, scene, parent, states=None):
    ''' Create a COMMENT symbol - note: relative positionning is lost '''
    _, _ = scene, states
    return genericSymbols.Comment(parent, ast=ast)


@render.register(ogAST.Task)
def _task(ast, scene, parent, states):
    ''' Create a TASK symbol '''
    _, _ = scene, states
    return sdlSymbols.Task(parent, ast=ast)


@render.register(ogAST.Output)
def _output(ast, scene, parent, states):
    ''' Create an OUTPUT or PROCEDURE CALL symbol '''
    _, _ = scene, states
    return sdlSymbols.Output(parent, ast=ast)


@render.register(ogAST.ProcedureCall)
Maxime Perrotin's avatar
Maxime Perrotin committed
267
def _procedure_call(ast, scene, parent, states):
Maxime Perrotin's avatar
Maxime Perrotin committed
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
    ''' Create an OUTPUT or PROCEDURE CALL symbol '''
    _, _ = scene, states
    return sdlSymbols.ProcedureCall(parent, ast=ast)


@render.register(ogAST.Decision)
def _decision(ast, scene, parent, states):
    ''' Create a DECISION symbol and all its answers '''
    symbol = sdlSymbols.Decision(parent, ast=ast)
    # Place the symbol at absolute coordinates
    if not parent:
        symbol.setPos(ast.pos_x, ast.pos_y)
    for branch in ast.answers:
        render(branch,
                      scene=scene, parent=symbol, states=states)
    return symbol


@render.register(ogAST.Label)
def _label(ast, scene, parent=None, states=None):
    ''' Create a LABEL symbol '''
    _, _ = scene, states
    return sdlSymbols.Label(parent, ast=ast)


@render.register(ogAST.Answer)
def _answer(ast, scene, parent, states):
    ''' Create an ANSWER symbol and build its following transition '''
    symbol = sdlSymbols.DecisionAnswer(parent, ast=ast)
    # Place the symbol at absolute coordinates so that if
    # the branch has NEXTSTATEs symbols, they are properly placed
    if not parent:
        symbol.setPos(ast.pos_x, ast.pos_y)
    if ast.transition:
        render(ast.transition,
                      scene=scene, parent=symbol, states=states)
    return symbol


@render.register(ogAST.Terminator)
def _terminator(ast, scene, parent, states):
    ''' Create a TERMINATOR symbol '''
    if ast.label:
        # pylint: disable=E1111
Maxime Perrotin's avatar
Maxime Perrotin committed
312
        parent = render(ast.label, scene=scene, parent=parent, states=states)
Maxime Perrotin's avatar
Maxime Perrotin committed
313
314
315
316
317
318
319
320
321
322
323
    if ast.kind == 'next_state':
        LOG.debug('ADDING NEXT_STATE ' + ast.inputString)
        # Create a new state symbol
        symbol = sdlSymbols.State(parent=parent, ast=ast)
        # If the terminator is also a new state, render the inputs below
        LOG.debug('STATELIST:' + str([st.inputString for st in states]))
        for state_ast in states:
            if (state_ast.inputString == ast.inputString and
                    state_ast.pos_x == ast.pos_x and
                    state_ast.pos_y == ast.pos_y):
                LOG.debug('MERGING TERMINATOR "' + ast.inputString + '"')
Maxime Perrotin's avatar
Maxime Perrotin committed
324
325
326
327
328
                symbol.nested_scene = state_ast.composite or \
                                      ogAST.CompositeState()
                for each in chain(state_ast.inputs, state_ast.connects):
                    render(each, scene=scene, parent=symbol, states=states)
                break
Maxime Perrotin's avatar
Maxime Perrotin committed
329
330
    elif ast.kind == 'join':
        symbol = sdlSymbols.Join(parent, ast)
331
    elif ast.kind in ('return', 'stop'):
Maxime Perrotin's avatar
Maxime Perrotin committed
332
333
334
335
336
337
338
339
340
341
342
343
        symbol = sdlSymbols.ProcedureStop(parent, ast)
    else:
        raise TypeError('Unsupported terminator: ' + repr(ast))
    return symbol


@render.register(ogAST.Input)
def _input(ast, scene, parent, states):
    ''' Add input from the AST to the scene '''
    # Note: PROVIDED clause is not supported
    inp = sdlSymbols.Input(parent, ast=ast)
    if inp not in scene.items():
Maxime Perrotin's avatar
Maxime Perrotin committed
344
        add_to_scene(inp, scene)
Maxime Perrotin's avatar
Maxime Perrotin committed
345
346
347
348
349
350
351
352
    if not parent:
        inp.setPos(ast.pos_x, ast.pos_y)
    if ast.transition:
        render(ast.transition,
               scene=scene,
               parent=inp,
               states=states)
    return inp
Maxime Perrotin's avatar
Maxime Perrotin committed
353

Maxime Perrotin's avatar
Maxime Perrotin committed
354

Maxime Perrotin's avatar
Maxime Perrotin committed
355
@render.register(ogAST.Connect)
Maxime Perrotin's avatar
Maxime Perrotin committed
356
def _connect(ast, scene, parent, states):
Maxime Perrotin's avatar
Maxime Perrotin committed
357
358
359
    ''' Add connect symbol from the AST to the scene '''
    conn = sdlSymbols.Connect(parent, ast=ast)
    if conn not in scene.items():
Maxime Perrotin's avatar
Maxime Perrotin committed
360
        add_to_scene(conn, scene)
Maxime Perrotin's avatar
Maxime Perrotin committed
361
362
363
364
365
366
367
368
    if not parent:
        conn.setPos(ast.pos_x, ast.pos_y)
    if ast.transition:
        render(ast.transition,
               scene=scene,
               parent=conn,
               states=states)
    return conn