asn1_value_editor.py 42.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
    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.6.5"
Maxime Perrotin's avatar
Maxime Perrotin committed
20
21
22
__url__ = "http://taste.tuxfamily.org"

import sys
Maxime Perrotin's avatar
Maxime Perrotin committed
23
import logging
Maxime Perrotin's avatar
Maxime Perrotin committed
24
25
26
27
28
29

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

import vn

MIN_RANGE = Qt.UserRole + 1
MAX_RANGE = Qt.UserRole + 2
37
38
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
39
40
41
42
43
PLOTTERS = Qt.UserRole + 4
ASN1TYPE = Qt.UserRole


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

    def contextMenuEvent(self, event):
50
51
        ''' When the context menu is open, add the Load from file action
        and open the menu '''
Maxime Perrotin's avatar
Maxime Perrotin committed
52
53
54
55
56
        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:
57
58
59
60
            filename = QFileDialog.getOpenFileName(self,
                                                  "Load string from file",
                                                  ".",
                                                  "All (*)")[0]
Maxime Perrotin's avatar
Maxime Perrotin committed
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
            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):
85
        super(TreeDelegate, self).__init__(oParent)
Maxime Perrotin's avatar
Maxime Perrotin committed
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

    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)
109
        elif asnType in ('ENUMERATED', 'CHOICE'):
Maxime Perrotin's avatar
Maxime Perrotin committed
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
162
            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
163
164
165
            self.seqof.emit(index.sibling(index.row(), 0),
                            val,
                            index.data(MAX_RANGE))
Maxime Perrotin's avatar
Maxime Perrotin committed
166
167
168
169
170
171
172
        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
173
174
175
            self.choice.emit(index.sibling(index.row(), 0),
                             len(index.data(CHOICE_LIST)),
                             editor.currentIndex())
Maxime Perrotin's avatar
Maxime Perrotin committed
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
        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':
192
193
            r = QRect(option.rect.x(), option.rect.y(),
                      option.rect.width(), max(option.rect.height(), 100))
Maxime Perrotin's avatar
Maxime Perrotin committed
194
195
196
197
198
199
200
201
202
203
204
        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)
205
206
    # Whenever a new TM is received, the new_tm signal is emitted
    new_tm = Signal()
Maxime Perrotin's avatar
Maxime Perrotin committed
207
208
    # Use a signal to tell the plots (matplotlib) to update
    plot_refresh = Signal()
Maxime Perrotin's avatar
Maxime Perrotin committed
209
210

    def __init__(self, parent=None):
211
        super(asn1Editor, self).__init__(parent)
Maxime Perrotin's avatar
Maxime Perrotin committed
212
        self.model = QStandardItemModel(1, 4)
213
214
        self.model.setHorizontalHeaderLabels(['Field', 'Type',
                                              'Constraints', 'Value'])
Maxime Perrotin's avatar
Maxime Perrotin committed
215
216
        self.delegate = TreeDelegate()
        self.setItemDelegate(self.delegate)
217
218
        # Set selection mode and behavior to allow multiple rows to be selected
        # with Ctrl/Shift keys
Maxime Perrotin's avatar
Maxime Perrotin committed
219
220
221
222
223
224
225
226
227
        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)
228
229
        # 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
230
231
232
233
234
235
236
        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 = []
Maxime Perrotin's avatar
Maxime Perrotin committed
237
        self.log = logging
238
        self.pendingTM = False
239
240
241
242
        # 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 = []
243
244
245
246
247
248
249
250
        # 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
251

252
253
254
255
    def setDefaultValue(self):
        # Update the value to get default values if set in ASN1
        self.updateVariable()

Maxime Perrotin's avatar
Maxime Perrotin committed
256
257
258
259
260
261
262
263
264
265
    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)

266
    def setAsn1Model(self, dataview, row=0):
Maxime Perrotin's avatar
Maxime Perrotin committed
267
        self.item = dataview
