gui.py 18.6 KB
Newer Older
1
2
3
4
#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
    TASTE ASN.1 Value Editor
Maxime Perrotin's avatar
Maxime Perrotin committed
5

6
7
8
9
10
11
12
13
14
15
    Tool main entry point (when used standalone)

    Copyright (c) 2012-2015 European Space Agency

    Designed and implemented by Maxime Perrotin

    Contact: maxime.perrotin@esa.int

    License is LGPLv3 - Check the LICENSE file
"""
Maxime Perrotin's avatar
Maxime Perrotin committed
16
17
18
19
20

__url__ = "http://taste.tuxfamily.org"


import os
21
import traceback
Maxime Perrotin's avatar
Maxime Perrotin committed
22
23
24
25
26
import signal
import sys
import platform
import re
import logging
27
import argparse
Maxime Perrotin's avatar
Maxime Perrotin committed
28
import time
29
from functools import partial
30
from ctypes import CDLL
Maxime Perrotin's avatar
Maxime Perrotin committed
31
32
33
34
35
36
37
38
39
40
41
42

log = logging.getLogger(__name__)
terminal_formatter = logging.Formatter(
        fmt="%(levelname)s - %(name)s: %(message)s")
handler_console = logging.StreamHandler()
handler_console.setLevel(logging.DEBUG)
handler_console.setFormatter(terminal_formatter)
log.addHandler(handler_console)


from ColorFormatter import ColorFormatter

Maxime Perrotin's avatar
Maxime Perrotin committed
43
from asn1_value_editor import asn1Editor, asn1Viewer, __version__
Maxime Perrotin's avatar
Maxime Perrotin committed
44
from plotmanager import PlotManager
45
import vn
Maxime Perrotin's avatar
Maxime Perrotin committed
46

47
48
import UserWidgets

Maxime Perrotin's avatar
Maxime Perrotin committed
49
50
51
52
53
try:
    import speedometer
except ImportError:
    log.error('You must install speedometer first')

54
55
56
57
58
59
60
61
62
# Make sure the gui can import modules in the current directory
sys.path.insert(0, '.')

try:
    import datamodel
except ImportError:
    datamodel = None

try:
63
    from PythonController import(OpenMsgQueueForReading, new_byte_SWIG_PTR,
64
65
66
67
68
                GetMsgQueueBufferSize, DV, RetrieveMessageFromQueue)
    python_controller = True
except ImportError:
    python_controller = False

Maxime Perrotin's avatar
Maxime Perrotin committed
69
70
71
import resources

from mscHandler import mscHandler
72
from sdlHandler import sdlHandler
Maxime Perrotin's avatar
Maxime Perrotin committed
73

74
from PySide.QtCore import QThread, QFile, Qt, Signal, QObject
Maxime Perrotin's avatar
Maxime Perrotin committed
75
from PySide.QtGui import(QApplication, QStatusBar, QLabel, QWidget,
76
        QListWidget, QPushButton, QDockWidget, QTabWidget, QMenu, QAction)
Maxime Perrotin's avatar
Maxime Perrotin committed
77
78
79
80

from PySide.QtUiTools import QUiLoader

g_tmPool = {}
Maxime Perrotin's avatar
Maxime Perrotin committed
81
False
Maxime Perrotin's avatar
Maxime Perrotin committed
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

class MsgQ_Poller(QThread):
    '''
        Thread for polling the GUI queue in order to receive
        the messages from the main binary
    '''
    tm = Signal()

    def __init__(self, log, parent=None):
        self.log = log
        QThread.__init__(self, parent)
        self.Qname = "{uid}_{fvname}_PI_queue".format(uid=str(os.geteuid()),
                                                    fvname=datamodel.FVname)
        self.log.info('msQ name= ' + self.Qname)

    def run(self):
        self.log.debug('Starting msgQ polling thread')
        self._bDie = False
        while True:
            if self._bDie:
                return
            self._msgQueue = OpenMsgQueueForReading(self.Qname)
            if (self._msgQueue != -1):
                break
            self.log.warning(
                    "Communication channel over {Qname} not established yet. "
                    "Retrying...".format(Qname=self.Qname))
            time.sleep(1)
        bufferSize = GetMsgQueueBufferSize(self._msgQueue)
111
        pDataFromMQ = new_byte_SWIG_PTR(bufferSize)
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
        while not self._bDie:
            messageReceivedType = RetrieveMessageFromQueue(
                                       self._msgQueue, bufferSize, pDataFromMQ)
            if messageReceivedType == -1:
                time.sleep(0.005)
                continue
            self.log.debug('MsgQ poller: received message')
            # use a signal to inform the TM editor of the received TM
            g_tmPool[messageReceivedType].pendingTM = pDataFromMQ
            self.tm.emit()


class MyLogger:
    ''' Hook for catching the calls to "print" from imported modules '''
    def __init__(self, log):
        self.log = log
        self.string = ""

    def write(self, string):
        if string.endswith('\n'):
            self.log.info(self.string)
            self.string = ""
        else:
            self.string += string


def gui():
    ''' Application entry point '''
    # Exit app on Ctrl-C
    signal.signal(signal.SIGINT, signal.SIG_DFL)
142
    if 'opengeode-simulator' in sys.argv[0]:
Maxime Perrotin's avatar
Maxime Perrotin committed
143
        logo = ':/opengeode.png'
144
        msclist_enable = False
145
        sys.argv.append('-l')
Maxime Perrotin's avatar
Maxime Perrotin committed
146
147
    else:
        logo = ':/tasteLogo_white.png'
148
        msclist_enable = True
Maxime Perrotin's avatar
Maxime Perrotin committed
149

150
    #usage = 'usage: gui.py [--udp=IP_Address:in_Port:out_Port]'
Maxime Perrotin's avatar
Maxime Perrotin committed
151
152
153
154
155
    version = 'taste auto-gui %s' % (__version__)

    # Set up the logging facilities
    log = logging.getLogger("gui")
    console = logging.StreamHandler(sys.__stdout__)
Maxime Perrotin's avatar
Maxime Perrotin committed
156
    console.setFormatter(ColorFormatter())
Maxime Perrotin's avatar
Maxime Perrotin committed
157
158
159
160
161
162
    log.addHandler(console)
    log.info('Starting GUI')
    myPrint = MyLogger(log)
    sys.stdout = myPrint

    # Parse the command line
163
164
    parser = argparse.ArgumentParser(version=version)
    parser.add_argument('-g', '--verbose', action='store_true', default=False,
Maxime Perrotin's avatar
Maxime Perrotin committed
165
                      help='Display debug information')
166
    parser.add_argument('--udp', dest='udp', metavar='RemoteIP:inPort:outPort',
Maxime Perrotin's avatar
Maxime Perrotin committed
167
                      help='Use UDP sockets instead of message queues')
168
169
170
171
    parser.add_argument('-l', '--shared_lib', action='store_true',
                      default=False, help='Simulate SDL system, '
                      'using a shared library')
    parser.add_argument('-r', '--reset', action='store_true', default=False,
Maxime Perrotin's avatar
Maxime Perrotin committed
172
                      help='Do not try to restore windows layout')
173
174
175
    parser.add_argument('-p', '--properties', dest='properties',
                      help='Specify a file containing stop conditions')
    parser.add_argument('-i', '--ivpath', dest='ivpath',
Maxime Perrotin's avatar
Maxime Perrotin committed
176
177
                      default='./InterfaceView.aadl',
                      help='Path and filename of the system interface view')
178
    options = parser.parse_args()
Maxime Perrotin's avatar
Maxime Perrotin committed
179
180
181
182
183
184
185
186
187
188
189
190
191
192
    if options.verbose:
        log.setLevel(logging.DEBUG)
    else:
        log.setLevel(logging.INFO)

    log.debug('{version} using Python {pyVersion}'.format(
                        version=version, pyVersion=platform.python_version()))
    log.debug('Using interface view (for MSC processing): ' + options.ivpath)
    if options.udp is not None and not re.match("\d+.\d+.\d+.\d+:\d+:\d+",
                                                options.udp):
        log.error('Wrong UDP format. Run with --help for the proper syntax')
        log.error('You entered ' + options.udp)
        sys.exit(-1)

193
    if not datamodel:
194
195
196
        log.error('Could not import project data')
        return -1

Maxime Perrotin's avatar
Maxime Perrotin committed
197
198
    msgQ = True
    udp = None
199
    dll = None
Maxime Perrotin's avatar
Maxime Perrotin committed
200
    hasTM = False
201
    if not options.udp and not options.shared_lib:
202
        # Default: use message queue
203
204
        log.info('Using message queues to communicate')
        if not python_controller:
Maxime Perrotin's avatar
Maxime Perrotin committed
205
206
            log.error('Python module "PythonController" is missing')
            return -1
207
    elif options.udp:
Maxime Perrotin's avatar
Maxime Perrotin committed
208
209
210
211
212
213
214
215
216
217
218
219
        msgQ = False
        udpConfig = options.udp.split(':')
        log.debug('UDP with IP={cfg[0]} inPort={cfg[1]} outPort={cfg[2]}'
                   .format(cfg=udpConfig))
        try:
            from udpcontroller import tasteUDP
            udp = tasteUDP(log=log, ip_out=udpConfig[0],
                           inport=int(udpConfig[1]), outport=int(udpConfig[2]))
            log.info('Using UDP to communicate')
        except ImportError:
            log.error('Python module "udpcontroller" is missing')
            return -1
Maxime Perrotin's avatar
Maxime Perrotin committed
220
    elif options.shared_lib:
221
        # Load and run the startup transition of the shared library (Ada only?)
Maxime Perrotin's avatar
Maxime Perrotin committed
222
        msgQ = False
223
        try:
224
225
            dll = CDLL('./lib{}.so'.format(datamodel.FVname.lower()))
            dll_init = getattr(dll, 'lib{}init'.format(datamodel.FVname.lower()))
226
            dll_init()
Maxime Perrotin's avatar
Maxime Perrotin committed
227
228
        except OSError as err:
            log.error('Issue with shared library lib{}.so:'
229
                      .format(datamodel.FVname))
Maxime Perrotin's avatar
Maxime Perrotin committed
230
            log.error(str(err))
231
            return -1
Maxime Perrotin's avatar
Maxime Perrotin committed
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

    # Define a Qt application (mandatory)
    app = QApplication(sys.argv)

    # All available styles are listed with: QStyleFactory.keys()
    app.setStyle("cleanlooks")

    # Load the GUI description file (.ui file editable with Qt Designer)
    # Pyside and PyQt have a different way of doing...
    from TasteMainWindow import TasteMainWindow
    loader = QUiLoader()
    loader.registerCustomWidget(asn1Editor)
    loader.registerCustomWidget(asn1Viewer)
    loader.registerCustomWidget(TasteMainWindow)
    uiFile = QFile("guilayout.ui")
    uiFile.open(QFile.ReadOnly)
    myWidget = loader.load(uiFile)
    uiFile.close()

    log.info('GUI generated for function ' + datamodel.FVname)
    myWidget.FVname = datamodel.FVname

    # Create an instance of the Plot/Meter manager
    plotter = PlotManager(parent=myWidget, log=log)

    # find QStatusBar widget
    statusbar = myWidget.findChildren(QStatusBar)[0]
    statusbar.showMessage('Welcome to TASTE')

    # find TASTE logo and get width of the picture
    tasteLogo = myWidget.findChild(QLabel, 'tasteLogo')
Maxime Perrotin's avatar
Maxime Perrotin committed
263
    tasteLogo.setPixmap(logo)
Maxime Perrotin's avatar
Maxime Perrotin committed
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
    logoWidth = tasteLogo.pixmap().width()

    # find Central widget and set maximum size to width of the logo
    centralWidget = myWidget.findChild(QWidget, 'centralWidget')
    centralWidget.setMaximumWidth(logoWidth)

    # To Put ASSERT background image
    #assertPix=QPalette()
    #assertPix.setBrush(myWidget.backgroundRole(),
    #                   QBrush(QImage("assert_bkg.jpg")))
    #myWidget.setPalette(assertPix)

    # find list to place MSC scenarii and corresponding buttons
    mscList = myWidget.findChild(QListWidget, 'msc')
    runMSC = myWidget.findChild(QPushButton, 'runMSC')
    loadMSC = myWidget.findChild(QPushButton, 'loadMSC')
    editMSC = myWidget.findChild(QPushButton, 'editMSC')
281
282
283
284
285
    # In SDL simulation mode, MSC record/replay is not supported yet
    mscList.setEnabled(msclist_enable)
    runMSC.setEnabled(msclist_enable)
    loadMSC.setEnabled(msclist_enable)
    editMSC.setEnabled(msclist_enable)
Maxime Perrotin's avatar
Maxime Perrotin committed
286
287
288
289
290
291
292

    # Create an instance of the class handling MSC/Python scripts
    msgs = []
    for msg in datamodel.tc:
        msgs.append({'name': msg, 'type': datamodel.tc[msg]['nodeTypename']})
    for msg in datamodel.tm:
        msgs.append({'name': msg, 'type': datamodel.tm[msg]['nodeTypename']})
293
294
295
296
297
298
299
300
301
302
303

    # set the names of the MSC instances, depending on the context
    if dll:
        instance1 = datamodel.FVname
        instance2 = 'Operator'
    else:
        instance1 = 'TASTE_System'
        instance2 = datamodel.FVname

    msc = mscHandler(myWidget, mscList, instance2, msgs, udpController=udp,
                     instance_name=instance1)
Maxime Perrotin's avatar
Maxime Perrotin committed
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
    msc.log = log
    msc.ivpath = options.ivpath
    runMSC.pressed.connect(msc.run)
    loadMSC.pressed.connect(msc.load)
    editMSC.pressed.connect(msc.edit)
    myWidget.mscStop.connect(msc.stopMscRecording)

    # Create toolbar with a button to start/stop MSC recording and streamind
    toolbar = myWidget.addToolBar('toolbar')
    toolbar.setObjectName('toolbar')
    mscButton = toolbar.addAction('MSC')
    mscButton.triggered.connect(msc.startStop)
    myWidget.mscTrigger.connect(msc.startStop)

    # find dockable widgets (containing TM and TC editors)
    docks = myWidget.findChildren(QDockWidget)
    firstTC = None
    firstTM = None
    # Arrange them in a nice way: group the TM and TC in tabs
    myWidget.setTabPosition(Qt.RightDockWidgetArea, QTabWidget.North)
    for dock in docks:
        if dock.objectName().startswith('tm'):
            if firstTM is None:
                firstTM = dock
            else:
                myWidget.tabifyDockWidget(firstTM, dock)
        else:
            if firstTC is None:
                firstTC = dock
            else:
                myWidget.tabifyDockWidget(firstTC, dock)
        dock.setMinimumWidth(700 - logoWidth)

    # find TC/TM Editors
    myEdits = myWidget.findChildren(asn1Editor)

    #Pattern to create/add a new dock window - easy!
    #newDock=QDockWidget('Hello', parent=myWidget)
    #newDock.setFloating(True)
    #myWidget.addDockWidget(Qt.RightDockWidgetArea, newDock)

345
346
347
348
    # Create a dock to handle the display of SDL diagrams
    try:
        sdl = sdlHandler(myWidget)
        sdl.dll = dll
349
        sdl.msc.connect(msc.addToMsc)
350
351
352
353
        sdl.msc_undo.connect(msc.undo)
        sdl.msc_redo.connect(msc.redo)
        sdl.msc_macro_start.connect(msc.start_undo_macro)
        sdl.msc_macro_stop.connect(msc.stop_undo_macro)
354
        sdl.allowed_messages.connect(myWidget.allowed_editors)
355
356
    except IOError as err:
        log.info('SDL viewer not available - ' + str(err))
357
        #log.info(traceback.format_exc())
358
359
360
361
        sdl = None
    else:
        sdlButton = toolbar.addAction('SDL')
        sdlButton.triggered.connect(sdl.startStop)
362
363
        if options.properties:
            sdl.load_properties(options.properties)
364
365


Maxime Perrotin's avatar
Maxime Perrotin committed
366
367
368
369
370
371
372
373
374
    # Set the ASN.1 data type of each TC editor
    for editor in myEdits:
        # Enable mouse tracking - to display tips in the status bar
        editor.setMouseTracking(True)
        editor.entered.connect(editor.displaytip)
        # Hide columns showing the ASN.1 Type and constraint
        editor.hideExtraColumns()
        # Import the backend generated by the pyside_B_mapper from aadl2glueC
        encoder_backend = __import__("%s_backend" % editor.objectName())
375

Maxime Perrotin's avatar
Maxime Perrotin committed
376
        # Set the callback in the backend to forward incoming TM to the GUI
377
378
379
380
381
        encoder_backend.editor = editor
        TMHandler = type('TMHandler', (QObject,), {'got_tm': Signal()})
        encoder_backend.tm_callback = TMHandler()
        encoder_backend.tm_callback.got_tm.connect(editor.receivedTM)

382
383
384
385
386
387
388
        # Set the callback in the backend to send messages via the dll
        # (handled in the SDL backend, also managing MSC traces)
        if dll:
            DLLHandler = type('DLLHandler', (QObject,),
                              {'dll': Signal(unicode, type, type)})
            encoder_backend.send_via_dll = DLLHandler()
            encoder_backend.send_via_dll.dll.connect(sdl.send_tc)
Maxime Perrotin's avatar
Maxime Perrotin committed
389
390
391
            if isinstance(editor, asn1Viewer):
                # Connect TM to MSC
                editor.msc.connect(sdl.add_to_msc)
392
393
394
        else:
            editor.msc.connect(msc.addToMsc)

Maxime Perrotin's avatar
Maxime Perrotin committed
395
396
397
398
399
        encoder_backend.log = log
        encoder_backend.statusbar = statusbar
        editor.statusBarMessage.connect(statusbar.showMessage)
        if msgQ:
            encoder_backend.setMsgQ()
400
        elif udp:
Maxime Perrotin's avatar
Maxime Perrotin committed
401
            encoder_backend.setUDP()
402
        elif dll:
403
            # Provide pointer to the shared lib to the backends
404
            encoder_backend.setSharedLib(dll)
Maxime Perrotin's avatar
Maxime Perrotin committed
405
406
407
408
        editor.backend = encoder_backend
        editor.log = log
        dockWidget = editor.parent()
        myButtons = dockWidget.findChildren(QPushButton)
409
410
411

        # retrieve user widgets for TM and TC
        customTC, customTM = [], []
412
413
414
415
416
417
        for each in UserWidgets.__all__:
            widget = getattr(UserWidgets, each)
            if widget.__base__ == UserWidgets.TC and widget.applicable():
                customTC.append(widget)
            elif widget.__base__ == UserWidgets.TM and widget.applicable():
                customTM.append(widget)
Maxime Perrotin's avatar
Maxime Perrotin committed
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433

        if isinstance(editor, asn1Viewer):  # TM Viewer
            hasTM = True
            editor.setAsn1Model(datamodel.tm[editor.objectName()])
            g_tmPool[encoder_backend.tmId] = editor
            editor.setPlotterBackend(plotter)
            for button in myButtons:
                if button.objectName() == 'plotButton':
                    myMenu = QMenu()
                    action = QAction("New Plot", myMenu)
                    myMenu.addAction(action)
                    button.setMenu(myMenu)
                    action.triggered.connect(editor.newPlot)
                    plotter.addPlotMenu(myMenu, editor)
                elif button.objectName() == 'meterButton':
                    button.clicked.connect(editor.meter)
434
435
436
437
438
439
440
441
442
443
444
                elif button.objectName() == 'customCombo':
                    if not customTM:
                        continue
                    myMenu = QMenu()
                    for each in customTM:
                        action = QAction(each.name, myMenu)
                        myMenu.addAction(action)
                        action.triggered.connect(partial(editor.custom,
                                                         each))

                    button.setMenu(myMenu)
445
                    button.menu() # Seems there is a refresh issue without that
Maxime Perrotin's avatar
Maxime Perrotin committed
446
447
448
449
450
451
452
453
454
455
456
457
458
                else:
                    button.hide()
        else:  # TC Editor
            editor.setAsn1Model(datamodel.tc[editor.objectName()])
            if not msgQ:
                encoder_backend.udpController = udp
            for button in myButtons:
                if button.objectName() == 'saveButton':
                    button.clicked.connect(editor.saveTC)
                elif button.objectName() == 'loadButton':
                    button.clicked.connect(editor.loadTC)
                elif button.objectName() == 'sendButton':
                    button.clicked.connect(editor.sendTC)
459
460
461
462
463
                    if dll:
                        sdl.param_tc_editors.append({'name':
                                                         editor.objectName(),
                                                     'editor': editor,
                                                     'send_btn': button})
464
465
466
467
468
469
470
471
472
473
474
475
476
                elif button.objectName() == 'customCombo':
                    if not customTC:
                        button.hide()
                    myMenu = QMenu()
                    for each in customTC:
                        action = QAction(each.name, myMenu)
                        myMenu.addAction(action)
                        action.triggered.connect(partial(editor.custom,
                                                         each))
                    button.setMenu(myMenu)
                    button.menu() # Seems there is a refresh issue without that
                else:
                    button.hide()
Maxime Perrotin's avatar
Maxime Perrotin committed
477
478
479
480
481
482
483
484
485

    # Create a thread to poll the message queue or open an UDP socket
    if msgQ:
        if hasTM:
            pollingThread = MsgQ_Poller(log=log)
            for editor in myEdits:
                if isinstance(editor, asn1Viewer):
                    pollingThread.tm.connect(editor.receivedTM)
            pollingThread.start()
486
    elif udp:
Maxime Perrotin's avatar
Maxime Perrotin committed
487
488
489
        if hasTM:
            udp.tmPool = g_tmPool
        udp.start(hasTM)
490
    elif dll:
491
        # Nothing to do, the TM callbacks have already been connected (above)
492
        pass
Maxime Perrotin's avatar
Maxime Perrotin committed
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517

    # Associate the plotter manager to the main app
    myWidget.plotter = plotter

    # Set list of editors to the main app
    myWidget.editors = myEdits

    # If applicable, restore window geometry from a previous session
    if not options.reset:
        log.info('Restoring windows layout (use --reset to discard)')
        myWidget.restoreApplicationState()
    else:
        log.info('Ignoring and deleting previously stored windows layout')

    # Display the main window (including TM/TC editors)
    myWidget.show()
    ret = app.exec_()
    sys.stdout = sys.__stdout__
    if msgQ and hasTM:
        pollingThread._bDie = True
        pollingThread.wait()
    return ret

if __name__ == '__main__':
    sys.exit(gui())