MatrixEditor · MatrixEditor · Aug 13, 2025 · Jul 5, 2025 · Jul 5, 2025 · Jul 5, 2025
diff --git a/.gitignore b/.gitignore
@@ -8,6 +8,9 @@ venv-matrix/
 # C extensions
 *.so
 include/caterpillar/caterpillar.h
+src/ccaterpillar/caterpillarapi.c
+src/ccaterpillar/module.c
+src/ccaterpillar/private.h
 
 # Distribution / packaging
 .Python
@@ -29,6 +32,8 @@ share/python-wheels/
 *.egg
 MANIFEST
 bench/
+pypi/
+caterpillarapi.h
 
 # PyInstaller
 #  Usually these files are written by a python script from a template
@@ -164,4 +169,6 @@ cython_debug/
 #.idea/
 
 # VSCode
-.vscode/
+.vscode/
+Makefile
+.clangd
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,59 @@
 # Changelog
 
+## [2.6.0] - Minor Release
+
+### Added
+- **caterpillar.fields._base**
+  - Add support for non-context lambda switch fields.
+
+- **caterpillar.fields.common**
+  - Add compatibility support for CAPI atoms in `Int`, `UInt` and `PyStructFormattedField`.
+
+- **caterpillar.options**
+  - Add custom `Flag.__eq__` implementation to support equality check with `c_Option` objects.
+
+- **caterpillar.abc**
+  - Add new typing-only `_OptionLike` protocol.
+  - Add missing `_SupportsType` protocol to the stubs file.
+  - Add new method `get` to the `_ContextLike` protocol.
+
+- **caterpillar.context**
+  - Add new option `O_CONTEXT_FACTORY` that controls the global context type.
+    Value must be a method or another type implementing the `_ContextLike` protocol.
+  - Add new global context path: `root` (exported as `G` in shortcuts).
+
+- **caterpillar.shortcuts**
+  - Add new shortcuts `C` for `ctx`, `P` for `parent` and `G` for the `root` context as `ContextPath` objects.
+
+- **CAPI**
+  - New index assignment system when generating CAPI code — a running number is now applied instead of a hard-coded index.
+  - Add complete Context implementation in C (`c_Context`) that conforms to the `_ContextLike` protocol.
+  - Add `Atom` for C-based struct-like classes (previously known as `catom`).
+  - Add native support for `__bits__` in `Atom`.
+  - Add special class `LengthInfo` for packing or unpacking multiple objects.
+  - New builtin atoms (CAPI): `Repeated`, `Conditional` and `Switch`.
+  - Add new shared objects and exception types to the native implementation (`Cp_ContextFactory`, `Cp_ArrayFactory`, `CpExc_Stop` and `Cp_DefaultOption`).
+
+---
+
+### Changed
+- **caterpillar.fields._base**
+  - Rework `Field` implementation to reduce overhead when packing and unpacking elements.
+  - Use pre-computed states instead of calculating everything on the fly; states will be adjusted automatically when setting new values (via `@property` attributes).
+
+---
+
+### Fixed
+- **caterpillar.fields.common**
+  - Fix issue in `Prefixed` that occurred when the internal struct packs a sequence of elements.
+
+---
+
+### Removed
+- **CAPI**
+  - Remove old CAPI and completely revamp the CAPI concept to make it compatible with the Python equivalent.
+
+
 ## [2.5.1] - Hot-Fix Release
 
 ### Fixed

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -17,42 +17,17 @@ python_add_library(
   MODULE
 
   src/ccaterpillar/arch.c
-  src/ccaterpillar/atomobj.c
-  src/ccaterpillar/context.c
   src/ccaterpillar/option.c
   src/ccaterpillar/module.c
   src/ccaterpillar/context.c
-  src/ccaterpillar/state.c
-  src/ccaterpillar/struct.c
-  src/ccaterpillar/layer.c
-  src/ccaterpillar/default.c
-
-  src/ccaterpillar/parsing_typeof.c
-  src/ccaterpillar/parsing_sizeof.c
-  src/ccaterpillar/parsing_pack.c
-  src/ccaterpillar/parsing_unpack.c
-
-  src/ccaterpillar/atomimpl/int.c
-  src/ccaterpillar/atomimpl/float.c
-  src/ccaterpillar/atomimpl/bool.c
-  src/ccaterpillar/atomimpl/char.c
-  src/ccaterpillar/atomimpl/pad.c
-  src/ccaterpillar/atomimpl/string.c
-  src/ccaterpillar/atomimpl/const.c
-  src/ccaterpillar/atomimpl/bytes.c
-  src/ccaterpillar/atomimpl/pstring.c
-  src/ccaterpillar/atomimpl/enum.c
-  src/ccaterpillar/atomimpl/varint.c
-  src/ccaterpillar/atomimpl/computed.c
-  src/ccaterpillar/atomimpl/lazy.c
-  src/ccaterpillar/atomimpl/cstring.c
-
-  src/ccaterpillar/atomimpl/builtins/builtin.c
-  src/ccaterpillar/atomimpl/builtins/repeated.c
-  src/ccaterpillar/atomimpl/builtins/condition.c
-  src/ccaterpillar/atomimpl/builtins/switch.c
-  src/ccaterpillar/atomimpl/builtins/atoffset.c
-  src/ccaterpillar/atomimpl/builtins/primitive.c
+  src/ccaterpillar/atom.c
+  src/ccaterpillar/lengthinfo.c
+  src/ccaterpillar/shared.c
+  src/ccaterpillar/atoms/builtin/builtin.c
+  src/ccaterpillar/atoms/builtin/repeated.c
+  src/ccaterpillar/atoms/builtin/switch.c
+  src/ccaterpillar/atoms/builtin/conditional.c
+  src/ccaterpillar/atoms/builtin/offset.c
 
   WITH_SOABI
 )
