File: cmFindPackageStack.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 (90 lines) | stat: -rw-r--r-- 2,294 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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
/* 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 <set>
#include <string>

#include <cm/optional>

#include "cmStack.h"

class cmMakefile;

/**
 * This data represents the actual contents of find_package
 * <PACKAGE>-Config.cmake or <PACKAGE>.cps file, and not what is passed
 * to the find_package command. They can be the same, but it is not guaranteed.
 */

class cmPackageInformation
{
public:
  cm::optional<std::string> Directory;
  cm::optional<std::string> Version;
  cm::optional<std::string> Description;
  cm::optional<std::string> License;
  cm::optional<std::string> Website;
  cm::optional<std::string> PackageUrl;
  std::set<std::string> Components;
};

/**
 * Represents one call to find_package.
 */
class cmFindPackageCall
{
public:
  std::string const Name;
  cmPackageInformation PackageInfo;
  unsigned int Index;
};

/**
 * RAII type to manage the find_package call stack.
 */
// Note: implemented in cmMakefile.cxx
class cmFindPackageStackRAII
{
  cmMakefile* Makefile;
  cmPackageInformation** Value = nullptr;

public:
  cmFindPackageStackRAII(cmMakefile* mf, std::string const& pkg);
  ~cmFindPackageStackRAII();

  cmFindPackageStackRAII(cmFindPackageStackRAII const&) = delete;
  cmFindPackageStackRAII& operator=(cmFindPackageStackRAII const&) = delete;

  /** Get a mutable pointer to the top of the stack.
      The pointer is invalidated if BindTop is called again or when the
      cmFindPackageStackRAII goes out of scope.  */
  void BindTop(cmPackageInformation*& value);
};

/**
 * Represents a stack of find_package calls with efficient value semantics.
 */
class cmFindPackageStack
  : protected cmStack<cmFindPackageCall, cmFindPackageStack>
{
  using cmStack::cmStack;
  friend cmFindPackageStack::Base;
  friend class cmFindPackageStackRAII;

public:
  using cmStack::Push;
  using cmStack::Pop;
  using cmStack::Empty;

  cmFindPackageCall const& Top() const;
};
#ifndef cmFindPackageStack_cxx
extern template class cmStack<cmFindPackageCall, cmFindPackageStack>;

extern template cmFindPackageCall&
cmStack<cmFindPackageCall, cmFindPackageStack>::Top<true>();
#endif