Merge pull request #10 from kamrann/pr/v11-modules

fmt v11 and (preliminary) c++20 modules support

.gitattributes

@@ -21,3 +21,5 @@
 fmt/fmt/include symlink=dir
 fmt/fmt/src symlink=dir
 fmt/doc symlink=dir
+fmt-tests/basics/test symlink=dir
+fmt-tests/test-main/test symlink=dir

.gitignore

@@ -1,4 +1,5 @@
 .bdep/
+.vs/
 
 # Local default options files.
 #

fmt-tests/.gitignore

@@ -0,0 +1,25 @@
+# Compiler/linker output.
+#
+*.d
+*.t
+*.i
+*.i.*
+*.ii
+*.ii.*
+*.o
+*.obj
+*.gcm
+*.pcm
+*.ifc
+*.so
+*.dylib
+*.dll
+*.a
+*.lib
+*.exp
+*.pdb
+*.ilk
+*.exe
+*.exe.dlls/
+*.exe.manifest
+*.pc

fmt-tests/basics/.gitignore

@@ -0,0 +1,5 @@
+basics
+
+# Testscript output directory (can be symlink).
+#
+test-basics

fmt-tests/basics/buildfile

@@ -0,0 +1,69 @@
+include ../test-main/
+
+# NOTE: Maintaining explicit lists to match upstream, as it's not clear that there is intended to be a uniform pattern that can be reliably globbed.
+# See individual invocations of add_fmt_test() in upstream/test/CMakeLists.txt
+
+
+# Tests that use gtest, and do not require any additional source/headers beyond a single cc file
+
+gtest_test_names =      \
+  args-test             \
+  assert-test           \
+  base-test             \
+  chrono-test           \
+  color-test            \
+  compile-fp-test       \
+  compile-test          \
+  format-test           \
+  gtest-extra-test      \
+  noexception-test      \
+  os-test               \
+  ostream-test          \
+  printf-test           \
+  std-test              \
+  unicode-test          \
+  xchar-test
+
+# NOTE: header-only-test - Excluded as this package does not currently provide support for FMT_HEADER_ONLY.
+# TODO: scan-test - Excluded due to unresolved linker errors.
+
+for test_name : $gtest_test_names
+{
+  ./: exe{$test_name} : test/cxx{$test_name}
+  exe{$test_name}: ../test-main/liba{test-main}:
+  {
+    bin.whole = true
+  }
+}
+
+# END [Tests that use gtest, and do not require any additional source/headers beyond a single cc file]
+
+
+# Tests using gtest but with additional prerequisites
+
+./: exe{ranges-test} : test/cxx{ranges-test ranges-odr-test}
+exe{ranges-test}: ../test-main/liba{test-main}:
+{
+  bin.whole = true
+}
+
+# NOTE: format-impl-test- For whatever reason, format-impl-test is tied in upstream to header-only-test, which we do not support. Attempting to compile it alone yields errors, therefore omitted.
+# TODO: posix-mock-test - Excluded pending further work. Needs posix-mock.h, and has some msvc/runtime conditional logic that needs looking into.
+
+# END [Tests using gtest but with additional prerequisites]
+
+
+# Tests which do not use gtest and therefore should link directly to fmt only and not the test-main lib
+
+# TODO: Is there a clean way to use a declarative list but with more structure, in order to pair names to additional options?
+standalone_test_names = \
+  enforce-checks-test           # -DFMT_ENFORCE_COMPILE_STRING
+
+import fmt = fmt%lib{fmt}
+
+for test_name : $standalone_test_names
+{
+  ./: exe{$test_name} : test/cxx{$test_name} $fmt
+}
+
+# END [Tests which do not use gtest and therefore should link directly to fmt only and not the test-main lib]

fmt-tests/basics/test

@@ -0,0 +1 @@
+../../upstream/test

fmt-tests/build/.gitignore

@@ -0,0 +1,4 @@
+/config.build
+/root/
+/bootstrap/
+build/

fmt-tests/build/bootstrap.build

@@ -0,0 +1,6 @@
+project = fmt-tests
+
+using version
+using config
+using test
+using dist

fmt-tests/build/root.build

@@ -0,0 +1,19 @@
+# Uncomment to suppress warnings coming from external libraries.
+#
+#cxx.internal.scope = current
+
+cxx.std = latest
+
+using cxx
+
+hxx{*}: extension = h
+mxx{*}: extension = cc
+cxx{*}: extension = cc
+
+# All executables are tests
+#
+exe{*}: test = true
+
+# The test target for cross-testing (running tests under Wine, etc).
+#
+test.target = $cxx.target

fmt-tests/buildfile

@@ -0,0 +1 @@
+./: {*/ -build/} manifest

fmt-tests/manifest

@@ -0,0 +1,13 @@
+: 1
+name: fmt-tests
+version: 11.0.1-a.0.z
+project: fmt
+summary: Tests package for fmt upstream tests
+license: MIT
+url: https://github.com/fmtlib/fmt/
+
+depends: * build2 >= 0.17.0
+depends: * bpkg >= 0.17.0
+
+depends: gtest ^1.11.0
+depends: gmock ^1.11.0

