Merge pull request #52 from bmwcarit/release-1-4-1

Oss release v1.4.1 created 2023-01-16-14-13

Author: violinyanev

.github/workflows/release.yml

@@ -27,7 +27,8 @@ jobs:
       shell: bash
       working-directory: ${{runner.workspace}}/build
       run: |
-        sudo apt-get install libgles2-mesa-dev libx11-dev
+        sudo apt-get update && sudo apt-get -y --no-install-recommends install \
+          libgles2-mesa-dev libx11-dev
         cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE \
             -Dramses-logic_PACKAGE_TYPE=DEB
         cmake --build . --target package --config $BUILD_TYPE

.github/workflows/test.yml

@@ -30,7 +30,8 @@ jobs:
 
     - name: Install GL/X11 packages for rendering (Linux only)
       run: |
-        sudo apt-get install libgles2-mesa-dev libx11-dev
+        sudo apt-get update && sudo apt-get -y --no-install-recommends install \
+          libgles2-mesa-dev libx11-dev
       if: ${{ contains(matrix.os, 'ubuntu') }}
 
     - name: Install clang and clang-tidy

CHANGELOG.md

@@ -2,6 +2,17 @@
 
 # Unreleased
 
+# v1.4.1
+
+**CHANGED**
+
+* Upgrade ramses from 27.0.126 to 27.0.128 (patchfix)
+
+**FIXED**
+
+* Fixed ABI break with LogicEngine::createLuaInterface, keeping old (deprecated) version for backcompatibility
+* Deprecated version of LogicEngine::createLuaInterface ignores modules declared in Lua script to keep old behavior
+
 # v1.4.0
 
 **ADDED**

CMakeLists.txt

@@ -15,7 +15,7 @@ cmake_minimum_required(VERSION 3.13)
 
 set(RLOGIC_VERSION_MAJOR 1)
 set(RLOGIC_VERSION_MINOR 4)
-set(RLOGIC_VERSION_PATCH 0)
+set(RLOGIC_VERSION_PATCH 1)
 
 set(RLOGIC_VERSION ${RLOGIC_VERSION_MAJOR}.${RLOGIC_VERSION_MINOR}.${RLOGIC_VERSION_PATCH})
 set(ramses-logic_VERSION "${RLOGIC_VERSION}" CACHE STRING "Ramses Logic version" FORCE)

README.md

@@ -40,6 +40,7 @@ existing files exported with Logic Engine version **W** or newer (Binary file co
 
 |Logic     | Included Ramses version       | Minimum required Ramses version    | Binary file compatibility    |
 |----------|-------------------------------|------------------------------------|------------------------------|
+|v1.4.1    | 27.0.128                      | 27.0.102                           | >= 1.0.0, F-Levels 01 - 05   |
 |v1.4.0    | 27.0.126                      | 27.0.102                           | >= 1.0.0, F-Levels 01 - 05   |
 |v1.3.0    | 27.0.126                      | 27.0.102                           | >= 1.0.0, F-Levels 01 - 04   |
 |v1.2.2    | 27.0.125                      | 27.0.102                           | >= 1.0.0, F-Levels 01 - 03   |

ci/scripts/code_style_checker/check_all_styles.py

@@ -58,6 +58,7 @@ def main():
     shared_blacklist = binary_files | {
         r'\.git',
         r'\.gitignore',
+        r'\.lfsconfig',
         r'gitconfig$',
         r'xorg.conf',
         r'Xwrapper.config',

doc/sphinx/api.rst

@@ -691,6 +691,23 @@ the specific use-case which needs optimizing. Refer to the
 `google-benchmark docs <https://github.com/google/benchmark>`_ for hints how to
 design good benchmarks, to set the time measurement units, derive O-complexity, etc.
 
+-------------------------
+Optimizing file size
+-------------------------
+
+It's possible to reduce the file size of the exported LogicEngine data by storing the bytecode of the
+Lua scripts and modules, instead of the source code. This might sound very attractive, but it has two
+major caveats:
+
+* Lua bytecode is notnriously vulnerable to malicious attacks
+* Bytecode is architecture-specific, i.e. you can't run ARM bytecode on a x86 processor
+
+In order to provide a good mix between flexibility and performance, the LogicEngine allows choosing what
+to be stored when saving into a binary file: only the source code, only the bytecode, or both. While the first
+option is the safest and most robust, it is also the slowest. Storing both source and binary will offer both fast loading
+when the architecture matches and a fallback solution when it doesn't, but it results in larger binary files. Choose
+an option which suits the needs of your application. Read more in :func:`rlogic::SaveFileConfig::setLuaSavingMode`.
+
 =========================
 List of all examples
 =========================

external/ramses

@@ -191,7 +191,25 @@ namespace rlogic
         RLOGIC_API LuaInterface* createLuaInterface(
             std::string_view source,
             std::string_view interfaceName,
-            const LuaConfig& config = {});
+            const LuaConfig& config);
+
+        /**
+        * Deprecated! Use #createLuaInterface(std::string_view, std::string_view, const LuaConfig&) instead.
+        *
+        * Same as #createLuaInterface(std::string_view, std::string_view, const LuaConfig&) but without
+        * support for using #rlogic::LuaModule in the interface, also will ignore any \c modules
+        * declaration within the provided interface source.
+        *
+        * @deprecated
+        * @param source the Lua source code
+        * @param interfaceName name to assign to the interface once it's created. This name must be unique!
+        * @return a pointer to the created object or nullptr if
+        * something went wrong during creation. In that case, use #getErrors() to obtain errors.
+        * The interface can be destroyed by calling the #destroy method
+        */
+        RLOGIC_API LuaInterface* createLuaInterface(
+            std::string_view source,
+            std::string_view interfaceName);
 
         /**
          * Creates a new #rlogic::LuaModule from Lua source code.

include/ramses-logic/LogicEngine.h

@@ -111,7 +111,13 @@ namespace rlogic
 
     LuaInterface* LogicEngine::createLuaInterface(std::string_view source, std::string_view interfaceName, const LuaConfig& config)
     {
-        return m_impl->createLuaInterface(source, *config.m_impl, interfaceName);
+        return m_impl->createLuaInterface(source, *config.m_impl, interfaceName, true);
+    }
+
+    LuaInterface* LogicEngine::createLuaInterface(std::string_view source, std::string_view interfaceName)
+    {
+        // deprecated version of interface creation does not verify modules declared in script
+        return m_impl->createLuaInterface(source, {}, interfaceName, false);
     }
 
     LuaModule* LogicEngine::createLuaModule(std::string_view source, const LuaConfig& config, std::string_view moduleName)