Skip to content

adds experimental support for C++20 modules #248

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
May 26, 2025
Merged

adds experimental support for C++20 modules #248

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
967964c
adds experimental support for C++20 modules
cjdb May 23, 2025
ded6ca9
Try to fix integration test
jeremy-rifkin May 25, 2025
1a0454c
Try to fix CI
jeremy-rifkin May 26, 2025
c73cceb
Detect module support with compiler versions
jeremy-rifkin May 26, 2025
6c27579
Remove register_jit_objects_from_gdb_jit_interface from the module in…
jeremy-rifkin May 26, 2025
d3d6bdc
Misc
jeremy-rifkin May 26, 2025
25a75dc
Remove gdb_jit include
jeremy-rifkin May 26, 2025
2375e9f
Fix for bazel
jeremy-rifkin May 26, 2025
af8b2db
Fix for bazel
jeremy-rifkin May 26, 2025
190a07e
Fix install rules
jeremy-rifkin May 26, 2025
a6f5018
Set a destination for the modules file set
jeremy-rifkin May 26, 2025
0a8c500
Update modules install destination
jeremy-rifkin May 26, 2025
ec9f31c
Cleanup and rename module to .cppm
jeremy-rifkin May 26, 2025
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
11 changes: 10 additions & 1 deletion CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
cmake_minimum_required(VERSION 3.14)
cmake_minimum_required(VERSION 3.15...4.0)

include(cmake/PreventInSourceBuilds.cmake)

Expand Down Expand Up @@ -156,6 +156,15 @@ target_sources(
src/platform/dbghelp_utils.cpp
)

if(HAS_CXX20_MODULES)
target_sources(
${target_name} PUBLIC
FILE_SET CXX_MODULES
FILES "src/cpptrace.cppm"
BASE_DIRS "src"
)
endif()

