Change tool metadata file format to JSON #1553
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ting trivial destruction.
…the search loop, and get rid of magic numbers that is the length of the table.
Make the table be static data, deduplicate part of the expression in the search loop, and get rid of magic numbers that is the length of the table.
vicroms
force-pushed
the
tools
branch
2 times, most recently
from
5fe30dc to
3747fae
Compare
vicroms
changed the title
vicroms
commented
Dec 14, 2024
vicroms
changed the title
BillyONeal
approved these changes
Dec 23, 2024
Comment on lines
+1656
to
+1660
| if (Util::contains(KNOWN_ARCHITECTURES, sv)) | ||
| { | ||
| return sv.to_string(); | ||
| } | ||
|
|
There was a problem hiding this comment.
Suggested change
| if (Util::contains(KNOWN_ARCHITECTURES, sv)) | |
| { | |
| return sv.to_string(); | |
| } | |
| if (to_cpu_architecture(sv).has_value()) { return sv.to_string(); } |
?
Alternately, can this just be made to return CPUArchitecture directly instead? This also avoids the need to have a duplicate KNOWN_ARCHITECTURES table.
(If you still want the table to generate the error message, can it at least be combined with the bits powering to_cpu_architecture so that we don't introduce a bug any time any of those are edited? For example:
struct KnownCPUArchitecture {
StringLiteral name;
CPUArchitecture architecture;
};
inline constexpr KnownCPUArchitecture KnownArchitectures[] = {
{"x86", CPUArchitecture::X86},
{"x64", CPUArchitecture::X64},
{"amd64", CPUArchitecture::X64},
{"arm", CPUArchitecture::ARM},
{"arm64", CPUArchitecture::ARM64},
{"arm64ec", CPUArchitecture::ARM64EC},
{"s390x", CPUArchitecture::S390X},
{"ppc64le", CPUArchitecture::PPC64LE},
{"riscv32", CPUArchitecture::RISCV32},
{"riscv64", CPUArchitecture::RISCV64},
{"loongarch32", CPUArchitecture::LOONGARCH32},
{"loongarch64", CPUArchitecture::LOONGARCH64},
{"mips64", CPUArchitecture::MIPS64},
};
)
| @@ -358,6 +358,7 @@ namespace vcpkg | |||
| args.parser.parse_option( | |||
| SwitchBuiltinRegistryVersionsDir, StabilityTag::Experimental, args.builtin_registry_versions_dir); | |||
| args.parser.parse_option(SwitchRegistriesCache, StabilityTag::Experimental, args.registries_cache_dir); | |||
| args.parser.parse_option(SwitchToolDataFile, StabilityTag::ImplementationDetail, args.tools_data_file); | |||
| @@ -1,6 +1,7 @@ | |||
| #pragma once | |||
There was a problem hiding this comment.
I really think this should just be in tools.h given that the things in here are contractual despite trying to claim that it's used for 'test'ing. But that's a preexisting situation so no change requested if you don't want to go there.
| REQUIRE(!invalid_arch.has_value()); | ||
| CHECK("invalid_arch.json: error: $.tools[0].arch (a CPU architecture): Invalid architecture: notanarchitecture. " | ||
| "Expected " | ||
| "one of: x86,x64,arm,arm64,arm64ec,s390x,ppc64le,riscv32,riscv64,loongarch32,loongarch64,mips64\n" |
There was a problem hiding this comment.
Suggested change
| "one of: x86,x64,arm,arm64,arm64ec,s390x,ppc64le,riscv32,riscv64,loongarch32,loongarch64,mips64\n" | |
| "one of: x86, x64,arm, arm64, arm64ec, s390x, ppc64le, riscv32, riscv64, loongarch32, loongarch64,mips64\n" |
Comment on lines
+82
to
+87
| if (auto tool_data = maybe_tool_data.get()) | ||
| { | ||
| return *tool_data; | ||
| } | ||
|
|
||
| return msg::format(msgErrorWhileParsingToolData, msg::path = origin); |
There was a problem hiding this comment.
Suggested change
| if (auto tool_data = maybe_tool_data.get()) | |
| { | |
| return *tool_data; | |
| } | |
| return msg::format(msgErrorWhileParsingToolData, msg::path = origin); | |
| return maybe_tool_data.value_or_exit(VCPKG_LINE_INFO); |
Any errors in parsing should have been reported by Json::Reader, so if we get here vcpkg has a bug and we shouldn't have separate localized messages for bugs.
Comment on lines
+68
to
+73
| auto as_json = Json::parse(contents, origin); | ||
| if (!as_json) | ||
| { | ||
| return as_json.error(); | ||
| } | ||
| auto as_value = std::move(as_json).value(VCPKG_LINE_INFO).value; |
There was a problem hiding this comment.
This should have error handling like that in Json::parse_object rather than crashing if it can't be interpreted as a value here.
Comment on lines
+92
to
+99
| std::error_code ec; | ||
| auto contents = fs.read_contents(path, ec); | ||
| if (ec) | ||
| { | ||
| return format_filesystem_call_error(ec, __func__, {path}); | ||
| } | ||
|
|
||
| return parse_tool_data(contents, path); |
There was a problem hiding this comment.
Suggested change
| std::error_code ec; | |
| auto contents = fs.read_contents(path, ec); | |
| if (ec) | |
| { | |
| return format_filesystem_call_error(ec, __func__, {path}); | |
| } | |
| return parse_tool_data(contents, path); | |
| return fs.try_read_contents(path).then([](FileContents&& fc) -> ExpectedL<std::vector<ToolDataEntry>> { | |
| return parse_tool_data(fc.content, Path{fc.origin}); | |
| }); |
| std::string arch_str; | ||
| if (r.optional_object_field(obj, "arch", arch_str, Json::ArchitectureDeserializer::instance)) | ||
| { | ||
| auto it = arch_map.find(arch_str); |
There was a problem hiding this comment.
Can you use to_cpu_architecture instead of a second duplicate table?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Continuation of #1490
Related: #1277
This PR contains several changes:
vcpkgTools.xmldata into a JSON file and removes the XML parsing code.To do: