CMake/Source/cmDefinitions.h
Sebastian Holtermann e268840c0a cmDefinitions: Add Unset and cm::string_view based Set methods
- The `cmDefinitions::Def` struct is simplified by removing an unused
  constructor and the `std_string` type definition.  The std::string value
  becomes a member variable instead of being derived from.

- The `cmDefinitions::Unset` method is added that unsets a definition.
  It has the same functionality as calling `cmDefinitions::Set` with a
  `nullptr` value argument,

- The `cmDefinitions::Set` method gets an overloaded version that takes a
  `cm::string_view` as value argument.

- The originl `cmDefinitions::Set` method with `const char*` argument is
  refactored to either call the `cm::string_view` based `cmDefinitions::Set`
  overload or `cmDefinitions::Unset`, depending on whether the value
  `const char*` is a nullptr (`Unset`) or not (`Set`).
2019-07-24 11:11:25 +02:00

82 lines
2.1 KiB
C++

/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
file Copyright.txt or https://cmake.org/licensing for details. */
#ifndef cmDefinitions_h
#define cmDefinitions_h
#include "cmConfigure.h" // IWYU pragma: keep
#include "cm_string_view.hxx"
#include "cmLinkedTree.h"
#include <string>
#include <unordered_map>
#include <vector>
/** \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
{
typedef cmLinkedTree<cmDefinitions>::iterator StackIter;
public:
static const std::string* Get(const std::string& key, StackIter begin,
StackIter end);
static void Raise(const std::string& key, StackIter begin, StackIter end);
static bool HasKey(const std::string& key, StackIter begin, StackIter end);
/** Set (or unset if null) a value associated with a key. */
void Set(const std::string& key, const char* value)
{
if (value) {
this->Set(key, cm::string_view(value));
} else {
this->Unset(key);
}
}
/** Set a value associated with a key. */
void Set(const std::string& key, cm::string_view value);
/** Unset a definition. */
void Unset(const std::string& key);
std::vector<std::string> UnusedKeys() const;
static std::vector<std::string> ClosureKeys(StackIter begin, StackIter end);
static cmDefinitions MakeClosure(StackIter begin, StackIter end);
private:
/** String with existence boolean. */
struct Def
{
public:
Def() = default;
Def(cm::string_view value)
: Value(value)
, Exists(true)
{
}
std::string Value;
bool Exists = false;
bool Used = false;
};
static Def NoDef;
typedef std::unordered_map<std::string, Def> MapType;
MapType Map;
static Def const& GetInternal(const std::string& key, StackIter begin,
StackIter end, bool raise);
};
#endif