268
269
        rootItem = self.addItem(self.item)
        self.treeItem = rootItem["item"]
Maxime Perrotin's avatar
Maxime Perrotin committed
270

271
272
273
        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
274
275

        # Add the item to the actual tree. 0,0 = 1st row, 1st column
276
        self.model.setItem(row, 0, self.treeItem)
Maxime Perrotin's avatar
Maxime Perrotin committed
277
        self.setWindowTitle('ASN.1 Variable editor')
278
        self.hideUnusedFields(self.treeItem, start=True, row=row)
Maxime Perrotin's avatar
Maxime Perrotin committed
279
280
281
        self.setColumnWidth(0, 200)
        self.setColumnWidth(1, 150)
        self.expandAll()
282
        return rootItem["item"]
Maxime Perrotin's avatar
Maxime Perrotin committed
283

284
    def hideUnusedFields(self, root, start=False, row=0):
Maxime Perrotin's avatar
Maxime Perrotin committed
285
        ''' Hide CHOICE unselected fields and SEQUENCE OF out-of-range fields '''
286
        rootType = self.model.item(row, 1).text()
Maxime Perrotin's avatar
Maxime Perrotin committed
287
        if rootType == 'CHOICE' and start:
288
289
            choices = self.model.item(row, 3).data(CHOICE_LIST)
            currValue = self.model.item(row, 3).text()
Maxime Perrotin's avatar
Maxime Perrotin committed
290
291
292
            for j in range(len(choices)):
                if currValue == choices[j]:
                    break
293
            rowIndex = self.model.item(row).index()
Maxime Perrotin's avatar
Maxime Perrotin committed
294
295
            self.choiceDisplay(rowIndex, len(choices), j)
        elif rootType == 'SEQOF' and start:
296
297
298
            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
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
            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)

319
    def parseModel(self, root, nbRows=-1, dest=None, choice=-1):
320
321
        ''' Parse the model to get all field values recursively
            root type is QStandardItem
Maxime Perrotin's avatar
Maxime Perrotin committed
322
            dest is a ctypes instance of the type to fill
323
            choice >= 0 to specify a specific row to parse for a CHOICE
324
        '''
Maxime Perrotin's avatar
Maxime Perrotin committed
325
326
327
        if dest is None:
            self.log.error('parseModel: destination ASN.1 variable not set')

Maxime Perrotin's avatar
Maxime Perrotin committed
328
        if root.hasChildren():
Maxime Perrotin's avatar
Maxime Perrotin committed
329
330
            seqOf = True if nbRows != -1 else False
            if not seqOf:
Maxime Perrotin's avatar
Maxime Perrotin committed
331
                nbRows = root.rowCount()
332

333
            def parseRow(root, i, dest, seqOf=False):
Maxime Perrotin's avatar
Maxime Perrotin committed
334
                name    = root.child(i, 0).text().replace('-', '_')
Maxime Perrotin's avatar
Maxime Perrotin committed
335
                asnType = root.child(i, 1).text()
Maxime Perrotin's avatar
Maxime Perrotin committed
336
                value   = root.child(i, 3).text()
Maxime Perrotin's avatar
Maxime Perrotin committed
337
                ptr = getattr(dest, name) if not seqOf else dest
338
339
                if seqOf:
                    ptr = ptr[i]
Maxime Perrotin's avatar
Maxime Perrotin committed
340

Maxime Perrotin's avatar
Maxime Perrotin committed
341
                if asnType in ('SEQUENCE', 'SET'):
Maxime Perrotin's avatar
Maxime Perrotin committed
342
343
344
                    if root.child(i).hasChildren():
                        # Discard empty sequence
                        self.parseModel(root.child(i), dest=ptr)
Maxime Perrotin's avatar
Maxime Perrotin committed
345
                elif asnType == 'SEQOF':
