blob: f83bc4f742defe659566b535ae2ab376bc20fa69 (
plain)
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
|
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
file Copyright.txt or https://cmake.org/licensing for details. */
#ifndef cmPropertyDefinition_h
#define cmPropertyDefinition_h
#include "cmConfigure.h" // IWYU pragma: keep
#include <map>
#include <string>
#include <utility>
#include "cmProperty.h"
/** \class cmPropertyDefinition
* \brief Property meta-information
*
* This class contains the following meta-information about property:
* - Various documentation strings;
* - If the property is chained.
*/
class cmPropertyDefinition
{
public:
/// Constructor
cmPropertyDefinition(std::string shortDescription,
std::string fullDescription, bool chained);
/// Is the property chained?
bool IsChained() const { return this->Chained; }
/// Get the documentation (short version)
const std::string& GetShortDescription() const
{
return this->ShortDescription;
}
/// Get the documentation (full version)
const std::string& GetFullDescription() const
{
return this->FullDescription;
}
private:
std::string ShortDescription;
std::string FullDescription;
bool Chained;
};
/** \class cmPropertyDefinitionMap
* \brief Map property name and scope to their definition
*/
class cmPropertyDefinitionMap
{
public:
// define the property
void DefineProperty(const std::string& name, cmProperty::ScopeType scope,
const std::string& ShortDescription,
const std::string& FullDescription, bool chain);
// get the property definition if present, otherwise nullptr
cmPropertyDefinition const* GetPropertyDefinition(
const std::string& name, cmProperty::ScopeType scope) const;
private:
using key_type = std::pair<std::string, cmProperty::ScopeType>;
std::map<key_type, cmPropertyDefinition> Map_;
};
#endif
|
