ArgumentList Class Reference

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

#include <src/arguments.h>

Collaboration diagram for ArgumentList:

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

Public Member Functions
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 Attributes
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

Detailed 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.

Member Typedef Documentation

const_iterator

using ArgumentList::const_iterator = typename Vec::const_iterator

Definition at line 69 of file arguments.h.

iterator

using ArgumentList::iterator = typename Vec::iterator

Definition at line 68 of file arguments.h.

Vec

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

Definition at line 67 of file arguments.h.

Member Function Documentation

at() [1/2]

Argument & ArgumentList::at ( size_t i )

inline

Definition at line 107 of file arguments.h.

{ return m_args.at(i); }

References m_args.

Referenced by makeQualifiedNameWithTemplateParameters().

at() [2/2]

const Argument & ArgumentList::at ( size_t i ) const

inline

Definition at line 108 of file arguments.h.

{ return m_args.at(i); }

References m_args.

back() [1/2]

Argument & ArgumentList::back ( )

inline

Definition at line 103 of file arguments.h.

{ return m_args.back(); }

References m_args.

back() [2/2]

const Argument & ArgumentList::back ( ) const

inline

Definition at line 104 of file arguments.h.

{ return m_args.back(); }

References m_args.

begin() [1/2]

iterator ArgumentList::begin ( )

inline

Definition at line 93 of file arguments.h.

{ return m_args.begin(); }

References 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() [2/2]

const_iterator ArgumentList::begin ( ) const

inline

Definition at line 95 of file arguments.h.

{ return m_args.cbegin(); }

References m_args.

cbegin()

const_iterator ArgumentList::cbegin ( ) const

inline

Definition at line 97 of file arguments.h.

{ return m_args.cbegin(); }

References m_args.

cend()

const_iterator ArgumentList::cend ( ) const

inline

Definition at line 98 of file arguments.h.

{ return m_args.cend();   }

References m_args.

clear()

void ArgumentList::clear ( )

inline

Definition at line 101 of file arguments.h.

{ m_args.clear(); }

References m_args.

Referenced by reset().

constSpecifier()

bool ArgumentList::constSpecifier ( ) const

inline

Definition at line 111 of file arguments.h.

{ return m_constSpecifier; }

References m_constSpecifier.

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

empty()

bool ArgumentList::empty ( ) const

inline

Definition at line 99 of file arguments.h.

{ return m_args.empty(); }

References 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() [1/2]

iterator ArgumentList::end ( )

inline

Definition at line 94 of file arguments.h.

{ return m_args.end();   }

References 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() [2/2]

const_iterator ArgumentList::end ( ) const

inline

Definition at line 96 of file arguments.h.

{ return m_args.cend();   }

References m_args.

front() [1/2]

Argument & ArgumentList::front ( )

inline

Definition at line 105 of file arguments.h.

{ return m_args.front(); }

References m_args.

Referenced by matchArguments2().

front() [2/2]

const Argument & ArgumentList::front ( ) const

inline

Definition at line 106 of file arguments.h.

{ return m_args.front(); }

References m_args.

hasDocumentation()

bool ArgumentList::hasDocumentation

(

)

const

Does any argument of this list have documentation?

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

Definition at line 21 of file arguments.cpp.

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

References begin(), end(), and Argument::hasDocumentation().

Referenced by inlineArgListToDoc().

hasParameters()

bool ArgumentList::hasParameters ( ) const

inline

Does this list have zero or more parameters

Definition at line 76 of file arguments.h.

    {
      return !empty() || m_noParameters;
    }

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

(

)

const

Does any template argument of this list have documentation?

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

Definition at line 29 of file arguments.cpp.

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

References begin(), end(), and Argument::hasTemplateDocumentation().

Referenced by inlineTemplateArgListToDoc().

isDeleted()

bool ArgumentList::isDeleted ( ) const

inline

Definition at line 115 of file arguments.h.

{ return m_isDeleted; }

References m_isDeleted.

Referenced by substituteTemplatesInArgList().

noParameters()

bool ArgumentList::noParameters ( ) const

inline

Definition at line 117 of file arguments.h.

{ return m_noParameters; }

References m_noParameters.

Referenced by substituteTemplatesInArgList().

pureSpecifier()

bool ArgumentList::pureSpecifier ( ) const

inline

Definition at line 113 of file arguments.h.

{ return m_pureSpecifier; }

References 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.

{ m_args.push_back(a); }

References m_args.

