stringutil.h File Reference

Some helper functions for std::string. More...

#include <string>
#include <string_view>
#include "containers.h"
#include "regex.h"

Include dependency graph for stringutil.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
void	substituteInplace (std::string &s, std::string_view toReplace, std::string_view replaceWith)
	Replaces occurrences of substring toReplace in string s with string replaceWith.
std::string	substituteStringView (std::string_view s, std::string_view toReplace, std::string_view replaceWith)
	Returns a new string where occurrences of substring toReplace in string s are replaced by string replaceWith.
std::string_view	stripWhiteSpace (std::string_view s)
	Given a string view s, returns a new, narrower view on that string, skipping over any leading or trailing whitespace characters.
void	addTerminalCharIfMissing (std::string &s, char c)
template<size_t N>
bool	literal_at (const char *data, const char(&str)[N])
	returns true iff data points to a substring that matches string literal str
template<size_t N>
bool	literal_at (std::string_view data, const char(&str)[N])
	returns true iff data points to a substring that matches string literal str
StringVector	split (const std::string &s, const std::string &delimiter)
	split input string s by string delimiter delimiter.
StringVector	split (const std::string &s, const reg::Ex &delimiter)
	split input string s by regular expression delimiter delimiter.
std::string	join (const StringVector &sv, const std::string &delimiter)
	create a string where the string in the vector are joined by the given delimiter
size_t	findIndex (const StringVector &sv, const std::string &s)
	find the index of a string in a vector of strings, returns std::string::npos if the string could not be found
size_t	findIndex (const std::string &s, const reg::Ex &re)
	find the index of the first occurrence of pattern re in a string s returns std::string::npos if the pattern could not be found
std::string	removeEmptyLines (const std::string &s)

Detailed Description

Some helper functions for std::string.

Definition in file stringutil.h.

Function Documentation

addTerminalCharIfMissing()

void addTerminalCharIfMissing ( std::string & s, char c )

inline

Definition at line 87 of file stringutil.h.

{
  if (s.empty())
  {
    s+=c;
  }
  else
  {
    if (s[s.length()-1]!=c) s+=c;
  }
}

Referenced by checkAndOpenFile(), fileToString(), parseFile(), and parseInput().

findIndex() [1/2]

size_t findIndex ( const std::string & s, const reg::Ex & re )

inline

find the index of the first occurrence of pattern re in a string s returns std::string::npos if the pattern could not be found

Definition at line 175 of file stringutil.h.

{
  reg::Match match;
  return reg::search(s,match,re) ? static_cast<size_t>(match.position()) : std::string::npos;
}

References reg::search().

findIndex() [2/2]

size_t findIndex ( const StringVector & sv, const std::string & s )

inline

find the index of a string in a vector of strings, returns std::string::npos if the string could not be found

Definition at line 167 of file stringutil.h.

{
  auto it = std::find(sv.begin(),sv.end(),s);
  return it!=sv.end() ? static_cast<size_t>(it-sv.begin()) : std::string::npos;
}

Referenced by initUCF(), VhdlDocGen::parseForBinding(), VhdlDocGen::parseUCF(), DotFilePatcher::run(), and VhdlDocGen::writeFormatString().

join()

std::string join ( const StringVector & sv, const std::string & delimiter )

inline

create a string where the string in the vector are joined by the given delimiter

Definition at line 153 of file stringutil.h.

{
  std::string result;
  bool first=true;
  for (const auto &s : sv)
  {
    if (!first) result+=delimiter;
    first=false;
    result+=s;
  }
  return result;
}

Referenced by handleAnchor(), handleCite(), handleFormatBlock(), and handleImage().

literal_at() [1/2]

template<size_t N>

bool literal_at	(	const char *	data,
		const char(&)	str[N] )

returns true iff data points to a substring that matches string literal str

Definition at line 101 of file stringutil.h.

{
  size_t len = N-1; // exclude 0 terminator
  return data!=nullptr && data[0]==str[0] && dstrncmp(data+1,str+1,len-1)==0;
}

References dstrncmp().

Referenced by computeIndent(), convertMapFile(), detab(), extractCopyDocId(), getConvertLatexMacro(), isExplicitPage(), isNewline(), Markdown::Private::isSpecialCommand(), Markdown::process(), Markdown::Private::processNmdash(), readSVGSize(), removeIdsAndMarkers(), skipOverFileAndLineCommands(), stripIndentation(), stripLeadingAndTrailingEmptyLines(), stripTrailingWhiteSpace(), and PlantumlManager::writePlantUMLSource().

literal_at() [2/2]

template<size_t N>

bool literal_at	(	std::string_view	data,
		const char(&)	str[N] )

returns true iff data points to a substring that matches string literal str

Definition at line 109 of file stringutil.h.

{
  size_t len = N-1; // exclude 0 terminator
  return len<=data.size() && data[0]==str[0] && dstrncmp(data.data()+1,str+1,len-1)==0;
}

References dstrncmp().

removeEmptyLines()

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

inline

Definition at line 181 of file stringutil.h.

