File: cmStack.h

package info (click to toggle)
cmake 4.2.1-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 152,348 kB
  • sloc: ansic: 403,894; cpp: 303,807; sh: 4,097; python: 3,582; yacc: 3,106; lex: 1,279; f90: 538; asm: 471; lisp: 375; cs: 270; java: 266; fortran: 239; objc: 215; perl: 213; xml: 198; makefile: 108; javascript: 83; pascal: 63; tcl: 55; php: 25; ruby: 22
file content (61 lines) | stat: -rw-r--r-- 1,783 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
/* 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>;