Merge branch 'develop'

Author: MaJerle

.github/workflows/release.yml

@@ -1,4 +1,4 @@
-name: Release workflow
+name: Create Release
 
 on:
   push:
@@ -7,23 +7,29 @@ on:
       - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10
 
 jobs:
-  # Create the release from the tag
   create-release:
-    name: Create Release
+    name: Create GitHub Release
     runs-on: ubuntu-latest
+    
+    # Explicitly grant permission to create/write releases
+    permissions:
+      contents: write
+
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-      - name: Create Release
-        id: create_release
-        uses: actions/create-release@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 
+      # Step 1: Check out the repository code
+      # Fetch the full history to compare between tags
+      - name: Checkout Code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      # Generate the release
+      - name: Generate and Publish Release
+        uses: softprops/action-gh-release@v2
         with:
-          tag_name: ${{ github.ref }}
-          release_name: Release ${{ github.ref }}
-          body: |
-            See the [CHANGELOG](CHANGELOG.md)
+          tag_name: ${{ github.ref_name }}
+          name: Release ${{ github.ref_name }}
+          generate_release_notes: true
           draft: false
           prerelease: false
 
@@ -46,3 +52,30 @@ jobs:
         env:
           PLATFORMIO_AUTH_TOKEN: ${{ secrets.PLATFORMIO_AUTH_TOKEN }}
         run: pio pkg publish --type library --non-interactive
+
+  # Publish python/ package to PyPI
+  publish-pypi:
+    runs-on: ubuntu-latest
+    environment: pypi # must match the environment name entered when registering the trusted publisher on pypi.org
+    permissions:
+      id-token: write # required for PyPI trusted publishing
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Install build tooling
+        run: pip install build
+
+      - name: Build package
+        working-directory: python
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: python/dist

.gitignore

@@ -358,6 +358,11 @@ paket-files/
 __pycache__/
 *.pyc
 
+# Python packaging build artifacts
+dist/
+*.egg-info/
+.pytest_cache/
+
 # Cake - Uncomment if you are using it
 # tools/**
 # !tools/packages.config

CHANGELOG.md

@@ -2,6 +2,17 @@
 
 ## Develop
 
+## v2.0.0
+
+- **Breaking (Python):** `rx_process()` now raises typed exceptions (`LwPKTError` and subclasses)
+  on malformed input, instead of silently discarding or printing to console
+- Publish Python implementation to PyPI as `lwpkt` (`pip install lwpkt`)
+- Add continuation-byte limits to variable-length fields (`len`, address, `cmd`, `flags`) in both
+  C and Python, rejecting corrupted/malicious streams instead of parsing them unbounded
+- Add missing `NULL`-instance checks across setter functions and `lwpkt_write`
+- Update bundled LwRB to latest version
+- Add GCC CMake preset for native builds
+
 ## v1.5.1
 
 - Fix the platformio library package description

CMakePresets.json

@@ -25,6 +25,14 @@
             "cacheVariables": {
                 "CMAKE_BUILD_TYPE": "Debug"
             }
+        },
+        {
+            "name": "Gcc-Debug",
+            "inherits": "default",
+            "toolchainFile": "${sourceDir}/cmake/gcc.cmake",
+            "cacheVariables": {
+                "CMAKE_BUILD_TYPE": "Debug"
+            }
         }
     ],
     "buildPresets": [
@@ -35,6 +43,10 @@
         {
             "name": "Win64-Debug",
             "configurePreset": "Win64-Debug"
+        },
+        {
+            "name": "Gcc-Debug",
+            "configurePreset": "Gcc-Debug"
         }
     ]
 }

cmake/gcc.cmake

@@ -0,0 +1,4 @@
+# Some default GCC settings
+# Assuming "gcc" and "g++" commands are globally available
+set(CMAKE_C_COMPILER    gcc)
+set(CMAKE_CXX_COMPILER  g++)

cmake/i686-w64-mingw32-gcc.cmake

@@ -1,7 +1,8 @@
-set(CMAKE_SYSTEM_NAME               Windows)
+set(CMAKE_SYSTEM_NAME   Windows)
 
 # Some default GCC settings
