vcpkg and CMake refinements

Decouple from snmalloc headers and add shared library (DLL) support

- Introduce include/trieste/compiler.h with self-contained TRIESTE_SLOW_PATH,
  TRIESTE_FAST_PATH, TRIESTE_LIKELY/UNLIKELY, and TRIESTE_USED_FUNCTION macros,
  replacing all uses of snmalloc/ds_core/defines.h macros throughout the
  headers (ast.h, intrusive_ptr.h, logging.h, pass.h, rewrite.h, wf.h).

- Make snmalloc an optional dependency controlled by TRIESTE_USE_SNMALLOC.
  When disabled, the core library no longer fetches or links snmalloc at all.
  The vcpkg port moves snmalloc from a hard dependency to an opt-in "snmalloc"
  feature.

- Add DLL export support for the JSON and YAML parser libraries:
  - Use CMake's GenerateExportHeader to produce json_export.h / yaml_export.h.
  - Annotate all public API functions with JSON_EXPORT / YAML_EXPORT.
  - Define JSON_STATIC_DEFINE / YAML_STATIC_DEFINE for static builds.
  - Rename output libraries to trieste-json / trieste-yaml.
  - Add a Windows shared-libs CI job (BUILD_SHARED_LIBS=ON).

- CMake modernisation:
  - Use native EXCLUDE_FROM_ALL on CMake 3.28+ instead of always fetching
    cmake_utils; emit a deprecation warning for CMake < 3.28.
  - Guard header installs on non-Debug builds to avoid installing into Debug
    prefixes.
  - Only define the clangformat target when snmalloc is available (it
    provides the clangformat_targets macro).

- vcpkg port fixes:
  - Prefix release tag refs with "v" to match actual Git tags.
  - Drop redundant PACKAGE_NAME from vcpkg_cmake_config_fixup.
  - Add "supports": "!x86" platform constraint.

- Fix C++17 compatibility in yaml reader (replace std::set::contains with
  find/end).

- Bump VERSION to 1.1.0.

Signed-off-by: Matthew A Johnson <matjoh@microsoft.com>

Author: matajoh

.github/workflows/buildtest.yml

@@ -35,6 +35,11 @@ jobs:
           variant:  "build-parser-tests"
           build-type: "Release"
           cmake-options: "-DTRIESTE_BUILD_PARSER_TESTS=1"
+
+        - platform: "windows-latest"
+          variant: "shared-libs"
+          build-type: "Release"
+          cmake-options: "-DBUILD_SHARED_LIBS=ON"
 
         - platform: "macos-latest"
           variant:  "build-parser-tests"

CMakeLists.txt

@@ -34,8 +34,8 @@ if(GIT_FOUND)
     list(GET TRIESTE_GIT_LOG_LIST 2 TRIESTE_BUILD_DATE)
   else()
     set(TRIESTE_GIT_HASH "unknown")
