fix doc example typo
[boost.git] / boost / regex / v4 / match_flags.hpp
blob9585aca8b23bdb641ef9b32c915c983c90071b5a
1 /*
3 * Copyright (c) 1998-2002
4 * John Maddock
6 * Use, modification and distribution are subject to the
7 * Boost Software License, Version 1.0. (See accompanying file
8 * LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
13 * LOCATION: see http://www.boost.org for most recent version.
14 * FILE match_flags.hpp
15 * VERSION see <boost/version.hpp>
16 * DESCRIPTION: Declares match_flags type.
19 #ifndef BOOST_REGEX_V4_MATCH_FLAGS
20 #define BOOST_REGEX_V4_MATCH_FLAGS
22 #ifdef __cplusplus
23 # include <boost/cstdint.hpp>
24 #endif
26 #ifdef __cplusplus
27 namespace boost{
28 namespace regex_constants{
29 #endif
31 typedef enum _match_flags
33 match_default = 0,
34 match_not_bol = 1, // first is not start of line
35 match_not_eol = match_not_bol << 1, // last is not end of line
36 match_not_bob = match_not_eol << 1, // first is not start of buffer
37 match_not_eob = match_not_bob << 1, // last is not end of buffer
38 match_not_bow = match_not_eob << 1, // first is not start of word
39 match_not_eow = match_not_bow << 1, // last is not end of word
40 match_not_dot_newline = match_not_eow << 1, // \n is not matched by '.'
41 match_not_dot_null = match_not_dot_newline << 1, // '\0' is not matched by '.'
42 match_prev_avail = match_not_dot_null << 1, // *--first is a valid expression
43 match_init = match_prev_avail << 1, // internal use
44 match_any = match_init << 1, // don't care what we match
45 match_not_null = match_any << 1, // string can't be null
46 match_continuous = match_not_null << 1, // each grep match must continue from
47 // uninterupted from the previous one
48 match_partial = match_continuous << 1, // find partial matches
50 match_stop = match_partial << 1, // stop after first match (grep) V3 only
51 match_not_initial_null = match_stop, // don't match initial null, V4 only
52 match_all = match_stop << 1, // must find the whole of input even if match_any is set
53 match_perl = match_all << 1, // Use perl matching rules
54 match_posix = match_perl << 1, // Use POSIX matching rules
55 match_nosubs = match_posix << 1, // don't trap marked subs
56 match_extra = match_nosubs << 1, // include full capture information for repeated captures
57 match_single_line = match_extra << 1, // treat text as single line and ignor any \n's when matching ^ and $.
58 match_unused1 = match_single_line << 1, // unused
59 match_unused2 = match_unused1 << 1, // unused
60 match_unused3 = match_unused2 << 1, // unused
61 match_max = match_unused3,
63 format_perl = 0, // perl style replacement
64 format_default = 0, // ditto.
65 format_sed = match_max << 1, // sed style replacement.
66 format_all = format_sed << 1, // enable all extentions to sytax.
67 format_no_copy = format_all << 1, // don't copy non-matching segments.
68 format_first_only = format_no_copy << 1, // Only replace first occurance.
69 format_is_if = format_first_only << 1, // internal use only.
70 format_literal = format_is_if << 1 // treat string as a literal
72 } match_flags;
74 #if (defined(_MSC_VER) && (_MSC_VER < 1300)) || defined(__BORLANDC__)
75 typedef unsigned long match_flag_type;
76 #else
77 typedef match_flags match_flag_type;
80 #ifdef __cplusplus
81 inline match_flags operator&(match_flags m1, match_flags m2)
82 { return static_cast<match_flags>(static_cast<boost::int32_t>(m1) & static_cast<boost::int32_t>(m2)); }
83 inline match_flags operator|(match_flags m1, match_flags m2)
84 { return static_cast<match_flags>(static_cast<boost::int32_t>(m1) | static_cast<boost::int32_t>(m2)); }
85 inline match_flags operator^(match_flags m1, match_flags m2)
86 { return static_cast<match_flags>(static_cast<boost::int32_t>(m1) ^ static_cast<boost::int32_t>(m2)); }
87 inline match_flags operator~(match_flags m1)
88 { return static_cast<match_flags>(~static_cast<boost::int32_t>(m1)); }
89 inline match_flags& operator&=(match_flags& m1, match_flags m2)
90 { m1 = m1&m2; return m1; }
91 inline match_flags& operator|=(match_flags& m1, match_flags m2)
92 { m1 = m1|m2; return m1; }
93 inline match_flags& operator^=(match_flags& m1, match_flags m2)
94 { m1 = m1^m2; return m1; }
95 #endif
96 #endif
98 #ifdef __cplusplus
99 } // namespace regex_constants
101 // import names into boost for backwards compatiblity:
103 using regex_constants::match_flag_type;
104 using regex_constants::match_default;
105 using regex_constants::match_not_bol;
106 using regex_constants::match_not_eol;
107 using regex_constants::match_not_bob;
108 using regex_constants::match_not_eob;
109 using regex_constants::match_not_bow;
110 using regex_constants::match_not_eow;
111 using regex_constants::match_not_dot_newline;
112 using regex_constants::match_not_dot_null;
113 using regex_constants::match_prev_avail;
114 //using regex_constants::match_init;
115 using regex_constants::match_any;
116 using regex_constants::match_not_null;
117 using regex_constants::match_continuous;
118 using regex_constants::match_partial;
119 //using regex_constants::match_stop;
120 using regex_constants::match_all;
121 using regex_constants::match_perl;
122 using regex_constants::match_posix;
123 using regex_constants::match_nosubs;
124 using regex_constants::match_extra;
125 using regex_constants::match_single_line;
126 //using regex_constants::match_max;
127 using regex_constants::format_all;
128 using regex_constants::format_sed;
129 using regex_constants::format_perl;
130 using regex_constants::format_default;
131 using regex_constants::format_no_copy;
132 using regex_constants::format_first_only;
133 //using regex_constants::format_is_if;
135 } // namespace boost
136 #endif // __cplusplus
137 #endif // include guard