/src/CMake/Source/cmPackageInfoReader.cxx

Source
/* Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
   file LICENSE.rst or https://cmake.org/licensing for details.  */
#include "cmPackageInfoReader.h"

#include <algorithm>
#include <initializer_list>
#include <limits>
#include <unordered_map>
#include <utility>

#include <cmext/algorithm>
#include <cmext/string_view>

#include <cm3p/json/value.h>
#include <cm3p/json/version.h>

#include "cmsys/RegularExpression.hxx"

#include "cmCxxModuleMetadata.h"
#include "cmExecutionStatus.h"
#include "cmFileSet.h"
#include "cmFileSetMetadata.h"
#include "cmJSONState.h"
#include "cmList.h"
#include "cmListFileCache.h"
#include "cmMakefile.h"
#include "cmMessageType.h"
#include "cmStringAlgorithms.h"
#include "cmSystemTools.h"
#include "cmTarget.h"
#include "cmTargetTypes.h"
#include "cmValue.h"

// When adding or changing CPS schema versions, component types, languages, or
// branch-selecting attributes, review Tests/Fuzzing/cmPackageInfoReader.dict.
// Add tokens including keys that help mutations reach the new paths; keep the
// dictionary focused on useful parser inputs, not an exhaustive list of CPS
// keywords.

