Click here to Skip to main content
14,971,661 members
Articles / Desktop Programming / ATL
Posted 5 Mar 2006


78 bookmarked

Using Regular Expressions in MFC

Rate me:
Please Sign up or sign in to vote.
4.81/5 (29 votes)
18 Jun 20064 min read
CATLRegExp - A Visual C++ built-in regular expression.

Sample image


I think most people will think of Boost::Regex or PCRE when they want to use Regular Expressions in a C++ project. However, in fact, Microsoft has its own regular expression implementation as part of the ATL server, and it is called CAtlRegExp. And as a bonus, CAtlRegExp supports not only ASCII and Unicode, but also MBCS.

Supported Regular Expression Syntax

The following tables are copied from MSDN. You can note that the syntax is not exactly the same as in Perl. For example, the grouping operator is {}, while in Perl it is (), and it doesn't have the {n} (match exactly n times) as in the Perl syntax<.

.Matches any single character.
[ ]Indicates a character class. Matches any character inside the brackets (for example, [abc] matches "a", "b", and "c").
^If this metacharacter occurs at the start of a character class, it negates the character class. A negated character class matches any character except those inside the brackets (for example, [^abc] matches all characters except "a", "b", and "c").

If ^ is at the beginning of the regular expression, it matches the beginning of the input (for example, ^[abc] will only match input that begins with "a", "b", or "c").

-In a character class, indicates a range of characters (for example, [0-9] matches any of the digits "0" through "9").
?Indicates that the preceding expression is optional: it matches once or not at all (for example, [0-9][0-9]? matches "2" and "12").
+Indicates that the preceding expression matches one or more times (for example, [0-9]+ matches "1", "13", "666", and so on).
*Indicates that the preceding expression matches zero or more times.
??, +?, *?Non-greedy versions of ?, +, and *. These match as little as possible, unlike the greedy versions which match as much as possible. Example: given the input "<abc><def>", <.*?> matches "<abc>" while <.*> matches "<abc><def>".
( )Grouping operator. Example: (\d+,)*\d+ matches a list of numbers separated by commas (such as "1" or "1,23,456").
{ }Indicates a match group. The actual text in the input that matches the expression inside the braces can be retrieved through the CAtlREMatchContext object.
\Escape character: interpret the next character literally (for example, [0-9]+ matches one or more digits, but [0-9]\+ matches a digit followed by a plus character). Also used for abbreviations (such as \a for any alphanumeric character; see table below).

If \ is followed by a number n, it matches the nth match group (starting from 0). Example: <{.*?}>.*?</\0> matches "<head>Contents</head>".

Note that in C++ string literals, two backslashes must be used: "\\+", "\\a", "<{.*?}>.*?</\\0>".

$At the end of a regular expression, this character matches the end of the input. Example: [0-9]$ matches a digit at the end of the input.
|Alternation operator: separates two expressions, exactly one of which matches (for example, T|the matches "The" or "the").
!Negation operator: the expression following ! does not match the input. Example: a!b matches "a" not followed by "b".

CAtlRegExp can handle abbreviations, such as \d instead of [0-9]. The abbreviations are provided by the character traits class passed in the CharTraits parameter. The predefined character traits classes provide the following abbreviations:

