Apply the normal "to_string" pattern in more places. (#1521)

Co-authored-by: Thomas1664 <[email protected]>

Author: BillyONeal

include/vcpkg/base/contractual-constants.h

@@ -558,4 +558,14 @@ namespace vcpkg
     inline constexpr StringLiteral AbiTagPostBuildChecks = "post_build_checks";
     inline constexpr StringLiteral AbiTagPowershell = "powershell";
     inline constexpr StringLiteral AbiTagPublicAbiOverride = "public_abi_override";
+
+    inline constexpr StringLiteral StatusDeinstall = "deinstall";
+    inline constexpr StringLiteral StatusError = "error";
+    inline constexpr StringLiteral StatusHalfInstalled = "half-installed";
+    inline constexpr StringLiteral StatusHold = "hold";
+    inline constexpr StringLiteral StatusInstall = "install";
+    inline constexpr StringLiteral StatusInstalled = "installed";
+    inline constexpr StringLiteral StatusNotInstalled = "not-installed";
+    inline constexpr StringLiteral StatusPurge = "purge";
+    inline constexpr StringLiteral StatusUnknown = "unknown";
 }

include/vcpkg/base/fmt.h

@@ -18,3 +18,11 @@ VCPKG_MSVC_WARNING(disable : 6239 4702)
 #include <fmt/format.h>
 #include <fmt/ranges.h>
 VCPKG_MSVC_WARNING(pop)
+
+template<class T>
+std::string adapt_to_string(const T& val)
+{
+    std::string result;
+    val.to_string(result);
+    return result;
+}

include/vcpkg/base/graphs.h

@@ -16,7 +16,6 @@ namespace vcpkg
     struct AdjacencyProvider
     {
         virtual std::vector<V> adjacency_list(const U& vertex) const = 0;
-        virtual std::string to_string(const V& vertex) const = 0;
         virtual U load_vertex_data(const V& vertex) const = 0;
     };
 

include/vcpkg/binaryparagraph.h

