Merge pull request #2 from ACRIOS-Systems/feature/support-comments-parsing

Add support for special characters in comment blocks

Author: Hadatko

dissect/cstruct/cstruct.py

@@ -81,7 +81,7 @@ def _read(self, stream):
 
         return Instance(self, r, sizes)
 
-    def add_fields(self, name, type_, offset=None, commentAttributes={}):
+    def add_fields(self, name, type_, offset=None, commentAttributes={{}}):
         raise NotImplementedError("Can't add fields to a compiled structure")
 
     def __repr__(self):
@@ -417,7 +417,7 @@ def _parse_fields(self, s):
             #parse the comment header
             if d['commentBlock'] is not None and d['commentBlock'].startswith('/*'):
                 commentfields = re.finditer(
-                    r'@(?P<commentType>[a-zA-Z0-9_\-\/,.]+):[ \t]*(?P<commentVal>[a-zA-Z0-9_\-,.]+)',
+                    r'@(?P<commentType>[^@,;:\\]+):[ \t]*(?P<commentVal>[^@,;:\s\\]+)',
                     d['commentBlock'],
                 )
                 for cf in commentfields:

tests/test_basic.py

@@ -779,13 +779,13 @@ def test_commentfieldparse(capsys):
     struct test{
         /*
         * @scale: 0.001
-        * @unit: testUnit1
+        * @unit: µtestUnit1
         */
         int testVar1;
         int testVar2;
         /* dicardedCom2
         * @scale: 5
-        * @unit: testUnit2
+        * @unit: %testUnit2
         */
         int testVar3;
     };
@@ -798,9 +798,9 @@ def test_commentfieldparse(capsys):
     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['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'
+    assert c.test.lookup['testVar3'].commentAttributes['unit'] == '%testUnit2'