Maxime Perrotin's avatar
Maxime Perrotin committed
346
                    state = ptr.GetState()
347
                    self.parseModel(root.child(i), nbRows=int(value), dest=ptr)
Maxime Perrotin's avatar
Maxime Perrotin committed
348
349
                    ptr.SetLength(int(value))
                    ptr.Reset(state)
Maxime Perrotin's avatar
Maxime Perrotin committed
350
                elif asnType == 'CHOICE':
351
352
353
354
                    state = ptr.GetState()
                    # We must parse only one row, containing the choice (value)
                    chrow = root.child(i)
                    for rownb in xrange(chrow.rowCount()):
Maxime Perrotin's avatar
Maxime Perrotin committed
355
356
                        curr = chrow.child(rownb, 0).text()
                        if curr == value:
357
358
359
                            # set rownb to the row of the current choice
                            break
                    else:
Maxime Perrotin's avatar
Maxime Perrotin committed
360
                        raise TypeError('CHOICE row not found')
361
                    parseRow(chrow, rownb, dest=ptr)
362
                    ptr.Reset(state)
Maxime Perrotin's avatar
Maxime Perrotin committed
363
364
365
366
367
368
369
                    intMappings = root.child(i, 3).data(INTMAP)
                    for enumerant, num in intMappings.viewitems():
                        if enumerant == value:
                            ptr.kind.Set(num)
                            break
                    else:
                        raise TypeError('CHOICE determinant not found')
Maxime Perrotin's avatar
Maxime Perrotin committed
370
                elif asnType == 'INTEGER':
371
                    ptr.Set(int(value))
Maxime Perrotin's avatar
Maxime Perrotin committed
372
                elif asnType == 'REAL':
373
                    ptr.Set(float(value))
Maxime Perrotin's avatar
Maxime Perrotin committed
374
                elif asnType == 'BOOLEAN':
Maxime Perrotin's avatar
Maxime Perrotin committed
375
                    boolValue = value == 'True'
376
                    ptr.Set(boolValue)
Maxime Perrotin's avatar
Maxime Perrotin committed
377
                elif asnType == 'ENUMERATED':
Maxime Perrotin's avatar
Maxime Perrotin committed
378
379
380
381
382
383
384
                    intMappings = root.child(i, 3).data(INTMAP)
                    for enumerant, num in intMappings.viewitems():
                        if enumerant == value:
                            ptr.Set(num)
                            break
                    else:
                        raise TypeError('ENUMERATED value not found')
Maxime Perrotin's avatar
Maxime Perrotin committed
385
                else:  # Strings
386
                    ptr.SetFromPyString(value)
387
388
389

            if choice != -1:
                # Read only the row of the choice selection
Maxime Perrotin's avatar
Maxime Perrotin committed
390
                stateBefore = dest.GetState()
391
                parseRow(root, choice, dest, seqOf=False)
Maxime Perrotin's avatar
Maxime Perrotin committed
392
                dest.Reset(stateBefore)
393
394
395
396
397
            else:
                for i in xrange(nbRows):  # for each child row
                    stateBefore = dest.GetState()
                    parseRow(root, i, dest, seqOf=seqOf)
                    dest.Reset(stateBefore)
398
        else:  # single elements (all but SeqOf, Choice, Sequence)
Maxime Perrotin's avatar
Maxime Perrotin committed
399
            row = root.row()
400
401
402
403
404
405
406
            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
407
            if asnType == 'INTEGER':
Maxime Perrotin's avatar
Maxime Perrotin committed
408
                # TESTED OK
409
                dest.Set(int(value))
Maxime Perrotin's avatar
Maxime Perrotin committed
410
            elif asnType == 'REAL':
Maxime Perrotin's avatar
Maxime Perrotin committed
411
                # TESTED OK
412
                dest.Set(float(value))
Maxime Perrotin's avatar
Maxime Perrotin committed
413
            elif asnType == 'BOOLEAN':
