This is an alternative implementation of QCString. More...

#include <src/qcstring.h>

Public Types
enum	SizeTag { ExplicitSize }
	creates a string with room for size characters More...

Public Member Functions
	QCString ()=default

	QCString (const std::string &s)

	QCString (std::string &&s)

	QCString (std::string_view sv)

QCString &	operator= (std::string_view sv)

	QCString (int)=delete

	QCString (const JavaCCString &s)
	For converting a JavaCC string.

QCString &	operator= (const JavaCCString &s)

	QCString (size_t size, SizeTag t)

	QCString (const char *str)
	creates a string from a plain C string.

	QCString (const char *str, size_t maxlen)
	creates a string from str and copies over the first maxlen characters.

QCString &	operator= (const char *str)
	replaces the contents by that of C string str.

QCString &	operator= (const std::string &s)

bool	isEmpty () const
	Returns TRUE iff the string is empty.

size_t	length () const
	Returns the length of the string, not counting the 0-terminator.

size_t	size () const
	Returns the length of the string, not counting the 0-terminator.

const char *	data () const
	Returns a pointer to the contents of the string in the form of a 0-terminated C string.

std::string_view	view () const

char *	rawData ()
	Returns a writable pointer to the data.

void	resize (size_t newlen)

void	clear ()

void	reserve (size_t size)
	Reserve space for size bytes without changing the string contents.

void	fill (char c, int len=-1)
	Fills a string with a predefined character.

QCString &	sprintf (const char *format,...)

int	find (char c, int index=0, bool cs=TRUE) const

int	find (const char *str, int index=0, bool cs=TRUE) const

int	find (const QCString &str, int index=0, bool cs=TRUE) const

int	findRev (char c, int index=-1, bool cs=TRUE) const

int	findRev (const char *str, int index=-1, bool cs=TRUE) const

int	contains (char c, bool cs=TRUE) const

int	contains (const char *str, bool cs=TRUE) const

bool	stripPrefix (const QCString &prefix)

bool	stripPrefix (const char *prefix)

QCString	left (size_t len) const

QCString	right (size_t len) const

QCString	mid (size_t index, size_t len=static_cast< size_t >(-1)) const

QCString	lower () const

QCString	upper () const

QCString	stripWhiteSpace () const
	returns a copy of this string with leading and trailing whitespace removed

QCString	stripLeadingAndTrailingEmptyLines () const

QCString	quoted () const

QCString	removeWhiteSpace () const
	returns a copy of this string with all whitespace removed

QCString	simplifyWhiteSpace () const
	return a copy of this string with leading and trailing whitespace removed and multiple whitespace characters replaced by a single space

QCString	repeat (unsigned int n) const

QCString &	insert (size_t index, const QCString &s)

QCString &	insert (size_t index, std::string_view s)

QCString &	insert (size_t index, const char *s)

QCString &	insert (size_t index, char c)

QCString &	append (char c)

QCString &	append (const char *s)

QCString &	append (const QCString &s)

QCString &	append (const std::string &s)

QCString &	append (std::string_view s)

QCString &	prepend (const char *s)

QCString &	prepend (const QCString &s)

QCString &	prepend (const std::string &s)

QCString &	prepend (std::string_view s)

QCString &	remove (size_t index, size_t len)

QCString &	replace (size_t index, size_t len, const char *s)

short	toShort (bool *ok=nullptr, int base=10) const

uint16_t	toUShort (bool *ok=nullptr, int base=10) const

int	toInt (bool *ok=nullptr, int base=10) const

uint32_t	toUInt (bool *ok=nullptr, int base=10) const

long	toLong (bool *ok=nullptr, int base=10) const

unsigned long	toULong (bool *ok=nullptr, int base=10) const

uint64_t	toUInt64 (bool *ok=nullptr, int base=10) const

QCString &	setNum (short n)

QCString &	setNum (uint16_t n)

QCString &	setNum (int n)

QCString &	setNum (uint32_t n)

QCString &	setNum (long n)

QCString &	setNum (long long n)

QCString &	setNum (unsigned long long n)

QCString &	setNum (unsigned long n)

bool	startsWith (const char *s) const

bool	startsWith (const QCString &s) const

bool	endsWith (const char *s) const

bool	endsWith (const QCString &s) const

const std::string &	str () const

QCString &	operator+= (const QCString &s)

QCString &	operator+= (const std::string &s)

QCString &	operator+= (std::string_view s)

QCString &	operator+= (const char *s)
	Appends string str to this string and returns a reference to the result.

char &	at (size_t i)
	Returns a reference to the character at index i.

const char &	at (size_t i) const

char &	operator[] (size_t i)
	Indexing operator.

const char &	operator[] (size_t i) const

Private Attributes
std::string	m_rep

Detailed Description

This is an alternative implementation of QCString.

It provides basically the same functions but uses std::string as the underlying string type

Definition at line 100 of file qcstring.h.

Member Enumeration Documentation

◆ SizeTag

enum QCString::SizeTag

creates a string with room for size characters

Parameters

[in] size the number of character to allocate (also counting the 0-terminator!)

Enumerator
ExplicitSize

Definition at line 133 of file qcstring.h.

133{ ExplicitSize };

QCString::ExplicitSize

@ ExplicitSize

Definition qcstring.h:133

Constructor & Destructor Documentation

◆ QCString() [1/9]

QCString::QCString ( )

default

◆ QCString() [2/9]

QCString::QCString ( const std::string & s )

inlineexplicit

Definition at line 104 of file qcstring.h.

104: m_rep(s) {}

QCString::m_rep

std::string m_rep

Definition qcstring.h:589

References m_rep.

◆ QCString() [3/9]

QCString::QCString ( std::string && s )

inline

Definition at line 106 of file qcstring.h.

106: m_rep(std::move(s)) {}

References m_rep.

◆ QCString() [4/9]

QCString::QCString ( std::string_view sv )

inline

Definition at line 108 of file qcstring.h.

108: m_rep(sv) {}

References m_rep.

◆ QCString() [5/9]

QCString::QCString ( int )

delete

◆ QCString() [6/9]

QCString::QCString ( const JavaCCString & s )

inline

For converting a JavaCC string.

Definition at line 118 of file qcstring.h.

    {
      m_rep.resize(s.size());
      memcpy(m_rep.data(),s.data(),s.size());
    }

References m_rep.

◆ QCString() [7/9]

QCString::QCString	(	size_t	size,
		SizeTag	t )

inlineexplicit

Definition at line 134 of file qcstring.h.

134{ m_rep.resize(size); }

QCString::size

size_t size() const

Returns the length of the string, not counting the 0-terminator.

Definition qcstring.h:156

References m_rep, and size().

◆ QCString() [8/9]

QCString::QCString ( const char * str )

inline

creates a string from a plain C string.

Parameters

[in] str A zero terminated C string. When 0 an empty string is created.

Definition at line 139 of file qcstring.h.

139: m_rep(str?str:"") {}

QCString::str

const std::string & str() const

Definition qcstring.h:526

References m_rep, and str().

◆ QCString() [9/9]

QCString::QCString	(	const char *	str,
		size_t	maxlen )

inline

creates a string from str and copies over the first maxlen characters.

Definition at line 142 of file qcstring.h.

142: m_rep(str?str:"") { m_rep.resize(maxlen); }

References m_rep, and str().

Member Function Documentation

◆ append() [1/5]

QCString & QCString::append ( char c )

inline

Definition at line 381 of file qcstring.h.

    {
      m_rep+=c;
      return *this;
    }

References m_rep, and QCString().

Referenced by VhdlDocGen::addBaseClass(), addModule(), FlowChart::alignCommentNode(), alignText(), appStringLower(), VhdlDocGen::convertArgumentListToString(), DocEmoji::DocEmoji(), externalRef(), generateDEFForMember(), MemberDefImpl::getDeclType(), VhdlDocGen::getProcessNumber(), initUCF(), SymbolResolver::Private::newResolveTypedef(), operator+(), operator+(), VhdlDocGen::parseUCF(), quoted(), MemberDefImpl::sourceRefName(), MemberDefImpl::writeDeclaration(), writeDefArgumentList(), and VhdlDocGen::writeSource().

◆ append() [2/5]

QCString & QCString::append ( const char * s )

inline

Definition at line 387 of file qcstring.h.

    {
      return operator+=(s);
    }

References operator+=(), and QCString().

◆ append() [3/5]

QCString & QCString::append ( const QCString & s )

inline

Definition at line 392 of file qcstring.h.

    {
      return operator+=(s);
    }

References operator+=(), and QCString().

◆ append() [4/5]

QCString & QCString::append ( const std::string & s )

inline

Definition at line 397 of file qcstring.h.

    {
      return operator+=(s);
    }

References operator+=(), and QCString().

◆ append() [5/5]

QCString & QCString::append ( std::string_view s )

inline

Definition at line 402 of file qcstring.h.

    {
      return operator+=(s);
    }

References operator+=(), and QCString().

◆ at() [1/2]

char & QCString::at ( size_t i )

inline

Returns a reference to the character at index i.

Definition at line 567 of file qcstring.h.

    {
      return m_rep[i];
    }

References m_rep.

Referenced by DefinitionImpl::_setBriefDescription(), abbreviate(), Qhp::addContentsItem(), addIncludeFile(), addSeparatorsIfNeeded(), addTemplateNames(), addVariableToFile(), Config::checkAndCorrect(), checkVhdlString(), computeVerifiedDotPath(), configStringRecode(), TranslatorPersian::convertDigitsToFarsi(), MemberDefImpl::displayDefinition(), DocEmoji::DocEmoji(), elemIsVisible(), expandExpression(), externalRef(), DefinitionImpl::externalReference(), extractPartAfterNewLine(), findDirDocumentation(), findEndOfTemplate(), findEnumDocumentation(), VhdlDocGen::formatString(), PerlModGenerator::generatePerlModForMember(), generateSqlite3ForMember(), generateXMLForMember(), getCanonicalTemplateSpec(), getCurrentChar(), getExtension(), getLanguageFromCodeLang(), getLanguageFromFileName(), getNextChar(), getNextId(), getScopeDefs(), getScopeFragment(), handleHtmlTag(), DocPara::handleStartCode(), Markdown::Private::isAtxHeader(), NamespaceDefImpl::isLinkableInProject(), isVarWithConstructor(), leftScopeMatch(), linkToText(), makeFileName(), makeFileName(), matchExcludedSymbols(), nameIsOperator(), SymbolResolver::Private::newResolveTypedef(), node2URL(), DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), ManDocVisitor::operator()(), parseCommentAsText(), parseFuncDecl(), Markdown::process(), Markdown::Private::processLink(), processList(), processString(), projectLogoSize(), readCodeFragment(), readIncludeFile(), readIncludeFile(), HtmlHelpRecoder::recode(), recognizeFixedForm(), replaceFunctionMacro(), resolveSymlink(), rightScopeMatch(), searchInputFiles(), splitSearchTokens(), startsWithKeyword(), stringize(), stripAnonymousNamespaceScope(), stripComment(), stripIrrelevantString(), stripQuotes(), stripQuotes(), stripScope(), stripTemplateSpecifiers(), stripTemplateSpecifiersFromScope(), stripTrailingWhiteSpace(), substEnvVarsInStrList(), Portable::system(), transcodeCharacterStringToUTF8(), Trace::trunc(), updateLanguageMapping(), validatingParseDoc(), MemberDefImpl::writeDeclaration(), MemberDefImpl::writeDocumentation(), writeExceptionList(), VhdlDocGen::writeFormatString(), writeIndexHierarchyEntries(), MemberDefImpl::writeMemberDocSimple(), writeMemberList(), writeObjCMethodCall(), PlantumlManager::writePlantUMLSource(), writeSingleFileIndex(), ConfigOption::writeStringList(), writeWord(), and HtmlEntityMapper::writeXMLSchema().

