Task coroutine

.github/workflows/build.yml

@@ -21,7 +21,7 @@ jobs:
     timeout-minutes: 15
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
       with:
           submodules: true
 

CMakeLists.txt

@@ -34,6 +34,7 @@ if(NOT DEFINED GAP_MASTER_PROJECT)
 endif()
 
 include(project_settings)
+include(utils)
 
 # adds header paths of library to list named var
 function(add_headers lib var)
@@ -44,6 +45,15 @@ function(add_headers lib var)
   set(${var} ${headers} PARENT_SCOPE)
 endfunction()
 
+# adds source paths of library to list named var
+function(add_sources lib var)
+  set(sources ${${var}})
+  foreach (source ${ARGN})
+    set(sources ${sources} ${CMAKE_CURRENT_SOURCE_DIR}/src/${source})
+  endforeach()
+  set(${var} ${sources} PARENT_SCOPE)
+endfunction()
+
 #
 # CCACHE
 #
@@ -91,9 +101,12 @@ endif()
 #
 
 add_subdirectory(core)
+add_subdirectory(coro)
+add_subdirectory(graph)
 
 set(GAP_HEADERS
   ${GAP_CORE_HEADERS}
+  ${GAP_CORO_HEADERS}
 )
 
 add_library(gap INTERFACE)
@@ -102,6 +115,7 @@ add_library(gap::gap ALIAS gap)
 target_link_libraries(gap
   INTERFACE
     gap-core
+    gap-coro
     gap-settings
 )
 
@@ -118,15 +132,6 @@ if (GAP_ENABLE_TESTING)
   add_subdirectory(test)
 endif ()
 
-#
-# examples
-#
-option(GAP_ENABLE_EXAMPLES "Enable GAP Examples Builds" ON)
-
-if (GAP_ENABLE_EXAMPLES)
-  add_subdirectory(examples)
-endif ()
-
 #
 # instalation support
 #
@@ -144,31 +149,14 @@ set_target_properties(${PROJECT_NAME}
 if (GAP_INSTALL)
   set(GAP_CMAKE_INSTALL_DIR ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME} CACHE PATH "Path where CMake utilities will be installed")
 
-  set(GAP_INSTALL_TARGETS gap gap-core gap-settings)
+  set(GAP_INSTALL_TARGETS gap gap-core gap-coro gap-settings)
   set(GAP_EXPORT_NAME gapTargets)
 
-  install(TARGETS ${GAP_INSTALL_TARGETS}
-    EXPORT ${GAP_EXPORT_NAME}
-    RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
-    LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
-      NAMELINK_SKIP
-    ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
-    PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/gap/core
-  )
-
-  install(EXPORT ${GAP_EXPORT_NAME}
-    FILE ${GAP_EXPORT_NAME}.cmake
-    NAMESPACE gap::
-    DESTINATION ${GAP_CMAKE_INSTALL_DIR}
-  )
-
-  install(TARGETS ${GAP_INSTALL_TARGETS}
-    RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
-    LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
-      NAMELINK_ONLY
-    ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
-    PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/gap/core
-  )
+  install_gap_target(gap core)
+  install_gap_target(gap-core core)
+  install_gap_target(gap-settings core)
+  install_gap_target(gap-coro coro)
+  install_gap_target(gap-graph graph)
 
   #
   # packaging support

cmake/utils.cmake

