Merge branch 'feature/msvc-win32-support' into develop

Author: vector-of-bool

.clang-format

@@ -62,23 +62,41 @@ SpaceBeforeAssignmentOperators: true
 ContinuationIndentWidth: 4
 CommentPragmas: "^ IWYU pragma:"
 SpaceBeforeParens: ControlStatements
+SortIncludes: CaseSensitive
 DisableFormat: false
 IncludeBlocks: Regroup
 IncludeCategories:
   - Regex: '"\.' # Relative headers
     Priority: 10
   - Regex: '<amongoc/|"amongoc/' # amongoc headers first
     Priority: 20
-  - Regex: '<bson/|"bson/' # bson headers next
+  - Regex: "<bson/" # bson headers next
     Priority: 25
-  - Regex: '<mlib/|"mlib/' # mlib headers next
+  - Regex: "<mlib/" # mlib headers next
     Priority: 30
   - Regex: '<.*/.*\.h>|<.*/.*\.hpp>' # Other non-standard headres
     Priority: 40
   - Regex: '<.*\.h>|<.*\.hpp>' # Other non-standard headres
     Priority: 50
   - Regex: '<[[:alnum:]_.]+>|<std.*\.h>' # Standard headres
     Priority: 60
+  # Unix platform headers
+  - Regex: '<(unistd|netdb|pthread|netinet/.*|sys/.*|netdb|fcntl|arpa/.*|resolv|sched|poll)\.h>'
+    Priority: 90
+  # Darwin platform headers
+  - Regex: '<(Availability|AvailabilityMacros|TargetConditionals|CommonCrypto/.*|Security/.*|CoreFoundation/.*)\.h>'
+    CaseSensitive: false
+    Priority: 90
+  # Windows platform headers
+  - Regex: '<(win(dows|sock2|error|trnl|error|crypt|ver|dns)|sspi|ws2tcpip|ntstatus|mstcpip|process)\.h>'
+    CaseSensitive: false
+    Priority: 90
+  # Standard library headers are near last
+  - Regex: "<(assert|string|ctype|limits|time|math|errno|inttypes|signal).h>|<std|<[^.]+>"
+    Priority: 100
+  # Other -I headers get sorted before platform headers
+  - Regex: "<"
+    Priority: 80
 InsertNewlineAtEOF: true
 IfMacros:
   - mlib_math_catch

CMakeLists.txt

@@ -3,6 +3,11 @@ project(amongoc VERSION 0.1.0 DESCRIPTION "An Asynchronous MongoDB Library for C
 
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/tools")
 
+# Declare that we are compiling with C++23 before we proceed. This must be near
+# the top before we import other libraries that might depend on our toolchain
+# settings (e.g. Catch2)
+set(CMAKE_CXX_STANDARD 23)
+
 # Pull our deps with PMM+vcpkg
 option(AMONGOC_USE_PMM "Enable PMM execution to bootstrap dependency packages automatically" ${PROJECT_IS_TOP_LEVEL})
 if(AMONGOC_USE_PMM)
@@ -24,6 +29,12 @@ find_package(Threads REQUIRED)
 # Note: We respect the BUILD_TESTING option from CTest.cmake
 include(CTest)
 
+# Tweak some options if we are added as a subdirectory project
+if(NOT PROJECT_IS_TOP_LEVEL)
+    # We aren't the top-level project. Don't define test cases
+    set(BUILD_TESTING FALSE)
+endif()
+
 if(BUILD_TESTING)
     find_package(Catch2 CONFIG REQUIRED)
 endif()
@@ -56,14 +67,12 @@ if(PROJECT_IS_TOP_LEVEL)
     )
 endif()
 
-# Tweak some options if we are added as a subdirectory project
-if(NOT PROJECT_IS_TOP_LEVEL)
-    # We aren't the top-level project. Don't define test cases
-    set(BUILD_TESTING FALSE)
-endif()
-
-# When compiling C++ with GCC, set a deeper diagnostics depth
-add_compile_options($<$<AND:$<CXX_COMPILER_ID:GNU>,$<COMPILE_LANGUAGE:CXX>>:-fconcepts-diagnostics-depth=4>)
+add_compile_options(
+    # When compiling C++ with GCC, set a deeper diagnostics depth
+    $<$<AND:$<CXX_COMPILER_ID:GNU>,$<COMPILE_LANGUAGE:CXX>>:-fconcepts-diagnostics-depth=4>
+    # Enable large object files with MSVC
+    $<$<CXX_COMPILER_ID:MSVC>:/bigobj>
+)
 
 # If we generate any DLLs, use a .dll.lib suffix for the importlibs, to distinguish
 # them from actual static libraries
@@ -125,7 +134,19 @@ target_compile_definitions(amongoc PRIVATE NEO_ENABLE_CHECKS=0)
 # Enable C++23 features on the target
 # We currently only use C++23 for `auto(). Future revisions
 # can remove these requirements for greater portability.
-target_compile_features(amongoc PRIVATE cxx_std_23)
+target_compile_features(amongoc PRIVATE cxx_std_23 PUBLIC cxx_std_20 c_std_11)
+
+# Tweaks for MSVC/Windows
+target_compile_options(amongoc
+    PUBLIC
+        # Enable the conforming preprocessor
+        $<$<C_COMPILER_ID:MSVC>:/Zc:preprocessor>
+    PRIVATE
+        # Add caret diagnostics, they're prettier
+        $<$<CXX_COMPILER_ID:MSVC>:/diagnostics:caret>
+    )
+# Set the Windows SDK target to Windows 7+
+add_compile_definitions($<$<PLATFORM_ID:Windows>:_WIN32_WINNT=0x601>)
 
 # Link deps and platform libs.
 target_link_libraries(amongoc
@@ -155,7 +176,9 @@ if(BUILD_TESTING)
         )
     target_include_directories(amongoc-test PRIVATE src)
     catch_discover_tests(amongoc-test DISCOVERY_MODE PRE_TEST
-        PROPERTIES SKIP_REGULAR_EXPRESSION ":[0-9]+: SKIPPED:"
+        PROPERTIES
+            SKIP_REGULAR_EXPRESSION ":[0-9]+: SKIPPED:"
+            TIMEOUT 5
         )
     target_compile_features(amongoc-test PRIVATE cxx_std_23)
 

docs/how-to/communicate.example.c

@@ -5,6 +5,8 @@
 #include <bson/mut.h>
 #include <bson/view.h>
 
+#include <time.h>
+
 /**
  * @brief Shared state for the application. This is passed through the app as pointer stored
  * in a box
@@ -21,8 +23,9 @@ typedef struct app_state {
  * @param resp_data A `bson_mut` object that contains the response message
  * @return amongoc_box Returns `amongoc_nil`
  */