◆ at() [2/2]

const char & QCString::at ( size_t i ) const

inline

Definition at line 572 of file qcstring.h.

    {
      return m_rep[i];
    }

References m_rep.

◆ clear()

void QCString::clear ( )

inline

Definition at line 169 of file qcstring.h.

169{ m_rep.clear(); }

References m_rep.

Referenced by DocGroup::addDocs(), addSubprogram(), appStringLower(), codifyMapLines(), FlowChart::delFlowList(), expandMacro(), extractClassNameFromType(), extractNamespaceName(), Markdown::extractPageTitle(), findClassRelation(), findMember(), fixArgumentListForJavaScript(), getDefsOld(), SymbolResolver::Private::getResolvedSymbol(), SymbolResolver::Private::getResolvedType(), handleHtmlTag(), handleParametersCommentBlocks(), DefinitionImpl::IMPL::init(), initUCF(), isLinkRef(), mergeArguments(), CommentScanner::parseCommentBlock(), ConfigImpl::parseString(), Markdown::Private::processBlocks(), Markdown::Private::processQuotations(), replaceFunctionMacro(), startCodeLine(), stripIrrelevantString(), writeDefArgumentList(), writeFuncProto(), VhdlDocGen::writeInlineClassLink(), ClassDefImpl::writeMemberDeclarations(), VhdlDocGen::writeVHDLDeclaration(), and writeWord().

◆ contains() [1/2]

int QCString::contains	(	char	c,
		bool	cs = TRUE ) const

Definition at line 143 of file qcstring.cpp.

{
  if (length()==0) return 0;
  int count=0;
  const char *pos = data();
  if (cs)
  {
    while (*pos) if (*pos++ == c) count++;
  }
  else
  {
    c = toLowerChar(c);
    while (*pos)
    {
      if (toLowerChar(*pos)==c) count++;
      pos++;
    }
  }
  return count;
}

References data(), length(), and toLowerChar().

Referenced by addMacroDefinition(), applyModifiers(), buildScopeFromQualifiedName(), VHDLOutlineParser::checkInlineCode(), DotNode::convertLabel(), SymbolModifiers::operator|=(), VhdlDocGen::parseForConfig(), readIncludeFile(), and writeUCFLink().

◆ contains() [2/2]

int QCString::contains	(	const char *	str,
		bool	cs = TRUE ) const

Definition at line 164 of file qcstring.cpp.

{
  if (str==nullptr || length()==0) return 0;
  int count=0;
  const char *pos = data();
  int len = qstrlen(str);
  while (*pos)
  {
    if (cs)
    {
      if (qstrncmp(pos,str,len)==0) count++;
    }
    else
    {
      if (qstrnicmp(pos,str,len)==0) count++;
    }
    pos++;
  }
  return count;
}

References data(), length(), qstrlen(), qstrncmp(), qstrnicmp(), and str().

◆ data()

const char * QCString::data ( ) const

inline

Returns a pointer to the contents of the string in the form of a 0-terminated C string.

Definition at line 159 of file qcstring.h.

159{ return m_rep.c_str(); }

References m_rep.

Referenced by DefinitionImpl::_docsAlreadyAdded(), SectionManager::add(), Crawlmap::addContentsItem(), addMacroDefinition(), GrowBuf::addStr(), addXRefItem(), adjustConfiguration(), bindTextParameter(), buildFileName(), checkBlocks(), checkMarkdownMainfile(), FlowChart::codify(), HtmlCodeGenerator::codify(), LatexCodeGenerator::codify(), ManCodeGenerator::codify(), RTFCodeGenerator::codify(), codifyLines(), codifyLines(), codifyLines(), codifyLines(), codifyLines(), codifyMapLines(), FilterCache::compileLineOffsets(), computeQualifiedIndex(), configStringRecode(), contains(), contains(), convertCharEntitiesToUTF8(), convertCppComments(), convertNameToFile(), convertToComment(), convertToDocBook(), convertToHtml(), convertToId(), convertToJSString(), convertToPSString(), convertToXML(), ResourceMgr::copyResourceAs(), Portable::correctPath(), VhdlDocGen::createFlowChart(), detab(), do_mscgen_generate(), ManGenerator::docify(), HtmlGenerator::docify_(), docifyToString(), docifyToString(), encodeDirName(), encodeForOutput(), escapeAt(), escapeCharsInString(), escapeDoubleQuotes(), escapeSpecialChars(), escapeTooltip(), extractBoundingBox(), HtmlDocVisitor::filter(), ManDocVisitor::filter(), RTFDocVisitor::filter(), TextDocVisitor::filter(), filter2008VhdlComment(), filterId(), filterLatexString(), HtmlDocVisitor::filterQuotedCdataAttr(), find(), find(), Markdown::Private::findEmphasisChar(), Markdown::Private::findEndOfLine(), findRev(), findRev(), DocTokenizer::findSections(), VhdlDocGen::findVhdlClass(), Portable::fopen(), format_warn(), formatDateTime(), generateAnonymousAnchor(), generateOutput(), generateXML(), getConvertLatexMacro(), Portable::getenv(), CitationManager::getFormulas(), ParserManager::getParsers(), getPrefixIndex(), getProjectId(), SymbolResolver::Private::getResolvedTypeRec(), handle_warn_as_error(), handleCommentBlock(), handleToc(), PerlModOutput::iaddQuoted(), LayoutDocManager::init(), HtmlHelpRecoder::initialize(), Qhp::initialize(), insert(), insertPath(), DocParser::internalValidatingParseDoc(), Portable::isAbsolutePath(), isLowerCase(), latexEscapeIndexChars(), latexEscapeLabelName(), latexEscapePDFString(), latexFilterURL(), letterToLabel(), VHDLOutlineParser::lineCount(), loadStylesheet(), nameIsActuallyPartOfType(), operator!=(), operator!=(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), LatexDocVisitor::operator()(), RTFDocVisitor::operator()(), operator<(), operator<(), operator<(), operator<=(), operator<=(), operator==(), operator==(), operator>(), operator>(), operator>=(), operator>=(), DocIncOperator::parse(), LayoutDocManager::parse(), CCodeParser::parseCode(), FileCodeParser::parseCode(), FortranCodeParser::parseCode(), LexCodeParser::parseCode(), PythonCodeParser::parseCode(), SQLCodeParser::parseCode(), VHDLCodeParser::parseCode(), XMLCodeParser::parseCode(), parseCommentAsText(), parseFile(), parseFuncDecl(), parsePrototype(), parsePrototype(), ConfigImpl::parseString(), parseTagFile(), VHDLOutlineParser::Private::parseVhdlfile(), Portable::popen(), prepend(), preProcessFile(), RTFGenerator::preProcessFileInplace(), Markdown::process(), Markdown::Private::processBlocks(), Markdown::Private::processQuotations(), Markdown::Private::processSpecialCommand(), pushBuffer(), qPrint(), qstrcmp(), qstrcmp(), qstrcmp(), qstricmp(), qstricmp(), qstricmp(), qstricmp_sort(), qstricmp_sort(), qstricmp_sort(), qstrnicmp(), qstrnicmp(), qstrnicmp(), readCodeFragment(), readConfiguration(), readIncludeFile(), HtmlHelpRecoder::recode(), Portable::recodeUtf8StringToW(), recognizeFixedForm(), removeEmptyLines(), removeIdsAndMarkers(), removeMarkers(), removeRedundantWhiteSpace(), repeat(), SectionManager::replace(), replaceAnonymousScopes(), CitationManager::replaceFormulas(), replaceVariables(), DotFilePatcher::run(), runPlantumlContent(), ColoredImage::save(), Image::save(), selectBlocks(), MemberDefImpl::setAnchor(), Portable::setenv(), simplifyWhiteSpace(), skipToEndMarker(), startCondSection(), Image::stringLength, stringToArgumentList(), stripIndentation(), stripIndentationVerbatim(), stripLeadingAndTrailingEmptyLines(), stripTrailingWhiteSpace(), substitute(), substitute(), substituteKeywords(), Portable::system(), toLong(), toUInt64(), toULong(), transcodeCharacterBuffer(), unescapeCharsInString(), unescapeCRef(), Portable::unlink(), DocTokenizer::unputString(), Portable::unsetenv(), updateLanguageMapping(), validatingParseDoc(), validatingParseText(), ManCodeGenerator::writeCodeLink(), writeDEFString(), writeDocbookCodeString(), ClassDefImpl::writeIncludeFilesForSlice(), writeMemberList(), writeMultiLineCodeLink(), writeMultiLineCodeLink(), writeMultiLineCodeLink(), writeMultiLineCodeLink(), HtmlDocVisitor::writeObfuscatedMailAddress(), writeObjCMethodCall(), DocbookGenerator::writePageLink(), PlantumlManager::writePlantUMLSource(), Image::writeString(), ConfigOption::writeStringValue(), and writeXMLCodeString().

◆ endsWith() [1/2]

bool QCString::endsWith ( const char * s ) const

inline

Definition at line 504 of file qcstring.h.

    {
      if (m_rep.empty() || s==nullptr) return s==nullptr;
      size_t l = strlen(s);
      return m_rep.length()>=l && m_rep.compare(m_rep.length()-l, l, s, l)==0;
    }

References m_rep.

Referenced by DocSets::addIndexItem(), addRelatedPage(), DocParser::checkArgumentName(), DocParser::checkUnOrMultipleDocumentedParams(), computeClassRelations(), createTagLessInstance(), extractNamespaceName(), DocParser::findAndCopyImage(), findClassRelation(), findUsedClassesForClass(), findUsingDeclarations(), findUsingDirectives(), getBibFile(), MemberDefImpl::init(), isVarWithConstructor(), DiagramItem::label(), makeDisplayName(), LatexDocVisitor::operator()(), MarkdownOutlineParser::parseInput(), parseInput(), readIncludeFile(), searchTemplateSpecs(), simplifyTypeForTable(), startOfRequiresExpression(), stripKnownExtensions(), MemberDefImpl::warnIfUndocumentedParams(), DocSets::writeToken(), and HtmlEntityMapper::writeXMLSchema().

◆ endsWith() [2/2]

bool QCString::endsWith ( const QCString & s ) const

inline