{
  std::string out;
  out.reserve(s.length());
  const char *p=s.data();
  if (p)
  {
    char c = 0;
    while ((c=*p++))
    {
      if (c=='\n')
      {
        const char *e = p;
        while (*e==' ' || *e=='\t') e++;
        if (*e=='\n')
        {
          p=e;
        }
        else out+=c;
      }
      else
      {
        out+=c;
      }
    }
  }
  return out;
}

Referenced by substituteHtmlKeywords(), and substituteLatexKeywords().

split() [1/2]

StringVector split ( const std::string & s, const reg::Ex & delimiter )

inline

split input string s by regular expression delimiter delimiter.

returns a vector of non-empty strings that are between the delimiters

Definition at line 134 of file stringutil.h.

{
  StringVector result;
  reg::Iterator iter(s, delimiter);
  reg::Iterator end;
  size_t p=0;
  for ( ; iter != end; ++iter)
  {
    const auto &match = *iter;
    size_t i=match.position();
    size_t l=match.length();
    if (i>p) result.push_back(s.substr(p,i-p));
    p=i+l;
  }
  if (p<s.length()) result.push_back(s.substr(p));
  return result;
}

References end().

split() [2/2]

StringVector split ( const std::string & s, const std::string & delimiter )

inline

split input string s by string delimiter delimiter.

returns a vector of non-empty strings that are between the delimiters

Definition at line 117 of file stringutil.h.

{
  StringVector result;
  size_t prev = 0, pos = 0, len = s.length();
  do
  {
    pos = s.find(delimiter, prev);
    if (pos == std::string::npos) pos = len;
    if (pos>prev) result.push_back(s.substr(prev,pos-prev));
    prev = pos + delimiter.length();
  }
  while (pos<len && prev<len);
  return result;
}

Referenced by VHDLOutlineParser::addProto(), VHDLOutlineParser::addVhdlType(), FlowChart::alignCommentNode(), anonymous_namespace{tagreader.cpp}::TagFileParser::buildLists(), VHDLOutlineParser::checkInlineCode(), checkVhdlString(), VHDLOutlineParser::createFunction(), VhdlDocGen::findArchitecture(), CitationManager::generatePage(), getFilteredImageAttributes(), VhdlDocGen::getIndexWord(), DocParser::handleCite(), DocPara::handleCommand(), DocParser::handleImage(), DocPara::handleInclude(), Qhp::initialize(), VhdlDocGen::parseForBinding(), VhdlDocGen::parseForConfig(), parseIncludeOptions(), writeFuncProto(), VhdlDocGen::writeInlineClassLink(), and VhdlDocGen::writeRecUnitDocu().

stripWhiteSpace()

std::string_view stripWhiteSpace ( std::string_view s )

inline

Given a string view s, returns a new, narrower view on that string, skipping over any leading or trailing whitespace characters.

Definition at line 75 of file stringutil.h.

{
  static auto isspace = [](char c){ return c==' ' || c=='\t' || c=='\n' || c=='\r'; };
  size_t sl = s.length();
  if (sl==0 || (!isspace(s[0]) && !isspace(s[sl-1]))) return s;
  size_t start=0, end=sl-1;
  while (start<sl && isspace(s[start])) start++;
  if (start==sl) return s.substr(0,0); // only whitespace
  while (end>start && isspace(s[end])) end--;
  return s.substr(start,end+1-start);
}

References end().

Referenced by DefinitionImpl::_setDocumentation(), endBrief(), VhdlDocGen::getClass(), handleInheritanceGraph(), handleToc(), FileDefImpl::hasDetailedDescription(), DefinitionImpl::operator=(), parseIncludeOptions(), DefinitionImpl::setDocumentation(), DefinitionMixin< Base >::setDocumentation(), DefinitionMutable::setDocumentation(), MemberDefImpl::setDocumentation(), Markdown::Private::writeBlockQuote(), and FileDefImpl::writeBriefDescription().

substituteInplace()

void substituteInplace ( std::string & s, std::string_view toReplace, std::string_view replaceWith )

inline

Replaces occurrences of substring toReplace in string s with string replaceWith.

Modifies s in place.

Definition at line 32 of file stringutil.h.

{
  std::string buf;
  size_t pos = 0;
  size_t prevPos = 0;
  buf.reserve(s.length());
 
  while ((pos=s.find(toReplace, prevPos))!=std::string::npos)
  {
    buf.append(s, prevPos, pos - prevPos);
    buf += replaceWith;
    prevPos = pos + toReplace.length();
  }
  buf.append(s, prevPos, s.size() - prevPos);
  s.swap(buf);
}

Referenced by replaceAliasArguments().

substituteStringView()

std::string substituteStringView ( std::string_view s, std::string_view toReplace, std::string_view replaceWith )

inline

Returns a new string where occurrences of substring toReplace in string s are replaced by string replaceWith.

Definition at line 53 of file stringutil.h.

{
  std::string buf;
  size_t pos = 0;
  size_t prevPos = 0;
  buf.reserve(s.length());
 
  while ((pos=s.find(toReplace, prevPos))!=std::string::npos)
  {
    buf.append(s, prevPos, pos - prevPos);
    buf += replaceWith;
    prevPos = pos + toReplace.length();
  }
  buf.append(s, prevPos, s.size() - prevPos);
  return buf;
}

Referenced by escapeAlias(), and replaceAliases().