feat: Add C++ modules support

.github/workflows/test-docs-examples.yml

@@ -18,7 +18,7 @@ permissions:
 jobs:
   test_docs_examples:
     name: Test build examples
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     concurrency:
       group: ${{ github.workflow }}-${{ github.ref }}
       cancel-in-progress: true
@@ -35,17 +35,19 @@ jobs:
           submodules: recursive
 
       - name: Install apt packages
-        run: sudo sed -i 's/azure\.//' /etc/apt/sources.list && sudo apt-get update && sudo apt-get install -y g++-12 libopus-dev zlib1g-dev libmpg123-dev liboggz-dev cmake libfmt-dev libopusfile-dev
+        run: sudo sed -i 's/azure\.//' /etc/apt/sources.list && sudo apt-get update && sudo apt-get install -y clang-20 libopus-dev ninja-build zlib1g-dev libmpg123-dev liboggz-dev cmake libfmt-dev libopusfile-dev
 
       - name: Generate CMake
-        run: mkdir build && cd build && cmake -DDPP_NO_VCPKG=ON -DAVX_TYPE=T_fallback -DDPP_CORO=ON -DCMAKE_BUILD_TYPE=Debug ..
+        run: mkdir build && cd build && cmake -G Ninja -DDPP_NO_VCPKG=ON -DDPP_MODULES=ON -DAVX_TYPE=T_fallback -DDPP_CORO=ON -DCMAKE_BUILD_TYPE=Debug ..
         env:
-          CXX: g++-12
+          CXX: clang++-20
 
       - name: Build Project
-        run: cd build && make -j2 && sudo make install
+        run: cd build && cmake --build . -j2 && sudo ninja install
+        env:
+          CXX: clang++-20
 
       - name: Test compile examples
-        run: cd docpages/example_code && mkdir build && cd build && cmake .. && make -j2
+        run: cd docpages/example_code && mkdir build && cd build && cmake -G Ninja -DDPP_MODULES=ON .. && cmake --build . -j2
         env:
-          CXX: g++-12
+          CXX: clang++-20

CMakeLists.txt

@@ -18,7 +18,7 @@
 
 cmake_minimum_required (VERSION 3.16)
 set(CMAKE_CXX_STANDARD 17)
- 
+
 option(BUILD_SHARED_LIBS "Build shared libraries" ON)
 option(BUILD_VOICE_SUPPORT "Build voice support" ON)
 option(RUN_LDCONFIG "Run ldconfig after installation" ON)
@@ -33,6 +33,7 @@ option(DPP_USE_EXTERNAL_JSON "Use an external installation of nlohmann::json" OF
 option(DPP_USE_PCH "Use precompiled headers to speed up compilation" OFF)
 option(AVX_TYPE "Force AVX type for speeding up audio mixing" OFF)
 option(DPP_TEST_VCPKG "Force VCPKG build without VCPKG installed (for development use only!)" OFF)
+option(DPP_MODULES "Support for C++20 modules (experimental)" OFF)
 
 include(CheckCXXSymbolExists)
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
@@ -159,3 +160,4 @@ endif()
 if (NOT WIN32)
 	target_link_libraries(dpp PRIVATE std::filesystem)
 endif()
+

README.md

@@ -33,6 +33,7 @@ D++ is a lightweight and efficient library for **Discord** written in **modern C
 * Stable [Windows support](https://dpp.dev/buildwindows.html)
 * Ready-made compiled packages for Windows, Raspberry Pi (ARM64/ARM7/ARMv6), Debian x86/x64, and RPM based distributions
 * Highly scalable for large amounts of guilds and users
+* Support for [C++ modules](https://dpp.dev/using_modules.html)
 
 Want to help? Drop me a line or send a PR.
 

cmake/CPackSetup.cmake

@@ -11,20 +11,40 @@ set(DPP_INSTALL_LIBRARY_DIR ${CMAKE_INSTALL_LIBDIR}/${DPP_VERSIONED})
 
 ## Pack the binary output
 if (WIN32)
-	install(TARGETS dpp
-		EXPORT ${DPP_EXPORT_NAME}
-		LIBRARY DESTINATION  ${DPP_INSTALL_LIBRARY_DIR}
-		ARCHIVE DESTINATION  ${DPP_INSTALL_LIBRARY_DIR}
-		RUNTIME DESTINATION  ${CMAKE_INSTALL_BINDIR}
-		INCLUDES DESTINATION ${DPP_INSTALL_INCLUDE_DIR})
+	if (DPP_MODULES)
+		install(TARGETS dpp
+			EXPORT ${DPP_EXPORT_NAME}
+			LIBRARY DESTINATION  ${DPP_INSTALL_LIBRARY_DIR}
+			ARCHIVE DESTINATION  ${DPP_INSTALL_LIBRARY_DIR}
+			RUNTIME DESTINATION  ${CMAKE_INSTALL_BINDIR}
+			INCLUDES DESTINATION ${DPP_INSTALL_INCLUDE_DIR}
+			FILE_SET CXX_MODULES DESTINATION ${DPP_INSTALL_INCLUDE_DIR})
+	else()
+		install(TARGETS dpp
+			EXPORT ${DPP_EXPORT_NAME}
+			LIBRARY DESTINATION  ${DPP_INSTALL_LIBRARY_DIR}
+			ARCHIVE DESTINATION  ${DPP_INSTALL_LIBRARY_DIR}
+			RUNTIME DESTINATION  ${CMAKE_INSTALL_BINDIR}
+			INCLUDES DESTINATION ${DPP_INSTALL_INCLUDE_DIR})
+	endif()
 	install(DIRECTORY "${DPP_ROOT_PATH}/include/" DESTINATION "${DPP_INSTALL_INCLUDE_DIR}")
 else()
-	install(TARGETS dpp
-		EXPORT ${DPP_EXPORT_NAME}
-		LIBRARY DESTINATION  ${CMAKE_INSTALL_LIBRARY_DIR}
-		ARCHIVE DESTINATION  ${CMAKE_INSTALL_LIBRARY_DIR}
-		RUNTIME DESTINATION  ${CMAKE_INSTALL_BINDIR}
-		INCLUDES DESTINATION ${CMAKE_INSTALL_INCLUDE_DIR})
+	if (DPP_MODULES)
+		install(TARGETS dpp
+			EXPORT ${DPP_EXPORT_NAME}
+			LIBRARY DESTINATION  ${CMAKE_INSTALL_LIBDIR}
+			ARCHIVE DESTINATION  ${CMAKE_INSTALL_LIBDIR}
+			RUNTIME DESTINATION  ${CMAKE_INSTALL_BINDIR}
+			INCLUDES DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
+			FILE_SET CXX_MODULES DESTINATION ${CMAKE_INSTALL_INCLUDEDIR})
+	else()
+		install(TARGETS dpp
+			EXPORT ${DPP_EXPORT_NAME}
+			LIBRARY DESTINATION  ${CMAKE_INSTALL_LIBDIR}
+			ARCHIVE DESTINATION  ${CMAKE_INSTALL_LIBDIR}
+			RUNTIME DESTINATION  ${CMAKE_INSTALL_BINDIR}
+			INCLUDES DESTINATION ${CMAKE_INSTALL_INCLUDEDIR})
+	endif()
 endif()
 
 ## Allow for a specific version to be chosen in the `find_package` command

docpages/example_code/CMakeLists.txt

@@ -28,19 +28,41 @@
 # libmpg123-dev
 # dpp latest master with -DDPP_CORO=ON installed sytemwide
 
-cmake_minimum_required (VERSION 3.16)
+cmake_minimum_required (VERSION 3.28)
 project(documentation_tests)
 
 include("${CMAKE_CURRENT_SOURCE_DIR}/../../cmake/colour.cmake")
 
-set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DDPP_CORO -std=c++20 -pthread -O0 -fPIC -rdynamic -DFMT_HEADER_ONLY -Wall -Wextra -Wpedantic -Werror -Wno-unused-parameter -Wno-deprecated-declarations")
+option(DPP_MODULES "Build examples with C++20 modules support" ON)
+
+set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DDPP_CORO -std=c++20 -pthread -O0 -fPIC -DFMT_HEADER_ONLY -Wall -Wextra -Wpedantic -Werror -Wno-unused-parameter -Wno-deprecated-declarations")
 set (CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -O0")
 
+# Create gcm.cache directory and symlink to the main build's dpp.gcm
+if (CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
+	file(MAKE_DIRECTORY "${CMAKE_BINARY_DIR}/gcm.cache")
+	file(CREATE_LINK "${CMAKE_SOURCE_DIR}/../../build/library/CMakeFiles/dpp.dir/dpp.gcm"
+		"${CMAKE_BINARY_DIR}/gcm.cache/dpp.gcm" SYMBOLIC)
+endif()
+
 file(GLOB example_list ./*.cpp)
 foreach (example ${example_list})
 	get_filename_component(examplename ${example} NAME)
 	message(STATUS "Found example '${BoldBlue}${examplename}${ColourReset}'")
 	add_executable(${examplename}_out ${example})
 	target_link_libraries(${examplename}_out dl dpp mpg123 oggz ogg opusfile opus)
 	include_directories(/usr/include/opus)
+
+	target_compile_definitions(${examplename}_out PRIVATE DPP_MODULES)
+	set_target_properties(${examplename}_out PROPERTIES CXX_SCAN_FOR_MODULES ON)
+
+	if (CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
+		target_compile_options(${examplename}_out PRIVATE -fmodules-ts)
+	elseif(CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
+		target_compile_options(${examplename}_out PRIVATE 
+			-fmodules
+			-mavx2
+			-fprebuilt-module-path=${CMAKE_SOURCE_DIR}/../../build/library/CMakeFiles/dpp.dir
+		)
+	endif()
 endforeach(example)

docpages/example_code/attachments1.cpp

@@ -6,7 +6,7 @@ int main() {
 	bot.on_log(dpp::utility::cout_logger());
 
 	/* The event is fired when someone issues your commands */
-	bot.on_slashcommand([&bot](const dpp::slashcommand_t& event) {
+	bot.on_slashcommand([](const dpp::slashcommand_t& event) {
 		/* Check which command they ran */
 		if (event.command.get_command_name() == "file") {
 			dpp::message msg(event.command.channel_id, "Hey there, I've got a new file!");

docpages/example_code/attachments3.cpp

@@ -6,7 +6,7 @@ int main() {
 	bot.on_log(dpp::utility::cout_logger());
 
 	/* The event is fired when someone issues your commands */
-	bot.on_slashcommand([&bot](const dpp::slashcommand_t& event) {
+	bot.on_slashcommand([](const dpp::slashcommand_t& event) {
 		/* Check which command they ran */
 		if (event.command.get_command_name() == "file") {
 			/* Create a message. */

docpages/example_code/autocomplete.cpp

@@ -23,7 +23,7 @@ int main()
 	});
 
 	/* The interaction create event is fired when someone issues your commands */
-	bot.on_slashcommand([&bot](const dpp::slashcommand_t & event) {
+	bot.on_slashcommand([](const dpp::slashcommand_t & event) {
 
 		/* Check which command they ran */
 		if (event.command.get_command_name() == "blep") {

docpages/example_code/cache_messages.cpp

@@ -23,7 +23,7 @@ int main() {
 	});
 
 	/* The event is fired when someone issues your commands */
-	bot.on_slashcommand([&bot, &message_cache](const dpp::slashcommand_t& event) {
+	bot.on_slashcommand([&message_cache](const dpp::slashcommand_t& event) {
 		/* Check which command they ran */
 		if (event.command.get_command_name() == "get") {
 

docpages/example_code/components.cpp

@@ -7,7 +7,7 @@ int main() {
 	bot.on_log(dpp::utility::cout_logger());
 
 	/* The event is fired when someone issues your commands */
-	bot.on_slashcommand([&bot](const dpp::slashcommand_t& event) {
+	bot.on_slashcommand([](const dpp::slashcommand_t& event) {
 		/* Check which command they ran */
 		if (event.command.get_command_name() == "button") {
 			/* Create a message */
@@ -33,7 +33,7 @@ int main() {
 	/* When a user clicks your button, the on_button_click event will fire,
 	 * containing the custom_id you defined in your button.
 	 */
-	bot.on_button_click([&bot](const dpp::button_click_t& event) {
+	bot.on_button_click([](const dpp::button_click_t& event) {
 		/* Button clicks are still interactions, and must be replied to in some form to
 		 * prevent the "this interaction has failed" message from Discord to the user.
  		 */

docpages/example_code/components2.cpp

@@ -6,7 +6,7 @@ int main() {
 	bot.on_log(dpp::utility::cout_logger());
 
 	/* The event is fired when someone issues your commands */
-	bot.on_slashcommand([&bot](const dpp::slashcommand_t& event) {
+	bot.on_slashcommand([](const dpp::slashcommand_t& event) {
 		/* Check which command they ran */
 		if (event.command.get_command_name() == "math") {
 
@@ -40,7 +40,7 @@ int main() {
 		}
 	});
 
-	bot.on_button_click([&bot](const dpp::button_click_t & event) {
+	bot.on_button_click([](const dpp::button_click_t & event) {
 		if (event.custom_id == "10") {
 			event.reply(dpp::message("You got it right!").set_flags(dpp::m_ephemeral));
 		} else {

docpages/example_code/components3.cpp

@@ -7,7 +7,7 @@ int main() {
 	bot.on_log(dpp::utility::cout_logger());
 
 	/* The event is fired when someone issues your commands */
-	bot.on_slashcommand([&bot](const dpp::slashcommand_t& event) {
+	bot.on_slashcommand([](const dpp::slashcommand_t& event) {
 		/* Check which command they ran */
 		if (event.command.get_command_name() == "select") {
 			/* Create a message */
@@ -33,7 +33,7 @@ int main() {
 	/* When a user clicks your select menu , the on_select_click event will fire,
 	 * containing the custom_id you defined in your select menu.
 	 */
-	bot.on_select_click([&bot](const dpp::select_click_t & event) {
+	bot.on_select_click([](const dpp::select_click_t & event) {
 		/* Select clicks are still interactions, and must be replied to in some form to
 		 * prevent the "this interaction has failed" message from Discord to the user.
 		 */

docpages/example_code/components3_rolemenu.cpp

@@ -6,7 +6,7 @@ int main() {
 	bot.on_log(dpp::utility::cout_logger());
 
 	/* The event is fired when someone issues your commands */
-	bot.on_slashcommand([&bot](const dpp::slashcommand_t& event) {
+	bot.on_slashcommand([](const dpp::slashcommand_t& event) {
 		/* Check which command they ran */
 		if (event.command.get_command_name() == "select") {
 			/* Create a message */

docpages/example_code/default_select_value.cpp

@@ -7,7 +7,7 @@ int main() {
 	bot.on_log(dpp::utility::cout_logger());
 
 	/* The event is fired when someone issues your commands */
-	bot.on_slashcommand([&bot](const dpp::slashcommand_t& event) {
+	bot.on_slashcommand([](const dpp::slashcommand_t& event) {
 		/* Check which command they ran */
 		if (event.command.get_command_name() == "select") {
 			/* Create a message */

docpages/example_code/detecting_messages.cpp

@@ -7,7 +7,7 @@ int main() {
 	bot.on_log(dpp::utility::cout_logger());
 
 	/* The event is fired when the bot detects a message in any server and any channel it has access to. */
-	bot.on_message_create([&bot](const dpp::message_create_t& event) {
+	bot.on_message_create([](const dpp::message_create_t& event) {
 		/* See if the message contains the phrase we want to check for.
 		 * If there's at least a single match, we reply and say it's not allowed.
 		 */

docpages/example_code/editing_message_after_click.cpp

@@ -7,7 +7,7 @@ int main() {
 	bot.on_log(dpp::utility::cout_logger());
 
 	/* The event is fired when someone issues your commands */
-	bot.on_slashcommand([&bot](const dpp::slashcommand_t& event) {
+	bot.on_slashcommand([](const dpp::slashcommand_t& event) {
 		/* Check which command they ran */
 		if (event.command.get_command_name() == "button") {
 			/* Create a message */
@@ -33,7 +33,7 @@ int main() {
 	/* When a user clicks your button, the on_button_click event will fire,
 	 * containing the custom_id you defined in your button.
 	 */
-	bot.on_button_click([&bot](const dpp::button_click_t& event) {
+	bot.on_button_click([](const dpp::button_click_t& event) {
 		/* Instead of replying to the button click itself,
 		 * we want to update the message that had the buttons on it.
 		 */

docpages/example_code/editing_message_after_click2.cpp

@@ -7,7 +7,7 @@ int main() {
 	bot.on_log(dpp::utility::cout_logger());
 
 	/* The event is fired when someone issues your commands */
-	bot.on_slashcommand([&bot](const dpp::slashcommand_t& event) {
+	bot.on_slashcommand([](const dpp::slashcommand_t& event) {
 		/* Check which command they ran */
 		if (event.command.get_command_name() == "button") {
 			/* Create a message */
@@ -33,7 +33,7 @@ int main() {
 	/* When a user clicks your button, the on_button_click event will fire,
 	 * containing the custom_id you defined in your button.
 	 */
-	bot.on_button_click([&bot](const dpp::button_click_t& event) {
+	bot.on_button_click([](const dpp::button_click_t& event) {
 		/* Instead of replying to the button click itself,
 		 * we want to update the message that had the buttons on it.
 		 */

docpages/example_code/embeds.cpp

@@ -7,7 +7,7 @@ int main() {
 	bot.on_log(dpp::utility::cout_logger());
 
 	/* The event is fired when someone issues your commands */
-	bot.on_slashcommand([&bot](const dpp::slashcommand_t& event) {
+	bot.on_slashcommand([](const dpp::slashcommand_t& event) {
 		/* Check which command they ran */
 		if (event.command.get_command_name() == "embed") {
 			/* Create an embed */

docpages/example_code/ephemeral.cpp

@@ -7,7 +7,7 @@ int main() {
 	bot.on_log(dpp::utility::cout_logger());
 
 	/* The event is fired when someone issues your commands */
-	bot.on_slashcommand([&bot](const dpp::slashcommand_t & event) {
+	bot.on_slashcommand([](const dpp::slashcommand_t & event) {
 		/* Check which command they ran */
 		if (event.command.get_command_name() == "hello") {
 			/* Reply to the user, but only let them see the response. */

docpages/example_code/eval.cpp

@@ -75,7 +75,7 @@ int main() {
 			 * This code assumes the current directory is writeable. The file will have a
 			 * unique name made from the user's id and the message id.
 			 */
-        		std::string source_filename = std::to_string(event.msg.author.id) + "_" + std::to_string(event.msg.id) + ".cpp";
+			std::string source_filename = std::to_string(event.msg.author.id) + "_" + std::to_string(event.msg.id) + ".cpp";
 			std::fstream code_file(source_filename, std::fstream::binary | std::fstream::out);
 			if (!code_file.is_open()) {
 				bot.message_create(dpp::message(event.msg.channel_id, "Unable to create source file for `eval`"));
@@ -96,7 +96,7 @@ int main() {
 				std::to_string(event.msg.author.id) + "_" + std::to_string(event.msg.id) + ".cpp",
 				"-ldpp",
 				"-ldl"
-			}, [event, &bot, source_filename, compile_start](const std::string &output) {
+			}, [event, &bot, compile_start](const std::string &output) {
 
 				/* After g++ is ran we end up inside this lambda with the output as a string */
 				double compile_time = dpp::utility::time_f() - compile_start;

docpages/example_code/join_voice.cpp

@@ -9,7 +9,7 @@ int main() {
 	bot.on_log(dpp::utility::cout_logger());
 
 	/* The event is fired when someone issues your commands */
-	bot.on_slashcommand([&bot](const dpp::slashcommand_t& event) {
+	bot.on_slashcommand([](const dpp::slashcommand_t& event) {
 
 		/* Check which command they ran */
 		if (event.command.get_command_name() == "join") {

docpages/example_code/modal_dialog_interactions.cpp

@@ -6,7 +6,7 @@ int main() {
 
 	bot.on_log(dpp::utility::cout_logger());
 
-	bot.on_slashcommand([&bot](const dpp::slashcommand_t& event) {
+	bot.on_slashcommand([](const dpp::slashcommand_t& event) {
 		/* Check for our /dialog command */
 		if (event.command.get_command_name() == "dialog") {
 			/* Instantiate an interaction_modal_response object */

docpages/example_code/mp3.cpp

@@ -41,8 +41,8 @@ int main() {
 	mpg123_open(mh, MUSIC_FILE);
 	mpg123_getformat(mh, &rate, &channels, &encoding);
 
-	unsigned int counter = 0;
-	for (int totalBytes = 0; mpg123_read(mh, buffer, buffer_size, &done) == MPG123_OK; ) {
+	[[maybe_unused]] unsigned int counter = 0;
+	for ([[maybe_unused]] int totalBytes = 0; mpg123_read(mh, buffer, buffer_size, &done) == MPG123_OK; ) {
 		for (size_t i = 0; i < buffer_size; i++) {
 			pcmdata.push_back(buffer[i]);
 		}
@@ -59,7 +59,7 @@ int main() {
 	bot.on_log(dpp::utility::cout_logger());
 
 	/* The event is fired when someone issues your commands */
-	bot.on_slashcommand([&bot, &pcmdata](const dpp::slashcommand_t& event) {
+	bot.on_slashcommand([&pcmdata](const dpp::slashcommand_t& event) {
 		/* Check which command they ran */
 		if (event.command.get_command_name() == "join") {
 			/* Get the guild */

docpages/example_code/oggopus.cpp

@@ -20,7 +20,7 @@ int main(int argc, char const *argv[]) {
 	bot.on_log(dpp::utility::cout_logger());
 
 	/* The event is fired when someone issues your commands */
-	bot.on_slashcommand([&bot](const dpp::slashcommand_t& event) {
+	bot.on_slashcommand([](const dpp::slashcommand_t& event) {
 
 		/* Check which command they ran */
 		if (event.command.get_command_name() == "join") {