Definition at line 511 of file qcstring.h.

    {
      size_t l = s.length();
      return m_rep.length()>=l && m_rep.compare(m_rep.length()-l, l, s.str())==0;
    }

References length(), m_rep, QCString(), and str().

◆ fill()

void QCString::fill	(	char	c,
		int	len = -1 )

inline

Fills a string with a predefined character.

Parameters

[in]	c	the character used to fill the string with.
[in]	len	the number of character to fill. Use -1 to fill the whole string.

Note: the string will be resized to contain len characters. The contents of the string will be lost.

Definition at line 180 of file qcstring.h.

    {
      int l = len==-1 ? static_cast<int>(m_rep.size()) : len;
      m_rep = std::string(l,c);
    }

References m_rep.

Referenced by FlowChart::alignCommentNode(), FlowChart::alignFuncProc(), checkIfHtmlEndTagEndsAutoList(), codifyMapLines(), generateJSTree(), DocSets::Private::indent(), ManDocVisitor::operator()(), ManDocVisitor::operator()(), ManDocVisitor::operator()(), ManDocVisitor::operator()(), printNavLayout(), printNavTree(), FlowChart::printNode(), readCodeFragment(), and writeTemplateArgumentList().

◆ find() [1/3]

int QCString::find	(	char	c,
		int	index = 0,
		bool	cs = TRUE ) const

Definition at line 43 of file qcstring.cpp.

{
  if (index<0 || index>=static_cast<int>(length())) return -1; // index outside string
  const char *pos = nullptr;
  if (cs)
  {
    pos = strchr(data()+index,c);
  }
  else
  {
    pos = data()+index;
    c = toLowerChar(c);
    while (*pos && toLowerChar(*pos)!=c) pos++;
    if (!*pos && c) pos=nullptr; // not found
  }
  return pos ? static_cast<int>(pos - data()) : -1;
}

References data(), length(), and toLowerChar().

Referenced by MemberDefImpl::_computeIsConstructor(), MemberDefImpl::_computeIsDestructor(), DefinitionImpl::_docsAlreadyAdded(), MemberDefImpl::_writeCategoryRelation(), MemberDefImpl::_writeReimplements(), VhdlDocGen::addBaseClass(), addClassToContext(), VHDLOutlineParser::addCompInst(), addConceptToContext(), ModuleManager::addDocs(), addHtmlExtensionIfMissing(), addMacroDefinition(), addSubprogram(), addTemplateNames(), ClassDefImpl::addTypeConstraints(), addVariableToFile(), adjustConfiguration(), argListToString(), buildScopeFromQualifiedName(), Config::checkAndCorrect(), VHDLOutlineParser::checkInlineCode(), checkList(), combineArgsAndException(), computeClassRelations(), VhdlDocGen::convertFileNameToClassName(), DotFilePatcher::convertMapFile(), MemberList::countEnumValues(), createDVIFile(), determineBlockName(), MemberDefImpl::displayDefinition(), DocInternalRef::DocInternalRef(), ExistsOnPath(), extractBeginRawStringDelimiter(), extractBlock(), extractBoundingBox(), extractClassName(), extractFromParens(), extractLanguageSpecificTitle(), extractNoExcept(), extractPartAfterNewLine(), fillColorStyleMap(), filterMemberDocumentation(), find(), VhdlDocGen::findAllArchitectures(), DocParser::findDocsForMemberOrCompound(), findGlobalMember(), findMember(), VhdlDocGen::findMemberDef(), findPackageScopeFromPath(), findUsedClassesForClass(), findUsingDeclImports(), generateClassOrGlobalLink(), generateDEFForClass(), generateFileSources(), generateFunctionLink(), CitationManager::generatePage(), generateXML(), generateXMLForMember(), getDefsOld(), getDotImageExtension(), getFilteredImageAttributes(), getFilterFromList(), getLinkInScope(), ParserManager::getParsers(), SymbolResolver::Private::getResolvedSymbolRec(), getTemplateArgumentsFromName(), DocPara::handleCommand(), DocParser::handleParameterType(), handleToc(), CitationManager::insertCrossReferencesForBibFile(), insertTemplateSpecifierInScope(), isCastKeyword(), MemberDefImpl::isDocumentedFriendClass(), ClassDefImpl::isExtension(), isRecursiveBaseClass(), DocImage::isSVG(), isURL(), isVarWithConstructor(), lineBlock(), linkToText(), Htags::loadFilemap(), makeBaseName(), makeBaseName(), makeBaseName(), makeQualifiedNameWithTemplateParameters(), makeTemplateInstanceRelation(), matchCanonicalTypes(), matchExcludedSymbols(), mergeArguments(), mergeCategories(), DirDefImpl::mergeDirectoryInTree(), nameIsOperator(), SymbolResolver::Private::newResolveTypedef(), normalizeNonTemplateArgumentsInString(), VHDLOutlineParser::oneLineComment(), SymbolModifiers::operator|=(), DocLink::parse(), DocParamList::parse(), parseFuncDecl(), VhdlDocGen::parseFuncProto(), parseMain(), VhdlDocGen::parseUCF(), Markdown::Private::processLink(), processTagLessClasses(), projectLogoFile(), projectLogoSize(), readTagFile(), CitationManager::replaceFormulas(), replaceRef(), replaceVariables(), resolveRef(), resolveSymlink(), resolveTypeDef(), DotFilePatcher::run(), searchTemplateSpecs(), MemberList::setAnonymousEnumType(), setClassScope(), SearchIndexExternal::setCurrentDoc(), setJavaProtection(), splitSearchTokens(), splitString(), LatexDocVisitor::startPlantUmlFile(), stripDeclKeywords(), stripIrrelevantString(), stripTemplateSpecifiersFromScope(), subrHandleCommentBlock(), substEnvVarsInStrList(), Portable::system(), trimBaseClassScope(), Portable::unsetenv(), MemberDefImpl::warnIfUndocumented(), MemberDefImpl::warnIfUndocumentedParams(), DotNode::writeDEF(), writeDefArgumentList(), FileDefImpl::writeDetailedDescription(), DotNode::writeDocbook(), MemberDefImpl::writeDocumentation(), writeExceptionList(), writeExceptionListImpl(), HtmlGenerator::writeExternalSearchPage(), writeFileIndex(), VhdlDocGen::writeFormatString(), writeGraphInfo(), LatexDocVisitor::writePlantUMLFile(), VhdlDocGen::writeRecordUnit(), VhdlDocGen::writeSource(), DefinitionImpl::writeSourceDef(), and DotNode::writeXML().

◆ find() [2/3]

int QCString::find	(	const char *	str,
		int	index = 0,
		bool	cs = TRUE ) const

Definition at line 61 of file qcstring.cpp.

{
  int l = static_cast<int>(length());
  if (index<0 || index>=l) return -1; // index outside string
  if (!str)  return -1;               // no string to search for
  if (!*str) return index;           // empty string matching at index
  const char *pos = nullptr;
  if (cs) // case sensitive
  {
    pos = strstr(data()+index,str);
  }
  else // case insensitive
  {
    pos = data();
    int len = qstrlen(str);
    while (*pos)
    {
      if (qstrnicmp(pos,str,len)==0) break;
      pos++;
    }
    if (!*pos) pos = nullptr; // not found
  }
  return pos ? static_cast<int>(pos - data()) : -1;
}

References data(), length(), qstrlen(), qstrnicmp(), and str().

◆ find() [3/3]

int QCString::find	(	const QCString &	str,
		int	index = 0,
		bool	cs = TRUE ) const

Definition at line 86 of file qcstring.cpp.

{
  return find(str.data(),index,cs);
}

References find(), QCString(), and str().

◆ findRev() [1/2]

int QCString::findRev	(	char	c,
		int	index = -1,
		bool	cs = TRUE ) const

Definition at line 91 of file qcstring.cpp.

{
  const char *b = data();
  const char *pos = nullptr;
  int len = static_cast<int>(length());
  if (len==0) return -1; // empty string
  if (index<0) // start from end
  {
    if (cs)
    {
      pos = strrchr(b,c);
      return pos ? static_cast<int>(pos - b) : -1;
    }
    index=len;
  }
  else if (index>len) // bad index
  {
    return -1;
  }
  pos = b+index;
  if (cs)
  {
    while ( pos>=b && *pos!=c) pos--;
  }
  else
  {
    c = toLowerChar(c);
    while ( pos>=b && toLowerChar(*pos)!=c) pos--;
  }
  return pos>=b ? static_cast<int>(pos - b) : -1;
}

References data(), length(), and toLowerChar().

Referenced by abbreviate(), addClassToContext(), addEnumValuesToEnums(), addHtmlExtensionIfMissing(), addMemberFunction(), addModule(), addTemplateNames(), TooltipManager::addTooltip(), alignText(), buildDirectories(), buildFileList(), combineArgsAndException(), computeCommonDirPrefix(), convertFileId2Var(), VhdlDocGen::correctMemberProperties(), MemberList::countEnumValues(), VhdlDocGen::deleteAllChars(), VhdlDocGen::deleteCharRev(), MemberDefImpl::displayDefinition(), endScope(), extractFromParens(), extractNamespaceName(), fillColorStyleMap(), DocParser::findAndCopyImage(), findClassRelation(), findDirDocumentation(), findEnumDocumentation(), findEnums(), findFileDef(), findGlobalMember(), findPackageScopeFromPath(), findParameterList(), findUsingDeclImports(), findUsingDirectives(), generateClassOrGlobalLink(), generateFunctionLink(), generateFunctionLink(), generateMemberLink(), PlantumlManager::generatePlantUMLOutput(), generateXMLForMember(), getBaseNameOfOutput(), getDefsOld(), getFileNameExtension(), getParserForFile(), getScopeDefs(), guessSection(), FileDefImpl::isDocumentationFile(), NamespaceDefImpl::isLinkableInProject(), Htags::loadFilemap(), makeBaseName(), makeShortName(), makeShortName(), makeShortName(), markdownFileNameToId(), mergeScopes(), SymbolResolver::Private::newResolveTypedef(), PerlModDocVisitor::operator()(), parseFile(), VhdlDocGen::parseForBinding(), VhdlDocGen::parseForConfig(), parseFuncDecl(), VhdlDocGen::parseFuncProto(), VHDLOutlineParser::popLabel(), readCodeFragment(), relativePathToRoot(), resolveModuleProcedures(), resolveRef(), resolveTypeDef(), MemberList::setAnonymousEnumType(), setCallContextForVar(), setClassScope(), showFileDefMatches(), ManGenerator::startDoxyAnchor(), stripPath(), NamespaceDefImpl::updateLocalName(), version(), writeDefArgumentList(), MemberDefImpl::writeDocumentation(), MemberDefImpl::writeEnumDeclaration(), writeMscGraphFromFile(), PlantumlManager::writePlantUMLSource(), FlowChart::writeShape(), and DotNode::writeUrl().

◆ findRev() [2/2]

int QCString::findRev	(	const char *	str,
		int	index = -1,
		bool	cs = TRUE ) const

Definition at line 123 of file qcstring.cpp.