namespace {

// Map of CPS language names to CMake language name.  Case insensitivity is
// achieved by converting the CPS value to lower case, so keys in this map must
// be lower case.
std::unordered_map<std::string, std::string> Languages = {
  // clang-format off
  { "c", "C" },
  { "c++", "CXX" },
  { "cpp", "CXX" },
  { "cxx", "CXX" },
  { "objc", "OBJC" },
  { "objc++", "OBJCXX" },
  { "objcpp", "OBJCXX" },
  { "objcxx", "OBJCXX" },
  { "swift", "swift" },
  { "hip", "HIP" },
  { "cuda", "CUDA" },
  { "ispc", "ISPC" },
  { "c#", "CSharp" },
  { "csharp", "CSharp" },
  { "fortran", "Fortran" },
  // clang-format on
};

enum LanguageGlobOption
{
  DisallowGlob,
  AllowGlob,
};

cm::string_view MapLanguage(cm::string_view lang,
                            LanguageGlobOption glob = AllowGlob)
{
  if (glob == AllowGlob && lang == "*"_s) {
    return "*"_s;
  }
  auto const li = Languages.find(cmSystemTools::LowerCase(lang));
  if (li != Languages.end()) {
    return li->second;
  }
  return {};
}

std::string GetRealPath(std::string const& path)
{
  return cmSystemTools::GetRealPath(path);
}

std::string GetRealDir(std::string const& path)
{
  return cmSystemTools::GetFilenamePath(cmSystemTools::GetRealPath(path));
}

Json::Value ReadJson(std::string const& fileName)
{
  Json::Value data;
  cmJSONState parseState(fileName, &data, cmJSONState::StrictMode::Relaxed);
  if (!parseState.errors.empty()) {
#if JSONCPP_VERSION_HEXA < 0x01070300
    return Json::Value::null;
#else
    return Json::Value::nullSingleton();
#endif
  }

  return data;
}

std::string ToString(Json::Value const& value)
{
  if (value.isString()) {
    return value.asString();
  }
  return {};
}

bool CheckSchemaVersion(Json::Value const& data)
{
  std::string const& version = ToString(data["cps_version"]);

  // Check that a valid version is specified.
  if (version.empty()) {
    return false;
  }

  // Check that we understand this version.
  return cmSystemTools::VersionCompare(cmSystemTools::OP_GREATER_EQUAL,
                                       version, "0.13") &&
    cmSystemTools::VersionCompare(cmSystemTools::OP_LESS, version, "0.16");

  // TODO Eventually this probably needs to return the version tuple, and
  // should share code with cmPackageInfoReader::ParseVersion.
}

bool ComparePathSuffix(std::string const& path, std::string const& suffix)
{
  std::string::size_type const ps = path.size();
  std::string::size_type const ss = suffix.size();

  if (ss > ps) {
    return false;
  }

  return cmSystemTools::ComparePath(path.substr(ps - ss), suffix);
}

std::string DeterminePrefix(std::string const& filepath,
                            Json::Value const& data)
{
  // First check if an absolute prefix was supplied.
  std::string prefix = ToString(data["prefix"]);
  if (!prefix.empty()) {
    // Ensure that the specified prefix is valid.
    if (cmsys::SystemTools::FileIsFullPath(prefix) &&
        cmsys::SystemTools::FileIsDirectory(prefix)) {
      cmSystemTools::ConvertToUnixSlashes(prefix);
      return prefix;
    }
    // The specified absolute prefix is not valid.
    return {};
  }

  // Get and validate prefix-relative path.
  std::string const& absPath = cmSystemTools::GetFilenamePath(filepath);
  std::string relPath = ToString(data["cps_path"]);
  cmSystemTools::ConvertToUnixSlashes(relPath);
  if (relPath.empty() || !cmHasLiteralPrefix(relPath, "@prefix@")) {
    // The relative prefix is not valid.
    return {};
  }
  if (relPath.size() == 8) {
    // The relative path is exactly "@prefix@".
    return absPath;
  }
  if (relPath[8] != '/') {
    // The relative prefix is not valid.
    return {};
  }
  relPath = relPath.substr(8);

  // Get directory portion of the absolute path.
  if (ComparePathSuffix(absPath, relPath)) {
    return absPath.substr(0, absPath.size() - relPath.size());
  }

  for (auto* const f : { GetRealPath, GetRealDir }) {
    std::string const& tmpPath = (*f)(absPath);
    if (!cmSystemTools::ComparePath(tmpPath, absPath) &&
        ComparePathSuffix(tmpPath, relPath)) {
      return tmpPath.substr(0, tmpPath.size() - relPath.size());
    }
  }

  return {};
}

// Extract key name from value iterator as string_view.
cm::string_view IterKey(Json::Value::const_iterator iter)
{
  char const* end;
  char const* const start = iter.memberName(&end);
  return { start, static_cast<std::string::size_type>(end - start) };
}

// Get list-of-strings value from object.
std::vector<std::string> ReadList(Json::Value const& arr)
{
  std::vector<std::string> result;

  if (arr.isArray()) {
    for (Json::Value const& val : arr) {
      if (val.isString()) {
        result.push_back(val.asString());
      }
    }
  }

  return result;
}

std::vector<std::string> ReadList(Json::Value const& data, char const* key)
{
  return ReadList(data[key]);
}

Json::Value GetExtensions(Json::Value const& data)
{
  if (data.isObject()) {
    Json::Value const& extensions = data["extensions"];
    if (extensions.isObject()) {
      Json::Value const& cmake = extensions["cmake"];
      if (cmake.isObject()) {
        return cmake;
      }
    }
  }
  return Json::Value{ Json::objectValue };
}

std::string NormalizeTargetName(std::string const& name,
                                std::string const& context)
{
  if (cmHasPrefix(name, ':')) {
    return cmStrCat(context, ':', name);
  }

  std::string::size_type const n = name.find_first_of(':');
  if (n != std::string::npos) {
    cm::string_view v{ name };
    return cmStrCat(v.substr(0, n), ':', v.substr(n));
  }
  return name;
}

void AppendProperty(cmMakefile* makefile, cmTarget* target,
                    cm::string_view property, cm::string_view configuration,
                    std::string const& value)
{
  std::string const fullprop = cmStrCat("INTERFACE_", property);
  if (!configuration.empty()) {
    std::string const genexValue =
      cmStrCat("$<$<CONFIG:", configuration, ">:", value, '>');
    target->AppendProperty(fullprop, genexValue, makefile->GetBacktrace());
  } else {
    target->AppendProperty(fullprop, value, makefile->GetBacktrace());
  }
}

void AppendImportProperty(cmMakefile* makefile, cmTarget* target,
                          cm::string_view property,
                          cm::string_view configuration,
                          std::string const& value)
{
  if (!configuration.empty()) {
    std::string const fullprop = cmStrCat(
      "IMPORTED_", property, '_', cmSystemTools::UpperCase(configuration));
    target->AppendProperty(fullprop, value, makefile->GetBacktrace());
  } else {
    std::string const fullprop = cmStrCat("IMPORTED_", property);
    target->AppendProperty(fullprop, value, makefile->GetBacktrace());
  }
}

template <typename Transform>
void AppendLanguageProperties(cmMakefile* makefile, cmTarget* target,
                              cm::string_view property,
                              cm::string_view configuration,
                              Json::Value const& data, char const* key,
                              Transform transform)
{
  Json::Value const& value = data[key];
  if (value.isArray()) {
    for (std::string v : ReadList(value)) {
      AppendProperty(makefile, target, property, configuration,
                     transform(std::move(v)));
    }
  } else if (value.isObject()) {
    for (auto vi = value.begin(), ve = value.end(); vi != ve; ++vi) {
      cm::string_view const originalLang = IterKey(vi);
      cm::string_view const lang = MapLanguage(originalLang);
      if (lang.empty()) {
        makefile->IssueMessage(MessageType::WARNING,
                               cmStrCat(R"(ignoring unknown language ")"_s,
                                        originalLang, R"(" in )"_s, key,
                                        " for "_s, target->GetName()));
        continue;
      }

      if (lang == "*"_s) {
        for (std::string v : ReadList(*vi)) {
          AppendProperty(makefile, target, property, configuration,
                         transform(std::move(v)));
        }
      } else {
        for (std::string v : ReadList(*vi)) {
          v = cmStrCat("$<$<COMPILE_LANGUAGE:"_s, lang, ">:"_s,
                       transform(std::move(v)), '>');
          AppendProperty(makefile, target, property, configuration, v);
        }
      }
    }
  }
}

