Separate UDA mapping plugin from libtokamap (include external library)

.clang-tidy

@@ -11,8 +11,8 @@ Checks: "*,
     -cppcoreguidelines-pro-type-reinterpret-cast,
     -altera-struct-pack-align,
     -cppcoreguidelines-pro-bounds-array-to-pointer-decay,
-    -hicpp-no-array-decay
-    -readability-identifier-naming
+    -hicpp-no-array-decay,
+    -readability-identifier-naming,
 "
 CheckOptions:
   misc-non-private-member-variables-in-classes: IgnoreClassesWithAllMemberVariablesBeingPublic

.github/workflows/build.yml

@@ -0,0 +1,61 @@
+name: Build & Test
+
+on:
+  push:
+    branches:
+      - main
+      - develop
+      - "feature/**"
+      - "release/**"
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        # os: [ubuntu-22.04, windows-latest, macos-latest]
+        os: [ubuntu-latest, macos-latest]
+        release: [Debug, Release]
+    runs-on: ${{ matrix.os }}
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/github-script@v7
+        with:
+          script: |
+            core.exportVariable('ACTIONS_CACHE_URL', process.env.ACTIONS_CACHE_URL || '');
+            core.exportVariable('ACTIONS_RUNTIME_TOKEN', process.env.ACTIONS_RUNTIME_TOKEN || '');
+
+      - name: Install linux dependencies
+        if: matrix.os == 'ubuntu-latest'
+        run: sudo apt update && sudo apt install -y libboost-dev
+
+      - name: Install macos dependencies
+        if: matrix.os == 'macos-latest'
+        run: brew update-reset && brew install boost
+
+      # - name: Configure CMake
+      #   run: >
+      #     cmake -G Ninja -B build -DCMAKE_BUILD_TYPE=${{ matrix.release }} -DENABLE_TESTING=ON -DENABLE_EXAMPLES=ON
+
+      # - name: Build
+      #   run: cmake --build build --config ${{ matrix.release }}
+
+      # - name: Install
+      #   if: matrix.os != 'windows-latest'
+      #   run: sudo cmake --install build --config ${{ matrix.release }}
+
+      # # - name: Install
+      # #   if: matrix.os == 'windows-latest'
+      # #   run: cmake --install build --config ${{ matrix.release }}
+
+      # - name: Test
+      #   run: ctest --test-dir build --output-on-failure
+
+      # - name: Examples
+      #   run: ./build/libtokamap/examples/simple_mapper/simple_mapper

.gitignore

@@ -1,42 +1,16 @@
 # Build & Install
