asn1_value_editor.py 40.4 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
    Main GUI widget

8
    Copyright (c) 2012-2016 European Space Agency
9
10
11
12
13
14
15

    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

__author__ = "Maxime Perrotin"
18
__license__ = "LGPLv3"
19
__version__ = "1.4.0"
Maxime Perrotin's avatar
Maxime Perrotin committed
20
21
22
23
24
25
26
27
28
__url__ = "http://taste.tuxfamily.org"

import sys

try:
    from PySide import *
    from PySide.QtCore import *
    from PySide.QtGui import *
    from PySide.QtUiTools import *
29
30
except ImportError as err:
    print 'Pyside not found (package python-pyside missing)...' + str(err)
Maxime Perrotin's avatar
Maxime Perrotin committed
31
32
33
34
35

import vn

MIN_RANGE = Qt.UserRole + 1
MAX_RANGE = Qt.UserRole + 2
36
37
CHOICE_LIST = Qt.UserRole + 1     # list of strings (enumerants)
INTMAP      = Qt.UserRole + 5     # for enum/choice: map string-numerical value
Maxime Perrotin's avatar
Maxime Perrotin committed
38
39
40
41
42
PLOTTERS = Qt.UserRole + 4
ASN1TYPE = Qt.UserRole


class myTextEdit(QTextEdit):
43
44
    ''' Customized text editor that contains a context menu for loading
    data from a file '''
Maxime Perrotin's avatar
Maxime Perrotin committed
45
    def __init__(self, parent=None):
46
        super(myTextEdit, self).__init__(parent)
Maxime Perrotin's avatar
Maxime Perrotin committed
47
48

    def contextMenuEvent(self, event):
49
50
        ''' When the context menu is open, add the Load from file action
        and open the menu '''
Maxime Perrotin's avatar
Maxime Perrotin committed
51
52
53
54
55
        myMenu = self.createStandardContextMenu()
        myAction = 'Load data from file'
        myMenu.addAction(myAction)
        action = myMenu.exec_(event.globalPos())
        if action is not None and action.text() == myAction:
56
57
58
59
            filename = QFileDialog.getOpenFileName(self,
                                                  "Load string from file",
                                                  ".",
                                                  "All (*)")[0]
Maxime Perrotin's avatar
Maxime Perrotin committed
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
            if len(filename) == 0:
                return
            stringFile = QFile(filename)
            stringFile.open(QIODevice.ReadOnly)
            stringData = str(stringFile.readData(stringFile.size()))
            self.setText(stringData)
            stringFile.close()


class TreeDelegate(QStyledItemDelegate):
    '''Tree Delegate allows to define specific editors for each cell of the
tree view. This way, e.g. ASN.1 ENUMERATED values can be selected using a
combo box, while INTEGERS values can be set using a spin box.
Three functions have been redefined:
(1) createEditor, which  sets an editor to a cell, using the cell attributes
to learn about the ASN.1 basic type (stored in Qt.UserRole)
(2) SetEditorData, which is used at runtime to put the value in the given
editor when the user clicks on the cell
(3) SetModelData, which is called when the user is done with the editing: it
reads the value from the editor and place it back in the model '''
    seqof = Signal(QModelIndex, int, int)
    choice = Signal(QModelIndex, int, int)

    def __init__(self, oParent=None):
84
        super(TreeDelegate, self).__init__(oParent)
Maxime Perrotin's avatar
Maxime Perrotin committed
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

    def createEditor(self, parent, option, index):
        ''' Define the delegate (editor) to use for a given cell.
index.data() returns the actual value, and index.data(role) points to
some user data when role >= 32. 32 is Qt.UserRole. '''
        # Check the (user-defined) type associated with the cell
        asnType = index.data(ASN1TYPE)
        if asnType == 'INTEGER':
            editor = QSpinBox(parent)
            # Qt's int is 32-bits signed, so we may get overflows
            try:
                editor.setMinimum(index.data(MIN_RANGE))
            except OverflowError:
                editor.setMinimum(sys.maxint)
            try:
                editor.setMaximum(index.data(MAX_RANGE))
            except OverflowError:
                editor.setMaximum(sys.maxint)
        elif asnType == 'SEQOF':
            editor = QSpinBox(parent)
            minVal = index.data(MIN_RANGE)
            maxVal = index.data(MAX_RANGE)
            editor.setRange(minVal, maxVal)
108
        elif asnType in ('ENUMERATED', 'CHOICE'):
Maxime Perrotin's avatar
Maxime Perrotin committed
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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
            editor = QComboBox(parent)
            enumVal = index.data(CHOICE_LIST)
            for val in enumVal:
                editor.addItem(val)
        elif asnType == 'REAL':
            editor = QDoubleSpinBox(parent)
            minVal = index.data(MIN_RANGE)
            maxVal = index.data(MAX_RANGE)
            editor.setRange(float(minVal), float(maxVal))
        elif asnType == 'STRING':
            editor = myTextEdit(parent)
        elif asnType == 'BOOLEAN':
            editor = QComboBox(parent)
            boolVal = index.data(CHOICE_LIST)
            for val in boolVal:
                editor.addItem(val)
        else:
            return  # Non-editable cells
        return editor

    def setEditorData(self, editor, index):
        ''' Set the curent value of the editor (when cell is clicked)
            in principle, take it from the model (index.data() = value) '''
        asnType = index.data(ASN1TYPE)
        if asnType in ('INTEGER', 'SEQOF'):
            editor. setValue(int(index.data()))
        elif asnType in ('ENUMERATED', 'CHOICE'):
            idx = editor.findText(index.data())
            editor.setCurrentIndex(idx)
            #editor. setEditText(index.data())
        elif asnType == 'REAL':
            editor.setValue(float(index.data()))
        elif asnType == 'STRING':
            editor.setText(index.data())
        elif asnType == 'BOOLEAN':
            idx = editor.findText(index.data())
            editor.setCurrentIndex(idx)
            #isChecked = index.model().data(index,  Qt.CheckStateRole)
            #editor.setCheckState(Qt.CheckState(isChecked))
        else:
            pass

    def setModelData(self, editor, model, index):
        '''  Once a choice has been made (by the user) take the value from
             the corresponding editor, and set it back in the model '''
        asnType = index.data(ASN1TYPE)
        if asnType == 'INTEGER':
            val = editor.value()
            model.setData(index, val)
        elif asnType == 'SEQOF':
            val = editor.value()
            model.setData(index, val)
            # Sequence of: display only the corresponding number of elements
