ceph/src/boost/libs/metaparse/doc/reference.qbk

   1 [#reference]
   2 [section Reference]
   3
   4 [section Parsers and combinators provided by the library]
   5
   6 [#parsers]
   7 [section Parsers]
   8
   9 [section Character]
  10
  11 * [link alphanum alphanum]
  12 * [link digit digit]
  13 * [link letter letter]
  14 * [link lit lit]
  15 * [link lit_c lit_c]
  16 * [link one_char one_char]
  17 * [link one_char_except one_char_except]
  18 * [link one_char_except_c one_char_except_c]
  19 * [link range range]
  20 * [link range_c range_c]
  21 * [link space space]
  22
  23 [endsect]
  24
  25 [section Numeric]
  26
  27 * [link digit_val digit_val]
  28 * [link int_ int_]
  29
  30 [endsect]
  31
  32 [section Whitespace]
  33
  34 * [link space space]
  35 * [link spaces spaces]
  36
  37 [endsect]
  38
  39 [section Validation and error reporting]
  40
  41 * [link empty empty]
  42 * [link fail fail]
  43
  44 [endsect]
  45
  46 [section Miscellaneous]
  47
  48 * [link keyword keyword]
  49 * [link return_ return_]
  50
  51 [endsect]
  52
  53 [endsect]
  54
  55 [#combinators]
  56 [section Combinators]
  57
  58 [section Validation and error reporting]
  59
  60 * [link accept_when accept_when]
  61 * [link change_error_message change_error_message]
  62 * [link entire_input entire_input]
  63 * [link except except]
  64 * [link fail_at_first_char_expected fail_at_first_char_expected]
  65 * [link transform_error transform_error]
  66 * [link transform_error_message transform_error_message]
  67
  68 [endsect]
  69
  70 [section Repetition]
  71
  72 See the [link repetition Repetition] section of the
  73 [link manual User Manual] for a detailed comparison of the most common
  74 repetition combinators.
  75
  76 [link finding-the-right-folding-parser-combinator Cheat-sheet] for
  77 choosing among the `fold*` parsers.
  78
  79 * [link foldl foldl]
  80 * [link foldl1 foldl1]
  81 * [link foldl_reject_incomplete foldl_reject_incomplete]
  82 * [link foldl_reject_incomplete1 foldl_reject_incomplete1]
  83 * [link foldl_reject_incomplete_start_with_parser foldl_reject_incomplete_start_with_parser]
  84 * [link foldl_start_with_parser foldl_start_with_parser]
  85 * [link foldr foldr]
  86 * [link foldr1 foldr1]
  87 * [link foldr_reject_incomplete foldr_reject_incomplete]
  88 * [link foldr_reject_incomplete1 foldr_reject_incomplete1]
  89 * [link foldr_start_with_parser foldr_start_with_parser]
  90 * [link iterate iterate]
  91 * [link iterate_c iterate_c]
  92 * [link repeated repeated]
  93 * [link repeated1 repeated1]
  94 * [link repeated_reject_incomplete repeated_reject_incomplete]
  95 * [link repeated_reject_incomplete1 repeated_reject_incomplete1]
  96 * [link repeated_one_of repeated_one_of]
  97 * [link repeated_one_of1 repeated_one_of1]
  98
  99 [endsect]
 100
 101 [section Selection]
 102
 103 * [link if_ if_]
 104 * [link one_of one_of]
 105 * [link one_of_c one_of_c]
 106 * [link optional optional]
 107 * [link repeated_one_of repeated_one_of]
 108 * [link repeated_one_of1 repeated_one_of1]
 109
 110 [endsect]
 111
 112 [section Sequence]
 113
 114 * [link first_of first_of]
 115 * [link last_of last_of]
 116 * [link middle_of middle_of]
 117 * [link nth_of nth_of]
 118 * [link nth_of_c nth_of_c]
 119 * [link sequence sequence]
 120 * [link sequence_apply sequence_apply]
 121
 122 [endsect]
 123
 124 [section Result transformation (semantic actions)]
 125
 126 * [link always always]
 127 * [link always_c always_c]
 128 * [link transform transform]
 129
 130 [endsect]
 131
 132 [section Miscellaneous]
 133
 134 * [link grammar grammar]
 135 * [link look_ahead look_ahead]
 136 * [link token token]
 137
 138 [endsect]
 139
 140 [endsect]
 141
 142 [endsect]
 143
 144 [section Compile-time data structures and values]
 145
 146 [section Result of parsing]
 147
 148 * [link accept accept]
 149 * [link get_message get_message]
 150 * [link get_position get_position]
 151 * [link get_remaining get_remaining]
 152 * [link get_result get_result]
 153 * [link is_error is_error]
 154 * [link reject reject]
 155
 156 [endsect]
 157
 158 [section Source position]
 159
 160 * [link get_col get_col]
 161 * [link get_line get_line]
 162 * [link get_prev_char get_prev_char]
 163 * [link next_char next_char]
 164 * [link next_line next_line]
 165 * [link source_position source_position]
 166 * [link source_position_tag source_position_tag]
 167 * [link start start]
 168
 169 [endsect]
 170
 171 [endsect]
 172
 173 [#ref-string]
 174 [section String]
 175
 176 * [link string string]
 177 * [link string_tag string_tag]
 178 * [link BOOST_METAPARSE_STRING BOOST_METAPARSE_STRING]
 179
 180 [endsect]
 181
 182 [section Errors]
 183
 184 * [link digit_expected digit_expected]
 185 * [link end_of_input_expected end_of_input_expected]
 186 * [link expected_to_fail expected_to_fail]
 187 * [link index_out_of_range index_out_of_range]
 188 * [link letter_expected letter_expected]
 189 * [link literal_expected literal_expected]
 190 * [link none_of_the_expected_cases_found none_of_the_expected_cases_found]
 191 * [link unexpected_character unexpected_character]
 192 * [link unexpected_end_of_input unexpected_end_of_input]
 193 * [link unpaired unpaired]
 194 * [link whitespace_expected whitespace_expected]
 195
 196 [endsect]
 197
 198 [section Tags]
 199
 200 * [link accept_tag accept_tag]
 201 * [link fail_tag fail_tag]
 202 * [link source_position_tag source_position_tag]
 203
 204 [endsect]
 205
 206 [section Utilities]
 207
 208 * [link build_parser build_parser]
 209 * [link debug_parsing_error debug_parsing_error]
 210 * [link BOOST_METAPARSE_DEFINE_ERROR BOOST_METAPARSE_DEFINE_ERROR]
 211 * [link BOOST_METAPARSE_VERSION BOOST_METAPARSE_VERSION]
 212 * [link unless_error unless_error]
 213
 214 Metaparse uses a number of general purpose metafunctions and metafunction
 215 classes.
 216
 217 * [link digit_to_int digit_to_int]
 218 * [link digit_to_int_c digit_to_int_c]
 219 * [link int_to_digit int_to_digit]
 220 * [link int_to_digit_c int_to_digit_c]
 221 * [link in_range in_range]
 222 * [link in_range_c in_range_c]
 223 * [link is_digit is_digit]
 224 * [link is_lcase_letter is_lcase_letter]
 225 * [link is_letter is_letter]
 226 * [link is_ucase_letter is_ucase_letter]
 227 * [link is_whitespace is_whitespace]
 228 * [link is_whitespace_c is_whitespace_c]
 229
 230 [endsect]
 231
 232 [section Terms used by the library]
 233
 234 * [link boxed_value boxed value]
 235 * [link currying currying]
 236 * [link lazy_metafunction lazy template metafunction]
 237 * [link nullary_metafunction nullary template metafunction]
 238 * [link parser parser]
 239 * [link parser_combinator parser combinator]
 240 * [link parsing_error_message parsing error message]
 241 * [link predicate predicate]
 242 * [link tag tag]
 243 * [link metafunction template metafunction]
 244 * [link metafunction_class template metafunction class]
 245 * [link metaprogramming_value template metaprogramming value]
 246
 247 [endsect]
 248
 249 [section Alphabetical]
 250
 251 [include accept.qbk]
 252 [include accept_tag.qbk]
 253 [include accept_when.qbk]
 254 [include alphanum.qbk]
 255 [include always_c.qbk]
 256 [include always.qbk]
 257 [include BOOST_METAPARSE_DEFINE_ERROR.qbk]
 258 [include BOOST_METAPARSE_STRING.qbk]
 259 [include BOOST_METAPARSE_VERSION.qbk]
 260 [include boxed_value.qbk]
 261 [include build_parser.qbk]
 262 [include change_error_message.qbk]
 263 [include currying.qbk]
 264 [include debug_parsing_error.qbk]
 265 [include digit_expected.qbk]
 266 [include digit.qbk]
 267 [include digit_to_int_c.qbk]
 268 [include digit_to_int.qbk]
 269 [include digit_val.qbk]
 270 [include empty.qbk]
 271 [include end_of_input_expected.qbk]
 272 [include entire_input.qbk]
 273 [include except.qbk]
 274 [include expected_to_fail.qbk]
 275 [include fail_at_first_char_expected.qbk]
 276 [include fail.qbk]
 277 [include fail_tag.qbk]
 278 [include first_of.qbk]
 279 [include foldl1.qbk]
 280 [include foldl_reject_incomplete.qbk]
 281 [include foldl_reject_incomplete1.qbk]
 282 [include foldl_reject_incomplete_start_with_parser.qbk]
 283 [include foldl_start_with_parser.qbk]
 284 [include foldl.qbk]
 285 [include foldr1.qbk]
 286 [include foldr_reject_incomplete.qbk]
 287 [include foldr_reject_incomplete1.qbk]
 288 [include foldr_start_with_parser.qbk]
 289 [include foldr.qbk]
 290 [include get_col.qbk]
 291 [include get_line.qbk]
 292 [include get_message.qbk]
 293 [include get_position.qbk]
 294 [include get_prev_char.qbk]
 295 [include get_remaining.qbk]
 296 [include get_result.qbk]
 297 [include grammar.qbk]
 298 [include if_.qbk]
 299 [include index_out_of_range.qbk]
 300 [include in_range_c.qbk]
 301 [include in_range.qbk]
 302 [include int_.qbk]
 303 [include int_to_digit_c.qbk]
 304 [include int_to_digit.qbk]
 305 [include is_digit.qbk]
 306 [include is_error.qbk]
 307 [include is_lcase_letter.qbk]
 308 [include is_letter.qbk]
 309 [include is_ucase_letter.qbk]
 310 [include is_whitespace_c.qbk]
 311 [include is_whitespace.qbk]
 312 [include iterate_c.qbk]
 313 [include iterate.qbk]
 314 [include keyword.qbk]
 315 [include last_of.qbk]
 316 [include lazy_metafunction.qbk]
 317 [include letter_expected.qbk]
 318 [include letter.qbk]
 319 [include lit_c.qbk]
 320 [include literal_expected.qbk]
 321 [include lit.qbk]
 322 [include look_ahead.qbk]
 323 [include metafunction_class.qbk]
 324 [include metafunction.qbk]
 325 [include metaprogramming_value.qbk]
 326 [include middle_of.qbk]
 327 [include next_char.qbk]
 328 [include next_line.qbk]
 329 [include none_of_the_expected_cases_found.qbk]
 330 [include nth_of_c.qbk]
 331 [include nth_of.qbk]
 332 [include nullary_metafunction.qbk]
 333 [include one_char_except_c.qbk]
 334 [include one_char_except.qbk]
 335 [include one_char.qbk]
 336 [include one_of_c.qbk]
 337 [include one_of.qbk]
 338 [include optional.qbk]
 339 [include parser_combinator.qbk]
 340 [include parser.qbk]
 341 [include parsing_error_message.qbk]
 342 [include predicate.qbk]
 343 [include range_c.qbk]
 344 [include range.qbk]
 345 [include reject.qbk]
 346 [include repeated1.qbk]
 347 [include repeated_reject_incomplete1.qbk]
 348 [include repeated_reject_incomplete.qbk]
 349 [include repeated_one_of1.qbk]
 350 [include repeated_one_of.qbk]
 351 [include repeated.qbk]
 352 [include return_.qbk]
 353 [include sequence.qbk]
 354 [include sequence_apply.qbk]
 355 [include source_position.qbk]
 356 [include source_position_tag.qbk]
 357 [include space.qbk]
 358 [include spaces.qbk]
 359 [include start.qbk]
 360 [include string.qbk]
 361 [include string_tag.qbk]
 362 [include tag.qbk]
 363 [include token.qbk]
 364 [include transform_error_message.qbk]
 365 [include transform_error.qbk]
 366 [include transform.qbk]
 367 [include unexpected_character.qbk]
 368 [include unexpected_end_of_input.qbk]
 369 [include unless_error.qbk]
 370 [include unpaired.qbk]
 371 [include whitespace_expected.qbk]
 372
 373 [endsect]
 374
 375 [endsect]
 376