Check for std::format support in CMake
#891
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Today I tried building traccc with g++12 which broke as acts-project#845 introduced a dependency on `std::format` which is not universally available. In order to provide earlier and more readable errors, this commit adds a configuration-time check to ensure that the C++ compiler supports `std::format`.
|
krasznaa
requested changes
Feb 25, 2025
Comment on lines
+73
to
+87
| message(STATUS "Checking for `std::format` support") | ||
| file( WRITE | ||
| "${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeTmp/compile_test_format.cpp" | ||
| "#include <format>\n" | ||
| "int main() {\n" | ||
| "std::format(\"Hello {}\\n\", \"world\");\n" | ||
| "return 0; }\n" ) | ||
| try_compile( TRACCCC_INTERNAL_STD_FORMAT_WORKS SOURCES | ||
| "${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeTmp/compile_test_format.cpp") | ||
|
|
||
| if (NOT TRACCCC_INTERNAL_STD_FORMAT_WORKS) | ||
| message(FATAL_ERROR "Examples are enabled, but `std::format` is not supported by the C++ compiler; upgrade to gcc 13 or clang 14 or higher.") | ||
| endif() | ||
|
|
||
| unset(TRACCCC_INTERNAL_STD_FORMAT_WORKS) |
There was a problem hiding this comment.
No need to write such low level code. We have check_cxx_source_compiles(...) for this. Which is used extensively in vecmem for instance. (https://github.com/acts-project/vecmem/blob/main/core/CMakeLists.txt#L208)
I'd propose:
Suggested change
| message(STATUS "Checking for `std::format` support") | |
| file( WRITE | |
| "${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeTmp/compile_test_format.cpp" | |
| "#include <format>\n" | |
| "int main() {\n" | |
| "std::format(\"Hello {}\\n\", \"world\");\n" | |
| "return 0; }\n" ) | |
| try_compile( TRACCCC_INTERNAL_STD_FORMAT_WORKS SOURCES | |
| "${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeTmp/compile_test_format.cpp") | |
| if (NOT TRACCCC_INTERNAL_STD_FORMAT_WORKS) | |
| message(FATAL_ERROR "Examples are enabled, but `std::format` is not supported by the C++ compiler; upgrade to gcc 13 or clang 14 or higher.") | |
| endif() | |
| unset(TRACCCC_INTERNAL_STD_FORMAT_WORKS) | |
| include(CheckCxxSourceCompiles) | |
| check_cxx_source_compiles( " | |
| #include <format> | |
| int main() { | |
| std::format(\"Hello {}\\n\", \"world\"); | |
| } | |
| " TRACCC_STD_FORMAT_WORKS ) | |
| if( NOT TRACCC_STD_FORMAT_WORKS ) | |
| message(FATAL_ERROR "Examples are enabled, but `std::format` is not supported by the C++ compiler; upgrade to gcc 13 or clang 14 or higher.") | |
| endif() |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Today I tried building traccc with g++12 which broke as #845 introduced a dependency on
std::formatwhich is not universally available. In order to provide earlier and more readable errors, this commit adds a configuration-time check to ensure that the C++ compiler supportsstd::format.