gui.py 15.2 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
#!/usr/bin/python

# ASN.1 Variable editor

__author__ = "Maxime Perrotin"
__license__ = "ESA Community (compatible with LGPLv3)"
__version__ = "1.0"
__url__ = "http://taste.tuxfamily.org"

# maxime.perrotin@esa.int

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

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

from asn1_value_editor import asn1Editor, asn1Viewer
from plotmanager import PlotManager

try:
    import speedometer
except ImportError:
    log.error('You must install speedometer first')

41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
# Make sure the gui can import modules in the current directory
sys.path.insert(0, '.')

try:
    import datamodel
except ImportError:
    datamodel = None

try:
    from PythonController import(OpenMsgQueueForReading,
                GetMsgQueueBufferSize, DV, RetrieveMessageFromQueue)
    python_controller = True
except ImportError:
    python_controller = False

Maxime Perrotin's avatar
Maxime Perrotin committed
56
57
58
import resources

from mscHandler import mscHandler
59
from sdlHandler import sdlHandler
Maxime Perrotin's avatar
Maxime Perrotin committed
60

61
from PySide.QtCore import QThread, QFile, Qt, Signal, QObject
Maxime Perrotin's avatar
Maxime Perrotin committed
62
63
64
65
66
67
from PySide.QtGui import(QApplication, QStatusBar, QLabel, QWidget,
        QListWidget, QPushButton, QDockWidget, QTabWidget, QMenu, QAction)

from PySide.QtUiTools import QUiLoader

g_tmPool = {}
Maxime Perrotin's avatar
Maxime Perrotin committed
68
False
Maxime Perrotin's avatar
Maxime Perrotin committed
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
101
102
103
104
105
106
107
108
109
110
111
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
143
144
145
146
147

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)
        while not self._bDie:
            pDataFromMQ = DV.new_byte_SWIG_PTR(bufferSize)
            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)

    usage = 'usage: gui.py [--udp=IP_Address:in_Port:out_Port]'
    version = 'taste auto-gui %s' % (__version__)

    # Set up the logging facilities
    log = logging.getLogger("gui")
    console = logging.StreamHandler(sys.__stdout__)
    console.setFormatter(ColorFormatter(True))
    log.addHandler(console)
    log.info('Starting GUI')
    myPrint = MyLogger(log)
    sys.stdout = myPrint

    # Parse the command line
    parser = optparse.OptionParser(usage=usage, version=version)
    parser.add_option('-v', '--verbose', action='store_true', default=False,
                      help='Display debug information')
    parser.add_option('--udp', dest='udp', metavar='RemoteIP:inPort:outPort',
                      help='Use UDP sockets instead of message queues')
148
149
    parser.add_option('-l', '--shared_lib', action='store_true', default=False,
                      help='Use a shared library instead of msgQ or UDP')
Maxime Perrotin's avatar
Maxime Perrotin committed
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
    parser.add_option('-r', '--reset', action='store_true', default=False,
                      help='Do not try to restore windows layout')
    parser.add_option('-i', '--ivpath', dest='ivpath',
                      default='./InterfaceView.aadl',
                      help='Path and filename of the system interface view')
    options, args = parser.parse_args()
    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)

170
    if not datamodel:
171
172
173
        log.error('Could not import project data')
        return -1

Maxime Perrotin's avatar
Maxime Perrotin committed
174
175
    msgQ = True
    udp = None
176
    dll = None
Maxime Perrotin's avatar
Maxime Perrotin committed
177
    hasTM = False
178
    if not options.udp and not options.shared_lib:
179
        # Default: use message queue
180
181
        log.info('Using message queues to communicate')
        if not python_controller:
Maxime Perrotin's avatar
Maxime Perrotin committed
182
183
            log.error('Python module "PythonController" is missing')
            return -1
184
    elif options.udp:
Maxime Perrotin's avatar
Maxime Perrotin committed
185
186
187
188
189
190
191
192
193
194
195
196
        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
197
    elif options.shared_lib:
198
        # Load and run the startup transition of the shared library (Ada only?)
Maxime Perrotin's avatar
Maxime Perrotin committed
199
        msgQ = False
200
        try:
Maxime Perrotin's avatar
Maxime Perrotin committed
201
            dll = CDLL('lib{}.so'.format(datamodel.FVname))
202
203
            dll_init = getattr(dll, 'lib{}init'.format(datamodel.FVname))
            dll_init()
Maxime Perrotin's avatar
Maxime Perrotin committed
204
205
        except OSError as err:
            log.error('Issue with shared library lib{}.so:'
206
                      .format(datamodel.FVname))
Maxime Perrotin's avatar
Maxime Perrotin committed
207
            log.error(str(err))
208
            return -1
Maxime Perrotin's avatar
Maxime Perrotin committed
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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264

    # 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')
    tasteLogo.setPixmap(':/tasteLogo_white.png')
    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')

    # 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']})
265
266
267
268
269
270
271
272
273
274
275

    # 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
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
312
313
314
315
316
    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)

317
318
319
320
    # Create a dock to handle the display of SDL diagrams
    try:
        sdl = sdlHandler(myWidget)
        sdl.dll = dll
321
        sdl.msc.connect(msc.addToMsc)
322
        sdl.state_change.connect(msc.addCondition)
323
324
325
326
327
328
329
330
    except IOError:
        log.info('SDL viewer not available')
        sdl = None
    else:
        sdlButton = toolbar.addAction('SDL')
        sdlButton.triggered.connect(sdl.startStop)


Maxime Perrotin's avatar
Maxime Perrotin committed
331
332
333
334
335
336
337
338
339
    # 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())
340

Maxime Perrotin's avatar
Maxime Perrotin committed
341
        # Set the callback in the backend to forward incoming TM to the GUI
342
343
344
345
346
        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)

Maxime Perrotin's avatar
Maxime Perrotin committed
347
348
349
350
351
352
        encoder_backend.log = log
        encoder_backend.statusbar = statusbar
        editor.statusBarMessage.connect(statusbar.showMessage)
        editor.msc.connect(msc.addToMsc)
        if msgQ:
            encoder_backend.setMsgQ()
353
        elif udp:
Maxime Perrotin's avatar
Maxime Perrotin committed
354
            encoder_backend.setUDP()
355
        elif dll:
356
            # Provide pointer to the shared lib to the backends
357
            encoder_backend.setSharedLib(dll)
Maxime Perrotin's avatar
Maxime Perrotin committed
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
        editor.backend = encoder_backend
        editor.log = log
        dockWidget = editor.parent()
        myButtons = dockWidget.findChildren(QPushButton)

        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)
                else:
                    button.hide()
                    # button.clicked.connect(editor.unmeter)
        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)
392
393
                    if sdl:
                        button.clicked.connect(sdl.on_event)
Maxime Perrotin's avatar
Maxime Perrotin committed
394
395
396
397
398
399
400
401
402

    # 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()
403
    elif udp:
Maxime Perrotin's avatar
Maxime Perrotin committed
404
405
406
        if hasTM:
            udp.tmPool = g_tmPool
        udp.start(hasTM)
407
    elif dll:
408
        # Nothing to do, the TM callbacks have already been connected (above)
409
        pass
Maxime Perrotin's avatar
Maxime Perrotin committed
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434

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