CMake/Source/cmCMakePresetsGraphResolve.cxx

/* Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
   file LICENSE.rst or https://cmake.org/licensing for details.  */
#include <map>
#include <string>
#include <utility>
#include <vector>

#include <cm/optional>

#include "cmCMakePresetsGraph.h"
#include "cmStringAlgorithms.h"
#include "cmUnreachable.h"

template <class T>
cmCMakePresetsGraph::PresetResolveResult<T> cmCMakePresetsGraph::ResolvePreset(
  std::string const& presetName,
  std::map<std::string, PresetPair<T>> const& presets) const
{
  using Result = PresetResolveResult<T>;
  Result result;

  auto presetPair = presets.find(presetName);
  if (presetPair == presets.end()) {
    result.StatusCode = Result::Status::NotFound;
    result.ErrorPresetName = presetName;
    std::vector<std::string> candidates;
    for (auto const& pair : presets) {
      if (!pair.second.Unexpanded.Hidden) {
        candidates.push_back(pair.first);
      }
    }
    result.Suggestion = cmFindClosestString(presetName, candidates);
    return result;
  }
  if (presetPair->second.Unexpanded.Hidden) {
    result.StatusCode = Result::Status::Hidden;
    result.ErrorPresetName = presetName;
    return result;
  }
  if (!presetPair->second.Expanded) {
    result.StatusCode = Result::Status::InvalidMacroExpansion;
    result.ErrorPresetName = presetName;
    return result;
  }
  if (!presetPair->second.Expanded->ConditionResult) {
    result.StatusCode = Result::Status::Disabled;
    result.ErrorPresetName = presetName;
    return result;
  }

  result.Preset = &*presetPair->second.Expanded;
  return result;
}

// Explicit template instantiations
template cmCMakePresetsGraph::PresetResolveResult<
  cmCMakePresetsGraph::ConfigurePreset>
cmCMakePresetsGraph::ResolvePreset(
  std::string const&,
  std::map<std::string,
           PresetPair<cmCMakePresetsGraph::ConfigurePreset>> const&) const;

template cmCMakePresetsGraph::PresetResolveResult<
  cmCMakePresetsGraph::BuildPreset>
cmCMakePresetsGraph::ResolvePreset(
  std::string const&,
  std::map<std::string, PresetPair<cmCMakePresetsGraph::BuildPreset>> const&)
  const;

template cmCMakePresetsGraph::PresetResolveResult<
  cmCMakePresetsGraph::TestPreset>
cmCMakePresetsGraph::ResolvePreset(
  std::string const&,
  std::map<std::string, PresetPair<cmCMakePresetsGraph::TestPreset>> const&)
  const;

template cmCMakePresetsGraph::PresetResolveResult<
  cmCMakePresetsGraph::PackagePreset>
cmCMakePresetsGraph::ResolvePreset(
  std::string const&,
  std::map<std::string, PresetPair<cmCMakePresetsGraph::PackagePreset>> const&)
  const;

template cmCMakePresetsGraph::PresetResolveResult<
  cmCMakePresetsGraph::WorkflowPreset>
cmCMakePresetsGraph::ResolvePreset(
  std::string const&,
  std::map<std::string,
           PresetPair<cmCMakePresetsGraph::WorkflowPreset>> const&) const;

template <class T>
cm::optional<std::string> cmCMakePresetsGraph::FormatPresetError(
  PresetResolveStatus status, std::string const& errorPresetName,
  std::string const& suggestion, std::string const& directory)
{
  using Status = PresetResolveStatus;
  switch (status) {
    case Status::NotFound: {
      std::string error = cmStrCat("No such ", T::kind(), " preset in ",
                                   directory, ": \"", errorPresetName, '"');
      if (!suggestion.empty()) {
        error =
          cmStrCat(std::move(error), ". Did you mean: \"", suggestion, "\"?");
      }
      return error;
    }
    case Status::Hidden:
      return cmStrCat("Cannot use hidden ", T::kind(), " preset in ",
                      directory, ": \"", errorPresetName, '"');
    case Status::InvalidMacroExpansion:
      return cmStrCat("Could not evaluate ", T::kind(), " preset \"",
                      errorPresetName, "\": Invalid macro expansion");
    case Status::Disabled:
      return cmStrCat("Cannot use disabled ", T::kind(), " preset in ",
                      directory, ": \"", errorPresetName, '"');
    case Status::Success:
      return cm::nullopt;
  }
  CM_UNREACHABLE;
  return cm::nullopt;
}

// Explicit template instantiations for FormatPresetError
template cm::optional<std::string>
cmCMakePresetsGraph::FormatPresetError<cmCMakePresetsGraph::ConfigurePreset>(
  PresetResolveStatus, std::string const&, std::string const&,
  std::string const&);

template cm::optional<std::string> cmCMakePresetsGraph::FormatPresetError<
  cmCMakePresetsGraph::BuildPreset>(PresetResolveStatus, std::string const&,
                                    std::string const&, std::string const&);

template cm::optional<std::string> cmCMakePresetsGraph::FormatPresetError<
  cmCMakePresetsGraph::TestPreset>(PresetResolveStatus, std::string const&,
                                   std::string const&, std::string const&);

template cm::optional<std::string> cmCMakePresetsGraph::FormatPresetError<
  cmCMakePresetsGraph::PackagePreset>(PresetResolveStatus, std::string const&,
                                      std::string const&, std::string const&);

template cm::optional<std::string> cmCMakePresetsGraph::FormatPresetError<
  cmCMakePresetsGraph::WorkflowPreset>(PresetResolveStatus, std::string const&,
                                       std::string const&, std::string const&);