-set(CMAKE_C_COMPILER                i686-w64-mingw32-gcc)
-set(CMAKE_CXX_COMPILER              i686-w64-mingw32-g++)
+# Use MSYS2's "mingw-w64-i686-gcc" package
+set(CMAKE_C_COMPILER    i686-w64-mingw32-gcc)
+set(CMAKE_CXX_COMPILER  i686-w64-mingw32-g++)
 
 set(CMAKE_TRY_COMPILE_TARGET_TYPE STATIC_LIBRARY)

cmake/x86_64-w64-mingw32-gcc.cmake

@@ -1,7 +1,8 @@
-set(CMAKE_SYSTEM_NAME               Windows)
+set(CMAKE_SYSTEM_NAME   Windows)
 
 # Some default GCC settings
-set(CMAKE_C_COMPILER                x86_64-w64-mingw32-gcc)
-set(CMAKE_CXX_COMPILER              x86_64-w64-mingw32-g++)
+# Use MSYS2's "mingw-w64-x86_64-gcc" package
+set(CMAKE_C_COMPILER    x86_64-w64-mingw32-gcc)
+set(CMAKE_CXX_COMPILER  x86_64-w64-mingw32-g++)
 
 set(CMAKE_TRY_COMPILE_TARGET_TYPE STATIC_LIBRARY)

library.json

