spl-core 7.3.0rc1__tar.gz → 7.3.2__tar.gz

{spl_core-7.3.0rc1 → spl_core-7.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: spl-core
-Version: 7.3.0rc1
+Version: 7.3.2
 Summary: Software Product Line Support for CMake
 License: MIT
 Author: Avengineers
@@ -18,7 +18,7 @@ Classifier: Topic :: Software Development :: Libraries
 Requires-Dist: cookiecutter (==2.1.1)
 Requires-Dist: doxysphinx (>=3.3,<4.0)
 Requires-Dist: gcovr (>=8.3,<9.0)
-Requires-Dist: hammocking (>=0.6,<0.7)
+Requires-Dist: hammocking (>=0.8,<0.9)
 Requires-Dist: kconfiglib (>=14.1,<15.0)
 Requires-Dist: mlx-traceability (>=10.0,<11.0)
 Requires-Dist: myst-parser (>=0.16)

{spl_core-7.3.0rc1 → spl_core-7.3.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "spl-core"
-version = "7.3.0-rc.1"
+version = "7.3.2"
 description = "Software Product Line Support for CMake"
 authors = ["Avengineers <karsten.guenther@kamg.de>"]
 license = "MIT"
@@ -28,7 +28,7 @@ python = ">=3.10,<3.12"
 py-app-dev = "^2.1"
 cookiecutter = "==2.1.1"
 gcovr = "^8.3"
-hammocking = "^0.6"
+hammocking = "^0.8"
 kconfiglib = "^14.1"
 typer = "^0"
 doxysphinx = "^3.3"

spl_core-7.3.2/src/spl_core/__init__.py

@@ -0,0 +1 @@
+__version__ = "7.3.2"

{spl_core-7.3.0rc1 → spl_core-7.3.2}/src/spl_core/common.cmake

@@ -76,6 +76,16 @@ macro(spl_add_test_source fileName)
     list(APPEND TEST_SOURCES ${to_be_appended})
 endmacro()
 
+macro(spl_add_provided_interface directory)
+    _spl_get_absolute_path(to_be_appended ${directory})
+    list(APPEND PROVIDED_INTERFACES ${to_be_appended})
+endmacro()
+
+macro(spl_add_required_interface component)
+    _spl_slash_to_underscore(component_name ${component})
+    list(APPEND REQUIRED_INTERFACES ${component_name})
+endmacro()
+
 macro(_spl_get_google_test)
     # GoogleTest requires at least C++14
     set(CMAKE_CXX_STANDARD 14)
@@ -182,19 +192,12 @@ macro(spl_create_component)
 \"has_reports\": \"\",
 \"reports_output_dir\": \"\"
 }")
-
-    # handle include directories with global variable
-    #list(APPEND target_include_directories__INCLUDES ${CMAKE_CURRENT_LIST_DIR}/src)
-    #list(APPEND target_include_directories__INCLUDES ${CMAKE_CURRENT_BINARY_DIR})
-    list(APPEND target_include_directories__INCLUDES ${INCLUDES})
-    list(REMOVE_DUPLICATES target_include_directories__INCLUDES)
-    set(target_include_directories__INCLUDES ${target_include_directories__INCLUDES} PARENT_SCOPE)
-
+    if(SOURCES)
+        # Create the component library
+        add_library(${component_name} ${CREATE_COMPONENT_LIBRARY_TYPE} ${SOURCES})
+    endif()
     if(BUILD_KIT STREQUAL prod)
         if(SOURCES)
-            # Create the component library
-            add_library(${component_name} ${CREATE_COMPONENT_LIBRARY_TYPE} ${SOURCES})
-
             # Define list of productive specific compile options for component's sources
             target_compile_definitions(${component_name} PRIVATE
                 SPLE_TESTABLE_STATIC=static
@@ -355,9 +358,30 @@ Code Coverage
         endif(EXISTS ${_component_doc_file})
     endif(BUILD_KIT STREQUAL prod)
 
-    # handle include directories with spl_macros
-    spl_add_provided_interfaces("${CMAKE_CURRENT_LIST_DIR}/src")
-    spl_add_provided_interfaces("${CMAKE_CURRENT_BINARY_DIR}")
+    # Implicitly add default include directories to provided interfaces
+    list(APPEND PROVIDED_INTERFACES ${CMAKE_CURRENT_LIST_DIR}/src)
+    list(APPEND PROVIDED_INTERFACES ${CMAKE_CURRENT_BINARY_DIR})
+    # Get rid of duplicates, in case the default directories where explicitly defined
+    list(REMOVE_DUPLICATES PROVIDED_INTERFACES)
+
+    # Make sure the component provided interfaces are added to the global include directories. Required for backward compatibility.
+    foreach(interfaceDir IN LISTS PROVIDED_INTERFACES)
+        spl_add_include(${interfaceDir})
+    endforeach()
+
+    list(APPEND target_include_directories__INCLUDES ${INCLUDES})
+    list(REMOVE_DUPLICATES target_include_directories__INCLUDES)
+    set(target_include_directories__INCLUDES ${target_include_directories__INCLUDES} PARENT_SCOPE)
+
+    # Define the target public interfaces to be used instead of the global include directories.
+    if(TARGET ${component_name})
+        foreach(interfaceDir IN LISTS PROVIDED_INTERFACES)
+            target_include_directories(${component_name} PUBLIC ${interfaceDir})
+        endforeach()
+        foreach(component IN LISTS REQUIRED_INTERFACES)
+            target_link_libraries(${component_name} PUBLIC ${component})
+        endforeach()
+    endif()
 
     # Collect all component info for later usage (e.g., in an extension)
     list(APPEND COMPONENTS_INFO ${_component_info})
@@ -564,9 +588,6 @@ macro(_spl_add_test_suite COMPONENT_NAME PROD_SRC TEST_SOURCES)
     target_compile_definitions(${exe_name} PRIVATE ${TEST_COMPILE_DEFINITIONS})
     target_link_options(${exe_name} PRIVATE ${TEST_LINK_OPTIONS})
 
-    # Create the component library for its productive sources
-    add_library(${COMPONENT_NAME} OBJECT ${SOURCES})
-
     target_compile_options(${COMPONENT_NAME} PRIVATE ${COMPONENT_TEST_COMPILE_OPTIONS})
 
     target_compile_definitions(${COMPONENT_NAME} PRIVATE ${TEST_COMPILE_DEFINITIONS})
@@ -744,71 +765,3 @@ macro(_spl_create_build_info_file)
     ]
 }")
 endmacro()