void AddCompileFeature(cmMakefile* makefile, cmTarget* target,
                       cm::string_view configuration, std::string const& value)
{
  auto reLanguageLevel = []() -> cmsys::RegularExpression {
    static cmsys::RegularExpression re{ "^[Cc]([+][+])?([0-9][0-9])$" };
    return re;
  }();

  if (reLanguageLevel.find(value)) {
    std::string::size_type const n = reLanguageLevel.end() - 2;
    cm::string_view const featurePrefix = (n == 3 ? "cxx_std_"_s : "c_std_"_s);
    if (configuration.empty()) {
      AppendProperty(makefile, target, "COMPILE_FEATURES"_s, {},
                     cmStrCat(featurePrefix, value.substr(n)));
    } else {
      std::string const& feature =
        cmStrCat("$<$<CONFIG:"_s, configuration, ">:"_s, featurePrefix,
                 value.substr(n), '>');
      AppendProperty(makefile, target, "COMPILE_FEATURES"_s, {}, feature);
    }
  } else if (cmStrCaseEq(value, "gnu"_s)) {
    // Not implemented in CMake at this time
  } else if (cmStrCaseEq(value, "threads"_s)) {
    AppendProperty(makefile, target, "LINK_LIBRARIES"_s, configuration,
                   "Threads::Threads");
  }
}

void AddLinkFeature(cmMakefile* makefile, cmTarget* target,
                    cm::string_view configuration, std::string const& value)
{
  if (cmStrCaseEq(value, "thread"_s)) {
    AppendProperty(makefile, target, "LINK_LIBRARIES"_s, configuration,
                   "Threads::Threads");
  }
}

std::string BuildDefinition(std::string const& name, Json::Value const& value)
{
  if (!value.isNull() && value.isConvertibleTo(Json::stringValue)) {
    return cmStrCat(name, '=', value.asString());
  }
  return name;
}

void AddDefinition(cmMakefile* makefile, cmTarget* target,
                   cm::string_view configuration,
                   std::string const& definition)
{
  AppendProperty(makefile, target, "COMPILE_DEFINITIONS"_s, configuration,
                 definition);
}

using DefinitionLanguageMap = std::map<cm::string_view, Json::Value>;
using DefinitionsMap = std::map<std::string, DefinitionLanguageMap>;

void AddDefinitions(cmMakefile* makefile, cmTarget* target,
                    cm::string_view configuration,
                    DefinitionsMap const& definitions)
{
  for (auto const& di : definitions) {
    auto const& g = di.second.find("*"_s);
    if (g != di.second.end()) {
      std::string const& def = BuildDefinition(di.first, g->second);
      if (di.second.size() == 1) {
        // Only the non-language-specific definition exists.
        AddDefinition(makefile, target, configuration, def);
        continue;
      }

      // Create a genex to apply this definition to all languages except
      // those that override it.
      std::vector<cm::string_view> excludedLanguages;
      for (auto const& li : di.second) {
        if (li.first != "*"_s) {
          excludedLanguages.emplace_back(li.first);
        }
      }
      AddDefinition(makefile, target, configuration,
                    cmStrCat("$<$<NOT:$<COMPILE_LANGUAGE:"_s,
                             cmJoin(excludedLanguages, ","_s), ">>:"_s, def,
                             '>'));
    }

    // Add language-specific definitions.
    for (auto const& li : di.second) {
      if (li.first != "*"_s) {
        AddDefinition(makefile, target, configuration,
                      cmStrCat("$<$<COMPILE_LANGUAGE:"_s, li.first, ">:"_s,
                               BuildDefinition(di.first, li.second), '>'));
      }
    }
  }
}