-amongoc_box after_hello(amongoc_box state_ptr, amongoc_status*, amongoc_box resp_data) {
-    (void)state_ptr;
+amongoc_box after_hello(amongoc_box _state_ptr, amongoc_status* _status, amongoc_box resp_data) {
+    (void)_status;
+    (void)_state_ptr;
     bson_view resp = bson_view_from(amongoc_box_cast(bson_doc, resp_data));
     // Just print the response message
     fprintf(stdout, "Got response: ");
@@ -40,7 +43,9 @@ amongoc_box after_hello(amongoc_box state_ptr, amongoc_status*, amongoc_box resp
  * @param cl_box An `amongoc_client*`
  * @return amongoc_emitter
  */
-amongoc_emitter after_connect_say_hello(amongoc_box state_ptr, amongoc_status, amongoc_box cl_box) {
+amongoc_emitter
+after_connect_say_hello(amongoc_box state_ptr, amongoc_status _status, amongoc_box cl_box) {
+    (void)_status;
     printf("Connected to server\n");
     // Store the connection in our app state
     amongoc_box_take(amongoc_box_cast(app_state*, state_ptr)->client, cl_box);

docs/how-to/looping.example.c

@@ -2,6 +2,7 @@
 
 #include <stdio.h>
 #include <stdlib.h>
+#include <time.h>
 
 /**
  * @brief State for the program
@@ -32,7 +33,7 @@ amongoc_emitter loop_step(amongoc_box    state_ptr,  //
     uint64_t sum = s->a + s->b;
     s->a         = s->b;
     s->b         = sum;
-    fprintf(stderr, "%d seconds remain, current value: %lu\n", s->countdown, cur);
+    fprintf(stderr, "%d seconds remain, current value: %" PRIu64 "\n", s->countdown, cur);
     // Check if we are done
     if (s->countdown == 0) {
         // No more looping to do. Return a final result
@@ -88,6 +89,6 @@ int main(int argc, char const* const* argv) {
         return 2;
     }
     // Get the value returned with `amongoc_just` in `loop_step`
-    printf("Got final value: %lu\n", amongoc_box_cast(uint64_t, result));
+    printf("Got final value: %" PRIu64 "\n", amongoc_box_cast(uint64_t, result));
     return 0;
 }

include/amongoc/box.h

@@ -82,7 +82,7 @@ struct _amongoc_dynamic_box {
     mlib_allocator         alloc;
     amongoc_box_destructor destroy;
     size_t                 alloc_size;
-    mlib_alignas(max_align_t) char object[1];
+    mlib_alignas(intmax_t) char object[1];
 };
 
 union _amongoc_box_union {
@@ -92,7 +92,7 @@ union _amongoc_box_union {
 };
 
 struct _amongoc_box_storage {
-    alignas(max_align_t) union _amongoc_box_union u;
+    alignas(intmax_t) union _amongoc_box_union u;
     // Non-zero if the box storage is dynamically allocated
     unsigned char is_dynamic : 1;
     // Non-zero if the box has an associated destructor function

include/amongoc/collection.h

@@ -32,9 +32,9 @@ mlib_extern_c_begin();
  */
 #define amongoc_collection_new(Client, DbName, CollName)                                           \
     amongoc_collection_new(Client, mlib_str_view_from(DbName), mlib_str_view_from(CollName))
-amongoc_collection*(amongoc_collection_new)(amongoc_client* cl,
-                                            mlib_str_view   db_name,
-                                            mlib_str_view   coll_name)mlib_noexcept;
+amongoc_collection*(amongoc_collection_new)(amongoc_client * cl,
+                                            mlib_str_view db_name,
+                                            mlib_str_view coll_name) mlib_noexcept;
 
 /**
  * @brief Delete a collection handle. Is a no-op for null handles.

include/amongoc/handler.hpp

@@ -52,7 +52,7 @@ class handler_stop_token {
         }
 
         // The function object to be called
-        [[no_unique_address]] F _fn;
+        mlib_no_unique_address F _fn;
         // The stop registration cookie
         unique_box _reg_cookie;
     };
@@ -141,8 +141,8 @@ struct unique_handler : mlib::unique<::amongoc_handler> {
     // Implement the wrapper for invocable objects, used by from()
     template <typename R>
     struct wrapper {
-        mlib::allocator<>       _alloc;
-        [[no_unique_address]] R _fn;
+        mlib::allocator<>        _alloc;
+        mlib_no_unique_address R _fn;
         AMONGOC_TRIVIALLY_RELOCATABLE_THIS(amongoc::enable_trivially_relocatable_v<R>, wrapper);
 
         static void _complete(amongoc_handler* self, status st, box result) noexcept {
@@ -169,7 +169,7 @@ struct unique_handler : mlib::unique<::amongoc_handler> {
         explicit wrapper(mlib::allocator<>, R&& r)
             : _fn(mlib_fwd(r)) {}
 
-        [[no_unique_address]] R _fn;
+        mlib_no_unique_address R _fn;
         AMONGOC_TRIVIALLY_RELOCATABLE_THIS(amongoc::enable_trivially_relocatable_v<R>, wrapper);
 
         static void _complete(amongoc_handler* self, status st, box result) noexcept {

include/bson/detail/assert.h

@@ -35,7 +35,8 @@ enum {
         _bson_assert_fail(#Cond, __FILE__, __LINE__);                                              \
         abort();                                                                                   \
     } else if (!(Cond)) {                                                                          \
-        __builtin_unreachable();                                                                   \
+        MLIB_IF_MSVC(__assume(0));                                                                 \
+        MLIB_IF_GNU_LIKE(__builtin_unreachable());                                                 \
     } else                                                                                         \
         ((void)0)
 

include/bson/make.hpp

@@ -266,7 +266,9 @@ explicit range(R&&) -> range<R>;
  */
 template <typename... Els>
 struct doc : doc<std::index_sequence_for<Els...>, Els...> {
-    using doc<std::index_sequence_for<Els...>, Els...>::doc;
+    template <typename... Es>
+    explicit doc(Es&&... es)
+        : doc<std::index_sequence_for<Els...>, Els...>(mlib_fwd(es)...) {}
 };
 
 template <std::size_t N, typename Elem>

include/bson/mut.h

@@ -64,7 +64,7 @@ inline uint32_t bson_mut_capacity(bson_mut d) mlib_noexcept {
  * @param pos An element iterator
  */
 inline bson_byte* _bson_mut_data_at(bson_mut doc, bson_iterator pos) mlib_noexcept {
-    const ssize_t off = bson_iterator_data(pos) - bson_data(doc);
+    const ptrdiff_t off = bson_iterator_data(pos) - bson_data(doc);
     return bson_mut_data(doc) + off;
 }
 
@@ -97,7 +97,7 @@ inline bson_byte* _bson_splice_region(bson_mut* const        mut,
                                       const bson_byte* const insert_from) mlib_noexcept {
     // The offset of the position. We use this to later recover a pointer upon
     // reallocation
-    const ssize_t pos_offset = position - bson_data(*mut);
+    const ptrdiff_t pos_offset = position - bson_data(*mut);
     //  Check that we aren't splicing within our document header:
     BV_ASSERT(pos_offset >= 4);
     // Check that we aren't splicing at/beyond the doc's null terminator: