The ArgumentList Class Reference

This class represents an function or template argument list. More...

Declaration

class ArgumentList { ... }

Included Headers

#include <src/arguments.h>

Public Member Typedefs Index

using	Vec = std::vector< Argument >
using	iterator = typename Vec::iterator
using	const_iterator = typename Vec::const_iterator

Public Member Functions Index

bool	hasDocumentation () const
bool	hasTemplateDocumentation () const
bool	hasParameters () const
void	reset ()
iterator	begin ()
iterator	end ()
const_iterator	begin () const
const_iterator	end () const
const_iterator	cbegin () const
const_iterator	cend () const
bool	empty () const
size_t	size () const
void	clear ()
void	push_back (const Argument &a)
Argument &	back ()
const Argument &	back () const
Argument &	front ()
const Argument &	front () const
Argument &	at (size_t i)
const Argument &	at (size_t i) const
bool	constSpecifier () const
bool	volatileSpecifier () const
bool	pureSpecifier () const
QCString	trailingReturnType () const
bool	isDeleted () const
RefQualifierType	refQualifier () const
bool	noParameters () const
void	setConstSpecifier (bool b)
void	setVolatileSpecifier (bool b)
void	setPureSpecifier (bool b)
void	setTrailingReturnType (const QCString &s)
void	setIsDeleted (bool b)
void	setRefQualifier (RefQualifierType t)
void	setNoParameters (bool b)

Private Member Attributes Index

std::vector< Argument >	m_args
bool	m_constSpecifier = FALSE
bool	m_volatileSpecifier = FALSE
bool	m_pureSpecifier = FALSE
QCString	m_trailingReturnType
bool	m_isDeleted = FALSE
RefQualifierType	m_refQualifier = RefQualifierType::None
bool	m_noParameters = FALSE

Description

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.

Definition at line 64 of file arguments.h.

Public Member Typedefs

const_iterator

using ArgumentList::const_iterator = typename Vec::const_iterator

Definition at line 69 of file arguments.h.

69 using const_iterator = typename Vec::const_iterator;

iterator

using ArgumentList::iterator = typename Vec::iterator

Definition at line 68 of file arguments.h.

68 using iterator = typename Vec::iterator;

Vec

using ArgumentList::Vec = std::vector<Argument>

Definition at line 67 of file arguments.h.

67 using Vec = std::vector<Argument>;

Public Member Functions

at()

Argument & ArgumentList::at (size_t i)

inline

Definition at line 107 of file arguments.h.

107 Argument &at(size_t i) { return m_args.at(i); }

Reference m_args.

Referenced by makeQualifiedNameWithTemplateParameters.

at()

const Argument & ArgumentList::at (size_t i)

inline

Definition at line 108 of file arguments.h.

108 const Argument &at(size_t i) const { return m_args.at(i); }

Reference m_args.

back()

Argument & ArgumentList::back ()

inline

Definition at line 103 of file arguments.h.

103 Argument &back() { return m_args.back(); }

Reference m_args.

back()

const Argument & ArgumentList::back ()

inline

Definition at line 104 of file arguments.h.

104 const Argument &back() const { return m_args.back(); }

Reference m_args.

begin()

iterator ArgumentList::begin ()

inline

Definition at line 93 of file arguments.h.

93 iterator begin() { return m_args.begin(); }

Reference m_args.

Referenced by MemberDefImpl::_writeTemplatePrefix, argListToString, MemberDefImpl::copyArgumentNames, MemberDefImpl::detectUndocumentedParams, generateDEFForMember, PerlModGenerator::generatePerlModForMember, generateXMLForMember, hasDocumentation, hasTemplateDocumentation, insertMemberFunctionParams, matchArguments2, matchTemplateArguments, mergeArguments, MemberDefImpl::resolveUnnamedParameters, substituteTemplateArgumentsInString, substituteTemplatesInArgList, substituteTemplatesInString, transferArgumentDocumentation and writeDefArgumentList.

begin()

const_iterator ArgumentList::begin ()

inline

Definition at line 95 of file arguments.h.

95 const_iterator begin() const { return m_args.cbegin(); }

Reference m_args.

cbegin()

const_iterator ArgumentList::cbegin ()

inline

Definition at line 97 of file arguments.h.

97 const_iterator cbegin() const { return m_args.cbegin(); }

Reference m_args.

cend()

const_iterator ArgumentList::cend ()

inline

Definition at line 98 of file arguments.h.

98 const_iterator cend() const { return m_args.cend(); }

Reference m_args.

clear()

void ArgumentList::clear ()

inline

Definition at line 101 of file arguments.h.

101 void clear() { m_args.clear(); }

Reference m_args.

Referenced by reset.

constSpecifier()

bool ArgumentList::constSpecifier ()

inline

Definition at line 111 of file arguments.h.

111 bool constSpecifier() const { return m_constSpecifier; }

Reference m_constSpecifier.

Referenced by argListToString, PerlModGenerator::generatePerlModForMember, generateSqlite3ForMember, generateXMLForMember, matchArguments2, substituteTemplatesInArgList and writeDefArgumentList.

empty()

bool ArgumentList::empty ()

inline

Definition at line 99 of file arguments.h.

99 bool empty() const { return m_args.empty(); }

Reference m_args.

Referenced by addClassToContext, addMemberFunction, buildFunctionList, DocParser::checkArgumentName, DocParser::checkUnOrMultipleDocumentedParams, computeTemplateClassRelations, MemberDefImpl::detectUndocumentedParams, findGlobalMember, PerlModGenerator::generatePerlModForMember, generateXMLForMember, getTemplateArgumentsFromName, hasParameters, insertMemberDefineParams, insertTemplateSpecifierInScope, isVarWithConstructor, makeQualifiedNameWithTemplateParameters, matchArguments2, SymbolResolver::Private::newResolveTypedef, searchTemplateSpecs, substituteTemplateArgumentsInString, tempArgListToString, MemberDefImpl::writeDocumentation and writeTypeConstraints.

end()

iterator ArgumentList::end ()

inline

Definition at line 94 of file arguments.h.

94 iterator end() { return m_args.end(); }

Reference m_args.

Referenced by MemberDefImpl::_writeTemplatePrefix, argListToString, MemberDefImpl::copyArgumentNames, MemberDefImpl::detectUndocumentedParams, generateDEFForMember, PerlModGenerator::generatePerlModForMember, generateXMLForMember, hasDocumentation, hasTemplateDocumentation, insertMemberFunctionParams, matchArguments2, matchTemplateArguments, mergeArguments, MemberDefImpl::resolveUnnamedParameters, substituteTemplateArgumentsInString, substituteTemplatesInArgList, substituteTemplatesInString, transferArgumentDocumentation and writeDefArgumentList.

end()

const_iterator ArgumentList::end ()

inline

Definition at line 96 of file arguments.h.

96 const_iterator end() const { return m_args.cend(); }

Reference m_args.

front()

Argument & ArgumentList::front ()

inline

Definition at line 105 of file arguments.h.

105 Argument &front() { return m_args.front(); }

Reference m_args.

Referenced by matchArguments2.

front()

const Argument & ArgumentList::front ()

inline

Definition at line 106 of file arguments.h.

106 const Argument &front() const { return m_args.front(); }

Reference m_args.

hasDocumentation()

bool ArgumentList::hasDocumentation ()

Does any argument of this list have documentation?

the argument list is documented if one of its arguments is documented

Declaration at line 72 of file arguments.h, definition at line 21 of file arguments.cpp.

21bool ArgumentList::hasDocumentation() const

22{

23 return std::any_of(begin(),end(),[](const Argument &a){ return a.hasDocumentation(); });

24}

References begin, end and Argument::hasDocumentation.

Referenced by inlineArgListToDoc.

hasParameters()

bool ArgumentList::hasParameters ()

inline

Does this list have zero or more parameters

Definition at line 76 of file arguments.h.

76 bool hasParameters() const

77 {

78 return !empty() || m_noParameters;

79 }

References empty and m_noParameters.

Referenced by addMemberFunction, addTemplateArgumentList, argListToString, combineDeclarationAndDefinition, MemberDefImpl::detectUndocumentedParams, generateXMLForMember, writeDefArgumentList, VhdlDocGen::writeFunctionProto, VhdlDocGen::writeProcessProto, writeTemplateArgumentList and VhdlDocGen::writeVHDLDeclaration.

