CMakeLists.txt

####
# CMakeLists.txt:
#
# Build core F prime.
####
cmake_minimum_required(VERSION 3.16)
project(FPrime C CXX)
set(FPRIME_FRAMEWORK_PATH "${CMAKE_CURRENT_LIST_DIR}" CACHE PATH "Location of F prime framework" FORCE)
set(FPRIME_PROJECT_ROOT "${CMAKE_CURRENT_LIST_DIR}" CACHE PATH "Root path of F prime project" FORCE)

# Include the build for F prime.
include("${CMAKE_CURRENT_LIST_DIR}/cmake/FPrime.cmake")

# This cmake project is only intended to be used by CI and developers to test F-prime. We enable
# -Wall and -Wextra on this particular project as a canary to warn about compilation
# errors without impacting real projects, where a warning from an untested compiler could break the
# build.

add_compile_options(
    -Wall
    -Wextra
    -Werror
    $<$<COMPILE_LANGUAGE:CXX>:-Wold-style-cast>
    -Wno-unused-parameter
)

# Add -Wshadow, -Wconversion and -pedantic only for framework code, not the unit tests
# TODO: uncomment -Wdouble-promotion once fpp is fixed
if (NOT BUILD_TESTING)
    add_compile_options(
        -Wshadow
        -pedantic
        -Wconversion
#        -Wdouble-promotion
    )
endif()

# Turn on pedantic checks for clang, but disable specific checks that F' doesn't comply with.
# GCC doesn't support disabling specific pedantic checks, so skip pedantic on GCC for now.
#
# -Wno-unused-parameter: Disable the unused parameter warning for now. F' has a lot of interfaces,
# so unused method parameters are common in the F prime code base. Eventually all intentionally
# unused parameters should be annotated to avoid this error.
#
# -Wno-gnu-zero-variadic-macro-arguments: gnu extension required to allow FW_ASSERT to support 0+
# optional arguments
#
# -Wno-vla-extension: Variable length arrays are required to support sending to async serializable
# ports. https://github.com/nasa/fprime/issues/945
#
# -Wno-zero-length-array: maximum port message size calculated by using sizeof on an array the size
# of all the port's arguments. When port has no argument array is zero sized. Array is used at
# compile time only.
if(CMAKE_CXX_COMPILER_ID MATCHES "Clang")
    add_compile_options(
        -pedantic
        -Wno-gnu-zero-variadic-macro-arguments
        $<$<COMPILE_LANGUAGE:CXX>:-Wno-vla-extension>
        $<$<COMPILE_LANGUAGE:CXX>:-Wno-zero-length-array>
    )
elseif(CMAKE_CXX_COMPILER_ID MATCHES "GNU" AND NOT DEFINED CMAKE_CXX_CLANG_TIDY)
    # The following is not supported by clang, which also causes issues when using clang-tidy
    add_compile_options(
        -Wno-format-truncation
    )
endif()

find_program(VALGRIND valgrind) # Find valgrind, and use it instead of leak check
# For this testing cmake project, enable AddressSanitizer, a runtime memory sanitizer, on all unit tests
if (BUILD_TESTING AND NOT VALGRIND)
    add_compile_options(-fno-omit-frame-pointer -fsanitize=address -fsanitize=undefined)
    add_link_options(-fno-omit-frame-pointer -fsanitize=address -fsanitize=undefined)
endif()

include("${CMAKE_CURRENT_LIST_DIR}/cmake/FPrime-Code.cmake")