All changes for v1.1.1

Author: gki63fr

.clang-format

@@ -53,6 +53,15 @@ DerivePointerAlignment: false
 DisableFormat:   false
 FixNamespaceComments: true
 IncludeBlocks: Regroup
+IncludeCategories:
+  - Regex: '^".*'
+    Priority: 1
+  - Regex: '^<(a_util|rpc|ddl|ddl_capi)/'
+    Priority: 2
+  - Regex: '^<(3rdparty|gtest|pugixml.*|httplib|helper|jsonrpccpp|client|server)/'
+    Priority: 3
+  - Regex: '^<.*'
+    Priority: 4
 IndentCaseLabels: false # conforming to CppCoreGuidelines examples
 IndentGotoLabels: true
 IndentPPDirectives: None

.gitattributes

@@ -1,3 +1,15 @@
+# Copyright @ 2021 VW Group. All rights reserved.
+#
+#     This Source Code Form is subject to the terms of the Mozilla
+#     Public License, v. 2.0. If a copy of the MPL was not distributed
+#     with this file, You can obtain one at https://mozilla.org/MPL/2.0/.
+#
+# If it is not possible or desirable to put the notice in a particular file, then
+# You may include the notice in a location (such as a LICENSE file in a
+# relevant directory) where a recipient would be likely to look for such a notice.
+#
+# You may add additional accurate notices of copyright ownership.
+
 * text=auto
 * whitespace=space-before-tab,tab-in-indent,trailing-space
 

.gitignore

@@ -1,2 +1,17 @@
+# Copyright @ 2021 VW Group. All rights reserved.
+#
+#     This Source Code Form is subject to the terms of the Mozilla
+#     Public License, v. 2.0. If a copy of the MPL was not distributed
+#     with this file, You can obtain one at https://mozilla.org/MPL/2.0/.
+#
+# If it is not possible or desirable to put the notice in a particular file, then
+# You may include the notice in a location (such as a LICENSE file in a
+# relevant directory) where a recipient would be likely to look for such a notice.
+#
+# You may add additional accurate notices of copyright ownership.
+
+.vs
+.vscode
 .project
 .pydevproject
+build

CMakeLists.txt

@@ -13,13 +13,19 @@
 ################################ Options and general project setup ################################
 cmake_minimum_required(VERSION 3.17.0) # cxx_std_11
 
+cmake_policy(SET CMP0048 NEW)
+
 # Start project() now, since any include checks will use the correct compiler flags
-project(dev_essential VERSION 1.0.0)
+file(STRINGS version VERSION LIMIT_COUNT 1)
+project(dev_essential VERSION ${VERSION})
 
 # Disable extensions here and require the chosen CMAKE_CXX_STANDARD
 set(CMAKE_CXX_EXTENSIONS OFF)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
-set(CMAKE_CXX_STANDARD 14)
+# minimum is currently C++14, but default is C++17
+if (NOT DEFINED CMAKE_CXX_STANDARD)
+    set(CMAKE_CXX_STANDARD 17)
+endif()
 
 # if Conan is used, we have to include the generated file and doing some basic setup
 if(CONAN_COMPILER)
@@ -40,7 +46,6 @@ if(CONAN_COMPILER)
         else()
             conan_basic_setup(TARGETS NO_OUTPUT_DIRS)
         endif()
