cemu-vcpkg/toolsrc/include/vcpkg/sourceparagraph.h
nicole mazzuca 1d8f0acc9c
[vcpkg manifest] Manifest Implementation (#11757)
==== Changes Related to manifests ====

* Add the `manifests` feature flag
  * This only says whether we look for a `vcpkg.json` in the cwd, not
    whether we support parsing manifests (for ports, for example)
* Changes to the manifests RFC
  * `"authors"` -> `"maintainers"`
  * `--x-classic-mode` -> `-manifests` \in `vcpkg_feature_flags`
  * reserve `"core"` in addition to `"default"`, since that's already
    reserved for features
  * Add a small helper note about what identifiers must look like
  * `<license-string>`: SPDX v3.8 -> v3.9
  * `"feature"."description"` is allowed to be an array of strings as well
  * `"version"` -> `"version-string"` for forward-compat with versions
    RFC
* Add the `--feature-flags` option
* Add the ability to turn off feature flags via passing
  `-<feature-flag>` to `VCPKG_FEATURE_FLAGS` or `--feature-flags`
* Add CMake toolchain support for manifests
  * Requires either:
    * a feature flag of `manifests` in either `Env{VCPKG_FEATURE_FLAGS}`
      or `VCPKG_FEATURE_FLAGS`
    * Passing the `VCPKG_ENABLE_MANIFESTS` option
  * The toolchain will install your packages to
    `${VCPKG_MANIFEST_DIR}/vcpkg_installed`.
* Add MSBuild `vcpkg integrate install` support for manifests
  * Requires `VcpkgEnableManifest` to be true
* `vcpkg create` creates a port that has a `vcpkg.json` instead of a
  `CONTROL`
* argparse, abseil, 3fd, and avisynthplus ports switched to manifest
  from CONTROL
* Add support for `--x-manifest-root`, as well as code for finding it if
  not passed
* Add support for parsing manifests!
* Add a filesystem lock!

==== Important Changes which are somewhat unrelated to manifests ====

* Rename `logicexpression.{h,cpp}` to `platform-expression.{h,cpp}`
* Add `PlatformExpression` type which takes the place of the old logic
  expression
  * Split the parsing of platform expressions from checking whether
    they're true or not
  * Eagerly parse PlatformExpressions as opposed to leaving them as
    strings
* Add checking for feature flag consistency
  * i.e., if `-binarycaching` is passed, you shouldn't be passing
    `--binarysource`
* Add the `Json::Reader` type which, with the help of user-defined
  visitors, converts JSON to your internal type
* VcpkgArgParser: place the switch names into a constant as opposed to
  using magic constants
  * In general update the parsing code so that this ^ works
* Add `Port-Version` fields to CONTROL files
  * This replaces the existing practice of
    `Version: <my-version>-<port-version>`

==== Smaller changes ====
* small drive-by cleanups to some CMake
  * `${_VCPKG_INSTALLED_DIR}/${VCPKG_TARGET_TRIPLET}` ->
    `${CURRENT_INSTALLED_DIR}`
  * Remove `-analyze` when compiling with clang-cl, since that's not a
    supported flag (vcpkg's build system)
  * Add a message about which compiler is detected by vcpkg's build
    system machinery
* Fix `Expected::then`
* Convert `""` to `{}` for `std::string` and `fs::path`, to avoid a
  `strlen` (additionally, `.empty()` instead of `== ""`, and `.clear()`)
* Add `Strings::strto` which converts strings to numeric types
* Support built-in arrays and `StringView` for `Strings::join`
* Add `operator<` and friends to `StringView`
* Add `substr` to `StringView`
* SourceParagraphParser gets some new errors
2020-06-30 10:40:18 -07:00

125 lines
4.3 KiB
C++

#pragma once
#include <vcpkg/base/expected.h>
#include <vcpkg/base/json.h>
#include <vcpkg/base/span.h>
#include <vcpkg/base/system.h>
#include <vcpkg/base/system.print.h>
#include <vcpkg/platform-expression.h>
#include <vcpkg/packagespec.h>
#include <vcpkg/paragraphparser.h>
namespace vcpkg
{
std::vector<FullPackageSpec> filter_dependencies(const std::vector<Dependency>& deps,
Triplet t,
const std::unordered_map<std::string, std::string>& cmake_vars);
struct Type
{
enum
{
UNKNOWN,
PORT,
ALIAS,
} type;
static std::string to_string(const Type&);
static Type from_string(const std::string&);
};
bool operator==(const Type&, const Type&);
bool operator!=(const Type&, const Type&);
/// <summary>
/// Port metadata of additional feature in a package (part of CONTROL file)
/// </summary>
struct FeatureParagraph
{
std::string name;
std::vector<std::string> description;
std::vector<Dependency> dependencies;
};
/// <summary>
/// Port metadata of the core feature of a package (part of CONTROL file)
/// </summary>
struct SourceParagraph
{
std::string name;
std::string version;
int port_version = 0;
std::vector<std::string> description;
std::vector<std::string> maintainers;
std::string homepage;
std::string documentation;
std::vector<Dependency> dependencies;
std::vector<std::string> default_features;
std::string license; // SPDX license expression
Type type;
PlatformExpression::Expr supports_expression;
};
/// <summary>
/// Full metadata of a package: core and other features.
/// </summary>
struct SourceControlFile
{
SourceControlFile() = default;
SourceControlFile(const SourceControlFile& scf)
: core_paragraph(std::make_unique<SourceParagraph>(*scf.core_paragraph))
{
for (const auto& feat_ptr : scf.feature_paragraphs)
{
feature_paragraphs.emplace_back(std::make_unique<FeatureParagraph>(*feat_ptr));
}
}
static Parse::ParseExpected<SourceControlFile> parse_manifest_file(const fs::path& path_to_manifest,
const Json::Object& object);
static Parse::ParseExpected<SourceControlFile> parse_control_file(
const fs::path& path_to_control, std::vector<Parse::Paragraph>&& control_paragraphs);
// Always non-null in non-error cases
std::unique_ptr<SourceParagraph> core_paragraph;
std::vector<std::unique_ptr<FeatureParagraph>> feature_paragraphs;
Optional<const FeatureParagraph&> find_feature(const std::string& featurename) const;
Optional<const std::vector<Dependency>&> find_dependencies_for_feature(const std::string& featurename) const;
};
/// <summary>
/// Full metadata of a package: core and other features. As well as the location the SourceControlFile was
/// loaded from.
/// </summary>
struct SourceControlFileLocation
{
SourceControlFileLocation(const SourceControlFileLocation& scfl)
: source_control_file(std::make_unique<SourceControlFile>(*scfl.source_control_file))
, source_location(scfl.source_location)
{
}
SourceControlFileLocation(std::unique_ptr<SourceControlFile>&& scf, fs::path&& source)
: source_control_file(std::move(scf)), source_location(std::move(source))
{
}
SourceControlFileLocation(std::unique_ptr<SourceControlFile>&& scf, const fs::path& source)
: source_control_file(std::move(scf)), source_location(source)
{
}
std::unique_ptr<SourceControlFile> source_control_file;
fs::path source_location;
};
void print_error_message(Span<const std::unique_ptr<Parse::ParseControlErrorInfo>> error_info_list);
inline void print_error_message(const std::unique_ptr<Parse::ParseControlErrorInfo>& error_info_list)
{
return print_error_message({&error_info_list, 1});
}
}