@@ -0,0 +1,62 @@
+function(add_gap_library name headers)
+	add_library(${name} INTERFACE)
+
+	add_library(gap::${name} ALIAS ${name})
+
+	target_compile_features(${name} INTERFACE cxx_std_20)
+
+	target_include_directories(${name}
+		INTERFACE
+			$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
+	    	$<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>
+	)
+
+	set_target_properties(${name} PROPERTIES PUBLIC_HEADER "${headers}")
+
+	target_link_libraries(${name} INTERFACE gap-settings)
+endfunction()
+
+function(add_gap_static_library name headers sources)
+	add_library(${name} STATIC ${sources})
+
+	add_library(gap::${name} ALIAS ${name})
+
+	target_compile_features(${name} INTERFACE cxx_std_20)
+
+	target_include_directories(${name}
+		PUBLIC
+			$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
+	    	$<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>
+	)
+
+	set_target_properties(${name} PROPERTIES PUBLIC_HEADER "${headers}")
+
+	target_link_libraries(${name} INTERFACE gap-settings)
+endfunction()
+
+function(install_gap_target name include_dir)
+	set(GAP_EXPORT_NAME gapTargets)
+
+	install(TARGETS ${name}
+		EXPORT ${GAP_EXPORT_NAME}
+		RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
+		LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+			NAMELINK_SKIP
+		ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
+		PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/gap/${include_dir}
+	)
+
+	install(EXPORT ${GAP_EXPORT_NAME}
+		FILE ${GAP_EXPORT_NAME}.cmake
+		NAMESPACE gap::
+		DESTINATION ${GAP_CMAKE_INSTALL_DIR}
+	)
+
+	install(TARGETS ${name}
+		RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
+		LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+			NAMELINK_ONLY
+		ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
+		PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/gap/${include_dir}
+	)
+endfunction()

core/CMakeLists.txt

@@ -24,18 +24,4 @@ add_headers(core GAP_CORE_HEADERS
 	union_find.hpp
 )
 
-add_library(gap-core INTERFACE)
-
-add_library(gap::gap-core ALIAS gap-core)
-
-target_compile_features(gap-core INTERFACE cxx_std_20)
-
-target_include_directories(gap-core
-	INTERFACE
-		$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
-    	$<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>
-)
-
-set_target_properties(gap-core PROPERTIES PUBLIC_HEADER "${GAP_CORE_HEADERS}")
-
-target_link_libraries(gap-core INTERFACE gap-settings)
+add_gap_library(gap-core "${GAP_CORE_HEADERS}")

core/include/gap/core/config.hpp

@@ -44,3 +44,17 @@
         #define GAP_COROHEADER_FOUND_AND_USABLE
     #endif
 #endif
+
+#if GAP_COMPILER_MSVC
+# define GAP_NOINLINE __declspec(noinline)
+#elif GAP_COMPILER_CLANG || GAP_COMPILER_GCC
+# define GAP_NOINLINE __attribute__((noinline))
+#endif
+
+#if GAP_COMPILER_MSVC
+# define GAP_FORCE_INLINE __forceinline
+#elif GAP_COMPILER_CLANG
+# define GAP_FORCE_INLINE __attribute__((always_inline))
+#else
+# define GAP_FORCE_INLINE inline
+#endif

core/include/gap/core/coroutine.hpp

@@ -1,41 +1,5 @@
-// Copyright (c) 2021-present, Trail of Bits, Inc.
+// Copyright (c) 2024, Trail of Bits, Inc.
 
 #pragma once
 
-#ifdef GAP_ENABLE_COROUTINES
-
-    #include "gap/core/config.hpp"
-
-    #ifdef GAP_COROHEADER_FOUND_AND_USABLE
-
-        #include <coroutine>
-
-namespace gap
-{
-    using std::coroutine_handle;
-    using std::noop_coroutine;
-    using std::suspend_always;
-    using std::suspend_never;
-
-} // namespace gap
-
-    #elif __has_include(<experimental/coroutine>)
-
-        #include <experimental/coroutine>
-
-namespace gap
-{
-    using std::experimental::coroutine_handle;
-    using std::experimental::suspend_always;
-    using std::experimental::suspend_never;
-
-        #if GAP_COMPILER_SUPPORTS_SYMMETRIC_TRANSFER
-    using std::experimental::noop_coroutine;
-        #endif
-} // namespace gap
-
-    #else
-        #error gap requires a C++20 compiler with coroutine support
-    #endif
-
-#endif
+#error "The gap/core/coroutine.hpp header was deprecated and removed. Please update your include paths to use gap/coro/coroutine.hpp instead."