cm::optional<cmPackageInfoReader::Pep440Version> ParseSimpleVersion(
  std::string const& version)
{
  if (version.empty()) {
    return cm::nullopt;
  }

  cmPackageInfoReader::Pep440Version result;
  result.Simple = true;

  cm::string_view remnant{ version };
  for (;;) {
    // Find the next part separator.
    std::string::size_type const n = remnant.find_first_of(".+-"_s);
    if (n == 0) {
      // The part is an empty string.
      return cm::nullopt;
    }

    // Extract the part as a number.
    cm::string_view const part = remnant.substr(0, n);
    std::string::size_type const l = part.size();
    std::string::size_type p;
    unsigned long const value = std::stoul(std::string{ part }, &p);
    if (p != l || value > std::numeric_limits<unsigned>::max()) {
      // The part was not a valid number or is too big.
      return cm::nullopt;
    }
    result.ReleaseComponents.push_back(static_cast<unsigned>(value));

    // Have we consumed the entire input?
    if (n == std::string::npos) {
      return { std::move(result) };
    }

    // Lop off the current part.
    char const sep = remnant[n];
    remnant = remnant.substr(n + 1);
    if (sep == '+' || sep == '-') {
      // If we hit the local label, we're done.
      result.LocalLabel = remnant;
      return { std::move(result) };
    }

    // We just consumed a '.'; check that there's more.
    if (remnant.empty()) {
      // A trailing part separator is not allowed.
      return cm::nullopt;
    }

    // Continue with the remaining input.
  }

  // Unreachable.
}

} // namespace

std::unique_ptr<cmPackageInfoReader> cmPackageInfoReader::Read(
  cmMakefile* makefile, std::string const& path,
  cmPackageInfoReader const* parent)
{
  // Read file and perform some basic validation:
  //   - the input is valid JSON
  //   - the input is a JSON object
  //   - the input has a "cps_version" that we (in theory) know how to parse
  Json::Value data = ReadJson(path);
  if (!data.isObject() || (!parent && !CheckSchemaVersion(data))) {
    return nullptr;
  }

  //   - the input has a "name" attribute that is a non-empty string
  Json::Value const& name = data["name"];
  if (!name.isString() || name.empty()) {
    return nullptr;
  }

  //   - the input has a "components" attribute that is a JSON object
  if (!data["components"].isObject()) {
    return nullptr;
  }

  std::string prefix = (parent ? parent->Prefix : DeterminePrefix(path, data));
  if (prefix.empty()) {
    return nullptr;
  }

  // Seems sane enough to hand back to the caller.
  std::unique_ptr<cmPackageInfoReader> reader{ new cmPackageInfoReader };
  reader->Data = std::move(data);
  reader->Prefix = std::move(prefix);
  reader->Path = path;

  // Determine other information we need to know immediately, or (if this is
  // a supplemental reader) copy from the parent.
  if (parent) {
    reader->ComponentTargets = parent->ComponentTargets;
    reader->DefaultConfigurations = parent->DefaultConfigurations;
    reader->RequirementDomains = parent->RequirementDomains;
  } else {
    for (std::string const& config :
         ReadList(reader->Data, "configurations")) {
      reader->DefaultConfigurations.emplace_back(
        cmSystemTools::UpperCase(config));
    }
  }

  // Read package-level requirements. (Configuration supplements are not
  // allowed to declare package requirements.)
  if (cmSystemTools::GetFilenameName(path).find('@') == std::string::npos) {
    reader->ReadRequirements();
  }

  // Check for a default license.
  Json::Value const& defaultLicense = reader->Data["default_license"];
  if (!defaultLicense.isNull()) {
    if (defaultLicense.isString()) {
      reader->DefaultLicense = defaultLicense.asString();
    } else {
      makefile->IssueMessage(
        MessageType::WARNING,
        "Package attribute \"default_license\" is not a string.");
    }
  } else if (parent) {
    reader->DefaultLicense = parent->DefaultLicense;
  } else {
    // If there is no 'default_license', check for 'license'. Note that we
    // intentionally allow `default_license` on an appendix to override the
    // parent, but we do not consider `license` on an appendix. This is
    // consistent with not allowing LICENSE and APPENDIX to be used together.
    Json::Value const& packageLicense = reader->Data["license"];
    if (!packageLicense.isNull()) {
      if (packageLicense.isString()) {
        reader->DefaultLicense = packageLicense.asString();
      } else {
        makefile->IssueMessage(
          MessageType::WARNING,
          "Package attribute \"license\" is not a string.");
      }
    }
  }

  return reader;
}

std::string cmPackageInfoReader::GetName() const
{
  return ToString(this->Data["name"]);
}

cm::optional<std::string> cmPackageInfoReader::GetVersion() const
{
  Json::Value const& version = this->Data["version"];
  if (version.isString()) {
    return version.asString();
  }
  return cm::nullopt;
}

cm::optional<std::string> cmPackageInfoReader::GetCompatVersion() const
{
  Json::Value const& version = this->Data["compat_version"];
  if (version.isString()) {
    return version.asString();
  }
  return cm::nullopt;
}