@@ -1,6 +1,6 @@
 {
     "name": "LwPKT",
-    "version": "1.5.1",
+    "version": "2.0.0",
     "description": "Lightweight packet protocol library for communication implementation",
     "keywords": "lwpkt, packet, protocol, manager, communication, com, lightweight, rs-485, rs-422, rs485, rs422, rs-232, rs232, uart, usart, lpuart",
     "repository": {

libs/lwrb/src/include/lwrb/lwrb.h

@@ -29,11 +29,12 @@
  * This file is part of LwRB - Lightweight ring buffer library.
  *
  * Author:          Tilen MAJERLE <tilen@majerle.eu>
- * Version:         v3.0.0-rc1
+ * Version:         v3.3.0
  */
 #ifndef LWRB_HDR_H
 #define LWRB_HDR_H
 
+#include <stddef.h>
 #include <stdint.h>
 #include <string.h>
 
@@ -47,11 +48,30 @@ extern "C" {
  * \{
  */
 
-#ifdef LWRB_DISABLE_ATOMIC
-typedef unsigned long lwrb_ulong_t;
-#else
+#if !defined(LWRB_DISABLE_ATOMIC) || __DOXYGEN__
 #include <stdatomic.h>
-typedef atomic_ulong lwrb_ulong_t;
+
+/**
+ * \brief           Atomic type for size variable.
+ * Default value is set to be `unsigned 32-bits` type
+ */
+typedef atomic_ulong lwrb_sz_atomic_t;
+
+/**
+ * \brief           Size variable for all library operations.
+ * Default value is set to be `unsigned 32-bits` type
+ */
+typedef unsigned long lwrb_sz_t;
+#else
+/*
+ * LWRB_DISABLE_ATOMIC is defined, so the atomic type is dropped in favor of a
+ * plain one. This is not "atomicity off, everything else still guaranteed" -
+ * there is no ordering or visibility guarantee between the write and read
+ * side left in the library at all. If you define this, it is entirely up to
+ * the application to make sure the target handles concurrent access safely.
+ */
+typedef unsigned long lwrb_sz_atomic_t;
+typedef unsigned long lwrb_sz_t;
 #endif
 
 /**
@@ -74,46 +94,61 @@ struct lwrb;
  * \param[in]       evt: Event type
  * \param[in]       bp: Number of bytes written or read (when used), depends on event type
  */
-typedef void (*lwrb_evt_fn)(struct lwrb* buff, lwrb_evt_type_t evt, size_t bp);
+typedef void (*lwrb_evt_fn)(struct lwrb* buff, lwrb_evt_type_t evt, lwrb_sz_t bp);
+
+/* List of flags */
+#define LWRB_FLAG_READ_ALL  ((uint16_t)0x0001)
+#define LWRB_FLAG_WRITE_ALL ((uint16_t)0x0001)
 
 /**
  * \brief           Buffer structure
  */
 typedef struct lwrb {
     uint8_t* buff;  /*!< Pointer to buffer data. Buffer is considered initialized when `buff != NULL` and `size > 0` */
-    size_t size;    /*!< Size of buffer data. Size of actual buffer is `1` byte less than value holds */
-    lwrb_ulong_t r; /*!< Next read pointer. Buffer is considered empty when `r == w` and full when `w == r - 1` */
-    lwrb_ulong_t w; /*!< Next write pointer. Buffer is considered empty when `r == w` and full when `w == r - 1` */
-    lwrb_evt_fn evt_fn; /*!< Pointer to event callback function */
+    lwrb_sz_t size; /*!< Size of buffer data. Size of actual buffer is `1` byte less than value holds */
+    lwrb_sz_atomic_t r_ptr; /*!< Next read pointer.
+                                Buffer is considered empty when `r == w` and full when `w == r - 1` */
+    lwrb_sz_atomic_t w_ptr; /*!< Next write pointer.
+                                Buffer is considered empty when `r == w` and full when `w == r - 1` */
+    lwrb_evt_fn evt_fn;     /*!< Pointer to event callback function */
+    void* arg;              /*!< Event custom user argument */
 } lwrb_t;
 
-uint8_t lwrb_init(lwrb_t* buff, void* buffdata, size_t size);
+uint8_t lwrb_init(lwrb_t* buff, void* buffdata, lwrb_sz_t size);
 uint8_t lwrb_is_ready(lwrb_t* buff);
 void lwrb_free(lwrb_t* buff);
 void lwrb_reset(lwrb_t* buff);
 void lwrb_set_evt_fn(lwrb_t* buff, lwrb_evt_fn fn);
+void lwrb_set_arg(lwrb_t* buff, void* arg);
+void* lwrb_get_arg(lwrb_t* buff);
 
 /* Read/Write functions */
-size_t lwrb_write(lwrb_t* buff, const void* data, size_t btw);
-size_t lwrb_read(lwrb_t* buff, void* data, size_t btr);
-size_t lwrb_peek(const lwrb_t* buff, size_t skip_count, void* data, size_t btp);
+lwrb_sz_t lwrb_write(lwrb_t* buff, const void* data, lwrb_sz_t btw);
+lwrb_sz_t lwrb_read(lwrb_t* buff, void* data, lwrb_sz_t btr);
+lwrb_sz_t lwrb_peek(const lwrb_t* buff, lwrb_sz_t skip_count, void* data, lwrb_sz_t btp);
+
+/* Extended read/write functions */
+uint8_t lwrb_write_ex(lwrb_t* buff, const void* data, lwrb_sz_t btw, lwrb_sz_t* bwritten, uint16_t flags);
+uint8_t lwrb_read_ex(lwrb_t* buff, void* data, lwrb_sz_t btr, lwrb_sz_t* bread, uint16_t flags);
 
 /* Buffer size information */
-size_t lwrb_get_free(const lwrb_t* buff);
-size_t lwrb_get_full(const lwrb_t* buff);
+lwrb_sz_t lwrb_get_free(const lwrb_t* buff);
+lwrb_sz_t lwrb_get_full(const lwrb_t* buff);
 
 /* Read data block management */
 void* lwrb_get_linear_block_read_address(const lwrb_t* buff);
-size_t lwrb_get_linear_block_read_length(const lwrb_t* buff);
-size_t lwrb_skip(lwrb_t* buff, size_t len);
+lwrb_sz_t lwrb_get_linear_block_read_length(const lwrb_t* buff);
+lwrb_sz_t lwrb_skip(lwrb_t* buff, lwrb_sz_t len);
 
 /* Write data block management */
 void* lwrb_get_linear_block_write_address(const lwrb_t* buff);
-size_t lwrb_get_linear_block_write_length(const lwrb_t* buff);
-size_t lwrb_advance(lwrb_t* buff, size_t len);
+lwrb_sz_t lwrb_get_linear_block_write_length(const lwrb_t* buff);
+lwrb_sz_t lwrb_advance(lwrb_t* buff, lwrb_sz_t len);
 
 /* Search in buffer */
-uint8_t lwrb_find(const lwrb_t* buff, const void* bts, size_t len, size_t start_offset, size_t* found_idx);
+uint8_t lwrb_find(const lwrb_t* buff, const void* bts, lwrb_sz_t len, lwrb_sz_t start_offset, lwrb_sz_t* found_idx);
+lwrb_sz_t lwrb_overwrite(lwrb_t* buff, const void* data, lwrb_sz_t btw);
+lwrb_sz_t lwrb_move(lwrb_t* dest, lwrb_t* src);
 
 /**
  * \}