mirror of
https://github.com/Kitware/CMake.git
synced 2025-10-14 02:08:27 +08:00

We would like to record additional information in the find-package stack, but we don't have the information at the point a stack entry is created. The most sane way to handle this appears to be making the stack mutable, at least under specific circumstances. To facilitate this, we need a mutable stack type. Refactor cmConstStack into cmStack, with the ability to either allow or forbid mutation of its data. Re-add cmConstStack as a type alias. This doesn't yet allow mutating cmFindPackageStack, but it's a necessary step toward being able to do so.
62 lines
1.7 KiB
C++
62 lines
1.7 KiB
C++
/* 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 <memory>
|
|
#include <type_traits>
|
|
|
|
enum class cmStackType
|
|
{
|
|
Const,
|
|
Mutable,
|
|
};
|
|
|
|
template <typename T, cmStackType Mutable>
|
|
struct cmStackEntry;
|
|
|
|
/** Base class template for CRTP to represent a stack of values.
|
|
Copies of the stack <i>share data</i>; mutating data on one copy will
|
|
change the data on <i>all</i> copies. */
|
|
template <typename T, typename Stack,
|
|
cmStackType Mutable = cmStackType::Mutable>
|
|
class cmStack
|
|
{
|
|
using Entry = cmStackEntry<T, Mutable>;
|
|
|
|
std::shared_ptr<Entry const> TopEntry;
|
|
|
|
public:
|
|
/** Default-construct an empty stack. */
|
|
cmStack();
|
|
|
|
/** Get a stack with the given call context added to the top. */
|
|
Stack Push(T value) const;
|
|
|
|
/** Get a stack with the top level removed.
|
|
May not be called until after a matching Push. */
|
|
Stack Pop() const;
|
|
|
|
/** Get the value at the top of the stack.
|
|
This may be called only if Empty() would return false. */
|
|
T const& Top() const;
|
|
template <bool E = (Mutable == cmStackType::Mutable)>
|
|
typename std::enable_if<E, T>::type& Top();
|
|
|
|
/** Return true if this stack is empty. */
|
|
bool Empty() const;
|
|
|
|
protected:
|
|
using Base = cmStack<T, Stack, Mutable>;
|
|
|
|
cmStack(std::shared_ptr<Entry const> parent, T value);
|
|
cmStack(std::shared_ptr<Entry const> top);
|
|
};
|
|
|
|
/** Specialization of cmStack for CRTP to represent a stack of constant values.
|
|
Provide value semantics, but use efficient reference-counting underneath
|
|
to avoid copies. */
|
|
template <typename T, typename Stack>
|
|
using cmConstStack = cmStack<T const, Stack, cmStackType::Const>;
|