target_include_directories(
${target_name}
PUBLIC
Expand Down
14 changes: 8 additions & 6 deletions ci/test-all-configs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,7 @@ def build(runner: MatrixRunner):
args = [
"cmake",
"..",
"-GNinja",
f"-DCMAKE_BUILD_TYPE={matrix['target']}",
f"-DCMAKE_CXX_COMPILER={matrix['compiler']}",
f"-DCMAKE_C_COMPILER={get_c_compiler_counterpart(matrix['compiler'])}",
Expand All @@ -138,7 +139,7 @@ def build(runner: MatrixRunner):
args.append("-DCPPTRACE_BUILD_TEST_RDYNAMIC=On")
succeeded = runner.run_command(*args)
if succeeded:
return runner.run_command("make", "-j")
return runner.run_command("ninja")
else:
args = [
"cmake",
Expand All @@ -158,11 +159,11 @@ def build(runner: MatrixRunner):
f"-DBUILD_SHARED_LIBS={matrix['shared']}"
]
if matrix["compiler"] == "g++":
args.append("-GUnix Makefiles")
args.append("-GNinja")
succeeded = runner.run_command(*args)
if succeeded:
if matrix["compiler"] == "g++":
return runner.run_command("make", "-j")
return runner.run_command("ninja")
else:
return runner.run_command("msbuild", "cpptrace.sln")
return False
Expand All @@ -173,6 +174,7 @@ def build_full_or_auto(runner: MatrixRunner):
args = [
"cmake",
"..",
"-GNinja",
f"-DCMAKE_BUILD_TYPE={matrix['target']}",
f"-DCMAKE_CXX_COMPILER={matrix['compiler']}",
f"-DCMAKE_C_COMPILER={get_c_compiler_counterpart(matrix['compiler'])}",
Expand All @@ -189,7 +191,7 @@ def build_full_or_auto(runner: MatrixRunner):
args.append(f"{matrix['config']}")
succeeded = runner.run_command(*args)
if succeeded:
return runner.run_command("make", "-j")
return runner.run_command("ninja")
else:
args = [
"cmake",
Expand All @@ -208,11 +210,11 @@ def build_full_or_auto(runner: MatrixRunner):
if matrix["config"] != "":
args.append(f"{matrix['config']}")
if matrix["compiler"] == "g++":
args.append("-GUnix Makefiles")
args.append("-GNinja")
succeeded = runner.run_command(*args)
if succeeded:
if matrix["compiler"] == "g++":
return runner.run_command("make", "-j")
return runner.run_command("ninja")
else:
return runner.run_command("msbuild", "cpptrace.sln")
return False
Expand Down
21 changes: 21 additions & 0 deletions cmake/Autoconfig.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,27 @@ else()
check_support(HAS_STACKWALK has_stackwalk.cpp "" "dbghelp" "")
endif()

set(HAS_CXX20_MODULES FALSE)
if(CMAKE_CXX_STANDARD GREATER_EQUAL 20)
# https://cmake.org/cmake/help/latest/manual/cmake-cxxmodules.7.html#compiler-support
# msvc 14.34+/19.34+
# clang 16+
# gcc 15 and newer
if(CMAKE_CXX_COMPILER_ID STREQUAL "MSVC")
if(CMAKE_CXX_COMPILER_VERSION VERSION_GREATER_EQUAL 19.34)
set(HAS_CXX20_MODULES TRUE)
endif()
elseif (CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
if(CMAKE_CXX_COMPILER_VERSION VERSION_GREATER_EQUAL 16.0)
set(HAS_CXX20_MODULES TRUE)
endif()
elseif(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
if(CMAKE_CXX_COMPILER_VERSION VERSION_GREATER_EQUAL 15.0)
set(HAS_CXX20_MODULES TRUE)
endif()
endif()
endif()

if(NOT WIN32 OR MINGW)
check_support(HAS_BACKTRACE has_backtrace.cpp "" "backtrace" "${CPPTRACE_BACKTRACE_PATH_DEFINITION}")
set(STACKTRACE_LINK_LIB "stdc++_libbacktrace")
Expand Down
2 changes: 2 additions & 0 deletions cmake/InstallRules.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ install(
COMPONENT ${package_name}_development
INCLUDES #
DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}"
FILE_SET CXX_MODULES
DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/cpptrace"
)

# create config file that points to targets file
Expand Down
18 changes: 1 addition & 17 deletions include/cpptrace/exceptions.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
#define CPPTRACE_EXCEPTIONS_HPP

#include <cpptrace/basic.hpp>
#include <cpptrace/exceptions_macros.hpp>

#include <exception>
#include <system_error>
Expand Down Expand Up @@ -195,23 +196,6 @@ CPPTRACE_BEGIN_NAMESPACE
[[noreturn]] CPPTRACE_EXPORT void rethrow_and_wrap_if_needed(std::size_t skip = 0);
CPPTRACE_END_NAMESPACE

// Exception wrapper utilities
#define CPPTRACE_WRAP_BLOCK(statements) do { \
try { \
statements \
} catch(...) { \
::cpptrace::rethrow_and_wrap_if_needed(); \
} \
} while(0)

#define CPPTRACE_WRAP(expression) [&] () -> decltype((expression)) { \
try { \
return expression; \
} catch(...) { \
::cpptrace::rethrow_and_wrap_if_needed(1); \
} \
} ()

#ifdef _MSC_VER
#pragma warning(pop)
#endif
Expand Down
21 changes: 21 additions & 0 deletions include/cpptrace/exceptions_macros.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
#ifndef CPPTRACE_EXCEPTIONS_MACROS_HPP
#define CPPTRACE_EXCEPTIONS_MACROS_HPP

// Exception wrapper utilities
#define CPPTRACE_WRAP_BLOCK(statements) do { \
try { \
statements \
} catch(...) { \
::cpptrace::rethrow_and_wrap_if_needed(); \
} \
} while(0)

#define CPPTRACE_WRAP(expression) [&] () -> decltype((expression)) { \
try { \
return expression; \
} catch(...) { \
::cpptrace::rethrow_and_wrap_if_needed(1); \
} \
} ()

#endif // CPPTRACE_EXCEPTIONS_MACROS_HPP
53 changes: 1 addition & 52 deletions include/cpptrace/from_current.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,7 @@
#endif

#include <cpptrace/basic.hpp>

// https://godbolt.org/z/4MsT6KqP1
#ifdef _MSC_VER
#define CPPTRACE_UNREACHABLE() __assume(false)
#else
#define CPPTRACE_UNREACHABLE() __builtin_unreachable()
#endif

// https://godbolt.org/z/7neGPEche
// gcc added support in 4.8 but I'm too lazy to check the minor version
#if defined(__GNUC__) && (__GNUC__ < 5)
#define CPPTRACE_NORETURN __attribute__((noreturn))
#else
#define CPPTRACE_NORETURN [[noreturn]]
#endif
#include <cpptrace/from_current_macros.hpp>

CPPTRACE_BEGIN_NAMESPACE
CPPTRACE_EXPORT const raw_trace& raw_trace_from_current_exception();
Expand Down Expand Up @@ -100,39 +86,7 @@ CPPTRACE_BEGIN_NAMESPACE
inline void nop(int) {}
#endif
}
CPPTRACE_END_NAMESPACE

