cmake/Source/cmPackageInfoReader.h

/* Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
   file LICENSE.rst 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>

class cmExecutionStatus;
class cmMakefile;
class cmTarget;

namespace cm {
enum class ImportedTargetScope;
enum class PackageDomain;
enum class TargetType;
} // namespace cm

struct cmPackageRequirement
{
  std::string Name;
  std::string Version;
  std::vector<std::string> Components;
  std::vector<std::string> Hints;
  std::vector<cm::PackageDomain> Domains;
};

/** \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(
    cmMakefile* makefile, std::string const& path,
    cmPackageInfoReader const* parent = nullptr);

  std::string GetName() const;
  cm::optional<std::string> GetVersion() const;
  cm::optional<std::string> GetCompatVersion() const;

  // NOTE: The eventual intent is for CPS to support multiple version schemas,
  // and in particular, we expect to want to support "simple", "custom", "rpm",
  // "dpkg" and "pep440". Additionally, we desire to be able to parse each of
  // these to the maximum extent possible; in particular, we want to be able
  // to decompose "simple" and "pep440" versions into components represented
  // as numeric types rather than strings, which is not possible with the "rpm"
  // and "dpkg" schemas. Therefore, we require different data structures to
  // represent different version schemas.

  struct Pep440Version
  {
    // NOTE: This structure is currently incomplete as we only support the
    // "simple" schema at this time.
    bool Simple; // "simple" can be represented as a subset of "pep440"
    std::vector<unsigned> ReleaseComponents;
    cm::optional<std::string> LocalLabel;
  };

  // FIXME: Return a sum type (e.g. {cm,std}::variant) of possible versions
  // when we support more than just the "simple" (and possibly "pep440")
  // schema(s).
  /// If the package uses the 'simple' version scheme, parse the provided
  /// version string as a numeric tuple and optional trailing string.  Returns
  /// a disengaged optional for other schemes or if no version is specified.
  cm::optional<Pep440Version> ParseVersion(
    cm::optional<std::string> const& version) const;

  /// Requirements declared by this file, excluding inherited requirements.
  std::vector<cmPackageRequirement> const& GetRequirements() const
  {
    return this->Requirements;
  }
  std::vector<std::string> GetComponentNames() const;

  /// Create targets for components specified in the CPS file.
  bool ImportTargets(cmMakefile* makefile, cmExecutionStatus& status,
                     cm::ImportedTargetScope scope);

  /// Add configuration-specific properties for targets.
  bool ImportTargetConfigurations(cmMakefile* makefile,
                                  cmExecutionStatus& status) const;

private:
  cmPackageInfoReader() = default;

  cmTarget* AddComponent(cmMakefile* makefile, cm::TargetType type,
                         std::string const& name, Json::Value const& data,
                         std::string const& package,
                         cm::ImportedTargetScope scope) const;

  void AddTargetConfiguration(cmTarget* target,
                              cm::string_view configuration) const;

  void AddTargetSources(cmMakefile* makefile, cmTarget* target,
                        Json::Value const& data) const;

  void SetTargetProperties(cmMakefile* makefile, cmTarget* target,
                           Json::Value const& data, std::string const& package,
                           cm::string_view configuration) const;
  void SetImportProperty(cmMakefile* makefile, cmTarget* target,
                         cm::string_view property,
                         cm::string_view configuration,
                         Json::Value const& object,
                         std::string const& attribute) const;
  void SetMetaProperty(cmMakefile* makefile, cmTarget* target,
                       std::string const& property, Json::Value const& object,
                       std::string const& attribute,
                       std::string const& defaultValue = {}) const;
  void ReadCxxModulesMetadata(cmMakefile* makefile, cmTarget* target,
                              cm::string_view configuration,
                              Json::Value const& object) const;

  std::string ResolvePath(std::string path) const;
  std::string ResolveTargetName(cmMakefile* makefile, std::string const& name,
                                std::string const& context) const;

  void ReadRequirements();

  std::string Path;
  Json::Value Data;
  std::string Prefix;
  std::vector<cmPackageRequirement> Requirements;
  std::map<std::string, std::vector<cm::PackageDomain>> RequirementDomains;

  std::map<std::string, cmTarget*> ComponentTargets;
  std::vector<std::string> DefaultConfigurations;
  std::string DefaultLicense;
};