Referenced by addSTLClass(), anonymous_namespace{tagreader.cpp}::TagFileParser::buildLists(), DocParser::checkUnOrMultipleDocumentedParams(), and substituteTemplatesInArgList().

refQualifier()

RefQualifierType ArgumentList::refQualifier ( ) const

inline

Definition at line 116 of file arguments.h.

{ return m_refQualifier; }

References m_refQualifier.

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

reset()

void ArgumentList::reset ( )

inline

Definition at line 80 of file arguments.h.

    {
      clear();
      m_constSpecifier = FALSE;
      m_volatileSpecifier = FALSE;
      m_pureSpecifier = FALSE;
      m_trailingReturnType.clear();
      m_isDeleted = FALSE;
      m_refQualifier = RefQualifierType::None;
      m_noParameters = FALSE;
    }

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.

{ m_constSpecifier = b; }

References m_constSpecifier.

Referenced by substituteTemplatesInArgList().

setIsDeleted()

void ArgumentList::setIsDeleted ( bool b )

inline

Definition at line 123 of file arguments.h.

{ m_isDeleted = b; }

References m_isDeleted.

Referenced by substituteTemplatesInArgList().

setNoParameters()

void ArgumentList::setNoParameters ( bool b )

inline

Definition at line 125 of file arguments.h.

{ m_noParameters = b; }

References m_noParameters.

Referenced by substituteTemplatesInArgList().

setPureSpecifier()

void ArgumentList::setPureSpecifier ( bool b )

inline

Definition at line 121 of file arguments.h.

{ m_pureSpecifier = b; }

References m_pureSpecifier.

Referenced by substituteTemplatesInArgList().

setRefQualifier()

void ArgumentList::setRefQualifier ( RefQualifierType t )

inline

Definition at line 124 of file arguments.h.

{ m_refQualifier = t; }

References m_refQualifier.

Referenced by substituteTemplatesInArgList().

setTrailingReturnType()

void ArgumentList::setTrailingReturnType ( const QCString & s )

inline

Definition at line 122 of file arguments.h.

{ m_trailingReturnType = s; }

References m_trailingReturnType.

Referenced by substituteTemplatesInArgList().

setVolatileSpecifier()

void ArgumentList::setVolatileSpecifier ( bool b )

inline

Definition at line 120 of file arguments.h.

{ m_volatileSpecifier = b; }

References m_volatileSpecifier.

Referenced by substituteTemplatesInArgList().

size()

size_t ArgumentList::size ( ) const

inline

Definition at line 100 of file arguments.h.

{ return m_args.size();  }

References 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 ( ) const

inline

Definition at line 114 of file arguments.h.

{ return m_trailingReturnType; }

References m_trailingReturnType.

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

volatileSpecifier()

bool ArgumentList::volatileSpecifier ( ) const

inline

Definition at line 112 of file arguments.h.

{ return m_volatileSpecifier; }

References m_volatileSpecifier.

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

Member Data Documentation

m_args

std::vector<Argument> ArgumentList::m_args

private

Definition at line 128 of file arguments.h.

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

private

Does the member modify the state of the class?

Definition at line 130 of file arguments.h.

Referenced by constSpecifier(), reset(), and setConstSpecifier().

m_isDeleted

bool ArgumentList::m_isDeleted = FALSE

private

method with =delete

Definition at line 138 of file arguments.h.

Referenced by isDeleted(), reset(), and setIsDeleted().

m_noParameters

bool ArgumentList::m_noParameters = FALSE

private

is it an explicit empty list

Definition at line 142 of file arguments.h.

Referenced by hasParameters(), noParameters(), reset(), and setNoParameters().

m_pureSpecifier

bool ArgumentList::m_pureSpecifier = FALSE

private

Is this a pure virtual member?

Definition at line 134 of file arguments.h.

Referenced by pureSpecifier(), reset(), and setPureSpecifier().

m_refQualifier

RefQualifierType ArgumentList::m_refQualifier = RefQualifierType::None

private

C++11 ref qualifier

Definition at line 140 of file arguments.h.

Referenced by refQualifier(), reset(), and setRefQualifier().

m_trailingReturnType

QCString ArgumentList::m_trailingReturnType

private

C++11 style Trailing return type?

Definition at line 136 of file arguments.h.

Referenced by reset(), setTrailingReturnType(), and trailingReturnType().

m_volatileSpecifier

bool ArgumentList::m_volatileSpecifier = FALSE

private

Is the member volatile?

Definition at line 132 of file arguments.h.

Referenced by reset(), setVolatileSpecifier(), and volatileSpecifier().

---

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

• src/arguments.h
• src/arguments.cpp