162
163
164
            self.seqof.emit(index.sibling(index.row(), 0),
                            val,
                            index.data(MAX_RANGE))
Maxime Perrotin's avatar
Maxime Perrotin committed
165
166
167
168
169
170
171
        elif asnType == 'ENUMERATED':
            val = editor.currentText()
            model.setData(index, val)
        elif asnType == 'CHOICE':
            val = editor.currentText()
            model.setData(index, val)
            # display only the corresponding choice definition
172
173
174
            self.choice.emit(index.sibling(index.row(), 0),
                             len(index.data(CHOICE_LIST)),
                             editor.currentIndex())
Maxime Perrotin's avatar
Maxime Perrotin committed
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
        elif asnType == 'REAL':
            val = editor.value()
            model.setData(index, val)
        elif asnType == 'STRING':
            val = editor.toPlainText()
            model.setData(index, val)
        elif asnType == 'BOOLEAN':
            val = editor.currentText()
            model.setData(index, val)
        else:
            pass

    def updateEditorGeometry(self, editor, option, index):
        ''' Set editor geometry (bigger box for string types) '''
        asnType = index.data(ASN1TYPE)
        if asnType == 'STRING':
191
192
            r = QRect(option.rect.x(), option.rect.y(),
                      option.rect.width(), max(option.rect.height(), 100))
Maxime Perrotin's avatar
Maxime Perrotin committed
193
194
195
196
197
198
199
200
201
202
203
        else:
            r = option.rect
        editor.setGeometry(r)


class asn1Editor(QTreeView):
    ''' ASN.1 Fields editor to define, load, save and/or send TC '''
    expandTree = Signal()
    expandBranch = Signal(QModelIndex)
    statusBarMessage = Signal(str)
    msc = Signal(unicode, unicode)
204
205
    # Whenever a new TM is received, the new_tm signal is emitted
    new_tm = Signal()
Maxime Perrotin's avatar
Maxime Perrotin committed
206
207

    def __init__(self, parent=None):
208
        super(asn1Editor, self).__init__(parent)
Maxime Perrotin's avatar
Maxime Perrotin committed
209
        self.model = QStandardItemModel(1, 4)
210
211
        self.model.setHorizontalHeaderLabels(['Field', 'Type',
                                              'Constraints', 'Value'])
Maxime Perrotin's avatar
Maxime Perrotin committed
212
213
        self.delegate = TreeDelegate()
        self.setItemDelegate(self.delegate)
214
215
        # Set selection mode and behavior to allow multiple rows to be selected
        # with Ctrl/Shift keys
Maxime Perrotin's avatar
Maxime Perrotin committed
216
217
218
219
220
221
222
223
224
        self.setSelectionBehavior(QAbstractItemView.SelectRows)
        self.setSelectionMode(QAbstractItemView.ExtendedSelection)

        self.setModel(self.model)
        self.setAlternatingRowColors(True)
        # Set Editing triggers so that a single click in a cell opens the editor
        self.setEditTriggers(QAbstractItemView.AllEditTriggers)
        # If we later want to drag & drop values (to plot, meter..):
        self.setDragEnabled(False)
225
226
        # When the number of elements for a sequence of is changed,
        # signal "seqof" is triggered by the delegate. Same for choice.
Maxime Perrotin's avatar
Maxime Perrotin committed
227
228
229
230
231
232
233
234
235
        self.delegate.seqof.connect(self.seqofDisplay)
        self.delegate.choice.connect(self.choiceDisplay)
        self.expandTree.connect(self.expandAll)
        self.expandBranch.connect(self.expand)
        self.plotterBackend = None
        self.backend = None
        self.plottedIdxs = []
        self.log = None
        self.pendingTM = None
236
237
238
239
        # item is the ASN.1 node in Pyside format from datamodel.py
        self.item = None
        # List of classes that have an "update" method (user custom widgets)
        self.tm_clients = []
240
241
242
243
244
245
246
247
        # Instance of the ASN.1 type to store the value of this editor
        self.asn1Instance = None

    def setBackend(self, backend):
        ''' Set the pointer to the TMTC backend generated by the B mapper '''
        self.backend = backend
        # Create an instance of the ASN.1 type using the backend
        self.asn1Instance = self.backend.typeInstance()
Maxime Perrotin's avatar
Maxime Perrotin committed
248
249
250
251
252
253
254
255
256
257
258

    def hideExtraColumns(self):
        ''' Hide the columns containing the type and constraint '''
        self.setColumnHidden(1, True)
        self.setColumnHidden(2, True)

    def showExtraColumns(self):
        ''' Show the columns containing the type and constraint '''
        self.setColumnHidden(1, False)
        self.setColumnHidden(2, False)

259
    def setAsn1Model(self, dataview, row=0):
Maxime Perrotin's avatar
Maxime Perrotin committed
260
        self.item = dataview
261
262
        rootItem = self.addItem(self.item)
        self.treeItem = rootItem["item"]
Maxime Perrotin's avatar
Maxime Perrotin committed
263

264
265
266
        self.model.setItem(row, 1, QStandardItem(rootItem["type"]))
        self.model.setItem(row, 2, QStandardItem(rootItem["constraint"]))
        self.model.setItem(row, 3, QStandardItem(rootItem["value"]))
Maxime Perrotin's avatar
Maxime Perrotin committed
267
268

        # Add the item to the actual tree. 0,0 = 1st row, 1st column
