mirror of
https://github.com/Kitware/CMake.git
synced 2026-01-07 06:09:52 -06:00
3d52d70b84
Add initial support for exporting (install only, for now) Common Package Specification (https://cps-org.github.io/cps/) format package descriptions. This has some limitations, such as not supporting generator expressions (as these cannot be portably exported), and only partially supporting transitive dependencies, but should be usable for at least some simple cases. (Actually, $<LINK_ONLY> is theoretically supportable, but is not yet implemented.) This still needs tests; these will be added in the next commit. Other potential improvements include support for language-specific compile definitions and inferring some package properties from project properties. Additionally, there is no module support yet; this is partly pending on having a tool agnostic format for providing the necessary information.
117 lines
4.0 KiB
C++
117 lines
4.0 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 <iosfwd>
|
|
#include <map>
|
|
#include <set>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
#include <cm/string_view>
|
|
|
|
#include "cmExportFileGenerator.h"
|
|
#include "cmStateTypes.h"
|
|
|
|
class cmGeneratorTarget;
|
|
namespace Json {
|
|
class Value;
|
|
}
|
|
|
|
/** \class cmExportPackageInfoGenerator
|
|
* \brief Generate Common Package Specification package information files
|
|
* exporting targets from a build or install tree.
|
|
*
|
|
* cmExportPackageInfoGenerator is the superclass for
|
|
* cmExportBuildPackageInfoGenerator and cmExportInstallPackageInfoGenerator.
|
|
* It contains common code generation routines for the two kinds of export
|
|
* implementations.
|
|
*/
|
|
class cmExportPackageInfoGenerator : virtual public cmExportFileGenerator
|
|
{
|
|
public:
|
|
cmExportPackageInfoGenerator(std::string packageName, std::string version,
|
|
std::string versionCompat,
|
|
std::string versionSchema,
|
|
std::vector<std::string> defaultTargets,
|
|
std::vector<std::string> defaultConfigurations);
|
|
|
|
using cmExportFileGenerator::GenerateImportFile;
|
|
|
|
protected:
|
|
std::string const& GetPackageName() const { return this->PackageName; }
|
|
|
|
void WritePackageInfo(Json::Value const& packageInfo,
|
|
std::ostream& os) const;
|
|
|
|
// Methods to implement export file code generation.
|
|
bool GenerateImportFile(std::ostream& os) override;
|
|
|
|
bool CheckDefaultTargets() const;
|
|
|
|
Json::Value GeneratePackageInfo() const;
|
|
Json::Value* GenerateImportTarget(Json::Value& components,
|
|
cmGeneratorTarget const* target,
|
|
cmStateEnums::TargetType targetType) const;
|
|
|
|
void GeneratePackageRequires(Json::Value& package) const;
|
|
|
|
using ImportPropertyMap = std::map<std::string, std::string>;
|
|
bool GenerateInterfaceProperties(Json::Value& component,
|
|
cmGeneratorTarget const* target,
|
|
ImportPropertyMap const& properties) const;
|
|
void GenerateInterfaceConfigProperties(
|
|
Json::Value& components, cmGeneratorTarget const* target,
|
|
std::string const& suffix, ImportPropertyMap const& properties) const;
|
|
|
|
cm::string_view GetImportPrefixWithSlash() const override;
|
|
|
|
std::string GetCxxModuleFile(std::string const& /*name*/) const override
|
|
{
|
|
// TODO
|
|
return {};
|
|
}
|
|
|
|
void GenerateCxxModuleConfigInformation(std::string const& /*name*/,
|
|
std::ostream& /*os*/) const override
|
|
{
|
|
// TODO
|
|
}
|
|
|
|
bool NoteLinkedTarget(cmGeneratorTarget const* target,
|
|
std::string const& linkedName,
|
|
cmGeneratorTarget const* linkedTarget) override;
|
|
|
|
private:
|
|
void GenerateInterfaceLinkProperties(
|
|
bool& result, Json::Value& component, cmGeneratorTarget const* target,
|
|
ImportPropertyMap const& properties) const;
|
|
|
|
void GenerateInterfaceCompileFeatures(
|
|
bool& result, Json::Value& component, cmGeneratorTarget const* target,
|
|
ImportPropertyMap const& properties) const;
|
|
|
|
void GenerateInterfaceCompileDefines(
|
|
bool& result, Json::Value& component, cmGeneratorTarget const* target,
|
|
ImportPropertyMap const& properties) const;
|
|
|
|
void GenerateInterfaceListProperty(
|
|
bool& result, Json::Value& component, cmGeneratorTarget const* target,
|
|
std::string const& outName, cm::string_view inName,
|
|
ImportPropertyMap const& properties) const;
|
|
|
|
std::string const PackageName;
|
|
std::string const PackageVersion;
|
|
std::string const PackageVersionCompat;
|
|
std::string const PackageVersionSchema;
|
|
std::vector<std::string> DefaultTargets;
|
|
std::vector<std::string> DefaultConfigurations;
|
|
|
|
std::map<std::string, std::string> LinkTargets;
|
|
std::set<std::string> Requirements;
|
|
|
|
static constexpr char const* CPS_VERSION_STR = "0.12.0";
|
|
};
|