add missing LIN experimental docs to html (SILKIT-1738) (#197)

MariusBgm · web-flow · commit eeef1af5ca73 · 2025-04-15T16:42:43.000+02:00
Use system libs for mingw-w64 build (WORKAROUND) and fix build on mingw with system libs.
diff --git a/.github/workflows/build-mingw64.yml b/.github/workflows/build-mingw64.yml
@@ -19,7 +19,7 @@ jobs:
     strategy:
       matrix:
         builds:
-          - arch: x86_64
+          - arch: mingw-w64-x86_64
             bin: /mingw64/bin
           #- arch: i686
           #  bin: /mingw32/bin
@@ -29,7 +29,7 @@ jobs:
     steps:
     - name: Setup host
       run: |
-        pacman -S mingw-w64-${{ matrix.builds.arch }}-gcc mingw-w64-${{ matrix.builds.arch }}-cmake mingw-w64-${{ matrix.builds.arch }}-ninja --noconfirm
+        pacman -S ${{ matrix.builds.arch }}-gcc ${{ matrix.builds.arch }}-cmake ${{ matrix.builds.arch }}-ninja ${{ matrix.builds.arch }}-yaml-cpp ${{ matrix.builds.arch }}-fmt ${{ matrix.builds.arch }}-gtest  ${{matrix.builds.arch}}-asio ${{matrix.builds.arch}}-spdlog --noconfirm
 
 
     - uses: actions/checkout@v4
@@ -40,6 +40,6 @@ jobs:
       with:
         preset-name: gcc-release
         artifact-label: ${{ github.job }}-${{ matrix.builds.arch }}
-        cmake-args: -D SILKIT_BUILD_DOCS=OFF
+        cmake-args: -D SILKIT_BUILD_DOCS=OFF -D SILKIT_USE_SYSTEM_LIBRARIES=ON -D SILKIT_BUILD_DASHBOARD=OFF
         extra-path: "${{ matrix.builds.bin }}:"
         shell: C:\shells\msys2bash.cmd {0}
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -112,6 +112,7 @@ set(SILKIT_HOST_PLATFORM "${plat}")
 set(SILKIT_HOST_ARCHITECTURE "${arch}")
 set(SILKIT_HOST_COMPILER "${comp}")
 message(STATUS "SIL Kit - CMAKE_VERSION ${CMAKE_VERSION}")
+message(STATUS "SIL Kit - CMAKE_COMMAND ${CMAKE_COMMAND}")
 message(STATUS "SIL Kit - SILKIT_HOST_PLATFORM ${SILKIT_HOST_PLATFORM}")
 message(STATUS "SIL Kit - SILKIT_HOST_ARCHITECTURE ${SILKIT_HOST_ARCHITECTURE}")
 message(STATUS "SIL Kit - SILKIT_HOST_COMPILER ${SILKIT_HOST_COMPILER}")
diff --git a/SilKit/IntegrationTests/FTest_PubSubPerf.cpp b/SilKit/IntegrationTests/FTest_PubSubPerf.cpp
@@ -20,6 +20,7 @@ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
 
 #include <iostream>
+#include <iomanip>
 
 #include "silkit/services/all.hpp"
 #include "silkit/services/logging/ILogger.hpp"
diff --git a/SilKit/cmake/SilKitTestAsio.cmake b/SilKit/cmake/SilKitTestAsio.cmake
diff --git a/SilKit/source/core/participant/Participant_impl.hpp b/SilKit/source/core/participant/Participant_impl.hpp
@@ -70,6 +70,8 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
 #include "Assert.hpp"
 #include "ExecutionEnvironment.hpp"
 
+#include "fmt/ranges.h"
+
 
 
 namespace SilKit {
diff --git a/SilKit/source/core/vasio/ConnectKnownParticipants.cpp b/SilKit/source/core/vasio/ConnectKnownParticipants.cpp
@@ -31,6 +31,7 @@
 #include <memory>
 
 #include "fmt/format.h"
+#include "fmt/ranges.h"
 
 
 #if SILKIT_ENABLE_TRACING_INSTRUMENTATION_VAsioConnection
diff --git a/SilKit/source/core/vasio/VAsioConnection.cpp b/SilKit/source/core/vasio/VAsioConnection.cpp
@@ -49,6 +49,8 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
 
 #include "asio.hpp"
 
+#include "fmt/ranges.h"
+
 
 #if SILKIT_ENABLE_TRACING_INSTRUMENTATION_VAsioConnection
 #define SILKIT_TRACE_METHOD_(logger, ...) SILKIT_TRACE_METHOD(logger, __VA_ARGS__)
diff --git a/SilKit/source/core/vasio/VAsioPeer.cpp b/SilKit/source/core/vasio/VAsioPeer.cpp
@@ -261,7 +261,7 @@ void VAsioPeer::DispatchBuffer()
     // validate the received size
     if (_currentMsgSize == 0 || _currentMsgSize > 1024 * 1024 * 1024)
     {
-        SilKit::Services::Logging::Error(_logger, "Received invalid Message Size: {}", _currentMsgSize);
+        SilKit::Services::Logging::Error(_logger, "Received invalid Message Size: {}", _currentMsgSize.load());
         Shutdown();
     }
 
diff --git a/SilKit/source/services/logging/Logger.cpp b/SilKit/source/services/logging/Logger.cpp
@@ -141,7 +141,7 @@ struct fmt::formatter<SilKit::Services::Logging::SimpleLogMessage>
     }
 
     template <typename FormatContext>
-    auto format(const SilKit::Services::Logging::SimpleLogMessage& msg, FormatContext& ctx)
+    auto format(const SilKit::Services::Logging::SimpleLogMessage& msg, FormatContext& ctx) const
     {
         if (!msg.kv.empty())
         {
@@ -164,7 +164,7 @@ struct fmt::formatter<SilKit::Services::Logging::JsonLogMessage>
     }
 
     template <typename FormatContext>
-    auto format(const SilKit::Services::Logging::JsonLogMessage& msg, FormatContext& ctx)
+    auto format(const SilKit::Services::Logging::JsonLogMessage& msg, FormatContext& ctx) const
     {
         if (!msg.kv.empty())
         {
@@ -430,7 +430,7 @@ void Logger::Log(Level level, const std::string& msg)
     if (nullptr != _loggerJson)
     {
         JsonString jsonString{msg};
-        _loggerJson->log(now, spdlog::source_loc{}, to_spdlog(level), fmt::format("{}", jsonString));
+        _loggerJson->log(now, spdlog::source_loc{}, to_spdlog(level), fmt::format("{}",jsonString.m));
     }
     if (nullptr != _loggerSimple)
     {
diff --git a/SilKit/source/util/CMakeLists.txt b/SilKit/source/util/CMakeLists.txt
@@ -29,7 +29,7 @@ target_link_libraries(O_SilKit_Util
     PUBLIC I_SilKit_Util
     PRIVATE SilKitInterface
     PRIVATE asio
-    PRIVATE fmt-header-only
+    PRIVATE fmt::fmt-header-only
 )
 
 if (MSVC)
diff --git a/ThirdParty/CMakeLists.txt b/ThirdParty/CMakeLists.txt
@@ -70,25 +70,23 @@ endfunction()
 # the binary distribution lacks the Asio sources
 # but it should be included/deployed by our packaging tools
 function(include_asio)
-    if(NOT SILKIT_USE_SYSTEM_LIBRARIES)
-        set(ASIO_INCLUDE_DIR ${SILKIT_THIRD_PARTY_SOURCE_DIR}/asio/asio/include)
 
-        if(NOT EXISTS ${ASIO_INCLUDE_DIR})
-            message(FATAL_ERROR "Asio include directory not found: ${ASIO_INCLUDE_DIR}")
-        else()
-            message(STATUS "Asio include directory found:${ASIO_INCLUDE_DIR}")
-        endif()
+    if( SILKIT_USE_SYSTEM_LIBRARIES)
+        find_path(ASIO_INCLUDE_DIR asio.hpp)
+    else()
+        set(ASIO_INCLUDE_DIR ${SILKIT_THIRD_PARTY_SOURCE_DIR}/asio/asio/include)
+    endif()
 
-        silkit_clean_default_compileflags()
-        add_library(asio INTERFACE)
-        target_include_directories(asio INTERFACE "${ASIO_INCLUDE_DIR}")
-        set(SILKIT_THIRD_PARTY_ASIO "asio" CACHE STRING "Name of the third party asio target")
+    if(NOT EXISTS ${ASIO_INCLUDE_DIR})
+        message(FATAL_ERROR "Asio include directory not found: ${ASIO_INCLUDE_DIR}")
     else()
-        # Test if ASIO is installed
-        include(SilKitTestAsio)
-        silkit_check_for_asio()
-        set(SILKIT_THIRD_PARTY_ASIO "" CACHE STRING "Name of the third party asio target")
+        message(STATUS "Asio include directory found:${ASIO_INCLUDE_DIR}")
     endif()
+
+    silkit_clean_default_compileflags()
+    add_library(asio INTERFACE)
+    target_include_directories(asio INTERFACE "${ASIO_INCLUDE_DIR}")
+    set(SILKIT_THIRD_PARTY_ASIO "asio" CACHE STRING "Name of the third party asio target")
 endfunction()
 
 # Third party YAML parsing 
@@ -146,9 +144,18 @@ function(include_fmt)
             set(SILKIT_THIRD_PARTY_FMT_HEADER_ONLY_TARGET "" CACHE STRING "Header only target for third party libfmt")
         endif()
     else()
-        # Find libfmt
-        find_package(fmt REQUIRED)
-        set(SILKIT_THIRD_PARTY_FMT_HEADER_ONLY_TARGET "fmt::fmt-header-only" CACHE STRING "Header only target for third party libfmt")
+        # Find system libfmt
+        include(FindPkgConfig)
+        pkg_check_modules(fmt REQUIRED IMPORTED_TARGET GLOBAL fmt)
+        add_library(fmt-header-only INTERFACE)
+        target_include_directories(fmt-header-only INTERFACE ${fmt_INCLUDE_DIRS})
+        target_compile_definitions(fmt-header-only INTERFACE FMT_HEADER_ONLY=1)
+
+        add_library(fmt::fmt-header-only ALIAS fmt-header-only)
+        add_library(fmt::fmt ALIAS fmt-header-only)
+        set(SPDLOG_FMT_EXTERNAL Off CACHE BOOL "we have our own")
+        set(SPDLOG_FMT_EXTERNAL_HO Off CACHE BOOL "we have our own")
+        set(SILKIT_THIRD_PARTY_FMT_HEADER_ONLY_TARGET "fmt::fmt-header-only" CACHE STRING "Header only target for third party libfmt (system library)")
     endif()
 endfunction()
 
diff --git a/docs/api/capi/capi-lin.rst b/docs/api/capi/capi-lin.rst
@@ -43,9 +43,13 @@ LIN Controller
 
 **The following functions are experimental and might be changed or removed in future versions:**
 
+.. doxygenfunction:: SilKit_Experimental_LinController_InitDynamic
 .. doxygenfunction:: SilKit_Experimental_LinController_AddLinSlaveConfigurationHandler
 .. doxygenfunction:: SilKit_Experimental_LinController_RemoveLinSlaveConfigurationHandler
 .. doxygenfunction:: SilKit_Experimental_LinController_GetSlaveConfiguration
+.. doxygenfunction:: SilKit_Experimental_LinController_SendDynamicResponse
+.. doxygenfunction:: SilKit_Experimental_LinController_AddFrameHeaderHandler
+.. doxygenfunction:: SilKit_Experimental_LinController_RemoveFrameHeaderHandler
 
 Data Structures
 ~~~~~~~~~~~~~~~
diff --git a/docs/api/services/lin.rst b/docs/api/services/lin.rst
@@ -12,6 +12,7 @@ LIN Service API
 .. |ILinController| replace:: :cpp:class:`ILinController<SilKit::Services::Lin::ILinController>`
 
 .. |Init| replace:: :cpp:func:`Init()<SilKit::Services::Lin::ILinController::Init>`
+.. |InitDynamic| replace:: :cpp:func:`InitDynamic()<SilKit::Experimental::Services::Lin::InitDynamic>`
 .. |SendFrame| replace:: :cpp:func:`SendFrame()<SilKit::Services::Lin::ILinController::SendFrame>`
 .. |SendFrameHeader| replace:: :cpp:func:`SendFrameHeader()<SilKit::Services::Lin::ILinController::SendFrameHeader>`
 .. |UpdateTxBuffer| replace:: :cpp:func:`UpdateTxBuffer()<SilKit::Services::Lin::ILinController::UpdateTxBuffer>`
@@ -91,12 +92,12 @@ Initialization
 ~~~~~~~~~~~~~~
 
 Before the LIN Controller can be used, it must be initialized. The initialization is performed by setting up a
-|LinControllerConfig| and passing it to |Init|. The |LinControllerMode| must be set to either 
-|LinControllerMode_Master| or |LinControllerMode_Slave| and the baud rate must be specified. Further, the 
-|LinControllerConfig| provides the configuration on which LIN IDs the controller will receive 
+|LinControllerConfig| and passing it to |Init| or |InitDynamic|. The |LinControllerMode| must be set to either
+|LinControllerMode_Master| or |LinControllerMode_Slave| and the baud rate must be specified. Further, the
+|LinControllerConfig| provides the configuration on which LIN IDs the controller will receive
 (|LinFrameResponseMode_Rx|) or respond to (|LinFrameResponseMode_Tx|) frames.
 
-The following example configures a LIN controller as a LIN slave with a baud rate of 20'000 baud. Furthermore, LIN ID 
+The following example configures a LIN controller as a LIN slave with a baud rate of 20'000 baud. Furthermore, LIN ID
 0x11 is configured for transmission::
 
     LinFrameResponse response;
@@ -425,6 +426,10 @@ reside in the `SilKit::Experimental::Services::Lin` namespace and might be chang
 
 The experimental API is defined as follows:
 
+.. doxygenfunction:: SilKit::Experimental::Services::Lin::InitDynamic(SilKit::Services::Lin::ILinController* linController, const SilKit::Experimental::Services::Lin::LinControllerDynamicConfig& dynamicConfig)
 .. doxygenfunction:: SilKit::Experimental::Services::Lin::AddLinSlaveConfigurationHandler(SilKit::Services::Lin::ILinController* linController, SilKit::Experimental::Services::Lin::LinSlaveConfigurationHandler handler)
 .. doxygenfunction:: SilKit::Experimental::Services::Lin::RemoveLinSlaveConfigurationHandler(SilKit::Services::Lin::ILinController* linController, SilKit::Util::HandlerId handlerId)
 .. doxygenfunction:: SilKit::Experimental::Services::Lin::GetSlaveConfiguration(SilKit::Services::Lin::ILinController* linController)
+.. doxygenfunction:: SilKit::Experimental::Services::Lin::AddFrameHeaderHandler(SilKit::Services::Lin::ILinController* linController, SilKit::Experimental::Services::Lin::LinFrameHeaderHandler handler)
+.. doxygenfunction:: SilKit::Experimental::Services::Lin::RemoveFrameHeaderHandler
+.. doxygenfunction:: SilKit::Experimental::Services::Lin::SendDynamicResponse

Original file line number	Diff line number	Diff line change
`@@ -261,7 +261,7 @@ void VAsioPeer::DispatchBuffer()`
`261`	`261`	`// validate the received size`
`262`	`262`	`if (_currentMsgSize == 0 \|\| _currentMsgSize > 1024 * 1024 * 1024)`
`263`	`263`	`{`
`264`		`- SilKit::Services::Logging::Error(_logger, "Received invalid Message Size: {}", _currentMsgSize);`
	`264`	`+ SilKit::Services::Logging::Error(_logger, "Received invalid Message Size: {}", _currentMsgSize.load());`
`265`	`265`	`Shutdown();`
`266`	`266`	`}`
`267`	`267`
Original file line number	Diff line number	Diff line change
`@@ -141,7 +141,7 @@ struct fmt::formatter<SilKit::Services::Logging::SimpleLogMessage>`
`141`	`141`	`}`
`142`	`142`
`143`	`143`	`template <typename FormatContext>`
`144`		`- auto format(const SilKit::Services::Logging::SimpleLogMessage& msg, FormatContext& ctx)`
	`144`	`+ auto format(const SilKit::Services::Logging::SimpleLogMessage& msg, FormatContext& ctx) const`
`145`	`145`	`{`
`146`	`146`	`if (!msg.kv.empty())`
`147`	`147`	`{`
`@@ -164,7 +164,7 @@ struct fmt::formatter<SilKit::Services::Logging::JsonLogMessage>`
`164`	`164`	`}`
`165`	`165`
`166`	`166`	`template <typename FormatContext>`
`167`		`- auto format(const SilKit::Services::Logging::JsonLogMessage& msg, FormatContext& ctx)`
	`167`	`+ auto format(const SilKit::Services::Logging::JsonLogMessage& msg, FormatContext& ctx) const`
`168`	`168`	`{`
`169`	`169`	`if (!msg.kv.empty())`
`170`	`170`	`{`
`@@ -430,7 +430,7 @@ void Logger::Log(Level level, const std::string& msg)`
`430`	`430`	`if (nullptr != _loggerJson)`
`431`	`431`	`{`
`432`	`432`	`JsonString jsonString{msg};`
`433`		`- _loggerJson->log(now, spdlog::source_loc{}, to_spdlog(level), fmt::format("{}", jsonString));`
	`433`	`+ _loggerJson->log(now, spdlog::source_loc{}, to_spdlog(level), fmt::format("{}",jsonString.m));`
`434`	`434`	`}`
`435`	`435`	`if (nullptr != _loggerSimple)`
`436`	`436`	`{`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ target_link_libraries(O_SilKit_Util`
`29`	`29`	`PUBLIC I_SilKit_Util`
`30`	`30`	`PRIVATE SilKitInterface`
`31`	`31`	`PRIVATE asio`
`32`		`- PRIVATE fmt-header-only`
	`32`	`+ PRIVATE fmt::fmt-header-only`
`33`	`33`	`)`
`34`	`34`
`35`	`35`	`if (MSVC)`