blob: 56dd7afc59a1262e12404c08e9609cd524c0c164 (
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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
/******************************************************************************
*
* Copyright (C) 1997-2015 by Dimitri van Heesch.
*
* Permission to use, copy, modify, and distribute this software and its
* documentation under the terms of the GNU General Public License is hereby
* granted. No representations are made about the suitability of this software
* for any purpose. It is provided "as is" without express or implied warranty.
* See the GNU General Public License for more details.
*
* Documents produced by Doxygen are derivative works derived from the
* input used in their production; they are not affected by this license.
*
*/
#ifndef ARGUMENTS_H
#define ARGUMENTS_H
#include <vector>
#include "qcstring.h"
/*! \brief This class contains the information about the argument of a
* function or template
*
*/
struct Argument
{
/*! return TRUE if this argument is documentation and the argument has a
* non empty name.
*/
bool hasDocumentation() const
{
return !name.isEmpty() && !docs.isEmpty();
}
QCString attrib; /*!< Argument's attribute (IDL only) */
QCString type; /*!< Argument's type */
QCString canType; /*!< Cached value of canonical type (after type resolution). Empty initially. */
QCString name; /*!< Argument's name (may be empty) */
QCString array; /*!< Argument's array specifier (may be empty) */
QCString defval; /*!< Argument's default value (may be empty) */
QCString docs; /*!< Argument's documentation (may be empty) */
QCString typeConstraint; /*!< Used for Java generics: \<T extends C\> */
};
enum RefQualifierType
{
RefQualifierNone,
RefQualifierLValue,
RefQualifierRValue
};
/*! \brief This class represents an function or template argument list.
*
* This class also stores some information about member that is typically
* put after the argument list, such as whether the member is const,
* volatile or pure virtual.
*/
class ArgumentList
{
public:
using Vec = std::vector<Argument>;
using iterator = typename Vec::iterator;
using const_iterator = typename Vec::const_iterator;
/*! Does any argument of this list have documentation? */
bool hasDocumentation() const;
/*! Does this list have zero or more parameters */
bool hasParameters() const
{
return !empty() || m_noParameters;
}
void reset()
{
clear();
m_constSpecifier = FALSE;
m_volatileSpecifier = FALSE;
m_pureSpecifier = FALSE;
m_trailingReturnType.resize(0);
m_isDeleted = FALSE;
m_refQualifier = RefQualifierNone;
m_noParameters = FALSE;
}
// make vector accessible
iterator begin() { return m_args.begin(); }
iterator end() { return m_args.end(); }
const_iterator begin() const { return m_args.cbegin(); }
const_iterator end() const { return m_args.cend(); }
const_iterator cbegin() const { return m_args.cbegin(); }
const_iterator cend() const { return m_args.cend(); }
bool empty() const { return m_args.empty(); }
size_t size() const { return m_args.size(); }
void clear() { m_args.clear(); }
void push_back(const Argument &a) { m_args.push_back(a); }
Argument &back() { return m_args.back(); }
const Argument &back() const { return m_args.back(); }
Argument &front() { return m_args.front(); }
const Argument &front() const { return m_args.front(); }
Argument &at(size_t i) { return m_args.at(i); }
const Argument &at(size_t i) const { return m_args.at(i); }
// getters for list wide attributes
bool constSpecifier() const { return m_constSpecifier; }
bool volatileSpecifier() const { return m_volatileSpecifier; }
bool pureSpecifier() const { return m_pureSpecifier; }
QCString trailingReturnType() const { return m_trailingReturnType; }
bool isDeleted() const { return m_isDeleted; }
RefQualifierType refQualifier() const { return m_refQualifier; }
bool noParameters() const { return m_noParameters; }
void setConstSpecifier(bool b) { m_constSpecifier = b; }
void setVolatileSpecifier(bool b) { m_volatileSpecifier = b; }
void setPureSpecifier(bool b) { m_pureSpecifier = b; }
void setTrailingReturnType(const QCString &s) { m_trailingReturnType = s; }
void setIsDeleted(bool b) { m_isDeleted = b; }
void setRefQualifier(RefQualifierType t) { m_refQualifier = t; }
void setNoParameters(bool b) { m_noParameters = b; }
private:
std::vector<Argument> m_args;
/*! Does the member modify the state of the class? */
bool m_constSpecifier = FALSE;
/*! Is the member volatile? */
bool m_volatileSpecifier = FALSE;
/*! Is this a pure virtual member? */
bool m_pureSpecifier = FALSE;
/*! C++11 style Trailing return type? */
QCString m_trailingReturnType;
/*! method with =delete */
bool m_isDeleted = FALSE;
/*! C++11 ref qualifier */
RefQualifierType m_refQualifier = RefQualifierNone;
/*! is it an explicit empty list */
bool m_noParameters = FALSE;
};
using ArgumentLists = std::vector<ArgumentList>;
#endif
|
