894f256a12
Implement finding components of CPS packages. Specifically, reject any candidate packages that don't provide all required components, and ignore appendices that don't provide requested (required or optional) components. This applies to both top-level searches and also searching for package dependencies.
87 lines
2.7 KiB
C++
87 lines
2.7 KiB
C++
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
file Copyright.txt or https://cmake.org/licensing for details. */
|
|
#pragma once
|
|
|
|
#include "cmConfigure.h" // IWYU pragma: keep
|
|
|
|
#include <map>
|
|
#include <memory>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
#include <cm/optional>
|
|
#include <cm/string_view>
|
|
|
|
#include <cm3p/json/value.h>
|
|
|
|
#include "cmStateTypes.h"
|
|
|
|
class cmExecutionStatus;
|
|
class cmMakefile;
|
|
class cmTarget;
|
|
|
|
struct cmPackageRequirement
|
|
{
|
|
std::string Name;
|
|
std::string Version;
|
|
std::vector<std::string> Components;
|
|
std::vector<std::string> Hints;
|
|
};
|
|
|
|
/** \class cmPackageInfoReader
|
|
* \brief Read and parse CPS files.
|
|
*
|
|
* This class encapsulates the functionality to read package configuration
|
|
* files which use the Common Package Specification, and provides utilities to
|
|
* translate the declarations therein into imported targets.
|
|
*/
|
|
class cmPackageInfoReader
|
|
{
|
|
public:
|
|
static std::unique_ptr<cmPackageInfoReader> Read(
|
|
std::string const& path, cmPackageInfoReader const* parent = nullptr);
|
|
|
|
std::string GetName() const;
|
|
cm::optional<std::string> GetVersion() const;
|
|
|
|
/// If the package uses the 'simple' version scheme, obtain the version as
|
|
/// a numeric tuple. Returns an empty vector for other schemes or if no
|
|
/// version is specified.
|
|
std::vector<unsigned> ParseVersion() const;
|
|
|
|
std::vector<cmPackageRequirement> GetRequirements() const;
|
|
std::vector<std::string> GetComponentNames() const;
|
|
|
|
/// Create targets for components specified in the CPS file.
|
|
bool ImportTargets(cmMakefile* makefile, cmExecutionStatus& status);
|
|
|
|
/// Add configuration-specific properties for targets.
|
|
bool ImportTargetConfigurations(cmMakefile* makefile,
|
|
cmExecutionStatus& status) const;
|
|
|
|
private:
|
|
cmPackageInfoReader() = default;
|
|
|
|
cmTarget* AddLibraryComponent(cmMakefile* makefile,
|
|
cmStateEnums::TargetType type,
|
|
std::string const& name,
|
|
Json::Value const& data,
|
|
std::string const& package) const;
|
|
|
|
void SetTargetProperties(cmMakefile* makefile, cmTarget* target,
|
|
Json::Value const& data, std::string const& package,
|
|
cm::string_view configuration) const;
|
|
void SetOptionalProperty(cmTarget* target, cm::string_view property,
|
|
cm::string_view configuration,
|
|
Json::Value const& value) const;
|
|
|
|
std::string ResolvePath(std::string path) const;
|
|
|
|
std::string Path;
|
|
Json::Value Data;
|
|
std::string Prefix;
|
|
|
|
std::map<std::string, cmTarget*> ComponentTargets;
|
|
std::vector<std::string> DefaultConfigurations;
|
|
};
|