269
        self.model.setItem(row, 0, self.treeItem)
Maxime Perrotin's avatar
Maxime Perrotin committed
270
        self.setWindowTitle('ASN.1 Variable editor')
271
        self.hideUnusedFields(self.treeItem, start=True, row=row)
Maxime Perrotin's avatar
Maxime Perrotin committed
272
273
274
        self.setColumnWidth(0, 200)
        self.setColumnWidth(1, 150)
        self.expandAll()
275
        return rootItem["item"]
Maxime Perrotin's avatar
Maxime Perrotin committed
276

277
    def hideUnusedFields(self, root, start=False, row=0):
Maxime Perrotin's avatar
Maxime Perrotin committed
278
        ''' Hide CHOICE unselected fields and SEQUENCE OF out-of-range fields '''
279
        rootType = self.model.item(row, 1).text()
Maxime Perrotin's avatar
Maxime Perrotin committed
280
        if rootType == 'CHOICE' and start:
281
282
            choices = self.model.item(row, 3).data(CHOICE_LIST)
            currValue = self.model.item(row, 3).text()
Maxime Perrotin's avatar
Maxime Perrotin committed
283
284
285
            for j in range(len(choices)):
                if currValue == choices[j]:
                    break
286
            rowIndex = self.model.item(row).index()
Maxime Perrotin's avatar
Maxime Perrotin committed
287
288
            self.choiceDisplay(rowIndex, len(choices), j)
        elif rootType == 'SEQOF' and start:
289
290
291
            maxValue = self.model.item(row, 3).data(MAX_RANGE)
            currValue = self.model.item(row, 3).text()
            rowIndex = self.model.item(row).index()
Maxime Perrotin's avatar
Maxime Perrotin committed
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
            self.seqofDisplay(rowIndex, currValue, maxValue)

        if root.hasChildren():
            for i in range(root.rowCount()):  # for each row
                self.hideUnusedFields(root.child(i))  # check recursively
                asnType = root.child(i, 1).text()
                if asnType == 'SEQOF':
                    maxValue = root.child(i, 3).data(MAX_RANGE)
                    currValue = root.child(i, 3).text()
                    rowIndex = root.child(i).index()
                    self.seqofDisplay(rowIndex, currValue, maxValue)
                elif asnType == 'CHOICE':
                    choices = root.child(i, 3).data(CHOICE_LIST)
                    currValue = root.child(i, 3).text()
                    for j in range(len(choices)):
                        if currValue == choices[j]:
                            break
                    rowIndex = root.child(i).index()
                    self.choiceDisplay(rowIndex, len(choices), j)

312
313
314
315
316
    def parseModel(self, root, nbRows=-1, dest=None):
        ''' Parse the model to get all field values recursively
            root type is QStandardItem
            (optional) dest is a ctypes instance of the type to fill
        '''
Maxime Perrotin's avatar
Maxime Perrotin committed
317
        if root.hasChildren():
318
            seqofValue = 0
Maxime Perrotin's avatar
Maxime Perrotin committed
319
            seqOf = False
320
            itemState = None
Maxime Perrotin's avatar
Maxime Perrotin committed
321
322
323
324
            if nbRows == -1:
                nbRows = root.rowCount()
            else:
                seqOf = True
325
326
            destState = dest.GetState()

Maxime Perrotin's avatar
Maxime Perrotin committed
327
            def parseRow(root, i, dest, choice=False, seqOf=False):
Maxime Perrotin's avatar
Maxime Perrotin committed
328
329
                name = root.child(i, 0).text()
                asnType = root.child(i, 1).text()
Maxime Perrotin's avatar
Maxime Perrotin committed
330
331
                # Value appears with underscore in the GUI but keys use ASN.1
                value = root.child(i, 3).text().replace('_', '-')
332
333
                if not choice:
                    dest.Reset(destState)
Maxime Perrotin's avatar
Maxime Perrotin committed
334
                ptr = getattr(dest, name) if not seqOf else dest
335
336
                if seqOf:
                    ptr = ptr[i]
Maxime Perrotin's avatar
Maxime Perrotin committed
337
                if asnType in ('SEQUENCE', 'SET'):
338
                    state = ptr.GetState()
Maxime Perrotin's avatar
Maxime Perrotin committed
339
340
                    if not seqOf:
                        ptr = getattr(ptr, name.replace('-', '_'))
341
342
                    self.parseModel(root.child(i), dest=ptr)
                    ptr.Reset(state)
Maxime Perrotin's avatar
Maxime Perrotin committed
343
                elif asnType == 'SEQOF':
344
                    state = ptr.GetState()
Maxime Perrotin's avatar
Maxime Perrotin committed
345
346
                    #if not seqOf:
                    #    ptr = getattr(ptr, name.replace('-', '_'))
347
348
                    self.parseModel(root.child(i), nbRows=int(value), dest=ptr)
                    ptr.Reset(state)
Maxime Perrotin's avatar
Maxime Perrotin committed
349
                elif asnType == 'CHOICE':
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
                    state = ptr.GetState()
                    # We must parse only one row, containing the choice (value)
                    chrow = root.child(i)
                    for rownb in xrange(chrow.rowCount()):
                        curr = chrow.child(rownb, 0).text().replace('-', '_')
                        if curr == value.replace('-', '_'):
                            # set rownb to the row of the current choice
                            break
                    else:
                        print('ERROR - choice not found')
                    parseRow(chrow, rownb, dest=ptr, choice=True)
                    ptr.Reset(state)
                    # not correct: _PRESENT is not sufficient, full prefix needed
                    ptr.kind.Set(getattr(self.backend.DV,
                                         value.replace('-', '_')+'_PRESENT'))
Maxime Perrotin's avatar
Maxime Perrotin committed
365
                elif asnType == 'INTEGER':
366
                    ptr.Set(int(value))
