xctype 0.0.2__py3-none-any.whl

xctype/__init__.py

@@ -0,0 +1,308 @@
+from abc import ABC,abstractmethod
+from sympy import *
+from pysatl import Utils
+from collections import OrderedDict
+from io import BytesIO
+
+class NotInitializedError(RuntimeError):
+    pass
+
+class XCType(ABC):
+
+    def get_val(self):
+        return self._value 
+    
+    def set_val(self,value):
+        self._value = value
+
+    def get_context(self):
+        return self._context 
+    
+    def set_context(self,value):
+        self._context = value
+
+    def __init__(self, init=None):
+        self._type_name = None
+        self._members = None
+        self._value = None
+        self._context = None
+        if init is not None:
+            self._type_name = init._type_name
+            self._members = init._members
+            self._value = init._value
+            self._context = init._context
+
+    def do_init(self,init):
+        if init is not None:
+            init_bytes = init.conv_to_bytes()
+            if len(init_bytes) != self.get_size():
+                raise RuntimeError('size mismatch')
+            self.conv_from_bytes(init_bytes)
+
+    def __str__(self):
+        return self.conv_to_str(deep=False)
+
+    def conv_to_str(self,*,deep=False,indent=''):
+        if self._value is not None:
+            # primitive type with concrete value
+            return f'{indent}{self._value:#0{self.get_size()*2+2}x}'
+        if self._members is None:
+            # primitive type without concrete value
+            return indent+self._type_name
+        # struct
+        out = f'{indent}{self._type_name} ({self.get_size()} bytes)\n'
+        
+        #return the value of each member
+        indent += '  '
+        for name in self._members:
+            m = self._members[name]
+            if deep:
+                m_str = m.conv_to_str(deep=True,indent=indent)
+                out += f'{indent}{name}: {m_str}'
+            else:
+                out += f'{indent}{name}: {m._type_name} ({m.get_size()} bytes)'
+                if m.get_is_initialized():
+                    if m.get_is_primitive():
+                        out += f' = {m}'
+                    else:
+                        out += f' = {Utils.hexstr(m.conv_to_bytes())}'
+            out += '\n'
+        
+        return out
+
+    def get_size(self):
+        # primitive type shall override this
+        out = 0
+        for m in self._members.values():
+            out += m.get_size()
+        return out
+    
+    @staticmethod
+    def get_is_primitive():
+        return False
+
+    def get_is_initialized(self):
+        try: 
+            self.conv_to_bytes()
+            return True
+        except NotInitializedError:
+            return False
+
+    def conv_to_bytes(self) -> bytes:
+        if self._members is None:
+            if self._value is None:
+                raise NotInitializedError()
+            return self._value.to_bytes(self.get_size(),byteorder='little')
+        out = bytearray()
+        for m in self._members.values():
+            out += m.to_bytes()
+        return out
+    
+    def _check_size(self, data: bytes):
+        if len(data) != self.get_size():
+            raise RuntimeError(f'size mismatch: {len(data)} vs {self.get_size()}')
+
+    def conv_from_bytes(self, data: bytes):
+        if self._members is None:
+            self._check_size(data)
+            self._value = int.from_bytes(data,byteorder='little')
+        else:
+            data_bytes = BytesIO(data)
+            consumed = 0
+            context = self._context
+            for name in self._members:
+                size = self._members[name].get_size()
+                if not isinstance(size,int):
+                    expression = size
+                    vars = sorted(expression.free_symbols)
+                    evaluated = expression.subs(context)
+                    size = evaluated
+                    self._members[name]._context = context
+                consumed += size
+                dat = data_bytes.read(size)
+                self._members[name].conv_from_bytes(dat)
+                if context is not None:
+                    context[name] = self._members[name]._value
+            self._context = context
+            if consumed != len(data):
+                raise RuntimeError(f'size mismatch: {len(data)} vs {consumed}')
+
+class BasePrimitive(XCType):   
+    def set_val(self,value):
+        if value>self._type_mask:
+            raise OverflowError()
+        self._value = value & self._type_mask
+
+    def __init__(self, init=None, size=None, name=None):
+        super().__init__()
+        self._type_size = size
+        self._type_mask = (1<<(size*8)) - 1
+        self._type_name = name
+        self._members = None
+        if init is not None:
+            self.set_val(int(init))
+
+    def get_size(self):
+        return self._type_size
+    
+    @staticmethod
+    def get_is_primitive():
+        return True
+    
+class U8(BasePrimitive):
+    def __init__(self, init=None):
+        super().__init__(init=init,size=1,name='uint8_t')
+
+class U16(BasePrimitive):
+    def __init__(self, init=None):
+        super().__init__(init=init,size=2,name='uint16_t')
+
+class U32(BasePrimitive):
+    def __init__(self, init=None):
+        super().__init__(init=init,size=4,name='uint32_t')
+
+class U64(BasePrimitive):
+    def __init__(self, init=None):
+        super().__init__(init=init,size=8,name='uint64_t')
+
+class U128(BasePrimitive):
+    def __init__(self, init=None):
+        super().__init__(init=init,size=16,name='uint128_t')
+
+class S8(BasePrimitive):
+    def __init__(self, init=None):
+        super().__init__(init=init,size=1,name='int8_t')
+
+class S16(BasePrimitive):
+    def __init__(self, init=None):
+        super().__init__(init=init,size=2,name='int16_t')
+
+class S32(BasePrimitive):
+    def __init__(self, init=None):
+        super().__init__(init=init,size=4,name='int32_t')
+
+class S64(BasePrimitive):
+    def __init__(self, init=None):
+        super().__init__(init=init,size=8,name='int64_t')
+
+class S128(BasePrimitive):
+    def __init__(self, init=None):
+        super().__init__(init=init,size=16,name='int128_t')
+
+
+class BaseStruct(XCType):
+    def __init__(self, init=None):
+        super().__init__()
+        self._members = OrderedDict()
+        self._context = dict()
+
+class Array(XCType):
+    def __init__(self, init=None,elem_class=None,num_elem=None):
+        super().__init__()
+        self._type_name = 'array'
+        self._context = dict()
+        self._num_elem_int = None
+        self._num_elem_sym = None
+        if init is not None:
+            self.do_init(init)
+        else:
+            self._elem_class = elem_class 
+            if isinstance(num_elem,int):
+                self._num_elem_int = num_elem
+                self._value = [elem_class() for i in range(num_elem)]
+            else:
+                self._num_elem_sym = num_elem
+            if elem_class is None:
+                raise RuntimeError('elem_class is mandatory when init is None')
+
+    def elem_size(self):
+        return self._elem_class().get_size() # we support only element types with fixed size
+
+    def get_size(self):
+        num_elem = self._num_elem_int
+        if num_elem is None:
+            num_elem = self._num_elem_sym
+            try:
+                num_elem = num_elem.subs(self._context)
+                self._num_elem_int = int(num_elem)
+            except:
+                pass
+        return num_elem * self.elem_size()
+
+    def conv_to_bytes(self) -> bytes:
+        out = bytearray()
+        if self._value is None:
+            raise NotInitializedError()
+        for m in self._value:
+            out += m.conv_to_bytes()
+        return out
+    
+    def conv_from_bytes(self, data: bytes):
+        size = self.get_size()
+        if len(data) != size:
+            raise RuntimeError(f'size mismatch: {len(data)} vs {size}')
+        data_bytes = BytesIO(data)
+        elem_size = self.elem_size()
+        self._value = [self._elem_class() for i in range(self._num_elem_int)]
+        for e in self._value:
+            e.conv_from_bytes(data_bytes.read(elem_size))
+
+    def conv_to_str(self,*,deep=False,indent=''):
+        if self.get_is_initialized():
+            out = indent+'{'
+            sep=''
+            for e in self._value:
+                out += f'{sep}{e.conv_to_str(deep=deep,indent='')}'
+                sep = ', '
+            out += '}'
+        else:
+            num_elem = self._num_elem_int
+            if num_elem is None:
+                num_elem = self._num_elem_sym
+            out = indent+'{'+self._elem_class()._type_name+'}*'+f'{num_elem}'
+        return out
+
+
+from collections.abc import MutableMapping, MutableSequence, MutableSet
+import copy
+
+MUTABLES = MutableMapping, MutableSequence, MutableSet  # Mutable containers
+
+def managed_attribute(name):
+    """Return a property that stores values under a private non-public name."""
+    storage_name = '_' + name.lower()
+
+    @property
+    def prop(self):
+        return getattr(self, storage_name)
+
+    @prop.setter
+    def prop(self, value):
+        #setattr(self, storage_name, value) #TODO: verify it works well
+        self._members[name.lower()].set_val(value)
+
+    return prop
+
+def make_struct(classname, **options):
+    """Return a class with the specified attributes implemented as properties.
+    """
+    class Class(BaseStruct):
+        def __init__(self, init=None):
+            """Initialize instance attribute storage name values."""
+            super().__init__()
+            self._type_name = classname
+            for key, value in options.items():
+                if isinstance(value, MUTABLES):  # Mutable?
+                    value = copy.deepcopy(value)  # Avoid mutable default arg.
+                name = key.lower()
+                self._members[name] = value
+                setattr(self, '_' + name, value)
+            self.do_init(init)
+
+    for key, value in options.items():  # Create class' properties.
+        setattr(Class, key.lower(), managed_attribute(key))
+
+    Class.__name__ = classname
+    return Class
+
+