fmt-tests/test-main/buildfile

@@ -0,0 +1,14 @@
+
+libs =
+import libs += fmt%lib{fmt}
+import libs += gtest%lib{gtest} gmock%lib{gmock}
+
+liba{test-main}: test/cxx{test-main gtest-extra util} test/hxx{gtest-extra mock-allocator test-assert util} $libs
+
+# Export options.
+#
+liba{test-main}:
+{
+  cxx.export.poptions += "-I$src_base/test"
+  cxx.export.libs = $libs
+}

fmt-tests/test-main/test

@@ -0,0 +1 @@
+../../upstream/test

fmt/README.md

@@ -9,9 +9,18 @@ See [`{fmt}` documentation](https://fmt.dev/) for usage and details.
 Note: This is the source code for the build2 package of the `{fmt}` C++ library,
 the actual library sources snapshot can be found in the `./upstream/` submodule.
 
-## Configuration Options:
+## Configuration Options
 
- - `config.fmt.enable_modules` : Set to `true` to build and provide the `fmt` C++ modules. If the compiler and C++ version don't support C++ modules (which is C++ > 20), this will result in a compilation failure. Set to `true` if `$cxx.features.modules == true` which means the configuration is set to enable C++ modules, `false` otherwise.
+### Experimental C++20 modules support
 
+Modules support is WIP, both in the `build2` package and also in `fmt` upstream. Latest versions of MSVC or Clang are recommended, and the most up-to-date version of the package with regards to modules compatibility can be used via git and the [modules branch](https://github.com/build2-packaging/fmt/tree/modules). For example, in project `repositories.manifest`:
+```
+:
+role: prerequisite
+location: https://github.com/build2-packaging/fmt.git#modules
+```
 
+Enable with `config.cxx.features.modules=true`. When enabled, by default dual mode is used meaning that the library can be consumed either through `import` or via `#include`. To enable this safely, all entities are attached to the global module (extern "C++"). See `modules_only` option for the alternative.
+ - `config.fmt.enable_import_std` : Set to `true` to consume the standard library as a module when building the `fmt` module. Support dependent on compiler and std lib. Defaults to `false`.
+ - `config.fmt.modules_only` : Set to `true` to enable modules-only mode for the package. In this mode, `fmt` entities are fully encapsulated in the `fmt` module meaning `#include`-based consumption cannot be mixed, and the package will not export headers. Defaults to `false`.
 

fmt/build/root.build

@@ -14,6 +14,5 @@ test.target = $cxx.target
 ##############################
 # Project-specific options:
 
-# Set to true to build and provide the `fmt` C++ module.
-config [bool] config.fmt.enable_modules ?= $cxx.features.modules # $($cxx.features.modules == true)
-
+config [bool]    config.fmt.enable_import_std ?= false
+config [bool]    config.fmt.modules_only ?= false

fmt/fmt/buildfile

@@ -6,14 +6,26 @@ imp_libs = # Implementation dependencies.
 
 lib{fmt}: include/hxx{**} hxx{version} $imp_libs $int_libs
 
-lib{fmt}: src/mxx{fmt} : include = ($config.fmt.enable_modules) # `fmt` C++ module only
-lib{fmt}: src/cxx{** -fmt} : include = (!$config.fmt.enable_modules) # no modules only
+# Automatically build as module if the feature is enabled
+build_fmt_module = $cxx.features.modules
+allow_header_usage = ($build_fmt_module == false || $config.fmt.modules_only == false)
+
+if($build_fmt_module && $allow_header_usage)
+  info "Building fmt with dual module/header mode enabled"
+
+# Workaround for MSVC bug: https://developercommunity.visualstudio.com/t/Separate-preprocessing-with-P-fails-wit/10707183
+if($build_fmt_module && $cxx.class == 'msvc')
+  cc.reprocess = true
+
+lib{fmt}: src/mxx{fmt} : include = ($build_fmt_module) # `fmt` C++ module only
+lib{fmt}: src/cxx{** -fmt} : include = (!$build_fmt_module) # no modules only
 
 # Meta data for users
 lib{fmt}:
 {
   export.metadata = 1 fmt
-  fmt.is_module = [bool] $config.fmt.enable_modules
+  fmt.has_header = [bool] $allow_header_usage
+  fmt.has_module = [bool] $build_fmt_module
 }
 
 # Include the generated version header into the distribution (so that we don't
@@ -31,22 +43,28 @@ hxx{version} : in{version} $src_root/manifest
 # Build options.
 #
 cxx.poptions =+ "-I$src_base/include" "-I$out_root" "-I$src_root"
-objs{*}: cxx.poptions += -DFMT_LIB_EXPORT
+{objs bmis}{*}: cxx.poptions += -DFMT_LIB_EXPORT
 
-if($config.fmt.enable_modules)
-  cxx.poptions =+ -DFMT_MODULE=ON
+# If building fmt module, also enable attaching to the global module in order to allow concurrent #include and import.
+if($build_fmt_module)
+{
+  cxx.poptions =+ -DFMT_MODULE
+  if($allow_header_usage)
+    # Support mixing consuming as both modules and headers within a single build
+    cxx.poptions =+ -DFMT_ATTACH_TO_GLOBAL_MODULE
+  if($config.fmt.enable_import_std)
+    cxx.poptions =+ -DFMT_IMPORT_STD
+}
 
 # Export options.
 #
-lib{fmt}:
+lib{fmt}: cxx.export.libs = $int_libs
+if($allow_header_usage) # Note: exported poptions only relevant for header consumption
 {
-  cxx.export.poptions = "-I$src_base/include" "-I$out_root" "-I$src_root"
-  cxx.export.libs = $int_libs
+  lib{fmt}: cxx.export.poptions = "-I$src_base/include" "-I$out_root" "-I$src_root"
+  libs{fmt}: cxx.export.poptions += -DFMT_SHARED
 }
 
-libs{fmt}: cxx.export.poptions += -DFMT_SHARED
-
-
 # For pre-releases use the complete version to make sure they cannot be used
 # in place of another pre-release or the final version. See the version module
 # for details on the version.* variable values.

fmt/manifest

@@ -9,6 +9,18 @@ url: https://github.com/fmtlib/fmt/
 package-url: https://github.com/build2-packaging/fmt/
 package-email: [email protected]
 
+tests: fmt-tests == $
+
 depends: * build2 >= 0.17.0
 depends: * bpkg >= 0.17.0
 
+builds: default
+builds: -freebsd							; fmt tests failing, fixed on upstream master, pending removal next package release after 11.0.2
+build-exclude: linux_debian_12-clang_17		; clang-17 bug with libstdc++ std::tuple (https://github.com/llvm/llvm-project/issues/61415)
+build-exclude: **/x86_64-w64-mingw32		; unknown error building installed tests 'error: unable to stat path D:\a\msys64\mingw64\lib\x86_64-w64-mingw32\14.1.0\pkgconfig\: the device is not ready'
+
+# Modules support still not sufficient to enable on CI
+#modules-builds: latest : &( +clang-18+ +msvc ) ; Modules builds only supported for latest Clang and MSVC
+#modules-build-config: config.cxx.features.modules=true ; Enable c++20 modules
+#modules-only-builds: latest : &( +clang-18+ +msvc ) ; Modules builds only supported for latest Clang and MSVC
+#modules-only-build-config: config.cxx.features.modules=true config.fmt.modules_only=true ; Enable c++20 modules and disable header usage

fmt/tests/basics/buildfile

@@ -1,9 +1,11 @@
 import! [metadata, rule_hint=cxx.link] libs = fmt%lib{fmt}
 
-./ : exe{driver} : {cxx}{driver} hxx{tests.inl} $libs testscript{**}
+./ : exe{driver} : include = $($libs: fmt.has_header)
+./ : exe{driver-modules} : include = $($libs: fmt.has_module)
 
-if $($libs: fmt.is_module)
-{
-    ./ : exe{driver-modules} : {cxx}{driver-modules} hxx{tests.inl} $libs testscript{**}
-}
+exe{driver} : {cxx}{driver} hxx{tests.inl} $libs testscript{**}
 
+# For purposes of verifying that fmt headers are not made available for include when in modules-only mode
+cxx.poptions =+ "-DFMT_BUILD2_HAS_HEADER=($($libs: fmt.has_header) ? 1 : 0)"
+
+exe{driver-modules} : {cxx}{driver-modules} hxx{tests.inl} $libs testscript{**}

fmt/tests/basics/driver-modules.cxx

@@ -1,8 +1,14 @@
 
+// Verify that fmt headers are not available if config.fmt.modules_only is true
+#if __has_include(<fmt/version.h>) != FMT_BUILD2_HAS_HEADER
+#error fmt headers should be available for include iff config.fmt.modules_only == false
+#endif
+
 #include <cassert>
-import std;
+#include <string>
+#include <chrono>
+#include <vector>
+
 import fmt;
 
 #include "tests.inl"
-
-

fmt/tests/basics/driver.cxx

@@ -1,4 +1,5 @@
 #include <cassert>
+#include <string>
 #include <chrono>
 #include <vector>
 

fmt/tests/basics/tests.inl

@@ -51,7 +51,8 @@ struct date {
 
 template <>
 struct fmt::formatter<date> {
-  constexpr auto parse(format_parse_context& ctx) const { return ctx.begin(); }
+  template <typename ParseContext>
+  constexpr auto parse(ParseContext& ctx) const { return ctx.begin(); }
 
   template <typename FormatContext>
   constexpr auto format(const date& d, FormatContext& ctx) const {

packages.manifest

@@ -1,2 +1,4 @@
 : 1
 location: fmt/
+:
+location: fmt-tests/

repositories.manifest

@@ -1,11 +1,6 @@
 : 1
 summary: fmt project repository
 
-#:
-#role: prerequisite
-#location: https://pkg.cppget.org/1/stable
-#trust: ...
-
-#:
-#role: prerequisite
-#location: https://git.build2.org/hello/libhello.git
+:
+role: prerequisite
+location: https://pkg.cppget.org/1/stable