{
  int slen = static_cast<int>(qstrlen(str));
  int len = static_cast<int>(length());
  if (index<0) index = len-slen; // start from end
  else if (index>len) return -1; // bad index
  else if (index+slen>len) index=len-slen; // str would be too long
  if (index<0) return -1; // no match possible
  const char *pos = data()+index;
  if (cs) // case sensitive
  {
    for (int i=index; i>=0; i--) if (qstrncmp(pos--,str,slen)==0) return i;
  }
  else // case insensitive
  {
    for (int i=index; i>=0; i--) if (qstrnicmp(pos,str,slen)==0) return i;
  }
  return -1;
}

References data(), length(), qstrlen(), qstrncmp(), qstrnicmp(), and str().

◆ insert() [1/4]

QCString & QCString::insert	(	size_t	index,
		char	c )

inline

Definition at line 375 of file qcstring.h.

    {
      char s[2] = { c, '\0' };
      return insert(index,s);
    }

References insert(), and QCString().

◆ insert() [2/4]

QCString & QCString::insert	(	size_t	index,
		const char *	s )

inline

Definition at line 355 of file qcstring.h.

    {
      size_t len = s ? qstrlen(s) : 0;
      if (len>0)
      {
        size_t ol = m_rep.size();
        if (index>ol) // insert beyond end of string and fill gap with spaces
        {
          m_rep.resize(index+len);
          std::memset(&m_rep[ol],' ',index-ol);
          std::memcpy(&m_rep[index],s,len+1);
        }
        else // insert inside the string
        {
          m_rep.insert(index,s);
        }
      }
      return *this;
    }

References m_rep, QCString(), and qstrlen().

◆ insert() [3/4]

QCString & QCString::insert	(	size_t	index,
		const QCString &	s )

inline

Definition at line 317 of file qcstring.h.

    {
      if (s.length()>0)
      {
        size_t ol = m_rep.size();
        if (index>ol) // insert beyond end of string and fill gap with spaces
        {
          m_rep.resize(index+s.length());
          std::memset(&m_rep[ol],' ',index-ol);
          std::memcpy(&m_rep[index],s.data(),s.length()+1);
        }
        else // insert inside the string
        {
          m_rep.insert(index,s.str());
        }
      }
      return *this;
    }

References data(), length(), m_rep, QCString(), and str().

Referenced by FileDefImpl::addIncludedUsingDirectives(), insert(), prepend(), prepend(), prepend(), prepend(), and replace().

◆ insert() [4/4]

QCString & QCString::insert	(	size_t	index,
		std::string_view	s )

inline

Definition at line 336 of file qcstring.h.

    {
      if (s.length()>0)
      {
        size_t ol = m_rep.size();
        if (index>ol) // insert beyond end of string and fill gap with spaces
        {
          m_rep.resize(index+s.length());
          std::memset(&m_rep[ol],' ',index-ol);
          std::memcpy(&m_rep[index],s.data(),s.length()+1);
        }
        else // insert inside the string
        {
          m_rep.insert(index,s);
        }
      }
      return *this;
    }

References m_rep, and QCString().

◆ isEmpty()

bool QCString::isEmpty ( ) const

inline

Returns TRUE iff the string is empty.

Definition at line 150 of file qcstring.h.

150{ return m_rep.empty(); }

References m_rep.

◆ left()

QCString QCString::left ( size_t len ) const

inline

Definition at line 214 of file qcstring.h.

    {
      return m_rep.empty() ? QCString() : QCString(m_rep.substr(0,len));
    }

References m_rep, and QCString().

Referenced by MemberDefImpl::_computeIsConstructor(), MemberDefImpl::_writeCategoryRelation(), MemberDefImpl::_writeReimplements(), abbreviate(), VhdlDocGen::addBaseClass(), addCite(), addClassToContext(), VHDLOutlineParser::addCompInst(), addEnumValuesToEnums(), DocSets::addIndexItem(), addMacroDefinition(), addMemberFunction(), addRelatedPage(), addTemplateNames(), adjustConfiguration(), alignText(), argListToString(), buildDirectories(), buildFileList(), DocParser::checkArgumentName(), checkList(), DocParser::checkUnOrMultipleDocumentedParams(), codifyLines(), combineArgsAndException(), computeCommonDirPrefix(), DotFilePatcher::convertMapFile(), convertNameToFile(), convertToHtmlAndTruncate(), ResourceMgr::copyResourceAs(), VhdlDocGen::correctMemberProperties(), createTagLessInstance(), determineBlockName(), MemberDefImpl::displayDefinition(), DocInternalRef::DocInternalRef(), expandExpression(), extractClassName(), extractLanguageSpecificTitle(), extractNamespaceName(), extractNoExcept(), Markdown::Private::extractTitleId(), fillColorStyleMap(), filterMemberDocumentation(), DocParser::findAndCopyImage(), findClassRelation(), findDirDocumentation(), DocParser::findDocsForMemberOrCompound(), findEnumDocumentation(), findEnums(), findFileDef(), findGlobalMember(), findMember(), findPackageScopeFromPath(), findScopeFromQualifiedName(), findUsingDeclImports(), findUsingDirectives(), generateClassOrGlobalLink(), generateClassOrGlobalLink(), generateFunctionLink(), generateFunctionLink(), generateMemberLink(), CitationManager::generatePage(), generateXMLForMember(), getBaseNameOfOutput(), MemberDefImpl::getClassDefOfAnonymousType(), getDefsOld(), getDotImageExtension(), getFilteredImageAttributes(), getFilterFromList(), getMemberFromSymbol(), ParserManager::getParsers(), SymbolResolver::Private::getResolvedSymbolRec(), SymbolResolver::Private::getResolvedTypeRec(), getScopeDefs(), getTemplateArgumentsFromName(), DocPara::handleCommand(), handleToc(), initUCF(), insertTemplateSpecifierInScope(), Markdown::Private::isAtxHeader(), isCastKeyword(), MemberDefImpl::isDocumentedFriendClass(), isRecursiveBaseClass(), isURL(), isVarWithConstructor(), DiagramItem::label(), leftScopeMatch(), Htags::loadFilemap(), makeBaseName(), makeBaseName(), makeBaseName(), makeDisplayName(), makeTemplateInstanceRelation(), markdownFileNameToId(), matchCanonicalTypes(), matchExcludedSymbols(), mergeArguments(), mergeCategories(), DirDefImpl::mergeDirectoryInTree(), ClassDefImpl::mergeMembersFromBaseClasses(), mergeScopes(), SymbolResolver::Private::newResolveTypedef(), normalizeNonTemplateArgumentsInString(), LatexDocVisitor::operator()(), DocLink::parse(), parseCommentAsText(), parseFuncDecl(), VhdlDocGen::parseFuncProto(), MarkdownOutlineParser::parseInput(), parseMain(), VhdlDocGen::parseUCF(), VHDLOutlineParser::popLabel(), FlowChart::printNode(), Markdown::Private::processLink(), projectLogoFile(), readTagFile(), replaceNamespaceAliasesRec(), replaceRef(), resolveRef(), resolveSymlink(), resolveTypeDef(), DotFilePatcher::run(), searchInputFiles(), searchTemplateSpecs(), setCallContextForVar(), setClassScope(), showFileDefMatches(), simplifyTypeForTable(), splitKnRArg(), splitString(), stripAnonymousNamespaceScope(), stripComment(), stripDeclKeywords(), stripExtensionGeneral(), stripFromPath(), stripFuncPtr(), stripIrrelevantString(), stripKnownExtensions(), stripWord(), substituteKeywords(), substituteTemplateArgumentsInString(), trimBaseClassScope(), MemberDefImpl::writeDeclaration(), DotNode::writeDEF(), writeDefArgumentList(), FileDefImpl::writeDetailedDescription(), DotNode::writeDocbook(), MemberDefImpl::writeDocumentation(), writeExceptionListImpl(), HtmlGenerator::writeExternalSearchPage(), HtmlHelpIndex::writeFields(), VhdlDocGen::writeFormatString(), writeGraphInfo(), ClassDefImpl::writeIncludeFilesForSlice(), MemberDefImpl::writeMemberDocSimple(), PlantumlManager::writePlantUMLSource(), VhdlDocGen::writeRecordUnit(), VhdlDocGen::writeSource(), DefinitionImpl::writeSourceDef(), DocSets::writeToken(), DotNode::writeUrl(), and DotNode::writeXML().

◆ length()

size_t QCString::length ( ) const

inline

Returns the length of the string, not counting the 0-terminator.

Equivalent to size().

Definition at line 153 of file qcstring.h.

153{ return m_rep.size(); }

References m_rep.

