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

186 lines
5.5 KiB
C++

#pragma once
#include <vcpkg/base/expected.h>
#include <vcpkg/base/optional.h>
#include <vcpkg/platform-expression.h>
#include <vcpkg/triplet.h>
namespace vcpkg::Parse
{
struct ParserBase;
}
namespace vcpkg
{
///
/// <summary>
/// Full specification of a package. Contains all information to reference
/// a specific package.
/// </summary>
///
struct PackageSpec
{
PackageSpec() noexcept = default;
PackageSpec(std::string name, Triplet triplet) : m_name(std::move(name)), m_triplet(triplet) { }
static std::vector<PackageSpec> to_package_specs(const std::vector<std::string>& ports, Triplet triplet);
const std::string& name() const;
Triplet triplet() const;
std::string dir() const;
std::string to_string() const;
void to_string(std::string& s) const;
bool operator<(const PackageSpec& other) const
{
if (name() < other.name()) return true;
if (name() > other.name()) return false;
return triplet() < other.triplet();
}
private:
std::string m_name;
Triplet m_triplet;
};
///
/// <summary>
/// Full specification of a feature. Contains all information to reference
/// a single feature in a specific package.
/// </summary>
///
struct FeatureSpec
{
FeatureSpec(const PackageSpec& spec, const std::string& feature) : m_spec(spec), m_feature(feature) { }
const std::string& name() const { return m_spec.name(); }
const std::string& feature() const { return m_feature; }
Triplet triplet() const { return m_spec.triplet(); }
const PackageSpec& spec() const { return m_spec; }
std::string to_string() const;
void to_string(std::string& out) const;
bool operator<(const FeatureSpec& other) const
{
if (name() < other.name()) return true;
if (name() > other.name()) return false;
if (feature() < other.feature()) return true;
if (feature() > other.feature()) return false;
return triplet() < other.triplet();
}
bool operator==(const FeatureSpec& other) const
{
return triplet() == other.triplet() && name() == other.name() && feature() == other.feature();
}
bool operator!=(const FeatureSpec& other) const { return !(*this == other); }
private:
PackageSpec m_spec;
std::string m_feature;
};
///
/// <summary>
/// Full specification of a package. Contains all information to reference
/// a collection of features in a single package.
/// </summary>
///
struct FullPackageSpec
{
PackageSpec package_spec;
std::vector<std::string> features;
FullPackageSpec() noexcept = default;
explicit FullPackageSpec(PackageSpec spec, std::vector<std::string> features = {})
: package_spec(std::move(spec)), features(std::move(features))
{
}
std::vector<FeatureSpec> to_feature_specs(const std::vector<std::string>& default_features,
const std::vector<std::string>& all_features) const;
static ExpectedS<FullPackageSpec> from_string(const std::string& spec_as_string, Triplet default_triplet);
};
///
/// <summary>
/// Contains all information to reference a collection of features in a single package by their names.
/// </summary>
///
struct Features
{
std::string name;
std::vector<std::string> features;
static ExpectedS<Features> from_string(const std::string& input);
};
struct Dependency
{
std::string name;
std::vector<std::string> features;
PlatformExpression::Expr platform;
};
struct ParsedQualifiedSpecifier
{
std::string name;
Optional<std::vector<std::string>> features;
Optional<std::string> triplet;
Optional<PlatformExpression::Expr> platform;
};
Optional<std::string> parse_feature_name(Parse::ParserBase& parser);
Optional<std::string> parse_package_name(Parse::ParserBase& parser);
ExpectedS<ParsedQualifiedSpecifier> parse_qualified_specifier(StringView input);
Optional<ParsedQualifiedSpecifier> parse_qualified_specifier(Parse::ParserBase& parser);
bool operator==(const PackageSpec& left, const PackageSpec& right);
bool operator!=(const PackageSpec& left, const PackageSpec& right);
}
namespace std
{
template<>
struct hash<vcpkg::PackageSpec>
{
size_t operator()(const vcpkg::PackageSpec& value) const
{
size_t hash = 17;
hash = hash * 31 + std::hash<std::string>()(value.name());
hash = hash * 31 + std::hash<vcpkg::Triplet>()(value.triplet());
return hash;
}
};
template<>
struct equal_to<vcpkg::PackageSpec>
{
bool operator()(const vcpkg::PackageSpec& left, const vcpkg::PackageSpec& right) const { return left == right; }
};
template<>
struct hash<vcpkg::FeatureSpec>
{
size_t operator()(const vcpkg::FeatureSpec& value) const
{
size_t hash = std::hash<vcpkg::PackageSpec>()(value.spec());
hash = hash * 31 + std::hash<std::string>()(value.feature());
return hash;
}
};
template<>
struct equal_to<vcpkg::FeatureSpec>
{
bool operator()(const vcpkg::FeatureSpec& left, const vcpkg::FeatureSpec& right) const { return left == right; }
};
}