cm::optional<cmPackageInfoReader::Pep440Version>
cmPackageInfoReader::ParseVersion(
  cm::optional<std::string> const& version) const
{
  // Check that we have a version.
  if (!version) {
    return cm::nullopt;
  }

  // Check if we know how to parse the version.
  Json::Value const& schema = this->Data["version_schema"];
  if (schema.isNull() || cmStrCaseEq(ToString(schema), "simple"_s)) {
    return ParseSimpleVersion(*version);
  }

  return cm::nullopt;
}

void cmPackageInfoReader::ReadRequirements()
{
  auto const& requirementObjects = this->Data["requires"];
  if (!requirementObjects.isObject()) {
    return;
  }

  for (auto ri = requirementObjects.begin(), re = requirementObjects.end();
       ri != re; ++ri) {
    if (!ri->isObject() && !ri->isNull()) {
      continue;
    }
    cmPackageRequirement r{ ri.name(),
                            ToString((*ri)["version"]),
                            ReadList(*ri, "components"),
                            ReadList(*ri, "hints"),
                            {} };
    for (std::string const& domain :
         ReadList(GetExtensions(*ri), "domains@v1")) {
      r.Domains.push_back(domain == "pkg-config" ? cm::PackageDomain::PkgConfig
                                                 : cm::PackageDomain::Unknown);
    }
    if (!r.Domains.empty()) {
      this->RequirementDomains[r.Name] = r.Domains;
    } else {
      // A local declaration without domains clears any inherited domains.
      this->RequirementDomains.erase(r.Name);
    }
    this->Requirements.emplace_back(std::move(r));
  }
}

std::string cmPackageInfoReader::ResolveTargetName(
  cmMakefile* makefile, std::string const& name,
  std::string const& context) const
{
  // A pkg-config package is exposed as a single component of the same name.
  // Only resolve it to a foreign target if this requirement opts in.
  std::string::size_type const n = name.find(':');
  if (n != std::string::npos && n > 0 &&
      name.substr(0, n) == name.substr(n + 1)) {
    std::string const package = name.substr(0, n);
    auto const di = this->RequirementDomains.find(package);
    if (di != this->RequirementDomains.end() &&
        cm::contains(di->second, cm::PackageDomain::PkgConfig)) {
      if (cmTarget* foreignTarget =
            makefile->FindForeignTarget("pkgcfg", package)) {
        return foreignTarget->GetName();
      }
    }
  }

  return NormalizeTargetName(name, context);
}

std::vector<std::string> cmPackageInfoReader::GetComponentNames() const
{
  std::vector<std::string> componentNames;

  Json::Value const& components = this->Data["components"];
  for (auto ci = components.begin(), ce = components.end(); ci != ce; ++ci) {
    componentNames.emplace_back(ci.name());
  }

  return componentNames;
}

std::string cmPackageInfoReader::ResolvePath(std::string path) const
{
  cmSystemTools::ConvertToUnixSlashes(path);
  if (cmHasPrefix(path, "@prefix@"_s)) {
    return cmStrCat(this->Prefix, path.substr(8));
  }
  if (!cmSystemTools::FileIsFullPath(path)) {
    return cmStrCat(cmSystemTools::GetFilenamePath(this->Path), '/', path);
  }
  return path;
}

void cmPackageInfoReader::AddTargetConfiguration(
  cmTarget* target, cm::string_view configuration) const
{
  static std::string const icProp = "IMPORTED_CONFIGURATIONS";

  std::string const& configUpper = cmSystemTools::UpperCase(configuration);

  // Get existing list of imported configurations.
  cmList configs;
  if (cmValue v = target->GetProperty(icProp)) {
    configs.assign(cmSystemTools::UpperCase(*v));
  } else {
    // If the existing list is empty, just add the new one and return.
    target->SetProperty(icProp, configUpper);
    return;
  }

  if (cm::contains(configs, configUpper)) {
    // If the configuration is already listed, we don't need to do anything.
    return;
  }

  // Add the new configuration.
  configs.append(configUpper);

  // Rebuild the configuration list by extracting any configuration in the
  // default configurations and reinserting it at the beginning of the list
  // according to the order of the default configurations.
  std::vector<std::string> newConfigs;
  for (std::string const& c : this->DefaultConfigurations) {
    auto ci = std::find(configs.begin(), configs.end(), c);
    if (ci != configs.end()) {
      newConfigs.emplace_back(std::move(*ci));
      configs.erase(ci);
    }
  }
  for (std::string& c : configs) {
    newConfigs.emplace_back(std::move(c));
  }

  target->SetProperty("IMPORTED_CONFIGURATIONS", cmJoin(newConfigs, ";"_s));
}