Referenced by DefinitionImpl::_docsAlreadyAdded(), DefinitionImpl::_setBriefDescription(), HtmlCodeGenerator::_writeCodeLink(), MemberDefImpl::_writeReimplements(), MemberDefImpl::_writeTemplatePrefix(), abbreviate(), VhdlDocGen::addBaseClass(), VHDLOutlineParser::addCompInst(), addEnumValuesToEnums(), addIncludeFile(), DocSets::addIndexItem(), addMacroDefinition(), addMemberToGroups(), addModule(), addRelatedPage(), addSeparatorsIfNeeded(), GrowBuf::addStr(), addTemplateNames(), ClassDefImpl::addTypeConstraints(), FlowChart::alignCommentNode(), FlowChart::alignFuncProc(), alignText(), buildDirectories(), buildFileName(), buildGroupListFiltered(), Config::checkAndCorrect(), DocParser::checkArgumentName(), checkExtension(), VHDLOutlineParser::checkInlineCode(), checkList(), DocParser::checkUnOrMultipleDocumentedParams(), checkVhdlString(), computeCommonDirPrefix(), computeQualifiedIndex(), computeVerifiedDotPath(), configStringRecode(), contains(), contains(), TranslatorPersian::convertDigitsToFarsi(), DotNode::convertLabel(), DotFilePatcher::convertMapFile(), convertNameToFile(), convertToHtmlAndTruncate(), ResourceMgr::copyResourceAs(), MemberList::countEnumValues(), createOutputDirectory(), createTagLessInstance(), detab(), DotClassGraph::determineVisibleNodes(), MemberDefImpl::displayDefinition(), DocAnchor::DocAnchor(), DocEmoji::DocEmoji(), docifyToString(), docifyToString(), DocInternalRef::DocInternalRef(), elemIsVisible(), encodeDirName(), encodeForOutput(), endsWith(), escapeId(), expandExpression(), externalRef(), DefinitionImpl::externalReference(), extractBeginRawStringDelimiter(), extractBind(), extractBlock(), extractCanonicalType(), extractClassNameFromType(), extractEndRawStringDelimiter(), extractFromParens(), extractLanguageSpecificTitle(), extractNamespaceName(), extractNoExcept(), extractTrailingComment(), filter2008VhdlComment(), filterMemberDocumentation(), find(), find(), DocParser::findAndCopyImage(), findClassRelation(), findDirDocumentation(), DocParser::findDocsForMemberOrCompound(), Markdown::Private::findEmphasisChar(), Markdown::Private::findEndOfLine(), findEndOfTemplate(), findEnumDocumentation(), findEnums(), findFileDef(), findMember(), findRev(), findRev(), findScopeFromQualifiedName(), findTemplateSpecializationPosition(), findUsingDeclImports(), findUsingDirectives(), format_warn(), VhdlDocGen::formatString(), generateAnonymousAnchor(), generateClassOrGlobalLink(), generateClassOrGlobalLink(), generateFunctionLink(), generateFunctionLink(), generateMemberLink(), CitationManager::generatePage(), PerlModGenerator::generatePerlModForMember(), getCanonicalTemplateSpec(), MemberDefImpl::getClassDefOfAnonymousType(), getConvertLatexMacro(), getCurrentChar(), getDefsOld(), getExtension(), getFileFilter(), getNextChar(), getNextId(), getParserForFile(), ParserManager::getParsers(), getProjectId(), SymbolResolver::Private::getResolvedSymbolRec(), SymbolResolver::Private::getResolvedTypeRec(), getScopeDefs(), getScopeFragment(), handle_warn_as_error(), DocPara::handleStartCode(), handleToc(), insert(), insertTemplateSpecifierInScope(), Portable::isAbsolutePath(), Markdown::Private::isAtxHeader(), isConstraintFile(), DocImage::isSVG(), isVarWithConstructor(), DiagramItem::label(), latexEscapeIndexChars(), latexEscapeLabelName(), leftScopeMatch(), linkToText(), makeDisplayName(), matchArgument2(), matchExcludedSymbols(), DirDefImpl::matchPath(), mergeArguments(), ClassDefImpl::mergeMembersFromBaseClasses(), mergeScopes(), nameIsActuallyPartOfType(), SymbolResolver::Private::newResolveTypedef(), VHDLOutlineParser::oneLineComment(), DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), LatexDocVisitor::operator()(), LatexDocVisitor::operator()(), LatexDocVisitor::operator()(), ManDocVisitor::operator()(), PerlModDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), TextDocVisitor::operator()(), XmlDocVisitor::operator()(), DocLink::parse(), FileCodeParser::parseCode(), parseCommentAsText(), parseFile(), parseFuncDecl(), VhdlDocGen::parseFuncProto(), MarkdownOutlineParser::parseInput(), parseMain(), Htags::path2URL(), Markdown::process(), Markdown::Private::processBlocks(), Markdown::Private::processLink(), processList(), Markdown::Private::processQuotations(), Markdown::Private::processSpecialCommand(), processString(), projectLogoSize(), DocTokenizer::pushBackHtmlTag(), readCodeFragment(), readIncludeFile(), readIncludeFile(), readTagFile(), HtmlHelpRecoder::recode(), Portable::recodeUtf8StringToW(), recognizeFixedForm(), removeEmptyLines(), removeRedundantWhiteSpace(), replaceFunctionMacro(), replaceVariables(), resolveRef(), resolveSymlink(), resolveTypeDef(), resolveUserReferences(), rightScopeMatch(), searchInputFiles(), searchTemplateSpecs(), selectBlocks(), MemberDefImpl::setAnchor(), MemberList::setAnonymousEnumType(), setCallContextForVar(), setClassScope(), showFileDefMatches(), simplifyTypeForTable(), simplifyWhiteSpace(), skipToEndMarker(), splitSearchTokens(), sprintf(), ManGenerator::startDoxyAnchor(), startsWithKeyword(), stringize(), stripAnonymousMarkers(), stripAnonymousNamespaceScope(), stripComment(), stripExtensionGeneral(), stripFromPath(), stripFuncPtr(), stripIrrelevantString(), stripKnownExtensions(), stripLeadingAndTrailingEmptyLines(), stripQuotes(), stripQuotes(), stripScope(), stripTemplateSpecifiers(), stripTemplateSpecifiersFromScope(), stripTrailingWhiteSpace(), stripWord(), subrHandleCommentBlock(), substEnvVarsInStrList(), substitute(), substitute(), substituteKeywords(), SymbolResolver::Private::substTypedef(), toLong(), toUInt64(), toULong(), trimBaseClassScope(), Trace::trunc(), TranslatorJapanese::trWriteList(), unputChar(), DocTokenizer::unputString(), validatingParseDoc(), DocbookCodeGenerator::writeCodeLink(), LatexCodeGenerator::writeCodeLink(), RTFCodeGenerator::writeCodeLink(), XMLCodeGenerator::writeCodeLink(), DocbookCodeGenerator::writeCodeLinkLine(), MemberDefImpl::writeDeclaration(), writeDefArgumentList(), FileDefImpl::writeDetailedDescription(), MemberDefImpl::writeDocumentation(), MemberDefImpl::writeEnumDeclaration(), HtmlGenerator::writeExternalSearchPage(), ClassDefImpl::writeIncludeFilesForSlice(), writeMscGraphFromFile(), PlantumlManager::writePlantUMLSource(), FlowChart::writeShape(), writeSingleFileIndex(), DefinitionImpl::writeSourceDef(), writeString(), ConfigOption::writeStringList(), ClassDefImpl::writeTemplateSpec(), DocSets::writeToken(), writeUCFLink(), DotNode::writeUrl(), writeWord(), and HtmlEntityMapper::writeXMLSchema().

◆ lower()

QCString QCString::lower ( ) const

inline

Definition at line 234 of file qcstring.h.

    {
      return QCString(convertUTF8ToLower(m_rep));
    }

References convertUTF8ToLower(), m_rep, and QCString().

Referenced by VHDLOutlineParser::addCompInst(), DocSets::addIndexItem(), VHDLOutlineParser::addLibUseClause(), addLocalVar(), addSubprogram(), adjustConfiguration(), Config::checkAndCorrect(), DocParser::checkArgumentName(), checkFileName(), checkIfHtmlEndTagEndsAutoList(), DocParser::checkUnOrMultipleDocumentedParams(), codifyMapLines(), convertStringToBool(), VhdlDocGen::correctMemberProperties(), elemIsVisible(), endScope(), extractClassNameFromType(), CitationManager::find(), findArgument(), findFileDef(), VhdlDocGen::findKeyWord(), VhdlDocGen::findMember(), generateLink(), CitationManager::generatePage(), genericPatternMatch(), getFilteredImageAttributes(), getFilterFromList(), getFortranDefs(), getLanguageFromCodeLang(), getLanguageFromFileName(), getParameter(), ParserManager::getParsers(), guessSection(), DocPara::handleCommand(), handleFileInfoResult(), handleHtmlTag(), DocParser::handleImage(), handleImage(), handleInheritanceGraph(), handleToc(), MemberDefImpl::init(), CitationManager::insert(), CitationManager::insertCrossReferencesForBibFile(), keyWordsFortranC(), Mapper< T >::map(), COutlineParser::needsPreprocessing(), FortranOutlineParser::needsPreprocessing(), SymbolModifiers::operator|=(), MarkdownOutlineParser::parseInput(), Markdown::Private::processHtmlTagWrite(), Markdown::Private::processLink(), subrHandleCommentBlock(), subrHandleCommentBlockResult(), substituteHtmlKeywords(), updateLanguageMapping(), Config::updateObsolete(), Markdown::Private::writeBlockQuote(), and ClassDefImpl::writeTemplateSpec().

◆ mid()

QCString QCString::mid	(	size_t	index,
		size_t	len = static_cast<size_t>(-1) ) const

inline

Definition at line 226 of file qcstring.h.

    {
      size_t slen = m_rep.size();
      if (len==static_cast<uint32_t>(-1)) len = slen-index;
      return m_rep.empty() || index>slen || len==0 ? QCString() :
             QCString(m_rep.substr(index,len));
    }

References m_rep, and QCString().

◆ operator+=() [1/4]

QCString & QCString::operator+= ( const char * s )

inline

Appends string str to this string and returns a reference to the result.

Definition at line 550 of file qcstring.h.

    {
      if (s) m_rep+=s;
      return *this;
    }

References m_rep, and QCString().

◆ operator+=() [2/4]

QCString & QCString::operator+= ( const QCString & s )

inline

Definition at line 531 of file qcstring.h.

    {
      m_rep+=s.str();
      return *this;
    }

References m_rep, QCString(), and str().

Referenced by append(), append(), append(), and append().

◆ operator+=() [3/4]

QCString & QCString::operator+= ( const std::string & s )

inline

Definition at line 537 of file qcstring.h.

    {
      m_rep+=s;
      return *this;
    }

References m_rep, and QCString().

◆ operator+=() [4/4]

QCString & QCString::operator+= ( std::string_view s )

inline

Definition at line 543 of file qcstring.h.

    {
      m_rep+=s;
      return *this;
    }

References m_rep, and QCString().

◆ operator=() [1/4]

QCString & QCString::operator= ( const char * str )

inline

replaces the contents by that of C string str.

Definition at line 145 of file qcstring.h.

145{ m_rep = str?str:""; return *this; }

References m_rep, QCString(), and str().

◆ operator=() [2/4]

QCString & QCString::operator= ( const JavaCCString & s )

inline

Definition at line 123 of file qcstring.h.

    {
      m_rep.resize(s.size());
      memcpy(m_rep.data(),s.data(),s.size());
      return *this;
    }

References m_rep, and QCString().

◆ operator=() [3/4]

QCString & QCString::operator= ( const std::string & s )

inline

Definition at line 147 of file qcstring.h.

147{ m_rep = s; return *this; }

References m_rep, and QCString().

◆ operator=() [4/4]

QCString & QCString::operator= ( std::string_view sv )

inline

Definition at line 110 of file qcstring.h.

                                           {
      m_rep=sv;
      return *this;
    }

References m_rep, and QCString().

◆ operator[]() [1/2]

char & QCString::operator[] ( size_t i )

inline

Indexing operator.

Equivalent to at().

Definition at line 578 of file qcstring.h.

    {
      return m_rep[i];
    }

References m_rep.

◆ operator[]() [2/2]

const char & QCString::operator[] ( size_t i ) const

inline

Definition at line 583 of file qcstring.h.

    {
      return m_rep[i];
    }

References m_rep.

◆ prepend() [1/4]

QCString & QCString::prepend ( const char * s )

inline

Definition at line 407 of file qcstring.h.

    {
      return insert(0,s);
    }

References insert(), and QCString().