-
-macro(spl_add_provided_interfaces list_of_directories)
-    # Collect all provided interfaces for later usage (e.g., in an extension)
-    if(TARGET ${component_name})
-        get_target_property(provided_interfaces ${component_name} PROVIDED_INTERFACES)
-        if(provided_interfaces STREQUAL "provided_interfaces-NOTFOUND")
-            set_target_properties(${component_name} PROPERTIES PROVIDED_INTERFACES "${list_of_directories}")
-        else()
-            list(APPEND provided_interfaces ${list_of_directories})
-            set_target_properties(${component_name} PROPERTIES PROVIDED_INTERFACES "${provided_interfaces}")
-        endif()
-    endif()
-    list(APPEND target_include_directories__INCLUDES ${list_of_directories})
-    list(REMOVE_DUPLICATES target_include_directories__INCLUDES)
-    set(target_include_directories__INCLUDES ${target_include_directories__INCLUDES} PARENT_SCOPE)
-endmacro()
-
-macro(spl_add_required_interfaces list_of_interfaces)
-    if(TARGET ${component_name})
-        get_target_property(required_interfaces ${component_name} REQUIRED_INTERFACES)
-        if(required_interfaces STREQUAL "required_interfaces-NOTFOUND")
-            set_target_properties(${component_name} PROPERTIES REQUIRED_INTERFACES "${list_of_interfaces}")
-        else()
-            list(APPEND required_interfaces ${list_of_interfaces})
-            set_target_properties(${component_name} PROPERTIES REQUIRED_INTERFACES "${required_interfaces}")
-        endif()
-    endif()
-endmacro()
-
-macro(spl_resolve_interfaces)
-    foreach(component_name ${COMPONENT_NAMES})
-        if(TARGET ${component_name})
-            # get provided interfaces
-            get_target_property(COMP_PROVIDED_INTERFACES ${component_name} PROVIDED_INTERFACES)
-            if(NOT COMP_PROVIDED_INTERFACES STREQUAL "COMP_PROVIDED_INTERFACES-NOTFOUND")
-                target_include_directories(${component_name} PUBLIC ${COMP_PROVIDED_INTERFACES})
-            endif()
-
-            # get required interfaces
-            set(COMP_REQUIRED_INTERFACES "")
-            get_target_property(REQUIRED_INTERFACES ${component_name} REQUIRED_INTERFACES)
-            if(NOT REQUIRED_INTERFACES STREQUAL "REQUIRED_INTERFACES-NOTFOUND")
-                foreach(interface ${REQUIRED_INTERFACES})
-                    if (TARGET ${interface})
-                        # if the interface is a target, we can get the provided interfaces
-                        get_target_property(IF_PROVIDED_INTERFACES ${interface} PROVIDED_INTERFACES)
-                        list(APPEND COMP_REQUIRED_INTERFACES ${IF_PROVIDED_INTERFACES})
-                    else()
-                        # if the interface is not a target, we assume it is a path to an include directory
-                        _spl_get_absolute_path(absolute_interface ${interface})
-                        if(EXISTS "${absolute_interface}" AND IS_DIRECTORY "${absolute_interface}")
-                            list(APPEND COMP_REQUIRED_INTERFACES ${absolute_interface})
-                            # support the old way of handling includes
-                            list(APPEND target_include_directories__INCLUDES ${absolute_interface})
-                        else()
-                            message(WARNING "Required interface ${interface} not found for component ${component_name}.")
-                        endif()
-                    endif()
-                endforeach()
-                list(REMOVE_DUPLICATES target_include_directories__INCLUDES)
-            else()
-                set(COMP_REQUIRED_INTERFACES ${target_include_directories__INCLUDES})
-            endif()
-            # add the include directories to the component
-            target_include_directories(${component_name} PUBLIC ${COMP_REQUIRED_INTERFACES})
-        endif()
-    endforeach()
-endmacro()

