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 (bool allowEmptyNames=false) 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
DString	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 DString &s)
void	appendTrailingReturnType (const DString &s)
void	finishTrailingReturnType ()
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
DString	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 65 of file arguments.h.

Member Typedef Documentation

◆ const_iterator

using ArgumentList::const_iterator = typename Vec::const_iterator

Definition at line 70 of file arguments.h.

◆ iterator

using ArgumentList::iterator = typename Vec::iterator

Definition at line 69 of file arguments.h.

◆ Vec

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

Definition at line 68 of file arguments.h.

Member Function Documentation

◆ appendTrailingReturnType()

void ArgumentList::appendTrailingReturnType ( const DString & s )

Definition at line 41 of file arguments.cpp.

{
  m_trailingReturnType += s;
}

References m_trailingReturnType.

◆ at() [1/2]

Argument & ArgumentList::at ( size_t i )

inline

Definition at line 108 of file arguments.h.

108{ return m_args.at(i); }

ArgumentList::m_args

std::vector< Argument > m_args

Definition arguments.h:131

References m_args.

◆ at() [2/2]

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

inline

Definition at line 109 of file arguments.h.

109{ return m_args.at(i); }

References m_args.

◆ back() [1/2]

Argument & ArgumentList::back ( )

inline

Definition at line 104 of file arguments.h.

104{ return m_args.back(); }

References m_args.

◆ back() [2/2]

const Argument & ArgumentList::back ( ) const

inline

Definition at line 105 of file arguments.h.

105{ return m_args.back(); }

References m_args.

◆ begin() [1/2]

iterator ArgumentList::begin ( )

inline

◆ begin() [2/2]

const_iterator ArgumentList::begin ( ) const

inline

Definition at line 96 of file arguments.h.

96{ return m_args.cbegin(); }

References m_args.

◆ cbegin()

const_iterator ArgumentList::cbegin ( ) const

inline

Definition at line 98 of file arguments.h.

98{ return m_args.cbegin(); }

References m_args.

◆ cend()

const_iterator ArgumentList::cend ( ) const

inline

Definition at line 99 of file arguments.h.

99{ return m_args.cend(); }

References m_args.

◆ clear()

void ArgumentList::clear ( )

inline

Definition at line 102 of file arguments.h.

102{ m_args.clear(); }

References m_args.

Referenced by reset().

◆ constSpecifier()

bool ArgumentList::constSpecifier ( ) const

inline

Definition at line 112 of file arguments.h.

112{ return m_constSpecifier; }

ArgumentList::m_constSpecifier

bool m_constSpecifier

Definition arguments.h:133

References m_constSpecifier.

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

◆ empty()

bool ArgumentList::empty ( ) const

inline

Definition at line 100 of file arguments.h.

100{ return m_args.empty(); }

References m_args.

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

◆ end() [1/2]

iterator ArgumentList::end ( )

inline

◆ end() [2/2]

const_iterator ArgumentList::end ( ) const

inline

Definition at line 97 of file arguments.h.

97{ return m_args.cend(); }

References m_args.

◆ finishTrailingReturnType()

void ArgumentList::finishTrailingReturnType ( )

Definition at line 46 of file arguments.cpp.

{
  if (!m_trailingReturnType.empty())
  {
    m_trailingReturnType = " "+removeRedundantWhiteSpace(m_trailingReturnType);
  }
}

References DString::empty(), m_trailingReturnType, and removeRedundantWhiteSpace().

◆ front() [1/2]

Argument & ArgumentList::front ( )

inline

Definition at line 106 of file arguments.h.

106{ return m_args.front(); }

References m_args.

Referenced by MemberDefImpl::isBriefSectionVisible(), and matchArguments2().

◆ front() [2/2]

const Argument & ArgumentList::front ( ) const

inline

Definition at line 107 of file arguments.h.

107{ return m_args.front(); }

References m_args.

◆ hasDocumentation()

bool ArgumentList::hasDocumentation ( bool allowEmptyNames = false ) const

Does any argument of this list have documentation?

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

Definition at line 22 of file arguments.cpp.

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

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

Referenced by MemberDefImpl::hasDetailedDescription(), MemberDefImpl::hasDocumentation(), and inlineArgListToDoc().

◆ hasParameters()

bool ArgumentList::hasParameters ( ) const

inline

Does this list have zero or more parameters

Definition at line 77 of file arguments.h.

    {
      return !empty() || m_noParameters;
    }

References empty(), and m_noParameters.

Referenced by MemberDefImpl::_writeTypeConstraints(), addMemberFunction(), addTemplateArgumentList(), argListToString(), combineDeclarationAndDefinition(), MemberDefImpl::detectUndocumentedParams(), generateXMLForMember(), MemberDefImpl::hasDetailedDescription(), MemberDefImpl::hasMultiLineInitializer(), MemberDefImpl::hasOneLineInitializer(), MemberDefImpl::setAnchor(), MemberDefImpl::writeDeclaration(), writeDefArgumentList(), MemberDefImpl::writeDocumentation(), 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 30 of file arguments.cpp.

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

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

Referenced by ClassDefImpl::hasDetailedDescription(), MemberDefImpl::hasDetailedDescription(), MemberDefImpl::hasDocumentation(), inlineTemplateArgListToDoc(), and ClassDefImpl::isLinkableInProject().

◆ isDeleted()

bool ArgumentList::isDeleted ( ) const

inline

Definition at line 116 of file arguments.h.

116{ return m_isDeleted; }

ArgumentList::m_isDeleted

bool m_isDeleted

Definition arguments.h:141

References m_isDeleted.

Referenced by MemberDefImpl::isDeleted(), and substituteTemplatesInArgList().

◆ noParameters()

bool ArgumentList::noParameters ( ) const

inline

Definition at line 118 of file arguments.h.

118{ return m_noParameters; }

References m_noParameters.

Referenced by substituteTemplatesInArgList().

◆ pureSpecifier()

bool ArgumentList::pureSpecifier ( ) const

inline

Definition at line 114 of file arguments.h.

114{ return m_pureSpecifier; }

ArgumentList::m_pureSpecifier

bool m_pureSpecifier

Definition arguments.h:137

References m_pureSpecifier.

Referenced by argListToString(), and substituteTemplatesInArgList().

◆ push_back()

void ArgumentList::push_back ( const Argument & a )

inline

Definition at line 103 of file arguments.h.

103{ m_args.push_back(a); }

References m_args.

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

◆ refQualifier()

RefQualifierType ArgumentList::refQualifier ( ) const

inline

Definition at line 117 of file arguments.h.

117{ return m_refQualifier; }

ArgumentList::m_refQualifier

RefQualifierType m_refQualifier

Definition arguments.h:143

References m_refQualifier.

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

◆ reset()

void ArgumentList::reset ( )

inline

Definition at line 81 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;
    }