Maxime Perrotin's avatar
Maxime Perrotin committed
367
                elif asnType == 'REAL':
368
                    ptr.Set(float(value))
Maxime Perrotin's avatar
Maxime Perrotin committed
369
                elif asnType == 'BOOLEAN':
370
371
                    boolValue = True if value == 'True' else False
                    ptr.Set(boolValue)
Maxime Perrotin's avatar
Maxime Perrotin committed
372
                elif asnType == 'ENUMERATED':
373
374
375
376
                    valNb = getattr(self.backend.DV, value.replace('-', '_'))
                    # XXX not correct, get the value from the data field
                    # (there could be prefixes)
                    ptr.Set(valNb)
Maxime Perrotin's avatar
Maxime Perrotin committed
377
                else:  # Strings
378
379
                    ptr.SetFromPyString(value)
            for i in xrange(nbRows):  # for each child row
Maxime Perrotin's avatar
Maxime Perrotin committed
380
                parseRow(root, i, dest, seqOf=seqOf)
381
382
            dest.Reset(destState)
        else:  # single elements (all but SeqOf, Choice, Sequence)
Maxime Perrotin's avatar
Maxime Perrotin committed
383
            row = root.row()
384
385
386
387
388
389
390
            try:
                value = self.model.item(row, 3).text()
                asnType = self.model.item(row, 1).text()
            except AttributeError:
                # Empty SEQUENCEs elems contain nothing
                value = ''
                asnType = None
Maxime Perrotin's avatar
Maxime Perrotin committed
391
            if asnType == 'INTEGER':
392
                dest.Set(int(value))
Maxime Perrotin's avatar
Maxime Perrotin committed
393
            elif asnType == 'REAL':
394
                dest.Set(float(value))
Maxime Perrotin's avatar
Maxime Perrotin committed
395
            elif asnType == 'BOOLEAN':
396
                dest.Set(True if value == 'True' else False)
Maxime Perrotin's avatar
Maxime Perrotin committed
397
            elif asnType == 'ENUMERATED':
398
399
400
                # XXX probably not good, take name from data first
                dest.Set(getattr(self.backend.DV, value.replace('-', '_')))
            else: # What about octet string ? XXX CHECKME
Maxime Perrotin's avatar
Maxime Perrotin committed
401
402
                pass

403
404
405
406
407
408
409
    def getVariable(self, root=None, dest=None):
        ''' Read the ASN.1 variable from the tree editor
            root allows to specify which variable/row to start from
            dest is an optional ctypes instance of the given type, that
            will be filled by the recursive parser.
        '''
        assert dest is not None
410
411
        root = root or self.treeItem
        row = root.row()
Maxime Perrotin's avatar
Maxime Perrotin committed
412
        name = root.text()
413
        asnType = self.model.item(row, 1).text()
Maxime Perrotin's avatar
Maxime Perrotin committed
414
        if asnType == 'SEQOF':
415
            # Missing a SetLength
416
            nbRows = int(self.model.item(row, 3).text())
417
            self.parseModel(root, nbRows=nbRows, dest=dest)
Maxime Perrotin's avatar
Maxime Perrotin committed
418
        elif asnType == 'CHOICE':
419
            value = self.model.item(row, 3).text()
420
421
            self.parseModel(root, dest=dest)
            # XXX missing a kind.Set here !
Maxime Perrotin's avatar
Maxime Perrotin committed
422
        else:
423
            self.parseModel(root, dest=dest)
Maxime Perrotin's avatar
Maxime Perrotin committed
424

425
    def updateModel(self, root, ptr, nbRows=-1):
Maxime Perrotin's avatar
Maxime Perrotin committed
426
        ''' Recursive update of the values in the GUI from ASN.1 instance '''
Maxime Perrotin's avatar
Maxime Perrotin committed
427
428
429
430
431
432
        if root.hasChildren():
            seqOf = False
            if nbRows == -1:
                nbRows = root.rowCount()
            else:
                seqOf = True
Maxime Perrotin's avatar
Maxime Perrotin committed
433
434
435
            destState = ptr.GetState()

            def fillRow(root, i, dest, choice=False):
Maxime Perrotin's avatar
Maxime Perrotin committed
436
437
438
                name = root.child(i, 0).text()
                asnType = root.child(i, 1).text()
                child = root.child(i, 3)
Maxime Perrotin's avatar
Maxime Perrotin committed
439
440
441
                if not choice:
                    dest.Reset(destState)
                ptr = getattr(dest, name)
Maxime Perrotin's avatar
Maxime Perrotin committed
442
                if seqOf:
Maxime Perrotin's avatar
Maxime Perrotin committed
443
                    ptr = ptr[i]
Maxime Perrotin's avatar
Maxime Perrotin committed
444
                if asnType in ('INTEGER', 'REAL', 'SEQOF'):
Maxime Perrotin's avatar
Maxime Perrotin committed
445
446
                    # XXX plotter: TODO
                    plotters = child.data(PLOTTERS)
Maxime Perrotin's avatar
Maxime Perrotin committed
447
448
449
450
451
                    if plotters is not None:
                        self.log.debug("updateModel - updatePlot call")
                        for plotter in plotters:
                            self.plotterBackend.updatePlot(plotter, value)
                        self.log.debug("updateModel - updatePlot end")
Maxime Perrotin's avatar
Maxime Perrotin committed
452
453
454
455
                if asnType in ('INTEGER', 'REAL', 'BOOLEAN'):
                    child.setText(str(ptr.Get()))
                elif asnType == 'STRING':
                    child.setText(ptr.GetFromPyString())
Maxime Perrotin's avatar
Maxime Perrotin committed
456
                elif asnType == 'ENUMERATED':
Maxime Perrotin's avatar
Maxime Perrotin committed
457
458
459
460
461
462
463
464
                    value = ptr.Get()
                    intMappings = child.data(INTMAP)
                    for enumerant, num in intMappings.viewitems():
                        if num == value:
                            child.setText(enumerant)
                            break
                    else:
                        print("ERROR = ENUMERATED value not found")