-build*/*
-install/*
-
-# Prerequisites
-*.d
-
-# Compiled Object files
-*.slo
-*.lo
-*.o
-*.obj
-
-# Precompiled Headers
-*.gch
-*.pch
-
-# Compiled Dynamic libraries
-*.so
-*.dylib
-*.dll
-
-# Fortran module files
-*.mod
-*.smod
-
-# Compiled Static libraries
-*.lai
-*.la
-*.a
-*.lib
-
-# Executables
-*.exe
-*.out
-*.app
+build*
+install
+cmake-build-*
+Testing
+venv
+.ropeproject
 
 # Machine dependent compile commands
 compile_commands.json
 
 # Compiler cache (clangd)
 .cache
+.clangd
+.idea
+.zed

CMakeLists.txt

@@ -1,96 +1,73 @@
 cmake_minimum_required( VERSION 3.15 )
 
-#
 # Project details
-#
 project(
     JSONMappingPlugin
-    VERSION 0.1.0
+    VERSION 0.2.0.0
     LANGUAGES CXX
 )
 
-#
 # Extra cmake modules to find libraries
-#
-set( CMAKE_MODULE_PATH
-     ${CMAKE_MODULE_PATH}
-     ${CMAKE_SOURCE_DIR}/cmake
-     ${CMAKE_SOURCE_DIR}/cmake/Modules
+list(
+    APPEND CMAKE_MODULE_PATH
+    ${CMAKE_SOURCE_DIR}/cmake
+    ${CMAKE_SOURCE_DIR}/cmake/Modules
 )
 
-find_package( Boost CONFIG )
-find_package( UDA 2.7.0 REQUIRED )
+# Specify C++ standard for all targets
+set( CMAKE_CXX_STANDARD 20 )
+set( CMAKE_CXX_STANDARD_REQUIRED ON )
+set( CMAKE_CXX_EXTENSIONS OFF )
 
-#
-# Set project options
-#
-include( StandardSettings )
-include( StaticAnalyzers )
-include( Utils )
-
-add_clang_format_target()
-
-message( STATUS "CMAKE_MODULE_PATH: ${CMAKE_MODULE_PATH}" )
+# Export compile commands for tools like clang-tidy
+set( CMAKE_EXPORT_COMPILE_COMMANDS ON )
 
-if( NOT CMAKE_BUILD_TYPE )
-  set( CMAKE_BUILD_TYPE "Debug" )
+# Set default build type if not specified
+if( NOT CMAKE_BUILD_TYPE)
+    set( CMAKE_BUILD_TYPE "Debug" )
 endif()
+
 message( STATUS "Started CMake for ${PROJECT_NAME} v${PROJECT_VERSION}...\n" )
 
-#
 # Prevent building in the source directory
-#
-if( PROJECT_SOURCE_DIR STREQUAL PROJECT_BINARY_DIR )
-  message( FATAL_ERROR "In-source builds not allowed.
-    Please make a new directory (called a build directory)
-    and run CMake from there.\n" )
+if (PROJECT_SOURCE_DIR STREQUAL PROJECT_BINARY_DIR )
+    message( FATAL_ERROR "In-source builds not allowed.
+            Please make a new directory (called a build directory)
+            and run CMake from there.\n" )
 endif()
 
-set( CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fPIC -pthread" )
-set( CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fPIC -pthread" )
-
-#
-# Create module
-#
-configure_file(
-    ${CMAKE_SOURCE_DIR}/JSON_mapping_plugin/etc/module.in
-    ${CMAKE_BINARY_DIR}/etc/JSON_mapping_plugin/${PROJECT_VERSION}
-    @ONLY
-)
+# Find dependencies using modern approach
+if( POLICY CMP0167 )
+    cmake_policy( SET CMP0167 NEW )
+endif()
 
-set( MODULE_PATH "modulefiles/JSON_mapping_plugin" CACHE PATH "location to install module files to" )
-set( MODULE_NAME "${PROJECT_VERSION}" CACHE STRING "name of the module file" )
-string( CONFIGURE "${MODULE_PATH}" MODULE_PATH_EXPANDED @ONLY )
+# Set project options
+include( StaticAnalyzers )
+include( Utils )
 
-get_filename_component(
-    MODULE_PATH_EXPANDED ${MODULE_PATH_EXPANDED}
-    REALPATH BASE_DIR "${CMAKE_INSTALL_PREFIX}"
-)
+option( ENABLE_TESTING "Enable unit tests for the project (from the `test` subfolder)." OFF )
+option( ENABLE_PROFILING "Enable profiling for the project." OFF )
+option( FETCH_LIBTOKAMAP "Fetch libtokamap as a dependency." OFF )
 
-install(
-    FILES ${CMAKE_BINARY_DIR}/etc/JSON_mapping_plugin/${PROJECT_VERSION}
-    DESTINATION ${MODULE_PATH_EXPANDED}
-    RENAME ${MODULE_NAME}
-)
+# add_clang_format_target()
 
-# Add JSON_mapping_plugin add_subdirectory
-add_subdirectory( JSON_mapping_plugin )
+if( ENABLE_TESTING )
+    enable_testing()
+endif()
 
-# This list is appended to by the uda_plugin macro
-set( BUILT_PLUGINS "${PLUGINS}" )
-message( STATUS "PLUGINS: ${PLUGINS}" )
+if( FETCH_LIBTOKAMAP )
+    include( FetchContent )
+    FetchContent_Declare(
+        libtokamap
+        GIT_REPOSITORY https://github.com/ukaea/libtokamap.git
+        GIT_TAG develop
+        CMAKE_ARGS -DENABLE_TESTS=OFF -DENABLE_PROFILING=${ENABLE_PROFILING}
+    )
+
+    FetchContent_MakeAvailable( libtokamap )
+else()
+    add_clang_format_target()
+endif()
 
-#
-# Generate scripts
-#
-string( REGEX REPLACE ";" " " PLUGINS "${BUILT_PLUGINS}" )
-configure_file(
-    ${CMAKE_SOURCE_DIR}/scripts/activate-plugins.sh.in
-    ${CMAKE_BINARY_DIR}/scripts/activate-plugins.sh
-    @ONLY
-)
-configure_file(
-    ${CMAKE_SOURCE_DIR}/scripts/remove-plugins.sh.in
-    ${CMAKE_BINARY_DIR}/scripts/remove-plugins.sh
-    @ONLY
-)
+find_package( UDA REQUIRED )
+add_subdirectory( mapping_plugin )