@@ -65,15 +40,20 @@ message(STATUS "Python ${Python_VERSION_MAJOR}.${Python_VERSION_MINOR}")
 set (CP_GENAPI_SCRIPT ${CMAKE_CURRENT_SOURCE_DIR}/src/code_gen/genapi.py)
 set (CP_CAPI_HEADER ${CMAKE_CURRENT_SOURCE_DIR}/src/caterpillar/include/caterpillar/caterpillarapi.h.in)
 set (CP_CAPI_CSRC ${CMAKE_CURRENT_SOURCE_DIR}/src/ccaterpillar/caterpillarapi.c.in)
+set (CP_CAPI_MOD_CSRC ${CMAKE_CURRENT_SOURCE_DIR}/src/ccaterpillar/module.c.in)
+set (CP_CAPI_PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/src/ccaterpillar/private.h.in)
+
 set (CP_CAPI_HEADER_OUT ${CMAKE_CURRENT_SOURCE_DIR}/src/caterpillar/include/caterpillar/caterpillarapi.h)
 set (CP_CAPI_CSRC_OUT ${CMAKE_CURRENT_SOURCE_DIR}/src/ccaterpillar/caterpillarapi.c)
+set (CP_CAPI_MOD_CSRC_OUT ${CMAKE_CURRENT_SOURCE_DIR}/src/ccaterpillar/module.c)
+set (CP_CAPI_PRIVATE_OUT ${CMAKE_CURRENT_SOURCE_DIR}/src/ccaterpillar/private.h)
 
 add_custom_target(
  genapi ALL
  # execute python ./src/code_gen/genapi.py ./src/caterpillar/include/caterpillar/caterpillarapi.h.in ./src/ccaterpillar/caterpillarapi.c.in
  # in the root directory
- COMMAND ${PYTHON_EXECUTABLE} ${CP_GENAPI_SCRIPT} ${CP_CAPI_HEADER} ${CP_CAPI_CSRC}
- BYPRODUCTS ${CP_CAPI_HEADER_OUT} ${CP_CAPI_CSRC_OUT}
+ COMMAND ${PYTHON_EXECUTABLE} ${CP_GENAPI_SCRIPT} ${CP_CAPI_HEADER} ${CP_CAPI_CSRC} ${CP_CAPI_MOD_CSRC} ${CP_CAPI_PRIVATE}
+ BYPRODUCTS ${CP_CAPI_HEADER_OUT} ${CP_CAPI_CSRC_OUT} ${CP_CAPI_MOD_CSRC_OUT} ${CP_CAPI_PRIVATE_OUT}
  COMMENT "Generating Public Caterpillar API"
 )
 