xctype-0.0.2.dist-info/METADATA

@@ -0,0 +1,30 @@
+Metadata-Version: 2.4
+Name: xctype
+Version: 0.0.2
+Summary: Python package for explicit C types
+Project-URL: Homepage, https://github.com/sebastien-riou/xctype
+Project-URL: Bug Tracker, https://github.com/sebastien-riou/xctype/issues
+Author: Sebastien Riou
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.10
+Requires-Dist: pysatl>=1.2.6
+Requires-Dist: sympy
+Provides-Extra: doc
+Requires-Dist: sphinx; extra == 'doc'
+Description-Content-Type: text/markdown
+
+# xctype
+Explicit C types for Python
+
+## Installation
+````
+python3 -m pip install xctype-***.whl
+````

xctype-0.0.2.dist-info/RECORD

@@ -0,0 +1,5 @@
+xctype/__init__.py,sha256=PX2bVK4_9VNDvBsJFjl7PcEg1niRXXEqptNVPNmjq7Q,9918
+xctype-0.0.2.dist-info/METADATA,sha256=HM2RngxHU7xHK59E5-ioiIzRrTLoVpBRWM-zfB49eqg,999
+xctype-0.0.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+xctype-0.0.2.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+xctype-0.0.2.dist-info/RECORD,,

xctype-0.0.2.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

xctype-0.0.2.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.