Basic build system, unit-testing, and Doxygen documentation.

.gitignore

@@ -0,0 +1,174 @@
+### Emacs template
+# -*- mode: gitignore; -*-
+*~
+\#*\#
+/.emacs.desktop
+/.emacs.desktop.lock
+*.elc
+auto-save-list
+tramp
+.\#*
+
+# Org-mode
+.org-id-locations
+*_archive
+
+# Flymake-mode
+*_flymake.*
+
+# Eshell files
+/eshell/history
+/eshell/lastdir
+
+# ELPA packages
+/elpa/
+
+# Reftex files
+*.rel
+
+# AUCTeX auto folder
+/auto/
+
+# Cask packages
+.cask/
+dist/
+
+# Flycheck
+flycheck_*.el
+
+# Server auth directory
+/server/
+
+# Projectiles files
+.projectile
+
+# Directory configuration
+.dir-locals.el
+
+# Network security
+/network-security.data
+
+
+### Visual Studio Code template
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+*.code-workspace
+
+# Local History for Visual Studio Code
+.history/
+
+### C++ template
+# 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
+
+### Fortran template
+# Prerequisites
+
+# Compiled Object files
+
+# Precompiled Headers
+
+# Compiled Dynamic libraries
+
+# Fortran module files
+
+# Compiled Static libraries
+
+# Executables
+
+### JetBrains template
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/
+
+# CMake
+cmake-build-*/
+
+# File-based project format
+*.iws
+
+# IntelliJ IDEA
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+### Vim template
+# Swap
+[._]*.s[a-v][a-z]
+!*.svg  # Comment out if you don't need vector files
+[._]*.sw[a-p]
+[._]s[a-rt-v][a-z]
+[._]ss[a-gi-z]
+[._]sw[a-p]
+
+# Session
+Session.vim
+Sessionx.vim
+
+# Temporary
+.netrwhist
+# Auto-generated tag files
+tags
+# Persistent undo
+[._]*.un~
+
+### CMake template
+CMakeLists.txt.user
+CMakeCache.txt
+CMakeFiles
+CMakeScripts
+Testing
+Makefile
+cmake_install.cmake
+install_manifest.txt
+compile_commands.json
+CTestTestfile.cmake
+_deps
+
+### Build directory
+build/

CHANGELOG.md

@@ -8,4 +8,4 @@
 
 ### Commits to master ###
 
-DD/MM/YYYY PR #NNN: 
+30/11/2021 PR #1: Add basic build system, unit-testing, and Doxygen documentation.

CMakeLists.txt

@@ -0,0 +1,65 @@
+# Set the minimum version of CMake required by the build system.
+cmake_minimum_required(VERSION 3.13 FATAL_ERROR)
+
+# Include file containing in-source build prevention.
+include(cmake/PreventInSourceBuilds.cmake)
+
+# Set project name and the languages required to build the project and a
+# project description.
+project(profiler LANGUAGES CXX
+        DESCRIPTION "Met Office profiler")
+
+# Set project versioning.
+# TODO - Issue #12 Move versioning to the project settings above.
+set(SOVERSION 0)
+set(VERSION 0.1.0)
+
+# Include general project setting files.
+include(cmake/StandardProjectSettings.cmake)
+include(cmake/CompilerWarnings.cmake)
+include(cmake/Doxygen.cmake)
+enable_doxygen()
+
+# Trick to make it easier to add warnings and options to libs/executables.
+add_library(project_options INTERFACE)
+add_library(project_warnings INTERFACE)
+set_project_warnings(project_warnings)
+
+# Defines some standard install directories such as $(prefix)/include.
+include(GNUInstallDirs)
+
+# Add src directory to build.
+add_subdirectory(src)
+
+# Include the testing setup.
+include(cmake/TestingSetup.cmake)
+
+# All below is for installation and creation of *.cmake files for use with the
+# find_package cmake function.
+# TODO - Issue #13 Move installation functionality to file in cmake directory.
+install(
+    EXPORT "${CMAKE_PROJECT_NAME}Targets"
+    DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/${CMAKE_PROJECT_NAME}
+    NAMESPACE   ${CMAKE_PROJECT_NAME}::
+    FILE       "${CMAKE_PROJECT_NAME}Targets.cmake"
+    )
+
+include(CMakePackageConfigHelpers)
+configure_package_config_file(
+    "${CMAKE_PROJECT_NAME}Config.cmake.in"
+    "${CMAKE_PROJECT_NAME}Config.cmake"
+    INSTALL_DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/${CMAKE_PROJECT_NAME}"
+    PATH_VARS CMAKE_INSTALL_LIBDIR 
+    )
+
+write_basic_package_version_file(
+        "${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_PROJECT_NAME}ConfigVersion.cmake"
+        VERSION ${VERSION}
+        COMPATIBILITY SameMajorVersion
+)
+
+install(
+    FILES "${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_PROJECT_NAME}Config.cmake"
+          "${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_PROJECT_NAME}ConfigVersion.cmake"
+    DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/${CMAKE_PROJECT_NAME}"
+    )