diff --git a/README.md b/README.md
@@ -8,12 +8,6 @@
 ![GitHub License](https://img.shields.io/github/license/MatrixEditor/caterpillar?logo=github)
 
 
-
-> [!WARNING]
-> This project is still in beta/testing phase. Expect bugs, naming changes and errors while using this
-> library. C API Reference is WIP, C extensions are supported since v2.1.0. The latest stable release
-> is available at PyPI.
-
 Caterpillar is a Python 3.12+ library to pack and unpack structurized binary data. It
 enhances the capabilities of [Python Struct](https://docs.python.org/3/library/struct.html)
 by enabling direct class declaration. More information about the different configuration
@@ -100,7 +94,7 @@ pip install caterpillar-py
 pip install "caterpillar[all]@git+https://github.com/MatrixEditor/caterpillar"
 ```
 
-### C-extension installation
+### Installation + C-extension
 
 ```bash
 pip install "caterpillar[all]@git+https://github.com/MatrixEditor/caterpillar/#subdirectory=src/ccaterpillar"

diff --git a/docs/doxygen/Doxyfile b/docs/doxygen/Doxyfile
@@ -949,7 +949,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = ../../include
+INPUT                  = ../../src/caterpillar/include
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py
@@ -15,7 +15,7 @@
 
 project = "Caterpillar"
 author = caterpillar.__author__
-copyright = f"2024, {author}"
+copyright = f"2025, {author}"
 release = version = caterpillar.__version__
 
 # -- General configuration ---------------------------------------------------

diff --git a/docs/sphinx/source/development/changelog.rst b/docs/sphinx/source/development/changelog.rst
@@ -6,6 +6,105 @@ Changelog
 
 *More entries will be added in the future.*
 
+.. _changelog_2.6.0:
+
+[2.6.0] - Minor Release
+=======================
+
+Added
+-----
+
+*caterpillar.fields._base*
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+- Add support for non-context lambda switch fields
+
+
+*caterpillar.fields.common*
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+- Add compatibility support for CAPI atoms in ``Int``, ``UInt`` and ``PyStructFormattedField``
+
+*caterpillar.options*
+^^^^^^^^^^^^^^^^^^^^^
+
+- Add custom ``Flag.__eq__`` implementation to support equality check with ``c_Option`` objects
+
+
+*caterpillar.abc*
+^^^^^^^^^^^^^^^^^
+
+- Add new typing-only `_OptionLike` protocol
+- Add missing `_SupportsType` protocol to the stubs file
+- Add new method `get` to the `_ContextLike` protocol
+
+
+*caterpillar.context*
+^^^^^^^^^^^^^^^^^^^^^
+
+- Add new option :py:attr:`~caterpillar.context.O_CONTEXT_FACTORY` that controls
+  the global context type. Value must be a method or another type implementing
+  the :class:`_ContextLike` protocol
+- Add new global context path: :py:attr:`~caterpillar.context.root` (exported as ``G`` in shortcuts)
+
+*caterpillar.shortcuts*
+^^^^^^^^^^^^^^^^^^^^^^^
+
+- Add new shortcuts ``C`` for :py:attr:`~caterpillar.context.ctx`, ``P`` for
+  :py:attr:`~caterpillar.context.parent` and ``G`` for the
+  :py:attr:`~caterpillar.context.root` context as
+  :class:`~caterpillar.context.ContextPath` objects
+
+
+*CAPI*
+^^^^^^
+
+- New index assignment system when generating CAPI code. A running number is now
+  applied instead of a hard coded index.
+- Add *complete* Context implementation in C (:class:`c_Context`) that conforms
+  to the :class:`_ContextLike` protocol.
+- Add :class:`Atom` for C-based struct-like classes. This class was previously
+  known as :class:`catom`
+- Add native support for `__bits__` in :class:`Atom`
+- Add special class :class:`LengthInfo` for packing or unpacking multiple objects
+- New builtin atoms (CAPI): :class:`Repeated`, :class:`Conditional` and :class:`Switch`
+- Add new shared objects and exception types to the native implementation
+  (:c:var:`Cp_ContextFactory`, :c:var:`Cp_ArrayFactory`, :c:var:`CpExc_Stop` and
+  :c:var:`Cp_DefaultOption`)
+
+
+Changed
+-------
+
+*caterpillar.fields._base*
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+- Rework :class:`~caterpillar.fields._base.Field` implementation to reduce
+  overhead when packing and unpacking elements
+- Use pre-computed states instead of calculating everything on-the-fly. States
+  will be adjusted when setting new values (automatically updated through
+  :code:`@property` attributes)
+
+
+Fixed
+-----
+
+*caterpillar.fields.common*
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
++ Fix issue in Prefixed that occurred when the internal struct packs a sequence
+  of elements
+
+Removed
+-------
+
+*CAPI*
+^^^^^^
+
+- Remove old CAPI and completely revamp the CAPI concept to make it compatible
+  to the Python equivalent.
+
+
 .. _changelog_2.5.1:
 
 [2.5.1] - Hot-Fix Release