-    set(TRIESTE_GIT_SHORT_HASH "unknown")
-    set(TRIESTE_BUILD_DATE "unknown")
+    set(TRIESTE_GIT_SHORT_HASH "v${TRIESTE_VERSION}")
+    string(TIMESTAMP TRIESTE_BUILD_DATE "%a, %d %b %Y %H:%M:%S %z")
   endif()
   execute_process(
     COMMAND ${GIT_EXECUTABLE} rev-parse --abbrev-ref HEAD
@@ -48,8 +48,8 @@ else()
   message(STATUS "Git not found; version metadata will be 'unknown'")
   set(TRIESTE_GIT_HASH "unknown")
   set(TRIESTE_GIT_BRANCH "unknown")
-  set(TRIESTE_GIT_SHORT_HASH "unknown")
-  set(TRIESTE_BUILD_DATE "unknown")
+  set(TRIESTE_GIT_SHORT_HASH "v${TRIESTE_VERSION}")
+  string(TIMESTAMP TRIESTE_BUILD_DATE "%a, %d %b %Y %H:%M:%S %z")
 endif()
 
 set(TRIESTE_BUILD_TOOLCHAIN "${CMAKE_CXX_COMPILER_ID} ${CMAKE_CXX_COMPILER_VERSION}")
@@ -99,50 +99,85 @@ set(TRIESTE_SANITIZE "" CACHE STRING "Argument to pass to sanitize (disabled by
 if(TRIESTE_USE_FETCH_CONTENT)
   include(FetchContent)
 
-  set(SNMALLOC_BUILD_TESTING OFF CACHE INTERNAL "Turn off snmalloc tests")
-  set(SNMALLOC_USE_CXX17 ${TRIESTE_USE_CXX17})
-
-  # Used to provide
-  #  FetchContent_MakeAvailable_ExcludeFromAll
-  FetchContent_Declare(
+  # CMake 3.28+ supports EXCLUDE_FROM_ALL on FetchContent_Declare natively.
+  # For older versions, we fall back to cmake_utils which provides
+  # FetchContent_MakeAvailable_ExcludeFromAll.
+  if(CMAKE_VERSION VERSION_LESS "3.28")
+    message(WARNING
+      "CMake < 3.28 detected. Support for CMake versions below 3.28 is "
+      "deprecated and will be removed in a future release. Please upgrade.")
+    FetchContent_Declare(
       cmake_utils
       GIT_REPOSITORY https://github.com/mjp41/cmake_utils
       GIT_TAG 2bf98b5773ea7282197c823e205547d8c2e323c0
       GIT_SHALLOW FALSE
-  )
-
-  FetchContent_MakeAvailable(cmake_utils)
+    )
+    FetchContent_MakeAvailable(cmake_utils)
+  endif()
 
-  FetchContent_Declare(
-    snmalloc
-    GIT_REPOSITORY https://github.com/microsoft/snmalloc
-    GIT_TAG 1c7a93aad54198423944a786da9dad3962134f75
-    # per https://gitlab.kitware.com/cmake/cmake/-/issues/17770, do not use GIT_SHALLOW here
-    # or it will silently break new builds days later, once the commit hash above no longer
-    # matches a named branch, like main.
-    # Tracking a named branch with GIT_SHALLOW enabled is ok, however.
-    # GIT_SHALLOW TRUE
-  )
+  # Wrapper: use EXCLUDE_FROM_ALL on 3.28+, fall back to cmake_utils otherwise.
+  macro(trieste_fetch_content_make_available target)
+    if(CMAKE_VERSION VERSION_LESS "3.28")
+      FetchContent_MakeAvailable_ExcludeFromAll(${target})
+    else()
+      FetchContent_MakeAvailable(${target})
+    endif()
+  endmacro()
+
+  if(TRIESTE_USE_SNMALLOC)
+    set(SNMALLOC_BUILD_TESTING OFF CACHE INTERNAL "Turn off snmalloc tests")
+    set(SNMALLOC_USE_CXX17 ${TRIESTE_USE_CXX17})
+
+    set(_snmalloc_extra_args "")
+    if(NOT CMAKE_VERSION VERSION_LESS "3.28")
+      list(APPEND _snmalloc_extra_args EXCLUDE_FROM_ALL)
+    endif()
+
+    FetchContent_Declare(
+      snmalloc
+      GIT_REPOSITORY https://github.com/microsoft/snmalloc
+      GIT_TAG 1c7a93aad54198423944a786da9dad3962134f75
+      ${_snmalloc_extra_args}
+      # per https://gitlab.kitware.com/cmake/cmake/-/issues/17770, do not use GIT_SHALLOW here
+      # or it will silently break new builds days later, once the commit hash above no longer
+      # matches a named branch, like main.
+      # Tracking a named branch with GIT_SHALLOW enabled is ok, however.
+      # GIT_SHALLOW TRUE
+    )
+
+    trieste_fetch_content_make_available(snmalloc)
+
+    set(TRIESTE_SNMALLOC_TARGET snmalloc)
+    set(TRIESTE_SNMALLOC_OVERRIDE_TARGET snmalloc-new-override)
+  else()
+    set(TRIESTE_SNMALLOC_TARGET "")
+    set(TRIESTE_SNMALLOC_OVERRIDE_TARGET "")
+  endif()
 
-  FetchContent_MakeAvailable_ExcludeFromAll(snmalloc)
+  set(_cli11_extra_args "")
+  if(NOT CMAKE_VERSION VERSION_LESS "3.28")
+    list(APPEND _cli11_extra_args EXCLUDE_FROM_ALL)
+  endif()
 
   FetchContent_Declare(
     cli11
     GIT_REPOSITORY https://github.com/CLIUtils/CLI11
     GIT_TAG 4160d259d961cd393fd8d67590a8c7d210207348
     GIT_SHALLOW TRUE
+    ${_cli11_extra_args}
   )
 
-  FetchContent_MakeAvailable_ExcludeFromAll(cli11)
-
-  set(TRIESTE_SNMALLOC_TARGET snmalloc)
-  set(TRIESTE_SNMALLOC_OVERRIDE_TARGET snmalloc-new-override)
+  trieste_fetch_content_make_available(cli11)
 else()
-  find_package(snmalloc CONFIG REQUIRED)
-  find_package(CLI11 CONFIG REQUIRED)
-
-  set(TRIESTE_SNMALLOC_TARGET snmalloc::snmalloc)
+  if(TRIESTE_USE_SNMALLOC)
+    find_package(snmalloc CONFIG REQUIRED)
+    set(TRIESTE_SNMALLOC_TARGET snmalloc::snmalloc)
+  else()
+    set(TRIESTE_SNMALLOC_TARGET "")
+  endif()
   set(TRIESTE_SNMALLOC_OVERRIDE_TARGET "")
+
+  find_package(CLI11 CONFIG REQUIRED)
 endif()
 
 # #############################################
@@ -162,14 +197,17 @@ target_include_directories(trieste
 target_link_libraries(trieste
   INTERFACE
   CLI11::CLI11
-  ${TRIESTE_SNMALLOC_TARGET}
 )
 
-if(TRIESTE_USE_SNMALLOC AND TRIESTE_SNMALLOC_OVERRIDE_TARGET)
-  if(TRIESTE_SANITIZE)
-    message(WARNING "Sanitizers are not supported with snmalloc, disabling snmalloc.")
-  else()
-    target_link_libraries(trieste INTERFACE ${TRIESTE_SNMALLOC_OVERRIDE_TARGET})
+if(TRIESTE_USE_SNMALLOC)
+  target_link_libraries(trieste INTERFACE ${TRIESTE_SNMALLOC_TARGET})
+
+  if(TRIESTE_SNMALLOC_OVERRIDE_TARGET)
+    if(TRIESTE_SANITIZE)
+      message(WARNING "Sanitizers are not supported with snmalloc, disabling snmalloc.")
+    else()
+      target_link_libraries(trieste INTERFACE ${TRIESTE_SNMALLOC_OVERRIDE_TARGET})
+    endif()
   endif()
 endif()
 
@@ -212,9 +250,12 @@ if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
 endif()
 
 if(TRIESTE_USE_FETCH_CONTENT)
-  set(INSTALL_DEPS ${TRIESTE_SNMALLOC_TARGET} CLI11)
-  if (TRIESTE_USE_SNMALLOC AND TRIESTE_SNMALLOC_OVERRIDE_TARGET)
-    list(APPEND INSTALL_DEPS ${TRIESTE_SNMALLOC_OVERRIDE_TARGET})
+  set(INSTALL_DEPS CLI11)
+  if(TRIESTE_USE_SNMALLOC)
+    list(APPEND INSTALL_DEPS ${TRIESTE_SNMALLOC_TARGET})
+    if(TRIESTE_SNMALLOC_OVERRIDE_TARGET)
+      list(APPEND INSTALL_DEPS ${TRIESTE_SNMALLOC_OVERRIDE_TARGET})
+    endif()
   endif()
 else()
   set(INSTALL_DEPS "")
@@ -250,11 +291,13 @@ install(FILES ${PROJECT_BINARY_DIR}/${PROJECT_NAME}Config.cmake
   ${PROJECT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake
   DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/${PROJECT_NAME}/cmake)
 
-install(DIRECTORY ${PROJECT_SOURCE_DIR}/include/trieste DESTINATION include
-  PATTERN "*.in" EXCLUDE)
+if(NOT CMAKE_BUILD_TYPE STREQUAL "Debug")
+  install(DIRECTORY ${PROJECT_SOURCE_DIR}/include/trieste DESTINATION include
+    PATTERN "*.in" EXCLUDE)
 
-install(FILES ${CMAKE_CURRENT_BINARY_DIR}/include/trieste/version.h
-  DESTINATION include/trieste)
+  install(FILES ${CMAKE_CURRENT_BINARY_DIR}/include/trieste/version.h
+    DESTINATION include/trieste)
+endif()
 
 # #############################################
 # # Exporting from the build tree
@@ -267,7 +310,7 @@ export(PACKAGE trieste)
 
 # #############################################
 # # Formatting targets
-if(TRIESTE_USE_FETCH_CONTENT)
+if(TRIESTE_USE_FETCH_CONTENT AND TRIESTE_USE_SNMALLOC)
   clangformat_targets(
     VERSION 18
     INCLUDE_PATTERNS include/*.h include/*.cc parsers/*.cc parsers/*.h samples/*.cc samples/*.h test/*.cc test/*.h

VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

include/trieste/ast.h

@@ -778,7 +778,7 @@ namespace trieste
     /*
      * Useful for calling from inside a debugger.
      */
-    std::string SNMALLOC_USED_FUNCTION str()
+    std::string TRIESTE_USED_FUNCTION str()
     {
       std::ostringstream out;
       str(out);
@@ -837,7 +837,7 @@ namespace trieste
      * passed to the action, but not above.
      */
     template<typename Pre, typename Post = NopPost>
-    SNMALLOC_FAST_PATH void traverse(Pre pre, Post post = NopPost())
+    TRIESTE_FAST_PATH void traverse(Pre pre, Post post = NopPost())
     {
       Node root = intrusive_ptr_from_this();
       if (!pre(root))

include/trieste/compiler.h

@@ -0,0 +1,38 @@
+#pragma once
+
+/**
+ * @file compiler.h
+ * @brief Compiler hint macros for Trieste.
+ *
+ * Provides portable macros for inlining hints and branch prediction.
+ * These are self-contained and do not depend on any external library.
+ */
+
+#if defined(_MSC_VER) && !defined(__clang__)
+#  define TRIESTE_SLOW_PATH __declspec(noinline)
+#  define TRIESTE_FAST_PATH __forceinline
+#  define TRIESTE_FAST_PATH_INLINE __forceinline
+#  define TRIESTE_LIKELY(x) (!!(x))
+#  define TRIESTE_UNLIKELY(x) (!!(x))
+#  define TRIESTE_USED_FUNCTION
+#  if _MSC_VER >= 1927 && _MSVC_LANG > 201703L
+#    define TRIESTE_FAST_PATH_LAMBDA [[msvc::forceinline]]
+#  else
+#    define TRIESTE_FAST_PATH_LAMBDA
+#  endif
+#else
+#  define TRIESTE_SLOW_PATH __attribute__((noinline))
+#  define TRIESTE_FAST_PATH __attribute__((always_inline))
+#  define TRIESTE_FAST_PATH_INLINE __attribute__((always_inline)) inline
+#  define TRIESTE_LIKELY(x) __builtin_expect(!!(x), 1)
+#  define TRIESTE_UNLIKELY(x) __builtin_expect(!!(x), 0)
+#  define TRIESTE_USED_FUNCTION __attribute__((used))
+#  define TRIESTE_FAST_PATH_LAMBDA __attribute__((always_inline))
+#endif
+
+namespace trieste
+{
+  template<typename... Args>
+  TRIESTE_FAST_PATH_INLINE void UNUSED(Args&&...)
+  {}
+} // namespace trieste

include/trieste/intrusive_ptr.h

@@ -1,6 +1,6 @@
 #pragma once
 
-#include "snmalloc/ds_core/defines.h"
+#include "compiler.h"
 
 #include <atomic>
 #include <cassert>
@@ -265,7 +265,7 @@ namespace trieste
     // It's better to have the non-null case dec_ref code all in one place,
     // because it's long for something that might be pasted over 10x
     // into functions that use intrusive_ptr a lot.
-    SNMALLOC_SLOW_PATH
+    TRIESTE_SLOW_PATH
     void intrusive_dec_ref()
     {
       // Atomically subtract 1 from refcount and get the _old value_.