Add options to handle static and static runtime builds.

.github/workflows/ci.yml

@@ -11,6 +11,11 @@ jobs:
  name: Linux
  runs-on: ubuntu-latest
  steps:
+ - name: Install Boost
+ run: |
+ sudo apt-get update -y
+ sudo apt-get install -y libboost-all-dev
+
  - name: Checkout sources
  uses: actions/checkout@v1
 
@@ -19,7 +24,6 @@ jobs:
  cmake -S $GITHUB_WORKSPACE -B $GITHUB_WORKSPACE/build-linux
  -DCMAKE_BUILD_TYPE=Release
  -DBUILD_EXAMPLES=ON
- -DCMAKE_PREFIX_PATH=$BOOST_ROOT_1_72_0
 
  - name: Build
  run: cmake --build $GITHUB_WORKSPACE/build-linux --parallel 3
@@ -33,7 +37,7 @@ jobs:
  name: MacOS
  runs-on: macos-latest
  steps:
- - name: Pre-requisites
+ - name: Install Boost
  run: brew install boost
 
  - name: Checkout sources
@@ -51,21 +55,32 @@ jobs:
  CTEST_OUTPUT_ON_FAILURE: 1
 
  windows:
+ env:
+ BOOST_ROOT: C:\thirdparties\boost-1.72.0
+ BOOST_URL: https://sourceforge.net/projects/boost/files/boost-binaries/1.72.0/boost_1_72_0-msvc-14.2-64.exe/download
+ LIBXML2_ROOT: C:\thirdparties\libxml2-2.9.10
+ LIBXML2_URL: https://github.com/GNOME/libxml2/archive/v2.9.10.zip
  name: Windows
  runs-on: windows-latest
  steps:
- - name: Pre-requisites
+ - name: Install LibXml2
  shell: cmd
  run: |
  call "C:\Program Files (x86)\Microsoft Visual Studio\2019\Enterprise\VC\Auxiliary\Build\vcvars64.bat"
  choco install wget --no-progress
- wget -nv https://github.com/GNOME/libxml2/archive/v2.9.10.zip
+ wget -nv %LIBXML2_URL%
  7z x v2.9.10.zip
  cd libxml2-2.9.10/win32
- cscript configure.js compiler=msvc prefix=C:\thirdparties\libxml2-2.9.10 iconv=no
+ cscript configure.js compiler=msvc prefix=%LIBXML2_ROOT% iconv=no
  nmake -f Makefile.msvc
  nmake -f Makefile.msvc install
 
+ - name: Install Boost
+ shell: cmd
+ run: |
+ wget -nv -O boost-installer.exe %BOOST_URL%
+ boost-installer.exe /dir=%BOOST_ROOT% /sp- /verysilent /suppressmsgboxes /norestart
+
  - name: Checkout sources
  uses: actions/checkout@v1
 
@@ -74,7 +89,6 @@ jobs:
  run: >
  cmake -S %GITHUB_WORKSPACE% -B %GITHUB_WORKSPACE%\build-windows
  -DBUILD_EXAMPLES=ON
- -DCMAKE_PREFIX_PATH=%BOOST_ROOT_1_72_0%;C:\thirdparties\libxml2-2.9.10
 
  - name: Build
  shell: cmd
@@ -85,7 +99,7 @@ jobs:
  - name: Tests
  shell: cmd
  run: |
- set PATH=%PATH%;C:\thirdparties\libxml2-2.9.10\bin;%BOOST_ROOT_1_72_0%\lib;%GITHUB_WORKSPACE%\build-windows\src\Release;%GITHUB_WORKSPACE%\build-windows\src\test\Release
+ set PATH=%PATH%;%LIBXML2_ROOT%\bin;%BOOST_ROOT%\lib64-msvc-14.2;%GITHUB_WORKSPACE%\build-windows\src\Release;%GITHUB_WORKSPACE%\build-windows\src\test\Release
  cmake --build %GITHUB_WORKSPACE%\build-windows --target RUN_TESTS --config Release --verbose
  env:
  CTEST_OUTPUT_ON_FAILURE: 1
@@ -118,6 +132,11 @@ jobs:
  env:
  SONAR_SCANNER_VERSION: 3.3.0.1492
 
+ - name: Install Boost
+ run: |
+ sudo apt-get update -y
+ sudo apt-get install -y libboost-all-dev
+
  - name: Checkout sources
  uses: actions/checkout@v1
 
@@ -127,7 +146,6 @@ jobs:
  -DCMAKE_BUILD_TYPE=Debug
  -DCODE_COVERAGE=TRUE
  -DBUILD_EXAMPLES=ON
- -DCMAKE_PREFIX_PATH=$BOOST_ROOT_1_72_0
 
  - name: Build
  run: >

.github/workflows/clang-tidy.yml

@@ -9,6 +9,11 @@ jobs:
  name: clang-tidy
  runs-on: ubuntu-latest
  steps:
+ - name: Install Boost
+ run: |
+ sudo apt-get update -y
+ sudo apt-get install -y libboost-all-dev
+
  - name: Install clang-tidy
  run: |
  sudo apt-get install -y clang-tidy-9
@@ -22,6 +27,7 @@ jobs:
  cmake -S $GITHUB_WORKSPACE -B $GITHUB_WORKSPACE/build
  -DCMAKE_BUILD_TYPE=Debug
  -DCMAKE_PREFIX_PATH=$BOOST_ROOT_1_72_0
+ -DBUILD_EXAMPLES=ON
  -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
 
  - name: Clang Tidy

CMakeLists.txt

@@ -4,12 +4,19 @@
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
 #
-cmake_minimum_required(VERSION 3.12 FATAL_ERROR)
+cmake_minimum_required(VERSION 3.15 FATAL_ERROR)
+
+if (${CMAKE_VERSION} VERSION_GREATER "3.15.0")
+ # Policy to activate a way to choose MSVC runtime. https://cmake.org/cmake/help/v3.15/policy/CMP0091.html
+ if (POLICY CMP0091)
+ cmake_policy(SET CMP0091 NEW)
+ endif ()
+endif ()
 
 project(powsybl-iidm4cpp)
 
 set(IIDM_VERSION_MAJOR 1)
-set(IIDM_VERSION_MINOR 3)
+set(IIDM_VERSION_MINOR 4)
 set(IIDM_VERSION_PATCH 0)
 set(IIDM_VERSION ${IIDM_VERSION_MAJOR}.${IIDM_VERSION_MINOR}.${IIDM_VERSION_PATCH})
 set(IIDM_SOVERSION ${IIDM_VERSION_MAJOR})
@@ -22,27 +29,54 @@ set(INSTALL_DOC_DIR share CACHE PATH "Installation directory for doxygen files")
 
 option(BUILD_DOXYGEN "Enable/Disable the generation of the Doxygen." OFF)
 option(BUILD_EXAMPLES "Enable/Disable the compilation of the examples." OFF)
+option(BUILD_TESTS "Enable/Disable the compilation of unit tests." ON)
+option(BUILD_TOOLS "Enable/Disable the compilation of tools." ON)
+option(BUILD_SHARED_LIBS "Enable/disable build of shared libraries." ON)
+option(BUILD_STATIC_LIBS "Enable/disable build of static libraries." ON)
+option(BOOST_STATIC_LIBS "Use static version of boost libraries." OFF)
+option(MSVC_STATIC_RUNTIME_LIBRARY "Enable/disable static runtime on Windows." OFF)
+
+# Handle options compatibility
+if (BOOST_STATIC_LIBS AND BUILD_SHARED_LIBS)
+ message(FATAL_ERROR "BOOST_STATIC_LIBS and BUILD_SHARED_LIBS are ON and should not be used together.
+ BOOST_STATIC_LIBS should only be used with BUILD_STATIC_LIBS=ON and BUILD_SHARED_LIBS=OFF.")
+endif ()
+
+if (BUILD_STATIC_LIBS AND NOT BUILD_SHARED_LIBS)
+ set(TARGET_POSTFIX "-static")
+endif ()
 
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
 
-if (${CMAKE_VERSION} VERSION_LESS "3.1.0")
- set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} --std=c++11")
-else ()
- set(CMAKE_CXX_STANDARD 11)
- set(CMAKE_CXX_STANDARD_REQUIRED TRUE)
-endif ()
+set(CMAKE_CXX_STANDARD 11)
+set(CMAKE_CXX_STANDARD_REQUIRED TRUE)
 
 if ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU" OR "${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang")
  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra -Werror -pedantic -Wswitch-enum")
  # set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -D_GLIBCXX_DEBUG")
  # set(CMAKE_CXX_FLAGS_RELWITHDEBINFO "${CMAKE_CXX_FLAGS_RELWITHDEBINFO} -D_GLIBCXX_DEBUG")
 elseif (MSVC)
  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /wd4244 /wd4250 /wd4251 /wd4267 /wd4275")
+ if (NOT BUILD_SHARED_LIBS AND BUILD_STATIC_LIBS)
+ if (MSVC_STATIC_RUNTIME_LIBRARY)
+ set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")
+ endif ()
+ else()
+ if (MSVC_STATIC_RUNTIME_LIBRARY)
+ message(WARNING "MSVC_STATIC_RUNTIME_LIBRARY should be used with BUILD_SHARED_LIBS=OFF and BUILD_STATIC_LIBS=ON.")
+ endif ()
+ endif ()
 endif ()
 
-set(Boost_USE_STATIC_LIBS OFF)
-find_package(Boost 1.65 REQUIRED COMPONENTS date_time filesystem program_options system unit_test_framework)
+set(Boost_USE_STATIC_LIBS ${BOOST_STATIC_LIBS})
+set(Boost_USE_STATIC_RUNTIME ${MSVC_STATIC_RUNTIME_LIBRARY})
+if (BUILD_TESTS)
+ find_package(Boost 1.65 REQUIRED COMPONENTS date_time filesystem program_options system unit_test_framework)
+else ()
+ find_package(Boost 1.65 REQUIRED COMPONENTS date_time filesystem program_options system)
+endif()
 find_package(LibXml2 REQUIRED)
+find_package(Threads REQUIRED)
 
 if (WIN32)
  # On windows, also force prefix to avoid conflict between import file (for shared compilation) and static file
@@ -55,6 +89,9 @@ enable_testing()
 
 set(CODE_COVERAGE FALSE CACHE BOOL "Enable code coverage")
 if (CODE_COVERAGE)
+ # if code-coverage is ON, force tests build
+ set(BUILD_TESTS ON)
+
  include(CodeCoverage)
  code_coverage(NAME code-coverage
  OUTPUT_DIR coverage
@@ -67,9 +104,16 @@ if (BUILD_DOXYGEN)
 endif ()
 
 add_subdirectory(src)
-add_subdirectory(test)
 add_subdirectory(extensions)
-add_subdirectory(tools)
+
+if (BUILD_TOOLS)
+ add_subdirectory(tools)
+endif ()
+
+if (BUILD_TESTS)
+ add_subdirectory(test)
+endif ()
+
 if (BUILD_EXAMPLES)
  add_subdirectory(examples)
 endif ()

README.md

@@ -18,6 +18,7 @@
 - [Build from sources](#build-from-sources)
  - [Build the examples](#build-the-examples)
  - [Generate the documentation](#generate-the-documentation)
+ - [Disable unit tests generation](#disable-tests-generation)
 - [Link with powsybl-iidm4cpp](#link-with-powsybl-iidm4cpp)
 - [Contributing](#contributing)
 
@@ -33,7 +34,7 @@ To build powsybl-iidm4cpp, you need:
 ### Ubuntu 20.04
 ```
 $> apt install -y cmake g++ git libboost-all-dev libxml2-dev make
-``` 
+```
 
 ### Ubuntu 18.04
 ```
@@ -145,11 +146,17 @@ $> cmake .. -DCMAKE_INSTALL_PREFIX=<PREFIX> -DCMAKE_BUILD_TYPE=<BUILD_TYPE>
 **Available options:**
 - BUILD_DOXYGEN: Generate the API documentation using doxygen (Default is **OFF**)
 - BUILD_EXAMPLES: Build the examples (Default is **OFF**)
+- BUILD_TESTS: Generate unit tests (Default is **ON**)
+- BUILD_TOOLS: Build the tools (Default is **ON**)
+- BUILD_SHARED_LIBS: Build shared version of the library (Default is **ON**)
+- BUILD_STATIC_LIBS: Build static version of library (Default is **ON**)
+- BOOST_STATIC_LIBS: Use static version of Boost libraries (Default is **OFF**)
+- MSVC_STATIC_RUNTIME_LIBRARY: Use MSVC static runtime (Default is **OFF**)
 
 **Note:** If you want to use custom version of **Boost** or **LibXML**, you would have to help `cmake` to find the required packages, using the `-DCMAKE_PREFIX_PATH` options:
 ```
 $> cmake .. -DCMAKE_INSTALL_PREFIX=<PREFIX> -DCMAKE_PREFIX_PATH=<BOOST_PREFIX>;<LIBXML2_PREFIX>
-``` 
+```
 
 3. Build the sources
 ```
@@ -172,9 +179,9 @@ To build the examples, you have to pass the `-DBUILD_EXAMPLES=ON` flag to the co
 ```
 $> cmake .. -DCMAKE_INSTALL_PREFIX=<PREFIX> -DCMAKE_BUILD_TYPE=<BUILD_TYPE> -DBUILD_EXAMPLES=ON
 $> cmake --build .
-``` 
+```
 
-Click [here](examples/README.md) to see the list of available examples. 
+Click [here](examples/README.md) to see the list of available examples.
 
 ### Generate the documentation
 This project uses [doxygen](http://www.doxygen.nl/) to generate code documentation. To generate the API documentation using doxygen, add `-DBUILD_DOXYGEN=ON` flag to the configure command line. This will create a new `doxygen` target.
@@ -184,20 +191,28 @@ $> cmake --build . --target doxygen
 ```
 The HTML documentation is available in `<BUILD_DIR>/doc/html/index.html`.
 
+### Disable unit tests generation
+Unit tests generation may be disabled to increase compilation time. When disabled, `Boost::unit_test_framework` is not necessary to build successfully.
+To disable tests generation, add `-DBUILD_TESTS=OFF` flag to the configure command line.
+```
+$> cmake .. -DCMAKE_INSTALL_PREFIX=<PREFIX> -DCMAKE_BUILD_TYPE=<BUILD_TYPE> -DBUILD_TESTS=OFF
+$> cmake --build .
+```
+
 ## Link with powsybl-iidm4cpp
 We provide cmake script files that make it easy to use `powsybl-iidm4cpp` in a CMake project, that are installed in the `<PREFIX>/LibIIDM/cmake` folder.
 
 To use the library in your project, add the `find_package` instruction to your `CMakeLists.txt` file:
 ```
 find_package(LibIIDM REQUIRED)
-``` 
+```
 
 Then configure your project passing the `-DCMAKE_PREFIX_PATH=<IIDM4CPP_PREFIX>` option to the cmake command:
 ```
 $> cmake ... -DCMAKE_PREFIX_PATH=<IIDM4CPP_PREFIX>
 ```
 
-A complete example is available [here](examples/example2). 
+A complete example is available [here](examples/example2).
 
 ## Contributing
 
@@ -215,4 +230,4 @@ $> cmake --build .
 $> cmake --build . --target test
 $> cmake --build . --target code-coverage
 ```
-The HTML report is available in `<BUILD_DIR>/coverage/index.html`. 
+The HTML report is available in `<BUILD_DIR>/coverage/index.html`.

examples/CMakeLists.txt

@@ -6,3 +6,6 @@
 #
 
 add_subdirectory(example1)
+if (BUILD_STATIC_LIBS)
+ add_subdirectory(example3)
+endif ()

examples/README.md

@@ -3,5 +3,6 @@
 ## Basic examples
 - [Example 1](example1/README.md): Read and write an XIIDM file
 - [Example 2](example2/README.md): Use iidm4cpp in a CMake project
+- [Example 3](example3/README.md): Use XIIDM extensions
 
 ## Advanced examples

examples/example1/CMakeLists.txt

@@ -6,4 +6,4 @@
 #
 
 add_executable(example1 example1.cpp)
-target_link_libraries(example1 PRIVATE iidm)
+target_link_libraries(example1 PRIVATE iidm${TARGET_POSTFIX})

examples/example1/example1.cpp

@@ -27,11 +27,9 @@ int main(int argc, char** argv) {
  try {
  xmlInitParser();
 
- std::ifstream inputStream(argv[1]);
- powsybl::iidm::Network network = powsybl::iidm::Network::readXml(inputStream);
+ powsybl::iidm::Network network = powsybl::iidm::Network::readXml(argv[1]);
 
- std::ofstream outputStream(argv[2]);
- powsybl::iidm::Network::writeXml(outputStream, network);
+ powsybl::iidm::Network::writeXml(argv[2], network);
 
  xmlCleanupParser();
 

examples/example2/CMakeLists.txt

@@ -11,7 +11,7 @@ cmake_minimum_required(VERSION 3.12 FATAL_ERROR)
 project(my-project)
 
 # Find the required dependencies: Boost, LibXML2 and IIDM and import the targets
-find_package(Boost 1.56 REQUIRED COMPONENTS date_time filesystem program_options system unit_test_framework)
+find_package(Boost 1.65 REQUIRED COMPONENTS date_time filesystem program_options system unit_test_framework)
 find_package(LibXml2 REQUIRED)
 find_package(LibIIDM REQUIRED)
 

examples/example2/README.md

@@ -60,7 +60,7 @@ cmake_minimum_required(VERSION 3.12 FATAL_ERROR)
 project(my-project)
 
 # Find the required dependencies: Boost, LibXML2 and IIDM and import the targets
-find_package(Boost 1.56 REQUIRED COMPONENTS date_time filesystem program_options system unit_test_framework)
+find_package(Boost 1.65 REQUIRED COMPONENTS date_time filesystem program_options system unit_test_framework)
 find_package(LibXml2 REQUIRED)
 find_package(LibIIDM REQUIRED)
 

examples/example3/CMakeLists.txt

@@ -0,0 +1,9 @@
+#
+# Copyright (c) 2021, RTE (http://www.rte-france.com)
+# 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 http://mozilla.org/MPL/2.0/.
+#
+
+add_executable(example3 example3.cpp)
+target_link_libraries(example3 PRIVATE iidm-static ext-iidm-static)