README.md

@@ -1,2 +1,31 @@
 # profiler
+
 Profiler for scientific code on HPC platforms.
+
+### Requirements
+
+- C++17 compatible compiler.
+- CMake version 3.13 or newer.
+- GoogleTest version 1.11 or newer.
+
+### Supported Compilers
+
+The code has been tested with the following compilers:
+- GCC versions: 9.2.0, 10.2.0.
+
+### Testing Framework and Documentation
+
+The testing framework is GoogleTest (1.11.0).  
+Source code documentation is generated using Doxygen (minimum 1.8.5).
+
+### Building profiler
+
+**To build:**  
+In project root directory:
+~~~~~~~~~~~~~~~~shell
+mkdir build
+cd build
+cmake ..
+make
+make test
+~~~~~~~~~~~~~~~~

cmake/CompilerWarnings.cmake

@@ -0,0 +1,90 @@
+# Contains a function for setting up the appropriate warnings for
+# different compilers and build settings.
+function(set_project_warnings project_name)
+    # Create option for forcing errors for all warnings.
+    option(WARNINGS_AS_ERRORS "Treat compiler warnings as errors" OFF)
+
+    # Create option to turn on sanitizers.
+    option(USE_SANITIZERS "Turn on sanitizers to help reporting of runtime errors" OFF)
+
+    set(CLANG_WARNINGS
+            # All warnings (actually not all warnings obviously)
+            -Wall
+            # More warnings (should be used on non-legacy code)
+            -Wextra
+            # Warn the user if a variable declaration shadows one from a parent context
+            -Wshadow
+            # Warn the user if a class with virtual functions has a non-virtual destructor.
+            # This helps catch hard to track down memory errors
+            -Wnon-virtual-dtor
+            # Warn for C-style casts
+            -Wold-style-cast
+            # Warn for potential performance problem casts
+            -Wcast-align
+            # Warn on anything being unused
+            -Wunused
+            # Warn if you overload (not override) a virtual function
+            -Woverloaded-virtual
+            # Warn if non-standard C++ is used
+            -Wpedantic
+            # Warn on type conversions that may lose data
+            -Wconversion
+            # Warn on sign conversions
+            -Wsign-conversion
+            # Warn if a null dereference is detected
+            -Wnull-dereference
+            # Warn if float is implicit promoted to double
+            -Wdouble-promotion
+            # Warn on security issues around functions that format output (i.e. 'printf')
+            -Wformat=2
+            )
+
+    # Set warnings as errors if requested (recommended during development/debug)
+    if (WARNINGS_AS_ERRORS)
+        set(CLANG_WARNINGS ${CLANG_WARNINGS} -Werror)
+    endif ()
+
+    set(GCC_WARNINGS
+            # Include all Clang compiler warnings (uses same flags as g++)
+            ${CLANG_WARNINGS}
+            # Warn if indentation implies blocks where blocks do not exist
+            -Wmisleading-indentation
+            # Warn if 'if / else' chain has duplicated conditions
+            -Wduplicated-cond
+            # Warn if 'if / else' branches have duplicated code
+            -Wduplicated-branches
+            # Warn about logical operations being used where bitwise were probably wanted
+            -Wlogical-op
+            # Warn if you perform a cast to the same type
+            -Wuseless-cast
+            )
+
+    # Set compiler and linker flags depending on compiler
+    if (CMAKE_CXX_COMPILER_ID MATCHES ".*Clang")
+        if(USE_SANITIZERS)
+            # Set Clang sanitizers for memory errors/leaks and undefined behaviour
+            set(CLANG_WARNINGS -fsanitize=address,undefined ${CLANG_WARNINGS})
+            set(CLANG_LINKER_FLAGS -fsanitize=address,undefined)
+        endif()
+        set(PROJECT_WARNINGS ${CLANG_WARNINGS})
+        set(LINKER_FLAGS ${CLANG_LINKER_FLAGS})
+    elseif (CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
+        if(USE_SANITIZERS)
+            # Get GCC sanitizers for memory errors/leaks, undefined behaviour and pointer operands
+            set(GCC_WARNINGS
+                    -fsanitize=address,undefined,leak,pointer-compare,pointer-subtract
+                    ${GCC_WARNINGS})
+            set(GCC_LINKER_FLAGS
+                    -fsanitize=address,undefined,leak,pointer-compare,pointer-subtract)
+        endif()
+        set(PROJECT_WARNINGS ${GCC_WARNINGS})
+        set(LINKER_FLAGS ${GCC_LINKER_FLAGS})
+    else ()
+        message(AUTHOR_WARNING "No compiler warnings set for '${CMAKE_CXX_COMPILER_ID}' compiler.")
+    endif ()
+
+    # Add compiler and linker flags to project_warnings
+    target_compile_options(project_warnings INTERFACE ${PROJECT_WARNINGS})
+    target_link_options(project_warnings INTERFACE ${LINKER_FLAGS})
+
+endfunction()