reg Namespace Reference

Namespace for the regular expression functions. More...

Classes
class	Ex
	Class representing a regular expression. More...
class	Iterator
	Class to iterate through matches. More...
class	Match
	Object representing the matching results. More...
class	PToken
	Class representing a token in the compiled regular expression token stream. More...
class	SubMatch
	Object representing the match results of a capture range. More...

Functions
static bool	isspace (char c)
static bool	isalpha (char c)
static bool	isdigit (char c)
static bool	isalnum (char c)
static std::string	wildcard2regex (std::string_view pattern)
bool	search (std::string_view str, Match &match, const Ex &re, size_t pos=0)
	Search in a given string str starting at position pos for a match against regular expression re.
bool	search (std::string_view str, const Ex &re, size_t pos=0)
	Search in a given string str starting at position pos for a match against regular expression re.
bool	match (std::string_view str, Match &match, const Ex &re)
	Matches a given string str for a match against regular expression re.
bool	match (std::string_view str, const Ex &re)
	Matches a given string str for a match against regular expression re.
std::string	replace (std::string_view str, const Ex &re, std::string_view replacement)
	Searching in a given input string for parts that match regular expression re and replaces those parts by string replacement.

Detailed Description

Namespace for the regular expression functions.

Function Documentation

isalnum()

bool reg::isalnum ( char c )

inlinestatic

Definition at line 48 of file regex.cpp.

{
  return isalpha(c) || isdigit(c);
}

References isalnum(), isalpha(), and isdigit().

Referenced by isalnum(), and reg::Ex::Private::matchAt().

isalpha()

bool reg::isalpha ( char c )

inlinestatic

Definition at line 38 of file regex.cpp.

{
  return static_cast<unsigned char>(c)>=128 || (c>='a' && c<='z') || (c>='A' && c<='Z');
}

References isalpha().

Referenced by isalnum(), isalpha(), and reg::Ex::Private::matchAt().

isdigit()

bool reg::isdigit ( char c )

inlinestatic

Definition at line 43 of file regex.cpp.

{
  return c>='0' && c<='9';
}

References isdigit().

Referenced by isalnum(), isdigit(), and reg::Ex::Private::matchAt().

isspace()

bool reg::isspace ( char c )

inlinestatic

Definition at line 33 of file regex.cpp.

{
  return c==' ' || c=='\t' || c=='\n' || c=='\r';
}

References isspace().

Referenced by isspace(), and reg::Ex::Private::matchAt().

match() [1/2]

bool reg::match	(	std::string_view	str,
		const Ex &	re )

Matches a given string str for a match against regular expression re.

Returns true iff a match was found for the whole string.

Definition at line 863 of file regex.cpp.

{
  Match match;
  return re.match(str,match,0) && match.position()==0 && match.length()==str.length();
}

References reg::Ex::match(), and match().

match() [2/2]

bool reg::match	(	std::string_view	str,
		Match &	match,
		const Ex &	re )

Matches a given string str for a match against regular expression re.

Returns true iff a match was found for the whole string. Any capture groups are returned via the match object.

Definition at line 858 of file regex.cpp.

{
  return re.match(str,match,0) && match.position()==0 && match.length()==str.length();
}

References reg::Ex::match(), and match().

Referenced by DocParser::checkArgumentName(), dateTimeFromString(), endBrief(), genericPatternMatch(), getFilterFromList(), DocParser::handleStyleArgument(), VhdlDocGen::isNumber(), match(), match(), replace(), search(), search(), setOutput(), and LayoutParser::startLayout().

replace()

std::string reg::replace	(	std::string_view	str,
		const Ex &	re,
		std::string_view	replacement )

Searching in a given input string for parts that match regular expression re and replaces those parts by string replacement.

Definition at line 869 of file regex.cpp.

{
  std::string result;
  Match match;
  size_t p=0;
  while (re.match(str,match,p))
  {
    size_t i=match.position();
    size_t l=match.length();
    if (i>p) result+=str.substr(p,i-p);
    result+=replacement;
    p=i+l;
  }
  if (p<str.length()) result+=str.substr(p);
  return result;
}

References reg::Ex::match(), match(), and replace().

Referenced by VhdlDocGen::addBaseClass(), VHDLOutlineParser::checkInlineCode(), FlowChart::printNode(), replace(), and replaceAnonymousScopes().

search() [1/2]

bool reg::search	(	std::string_view	str,
		const Ex &	re,
		size_t	pos = 0 )

Search in a given string str starting at position pos for a match against regular expression re.

Returns true iff a match was found.

Definition at line 852 of file regex.cpp.

{
  Match match;
  return re.match(str,match,pos);
}

References reg::Ex::match(), match(), and search().

search() [2/2]

bool reg::search	(	std::string_view	str,
		Match &	match,
		const Ex &	re,
		size_t	pos = 0 )

Search in a given string str starting at position pos for a match against regular expression re.

Returns true iff a match was found. Details of what part of the string has matched is returned via the match object.

An example to show how to match all identifiers in a string.

static reg::Ex re(R"(\a\w*)");
std::string = u8"void(Func是<B_C::Códe42>(42));";
while (reg::search(str,match,re,pos))
{
  std::cout << match.str() << std::endl;
  pos=match.position()+match.length();
}

produces:

void
Func是
B_C
Códe42

See also

Ex::Ex() for details on the regular expression patterns.

Definition at line 847 of file regex.cpp.

{
  return re.match(str,match,pos);
}

References reg::Ex::match(), match(), and search().

Referenced by CommentScanner::addDeprecatedDocs(), HtmlHelpIndex::addItem(), addValidAliasToMap(), addVariable(), addVariableToFile(), VHDLOutlineParser::checkInlineCode(), containsEnvVar(), MemberDefImpl::displayDefinition(), expandAliasRec(), Markdown::Private::extractTitleId(), findFunctionPtr(), findIndex(), FormulaManager::initFromRepository(), insertDimension(), isVarWithConstructor(), loadExtensions(), loadStylesheet(), matchExcludedSymbols(), MarkdownOutlineParser::parseInput(), runQHelpGenerator(), search(), search(), StyleData::setStyle(), simplifyTypeForTable(), splitKnRArg(), StyleData::StyleData(), DotAttributes::updateValue(), MemberDefImpl::writeDeclaration(), MemberDefImpl::writeDocumentation(), and MemberDefImpl::writeMemberDocSimple().

wildcard2regex()

std::string reg::wildcard2regex ( std::string_view pattern )

static

Definition at line 748 of file regex.cpp.

{
  std::string result="^"; // match start of input
  result.reserve(pattern.length());
  for (size_t i=0;i<pattern.length();i++)
  {
    char c=pattern[i];
    switch(c)
    {
      case '*':
        result+=".*";
        break; // '*' => '.*'
      case '?':
        result+='.';
        break; // '?' => '.'
      case '.':
      case '+':
      case '\\':
      case '$':
      case '^':
      case '(':
      case ')':
         result+='\\'; result+=c;  // escape
         break;
      case '[':
         if (i<pattern.length()-1 && pattern[i+1]=='^') // don't escape ^ after [
         {
           result+="[^";
           i++;
         }
         else
         {
           result+=c;
         }
        break;
      default:  // just copy
        result+=c;
        break;
    }
  }
  result+='$'; // match end of input
  return result;
}

References wildcard2regex().

Referenced by reg::Ex::Ex(), and wildcard2regex().