hasTemplateDocumentation()

bool ArgumentList::hasTemplateDocumentation ()

Does any template argument of this list have documentation?

the template argument list is documented if one of its template arguments is documented

Declaration at line 74 of file arguments.h, definition at line 29 of file arguments.cpp.

29bool ArgumentList::hasTemplateDocumentation() const

30{

31 return std::any_of(begin(),end(),[](const Argument &a){ return a.hasTemplateDocumentation(); });

32}

References begin, end and Argument::hasTemplateDocumentation.

Referenced by inlineTemplateArgListToDoc.

isDeleted()

bool ArgumentList::isDeleted ()

inline

Definition at line 115 of file arguments.h.

115 bool isDeleted() const { return m_isDeleted; }

Reference m_isDeleted.

Referenced by substituteTemplatesInArgList.

noParameters()

bool ArgumentList::noParameters ()

inline

Definition at line 117 of file arguments.h.

117 bool noParameters() const { return m_noParameters; }

Reference m_noParameters.

Referenced by substituteTemplatesInArgList.

pureSpecifier()

bool ArgumentList::pureSpecifier ()

inline

Definition at line 113 of file arguments.h.

113 bool pureSpecifier() const { return m_pureSpecifier; }

Reference m_pureSpecifier.

Referenced by argListToString and substituteTemplatesInArgList.

push_back()

void ArgumentList::push_back (const Argument & a)

inline

Definition at line 102 of file arguments.h.

102 void push_back(const Argument &a) { m_args.push_back(a); }

Reference m_args.

Referenced by addSTLClass, anonymous{tagreader.cpp}::TagFileParser::buildClassEntry, DocParser::checkUnOrMultipleDocumentedParams and substituteTemplatesInArgList.

refQualifier()

RefQualifierType ArgumentList::refQualifier ()

inline

Definition at line 116 of file arguments.h.

116 RefQualifierType refQualifier() const { return m_refQualifier; }

Reference m_refQualifier.

Referenced by argListToString, generateXMLForMember, matchArguments2, substituteTemplatesInArgList and writeDefArgumentList.

reset()

void ArgumentList::reset ()

inline

Definition at line 80 of file arguments.h.

80 void reset()

81 {

82 clear();

83 m_constSpecifier = FALSE;

84 m_volatileSpecifier = FALSE;

85 m_pureSpecifier = FALSE;

86 m_trailingReturnType.clear();

87 m_isDeleted = FALSE;

88 m_refQualifier = RefQualifierType::None;

89 m_noParameters = FALSE;

90 }

References clear, FALSE, m_constSpecifier, m_isDeleted, m_noParameters, m_pureSpecifier, m_refQualifier, m_trailingReturnType, m_volatileSpecifier and None.

setConstSpecifier()

void ArgumentList::setConstSpecifier (bool b)

inline

Definition at line 119 of file arguments.h.

119 void setConstSpecifier(bool b) { m_constSpecifier = b; }

Reference m_constSpecifier.

Referenced by substituteTemplatesInArgList.

setIsDeleted()

void ArgumentList::setIsDeleted (bool b)

inline

Definition at line 123 of file arguments.h.

123 void setIsDeleted(bool b) { m_isDeleted = b; }

Reference m_isDeleted.

Referenced by substituteTemplatesInArgList.

setNoParameters()

void ArgumentList::setNoParameters (bool b)

inline

Definition at line 125 of file arguments.h.

125 void setNoParameters(bool b) { m_noParameters = b; }

Reference m_noParameters.

Referenced by substituteTemplatesInArgList.

setPureSpecifier()

void ArgumentList::setPureSpecifier (bool b)

inline

Definition at line 121 of file arguments.h.

121 void setPureSpecifier(bool b) { m_pureSpecifier = b; }

Reference m_pureSpecifier.

Referenced by substituteTemplatesInArgList.

setRefQualifier()

void ArgumentList::setRefQualifier (RefQualifierType t)

inline

Definition at line 124 of file arguments.h.

124 void setRefQualifier(RefQualifierType t) { m_refQualifier = t; }

Reference m_refQualifier.

Referenced by substituteTemplatesInArgList.

setTrailingReturnType()

void ArgumentList::setTrailingReturnType (const QCString & s)

