Localize binaryparagraph.cpp and sourceparagraph.cpp

include/vcpkg/base/messages.h

@@ -711,8 +711,8 @@ namespace vcpkg
                     (msg::value),
                     "'{value}' is a command line option.",
                     "'--{value}' specified multiple times.");
-    DECLARE_MESSAGE(EmptyArg, (msg::option), "", "The option --{option} must be passed a non-empty argument.");
     DECLARE_MESSAGE(EmailVcpkgTeam, (msg::url), "", "Send an email to {url} with any feedback.");
+    DECLARE_MESSAGE(EmptyArg, (msg::option), "", "The option --{option} must be passed a non-empty argument.");
     DECLARE_MESSAGE(EmptyLicenseExpression, (), "", "SPDX license expression was empty.");
     DECLARE_MESSAGE(EnvStrFailedToExtract, (), "", "could not expand the environment string:");
     DECLARE_MESSAGE(ErrorDetectingCompilerInfo,
@@ -1106,6 +1106,11 @@ namespace vcpkg
                     "paragraph.\nPlease open an issue at {url}, with the following output:");
     DECLARE_MESSAGE(Missing7zHeader, (), "", "Unable to find 7z header.");
     DECLARE_MESSAGE(MissingExtension, (msg::extension), "", "Missing '{extension}' extension.");
+    DECLARE_MESSAGE(MissmatchedBinParagraphs,
+                    (),
+                    "",
+                    "The serialized binary paragraph was different from the original binary paragraph. Please open an "
+                    "issue at https://github.com/microsoft/vcpkg with the following output:");
     DECLARE_MESSAGE(MonoInstructions,
                     (),
                     "",
@@ -1116,6 +1121,7 @@ namespace vcpkg
                     (msg::path, msg::exit_code),
                     "",
                     "msiexec failed while extracting \"{path}\" with launch or exit code {exit_code} and message:");
+    DECLARE_MESSAGE(MultiArch, (msg::option), "", "Multi-Arch must be 'same' but was {option}");
     DECLARE_MESSAGE(NavigateToNPS, (msg::url), "", "Please navigate to {url} in your preferred browser.");
     DECLARE_MESSAGE(NewConfigurationAlreadyExists,
                     (msg::path),
@@ -1141,7 +1147,7 @@ namespace vcpkg
                     (msg::path),
                     "",
                     "NuGet package creation succeeded, but no .nupkg was produced. Expected: \"{path}\"");
-    DECLARE_MESSAGE(MultiArch, (msg::option), "", "Multi-Arch must be 'same' but was {option}");
+    DECLARE_MESSAGE(OriginalBinParagraphHeader, (), "", "\nOriginal Binary Paragraph");
     DECLARE_MESSAGE(PackageFailedtWhileExtracting,
                     (msg::value, msg::path),
                     "'{value}' is either a tool name or a package name.",
@@ -1208,6 +1214,7 @@ namespace vcpkg
         "{value} may be either a 'vendor' like 'Azure' or 'NuGet', or a file path like C:\\example or /usr/example",
         "Restored {count} package(s) from {value} in {elapsed}. Use --debug to see more details.");
     DECLARE_MESSAGE(ResultsHeader, (), "Displayed before a list of installation results.", "RESULTS");
+    DECLARE_MESSAGE(SerializedBinParagraphHeader, (), "", "\nSerialized Binary Paragraph");
     DECLARE_MESSAGE(SettingEnvVar,
                     (msg::env_var, msg::url),
                     "An example of env_var is \"HTTP(S)_PROXY\""

include/vcpkg/binaryparagraph.h

@@ -56,4 +56,5 @@ namespace vcpkg
     };
 
     void serialize(const BinaryParagraph& pgh, std::string& out_str);
+    std::string format_binary_paragraph(BinaryParagraph paragraph);
 }

locales/messages.en.json

@@ -237,6 +237,7 @@
   "MismatchedBinaryParagraphs": "[sanity check] The serialized binary paragraph was different from the original binary paragraph.\nPlease open an issue at {url}, with the following output:",
   "Missing7zHeader": "Unable to find 7z header.",
   "MissingExtension": "Missing '{extension}' extension.",
+  "MissmatchedBinParagraphs": "The serialized binary paragraph was different from the original binary paragraph. Please open an issue at https://github.com/microsoft/vcpkg with the following output:",
   "MonoInstructions": "This may be caused by an incomplete mono installation. Full mono is available on some systems via `sudo apt install mono-complete`. Ubuntu 18.04 users may need a newer version of mono, available at https://www.mono-project.com/download/stable/",
   "MsiexecFailedToExtract": "msiexec failed while extracting \"{path}\" with launch or exit code {exit_code} and message:",
   "MultiArch": "Multi-Arch must be 'same' but was {option}",
