Corrections to commentAttributes parsing logic

*minor cstruct.py fixes
*added functioning test to verify comments parsing

Signed-off-by: qcabrol

Author: cabrol

dissect/cstruct/cstruct.py

@@ -412,6 +412,8 @@ def _parse_fields(self, s):
             if d['type'].startswith('//'):
                 continue
 
+            commentAttributes={}
+
             #parse the comment header
             if d['commentBlock'] is not None and d['commentBlock'].startswith('/*'):
                 commentfields = re.finditer(
@@ -447,7 +449,7 @@ def _parse_fields(self, s):
                 d['name'] = d['name'][1:]
                 type_ = Pointer(self.cstruct, type_)
 
-            field = Field(d['name'], type_, int(d['bits']) if d['bits'] else None, commentAttributes)
+            field = Field(d['name'], type_, int(d['bits']) if d['bits'] else None, commentAttributes=commentAttributes)
             r.append(field)
 
         return r
@@ -761,6 +763,7 @@ def __init__(self, cstruct, name, fields=None):
         self.lookup = OrderedDict()
         self.fields = fields if fields else []
 
+
         for f in self.fields:
             self.lookup[f.name] = f
 
@@ -983,15 +986,15 @@ def reset(self):
 class Field(object):
     """Holds a structure field."""
 
-    def __init__(self, name, type_, bits=None, offset=None, commentAttributes=None):
+    def __init__(self, name, type_, bits=None, offset=None, commentAttributes={}):
         self.name = name
         self.type = type_
         self.bits = bits
         self.offset = offset
         self.commentAttributes = commentAttributes
 
     def __repr__(self):
-        return '<Field {} {}>'.format(self.name, self.type)
+        return '<Field {} {} {}>'.format(self.name, self.type, self.commentAttributes)
 
 
 class Array(BaseType):

tests/test_basic.py

@@ -770,3 +770,37 @@ def test_dumpstruct(capsys):
     captured_2 = capsys.readouterr()
 
     assert captured_1.out == captured_2.out
+
+
+def test_commentfieldparse(capsys):
+    c = cstruct.cstruct()
+    c.load("""
+    /*discardedCom1*/
+    struct test{
+        /*
+        * @scale: 0.001
+        * @unit: testUnit1
+        */
+        int testVar1;
+        int testVar2;
+        /* dicardedCom2
+        * @scale: 5
+        * @unit: testUnit2
+        */
+        int testVar3;
+    };
+    """, compiled=False)
+
+    assert c.test.name == 'test'
+
+    assert 'testVar1' in c.test.lookup
+    assert 'testVar2' in c.test.lookup
+    assert 'testVar2' in c.test.lookup
+
+    assert c.test.lookup['testVar1'].commentAttributes['scale'] == '0.001'
+    assert c.test.lookup['testVar1'].commentAttributes['unit'] == 'testUnit1'
+
+    assert c.test.lookup['testVar2'].commentAttributes == {}
+
+    assert c.test.lookup['testVar3'].commentAttributes['scale'] == '5'
+    assert c.test.lookup['testVar3'].commentAttributes['unit'] == 'testUnit2'