Referenced by addClassToContext(), addConceptToContext(), MemberDefImpl::addListReference(), addMemberFunction(), addModule(), addSTLClass(), ClassDefImpl::addUsedByClass(), ClassDefImpl::addUsedClass(), FlowChart::alignFuncProc(), MemberDefImpl::anchor(), convertNameToFile(), correctURL(), VHDLOutlineParser::createFlow(), createOutputDirectory(), MemberDefImpl::displayDefinition(), DocEmoji::DocEmoji(), externalRef(), DefinitionImpl::externalReference(), MemberDefImpl::fieldType(), filterMemberDocumentation(), findClassRelation(), DocParser::findDocsForMemberOrCompound(), findEnumDocumentation(), findEnums(), findMember(), generateDEFForMember(), generateOutput(), generatePHPVariableLink(), MemberDefImpl::getDeclType(), getExtension(), getLanguageFromFileName(), getLink(), getLink(), FlowChart::getNodeName(), getScopeDefs(), SymbolResolver::Private::newResolveTypedef(), HtmlDocVisitor::operator()(), parseFuncDecl(), MarkdownOutlineParser::parseInput(), processTagLessClasses(), projectLogoSize(), quoted(), replaceRef(), MemberDefImpl::setAnchor(), SearchIndex::setCurrentDoc(), setDotFontPath(), MemberDefImpl::sourceRefName(), LatexDocVisitor::startDiaFile(), LatexDocVisitor::startDotFile(), LatexDocVisitor::startMscFile(), substituteHtmlKeywords(), unputChar(), updateLanguageMapping(), MemberDefImpl::writeDeclaration(), writeDefArgumentList(), HtmlDocVisitor::writeDiaFile(), MemberDefImpl::writeDocumentation(), HtmlDocVisitor::writeDotFile(), writeIndexHierarchyEntries(), HtmlGenerator::writeInheritedSectionTitle(), VhdlDocGen::writeInlineClassLink(), LatexCodeGenerator::writeLineNumber(), RTFCodeGenerator::writeLineNumber(), MemberDefImpl::writeLink(), writeMemberReference(), HtmlDocVisitor::writeMscFile(), PlantumlManager::writePlantUMLSource(), writeSingleFileIndex(), VhdlDocGen::writeSource(), VhdlDocGen::writeVHDLDeclaration(), and VhdlDocGen::writeVhdlLink().

◆ prepend() [2/4]

QCString & QCString::prepend ( const QCString & s )

inline

Definition at line 412 of file qcstring.h.

    {
      return insert(0,s.data());
    }

References data(), insert(), and QCString().

◆ prepend() [3/4]

QCString & QCString::prepend ( const std::string & s )

inline

Definition at line 417 of file qcstring.h.

    {
      return insert(0,s.c_str());
    }

References insert(), and QCString().

◆ prepend() [4/4]

QCString & QCString::prepend ( std::string_view s )

inline

Definition at line 422 of file qcstring.h.

    {
      return insert(0,s);
    }

References insert(), and QCString().

◆ quoted()

QCString QCString::quoted ( ) const

inline

Definition at line 260 of file qcstring.h.

    {
      size_t start=0, sl=m_rep.size(), end=sl-1;
      while (start<sl  && qisspace(m_rep[start])) start++; // skip over leading whitespace
      if (start==sl) return QCString(); // only whitespace
      while (end>start && qisspace(m_rep[end]))   end--;   // skip over trailing whitespace
      bool needsQuotes=false;
      size_t i=start;
      if (i<end && m_rep[i]!='"') // stripped string has at least non-whitespace unquoted character
      {
        while (i<end && !needsQuotes) // check if the to be quoted part has at least one whitespace character
        {
          needsQuotes = m_rep[i] =='-';
          needsQuotes |= qisspace(m_rep[i++]);
        }
      }
      QCString result(m_rep.substr(start,1+end-start));
      if (needsQuotes)
      {
        result.prepend("\"");
        result.append("\"");
      }
      return result;
    }

References append(), end(), m_rep, prepend(), QCString(), and qisspace().

Referenced by projectLogoSize(), DotAttributes::updateValue(), writeLatexMakefile(), and writeMakeBat().

◆ rawData()

char * QCString::rawData ( )

inline

Returns a writable pointer to the data.

Definition at line 165 of file qcstring.h.

165{ return &m_rep[0]; }

References m_rep.

Referenced by configStringRecode(), ResourceMgr::copyResourceAs(), do_warn(), ResourceMgr::getAsString(), SymbolResolver::Private::getResolvedTypeRec(), HtmlHelpRecoder::recode(), repeat(), simplifyWhiteSpace(), sprintf(), stripIndentationVerbatim(), substitute(), substitute(), and transcodeCharacterStringToUTF8().

◆ remove()

QCString & QCString::remove	(	size_t	index,
		size_t	len )

inline

Definition at line 427 of file qcstring.h.

    {
      size_t ol = m_rep.size();
      if (index<ol && len>0) m_rep.erase(index,index+len>=ol ? std::string::npos : len);
      return *this;
    }

References m_rep, and QCString().

Referenced by alignText(), VhdlDocGen::convertFileNameToClassName(), VhdlDocGen::deleteAllChars(), VhdlDocGen::deleteCharRev(), endScope(), extractFromParens(), initUCF(), VhdlDocGen::parseForBinding(), VhdlDocGen::parseForConfig(), VhdlDocGen::parseUCF(), replace(), resolveModuleProcedures(), splitString(), MemberDefImpl::writeDocumentation(), VhdlDocGen::writeFormatString(), and FlowChart::writeShape().

◆ removeWhiteSpace()

QCString QCString::removeWhiteSpace ( ) const

inline

returns a copy of this string with all whitespace removed

Definition at line 286 of file qcstring.h.

    {
      size_t sl = m_rep.size();
      if (sl==0) return *this;
      std::string result = m_rep;
      size_t src=0,dst=0;
      while (src<sl)
      {
        if (!qisspace(m_rep[src])) result[dst++]=m_rep[src];
        src++;
      }
      if (dst<m_rep.size()) result.resize(dst);
      return QCString(result);
    }

References m_rep, QCString(), and qisspace().

◆ repeat()

QCString QCString::repeat ( unsigned int n ) const

inline

Definition at line 306 of file qcstring.h.

    {
      QCString result(n * size(), ExplicitSize);
      size_t offset = 0;
      for (offset = 0; offset < n * size(); offset += size())
      {
        memcpy(result.rawData() + offset, data(), size());
      }
      return result;
    }

References data(), ExplicitSize, QCString(), rawData(), and size().

◆ replace()

QCString & QCString::replace	(	size_t	index,
		size_t	len,
		const char *	s )

Definition at line 212 of file qcstring.cpp.

{
  remove( index, len );
  insert( index, s );
  return *this;
}

References insert(), QCString(), and remove().

Referenced by VhdlDocGen::convertFileNameToClassName(), VhdlDocGen::formatString(), version(), writeClassTreeInsideNamespaceElement(), writeNamespaceIndex(), and writeNamespaceTreeElement().

◆ reserve()

void QCString::reserve ( size_t size )

inline

Reserve space for size bytes without changing the string contents.

Definition at line 172 of file qcstring.h.

172{ m_rep.reserve(size); }

References m_rep, and size().

Referenced by docifyToString(), docifyToString(), selectBlocks(), and PlantumlManager::writePlantUMLSource().

◆ resize()

void QCString::resize ( size_t newlen )

inline

Definition at line 167 of file qcstring.h.

167{ m_rep.resize(newlen); }

References m_rep.

Referenced by alignText(), configStringRecode(), readCodeFragment(), HtmlHelpRecoder::recode(), simplifyWhiteSpace(), splitSearchTokens(), sprintf(), stripAnonymousMarkers(), stripIndentationVerbatim(), stripTrailingWhiteSpace(), substitute(), and transcodeCharacterStringToUTF8().

◆ right()

QCString QCString::right ( size_t len ) const

inline

Definition at line 219 of file qcstring.h.

    {
      return m_rep.empty()    ? QCString() :
             len<m_rep.size() ? QCString(m_rep.substr(m_rep.size()-len,len)) :
             *this;
    }

References m_rep, and QCString().

Referenced by MemberDefImpl::_writeReimplements(), VhdlDocGen::addBaseClass(), VHDLOutlineParser::addCompInst(), addEnumValuesToEnums(), addMacroDefinition(), addModule(), addRelatedPage(), addTemplateNames(), ClassDefImpl::addTypeConstraints(), buildFileName(), checkExtension(), checkList(), computeCommonDirPrefix(), DotFilePatcher::convertMapFile(), MemberList::countEnumValues(), DocInternalRef::DocInternalRef(), expandExpression(), extractCanonicalType(), extractNamespaceName(), filterMemberDocumentation(), DocParser::findAndCopyImage(), findClassRelation(), DocParser::findDocsForMemberOrCompound(), findEnumDocumentation(), findEnums(), findFileDef(), findMember(), findScopeFromQualifiedName(), findUsingDeclImports(), generateClassOrGlobalLink(), generateClassOrGlobalLink(), generateFunctionLink(), generateFunctionLink(), generateMemberLink(), CitationManager::generatePage(), PerlModGenerator::generatePerlModForMember(), getCanonicalTemplateSpec(), getDefsOld(), getNextChar(), getParserForFile(), getScopeDefs(), handleToc(), insertTemplateSpecifierInScope(), isConstraintFile(), linkToText(), matchArgument2(), mergeArguments(), mergeScopes(), SymbolResolver::Private::newResolveTypedef(), VHDLOutlineParser::oneLineComment(), PerlModDocVisitor::operator()(), RTFDocVisitor::operator()(), DocLink::parse(), parseFile(), parseFuncDecl(), MarkdownOutlineParser::parseInput(), readTagFile(), resolveRef(), resolveTypeDef(), rightScopeMatch(), MemberList::setAnonymousEnumType(), setCallContextForVar(), setClassScope(), showFileDefMatches(), ManGenerator::startDoxyAnchor(), stripAnonymousNamespaceScope(), stripExtensionGeneral(), stripFromPath(), stripIrrelevantString(), stripKnownExtensions(), stripScope(), stripTemplateSpecifiersFromScope(), stripWord(), subrHandleCommentBlock(), substEnvVarsInStrList(), tempArgListToString(), trimBaseClassScope(), MemberDefImpl::writeDeclaration(), FileDefImpl::writeDetailedDescription(), MemberDefImpl::writeEnumDeclaration(), HtmlGenerator::writeExternalSearchPage(), HtmlHelpIndex::writeFields(), ClassDefImpl::writeIncludeFilesForSlice(), writeMscGraphFromFile(), PlantumlManager::writePlantUMLSource(), DefinitionImpl::writeSourceDef(), and DotNode::writeUrl().

◆ setNum() [1/8]

QCString & QCString::setNum ( int n )

inline

Definition at line 456 of file qcstring.h.

    {
      m_rep = std::to_string(n);
      return *this;
    }

References m_rep, and QCString().

◆ setNum() [2/8]

QCString & QCString::setNum ( long long n )

inline

Definition at line 474 of file qcstring.h.

    {
      m_rep = std::to_string(n);
      return *this;
    }

References m_rep, and QCString().

◆ setNum() [3/8]

QCString & QCString::setNum ( long n )

inline

Definition at line 468 of file qcstring.h.

    {
      m_rep = std::to_string(n);
      return *this;
    }

References m_rep, and QCString().

◆ setNum() [4/8]

QCString & QCString::setNum ( short n )

inline

Definition at line 444 of file qcstring.h.

    {
      m_rep = std::to_string(n);
      return *this;
    }

References m_rep, and QCString().