@@ -253,6 +254,7 @@
   "NoRegistryForPort": "no registry configured for port {package_name}",
   "NoteMessage": "note: ",
   "NugetPackageFileSucceededButCreationFailed": "NuGet package creation succeeded, but no .nupkg was produced. Expected: \"{path}\"",
+  "OriginalBinParagraphHeader": "\nOriginal Binary Paragraph",
   "PackageFailedtWhileExtracting": "'{value}' failed while extracting {path}.",
   "PackageRootDir": "(Experimental) Specify the packages root directory.",
   "PackingVendorFailed": "Packing {vendor} failed. Use --debug for more information.",
@@ -276,6 +278,7 @@
   "RestoredPackagesFromVendor": "Restored {count} package(s) from {value} in {elapsed}. Use --debug to see more details.",
   "ResultsHeader": "RESULTS",
   "SeeURL": "See {url} for more information.",
+  "SerializedBinParagraphHeader": "\nSerialized Binary Paragraph",
   "SettingEnvVar": "-- Setting \"{env_var}\" environment variables to \"{url}\".",
   "SourceFieldPortNameMismatch": "The 'Source' field inside the CONTROL file, or \"name\" field inside the vcpkg.json file has the name {package_name} and does not match the port directory \"{path}\".",
   "SpecifiedFeatureTurnedOff": "'{command_name}' feature specifically turned off, but --{option} was specified.",

locales/messages.json

@@ -396,6 +396,7 @@
   "Missing7zHeader": "Unable to find 7z header.",
   "MissingExtension": "Missing '{extension}' extension.",
   "_MissingExtension.comment": "An example of {extension} is .exe.",
+  "MissmatchedBinParagraphs": "The serialized binary paragraph was different from the original binary paragraph. Please open an issue at https://github.com/microsoft/vcpkg with the following output:",
   "MonoInstructions": "This may be caused by an incomplete mono installation. Full mono is available on some systems via `sudo apt install mono-complete`. Ubuntu 18.04 users may need a newer version of mono, available at https://www.mono-project.com/download/stable/",
   "MsiexecFailedToExtract": "msiexec failed while extracting \"{path}\" with launch or exit code {exit_code} and message:",
   "_MsiexecFailedToExtract.comment": "An example of {path} is /foo/bar. An example of {exit_code} is 127.",
@@ -420,6 +421,7 @@
   "NoteMessage": "note: ",
   "NugetPackageFileSucceededButCreationFailed": "NuGet package creation succeeded, but no .nupkg was produced. Expected: \"{path}\"",
   "_NugetPackageFileSucceededButCreationFailed.comment": "An example of {path} is /foo/bar.",
+  "OriginalBinParagraphHeader": "\nOriginal Binary Paragraph",
   "PackageFailedtWhileExtracting": "'{value}' failed while extracting {path}.",
   "_PackageFailedtWhileExtracting.comment": "'{value}' is either a tool name or a package name. An example of {path} is /foo/bar.",
   "PackageRootDir": "(Experimental) Specify the packages root directory.",
@@ -460,6 +462,7 @@
   "_ResultsHeader.comment": "Displayed before a list of installation results.",
   "SeeURL": "See {url} for more information.",
   "_SeeURL.comment": "An example of {url} is https://github.com/microsoft/vcpkg.",
+  "SerializedBinParagraphHeader": "\nSerialized Binary Paragraph",
   "SettingEnvVar": "-- Setting \"{env_var}\" environment variables to \"{url}\".",
   "_SettingEnvVar.comment": "An example of env_var is \"HTTP(S)_PROXY\"'--' at the beginning must be preserved An example of {env_var} is VCPKG_DEFAULT_TRIPLET. An example of {url} is https://github.com/microsoft/vcpkg.",
   "SourceFieldPortNameMismatch": "The 'Source' field inside the CONTROL file, or \"name\" field inside the vcpkg.json file has the name {package_name} and does not match the port directory \"{path}\".",

src/vcpkg/base/messages.cpp

@@ -637,6 +637,7 @@ namespace vcpkg
     REGISTER_MESSAGE(MismatchedBinaryParagraphs);
     REGISTER_MESSAGE(Missing7zHeader);
     REGISTER_MESSAGE(MissingExtension);
+    REGISTER_MESSAGE(MissmatchedBinParagraphs);
     REGISTER_MESSAGE(MonoInstructions);
     REGISTER_MESSAGE(MsiexecFailedToExtract);
     REGISTER_MESSAGE(MultiArch);
@@ -652,6 +653,7 @@ namespace vcpkg
     REGISTER_MESSAGE(NoLocalizationForMessages);
     REGISTER_MESSAGE(NoRegistryForPort);
     REGISTER_MESSAGE(NugetPackageFileSucceededButCreationFailed);