Maxime Perrotin's avatar
Maxime Perrotin committed
465
                elif asnType in ('SEQUENCE', 'SET'):
Maxime Perrotin's avatar
Maxime Perrotin committed
466
                    self.updateModel(root.child(i), ptr)
Maxime Perrotin's avatar
Maxime Perrotin committed
467
                elif asnType == 'CHOICE':
Maxime Perrotin's avatar
Maxime Perrotin committed
468
469
470
471
472
473
474
475
                    value = ptr.kind.Get()
                    intMappings = child.data(INTMAP)
                    for enumerant, num in intMappings.viewitems():
                        if num == value:
                            child.setText(str(enumerant))
                            # is num really the row of this choice ? XXX
                            fillRow(root.child(i), num, dest=ptr, choice=True)
                            break
Maxime Perrotin's avatar
Maxime Perrotin committed
476
                elif asnType == 'SEQOF':
Maxime Perrotin's avatar
Maxime Perrotin committed
477
478
479
                    size = ptr.GetLength()
                    child.setText(str(size))
                    self.updateModel(root.child(i), ptr, nbRows=size)
Maxime Perrotin's avatar
Maxime Perrotin committed
480

Maxime Perrotin's avatar
Maxime Perrotin committed
481
482
            for i in xrange(nbRows):
                fillRow(root, i, ptr)
483
484
485

    def updateVariable(self, root=None):
        ''' Update the variable value (when loading a TC or receiving a TM) '''
486
        root = root or self.treeItem
Maxime Perrotin's avatar
Maxime Perrotin committed
487
        row = root.row()
Maxime Perrotin's avatar
Maxime Perrotin committed
488
        name = root.text()
489
        #value = var[name] # value replaced now by asn1Instance
490
        asnType = self.model.item(row, 1).text()
Maxime Perrotin's avatar
Maxime Perrotin committed
491
        if asnType == 'SEQOF':
492
493
494
495
496
            # Set the number of items in column 3
            nbElem = self.asn1Instance.GetLength()
            self.model.item(row, 3).setText(str(nbElem))
            # And set the values recursively
            self.updateModel(root, ptr=self.asn1Instance, nbRows=nbElem)
Maxime Perrotin's avatar
Maxime Perrotin committed
497
        elif asnType == 'CHOICE':
498
499
500
501
502
503
504
505
506
507
508
509
510
            kind = self.asn1Instance.kind.Get()
            # get the mapping to retrieve the choice name from the kind
            intMappings = self.model.item(row, 3).data(INTMAP)
            for enumerant, num in intMappings.viewitems():
                if num == kind:
                    break
            else:
                print("ERROR - CHOICE index not found in DV.py")
            # how to translate this kind number into the choice string?
            self.model.item(row, 3).setText(enumerant)
            # decode the actual value
            ptr = getattr(self.asn1Instance, enumerant)
            self.updateModel(root, ptr)
Maxime Perrotin's avatar
Maxime Perrotin committed
511
        elif asnType in ('INTEGER', 'REAL', 'STRING', 'BOOLEAN'):
512
513
514
            value = self.asn1Instance.Get()
            if asnType == 'BOOLEAN':
                value = 'True' if value else 'False'
515
            self.model.item(row, 3).setText(str(value))
Maxime Perrotin's avatar
Maxime Perrotin committed
516
        elif asnType == 'ENUMERATED':
517
518
519
520
521
522
523
524
525
            value = self.asn1Instance.Get()
            # get the mapping to retrieve the integer value
            intMappings = self.model.item(row, 3).data(INTMAP)
            for enumerant, num in intMappings.viewitems():
                if num == value:
                    self.model.item(row, 3).setText(enumerant)
                    break
            else:
                print("ERROR - ENUMERATED value not found")
Maxime Perrotin's avatar
Maxime Perrotin committed
526
        else:  # SEQUENCE or SET
527
            self.updateModel(root, self.asn1Instance)
Maxime Perrotin's avatar
Maxime Perrotin committed
528
        if asnType in ('INTEGER', 'REAL', 'SEQOF'):
529
            plotters = self.model.item(row, 3).data(PLOTTERS)
Maxime Perrotin's avatar
Maxime Perrotin committed
530
531
            if plotters != None:
                for plotter in plotters:
532
                    # XXX this won't work, value is not in the right format
Maxime Perrotin's avatar
Maxime Perrotin committed
533
                    self.plotterBackend.updatePlot(plotter, value)
534
        self.hideUnusedFields(root, True, row=row)
Maxime Perrotin's avatar
Maxime Perrotin committed
535
536
537
538
539
        if self.plotterBackend is not None:
            self.plotterBackend.refresh()
        # Inform the thread to update the tree (expand all branches)
        self.expandTree.emit()

540
    def tmToEditor(self, emit_msc=True):
Maxime Perrotin's avatar
Maxime Perrotin committed
541
542
        ''' Check validity of a TM and update the viewer with the value '''
        self.log.debug("Entering tmToEditor")
543
544
545
546
547
548
549
550
        self.updateVariable()
        # Send value to the MSC recorder
        name = self.item['nodeTypename'] # XXX probably wrong, name should be the name of the TM
        msg = name + '(' + self.asn1Instance.GSER() + ')'
        self.log.debug('Emitting input to MSC')
        if emit_msc:
            self.msc.emit('in', msg)
        self.new_tm.emit()
Maxime Perrotin's avatar
Maxime Perrotin committed
551
552
553
        self.log.debug("Leaving tmToEditor")

    def ProcessTM(self, rawMsg):
554
555
        ''' Decode a TM received from the msgQ (not UDP)
            and update the model '''
Maxime Perrotin's avatar
Maxime Perrotin committed
556
        self.log.debug("Entering ProcessTM")