Maxime Perrotin's avatar
Maxime Perrotin committed
414
                # TESTED OK
415
                dest.Set(True if value == 'True' else False)
Maxime Perrotin's avatar
Maxime Perrotin committed
416
            elif asnType == 'ENUMERATED':
Maxime Perrotin's avatar
Maxime Perrotin committed
417
418
419
420
421
422
423
424
425
426
                # TESTED OK
                intMappings = self.model.item(row, 3).data(INTMAP)
                for enumerant, num in intMappings.viewitems():
                    if enumerant == value:
                        dest.Set(num)
                        break
                else:
                    self.log.error('Missing enumerted or bug - please report')
            elif asnType == 'STRING':
                dest.SetFromPyString(value)
Maxime Perrotin's avatar
Maxime Perrotin committed
427
            else:
Maxime Perrotin's avatar
Maxime Perrotin committed
428
                self.log.error('Unsupported type: please report bug')
Maxime Perrotin's avatar
Maxime Perrotin committed
429

430
431
432
    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
433
            dest is a ctypes instance of the given type, that
434
435
436
            will be filled by the recursive parser.
        '''
        assert dest is not None
437
438
        root = root or self.treeItem
        row = root.row()
Maxime Perrotin's avatar
Maxime Perrotin committed
439
        name = root.text()
440
        asnType = self.model.item(row, 1).text()
Maxime Perrotin's avatar
Maxime Perrotin committed
441
        if asnType == 'SEQOF':
442
            nbRows = int(self.model.item(row, 3).text())
443
            self.parseModel(root, nbRows=nbRows, dest=dest)
Maxime Perrotin's avatar
Maxime Perrotin committed
444
            dest.SetLength(nbRows)
Maxime Perrotin's avatar
Maxime Perrotin committed
445
        elif asnType == 'CHOICE':
446
            value = self.model.item(row, 3).text()
447
448
449
450
451
452
453
454
            # We must parse only one row, containing the choice (value)
            for rownb in xrange(root.rowCount()):
                curr = root.child(rownb, 0).text()
                if curr == value:
                    break
            else:
                raise TypeError('CHOICE ROW not found')
            self.parseModel(root, dest=dest, choice=rownb)
Maxime Perrotin's avatar
Maxime Perrotin committed
455
456
457
458
459
460
461
            intMappings = self.model.item(row, 3).data(INTMAP)
            for enumerant, num in intMappings.viewitems():
                if enumerant == value:
                    dest.kind.Set(num)
                    break
            else:
                raise TypeError('CHOICE discriminant not found')
Maxime Perrotin's avatar
Maxime Perrotin committed
462
        else:
463
            self.parseModel(root, dest=dest)
Maxime Perrotin's avatar
Maxime Perrotin committed
464

Maxime Perrotin's avatar
Maxime Perrotin committed
465
    def updateModel(self, root, ptr, nbRows=-1, choice=-1):
Maxime Perrotin's avatar
Maxime Perrotin committed
466
        ''' Recursive update of the values in the GUI from ASN.1 instance '''
Maxime Perrotin's avatar
Maxime Perrotin committed
467
        def fillRow(root, i, dest, seqOf=False):
Maxime Perrotin's avatar
Maxime Perrotin committed
468
469
470
471
472
473
            name    = root.child(i, 0).text().replace('-', '_')
            asnType = root.child(i, 1).text()
            child   = root.child(i, 3)
            ptr = getattr(dest, name) if not seqOf else dest
            if seqOf:
                ptr = ptr[i]
Maxime Perrotin's avatar
Maxime Perrotin committed
474
            if asnType in ('INTEGER', 'REAL'):
Maxime Perrotin's avatar
Maxime Perrotin committed
475
                child.setText(str(ptr.Get()))
Maxime Perrotin's avatar
Maxime Perrotin committed
476
477
            elif asnType == 'BOOLEAN':
                child.setText('True' if ptr.Get() else 'False')
Maxime Perrotin's avatar
Maxime Perrotin committed
478
479
480
481
482
483
484
485
486
487
            elif asnType == 'STRING':
                child.setText(ptr.GetPyString())
            elif asnType == 'ENUMERATED':
                value = ptr.Get()
                intMappings = child.data(INTMAP)
                for enumerant, num in intMappings.viewitems():
                    if num == value:
                        child.setText(enumerant)
                        break
                else:
Maxime Perrotin's avatar
Maxime Perrotin committed
488
                    raise TypeError("ENUMERATED value not found")
Maxime Perrotin's avatar
Maxime Perrotin committed
489
490
491
492
            elif asnType in ('SEQUENCE', 'SET'):
                self.updateModel(root.child(i), ptr)
            elif asnType == 'CHOICE':
                state = ptr.GetState()
Maxime Perrotin's avatar
Maxime Perrotin committed
493
                valueNum = ptr.kind.Get()
Maxime Perrotin's avatar
Maxime Perrotin committed
494
495
                ptr.Reset(state)
                intMappings = child.data(INTMAP)
Maxime Perrotin's avatar
Maxime Perrotin committed
496
                choiceList = child.data(CHOICE_LIST)
Maxime Perrotin's avatar
Maxime Perrotin committed
497
                for enumerant, num in intMappings.viewitems():
Maxime Perrotin's avatar
Maxime Perrotin committed
498
                    if num == valueNum:
Maxime Perrotin's avatar
Maxime Perrotin committed
499
                        child.setText(str(enumerant))
Maxime Perrotin's avatar
Maxime Perrotin committed
500
501
502
503
                        # Find the choice row number
                        for rowNb, choiceName in enumerate(choiceList):
                            if choiceName == enumerant:
                                fillRow(root.child(i),
Maxime Perrotin's avatar
Maxime Perrotin committed
504
                                        rowNb, dest=ptr)
Maxime Perrotin's avatar
Maxime Perrotin committed
505
506
507
                                break
                        else:
                            raise TypeError('CHOICE ROW not found')
Maxime Perrotin's avatar
Maxime Perrotin committed
508
                        break
Maxime Perrotin's avatar
Maxime Perrotin committed
509
510
                else:
                    raise TypeError('fillRow: CHOICE determinant not found')
Maxime Perrotin's avatar
Maxime Perrotin committed
511
512
513
514
515
516
            elif asnType == 'SEQOF':
                state = ptr.GetState()
                size = ptr.GetLength()
                ptr.Reset(state)
                child.setText(str(size))
                self.updateModel(root.child(i), ptr, nbRows=size)
Maxime Perrotin's avatar
Maxime Perrotin committed
517
518
519
520
521
522
523
524
            if asnType in ('INTEGER', 'REAL', 'SEQOF'):
                plotters = child.data(PLOTTERS)
                if plotters is not None:
                    self.log.debug("updateModel - updatePlot call")
                    value = float(child.text())
                    for plotter in plotters:
                        self.plotterBackend.updatePlot(plotter, value)
                    self.log.debug("updateModel - updatePlot end")
Maxime Perrotin's avatar
Maxime Perrotin committed
525

Maxime Perrotin's avatar
Maxime Perrotin committed
526
527
528
529
530
531
532
533
534
        if choice != -1:
            stateBefore = ptr.GetState()
            fillRow(root, choice, ptr)
            ptr.Reset(stateBefore)
        else:
            if root.hasChildren():
                seqOf = True if nbRows != -1 else False
                if not seqOf:
                    nbRows = root.rowCount()
Maxime Perrotin's avatar
Maxime Perrotin committed
535

Maxime Perrotin's avatar
Maxime Perrotin committed
536
537
538
539
                for i in xrange(nbRows):
                    stateBefore = ptr.GetState()
                    fillRow(root, i, ptr, seqOf=seqOf)
                    ptr.Reset(stateBefore)
540

Maxime Perrotin's avatar
Maxime Perrotin committed
541
    def updateVariable(self, root=None, asn1Var=None):
542
        ''' Update the variable value (when loading a TC or receiving a TM) '''
Maxime Perrotin's avatar
Maxime Perrotin committed
543
        root         = root or self.treeItem
Maxime Perrotin's avatar
Maxime Perrotin committed
544
        asn1Instance = asn1Var or self.asn1Instance
Maxime Perrotin's avatar
Maxime Perrotin committed
545
546
        row          = root.row()
        asnType      = self.model.item(row, 1).text()
Maxime Perrotin's avatar
Maxime Perrotin committed
547
        asn1Instance.Reset()
Maxime Perrotin's avatar
Maxime Perrotin committed
548

Maxime Perrotin's avatar
Maxime Perrotin committed
549
        if asnType == 'SEQOF':
550
            # Set the number of items in column 3
Maxime Perrotin's avatar
Maxime Perrotin committed
551
            nbElem = asn1Instance.GetLength()
552
553
            self.model.item(row, 3).setText(str(nbElem))
            # And set the values recursively
Maxime Perrotin's avatar
Maxime Perrotin committed
554
            self.updateModel(root, ptr=asn1Instance, nbRows=nbElem)
Maxime Perrotin's avatar
Maxime Perrotin committed
555
        elif asnType == 'CHOICE':
Maxime Perrotin's avatar
Maxime Perrotin committed
556
            kind = asn1Instance.kind.Get()
557
558
559
560
561
562
            # 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:
Maxime Perrotin's avatar
Maxime Perrotin committed
563
                self.log.error("CHOICE index not found in DV.py")
564
            self.model.item(row, 3).setText(enumerant)
Maxime Perrotin's avatar
Maxime Perrotin committed
565
566
567
568
569
570
571
            # Find the row and set the value
            for rownb in xrange(root.rowCount()):
                if enumerant == root.child(rownb, 0).text():
                    break
            else:
                raise TypeError('(SET) CHOICE ROW not found')
            self.updateModel(root, asn1Instance, choice=rownb)
Maxime Perrotin's avatar
Maxime Perrotin committed
572
573
574
575
576
577
578
        elif asnType in ('INTEGER', 'REAL'):
            self.model.item(row, 3).setText(str(asn1Instance.Get()))
        elif asnType == 'BOOLEAN':
            value = 'True' if asn1Instance.Get() else 'False'
            self.model.item(row, 3).setText(value)
        elif asnType == 'STRING':
            self.model.item(row, 3).setText(asn1Instance.GetPyString())
Maxime Perrotin's avatar
Maxime Perrotin committed
579
        elif asnType == 'ENUMERATED':
Maxime Perrotin's avatar
Maxime Perrotin committed
580
            value = asn1Instance.Get()
581
582
583
            # get the mapping to retrieve the integer value
            intMappings = self.model.item(row, 3).data(INTMAP)
            for enumerant, num in intMappings.viewitems():
Maxime Perrotin's avatar
Maxime Perrotin committed
584
585
                # XXX if value is not initialized and no enum has value 0
                # an error will be raised
586
587
588
589
                if num == value:
                    self.model.item(row, 3).setText(enumerant)
                    break
            else:
Maxime Perrotin's avatar
Maxime Perrotin committed
590
                self.log.error("ENUMERATED value '{}' not found".format(value))
Maxime Perrotin's avatar
Maxime Perrotin committed
591
        else:  # SEQUENCE or SET
Maxime Perrotin's avatar
Maxime Perrotin committed
592
            self.updateModel(root, asn1Instance)
Maxime Perrotin's avatar
Maxime Perrotin committed
593
        if asnType in ('INTEGER', 'REAL', 'SEQOF'):
Maxime Perrotin's avatar
Maxime Perrotin committed
594
595
596
597
            plotters = self.model.item(row, 3).data(PLOTTERS) or []
            value = self.model.item(row, 3).text()
            for plotter in plotters:
                self.plotterBackend.updatePlot(plotter, float(value))
598
        self.hideUnusedFields(root, True, row=row)
Maxime Perrotin's avatar
Maxime Perrotin committed
599
        if self.plotterBackend is not None:
Maxime Perrotin's avatar
Maxime Perrotin committed
600
601
            self.plot_refresh.emit()
            #self.plotterBackend.refresh()
Maxime Perrotin's avatar
Maxime Perrotin committed
602
603
604
        # Inform the thread to update the tree (expand all branches)
        self.expandTree.emit()

605
    def tmToEditor(self, emit_msc=True):
Maxime Perrotin's avatar
Maxime Perrotin committed
606
        ''' Check validity of a TM and update the viewer with the value '''
607
608
        self.updateVariable()
        # Send value to the MSC recorder
Maxime Perrotin's avatar
Maxime Perrotin committed
609
610
611
        name = self.item['id']
        msg = name + '(' + vn.format_gser(self.asn1Instance.GSER()) + ')'
        self.log.debug('MSC: '+ msg)
612
613
614
        if emit_msc:
            self.msc.emit('in', msg)
        self.new_tm.emit()
Maxime Perrotin's avatar
Maxime Perrotin committed
615
616
617
618
619

    @Slot()
    def receivedTM(self):
        ''' TM received from another thread (polling queue) '''
        if self.pendingTM:
620
621
622
623
624
625
            self.log.debug("Got TM from MsgQ")
            self.tmToEditor()
            # Send TM to user custom widgets
            for each in self.tm_clients:
                each.update(self.asn1Instance)
            self.pendingTM = False
Maxime Perrotin's avatar
Maxime Perrotin committed
626
627

    def ProcessUDPTM(self, uperMsg):
Maxime Perrotin's avatar
Maxime Perrotin committed
628
629
        ''' Decode an uPER-encoded TM (e.g. received from UDP sockets)
            and update the model '''
630
631
632
633
634
        self.log.error('DEPRECATED - UDP channel not supported anymore')
        return
        #native_tm = self.backend.decode_uPER(uperMsg)
        #pythonVar = self.backend.fromASN1ToPyside(native_tm)
        #self.tmToEditor(pythonVar)
Maxime Perrotin's avatar
Maxime Perrotin committed
635

636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
#   def saveTC(self):
#   DEPRECATED - Load/Save TC must be done with databases
#       ''' Encode the data using GSER (ASN.1 Value Notation) and save it
#       to a file'''
#       name = self.treeItem.text()
#       gser = self.gser(use_dash=True)
#       self.log.debug('Saving ' + gser)
#       filename = QFileDialog.getSaveFileName(self,
#                                              "Save TC",
#                                              ".",
#                                              "ASN.1 Variable (*.tc)")[0]
#       try:
#           if filename.split('.')[-1] != 'tc':
#               filename += ".tc"
#           tcFile = QFile(filename)
#           tcFile.open(QIODevice.WriteOnly | QIODevice.Text)
#           tcFile.write(str(gser))
#           tcFile.close()
#       except:
#           pass
Maxime Perrotin's avatar
Maxime Perrotin committed
656