void cmPackageInfoReader::SetImportProperty(cmMakefile* makefile,
                                            cmTarget* target,
                                            cm::string_view property,
                                            cm::string_view configuration,
                                            Json::Value const& object,
                                            std::string const& attribute) const
{
  Json::Value const& value = object[attribute];
  if (!value.isNull()) {
    std::string fullprop;
    if (configuration.empty()) {
      fullprop = cmStrCat("IMPORTED_"_s, property);
    } else {
      fullprop = cmStrCat("IMPORTED_"_s, property, '_',
                          cmSystemTools::UpperCase(configuration));
    }

    if (value.isString()) {
      target->SetProperty(fullprop, this->ResolvePath(value.asString()));
    } else {
      makefile->IssueMessage(MessageType::WARNING,
                             cmStrCat("Failed to set property \""_s, property,
                                      "\" on target \""_s, target->GetName(),
                                      "\": attribute \"", attribute,
                                      "\" is not a string."_s));
    }
  }
}

void cmPackageInfoReader::SetMetaProperty(
  cmMakefile* makefile, cmTarget* target, std::string const& property,
  Json::Value const& object, std::string const& attribute,
  std::string const& defaultValue) const
{
  Json::Value const& value = object[attribute];
  if (!value.isNull()) {
    if (value.isString()) {
      target->SetProperty(property, value.asString());
    } else {
      makefile->IssueMessage(MessageType::WARNING,
                             cmStrCat("Failed to set property \""_s, property,
                                      "\" on target \""_s, target->GetName(),
                                      "\": attribute \"", attribute,
                                      "\" is not a string."_s));
    }
  } else if (!defaultValue.empty()) {
    target->SetProperty(property, defaultValue);
  }
}

void cmPackageInfoReader::SetTargetProperties(
  cmMakefile* makefile, cmTarget* target, Json::Value const& data,
  std::string const& package, cm::string_view configuration) const
{
  // Add configuration (if applicable).
  if (!configuration.empty()) {
    this->AddTargetConfiguration(target, configuration);
  }

  // Add compile and link features.
  for (std::string const& def : ReadList(data, "compile_features")) {
    AddCompileFeature(makefile, target, configuration, def);
  }

  for (std::string const& def : ReadList(data, "link_features")) {
    AddLinkFeature(makefile, target, configuration, def);
  }

  // Add compile and link flags.
  AppendLanguageProperties(
    makefile, target, "COMPILE_OPTIONS"_s, configuration, data,
    "compile_flags", [](std::string flag) -> std::string { return flag; });

  for (std::string const& flag : ReadList(data, "link_flags")) {
    AppendProperty(makefile, target, "LINK_OPTIONS"_s, configuration, flag);
  }

  // Add compile definitions.
  Json::Value const& defs = data["definitions"];
  DefinitionsMap definitionsMap;
  for (auto ldi = defs.begin(), lde = defs.end(); ldi != lde; ++ldi) {
    cm::string_view const originalLang = IterKey(ldi);
    cm::string_view const lang = MapLanguage(originalLang);
    if (lang.empty()) {
      makefile->IssueMessage(
        MessageType::WARNING,
        cmStrCat(R"(ignoring unknown language ")"_s, originalLang,
                 R"(" in definitions for )"_s, target->GetName()));
      continue;
    }

    for (auto di = ldi->begin(), de = ldi->end(); di != de; ++di) {
      definitionsMap[di.name()].emplace(lang, *di);
    }
  }
  AddDefinitions(makefile, target, configuration, definitionsMap);

  // Add include directories.
  AppendLanguageProperties(makefile, target, "INCLUDE_DIRECTORIES"_s,
                           configuration, data, "includes",
                           [this](std::string p) -> std::string {
                             return this->ResolvePath(std::move(p));
                           });

  // Add link name/location(s).
  this->SetImportProperty(makefile, target, "LOCATION"_s, // br
                          configuration, data, "location");

  this->SetImportProperty(makefile, target, "IMPLIB"_s, // br
                          configuration, data, "link_location");

  this->SetImportProperty(makefile, target, "SONAME"_s, // br
                          configuration, data, "link_name");

  // Add link languages.
  for (std::string const& originalLang : ReadList(data, "link_languages")) {
    cm::string_view const lang = MapLanguage(originalLang, DisallowGlob);
    if (!lang.empty()) {
      AppendProperty(makefile, target, "LINK_LANGUAGES"_s, configuration,
                     std::string{ lang });
    }
  }

  // Add transitive dependencies.
  for (std::string const& dep : ReadList(data, "requires")) {
    AppendProperty(makefile, target, "LINK_LIBRARIES"_s, configuration,
                   this->ResolveTargetName(makefile, dep, package));
  }

  for (std::string const& dep : ReadList(data, "compile_requires")) {
    std::string const& lib =
      cmStrCat("$<COMPILE_ONLY:"_s,
               this->ResolveTargetName(makefile, dep, package), '>');
    AppendProperty(makefile, target, "LINK_LIBRARIES"_s, configuration, lib);
  }

  for (std::string const& dep : ReadList(data, "link_requires")) {
    std::string const& lib = cmStrCat(
      "$<LINK_ONLY:"_s, this->ResolveTargetName(makefile, dep, package), '>');
    AppendProperty(makefile, target, "LINK_LIBRARIES"_s, configuration, lib);
  }

  for (std::string const& dep : ReadList(data, "dyld_requires")) {
    AppendImportProperty(makefile, target, "LINK_DEPENDENT_LIBRARIES"_s,
                         configuration,
                         this->ResolveTargetName(makefile, dep, package));
  }

  for (std::string const& lib : ReadList(data, "link_libraries")) {
    AppendProperty(makefile, target, "LINK_LIBRARIES"_s, configuration, lib);
  }

  // TODO: Handle non-configuration modules
  // once IMPORTED_CXX_MODULES supports it
  if (!configuration.empty()) {
    this->ReadCxxModulesMetadata(makefile, target, configuration, data);
  }

  // Add other information.
  if (configuration.empty()) {
    this->SetMetaProperty(makefile, target, "SPDX_LICENSE", data, "license",
                          this->DefaultLicense);
  }
}

