idl-parser 0.1.0__tar.gz

idl_parser-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,84 @@
+name: Release
+
+# - pull_request : build only (checks that the package builds)
+# - push to main : build and publish a .devN version to TestPyPI
+# - push tag v*  : build and publish the tagged version to PyPI
+on:
+  push:
+    branches: [main]
+    tags: ["v*"]
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    uses: ./.github/workflows/test.yml
+
+  build:
+    name: Build distributions
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0 # setuptools-scm needs tags and history
+          persist-credentials: false
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.x"
+
+      - name: Build sdist and wheel
+        run: |
+          python -m pip install --upgrade build twine
+          python -m build
+          python -m twine check --strict dist/*
+          ls -l dist
+
+      - uses: actions/upload-artifact@v7
+        with:
+          name: dist
+          path: dist/
+          if-no-files-found: error
+
+  publish-testpypi:
+    name: Publish to TestPyPI
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/idl_parser
+    permissions:
+      id-token: write # Trusted Publishing
+    steps:
+      - uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist/
+
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          skip-existing: true
+
+  publish-pypi:
+    name: Publish to PyPI
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/idl_parser
+    permissions:
+      id-token: write # Trusted Publishing
+    steps:
+      - uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist/
+
+      - uses: pypa/gh-action-pypi-publish@release/v1

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

@@ -0,0 +1,35 @@
+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

idl_parser-0.1.0/.gitignore

@@ -0,0 +1,5 @@
+*.pyc
+*~
+*.egg-info
+build/*
+dist/*

idl_parser-0.1.0/PKG-INFO

@@ -0,0 +1,110 @@
+Metadata-Version: 2.4
+Name: idl_parser
+Version: 0.1.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: Source, https://github.com/sugarsweetrobotics/idl_parser
+Project-URL: Issues, https://github.com/sugarsweetrobotics/idl_parser/issues
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.9
+Description-Content-Type: text/x-rst
+
+idl_parser
+============
+
+|Test Status|
+
+Description 
+-----------
+
+OMG IDL file parser. This library just parse IDL files, and output intermidiate type objects.
+
+Example
+-----------
+
+.. code:: python
+
+  """
+  example for idl_parser package   
+  """
+    
+  from idl_parser import parser
+  parser_ = parser.IDLParser()
+  idl_str = """
+  module my_module {
+    struct Time {
+      long sec;
+      long usec;
+    };
+
+    typedef sequence<double> DoubleSeq;
+  
+    struct TimedDoubleSeq {
+      Time tm;
+      DoubleSeq data;
+    };
+  
+    enum RETURN_VALUE {
+      RETURN_OK,
+      RETURN_FAILED,
+    };
+
+    interface DataGetter {
+      RETURN_VALUE getData(out TimedDoubleSeq data);
+    };
+
+  };
+  """
+    
+  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:'
+    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)
+
+  timedDoubleSeq = my_module.struct_by_name('TimedDoubleSeq')
+  print 'TimedDoubleSeq'
+  for m in timedDoubleSeq.members:
+    print '- member:'
+    print '  name:', m.name
+    print '  type:', m.type.name    
+
+How to install
+---------------
+
+    sudo pip install idl_parser
+
+
+Copyright
+------------
+
+- author: Yuki Suga
+
+- copyright: Yuki Suga
+
+- contact: please open an issue on `GitHub Issues <https://github.com/sugarsweetrobotics/idl_parser/issues>`_
+
+- license: GPLv3
+
+.. |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

idl_parser-0.1.0/README.md

@@ -0,0 +1,76 @@
+# 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)
+
+
+## Description 
+
+OMG IDL file parser. This library just parse IDL files, and output intermidiate type objects.
+
+## Example
+```
+"""
+    
+"""
+    
+from idl_parser import parser
+parser_ = parser.IDLParser()
+idl_str = """
+module my_module {
+  struct Time {
+    long sec;
+    long usec;
+  };
+
+  typedef sequence<double> DoubleSeq;
+  
+  struct TimedDoubleSeq {
+    Time tm;
+    DoubleSeq data;
+  };
+
+  enum RETURN_VALUE {
+    RETURN_OK,
+    RETURN_FAILED,
+  };
+
+  interface DataGetter {
+    RETURN_VALUE getData(out TimedDoubleSeq data);
+  };
+
+};
+"""
+    
+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:'
+  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)
+
+timedDoubleSeq = my_module.struct_by_name('TimedDoubleSeq')
+print 'TimedDoubleSeq'
+for m in timedDoubleSeq.members:
+  print '- member:'
+  print '  name:', m.name
+  print '  type:', m.type.name    
+```
+## How to install
+    sudo pip install idl_parser
+
+## Copyright
+* author: Yuki Suga
+* copyright: Yuki Suga
+* contact: please open an issue on [GitHub Issues](https://github.com/sugarsweetrobotics/idl_parser/issues)
+* license: GPLv3
+

idl_parser-0.1.0/README.rst

@@ -0,0 +1,90 @@
+idl_parser
+============
+
+|Test Status|
+
+Description 
+-----------
+
+OMG IDL file parser. This library just parse IDL files, and output intermidiate type objects.
+
+Example
+-----------
+
+.. code:: python
+
+  """
+  example for idl_parser package   
+  """
+    
+  from idl_parser import parser
+  parser_ = parser.IDLParser()
+  idl_str = """
+  module my_module {
+    struct Time {
+      long sec;
+      long usec;
+    };
+
+    typedef sequence<double> DoubleSeq;
+  
+    struct TimedDoubleSeq {
+      Time tm;
+      DoubleSeq data;
+    };
+  
+    enum RETURN_VALUE {
+      RETURN_OK,
+      RETURN_FAILED,
+    };
+
+    interface DataGetter {
+      RETURN_VALUE getData(out TimedDoubleSeq data);
+    };
+
+  };
+  """
+    
+  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:'
+    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)
+
+  timedDoubleSeq = my_module.struct_by_name('TimedDoubleSeq')
+  print 'TimedDoubleSeq'
+  for m in timedDoubleSeq.members:
+    print '- member:'
+    print '  name:', m.name
+    print '  type:', m.type.name    
+
+How to install
+---------------
+
+    sudo pip install idl_parser
+
+
+Copyright
+------------
+
+- author: Yuki Suga
+
+- copyright: Yuki Suga
+
+- contact: please open an issue on `GitHub Issues <https://github.com/sugarsweetrobotics/idl_parser/issues>`_
+
+- license: GPLv3
+
+.. |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

idl_parser-0.1.0/example.py

@@ -0,0 +1,93 @@
+"""
+
+"""
+
+def  test():
+    from idl_parser import parser
+    _parser = parser.IDLParser()
+    idl_str = '''
+module my_module {
+  struct Time {
+    long sec;
+    long usec;
+  };
+
+  enum UNION_DESCRIMINATOR_KIND
+  {
+      DESCRIMINATOR_UNKNOWN,
+      DESCRIMINATOR_ULONGLONG,
+      DESCRIMINATOR_LONGLONG,
+      DESCRIMINATOR_DOUBLE,
+      DESCRIMINATOR_STRING,
+      DESCRIMINATOR_KIND_COUNT
+  };
+
+  union UnionType switch( UNION_DESCRIMINATOR_KIND )
+  {
+      case DESCRIMINATOR_UNKNOWN:
+      case DESCRIMINATOR_KIND_COUNT:
+      case DESCRIMINATOR_ULONGLONG:
+          unsigned long long      ull_value;
+      case DESCRIMINATOR_LONGLONG:
+          long long               ll_value;
+      case DESCRIMINATOR_DOUBLE:
+          double                  d_value;
+      case DESCRIMINATOR_STRING:
+          sequence<char>     str_value;
+  };
+
+  typedef sequence<double> DoubleSeq;
+
+  struct TimedDoubleSeq {
+    Time tm;
+    DoubleSeq data;
+  };
+
+  enum RETURN_VALUE {
+    RETURN_OK,
+    RETURN_FAILED,
+  };
+
+  interface DataGetter {
+    RETURN_VALUE getData(out TimedDoubleSeq data);
+  };
+};
+'''
+
+    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:'
+      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)
+
+    unionType = my_module.union_by_name('UnionType')
+    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:'
+        for a in m.descriminator_value_associations:
+            print '    %s' % a
+
+    timedDoubleSeq = my_module.struct_by_name('TimedDoubleSeq')
+    print 'TimedDoubleSeq'
+    for m in timedDoubleSeq.members:
+      print '- member:'
+      print '  name:', m.name
+      print '  type:', m.type.name
+
+
+if __name__ == '__main__':
+    test()

idl_parser-0.1.0/idl_parser/__init__.py

@@ -0,0 +1,7 @@
+#from parser import IDLParser
+__all__=['parser', 'exception']
+
+
+
+    
+    

idl_parser-0.1.0/idl_parser/const.py

@@ -0,0 +1,50 @@
+import os, sys, traceback
+
+from . import node
+sep = '::'
+
+
+class IDLConst(node.IDLNode):
+
+    def __init__(self, name, typename, value, parent, filepath=None):
+        super(IDLConst, self).__init__('IDLConst', name, parent)
+        self._typename = typename
+        self._verbose = True
+        self._value = value
+        self._filepath= filepath
+
+    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 'const %s %s = %s' % (self.typename, name, self.value)
+        dic = { 'const %s' % name : { 'type' : self.typename,
+                                      'value' : self.value } }
+        return dic
+
+    def to_dic(self):
+        dic = { 'name' : self.name,
+                'filepath' : self.filepath,
+                'classname' : self.classname,
+                'typename' : self.typename,
+                'value' : self.value }
+        return dic
+
+    @property
+    def typename(self):
+        return self._typename
+
+    @property
+    def type(self):
+        return self.root_node.find_types(self.typename)[0]
+    @property
+    def value(self):
+        return self._value
+
+    @property
+    def value_string(self):
+        return self._value
+
+    @property
+    def full_path(self):
+        return self.parent.full_path + sep + self.name
+

idl_parser-0.1.0/idl_parser/enum.py

@@ -0,0 +1,114 @@
+import os, sys, traceback
+
+from . import node
+sep = '::'
+
+class IDLEnumValue(node.IDLNode):
+    def __init__(self, value, parent):
+        super(IDLEnumValue, self).__init__('IDLEnumValue', '', parent)
+        self._verbose = True
+        self._value = value
+
+    def parse_blocks(self, blocks, filepath=None):
+        self._filepath = filepath
+        if len(blocks) == 1:
+            self._name = blocks[0]
+        else:
+            sys.stdout.write('Unkown Enum format %s\n' % blocks)
+        #name, type = self._name_and_type(blocks)
+        #self._name = name
+        #self._type = type
+
+    @property
+    def full_path(self):
+        return self.full_path + '.' + self.name
+
+    def to_simple_dic(self):
+        dic = {self.name : self.value }
+        return dic
+
+    def to_dic(self):
+        dic = { 'name' : self.name,
+                'filepath' : self.filepath,
+                'classname' : self.classname,
+                'value' : self.value }
+        return dic
+    @property
+    def value(self):
+        return self._value
+
+
+
+
+class IDLEnum(node.IDLNode):
+
+    def __init__(self, name, parent):
+        super(IDLEnum, self).__init__('IDLEnum', name, parent)
+        self._verbose = True
+        self._values = []
+
+    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 'enum %s' % name
+        dic = { 'enum %s' % name : [v.to_simple_dic() for v in self.values] }
+        return dic
+
+
+    def to_dic(self):
+        dic = { 'name' : self.name,
+                'classname' : self.classname,
+                'values' : [v.to_dic() for v in self.values] }
+        return dic
+
+    @property
+    def full_path(self):
+        return self.parent.full_path + sep + self.name
+
+    def parse_tokens(self, token_buf, filepath=None):
+        self._filepath = filepath
+        self._counter = 0
+        ln, fn, kakko = token_buf.pop()
+        if not kakko == '{':
+            if self._verbose: sys.stdout.write('# Error. No kakko "{".\n')
+            raise InvalidIDLSyntaxError()
+
+        block_tokens = []
+        while True:
+            ln, fn, token = token_buf.pop()
+            if token == None:
+                if self._verbose: sys.stdout.write('# Error. No kokka "}".\n')
+                raise InvalidIDLSyntaxError()
+
+            elif token == '}':
+                ln, fn, token = token_buf.pop()
+                if not token == ';':
+                    if self._verbose: sys.stdout.write('# Error. No semi-colon after "}".\n')
+                    raise InvalidIDLSyntaxError()
+
+                if len(block_tokens) > 0:
+                    self._parse_block(block_tokens)
+                break
+
+            if token == ',':
+                self._parse_block(block_tokens)
+                block_tokens = []
+                continue
+            block_tokens.append(token)
+
+    def _parse_block(self, blocks):
+        v = IDLEnumValue(self._counter, self)
+        self._counter = self._counter+ 1
+        v.parse_blocks(blocks, self.filepath)
+        self._values.append(v)
+
+    @property
+    def values(self):
+        return self._values
+
+
+    def value_by_name(self, name):
+        for m in self.values:
+            if m.name == name:
+                return m
+        return None

idl_parser-0.1.0/idl_parser/exception.py

@@ -0,0 +1,37 @@
+
+
+
+class IDLParserException(Exception):
+
+    def __init__(self, line_number=None, file_name=None, message='IDLParserException occurred.'):
+        self._className = 'IDLParserException'
+        self._line_number = line_number
+        self._file_name = file_name
+        self._message = message
+
+    @property
+    def message(self):
+        return 'File "' + self.file_name + '", line %s, ' % self.line_number + '(' + self._className + '):"' + self._message
+
+    @property
+    def line_number(self):
+        return self._line_number
+        
+    @property
+    def file_name(self):
+        return self._file_name
+
+
+
+class InvalidIDLSyntaxError(IDLParserException):
+
+    def __init__(self, line_number=None, file_name=None, message='IDLParserException occurred.'):
+        super(InvalidIDLSyntaxError, self).__init__(line_number, file_name, message)
+        self._className = 'InvalidIDLSyntaxError'
+    pass
+
+class InvalidDataTypeException(IDLParserException):
+    pass
+
+class IDLCanNotFindException(IDLParserException):
+    pass