+    REGISTER_MESSAGE(OriginalBinParagraphHeader);
     REGISTER_MESSAGE(PackageFailedtWhileExtracting);
     REGISTER_MESSAGE(PackageRootDir);
     REGISTER_MESSAGE(PackingVendorFailed);
@@ -673,6 +675,7 @@ namespace vcpkg
     REGISTER_MESSAGE(RestoredPackage);
     REGISTER_MESSAGE(RestoredPackagesFromVendor);
     REGISTER_MESSAGE(ResultsHeader);
+    REGISTER_MESSAGE(SerializedBinParagraphHeader);
     REGISTER_MESSAGE(SettingEnvVar);
     REGISTER_MESSAGE(SourceFieldPortNameMismatch);
     REGISTER_MESSAGE(SpecifiedFeatureTurnedOff);

src/vcpkg/binaryparagraph.cpp

@@ -289,56 +289,30 @@ namespace vcpkg
         auto binary_paragraph = BinaryParagraph(*parsed_paragraph.get());
         if (binary_paragraph != pgh)
         {
-            const auto& join_str = R"(", ")";
-            Checks::exit_maybe_upgrade(
-                VCPKG_LINE_INFO,
-                R"([sanity check] The serialized binary paragraph was different from the original binary paragraph.
-Please open an issue at https://github.com/microsoft/vcpkg, with the following output:
-
-=== Original BinaryParagraph ===
-spec: "%s"
-version: "%s"
-port_version: %d
-description: ["%s"]
-maintainers: ["%s"]
-feature: "%s"
-default_features: ["%s"]
-dependencies: ["%s"]
-abi: "%s"
-type: %s
-
-=== Serialized BinaryParagraph ===
-spec: "%s"
-version: "%s"
-port_version: %d
-description: ["%s"]
-maintainers: ["%s"]
-feature: "%s"
-default_features: ["%s"]
-dependencies: ["%s"]
-abi: "%s"
-type: %s
-)",
-                pgh.spec.to_string(),
-                pgh.version,
-                pgh.port_version,
-                Strings::join(join_str, pgh.description),
-                Strings::join(join_str, pgh.maintainers),
-                pgh.feature,
-                Strings::join(join_str, pgh.default_features),
-                Strings::join(join_str, pgh.dependencies),
-                pgh.abi,
-                Type::to_string(pgh.type),
-                binary_paragraph.spec.to_string(),
-                binary_paragraph.version,
-                binary_paragraph.port_version,
-                Strings::join(join_str, binary_paragraph.description),
-                Strings::join(join_str, binary_paragraph.maintainers),
-                binary_paragraph.feature,
-                Strings::join(join_str, binary_paragraph.default_features),
-                Strings::join(join_str, binary_paragraph.dependencies),
-                binary_paragraph.abi,
-                Type::to_string(binary_paragraph.type));
+            Checks::msg_exit_maybe_upgrade(VCPKG_LINE_INFO,
+                                           msg::format(msgMissmatchedBinParagraphs)
+                                               .append(msgOriginalBinParagraphHeader)
+                                               .append_raw(format_binary_paragraph(pgh))
+                                               .append(msgSerializedBinParagraphHeader)
+                                               .append_raw(format_binary_paragraph(binary_paragraph)));
         }
     }
+
+    std::string format_binary_paragraph(BinaryParagraph paragraph)
+    {
+        const auto& join_str = R"(", ")";
+        return Strings::format(
+            "\nspec: \"%s\"\nversion: \"%s\"\nport_version: %d\ndescription: [\"%s\"]\nmaintainers: [\"%s\"]\nfeature: "
+            "\"%s\"\ndefault_features: [\"%s\"]\ndependencies: [\"%s\"]\nabi: \"%s\"\ntype: %s",
+            paragraph.spec.to_string(),
+            paragraph.version,
+            paragraph.port_version,
+            Strings::join(join_str, paragraph.description),
+            Strings::join(join_str, paragraph.maintainers),
+            paragraph.feature,
+            Strings::join(join_str, paragraph.default_features),
+            Strings::join(join_str, paragraph.dependencies),
+            paragraph.abi,
+            Type::to_string(paragraph.type));
+    }
 }

src/vcpkg/sourceparagraph.cpp

@@ -1439,7 +1439,7 @@ namespace vcpkg
             }
             if (start_of_chunk != end_of_chunk)
             {
-                msg::println_error(LocalizedString::from_raw(StringView{start_of_chunk, end_of_chunk}));
+                msg::write_unlocalized_text_to_stdout(Color::error, StringView{start_of_chunk, end_of_chunk});
                 start_of_chunk = end_of_chunk;
             }
         }