Regex

Boost.
Regex
John Maddock
Copyright 1998-2010 John Maddock Distributed under the Boost Software License, Version 1.0. (See accompanying le LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
Table of Contents
Conguration ........................................................................................................................................................ 3 Compiler Setup .............................................................................................................................................. 3 Locale and traits class selection ........................................................................................................................ 3 Linkage Options ............................................................................................................................................ 3 Algorithm Selection ....................................................................................................................................... 4 Algorithm Tuning .......................................................................................................................................... 4 Building and Installing the Library ............................................................................................................................ 5 Introduction and Overview ..................................................................................................................................... 10 Unicode and Boost.Regex ...................................................................................................................................... 12 Understanding Marked Sub-Expressions and Captures ................................................................................................. 13 Partial Matches .................................................................................................................................................... 17 Regular Expression Syntax ..................................................................................................................................... 20 Perl Regular Expression Syntax ...................................................................................................................... 20 POSIX Extended Regular Expression Syntax ..................................................................................................... 32 POSIX Basic Regular Expression Syntax .......................................................................................................... 39 Character Class Names .................................................................................................................................. 43 Character Classes that are Always Supported ............................................................................................. 43 Character classes that are supported by Unicode Regular Expressions ............................................................. 44 Collating Names .......................................................................................................................................... 46 Digraphs ............................................................................................................................................. 46 POSIX Symbolic Names ........................................................................................................................ 46 Named Unicode Characters .................................................................................................................... 49 The Leftmost Longest Rule ............................................................................................................................ 49 Search and Replace Format String Syntax ................................................................................................................. 51 Sed Format String Syntax .............................................................................................................................. 51 Perl Format String Syntax .............................................................................................................................. 51 Boost-Extended Format String Syntax .............................................................................................................. 53 Reference ........................................................................................................................................................... 56 basic_regex ................................................................................................................................................. 56 match_results .............................................................................................................................................. 67 sub_match .................................................................................................................................................. 75 regex_match ................................................................................................................................................ 87 regex_search ............................................................................................................................................... 91 regex_replace .............................................................................................................................................. 94 regex_iterator .............................................................................................................................................. 98 regex_token_iterator .................................................................................................................................... 104 bad_expression ........................................................................................................................................... 112 syntax_option_type ..................................................................................................................................... 113 syntax_option_type Synopsis ................................................................................................................ 113 Overview of syntax_option_type ............................................................................................................ 114 Options for Perl Regular Expressions ..................................................................................................... 114 Options for POSIX Extended Regular Expressions .................................................................................... 116 Options for POSIX Basic Regular Expressions ......................................................................................... 119 Options for Literal Strings .................................................................................................................... 121
XML to PDF by RenderX XEP XSL-FO Formatter, visit us at http://www.renderx.com/
Boost.Regex
match_ag_type ......................................................................................................................................... 121 error_type ................................................................................................................................................. 125 regex_traits ................................................................................................................................................ 126 Interfacing With Non-Standard String Types .................................................................................................... 127 Working With Unicode and ICU String Types .......................................................................................... 127 Introduction to using Regex with ICU ............................................................................................. 127 Unicode regular expression types ................................................................................................... 127 Unicode Regular Expression Algorithms ......................................................................................... 129 Unicode Aware Regex Iterators ...................................................................................................... 130 Using Boost Regex With MFC Strings .................................................................................................... 136 Introduction to Boost.Regex and MFC Strings .................................................................................. 136 Regex Types Used With MFC Strings ............................................................................................. 136 Regular Expression Creation From an MFC String ............................................................................ 136 Overloaded Algorithms For MFC String Types ................................................................................. 137 Iterating Over the Matches Within An MFC String ............................................................................ 139 POSIX Compatible C API's .......................................................................................................................... 141 Concepts ................................................................................................................................................... 144 charT Requirements ............................................................................................................................ 144 Traits Class Requirements .................................................................................................................... 145 Iterator Requirements .......................................................................................................................... 148 Deprecated Interfaces .................................................................................................................................. 149 regex_format (Deprecated) ................................................................................................................... 149 regex_grep (Deprecated) ...................................................................................................................... 150 regex_split (deprecated) ....................................................................................................................... 154 High Level Class RegEx (Deprecated) .................................................................................................... 156 Internal Details ........................................................................................................................................... 162 Unicode Iterators ................................................................................................................................ 162 Background Information ...................................................................................................................................... 165 Headers .................................................................................................................................................... 165 Localization ............................................................................................................................................... 165 Thread Safety ............................................................................................................................................ 173 Test and Example Programs .......................................................................................................................... 173 References and Further Information ............................................................................................................... 175 FAQ ......................................................................................................................................................... 175 Performance .............................................................................................................................................. 176 Standards Conformance ............................................................................................................................... 177 Redistributables .......................................................................................................................................... 179 Acknowledgements ..................................................................................................................................... 179 History ..................................................................................................................................................... 180 A printer-friendly PDF version of this manual is also available.
Boost.Regex
Configuration
Compiler Setup
You shouldn't need to do anything special to congure Boost.Regex for use with your compiler - the Boost.Cong subsystem should already take care of it, if you do have problems (or you are using a particularly obscure compiler or platform) then Boost.Cong has a congure script that you can run.
Locale and traits class selection

The following macros (see user.hpp) control how Boost.Regex interacts with the user's locale: macro BOOST_REGEX_USE_C_LOCALE description Forces Boost.Regex to use the global C locale in its traits class support: this is now deprecated in favour of the C++ locale. Forces Boost.Regex to use std::locale in it's default traits class, regular expressions can then be imbued with an instance specic locale. This is the default behaviour on non-Windows platforms. Tells Boost.Regex not to use any Win32 API's even when available (implies BOOST_REGEX_USE_CPP_LOCALE unless BOOST_REGEX_USE_C_LOCALE is set).
BOOST_REGEX_USE_CPP_LOCALE
BOOST_REGEX_NO_W32
Linkage Options
macro BOOST_REGEX_DYN_LINK description For Microsoft and Borland C++ builds, this tells Boost.Regex that it should link to the dll build of the Boost.Regex. By default boost.regex will link to its static library build, even if the dynamic C runtime library is in use. For Microsoft and Borland C++ builds, this tells Boost.Regex that it should not automatically select the library to link to. For Microsoft builds, this tells Boost.Regex to use the __cdecl calling convention rather than __fastcall. Useful if you want to use the same library from both managed and unmanaged code.
BOOST_REGEX_NO_LIB
BOOST_REGEX_NO_FASTCALL
Boost.Regex
Algorithm Selection
macro BOOST_REGEX_RECURSIVE description Tells Boost.Regex to use a stack-recursive matching algorithm. This is generally the fastest option (although there is very little in it), but can cause stack overow in extreme cases, on Win32 this can be handled safely, but this is not the case on other platforms. Tells Boost.Regex to use a non-stack recursive matching algorithm, this can be slightly slower than the alternative, but is always safe no matter how pathological the regular expression. This is the default on non-Win32 platforms.
BOOST_REGEX_NON_RECURSIVE
Algorithm Tuning
The following option applies only if BOOST_REGEX_RECURSIVE is set. macro BOOST_REGEX_HAS_MS_STACK_GUARD description Tells Boost.Regex that Microsoft style __try - __except blocks are supported, and can be used to safely trap stack overow.
The following options apply only if BOOST_REGEX_NON_RECURSIVE is set. macro BOOST_REGEX_BLOCKSIZE description In non-recursive mode, Boost.Regex uses largish blocks of memory to act as a stack for the state machine, the larger the block size then the fewer allocations that will take place. This defaults to 4096 bytes, which is large enough to match the vast majority of regular expressions without further allocations, however, you can choose smaller or larger values depending upon your platforms characteristics. Tells Boost.Regex how many blocks of size BOOST_REGEX_BLOCKSIZE it is permitted to use. If this value is exceeded then Boost.Regex will stop trying to nd a match and throw a std::runtime_error. Defaults to 1024, don't f o rg e t t o t w e e k t h i s va l u e i f y o u a l t e r BOOST_REGEX_BLOCKSIZE by much. Tells Boost.Regex how many memory blocks to store in it's internal cache - memory blocks are taken from this cache rather than by calling ::operator new. Generally speeking this can be an order of magnitude faster than calling ::opertator new each time a memory block is required, but has the downside that Boost.Regex can end up caching a large chunk of memory (by default up to 16 blocks each of BOOST_REGEX_BLOCKSIZE size). If memory is tight then try dening this to 0 (disables all caching), or if that is too slow, then a value of 1 or 2, may be sufcient. On the other hand, on large multi-processor, multithreaded systems, you may nd that a higher value is in order.
BOOST_REGEX_MAX_BLOCKS
BOOST_REGEX_MAX_CACHE_BLOCKS
Boost.Regex
Building and Installing the Library

When you extract the library from its zip le, you must preserve its internal directory structure (for example by using the -d option when extracting). If you didn't do that when extracting, then you'd better stop reading this, delete the les you just extracted, and try again! This library should not need conguring before use; most popular compilers/standard libraries/platforms are already supported "as is". If you do experience conguration problems, or just want to test the conguration with your compiler, then the process is the same as for all of boost; see the conguration library documentation. The library will encase all code inside namespace boost. Unlike some other template libraries, this library consists of a mixture of template code (in the headers) and static code and data (in cpp les). Consequently it is necessary to build the library's support code into a library or archive le before you can use it, instructions for specic platforms are as follows:
Building with bjam

This is now the preferred method for building and installing this library, please refer to the getting started guide for more information.
Building With Unicode and ICU Support

Boost.Regex is now capable of performing a conguration check to test whether ICU is already installed in your compiler's search paths. When you build you should see a message like this:
Performing configuration checks - has_icu builds : yes
Whick means that ICU has been found, and support for it will be enabled in the library build.
Tip
If you don't want the regex library to use ICU then build with the "--disable-icu" command line option.
If instead you see:

Performing configuration checks - has_icu builds : no
Then ICU was not found and support for it will not be compiled into the library. If you think that it should have been found, then you will need to take a look at the contents of the le boost-root/bin.v2/cong.log for the actual error messages obtained when the build carried out the conguration check. You will then need to x these errors by ensuring your compiler gets invoked with the correct options, for example:
bjam include=some-include-path --toolset=toolset-name install
will add "some-include-path" to your compilers header include path, or if ICU has been built with non-standard names for it's binaries, then:
bjam -sICU_LINK="linker-options-for-icu" --toolset=toolset-name install
Boost.Regex
Will use "linker-options-for-icu" when linking the library rather than the default ICU binary names. You might also need to use the options "cxxags=-option" and "linkags=-option" to set compiler and linker specic options.
Important
Conguration results are cached - if you try rebuilding with different compiler options then add an "-a" to the bjam command line to force all targets to be rebuilt. If ICU is not already in your compiler's path, but instead headers, libraries and binaries are located at path-to-icu/include, path-toicu/lib and path-to-icu/bin respectively then you need to set the environment variable ICU_PATH to point to the root directory of your ICU installation: this typically happens if you're building with MSVC. For example if ICU was installed to c:\download\icu you might use:
bjam -sICU_PATH=c:\download\icu --toolset=toolset-name install
Important
ICU is a C++ library just like Boost is, as such your copy of ICU must have been built with the same C++ compiler (and compiler version) that you are using to build Boost. Boost.Regex will not work correctly unless you ensure that this is the case: it is up to you to ensure that the version of ICU you are using is binary compatible with the toolset you use to build Boost. And nally, if you want to build/test with multiple compiler versions, all with different ICU builds, then the only way to achieve that currently is to modify your user-cong.jam so that each toolset has the necessary compiler/linker options set so that ICU is found automatically by the conguration step (providing the ICU binaries use the standard names, all you have to add is the appropriate header-include and linker-search paths).
Building via makefiles

Borland C++ Builder: Open up a console window and change to the <boost>\libs\regex\build directory. Select the appropriate makele (bcb4.mak for C++ Builder 4, bcb5.mak for C++ Builder 5, and bcb6.mak for C++ Builder 6). Invoke the makele (pass the full path to your version of make if you have more than one version installed, the makele relies on the path to make to obtain your C++ Builder installation directory and tools) for example:
make -fbcb5.mak
The build process will build a variety of .lib and .dll les (the exact number depends upon the version of Borland's tools you are using) the .lib and dll les will be in a sub-directory called bcb4 or bcb5 depending upon the makele used. To install the libraries into your development system use:
make -fbcb5.mak install
library les will be copied to <BCROOT>/lib and the dll's to <BCROOT>/bin, where <BCROOT> corresponds to the install path of your Borland C++ tools. You may also remove temporary les created during the build process (excluding lib and dll les) by using:
make -fbcb5.mak clean
Boost.Regex
Finally when you use Boost.Regex it is only necessary for you to add the <boost> root director to your list of include directories for that project. It is not necessary for you to manually add a .lib le to the project; the headers will automatically select the correct .lib le for your build mode and tell the linker to include it. There is one caveat however: the library can not tell the difference between VCL and non-VCL enabled builds when building a GUI application from the command line, if you build from the command line with the 5.5 command line tools then you must dene the pre-processor symbol _NO_VCL in order to ensure that the correct link libraries are selected: the C++ Builder IDE normally sets this automatically. Hint, users of the 5.5 command line tools may want to add a -D_NO_VCL to bcc32.cfg in order to set this option permanently. If you would prefer to do a dynamic link to the regex libraries when using the dll runtime then dene BOOST_REGEX_DYN_LINK (you must do this if you want to use Boost.Regex in multiple dll's), otherwise Boost.Regex will be statically linked by default. If you want to suppress automatic linking altogether (and supply your own custom build of the lib) then dene BOOST_REGEX_NO_LIB. If you are building with C++ Builder 6, you will nd that <boost/regex.hpp> can not be used in a pre-compiled header (the actual problem is in <locale> which gets included by <boost/regex.hpp>), if this causes problems for you, then try dening BOOST_NO_STD_LOCALE when building, this will disable some features throughout boost, but may save you a lot in compile times!
Microsoft Visual C++ 6, 7, 7.1 and 8

You need version 6 or later of MSVC to build this library. If you are using VC5 then you may want to look at one of the previous releases of this library. Open up a command prompt, which has the necessary MSVC environment variables dened (for example by using the batch le Vcvars32.bat installed by the Visual Studio installation), and change to the <boost>\libs\regex\build directory. Select the correct makele - vc6.mak for "vanilla" Visual C++ 6 or vc6-stlport.mak if you are using STLPort. Invoke the makele like this:
nmake -fvc6.mak
You will now have a collection of lib and dll les in a "vc6" subdirectory, to install these into your development system use:
nmake -fvc6.mak install
The lib les will be copied to your <VC6>\lib directory and the dll les to <VC6>\bin, where <VC6> is the root of your Visual C++ 6 installation. You can delete all the temporary les created during the build (excluding lib and dll les) using:
nmake -fvc6.mak clean
If you want to build with ICU support, then you need to pass the path to your ICU directory to the makele, for example with:
nmake ICU_PATH=c:\open-source\icu -fvc71.mak install
Finally when you use Boost.Regex it is only necessary for you to add the <boost> root directory to your list of include directories for that project. It is not necessary for you to manually add a .lib le to the project; the headers will automatically select the correct .lib le for your build mode and tell the linker to include it. Note that if you want to dynamically link to the regex library when using the dynamic C++ runtime, dene BOOST_REGEX_DYN_LINK when building your project. If you want to add the source directly to your project then dene BOOST_REGEX_NO_LIB to disable automatic library selection.
Boost.Regex
There are several important caveats to remember when using Boost.Regex with Microsoft's Compiler: There have been some reports of compiler-optimization bugs affecting this library, (particularly with VC6 versions prior to service patch 5) the workaround is to build the library using /Oityb1 rather than /O2. That is to use all optimization settings except /Oa. This problem is reported to affect some standard library code as well ( in fact I'm not sure if the problem is with the regex code or the underlying standard library), so it's probably worthwhile applying this workaround in normal practice in any case. If you have replaced the C++ standard library that comes with VC6, then when you build the library you must ensure that the environment variables "INCLUDE" and "LIB" have been updated to reect the include and library paths for the new library - see vcvars32.bat (part of your Visual Studio installation) for more details. If you are building with the full STLPort v4.x, then use the vc6-stlport.mak le provided and set the environment variable STLPORT_PATH to point to the location of your STLPort installation (Note that the full STLPort libraries appear not to support single-thread static builds). If you are building your application with /Zc:wchar_t then you will need to modify the makele to add /Zc:wchar_t before building the library. GCC(2.95 and later) You can build with gcc using the normal boost Jamle in <boost>/libs/regex/build, alternatively there is a conservative makele for the g++ compiler. From the command prompt change to the <boost>/libs/regex/build directory and type:
make -fgcc.mak
At the end of the build process you should have a gcc sub-directory containing release and debug versions of the library (libboost_regex.a and libboost_regex_debug.a). When you build projects that use regex++, you will need to add the boost install directory to your list of include paths and add <boost>/libs/regex/build/gcc/libboost_regex.a to your list of library les. There is also a makele to build the library as a shared library:
make -fgcc-shared.mak
which will build libboost_regex.so and libboost_regex_debug.so. Both of the these makeles support the following environment variables: ICU_PATH: tells the makele to build with Unicode support, set to the path where your ICU installation is located, for example with: make ICU_PATH=/usr/local install -fgcc.mak CXXFLAGS: extra compiler options - note that this applies to both the debug and release builds. INCLUDES: additional include directories. LDFLAGS: additional linker options. LIBS: additional library les. For the more adventurous there is a congure script in <boost>/libs/config; see the cong library documentation. Sun Workshop 6.1 There is a makele for the sun (6.1) compiler (C++ version 3.12). From the command prompt change to the <boost>/libs/regex/build directory and type:
dmake -f sunpro.mak
At the end of the build process you should have a sunpro sub-directory containing single and multithread versions of the library (libboost_regex.a, libboost_regex.so, libboost_regex_mt.a and libboost_regex_mt.so). When you build projects that use Boost.Regex,
Boost.Regex
you will need to add the boost install directory to your list of include paths and add <boost>/libs/regex/build/sunpro/ to your library search path. Both of the these makeles support the following environment variables: CXXFLAGS: extra compiler options - note that this applies to both the single and multithreaded builds. INCLUDES: additional include directories. LDFLAGS: additional linker options. LIBS: additional library les. LIBSUFFIX: a sufx to mangle the library name with (defaults to nothing). This makele does not set any architecture specic options like -xarch=v9, you can set these by dening the appropriate macros, for example:
dmake CXXFLAGS="-xarch=v9" LDFLAGS="-xarch=v9" LIBSUFFIX="_v9" -f sunpro.mak
will build v9 variants of the regex library named libboost_regex_v9.a etc. Makefiles for Other compilers There is a generic makele (generic.mak ) provided in <boost-root>/libs/regex/build - see that makele for details of environment variables that need to be set before use.
Boost.Regex
Introduction and Overview

Regular expressions are a form of pattern-matching that are often used in text processing; many users will be familiar with the Unix utilities grep, sed and awk, and the programming language Perl, each of which make extensive use of regular expressions. Traditionally C++ users have been limited to the POSIX C API's for manipulating regular expressions, and while Boost.Regex does provide these API's, they do not represent the best way to use the library. For example Boost.Regex can cope with wide character strings, or search and replace operations (in a manner analogous to either sed or Perl), something that traditional C libraries can not do. The class basic_regex is the key class in this library; it represents a "machine readable" regular expression, and is very closely modeled on std::basic_string, think of it as a string plus the actual state-machine required by the regular expression algorithms. Like std::basic_string there are two typedefs that are almost always the means by which this class is referenced:
namespace boost{ template <class charT, class traits = regex_traits<charT> > class basic_regex; typedef basic_regex<char> regex; typedef basic_regex<wchar_t> wregex; }
To see how this library can be used, imagine that we are writing a credit card processing application. Credit card numbers generally come as a string of 16-digits, separated into groups of 4-digits, and separated by either a space or a hyphen. Before storing a credit card number in a database (not necessarily something your customers will appreciate!), we may want to verify that the number is in the correct format. To match any digit we could use the regular expression [0-9], however ranges of characters like this are actually locale dependent. Instead we should use the POSIX standard form [[:digit:]], or the Boost.Regex and Perl shorthand for this \d (note that many older libraries tended to be hard-coded to the C-locale, consequently this was not an issue for them). That leaves us with the following regular expression to validate credit card number formats:
(\d{4}[- ]){3}\d{4}
Here the parenthesis act to group (and mark for future reference) sub-expressions, and the {4} means "repeat exactly 4 times". This is an example of the extended regular expression syntax used by Perl, awk and egrep. Boost.Regex also supports the older "basic" syntax used by sed and grep, but this is generally less useful, unless you already have some basic regular expressions that you need to reuse. Now let's take that expression and place it in some C++ code to validate the format of a credit card number:
bool validate_card_format(const std::string& s) { static const boost::regex e("(\\d{4}[- ]){3}\\d{4}"); return regex_match(s, e); }
Note how we had to add some extra escapes to the expression: remember that the escape is seen once by the C++ compiler, before it gets to be seen by the regular expression engine, consequently escapes in regular expressions have to be doubled up when embedding them in C/C++ code. Also note that all the examples assume that your compiler supports argument-dependent-lookup lookup, if yours doesn't (for example VC6), then you will have to add some boost:: prexes to some of the function calls in the examples. Those of you who are familiar with credit card processing, will have realized that while the format used above is suitable for human readable card numbers, it does not represent the format required by online credit card systems; these require the number as a string of 16 (or possibly 15) digits, without any intervening spaces. What we need is a means to convert easily between the two formats, and this is where search and replace comes in. Those who are familiar with the utilities sed and Perl will already be ahead here; we need two strings - one a regular expression - the other a "format string" that provides a description of the text to replace the match
10
Boost.Regex
with. In Boost.Regex this search and replace operation is performed with the algorithm regex_replace, for our credit card example we can write two algorithms like this to provide the format conversions:
// match any format with the regular expression: const boost::regex e("\\A(\\d{3,4})[- ]?(\\d{4})[- ]?(\\d{4})[- ]?(\\d{4})\\z"); const std::string machine_format("\\1\\2\\3\\4"); const std::string human_format("\\1-\\2-\\3-\\4"); std::string machine_readable_card_number(const std::string s) { return regex_replace(s, e, machine_format, boost::match_default | boost::format_sed); } std::string human_readable_card_number(const std::string s) { return regex_replace(s, e, human_format, boost::match_default | boost::format_sed); }
Here we've used marked sub-expressions in the regular expression to split out the four parts of the card number as separate elds, the format string then uses the sed-like syntax to replace the matched text with the reformatted version. In the examples above, we haven't directly manipulated the results of a regular expression match, however in general the result of a match contains a number of sub-expression matches in addition to the overall match. When the library needs to report a regular expression match it does so using an instance of the class match_results, as before there are typedefs of this class for the most common cases:
namespace boost{ typedef typedef typedef typedef } match_results<const char*> match_results<const wchar_t*> match_results<std::string::const_iterator> match_results<std::wstring::const_iterator> cmatch; wcmatch; smatch; wsmatch;
The algorithms regex_search and regex_match make use of match_results to report what matched; the difference between these algorithms is that regex_match will only nd matches that consume all of the input text, where as regex_search will search for a match anywhere within the text being matched. Note that these algorithms are not restricted to searching regular C-strings, any bidirectional iterator type can be searched, allowing for the possibility of seamlessly searching almost any kind of data. For search and replace operations, in addition to the algorithm regex_replace that we have already seen, the match_results class has a format member that takes the result of a match and a format string, and produces a new string by merging the two. For iterating through all occurences of an expression within a text, there are two iterator types: regex_iterator will enumerate over the match_results objects found, while regex_token_iterator will enumerate a series of strings (similar to perl style split operations). For those that dislike templates, there is a high level wrapper class RegEx that is an encapsulation of the lower level template code - it provides a simplied interface for those that don't need the full power of the library, and supports only narrow characters, and the "extended" regular expression syntax. This class is now deprecated as it does not form part of the regular expressions C++ standard library proposal. The POSIX API functions: regcomp, regexec, regfree and [regerr], are available in both narrow character and Unicode versions, and are provided for those who need compatibility with these API's. Finally, note that the library now has run-time localization support, and recognizes the full POSIX regular expression syntax - including advanced features like multi-character collating elements and equivalence classes - as well as providing compatibility with other regular expression libraries including GNU and BSD4 regex packages, PCRE and Perl 5.
11
Boost.Regex
Unicode and Boost.Regex

There are two ways to use Boost.Regex with Unicode strings:
Rely on wchar_t
If your platform's wchar_t type can hold Unicode strings, and your platform's C/C++ runtime correctly handles wide character constants (when passed to std::iswspace std::iswlower etc), then you can use boost::wregex to process Unicode. However, there are several disadvantages to this approach: It's not portable: there's no guarantee on the width of wchar_t, or even whether the runtime treats wide characters as Unicode at all, most Windows compilers do so, but many Unix systems do not. There's no support for Unicode-specic character classes: [[:Nd:]], [[:Po:]] etc. You can only search strings that are encoded as sequences of wide characters, it is not possible to search UTF-8, or even UTF-16 on many platforms.
Use a Unicode Aware Regular Expression Type.

If you have the ICU library, then Boost.Regex can be congured to make use of it, and provide a distinct regular expression type (boost::u32regex), that supports both Unicode specic character properties, and the searching of text that is encoded in either UTF8, UTF-16, or UTF-32. See: ICU string class support.
12
Boost.Regex
Understanding Marked Sub-Expressions and Captures

Captures are the iterator ranges that are "captured" by marked sub-expressions as a regular expression gets matched. Each marked sub-expression can result in more than one capture, if it is matched more than once. This document explains how captures and marked sub-expressions in Boost.Regex are represented and accessed.
Marked sub-expressions
Every time a Perl regular expression contains a parenthesis group (), it spits out an extra eld, known as a marked sub-expression, for example the expression:
(\w+)\W+(\w+)
Has two marked sub-expressions (known as $1 and $2 respectively), in addition the complete match is known as $&, everything before the rst match as $`, and everything after the match as $'. So if the above expression is searched for within "@abc def--", then we obtain: Sub-expression $` $& $1 $2 $' Text found "@" "abc def" "abc" "def" "--"
In Boost.Regex all these are accessible via the match_results class that gets lled in when calling one of the regular expression matching algorithms ( regex_search, regex_match, or regex_iterator). So given:
boost::match_results<IteratorType> m;
The Perl and Boost.Regex equivalents are as follows: Perl $` $& $n $' Boost.Regex
m.prefix() m[0] m[n] m.suffix()
In Boost.Regex each sub-expression match is represented by a sub_match object, this is basically just a pair of iterators denoting the start and end position of the sub-expression match, but there are some additional operators provided so that objects of type sub_match behave a lot like a std::basic_string: for example they are implicitly convertible to a basic_string, they can be compared to a string, added to a string, or streamed out to an output stream.
Unmatched Sub-Expressions
When a regular expression match is found there is no need for all of the marked sub-expressions to have participated in the match, for example the expression:
13
Boost.Regex
(abc)|(def)
can match either $1 or $2, but never both at the same time. In Boost.Regex you can determine which sub-expressions matched by accessing the sub_match::matched data member.
Repeated Captures
When a marked sub-expression is repeated, then the sub-expression gets "captured" multiple times, however normally only the nal capture is available, for example if
(?:(\w+)\W+)+
is matched against
one fine day
Then $1 will contain the string "day", and all the previous captures will have been forgotten. However, Boost.Regex has an experimental feature that allows all the capture information to be retained - this is accessed either via the match_results::captures member function or the sub_match::captures member function. These functions return a container that contains a sequence of all the captures obtained during the regular expression matching. The following example program shows how this information may be used:
14
Boost.Regex
#include <boost/regex.hpp> #include <iostream> void print_captures(const std::string& regx, const std::string& text) { boost::regex e(regx); boost::smatch what; std::cout << "Expression: \"" << regx << "\"\n"; std::cout << "Text: \"" << text << "\"\n"; if(boost::regex_match(text, what, e, boost::match_extra)) { unsigned i, j; std::cout << "** Match found **\n Sub-Expressions:\n"; for(i = 0; i < what.size(); ++i) std::cout << " $" << i << " = \"" << what[i] << "\"\n"; std::cout << " Captures:\n"; for(i = 0; i < what.size(); ++i) { std::cout << " $" << i << " = {"; for(j = 0; j < what.captures(i).size(); ++j) { if(j) std::cout << ", "; else std::cout << " "; std::cout << "\"" << what.captures(i)[j] << "\""; } std::cout << " }\n"; } } else { std::cout << "** No Match found **\n"; } } int main(int , char* []) { print_captures("(([[:lower:]]+)|([[:upper:]]+))+", "aBBcccDDDDDeeeeeeee"); print_captures("(.*)bar|(.*)bah", "abcbar"); print_captures("(.*)bar|(.*)bah", "abcbah"); print_captures("^(?:(\\w+)|(?>\\W+))*$", "now is the time for all good men to come to the aid of the party"); return 0; }
Which produces the following output:
15
Boost.Regex
Expression: "(([[:lower:]]+)|([[:upper:]]+))+" Text: "aBBcccDDDDDeeeeeeee" ** Match found ** Sub-Expressions: $0 = "aBBcccDDDDDeeeeeeee" $1 = "eeeeeeee" $2 = "eeeeeeee" $3 = "DDDDD" Captures: $0 = { "aBBcccDDDDDeeeeeeee" } $1 = { "a", "BB", "ccc", "DDDDD", "eeeeeeee" } $2 = { "a", "ccc", "eeeeeeee" } $3 = { "BB", "DDDDD" } Expression: "(.*)bar|(.*)bah" Text: "abcbar" ** Match found ** Sub-Expressions: $0 = "abcbar" $1 = "abc" $2 = "" Captures: $0 = { "abcbar" } $1 = { "abc" } $2 = { } Expression: "(.*)bar|(.*)bah" Text: "abcbah" ** Match found ** Sub-Expressions: $0 = "abcbah" $1 = "" $2 = "abc" Captures: $0 = { "abcbah" } $1 = { } $2 = { "abc" } Expression: "^(?:(\w+)|(?>\W+))*$" Text: "now is the time for all good men to come to the aid of the party" ** Match found ** Sub-Expressions: $0 = "now is the time for all good men to come to the aid of the party" $1 = "party" Captures: $0 = { "now is the time for all good men to come to the aid of the party" } $1 = { "now", "is", "the", "time", "for", "all", "good", "men", "to", "come", "to", "the", "aid", "of", "the", "party" }
Unfortunately enabling this feature has an impact on performance (even if you don't use it), and a much bigger impact if you do use it, therefore to use this feature you need to: Dene BOOST_REGEX_MATCH_EXTRA for all translation units including the library source (the best way to do this is to uncomment this dene in boost/regex/user.hpp and then rebuild everything. Pass the match_extra ag to the particular algorithms where you actually need the captures information (regex_search, regex_match, or regex_iterator).
16
Boost.Regex
Partial Matches
The match_flag_type match_partial can be passed to the following algorithms: regex_match, regex_search, and regex_grep, and used with the iterator regex_iterator. When used it indicates that partial as well as full matches should be found. A partial match is one that matched one or more characters at the end of the text input, but did not match all of the regular expression (although it may have done so had more input been available). Partial matches are typically used when either validating data input (checking each character as it is entered on the keyboard), or when searching texts that are either too long to load into memory (or even into a memory mapped le), or are of indeterminate length (for example the source may be a socket or similar). Partial and full matches can be differentiated as shown in the following table (the variable M represents an instance of match_results as lled in by regex_match, regex_search or regex_grep): Result No match Partial match False True M[0].matched Undened False M[0].rst Undened Start of partial match. M[0].second Undened End of partial match (end of text). End of full match.
Full match
True
True
Start of full match.
Be aware that using partial matches can sometimes result in somewhat imperfect behavior: There are some expressions, such as ".*abc" that will always produce a partial match. This problem can be reduced by careful construction of the regular expressions used, or by setting ags like match_not_dot_newline so that expressions like .* can't match past line boundaries. Boost.Regex currently prefers leftmost matches to full matches, so for example matching "abc|b" against "ab" produces a partial match against the "ab" rather than a full match against "b". It's more efcient to work this way, but may not be the behavior you want in all situations. The following example tests to see whether the text could be a valid credit card number, as the user presses a key, the character entered would be added to the string being built up, and passed to is_possible_card_number. If this returns true then the text could be a valid card number, so the user interface's OK button would be enabled. If it returns false, then this is not yet a valid card number, but could be with more input, so the user interface would disable the OK button. Finally, if the procedure throws an exception the input could never become a valid number, and the inputted character must be discarded, and a suitable error indication displayed to the user.
17
Boost.Regex
#include <string> #include <iostream> #include <boost/regex.hpp> boost::regex e("(\\d{3,4})[- ]?(\\d{4})[- ]?(\\d{4})[- ]?(\\d{4})"); bool is_possible_card_number(const std::string& input) { // // return false for partial match, true for full match, or throw for // impossible match based on what we have so far... boost::match_results<std::string::const_iterator> what; if(0 == boost::regex_match(input, what, e, boost::match_default | boost::match_partial)) { // the input so far could not possibly be valid so reject it: throw std::runtime_error( "Invalid data entered - this could not possibly be a valid card number"); } // OK so far so good, but have we finished? if(what[0].matched) { // excellent, we have a result: return true; } // what we have so far is only a partial match... return false; }
In the following example, text input is taken from a stream containing an unknown amount of text; this example simply counts the number of html tags encountered in the stream. The text is loaded into a buffer and searched a part at a time, if a partial match was encountered, then the partial match gets searched a second time as the start of the next batch of text:
18
Boost.Regex
#include #include #include #include #include
<iostream> <fstream> <sstream> <string> <boost/regex.hpp>
// match some kind of html tag: boost::regex e("<[^>]*>"); // count how many: unsigned int tags = 0; void search(std::istream& is) { // buffer we'll be searching in: char buf[4096]; // saved position of end of partial match: const char* next_pos = buf + sizeof(buf); // flag to indicate whether there is more input to come: bool have_more = true; while(have_more) { // how much do we copy forward from last try: unsigned leftover = (buf + sizeof(buf)) - next_pos; // and how much is left to fill: unsigned size = next_pos - buf; // copy forward whatever we have left: std::memmove(buf, next_pos, leftover); // fill the rest from the stream: is.read(buf + leftover, size); unsigned read = is.gcount(); // check to see if we've run out of text: have_more = read == size; // reset next_pos: next_pos = buf + sizeof(buf); // and then iterate: boost::cregex_iterator a( buf, buf + read + leftover, e, boost::match_default | boost::match_partial); boost::cregex_iterator b; while(a != b) { if((*a)[0].matched == false) { // Partial match, save position and break: next_pos = (*a)[0].first; break; } else { // full match: ++tags; } // move to next match: ++a; } } }
19
Boost.Regex
Regular Expression Syntax

This section covers the regular expression syntax used by this library, this is a programmers guide, the actual syntax presented to your program's users will depend upon the ags used during expression compilation. There are three main syntax options available, depending upon how you construct the regular expression object: Perl (this is the default behavior). POSIX extended (including the egrep and awk variations). POSIX Basic (including the grep and emacs variations). You can also construct a regular expression that treats every character as a literal, but that's not really a "syntax"!
Perl Regular Expression Syntax

Synopsis
The Perl regular expression syntax is based on that used by the programming language Perl . Perl regular expressions are the default behavior in Boost.Regex or you can pass the ag perl to the basic_regex constructor, for example:
// e1 is a case sensitive Perl regular expression: // since Perl is the default option there's no need to explicitly specify the syntax used here: boost::regex e1(my_expression); // e2 a case insensitive Perl regular expression: boost::regex e2(my_expression, boost::regex::perl|boost::regex::icase);
Perl Regular Expression Syntax

In Perl regular expressions, all characters match themselves except for the following special characters:
.[{}()\*+?|^$
Wildcard
The single character '.' when used outside of a character set will match any single character except: The NULL character when the ag match_not_dot_null is passed to the matching algorithms. The newline character when the ag match_not_dot_newline is passed to the matching algorithms.
Anchors
A '^' character shall match the start of a line. A '$' character shall match the end of a line.
Marked sub-expressions
A section beginning ( and ending ) acts as a marked sub-expression. Whatever matched the sub-expression is split out in a separate eld by the matching algorithms. Marked sub-expressions can also repeated, or referred to by a back-reference.
20
Boost.Regex
Non-marking grouping
A marked sub-expression is useful to lexically group part of a regular expression, but has the side-effect of spitting out an extra eld in the result. As an alternative you can lexically group part of a regular expression, without generating a marked sub-expression by using (?: and ) , for example (?:ab)+ will repeat ab without splitting out any separate sub-expressions.
Repeats
Any atom (a single character, a marked sub-expression, or a character class) can be repeated with the *, +, ?, and {} operators. The * operator will match the preceding atom zero or more times, for example the expression a*b will match any of the following:
b ab aaaaaaaab
The + operator will match the preceding atom one or more times, for example the expression a+b will match any of the following:
ab aaaaaaaab
But will not match:

b
The ? operator will match the preceding atom zero or one times, for example the expression ca?b will match any of the following:
cb cab
But will not match:

caab
An atom can also be repeated with a bounded repeat:

a{n} Matches 'a' repeated exactly n times. a{n,} Matches 'a' repeated n or more times. a{n, m} Matches 'a' repeated between n and m times inclusive.
For example:
â{2,3}$
Will match either of:

aa aaa
But neither of:

a aaaa
21
Boost.Regex
It is an error to use a repeat operator, if the preceding construct can not be repeated, for example:
a(*)
Will raise an error, as there is nothing for the * operator to be applied to.
Non greedy repeats

The normal repeat operators are "greedy", that is to say they will consume as much input as possible. There are non-greedy versions available that will consume as little input as possible while still producing a match.
*? Matches the previous atom zero or more times, while consuming as little input as possible. +? Matches the previous atom one or more times, while consuming as little input as possible. ?? Matches the previous atom zero or one times, while consuming as little input as possible. {n,}? Matches the previous atom n or more times, while consuming as little input as possible. {n,m}? Matches the previous atom between n and m times, while consuming as little input as possible.
Possessive repeats
By default when a repeated pattern does not match then the engine will backtrack until a match is found. However, this behaviour can sometime be undesireable so there are also "possessive" repeats: these match as much as possible and do not then allow backtracking if the rest of the expression fails to match.
*+ Matches the previous atom zero or more times, while giving nothing back. ++ Matches the previous atom one or more times, while giving nothing back. ?+ Matches the previous atom zero or one times, while giving nothing back. {n,}+ Matches the previous atom n or more times, while giving nothing back. {n,m}+ Matches the previous atom between n and m times, while giving nothing back.
Back references
An escape character followed by a digit n, where n is in the range 1-9, matches the same string that was matched by sub-expression n. For example the expression:
^(a*).*\1$
Will match the string:

aaabbaaa
But not the string:

aaabba
You can also use the \g escape for the same function, for example:
22
Boost.Regex
Escape
\g1 \g{1}
Meaning Match whatever matched sub-expression 1 Match whatever matched sub-expression 1: this form allows for safer parsing of the expression in cases like \g{1}2 or for indexes higher than 9 as in \g{1234} Match whatever matched the last opened sub-expression Match whatever matched the last but one opened sub-expression Match whatever matched the sub-expression named "one"
\g-1 \g{-2} \g{one}
Finally the \k escape can be used to refer to named subexpressions, for example \k<two> will match whatever matched the subexpression named "two".
Alternation
The | operator will match either of its arguments, so for example: abc|def will match either "abc" or "def". Parenthesis can be used to group alternations, for example: ab(d|ef) will match either of "abd" or "abef". Empty alternatives are not allowed (these are almost always a mistake), but if you really want an empty alternative use (?:) as a placeholder, for example:
|abc is not a valid expression, but (?:)|abc is and is equivalent, also the expression: (?:abc)?? has exactly the same effect.
Character sets
A character set is a bracket-expression starting with [ and ending with ], it denes a set of characters, and matches any single character that is a member of that set. A bracket expression may contain any combination of the following: Single characters For example =[abc]=, will match any of the characters 'a', 'b', or 'c'. Character ranges For example =[a-c]= will match any single character in the range 'a' to 'c'. By default, for Perl regular expressions, a character x is within the range y to z, if the code point of the character lies within the codepoints of the endpoints of the range. Alternatively, if you set the collate ag when constructing the regular expression, then ranges are locale sensitive. Negation If the bracket-expression begins with the ^ character, then it matches the complement of the characters it contains, for example =a-c= matches any character that is not in the range a-c. Character classes An expression of the form [[:name:]] matches the named character class "name", for example [[:lower:]] matches any lower case character. See character class names.
23
Boost.Regex
Collating Elements An expression of the form [[.col.]] matches the collating element col. A collating element is any single character, or any sequence of characters that collates as a single unit. Collating elements may also be used as the end point of a range, for example: [[.ae.]c] matches the character sequence "ae", plus any single character in the range "ae"-c, assuming that "ae" is treated as a single collating element in the current locale. As an extension, a collating element may also be specied via it's symbolic name, for example:
[[.NUL.]]
matches a \0 character. Equivalence classes An expression of the form [[=col=]], matches any character or collating element whose primary sort key is the same as that for collating element col, as with collating elements the name col may be a symbolic name. A primary sort key is one that ignores case, accentation, or locale-specic tailorings; so for example [[=a=]] matches any of the characters: a, , , , , , , A, , , , , and . Unfortunately implementation of this is reliant on the platform's collation and localisation support; this feature can not be relied upon to work portably across all platforms, or even all locales on one platform. Escaped Characters All the escape sequences that match a single character, or a single character class are permitted within a character class denition. For example [\[\]] would match either of [ or ] while [\W\d] would match any character that is either a "digit", or is not a "word" character. Combinations All of the above can be combined in one character set declaration, for example: [[:digit:]a-c[.NUL.]].
Escapes
Any special character preceded by an escape shall match itself. The following escape sequences are all synonyms for single characters:
24
Boost.Regex
Escape
\a \e \f \n \r \t \v \b \cX
Character
\a 0x1B \f \n \r \t \v \b (but only inside a character class declaration).
An ASCII escape sequence - the character whose code point is X % 32 A hexadecimal escape sequence - matches the single character whose code point is 0xdd. A hexadecimal escape sequence - matches the single character whose code point is 0xdddd. An octal escape sequence - matches the single character whose code point is 0ddd. Matches the single character which has the symbolic name name. For example \N{newline} matches the single character \n.
\xdd
\x{dddd}
\0ddd
\N{name}
"Single character" character classes: Any escaped character x, if x is the name of a character class shall match any character that is a member of that class, and any escaped character X, if x is the name of a character class, shall match any character not in that class. The following are supported by default:
25
Boost.Regex
Escape sequence
\d \l \s \u \w \h \v \D \L \S \U \W \H \V
Equivalent to
[[:digit:]] [[:lower:]] [[:space:]] [[:upper:]] [[:word:]]
Horizontal whitespace Vertical whitespace

[^[:digit:]] [^[:lower:]] [^[:space:]] [^[:upper:]] [^[:word:]]
Not Horizontal whitespace Not Vertical whitespace
Character Properties The character property names in the following table are all equivalent to the names used in character classes. Form
\pX
Description Matches any character that has the property X. Matches any character that has the property Name. Matches any character that does not have the property X. Matches any character that does not have the property Name.
Equivalent character set form

[[:X:]]
\p{Name}
[[:Name:]]
\PX
[^[:X:]]
\P{Name}
[^[:Name:]]
For example \pd matches any "digit" character, as does \p{digit}. Word Boundaries The following escape sequences match the boundaries of words:
\< Matches the start of a word. \> Matches the end of a word.
26
Boost.Regex
\b Matches a word boundary (the start or end of a word). \B Matches only when not at a word boundary.
Buffer boundaries The following match only at buffer boundaries: a "buffer" in this context is the whole of the input text that is being matched against (note that ^ and $ may match embedded newlines within the text). \` Matches at the start of a buffer only. \' Matches at the end of a buffer only. \A Matches at the start of a buffer only (the same as =\`=). \z Matches at the end of a buffer only (the same as \\'). \Z Matches a zero-width assertion consisting of an optional sequence of newlines at the end of a buffer: equivalent to the regular expression (?=\v*\z). Note that this is subtly different from Perl which behaves as if matching (?=\n?\z). Continuation Escape The sequence \G matches only at the end of the last match found, or at the start of the text being matched if no previous match was found. This escape useful if you're iterating over the matches contained within a text, and you want each subsequence match to start where the last one ended. Quoting escape The escape sequence \Q begins a "quoted sequence": all the subsequent characters are treated as literals, until either the end of the regular expression or \E is found. For example the expression: \Q\*+\Ea+ would match either of:
\*+a \*+aaa
Unicode escapes
\C Matches a single code point: in Boost regex this has exactly the same effect as a "." operator. \X Matches a combining character
sequence: that is any non-combining character followed by a sequence of zero or more combining characters. Matching Line Endings The escape sequence \R matches any line ending character sequence, specically it is identical to the expression (?>\x0D\x0A?|[\x0A-\x0C\x85\x{2028}\x{2029}]). Keeping back some text
\K Resets the start location of $0 to the current text position: in other words everything to the left of \K is "kept back" and does not
form part of the regular expression match. $` is updated accordingly. For example foo\Kbar matched against the text "foobar" would return the match "bar" for $0 and "foo" for $`. This can be used to simulate variable width lookbehind assertions. Any other escape Any other escape sequence matches the character that is escaped, for example \@ matches a literal '@'.
Perl Extended Patterns

Perl-specic extensions to the regular expression syntax all start with (?.
27
Boost.Regex
Named Subexpressions You can create a named subexpression using:

(?<NAME>expression)
Which can be then be refered to by the name NAME. Alternatively you can delimit the name using 'NAME' as in:
(?'NAME'expression)
These named subexpressions can be refered to in a backreference using either \g{NAME} or \k<NAME> and can also be refered to by name in a Perl format string for search and replace operations, or in the match_results member functions. Comments
(?# ... ) is treated as a comment, it's contents are ignored.
Modifiers
(?imsx-imsx ... ) alters which of the perl modiers are in effect within the pattern, changes take effect from the point that the block is rst seen and extend to any enclosing ). Letters before a '-' turn that perl modier on, letters afterward, turn it off. (?imsx-imsx:pattern) applies the specied modiers to pattern only.
Non-marking groups
(?:pattern) lexically groups pattern, without generating an additional sub-expression.
Branch reset
(?|pattern) resets the subexpression count at the start of each "|" alternative within pattern.
The sub-expression count following this construct is that of whichever branch had the largest number of sub-expressions. This construct is useful when you want to capture one of a number of alternative matches in a single sub-expression index. In the following example the index of each sub-expression is shown below the expression:
# before ---------------branch-reset----------- after / ( a ) (?| x ( y ) z | (p (q) r) | (t) u (v) ) ( z ) /x # 1 2 2 3 2 3 4
Lookahead
(?=pattern) consumes zero characters, only if pattern matches. (?!pattern) consumes zero characters, only if pattern does not match.
Lookahead is typically used to create the logical AND of two regular expressions, for example if a password must contain a lower case letter, an upper case letter, a punctuation symbol, and be at least 6 characters long, then the expression:
(?=.*[[:lower:]])(?=.*[[:upper:]])(?=.*[[:punct:]]).{6,}
could be used to validate the password. Lookbehind

(?<=pattern) consumes zero characters, only if pattern could be matched against the characters preceding the current position
(pattern must be of xed length).
28
Boost.Regex
(?<!pattern) consumes zero characters, only if pattern could not be matched against the characters preceding the current position
(pattern must be of xed length). Independent sub-expressions

(?>pattern) pattern is matched independently of the surrounding patterns, the expression will never backtrack into pattern. Inde-
pendent sub-expressions are typically used to improve performance; only the best possible match for pattern will be considered, if this doesn't allow the expression as a whole to match then no match is found at all. Recursive Expressions
(?N) (?-N) (?+N) (?R) (?0) (?&NAME) (?R) and (?0) recurse to the start of the entire pattern. (?N) executes sub-expression N recursively, for example (?2) will recurse to sub-expression 2. (?-N) and (?+N) are relative recursions, so for example (?-1) recurses to the last sub-expression to be declared, and (?+1) recurses
to the next sub-expression to be declared.

(?&NAME) recurses to named sub-expression NAME.
Conditional Expressions
(?(condition)yes-pattern|no-pattern) attempts to match yes-pattern if the condition is true, otherwise attempts to match
no-pattern.
(?(condition)yes-pattern) attempts to match yes-pattern if the condition is true, otherwise matches the NULL string.
condition may be either: a forward lookahead assert, the index of a marked sub-expression (the condition becomes true if the subexpression has been matched), or an index of a recursion (the condition become true if we are executing directly inside the specied recursion). Here is a summary of the possible predicates: (?(?=assert)yes-pattern|no-pattern) Executes yes-pattern if the forward look-ahead assert matches, otherwise executes no-pattern. (?(?!assert)yes-pattern|no-pattern) Executes yes-pattern if the forward look-ahead assert does not match, otherwise executes no-pattern. =(?(N)yes-pattern|no-pattern)= Executes yes-pattern if subexpression N has been matched, otherwise executes no-pattern. =(?(<name>)yes-pattern|no-pattern)= Executes yes-pattern if named subexpression name has been matched, otherwise executes no-pattern. =(?('name')yes-pattern|no-pattern)= Executes yes-pattern if named subexpression name has been matched, otherwise executes nopattern. (?(R)yes-pattern|no-pattern) Executes yes-pattern if we are executing inside a recursion, otherwise executes no-pattern. (?(RN)yes-pattern|no-pattern) Executes yes-pattern if we are executing inside a recursion to sub-expression N, otherwise executes no-pattern. (?(R&name)yes-pattern|no-pattern) Executes yes-pattern if we are executing inside a recursion to named sub-expression name, otherwise executes no-pattern. (?(DEFINE)never-exectuted-pattern) Denes a block of code that is never executed and matches no characters: this is usually used to dene one or more named sub-expressions which are refered to from elsewhere in the pattern.
29
Boost.Regex
Operator precedence
The order of precedence for of operators is as follows: 1. Collation-related bracket symbols [==] [::] [..] 2. Escaped characters \ 3. Character set (bracket expression) [] 4. Grouping () 5. Single-character-ERE duplication * + ? {m,n} 6. Concatenation 7. Anchoring ^$ 8. Alternation |
What gets matched

If you view the regular expression as a directed (possibly cyclic) graph, then the best match found is the rst match found by a depthrst-search performed on that graph, while matching the input text. Alternatively: The best match found is the leftmost match, with individual elements matched as follows;
30
Boost.Regex
Construct
AtomA AtomB
What gets matched Locates the best match for AtomA that has a following match for AtomB. If Expresion1 can be matched then returns that match, otherwise attempts to match Expression2. Matches S repeated exactly N times. Matches S repeated between N and M times, and as many times as possible. Matches S repeated between N and M times, and as few times as possible. The same as S{0,1}, S{0,UINT_MAX}, S{1,UINT_MAX} respectively. The same as S{0,1}?, S{0,UINT_MAX}?, S{1,UINT_MAX}? respectively. Matches the best match for S, and only that. Matches only the best match for S (this is only visible if there are capturing parenthesis within S). Considers only whether a match for S exists or not. If condition is true, then only yes-pattern is considered, otherwise only no-pattern is considered.
Expression1 | Expression2
S{N} S{N,M}
S{N,M}?
S?, S*, S+
S??, S*?, S+?
(?>S) (?=S), (?<=S)
(?!S), (?<!S) (?(condition)yes-pattern | no-pattern)
Variations
The options normal, ECMAScript, JavaScript and JScript are all synonyms for perl.
Options
There are a variety of ags that may be combined with the perl option when constructing the regular expression, in particular note that the newline_alt option alters the syntax, while the collate, nosubs and icase options modify how the case and locale sensitivity are to be applied.
Pattern Modifiers
The perl smix modiers can either be applied using a (?smix-smix) prex to the regular expression, or with one of the regexcompile time ags no_mod_m, mod_x, mod_s, and no_mod_s.
References
Perl 5.8.
31
Boost.Regex
POSIX Extended Regular Expression Syntax

Synopsis
The POSIX-Extended regular expression syntax is supported by the POSIX C regular expression API's, and variations are used by the utilities egrep and awk. You can construct POSIX extended regular expressions in Boost.Regex by passing the ag extended to the regex constructor, for example:
// e1 is a case sensitive POSIX-Extended expression: boost::regex e1(my_expression, boost::regex::extended); // e2 a case insensitive POSIX-Extended expression: boost::regex e2(my_expression, boost::regex::extended|boost::regex::icase);
POSIX Extended Syntax

In POSIX-Extended regular expressions, all characters match themselves except for the following special characters:
.[{}()\*+?|^$
Wildcard:
The single character '.' when used outside of a character set will match any single character except: The NULL character when the ag match_no_dot_null is passed to the matching algorithms. The newline character when the ag match_not_dot_newline is passed to the matching algorithms.
Anchors:
A '^' character shall match the start of a line when used as the rst character of an expression, or the rst character of a sub-expression. A '$' character shall match the end of a line when used as the last character of an expression, or the last character of a sub-expression.
Marked sub-expressions:
A section beginning ( and ending ) acts as a marked sub-expression. Whatever matched the sub-expression is split out in a separate eld by the matching algorithms. Marked sub-expressions can also repeated, or referred to by a back-reference.
Repeats:
Any atom (a single character, a marked sub-expression, or a character class) can be repeated with the *, +, ?, and {} operators. The * operator will match the preceding atom zero or more times, for example the expression a*b will match any of the following:
b ab aaaaaaaab
The + operator will match the preceding atom one or more times, for example the expression a+b will match any of the following:
ab aaaaaaaab
But will not match:
32
Boost.Regex
The ? operator will match the preceding atom zero or one times, for example the expression ca?b will match any of the following:
cb cab
But will not match:

caab

a{n} Matches 'a' repeated exactly n times. a{n,} Matches 'a' repeated n or more times. a{n, m} Matches 'a' repeated between n and m times inclusive.
For example:
â{2,3}$

aa aaa
But neither of:

a aaaa
a(*)
Back references:
^(a*).*\1$

aaabbaaa
But not the string:

aaabba
33
Boost.Regex
Caution
The POSIX standard does not support back-references for "extended" regular expressions, this is a compatible extension to that standard.
Alternation
The | operator will match either of its arguments, so for example: abc|def will match either "abc" or "def". Parenthesis can be used to group alternations, for example: ab(d|ef) will match either of "abd" or "abef".
Character sets:
A character set is a bracket-expression starting with [ and ending with ], it denes a set of characters, and matches any single character that is a member of that set. A bracket expression may contain any combination of the following: Single characters: For example [abc], will match any of the characters 'a', 'b', or 'c'. Character ranges: For example [a-c] will match any single character in the range 'a' to 'c'. By default, for POSIX-Extended regular expressions, a character x is within the range y to z, if it collates within that range; this results in locale specic behavior . This behavior can be turned off by unsetting the collate option ag - in which case whether a character appears within a range is determined by comparing the code points of the characters only. Negation: If the bracket-expression begins with the ^ character, then it matches the complement of the characters it contains, for example [â-c] matches any character that is not in the range a-c. Character classes: An expression of the form [[:name:]] matches the named character class "name", for example [[:lower:]] matches any lower case character. See character class names. Collating Elements: An expression of the form [[.col.] matches the collating element col. A collating element is any single character, or any sequence of characters that collates as a single unit. Collating elements may also be used as the end point of a range, for example: [[.ae.]-c] matches the character sequence "ae", plus any single character in the range "ae"-c, assuming that "ae" is treated as a single collating element in the current locale. Collating elements may be used in place of escapes (which are not normally allowed inside character sets), for example [[.^.]abc] would match either one of the characters 'abc^'. As an extension, a collating element may also be specied via its symbolic name, for example:
[[.NUL.]]
matches a NUL character. Equivalence classes: An expression of the form [[=col=]], matches any character or collating element whose primary sort key is the same as that for collating element col, as with colating elements the name col may be a symbolic name. A primary sort key is one that ignores case,
34
Boost.Regex
accentation, or locale-specic tailorings; so for example [[=a=]] matches any of the characters: a, , , , , , , A, , , , , and . Unfortunately implementation of this is reliant on the platform's collation and localisation support; this feature can not be relied upon to work portably across all platforms, or even all locales on one platform. Combinations: All of the above can be combined in one character set declaration, for example: [[:digit:]a-c[.NUL.]].
Escapes
The POSIX standard denes no escape sequences for POSIX-Extended regular expressions, except that: Any special character preceded by an escape shall match itself. The effect of any ordinary character being preceded by an escape is undened. An escape inside a character class declaration shall match itself: in other words the escape character is not "special" inside a character class declaration; so [\^] will match either a literal '\' or a '^'. However, that's rather restrictive, so the following standard-compatible extensions are also supported by Boost.Regex: Escapes matching a specific character The following escape sequences are all synonyms for single characters: Escape \a \e \f \n \r \t \v \b \cX Character '\a' 0x1B \f \n \r \t \v \b (but only inside a character class declaration). An ASCII escape sequence - the character whose code point is X % 32 A hexadecimal escape sequence - matches the single character whose code point is 0xdd. A hexadecimal escape sequence - matches the single character whose code point is 0xdddd. An octal escape sequence - matches the single character whose code point is 0ddd. Matches the single character which has the symbolic name name. For example \\N{newline} matches the single character \n.
\xdd
\x{dddd}
\0ddd
\N{Name}
35
Boost.Regex
"Single character" character classes: Any escaped character x, if x is the name of a character class shall match any character that is a member of that class, and any escaped character X, if x is the name of a character class, shall match any character not in that class. The following are supported by default: Escape sequence
\d \l \s \u \w \D \L \S \U \W
Equivalent to
[[:digit:]] [[:lower:]] [[:space:]] [[:upper:]] [[:word:]] [^[:digit:]] [^[:lower:]] [^[:space:]] [^[:upper:]] [^[:word:]]
Character Properties The character property names in the following table are all equivalent to the names used in character classes. Form
\pX
Description Matches any character that has the property X. Matches any character that has the property Name. Matches any character that does not have the property X. Matches any character that does not have the property Name.
Equivalent character set form

[[:X:]]
\p{Name}
[[:Name:]]
\PX
[^[:X:]]
\P{Name}
[^[:Name:]]
For example \pd matches any "digit" character, as does \p{digit}. Word Boundaries The following escape sequences match the boundaries of words:
36
Boost.Regex
Escape
\< \> \b \B
Meaning Matches the start of a word. Matches the end of a word. Matches a word boundary (the start or end of a word). Matches only when not at a word boundary.
Buffer boundaries The following match only at buffer boundaries: a "buffer" in this context is the whole of the input text that is being matched against (note that ^ and $ may match embedded newlines within the text). Escape \` \'
\A \z \Z
Meaning Matches at the start of a buffer only. Matches at the end of a buffer only. Matches at the start of a buffer only (the same as \`). Matches at the end of a buffer only (the same as \'). Matches an optional sequence of newlines at the end of a buffer: equivalent to the regular expression \n*\z
Continuation Escape The sequence \G matches only at the end of the last match found, or at the start of the text being matched if no previous match was found. This escape useful if you're iterating over the matches contained within a text, and you want each subsequence match to start where the last one ended. Quoting escape The escape sequence \Q begins a "quoted sequence": all the subsequent characters are treated as literals, until either the end of the regular expression or \E is found. For example the expression: \Q\*+\Ea+ would match either of:
\*+a \*+aaa
Unicode escapes Escape

\C
Meaning Matches a single code point: in Boost regex this has exactly the same effect as a "." operator. Matches a combining character sequence: that is any non-combining character followed by a sequence of zero or more combining characters.
\X
Any other escape Any other escape sequence matches the character that is escaped, for example \@ matches a literal '@'.
37
Boost.Regex
Operator precedence
The order of precedence for of operators is as follows: 1. Collation-related bracket symbols [==] [::] [..] 2. Escaped characters \ 3. Character set (bracket expression) [] 4. Grouping () 5. Single-character-ERE duplication * + ? {m,n} 6. Concatenation 7. Anchoring ^$ 8. Alternation |
What Gets Matched

When there is more that one way to match a regular expression, the "best" possible match is obtained using the leftmost-longest rule.
Variations
Egrep
When an expression is compiled with the ag egrep set, then the expression is treated as a newline separated list of POSIX-Extended expressions, a match is found if any of the expressions in the list match, for example:
boost::regex e("abc\ndef", boost::regex::egrep);
will match either of the POSIX-Basic expressions "abc" or "def". As its name suggests, this behavior is consistent with the Unix utility egrep, and with grep when used with the -E option.
awk
In addition to the POSIX-Extended features the escape character is special inside a character class declaration. In addition, some escape sequences that are not dened as part of POSIX-Extended specication are required to be supported however Boost.Regex supports these by default anyway.
Options
There are a variety of ags that may be combined with the extended and egrep options when constructing the regular expression, in particular note that the newline_alt option alters the syntax, while the collate, nosubs and icase options modify how the case and locale sensitivity are to be applied.
References
IEEE Std 1003.1-2001, Portable Operating System Interface (POSIX ), Base Denitions and Headers, Section 9, Regular Expressions. IEEE Std 1003.1-2001, Portable Operating System Interface (POSIX ), Shells and Utilities, Section 4, Utilities, egrep. IEEE Std 1003.1-2001, Portable Operating System Interface (POSIX ), Shells and Utilities, Section 4, Utilities, awk.
38
Boost.Regex
POSIX Basic Regular Expression Syntax

Synopsis
The POSIX-Basic regular expression syntax is used by the Unix utility sed, and variations are used by grep and emacs. You can construct POSIX basic regular expressions in Boost.Regex by passing the ag basic to the regex constructor (see syntax_option_type), for example:
// e1 is a case sensitive POSIX-Basic expression: boost::regex e1(my_expression, boost::regex::basic); // e2 a case insensitive POSIX-Basic expression: boost::regex e2(my_expression, boost::regex::basic|boost::regex::icase);
POSIX Basic Syntax

In POSIX-Basic regular expressions, all characters are match themselves except for the following special characters:
.[\*^$
Wildcard:
The single character '.' when used outside of a character set will match any single character except: The NULL character when the ag match_no_dot_null is passed to the matching algorithms. The newline character when the ag match_not_dot_newline is passed to the matching algorithms.
Anchors:
A '^' character shall match the start of a line when used as the rst character of an expression, or the rst character of a sub-expression. A '$' character shall match the end of a line when used as the last character of an expression, or the last character of a sub-expression.
Marked sub-expressions:
A section beginning $ and ending $ acts as a marked sub-expression. Whatever matched the sub-expression is split out in a separate eld by the matching algorithms. Marked sub-expressions can also repeated, or referred-to by a back-reference.
Repeats:
Any atom (a single character, a marked sub-expression, or a character class) can be repeated with the * operator. For example a* will match any number of letter a's repeated zero or more times (an atom repeated zero times matches an empty string), so the expression a*b will match any of the following:
b ab aaaaaaaab

a\{n\} Matches 'a' repeated exactly n times. a\{n,\} Matches 'a' repeated n or more times. a\{n, m\} Matches 'a' repeated between n and m times inclusive.
39
Boost.Regex
For example:
â{2,3}$

aa aaa
But neither of:

a aaaa
a(*)
Back references:
^$a*$.*\1$

aaabbaaa
But not the string:

aaabba
Character sets:
A character set is a bracket-expression starting with [ and ending with ], it denes a set of characters, and matches any single character that is a member of that set. A bracket expression may contain any combination of the following: Single characters: For example [abc], will match any of the characters 'a', 'b', or 'c'. Character ranges: For example [a-c] will match any single character in the range 'a' to 'c'. By default, for POSIX-Basic regular expressions, a character x is within the range y to z, if it collates within that range; this results in locale specic behavior. This behavior can be turned off by unsetting the collate option ag when constructing the regular expression - in which case whether a character appears within a range is determined by comparing the code points of the characters only.
40
Boost.Regex
Negation: If the bracket-expression begins with the ^ character, then it matches the complement of the characters it contains, for example [â-c] matches any character that is not in the range a-c. Character classes: An expression of the form [[:name:]] matches the named character class "name", for example [[:lower:]] matches any lower case character. See character class names. Collating Elements: An expression of the form [[.col.] matches the collating element col. A collating element is any single character, or any sequence of characters that collates as a single unit. Collating elements may also be used as the end point of a range, for example: [[.ae.]-c] matches the character sequence "ae", plus any single character in the rangle "ae"-c, assuming that "ae" is treated as a single collating element in the current locale. Collating elements may be used in place of escapes (which are not normally allowed inside character sets), for example [[.^.]abc] would match either one of the characters 'abc^'. As an extension, a collating element may also be specied via its symbolic name, for example:
[[.NUL.]]
matches a 'NUL' character. See collating element names. Equivalence classes: An expression of theform [[=col=]], matches any character or collating element whose primary sort key is the same as that for collating element col, as with collating elements the name col may be a collating symbolic name. A primary sort key is one that ignores case, accentation, or locale-specic tailorings; so for example [[=a=]] matches any of the characters: a, , , , , , , A, , , , , and . Unfortunately implementation of this is reliant on the platform's collation and localisation support; this feature can not be relied upon to work portably across all platforms, or even all locales on one platform. Combinations: All of the above can be combined in one character set declaration, for example: [[:digit:]a-c[.NUL.]].
Escapes
With the exception of the escape sequences \{, \}, $, and $, which are documented above, an escape followed by any character matches that character. This can be used to make the special characters
.[\*^$
"ordinary". Note that the escape character loses its special meaning inside a character set, so [\^] will match either a literal '\' or a '^'.
What Gets Matched

When there is more that one way to match a regular expression, the "best" possible match is obtained using the leftmost-longest rule.
Variations
Grep
When an expression is compiled with the ag grep set, then the expression is treated as a newline separated list of POSIX-Basic expressions, a match is found if any of the expressions in the list match, for example:
41
Boost.Regex
boost::regex e("abc\ndef", boost::regex::grep);
will match either of the POSIX-Basic expressions "abc" or "def". As its name suggests, this behavior is consistent with the Unix utility grep.
emacs
In addition to the POSIX-Basic features the following characters are also special: Character + ? *? +? ?? And the following escape sequences are also recognised: Escape \| \(?: ... ) Description species an alternative. is a non-marking grouping construct - allows you to lexically group something without spitting out an extra sub-expression. matches any word character. matches any non-word character. matches any character in the syntax group x, the following emacs groupings are supported: 's', ' ', '_', 'w', '.', ')', '(', '"', '\'', '>' and '<'. Refer to the emacs docs for details. matches any character not in the syntax grouping x. These are not supported. matches zero characters only at the start of a buffer (or string being matched). matches zero characters only at the end of a buffer (or string being matched). matches zero characters at a word boundary. matches zero characters, not at a word boundary. matches zero characters only at the start of a word. matches zero characters only at the end of a word. Description repeats the preceding atom one or more times. repeats the preceding atom zero or one times. A non-greedy version of *. A non-greedy version of +. A non-greedy version of ?.
\w \W \sx
\Sx \c and \C \`
\'
\b \B \< \>
42
Boost.Regex
Finally, you should note that emacs style regular expressions are matched according to the Perl "depth rst search" rules. Emacs expressions are matched this way because they contain Perl-like extensions, that do not interact well with the POSIX-style leftmostlongest rule.
Options
There are a variety of ags that may be combined with the basic and grep options when constructing the regular expression, in particular note that the newline_alt, no_char_classes, no-intervals, bk_plus_qm and bk_plus_vbar options all alter the syntax, while the collate and icase options modify how the case and locale sensitivity are to be applied.
References
IEEE Std 1003.1-2001, Portable Operating System Interface (POSIX ), Base Denitions and Headers, Section 9, Regular Expressions (FWD.1). IEEE Std 1003.1-2001, Portable Operating System Interface (POSIX ), Shells and Utilities, Section 4, Utilities, grep (FWD.1). Emacs Version 21.3.
Character Class Names

Character Classes that are Always Supported
The following character class names are always supported by Boost.Regex:
43
Boost.Regex
Name alnum alpha blank
POSIX-standard name Yes Yes Yes
Description Any alpha-numeric character. Any alphabetic character. Any whitespace character that is not a line separator. Any control character. Any decimal digit Any decimal digit. Any graphical character. Any lower case character. Any lower case character. Any printable character. Any punctuation character. Any whitespace character. Any whitespace character. Any extended character whose code point is above 255 in value. Any upper case character. Any upper case character. Any word character (alphanumeric characters plus the underscore). Any word character (alphanumeric characters plus the underscore). Any hexadecimal digit character.
cntrl d digit graph l lower print punct s space unicode
Yes No Yes Yes No Yes Yes Yes No Yes No
u upper w
No Yes No
word
No
xdigit
Yes
Character classes that are supported by Unicode Regular Expressions

The following character classes are only supported by Unicode Regular Expressions: that is those that use the u32regex type. The names used are the same as those from Chapter 4 of the Unicode standard.
44
Boost.Regex
Short Name
Long Name ASCII Any Assigned
C* Cc Cf Cn Co Cs L* Ll Lm Lo Lt Lu M* Mc Me Mn N* Nd Nl No P* Pc Pd Pe Pf
Other Control Format Not Assigned Private Use Surrogate Letter Lowercase Letter Modier Letter Other Letter Titlecase Uppercase Letter Mark Spacing Combining Mark Enclosing Mark Non-Spacing Mark Number Decimal Digit Number Letter Number Other Number Punctuation Connector Punctuation Dash Punctuation Close Punctuation Final Punctuation
45
Boost.Regex
Short Name Pi Po Ps S* Sc Sk Sm So Z* Zl Zp Zs
Long Name Initial Punctuation Other Punctuation Open Punctuation Symbol Currency Symbol Modier Symbol Math Symbol Other Symbol Separator Line Separator Paragraph Separator Space Separator
Collating Names
Digraphs
The following are treated as valid digraphs when used as a collating name: "ae", "Ae", "AE", "ch", "Ch", "CH", "ll", "Ll", "LL", "ss", "Ss", "SS", "nj", "Nj", "NJ", "dz", "Dz", "DZ", "lj", "Lj", "LJ". So for example the expression:
[[.ae.]-c]
will match any character that collates between the digraph "ae" and the character "c".
POSIX Symbolic Names

The following symbolic names are recognised as valid collating element names, in addition to any single character, this allows you to write for example:
[[.left-square-bracket.][.right-square-bracket.]]
if you wanted to match either "[" or "]".
46
Boost.Regex
Name NUL SOH STX ETX EOT ENQ ACK alert backspace tab newline vertical-tab form-feed carriage-return SO SI DLE DC1 DC2 DC3 DC4 NAK SYN ETB CAN EM SUB ESC
Character \x00 \x01 \x02 \x03 \x04 \x05 \x06 \x07 \x08 \t \n \v \f \r \xE \xF \x10 \x11 \x12 \x13 \x14 \x15 \x16 \x17 \x18 \x19 \x1A \x1B
47
Boost.Regex
Name IS4 IS3 IS2 IS1 space exclamation-mark quotation-mark number-sign dollar-sign percent-sign ampersand apostrophe left-parenthesis right-parenthesis asterisk plus-sign comma hyphen period slash zero one two three four ve six seven
Character \x1C \x1D \x1E \x1F \x20 ! " # $ % & ' ( ) * + , . / 0 1 2 3 4 5 6 7
48
Boost.Regex
Name eight nine colon semicolon less-than-sign equals-sign greater-than-sign question-mark commercial-at left-square-bracket backslash right-square-bracket circumex underscore grave-accent left-curly-bracket vertical-line right-curly-bracket tilde DEL
Character 8 9 : ; < = > ? @ [ \ ] ~ _ ` { | } ~ \x7F
Named Unicode Characters

When using Unicode aware regular expressions (with the u32regex type), all the normal symbolic names for Unicode characters (those given in Unidata.txt) are recognised. So for example:
[[.CYRILLIC CAPITAL LETTER I.]]
would match the Unicode character 0x0418.
The Leftmost Longest Rule

Often there is more than one way of matching a regular expression at a particular location, for POSIX basic and extended regular expressions, the "best" match is determined as follows:
49
Boost.Regex
1. Find the leftmost match, if there is only one match possible at this location then return it. 2. Find the longest of the possible matches, along with any ties. If there is only one such possible match then return it. 3. If there are no marked sub-expressions, then all the remaining alternatives are indistinguishable; return the rst of these found. 4. Find the match which has matched the rst sub-expression in the leftmost position, along with any ties. If there is only on such match possible then return it. 5. Find the match which has the longest match for the rst sub-expression, along with any ties. If there is only one such match then return it. 6. Repeat steps 4 and 5 for each additional marked sub-expression. 7. If there is still more than one possible match remaining, then they are indistinguishable; return the rst one found.
50
Boost.Regex
Search and Replace Format String Syntax

Format strings are used by the algorithm regex_replace and by match_results<>::format, and are used to transform one string into another. There are three kind of format string: Sed, Perl and Boost-Extended. Alternatively, when the ag format_literal is passed to one of these functions, then the format string is treated as a string literal, and is copied unchanged to the output.
Sed Format String Syntax

Sed-style format strings treat all characters as literals except: character & description The ampersand character is replaced in the output stream by the the whole of what matched the regular expression. Use \& to output a literal '&' character. Species an escape sequence.
An escape character followed by any character x, outputs that character unless x is one of the escape sequences shown below. Escape \a \e \f \n \r \t \v \xDD \x{DDDD} Meaning Outputs the bell character: '\a'. Outputs the ANSI escape character (code point 27). Outputs a form feed character: '\f' Outputs a newline character: '\n'. Outputs a carriage return character: '\r'. Outputs a tab character: '\t'. Outputs a vertical tab character: '\v'. Outputs the character whose hexadecimal code point is 0xDD Outputs the character whose hexadecimal code point is 0xDDDDD Outputs the ANSI escape sequence "escape-X". If D is a decimal digit in the range 1-9, then outputs the text that matched sub-expression D.
\cX \D
Perl Format String Syntax

Perl-style format strings treat all characters as literals except '$' and '\' which start placeholder and escape sequences respectively. Placeholder sequences specify that some part of what matched the regular expression should be sent to output as follows:
51
Boost.Regex
Placeholder $& $MATCH ${^MATCH} $`
Meaning Outputs what matched the whole expression. As $& As $& Outputs the text between the end of the last match found (or the start of the text if no previous match was found), and the start of the current match. As $` As $` Outputs all the text following the end of the current match. As $' As $' Outputs what matched the last marked sub-expression in the regular expression. As $+ Outputs what matched the last sub-expression to be actually matched. As $LAST_SUBMATCH_RESULT Outputs a literal '$' Outputs what matched the n'th sub-expression. Outputs what matched the n'th sub-expression. Outputs whatever matched the sub-expression named "NAME".
$PREMATCH ${^PREMATCH} $' $POSTMATCH ${^POSTMATCH} $+
$LAST_PAREN_MATCH $LAST_SUBMATCH_RESULT
$^N $$ $n ${n} $+{NAME}
Any $-placeholder sequence not listed above, results in '$' being treated as a literal. An escape character followed by any character x, outputs that character unless x is one of the escape sequences shown below.
52
Boost.Regex
Escape \a \e \f \n \r \t \v \xDD \x{DDDD}
Meaning Outputs the bell character: '\a'. Outputs the ANSI escape character (code point 27). Outputs a form feed character: '\f' Outputs a newline character: '\n'. Outputs a carriage return character: '\r'. Outputs a tab character: '\t'. Outputs a vertical tab character: '\v'. Outputs the character whose hexadecimal code point is 0xDD Outputs the character whose hexadecimal code point is 0xDDDDD Outputs the ANSI escape sequence "escape-X". If D is a decimal digit in the range 1-9, then outputs the text that matched sub-expression D. Causes the next character to be outputted, to be output in lower case. Causes the next character to be outputted, to be output in upper case. Causes all subsequent characters to be output in lower case, until a \E is found. Causes all subsequent characters to be output in upper case, until a \E is found. Terminates a \L or \U sequence.
\cX \D
\l
\u
\L
\U
\E
Boost-Extended Format String Syntax

Boost-Extended format strings treat all characters as literals except for '$', '\', '(', ')', '?', and ':'.
Grouping
The characters '(' and ')' perform lexical grouping, so use $ and $ if you want a to output literal parenthesis.
Conditionals
The character '?' begins a conditional expression, the general form is: ?Ntrue-expression:false-expression where N is decimal digit. If sub-expression N was matched, then true-expression is evaluated and sent to output, otherwise false-expression is evaluated and sent to output.
53
Boost.Regex
You will normally need to surround a conditional-expression with parenthesis in order to prevent ambiguities. For example, the format string "(?1foo:bar)" will replace each match found with "foo" if the sub-expression $1 was matched, and with "bar" otherwise. For sub-expressions with an index greater than 9, or for access to named sub-expressions use: ?{INDEX}true-expression:false-expression or ?{NAME}true-expression:false-expression
Placeholder Sequences
Placeholder sequences specify that some part of what matched the regular expression should be sent to output as follows: Placeholder $& $MATCH ${^MATCH} $` Meaning Outputs what matched the whole expression. As $& As $& Outputs the text between the end of the last match found (or the start of the text if no previous match was found), and the start of the current match. As $` As $` Outputs all the text following the end of the current match. As $' As $' Outputs what matched the last marked sub-expression in the regular expression. As $+ Outputs what matched the last sub-expression to be actually matched. As $LAST_SUBMATCH_RESULT Outputs a literal '$' Outputs what matched the n'th sub-expression. Outputs what matched the n'th sub-expression. Outputs whatever matched the sub-expression named "NAME".
$PREMATCH ${^PREMATCH} $' $POSTMATCH ${^POSTMATCH} $+
$LAST_PAREN_MATCH $LAST_SUBMATCH_RESULT
$^N $$ $n ${n} $+{NAME}
Any $-placeholder sequence not listed above, results in '$' being treated as a literal.
54
Boost.Regex
Escape Sequences
An escape character followed by any character x, outputs that character unless x is one of the escape sequences shown below. Escape \a \e \f \n \r \t \v \xDD \x{DDDD} Meaning Outputs the bell character: '\a'. Outputs the ANSI escape character (code point 27). Outputs a form feed character: '\f' Outputs a newline character: '\n'. Outputs a carriage return character: '\r'. Outputs a tab character: '\t'. Outputs a vertical tab character: '\v'. Outputs the character whose hexadecimal code point is 0xDD Outputs the character whose hexadecimal code point is 0xDDDDD Outputs the ANSI escape sequence "escape-X". If D is a decimal digit in the range 1-9, then outputs the text that matched sub-expression D. Causes the next character to be outputted, to be output in lower case. Causes the next character to be outputted, to be output in upper case. Causes all subsequent characters to be output in lower case, until a \E is found. Causes all subsequent characters to be output in upper case, until a \E is found. Terminates a \L or \U sequence.
\cX \D
\l
\u
\L
\U
\E
55
Boost.Regex
Reference
basic_regex
Synopsis
#include <boost/regex.hpp>
The template class basic_regex encapsulates regular expression parsing and compilation. The class takes two template parameters: charT: determines the character type, i.e. either char or wchar_t; see charT concept. traits: determines the behavior of the character type, for example which character class names are recognized. A default traits class is provided: regex_traits<charT>. See also traits concept. For ease of use there are two typedefs that dene the two standard basic_regex instances, unless you want to use custom traits classes or non-standard character types (for example see unicode support), you won't need to use anything other than these:
namespace boost{ template <class charT, class traits = regex_traits<charT> class basic_regex; typedef basic_regex<char> typedef basic_regex<wchar_t> } regex; wregex; >
The denition of basic_regex follows: it is based very closely on class basic_string, and fulls the requirements for a constantcontainer of charT.
56
Boost.Regex
namespace boost{ template <class charT, class traits = regex_traits<charT> > class basic_regex { public: // types: typedef charT value_type; typedef implementation-specific const_iterator; typedef const_iterator iterator; typedef charT& reference; typedef const charT& const_reference; typedef std::ptrdiff_t difference_type; typedef std::size_t size_type; typedef regex_constants:: syntax_option_type flag_type; typedef typename traits::locale_type locale_type; // constants: // main option selection: static const regex_constants:: syntax_option_type normal = regex_constants::normal; static const regex_constants:: syntax_option_type ECMAScript = normal; static const regex_constants:: syntax_option_type JavaScript = normal; static const regex_constants:: syntax_option_type JScript = normal; static const regex_constants:: syntax_option_type basic = regex_constants::basic; static const regex_constants:: syntax_option_type extended = regex_constants::extended; static const regex_constants:: syntax_option_type awk = regex_constants::awk; static const regex_constants:: syntax_option_type grep = regex_constants::grep; static const regex_constants:: syntax_option_type egrep = regex_constants::egrep; static const regex_constants:: syntax_option_type sed = basic = regex_constants::sed; static const regex_constants:: syntax_option_type perl = regex_constants::perl; static const regex_constants:: syntax_option_type literal = regex_constants::literal; // modifiers specific to perl expressions: static const regex_constants:: syntax_option_type no_mod_m = regex_constants::no_mod_m; static const regex_constants:: syntax_option_type no_mod_s = regex_constants::no_mod_s; static const regex_constants:: syntax_option_type mod_s = regex_constants::mod_s; static const regex_constants:: syntax_option_type mod_x = regex_constants::mod_x; // modifiers specific to POSIX basic expressions: static const regex_constants:: syntax_option_type bk_plus_qm = regex_constants::bk_plus_qm; static const regex_constants:: syntax_option_type bk_vbar = regex_constants::bk_vbar static const regex_constants:: syntax_option_type no_char_classes = regex_constants::no_char_classes static const regex_constants:: syntax_option_type no_intervals = regex_constants::no_intervals
57
Boost.Regex
// common modifiers: static const regex_constants:: syntax_option_type nosubs = regex_constants::nosubs; static const regex_constants:: syntax_option_type optimize = regex_constants::optimize; static const regex_constants:: syntax_option_type collate = regex_constants::collate; static const regex_constants:: syntax_option_type newline_alt = regex_constants::newline_alt; static const regex_constants:: syntax_option_type no_except = regex_constants::newline_alt; // construct/copy/destroy: explicit basic_regex (); explicit basic_regex(const charT* p, flag_type f = regex_constants::normal); basic_regex(const charT* p1, const charT* p2, flag_type f = regex_constants::normal); basic_regex(const charT* p, size_type len, flag_type f); basic_regex(const basic_regex&); template <class ST, class SA> explicit basic_regex(const basic_string<charT, ST, SA>& p, flag_type f = regex_constants::normal); template <class InputIterator> basic_regex(InputIterator first, InputIterator last, flag_type f = regex_constants::normal); ~basic_regex(); basic_regex& operator=(const basic_regex&); basic_regex& operator= (const charT* ptr); template <class ST, class SA> basic_regex& operator= (const basic_string<charT, ST, SA>& p); // iterators: std::pair<const_iterator, const_iterator> subexpression(size_type n) const; const_iterator begin() const; const_iterator end() const; // capacity: size_type size() const; size_type max_size() const; bool empty() const; size_type mark_count()const; // // modifiers: basic_regex& assign(const basic_regex& that); basic_regex& assign(const charT* ptr, flag_type f = regex_constants::normal); basic_regex& assign(const charT* ptr, unsigned int len, flag_type f); template <class string_traits, class A> basic_regex& assign(const basic_string<charT, string_traits, A>& s, flag_type f = regex_constants::normal); template <class InputIterator> basic_regex& assign(InputIterator first, InputIterator last, flag_type f = regex_constants::normal); // const operations: flag_type flags() const; int status()const; basic_string<charT> str() const; int compare(basic_regex&) const;
58
Boost.Regex
// locale: locale_type imbue(locale_type loc); locale_type getloc() const; // swap void swap(basic_regex&) throw(); }; template <class charT, class traits> bool operator == (const basic_regex<charT, traits>& lhs, const basic_regex<charT, traits>& rhs); template <class charT, class traits> bool operator != (const basic_regex<charT, traits>& lhs, const basic_regex<charT, traits>& rhs); template <class charT, class traits> bool operator < (const basic_regex<charT, traits>& lhs, const basic_regex<charT, traits>& rhs); template <class charT, class traits> bool operator <= (const basic_regex<charT, traits>& lhs, const basic_regex<charT, traits>& rhs); template <class charT, class traits> bool operator >= (const basic_regex<charT, traits>& lhs, const basic_regex<charT, traits>& rhs); template <class charT, class traits> bool operator > (const basic_regex<charT, traits>& lhs, const basic_regex<charT, traits>& rhs); template <class charT, class io_traits, class re_traits> basic_ostream<charT, io_traits>& operator << (basic_ostream<charT, io_traits>& os, const basic_regex<charT, re_traits>& e); template <class charT, class traits> void swap(basic_regex<charT, traits>& e1, basic_regex<charT, traits>& e2); typedef basic_regex<char> regex; typedef basic_regex<wchar_t> wregex; } // namespace boost
Description
Class basic_regex has the following public members:
59
Boost.Regex
// main option selection: static const regex_constants:: syntax_option_type normal = regex_constants::normal; static const regex_constants:: syntax_option_type ECMAScript = normal; static const regex_constants:: syntax_option_type JavaScript = normal; static const regex_constants:: syntax_option_type JScript = normal; static const regex_constants:: syntax_option_type basic = regex_constants::basic; static const regex_constants:: syntax_option_type extended = regex_constants::extended; static const regex_constants:: syntax_option_type awk = regex_constants::awk; static const regex_constants:: syntax_option_type grep = regex_constants::grep; static const regex_constants:: syntax_option_type egrep = regex_constants::egrep; static const regex_constants:: syntax_option_type sed = regex_constants::sed; static const regex_constants:: syntax_option_type perl = regex_constants::perl; static const regex_constants:: syntax_option_type literal = regex_constants::literal; // modifiers specific to perl expressions: static const regex_constants:: syntax_option_type no_mod_m = regex_constants::no_mod_m; static const regex_constants:: syntax_option_type no_mod_s = regex_constants::no_mod_s; static const regex_constants:: syntax_option_type mod_s = regex_constants::mod_s; static const regex_constants:: syntax_option_type mod_x = regex_constants::mod_x; // modifiers specific to POSIX basic expressions: static const regex_constants:: syntax_option_type bk_plus_qm = regex_constants::bk_plus_qm; static const regex_constants:: syntax_option_type bk_vbar = regex_constants::bk_vbar static const regex_constants:: syntax_option_type no_char_classes = regex_constants::no_char_classes static const regex_constants:: syntax_option_type no_intervals = regex_constants::no_intervals // common modifiers: static const regex_constants:: syntax_option_type nosubs = regex_constants::nosubs; static const regex_constants:: syntax_option_type optimize = regex_constants::optimize; static const regex_constants:: syntax_option_type collate = regex_constants::collate; static const regex_constants:: syntax_option_type newline_alt = regex_constants::newline_alt;
The meaning of these options is documented in the syntax_option_type section. The static constant members are provided as synonyms for the constants declared in namespace boost::regex_constants; for each constant of type syntax_option_type declared in namespace boost::regex_constants then a constant with the same name, type and value is declared within the scope of basic_regex.
60
Boost.Regex
basic_regex();
Effects: Constructs an object of class basic_regex.
Table 1. basic_regex default construction postconditions

Element
empty() size() str()
Value
true 0 basic_string<charT>()
basic_regex(const charT* p, flag_type f = regex_constants::normal);
Requires: p shall not be a null pointer. Throws: bad_expression if p is not a valid regular expression, unless the ag no_except is set in f. Effects: Constructs an object of class basic_regex; the object's internal nite state machine is constructed from the regular expression contained in the null-terminated string p, and interpreted according to the option ags specied in f.
Table 2. Postconditions for basic_regex construction

Element
empty() size() str() flags() mark_count()
Value
false char_traits<charT>::length(p) basic_string<charT>(p)
f The number of marked sub-expressions within the expression.
basic_regex(const charT* p1, const charT* p2, flag_type f = regex_constants::normal);
Requires: p1 and p2 are not null pointers, p1 < p2. Throws: bad_expression if [p1,p2) is not a valid regular expression, unless the ag no_except is set in f. Effects: Constructs an object of class basic_regex; the object's internal nite state machine is constructed from the regular expression contained in the sequence of characters [p1,p2), and interpreted according the option ags specied in f.
61
Boost.Regex

Element
Value
false std::distance(p1,p2) basic_string<charT>(p1,p2)
basic_regex(const charT* p, size_type len, flag_type f);
Requires: p shall not be a null pointer, len < max_size(). Throws: bad_expression if p is not a valid regular expression, unless the ag no_except is set in f. Effects: Constructs an object of class basic_regex; the object's internal nite state machine is constructed from the regular expression contained in the sequence of characters [p, p+len), and interpreted according the option ags specied in f.

Element
Value
false
len
basic_string<charT>(p, len)
basic_regex(const basic_regex& e);
Effects: Constructs an object of class basic_regex as a copy of the object e.

template <class ST, class SA> basic_regex(const basic_string<charT, ST, SA>& s, flag_type f = regex_constants::normal);
Throws: bad_expression if s is not a valid regular expression, unless the ag no_except is set in f. Effects: Constructs an object of class basic_regex; the object's internal nite state machine is constructed from the regular expression contained in the string s, and interpreted according to the option ags specied in f.
62
Boost.Regex

Element
Value
false s.size()
s f The number of marked sub-expressions within the expression.
template <class ForwardIterator> basic_regex(ForwardIterator first, ForwardIterator last, flag_type f = regex_constants::normal);
Throws: bad_expression if the sequence [rst, last) is not a valid regular expression, unless the ag no_except is set in f. Effects: Constructs an object of class basic_regex; the object's internal nite state machine is constructed from the regular expression contained in the sequence of characters [rst, last), and interpreted according to the option ags specied in f.

Element
Value
false distance(first,last) basic_string<charT>(first,last)
basic_regex& operator=(const basic_regex& e);
Effects: Returns the result of assign(e.str(), e.flags()).

basic_regex& operator=(const charT* ptr);
Requires: p shall not be a null pointer. Effects: Returns the result of assign(ptr).
template <class ST, class SA> basic_regex& operator=(const basic_string<charT, ST, SA>& p);
Effects: Returns the result of assign(p).

std::pair<const_iterator, const_iterator> subexpression(size_type n) const;
63
Boost.Regex
Effects: Returns a pair of iterators denoting the location of marked subexpression n within the original regular expression string. The returned iterators are relative to begin() and end(). Requires: The expression must have been compiled with the syntax_option_type save_subexpression_location set. Argument n must be in within the range 1 <= n < mark_count().
const_iterator begin() const;
Effects: Returns a starting iterator to a sequence of characters representing the regular expression.
const_iterator end() const;
Effects: Returns termination iterator to a sequence of characters representing the regular expression.
size_type size() const;
Effects: Returns the length of the sequence of characters representing the regular expression.
size_type max_size() const;
Effects: Returns the maximum length of the sequence of characters representing the regular expression.
bool empty() const;
Effects: Returns true if the object does not contain a valid regular expression, otherwise false.
size_type mark_count() const;
Effects: Returns the number of marked sub-expressions within the regular expresion.
basic_regex& assign(const basic_regex& that);
Effects: Returns assign(that.str(), that.flags()).

basic_regex& assign(const charT* ptr, flag_type f = regex_constants::normal);
Effects: Returns assign(string_type(ptr), f).

basic_regex& assign(const charT* ptr, unsigned int len, flag_type f);
Effects: Returns assign(string_type(ptr, len), f).

template <class string_traits, class A> basic_regex& assign(const basic_string<charT, string_traits, A>& s, flag_type f = regex_constants::normal);
Throws: bad_expression if s is not a valid regular expression, unless the ag no_except is set in f. Returns: *this. Effects: Assigns the regular expression contained in the string s, interpreted according the option ags specied in f.
64
Boost.Regex
Table 7. Postconditions for basic_regex::assign

Element
Value
false s.size()
s f The number of marked sub-expressions within the expression.
template <class InputIterator> basic_regex& assign(InputIterator first, InputIterator last, flag_type f = regex_constants::normal);
Requires: The type InputIterator corresponds to the Input Iterator requirements (24.1.1). Effects: Returns assign(string_type(first, last), f).
flag_type flags() const;
Effects: Returns a copy of the regular expression syntax ags that were passed to the object's constructor, or the last call to assign.
int status() const;
Effects: Returns zero if the expression contains a valid regular expression, otherwise an error code. This member function is retained for use in environments that cannot use exception handling.
basic_string<charT> str() const;
Effects: Returns a copy of the character sequence passed to the object's constructor, or the last call to assign.
int compare(basic_regex& e)const;
Effects: If flags() == e.flags() then returns str().compare(e.str()), otherwise returns flags() - e.flags().
locale_type imbue(locale_type l);
Effects: Returns the result of traits_inst.imbue(l) where traits_inst is a (default initialized) instance of the template parameter traits stored within the object. Calls to imbue invalidate any currently contained regular expression. Postcondition: empty() == true.
locale_type getloc() const;
Effects: Returns the result of traits_inst.getloc() where traits_inst is a (default initialized) instance of the template parameter traits stored within the object.
void swap(basic_regex& e) throw();
65
Boost.Regex
Effects: Swaps the contents of the two regular expressions. Postcondition: *this contains the regular expression that was in e, e contains the regular expression that was in *this. Complexity: constant time.
Note
Comparisons between basic_regex objects are provided on an experimental basis: please note that these are not present in the Technical Report on C++ Library Extensions, so use with care if you are writing code that may need to be ported to other implementations of basic_regex.
template <class charT, class traits> bool operator == (const basic_regex<charT, traits>& lhs, const basic_regex<charT, traits>& rhs);
Effects: Returns lhs.compare(rhs) == 0.

template <class charT, class traits> bool operator != (const basic_regex<charT, traits>& lhs, const basic_regex<charT, traits>& rhs);
Effects: Returns lhs.compare(rhs) != 0.

template <class charT, class traits> bool operator < (const basic_regex<charT, traits>& lhs, const basic_regex<charT, traits>& rhs);
Effects: Returns lhs.compare(rhs) < 0.

template <class charT, class traits> bool operator <= (const basic_regex<charT, traits>& lhs, const basic_regex<charT, traits>& rhs);
Effects: Returns lhs.compare(rhs) <= 0.

template <class charT, class traits> bool operator >= (const basic_regex<charT, traits>& lhs, const basic_regex<charT, traits>& rhs);
Effects: Returns lhs.compare(rhs) >= 0.

template <class charT, class traits> bool operator > (const basic_regex<charT, traits>& lhs, const basic_regex<charT, traits>& rhs);
Effects: Returns lhs.compare(rhs) > 0.
Note
The basic_regex stream inserter is provided on an experimental basis, and outputs the textual representation of the expression to the stream.
66
Boost.Regex
template <class charT, class io_traits, class re_traits> basic_ostream<charT, io_traits>& operator << (basic_ostream<charT, io_traits>& os const basic_regex<charT, re_traits>& e);
Effects: Returns (os << e.str()).

template <class charT, class traits> void swap(basic_regex<charT, traits>& lhs, basic_regex<charT, traits>& rhs);
Effects: calls lhs.swap(rhs).
match_results
Synopsis
Regular expressions are different from many simple pattern-matching algorithms in that as well as nding an overall match they can also produce sub-expression matches: each sub-expression being delimited in the pattern by a pair of parenthesis (...). There has to be some method for reporting sub-expression matches back to the user: this is achieved this by dening a class match_results that acts as an indexed collection of sub-expression matches, each sub-expression match being contained in an object of type sub_match. Template class match_results denotes a collection of character sequences representing the result of a regular expression match. Objects of type match_results are passed to the algorithms regex_match and regex_search, and are returned by the iterator regex_iterator. Storage for the collection is allocated and freed as necessary by the member functions of class match_results. The template class match_results conforms to the requirements of a Sequence, as specied in (lib.sequence.reqmts), except that only operations dened for const-qualied Sequences are supported. Class template match_results is most commonly used as one of the typedefs cmatch, wcmatch, smatch, or wsmatch:
67
Boost.Regex
template <class BidirectionalIterator, class Allocator = std::allocator<sub_match<BidirectionalIterator> > class match_results; typedef typedef typedef typedef match_results<const char*> match_results<const wchar_t*> match_results<string::const_iterator> match_results<wstring::const_iterator> cmatch; wcmatch; smatch; wsmatch;
template <class BidirectionalIterator, class Allocator = std::allocator<sub_match<BidirectionalIterator> > class match_results { public: typedef sub_match<BidirectionalIterator> value_type; typedef const value_type& const_reference; typedef const_reference reference; typedef implementation defined const_iterator; typedef const_iterator iterator; typedef typename iterator_traits<BidirectionalIterator>::difference_type difference_type; typedef typename Allocator::size_type size_type; typedef Allocator allocator_type; typedef typename iterator_traits<BidirectionalIterator>::value_type char_type; typedef basic_string<char_type> string_type; // construct/copy/destroy: explicit match_results(const Allocator& a = Allocator()); match_results(const match_results& m); match_results& operator=(const match_results& m); ~match_results(); // size: size_type size() const; size_type max_size() const; bool empty() const; // element access: difference_type length(int sub = 0) const; difference_type length(const char_type* sub) const; template <class charT> difference_type length(const charT* sub) const; template <class charT, class Traits, class A> difference_type length(const std::basic_string<charT, Traits, A>& sub) const; difference_type position(unsigned int sub = 0) const; difference_type position(const char_type* sub) const; template <class charT> difference_type position(const charT* sub) const; template <class charT, class Traits, class A> difference_type position(const std::basic_string<charT, Traits, A>& sub) const; string_type str(int sub = 0) const; string_type str(const char_type* sub)const; template <class Traits, class A> string_type str(const std::basic_string<char_type, Traits, A>& sub)const; template <class charT> string_type str(const charT* sub)const; template <class charT, class Traits, class A> string_type str(const std::basic_string<charT, Traits, A>& sub)const; const_reference operator[](int n) const; const_reference operator[](const char_type* n) const; template <class Traits, class A> const_reference operator[](const std::basic_string<char_type, Traits, A>& n) const; template <class charT> const_reference operator[](const charT* n) const; template <class charT, class Traits, class A>
68
Boost.Regex
const_reference operator[](const std::basic_string<charT, Traits, A>& n) const; const_reference prefix() const; const_reference suffix() const; const_iterator begin() const; const_iterator end() const; // format: template <class OutputIterator, class Formatter> OutputIterator format(OutputIterator out, Formatter fmt, match_flag_type flags = format_default) const; template <class Formatter> string_type format(Formatter fmt, match_flag_type flags = format_default) const; allocator_type get_allocator() const; void swap(match_results& that); #ifdef BOOST_REGEX_MATCH_EXTRA typedef typename value_type::capture_sequence_type capture_sequence_type; const capture_sequence_type& captures(std::size_t i)const; #endif }; template <class BidirectionalIterator, class Allocator> bool operator == (const match_results<BidirectionalIterator, const match_results<BidirectionalIterator, template <class BidirectionalIterator, class Allocator> bool operator != (const match_results<BidirectionalIterator, const match_results<BidirectionalIterator,
Allocator>& m1, Allocator>& m2); Allocator>& m1, Allocator>& m2);
template <class charT, class traits, class BidirectionalIterator, class Allocator> basic_ostream<charT, traits>& operator << (basic_ostream<charT, traits>& os, const match_results<BidirectionalIterator, Allocator>& m); template <class BidirectionalIterator, class Allocator> void swap(match_results<BidirectionalIterator, Allocator>& m1, match_results<BidirectionalIterator, Allocator>& m2);
Description
In all match_results constructors, a copy of the Allocator argument is used for any memory allocation performed by the constructor or member functions during the lifetime of the object.
match_results(const Allocator& a = Allocator());
Effects: Constructs an object of class match_results. The postconditions of this function are indicated in the table: Element empty() size() str() Value true 0 basic_string<charT>()
69
Boost.Regex
match_results(const match_results& m);
Effects: Constructs an object of class match_results, as a copy of m.

match_results& operator=(const match_results& m);
Effects: Assigns m to *this. The postconditions of this function are indicated in the table: Element empty() size() str(n) prex() sufx() (*this)[n] length(n) position(n) Value m.empty(). m.size(). m.str(n) for all integers n < m.size(). m.prex(). m.sufx(). m[n] for all integers n < m.size(). m.length(n) for all integers n < m.size(). m.position(n) for all integers n < m.size().
size_type size()const;
Effects: Returns the number of sub_match elements stored in *this; that is the number of marked sub-expressions in the regular expression that was matched plus one.
size_type max_size()const;
Effects: Returns the maximum number of sub_match elements that can be stored in *this.
bool empty()const;
Effects: Returns size() == 0.

difference_type difference_type template <class difference_type template <class difference_type length(int sub = 0)const; length(const char_type* sub)const; charT> length(const charT* sub)const; charT, class Traits, class A> length(const std::basic_string<charT, Traits, A>&)const;
Requires: that the match_results object has been initialized as a result of a successful call to regex_search or regex_match or was returned from a regex_iterator, and that the underlying iterators have not been subsequently invalidated. Will raise a std::logic_error if the match_results object was not initialized. Effects: Returns the length of sub-expression sub, that is to say: (*this)[sub].length(). The overloads that accept a string refer to a named sub-expression n. In the event that there is no such named sub-expression then returns zero.
70
Boost.Regex
The template overloads of this function, allow the string and/or character type to be different from the character type of the underlying sequence and/or regular expression: in this case the characters will be widened to the underlying character type of the original regular expression. A compiler error will occur if the argument passes a wider character type than the underlying sequence. These overloads allow a normal narrow character C string literal to be used as an argument, even when the underlying character type of the expression being matched may be something more exotic such as a Unicode character type.
difference_type difference_type template <class difference_type template <class difference_type position(unsigned int sub = 0)const; position(const char_type* sub)const; charT> position(const charT* sub)const; charT, class Traits, class A> position(const std::basic_string<charT, Traits, A>&)const;
Requires: that the match_results object has been initialized as a result of a successful call to regex_search or regex_match or was returned from a regex_iterator, and that the underlying iterators have not been subsequently invalidated. Will raise a std::logic_error if the match_results object was not initialized. Effects: Returns the starting location of sub-expression sub, or -1 if sub was not matched. Note that if this represents a partial match , then position() will return the location of the partial match even though (*this)[0].matched is false. The overloads that accept a string refer to a named sub-expression n. In the event that there is no such named sub-expression then returns -1. The template overloads of this function, allow the string and/or character type to be different from the character type of the underlying sequence and/or regular expression: in this case the characters will be widened to the underlying character type of the original regular expression. A compiler error will occur if the argument passes a wider character type than the underlying sequence. These overloads allow a normal narrow character C string literal to be used as an argument, even when the underlying character type of the expression being matched may be something more exotic such as a Unicode character type.
string_type str(int sub = 0)const; string_type str(const char_type* sub)const; template <class Traits, class A> string_type str(const std::basic_string<char_type, Traits, A>& sub)const; template <class charT> string_type str(const charT* sub)const; template <class charT, class Traits, class A> string_type str(const std::basic_string<charT, Traits, A>& sub)const;
Requires: that the match_results object has been initialized as a result of a successful call to regex_search or regex_match or was returned from a regex_iterator, and that the underlying iterators have not been subsequently invalidated. Will raise a std::logic_error if the match_results object was not initialized. Effects: Returns sub-expression sub as a string: string_type((*this)[sub]). The overloads that accept a string, return the string that matched the named sub-expression n. In the event that there is no such named sub-expression then returns an empty string. The template overloads of this function, allow the string and/or character type to be different from the character type of the underlying sequence and/or regular expression: in this case the characters will be widened to the underlying character type of the original regular expression. A compiler error will occur if the argument passes a wider character type than the underlying sequence. These overloads allow a normal narrow character C string literal to be used as an argument, even when the underlying character type of the expression being matched may be something more exotic such as a Unicode character type.
71
Boost.Regex
const_reference const_reference template <class const_reference template <class const_reference template <class const_reference
operator[](int n) const; operator[](const char_type* n) const; Traits, class A> operator[](const std::basic_string<char_type, Traits, A>& n) const; charT> operator[](const charT* n) const; charT, class Traits, class A> operator[](const std::basic_string<charT, Traits, A>& n) const;
Requires: that the match_results object has been initialized as a result of a successful call to regex_search or regex_match or was returned from a regex_iterator, and that the underlying iterators have not been subsequently invalidated. Will raise a std::logic_error if the match_results object was not initialized. Effects: Returns a reference to the sub_match object representing the character sequence that matched marked sub-expression n. If n == 0 then returns a reference to a sub_match object representing the character sequence that matched the whole regular expression. If n is out of range, or if n is an unmatched sub-expression, then returns a sub_match object whose matched member is false. The overloads that accept a string, return a reference to the sub_match object representing the character sequence that matched the named sub-expression n. In the event that there is no such named sub-expression then returns a sub_match object whose matched member is false. The template overloads of this function, allow the string and/or character type to be different from the character type of the underlying sequence and/or regular expression: in this case the characters will be widened to the underlying character type of the original regular expression. A compiler error will occur if the argument passes a wider character type than the underlying sequence. These overloads allow a normal narrow character C string literal to be used as an argument, even when the underlying character type of the expression being matched may be something more exotic such as a Unicode character type.
const_reference prefix()const;
Requires: that the match_results object has been initialized as a result of a successful call to regex_search or regex_match or was returned from a regex_iterator, and that the underlying iterators have not been subsequently invalidated. Will raise a std::logic_error if the match_results object was not initialized. Effects: Returns a reference to the sub_match object representing the character sequence from the start of the string being matched or searched, to the start of the match found.
const_reference suffix()const;
Requires: that the match_results object has been initialized as a result of a successful call to regex_search or regex_match or was returned from a regex_iterator, and that the underlying iterators have not been subsequently invalidated. Will raise a std::logic_error if the match_results object was not initialized. Effects: Returns a reference to the sub_match object representing the character sequence from the end of the match found to the end of the string being matched or searched.
const_iterator begin()const;
Effects: Returns a starting iterator that enumerates over all the marked sub-expression matches stored in *this.
const_iterator end()const;
Effects: Returns a terminating iterator that enumerates over all the marked sub-expression matches stored in *this.
72
Boost.Regex
template <class OutputIterator, class Formatter> OutputIterator format(OutputIterator out, Formatter fmt, match_flag_type flags = format_default);
Requires: The type OutputIterator conforms to the Output Iterator requirements (C++ std 24.1.2). The type Formatter must be either a pointer to a null-terminated string of type char_type[], or be a container of char_type's (for example std::basic_string<char_type>) or be a unary, binary or ternary functor that computes the replacement string from a function call: either fmt(*this) which must return a container of char_type's to be used as the replacement text, or either fmt(*this, out) or fmt(*this, out, flags), both of which write the replacement text to *out, and then return the new OutputIterator position. Note that if the formatter is a functor, then it is passed by value: users that want to pass function objects with internal state might want to use Boost.Ref to wrap the object so that it's passed by reference. Requires: that the match_results object has been initialized as a result of a successful call to regex_search or regex_match or was returned from a regex_iterator, and that the underlying iterators have not been subsequently invalidated. Will raise a std::logic_error if the match_results object was not initialized. Effects: If fmt is either a null-terminated string, or a container of char_type's, then copies the character sequence [fmt.begin(), fmt.end()) to OutputIterator out. For each format specier or escape sequence in fmt, replace that sequence with either the character(s) it represents, or the sequence of characters within *this to which it refers. The bitmasks specied in ags determines what format speciers or escape sequences are recognized, by default this is the format used by ECMA-262, ECMAScript Language Specication, Chapter 15 part 5.4.11 String.prototype.replace. If fmt is a function object, then depending on the number of arguments the function object accepts, it will either: Call fmt(*this) and copy the string returned to OutputIterator out. Call fmt(*this, out). Call fmt(*this, out, flags). In all cases the new position of the OutputIterator is returned. See the format syntax guide for more information. Returns: out.
template <class Formatter> string_type format(Formatter fmt, match_flag_type flags = format_default);
Requires The type Formatter must be either a pointer to a null-terminated string of type char_type[], or be a container of char_type's (for example std::basic_string<char_type>) or be a unary, binary or ternary functor that computes the replacement string from a function call: either fmt(*this) which must return a container of char_type's to be used as the replacement text, or either fmt(*this, out) or fmt(*this, out, flags), both of which write the replacement text to *out, and then return the new OutputIterator position. Requires: that the match_results object has been initialized as a result of a successful call to regex_search or regex_match or was returned from a regex_iterator, and that the underlying iterators have not been subsequently invalidated. Will raise a std::logic_error if the match_results object was not initialized. Effects: If fmt is either a null-terminated string, or a container of char_type's, then copies the string fmt: For each format specier or escape sequence in fmt, replace that sequence with either the character(s) it represents, or the sequence of characters within *this to which it refers. The bitmasks specied in ags determines what format speciers or escape sequences are recognized, by default this is the format used by ECMA-262, ECMAScript Language Specication, Chapter 15 part 5.4.11 String.prototype.replace. If fmt is a function object, then depending on the number of arguments the function object accepts, it will either:
73
Boost.Regex
Call fmt(*this) and return the result. Call fmt(*this, unspecified-output-iterator), where unspecified-output-iterator is an unspecied OutputIterator type used to copy the output to the string result. Call fmt(*this, unspecified-output-iterator, flags), where unspecified-output-iterator is an unspecied OutputIterator type used to copy the output to the string result. See the format syntax guide for more information.
allocator_type get_allocator()const;
Effects: Returns a copy of the Allocator that was passed to the object's constructor.
void swap(match_results& that);
Effects: Swaps the contents of the two sequences. Postcondition: *this contains the sequence of matched sub-expressions that were in that, that contains the sequence of matched subexpressions that were in *this. Complexity: constant time.
typedef typename value_type::capture_sequence_type capture_sequence_type;
Denes an implementation-specic type that satises the requirements of a standard library Sequence (21.1.1 including the optional Table 68 operations), whose value_type is a sub_match<BidirectionalIterator>. This type happens to be std::vector<sub_match<BidirectionalIterator> >, but you shouldn't actually rely on that.
const capture_sequence_type& captures(std::size_t i)const;
Requires: that the match_results object has been initialized as a result of a successful call to regex_search or regex_match or was returned from a regex_iterator, and that the underlying iterators have not been subsequently invalidated. Will raise a std::logic_error if the match_results object was not initialized. Effects: returns a sequence containing all the captures obtained for sub-expression i. Returns: (*this)[i].captures(); Preconditions: the library must be built and used with BOOST_REGEX_MATCH_EXTRA dened, and you must pass the ag match_extra to the regex matching functions ( regex_match, regex_search, regex_iterator or regex_token_iterator) in order for this member function to be dened and return useful information. Rationale: Enabling this feature has several consequences: sub_match occupies more memory resulting in complex expressions running out of memory or stack space more quickly during matching. The matching algorithms are less efcient at handling some features (independent sub-expressions for example), even when match_extra is not used. The matching algorithms are much less efcient (i.e. slower), when match_extra is used. Mostly this is down to the extra memory allocations that have to take place.
template <class BidirectionalIterator, class Allocator> bool operator == (const match_results<BidirectionalIterator, Allocator>& m1, const match_results<BidirectionalIterator, Allocator>& m2);
74
Boost.Regex
Effects: Compares the two sequences for equality.

template <class BidirectionalIterator, class Allocator> bool operator != (const match_results<BidirectionalIterator, Allocator>& m1, const match_results<BidirectionalIterator, Allocator>& m2);
Effects: Compares the two sequences for inequality.

template <class charT, class traits, class BidirectionalIterator, class Allocator> basic_ostream<charT, traits>& operator << (basic_ostream<charT, traits>& os, const match_results<BidirectionalIterator, Allocator>& m);
Effects: Writes the contents of m to the stream os as if by calling os << m.str(); Returns os.
template <class BidirectionalIterator, class Allocator> void swap(match_results<BidirectionalIterator, Allocator>& m1, match_results<BidirectionalIterator, Allocator>& m2);
Effects: Swaps the contents of the two sequences.
sub_match
Regular expressions are different from many simple pattern-matching algorithms in that as well as nding an overall match they can also produce sub-expression matches: each sub-expression being delimited in the pattern by a pair of parenthesis (...). There has to be some method for reporting sub-expression matches back to the user: this is achieved this by dening a class match_results that acts as an indexed collection of sub-expression matches, each sub-expression match being contained in an object of type sub_match. Objects of type sub_match may only be obtained by subscripting an object of type match_results. Objects of type sub_match may be compared to objects of type std::basic_string, or const charT* or const charT. Objects of type sub_match may be added to objects of type std::basic_string, or const charT* or const charT, to produce a new std::basic_string object. When the marked sub-expression denoted by an object of type sub_match participated in a regular expression match then member matched evaluates to true, and members rst and second denote the range of characters [rst,second) which formed that match. Otherwise matched is false, and members rst and second contained undened values. When the marked sub-expression denoted by an object of type sub_match was repeated, then the sub_match object represents the match obtained by the last repeat. The complete set of all the captures obtained for all the repeats, may be accessed via the captures() member function (Note: this has serious performance implications, you have to explicitly enable this feature). If an object of type sub_match represents sub-expression 0 - that is to say the whole match - then member matched is always true, unless a partial match was obtained as a result of the ag match_partial being passed to a regular expression algorithm, in which case member matched is false, and members rst and second represent the character range that formed the partial match.
75
Boost.Regex
namespace boost{ template <class BidirectionalIterator> class sub_match; typedef typedef typedef typedef sub_match<const char*> sub_match<const wchar_t*> sub_match<std::string::const_iterator> sub_match<std::wstring::const_iterator> csub_match; wcsub_match; ssub_match; wssub_match;
template <class BidirectionalIterator> class sub_match : public std::pair<BidirectionalIterator, BidirectionalIterator> { public: typedef typename iterator_traits<BidirectionalIterator>::value_type value_type; typedef typename iterator_traits<BidirectionalIterator>::difference_type difference_type; typedef BidirectionalIterator iterator; bool matched; difference_type length()const; operator basic_string<value_type>()const; basic_string<value_type> str()const; int compare(const sub_match& s)const; int compare(const basic_string<value_type>& s)const; int compare(const value_type* s)const; #ifdef BOOST_REGEX_MATCH_EXTRA typedef implementation-private capture_sequence_type; const capture_sequence_type& captures()const; #endif }; // // comparisons to another sub_match: // template <class BidirectionalIterator> bool operator == (const sub_match<BidirectionalIterator>& lhs, const sub_match<BidirectionalIterator>& rhs); template <class BidirectionalIterator> bool operator != (const sub_match<BidirectionalIterator>& lhs, const sub_match<BidirectionalIterator>& rhs); template <class BidirectionalIterator> bool operator < (const sub_match<BidirectionalIterator>& lhs, const sub_match<BidirectionalIterator>& rhs); template <class BidirectionalIterator> bool operator <= (const sub_match<BidirectionalIterator>& lhs, const sub_match<BidirectionalIterator>& rhs); template <class BidirectionalIterator> bool operator >= (const sub_match<BidirectionalIterator>& lhs, const sub_match<BidirectionalIterator>& rhs); template <class BidirectionalIterator> bool operator > (const sub_match<BidirectionalIterator>& lhs, const sub_match<BidirectionalIterator>& rhs);
// // comparisons to a basic_string: // template <class BidirectionalIterator, class traits, class Allocator> bool operator == (const std::basic_string<iterator_traits<BidirectionalIterator>::value_type, traits, Allocator>& lhs, const sub_match<BidirectionalIterator>& rhs);
76
Boost.Regex
template <class BidirectionalIterator, class traits, class Allocator> bool operator != (const std::basic_string<iterator_traits<BidirectionalIterator>::value_type, traits, Allocator>& lhs, const sub_match<BidirectionalIterator>& rhs); template <class BidirectionalIterator, class traits, class Allocator> bool operator < (const std::basic_string<iterator_traits<BidirectionalIterator>::value_type, traits, Allocator>& lhs, const sub_match<BidirectionalIterator>& rhs); template <class BidirectionalIterator, class traits, class Allocator> bool operator > (const std::basic_string<iterator_traits<BidirectionalIterator>::value_type, traits, Allocator>& lhs, const sub_match<BidirectionalIterator>& rhs); template <class BidirectionalIterator, class traits, class Allocator> bool operator >= (const std::basic_string<iterator_traits<BidirectionalIterator>::value_type, traits, Allocator>& lhs, const sub_match<BidirectionalIterator>& rhs); template <class BidirectionalIterator, class traits, class Allocator> bool operator <= (const std::basic_string<iterator_traits<BidirectionalIterator>::value_type, traits, Allocator>& lhs, const sub_match<BidirectionalIterator>& rhs); template <class BidirectionalIterator, class traits, class Allocator> bool operator == (const sub_match<BidirectionalIterator>& lhs, const std::basic_string<iterator_traits<BidirectionalIterator>::value_type, traits, Allocator>& rhs); template <class BidirectionalIterator, class traits, class Allocator> bool operator != (const sub_match<BidirectionalIterator>& lhs, const std::basic_string<iterator_traits<BidirectionalIterator>::value_type, traits, Allocator>& rhs); template <class BidirectionalIterator, class traits, class Allocator> bool operator < (const sub_match<BidirectionalIterator>& lhs, const std::basic_string<iterator_traits<BidirectionalIterator>::value_type, traits, Allocator>& rhs); template <class BidirectionalIterator, class traits, class Allocator> bool operator > (const sub_match<BidirectionalIterator>& lhs, const std::basic_string<iterator_traits<BidirectionalIterator>::value_type, traits, Allocator>& rhs); template <class BidirectionalIterator, class traits, class Allocator> bool operator >= (const sub_match<BidirectionalIterator>& lhs, const std::basic_string<iterator_traits<BidirectionalIterator>::value_type, traits, Allocator>& rhs); template <class BidirectionalIterator, class traits, class Allocator> bool operator <= (const sub_match<BidirectionalIterator>& lhs, const std::basic_string<iterator_traits<BidirectionalIterator>::value_type, traits, Allocator>& rhs); // // comparisons to a pointer to a character array: // template <class BidirectionalIterator> bool operator == (typename iterator_traits<BidirectionalIterator>::value_type const* lhs, const sub_match<BidirectionalIterator>& rhs);
77
Boost.Regex
template <class BidirectionalIterator> bool operator != (typename iterator_traits<BidirectionalIterator>::value_type const* lhs, const sub_match<BidirectionalIterator>& rhs); template <class BidirectionalIterator> bool operator < (typename iterator_traits<BidirectionalIterator>::value_type const* lhs, const sub_match<BidirectionalIterator>& rhs); template <class BidirectionalIterator> bool operator > (typename iterator_traits<BidirectionalIterator>::value_type const* lhs, const sub_match<BidirectionalIterator>& rhs); template <class BidirectionalIterator> bool operator >= (typename iterator_traits<BidirectionalIterator>::value_type const* lhs, const sub_match<BidirectionalIterator>& rhs); template <class BidirectionalIterator> bool operator <= (typename iterator_traits<BidirectionalIterator>::value_type const* lhs, const sub_match<BidirectionalIterator>& rhs); template <class BidirectionalIterator> bool operator == (const sub_match<BidirectionalIterator>& lhs, typename iterator_traits<BidirectionalIterator>::value_type const* rhs); template <class BidirectionalIterator> bool operator != (const sub_match<BidirectionalIterator>& lhs, typename iterator_traits<BidirectionalIterator>::value_type const* rhs); template <class BidirectionalIterator> bool operator < (const sub_match<BidirectionalIterator>& lhs, typename iterator_traits<BidirectionalIterator>::value_type const* rhs); template <class BidirectionalIterator> bool operator > (const sub_match<BidirectionalIterator>& lhs, typename iterator_traits<BidirectionalIterator>::value_type const* rhs); template <class BidirectionalIterator> bool operator >= (const sub_match<BidirectionalIterator>& lhs, typename iterator_traits<BidirectionalIterator>::value_type const* rhs); template <class BidirectionalIterator> bool operator <= (const sub_match<BidirectionalIterator>& lhs, typename iterator_traits<BidirectionalIterator>::value_type const* rhs); // // comparisons to a single character: // template <class BidirectionalIterator> bool operator == (typename iterator_traits<BidirectionalIterator>::value_type const& lhs, const sub_match<BidirectionalIterator>& rhs); template <class BidirectionalIterator> bool operator != (typename iterator_traits<BidirectionalIterator>::value_type const& lhs, const sub_match<BidirectionalIterator>& rhs); template <class BidirectionalIterator> bool operator < (typename iterator_traits<BidirectionalIterator>::value_type const& lhs, const sub_match<BidirectionalIterator>& rhs); template <class BidirectionalIterator> bool operator > (typename iterator_traits<BidirectionalIterator>::value_type const& lhs, const sub_match<BidirectionalIterator>& rhs); template <class BidirectionalIterator> bool operator >= (typename iterator_traits<BidirectionalIterator>::value_type const& lhs, const sub_match<BidirectionalIterator>& rhs); template <class BidirectionalIterator> bool operator <= (typename iterator_traits<BidirectionalIterator>::value_type const& lhs, const sub_match<BidirectionalIterator>& rhs); template <class BidirectionalIterator> bool operator == (const sub_match<BidirectionalIterator>& lhs, typename iterator_traits<BidirectionalIterator>::value_type const& rhs); template <class BidirectionalIterator> bool operator != (const sub_match<BidirectionalIterator>& lhs, typename iterator_traits<BidirectionalIterator>::value_type const& rhs);
78
Boost.Regex
template <class BidirectionalIterator> bool operator < (const sub_match<BidirectionalIterator>& lhs, typename iterator_traits<BidirectionalIterator>::value_type const& rhs); template <class BidirectionalIterator> bool operator > (const sub_match<BidirectionalIterator>& lhs, typename iterator_traits<BidirectionalIterator>::value_type const& rhs); template <class BidirectionalIterator> bool operator >= (const sub_match<BidirectionalIterator>& lhs, typename iterator_traits<BidirectionalIterator>::value_type const& rhs); template <class BidirectionalIterator> bool operator <= (const sub_match<BidirectionalIterator>& lhs, typename iterator_traits<BidirectionalIterator>::value_type const& rhs); // // addition operators: // template <class BidirectionalIterator, class traits, class Allocator> std::basic_string<typename iterator_traits<BidirectionalIterator>::value_type, traits, Allocator> operator + (const std::basic_string<typename iterator_traits<BidirectionalIterator>::value_type, traits, Allocator>& s, const sub_match<BidirectionalIterator>& m); template <class BidirectionalIterator, class traits, class Allocator> std::basic_string<typename iterator_traits<BidirectionalIterator>::value_type, traits, Allocator> operator + (const sub_match<BidirectionalIterator>& m, const std::basic_string<typename iterator_traits<BidirectionalIterator>::value_type, traits, Allocator>& s); template <class BidirectionalIterator> std::basic_string<typename iterator_traits<BidirectionalIterator>::value_type> operator + (typename iterator_traits<BidirectionalIterator>::value_type const* s, const sub_match<BidirectionalIterator>& m); template <class BidirectionalIterator> std::basic_string<typename iterator_traits<BidirectionalIterator>::value_type> operator + (const sub_match<BidirectionalIterator>& m, typename iterator_traits<BidirectionalIterator>::value_type const * s); template <class BidirectionalIterator> std::basic_string<typename iterator_traits<BidirectionalIterator>::value_type> operator + (typename iterator_traits<BidirectionalIterator>::value_type const& s, const sub_match<BidirectionalIterator>& m); template <class BidirectionalIterator> std::basic_string<typename iterator_traits<BidirectionalIterator>::value_type> operator + (const sub_match<BidirectionalIterator>& m, typename iterator_traits<BidirectionalIterator>::value_type const& s); template <class BidirectionalIterator> std::basic_string<typename iterator_traits<BidirectionalIterator>::value_type> operator + (const sub_match<BidirectionalIterator>& m1, const sub_match<BidirectionalIterator>& m2); // // stream inserter: // template <class charT, class traits, class BidirectionalIterator> basic_ostream<charT, traits>& operator << (basic_ostream<charT, traits>& os, const sub_match<BidirectionalIterator>& m); } // namespace boost
79
Boost.Regex
Description
Members
typedef typename std::iterator_traits<iterator>::value_type value_type;
The type pointed to by the iterators.

typedef typename std::iterator_traits<iterator>::difference_type difference_type;
A type that represents the difference between two iterators.

typedef BidirectionalIterator iterator;
The iterator type.

iterator first
An iterator denoting the position of the start of the match.

iterator second
An iterator denoting the position of the end of the match.

bool matched
A Boolean value denoting whether this sub-expression participated in the match.

static difference_type length();
Effects: returns the length of this matched sub-expression, or 0 if this sub-expression was not matched: matched ? distance(first, second) : 0).
operator basic_string<value_type>()const;
Effects: converts *this into a string: returns (matched ? basic_string<value_type>(first, second) : basic_string<value_type>()).
basic_string<value_type> str()const;
Effects: returns a string representation of *this: (matched ? basic_string<value_type>(first, second) : basic_string<value_type>()).

int compare(const sub_match& s)const;
Effects: performs a lexical comparison to s: returns str().compare(s.str()).

int compare(const basic_string<value_type>& s)const;
Effects: compares *this to the string s: returns str().compare(s).
80
Boost.Regex
int compare(const value_type* s)const;
Effects: compares *this to the null-terminated string s: returns str().compare(s).

typedef implementation-private capture_sequence_type;
Denes an implementation-specic type that satises the requirements of a standard library Sequence (21.1.1 including the optional Table 68 operations), whose value_type is a sub_match<BidirectionalIterator>. This type happens to be std::vector<sub_match<BidirectionalIterator> >, but you shouldn't actually rely on that.
const capture_sequence_type& captures()const;
Effects: returns a sequence containing all the captures obtained for this sub-expression. Preconditions: the library must be built and used with BOOST_REGEX_MATCH_EXTRA dened, and you must pass the ag match_extra to the regex matching functions ( regex_match, regex_search, regex_iterator or regex_token_iterator) in order for this member #function to be dened and return useful information. Rationale: Enabling this feature has several consequences: sub_match occupies more memory resulting in complex expressions running out of memory or stack space more quickly during matching. The matching algorithms are less efcient at handling some features (independent sub-expressions for example), even when match_extra is not used. The matching algorithms are much less efcient (i.e. slower), when match_extra is used. Mostly this is down to the extra memory allocations that have to take place. sub_match non-member operators
template <class BidirectionalIterator> bool operator == (const sub_match<BidirectionalIterator>& lhs, const sub_match<BidirectionalIterator>& rhs);
Effects: returns lhs.compare(rhs) == 0.

template <class BidirectionalIterator> bool operator != (const sub_match<BidirectionalIterator>& lhs, const sub_match<BidirectionalIterator>& rhs);
Effects: returns lhs.compare(rhs) != 0.

template <class BidirectionalIterator> bool operator < (const sub_match<BidirectionalIterator>& lhs, const sub_match<BidirectionalIterator>& rhs);
Effects: returns lhs.compare(rhs) < 0.

template <class BidirectionalIterator> bool operator <= (const sub_match<BidirectionalIterator>& lhs, const sub_match<BidirectionalIterator>& rhs);
Effects: returns lhs.compare(rhs) <= 0.
81
Boost.Regex
template <class BidirectionalIterator> bool operator >= (const sub_match<BidirectionalIterator>& lhs, const sub_match<BidirectionalIterator>& rhs);
Effects: returns lhs.compare(rhs) >= 0.

template <class BidirectionalIterator> bool operator > (const sub_match<BidirectionalIterator>& lhs, const sub_match<BidirectionalIterator>& rhs);
Effects: returns lhs.compare(rhs) > 0.

template <class BidirectionalIterator, class traits, class Allocator> bool operator == (const std::basic_string<iterator_traits<BidirectionalIterator>::value_type, traits, Allocator>& lhs, const sub_match<BidirectionalIterator>& rhs);
Effects: returns lhs == rhs.str().

template <class BidirectionalIterator, class traits, class Allocator> bool operator != (const std::basic_string<iterator_traits<BidirectionalIterator>::value_type, traits, Allocator>& lhs, const sub_match<BidirectionalIterator>& rhs);
Effects: returns lhs != rhs.str().

template <class BidirectionalIterator, class traits, class Allocator> bool operator < (const std::basic_string<iterator_traits<BidirectionalIterator>::value_type, traits, Allocator>& lhs, const sub_match<BidirectionalIterator>& rhs);
Effects: returns lhs < rhs.str().

template <class BidirectionalIterator, class traits, class Allocator> bool operator > (const std::basic_string<iterator_traits<BidirectionalIterator>::value_type, traits, Allocator>& lhs, const sub_match<BidirectionalIterator>& rhs);
Effects: returns lhs > rhs.str().

template <class BidirectionalIterator, class traits, class Allocator> bool operator >= (const std::basic_string<iterator_traits<BidirectionalIterator>::value_type, traits, Allocator>& lhs, const sub_match<BidirectionalIterator>& rhs);
Effects: returns lhs >= rhs.str().
82
Boost.Regex
template <class BidirectionalIterator, class traits, class Allocator> bool operator <= (const std::basic_string<iterator_traits<BidirectionalIterator>::value_type, traits, Allocator>& lhs, const sub_match<BidirectionalIterator>& rhs);
Effects: returns lhs <= rhs.str().

template <class BidirectionalIterator, class traits, class Allocator> bool operator == (const sub_match<BidirectionalIterator>& lhs, const std::basic_string<iterator_traits<BidirectionalIterator>::value_type, traits, Allocator>& rhs);
Effects: returns lhs.str() == rhs.

template <class BidirectionalIterator, class traits, class Allocator> bool operator != (const sub_match<BidirectionalIterator>& lhs, const std::basic_string<iterator_traits<BidirectionalIterator>::value_type, traits, Allocator>& rhs);
Effects: returns lhs.str() != rhs.

template <class BidirectionalIterator, class traits, class Allocator> bool operator < (const sub_match<BidirectionalIterator>& lhs, const std::basic_string<iterator_traits<BidirectionalIterator>::value_type, traits, Allocator>& rhs);
Effects: returns lhs.str() < rhs.

template <class BidirectionalIterator, class traits, class Allocator> bool operator > (const sub_match<BidirectionalIterator>& lhs, const std::basic_string<iterator_traits<BidirectionalIterator>::value_type, traits, Allocator>& rhs);
Effects: returns lhs.str() > rhs.

template <class BidirectionalIterator, class traits, class Allocator> bool operator >= (const sub_match<BidirectionalIterator>& lhs, const std::basic_string<iterator_traits<BidirectionalIterator>::value_type, traits, Allocator>& rhs);
Effects: returns lhs.str() >= rhs.

template <class BidirectionalIterator, class traits, class Allocator> bool operator <= (const sub_match<BidirectionalIterator>& lhs, const std::basic_string<iterator_traits<BidirectionalIterator>::value_type, traits, Allocator>& rhs);
Effects: returns lhs.str() <= rhs.
83
Boost.Regex
template <class BidirectionalIterator> bool operator == (typename iterator_traits<BidirectionalIterator>::value_type const* lhs, const sub_match<BidirectionalIterator>& rhs);

template <class BidirectionalIterator> bool operator != (typename iterator_traits<BidirectionalIterator>::value_type const* lhs, const sub_match<BidirectionalIterator>& rhs);

template <class BidirectionalIterator> bool operator < (typename iterator_traits<BidirectionalIterator>::value_type const* lhs, const sub_match<BidirectionalIterator>& rhs);

template <class BidirectionalIterator> bool operator > (typename iterator_traits<BidirectionalIterator>::value_type const* lhs, const sub_match<BidirectionalIterator>& rhs);

template <class BidirectionalIterator> bool operator >= (typename iterator_traits<BidirectionalIterator>::value_type const* lhs, const sub_match<BidirectionalIterator>& rhs);

template <class BidirectionalIterator> bool operator <= (typename iterator_traits<BidirectionalIterator>::value_type const* lhs, const sub_match<BidirectionalIterator>& rhs);

template <class BidirectionalIterator> bool operator == (const sub_match<BidirectionalIterator>& lhs, typename iterator_traits<BidirectionalIterator>::value_type const* rhs);

template <class BidirectionalIterator> bool operator != (const sub_match<BidirectionalIterator>& lhs, typename iterator_traits<BidirectionalIterator>::value_type const* rhs);

template <class BidirectionalIterator> bool operator < (const sub_match<BidirectionalIterator>& lhs, typename iterator_traits<BidirectionalIterator>::value_type const* rhs);
84
Boost.Regex
template <class BidirectionalIterator> bool operator > (const sub_match<BidirectionalIterator>& lhs, typename iterator_traits<BidirectionalIterator>::value_type const* rhs);

template <class BidirectionalIterator> bool operator >= (const sub_match<BidirectionalIterator>& lhs, typename iterator_traits<BidirectionalIterator>::value_type const* rhs);

template <class BidirectionalIterator> bool operator <= (const sub_match<BidirectionalIterator>& lhs, typename iterator_traits<BidirectionalIterator>::value_type const* rhs);
Effects: returns lhs.str() <= rhs.

template <class BidirectionalIterator> bool operator == (typename iterator_traits<BidirectionalIterator>::value_type const& lhs, const sub_match<BidirectionalIterator>& rhs);

template <class BidirectionalIterator> bool operator != (typename iterator_traits<BidirectionalIterator>::value_type const& lhs, const sub_match<BidirectionalIterator>& rhs);

template <class BidirectionalIterator> bool operator < (typename iterator_traits<BidirectionalIterator>::value_type const& lhs, const sub_match<BidirectionalIterator>& rhs);

template <class BidirectionalIterator> bool operator > (typename iterator_traits<BidirectionalIterator>::value_type const& lhs, const sub_match<BidirectionalIterator>& rhs);

template <class BidirectionalIterator> bool operator >= (typename iterator_traits<BidirectionalIterator>::value_type const& lhs, const sub_match<BidirectionalIterator>& rhs);

template <class BidirectionalIterator> bool operator <= (typename iterator_traits<BidirectionalIterator>::value_type const& lhs, const sub_match<BidirectionalIterator>& rhs);
85
Boost.Regex
template <class BidirectionalIterator> bool operator == (const sub_match<BidirectionalIterator>& lhs, typename iterator_traits<BidirectionalIterator>::value_type const& rhs);

template <class BidirectionalIterator> bool operator != (const sub_match<BidirectionalIterator>& lhs, typename iterator_traits<BidirectionalIterator>::value_type const& rhs);

template <class BidirectionalIterator> bool operator < (const sub_match<BidirectionalIterator>& lhs, typename iterator_traits<BidirectionalIterator>::value_type const& rhs);

template <class BidirectionalIterator> bool operator > (const sub_match<BidirectionalIterator>& lhs, typename iterator_traits<BidirectionalIterator>::value_type const& rhs);

template <class BidirectionalIterator> bool operator >= (const sub_match<BidirectionalIterator>& lhs, typename iterator_traits<BidirectionalIterator>::value_type const& rhs);

template <class BidirectionalIterator> bool operator <= (const sub_match<BidirectionalIterator>& lhs, typename iterator_traits<BidirectionalIterator>::value_type const& rhs);
Effects: returns lhs.str() <= rhs. The addition operators for sub_match allow you to add a sub_match to any type to which you can add a std::string and obtain a new string as the result.
template <class BidirectionalIterator, class traits, class Allocator> std::basic_string<typename iterator_traits<BidirectionalIterator>::value_type, traits, Allocator> operator + (const std::basic_string<typename iterator_traits<BidirectionalIterator>::value_type, traits, Allocator>& s, const sub_match<BidirectionalIterator>& m);
Effects: returns s + m.str().

template <class BidirectionalIterator, class traits, class Allocator> std::basic_string<typename iterator_traits<BidirectionalIterator>::value_type, traits, Allocator> operator + (const sub_match<BidirectionalIterator>& m, const std::basic_string<typename iterator_traits<BidirectionalIterator>::value_type, traits, Allocator>& s);
Effects: returns m.str() + s.
86
Boost.Regex
template <class BidirectionalIterator> std::basic_string<typename iterator_traits<BidirectionalIterator>::value_type> operator + (typename iterator_traits<BidirectionalIterator>::value_type const* s, const sub_match<BidirectionalIterator>& m);

template <class BidirectionalIterator> std::basic_string<typename iterator_traits<BidirectionalIterator>::value_type> operator + (const sub_match<BidirectionalIterator>& m, typename iterator_traits<BidirectionalIterator>::value_type const * s);

template <class BidirectionalIterator> std::basic_string<typename iterator_traits<BidirectionalIterator>::value_type> operator + (typename iterator_traits<BidirectionalIterator>::value_type const& s, const sub_match<BidirectionalIterator>& m);

template <class BidirectionalIterator> std::basic_string<typename iterator_traits<BidirectionalIterator>::value_type> operator + (const sub_match<BidirectionalIterator>& m, typename iterator_traits<BidirectionalIterator>::value_type const& s);

template <class BidirectionalIterator> std::basic_string<typename iterator_traits<BidirectionalIterator>::value_type> operator + (const sub_match<BidirectionalIterator>& m1, const sub_match<BidirectionalIterator>& m2);
Effects: returns m1.str() + m2.str(). Stream inserter

template <class charT, class traits, class BidirectionalIterator> basic_ostream<charT, traits>& operator << (basic_ostream<charT, traits>& os const sub_match<BidirectionalIterator>& m);
Effects: returns (os << m.str()).
regex_match
The algorithm regex_match determines whether a given regular expression matches all of a given character sequence denoted by a pair of bidirectional-iterators, the algorithm is dened as follows, the main use of this function is data input validation.
87
Boost.Regex
Important
Note that the result is true only if the expression matches the whole of the input sequence. If you want to search for an expression somewhere within the sequence then use regex_search. If you want to match a prex of the character string then use regex_search with the ag match_continuous set.
template <class BidirectionalIterator, class Allocator, class charT, class traits> bool regex_match(BidirectionalIterator first, BidirectionalIterator last, match_results<BidirectionalIterator, Allocator>& m, const basic_regex <charT, traits>& e, match_flag_type flags = match_default); template <class BidirectionalIterator, class charT, class traits> bool regex_match(BidirectionalIterator first, BidirectionalIterator last, const basic_regex <charT, traits>& e, match_flag_type flags = match_default); template <class charT, class Allocator, class traits> bool regex_match(const charT* str, match_results<const charT*, Allocator>& m, const basic_regex <charT, traits>& e, match_flag_type flags = match_default); template <class ST, class SA, class Allocator, class charT, class traits> bool regex_match(const basic_string<charT, ST, SA>& s, match_results<typename basic_string<charT, ST, SA>::const_iterator, Allocator>& m, const basic_regex <charT, traits>& e, match_flag_type flags = match_default); template <class charT, class traits> bool regex_match(const charT* str, const basic_regex <charT, traits>& e, match_flag_type flags = match_default); template <class ST, class SA, class charT, class traits> bool regex_match(const basic_string<charT, ST, SA>& s, const basic_regex <charT, traits>& e, match_flag_type flags = match_default);
Description
template <class BidirectionalIterator, class Allocator, class charT, class traits> bool regex_match(BidirectionalIterator first, BidirectionalIterator last, match_results<BidirectionalIterator, Allocator>& m, const basic_regex <charT, traits>& e, match_flag_type flags = match_default);
Requires: Type BidirectionalIterator meets the requirements of a Bidirectional Iterator (24.1.4). Effects: Determines whether there is an exact match between the regular expression e, and all of the character sequence [rst, last), parameter ags (see match_flag_type) is used to control how the expression is matched against the character sequence. Returns true if such a match exists, false otherwise. Throws: std::runtime_error if the complexity of matching the expression against an N character string begins to exceed O(N2), or if the program runs out of stack space while matching the expression (if Boost.Regex is congured in recursive mode), or if the matcher exhausts its permitted memory allocation (if Boost.Regex is congured in non-recursive mode). Postconditions: If the function returns false, then the effect on parameter m is undened, otherwise the effects on parameter m are given in the table:
88
Boost.Regex
Element
m.size() m.empty() m.prefix().first m.prefix().last m.prefix().matched m.suffix().first m.suffix().last m.suffix().matched m[0].first m[0].second m[0].matched
Value
e.mark_count() false first first false last last false first last
true if a full match was found, and false if it was a partial match (found as a result of the match_partial ag being set). For all integers n < m.size(), the start of the sequence that matched sub-expression n. Alternatively, if sub-expression n did not participate in the match, then last. For all integers n < m.size(), the end of the sequence that matched sub-expression n. Alternatively, if sub-expression n did not participate in the match, then last. For all integers n < m.size(), true if sub-expression n participated in the match, false otherwise.
m[n].first
m[n].second
m[n].matched
template <class BidirectionalIterator, class charT, class traits> bool regex_match(BidirectionalIterator first, BidirectionalIterator last, const basic_regex <charT, traits>& e, match_flag_type flags = match_default);
Effects: Behaves "as if" by constructing an instance of match_results<BidirectionalIterator> what, and then returning the result of regex_match(first, last, what, e, flags).
template <class charT, class Allocator, class traits> bool regex_match(const charT* str, match_results<const charT*, Allocator>& m, const basic_regex <charT, traits>& e, match_flag_type flags = match_default);
Effects: Returns the result of regex_match(str, str + char_traits<charT>::length(str), m, e, flags).
89
Boost.Regex
template <class ST, class SA, class Allocator, class charT, class traits> bool regex_match(const basic_string<charT, ST, SA>& s, match_results<typename basic_string<charT, ST, SA>::const_iterator, Allocator>& m, const basic_regex <charT, traits>& e, match_flag_type flags = match_default);
Effects: Returns the result of regex_match(s.begin(), s.end(), m, e, flags).

template <class charT, class traits> bool regex_match(const charT* str, const basic_regex <charT, traits>& e, match_flag_type flags = match_default);
Effects: Returns the result of regex_match(str, str + char_traits<charT>::length(str), e, flags).

template <class ST, class SA, class charT, class traits> bool regex_match(const basic_string<charT, ST, SA>& s, const basic_regex <charT, traits>& e, match_flag_type flags = match_default);
Effects: Returns the result of regex_match(s.begin(), s.end(), e, flags).
Examples
The following example processes an ftp response:
#include #include #include #include <stdlib.h> <boost/regex.hpp> <string> <iostream>
using namespace boost; regex expression("([0-9]+)(\\-| |$)(.*)"); // process_ftp: // on success returns the ftp response code, and fills // msg with the ftp response message. int process_ftp(const char* response, std::string* msg) { cmatch what; if(regex_match(response, what, expression)) { // what[0] contains the whole string // what[1] contains the response code // what[2] contains the separator character // what[3] contains the text message. if(msg) msg->assign(what[3].first, what[3].second); return std::atoi(what[1].first); } // failure did not match if(msg) msg->erase(); return -1; }
90
Boost.Regex
regex_search
The algorithm regex_search will search a range denoted by a pair of bidirectional-iterators for a given regular expression. The algorithm uses various heuristics to reduce the search time by only checking for a match if a match could conceivably start at that position. The algorithm is dened as follows:
template <class BidirectionalIterator, class Allocator, class charT, class traits> bool regex_search(BidirectionalIterator first, BidirectionalIterator last, match_results<BidirectionalIterator, Allocator>& m, const basic_regex<charT, traits>& e, match_flag_type flags = match_default); template <class ST, class SA, class Allocator, class charT, class traits> bool regex_search(const basic_string<charT, ST, SA>& s, match_results< typename basic_string<charT, ST,SA>::const_iterator, Allocator>& m, const basic_regex<charT, traits>& e, match_flag_type flags = match_default); template<class charT, class Allocator, class traits> bool regex_search(const charT* str, match_results<const charT*, Allocator>& m, const basic_regex<charT, traits>& e, match_flag_type flags = match_default); template <class BidirectionalIterator, class charT, class traits> bool regex_search(BidirectionalIterator first, BidirectionalIterator last, const basic_regex<charT, traits>& e, match_flag_type flags = match_default); template <class charT, class traits> bool regex_search(const charT* str, const basic_regex<charT, traits>& e, match_flag_type flags = match_default); template<class ST, class SA, class charT, class traits> bool regex_search(const basic_string<charT, ST, SA>& s, const basic_regex<charT, traits>& e, match_flag_type flags = match_default);
Description
template <class BidirectionalIterator, class Allocator, class charT, class traits> bool regex_search(BidirectionalIterator first, BidirectionalIterator last, match_results<BidirectionalIterator, Allocator>& m, const basic_regex<charT, traits>& e, match_flag_type flags = match_default);
Requires: Type BidirectionalIterator meets the requirements of a Bidirectional Iterator (24.1.4). Effects: Determines whether there is some sub-sequence within [rst,last) that matches the regular expression e, parameter ags is used to control how the expression is matched against the character sequence. Returns true if such a sequence exists, false otherwise.
91
Boost.Regex Throws: std::runtime_error if the complexity of matching the expression against an N character string begins to exceed O(N2), or if the program runs out of stack space while matching the expression (if Boost.Regex is congured in recursive mode), or if the matcher exhausts its permitted memory allocation (if Boost.Regex is congured in non-recursive mode). Postconditions: If the function returns false, then the effect on parameter m is undened, otherwise the effects on parameter m are given in the table: Element
m.size() m.empty() m.prefix().first m.prefix().last m.prefix().matched m.suffix().first m.suffix().last m.suffix().matched m[0].first
Value
e.mark_count() false first m[0].first m.prefix().first != m.prefix().second m[0].second last m.suffix().first != m.suffix().second
The start of the sequence of characters that matched the regular expression The end of the sequence of characters that matched the regular expression true if a full match was found, and false if it was a partial match (found as a result of the match_partial ag being set). For all integers n < m.size(), the start of the sequence that matched sub-expression n. Alternatively, if sub-expression n did not participate in the match, then last. For all integers n < m.size(), the end of the sequence that matched sub-expression n. Alternatively, if sub-expression n did not participate in the match, then last. For all integers n < m.size(), true if sub-expression n participated in the match, false otherwise.
m[0].second
m[0].matched
m[n].first
m[n].second
m[n].matched
template <class charT, class Allocator, class traits> bool regex_search(const charT* str, match_results<const charT*, Allocator>& m, const basic_regex<charT, traits>& e, match_flag_type flags = match_default);
Effects: Returns the result of regex_search(str, str + char_traits<charT>::length(str), m, e, flags).
92
Boost.Regex
template <class ST, class SA, class Allocator, class charT, class traits> bool regex_search(const basic_string<charT, ST, SA>& s, match_results<typename basic_string<charT, ST, SA>::const_iterator, Allocat or>& m, const basic_regex<charT, traits>& e, match_flag_type flags = match_default);
Effects: Returns the result of regex_search(s.begin(), s.end(), m, e, flags).

template <class iterator, class charT, class traits> bool regex_search(iterator first, iterator last, const basic_regex<charT, traits>& e, match_flag_type flags = match_default);
Effects: Behaves "as if" by constructing an instance of match_results<BidirectionalIterator> what, and then returning the result of regex_search(first, last, what, e, flags).
template <class charT, class traits> bool regex_search(const charT* str const basic_regex<charT, traits>& e, match_flag_type flags = match_default);
Effects: Returns the result of regex_search(str, str + char_traits<charT>::length(str), e, flags).

template <class ST, class SA, class charT, class traits> bool regex_search(const basic_string<charT, ST, SA>& s, const basic_regex<charT, traits>& e, match_flag_type flags = match_default);
Effects: Returns the result of regex_search(s.begin(), s.end(), e, flags).
Examples
The following example, takes the contents of a le in the form of a string, and searches for all the C++ class declarations in the le. The code will work regardless of the way that std::string is implemented, for example it could easily be modied to work with the SGI rope class, which uses a non-contiguous storage strategy.
93
Boost.Regex
#include <string> #include <map> #include <boost/regex.hpp> // purpose: // takes the contents of a file in the form of a string // and searches for all the C++ class definitions, storing // their locations in a map of strings/int's typedef std::map<std::string, int, std::less<std::string> > map_type; boost::regex expression( "^(template[[:space:]]*<[^;:{]+>[[:space:]]*)?" "(class|struct)[[:space:]]*" "(\\<\\w+\\>([[:blank:]]*\$[^)]*\$)?" "[[:space:]]*)*(\\<\\w*\\>)[[:space:]]*" "(<[^;:{]+>[[:space:]]*)?(\\{|:[^;\\{()]*\\{)"); void IndexClasses(map_type& m, const std::string& file) { std::string::const_iterator start, end; start = file.begin(); end = file.end(); boost::match_results<std::string::const_iterator> what; boost::match_flag_type flags = boost::match_default; while(regex_search(start, end, what, expression, flags)) { // what[0] contains the whole string // what[5] contains the class name. // what[6] contains the template specialisation if any. // add class name and position to map: m[std::string(what[5].first, what[5].second) + std::string(what[6].first, what[6].second)] = what[5].first - file.begin(); // update search position: start = what[0].second; // update flags: flags |= boost::match_prev_avail; flags |= boost::match_not_bob; } }
regex_replace
The algorithm regex_replace searches through a string nding all the matches to the regular expression: for each match it then calls match_results<>::format to format the string and sends the result to the output iterator. Sections of text that do not match are copied to the output unchanged only if the ags parameter does not have the ag format_no_copy set. If the ag format_first_only is set then only the rst occurrence is replaced rather than all occurrences.
94
Boost.Regex
template <class OutputIterator, class BidirectionalIterator, class traits, class Formatter> OutputIterator regex_replace(OutputIterator out, BidirectionalIterator first, BidirectionalIterator last, const basic_regex<charT, traits>& e, Formatter fmt, match_flag_type flags = match_default); template <class traits, class Formatter> basic_string<charT> regex_replace(const basic_string<charT>& s, const basic_regex<charT, traits>& e, Formatter fmt, match_flag_type flags = match_default);
Description
template <class OutputIterator, class BidirectionalIterator, class traits, class Formatter> OutputIterator regex_replace(OutputIterator out, BidirectionalIterator first, BidirectionalIterator last, const basic_regex<charT, traits>& e, Formatter fmt, match_flag_type flags = match_default);
Enumerates all the occurences of expression e in the sequence [rst, last), replacing each occurence with the string that results by merging the match found with the format string fmt, and copies the resulting string to out. In the case that fmt is a unary, binary or ternary function object, then the character sequence generated by that object is copied unchanged to the output when performing a substitution. If the ag format_no_copy is set in ags then unmatched sections of text are not copied to output. If the ag format_first_only is set in ags then only the rst occurence of e is replaced. The manner in which the format string fmt is interpretted, along with the rules used for nding matches, are determined by the ags set in ags: see match_flag_type. Requires The type Formatter must be either a pointer to a null-terminated string of type char_type[], or be a container of char_type's (for example std::basic_string<char_type>) or be a unary, binary or ternary functor that computes the replacement string from a function call: either fmt(what) which must return a container of char_type's to be used as the replacement text, or either fmt(what, out) or fmt(what, out, flags), both of which write the replacement text to *out, and then return the new OutputIterator position. In each case what is the match_results object that represents the match found. Note that if the formatter is a functor, then it is passed by value: users that want to pass function objects with internal state might want to use Boost.Ref to wrap the object so that it's passed by reference. Effects: Constructs an regex_iterator object:
regex_iterator<BidirectionalIterator, charT, traits, Allocator> i(first, last, e, flags),
and uses i to enumerate through all of the matches m of type match_results <BidirectionalIterator> that occur within the sequence [rst, last). If no such matches are found and
!(flags & format_no_copy)
then calls
95
Boost.Regex
std::copy(first, last, out).
Otherwise, for each match found, if

calls
std::copy(m.prefix().first, m.prefix().last, out),
and then calls

m.format(out, fmt, flags).
Finally if
calls
std::copy(last_m.suffix().first, last_m,suffix().last, out)
where last_m is a copy of the last match found. If flags & format_first_only is non-zero then only the rst match found is replaced. Throws: std::runtime_error if the complexity of matching the expression against an N character string begins to exceed O(N2), or if the program runs out of stack space while matching the expression (if Boost.Regex is congured in recursive mode), or if the matcher exhausts its permitted memory allocation (if Boost.Regex is congured in non-recursive mode). Returns: out.
template <class traits, class Formatter> basic_string<charT> regex_replace(const basic_string<charT>& s, const basic_regex<charT, traits>& e, Formatter fmt, match_flag_type flags = match_default);
Requires The type Formatter must be either a pointer to a null-terminated string of type char_type[], or be a container of char_type's (for example std::basic_string<char_type>) or be a unary, binary or ternary functor that computes the replacement string from a function call: either fmt(what) which must return a container of char_type's to be used as the replacement text, or either fmt(what, out) or fmt(what, out, flags), both of which write the replacement text to *out, and then return the new OutputIterator position. In each case what is the match_results object that represents the match found. Effects: Constructs an object basic_string<charT> result, calls regex_replace(back_inserter(result), s.begin(), s.end(), e, fmt, flags), and then returns result.
Examples
The following example takes C/C++ source code as input, and outputs syntax highlighted HTML code.
96
Boost.Regex
#include #include #include #include #include #include #include
<fstream> <sstream> <string> <iterator> <boost/regex.hpp> <fstream> <iostream>
// purpose: // takes the contents of a file and transform to // syntax highlighted code in html format boost::regex extern const extern const extern const extern const extern const extern const e1, e2; char* expression_text; char* format_string; char* pre_expression; char* pre_format; char* header_text; char* footer_text;
void load_file(std::string& s, std::istream& is) { s.erase(); s.reserve(is.rdbuf()->in_avail()); char c; while(is.get(c)) { if(s.capacity() == s.size()) s.reserve(s.capacity() * 3); s.append(1, c); } } int main(int argc, const char** argv) { try{ e1.assign(expression_text); e2.assign(pre_expression); for(int i = 1; i < argc; ++i) { std::cout << "Processing file " << argv[i] << std::endl; std::ifstream fs(argv[i]); std::string in; load_file(in, fs); std::string out_name(std::string(argv[i]) + std::string(".htm")); std::ofstream os(out_name.c_str()); os << header_text; // strip '<' and '>' first by outputting to a // temporary string stream std::ostringstream t(std::ios::out | std::ios::binary); std::ostream_iterator<char, char> oi(t); boost::regex_replace(oi, in.begin(), in.end(), e2, pre_format, boost::match_default | boost::format_all); // then output to final output stream // adding syntax highlighting: std::string s(t.str()); std::ostream_iterator<char, char> out(os); boost::regex_replace(out, s.begin(), s.end(), e1, format_string, boost::match_default | boost::format_all); os << footer_text; } } catch(...)
97
Boost.Regex
{ return -1; } return 0; } extern const char* pre_expression = "(<)|(>)|(&)|\\r"; extern const char* pre_format = "(?1<)(?2>)(?3&)";
const char* expression_text = // preprocessor directives: index 1 "(^[[:blank:]]*#(?:[^\\\\\\n]|\\\\[^\\n[:punct:][:word:]]*[\\n[:punct:][:word:]])*)|" // comment: index 2 "(//[^\\n]*|/\\*.*?\\*/)|" // literals: index 3 "\\<([+-]?(?:(?:0x[[:xdigit:]]+)|(?:(?:[[:digit:]]*\\.)?[[:digit:]]+" "(?:[eE][+-]?[[:digit:]]+)?))u?(?:(?:int(?:8|16|32|64))|L)?)\\>|" // string literals: index 4 "('(?:[^\\\\']|\\\\.)*'|\"(?:[^\\\\\"]|\\\\.)*\")|" // keywords: index 5 "\\<(__asm|__cdecl|__declspec|__export|__far16|__fastcall|__fortran|__import" "|__pascal|__rtti|__stdcall|_asm|_cdecl|__except|_export|_far16|_fastcall" "|__finally|_fortran|_import|_pascal|_stdcall|__thread|__try|asm|auto|bool" "|break|case|catch|cdecl|char|class|const|const_cast|continue|default|delete" "|do|double|dynamic_cast|else|enum|explicit|extern|false|float|for|friend|goto" "|if|inline|int|long|mutable|namespace|new|operator|pascal|private|protected" "|public|register|reinterpret_cast|return|short|signed|sizeof|static|static_cast" "|struct|switch|template|this|throw|true|try|typedef|typeid|typename|union|unsigned" "|using|virtual|void|volatile|wchar_t|while)\\>" ; const char* format_string = "(?1$&)" "(?2$&)" "(?3$&)" "(?4$&)" "(?5$&)"; const char* header_text = "<HTML>\n<HEAD>\n" "<TITLE>Auto-generated html formated source</TITLE>\n" "<META HTTP-EQUIV=\"Content-Type\" CONTENT=\"text/html; charset=windows-1252\">\n" "</HEAD>\n" "<BODY LINK=\"#0000ff\" VLINK=\"#800080\" BGCOLOR=\"#ffffff\">\n" " \n<PRE>"; const char* footer_text = "</PRE>\n</BODY>\n\n";
regex_iterator
The iterator type regex_iterator will enumerate all of the regular expression matches found in some sequence: dereferencing a regex_iterator yields a reference to a match_results object.
98
Boost.Regex
template <class BidirectionalIterator, class charT = iterator_traits<BidirectionalIterator>::value_type, class traits = regex_traits<charT> > class regex_iterator { public: typedef basic_regex<charT, traits> typedef match_results<BidirectionalIterator> typedef typename iterator_traits<BidirectionalIterator>::difference_type typedef const value_type* typedef const value_type& typedef std::forward_iterator_tag regex_iterator(); regex_iterator(BidirectionalIterator a, BidirectionalIterator b, const regex_type& re, match_flag_type m = match_default); regex_iterator(const regex_iterator&); regex_iterator& operator=(const regex_iterator&); bool operator==(const regex_iterator&)const; bool operator!=(const regex_iterator&)const; const value_type& operator*()const; const value_type* operator->()const; regex_iterator& operator++(); regex_iterator operator++(int); }; typedef regex_iterator<const char*> typedef regex_iterator<std::string::const_iterator> cregex_iterator; sregex_iterator;
regex_type; value_type; difference_type; pointer; reference; iterator_category;
#ifndef BOOST_NO_WREGEX typedef regex_iterator<const wchar_t*> wcregex_iterator; typedef regex_iterator<std::wstring::const_iterator> wsregex_iterator; #endif template <class charT, class traits> regex_iterator<const charT*, charT, traits> make_regex_iterator(const charT* p, const basic_regex<charT, traits>& e, regex_constants::match_flag_type m = regex_constants::match_default); template <class charT, class traits, class ST, class SA> regex_iterator<typename std::basic_string<charT, ST, SA>::const_iterator, charT, traits> make_regex_iterator(const std::basic_string<charT, ST, SA>& p, const basic_regex<charT, traits>& e, regex_constants::match_flag_type m = regex_constants::match_default);
Description
A regex_iterator is constructed from a pair of iterators, and enumerates all occurrences of a regular expression within that iterator range.
regex_iterator();
Effects: constructs an end of sequence regex_iterator.

regex_iterator(BidirectionalIterator a, BidirectionalIterator b, const regex_type& re, match_flag_type m = match_default);
99
Boost.Regex
Effects: constructs a regex_iterator that will enumerate all occurrences of the expression re, within the sequence [a,b), and found using match_flag_type m. The object re must exist for the lifetime of the regex_iterator. Throws: std::runtime_error if the complexity of matching the expression against an N character string begins to exceed O(N2), or if the program runs out of stack space while matching the expression (if Boost.Regex is congured in recursive mode), or if the matcher exhausts its permitted memory allocation (if Boost.Regex is congured in non-recursive mode).
regex_iterator(const regex_iterator& that);
Effects: constructs a copy of that. Postconditions: *this == that.

regex_iterator& operator=(const regex_iterator&);
Effects: sets *this equal to those in that. Postconditions: *this == that.

bool operator==(const regex_iterator& that)const;
Effects: returns true if *this is equal to that.

bool operator!=(const regex_iterator&)const;
Effects: returns !(*this == that).

const value_type& operator*()const;
Effects: dereferencing a regex_iterator object it yields a const reference to a match_results object, whose members are set as follows:
100
Boost.Regex
Element
(*it).size() (*it).empty() (*it).prefix().first
Value
re.mark_count() false
The end of the last match found, or the start of the underlying sequence if this is the rst match enumerated The same as the start of the match found: (*it)[0].first True if the prex did not match an empty string: (*it).prefix().first != (*it).prefix().second
(*it).prefix().last (*it).prefix().matched
(*it).suffix().first (*it).suffix().last (*it).suffix().matched
The same as the end of the match found: (*it)[0].second The end of the underlying sequence. True if the sufx did not match an empty string: (*it).suffix().first != (*it).suffix().second
(*it)[0].first
The start of the sequence of characters that matched the regular expression The end of the sequence of characters that matched the regular expression true if a full match was found, and false if it was a partial match (found as a result of the match_partial ag being set). For all integers n < (*it).size(), the start of the sequence that matched sub-expression n. Alternatively, if sub-expression n did not participate in the match, then last. For all integers n < (*it).size(), the end of the sequence that matched sub-expression n. Alternatively, if sub-expression n did not participate in the match, then last. For all integers n < (*it).size(), true if sub-expression n participated in the match, false otherwise. For all integers n < (*it).size(), then the distance from the start of the underlying sequence to the start of sub-expression match n.
(*it)[0].second
(*it)[0].matched
(*it)[n].first
(*it)[n].second
(*it)[n].matched
(*it).position(n)
const value_type* operator->()const;
Effects: returns &(*this).

regex_iterator& operator++();
Effects: moves the iterator to the next match in the underlying sequence, or the end of sequence iterator if none if found. When the last match found matched a zero length string, then the regex_iterator will nd the next match as follows: if there exists a nonzero length match that starts at the same location as the last one, then returns it, otherwise starts looking for the next (possibly zero length) match from one position to the right of the last match.
101
Boost.Regex Throws: std::runtime_error if the complexity of matching the expression against an N character string begins to exceed O(N2), or if the program runs out of stack space while matching the expression (if Boost.Regex is congured in recursive mode), or if the matcher exhausts its permitted memory allocation (if Boost.Regex is congured in non-recursive mode). Returns: *this.
regex_iterator operator++(int);
Effects: constructs a copy result of *this, then calls ++(*this). Returns: result.
template <class charT, class traits> regex_iterator<const charT*, charT, traits> make_regex_iterator(const charT* p, const basic_regex<charT, traits>& e, regex_constants::match_flag_type m = regex_constants::match_default); template <class charT, class traits, class ST, class SA> regex_iterator<typename std::basic_string<charT, ST, SA>::const_iterator, charT, traits> make_regex_iterator(const std::basic_string<charT, ST, SA>& p, const basic_regex<charT, traits>& e, regex_constants::match_flag_type m = regex_constants::match_default);
Effects: returns an iterator that enumerates all occurences of expression e in text p using match_flag_type m.
Examples
The following example takes a C++ source le and builds up an index of class names, and the location of that class in the le.
102
Boost.Regex
#include #include #include #include #include
<string> <map> <fstream> <iostream> <boost/regex.hpp>
using namespace std; // // // // purpose: takes the contents of a file in the form of a string and searches for all the C++ class definitions, storing their locations in a map of strings/int's
typedef std::map<std::string, std::string::difference_type, std::less<std::string> > map_type; const char* re = // possibly leading whitespace: "^[[:space:]]*" // possible template declaration: "(template[[:space:]]*<[^;:{]+>[[:space:]]*)?" // class or struct: "(class|struct)[[:space:]]*" // leading declspec macros etc: "(" "\\<\\w+\\>" "(" "[[:blank:]]*\$[^)]*\$" ")?" "[[:space:]]*" ")*" // the class name "(\\<\\w*\\>)[[:space:]]*" // template specialisation parameters "(<[^;:{]+>)?[[:space:]]*" // terminate in { or : "(\\{|:[^;\\{()]*\\{)";
boost::regex expression(re); map_type class_index; bool regex_callback(const boost::match_results<std::string::const_iterator>& what) { // what[0] contains the whole string // what[5] contains the class name. // what[6] contains the template specialisation if any. // add class name and position to map: class_index[what[5].str() + what[6].str()] = what.position(5); return true; } void load_file(std::string& s, std::istream& is) { s.erase(); s.reserve(is.rdbuf()->in_avail()); char c; while(is.get(c)) { if(s.capacity() == s.size()) s.reserve(s.capacity() * 3); s.append(1, c); } }
103
Boost.Regex
int main(int argc, const char** argv) { std::string text; for(int i = 1; i < argc; ++i) { cout << "Processing file " << argv[i] << endl; std::ifstream fs(argv[i]); load_file(text, fs); // construct our iterators: boost::sregex_iterator m1(text.begin(), text.end(), expression); boost::sregex_iterator m2; std::for_each(m1, m2, &regex_callback); // copy results: cout << class_index.size() << " matches found" << endl; map_type::iterator c, d; c = class_index.begin(); d = class_index.end(); while(c != d) { cout << "class \"" << (*c).first << "\" found at index: " << (*c).second << endl; ++c; } class_index.erase(class_index.begin(), class_index.end()); } return 0; }
regex_token_iterator
The template class regex_token_iterator is an iterator adapter; that is to say it represents a new view of an existing iterator sequence, by enumerating all the occurrences of a regular expression within that sequence, and presenting one or more character sequence for each match found. Each position enumerated by the iterator is a sub_match object that represents what matched a particular sub-expression within the regular expression. When class regex_token_iterator is used to enumerate a single sub-expression with index -1, then the iterator performs eld splitting: that is to say it enumerates one character sequence for each section of the character container sequence that does not match the regular expression specied.
104
Boost.Regex
template <class BidirectionalIterator, class charT = iterator_traits<BidirectionalIterator>::value_type, class traits = regex_traits<charT> > class regex_token_iterator { public: typedef basic_regex<charT, traits> typedef sub_match<BidirectionalIterator> typedef typename iterator_traits<BidirectionalIterator>::difference_type typedef const value_type* typedef const value_type& typedef std::forward_iterator_tag regex_token_iterator(); regex_token_iterator(BidirectionalIterator a, BidirectionalIterator b, const regex_type& re, int submatch = 0, match_flag_type m = match_default); regex_token_iterator(BidirectionalIterator a, BidirectionalIterator b, const regex_type& re, const std::vector<int>& submatches, match_flag_type m = match_default); template <std::size_t N> regex_token_iterator(BidirectionalIterator a, BidirectionalIterator b, const regex_type& re, const int (&submatches)[N], match_flag_type m = match_default); regex_token_iterator(const regex_token_iterator&); regex_token_iterator& operator=(const regex_token_iterator&); bool operator==(const regex_token_iterator&)const; bool operator!=(const regex_token_iterator&)const; const value_type& operator*()const; const value_type* operator->()const; regex_token_iterator& operator++(); regex_token_iterator operator++(int); }; typedef typedef #ifndef typedef typedef #endif regex_token_iterator<const char*> regex_token_iterator<std::string::const_iterator> BOOST_NO_WREGEX regex_token_iterator<const wchar_t*> regex_token_iterator<<std::wstring::const_iterator>
regex_type; value_type; difference_type; pointer; reference; iterator_category;
cregex_token_iterator; sregex_token_iterator; wcregex_token_iterator; wsregex_token_iterator;
template <class charT, class traits> regex_token_iterator<const charT*, charT, traits> make_regex_token_iterator( const charT* p, const basic_regex<charT, traits>& e, int submatch = 0, regex_constants::match_flag_type m = regex_constants::match_default); template <class charT, class traits, class ST, class SA> regex_token_iterator<typename std::basic_string<charT, ST, SA>::const_iterator, charT, traits> make_regex_token_iterator( const std::basic_string<charT, ST, SA>& p, const basic_regex<charT, traits>& e, int submatch = 0, regex_constants::match_flag_type m = regex_constants::match_default);
105
Boost.Regex
template <class charT, class traits, std::size_t N> regex_token_iterator<const charT*, charT, traits> make_regex_token_iterator( const charT* p, const basic_regex<charT, traits>& e, const int (&submatch)[N], regex_constants::match_flag_type m = regex_constants::match_default); template <class charT, class traits, class ST, class SA, std::size_t N> regex_token_iterator<typename std::basic_string<charT, ST, SA>::const_iterator, charT, traits> make_regex_token_iterator( const std::basic_string<charT, ST, SA>& p, const basic_regex<charT, traits>& e, const int (&submatch)[N], regex_constants::match_flag_type m = regex_constants::match_default); template <class charT, class traits> regex_token_iterator<const charT*, charT, traits> make_regex_token_iterator( const charT* p, const basic_regex<charT, traits>& e, const std::vector<int>& submatch, regex_constants::match_flag_type m = regex_constants::match_default); template <class charT, class traits, class ST, class SA> regex_token_iterator< typename std::basic_string<charT, ST, SA>::const_iterator, charT, traits> make_regex_token_iterator( const std::basic_string<charT, ST, SA>& p, const basic_regex<charT, traits>& e, const std::vector<int>& submatch, regex_constants::match_flag_type m = regex_constants::match_default);
Description
regex_token_iterator();
Effects: constructs an end of sequence iterator.

regex_token_iterator(BidirectionalIterator a, BidirectionalIterator b, const regex_type& re, int submatch = 0, match_flag_type m = match_default);
Preconditions: !re.empty(). Object re shall exist for the lifetime of the iterator constructed from it. Effects: constructs a regex_token_iterator that will enumerate one string for each regular expression match of the expression re found within the sequence [a,b), using match ags m (see match_flag_type). The string enumerated is the sub-expression submatch for each match found; if submatch is -1, then enumerates all the text sequences that did not match the expression re (that is to performs eld splitting). Throws: std::runtime_error if the complexity of matching the expression against an N character string begins to exceed O(N2), or if the program runs out of stack space while matching the expression (if Boost.Regex is congured in recursive mode), or if the matcher exhausts its permitted memory allocation (if Boost.Regex is congured in non-recursive mode).
106
Boost.Regex
regex_token_iterator(BidirectionalIterator a, BidirectionalIterator b, const regex_type& re, const std::vector<int>& submatches, match_flag_type m = match_default);
Preconditions: submatches.size() && !re.empty(). Object re shall exist for the lifetime of the iterator constructed from it. Effects: constructs a regex_token_iterator that will enumerate submatches.size() strings for each regular expression match of the expression re found within the sequence [a,b), using match ags m (see match_flag_type). For each match found one string will be enumerated for each sub-expression index contained within submatches vector; if submatches[0] is -1, then the rst string enumerated for each match will be all of the text from end of the last match to the start of the current match, in addition there will be one extra string enumerated when no more matches can be found: from the end of the last match found, to the end of the underlying sequence. Throws: std::runtime_error if the complexity of matching the expression against an N character string begins to exceed O(N2), or if the program runs out of stack space while matching the expression (if Boost.Regex is congured in recursive mode), or if the matcher exhausts its permitted memory allocation (if Boost.Regex is congured in non-recursive mode).
template <std::size_t N> regex_token_iterator(BidirectionalIterator a, BidirectionalIterator b, const regex_type& re, const int (&submatches)[R], match_flag_type m = match_default);
Preconditions: !re.empty(). Object re shall exist for the lifetime of the iterator constructed from it. Effects: constructs a regex_token_iterator that will enumerate R strings for each regular expression match of the expression re found within the sequence [a,b), using match ags m (see match_flag_type). For each match found one string will be enumerated for each sub-expression index contained within the submatches array; if submatches[0] is -1, then the rst string enumerated for each match will be all of the text from end of the last match to the start of the current match, in addition there will be one extra string enumerated when no more matches can be found: from the end of the last match found, to the end of the underlying sequence. Throws: std::runtime_error if the complexity of matching the expression against an N character string begins to exceed O(N2), or if the program runs out of stack space while matching the expression (if Boost.Regex is congured in recursive mode), or if the matcher exhausts its permitted memory allocation (if Boost.Regex is congured in non-recursive mode).
regex_token_iterator(const regex_token_iterator& that);
Effects: constructs a copy of that. Postconditions: *this == that.

regex_token_iterator& operator=(const regex_token_iterator& that);
Effects: sets *this to be equal to that. Postconditions: *this == that.

bool operator==(const regex_token_iterator&)const;
Effects: returns true if *this is the same position as that.

bool operator!=(const regex_token_iterator&)const;
107
Boost.Regex
Effects: returns !(*this == that).

const value_type& operator*()const;
Effects: returns the current character sequence being enumerated.

const value_type* operator->()const;
Effects: returns &(*this).

regex_token_iterator& operator++();
Effects: Moves on to the next character sequence to be enumerated. Throws: std::runtime_error if the complexity of matching the expression against an N character string begins to exceed O(N2), or if the program runs out of stack space while matching the expression (if Boost.Regex is congured in recursive mode), or if the matcher exhausts its permitted memory allocation (if Boost.Regex is congured in non-recursive mode). Returns: *this.
regex_token_iterator& operator++(int);
Effects: constructs a copy result of *this, then calls ++(*this). Returns: result.
108
Boost.Regex
template <class charT, class traits> regex_token_iterator<const charT*, charT, traits> make_regex_token_iterator( const charT* p, const basic_regex<charT, traits>& e, int submatch = 0, regex_constants::match_flag_type m = regex_constants::match_default); template <class charT, class traits, class ST, class SA> regex_token_iterator<typename std::basic_string<charT, ST, SA>::const_iterator, charT, traits> make_regex_token_iterator( const std::basic_string<charT, ST, SA>& p, const basic_regex<charT, traits>& e, int submatch = 0, regex_constants::match_flag_type m = regex_constants::match_default); template <class charT, class traits, std::size_t N> regex_token_iterator<const charT*, charT, traits> make_regex_token_iterator( const charT* p, const basic_regex<charT, traits>& e, const int (&submatch)[N], regex_constants::match_flag_type m = regex_constants::match_default); template <class charT, class traits, class ST, class SA, std::size_t N> regex_token_iterator< typename std::basic_string<charT, ST, SA>::const_iterator, charT, traits> make_regex_token_iterator( const std::basic_string<charT, ST, SA>& p, const basic_regex<charT, traits>& e, const int (&submatch)[N], regex_constants::match_flag_type m = regex_constants::match_default); template <class charT, class traits> regex_token_iterator<const charT*, charT, traits> make_regex_token_iterator( const charT* p, const basic_regex<charT, traits>& e, const std::vector<int>& submatch, regex_constants::match_flag_type m = regex_constants::match_default); template <class charT, class traits, class ST, class SA> regex_token_iterator< typename std::basic_string<charT, ST, SA>::const_iterator, charT, traits> make_regex_token_iterator( const std::basic_string<charT, ST, SA>& p, const basic_regex<charT, traits>& e, const std::vector<int>& submatch, regex_constants::match_flag_type m = regex_constants::match_default);
Effects: returns a regex_token_iterator that enumerates one sub_match for each value in submatch for each occurrence of regular expression e in string p, matched using match_flag_type m.
Examples
The following example takes a string and splits it into a series of tokens:
109
Boost.Regex
#include <iostream> #include <boost/regex.hpp> using namespace std; int main(int argc) { string s; do{ if(argc == 1) { cout << "Enter text to split (or \"quit\" to exit): "; getline(cin, s); if(s == "quit") break; } else s = "This is a string of tokens"; boost::regex re("\\s+"); boost::sregex_token_iterator i(s.begin(), s.end(), re, -1); boost::sregex_token_iterator j; unsigned count = 0; while(i != j) { cout << *i++ << endl; count++; } cout << "There were " << count << " tokens found." << endl; }while(argc == 1); return 0; }
The following example takes a html le and outputs a list of all the linked les:
110
Boost.Regex
#include #include #include #include
<fstream> <iostream> <iterator> <boost/regex.hpp>
boost::regex e("<\\s*A\\s+[^>]*href\\s*=\\s*\"([^\"]*)\"", boost::regex::normal | boost::regbase::icase); void load_file(std::string& s, std::istream& is) { s.erase(); // // attempt to grow string buffer to match file size, // this doesn't always work... s.reserve(is.rdbuf()->in_avail()); char c; while(is.get(c)) { // use logarithmic growth stategy, in case // in_avail (above) returned zero: if(s.capacity() == s.size()) s.reserve(s.capacity() * 3); s.append(1, c); } } int main(int argc, char** argv) { std::string s; int i; for(i = 1; i < argc; ++i) { std::cout << "Findings URL's in " << argv[i] << ":" << std::endl; s.erase(); std::ifstream is(argv[i]); load_file(s, is); boost::sregex_token_iterator i(s.begin(), s.end(), e, 1); boost::sregex_token_iterator j; while(i != j) { std::cout << *i++ << std::endl; } } // // alternative method: // test the array-literal constructor, and split out the whole // match as well as $1.... // for(i = 1; i < argc; ++i) { std::cout << "Findings URL's in " << argv[i] << ":" << std::endl; s.erase(); std::ifstream is(argv[i]); load_file(s, is); const int subs[] = {1, 0,}; boost::sregex_token_iterator i(s.begin(), s.end(), e, subs); boost::sregex_token_iterator j; while(i != j) {
111
Boost.Regex
std::cout << *i++ << std::endl; } } return 0; }
bad_expression
Synopsis
#include <boost/pattern_except.hpp>
The class regex_error denes the type of objects thrown as exceptions to report errors during the conversion from a string representing a regular expression to a nite state machine.
namespace boost{ class regex_error : public std::runtime_error { public: explicit regex_error(const std::string& s, regex_constants::error_type err, std::ptrdiff_t pos); explicit regex_error(boost::regex_constants::error_type err); boost::regex_constants::error_type code()const; std::ptrdiff_t position()const; }; typedef regex_error bad_pattern; // for backwards compatibility typedef regex_error bad_expression; // for backwards compatibility } // namespace boost
Description
regex_error(const std::string& s, regex_constants::error_type err, std::ptrdiff_t pos); regex_error(boost::regex_constants::error_type err);
Effects: Constructs an object of class regex_error.

boost::regex_constants::error_type code()const;
Effects: returns the error code that represents parsing error that occurred.
std::ptrdiff_t position()const;
Effects: returns the location in the expression where parsing stopped. Footnotes: the choice of std::runtime_error as the base class for regex_error is moot; depending upon how the library is used exceptions may be either logic errors (programmer supplied expressions) or run time errors (user supplied expressions). The library previously used bad_pattern and bad_expression for errors, these have been replaced by the single class regex_error to keep the library in synchronization with the Technical Report on C++ Library Extensions.
112
Boost.Regex
syntax_option_type
syntax_option_type Synopsis
Type syntax_option_type is an implementation specic bitmask type that controls how a regular expression string is to be interpreted. For convenience note that all the constants listed here, are also duplicated within the scope of class template basic_regex.
namespace std{ namespace regex_constants{ typedef implementation-specific-bitmask-type syntax_option_type; // these flags are standardized: static const syntax_option_type normal; static const syntax_option_type ECMAScript = normal; static const syntax_option_type JavaScript = normal; static const syntax_option_type JScript = normal; static const syntax_option_type perl = normal; static const syntax_option_type basic; static const syntax_option_type sed = basic; static const syntax_option_type extended; static const syntax_option_type awk; static const syntax_option_type grep; static const syntax_option_type egrep; static const syntax_option_type icase; static const syntax_option_type nosubs; static const syntax_option_type optimize; static const syntax_option_type collate; // // The remaining options are specific to Boost.Regex: // // Options common to both Perl and POSIX regular expressions: static const syntax_option_type newline_alt; static const syntax_option_type no_except; static const syntax_option_type save_subexpression_location; // Perl specific options: static const syntax_option_type static const syntax_option_type static const syntax_option_type static const syntax_option_type static const syntax_option_type
no_mod_m; no_mod_s; mod_s; mod_x; no_empty_expressions;
// POSIX extended specific options: static const syntax_option_type no_escape_in_lists; static const syntax_option_type no_bk_refs; // POSIX basic specific options: static const syntax_option_type no_escape_in_lists; static const syntax_option_type no_char_classes; static const syntax_option_type no_intervals; static const syntax_option_type bk_plus_qm; static const syntax_option_type bk_vbar; } // namespace regex_constants } // namespace std
113
Boost.Regex
Overview of syntax_option_type
The type syntax_option_type is an implementation specic bitmask type (see C++ standard 17.3.2.1.2). Setting its elements has the effects listed in the table below, a valid value of type syntax_option_type will always have exactly one of the elements normal, basic, extended, awk, grep, egrep, sed, literal or perl set. Note that for convenience all the constants listed here are duplicated within the scope of class template basic_regex, so you can use any of:
boost::regex_constants::constant_name
or
boost::regex::constant_name
or
boost::wregex::constant_name
in an interchangeable manner.
Options for Perl Regular Expressions

One of the following must always be set for perl regular expressions: Element ECMAScript Standardized Yes Effect when set Species that the grammar recognized by the regular expression engine uses its normal semantics: that is the same as that given in the ECMA-262, ECMAScript Language Specication, Chapter 15 part 10, RegExp (Regular Expression) Objects (FWD.1). This is functionally identical to the Perl regular expression syntax. Boost.Regex also recognizes all of the perl-compatible (?...) extensions in this mode. perl normal JavaScript JScript No No No No As above. As above. As above. As above.
The following options may also be set when using perl-style regular expressions:
114
Boost.Regex
Element icase
Standardized Yes
Effect when set Species that matching of regular expressions against a character container sequence shall be performed without regard to case. Species that when a regular expression is matched against a character container sequence, then no sub-expression matches are to be stored in the supplied match_results structure. Species that the regular expression engine should pay more attention to the speed with which regular expressions are matched, and less to the speed with which regular expression objects are constructed. Otherwise it has no detectable effect on the program output. This currently has no effect for Boost.Regex. Species that character ranges of the form [a-b] should be locale sensitive. Species that the \n character has the same effect as the alternation operator |. Allows newline separated lists to be used as a list of alternatives. Prevents basic_regex from throwing an exception when an invalid expression is encountered. Normally Boost.Regex behaves as if the Perl m-modier is on: so the assertions ^ and $ match after and before embedded newlines respectively, setting this ags is equivalent to prexing the expression with (?-m). Normally whether Boost.Regex will match "." against a newline character is determined by the match ag match_dot_not_newline. Specifying this ag is equivalent to prexing the expression with (?-s) and therefore causes "." not to match a newline character regardless of whether match_not_dot_newline is set in the match ags.
nosubs
Yes
optimize
Yes
collate
Yes
newline_alt
No
no_except
No
no_mod_m
No
no_mod_s
No
115
Boost.Regex
Element mod_s
Standardized No
Effect when set Normally whether Boost.Regex will match "." against a newline character is determined by the match ag match_dot_not_newline. Specifying this ag is equivalent to prexing the expression with (?s) and therefore causes "." to match a newline character regardless of whether match_not_dot_newline is set in the match ags. Turns on the perl x-modier: causes unescaped whitespace in the expression to be ignored. When set then empty expressions/alternatives are prohibited. When set then the locations of individual sub-expressions within the original regular expression string can be accessed via the subexpression() member function of basic_regex.
mod_x
No
no_empty_expressions
No
save_subexpression_location
No
Options for POSIX Extended Regular Expressions

Exactly one of the following must always be set for POSIX extended regular expressions:
116
Boost.Regex
Element extended
Standardized Yes
Effect when set Species that the grammar recognized by the regular expression engine is the same as that used by POSIX extended regular expressions in IEEE Std 1003.1-2001, Portable Operating System Interface (POSIX ), Base Denitions and Headers, Section 9, Regular Expressions (FWD.1). Refer to the POSIX extended regular expression guide for more information. In addition some perl-style escape sequences are supported (The POSIX standard species that only "special" characters may be escaped, all other escape sequences result in undened behavior).
egrep
Yes
Species that the grammar recognized by the regular expression engine is the same as that used by POSIX utility grep when given the -E option in IEEE Std 1003.12001, Portable Operating System Interface (POSIX ), Shells and Utilities, Section 4, Utilities, grep (FWD.1). That is to say, the same as POSIX extended syntax, but with the newline character acting as an alternation character in addition to "|".
awk
Yes
Species that the grammar recognized by the regular expression engine is the same as that used by POSIX utility awk in IEEE Std 1003.1-2001, Portable Operating System Interface (POSIX ), Shells and Utilities, Section 4, awk (FWD.1). That is to say: the same as POSIX extended syntax, but with escape sequences in character classes permitted. In addition some perl-style escape sequences are supported (actually the awk syntax only requires \a \b \t \v \f \n and \r to be recognised, all other Perl-style escape sequences invoke undened behavior according to the POSIX standard, but are in fact recognised by Boost.Regex).
The following options may also be set when using POSIX extended regular expressions:
117
Boost.Regex
Element icase
Standardized Yes
Effect when set Species that matching of regular expressions against a character container sequence shall be performed without regard to case. Species that when a regular expression is matched against a character container sequence, then no sub-expression matches are to be stored in the supplied match_results structure. Species that the regular expression engine should pay more attention to the speed with which regular expressions are matched, and less to the speed with which regular expression objects are constructed. Otherwise it has no detectable effect on the program output. This currently has no effect for Boost.Regex. Species that character ranges of the form [a-b] should be locale sensitive. This bit is on by default for POSIX-Extended regular expressions, but can be unset to force ranges to be compared by code point only. Species that the \n character has the same effect as the alternation operator |. Allows newline separated lists to be used as a list of alternatives. When set this makes the escape character ordinary inside lists, so that [\b] would match either '\' or 'b'. This bit is on by default for POSIX-Extended regular expressions, but can be unset to force escapes to be recognised inside lists. When set then backreferences are disabled. This bit is on by default for POSIXExtended regular expressions, but can be unset to support for backreferences on. Prevents basic_regex from throwing an exception when an invalid expression is encountered. When set then the locations of individual sub-expressions within the original regular expression string can be accessed via the subexpression() member function of basic_regex.
nosubs
Yes
optimize
Yes
collate
Yes
newline_alt
No
no_escape_in_lists
No
no_bk_refs
No
no_except
No
save_subexpression_location
No
118
Boost.Regex
Options for POSIX Basic Regular Expressions

Exactly one of the following must always be set for POSIX basic regular expressions: Element basic Standardized Yes Effect When Set Species that the grammar recognized by the regular expression engine is the same as that used by POSIX basic regular expressions in IEEE Std 1003.1-2001, Portable Operating System Interface (POSIX ), Base Denitions and Headers, Section 9, Regular Expressions (FWD.1). As Above. Species that the grammar recognized by the regular expression engine is the same as that used by POSIX utility grep in IEEE Std 1003.1-2001, Portable Operating System Interface (POSIX ), Shells and Utilities, Section 4, Utilit\ies, grep (FWD.1). That is to say, the same as POSIX basic syntax, but with the newline character acting as an alternation character; the expression is treated as a newline separated list of alternatives. emacs No Species that the grammar recognised is the superset of the POSIX-Basic syntax used by the emacs program.
sed grep
No Yes
The following options may also be set when using POSIX basic regular expressions:
119
Boost.Regex
Element icase
Standardized Yes
Effect when set Species that matching of regular expressions against a character container sequence shall be performed without regard to case. Species that when a regular expression is matched against a character container sequence, then no sub-expression matches are to be stored in the supplied match_results structure. Species that the regular expression engine should pay more attention to the speed with which regular expressions are matched, and less to the speed with which regular expression objects are constructed. Otherwise it has no detectable effect on the program output. This currently has no effect for Boost.Regex. Species that character ranges of the form [a-b] should be locale sensitive. This bit is on by default for POSIX-Basic regular expressions, but can be unset to force ranges to be compared by code point only. Species that the \n character has the same effect as the alternation operator |. Allows newline separated lists to be used as a list of alternatives. This bit is already set, if you use the grep option. When set then character classes such as [[:alnum:]] are not allowed. When set this makes the escape character ordinary inside lists, so that [\b] would match either '\' or 'b'. This bit is on by default for POSIX-basic regular expressions, but can be unset to force escapes to be recognised inside lists. When set then bounded repeats such as a{2,3} are not permitted. When set then \? acts as a zero-or-one repeat operator, and \+ acts as a one-ormore repeat operator. When set then \| acts as the alternation operator. Prevents basic_regex from throwing an exception when an invalid expression is encountered.
nosubs
Yes
optimize
Yes
collate
Yes
newline_alt
No
no_char_classes
No
no_escape_in_lists
No
no_intervals
No
bk_plus_qm
No
bk_vbar
No
no_except
No
120
Boost.Regex
Element save_subexpression_location
Standardized No
Effect when set When set then the locations of individual sub-expressions within the original regular expression string can be accessed via the subexpression() member function of basic_regex.
Options for Literal Strings

The following must always be set to interpret the expression as a string literal: Element literal Standardized Yes Effect when set Treat the string as a literal (no special characters).
The following options may also be combined with the literal ag: Element icase Standardized Yes Effect when set Species that matching of regular expressions against a character container sequence shall be performed without regard to case. Species that the regular expression engine should pay more attention to the speed with which regular expressions are matched, and less to the speed with which regular expression objects are constructed. Otherwise it has no detectable effect on the program output. This currently has no effect for Boost.Regex.
optimize
Yes
match_flag_type
The type match_flag_type is an implementation specic bitmask type (see C++ std 17.3.2.1.2) that controls how a regular expression is matched against a character sequence. The behavior of the format ags is described in more detail in the format syntax guide.
121
Boost.Regex
namespace boost{ namespace regex_constants{ typedef implemenation-specific-bitmask-type match_flag_type; static static static static static static static static static static static static static static static static static static static static static static static const const const const const const const const const const const const const const const const const const const const const const const match_flag_type match_flag_type match_flag_type match_flag_type match_flag_type match_flag_type match_flag_type match_flag_type match_flag_type match_flag_type match_flag_type match_flag_type match_flag_type match_flag_type match_flag_type match_flag_type match_flag_type match_flag_type match_flag_type match_flag_type match_flag_type match_flag_type match_flag_type match_default = 0; match_not_bob; match_not_eob; match_not_bol; match_not_eol; match_not_bow; match_not_eow; match_any; match_not_null; match_continuous; match_partial; match_single_line; match_prev_avail; match_not_dot_newline; match_not_dot_null; match_posix; match_perl; match_nosubs; match_extra; format_default = 0; format_sed; format_perl; format_literal;
static const match_flag_type format_no_copy; static const match_flag_type format_first_only; static const match_flag_type format_all; } // namespace regex_constants } // namespace boost
Description
The type match_flag_type is an implementation specic bitmask type (see C++ std 17.3.2.1.2). When matching a regular expression against a sequence of characters [rst, last) then setting its elements has the effects listed in the table below:
122
Boost.Regex
Element match_default
Effect if set Species that matching of regular expressions proceeds without any modication of the normal rules used in ECMA-262, ECMAScript Language Specication, Chapter 15 part 10, RegExp (Regular Expression) Objects (FWD.1) Species that the expressions "\A" and "\`" should not match against the sub-sequence [rst,rst). Species that the expressions "\'", "\z" and "\Z" should not match against the sub-sequence [last,last). Species that the expression "^" should not be matched against the sub-sequence [rst,rst). Species that the expression "$" should not be matched against the sub-sequence [last,last). Species that the expressions "\<" and "\b" should not be matched against the sub-sequence [rst,rst). Species that the expressions "\>" and "\b" should not be matched against the sub-sequence [last,last). Species that if more than one match is possible then any match is an acceptable result: this will still nd the leftmost match, but may not nd the "best" match at that position. Use this ag if you care about the speed of matching, but don't care what was matched (only whether there is one or not). Species that the expression can not be matched against an empty sequence. Species that the expression must match a sub-sequence that begins at rst. Species that if no match can be found, then it is acceptable to return a match [from, last) such that from!= last, if there could exist some longer sequence of characters [from,to) of which [from,last) is a prex, and which would result in a full match. This ag is used when matching incomplete or very long texts, see the partial matches documentation for more information. Instructs the matching engine to retain all available capture information; if a capturing group is repeated then information about every repeat is available via match_results::captures() or sub_match_captures(). Equivalent to the inverse of Perl's m/ modier; prevents ^ from matching after an embedded newline character (so that it only matches at the start of the text being matched), and $ from matching before an embedded newline (so that it only matches at the end of the text being matched).
match_not_bob
match_not_eob
match_not_bol
match_not_eol
match_not_bow
match_not_eow
match_any
match_not_null
match_continuous
match_partial
match_extra
match_single_line
123
Boost.Regex
Element match_prev_avail
Effect if set Species that --rst is a valid iterator position, when this ag is set then the ags match_not_bol and match_not_bow are ignored by the regular expression algorithms (RE.7) and iterators (RE.8). Species that the expression "." does not match a newline character. This is the inverse of Perl's s/ modier. Species that the expression "." does not match a character null '\0'. Species that the expression should be matched according to the POSIX leftmost-longest rule, regardless of what kind of expression was compiled. Be warned that these rules do not work well with many Perl-specic features such as non-greedy repeats. Species that the expression should be matched according to the Perl matching rules, irrespective of what kind of expression was compiled. Makes the expression behave as if it had no marked subexpressions, no matter how many capturing groups are actually present. The match_results class will only contain information about the overall match, and not any sub-expressions. Species that when a regular expression match is to be replaced by a new string, that the new string is constructed using the rules used by the ECMAScript replace function in ECMA-262, ECMAScript Language Specication, Chapter 15 part 5.4.11 String.prototype.replace. (FWD.1). This is functionally identical to the Perl format string rules. In addition during search and replace operations then all nonoverlapping occurrences of the regular expression are located and replaced, and sections of the input that did not match the expression, are copied unchanged to the output string.
match_not_dot_newline
match_not_dot_null
match_posix
match_perl
match_nosubs
format_default
format_sed
Species that when a regular expression match is to be replaced by a new string, that the new string is constructed using the rules used by the Unix sed utility in IEEE Std 1003.1-2001, Portable Operating SystemInterface (POSIX ), Shells and Utilities. See also the Sed Format string reference. Species that when a regular expression match is to be replaced by a new string, that the new string is constructed using the same rules as Perl 5. Species that when a regular expression match is to be replaced by a new string, that the new string is a literal copy of the replacement text.
format_perl
format_literal
124
Boost.Regex
Element format_all
Effect if set Species that all syntax extensions are enabled, including conditional (?ddexpression1:expression2) replacements: see the format string guide for more details. When specied during a search and replace operation, then sections of the character container sequence being searched that do match the regular expression, are not copied to the output string. When specied during a search and replace operation, then only the rst occurrence of the regular expression is replaced.
format_no_copy
format_rst_only
error_type
Synopsis
Type error type represents the different types of errors that can be raised by the library when parsing a regular expression.
namespace boost{ namespace regex_constants{ typedef implementation-specific-type error_type; static static static static static static static static static static static static static static const const const const const const const const const const const const const const error_type error_type error_type error_type error_type error_type error_type error_type error_type error_type error_type error_type error_type error_type error_collate; error_ctype; error_escape; error_backref; error_brack; error_paren; error_brace; error_badbrace; error_range; error_space; error_badrepeat; error_complexity; error_stack; error_bad_pattern;
} // namespace regex_constants } // namespace boost
Description
The type error_type is an implementation-specic enumeration type that may take one of the following values:
125
Boost.Regex
Constant error_collate error_ctype
Meaning An invalid collating element was specied in a [[.name.]] block. An invalid character class name was specied in a [[:name:]] block. An invalid or trailing escape was encountered. A back-reference to a non-existant marked sub-expression was encountered. An invalid character set [...] was encountered. Mismatched '(' and ')'. Mismatched '{' and '}'. Invalid contents of a {...} block. A character range was invalid, for example [d-a]. Out of memory. An attempt to repeat something that can not be repeated - for example a*+ The expression became too complex to handle. Out of program stack space. Other unspecied errors.
error_escape error_backref
error_brack error_paren error_brace error_badbrace error_range error_space error_badrepeat
error_complexity error_stack error_bad_pattern
regex_traits
namespace boost{ template <class charT, class implementationT = sensible_default_choice> struct regex_traits : public implementationT { regex_traits() : implementationT() {} }; template <class charT> struct c_regex_traits; template <class charT> class cpp_regex_traits; template <class charT> class w32_regex_traits; } // namespace boost
Description
The class regex_traits is just a thin wrapper around an actual implemention class, which may be one of:
126
Boost.Regex
c_regex_traits: this class is deprecated, it wraps the C locale, and is used as the default implementation when the platform is not Win32, and the C++ locale is not available. cpp_regex_traits: the default traits class for non-Win32 platforms, allows the regex class to be imbued with a std::locale instance. w32_regex_traits: the default traits class implementation on Win32 platforms, allows the regex class to be imbued with an LCID. The default behavior can be altered by dening one of the following conguration macros in boost/regex/user.hpp BOOST_REGEX_USE_C_LOCALE: makes c_regex_traits the default. BOOST_REGEX_USE_CPP_LOCALE: makes cpp_regex_traits the default. All these traits classes full the traits class requirements.
Interfacing With Non-Standard String Types

The Boost.Regex algorithms and iterators are all iterator-based, with convenience overloads of the algorithms provided that convert standard library string types to iterator pairs internally. If you want to search a non-standard string type then the trick is to convert that string into an iterator pair: so far I haven't come across any string types that can't be handled this way, even if they're not ofcially iterator based. Certainly any string type that provides access to it's internal buffer, along with it's length, can be converted into a pair of pointers (which can be used as iterators). Some non-standard string types are sufciently common that wappers have been provided for them already: currently this includes the ICU and MFC string class types.
Working With Unicode and ICU String Types

Introduction to using Regex with ICU
The header:
<boost/regex/icu.hpp>
contains the data types and algorithms necessary for working with regular expressions in a Unicode aware environment. In order to use this header you will need the ICU library, and you will need to have built the Boost.Regex library with ICU support enabled. The header will enable you to: Create regular expressions that treat Unicode strings as sequences of UTF-32 code points. Create regular expressions that support various Unicode data properties, including character classication. Transparently search Unicode strings that are encoded as either UTF-8, UTF-16 or UTF-32.
Unicode regular expression types

Header <boost/regex/icu.hpp> provides a regular expression traits class that handles UTF-32 characters:
class icu_regex_traits;
and a regular expression type based upon that:

typedef basic_regex<UChar32,icu_regex_traits> u32regex;
127
Boost.Regex
The type u32regex is regular expression type to use for all Unicode regular expressions; internally it uses UTF-32 code points, but can be created from, and used to search, either UTF-8, or UTF-16 encoded strings as well as UTF-32 ones. The constructors, and assign member functions of u32regex, require UTF-32 encoded strings, but there are a series of overloaded algorithms called make_u32regex which allow regular expressions to be created from UTF-8, UTF-16, or UTF-32 encoded strings:
template <class InputIterator> u32regex make_u32regex(InputIterator i, InputIterator j, boost::regex_constants::syntax_option_type opt);
Effects: Creates a regular expression object from the iterator sequence [i,j). The character encoding of the sequence is determined based upon sizeof(*i): 1 implies UTF-8, 2 implies UTF-16, and 4 implies UTF-32.
u32regex make_u32regex(const char* p, boost::regex_constants::syntax_option_type opt = boost::regex_constants::perl);
Effects: Creates a regular expression object from the Null-terminated UTF-8 characater sequence p.
u32regex make_u32regex(const unsigned char* p, boost::regex_constants::syntax_option_type opt = boost::regex_constants::perl);
u32regex make_u32regex(const wchar_t* p, boost::regex_constants::syntax_option_type opt = boost::regex_constants::perl);
Effects: Creates a regular expression object from the Null-terminated characater sequence p. The character encoding of the sequence is determined based upon sizeof(wchar_t): 1 implies UTF-8, 2 implies UTF-16, and 4 implies UTF-32.
u32regex make_u32regex(const UChar* p, boost::regex_constants::syntax_option_type opt = boost::regex_constants::perl);
template<class C, class T, class A> u32regex make_u32regex(const std::basic_string<C, T, A>& s, boost::regex_constants::syntax_option_type opt = boost::regex_constants::perl);
Effects: Creates a regular expression object from the string s. The character encoding of the string is determined based upon sizeof(C): 1 implies UTF-8, 2 implies UTF-16, and 4 implies UTF-32.
u32regex make_u32regex(const UnicodeString& s, boost::regex_constants::syntax_option_type opt = boost::regex_constants::perl);
Effects: Creates a regular expression object from the UTF-16 encoding string s.
128
Boost.Regex
Unicode Regular Expression Algorithms

The regular expression algorithms regex_match, regex_search and regex_replace all expect that the character sequence upon which they operate, is encoded in the same character encoding as the regular expression object with which they are used. For Unicode regular expressions that behavior is undesirable: while we may want to process the data in UTF-32 "chunks", the actual data is much more likely to encoded as either UTF-8 or UTF-16. Therefore the header <boost/regex/icu.hpp> provides a series of thin wrappers around these algorithms, called u32regex_match, u32regex_search, and u32regex_replace. These wrappers use iteratoradapters internally to make external UTF-8 or UTF-16 data look as though it's really a UTF-32 sequence, that can then be passed on to the "real" algorithm.
u32regex_match
For each regex_match algorithm dened by <boost/regex.hpp>, then <boost/regex/icu.hpp> denes an overloaded algorithm that takes the same arguments, but which is called u32regex_match, and which will accept UTF-8, UTF-16 or UTF-32 encoded data, as well as an ICU UnicodeString as input. Example: match a password, encoded in a UTF-16 UnicodeString:
// // Find out if *password* meets our password requirements, // as defined by the regular expression *requirements*. // bool is_valid_password(const UnicodeString& password, const UnicodeString& requirements) { return boost::u32regex_match(password, boost::make_u32regex(requirements)); }
Example: match a UTF-8 encoded lename:

// // Extract filename part of a path from a UTF-8 encoded std::string and return the result // as another std::string: // std::string get_filename(const std::string& path) { boost::u32regex r = boost::make_u32regex("(?:\\A|.*\\\\)([^\\\\]+)"); boost::smatch what; if(boost::u32regex_match(path, what, r)) { // extract $1 as a std::string: return what.str(1); } else { throw std::runtime_error("Invalid pathname"); } }
u32regex_search
For each regex_search algorithm dened by <boost/regex.hpp>, then <boost/regex/icu.hpp> denes an overloaded algorithm that takes the same arguments, but which is called u32regex_search, and which will accept UTF-8, UTF-16 or UTF-32 encoded data, as well as an ICU UnicodeString as input. Example: search for a character sequence in a specic language block:
129
Boost.Regex
UnicodeString extract_greek(const UnicodeString& text) { // searches through some UTF-16 encoded text for a block encoded in Greek, // this expression is imperfect, but the best we can do for now - searching // for specific scripts is actually pretty hard to do right. // // Here we search for a character sequence that begins with a Greek letter, // and continues with characters that are either not-letters ( [^[:L*:]] ) // or are characters in the Greek character block ( [\\x{370}-\\x{3FF}] ). // boost::u32regex r = boost::make_u32regex( L"[\\x{370}-\\x{3FF}](?:[^[:L*:]]|[\\x{370}-\\x{3FF}])*"); boost::u16match what; if(boost::u32regex_search(text, what, r)) { // extract $0 as a UnicodeString: return UnicodeString(what[0].first, what.length(0)); } else { throw std::runtime_error("No Greek found!"); } }
u32regex_replace
For each regex_replace algorithm dened by <boost/regex.hpp>, then <boost/regex/icu.hpp> denes an overloaded algorithm that takes the same arguments, but which is called u32regex_replace, and which will accept UTF-8, UTF-16 or UTF32 encoded data, as well as an ICU UnicodeString as input. The input sequence and the format string specier passed to the algorithm, can be encoded independently (for example one can be UTF-8, the other in UTF-16), but the result string / output iterator argument must use the same character encoding as the text being searched. Example: Credit card number reformatting:
// // Take a credit card number as a string of digits, // and reformat it as a human readable string with "-" // separating each group of four digit;, // note that we're mixing a UTF-32 regex, with a UTF-16 // string and a UTF-8 format specifier, and it still all // just works: // const boost::u32regex e = boost::make_u32regex( "\\A(\\d{3,4})[- ]?(\\d{4})[- ]?(\\d{4})[- ]?(\\d{4})\\z"); const char* human_format = "$1-$2-$3-$4"; UnicodeString human_readable_card_number(const UnicodeString& s) { return boost::u32regex_replace(s, e, human_format); }
Unicode Aware Regex Iterators u32regex_iterator

Type u32regex_iterator is in all respects the same as regex_iterator except that since the regular expression type is always u32regex it only takes one template parameter (the iterator type). It also calls u32regex_search internally, allowing it to interface correctly with UTF-8, UTF-16, and UTF-32 data:
130
Boost.Regex
template <class BidirectionalIterator> class u32regex_iterator { // for members see regex_iterator }; typedef u32regex_iterator<const char*> typedef u32regex_iterator<const UChar*> typedef u32regex_iterator<const UChar32*> utf8regex_iterator; utf16regex_iterator; utf32regex_iterator;
In order to simplify the construction of a u32regex_iterator from a string, there are a series of non-member helper functions called make_u32regex_iterator:
u32regex_iterator<const char*> make_u32regex_iterator(const char* s, const u32regex& e, regex_constants::match_flag_type m = regex_constants::match_default); u32regex_iterator<const wchar_t*> make_u32regex_iterator(const wchar_t* s, const u32regex& e, regex_constants::match_flag_type m = regex_constants::match_default); u32regex_iterator<const UChar*> make_u32regex_iterator(const UChar* s, const u32regex& e, regex_constants::match_flag_type m = regex_constants::match_default); template <class charT, class Traits, class Alloc> u32regex_iterator<typename std::basic_string<charT, Traits, Alloc>::const_iterator> make_u32regex_iterator(const std::basic_string<charT, Traits, Alloc>& s, const u32regex& e, regex_constants::match_flag_type m = regex_constants::match_default); u32regex_iterator<const UChar*> make_u32regex_iterator(const UnicodeString& s, const u32regex& e, regex_constants::match_flag_type m = regex_constants::match_default);
Each of these overloads returns an iterator that enumerates all occurrences of expression e, in text s, using match_ags m. Example: search for international currency symbols, along with their associated numeric value:
131
Boost.Regex
void enumerate_currencies(const std::string& text) { // enumerate and print all the currency symbols, along // with any associated numeric values: const char* re = "([[:Sc:]][[:Cf:][:Cc:][:Z*:]]*)?" "([[:Nd:]]+(?:[[:Po:]][[:Nd:]]+)?)?" "(?(1)" "|(?(2)" "[[:Cf:][:Cc:][:Z*:]]*" ")" "[[:Sc:]]" ")"; boost::u32regex r = boost::make_u32regex(re); boost::u32regex_iterator<std::string::const_iterator> i(boost::make_u32regex_iterator(text, r)), j; while(i != j) { std::cout << (*i)[0] << std::endl; ++i; } }
Calling
enumerate_currencies(" $100.23 or 198.12 ");
Yields the output:

$100.23 198.12
Provided of course that the input is encoded as UTF-8.
u32regex_token_iterator
Type u32regex_token_iterator is in all respects the same as regex_token_iterator except that since the regular expression type is always u32regex it only takes one template parameter (the iterator type). It also calls u32regex_search internally, allowing it to interface correctly with UTF-8, UTF-16, and UTF-32 data:
template <class BidirectionalIterator> class u32regex_token_iterator { // for members see regex_token_iterator }; typedef u32regex_token_iterator<const char*> typedef u32regex_token_iterator<const UChar*> typedef u32regex_token_iterator<const UChar32*> utf8regex_token_iterator; utf16regex_token_iterator; utf32regex_token_iterator;
In order to simplify the construction of a u32regex_token_iterator from a string, there are a series of non-member helper functions called make_u32regex_token_iterator:
132
Boost.Regex
u32regex_token_iterator<const char*> make_u32regex_token_iterator( const char* s, const u32regex& e, int sub, regex_constants::match_flag_type m = regex_constants::match_default); u32regex_token_iterator<const wchar_t*> make_u32regex_token_iterator( const wchar_t* s, const u32regex& e, int sub, regex_constants::match_flag_type m = regex_constants::match_default); u32regex_token_iterator<const UChar*> make_u32regex_token_iterator( const UChar* s, const u32regex& e, int sub, regex_constants::match_flag_type m = regex_constants::match_default); template <class charT, class Traits, class Alloc> u32regex_token_iterator<typename std::basic_string<charT, Traits, Alloc>::const_iterator> make_u32regex_token_iterator( const std::basic_string<charT, Traits, Alloc>& s, const u32regex& e, int sub, regex_constants::match_flag_type m = regex_constants::match_default); u32regex_token_iterator<const UChar*> make_u32regex_token_iterator( const UnicodeString& s, const u32regex& e, int sub, regex_constants::match_flag_type m = regex_constants::match_default);
Each of these overloads returns an iterator that enumerates all occurrences of marked sub-expression sub in regular expression e, found in text s, using match_ags m.
133
Boost.Regex
template <std::size_t N> u32regex_token_iterator<const char*> make_u32regex_token_iterator( const char* p, const u32regex& e, const int (&submatch)[N], regex_constants::match_flag_type m = regex_constants::match_default); template <std::size_t N> u32regex_token_iterator<const wchar_t*> make_u32regex_token_iterator( const wchar_t* p, const u32regex& e, const int (&submatch)[N], regex_constants::match_flag_type m = regex_constants::match_default); template <std::size_t N> u32regex_token_iterator<const UChar*> make_u32regex_token_iterator( const UChar* p, const u32regex& e, const int (&submatch)[N], regex_constants::match_flag_type m = regex_constants::match_default); template <class charT, class Traits, class Alloc, std::size_t N> u32regex_token_iterator<typename std::basic_string<charT, Traits, Alloc>::const_iterator> make_u32regex_token_iterator( const std::basic_string<charT, Traits, Alloc>& p, const u32regex& e, const int (&submatch)[N], regex_constants::match_flag_type m = regex_constants::match_default); template <std::size_t N> u32regex_token_iterator<const UChar*> make_u32regex_token_iterator( const UnicodeString& s, const u32regex& e, const int (&submatch)[N], regex_constants::match_flag_type m = regex_constants::match_default);
Each of these overloads returns an iterator that enumerates one sub-expression for each submatch in regular expression e, found in text s, using match_ags m.
134
Boost.Regex
u32regex_token_iterator<const char*> make_u32regex_token_iterator( const char* p, const u32regex& e, const std::vector<int>& submatch, regex_constants::match_flag_type m = regex_constants::match_default); u32regex_token_iterator<const wchar_t*> make_u32regex_token_iterator( const wchar_t* p, const u32regex& e, const std::vector<int>& submatch, regex_constants::match_flag_type m = regex_constants::match_default); u32regex_token_iterator<const UChar*> make_u32regex_token_iterator( const UChar* p, const u32regex& e, const std::vector<int>& submatch, regex_constants::match_flag_type m = regex_constants::match_default); template <class charT, class Traits, class Alloc> u32regex_token_iterator<typename std::basic_string<charT, Traits, Alloc>::const_iterator> make_u32regex_token_iterator( const std::basic_string<charT, Traits, Alloc>& p, const u32regex& e, const std::vector<int>& submatch, regex_constants::match_flag_type m = regex_constants::match_default); u32regex_token_iterator<const UChar*> make_u32regex_token_iterator( const UnicodeString& s, const u32regex& e, const std::vector<int>& submatch, regex_constants::match_flag_type m = regex_constants::match_default);
Each of these overloads returns an iterator that enumerates one sub-expression for each submatch in regular expression e, found in text s, using match_ags m. Example: search for international currency symbols, along with their associated numeric value:
135
Boost.Regex
void enumerate_currencies2(const std::string& text) { // enumerate and print all the currency symbols, along // with any associated numeric values: const char* re = "([[:Sc:]][[:Cf:][:Cc:][:Z*:]]*)?" "([[:Nd:]]+(?:[[:Po:]][[:Nd:]]+)?)?" "(?(1)" "|(?(2)" "[[:Cf:][:Cc:][:Z*:]]*" ")" "[[:Sc:]]" ")"; boost::u32regex r = boost::make_u32regex(re); boost::u32regex_token_iterator<std::string::const_iterator> i(boost::make_u32regex_token_iterator(text, r, 1)), j; while(i != j) { std::cout << *i << std::endl; ++i; } }
Using Boost Regex With MFC Strings

Introduction to Boost.Regex and MFC Strings
The header <boost/regex/mfc.hpp> provides Boost.Regex support for MFC string types: note that this support requires Visual Studio .NET (Visual C++ 7) or later, where all of the MFC and ATL string types are based around the CSimpleStringT class template. In the following documentation, whenever you see CSimpleStringT<charT>, then you can substitute any of the following MFC/ATL types (all of which inherit from CSimpleStringT):
CString CStringA CStringW CAtlString CAtlStringA CAtlStringW CStringT<charT,traits> CFixedStringT<charT,N> CSimpleStringT<charT>
Regex Types Used With MFC Strings

The following typedefs are provided for the convenience of those working with TCHAR's:
typedef typedef typedef typedef basic_regex<TCHAR> match_results<TCHAR const*> regex_iterator<TCHAR const*> regex_token_iterator<TCHAR const*> tregex; tmatch; tregex_iterator; tregex_token_iterator;
If you are working with explicitly narrow or wide characters rather than TCHAR, then use the regular Boost.Regex types regex and wregex instead.
Regular Expression Creation From an MFC String

The following helper function is available to assist in the creation of a regular expression from an MFC/ATL string type:
136
Boost.Regex
template <class charT> basic_regex<charT> make_regex(const ATL::CSimpleStringT<charT>& s, ::boost::regex_constants::syntax_option_type f = boost::regex_constants::normal);
Effects: returns basic_regex<charT>(s.GetString(), s.GetString() + s.GetLength(), f);
Overloaded Algorithms For MFC String Types

For each regular expression algorithm that's overloaded for a std::basic_string argument, there is also one overloaded for the MFC/ATL string types. These algorithm signatures all look a lot more complex than they actually are, but for completeness here they are anyway:
regex_match
There are two overloads, the rst reports what matched in a match_results structure, the second does not. All the usual caveats for regex_match apply, in particular the algorithm will only report a successful match if all of the input text matches the expression, if this isn't what you want then use regex_search instead.
template <class charT, class T, class A> bool regex_match( const ATL::CSimpleStringT<charT>& s, match_results<const B*, A>& what, const basic_regex<charT, T>& e, boost::regex_constants::match_flag_type f = boost::regex_constants::match_default);
Effects: returns ::boost::regex_match(s.GetString(), s.GetString() + s.GetLength(), what, e, f); Example:

// // Extract filename part of a path from a CString and return the result // as another CString: // CString get_filename(const CString& path) { boost::tregex r(__T("(?:\\A|.*\\\\)([^\\\\]+)")); boost::tmatch what; if(boost::regex_match(path, what, r)) { // extract $1 as a CString: return CString(what[1].first, what.length(1)); } else { throw std::runtime_error("Invalid pathname"); } }
regex_match (second overload)

template <class charT, class T> bool regex_match( const ATL::CSimpleStringT<charT>& s, const basic_regex<B, T>& e, boost::regex_constants::match_flag_type f = boost::regex_constants::match_default)
Effects: returns ::boost::regex_match(s.GetString(), s.GetString() + s.GetLength(), e, f);
137
Boost.Regex
Example:
// // Find out if *password* meets our password requirements, // as defined by the regular expression *requirements*. // bool is_valid_password(const CString& password, const CString& requirements) { return boost::regex_match(password, boost::make_regex(requirements)); }
regex_search
There are two additional overloads for regex_search, the rst reports what matched the second does not:
template <class charT, class A, class T> bool regex_search(const ATL::CSimpleStringT<charT>& s, match_results<const charT*, A>& what, const basic_regex<charT, T>& e, boost::regex_constants::match_flag_type f = boost::regex_constants::match_de fault)
Effects: returns ::boost::regex_search(s.GetString(), s.GetString() + s.GetLength(), what, e, f); Example: Postcode extraction from an address string.
CString extract_postcode(const CString& address) { // searches throw address for a UK postcode and returns the result, // the expression used is by Phil A. on www.regxlib.com: boost::tregex r(__T("^(([A-Z]{1,2}[0-9]{1,2})|([A-Z]{1,2}[0-9][A-Z]))\\s?([0-9][A-Z]{2})$")); boost::tmatch what; if(boost::regex_search(address, what, r)) { // extract $0 as a CString: return CString(what[0].first, what.length()); } else { throw std::runtime_error("No postcode found"); } }
regex_search (second overload)

template <class charT, class T> inline bool regex_search(const ATL::CSimpleStringT<charT>& s, const basic_regex<charT, T>& e, boost::regex_constants::match_flag_type f = boost::regex_constants::match_default)
Effects: returns ::boost::regex_search(s.GetString(), s.GetString() + s.GetLength(), e, f);
regex_replace
There are two additional overloads for regex_replace, the rst sends output to an output iterator, while the second creates a new string
138
Boost.Regex
template <class OutputIterator, class BidirectionalIterator, class traits, class charT> OutputIterator regex_replace(OutputIterator out, BidirectionalIterator first, BidirectionalIterator last, const basic_regex<charT, traits>& e, const ATL::CSimpleStringT<charT>& fmt, match_flag_type flags = match_default)
Effects: returns ::boost::regex_replace(out, first, last, e, fmt.GetString(), flags);

template <class traits, charT> ATL::CSimpleStringT<charT> regex_replace(const ATL::CSimpleStringT<charT>& s, const basic_regex<charT, traits>& e, const ATL::CSimpleStringT<charT>& fmt, match_flag_type flags = match_default)
Effects: returns a new string created using regex_replace, and the same memory manager as string s. Example:
// // Take a credit card number as a string of digits, // and reformat it as a human readable string with "-" // separating each group of four digits: // const boost::tregex e(__T("\\A(\\d{3,4})[- ]?(\\d{4})[- ]?(\\d{4})[- ]?(\\d{4})\\z")); const CString human_format = __T("$1-$2-$3-$4"); CString human_readable_card_number(const CString& s) { return boost::regex_replace(s, e, human_format); }
Iterating Over the Matches Within An MFC String

The following helper functions are provided to ease the conversion from an MFC/ATL string to a regex_iterator or regex_token_iterator:
regex_iterator creation helper

template <class charT> regex_iterator<charT const*> make_regex_iterator( const ATL::CSimpleStringT<charT>& s, const basic_regex<charT>& e, ::boost::regex_constants::match_flag_type f = boost::regex_constants::match_default);
Effects: returns regex_iterator(s.GetString(), s.GetString() + s.GetLength(), e, f); Example:
139
Boost.Regex
void enumerate_links(const CString& html) { // enumerate and print all the links in some HTML text, // the expression used is by Andew Lee on www.regxlib.com: boost::tregex r( __T("href=[\"\']((http:\\/\\/|\\.\\/|\\/)?\\w+" "(\\.\\w+)*(\\/\\w+(\\.\\w+)?)*" "(\\/|\\?\\w*=\\w*(&\\w*=\\w*)*)?)[\"\']")); boost::tregex_iterator i(boost::make_regex_iterator(html, r)), j; while(i != j) { std::cout << (*i)[1] << std::endl; ++i; } }
regex_token_iterator creation helpers

template <class charT> regex_token_iterator<charT const*> make_regex_token_iterator( const ATL::CSimpleStringT<charT>& s, const basic_regex<charT>& e, int sub = 0, ::boost::regex_constants::match_flag_type f = boost::regex_constants::match_default);
Effects: returns regex_token_iterator(s.GetString(), s.GetString() + s.GetLength(), e, sub, f);

template <class charT> regex_token_iterator<charT const*> make_regex_token_iterator( const ATL::CSimpleStringT<charT>& s, const basic_regex<charT>& e, const std::vector<int>& subs, ::boost::regex_constants::match_flag_type f = boost::regex_constants::match_default);
Effects: returns regex_token_iterator(s.GetString(), s.GetString() + s.GetLength(), e, subs, f);

template <class charT, std::size_t N> regex_token_iterator<charT const*> make_regex_token_iterator( const ATL::CSimpleStringT<charT>& s, const basic_regex<charT>& e, const int (& subs)[N], ::boost::regex_constants::match_flag_type f = boost::regex_constants::match_default);
Effects: returns regex_token_iterator(s.GetString(), s.GetString() + s.GetLength(), e, subs, f); Example:
140
Boost.Regex
void enumerate_links2(const CString& html) { // enumerate and print all the links in some HTML text, // the expression used is by Andew Lee on www.regxlib.com: boost::tregex r( __T("href=[\"\']((http:\\/\\/|\\.\\/|\\/)?\\w+" "(\\.\\w+)*(\\/\\w+(\\.\\w+)?)*" "(\\/|\\?\\w*=\\w*(&\\w*=\\w*)*)?)[\"\']")); boost::tregex_token_iterator i(boost::make_regex_token_iterator(html, r, 1)), j; while(i != j) { std::cout << *i << std::endl; ++i; } }
POSIX Compatible C API's

Note
this is an abridged reference to the POSIX API functions, these are provided for compatibility with other libraries, rather than as an API to be used in new code (unless you need access from a language other than C++). This version of these functions should also happily coexist with other versions, as the names used are macros that expand to the actual function names.
#include <boost/cregex.hpp>
or:
#include <boost/regex.h>
The following functions are available for users who need a POSIX compatible C library, they are available in both Unicode and narrow character versions, the standard POSIX API names are macros that expand to one version or the other depending upon whether UNICODE is dened or not.
Important
Note that all the symbols dened here are enclosed inside namespace boost when used in C++ programs, unless you use #include <boost/regex.h> instead - in which case the symbols are still dened in namespace boost, but are made available in the global namespace as well. The functions are dened as:
141
Boost.Regex
extern "C" { struct regex_tA; struct regex_tW; int regcompA(regex_tA*, const char*, int); unsigned int regerrorA(int, const regex_tA*, char*, unsigned int); int regexecA(const regex_tA*, const char*, unsigned int, regmatch_t*, int); void regfreeA(regex_tA*); int regcompW(regex_tW*, const wchar_t*, int); unsigned int regerrorW(int, const regex_tW*, wchar_t*, unsigned int); int regexecW(const regex_tW*, const wchar_t*, unsigned int, regmatch_t*, int); void regfreeW(regex_tW*); #ifdef UNICODE #define regcomp regcompW #define regerror regerrorW #define regexec regexecW #define regfree regfreeW #define regex_t regex_tW #else #define regcomp regcompA #define regerror regerrorA #define regexec regexecA #define regfree regfreeA #define regex_t regex_tA #endif }
All the functions operate on structure regex_t, which exposes two public members: Member
unsigned int re_nsub
Meaning This is lled in by regcomp and indicates the number of subexpressions contained in the regular expression. Points to the end of the expression to compile when the ag REG_PEND is set.
const TCHAR* re_endp
Note
regex_t is actually a #define - it is either regex_tA or regex_tW depending upon whether UNICODE is dened or not, TCHAR is either char or wchar_t again depending upon the macro UNICODE.
regcomp
regcomp takes a pointer to a regex_t, a pointer to the expression to compile and a ags parameter which can be a combination of:
142
Boost.Regex
Flag REG_EXTENDED
Meaning Compiles modern regular expressions. Equivalent to regbase::char_classes | regbase::intervals | regbase::bk_refs.
REG_BASIC
Compiles basic (obsolete) regular expression syntax. Equivalent to regbase::char_classes | regbase::intervals |

regbase::limited_ops | regbase::bk_braces regbase::bk_parens | regbase::bk_refs. |
REG_NOSPEC REG_ICASE REG_NOSUB REG_NEWLINE REG_PEND
All characters are ordinary, the expression is a literal string. Compiles for matching that ignores character case. Has no effect in this library. When this ag is set a dot does not match the newline character. When this ag is set the re_endp parameter of the regex_t structure must point to the end of the regular expression to compile. When this ag is set then locale dependent collation for character ranges is turned off. When this ag is set, then escape sequences are permitted in bracket expressions (character sets). When this ag is set then the newline character is equivalent to the alternation operator |. Compiles Perl like regular expressions. A shortcut for awk-like behavior: REG_EXTENDED | REG_ESCAPE_IN_LISTS
REG_NOCOLLATE
REG_ESCAPE_IN_LISTS
REG_NEWLINE_ALT
REG_PERL REG_AWK
REG_GREP
shortcut
for
grep
like
behavior:
REG_BASIC
REG_NEWLINE_ALT
REG_EGREP
A shortcut for egrep like behavior: REG_EXTENDED

REG_NEWLINE_ALT
regerror
regerror takes the following parameters, it maps an error code to a human readable string: Parameter int code const regex_t* e char* buf unsigned int buf_size Meaning The error code. The regular expression (can be null). The buffer to ll in with the error message. The length of buf.
143
Boost.Regex
If the error code is OR'ed with REG_ITOA then the message that results is the printable name of the code rather than a message, for example "REG_BADPAT". If the code is REG_ATIO then e must not be null and e->re_pend must point to the printable name of an error code, the return value is then the value of the error code. For any other value of code, the return value is the number of characters in the error message, if the return value is greater than or equal to buf_size then regerror will have to be called again with a larger buffer.
regexec
regexec nds the rst occurrence of expression e within string buf. If len is non-zero then *m is lled in with what matched the regular expression, m[0] contains what matched the whole string, m[1] the rst sub-expression etc, see regmatch_t in the header le declaration for more details. The eags parameter can be a combination of: Flag REG_NOTBOL REG_NOTEOL REG_STARTEND Meaning Parameter buf does not represent the start of a line. Parameter buf does not terminate at the end of a line. The string searched starts at buf + pmatch[0].rm_so and ends at buf + pmatch[0].rm_eo.
regfree
regfree frees all the memory that was allocated by regcomp.
Concepts
charT Requirements
Type charT used a template argument to class template basic_regex, must have a trivial default constructor, copy constructor, assignment operator, and destructor. In addition the following requirements must be met for objects; c of type charT, c1 and c2 of type charT const, and i of type int:
144
Boost.Regex
Expression charT c charT c(c1) c1 = c2 c1 == c2 c1 != c2 c1 < c2 c1 > c2 c1 <= c2 c1 >= c2 intmax_t i = c1
Return type charT charT charT bool bool bool bool bool bool int
Assertion / Note / Pre- / Post-condition Default constructor (must be trivial). Copy constructor (must be trivial). Assignment operator (must be trivial). true if c1 has the same value as c2. true if c1 and c2 are not equal. true if the value of c1 is less than c2. true if the value of c1 is greater than c2. true if c1 is less than or equal to c2. true if c1 is greater than or equal to c2. charT must be convertible to an integral type. Note: type charT is not required to support this operation, if the traits class used supports the full Boost-specic interface, rather than the minimal standardised-interface (see traits class requirements below).
charT c(i);
charT
charT must be constructable from an integral type.
Traits Class Requirements

There are two sets of requirements for the traits template argument to basic_regex: a mininal interface (which is part of the regex standardization proposal), and an optional Boost-specic enhanced interface.
Minimal requirements.
In the following table X denotes a traits class dening types and functions for the character container type charT; u is an object of type X; v is an object of type const X; p is a value of type const charT*; I1 and I2 are Input Iterators; c is a value of type const charT; s is an object of type X::string_type; cs is an object of type const X::string_type; b is a value of type bool; I is a value of type int; F1 and F2 are values of type const charT*; and loc is an object of type X::locale_type.
145
Boost.Regex
Expression X::char_type
Return type charT
Assertion / Note Pre / Post condition The character container type used in the implementation of class template basic_regex. An unsigned integer type, capable of holding the length of a null-terminated string of charT's.
X::size_type
X::string_type
std::basic_string<charT> tor<charT> Implementation dened
or
std::vec-
X::locale_type
A copy constructible type that represents the locale used by the traits class. A bitmask type representing a particular character classication. Multiple values of this type can be bitwise-or'ed together to obtain a new valid value. Yields the smallest i such that p[i] == 0. Complexity is linear in i. Returns a character such that for any character d that is to be considered equivalent to c then v.translate(c) == v.translate(d). For all characters C that are to be considered equivalent to c when comparisons are to be performed without regard to case, then v.translate_nocase(c) == v.translate_nocase(C). Returns a sort key for the character sequence designated by the iterator range [F1, F2) such that if the character sequence [G1, G2) sorts before the character sequence [H1, H2) then v.transform(G1, G2) < v.transform(H1, H2). Returns a sort key for the character sequence designated by the iterator range [F1, F2) such that if the character sequence [G1, G2) sorts before the character sequence [H1, H2) when character case is not considered then v.transform_primary(G1, G2) < v.transform_primary(H1, H2).
X::char_class_type
Implementation dened
X::length(p)
X::size_type
v.translate(c)
X::char_type
v.translate_nocase(c)
X::char_type
v.transform(F1, F2)
X::string_type
v.transform_primary(F1, F2)
X::string_type
146
Boost.Regex
Expression v.lookup_classname(F1, F2)
Return type X::char_class_type
Assertion / Note Pre / Post condition Converts the character sequence designated by the iterator range [F1,F2) into a bitmask type that can subsequently be passed to isctype. Values returned from lookup_classname can be safely bitwise or'ed together. Returns 0 if the character sequence is not the name of a character class recognized by X. The value returned shall be independent of the case of the characters in the sequence. Returns a sequence of characters that represents the collating element consisting of the character sequence designated by the iterator range [F1, F2). Returns an empty string if the character sequence is not a valid collating element. Returns true if character c is a member of the character class designated by the iterator range [F1, F2), false otherwise. Returns the value represented by the digit c in base I if the character c is a valid digit in base I; otherwise returns -1. [Note: the value of I will only be 8, 10, or 16. -end note] Imbues u with the locale loc, returns the previous locale used by u if any. Returns the current locale used by v if any.
v.lookup_collatename(F1, F2)
X::string_type
v.isctype(c, v.lookup_classname (F1, F2))
bool
v.value(c, I)
int
u.imbue(loc)
X::locale_type
v.getloc()
X::locale_type
Additional Optional Requirements

The following additional requirements are strictly optional, however in order for basic_regex to take advantage of these additional interfaces, all of the following requirements must be met; basic_regex will detect the presence or absense of the member boost_extensions_tag and congure itself appropriately.
147
Boost.Regex
Expression X::boost_extensions_tag
Result An unspecied type.
Assertion / Note Pre / Post condition When present, all of the extensions listed in this table must be present. Returns a symbolic value of type regex_constants::syntax_type that signies the meaning of character c within the regular expression grammar. Returns a symbolic value of type regex_constants::escape_syntax_type, that signies the meaning of character c within the regular expression grammar, when c has been preceded by an escape character. Precondition: if b is the character preceding c in the expression being parsed then:
v.syntax_type(b) == syntax_escape
v.syntax_type(c)
regex_constants::syntax_type
v.escape_syntax_type(c)
regex_constants::escape_syntax_type
v.translate(c, b)
X::char_type
Returns a character d such that: for any character d that is to be considered equivalent to c then v.translate(c,false)==v.translate(d,false). Likewise for all charac-
ters C that are to be considered equivalent to c when comparisons are to be performed without regard to case, then
v.translate(c,true)==v.translate(C,true).
v.toi(I1, I2, i)
An integer type capable of holding either a charT or an int.
Behaves as follows: if p == q or if *p is not a digit character then returns -1. Otherwise performs formatted numeric input on the sequence [p,q) and returns the result as an int. Postcondition: either p == q or *p is a non-digit character. Returns a human readable error string for the error condition i, where i is one of the values enumerated by type regex_constants::error_type. If the value I is not recognized then returns the string "Unknown error" or a localized equivalent. Converts c to lower case, used for Perlstyle \l and \L formating operations. Converts c to upper case, used for Perlstyle \u and \U formating operations.
v.error_string(I)
std::string
v.tolower(c)
X::char_type
v.toupper(c)
X::char_type
Iterator Requirements
The regular expression algorithms (and iterators) take all require a Bidirectional-Iterator.
148
Boost.Regex
Deprecated Interfaces
regex_format (Deprecated)
The algorithm regex_format is deprecated; new code should use match_results<>::format instead. Existing code will continue to compile, the following documentation is taken from the previous version of Boost.Regex and will not be further updated:
Algorithm regex_format
The algorithm regex_format takes the results of a match and creates a new string based upon a format string, regex_format can be used for search and replace operations:
template <class OutputIterator, class iterator, class Allocator, class Formatter> OutputIterator regex_format(OutputIterator out, const match_results<iterator, Allocator>& m, Formatter fmt, match_flag_type flags = 0);
The library also denes the following convenience variation of regex_format, which returns the result directly as a string, rather than outputting to an iterator.
Note
This version may not be available, or may be available in a more limited form, depending upon your compilers capabilities
template <class iterator, class Allocator, class Formatter> std::basic_string<charT> regex_format (const match_results<iterator, Allocator>& m, Formatter fmt, match_flag_type flags = 0);
Parameters to the main version of the function are passed as follows: Parameter
OutputIterator out
Description An output iterator type, the output string is sent to this iterator. Typically this would be a std::ostream_iterator. An instance of match_results obtained from one of the matching algorithms above, and denoting what matched. Either a format string that determines how the match is transformed into the new string, or a functor that computes the new string from m - see match_results<>::format. Optional ags which describe how the format string is to be interpreted.
const match_results<iterator, Allocator>& m
Formatter fmt
unsigned flags
Format ags are described under match_flag_type. The format string syntax (and available options) is described more fully under format strings.
149
Boost.Regex
regex_grep (Deprecated)
The algorithm regex_grep is deprecated in favor of regex_iterator which provides a more convenient and standard library friendly interface. The following documentation is taken unchanged from the previous boost release, and will not be updated in future.
#include <boost/regex.hpp> regex_grep allows you to search through a bidirectional-iterator range and locate all the (non-overlapping) matches with a given
regular expression. The function is declared as:

template <class Predicate, class iterator, class charT, class traits> unsigned int regex_grep(Predicate foo, iterator first, iterator last, const basic_regex<charT, traits>& e, boost::match_flag_type flags = match_default)
The library also denes the following convenience versions, which take either a const charT*, or a const std::basic_string<>& in place of a pair of iterators.
template <class Predicate, class charT, class traits> unsigned int regex_grep(Predicate foo, const charT* str, const basic_regex<charT, traits>& e, boost::match_flag_type flags = match_default); template <class Predicate, class ST, class SA, class charT, class traits> unsigned int regex_grep(Predicate foo, const std::basic_string<charT, ST, SA>& s, const basic_regex<charT, traits>& e, boost::match_flag_type flags = match_default);
The parameters for the primary version of regex_grep have the following meanings: foo: A predicate function object or function pointer, see below for more information. rst: The start of the range to search. last: The end of the range to search. e: The regular expression to search for. ags: The ags that determine how matching is carried out, one of the match_ags enumerators. The algorithm nds all of the non-overlapping matches of the expression e, for each match it lls a match_results<iterator> structure, which contains information on what matched, and calls the predicate foo, passing the match_results<iterator> as a single argument. If the predicate returns true, then the grep operation continues, otherwise it terminates without searching for further matches. The function returns the number of matches found. The general form of the predicate is:
struct grep_predicate { bool operator()(const match_results<iterator_type>& m); };
150
Boost.Regex
For example the regular expression "a*b" would nd one match in the string "aaaaab" and two in the string "aaabb". Remember this algorithm can be used for a lot more than implementing a version of grep, the predicate can be and do anything that you want, grep utilities would output the results to the screen, another program could index a le based on a regular expression and store a set of bookmarks in a list, or a text le conversion utility would output to le. The results of one regex_grep can even be chained into another regex_grep to create recursive parsers. The algorithm may throw std::runtime_error if the complexity of matching the expression against an N character string begins to exceed O(N2), or if the program runs out of stack space while matching the expression (if Boost.Regex is congured in recursive mode), or if the matcher exhausts it's permitted memory allocation (if Boost.Regex is congured in non-recursive mode). Example: convert the example from regex_search to use regex_grep instead:
#include <string> #include <map> #include <boost/regex.hpp> // IndexClasses: // takes the contents of a file in the form of a string // and searches for all the C++ class definitions, storing // their locations in a map of strings/int's typedef std::map<std::string, int, std::less<std::string> > map_type; const char* re = // possibly leading whitespace: "^[[:space:]]*" // possible template declaration: "(template[[:space:]]*<[^;:{]+>[[:space:]]*)?" // class or struct: "(class|struct)[[:space:]]*" // leading declspec macros etc: "(" "\\<\\w+\\>" "(" "[[:blank:]]*\$[^)]*\$" ")?" "[[:space:]]*" ")*" // the class name "(\\<\\w*\\>)[[:space:]]*" // template specialisation parameters "(<[^;:{]+>)?[[:space:]]*" // terminate in { or : "(\\{|:[^;\\{()]*\\{)"; boost::regex expression(re); class IndexClassesPred { map_type& m; std::string::const_iterator base; public: IndexClassesPred(map_type& a, std::string::const_iterator b) : m(a), base(b) {} bool operator()(const smatch& what) { // what[0] contains the whole string // what[5] contains the class name. // what[6] contains the template specialisation if any. // add class name and position to map: m[std::string(what[5].first, what[5].second) + std::string(what[6].first, what[6].second)] = what[5].first - base; return true; }
151
Boost.Regex
}; void IndexClasses(map_type& m, const std::string& file) { std::string::const_iterator start, end; start = file.begin(); end = file.end(); regex_grep(IndexClassesPred(m, start), start, end, expression); }
Example: Use regex_grep to call a global callback function:

#include <string> #include <map> #include <boost/regex.hpp> // purpose: // takes the contents of a file in the form of a string // and searches for all the C++ class definitions, storing // their locations in a map of strings/int's typedef std::map<std::string, int, std::less<std::string> > map_type; const char* re = // possibly leading whitespace: "^[[:space:]]*" // possible template declaration: "(template[[:space:]]*<[^;:{]+>[[:space:]]*)?" // class or struct: "(class|struct)[[:space:]]*" // leading declspec macros etc: "(" "\\<\\w+\\>" "(" "[[:blank:]]*\$[^)]*\$" ")?" "[[:space:]]*" ")*" // the class name "(\\<\\w*\\>)[[:space:]]*" // template specialisation parameters "(<[^;:{]+>)?[[:space:]]*" // terminate in { or : "(\\{|:[^;\\{()]*\\{)"; boost::regex expression(re); map_type class_index; std::string::const_iterator base; bool grep_callback(const boost::smatch& what) { // what[0] contains the whole string // what[5] contains the class name. // what[6] contains the template specialisation if any. // add class name and position to map: class_in dex[std::string(what[5].first, what[5].second) + std::string(what[6].first, what[6].second)] = what[5].first - base; return true; } void IndexClasses(const std::string& file) {
152
Boost.Regex
std::string::const_iterator start, end; start = file.begin(); end = file.end(); base = start; regex_grep(grep_callback, start, end, expression, match_default); }
Example: use regex_grep to call a class member function, use the standard library adapters std::mem_fun and std::bind1st to convert the member function into a predicate:
#include <string> #include <map> #include <boost/regex.hpp> #include <functional> // purpose: // takes the contents of a file in the form of a string // and searches for all the C++ class definitions, storing // their locations in a map of strings/int's typedef std::map<std::string, int, std::less<std::string> > map_type; class class_index { boost::regex expression; map_type index; std::string::const_iterator base; bool grep_callback(boost::smatch what); public: void IndexClasses(const std::string& file); class_index() : index(), expression("^(template[[:space:]]*<[^;:{]+>[[:space:]]*)?" "(class|struct)[[:space:]]*(\\<\\w+\\>([[:blank:]]*\$[^)]*\$)?" "[[:space:]]*)*(\\<\\w*\\>)[[:space:]]*(<[^;:{]+>[[:space:]]*)?" "(\\{|:[^;\\{()]*\\{)" ){} }; bool class_index::grep_callback(boost::smatch what) { // what[0] contains the whole string // what[5] contains the class name. // what[6] contains the template specialisation if any. // add class name and position to map: index[std::string(what[5].first, what[5].second) + std::string(what[6].first, what[6].second)] = what[5].first - base; return true; } void class_index::IndexClasses(const std::string& file) { std::string::const_iterator start, end; start = file.begin(); end = file.end(); base = start; regex_grep(std::bind1st(std::mem_fun(&class_index::grep_callback), this), start, end, expression); }
Finally, C++ Builder users can use C++ Builder's closure type as a callback argument:
153
Boost.Regex
#include <string> #include <map> #include <boost/regex.hpp> #include <functional> // purpose: // takes the contents of a file in the form of a string // and searches for all the C++ class definitions, storing // their locations in a map of strings/int's typedef std::map<std::string, int, std::less<std::string> > map_type; class class_index { boost::regex expression; map_type index; std::string::const_iterator base; typedef boost::smatch arg_type; bool grep_callback(const arg_type& what); public: typedef bool (__closure* grep_callback_type)(const arg_type&); void IndexClasses(const std::string& file); class_index() : index(), expression("^(template[[:space:]]*<[^;:{]+>[[:space:]]*)?" "(class|struct)[[:space:]]*(\\<\\w+\\>([[:blank:]]*\$[^)]*\$)?" "[[:space:]]*)*(\\<\\w*\\>)[[:space:]]*(<[^;:{]+>[[:space:]]*)?" "(\\{|:[^;\\{()]*\\{)" ){} }; bool class_index::grep_callback(const arg_type& what) { // what[0] contains the whole string // what[5] contains the class name. // what[6] contains the template specialisation if any. // add class name and position to map: index[std::string(what[5].first, what[5].second) + std::string(what[6].first, what[6].second)] = what[5].first - base; return true; } void class_index::IndexClasses(const std::string& file) { std::string::const_iterator start, end; start = file.begin(); end = file.end(); base = start; class_index::grep_callback_type cl = &(this->grep_callback); regex_grep(cl, start, end, expression); }
regex_split (deprecated)
The algorithm regex_split has been deprecated in favor of the iterator regex_token_iterator which has a more exible and powerful interface, as well as following the more usual standard library "pull" rather than "push" semantics. Code which uses regex_split will continue to compile, the following documentation is taken from a previous Boost.Regex version:
154
Boost.Regex
Algorithm regex_split performs a similar operation to the perl split operation, and comes in three overloaded forms:
template <class OutputIterator, class charT, class Traits1, class Alloc1, class Traits2> std::size_t regex_split(OutputIterator out, std::basic_string<charT, Traits1, Alloc1>& s, const basic_regex<charT, Traits2>& e, boost::match_flag_type flags, std::size_t max_split); template <class OutputIterator, class charT, class Traits1, class Alloc1, class Traits2> std::size_t regex_split(OutputIterator out, std::basic_string<charT, Traits1, Alloc1>& s, const basic_regex<charT, Traits2>& e, boost::match_flag_type flags = match_default); template <class OutputIterator, class charT, class Traits1, class Alloc1> std::size_t regex_split(OutputIterator out, std::basic_string<charT, Traits1, Alloc1>& s);
Effects: Each version of the algorithm takes an output-iterator for output, and a string for input. If the expression contains no marked sub-expressions, then the algorithm writes one string onto the output-iterator for each section of input that does not match the expression. If the expression does contain marked sub-expressions, then each time a match is found, one string for each marked sub-expression will be written to the output-iterator. No more than max_split strings will be written to the output-iterator. Before returning, all the input processed will be deleted from the string s (if max_split is not reached then all of s will be deleted). Returns the number of strings written to the output-iterator. If the parameter max_split is not specied then it defaults to UINT_MAX. If no expression is specied, then it defaults to "\s+", and splitting occurs on whitespace. Throws: std::runtime_error if the complexity of matching the expression against an N character string begins to exceed O(N2), or if the program runs out of stack space while matching the expression (if Boost.Regex is congured in recursive mode), or if the matcher exhausts its permitted memory allocation (if Boost.Regex is congured in non-recursive mode). Example: the following function will split the input string into a series of tokens, and remove each token from the string s:
unsigned tokenise(std::list<std::string>& l, std::string& s) { return boost::regex_split(std::back_inserter(l), s); }
Example: the following short program will extract all of the URL's from a html le, and print them out to cout:
155
Boost.Regex
#include #include #include #include
<list> <fstream> <iostream> <boost/regex.hpp>
boost::regex e("<\\s*A\\s+[^>]*href\\s*=\\s*\"([^\"]*)\"", boost::regbase::normal | boost::regbase::icase); void load_file(std::string& s, std::istream& is) { s.erase(); // // attempt to grow string buffer to match file size, // this doesn't always work... s.reserve(is.rdbuf()-&gtin_avail()); char c; while(is.get(c)) { // use logarithmic growth stategy, in case // in_avail (above) returned zero: if(s.capacity() == s.size()) s.reserve(s.capacity() * 3); s.append(1, c); } }
int main(int argc, char** argv) { std::string s; std::list<std::string> l; for(int i = 1; i < argc; ++i) { std::cout << "Findings URL's in " << argv[i] << ":" << std::endl; s.erase(); std::ifstream is(argv[i]); load_file(s, is); boost::regex_split(std::back_inserter(l), s, e); while(l.size()) { s = *(l.begin()); l.pop_front(); std::cout << s << std::endl; } } return 0; }
High Level Class RegEx (Deprecated)

The high level wrapper class RegEx is now deprecated and does not form part of the regular expression standardization proposal. This type still exists, and existing code will continue to compile, however the following documentation is unlikely to be further updated.
#include <boost/cregex.hpp>
The class RegEx provides a high level simplied interface to the regular expression library, this class only handles narrow character strings, and regular expressions always follow the "normal" syntax - that is the same as the perl / ECMAScript synatx.
156
Boost.Regex
typedef bool (*GrepCallback)(const RegEx& expression); typedef bool (*GrepFileCallback)(const char* file, const RegEx& expression); typedef bool (*FindFilesCallback)(const char* file); class RegEx { public: RegEx(); RegEx(const RegEx& o); ~RegEx(); RegEx(const char* c, bool icase = false); explicit RegEx(const std::string& s, bool icase = false); RegEx& operator=(const RegEx& o); RegEx& operator=(const char* p); RegEx& operator=(const std::string& s); unsigned int SetExpression(const char* p, bool icase = false); unsigned int SetExpression(const std::string& s, bool icase = false); std::string Expression()const; // // now matching operators: // bool Match(const char* p, boost::match_flag_type flags = match_default); bool Match(const std::string& s, boost::match_flag_type flags = match_default); bool Search(const char* p, boost::match_flag_type flags = match_default); bool Search(const std::string& s, boost::match_flag_type flags = match_default); unsigned int Grep(GrepCallback cb, const char* p, boost::match_flag_type flags = match_default); unsigned int Grep(GrepCallback cb, const std::string& s, boost::match_flag_type flags = match_default); unsigned int Grep(std::vector<std::string>& v, const char* p, boost::match_flag_type flags = match_default); unsigned int Grep(std::vector<std::string>& v, const std::string& s, boost::match_flag_type flags = match_default); unsigned int Grep(std::vector<unsigned int>& v, const char* p, boost::match_flag_type flags = match_default); unsigned int Grep(std::vector<unsigned int>& v, const std::string& s, boost::match_flag_type flags = match_default); unsigned int GrepFiles(GrepFileCallback cb, const char* files, bool recurse = false, boost::match_flag_type flags = match_default); unsigned int GrepFiles(GrepFileCallback cb, const std::string& files, bool recurse = false, boost::match_flag_type flags = match_default); unsigned int FindFiles(FindFilesCallback cb, const char* files, bool recurse = false, boost::match_flag_type flags = match_default); unsigned int FindFiles(FindFilesCallback cb, const std::string& files, bool recurse = false, boost::match_flag_type flags = match_default); std::string Merge(const std::string& in, const std::string& fmt, bool copy = true, boost::match_flag_type flags = match_default); std::string Merge(const char* in, const char* fmt, bool copy = true, boost::match_flag_type flags = match_default); unsigned Split(std::vector<std::string>& v, std::string& s, boost::match_flag_type flags = match_default, unsigned max_count = ~0); // // now operators for returning what matched in more detail: // unsigned int Position(int i = 0)const; unsigned int Length(int i = 0)const; bool Matched(int i = 0)const; unsigned int Line()const;
157
Boost.Regex
unsigned int Marks() const; std::string What(int i)const; std::string operator[](int i)const ; static const unsigned int npos; };
Member functions for class RegEx are dened as follows:
158
Boost.Regex
Member
RegEx();
Description Default constructor, constructs an instance of RegEx without any valid expression. Copy constructor, all the properties of parameter o are copied. Constructs an instance of RegEx, setting the expression to c, if icase is true then matching is insensitive to case, otherwise it is sensitive to case. Throws bad_expression on failure. Constructs an instance of RegEx, setting the expression to s, if icase is true then matching is insensitive to case, otherwise it is sensitive to case. Throws bad_expression on failure. Default assignment operator. Assignment operator, equivalent to calling SetExpression(p, false). Throws bad_expression on failure. Assignment operator, equivalent to calling SetExpression(s, false). Throws bad_expression on failure. Sets the current expression to p, if icase is true then matching is insensitive to case, otherwise it is sensitive to case. Throws bad_expression on failure. Sets the current expression to s, if icase is true then matching is insensitive to case, otherwise it is sensitive to case. Throws bad_expression on failure. Returns a copy of the current regular expression. Attempts to match the current expression against the text p using the match ags ags - see match_flag_type. Returns true if the expression matches the whole of the input string. Attempts to match the current expression against the text s using the match_flag_type ags. Returns true if the expression matches the whole of the input string. Attempts to nd a match for the current expression somewhere in the text p using the match_flag_type ags. Returns true if the match succeeds. Attempts to nd a match for the current expression somewhere in the text s using the match_flag_type ags. Returns true if the match succeeds. Finds all matches of the current expression in the text p using the match_flag_type ags. For each match found calls the call-back function cb as: cb(*this); If at any stage the callback function returns false then the grep operation terminates, otherwise continues until no further matches are found. Returns the number of matches found.
RegEx(const RegEx& o); RegEx(const char* c, bool icase = false);
RegEx(const std::string& s, bool icase = false);
RegEx& operator=(const RegEx& o); RegEx& operator=(const char* p);
RegEx& operator=(const std::string& s);
unsigned int SetExpression(constchar* p, bool icase = false);
unsigned int SetExpression(const std::string& s, bool icase = false);
std::string Expression()const; bool Match(const char* p, boost::match_flag_type flags = match_default);
bool Match(const std::string& s, boost::match_flag_type flags = match_default);
bool Search(const char* p, boost::match_flag_type flags = match_default);
bool Search(const std::string& s, boost::match_flag_type flags = match_default);
unsigned int Grep(GrepCallback cb, const char* p, boost::match_flag_type flags = match_default);
159
Boost.Regex
Member
unsigned int Grep(GrepCallback cb, const std::string& s, boost::match_flag_type flags = match_default);
Description Finds all matches of the current expression in the text s using the match_flag_type ags. For each match found calls the call-back function cb as: cb(*this); If at any stage the callback function returns false then the grep operation terminates, otherwise continues until no further matches are found. Returns the number of matches found. Finds all matches of the current expression in the text p using the match_flag_type ags. For each match pushes a copy of what matched onto v. Returns the number of matches found. Finds all matches of the current expression in the text s using the match_flag_type ags. For each match pushes a copy of what matched onto v. Returns the number of matches found. Finds all matches of the current expression in the text p using the match_flag_type ags. For each match pushes the starting index of what matched onto v. Returns the number of matches found. Finds all matches of the current expression in the text s using the match_flag_type ags. For each match pushes the starting index of what matched onto v. Returns the number of matches found. Finds all matches of the current expression in the les les using the match_flag_type ags. For each match calls the call-back function cb. If the call-back returns false then the algorithm returns without considering further matches in the current le, or any further les. The parameter les can include wild card characters '*' and '?', if the parameter recurse is true then searches sub-directories for matching le names. Returns the total number of matches found. May throw an exception derived from std::runtime_error if le io fails.
unsigned int Grep(std::vector<std::string>& v, const char* p, boost::match_flag_type flags = match_default); unsigned int Grep(std::vector<std::string>& v, const std::string& s, boost::match_flag_type flags = match_default); unsigned int Grep(std::vector<unsigned int>& v, const char* p, boost::match_flag_type flags = match_default);
unsigned int Grep(std::vector<unsigned int>& v, const std::string& s, boost::match_flag_type flags = match_default);
unsigned int GrepFiles(GrepFileCallback cb, const char* files, bool recurse = false, boost::match_flag_type flags = match_default);
unsigned int GrepFiles(GrepFileCallback cb, const std::string& files, bool recurse = false, boost::match_flag_type flags = match_default);
Finds all matches of the current expression in the les les using the match_flag_type ags. For each match calls the call-back function cb. If the call-back returns false then the algorithm returns without considering further matches in the current le, or any further les. The parameter les can include wild card characters '*' and '?', if the parameter recurse is true then searches sub-directories for matching le names. Returns the total number of matches found. May throw an exception derived from std::runtime_error if le io fails.
160
Boost.Regex
Member
unsigned int FindFiles(FindFilesCallback cb, const char* files, bool recurse = false, boost::match_flag_type flags = match_default);
Description Searches les to nd all those which contain at least one match of the current expression using the match_flag_type ags. For each matching le calls the call-back function cb. If the call-back returns false then the algorithm returns without considering any further les. The parameter les can include wild card characters '*' and '?', if the parameter recurse is true then searches sub-directories for matching le names. Returns the total number of les found. May throw an exception derived from std::runtime_error if le io fails.
unsigned int FindFiles(FindFilesCallback cb, const std::string& files, bool recurse = false, boost::match_flag_type flags = match_default);
Searches les to nd all those which contain at least one match of the current expression using the match_flag_type ags. For each matching le calls the call-back function cb. If the call-back returns false then the algorithm returns without considering any further les. The parameter les can include wild card characters '*' and '?', if the parameter recurse is true then searches sub-directories for matching le names. Returns the total number of les found. May throw an exception derived from std::runtime_error if le io fails.
std::string Merge(const std::string& in, const std::string& fmt, bool copy = true, boost::match_flag_type flags = match_default);
Performs a search and replace operation: searches through the string in for all occurrences of the current expression, for each occurrence replaces the match with the format string fmt. Uses ags to determine what gets matched, and how the format string should be treated. If copy is true then all unmatched sections of input are copied unchanged to output, if the ag format_rst_only is set then only the rst occurance of the pattern found is replaced. Returns the new string. See also format string syntax, and match_flag_type. Performs a search and replace operation: searches through the string in for all occurrences of the current expression, for each occurrence replaces the match with the format string fmt. Uses ags to determine what gets matched, and how the format string should be treated. If copy is true then all unmatched sections of input are copied unchanged to output, if the ag format_rst_only is set then only the rst occurance of the pattern found is replaced. Returns the new string. See also format string syntax, and match_flag_type.
std::string Merge(const char* in, const char* fmt, bool copy = true, boost::match_flag_type flags = match_default);
161
Boost.Regex
Member
unsigned Split(std::vector<std::string>& v, std::string& s, boost::match_flag_type flags = match_default, unsigned max_count = ~0);
Description Splits the input string and pushes each one onto the vector. If the expression contains no marked sub-expressions, then one string is outputted for each section of the input that does not match the expression. If the expression does contain marked sub-expressions, then outputs one string for each marked subexpression each time a match occurs. Outputs no more than max_count strings. Before returning, deletes from the input string s all of the input that has been processed (all of the string if max_count was not reached). Returns the number of strings pushed onto the vector. Returns the position of what matched sub-expression i. If i = 0 then returns the position of the whole match. Returns RegEx::npos if the supplied index is invalid, or if the specied sub-expression did not participate in the match. Returns the length of what matched sub-expression i. If i = 0 then returns the length of the whole match. Returns RegEx::npos if the supplied index is invalid, or if the specied sub-expression did not participate in the match. Returns true if sub-expression i was matched, false otherwise. Returns the line on which the match occurred, indexes start from 1 not zero, if no match occurred then returns RegEx::npos. Returns the number of marked sub-expressions contained in the expression. Note that this includes the whole match (sub-expression zero), so the value returned is always >= 1. Returns a copy of what matched sub-expression i. If i = 0 then returns a copy of the whole match. Returns a null string if the index is invalid or if the specied sub-expression did not participate in a match. Returns what(i); Can be used to simplify access to sub-expression matches, and make usage more perl-like.
unsigned int Position(int i = 0)const;
unsigned int Length(int i = 0)const;
bool Matched(int i = 0)const; unsigned int Line()const;
unsigned int Marks() const;
std::string What(int i)const;
std::string operator[](int i)const ;
Internal Details
Unicode Iterators
Synopsis
#include <boost/regex/pending/unicode_iterator.hpp>
162
Boost.Regex
template <class BaseIterator, class U16Type = ::boost::uint16_t> class u32_to_u16_iterator; template <class BaseIterator, class U32Type = ::boost::uint32_t> class u16_to_u32_iterator; template <class BaseIterator, class U8Type = ::boost::uint8_t> class u32_to_u8_iterator; template <class BaseIterator, class U32Type = ::boost::uint32_t> class u8_to_u32_iterator; template <class BaseIterator> class utf16_output_iterator; template <class BaseIterator> class utf8_output_iterator;
Description
This header contains a selection of iterator adaptors that make a sequence of characters in one encoding "look like" a read-only sequence of characters in another encoding.
template <class BaseIterator, class U16Type = ::boost::uint16_t> class u32_to_u16_iterator { u32_to_u16_iterator(); u32_to_u16_iterator(BaseIterator start_position); // Other standard BidirectionalIterator members here... };
A Bidirectional iterator adapter that makes an underlying sequence of UTF32 characters look like a (read-only) sequence of UTF16 characters. The UTF16 characters are encoded in the platforms native byte order.
template <class BaseIterator, class U32Type = ::boost::uint32_t> class u16_to_u32_iterator { u16_to_u32_iterator(); u16_to_u32_iterator(BaseIterator start_position); u16_to_u32_iterator(BaseIterator start_position, BaseIterator start_range, BaseIterat or end_range); // Other standard BidirectionalIterator members here... };
A Bidirectional iterator adapter that makes an underlying sequence of UTF16 characters (in the platforms native byte order) look like a (read-only) sequence of UTF32 characters. The three-arg constructor of this class takes the start and end of the underlying sequence as well as the position to start iteration from. This constructor validates that the underlying sequence has validly encoded endpoints: this prevents accidently incrementing/decrementing past the end of the underlying sequence as a result of invalid UTF16 code sequences at the endpoints of the underlying range.
163
Boost.Regex
template <class BaseIterator, class U8Type = ::boost::uint8_t> class u32_to_u8_iterator { u32_to_u8_iterator(); u32_to_u8_iterator(BaseIterator start_position); // Other standard BidirectionalIterator members here... };
A Bidirectional iterator adapter that makes an underlying sequence of UTF32 characters look like a (read-only) sequence of UTF8 characters.
template <class BaseIterator, class U32Type = ::boost::uint32_t> class u8_to_u32_iterator { u8_to_u32_iterator(); u8_to_u32_iterator(BaseIterator start_position); u8_to_u32_iterator(BaseIterator start_position, BaseIterator start_range, BaseIterat or end_range); // Other standard BidirectionalIterator members here... };
A Bidirectional iterator adapter that makes an underlying sequence of UTF8 characters look like a (read-only) sequence of UTF32 characters. The three-arg constructor of this class takes the start and end of the underlying sequence as well as the position to start iteration from. This constructor validates that the underlying sequence has validly encoded endpoints: this prevents accidently incrementing/decrementing past the end of the underlying sequence as a result of invalid UTF8 code sequences at the endpoints of the underlying range.
template <class BaseIterator> class utf16_output_iterator { utf16_output_iterator(const BaseIterator& b); utf16_output_iterator(const utf16_output_iterator& that); utf16_output_iterator& operator=(const utf16_output_iterator& that); // Other standard OutputIterator members here... };
Simple OutputIterator adapter - accepts UTF32 values as input, and forwards them to BaseIterator b as UTF16. Both UTF32 and UTF16 values are in native byte order.
template <class BaseIterator> class utf8_output_iterator { utf8_output_iterator(const BaseIterator& b); utf8_output_iterator(const utf8_output_iterator& that); utf8_output_iterator& operator=(const utf8_output_iterator& that); // Other standard OutputIterator members here... };
Simple OutputIterator adapter - accepts UTF32 values as input, and forwards them to BaseIterator b as UTF8. The UTF32 input values must be in native byte order.
164
Boost.Regex
Background Information
Headers
There are two main headers used by this library: <boost/regex.hpp> provides full access to the main template library, while <boost/cregex.hpp> provides access to the (deprecated) high level class RegEx, and the POSIX API functions. There is also a header containing only forward declarations <boost/regex_fwd.hpp> for use when an interface is dependent upon basic_regex, but otherwise does not need the full denitions.
Localization
Boost.Regex provides extensive support for run-time localization, the localization model used can be split into two parts: front-end and back-end. Front-end localization deals with everything which the user sees - error messages, and the regular expression syntax itself. For example a French application could change [[:word:]] to [[:mot:]] and \w to \m. Modifying the front end locale requires active support from the developer, by providing the library with a message catalogue to load, containing the localized strings. Front-end locale is affected by the LC_MESSAGES category only. Back-end localization deals with everything that occurs after the expression has been parsed - in other words everything that the user does not see or interact with directly. It deals with case conversion, collation, and character class membership. The back-end locale does not require any intervention from the developer - the library will acquire all the information it requires for the current locale from the underlying operating system / run time library. This means that if the program user does not interact with regular expressions directly - for example if the expressions are embedded in your C++ code - then no explicit localization is required, as the library will take care of everything for you. For example embedding the expression [[:word:]]+ in your code will always match a whole word, if the program is run on a machine with, for example, a Greek locale, then it will still match a whole word, but in Greek characters rather than Latin ones. The back-end locale is affected by the LC_TYPE and LC_COLLATE categories. There are three separate localization mechanisms supported by Boost.Regex:
Win32 localization model.

This is the default model when the library is compiled under Win32, and is encapsulated by the traits class w32_regex_traits. When this model is in effect each basic_regex object gets it's own LCID, by default this is the users default setting as returned by GetUserDefaultLCID, but you can call imbue on the basic_regex object to set it's locale to some other LCID if you wish. All the settings used by Boost.Regex are acquired directly from the operating system bypassing the C run time library. Front-end localization requires a resource dll, containing a string table with the user-dened strings. The traits class exports the function:
static std::string set_message_catalogue(const std::string& s);
which needs to be called with a string identifying the name of the resource dll, before your code compiles any regular expressions (but not necessarily before you construct any basic_regex instances):
boost::w32_regex_traits<char>::set_message_catalogue("mydll.dll");
The library provides full Unicode support under NT, under Windows 9x the library degrades gracefully - characters 0 to 255 are supported, the remainder are treated as "unknown" graphic characters.
C localization model.
This model has been deprecated in favor of the C++ locale for all non-Windows compilers that support it. This locale is encapsulated by the traits class c_regex_traits, Win32 users can force this model to take effect by dening the pre-processor symbol BOOST_REGEX_USE_C_LOCALE. When this model is in effect there is a single global locale, as set by setlocale. All settings are acquired from your run time library, consequently Unicode support is dependent upon your run time library implementation.
165
Boost.Regex
Front end localization is not supported. Note that calling setlocale invalidates all compiled regular expressions, calling setlocale(LC_ALL, "C") will make this library behave equivalent to most traditional regular expression libraries including version 1 of this library.
C++ localization model.

This model is the default for non-Windows compilers. When this model is in effect each instance of basic_regex has its own instance of std::locale, class basic_regex also has a member function imbue which allows the locale for the expression to be set on a per-instance basis. Front end localization requires a POSIX message catalogue, which will be loaded via the std::messages facet of the expression's locale, the traits class exports the symbol:
static std::string set_message_catalogue(const std::string& s);
which needs to be called with a string identifying the name of the message catalogue, before your code compiles any regular expressions (but not necessarily before you construct any basic_regex instances):
boost::cpp_regex_traits<char>::set_message_catalogue("mycatalogue");
Note that calling basic_regex<>::imbue will invalidate any expression currently compiled in that instance of basic_regex. Finally note that if you build the library with a non-default localization model, then the appropriate pre-processor symbol (BOOST_REGEX_USE_C_LOCALE or BOOST_REGEX_USE_CPP_LOCALE) must be dened both when you build the support library, and when you include <boost/regex.hpp> or <boost/cregex.hpp> in your code. The best way to ensure this is to add the #dene to <boost/regex/user.hpp>.
Providing a message catalogue

In order to localize the front end of the library, you need to provide the library with the appropriate message strings contained either in a resource dll's string table (Win32 model), or a POSIX message catalogue (C++ models). In the latter case the messages must appear in message set zero of the catalogue. The messages and their id's are as follows:
166
Boost.Regex
Message
id
Meaning
Default value
101
The character used to start a sub-expression. The character used to end a sub-expression declaration. The character used to denote an end of line assertion. The character used to denote the start of line assertion. The character used to denote the "match any character expression". The match zero or more times repetition operator. The match one or more repetition operator. The match zero or one repetition operator. The character set opening character. The character set closing character. The alternation operator. The escape character. The hash character (not currently used). The range operator. The repetition operator opening character. The repetition operator closing character. The digit characters. The character which when preceded by an escape character represents the word boundary assertion. The character which when preceded by an escape character represents the non-word boundary assertion.
"("
102
")"
103
"$"
104
"^"
105
"."
106
"*"
107
"+"
108
"?"
109 110 111 112 113
"[" "]" "|" "\" "#"
114 115
"-" "{"
116
"}"
117 118
"0123456789" "b"
119
"B"
167
Boost.Regex
Message
id
Meaning
Default value
120
The character which when preceded by an escape character represents the word-start boundary assertion. The character which when preceded by an escape character represents the word-end boundary assertion. The character which when preceded by an escape character represents any word character. The character which when preceded by an escape character represents a non-word character. The character which when preceded by an escape character represents a start of buffer assertion. The character which when preceded by an escape character represents an end of buffer assertion. The newline character. The comma separator. The character which when preceded by an escape character represents the bell character. The character which when preceded by an escape character represents the form feed character. The character which when preceded by an escape character represents the newline character. The character which when preceded by an escape character represents the carriage return character. The character which when preceded by an escape character represents the tab character. The character which when preceded by an escape character represents the vertical tab character.
"<"
121
">"
122
"w"
123
"W"
124
"À"
125
"'z"
126 127 128
"\n" "," "a"
129
"f"
130
"n"
131
"r"
132
"t"
133
"v"
168
Boost.Regex
Message
id
Meaning
Default value
134
The character which when preceded by an escape character represents the start of a hexadecimal character constant. The character which when preceded by an escape character represents the start of an ASCII escape character. The colon character. The equals character. The character which when preceded by an escape character represents the ASCII escape character. The character which when preceded by an escape character represents any lower case character. The character which when preceded by an escape character represents any non-lower case character. The character which when preceded by an escape character represents any upper case character. The character which when preceded by an escape character represents any non-upper case character. The character which when preceded by an escape character represents any space character. The character which when preceded by an escape character represents any non-space character. The character which when preceded by an escape character represents any digit character. The character which when preceded by an escape character represents any non-digit character. The character which when preceded by an escape character represents the end quote operator.
"x"
135
"c"
136 137 138
":" "=" "e"
139
"l"
140
"L"
141
"u"
142
"U"
143
"s"
144
"S"
145
"d"
146
"D"
147
"E"
169
Boost.Regex
Message
id
Meaning
Default value
148
The character which when preceded by an escape character represents the start quote operator. The character which when preceded by an escape character represents a Unicode combining character sequence. The character which when preceded by an escape character represents any single character. The character which when preceded by an escape character represents end of buffer operator. The character which when preceded by an escape character represents the continuation assertion. The character which when preceeded by (? indicates a zero width negated forward lookahead assert.
"Q"
149
"X"
150
"C"
151
"Z"
152
"G"
153
Custom error messages are loaded as follows:
170
Boost.Regex
Message ID 201 202 203 204 205 206 207
Error message ID REG_NOMATCH REG_BADPAT REG_ECOLLATE REG_ECTYPE REG_EESCAPE REG_ESUBREG REG_EBRACK
Default string "No match" "Invalid regular expression" "Invalid collation character" "Invalid character class name" "Trailing backslash" "Invalid back reference" "Unmatched [ or " [208 REG_EPAREN " U n matched ( or $"
209 210 211 212 213
REG_EBRACE REG_BADBR REG_ERANGE REG_ESPACE REG_BADRPT
"Unmatched \{" "Invalid content of \{\}" "Invalid range end" "Memory exhausted" "Invalid preceding regular expression" "Premature end of regular expression" "Regular expression too big" "Unmatched ) or $" "Empty expression" "Unknown error"
214
REG_EEND
215 216 217 218
REG_ESIZE REG_ERPAREN REG_EMPTY REG_E_UNKNOWN
Custom character class names are loaded as followed:
171
Boost.Regex
Message ID 300
Description The character class name for alphanumeric characters. The character class name for alphabetic characters. The character class name for control characters. The character class name for digit characters. The character class name for graphics characters. The character class name for lower case characters. The character class name for printable characters. The character class name for punctuation characters. The character class name for space characters. The character class name for upper case characters. The character class name for hexadecimal characters. The character class name for blank characters. The character class name for word characters. The character class name for Unicode characters.
Equivalent default class name "alnum"
301
"alpha"
302
"cntrl"
303
"digit"
304
"graph"
305
"lower"
306
"print"
307
"punct"
308
"space"
309
"upper"
310
"xdigit"
311
"blank"
312
"word"
313
"unicode"
Finally, custom collating element names are loaded starting from message id 400, and terminating when the rst load thereafter fails. Each message looks something like: "tagname string" where tagname is the name used inside [[.tagname.]] and string is the actual text of the collating element. Note that the value of collating element [[.zero.]] is used for the conversion of strings to numbers - if you replace this with another value then that will be used for string parsing - for example use the Unicode character 0x0660 for [[.zero.]] if you want to use Unicode Arabic-Indic digits in your regular expressions in place of Latin digits. Note that the POSIX dened names for character classes and collating elements are always available - even if custom names are dened, in contrast, custom error messages, and custom syntax messages replace the default ones.
172
Boost.Regex
Thread Safety
The Boost.Regex library is thread safe when Boost is: you can verify that Boost is in thread safe mode by checking to see if BOOST_HAS_THREADS is dened: this macro is set automatically by the cong system when threading support is turned on in your compiler. Class basic_regex and its typedefs regex and wregex are thread safe, in that compiled regular expressions can safely be shared between threads. The matching algorithms regex_match, regex_search, and regex_replace are all re-entrant and thread safe. Class match_results is now thread safe, in that the results of a match can be safely copied from one thread to another (for example one thread may nd matches and push match_results instances onto a queue, while another thread pops them off the other end), otherwise use a separate instance of match_results per thread. The POSIX API functions are all re-entrant and thread safe, regular expressions compiled with regcomp can also be shared between threads. The class RegEx is only thread safe if each thread gets its own RegEx instance (apartment threading) - this is a consequence of RegEx handling both compiling and matching regular expressions. Finally note that changing the global locale invalidates all compiled regular expressions, therefore calling set_locale from one thread while another uses regular expressions will produce unpredictable results. There is also a requirement that there is only one thread executing prior to the start of main().
Test and Example Programs

Test Programs
regress: A regression test application that gives the matching/searching algorithms a full workout. The presence of this program is your guarantee that the library will behave as claimed - at least as far as those items tested are concerned - if anyone spots anything that isn't being tested I'd be glad to hear about it. Files: main.cpp basic_tests.cpp test_alt.cpp test_anchors.cpp test_asserts.cpp test_backrefs.cpp test_deprecated.cpp test_emacs.cpp test_escapes.cpp test_grep.cpp test_icu.cpp test_locale.cpp test_mfc.cpp
173
Boost.Regex
test_non_greedy_repeats.cpp test_operators.cpp test_overloads.cpp test_perl_ex.cpp test_replace.cpp test_sets.cpp test_simple_repeats.cpp test_tricky_cases.cpp test_unicode.cpp bad_expression_test: Veries that "bad" regular expressions don't cause the matcher to go into innite loops, but to throw an exception instead. Files: bad_expression_test.cpp. recursion_test: Veries that the matcher can't overrun the stack (no matter what the expression). Files: recursion_test.cpp. concepts: Veries that the library meets all documented concepts (a compile only test). Files: concept_check.cpp. captures_test: Test code for captures. Files: captures_test.cpp.
Example programs
grep A simple grep implementation, run with the -h command line option to nd out its usage. Files: grep.cpp timer.exe A simple interactive expression matching application, the results of all matches are timed, allowing the programmer to optimize their regular expressions where performance is critical. Files: regex_timer.cpp.
Code snippets
The snippets examples contain the code examples used in the documentation: captures_example.cpp: Demonstrates the use of captures.
174
Boost.Regex
credit_card_example.cpp: Credit card number formatting code. partial_regex_grep.cpp: Search example using partial matches. partial_regex_match.cpp: regex_match example using partial matches. regex_iterator_example.cpp: Iterating through a series of matches. regex_match_example.cpp: ftp based regex_match example. regex_merge_example.cpp: regex_merge example: converts a C++ le to syntax highlighted HTML. regex_replace_example.cpp: regex_replace example: converts a C++ le to syntax highlighted HTML regex_search_example.cpp: regex_search example: searches a cpp le for class denitions. regex_token_iterator_eg_1.cpp: split a string into a series of tokens. regex_token_iterator_eg_2.cpp: enumerate the linked URL's in a HTML le. The following are deprecated: regex_grep_example_1.cpp: regex_grep example 1: searches a cpp le for class denitions. regex_grep_example_2.cpp: regex_grep example 2: searches a cpp le for class denitions, using a global callback function. regex_grep_example_3.cpp: regex_grep example 2: searches a cpp le for class denitions, using a bound member function callback. regex_grep_example_4.cpp: regex_grep example 2: searches a cpp le for class denitions, using a C++ Builder closure as a callback. regex_split_example_1.cpp: regex_split example: split a string into tokens. regex_split_example_2.cpp : regex_split example: spit out linked URL's.
References and Further Information

Short tutorials on regular expressions can be found here and here. The main book on regular expressions is Mastering Regular Expressions, published by O'Reilly. Boost.Regex forms the basis for the regular expression chapter of the Technical Report on C++ Library Extensions. The Open Unix Specication contains a wealth of useful material, including the POSIX regular expression syntax. The Pattern Matching Pointers site is a "must visit" resource for anyone interested in pattern matching. Glimpse and Agrep, use a simplied regular expression syntax to achieve faster search times. Udi Manber and Ricardo Baeza-Yates both have a selection of useful pattern matching papers available from their respective web sites.
FAQ
Q. I can't get regex++ to work with escape characters, what's going on? A. If you embed regular expressions in C++ code, then remember that escape characters are processed twice: once by the C++ compiler, and once by the Boost.Regex expression compiler, so to pass the regular expression \d+ to Boost.Regex, you need to embed "\d+" in your code. Likewise to match a literal backslash you will need to embed "\\" in your code. Q. No matter what I do regex_match always returns false, what's going on?
175
Boost.Regex
A. The algorithm regex_match only succeeds if the expression matches all of the text, if you want to nd a sub-string within the text that matches the expression then use regex_search instead. Q. Why does using parenthesis in a POSIX regular expression change the result of a match? A. For POSIX (extended and basic) regular expressions, but not for perl regexes, parentheses don't only mark; they determine what the best match is as well. When the expression is compiled as a POSIX basic or extended regex then Boost.Regex follows the POSIX standard leftmost longest rule for determining what matched. So if there is more than one possible match after considering the whole expression, it looks next at the rst sub-expression and then the second sub-expression and so on. So... "(0*)([0-9]*)" against "00123" would produce $1 = "00" $2 = "123" where as "0*([0-9])*" against "00123" would produce $1 = "00123" If you think about it, had $1 only matched the "123", this would be "less good" than the match "00123" which is both further to the left and longer. If you want $1 to match only the "123" part, then you need to use something like: "0*([1-9][0-9]*)" as the expression. Q. Why don't character ranges work properly (POSIX mode only)? A. The POSIX standard species that character range expressions are locale sensitive - so for example the expression [A-Z] will match any collating element that collates between 'A' and 'Z'. That means that for most locales other than "C" or "POSIX", [A-Z] would match the single character 't' for example, which is not what most people expect - or at least not what most people have come to expect from regular expression engines. For this reason, the default behaviour of Boost.Regex (perl mode) is to turn locale sensitive collation off by not setting the regex_constants::collate compile time ag. However if you set a non-default compile time ag - for example regex_constants::extended or regex_constants::basic, then locale dependent collation will be enabled, this also applies to the POSIX API functions which use either regex_constants::extended or regex_constants::basic internally. [Note - when regex_constants::nocollate in effect, the library behaves "as if" the LC_COLLATE locale category were always "C", regardless of what its actually set to - end note]. Q. Why are there no throw specications on any of the functions? What exceptions can the library throw? A. Not all compilers support (or honor) throw specications, others support them but with reduced efciency. Throw specications may be added at a later date as compilers begin to handle this better. The library should throw only three types of exception: [boost::regex_error] can be thrown by basic_regex when compiling a regular expression, std::runtime_error can be thrown when a call to basic_regex::imbue tries to open a message catalogue that doesn't exist, or when a call to regex_search or regex_match results in an "everlasting" search, or when a call to RegEx::GrepFiles or RegEx::FindFiles tries to open a le that cannot be opened, nally std::bad_alloc can be thrown by just about any of the functions in this library. Q. Why can't I use the "convenience" versions of regex_match / regex_search / regex_grep / regex_format / regex_merge? A. These versions may or may not be available depending upon the capabilities of your compiler, the rules determining the format of these functions are quite complex - and only the versions visible to a standard compliant compiler are given in the help. To nd out what your compiler supports, run <boost/regex.hpp> through your C++ pre-processor, and search the output le for the function that you are interested in. Note however, that very few current compilers still have problems with these overloaded functions.
Performance
The performance of Boost.Regex in both recursive and non-recursive modes should be broadly comparable to other regular expression libraries: recursive mode is slightly faster (especially where memory allocation requires thread synchronisation), but not by much. The following pages compare Boost.Regex with various other regular expression libraries for the following compilers: Visual Studio.Net 2003 (recursive Boost.Regex implementation). Gcc 3.2 (cygwin) (non-recursive Boost.Regex implementation).
176
Boost.Regex
Standards Conformance
C++
Boost.Regex is intended to conform to the Technical Report on C++ Library Extensions.
ECMAScript / JavaScript
All of the ECMAScript regular expression syntax features are supported, except that: The escape sequence \u matches any upper case character (the same as [[:upper:]]) rather than a Unicode escape sequence; use \x{DDDD} for Unicode escape sequences.
Perl
Almost all Perl features are supported, except for: (?{code}) Not implementable in a compiled strongly typed language. (??{code}) Not implementable in a compiled strongly typed language. (*VERB) The backtracking control verbs are not recognised or implemented at this time. In addition the following features behave slightly differently from Perl: ^ $ \Z These recognise any line termination sequence, and not just \n: see the Unicode requirements below.
POSIX
All the POSIX basic and extended regular expression features are supported, except that: No character collating names are recognized except those specied in the POSIX standard for the C locale, unless they are explicitly registered with the traits class. Character equivalence classes ( [[=a=]] etc) are probably buggy except on Win32. Implementing this feature requires knowledge of the format of the string sort keys produced by the system; if you need this, and the default implementation doesn't work on your platform, then you will need to supply a custom traits class.
Unicode
The following comments refer to Unicode Technical Standard #18: Unicode Regular Expressions version 11.
177
Boost.Regex
Item 1.1
Feature Hex Notation
Support Yes: use \x{DDDD} to refer to code point UDDDD. All the names listed under the General Category Property are supported. Script names and Other Names are not currently supported. Indirectly support by forward-lookahead:
(?=[[:X:]])[[:Y:]]
1.2
Character Properties
1.3
Subtraction and Intersection
Gives the intersection of character properties X and Y.

(?![[:X:]])[[:Y:]]
Gives everything in Y that is not in X (subtraction). 1.4 Simple Word Boundaries Conforming: non-spacing marks are included in the set of word characters. Supported, note that at this level, case transformations are 1:1, many to many case folding operations are not supported (for example "" to "SS"). Supported, except that "." matches only one character of "\r\n". Other than that word boundaries match correctly; including not matching in the middle of a "\r\n" sequence. Supported: provided you use the u32* algorithms, then UTF-8, UTF-16 and UTF32 are all treated as sequences of 32-bit code points. Not supported: it is up to the user of the library to convert all text into the same canonical form as the regular expression. Not supported.
1.5
Caseless Matching
1.6
Line Boundaries
1.7
Code Points
2.1
Canonical Equivalence
2.2 2.3Default Word Boundaries 2.4 2.5
Default Grapheme Clusters Not supported. Default Loose Matches Named Properties
Not Supported. Supported: the expression "[[:name:]]" or \N{name} matches the named character "name". Not Supported. Not Supported.
2.6 3.1
Wildcard properties Tailored Punctuation.
178
Boost.Regex
Item 3.2 3.3 3.4
Feature Tailored Grapheme Clusters Tailored Word Boundaries. Tailored Loose Matches
Support Not Supported. Not Supported. Partial support: [[=c=]] matches characters with the same primary equivalence class as "c". Supported: [a-b] matches any character that collates in the range a to b, when the expression is constructed with the collate ag set. Not Supported. Supported: pass the ag match_partial to the regex algorithms. Not Supported. Not supported, however this information is used internally to optimise the matching of regular expressions, and return quickly if no match is possible. Partial Support: It is possible to achieve a similar effect by using a custom regular expression traits class. Not Supported.
3.5
Tailored Ranges
3.6 3.7
Context Matches Incremental Matches
3.8 3.9
Unicode Set Sharing Possible Match Sets
3.10
Folded Matching
3.11
Custom Submatch Evaluation
Redistributables
If you are using Microsoft or Borland C++ and link to a dll version of the run time library, then you can choose to also link to a dll version of Boost.Regex by dening the symbol BOOST_REGEX_DYN_LINK when you compile your code. While these dll's are redistributable, there are no "standard" versions, so when installing on the users PC, you should place these in a directory private to your application, and not in the PC's directory path. Note that if you link to a static version of your run time library, then you will also link to a static version of Boost.Regex and no dll's will need to be distributed. The possible Boost.Regex dll and library names are computed according to the formula given in the getting started guide. Note: you can disable automatic library selection by dening the symbol BOOST_REGEX_NO_LIB when compiling, this is useful if you want to build Boost.Regex yourself in your IDE, or if you need to debug Boost.Regex.
Acknowledgements
The author can be contacted at john - at - johnmaddock.co.uk; the home page for this library is at www.boost.org. I am indebted to Robert Sedgewick's "Algorithms in C++" for forcing me to think about algorithms and their performance, and to the folks at boost for forcing me to think, period. Eric Niebler, author of Boost.Expressive and the GRETA regular expression component, has shared several important ideas, in a series of long discussions. Pete Becker, of Roundhouse Consulting, Ltd., has helped enormously with the standardisation proposal language.
179
Boost.Regex
The following people have all contributed useful comments or xes: Dave Abrahams, Mike Allison, Edan Ayal, Jayashree Balasubramanian, Jan Blsche, Beman Dawes, Paul Baxter, David Bergman, David Dennerline, Edward Diener, Peter Dimov, Robert Dunn, Fabio Forno, Tobias Gabrielsson, Rob Gillen, Marc Gregoire, Chris Hecker, Nick Hodapp, Jesse Jones, Martin Jost, Boris Krasnovskiy, Jan Hermelink, Max Leung, Wei-hao Lin, Jens Maurer, Richard Peters, Heiko Schmidt, Jason Shirk, Gerald Slacik, Scobie Smith, Mike Smyth, Alexander Sokolovsky, Herv Poirier, Michael Raykh, Marc Recht, Scott VanCamp, Bruno Voigt, Alexey Voinov, Jerry Waldorf, Rob Ward, Lealon Watts, John Wismar, Thomas Witt and Yuval Yosef. If I've missed your name off (I'm sure there are a few, just not who they are...) then please do get in touch. I am also grateful to the manuals supplied with the Henry Spencer, PCRE, Perl and GNU regular expression libraries - wherever possible I have tried to maintain compatibility with these libraries and with the POSIX standard - the code however is entirely my own, including any bugs! I can absolutely guarantee that I will not x any bugs I don't know about, so if you have any comments or spot any bugs, please get in touch.
History
New issues should be submitted at svn.boost.org - don't forget to include your email address in the ticket! Currently open issues can be viewed here. All issues including closed ones can be viewed here.
Boost-1.51
Fixed issues: #589, #7084, #7032, #6346.
Boost-1.50
Fixed issue with (?!) not being a valid expression, and updated docs on what constitutes a valid conditional expression.
Boost-1.48
Fixed issues: #698, #5835, #5958, #5736.
Boost 1.47
Fixed issues: #5223, #5353, #5363, #5462, #5472, #5504.
Boost 1.44
Fixed issues: #4309, #4215, #4212, #4191, #4132, #4123, #4114, #4036, #4020, #3941, #3902, #3890
Boost 1.42
Added support for Functors rather than strings as format expressions. Improved error reporting when throwing exceptions to include better more relevant information. Improved performance and reduced stack usage of recursive expressions. Fixed tickets #2802, #3425, #3507, #3546, #3631, #3632, #3715, #3718, #3763, #3764
Boost 1.40
Added support for many Perl 5.10 syntax elements including named sub-expressions, branch resets and recursive regular expressions.
180
Boost.Regex
Boost 1.38
Breaking change: empty expressions, and empty alternatives are now allowed when using the Perl regular expression syntax. This change has been added for Perl compatibility, when the new syntax_option_type no_empty_expressions is set then the old behaviour is preserved and empty expressions are prohibited. This is issue #1081. Added support for Perl style ${n} expressions in format strings (issue #2556). Added support for accessing the location of sub-expressions within the regular expression string (issue #2269). Fixed compiler compatibility issues #2244, #2514, and #2458.
Boost 1.34
Fix for non-greedy repeats and partial matches not working correctly in some cases. Fix for non-greedy repeats on VC++ not working in some cases (bug report 1515830). Changed match_results::position() to return a valid result when *this represents a partial match. Fixed the grep and egrep options so that the newline character gets treated the same as |.
Boost 1.33.1
Fixed broken makeles. Fixed conguration setup to allow building with VC7.1 - STLport-4.6.2 when using /Zc:wchar_t. Moved declarations class-inline in static_mutex.hpp so that SGI Irix compiler can cope. Added needed standard library #includes to leiter.hpp, regex_workaround.hpp and cpp_regex_traits.hpp. Fixed a bug where non-greedy repeats could in certain strange curcumstances repeat more times than their maximum value. Fixed the value returned by basic_regex<>::empty() from a default constructed object. Changed the defnition of regex_error to make it backwards compatible with Boost-1.32.0. Disabled external templates for Intel C++ 8.0 and earlier - otherwise unresolved references can occur. Rewritten extern template code for gcc so that only specic member functions are exported: otherwise strange unresolved references can occur when linking and mixing debug and non-debug code. Initialise all the data members of the unicode_iterators: this keeps gcc from issuing needless warnings. Ported the ICU integration code to VC6 and VC7. Ensured code is STLport debug mode clean. Fixed lookbehind assertions so that xed length repeats are permitted, and so that regex iteration allows lookbehind to look back before the current search range (into the last match). Fixed strange bug with non-greedy repeats inside forward lookahead assertions. Enabled negated character classes inside character sets. Fixed regression so that [a-z-] is a valid expression again. Fixed bug that allowed some invalid expressions to be accepted.
181
Boost.Regex
Boost 1.33.0
Completely rewritten expression parsing code, and traits class support; now conforms to the standardization proposal. Breaking Change: The syntax options that can be passed to basic_regex constructors have been rationalized. The default option (perl) now has a value of zero, and it is now clearly documented which options apply to which regular expression syntax styles (perl, POSIX-extended, POSIX-basic etc). Some of the more esoteric options have now been removed, so there is the possibility that existing code may fail to compile: however equivalent functionality should still be available. Breaking Change: POSIX-extended and POSIX-basic regular expressions now enforce the letter of the POSIX standard much more closely than before. Added support for (?imsx-imsx) constructs. Added support for lookbehind expressions (?<=positive-lookbehind) and (?<!negative-lookbehind). Added support for conditional expressions (?(assertion)true-expresion|false-expression). Added MFC/ATL string wrappers. Added Unicode support; based on ICU. Changed newline support to recognise \f as a line separator (all character types), and \x85 as a line separator for wide characters / Unicode only. Added a new format ag format_literal that treats the replace string as a literal, rather than a Perl or Sed style format string. Errors are now reported by throwing exceptions of type regex_error. The types used previously - bad_expression and bad_pattern - are now just typedefs for regex_error. Type regex_error has a couple of new members: code() to report an error code rather than a string, and position() to report where in the expression the error occurred.
Boost 1.32.1
Fixed bug in partial matches of bounded repeats of '.'.
Boost 1.31.0
Completely rewritten pattern matching code - it is now up to 10 times faster than before. Reorganized documentation. Deprecated all interfaces that are not part of the regular expression standardization proposal. Added regex_iterator and regex_token_iterator . Added support for Perl style independent sub-expressions. Added non-member operators to the sub_match class, so that you can compare sub_match's with strings, or add them to a string to produce a new string. Added experimental support for extended capture information. Changed the match ags so that they are a distinct type (not an integer), if you try to pass the match ags as an integer rather than match_ag_type to the regex algorithms then you will now get a compiler error.
182

Regex

Uploaded by

Copyright:

Available Formats

Regex

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Regex

Uploaded by

Copyright:

Available Formats

Boost.

XML to PDF by RenderX XEP XSL-FO Formatter, visit us at http://www.renderx.com/

XML to PDF by RenderX XEP XSL-FO Formatter, visit us at http://www.renderx.com/

Locale and traits class selection

XML to PDF by RenderX XEP XSL-FO Formatter, visit us at http://www.renderx.com/

XML to PDF by RenderX XEP XSL-FO Formatter, visit us at http://www.renderx.com/

Building and Installing the Library

Building with bjam

Building With Unicode and ICU Support

If instead you see:

XML to PDF by RenderX XEP XSL-FO Formatter, visit us at http://www.renderx.com/

Building via makefiles

XML to PDF by RenderX XEP XSL-FO Formatter, visit us at http://www.renderx.com/

Microsoft Visual C++ 6, 7, 7.1 and 8

XML to PDF by RenderX XEP XSL-FO Formatter, visit us at http://www.renderx.com/

XML to PDF by RenderX XEP XSL-FO Formatter, visit us at http://www.renderx.com/

XML to PDF by RenderX XEP XSL-FO Formatter, visit us at http://www.renderx.com/

Introduction and Overview

XML to PDF by RenderX XEP XSL-FO Formatter, visit us at http://www.renderx.com/

XML to PDF by RenderX XEP XSL-FO Formatter, visit us at http://www.renderx.com/

Unicode and Boost.Regex

Use a Unicode Aware Regular Expression Type.

XML to PDF by RenderX XEP XSL-FO Formatter, visit us at http://www.renderx.com/

Understanding Marked Sub-Expressions and Captures

XML to PDF by RenderX XEP XSL-FO Formatter, visit us at http://www.renderx.com/

XML to PDF by RenderX XEP XSL-FO Formatter, visit us at http://www.renderx.com/

Which produces the following output:

XML to PDF by RenderX XEP XSL-FO Formatter, visit us at http://www.renderx.com/

XML to PDF by RenderX XEP XSL-FO Formatter, visit us at http://www.renderx.com/

Start of full match.

XML to PDF by RenderX XEP XSL-FO Formatter, visit us at http://www.renderx.com/

XML to PDF by RenderX XEP XSL-FO Formatter, visit us at http://www.renderx.com/

#include #include #include #include #include

<iostream> <fstream> <sstream> <string> <boost/regex.hpp>

XML to PDF by RenderX XEP XSL-FO Formatter, visit us at http://www.renderx.com/

Regular Expression Syntax

Perl Regular Expression Syntax

Perl Regular Expression Syntax

XML to PDF by RenderX XEP XSL-FO Formatter, visit us at http://www.renderx.com/

But will not match:

But will not match:

An atom can also be repeated with a bounded repeat:

Will match either of:

But neither of:

XML to PDF by RenderX XEP XSL-FO Formatter, visit us at http://www.renderx.com/

Non greedy repeats

Will match the string:

But not the string:

XML to PDF by RenderX XEP XSL-FO Formatter, visit us at http://www.renderx.com/

\g-1 \g{-2} \g{one}

XML to PDF by RenderX XEP XSL-FO Formatter, visit us at http://www.renderx.com/

XML to PDF by RenderX XEP XSL-FO Formatter, visit us at http://www.renderx.com/

XML to PDF by RenderX XEP XSL-FO Formatter, visit us at http://www.renderx.com/

Horizontal whitespace Vertical whitespace

Not Horizontal whitespace Not Vertical whitespace

Equivalent character set form

XML to PDF by RenderX XEP XSL-FO Formatter, visit us at http://www.renderx.com/

Perl Extended Patterns

XML to PDF by RenderX XEP XSL-FO Formatter, visit us at http://www.renderx.com/