Referenced by VhdlDocGen::addBaseClass(), addModule(), compileOptions(), compileOptions(), compileOptions(), compileOptions(), compileOptions(), convertCppComments(), convertIndexWordToAnchor(), format_warn(), generateAnonymousAnchor(), generateIndentLabel(), generateJSNavTree(), CitationManager::generatePage(), VHDLOutlineParser::getNameID(), FlowChart::getNodeName(), RTFDocVisitor::getStyle(), CitationManager::latexBibFiles(), pathToNode(), Markdown::Private::processLink(), processTagLessClasses(), removeIdsAndMarkers(), setOutput(), warn_line(), PlantumlManager::writePlantUMLSource(), Markdown::Private::writeTableBlock(), and yearToString().

◆ setNum() [5/8]

QCString & QCString::setNum ( uint16_t n )

inline

Definition at line 450 of file qcstring.h.

    {
      m_rep = std::to_string(n);
      return *this;
    }

References m_rep, and QCString().

◆ setNum() [6/8]

QCString & QCString::setNum ( uint32_t n )

inline

Definition at line 462 of file qcstring.h.

    {
      m_rep = std::to_string(n);
      return *this;
    }

References m_rep, and QCString().

◆ setNum() [7/8]

QCString & QCString::setNum ( unsigned long long n )

inline

Definition at line 480 of file qcstring.h.

    {
      m_rep = std::to_string(n);
      return *this;
    }

References m_rep, and QCString().

◆ setNum() [8/8]

QCString & QCString::setNum ( unsigned long n )

inline

Definition at line 486 of file qcstring.h.

    {
      m_rep = std::to_string(n);
      return *this;
    }

References m_rep, and QCString().

◆ simplifyWhiteSpace()

QCString QCString::simplifyWhiteSpace ( ) const

return a copy of this string with leading and trailing whitespace removed and multiple whitespace characters replaced by a single space

Definition at line 185 of file qcstring.cpp.

{
  if ( isEmpty() )                            // nothing to do
    return *this;
 
  QCString result( length(), ExplicitSize );
  const char *from  = data();
  char *to    = result.rawData();
  char *first = to;
  while ( TRUE )
  {
    while ( *from && qisspace(*from) )
      from++;
    while ( *from && !qisspace(*from) )
      *to++ = *from++;
    if ( *from )
      *to++ = 0x20;                       // ' '
    else
      break;
  }
  if ( to > first && *(to-1) == 0x20 )
    to--;
  *to = '\0';
  result.resize( static_cast<int>(to - result.data()) );
  return result;
}

References data(), ExplicitSize, isEmpty(), length(), QCString(), qisspace(), rawData(), resize(), and TRUE.

Referenced by DefinitionImpl::_docsAlreadyAdded(), addVariable(), VHDLOutlineParser::checkInlineCode(), findAndRemoveWord(), Markdown::Private::processLink(), setClassScope(), substituteTemplateArgumentsInString(), and FlowChart::writeFlowLinks().

◆ size()

size_t QCString::size ( ) const

inline

Returns the length of the string, not counting the 0-terminator.

Definition at line 156 of file qcstring.h.

156{ return m_rep.size(); }

References m_rep.

Referenced by DocParser::findDocsForMemberOrCompound(), findGlobalMember(), FlowChart::findNextLoop(), SymbolResolver::Private::getResolvedSymbolRec(), VHDLOutlineParser::Private::parseVhdlfile(), FlowChart::printUmlTree(), QCString(), repeat(), reserve(), and searchInputFiles().

◆ sprintf()

QCString & QCString::sprintf	(	const char *	format,
			... )

Definition at line 29 of file qcstring.cpp.

{
  va_list ap;
  va_start( ap, format );
  const size_t minlen=256;
  size_t l = length();
  if (l<minlen) { resize(minlen+1); l=minlen; }
  int n=vsnprintf( rawData(), l+1, format, ap);
  if (n<0) n=static_cast<int>(l);
  resize(n);
  va_end( ap );
  return *this;
}

References length(), QCString(), rawData(), and resize().

◆ startsWith() [1/2]

bool QCString::startsWith ( const char * s ) const

inline

Definition at line 492 of file qcstring.h.

    {
      if (m_rep.empty() || s==nullptr) return s==nullptr;
      return m_rep.rfind(s,0)==0; // looking "backward" starting and ending at index 0
    }

References m_rep.

Referenced by MemberDefImpl::_isAnonymousBitField(), MemberDefImpl::_writeEnumValues(), DocHtmlCell::alignment(), Config::checkAndCorrect(), DotFilePatcher::convertMapFile(), copyStyleSheet(), MemberDefImpl::createTemplateInstanceMember(), extractClassNameFromType(), fillColorStyleMap(), filterMemberDocumentation(), DocParser::findAndCopyImage(), findClassRelation(), DocParser::findDocsForMemberOrCompound(), findMember(), findUsingDeclImports(), SymbolResolver::Private::followPath(), generateFunctionLink(), getCanonicalTypeForIdentifier(), getDefsOld(), DocParser::handleImage(), handleImage(), CitationManager::insertCrossReferencesForBibFile(), SymbolResolver::Private::isAccessibleFrom(), HtmlDocVisitor::operator()(), RTFDocVisitor::operator()(), SymbolModifiers::operator|=(), parseFuncDecl(), VhdlDocGen::prepareComment(), RTFGenerator::preProcessFileInplace(), removeLongPathMarker(), replaceRef(), SymbolResolver::resolveClass(), resolveRef(), resolveSymlink(), startsWithKeyword(), stripTrailingReturn(), substituteHtmlKeywords(), substituteTemplateArgumentsInString(), substituteTemplatesInString(), HtmlGenerator::writeStyleInfo(), and writeUserGroupStubPage().

◆ startsWith() [2/2]

bool QCString::startsWith ( const QCString & s ) const

inline

Definition at line 498 of file qcstring.h.

    {
      if (m_rep.empty() || s.isEmpty()) return s.isEmpty();
      return m_rep.rfind(s.str(),0)==0; // looking "backward" starting and ending at index 0
    }

References isEmpty(), m_rep, QCString(), and str().

◆ str()

const std::string & QCString::str ( ) const

inline

Definition at line 526 of file qcstring.h.

    {
      return m_rep;
    }

References m_rep.

◆ stripLeadingAndTrailingEmptyLines()

QCString QCString::stripLeadingAndTrailingEmptyLines ( ) const

Definition at line 573 of file qcstring.cpp.

{
  if (isEmpty()) return QCString();
  const std::string &s = m_rep;
  int end=static_cast<int>(s.length());
  int start=0,p=0;
  // skip leading empty lines
  for (;;)
  {
    int c;
    while ((c=s[p]) && (c==' ' || c=='\t')) p++;
    if (s[p]=='\n')
    {
      start=++p;
    }
    else
    {
      break;
    }
  }
  // skip trailing empty lines
  p=end-1;
  if (p>=start && s.at(p)=='\n') p--;
  while (p>=start)
  {
    int c;
    while ((c=s[p]) && (c==' ' || c=='\t')) p--;
    if (s[p]=='\n')
    {
      end=p+1;
    }
    else
    {
      break;
    }
    p--;
  }
  //printf("stripLeadingAndTrailingEmptyLines(%d-%d)\n",start,end);
  return s.substr(start,end-start);
}

References end(), isEmpty(), m_rep, and QCString().

◆ stripPrefix() [1/2]

bool QCString::stripPrefix ( const char * prefix )

inline

Definition at line 209 of file qcstring.h.

    {
      return stripPrefix(QCString(prefix));
    }

References prefix, QCString(), and stripPrefix().

◆ stripPrefix() [2/2]

bool QCString::stripPrefix ( const QCString & prefix )

inline

Definition at line 198 of file qcstring.h.

    {
      if (prefix.isEmpty() || m_rep.empty()) return FALSE;
      if (m_rep.rfind(prefix.data(),0)==0) // string starts with prefix
      {
        m_rep.erase(0,prefix.length());
        return TRUE;
      }
      return FALSE;
    }

References FALSE, m_rep, prefix, QCString(), and TRUE.

Referenced by addKnRArgInfo(), VHDLOutlineParser::addLibUseClause(), addMemberDocs(), addMemberFunction(), addVariable(), addVariableToClass(), addVariableToFile(), buildScopeFromQualifiedName(), VhdlDocGen::correctMemberProperties(), extractCanonicalType(), findMember(), VhdlDocGen::formatString(), generateClassOrGlobalLink(), generateMemLink(), generateSqlite3ForFile(), generateXMLForMember(), getCanonicalTypeForIdentifier(), MemberDefImpl::getClassDefOfAnonymousType(), VhdlDocGen::getClassName(), MemberDefImpl::getDeclType(), VHDLOutlineParser::handleFlowComment(), initUCF(), SymbolResolver::Private::newResolveTypedef(), VhdlDocGen::parseUCF(), stripPrefix(), stripQualifiers(), stripQualifiers(), subrHandleCommentBlock(), subrHandleCommentBlockResult(), MemberDefImpl::writeDeclaration(), MemberDefImpl::writeDocumentation(), writeFuncProto(), VhdlDocGen::writeFunctionProto(), VhdlDocGen::writeInlineClassLink(), VhdlDocGen::writeVHDLDeclaration(), VhdlDocGen::writeVhdlLink(), and VhdlDocGen::writeVHDLTypeDocumentation().

◆ stripWhiteSpace()

QCString QCString::stripWhiteSpace ( ) const

inline

returns a copy of this string with leading and trailing whitespace removed

Definition at line 245 of file qcstring.h.

    {
      size_t sl = m_rep.size();
      if (sl==0 || (!qisspace(m_rep[0]) && !qisspace(m_rep[sl-1]))) return *this;
      size_t start=0,end=sl-1;
      while (start<sl && qisspace(m_rep[start])) start++;
      if (start==sl) return QCString(); // only whitespace
      while (end>start && qisspace(m_rep[end])) end--;
      return QCString(m_rep.substr(start,1+end-start));
    }

References end(), m_rep, QCString(), and qisspace().