void cmPackageInfoReader::ReadCxxModulesMetadata(
  cmMakefile* makefile, cmTarget* target, cm::string_view configuration,
  Json::Value const& object) const
{
#ifndef CMAKE_BOOTSTRAP
  Json::Value const& path = object["cpp_module_metadata"];

  if (!path.isString()) {
    return;
  }

  cmCxxModuleMetadata::ParseResult result =
    cmCxxModuleMetadata::LoadFromFile(this->ResolvePath(path.asString()));

  if (!result) {
    makefile->IssueMessage(
      MessageType::WARNING,
      cmStrCat("Error parsing module manifest:\n"_s, result.Error));
    return;
  }

  cmCxxModuleMetadata::PopulateTarget(*target, *result.Meta, configuration);
#endif
}

cmTarget* cmPackageInfoReader::AddComponent(
  cmMakefile* makefile, cm::TargetType type, std::string const& name,
  Json::Value const& data, std::string const& package,
  cm::ImportedTargetScope scope) const
{
  // Create the imported target.
  cmTarget* const target = makefile->AddImportedTarget(name, type, scope);
  target->SetOrigin(cmTarget::Origin::Cps);

  // Set target properties.
  this->SetTargetProperties(makefile, target, data, package, {});
  auto const& cfgData = data["configurations"];
  if (cfgData.isObject()) {
    for (auto ci = cfgData.begin(), ce = cfgData.end(); ci != ce; ++ci) {
      cm::string_view const cfgName = IterKey(ci);
      Json::Value const& cfgObj = *ci;
      if (cfgObj.isObject()) {
        this->SetTargetProperties(makefile, target, cfgObj, package, cfgName);
      } else if (!cfgObj.isNull()) {
        makefile->IssueMessage(MessageType::WARNING,
                               cmStrCat("Component \""_s, name,
                                        "\" configuration \""_s, cfgName,
                                        "\" is not an object."_s));
      }
    }
  } else if (!cfgData.isNull()) {
    makefile->IssueMessage(
      MessageType::WARNING,
      cmStrCat(R"(Component ")"_s, name,
               R"(" attribute "configurations" is not an object.)"_s));
  }

  // Add target sources.
  this->AddTargetSources(makefile, target, data["file_sets"]);

  return target;
}

void cmPackageInfoReader::AddTargetSources(cmMakefile* makefile,
                                           cmTarget* target,
                                           Json::Value const& data) const
{
  if (data.isArray()) {
    for (Json::Value const& fs : data) {
      if (fs.isObject()) {
        std::string const& type = ToString(fs["type"]);
        std::string const& root = this->ResolvePath(ToString(fs["root"]));
        std::vector<std::string> files = ReadList(fs["files"]);

        if (files.empty() || root.empty() || type != "includes") {
          continue;
        }

        Json::Value const& ext = GetExtensions(fs);
        std::string const& name = [&] {
          std::string const& extName = ToString(ext["name@v1"]);
          if (!extName.empty()) {
            return extName;
          }
          return std::string{ cm::FileSetMetadata::HEADERS };
        }();

        // TODO: When we support more than one file set type, check that we
        // don't see the same 'name' on sets of different types.
        auto fileSet = target->GetOrCreateFileSet(
          name, std::string{ cm::FileSetMetadata::HEADERS },
          cm::FileSetMetadata::Visibility::Interface);
        cmListFileBacktrace const& bt = makefile->GetBacktrace();

        for (std::string& file : files) {
          file = cmStrCat(root, '/', std::move(file));
        }
        fileSet.first->AddFileEntry(
          BT<std::string>{ cmList{ files }.to_string(), bt });

        fileSet.first->AddDirectoryEntry(BT<std::string>{ root, bt });
      }
    }
  }
}

