blob: eb8d0644008ddc48658474eb14ee41e972d98197 (
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
|
/* 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 "cmProperty.h"
#include <string>
/** \class cmPropertyDefinition
* \brief Property meta-information
*
* This class contains the following meta-information about property:
* - Name;
* - Various documentation strings;
* - The scope of the property;
* - If the property is chained.
*/
class cmPropertyDefinition
{
public:
/// Define this property
void DefineProperty(const std::string& name, cmProperty::ScopeType scope,
const char* ShortDescription,
const char* FullDescription, bool chained);
/// Default constructor
cmPropertyDefinition() { this->Chained = false; }
/// Is the property chained?
bool IsChained() const { return this->Chained; }
/// Get the scope
cmProperty::ScopeType GetScope() const { return this->Scope; }
/// 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;
}
protected:
std::string Name;
std::string ShortDescription;
std::string FullDescription;
cmProperty::ScopeType Scope;
bool Chained;
};
#endif
|