{spl_core-7.3.0rc1 → spl_core-7.3.2}/src/spl_core/kickstart/templates/application/src/main/CMakeLists.txt

@@ -1,2 +1,3 @@
 spl_add_source(src/main.c)
+spl_add_required_interface(src/greeter)
 spl_create_component(LONG_NAME "Main")

spl_core-7.3.2/src/spl_core/kickstart/templates/project/.vscode/cmake-kits.json

@@ -0,0 +1,11 @@
+[
+  {
+    "name": "prod",
+    "environmentSetupScript": "${workspaceFolder}/build/env_setup.bat"
+  },
+  {
+    "name": "test",
+    "toolchainFile": "tools/toolchains/gcc/toolchain.cmake",
+    "environmentSetupScript": "${workspaceFolder}/build/env_setup.bat"
+  }
+]

{spl_core-7.3.0rc1 → spl_core-7.3.2}/src/spl_core/kickstart/templates/project/.vscode/extensions.json

@@ -2,7 +2,6 @@
     "recommendations": [
         "mhutchie.git-graph",
         "ms-vscode.cmake-tools",
-        "twxs.cmake",
         "ms-vscode.cpptools",
         "ms-vscode.cpptools-themes",
         "visualstudioexptteam.intellicode-api-usage-examples",
@@ -15,6 +14,8 @@
         "felipecaputo.git-project-manager",
         "ms-vscode.powershell",
         "waderyan.gitblame",
-        "sandcastle.vscode-open"
+        "sandcastle.vscode-open",
+        "josetr.cmake-language-support-vscode",
+        "ibm.output-colorizer"
     ]
 }

spl_core-7.3.2/src/spl_core/kickstart/templates/project/.vscode/settings.json