bool cmPackageInfoReader::ImportTargets(cmMakefile* makefile,
                                        cmExecutionStatus& status,
                                        cm::ImportedTargetScope scope)
{
  std::string const& package = this->GetName();

  // Read components.
  Json::Value const& components = this->Data["components"];

  for (auto ci = components.begin(), ce = components.end(); ci != ce; ++ci) {
    cm::string_view const name = IterKey(ci);

    // Get and validate full target name.
    std::string const& fullName = cmStrCat(package, "::"_s, name);
    {
      std::string msg;
      if (!makefile->EnforceUniqueName(fullName, msg)) {
        status.SetError(msg);
        return false;
      }
    }

    Json::Value const& component = *ci;
    if (!component.isObject()) {
      makefile->IssueMessage(
        MessageType::WARNING,
        cmStrCat(R"(Component ")"_s, fullName, R"(" is not an object.)"_s));
      continue;
    }

    auto createTarget = [&](cm::TargetType typeEnum) {
      return this->AddComponent(makefile, typeEnum, fullName, component,
                                package, scope);
    };

    cmTarget* target = nullptr;
    std::string const& type =
      cmSystemTools::LowerCase(ToString(component["type"]));
    if (type == "symbolic"_s) {
      target = createTarget(cm::TargetType::INTERFACE_LIBRARY);
      target->SetSymbolic(true);
    } else if (type == "executable"_s) {
      target = createTarget(cm::TargetType::EXECUTABLE);
    } else if (type == "dylib"_s) {
      target = createTarget(cm::TargetType::SHARED_LIBRARY);
    } else if (type == "module"_s) {
      target = createTarget(cm::TargetType::MODULE_LIBRARY);
    } else if (type == "archive"_s) {
      target = createTarget(cm::TargetType::STATIC_LIBRARY);
    } else if (type == "interface"_s) {
      target = createTarget(cm::TargetType::INTERFACE_LIBRARY);
    } else {
      makefile->IssueMessage(MessageType::WARNING,
                             cmStrCat(R"(component ")"_s, fullName,
                                      R"(" has unknown type ")"_s, type,
                                      R"(" and was not imported)"_s));
    }

    if (target) {
      this->ComponentTargets.emplace(std::string{ name }, target);
    }
  }

  // Read default components.
  std::vector<std::string> const& defaultComponents =
    ReadList(this->Data, "default_components");
  if (!defaultComponents.empty()) {
    std::string msg;
    if (!makefile->EnforceUniqueName(package, msg)) {
      status.SetError(msg);
      return false;
    }

    cmTarget* const target = makefile->AddImportedTarget(
      package, cm::TargetType::INTERFACE_LIBRARY, scope);
    for (std::string const& name : defaultComponents) {
      std::string const& fullName = cmStrCat(package, "::"_s, name);
      AppendProperty(makefile, target, "LINK_LIBRARIES"_s, {}, fullName);
    }
    target->SetExportPassthrough(true);
  }

  return true;
}

bool cmPackageInfoReader::ImportTargetConfigurations(
  cmMakefile* makefile, cmExecutionStatus& status) const
{
  std::string const& configuration = ToString(this->Data["configuration"]);

  if (configuration.empty()) {
    makefile->IssueMessage(MessageType::WARNING,
                           cmStrCat("supplemental file "_s, this->Path,
                                    " does not specify a configuration"_s));
    return true;
  }

  std::string const& package = this->GetName();
  Json::Value const& components = this->Data["components"];

  for (auto ci = components.begin(), ce = components.end(); ci != ce; ++ci) {
    // Get component name and look up target.
    cm::string_view const name = IterKey(ci);
    auto const& ti = this->ComponentTargets.find(std::string{ name });
    if (ti == this->ComponentTargets.end()) {
      status.SetError(cmStrCat("component "_s, name, " was not found"_s));
      return false;
    }

    // Read supplemental data for component.
    if (!ci->isObject()) {
      makefile->IssueMessage(
        MessageType::WARNING,
        cmStrCat("Component \""_s, name, "\" is not an object."_s));
      continue;
    }
    this->SetTargetProperties(makefile, ti->second, *ci, package,
                              configuration);
  }

  return true;
}

Coverage Report

Created: 2026-10-28 06:38