#ifdef _MSC_VER
#define CPPTRACE_TYPE_FOR(param) \
::cpptrace::detail::argument<void(param)>::type
// this awful double-IILE is due to C2713 "You can't use structured exception handling (__try/__except) and C++
// exception handling (try/catch) in the same function."
#define CPPTRACE_TRY \
try { \
[&]() { \
__try { \
[&]() {
#define CPPTRACE_CATCH(param) \
}(); \
} __except(::cpptrace::detail::exception_filter<CPPTRACE_TYPE_FOR(param)>(GetExceptionInformation())) {} \
}(); \
} catch(param)
#else
#define CPPTRACE_UNWIND_INTERCEPTOR_FOR(param) \
::cpptrace::detail::unwind_interceptor_for<void(param)>
#define CPPTRACE_TRY \
try { \
try {
#define CPPTRACE_CATCH(param) \
} catch(const CPPTRACE_UNWIND_INTERCEPTOR_FOR(param)&) { \
CPPTRACE_UNREACHABLE(); \
/* force instantiation of the init-er */ \
::cpptrace::detail::nop(CPPTRACE_UNWIND_INTERCEPTOR_FOR(param)::init); \
} \
} catch(param)
#endif

CPPTRACE_BEGIN_NAMESPACE
namespace detail {
template<typename R, typename Arg>
Arg get_callable_argument_helper(R(*) (Arg));
Expand Down Expand Up @@ -194,9 +148,4 @@ CPPTRACE_BEGIN_NAMESPACE
}
CPPTRACE_END_NAMESPACE

#ifdef CPPTRACE_UNPREFIXED_TRY_CATCH
#define TRY CPPTRACE_TRY
#define CATCH(param) CPPTRACE_CATCH(param)
#endif

#endif
54 changes: 54 additions & 0 deletions include/cpptrace/from_current_macros.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
#ifndef CPPTRACE_FROM_CURRENT_MACROS_HPP
Copy link
Owner

Choose a reason for hiding this comment

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

Out of curiosity, is there a sensible way to make either of the following work instead of a new macros header?

#include <cpptrace/from_current.hpp>
import cpptrace;
// or
import cpptrace;
#include <cpptrace/from_current.hpp>

If a macros header is the best way to do this I think it's good with me - and I'm guessing if so other libraries might follow the same pattern. But I'd love to be able to keep #include <cpptrace/from_current.hpp> under modules if possible as that is currently in a sense part of the library interface.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We can do the former, but not the latter (yet). Having said that, including cpptrace/from_current.hpp will undo some or all of the hard work that modules is accomplishing. I'm not aware of a better way to import macros from a module library than to do

#include <cpptrace/from_current_macros.hpp>

import cpptrace;

Once support for modules stabilises, I'd recommend the docs encourage header users not include the _macros.hpp headers, and instead just stick with the original headers (which export the macros).

#define CPPTRACE_FROM_CURRENT_MACROS_HPP

// https://godbolt.org/z/4MsT6KqP1
#ifdef _MSC_VER
#define CPPTRACE_UNREACHABLE() __assume(false)
#else
#define CPPTRACE_UNREACHABLE() __builtin_unreachable()
#endif

// https://godbolt.org/z/7neGPEche
// gcc added support in 4.8 but I'm too lazy to check the minor version
#if defined(__GNUC__) && (__GNUC__ < 5)
#define CPPTRACE_NORETURN __attribute__((noreturn))
#else
#define CPPTRACE_NORETURN [[noreturn]]
#endif

#ifdef _MSC_VER
#define CPPTRACE_TYPE_FOR(param) \
::cpptrace::detail::argument<void(param)>::type
// this awful double-IILE is due to C2713 "You can't use structured exception handling (__try/__except) and C++
// exception handling (try/catch) in the same function."
#define CPPTRACE_TRY \
try { \
[&]() { \
__try { \
[&]() {
#define CPPTRACE_CATCH(param) \
}(); \
} __except(::cpptrace::detail::exception_filter<CPPTRACE_TYPE_FOR(param)>(GetExceptionInformation())) {} \
}(); \
} catch(param)
#else
#define CPPTRACE_UNWIND_INTERCEPTOR_FOR(param) \
::cpptrace::detail::unwind_interceptor_for<void(param)>
#define CPPTRACE_TRY \
try { \
try {
#define CPPTRACE_CATCH(param) \
} catch(const CPPTRACE_UNWIND_INTERCEPTOR_FOR(param)&) { \
CPPTRACE_UNREACHABLE(); \
/* force instantiation of the init-er */ \
::cpptrace::detail::nop(CPPTRACE_UNWIND_INTERCEPTOR_FOR(param)::init); \
} \
} catch(param)
#endif

#ifdef CPPTRACE_UNPREFIXED_TRY_CATCH
#define TRY CPPTRACE_TRY
#define CATCH(param) CPPTRACE_CATCH(param)
#endif

#endif // CPPTRACE_FROM_CURRENT_MACROS_HPP
Loading
Loading