CMakeLists.txt

# ##############
# ### /root ####
# ##############
cmake_minimum_required(VERSION 3.20.0)

set(CMAKE_C_STANDARD 17)

# project name (main executable name)
project(C_Example)

# determine OS bitness
if(CMAKE_SIZEOF_VOID_P EQUAL 8)
  set(OSBitness 64)
else()
  set(OSBitness 32)
endif()

# build output directory based on OS and build type.
# (example: bin/Linux_64/Debug)
set(BINARIES_OUTPUT_DIRECTORY
  "${CMAKE_SOURCE_DIR}/bin/${CMAKE_SYSTEM_NAME}_${OSBitness}/${CMAKE_BUILD_TYPE}"
)

# path of the executable
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY
  "${BINARIES_OUTPUT_DIRECTORY}"
)

# path of the static libraries. (will be embedded in executable)
set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY
  "${BINARIES_OUTPUT_DIRECTORY}/static libs"
)

# path of the dynamic libraries. (seperate files to be shipped with executable)
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY
  "${BINARIES_OUTPUT_DIRECTORY}"
)

# project-wide include (headers) directory
include_directories(${CMAKE_CURRENT_LIST_DIR}/include)

# #####################################################
# ############ processing ./src starts here #############
# #####################################################

# add main executable
add_executable(${PROJECT_NAME} src/main.c)

# add external subdirectory
add_subdirectory(external)

# add /src as an include directory for the main executable
target_include_directories(${PROJECT_NAME} PUBLIC src)

# contains important utilities for managing modules.
include(_cmake/Modules.cmake)

# lists the modules in the system
include(src/modules/modules.cmake)

# #####################################################
# ############ processing ./src ends here #############
# #####################################################

# compiler flags
target_compile_options(${PROJECT_NAME} PRIVATE
  -Wall
  -Wextra
  -Wpedantic
)

# CTest sets BUILD_TESTING option to ON by default when included.
include(CTest)

if(BUILD_TESTING)
  # test related configs go here
  enable_testing()
  set(CMAKE_TESTS_OUTPUT_DIRECTORY # path of tests binaries
    "${BINARIES_OUTPUT_DIRECTORY}/tests"
  )

  include(_cmake/Tests.cmake) # macros and functions
  include(tests/tests.cmake) # lists tests suites in the project
endif()