-    set(gtest_search_mode CONFIG)
 endif(CONAN_COMPILER)
 
 set(dev_essential_cmake_include_components "." CACHE STRING "List of components to build, separated\
@@ -58,6 +63,9 @@ include(scripts/cmake/enable_multicore_compilation.cmake)
 # Use integrated debug symbols on Windows (avoiding PDBs)
 include(scripts/cmake/use_integrated_debug_symbols.cmake)
 
+# set default symbol visibility for compilers supporting it
+include(scripts/cmake/set_symbol_visibilty.cmake)
+
 if("${dev_essential_cmake_include_components}" STREQUAL ".")
     add_subdirectory(extern/3rdparty/clara)
 endif()
@@ -87,6 +95,7 @@ if(dev_essential_cmake_enable_integrated_tests)
         include(scripts/cmake/stub_generation.cmake)
         add_subdirectory(test/function)
     endif (NOT GTest_FOUND)
+    add_subdirectory(test/sca)
 endif(dev_essential_cmake_enable_integrated_tests)
 
 # License Information must be delivered anyway!

README.md

@@ -1,14 +1,14 @@
 <!---
 Copyright @ 2021 VW Group. All rights reserved.
- 
+
      This Source Code Form is subject to the terms of the Mozilla
      Public License, v. 2.0. If a copy of the MPL was not distributed
      with this file, You can obtain one at https://mozilla.org/MPL/2.0/.
- 
+
 If it is not possible or desirable to put the notice in a particular file, then
 You may include the notice in a location (such as a LICENSE file in a
 relevant directory) where a recipient would be likely to look for such a notice.
- 
+
 You may add additional accurate notices of copyright ownership.
 -->
 # Dev essential
@@ -19,6 +19,7 @@ The dev_essential project is the successor of the following projects:
 * Utility library aka [a_util](a_util.md)
 * Package Remote Procedure Call aka [pkg_rpc](rpc.md)
 * Data Definition Language Library aka [ddl](ddl.md)
+* DDL C Application Programming Interface aka [ddl_capi](ddl_capi.md)
 * ...
 
 The dev_essential project strives for backwards compatibility with the latest versions of these
@@ -29,6 +30,7 @@ projects. The following table provides an overview of the versions and the compa
 | a_util v5.8.x | dev_essential 1.0.0 |
 | pkg_rpc 3.5.x | dev_essential 1.0.0 |
 | ddl 4.6.x     | dev_essential 1.0.0 |
+| ddl_capi      | dev_essential 1.1.0 |
 
 However, for downstream projects already using one of the aforementioned projects and porting to the
 dev_essential project, the [portation guide](#portation-guide) shall be consulted.
@@ -57,12 +59,19 @@ Table of contents:
 **dev_essential_cmake_enable_integrated_tests (default: OFF)**
 * Enable tests as integrated build - requires googletest
 
+**dev_essential_cmake_enable_self_contained_header_tests (default: ON)**
+* Whether or not to enable tests checking for self contained header files
+* Requires `dev_essential_cmake_enable_integrated_tests=ON`
+
 **dev_essential_cmake_enable_position_independent_code (Default: ON)**
 * Enable position independent code for static libraries
 
 **dev_essential_cmake_enable_result_header_only (default: OFF)**
 * Whether or not to build header only version of dev_essential_result library
 
+**dev_essential_cmake_enable_visibility_hidden (default: ON)**
+* If ON, set visibility of target symbols to hidden, otherwise use the default visibility
+
 **dev_essential_cmake_enable_warn_on_default_cmake_install_prefix (Default: ON)**
 * Warn if `CMAKE_INSTALL_PREFIX` is set to default
 
@@ -197,16 +206,14 @@ The changelog can be found [here](doc/extern/changelog.md).
 ## License Information <a name="license-information"></a>
 ### Dev essential libraries - License
 The dev essential libraries are delivered under the
-[MPL - Mozilla Public License - Version 2.0](LICENSE).
+[MPL - Mozilla Public License - Version 2.0](doc/extern/license/MPL2.0.txt).
 
 ### Used software license information
 The dev essential libraries are delivered with the following 3rdparty dependencies:
 - [Clara 1.1.2](https://github.com/catchorg/Clara/tree/v1.1.2)
   ([License](extern/3rdparty/clara/Clara-1.1.2/LICENSE.txt))
 - [current_function of Boost 1.64.0](http://www.boost.org/doc/libs/1_64_0/boost/current_function.hpp)
   ([License](extern/3rdparty/boost/boost_1_64_0/boost/current_function.hpp))
-- [PCRE 8.39](https://sourceforge.net/projects/pcre/files/pcre/8.39/)
-  ([License](extern/3rdparty/pcre/pcre-8.39/LICENCE))
 - [pugixml 1.8](https://github.com/zeux/pugixml/tree/v1.8)
   ([License](extern/3rdparty/pugixml/pugixml-1.8/readme.txt))
 - [uuid 1.6.2](http://www.ossp.org/pkg/lib/uuid/)

a_util.md

@@ -1,14 +1,14 @@
 <!---
 Copyright @ 2021 VW Group. All rights reserved.
- 
+
      This Source Code Form is subject to the terms of the Mozilla
      Public License, v. 2.0. If a copy of the MPL was not distributed
      with this file, You can obtain one at https://mozilla.org/MPL/2.0/.
- 
+
 If it is not possible or desirable to put the notice in a particular file, then
 You may include the notice in a location (such as a LICENSE file in a
 relevant directory) where a recipient would be likely to look for such a notice.
- 
+
 You may add additional accurate notices of copyright ownership.
 -->
 

ddl.md

@@ -1,14 +1,14 @@
 <!---
 Copyright @ 2021 VW Group. All rights reserved.
- 
+
      This Source Code Form is subject to the terms of the Mozilla
      Public License, v. 2.0. If a copy of the MPL was not distributed
      with this file, You can obtain one at https://mozilla.org/MPL/2.0/.
- 
+
 If it is not possible or desirable to put the notice in a particular file, then
 You may include the notice in a location (such as a LICENSE file in a
 relevant directory) where a recipient would be likely to look for such a notice.
- 
+
 You may add additional accurate notices of copyright ownership.
 -->
 
@@ -52,16 +52,6 @@ Access, decode and encode ddl described memory data.
         ddl/codec/pkg_codec.h
 
 
-## DDL-2-header and header-2-DDL generation
-
-Generating a c-header file from DDL and vice versa.
-
-* See [DDL Generators](doc/extern/ddl/ddl_generators.md)
-
-        ddl/ddlgenerators/generatorlibrary
-        ddl/ddlgenerators/ddl2header
-        ddl/ddlgenerators/header2ddl
-
 ## Mapping Functionality
 
 Map data from one DDL structure to another

ddl_capi.md

@@ -0,0 +1,17 @@
+<!---
+Copyright @ 2021 VW Group. All rights reserved.
+
+    This Source Code Form is subject to the terms of the Mozilla
+    Public License, v. 2.0. If a copy of the MPL was not distributed
+    with this file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular file, then
+You may include the notice in a location (such as a LICENSE file in a
+relevant directory) where a recipient would be likely to look for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+-->
+
+# FEP Interface C DLL
+
+TODO: To be filled with information.

doc/CMakeLists.txt

@@ -12,4 +12,17 @@
 
 ##installation of documentation related files
 install(FILES extern/changelog.md DESTINATION doc)
-install(FILES LICENSE DESTINATION ${CMAKE_INSTALL_PREFIX})
+install(FILES extern/license/MPL2.0.txt DESTINATION ${CMAKE_INSTALL_PREFIX})
+install(DIRECTORY extern/license DESTINATION doc)
+
+# check for valid version string
+string(REGEX MATCH "^[0-9]+\.[0-9]+\.[0-9]+$" VER ${VERSION})
+if(NOT VER)
+    message(FATAL_ERROR "${VERSION} is not a valid semver espression for version")
+endif()
+
+# check for valid entry in doxyfile
+file(STRINGS extern/Doxyfile RES REGEX "^PROJECT_NUMBER += v${VER}$")
+if(NOT RES)
+    message(FATAL_ERROR "Doxyfile does not contain the current version ${VER}")
+endif()

doc/extern/Doxyfile

@@ -17,7 +17,7 @@
 # Project related configuration options
 #---------------------------------------------------------------------------
 PROJECT_NAME           = dev_essential
-PROJECT_NUMBER         = v1.0.0
+PROJECT_NUMBER         = v1.1.1
 PROJECT_BRIEF          = "Documentation for essential C++ libraries and interfaces"
 OUTPUT_DIRECTORY       =
 STRIP_FROM_PATH        = include/
@@ -48,7 +48,7 @@ WARN_AS_ERROR          = YES
 #---------------------------------------------------------------------------
 # Configuration options related to the input files
 #---------------------------------------------------------------------------
-INPUT                  = include doc/extern README.md a_util.md rpc.md ddl.md
+INPUT                  = include doc/extern README.md a_util.md rpc.md ddl.md ddl_capi.md
 FILE_PATTERNS          = *.h *.md *.dox
 RECURSIVE              = YES
 EXCLUDE_PATTERNS       = *_impl.h