657
658
    def gser(self, use_dash=False):
        ''' Helper API function: return the GSER representation of the data '''
659
        self.getVariable(dest=self.asn1Instance)
Maxime Perrotin's avatar
Maxime Perrotin committed
660
        res = vn.format_gser(self.asn1Instance.GSER())
661
        return res if use_dash else res.replace('-', '_')
662

663
664
    def to_asn1scc_ctypes(self, root, dest, ASN1Mod, sort, ASN1_AST):
        ''' Helper API function: read variable and set ASN.1 Native variable
665
        Inputs: root: select which variable to parse
666
667
                dest: Native ctypes variable (will be modified)
                ASN1Mod: python module containing ctypes DV access
668
669
                sort: root ASN.1 typename (with dash, no underscores)
                ASN1_AST: full AST generated by ASN1SCC
670
        '''
Maxime Perrotin's avatar
Maxime Perrotin committed
671
        # DEPRECATED - call getVariable directly
672
        self.getVariable(root=root, dest=dest)
673

Maxime Perrotin's avatar
Maxime Perrotin committed
674
    def sendTC(self):
Maxime Perrotin's avatar
Maxime Perrotin committed
675
676
        ''' Encode and send the TC to the main TASTE binary
            using message queue or UDP '''
677
        self.getVariable(dest=self.asn1Instance)