@@ -0,0 +1,115 @@
+{
+    "python.testing.pytestEnabled": true,
+    "python.testing.unittestEnabled": false,
+    "python.analysis.include": [
+        "test",
+        "build/modules/spl-core-src"
+    ],
+    "[python]": {
+        "editor.defaultFormatter": "charliermarsh.ruff"
+    },
+    "[cmake]": {
+        "editor.defaultFormatter": "josetr.cmake-language-support-vscode"
+    },
+    "cmake.configureOnOpen": false,
+    "cmake.buildDirectory": "${workspaceFolder}/build/${variant:variant}/${buildKit}/${buildType}",
+    "cmake.configureSettings": {
+        "BUILD_KIT": "${buildKit}",
+        "CMAKE_MESSAGE_LOG_LEVEL": "STATUS",
+        "BUILD_TYPE": "${buildType}",
+    },
+    "cmake.generator": "Ninja",
+    "cmake.debugConfig": {
+        "MIMode": "gdb",
+        "miDebuggerPath": "gdb",
+        "stopAtEntry": true
+    },
+    "cmake.configureOnEdit": false,
+    "cmake.buildBeforeRun": false,
+    "cmake.options.statusBarVisibility": "compact",
+    "cmake.buildToolArgs": [],
+    "git.ignoreLimitWarning": true,
+    "C_Cpp.errorSquiggles": "enabled",
+    "C_Cpp.default.cStandard": "gnu17",
+    "C_Cpp.default.configurationProvider": "ms-vscode.cmake-tools",
+    "C_Cpp.formatting": "clangFormat",
+    "editor.formatOnSave": true,
+    "files.insertFinalNewline": true,
+    "files.trimTrailingWhitespace": true,
+    "files.associations": {
+        "*.h": "c",
+        "*.c": "c",
+        "Jenkinsfile": "groovy",
+        "*.py": "python",
+        "array": "cpp",
+        "string_view": "cpp",
+        "initializer_list": "cpp",
+        "span": "cpp",
+        "any": "cpp",
+        "atomic": "cpp",
+        "bit": "cpp",
+        "*.tcc": "cpp",
+        "cctype": "cpp",
+        "charconv": "cpp",
+        "chrono": "cpp",
+        "clocale": "cpp",
+        "cmath": "cpp",
+        "compare": "cpp",
+        "concepts": "cpp",
+        "condition_variable": "cpp",
+        "cstdarg": "cpp",
+        "cstddef": "cpp",
+        "cstdint": "cpp",
+        "cstdio": "cpp",
+        "cstdlib": "cpp",
+        "cstring": "cpp",
+        "ctime": "cpp",
+        "cwchar": "cpp",
+        "cwctype": "cpp",
+        "deque": "cpp",
+        "forward_list": "cpp",
+        "list": "cpp",
+        "map": "cpp",
+        "set": "cpp",
+        "string": "cpp",
+        "unordered_map": "cpp",
+        "unordered_set": "cpp",
+        "vector": "cpp",
+        "exception": "cpp",
+        "algorithm": "cpp",
+        "functional": "cpp",
+        "iterator": "cpp",
+        "memory": "cpp",
+        "memory_resource": "cpp",
+        "numeric": "cpp",
+        "optional": "cpp",
+        "random": "cpp",
+        "ratio": "cpp",
+        "system_error": "cpp",
+        "tuple": "cpp",
+        "type_traits": "cpp",
+        "utility": "cpp",
+        "format": "cpp",
+        "fstream": "cpp",
+        "iomanip": "cpp",
+        "iosfwd": "cpp",
+        "iostream": "cpp",
+        "istream": "cpp",
+        "limits": "cpp",
+        "mutex": "cpp",
+        "new": "cpp",
+        "numbers": "cpp",
+        "ostream": "cpp",
+        "semaphore": "cpp",
+        "sstream": "cpp",
+        "stdexcept": "cpp",
+        "stop_token": "cpp",
+        "streambuf": "cpp",
+        "thread": "cpp",
+        "typeinfo": "cpp",
+        "variant": "cpp"
+    },
+    "git.repositoryScanMaxDepth": 3,
+    "git-graph.maxDepthOfRepoSearch": 3,
+    "editor.tabSize": 4,
+}

spl_core-7.3.2/src/spl_core/kickstart/templates/project/.vscode/tasks.json