inline

Definition at line 122 of file arguments.h.

122 void setTrailingReturnType(const QCString &s) { m_trailingReturnType = s; }

Reference m_trailingReturnType.

Referenced by substituteTemplatesInArgList.

setVolatileSpecifier()

void ArgumentList::setVolatileSpecifier (bool b)

inline

Definition at line 120 of file arguments.h.

120 void setVolatileSpecifier(bool b) { m_volatileSpecifier = b; }

Reference m_volatileSpecifier.

Referenced by substituteTemplatesInArgList.

size()

size_t ArgumentList::size ()

inline

Definition at line 100 of file arguments.h.

100 size_t size() const { return m_args.size(); }

Reference m_args.

Referenced by addMemberFunction, FlowChart::alignFuncProc, DocParser::checkUnOrMultipleDocumentedParams, combineDeclarationAndDefinition, findGlobalMember, GroupDefImpl::insertMember, insertMemberFunctionParams, matchArguments2, matchTemplateArguments, mergeArguments, writeDefArgumentList, VhdlDocGen::writeFuncProcDocu, VhdlDocGen::writeFunctionProto and VhdlDocGen::writeProcedureProto.

trailingReturnType()

QCString ArgumentList::trailingReturnType ()

inline

Definition at line 114 of file arguments.h.

114 QCString trailingReturnType() const { return m_trailingReturnType; }

Reference m_trailingReturnType.

Referenced by argListToString, substituteTemplatesInArgList, MemberDefImpl::warnIfUndocumentedParams and writeDefArgumentList.

volatileSpecifier()

bool ArgumentList::volatileSpecifier ()

inline

Definition at line 112 of file arguments.h.

112 bool volatileSpecifier() const { return m_volatileSpecifier; }

Reference m_volatileSpecifier.

Referenced by argListToString, PerlModGenerator::generatePerlModForMember, generateSqlite3ForMember, generateXMLForMember, matchArguments2, substituteTemplatesInArgList and writeDefArgumentList.

Private Member Attributes

m_args

std::vector<Argument> ArgumentList::m_args

Definition at line 128 of file arguments.h.

128 std::vector<Argument> m_args;

Referenced by at, at, back, back, begin, begin, cbegin, cend, clear, empty, end, end, front, front, push_back and size.

m_constSpecifier

bool ArgumentList::m_constSpecifier = FALSE

Does the member modify the state of the class?

Definition at line 130 of file arguments.h.

130 bool m_constSpecifier = FALSE;

Referenced by constSpecifier, reset and setConstSpecifier.

m_isDeleted

bool ArgumentList::m_isDeleted = FALSE

method with =delete

Definition at line 138 of file arguments.h.

138 bool m_isDeleted = FALSE;

Referenced by isDeleted, reset and setIsDeleted.

m_noParameters

bool ArgumentList::m_noParameters = FALSE

is it an explicit empty list

Definition at line 142 of file arguments.h.

142 bool m_noParameters = FALSE;

Referenced by hasParameters, noParameters, reset and setNoParameters.

m_pureSpecifier

bool ArgumentList::m_pureSpecifier = FALSE

Is this a pure virtual member?

Definition at line 134 of file arguments.h.

134 bool m_pureSpecifier = FALSE;

Referenced by pureSpecifier, reset and setPureSpecifier.

m_refQualifier

RefQualifierType ArgumentList::m_refQualifier = RefQualifierType::None

C++11 ref qualifier

Definition at line 140 of file arguments.h.

140 RefQualifierType m_refQualifier = RefQualifierType::None;

Referenced by refQualifier, reset and setRefQualifier.

m_trailingReturnType

QCString ArgumentList::m_trailingReturnType

C++11 style Trailing return type?

Definition at line 136 of file arguments.h.

136 QCString m_trailingReturnType;

Referenced by reset, setTrailingReturnType and trailingReturnType.

m_volatileSpecifier

bool ArgumentList::m_volatileSpecifier = FALSE

Is the member volatile?

Definition at line 132 of file arguments.h.

132 bool m_volatileSpecifier = FALSE;

Referenced by reset, setVolatileSpecifier and volatileSpecifier.

---

The documentation for this class was generated from the following files:

• arguments.cpp
• arguments.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.