@@ -8,9 +8,7 @@
 
 namespace vcpkg
 {
-    /// <summary>
-    /// Built package metadata
-    /// </summary>
+    // metadata for a package in the 'packages' tree
     struct BinaryParagraph
     {
         BinaryParagraph() = default;

include/vcpkg/statusparagraph.h

@@ -13,9 +13,8 @@
 
 namespace vcpkg
 {
-    /// <summary>
-    /// Installed package metadata
-    /// </summary>
+
+    // metadata for a package's representation in the 'installed' tree
     struct StatusParagraph
     {
         StatusParagraph() noexcept;
@@ -30,14 +29,12 @@ namespace vcpkg
 
     void serialize(const StatusParagraph& pgh, std::string& out_str);
 
-    std::string to_string(InstallState f);
-
-    std::string to_string(Want f);
+    StringLiteral to_string_literal(InstallState f);
+    StringLiteral to_string_literal(Want f);
 
     struct InstalledPackageView
     {
-        InstalledPackageView() noexcept : core(nullptr) { }
-
+        InstalledPackageView() = default;
         InstalledPackageView(const StatusParagraph* c, std::vector<const StatusParagraph*>&& fs)
             : core(c), features(std::move(fs))
         {
@@ -51,11 +48,14 @@ namespace vcpkg
 
         std::vector<StatusParagraph> all_status_paragraphs() const;
 
-        const StatusParagraph* core;
+        const StatusParagraph* core = nullptr;
         std::vector<const StatusParagraph*> features;
     };
 
     Json::Value serialize_ipv(const InstalledPackageView& ipv,
                               const InstalledPaths& installed,
                               const ReadOnlyFilesystem& fs);
 }
+
+VCPKG_FORMAT_WITH_TO_STRING_LITERAL_NONMEMBER(vcpkg::InstallState);
+VCPKG_FORMAT_WITH_TO_STRING_LITERAL_NONMEMBER(vcpkg::Want);

include/vcpkg/versions.h

@@ -48,6 +48,7 @@ namespace vcpkg
         VersionDiff(const Version& left, const Version& right);
 
         std::string to_string() const;
+        void to_string(std::string& out) const;
     };
 
     struct VersionMapLess
@@ -85,6 +86,7 @@ namespace vcpkg
         VersionSpec(const std::string& port_name, const std::string& version_string, int port_version);
 
         std::string to_string() const;
+        void to_string(std::string& out) const;
 
         friend bool operator==(const VersionSpec& lhs, const VersionSpec& rhs);
         friend bool operator!=(const VersionSpec& lhs, const VersionSpec& rhs);
@@ -97,7 +99,7 @@ namespace vcpkg
 
     struct DotVersion
     {
-        DotVersion() { } // intentionally disable making this type an aggregate
+        DotVersion() noexcept { } // intentionally disable making this type an aggregate
 
         std::string original_string;
         std::string version_string;
@@ -122,7 +124,7 @@ namespace vcpkg
 
     struct DateVersion
     {
-        DateVersion() { } // intentionally disable making this type an aggregate
+        DateVersion() noexcept { } // intentionally disable making this type an aggregate
 
         std::string original_string;
         std::string version_string;

src/vcpkg/binaryparagraph.cpp

@@ -284,7 +284,7 @@ namespace vcpkg
         return fmt::format(
             "\nspec: \"{}\"\nversion: \"{}\"\nport_version: {}\ndescription: [\"{}\"]\nmaintainers: [\"{}\"]\nfeature: "
             "\"{}\"\ndefault_features: [\"{}\"]\ndependencies: [\"{}\"]\nabi: \"{}\"",
-            paragraph.spec.to_string(),
+            paragraph.spec,
             paragraph.version.text,
             paragraph.version.port_version,
             Strings::join(join_str, paragraph.description),

src/vcpkg/commands.ci.cpp

@@ -52,11 +52,11 @@ namespace
             (void)filesystem.create_directory(target_path, VCPKG_LINE_INFO);
             if (children.empty())
             {
-                std::string message =
-                    "There are no build logs for " + spec.to_string() +
-                    " build.\n"
-                    "This is usually because the build failed early and outside of a task that is logged.\n"
-                    "See the console output logs from vcpkg for more information on the failure.\n";
+                auto message =
+                    fmt::format("There are no build logs for {} build.\n"
+                                "This is usually because the build failed early and outside of a task that is logged.\n"
+                                "See the console output logs from vcpkg for more information on the failure.\n",
+                                spec);
                 filesystem.write_contents(std::move(target_path) / "readme.log", message, VCPKG_LINE_INFO);
             }
             else

src/vcpkg/commands.export.cpp

@@ -472,8 +472,7 @@ namespace
                     Checks::unreachable(VCPKG_LINE_INFO);
                 }
 
-                const std::string display_name = action.spec.to_string();
-                msg::println(msgExportingPackage, msg::package_name = display_name);
+                msg::println(msgExportingPackage, msg::package_name = action.spec);
 
                 const BinaryParagraph& binary_paragraph = action.core_paragraph().value_or_exit(VCPKG_LINE_INFO);
 

src/vcpkg/commands.list.cpp

@@ -17,19 +17,20 @@ namespace
         Json::Object obj;
         for (const StatusParagraph* status_paragraph : installed_packages)
         {
-            auto current_spec = status_paragraph->package.spec;
-            if (obj.contains(current_spec.to_string()))
+            const auto& current_spec = status_paragraph->package.spec;
+            const auto current_spec_string = current_spec.to_string();
+            if (obj.contains(current_spec_string))
             {
                 if (status_paragraph->package.is_feature())
                 {
-                    Json::Value* value_obj = obj.get(current_spec.to_string());
+                    Json::Value* value_obj = obj.get(current_spec_string);
                     auto& feature_list = value_obj->object(VCPKG_LINE_INFO)[JsonIdFeatures].array(VCPKG_LINE_INFO);
                     feature_list.push_back(Json::Value::string(status_paragraph->package.feature));
                 }
             }
             else
             {
-                Json::Object& library_obj = obj.insert(current_spec.to_string(), Json::Object());
+                Json::Object& library_obj = obj.insert(current_spec_string, Json::Object());
                 library_obj.insert(JsonIdPackageUnderscoreName, Json::Value::string(current_spec.name()));
                 library_obj.insert(JsonIdTriplet, Json::Value::string(current_spec.triplet().to_string()));
                 library_obj.insert(JsonIdVersion, Json::Value::string(status_paragraph->package.version.text));