Referenced by DefinitionImpl::_setBriefDescription(), MemberDefImpl::_writeEnumValues(), abbreviate(), addDefine(), DocGroup::addDocs(), addFormula(), addIncludeFile(), addKnRArgInfo(), addMacroDefinition(), addPerlModDocBlock(), addRelatedPage(), addSeparatorsIfNeeded(), addSubprogram(), ClassDefImpl::addTypeConstraints(), adjustConfiguration(), appStringLower(), buildPageList(), Config::checkAndCorrect(), DocParser::checkArgumentName(), checkFileName(), checkList(), DocParser::checkUnOrMultipleDocumentedParams(), compareString(), convertCppComments(), DotNode::convertLabel(), convertStringToBool(), convertToComment(), determineBlockName(), expandExpression(), extractBind(), extractCanonicalArgType(), extractCanonicalType(), extractFromParens(), extractNoExcept(), fillColorStyleMap(), findMainPage(), findMember(), VhdlDocGen::formatString(), generateFunctionLink(), generateFunctionLink(), generateSqlite3ForMember(), generateXMLForMember(), getCanonicalTemplateSpec(), getFilteredImageAttributes(), DocPara::handleCommand(), handleFileInfoResult(), VHDLOutlineParser::handleFlowComment(), handleGuard(), DocParser::handleImage(), handleImage(), DocPara::handleInclude(), handleInheritanceGraph(), DocPara::handleShowDate(), handleToc(), initUCF(), CitationManager::insertCrossReferencesForBibFile(), isCastKeyword(), ClassDefImpl::isExtension(), isURL(), Htags::loadFilemap(), mergeArguments(), parseCommentAsText(), VhdlDocGen::parseFuncProto(), MarkdownOutlineParser::parseInput(), VhdlDocGen::parseUCF(), VhdlDocGen::prepareComment(), FlowChart::printNode(), FlowChart::printPlantUmlNode(), Markdown::Private::processLink(), processStoreRepl(), projectLogoSize(), readIncludeFile(), readIncludeFile(), readTagFile(), replaceFunctionMacro(), SymbolResolver::resolveClass(), splitKnRArg(), startOfRequiresExpression(), stripComment(), stripIrrelevantString(), stripTrailingReturn(), subrHandleCommentBlock(), subrHandleCommentBlockResult(), substEnvVarsInString(), substituteTemplateArgumentsInString(), Portable::system(), LayoutNavEntry::url(), MemberDefImpl::writeDeclaration(), MemberList::writeDeclarations(), writeExceptionList(), HtmlGenerator::writeExternalSearchPage(), VhdlDocGen::writeFunctionProto(), writeObjCMethodCall(), VhdlDocGen::writeVHDLTypeDocumentation(), and writeXMLDocBlock().

◆ toInt()

int QCString::toInt	(	bool *	ok = nullptr,
		int	base = 10 ) const

Definition at line 249 of file qcstring.cpp.

{
  return static_cast<int>(toLong( ok, base ));
}

References toLong().

Referenced by VhdlDocGen::addBaseClass(), insertDimension(), runQHelpGenerator(), TranslatorSlovak::trAndMore(), and writeObjCMethodCall().

◆ toLong()

long QCString::toLong	(	bool *	ok = nullptr,
		int	base = 10 ) const

Definition at line 260 of file qcstring.cpp.

{
  const char *p = data();
  long val=0;
  int l = static_cast<int>(length());
  const long max_mult = INT_MAX / base;
  bool is_ok = FALSE;
  int neg = 0;
  if ( !p )
    goto bye;
  while ( l && qisspace(*p) )                   // skip leading space
    l--,p++;
  if ( l && *p == '-' ) {
    l--;
    p++;
    neg = 1;
  } else if ( *p == '+' ) {
    l--;
    p++;
  }
 
  // NOTE: toULong() code is similar
  if ( !l || !ok_in_base(*p,base) )
    goto bye;
  while ( l && ok_in_base(*p,base) ) {
    l--;
    int dv = 0;
    if ( *p>='0' && *p<='9' ) {
      dv = *p-'0';
    } else {
      if ( *p >= 'a' && *p <= 'z' )
        dv = *p - 'a' + 10;
      else
        dv = *p - 'A' + 10;
    }
    if ( val > max_mult || (val == max_mult && dv > (INT_MAX%base)+neg) )
      goto bye;
    val = base*val + dv;
    p++;
  }
  if ( neg )
    val = -val;
  while ( l && qisspace(*p) )                   // skip trailing space
    l--,p++;
  if ( !l )
    is_ok = TRUE;
bye:
  if ( ok )
    *ok = is_ok;
  return is_ok ? val : 0;
}

References data(), FALSE, length(), ok_in_base(), qisspace(), and TRUE.

Referenced by toInt(), and toShort().

◆ toShort()

short QCString::toShort	(	bool *	ok = nullptr,
		int	base = 10 ) const

Definition at line 229 of file qcstring.cpp.

{
  long v = toLong( ok, base );
  if ( ok && *ok && (v < -32768 || v > 32767) ) {
    *ok = FALSE;
    v = 0;
  }
  return static_cast<short>(v);
}

References FALSE, and toLong().

◆ toUInt()

uint32_t QCString::toUInt	(	bool *	ok = nullptr,
		int	base = 10 ) const

Definition at line 254 of file qcstring.cpp.

{
  return static_cast<uint32_t>(toULong( ok, base ));
}

References toULong().

◆ toUInt64()

uint64_t QCString::toUInt64	(	bool *	ok = nullptr,
		int	base = 10 ) const

Definition at line 356 of file qcstring.cpp.

{
  const char *p = data();
  uint64_t val=0;
  int l = static_cast<int>(length());
  const uint64_t max_mult = 1844674407370955161ULL;  // ULLONG_MAX/10, rounded down
  bool is_ok = FALSE;
  if ( !p )
    goto bye;
  while ( l && qisspace(*p) )                      // skip leading space
    l--,p++;
  if ( *p == '+' )
    l--,p++;
 
  // NOTE: toULong() code is similar
  if ( !l || !ok_in_base(*p,base) )
    goto bye;
  while ( l && ok_in_base(*p,base) ) {
    l--;
    uint32_t dv = 0;
    if ( *p>='0' && *p<='9' ) {
      dv = *p-'0';
    } else {
      if ( *p >= 'a' && *p <= 'z' )
        dv = *p - 'a' + 10;
      else
        dv = *p - 'A' + 10;
    }
    if ( val > max_mult || (val == max_mult && dv > (ULLONG_MAX%base)) )
      goto bye;
    val = base*val + dv;
    p++;
  }
 
  while ( l && qisspace(*p) )                   // skip trailing space
    l--,p++;
  if ( !l )
    is_ok = TRUE;
bye:
  if ( ok )
    *ok = is_ok;
  return is_ok ? val : 0;
}

References data(), FALSE, length(), ok_in_base(), qisspace(), and TRUE.

Referenced by getCurrentDateTime().

◆ toULong()

unsigned long QCString::toULong	(	bool *	ok = nullptr,
		int	base = 10 ) const

Definition at line 312 of file qcstring.cpp.

{
  const char *p = data();
  unsigned long val=0;
  int l = static_cast<int>(length());
  const unsigned long max_mult = 429496729;             // UINT_MAX/10, rounded down
  bool is_ok = FALSE;
  if ( !p )
    goto bye;
  while ( l && qisspace(*p) )                   // skip leading space
    l--,p++;
  if ( *p == '+' )
    l--,p++;
 
  // NOTE: toLong() code is similar
  if ( !l || !ok_in_base(*p,base) )
    goto bye;
  while ( l && ok_in_base(*p,base) ) {
    l--;
    uint32_t dv = 0;
    if ( *p>='0' && *p<='9' ) {
      dv = *p-'0';
    } else {
      if ( *p >= 'a' && *p <= 'z' )
        dv = *p - 'a' + 10;
      else
        dv = *p - 'A' + 10;
    }
    if ( val > max_mult || (val == max_mult && dv > (UINT_MAX%base)) )
      goto bye;
    val = base*val + dv;
    p++;
  }
 
  while ( l && qisspace(*p) )                   // skip trailing space
    l--,p++;
  if ( !l )
    is_ok = TRUE;
bye:
  if ( ok )
    *ok = is_ok;
  return is_ok ? val : 0;
}

References data(), FALSE, length(), ok_in_base(), qisspace(), and TRUE.

Referenced by toUInt(), and toUShort().

◆ toUShort()

uint16_t QCString::toUShort	(	bool *	ok = nullptr,
		int	base = 10 ) const

Definition at line 239 of file qcstring.cpp.

{
  unsigned long v = toULong( ok, base );
  if ( ok && *ok && (v > 65535) ) {
    *ok = FALSE;
    v = 0;
  }
  return static_cast<uint16_t>(v);
}

References FALSE, and toULong().

◆ upper()

QCString QCString::upper ( ) const

inline

Definition at line 239 of file qcstring.h.

    {
      return QCString(convertUTF8ToUpper(m_rep));
    }

References convertUTF8ToUpper(), m_rep, and QCString().

◆ view()

std::string_view QCString::view ( ) const

inline

Definition at line 161 of file qcstring.h.

161{ return m_rep; }

References m_rep.

Referenced by DocPara::handleCommand(), linkifyText(), Markdown::process(), Markdown::Private::processBlocks(), Markdown::Private::processQuotations(), and readIncludeFile().

Member Data Documentation

◆ m_rep

std::string QCString::m_rep

private

Definition at line 589 of file qcstring.h.

Referenced by append(), at(), at(), clear(), data(), endsWith(), endsWith(), fill(), insert(), insert(), insert(), isEmpty(), left(), length(), lower(), mid(), operator+=(), operator+=(), operator+=(), operator+=(), operator=(), operator=(), operator=(), operator=(), operator[](), operator[](), QCString(), QCString(), QCString(), QCString(), QCString(), QCString(), QCString(), quoted(), rawData(), remove(), removeWhiteSpace(), reserve(), resize(), right(), setNum(), setNum(), setNum(), setNum(), setNum(), setNum(), setNum(), setNum(), size(), startsWith(), startsWith(), str(), stripLeadingAndTrailingEmptyLines(), stripPrefix(), stripWhiteSpace(), upper(), and view().

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

src/qcstring.h
src/qcstring.cpp

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ SizeTag

Constructor & Destructor Documentation

◆ QCString() [1/9]

◆ QCString() [2/9]

◆ QCString() [3/9]

◆ QCString() [4/9]

◆ QCString() [5/9]

◆ QCString() [6/9]

◆ QCString() [7/9]

◆ QCString() [8/9]

◆ QCString() [9/9]

Member Function Documentation

◆ append() [1/5]

◆ append() [2/5]

◆ append() [3/5]

◆ append() [4/5]

◆ append() [5/5]

◆ at() [1/2]

◆ at() [2/2]

◆ clear()

◆ contains() [1/2]

◆ contains() [2/2]

◆ data()

◆ endsWith() [1/2]

◆ endsWith() [2/2]

◆ fill()

◆ find() [1/3]

◆ find() [2/3]

◆ find() [3/3]

◆ findRev() [1/2]

◆ findRev() [2/2]

◆ insert() [1/4]

◆ insert() [2/4]

◆ insert() [3/4]

◆ insert() [4/4]

◆ isEmpty()

◆ left()

◆ length()

◆ lower()

◆ mid()

◆ operator+=() [1/4]

◆ operator+=() [2/4]

◆ operator+=() [3/4]

◆ operator+=() [4/4]

◆ operator=() [1/4]

◆ operator=() [2/4]

◆ operator=() [3/4]

◆ operator=() [4/4]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ prepend() [1/4]

◆ prepend() [2/4]

◆ prepend() [3/4]

◆ prepend() [4/4]

◆ quoted()

◆ rawData()

◆ remove()

◆ removeWhiteSpace()

◆ repeat()

◆ replace()

◆ reserve()

◆ resize()

◆ right()

◆ setNum() [1/8]

◆ setNum() [2/8]

◆ setNum() [3/8]

◆ setNum() [4/8]

◆ setNum() [5/8]

◆ setNum() [6/8]

◆ setNum() [7/8]

◆ setNum() [8/8]

◆ simplifyWhiteSpace()

◆ size()

◆ sprintf()

◆ startsWith() [1/2]