Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions .github/workflows/ci_tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ on:

jobs:
beman-submodule-check:
uses: bemanproject/infra-workflows/.github/workflows/reusable-beman-submodule-check.yml@1.1.0
uses: bemanproject/infra-workflows/.github/workflows/reusable-beman-submodule-check.yml@1.2.1

preset-test:
uses: bemanproject/infra-workflows/.github/workflows/reusable-beman-preset-test.yml@1.1.0
uses: bemanproject/infra-workflows/.github/workflows/reusable-beman-preset-test.yml@1.2.1
with:
matrix_config: >
[
Expand All @@ -29,7 +29,7 @@ jobs:
]

build-and-test:
uses: bemanproject/infra-workflows/.github/workflows/reusable-beman-build-and-test.yml@1.1.0
uses: bemanproject/infra-workflows/.github/workflows/reusable-beman-build-and-test.yml@1.2.1
with:
matrix_config: >
{
Expand All @@ -40,7 +40,8 @@ jobs:
"tests": [
{ "stdlibs": ["libstdc++"],
"tests": [
"Debug.Default", "Release.Default", "Release.MaxSan",
"Debug.Default", "Release.Default", "Release.TSan",
"Release.MaxSan", "Debug.Werror",
"Debug.Dynamic", "Debug.Coverage"
]
}
Expand All @@ -51,7 +52,7 @@ jobs:
}
]
},
{ "versions": ["14", "13"],
{ "versions": ["14"],
"tests": [
{ "cxxversions": ["c++26", "c++23"],
"tests": [{ "stdlibs": ["libstdc++"], "tests": ["Release.Default"]}]
Expand All @@ -60,7 +61,7 @@ jobs:
}
],
"clang": [
{ "versions": ["20"],
{ "versions": ["21"],
"tests": [
{"cxxversions": ["c++26"],
"tests": [
Expand All @@ -79,7 +80,7 @@ jobs:
}
]
},
{ "versions": ["19"],
{ "versions": ["20", "19"],
"tests": [
{ "cxxversions": ["c++26", "c++23"],
"tests": [
Expand All @@ -95,7 +96,7 @@ jobs:
{ "cxxversions": ["c++23"],
"tests": [
{ "stdlibs": ["stl"],
"tests": ["Debug.Default", "Release.Default"]
"tests": ["Debug.Default", "Release.Default", "Release.MaxSan"]
}
]
}
Expand All @@ -107,4 +108,4 @@ jobs:
create-issue-when-fault:
needs: [preset-test, build-and-test]
if: failure() && github.event_name == 'schedule'
uses: bemanproject/infra-workflows/.github/workflows/reusable-beman-create-issue-when-fault.yml@1.1.0
uses: bemanproject/infra-workflows/.github/workflows/reusable-beman-create-issue-when-fault.yml@1.2.1
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ repos:

# CMake linting and formatting
- repo: https://github.com/BlankSpruce/gersemi
rev: 0.25.3
rev: 0.25.4
hooks:
- id: gersemi
name: CMake linting
Expand Down
80 changes: 24 additions & 56 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,93 +3,57 @@
# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
# gersemi: on

cmake_minimum_required(VERSION 3.25...4.2)
cmake_minimum_required(VERSION 3.30...4.2)

#========================== pre project settings ===============================
# gersemi: off
if(CMAKE_VERSION VERSION_GREATER_EQUAL 4.2)
set(CMAKE_EXPERIMENTAL_CXX_IMPORT_STD "d0edc3af-4c50-42ea-a356-e2862fe7a444")

if(CMAKE_CXX_STDLIB_MODULES_JSON)
message(
STATUS
"CMAKE_CXX_STDLIB_MODULES_JSON=${CMAKE_CXX_STDLIB_MODULES_JSON}"
)
endif()
endif()
# gersemi: on
#===============================================================================
include(cmake/prelude.cmake)

#===================================================
project(beman_execution VERSION 0.0.1 LANGUAGES CXX)
project(beman_execution VERSION 0.1.0 LANGUAGES CXX)
#===================================================

if(${CMAKE_SOURCE_DIR} STREQUAL ${CMAKE_BINARY_DIR})
message(FATAL_ERROR "In-source builds are not allowed!")
endif()
# Modules opt in only on compilers that support it: msvc, g++-15 and clang-20+
include(cxx-modules-rules)

set(TARGET_NAME execution)
set(TARGET_NAMESPACE beman)
set(TARGET_PREFIX ${TARGET_NAMESPACE}.${TARGET_NAME})
set(TARGET_LIBRARY ${PROJECT_NAME})
set(TARGET_ALIAS ${TARGET_NAMESPACE}::${TARGET_NAME})
set(TARGET_NAME beman_execution_headers) # used in src, and docs
set(TARGET_NAMESPACE beman) # NOTE: only still used in docs?
set(TARGET_PREFIX ${PROJECT_NAME}) # NOTE: only still used in docs?
set(TARGET_PACKAGE_NAME ${PROJECT_NAME}-config)
set(TARGETS_EXPORT_NAME ${PROJECT_NAME}-config-targets)

#========================== post project settings ==============================
# Tell CMake that we explicitly want `import std`.
# This will initialize the property on all targets declared after this to 1
message(STATUS "CMAKE_CXX_COMPILER_IMPORT_STD=${CMAKE_CXX_COMPILER_IMPORT_STD}")
if(${CMAKE_CXX_STANDARD} IN_LIST CMAKE_CXX_COMPILER_IMPORT_STD)
set(CMAKE_CXX_MODULE_STD ON)
message(STATUS "CMAKE_CXX_MODULE_STD=${CMAKE_CXX_MODULE_STD}")
endif()

# gersemi: off
if(CMAKE_CXX_SCAN_FOR_MODULES AND ${CMAKE_GENERATOR} STREQUAL Ninja)
set(BEMAN_USE_MODULES ON)
message(STATUS "BEMAN_USE_MODULES=${BEMAN_USE_MODULES}")
else()
message(WARNING "Missing support for CMAKE_CXX_SCAN_FOR_MODULES!")
endif()

if(CMAKE_EXPORT_COMPILE_COMMANDS)
set(CMAKE_CXX_STANDARD_INCLUDE_DIRECTORIES ${CMAKE_CXX_IMPLICIT_INCLUDE_DIRECTORIES})
message(
STATUS
"CMAKE_CXX_IMPLICIT_INCLUDE_DIRECTORIES=${CMAKE_CXX_IMPLICIT_INCLUDE_DIRECTORIES}"
)
endif()
# gersemi: on

#===============================================================================
if(BEMAN_USE_MODULES)
set(CMAKE_CXX_VISIBILITY_PRESET hidden)
set(CMAKE_VISIBILITY_INLINES_HIDDEN TRUE)

# CMake requires the language standard to be specified as compile feature
# when a target provides C++23 modules and the target will be installed
add_library(${TARGET_NAME} STATIC)
target_compile_features(${TARGET_NAME} PUBLIC cxx_std_${CMAKE_CXX_STANDARD})
add_library(beman_execution STATIC)
add_library(beman::beman_execution ALIAS beman_execution)
target_compile_features(
beman_execution
PUBLIC cxx_std_${CMAKE_CXX_STANDARD}
)

include(GenerateExportHeader)

generate_export_header(
${TARGET_NAME}
BASE_NAME beman.execution
beman_execution
BASE_NAME beman_execution
EXPORT_FILE_NAME beman/execution/modules_export.hpp
)
target_sources(
${TARGET_NAME}
beman_execution
PUBLIC
FILE_SET HEADERS
BASE_DIRS include ${CMAKE_CURRENT_BINARY_DIR}
FILES
${CMAKE_CURRENT_BINARY_DIR}/beman/execution/modules_export.hpp
)
target_compile_definitions(beman_execution PUBLIC BEMAN_USE_MODULES)
endif()

if(BEMAN_USE_MODULES AND CMAKE_CXX_MODULE_STD)
target_compile_definitions(${TARGET_NAME} PUBLIC BEMAN_HAS_IMPORT_STD)
target_compile_definitions(beman_execution PUBLIC BEMAN_HAS_IMPORT_STD)
else()
message(WARNING "Missing support for CMAKE_CXX_MODULE_STD!")
endif()
Expand Down Expand Up @@ -133,6 +97,10 @@ if(NOT BEMAN_EXECUTION_ENABLE_INSTALL OR CMAKE_SKIP_INSTALL_RULES)
return()
endif()

include(infra/cmake/beman-install-library-config.cmake)
# FIXME: install TARGETS target beman.execution is exported but not all of its interface file sets are installed
# TODO: beman_install_library(beman_execution beman_execution_headers)

Comment on lines +100 to +103
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ednolan How to install a project like execution with this CMake module?

include(CMakePackageConfigHelpers)

write_basic_package_version_file(
Expand Down
4 changes: 3 additions & 1 deletion CMakePresets.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"cacheVariables": {
"CMAKE_CXX_STANDARD": "23",
"CMAKE_CXX_EXTENSIONS": true,
"CMAKE_CXX_SCAN_FOR_MODULES": false,
"CMAKE_CXX_SCAN_FOR_MODULES": true,
"CMAKE_CXX_STANDARD_REQUIRED": true,
"CMAKE_EXPORT_COMPILE_COMMANDS": true,
"CMAKE_SKIP_TEST_ALL_DEPENDENCY": false,
Expand Down Expand Up @@ -83,6 +83,7 @@
"_debug-base"
],
"cacheVariables": {
"CMAKE_CXX_SCAN_FOR_MODULES": false,
"CMAKE_TOOLCHAIN_FILE": "infra/cmake/appleclang-toolchain.cmake"
}
},
Expand All @@ -94,6 +95,7 @@
"_release-base"
],
"cacheVariables": {
"CMAKE_CXX_SCAN_FOR_MODULES": false,
"CMAKE_TOOLCHAIN_FILE": "infra/cmake/appleclang-toolchain.cmake"
}
},
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ contains some links for general information about the sender/receivers and `std:
## Preconditions

- cmake v3.30 or newer
- ninja v1.11.1 or newer
- ninja v1.13.0 or newer
- A compiler that supports at least C++23


Expand Down
150 changes: 150 additions & 0 deletions cmake/cxx-modules-rules.cmake
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
#
# A CMake language file to be included as the last step of all project() command calls.
# This file must be included/used as CMAKE_PROJECT_INCLUDE -> after project()
#

# ---- The include guard applies within the current directory and below ----
include_guard(DIRECTORY)

if(NOT PROJECT_NAME)
message(
FATAL_ERROR
"This CMake file has to be included as the last step of all project() command calls!"
)
endif()

# Use modules? default NO!
if(NOT DEFINED CMAKE_CXX_SCAN_FOR_MODULES)
set(CMAKE_CXX_SCAN_FOR_MODULES OFF)
endif()

# Control whether the test target depends on the all target.
set(CMAKE_SKIP_TEST_ALL_DEPENDENCY OFF)

# gersemi: off
option(CMAKE_EXPORT_COMPILE_COMMANDS "Prepare run-clang-tidy" ${PROJECT_IS_TOP_LEVEL})
if(CMAKE_EXPORT_COMPILE_COMMANDS)
message(
STATUS
"CMAKE_CXX_IMPLICIT_INCLUDE_DIRECTORIES=${CMAKE_CXX_IMPLICIT_INCLUDE_DIRECTORIES}"
)
set(CMAKE_CXX_STANDARD_INCLUDE_DIRECTORIES ${CMAKE_CXX_IMPLICIT_INCLUDE_DIRECTORIES})
endif()
# gersemi: on

# Ensure non-empty default build type for single-config
get_property(isMultiConfig GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG)
if(NOT isMultiConfig)
set(CMAKE_BUILD_TYPE Debug CACHE STRING "Build type")
endif()
set(CMAKE_DEBUG_POSTFIX _d)

# ------------------------------------------------------------------------------
# This property setting also needs to be consistent between the installed shared
# library and its consumer, otherwise most toolchains will once again reject the
# consumer's generated BMI.
# ------------------------------------------------------------------------------
if(NOT DEFINED CMAKE_CXX_STANDARD)
set(CMAKE_CXX_STANDARD 23)
endif()

# Neither of these two are technically needed, but they make the expectation clear
set(CMAKE_CXX_EXTENSIONS ON)
set(CMAKE_CXX_STANDARD_REQUIRED ON)

# NOTE: only with Ninja generator install of bmi files works yet!
if(CMAKE_GENERATOR MATCHES "Ninja")
if(
CMAKE_CXX_COMPILER_ID STREQUAL "Clang"
AND CMAKE_CXX_COMPILER_VERSION VERSION_GREATER_EQUAL 19.0
)
set(CMAKE_CXX_SCAN_FOR_MODULES ON)

if(NOT LINUX)
string(APPEND CMAKE_CXX_MODULE_MAP_FLAG " -fmodules-reduced-bmi")
endif()

add_compile_options($ENV{CXXFLAGS})
add_link_options($ENV{CXXFLAGS})
elseif(
CMAKE_CXX_COMPILER_ID STREQUAL "GNU"
AND CMAKE_CXX_COMPILER_VERSION VERSION_GREATER_EQUAL 15.0
)
set(CMAKE_CXX_SCAN_FOR_MODULES ON)
elseif(CMAKE_CXX_COMPILER_ID STREQUAL "MSVC")
set(CMAKE_CXX_SCAN_FOR_MODULES ON)
else()
set(CMAKE_CXX_SCAN_FOR_MODULES OFF)
endif()
endif()

if(CMAKE_CXX_STDLIB_MODULES_JSON)
message(
STATUS
"CMAKE_CXX_STDLIB_MODULES_JSON=${CMAKE_CXX_STDLIB_MODULES_JSON}"
)
endif()

if(NOT DEFINED CMAKE_CXX_MODULE_STD)
set(CMAKE_CXX_MODULE_STD OFF)
endif()

option(
BEMAN_USE_STD_MODULE
"Check if 'import std;' is possible with the toolchain"
OFF
)
message(STATUS "BEMAN_USE_STD_MODULE=${BEMAN_USE_STD_MODULE}")

if(BEMAN_USE_STD_MODULE)
# -------------------------------------------------------------------------
# Tell CMake that we explicitly want `import std`.
# This will initialize the property on all targets declared after this to 1
# -------------------------------------------------------------------------
message(
STATUS
"CMAKE_CXX_COMPILER_IMPORT_STD=${CMAKE_CXX_COMPILER_IMPORT_STD}"
)
if(${CMAKE_CXX_STANDARD} IN_LIST CMAKE_CXX_COMPILER_IMPORT_STD)
set(CMAKE_CXX_MODULE_STD ON)
set(CMAKE_CXX_SCAN_FOR_MODULES ON)
option(
BEMAN_HAS_IMPORT_STD
"Build with import std; possible"
${CMAKE_CXX_MODULE_STD}
)
message(STATUS "BEMAN_HAS_IMPORT_STD=${BEMAN_HAS_IMPORT_STD}")
message(STATUS "CMAKE_CXX_MODULE_STD=${CMAKE_CXX_MODULE_STD}")
else()
set(CMAKE_CXX_MODULE_STD OFF)
message(WARNING "CMAKE_CXX_MODULE_STD=${CMAKE_CXX_MODULE_STD}")
endif()
endif()
message(STATUS "CMAKE_CXX_SCAN_FOR_MODULES=${CMAKE_CXX_SCAN_FOR_MODULES}")

if(CMAKE_CXX_STANDARD GREATER_EQUAL 20)
option(BEMAN_USE_MODULES "Build CXX_MODULES" ${CMAKE_CXX_SCAN_FOR_MODULES})
endif()
message(STATUS "BEMAN_USE_MODULES=${BEMAN_USE_MODULES}")

# ------------------------------------------------------------------------------
# Avoid creating CMAKE_..._OUTPUT_DIRECTORY as cache variables, they should not
# be under the control of the developer. They should be controlled by the
# project because parts of the project may make assumptions about the relative
# layout of the binaries. More importantly, leaving them as ordinary variables
# also means they can be unset within subdirectories where test executables are
# defined, allowing them to avoid being collected with the other main binaries
# and cluttering up that area.
# ------------------------------------------------------------------------------
set(stageDir ${CMAKE_CURRENT_BINARY_DIR}/stagedir)
include(GNUInstallDirs)

if(NOT CMAKE_RUNTIME_OUTPUT_DIRECTORY)
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${stageDir}/${CMAKE_INSTALL_BINDIR})
endif()
if(NOT CMAKE_LIBRARY_OUTPUT_DIRECTORY)
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${stageDir}/${CMAKE_INSTALL_LIBDIR})
endif()
if(NOT CMAKE_ARCHIVE_OUTPUT_DIRECTORY)
set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${stageDir}/${CMAKE_INSTALL_LIBDIR})
endif()
Loading
Loading