CMake/Source/cmDefinitions.h
Kitware Robot 0b96ae1f6a Revise C++ coding style using clang-format with "east const"
Run the `clang-format.bash` script to update all our C and C++ code to a
new style defined by `.clang-format`, now with "east const" enforcement.
Use `clang-format` version 18.

* If you reached this commit for a line in `git blame`, re-run the blame
  operation starting at the parent of this commit to see older history
  for the content.

* See the parent commit for instructions to rebase a change across this
  style transition commit.

Issue: #26123
2025-01-23 13:09:50 -05:00

68 lines
1.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 <string>
#include <unordered_map>
#include <vector>
#include <cm/string_view>
#include "cmLinkedTree.h"
#include "cmString.hxx"
#include "cmValue.h"
/** \class cmDefinitions
* \brief Store a scope of variable definitions for CMake language.
*
* This stores the state of variable definitions (set or unset) for
* one scope. Sets are always local. Gets search parent scopes
* transitively and save results locally.
*/
class cmDefinitions
{
using StackIter = cmLinkedTree<cmDefinitions>::iterator;
public:
// -- Static member functions
static cmValue Get(std::string const& key, StackIter begin, StackIter end);
static void Raise(std::string const& key, StackIter begin, StackIter end);
static bool HasKey(std::string const& key, StackIter begin, StackIter end);
static std::vector<std::string> ClosureKeys(StackIter begin, StackIter end);
static cmDefinitions MakeClosure(StackIter begin, StackIter end);
// -- Member functions
/** Set a value associated with a key. */
void Set(std::string const& key, cm::string_view value);
/** Unset a definition. */
void Unset(std::string const& key);
private:
/** String with existence boolean. */
struct Def
{
public:
Def() = default;
Def(cm::string_view value)
: Value(value)
{
}
cm::String Value;
};
static Def NoDef;
std::unordered_map<cm::String, Def> Map;
static Def const& GetInternal(std::string const& key, StackIter begin,
StackIter end, bool raise);
};