\aAny alphanumeric character: ([a-zA-Z0-9])
\bWhite space (blank): ([ \\t])
\cAny alphabetic character: ([a-zA-Z])
\dAny decimal digit: ([0-9])
\hAny hexadecimal digit: ([0-9a-fA-F])
\nNewline: (\r|(\r?\n))
\qA quoted string: (\"[^\"]*\")|(\'[^\']*\')
\wA simple word: ([a-zA-Z]+)
\zAn integer: ([0-9]+)

Using the code

Although CAtlRegExp is part of the ATL server classes, you don't have to be an ATL project in order to use this class, simply #include "atlrx.h" is enough.

I have written a simple Dialog based program to test/demo the CAtlRegExp. The core of the program is listed as follows:

// create regular expression content
CAtlRegExp<> regex;
REParseError status = regex.Parse(m_szRegex, m_bCaseSensitive);

if (REPARSE_ERROR_OK != status) {
  // invalid pattern, show error
  m_szStatus = TEXT("Parser Error: ");
  m_szStatus += REError2String(status);
} else {
  // valid regex pattern, now try to match the content
  CAtlREMatchContext<> mc;
  if (!regex.Match(m_szInput, &mc)) {
    // content not match
    m_szStatus = TEXT("No match");
  } else {
    // content match, show match-group
    m_szStatus = TEXT("Success match");
    for (UINT nGroupIndex = 0; nGroupIndex < mc.m_uNumGroups; 
         ++nGroupIndex) {
      const CAtlREMatchContext<>::RECHAR* szStart = 0;
      const CAtlREMatchContext<>::RECHAR* szEnd = 0;
      mc.GetMatch(nGroupIndex, &szStart, &szEnd);
      ptrdiff_t nLength = szEnd - szStart;
      CString text(szStart, nLength);

And the function REError2String is listed as follows:

// refer to REParseError for more information
CString CMfcRegexDlg::REError2String(REParseError status)
  switch (status) {
         return TEXT("No error occurred");
         return TEXT("Out of memory");
         return TEXT("A closing brace was expected");
         return TEXT("A closing parenthesis was expected");
         return TEXT("A closing bracket was expected");
         return TEXT("An unspecified fatal error occurred");
         return TEXT("A range expression was empty");
         return TEXT("A back reference was made to a group" 
                     " that did not exist");
         return TEXT("An invalid range was specified");
         return TEXT("A repeat operator (* or +) was applied" 
                     " to an expression that could be empty");
         return TEXT("The input string was invalid");
    default: return TEXT("Unknown error");

Special note about MBCS

By default, CAtlRegExp uses CAtlRECharTraits, which is CAtlRECharTraitsA for non-Unicode version. However, unless you are using strict and pure ASCII, you should use CAtlRECharTraitsMB; otherwise, you may encounter some un-expected results in non-ASCII text. For example, the Chinese character for Chinese Character ("word") in Big5 encoding is the two byte word "\0xA6 r", which has a 'r' in as the second byte.



  • 6th March 2006: Initial version uploaded.


This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here


About the Author

Sam NG
Hong Kong Hong Kong
No Biography provided

Comments and Discussions

GeneralMy vote of 1 Pin
Member 42633028-Jul-09 18:18
MemberMember 42633028-Jul-09 18:18 
GeneralATL Server not in VC++ 2008 Pin
bob1697220-Jun-08 3:23
Memberbob1697220-Jun-08 3:23 
AnswerRe: ATL Server not in VC++ 2008 Pin
mknaup10-Sep-08 23:38
Membermknaup10-Sep-08 23:38 
GeneralUnhandled exception Pin
bob1697219-Jun-08 11:11
Memberbob1697219-Jun-08 11:11 
QuestionHow conver szEnd and szStart to int ? Pin
JetDraft20-Feb-07 8:17
MemberJetDraft20-Feb-07 8:17 
AnswerRe: How conver szEnd and szStart to int ? Pin
Legolas655-Aug-07 12:35
MemberLegolas655-Aug-07 12:35 
GeneralRe: How conver szEnd and szStart to int ? Pin
Legolas658-Aug-07 1:23
MemberLegolas658-Aug-07 1:23 
Generalthere are some bugs Pin
superxsc3-Jan-07 18:20
Membersuperxsc3-Jan-07 18:20 
GeneralRe: there are some bugs Pin
dxlee8-Jan-07 7:51
Memberdxlee8-Jan-07 7:51 
Questioncase-insensistive search? Pin
CrazyScntst24-Jul-06 5:25
MemberCrazyScntst24-Jul-06 5:25 
AnswerRe: case-insensistive search? Pin
Sam NG24-Jul-06 15:56
MemberSam NG24-Jul-06 15:56 
QuestionWarning C4018 in ATL code Pin
Julberto Danray26-Jun-06 5:13
MemberJulberto Danray26-Jun-06 5:13 
AnswerRe: Warning C4018 in ATL code Pin
Sam NG26-Jun-06 15:42
MemberSam NG26-Jun-06 15:42 
GeneralRe: Warning C4018 in ATL code Pin
Julberto Danray27-Jun-06 9:42
MemberJulberto Danray27-Jun-06 9:42 
GeneralOnly works with groups in regexp limitation Pin
Gerhard Schmeusser19-Jun-06 22:05
MemberGerhard Schmeusser19-Jun-06 22:05 
GeneralRe: Only works with groups in regexp limitation Pin
Sam NG19-Jun-06 23:11
MemberSam NG19-Jun-06 23:11 
GeneralRe: Only works with groups in regexp limitation Pin
k77714-Jun-09 8:49
Memberk77714-Jun-09 8:49 
GeneralRe: Only works with groups in regexp limitation Pin
Legolas655-Aug-07 10:36
MemberLegolas655-Aug-07 10:36 
GeneralSerious bug but not yours Pin
phgo19-Jun-06 4:00
Memberphgo19-Jun-06 4:00 
GeneralRe: Serious bug but not yours Pin
YoSilver19-Jun-06 12:30
MemberYoSilver19-Jun-06 12:30 
GeneralRe: Serious bug but not yours Pin
phgo19-Jun-06 21:02
Memberphgo19-Jun-06 21:02 
GeneralRe: Serious bug but not yours Pin
YoSilver20-Jun-06 0:21
MemberYoSilver20-Jun-06 0:21 
GeneralRe: Serious bug but not yours Pin
phgo20-Jun-06 0:53
Memberphgo20-Jun-06 0:53 
GeneralRe: Serious bug but not yours Pin
YoSilver20-Jun-06 11:46
MemberYoSilver20-Jun-06 11:46 
GeneralRe: Serious bug but not yours Pin
Legolas6518-Aug-07 0:23
MemberLegolas6518-Aug-07 0:23 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.