Maxime Perrotin's avatar
Maxime Perrotin committed
678
        gser = vn.format_gser(self.asn1Instance.GSER())
679
680
681
682
        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
683

684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
#   def loadTC(self, dest=None):
#   DEPRECATED / Load/Save of TC must be done with databases
#       ''' Load/Decode a TC and populate the values in the model '''
#       dest = dest or self.asn1Instance
#       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()
#           vn.valueNotationToCTypes(gser=asnVN,
#                                    dest=dest,
#                                    sort=,
#                                    ASN1Mod=,
#                                    ASN1_AST=)
#       except:
#           self.log.error('TC not loaded')
Maxime Perrotin's avatar
Maxime Perrotin committed
706
707

    def dataPath(self, idx):
Maxime Perrotin's avatar
Maxime Perrotin committed
708
709
        ''' Create a textual representation of a field path
            (e.g. myTM.myChoice.position.x) '''
Maxime Perrotin's avatar
Maxime Perrotin committed
710
711
712
713
        if not idx.isValid():
            return ''
        subpath = self.dataPath(idx.parent())
        if len(subpath)>0:
714
            subpath += '.'
Maxime Perrotin's avatar
Maxime Perrotin committed
715
716
717
718
        subpath += idx.data()
        return subpath

    def pathToIdx(self, path, root=None):
