idl-parser 0.1.0__tar.gz → 0.2.0__tar.gz

idl_parser-0.2.0/.github/workflows/test.yml

@@ -0,0 +1,70 @@
+name: Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+  workflow_call: # reused by release.yml before building
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    name: Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      # Tests open IDL files by relative path (idls/...), so run from the repository root.
+      - name: Run tests
+        run: python -m unittest discover --start-directory tests --pattern '*_test.py' --top-level-directory . --verbose
+
+  lint:
+    name: Check undefined names
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+
+      # Catches names that are used but never defined or imported (F821 etc.).
+      # Such bugs hide in error paths that the tests do not reach.
+      - name: Run ruff
+        run: |
+          python -m pip install ruff
+          ruff check --select F821,F822,F823 --output-format github idl_parser
+
+  docs:
+    name: Build docs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0 # setuptools-scm needs tags for the version shown in the docs
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+
+      # Same settings as Read the Docs (.readthedocs.yaml): warnings are errors.
+      - name: Build HTML docs
+        run: |
+          python -m pip install -r docs/requirements.txt .
+          python -m sphinx -W --keep-going -b html docs docs/_build/html

idl_parser-0.2.0/.gitignore

@@ -0,0 +1,6 @@
+*.pyc
+*~
+*.egg-info
+build/*
+dist/*docs/_build/
+docs/api/generated/

idl_parser-0.2.0/.readthedocs.yaml

@@ -0,0 +1,22 @@
+# Read the Docs configuration
+# https://docs.readthedocs.io/en/stable/config-file/v2.html
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+  jobs:
+    # setuptools-scm derives the version from git tags, so fetch full history/tags
+    post_checkout:
+      - git fetch --unshallow --tags || true
+
+sphinx:
+  configuration: docs/conf.py
+  fail_on_warning: true
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .

{idl_parser-0.1.0/idl_parser.egg-info → idl_parser-0.2.0}/PKG-INFO

@@ -1,9 +1,10 @@
 Metadata-Version: 2.4
 Name: idl_parser
-Version: 0.1.0
+Version: 0.2.0
 Summary: Very simple OMG IDL (Interface Definition Language) parser. This parses IDL files and outputs intermediate class objects.
 Author-email: ysuga <ysuga@ysuga.net>
 Project-URL: Homepage, http://www.sugarsweetrobotics.com/
+Project-URL: Documentation, https://idl-parser.readthedocs.io/
 Project-URL: Source, https://github.com/sugarsweetrobotics/idl_parser
 Project-URL: Issues, https://github.com/sugarsweetrobotics/idl_parser/issues
 Classifier: Development Status :: 5 - Production/Stable
@@ -21,13 +22,18 @@ Description-Content-Type: text/x-rst
 idl_parser
 ============
 
-|Test Status|
+|Test Status| |Docs Status|
 
 Description 
 -----------
 
 OMG IDL file parser. This library just parse IDL files, and output intermidiate type objects.
 
+Documentation
+-------------
+
+API reference and usage: https://idl-parser.readthedocs.io/
+
 Example
 -----------
 
@@ -68,26 +74,26 @@ Example
   global_module = parser_.load(idl_str)
   my_module = global_module.module_by_name('my_module')
   dataGetter = my_module.interface_by_name('DataGetter')
-  print 'DataGetter interface'
-  for m in dataGetter.methods: 
-    print '- method:'
-    print '  name:', m.name
-    print '  returns:', m.returns.name
-    print '  arguments:'
+  print('DataGetter interface')
+  for m in dataGetter.methods:
+    print('- method:')
+    print('  name:', m.name)
+    print('  returns:', m.returns.name)
+    print('  arguments:')
     for a in m.arguments:
-      print '    name:', a.name
-      print '    type:', a.type
-      print '    direction:', a.direction
+      print('    name:', a.name)
+      print('    type:', a.type)
+      print('    direction:', a.direction)
     
   doubleSeq = my_module.typedef_by_name('DoubleSeq')
-  print 'typedef %s %s' % (doubleSeq.type.name, doubleSeq.name)
+  print('typedef %s %s' % (doubleSeq.type.name, doubleSeq.name))
 
   timedDoubleSeq = my_module.struct_by_name('TimedDoubleSeq')
-  print 'TimedDoubleSeq'
+  print('TimedDoubleSeq')
   for m in timedDoubleSeq.members:
-    print '- member:'
-    print '  name:', m.name
-    print '  type:', m.type.name    
+    print('- member:')
+    print('  name:', m.name)
+    print('  type:', m.type.name)
 
 How to install
 ---------------
@@ -108,3 +114,7 @@ Copyright
 
 .. |Test Status| image:: https://github.com/sugarsweetrobotics/idl_parser/actions/workflows/test.yml/badge.svg?branch=main
    :target: https://github.com/sugarsweetrobotics/idl_parser/actions/workflows/test.yml
+
+.. |Docs Status| image:: https://readthedocs.org/projects/idl-parser/badge/?version=latest
+   :target: https://idl-parser.readthedocs.io/en/latest/
+   :alt: Documentation Status

{idl_parser-0.1.0 → idl_parser-0.2.0}/README.md

@@ -1,12 +1,17 @@
 # idl_parser
 
 [![Test](https://github.com/sugarsweetrobotics/idl_parser/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/sugarsweetrobotics/idl_parser/actions/workflows/test.yml)
+[![Documentation Status](https://readthedocs.org/projects/idl-parser/badge/?version=latest)](https://idl-parser.readthedocs.io/en/latest/)
 
 
 ## Description 
 
 OMG IDL file parser. This library just parse IDL files, and output intermidiate type objects.
 
+## Documentation
+
+API reference and usage: https://idl-parser.readthedocs.io/
+
 ## Example
 ```
 """
@@ -44,26 +49,26 @@ module my_module {
 global_module = parser_.load(idl_str)
 my_module = global_module.module_by_name('my_module')
 dataGetter = my_module.interface_by_name('DataGetter')
-print 'DataGetter interface'
+print('DataGetter interface')
 for m in dataGetter.methods:
-  print '- method:'
-  print '  name:', m.name
-  print '  returns:', m.returns.name
-  print '  arguments:'
+  print('- method:')
+  print('  name:', m.name)
+  print('  returns:', m.returns.name)
+  print('  arguments:')
   for a in m.arguments:
-    print '    name:', a.name
-    print '    type:', a.type
-    print '    direction:', a.direction
+    print('    name:', a.name)
+    print('    type:', a.type)
+    print('    direction:', a.direction)
     
 doubleSeq = my_module.typedef_by_name('DoubleSeq')
-print 'typedef %s %s' % (doubleSeq.type.name, doubleSeq.name)
+print('typedef %s %s' % (doubleSeq.type.name, doubleSeq.name))
 
 timedDoubleSeq = my_module.struct_by_name('TimedDoubleSeq')
-print 'TimedDoubleSeq'
+print('TimedDoubleSeq')
 for m in timedDoubleSeq.members:
-  print '- member:'
-  print '  name:', m.name
-  print '  type:', m.type.name    
+  print('- member:')
+  print('  name:', m.name)
+  print('  type:', m.type.name)
 ```
 ## How to install
     sudo pip install idl_parser

{idl_parser-0.1.0 → idl_parser-0.2.0}/README.rst

@@ -1,13 +1,18 @@
 idl_parser
 ============
 
-|Test Status|
+|Test Status| |Docs Status|
 
 Description 
 -----------
 
 OMG IDL file parser. This library just parse IDL files, and output intermidiate type objects.
 
+Documentation
+-------------
+
+API reference and usage: https://idl-parser.readthedocs.io/
+
 Example
 -----------
 
@@ -48,26 +53,26 @@ Example
   global_module = parser_.load(idl_str)
   my_module = global_module.module_by_name('my_module')
   dataGetter = my_module.interface_by_name('DataGetter')
-  print 'DataGetter interface'
-  for m in dataGetter.methods: 
-    print '- method:'
-    print '  name:', m.name
-    print '  returns:', m.returns.name
-    print '  arguments:'
+  print('DataGetter interface')
+  for m in dataGetter.methods:
+    print('- method:')
+    print('  name:', m.name)
+    print('  returns:', m.returns.name)
+    print('  arguments:')
     for a in m.arguments:
-      print '    name:', a.name
-      print '    type:', a.type
-      print '    direction:', a.direction
+      print('    name:', a.name)
+      print('    type:', a.type)
+      print('    direction:', a.direction)
     
   doubleSeq = my_module.typedef_by_name('DoubleSeq')
-  print 'typedef %s %s' % (doubleSeq.type.name, doubleSeq.name)
+  print('typedef %s %s' % (doubleSeq.type.name, doubleSeq.name))
 
   timedDoubleSeq = my_module.struct_by_name('TimedDoubleSeq')
-  print 'TimedDoubleSeq'
+  print('TimedDoubleSeq')
   for m in timedDoubleSeq.members:
-    print '- member:'
-    print '  name:', m.name
-    print '  type:', m.type.name    
+    print('- member:')
+    print('  name:', m.name)
+    print('  type:', m.type.name)
 
 How to install
 ---------------
@@ -88,3 +93,7 @@ Copyright
 
 .. |Test Status| image:: https://github.com/sugarsweetrobotics/idl_parser/actions/workflows/test.yml/badge.svg?branch=main
    :target: https://github.com/sugarsweetrobotics/idl_parser/actions/workflows/test.yml
+
+.. |Docs Status| image:: https://readthedocs.org/projects/idl-parser/badge/?version=latest
+   :target: https://idl-parser.readthedocs.io/en/latest/
+   :alt: Documentation Status

idl_parser-0.2.0/docs/api/index.rst

@@ -0,0 +1,22 @@
+API Reference
+=============
+
+.. autosummary::
+   :toctree: generated
+   :nosignatures:
+
+   idl_parser.parser
+   idl_parser.module
+   idl_parser.interface
+   idl_parser.struct
+   idl_parser.enum
+   idl_parser.bitmask
+   idl_parser.bitset
+   idl_parser.union
+   idl_parser.typedef
+   idl_parser.const
+   idl_parser.pragma
+   idl_parser.type
+   idl_parser.node
+   idl_parser.token_buffer
+   idl_parser.exception

idl_parser-0.2.0/docs/conf.py

@@ -0,0 +1,38 @@
+"""Sphinx configuration for idl_parser."""
+
+import os
+import sys
+from importlib.metadata import PackageNotFoundError, version as _pkg_version
+
+# Allow building from a source checkout without installing the package.
+sys.path.insert(0, os.path.abspath(".."))
+
+project = "idl_parser"
+author = "Yuki Suga"
+copyright = "Yuki Suga"
+
+try:
+    release = _pkg_version("idl_parser")
+except PackageNotFoundError:
+    release = "unknown"
+version = ".".join(release.split(".")[:3])
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+]
+
+autodoc_default_options = {
+    "members": True,
+    "undoc-members": True,
+    "show-inheritance": True,
+    "member-order": "bysource",
+}
+autosummary_generate = True
+
+exclude_patterns = ["_build"]
+
+html_theme = "furo"
+html_title = f"idl_parser {version}"

idl_parser-0.2.0/docs/index.rst

@@ -0,0 +1,18 @@
+.. include:: ../README.rst
+
+API Reference
+-------------
+
+See the :doc:`API Reference <api/index>` for the classes and functions of each module.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents
+
+   api/index
+
+Indices
+-------
+
+* :ref:`genindex`
+* :ref:`modindex`

idl_parser-0.2.0/docs/requirements.txt

@@ -0,0 +1,2 @@
+sphinx>=7
+furo

{idl_parser-0.1.0 → idl_parser-0.2.0}/example.py

@@ -1,8 +1,6 @@
-"""
+"""Example: parse an IDL string and print interfaces, typedefs, unions and structs."""
 
-"""
-
-def  test():
+def test():
     from idl_parser import parser
     _parser = parser.IDLParser()
     idl_str = '''
@@ -57,36 +55,36 @@ module my_module {
     global_module = _parser.load(idl_str)
     my_module = global_module.module_by_name('my_module')
     dataGetter = my_module.interface_by_name('DataGetter')
-    print 'DataGetter interface'
+    print('DataGetter interface')
     for m in dataGetter.methods:
-      print '- method:'
-      print '  name:', m.name
-      print '  returns:', m.returns.name
-      print '  arguments:'
-      for a in m.arguments:
-        print '    name:', a.name
-        print '    type:', a.type
-        print '    direction:', a.direction
+        print('- method:')
+        print('  name:', m.name)
+        print('  returns:', m.returns.name)
+        print('  arguments:')
+        for a in m.arguments:
+            print('    name:', a.name)
+            print('    type:', a.type)
+            print('    direction:', a.direction)
 
     doubleSeq = my_module.typedef_by_name('DoubleSeq')
-    print 'typedef %s %s' % (doubleSeq.type.name, doubleSeq.name)
+    print('typedef %s %s' % (doubleSeq.type.name, doubleSeq.name))
 
     unionType = my_module.union_by_name('UnionType')
-    print 'descriminator kind: %s' % unionType.descriminator_kind
+    print('descriminator kind: %s' % unionType.descriminator_kind)
     for m in unionType.members:
-        print '- member:'
-        print '  name:', m.name
-        print '  type:', m.type.name
-        print 'descriminator value associations:'
+        print('- member:')
+        print('  name:', m.name)
+        print('  type:', m.type.name)
+        print('  descriminator value associations:')
         for a in m.descriminator_value_associations:
-            print '    %s' % a
+            print('    %s' % a)
 
     timedDoubleSeq = my_module.struct_by_name('TimedDoubleSeq')
-    print 'TimedDoubleSeq'
+    print('TimedDoubleSeq')
     for m in timedDoubleSeq.members:
-      print '- member:'
-      print '  name:', m.name
-      print '  type:', m.type.name
+        print('- member:')
+        print('  name:', m.name)
+        print('  type:', m.type.name)
 
 
 if __name__ == '__main__':

idl_parser-0.2.0/idl_parser/bitmask.py

@@ -0,0 +1,175 @@
+"""IDL 4.2 bitmask type (issue #39).
+
+::
+
+    @bit_bound(8) bitmask Flags { FLAG_A, @position(4) FLAG_B, FLAG_C };
+
+Each value is a single bit. Positions start at 0 and follow the previous
+value unless given with ``@position(n)``. ``@bit_bound`` (default 32) is the
+number of bits the bitmask can hold.
+"""
+
+from . import node, exception
+sep = '::'
+
+DEFAULT_BIT_BOUND = 32
+MAX_BIT_BOUND = 64
+
+
+def parse_int(literal):
+    """Integer value of an IDL integer literal (decimal, hex 0x.., octal 0..)."""
+    try:
+        return int(literal, 0)
+    except (TypeError, ValueError):
+        try:
+            return int(literal, 8)  # e.g. '010' (IDL octal)
+        except (TypeError, ValueError):
+            return None
+
+
+class IDLBitValue(node.IDLNode):
+    """A value (flag) of a bitmask."""
+
+    def __init__(self, name, position, parent):
+        super(IDLBitValue, self).__init__('IDLBitValue', name, parent)
+        self._position = position
+
+    @property
+    def position(self):
+        """Bit position of this flag (0 is the least significant bit)."""
+        return self._position
+
+    @property
+    def value(self):
+        """Integer value of this flag (``1 << position``)."""
+        return 1 << self._position
+
+    @property
+    def full_path(self):
+        return self.parent.full_path + sep + self.name
+
+    def to_simple_dic(self):
+        return {self.name: self.position}
+
+    def to_dic(self):
+        return self._with_annotations({'name': self.name,
+                'classname': self.classname,
+                'position': self.position,
+                'value': self.value})
+
+
+class IDLBitmask(node.IDLNode):
+
+    def __init__(self, name, parent, annotations=None):
+        super(IDLBitmask, self).__init__('IDLBitmask', name, parent)
+        self._verbose = False
+        self._values = []
+        self._bit_bound = DEFAULT_BIT_BOUND
+        self._add_annotations(annotations or [])
+        a = self.annotation_by_name('bit_bound')
+        if a is not None:
+            self._bit_bound = self._parse_bound(a.value)
+
+    def _parse_bound(self, literal):
+        bound = parse_int(literal)
+        if bound is None or not 1 <= bound <= MAX_BIT_BOUND:
+            raise exception.InvalidIDLSyntaxError(
+                message='Invalid @bit_bound(%s) of bitmask "%s" (must be 1..%d)'
+                % (literal, self.name, MAX_BIT_BOUND))
+        return bound
+
+    @property
+    def full_path(self):
+        return self.parent.full_path + sep + self.name
+
+    @property
+    def bit_bound(self):
+        """Number of bits the bitmask can hold (``@bit_bound``, default 32)."""
+        return self._bit_bound
+
+    @property
+    def values(self):
+        """Flags in declaration order (list of :class:`IDLBitValue`)."""
+        return self._values
+
+    def value_by_name(self, name):
+        for v in self._values:
+            if v.name == name:
+                return v
+        return None
+
+    def to_simple_dic(self, quiet=False, full_path=False, recursive=False, member_only=False):
+        name = self.full_path if full_path else self.name
+        if quiet:
+            return 'bitmask %s' % name
+        if member_only:
+            return [v.to_simple_dic() for v in self.values]
+        return {'bitmask %s' % name: [v.to_simple_dic() for v in self.values]}
+
+    def to_dic(self):
+        return self._with_annotations({'name': self.name,
+                'filepath': self.filepath,
+                'classname': self.classname,
+                'bit_bound': self.bit_bound,
+                'values': [v.to_dic() for v in self.values]})
+
+    def parse_tokens(self, token_buf, filepath=None):
+        self._filepath = filepath
+        ln, fn, token = token_buf.pop()
+        if token != '{':
+            raise exception.InvalidIDLSyntaxError(ln, fn, 'No "{" in the declaration of bitmask "%s"' % self.name)
+
+        block = []
+        depth = 0  # inside the parentheses of an annotation, e.g. @foo(a, b)
+        while True:
+            ln, fn, token = token_buf.pop()
+            if token is None:
+                raise exception.InvalidIDLSyntaxError(ln, fn, 'No "}" in the declaration of bitmask "%s"' % self.name)
+            elif token == '}' and depth == 0:
+                if block:
+                    self._parse_block(block, ln, fn)
+                ln, fn, token = token_buf.pop()
+                if token != ';':
+                    raise exception.InvalidIDLSyntaxError(ln, fn, 'No ";" after "}" in the declaration of bitmask "%s"' % self.name)
+                break
+            elif token == ',' and depth == 0:
+                self._parse_block(block, ln, fn)
+                block = []
+            else:
+                if token == '(':
+                    depth += 1
+                elif token == ')':
+                    depth -= 1
+                block.append(token)
+
+    def _parse_block(self, block, ln, fn):
+        # block: [annotation tokens...] NAME
+        annotations, rest = node.parse_annotations(block)
+        if len(rest) != 1:
+            raise exception.InvalidIDLSyntaxError(ln, fn, 'Invalid value "%s" in bitmask "%s"' % (' '.join(block), self.name))
+
+        if self._values:
+            position = self._values[-1].position + 1
+        else:
+            position = 0
+        for a in annotations:
+            if a.name == 'position':
+                position = parse_int(a.value)
+                if position is None:
+                    raise exception.InvalidIDLSyntaxError(ln, fn, 'Invalid %s in bitmask "%s"' % (a, self.name))
+
+        if not 0 <= position < self.bit_bound:
+            raise exception.InvalidIDLSyntaxError(
+                ln, fn, 'Position %s of "%s" is out of @bit_bound(%d) of bitmask "%s"'
+                % (position, rest[0], self.bit_bound, self.name))
+        for v in self._values:
+            if v.position == position:
+                raise exception.InvalidIDLSyntaxError(
+                    ln, fn, 'Position %d of "%s" is already used by "%s" in bitmask "%s"'
+                    % (position, rest[0], v.name, self.name))
+
+        v = IDLBitValue(rest[0], position, self)
+        v._filepath = self.filepath
+        v._add_annotations(annotations)
+        self._values.append(v)
+