@@ -0,0 +1,146 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "Get mandatory tools",
+            "detail": "Installation of mandatory tools",
+            "type": "shell",
+            "command": ".\\build.ps1 -install",
+            "problemMatcher": []
+        },
+        {
+            "label": "Environment",
+            "detail": "Print all environment variables for debugging purposes",
+            "type": "shell",
+            "command": "dir env:",
+            "problemMatcher": []
+        },
+        {
+            "label": "Configure variant",
+            "detail": "Feature configuration using KConfig",
+            "type": "shell",
+            "command": ".venv/Scripts/poetry run guiconfig",
+            "options": {
+                "env": {
+                    "KCONFIG_CONFIG": "variants/${input:variant}/config.txt"
+                }
+            },
+            "problemMatcher": []
+        },
+        {
+            "label": "Open variant test report",
+            "detail": "Open the variant's overall test report in your web browser",
+            "command": "${workspaceFolder}/build/${input:variant}/test/Debug/reports/html/index.html",
+            "type": "shell",
+            "presentation": {
+                "reveal": "always"
+            },
+            "group": {
+                "kind": "build",
+                "isDefault": false
+            }
+        },
+        {
+            "label": "Open variant coverage report",
+            "detail": "Open the variant's overall coverage report in your web browser",
+            "command": "${workspaceFolder}/build/${input:variant}/test/Debug/reports/coverage/index.html",
+            "type": "shell",
+            "presentation": {
+                "reveal": "always"
+            },
+            "group": {
+                "kind": "build",
+                "isDefault": false
+            }
+        },
+        {
+            "label": "Open component test report",
+            "detail": "Open the component's test report in your web browser",
+            "command": "${workspaceFolder}/build/${input:variant}/test/Debug/${input:component}/reports/html/index.html",
+            "type": "shell",
+            "presentation": {
+                "reveal": "always"
+            },
+            "group": {
+                "kind": "build",
+                "isDefault": false
+            }
+        },
+        {
+            "label": "Open component coverage report",
+            "detail": "Open the component's coverage report in your web browser",
+            "command": "${workspaceFolder}/build/${input:variant}/test/Debug/${input:component}/reports/coverage/index.html",
+            "type": "shell",
+            "presentation": {
+                "reveal": "always"
+            },
+            "group": {
+                "kind": "build",
+                "isDefault": false
+            }
+        },
+        {
+            "label": "Generate PAYC options file",
+            "detail": "Generate Polyspace-As-You-Code options file for the selected variant",
+            "command": "./build.ps1",
+            "args": [
+                "-command",
+                "sple_static_analysis.exe generate-ps-options-file --project-root-dir ${workspaceFolder} --variant ${input:variant} --build-kit prod --build-type ${input:buildType} --payc --output-folder ./build"
+            ],
+            "type": "shell",
+            "presentation": {
+                "reveal": "always"
+            },
+            "group": {
+                "kind": "build",
+                "isDefault": false
+            }
+        },
+        {
+            "label": "Generate Polyspace BF options file",
+            "detail": "Generate Polyspace Bug Finder options file for the selected variant",
+            "command": "./build.ps1",
+            "args": [
+                "-command",
+                "sple_static_analysis.exe generate-ps-options-file --project-root-dir ${workspaceFolder} --variant ${input:variant} --build-kit prod --build-type Debug --output-folder ./variants/${input:variant}"
+            ],
+            "type": "shell",
+            "presentation": {
+                "reveal": "always"
+            },
+            "group": {
+                "kind": "build",
+                "isDefault": false
+            }
+        }
+    ],
+    "inputs": [
+        {
+            "type": "pickString",
+            "id": "variant",
+            "description": "Which variant do you want to select?",
+            "options": [
+                "EnglishVariant",
+                "GermanVariant"
+            ]
+        },
+        {
+            "type": "pickString",
+            "id": "component",
+            "description": "Which component do you want to select?",
+            "options": [
+                "src/greeter",
+                "src/main"
+            ]
+        },
+        {
+            "type": "pickString",
+            "id": "buildType",
+            "description": "Which build type do you want to use?",
+            "options": [
+                "Debug",
+                "Release"
+            ]
+        }
+    ]
+}

{spl_core-7.3.0rc1 → spl_core-7.3.2}/src/spl_core/kickstart/templates/project/CMakeLists.txt

@@ -10,7 +10,7 @@ include(${CMAKE_SOURCE_DIR}/variants/${VARIANT}/config.cmake)
 if(BUILD_KIT STREQUAL prod)
     project(${VARIANT} C ASM)
 else()
-    # In case of test the project is a C++ project due to GTest usage
+    # C++ project due to GTest usage
     project(${VARIANT} C ASM CXX)
 endif()
 
@@ -24,23 +24,7 @@ if(DEFINED ENV{SPLCORE_PATH})
     message(WARNING "SPLCORE_PATH defined! Use fixed SPL-CORE version from: $ENV{SPLCORE_PATH}")
     include($ENV{SPLCORE_PATH}/spl.cmake)
 else()
-    # Fetch spl-core
-    FetchContent_Declare(
-        spl-core
-        GIT_REPOSITORY https://github.com/avengineers/spl-core.git
-        GIT_TAG develop
-    )
-    FetchContent_MakeAvailable(spl-core)
-
-    # Include spl-core
-    include(${spl-core_SOURCE_DIR}/src/spl_core/spl.cmake)
+    include(".venv/Lib/site-packages/spl_core/spl.cmake")
 endif()
 
 include(${CMAKE_SOURCE_DIR}/variants/${VARIANT}/parts.cmake)
-
-# add all components' include directories to the include paths of each component
-foreach(component_name ${COMPONENT_NAMES})
-    if(TARGET ${component_name})
-        target_include_directories(${component_name} PUBLIC ${target_include_directories__INCLUDES})
-    endif()
-endforeach()

spl_core-7.3.2/src/spl_core/kickstart/templates/project/bootstrap.json

@@ -0,0 +1,5 @@
+{
+    "python_version": "3.11",
+    "python_package_manager": "poetry>=2.0",
+    "scoop_ignore_scoopfile": true
+}

spl_core-7.3.2/src/spl_core/kickstart/templates/project/build.bat

@@ -0,0 +1 @@
+powershell -ExecutionPolicy Bypass -File %~dp0build.ps1 -waitForKey %* || exit /b 1