557
558
559
560
        #native_tm = self.backend.decode_TM(rawMsg)
        self.asn1Instance.SetData(rawMsg)
        #pythonVar = self.backend.fromASN1ToPyside(self.asn1Instance)
        self.tmToEditor()
561
        for each in self.tm_clients:
562
            each.update(self.asn1Instance)
Maxime Perrotin's avatar
Maxime Perrotin committed
563
564
565
566
567
568
569
570
571
572
        self.log.debug("Leaving ProcessTM")

    @Slot()
    def receivedTM(self):
        ''' TM received from another thread (polling queue) '''
        if self.pendingTM:
            self.ProcessTM(self.pendingTM)
            self.pendingTM = None

    def ProcessUDPTM(self, uperMsg):
Maxime Perrotin's avatar
Maxime Perrotin committed
573
574
        ''' Decode an uPER-encoded TM (e.g. received from UDP sockets)
            and update the model '''
Maxime Perrotin's avatar
Maxime Perrotin committed
575
576
577
578
579
        native_tm = self.backend.decode_uPER(uperMsg)
        pythonVar = self.backend.fromASN1ToPyside(native_tm)
        self.tmToEditor(pythonVar)

    def saveTC(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
580
581
        ''' Encode the data using GSER (ASN.1 Value Notation) and save it
        to a file'''
582
583
584
        name = self.treeItem.text()
        gser = self.gser(use_dash=True)
        self.log.debug('Saving ' + gser)
Maxime Perrotin's avatar
Maxime Perrotin committed
585
586
587
588
        filename = QFileDialog.getSaveFileName(self,
                                               "Save TC",
                                               ".",
                                               "ASN.1 Variable (*.tc)")[0]
Maxime Perrotin's avatar
Maxime Perrotin committed
589
590
591
592
593
        try:
            if filename.split('.')[-1] != 'tc':
                filename += ".tc"
            tcFile = QFile(filename)
            tcFile.open(QIODevice.WriteOnly | QIODevice.Text)
594
            tcFile.write(str(gser))
Maxime Perrotin's avatar
Maxime Perrotin committed
595
596
597
598
            tcFile.close()
        except:
            pass

599
600
601
    @property
    def gser(self, use_dash=False):
        ''' Helper API function: return the GSER representation of the data '''
602
603
604
605
606
#        data, = self.getVariable().values()
        self.getVariable(dest=self.asn1Instance)
        res = self.asn1Instance.GSER()
#        raw = vn.toASN1ValueNotation(data).strip()
        return res if use_dash else res.replace('-', '_')
607

608
609
    def to_asn1scc_ctypes(self, root, dest, ASN1Mod, sort, ASN1_AST):
        ''' Helper API function: read variable and set ASN.1 Native variable
610
        Inputs: root: select which variable to parse
611
612
                dest: Native ctypes variable (will be modified)
                ASN1Mod: python module containing ctypes DV access
613
614
                sort: root ASN.1 typename (with dash, no underscores)
                ASN1_AST: full AST generated by ASN1SCC
615
        '''
616
617
618
619
620
621
622
623
        #var = self.getVariable(root).popitem()[1]
        self.getVariable(root=root, dest=dest)
#       vn.valueNotationToCTypes(gser=None,
#                                var=var,
#                                dest=dest,
#                                ASN1Mod=ASN1Mod,
#                                sort=sort,
#                                ASN1_AST=ASN1_AST)
624
625


Maxime Perrotin's avatar
Maxime Perrotin committed
626
627
    def sendTC(self):
        ''' Encode and send the TC to the main TASTE binary using message queue or UDP '''
628
629
630
631
632
633
        self.getVariable(dest=self.asn1Instance)
        gser = self.asn1Instance.GSER()
        msg = "{name}({gser})".format(name=self.treeItem.text(), gser=gser)
        self.log.debug('out ' + msg)
        self.msc.emit('out', msg)
        self.backend.sendTC(self.asn1Instance)
Maxime Perrotin's avatar
Maxime Perrotin committed
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655

    def loadTC(self):
        ''' Load/Decode a TC and populate the values in the model '''
        filename = QFileDialog.getOpenFileName(self, "Open TC", ".", "ASN.1 Variable (*.tc)")[0]
        if len(filename) == 0:
            return
        try:
            tcFile = QFile(filename)
            tcFile.open(QIODevice.ReadOnly | QIODevice.Text)
            asnVN = str(tcFile.readData(tcFile.size()))
            tcFile.close()
            pythonVar = vn.fromValueNotationToPySide(self.treeItem.text(), asnVN)
            self.updateVariable(pythonVar)
        except:
            pass

    def dataPath(self, idx):
        ''' Create a textual representation of a field path (e.g. myTM.myChoice.position.x) '''
        if not idx.isValid():
            return ''
        subpath = self.dataPath(idx.parent())
        if len(subpath)>0:
656
            subpath += '.'
Maxime Perrotin's avatar
Maxime Perrotin committed
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
        subpath += idx.data()
        return subpath

    def pathToIdx(self, path, root=None):
        ''' Find an index in the model based from a dot-splitted path representation '''
        if root is None:
            root = self.treeItem.index()
        if len(path) == 1:
            return QPersistentModelIndex(root) if root.data() == path[0] else None
        else:
            # Recursive call for each child
            for i in range(self.model.itemFromIndex(root).rowCount()):
                result = self.pathToIdx(path[1:], root.child(i, 0))
                if result is not None:
                    return result

    def newPlot(self, fifoId=-1, meter=False):
        ''' Add a set of data (based on selected lines) to a new plotter or speedometer '''
        selectedIdxs = self.selectedIndexes()
        # Count the number of eligible lines for plotting (discard non-numerical types)
        eligible=[]
        for idx in selectedIdxs:
            if idx.column() > 0:
                continue
            asntype = idx.sibling(idx.row(), 1).data()
            if asntype in ('INTEGER', 'REAL', 'SEQOF'):
                self.log.info('Candidate for plot: '+ self.dataPath(idx))
                discard = False
                if fifoId > 0:
                    currData=idx.sibling(idx.row(), 3).data(PLOTTERS)
                    if currData is not None:
                        for elem in currData:
                            if elem['fifoId'] == fifoId:
                                discard = True
                if not discard:
                    eligible.append(idx.sibling(idx.row(), 3))
                else:
                    self.log.info('(but discarding because already in current plot)')
            else:
                self.log.warning('Cannot plot {data} (type {asntype} is not numerical)'.format(data=idx.data(), asntype=asntype))
        if len(eligible) == 0:
            self.log.warning('No valid lines selected for the plot')
            self.statusBarMessage.emit('No valid lines selected for the plot')
            return
        if fifoId == -1 and not meter:
            fifoId = self.plotterBackend.newPlot()
        for idx in eligible:
            dataPath = self.dataPath(idx.sibling(idx.row(), 0))
            currData = idx.data(PLOTTERS)
            minRange = idx.data(MIN_RANGE)
            maxRange = idx.data(MAX_RANGE)
            if meter:
                fifoId = self.plotterBackend.newMeter(dataPath, minRange, maxRange)
            if currData is None:
                currData = []
            currData.append({'fifoId': int(fifoId), 'curveName': dataPath})
            idx.model().setData(idx, currData, PLOTTERS)
            # Keep track of all plotted values - used when saving the model state
            persistentIdx = QPersistentModelIndex(idx)
            if persistentIdx not in self.plottedIdxs:
                self.plottedIdxs.append(persistentIdx)

    def addToPlot(self):
        ''' Add a new curve to an existing plot window '''
        fifoId = self.sender().text().split()[-1]
        self.newPlot(int(fifoId))

    def setPlotterBackend(self, backend):
        ''' Set a "pointer" to the GnuPlot/Meter backend module '''
        self.plotterBackend = backend

    def meter(self):
        ''' Create speedometers for the selected values '''
        self.newPlot(meter=True)

732
733
734
735
736
737
738
739
740
741
    def custom(self, custom_class):
        ''' Handle user-defined widgets: for TC, provide access to the Send
        and Update APIs. Defined differently for the asn1Viwer (TM) class '''
        custom_handler = custom_class(self.item['nodeTypename']
                                      .replace('-', '_'), parent=self)
        # Attach the docking widget to the GUI (XXX refactor)
        self.parent().parent().parent().addDockWidget(Qt.RightDockWidgetArea,
                                                      custom_handler)
        custom_handler.setFloating(True)

Maxime Perrotin's avatar
Maxime Perrotin committed
742
743
744
745
    def displaytip(self, index):
        ''' Display a tip when the mouse moves above a cell '''
        asnType = index.sibling(index.row(), 1).data()
        constraint = index.sibling(index.row(), 2).data()
746
747
        self.statusBarMessage.emit(asnType + ' ' +
                             (constraint if constraint is not None else ''))
Maxime Perrotin's avatar
Maxime Perrotin committed
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813

    @Slot(QModelIndex, int, int)
    def seqofDisplay(self, parent, val, max):
        ''' Slot updating the number of SEQOF elements displayed '''
        for row in range(max):
            if int(row) < int(val):
                display = False
            else:
                display = True
            self.setRowHidden(row, parent, display)
        self.expandBranch.emit(parent)

    @Slot(QModelIndex, int, int)
    def choiceDisplay(self, parent, nbOfElem, choice):
        ''' Slot updating the current selected CHOICE element '''
        for row in range(nbOfElem):
            if int(choice) == int(row):
                display = False
            else:
                display = True
            self.setRowHidden(row, parent, display)
        self.expandBranch.emit(parent)

    def addInteger(self, elem):
        # Set default value (min range):
        val = QStandardItem('%d' % elem["minR"])
        # Define type attributes, later used to define the proper cell editor
        val.setData(elem["type"], ASN1TYPE)
        try:
            val.setData(elem["minR"], MIN_RANGE)
        except OverflowError:
            val.setData(-1000000, MIN_RANGE)
        try:
            val.setData(elem["maxR"], MAX_RANGE)
        except OverflowError:
            val.setData(1000000, MAX_RANGE)
        # Set the text for the constraint and add it to the 3rd column:
        constraint = QStandardItem('(%d..%d)' % (elem["minR"], elem["maxR"]))
        constraint.setData(QBrush(QColor("gray")), Qt.ForegroundRole)
        return {"value": val, "constraint": constraint}

    def addReal(self, elem):
        # Set default value (min range):
        val = QStandardItem('%.2f' % elem["minR"])
        # Define type attributes, later used to define the proper cell editor
        val.setData(elem["type"], ASN1TYPE)
        try:
            val.setData(elem["minR"], MIN_RANGE)
        except OverflowError:
            # Python cannot handle 64bit double - reducing the range in case of overflow
            val.setData(-10000000.0, MIN_RANGE)
        try:
            val.setData(elem["maxR"], MAX_RANGE)
        except OverflowError:
            val.setData(10000000.0, MAX_RANGE)
        # Set the text for the constraint and add it to the 3rd column:
        constraint = QStandardItem('(%.2f..%.2f)' % (elem["minR"], elem["maxR"]))
        constraint.setData(QBrush(QColor("gray")), Qt.ForegroundRole)
        return {"value": val, "constraint": constraint}

    def addEnum(self, elem):
        # Set default value (first enum value)
        val = QStandardItem(elem["values"][0])
        # Define type attributes, later used to define the proper cell editor
        val.setData(elem["type"], ASN1TYPE)  # type (ENUMERATED)
        val.setData(elem["values"], CHOICE_LIST)  # enum values
814
        val.setData(elem["valuesInt"], INTMAP) # mapping name - value
Maxime Perrotin's avatar
Maxime Perrotin committed
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
        constraint = QStandardItem()
        return {"value": val, "constraint": constraint}

    def addString(self, elem):
        # Set default value (empty string)
        if "default" in elem:
            defaultString = elem["default"]
        else:
            defaultString = ""
        val = QStandardItem(defaultString)
        # Define type attributes, later used to define the proper cell editor
        val.setData(elem["type"], ASN1TYPE)  # type (IA5String)
        val.setData(elem["minSize"], MIN_RANGE)  # size min
        val.setData(elem["maxSize"], MAX_RANGE)  # size max
        # Set the text for the constraint and add it to the 3rd column:
        if elem["minSize"] == elem["maxSize"]:
            constraintStr = 'SIZE(%d)' % elem["minSize"]
        else:
            constraintStr = 'SIZE(%d..%d)' % (elem["minSize"], elem["maxSize"])
        constraint = QStandardItem(constraintStr)
        constraint.setData(QBrush(QColor("gray")), Qt.ForegroundRole)
        return {"value": val, "constraint": constraint}

    def addBool(self, elem):
        # Set default value (True or False)
        val = QStandardItem(elem["default"])
        # Define type attributes, later used to define the proper cell editor
        val.setData(elem["type"], ASN1TYPE)  # type (BOOLEAN)
        val.setData(['True', 'False'], CHOICE_LIST)  # enum values
        constraint = QStandardItem()
        return {"value": val, "constraint": constraint}

    def addSequence(self, elem, parent):
        types = []
        values = []
        constraints = []

        for child in elem["children"]:
            field = self.addItem(child)
            parent.appendRow(field["item"])
            types.append(field["type"])
            values.append(field["value"])
            constraints.append(field["constraint"])

        parent.appendColumn(types)
        parent.appendColumn(constraints)
        parent.appendColumn(values)
        constraint = QStandardItem()
        val = QStandardItem()
        return {"value": val, "constraint": constraint}

    def addSeqOf(self, elem, parent):
        types = []
        values = []
        constraints = []
        for i in range(elem["maxSize"]):
            elem["seqoftype"]["id"] = "elem_%d" % i
            field = self.addItem(elem["seqoftype"])
            parent.appendRow(field["item"])
            types.append(field["type"])
            values.append(field["value"])
            constraints.append(field["constraint"])
        parent.appendColumn(types)
        parent.appendColumn(constraints)
        parent.appendColumn(values)
        if elem["minSize"] == elem["maxSize"]:
            constraintStr = 'SIZE(%d)' % elem["minSize"]
        else:
            constraintStr = 'SIZE(%d..%d)' % (elem["minSize"], elem["maxSize"])
        constraint = QStandardItem(constraintStr)
        constraint.setData(QBrush(QColor("gray")), Qt.ForegroundRole)
        val = QStandardItem('%d' % elem["minSize"])
        val.setData(elem["type"], ASN1TYPE)   # type (SEQOF)
        val.setData(elem["minSize"], MIN_RANGE)  # min number of elements
        val.setData(elem["maxSize"], MAX_RANGE)  # max number of elements
        return {"value": val, "constraint": constraint}

    def addChoice(self, elem, parent):
        types = []
        values = []
        constraints = []
        ids = []
        for choice in elem["choices"]:
            field = self.addItem(choice)
            ids.append(choice["id"])
            parent.appendRow(field["item"])
            types.append(field["type"])
            values.append(field["value"])
            constraints.append(field["constraint"])

        parent.appendColumn(types)
        parent.appendColumn(constraints)
        parent.appendColumn(values)

        val = QStandardItem(ids[0])  # default value: first choice
        # Define type attributes, later used to define the proper cell editor
        val.setData(elem["type"], ASN1TYPE)  # type (CHOICE)
        val.setData(ids, CHOICE_LIST)  # choice values
913
        val.setData(elem["choiceIdx"], INTMAP) # mapping name - DV value
Maxime Perrotin's avatar
Maxime Perrotin committed
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
        constraint = QStandardItem()
        return {"value": val, "constraint": constraint}

    def addItem(self, elem):
        # Add field name on the first column:
        field = QStandardItem(elem["id"])
        # Add type on the second column in gray:
        asnType = QStandardItem(elem["type"])
        asnType.setData(QBrush(QColor("gray")), Qt.ForegroundRole)

        # get the Value and Contraints fields for the different types:
        if elem["type"] == 'INTEGER':
            data = self.addInteger(elem)
        elif elem["type"] == 'REAL':
            data = self.addReal(elem)
        elif elem["type"] == 'BOOLEAN':
            data = self.addBool(elem)
        elif elem["type"] == 'ENUMERATED':
            data = self.addEnum(elem)
        elif elem["type"] == 'STRING':
            data = self.addString(elem)
        elif elem["type"] in ('SEQUENCE', 'SET'):
            data = self.addSequence(elem, field)
        elif elem["type"] == 'SEQOF':
            data = self.addSeqOf(elem, field)
        elif elem["type"] == 'CHOICE':
            data = self.addChoice(elem, field)
        else:
            print 'You are using a non-supported type: ' + elem["type"]
            sys.exit(-1)
        return {"item": field, "type": asnType, "value": data["value"], "constraint": data["constraint"]}


class asn1Viewer(asn1Editor):
    ''' TM Viewing class. Fields are not editable '''
    def __init__(self, parent=None):
950
        super(asn1Viewer, self).__init__(parent)
Maxime Perrotin's avatar
Maxime Perrotin committed
951
        self.setEditTriggers(QAbstractItemView.NoEditTriggers)
952
953
954
955
956
957
958
959
960
961
962

    def custom(self, custom_class):
        ''' Handle user-defined widgets: for TM make sure a signal is emitted
        with ASN1 value when a TM is received '''
        custom_handler = custom_class(parent=self)
        # Attach the docking widget to the GUI (XXX refactor)
        self.parent().parent().parent().addDockWidget(Qt.RightDockWidgetArea,
                                                      custom_handler)
        self.tm_clients.append(custom_handler)
        self.new_tm.connect(custom_handler.new_tm)
        custom_handler.setFloating(True)