libstdc++
|
00001 // class template regex -*- C++ -*- 00002 00003 // Copyright (C) 2010-2015 Free Software Foundation, Inc. 00004 // 00005 // This file is part of the GNU ISO C++ Library. This library is free 00006 // software; you can redistribute it and/or modify it under the 00007 // terms of the GNU General Public License as published by the 00008 // Free Software Foundation; either version 3, or (at your option) 00009 // any later version. 00010 00011 // This library is distributed in the hope that it will be useful, 00012 // but WITHOUT ANY WARRANTY; without even the implied warranty of 00013 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00014 // GNU General Public License for more details. 00015 00016 // Under Section 7 of GPL version 3, you are granted additional 00017 // permissions described in the GCC Runtime Library Exception, version 00018 // 3.1, as published by the Free Software Foundation. 00019 00020 // You should have received a copy of the GNU General Public License and 00021 // a copy of the GCC Runtime Library Exception along with this program; 00022 // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see 00023 // <http://www.gnu.org/licenses/>. 00024 00025 /** 00026 * @file bits/regex_constants.h 00027 * @brief Constant definitions for the std regex library. 00028 * 00029 * This is an internal header file, included by other library headers. 00030 * Do not attempt to use it directly. @headername{regex} 00031 */ 00032 00033 namespace std _GLIBCXX_VISIBILITY(default) 00034 { 00035 /** 00036 * @defgroup regex Regular Expressions 00037 * 00038 * A facility for performing regular expression pattern matching. 00039 * @{ 00040 */ 00041 00042 /** 00043 * @namespace std::regex_constants 00044 * @brief ISO C++-0x entities sub namespace for regex. 00045 */ 00046 namespace regex_constants 00047 { 00048 _GLIBCXX_BEGIN_NAMESPACE_VERSION 00049 00050 /** 00051 * @name 5.1 Regular Expression Syntax Options 00052 */ 00053 //@{ 00054 enum __syntax_option 00055 { 00056 _S_icase, 00057 _S_nosubs, 00058 _S_optimize, 00059 _S_collate, 00060 _S_ECMAScript, 00061 _S_basic, 00062 _S_extended, 00063 _S_awk, 00064 _S_grep, 00065 _S_egrep, 00066 _S_syntax_last 00067 }; 00068 00069 /** 00070 * @brief This is a bitmask type indicating how to interpret the regex. 00071 * 00072 * The @c syntax_option_type is implementation defined but it is valid to 00073 * perform bitwise operations on these values and expect the right thing to 00074 * happen. 00075 * 00076 * A valid value of type syntax_option_type shall have exactly one of the 00077 * elements @c ECMAScript, @c basic, @c extended, @c awk, @c grep, @c egrep 00078 * %set. 00079 */ 00080 enum syntax_option_type : unsigned int { }; 00081 00082 /** 00083 * Specifies that the matching of regular expressions against a character 00084 * sequence shall be performed without regard to case. 00085 */ 00086 constexpr syntax_option_type icase = 00087 static_cast<syntax_option_type>(1 << _S_icase); 00088 00089 /** 00090 * Specifies that when a regular expression is matched against a character 00091 * container sequence, no sub-expression matches are to be stored in the 00092 * supplied match_results structure. 00093 */ 00094 constexpr syntax_option_type nosubs = 00095 static_cast<syntax_option_type>(1 << _S_nosubs); 00096 00097 /** 00098 * Specifies that the regular expression engine should pay more attention to 00099 * the speed with which regular expressions are matched, and less to the 00100 * speed with which regular expression objects are constructed. Otherwise 00101 * it has no detectable effect on the program output. 00102 */ 00103 constexpr syntax_option_type optimize = 00104 static_cast<syntax_option_type>(1 << _S_optimize); 00105 00106 /** 00107 * Specifies that character ranges of the form [a-b] should be locale 00108 * sensitive. 00109 */ 00110 constexpr syntax_option_type collate = 00111 static_cast<syntax_option_type>(1 << _S_collate); 00112 00113 /** 00114 * Specifies that the grammar recognized by the regular expression engine is 00115 * that used by ECMAScript in ECMA-262 [Ecma International, ECMAScript 00116 * Language Specification, Standard Ecma-262, third edition, 1999], as 00117 * modified in section [28.13]. This grammar is similar to that defined 00118 * in the PERL scripting language but extended with elements found in the 00119 * POSIX regular expression grammar. 00120 */ 00121 constexpr syntax_option_type ECMAScript = 00122 static_cast<syntax_option_type>(1 << _S_ECMAScript); 00123 00124 /** 00125 * Specifies that the grammar recognized by the regular expression engine is 00126 * that used by POSIX basic regular expressions in IEEE Std 1003.1-2001, 00127 * Portable Operating System Interface (POSIX), Base Definitions and 00128 * Headers, Section 9, Regular Expressions [IEEE, Information Technology -- 00129 * Portable Operating System Interface (POSIX), IEEE Standard 1003.1-2001]. 00130 */ 00131 constexpr syntax_option_type basic = 00132 static_cast<syntax_option_type>(1 << _S_basic); 00133 00134 /** 00135 * Specifies that the grammar recognized by the regular expression engine is 00136 * that used by POSIX extended regular expressions in IEEE Std 1003.1-2001, 00137 * Portable Operating System Interface (POSIX), Base Definitions and 00138 * Headers, Section 9, Regular Expressions. 00139 */ 00140 constexpr syntax_option_type extended = 00141 static_cast<syntax_option_type>(1 << _S_extended); 00142 00143 /** 00144 * Specifies that the grammar recognized by the regular expression engine is 00145 * that used by POSIX utility awk in IEEE Std 1003.1-2001. This option is 00146 * identical to syntax_option_type extended, except that C-style escape 00147 * sequences are supported. These sequences are: 00148 * \\\\, \\a, \\b, \\f, \\n, \\r, \\t , \\v, \\&apos,, &apos,, 00149 * and \\ddd (where ddd is one, two, or three octal digits). 00150 */ 00151 constexpr syntax_option_type awk = 00152 static_cast<syntax_option_type>(1 << _S_awk); 00153 00154 /** 00155 * Specifies that the grammar recognized by the regular expression engine is 00156 * that used by POSIX utility grep in IEEE Std 1003.1-2001. This option is 00157 * identical to syntax_option_type basic, except that newlines are treated 00158 * as whitespace. 00159 */ 00160 constexpr syntax_option_type grep = 00161 static_cast<syntax_option_type>(1 << _S_grep); 00162 00163 /** 00164 * Specifies that the grammar recognized by the regular expression engine is 00165 * that used by POSIX utility grep when given the -E option in 00166 * IEEE Std 1003.1-2001. This option is identical to syntax_option_type 00167 * extended, except that newlines are treated as whitespace. 00168 */ 00169 constexpr syntax_option_type egrep = 00170 static_cast<syntax_option_type>(1 << _S_egrep); 00171 00172 constexpr inline syntax_option_type 00173 operator&(syntax_option_type __a, syntax_option_type __b) 00174 { 00175 return (syntax_option_type)(static_cast<unsigned int>(__a) 00176 & static_cast<unsigned int>(__b)); 00177 } 00178 00179 constexpr inline syntax_option_type 00180 operator|(syntax_option_type __a, syntax_option_type __b) 00181 { 00182 return (syntax_option_type)(static_cast<unsigned int>(__a) 00183 | static_cast<unsigned int>(__b)); 00184 } 00185 00186 constexpr inline syntax_option_type 00187 operator^(syntax_option_type __a, syntax_option_type __b) 00188 { 00189 return (syntax_option_type)(static_cast<unsigned int>(__a) 00190 ^ static_cast<unsigned int>(__b)); 00191 } 00192 00193 constexpr inline syntax_option_type 00194 operator~(syntax_option_type __a) 00195 { return (syntax_option_type)(~static_cast<unsigned int>(__a)); } 00196 00197 inline syntax_option_type& 00198 operator&=(syntax_option_type& __a, syntax_option_type __b) 00199 { return __a = __a & __b; } 00200 00201 inline syntax_option_type& 00202 operator|=(syntax_option_type& __a, syntax_option_type __b) 00203 { return __a = __a | __b; } 00204 00205 inline syntax_option_type& 00206 operator^=(syntax_option_type& __a, syntax_option_type __b) 00207 { return __a = __a ^ __b; } 00208 00209 //@} 00210 00211 /** 00212 * @name 5.2 Matching Rules 00213 * 00214 * Matching a regular expression against a sequence of characters [first, 00215 * last) proceeds according to the rules of the grammar specified for the 00216 * regular expression object, modified according to the effects listed 00217 * below for any bitmask elements set. 00218 * 00219 */ 00220 //@{ 00221 00222 enum __match_flag 00223 { 00224 _S_not_bol, 00225 _S_not_eol, 00226 _S_not_bow, 00227 _S_not_eow, 00228 _S_any, 00229 _S_not_null, 00230 _S_continuous, 00231 _S_prev_avail, 00232 _S_sed, 00233 _S_no_copy, 00234 _S_first_only, 00235 _S_match_flag_last 00236 }; 00237 00238 /** 00239 * @brief This is a bitmask type indicating regex matching rules. 00240 * 00241 * The @c match_flag_type is implementation defined but it is valid to 00242 * perform bitwise operations on these values and expect the right thing to 00243 * happen. 00244 */ 00245 enum match_flag_type : unsigned int { }; 00246 00247 /** 00248 * The default matching rules. 00249 */ 00250 constexpr match_flag_type match_default = static_cast<match_flag_type>(0); 00251 00252 /** 00253 * The first character in the sequence [first, last) is treated as though it 00254 * is not at the beginning of a line, so the character (^) in the regular 00255 * expression shall not match [first, first). 00256 */ 00257 constexpr match_flag_type match_not_bol = 00258 static_cast<match_flag_type>(1 << _S_not_bol); 00259 00260 /** 00261 * The last character in the sequence [first, last) is treated as though it 00262 * is not at the end of a line, so the character ($) in the regular 00263 * expression shall not match [last, last). 00264 */ 00265 constexpr match_flag_type match_not_eol = 00266 static_cast<match_flag_type>(1 << _S_not_eol); 00267 00268 /** 00269 * The expression \\b is not matched against the sub-sequence 00270 * [first,first). 00271 */ 00272 constexpr match_flag_type match_not_bow = 00273 static_cast<match_flag_type>(1 << _S_not_bow); 00274 00275 /** 00276 * The expression \\b should not be matched against the sub-sequence 00277 * [last,last). 00278 */ 00279 constexpr match_flag_type match_not_eow = 00280 static_cast<match_flag_type>(1 << _S_not_eow); 00281 00282 /** 00283 * If more than one match is possible then any match is an acceptable 00284 * result. 00285 */ 00286 constexpr match_flag_type match_any = 00287 static_cast<match_flag_type>(1 << _S_any); 00288 00289 /** 00290 * The expression does not match an empty sequence. 00291 */ 00292 constexpr match_flag_type match_not_null = 00293 static_cast<match_flag_type>(1 << _S_not_null); 00294 00295 /** 00296 * The expression only matches a sub-sequence that begins at first . 00297 */ 00298 constexpr match_flag_type match_continuous = 00299 static_cast<match_flag_type>(1 << _S_continuous); 00300 00301 /** 00302 * --first is a valid iterator position. When this flag is set then the 00303 * flags match_not_bol and match_not_bow are ignored by the regular 00304 * expression algorithms 28.11 and iterators 28.12. 00305 */ 00306 constexpr match_flag_type match_prev_avail = 00307 static_cast<match_flag_type>(1 << _S_prev_avail); 00308 00309 /** 00310 * When a regular expression match is to be replaced by a new string, the 00311 * new string is constructed using the rules used by the ECMAScript replace 00312 * function in ECMA- 262 [Ecma International, ECMAScript Language 00313 * Specification, Standard Ecma-262, third edition, 1999], part 15.5.4.11 00314 * String.prototype.replace. In addition, during search and replace 00315 * operations all non-overlapping occurrences of the regular expression 00316 * are located and replaced, and sections of the input that did not match 00317 * the expression are copied unchanged to the output string. 00318 * 00319 * Format strings (from ECMA-262 [15.5.4.11]): 00320 * @li $$ The dollar-sign itself ($) 00321 * @li $& The matched substring. 00322 * @li $` The portion of @a string that precedes the matched substring. 00323 * This would be match_results::prefix(). 00324 * @li $' The portion of @a string that follows the matched substring. 00325 * This would be match_results::suffix(). 00326 * @li $n The nth capture, where n is in [1,9] and $n is not followed by a 00327 * decimal digit. If n <= match_results::size() and the nth capture 00328 * is undefined, use the empty string instead. If n > 00329 * match_results::size(), the result is implementation-defined. 00330 * @li $nn The nnth capture, where nn is a two-digit decimal number on 00331 * [01, 99]. If nn <= match_results::size() and the nth capture is 00332 * undefined, use the empty string instead. If 00333 * nn > match_results::size(), the result is implementation-defined. 00334 */ 00335 constexpr match_flag_type format_default = static_cast<match_flag_type>(0); 00336 00337 /** 00338 * When a regular expression match is to be replaced by a new string, the 00339 * new string is constructed using the rules used by the POSIX sed utility 00340 * in IEEE Std 1003.1- 2001 [IEEE, Information Technology -- Portable 00341 * Operating System Interface (POSIX), IEEE Standard 1003.1-2001]. 00342 */ 00343 constexpr match_flag_type format_sed = 00344 static_cast<match_flag_type>(1 << _S_sed); 00345 00346 /** 00347 * During a search and replace operation, sections of the character 00348 * container sequence being searched that do not match the regular 00349 * expression shall not be copied to the output string. 00350 */ 00351 constexpr match_flag_type format_no_copy = 00352 static_cast<match_flag_type>(1 << _S_no_copy); 00353 00354 /** 00355 * When specified during a search and replace operation, only the first 00356 * occurrence of the regular expression shall be replaced. 00357 */ 00358 constexpr match_flag_type format_first_only = 00359 static_cast<match_flag_type>(1 << _S_first_only); 00360 00361 constexpr inline match_flag_type 00362 operator&(match_flag_type __a, match_flag_type __b) 00363 { 00364 return (match_flag_type)(static_cast<unsigned int>(__a) 00365 & static_cast<unsigned int>(__b)); 00366 } 00367 00368 constexpr inline match_flag_type 00369 operator|(match_flag_type __a, match_flag_type __b) 00370 { 00371 return (match_flag_type)(static_cast<unsigned int>(__a) 00372 | static_cast<unsigned int>(__b)); 00373 } 00374 00375 constexpr inline match_flag_type 00376 operator^(match_flag_type __a, match_flag_type __b) 00377 { 00378 return (match_flag_type)(static_cast<unsigned int>(__a) 00379 ^ static_cast<unsigned int>(__b)); 00380 } 00381 00382 constexpr inline match_flag_type 00383 operator~(match_flag_type __a) 00384 { return (match_flag_type)(~static_cast<unsigned int>(__a)); } 00385 00386 inline match_flag_type& 00387 operator&=(match_flag_type& __a, match_flag_type __b) 00388 { return __a = __a & __b; } 00389 00390 inline match_flag_type& 00391 operator|=(match_flag_type& __a, match_flag_type __b) 00392 { return __a = __a | __b; } 00393 00394 inline match_flag_type& 00395 operator^=(match_flag_type& __a, match_flag_type __b) 00396 { return __a = __a ^ __b; } 00397 00398 //@} 00399 00400 _GLIBCXX_END_NAMESPACE_VERSION 00401 } // namespace regex_constants 00402 00403 /* @} */ // group regex 00404 } // namespace std 00405