Maxime Perrotin's avatar
Maxime Perrotin committed
719
720
        ''' Find an index in the model based from a dot-splitted
            path representation '''
Maxime Perrotin's avatar
Maxime Perrotin committed
721
722
723
724
725
726
727
728
729
730
731
732
        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):
Maxime Perrotin's avatar
Maxime Perrotin committed
733
734
        ''' Add a set of data (based on selected lines) to a new plotter
            or speedometer '''
Maxime Perrotin's avatar
Maxime Perrotin committed
735
736
737
738
739
740
741
742
743
744
745
746
747
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
        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)

792
793
794
795
796
797
798
799
800
801
    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
802
803
804
805
    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()
806
807
        self.statusBarMessage.emit(asnType + ' ' +
                             (constraint if constraint is not None else ''))
Maxime Perrotin's avatar
Maxime Perrotin committed
808
809
810
811
812
813
814
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

    @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
874
        val.setData(elem["valuesInt"], INTMAP) # mapping name - value
Maxime Perrotin's avatar
Maxime Perrotin committed
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
913
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
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
        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
973
        val.setData(elem["choiceIdx"], INTMAP) # mapping name - DV value
Maxime Perrotin's avatar
Maxime Perrotin committed
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
        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:
Maxime Perrotin's avatar
Maxime Perrotin committed
1002
            raise TypeError('Unsupported type: ' + elem["type"])
Maxime Perrotin's avatar
Maxime Perrotin committed
1003
1004
1005
1006
1007
1008
1009
            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):
1010
        super(asn1Viewer, self).__init__(parent)
Maxime Perrotin's avatar
Maxime Perrotin committed
1011
        self.setEditTriggers(QAbstractItemView.NoEditTriggers)
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022

    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)