metaparse/doc/fail_at_first_char_expected.qbk
2015-09-05 16:11:18 +02:00

94 lines
2.5 KiB
Plaintext

[#fail_at_first_char_expected]
[section fail_at_first_char_expected]
[h1 Synopsis]
template <class P>
struct fail_at_first_char_expected;
This is a [link parser_combinator parser combinator].
[table Arguments
[[Name] [Type]]
[[`P`] [[link parser parser]]]
]
[h1 Description]
It tries to parse the input using `P`. When `P` rejects the input without
consuming any character, `fail_at_first_char_expected` accepts the input.
Otherwise (when `P` accepts the input or when it consumes characters before
rejecting the input) `fail_at_first_char_expected` rejects the input.
[h1 Header]
#include <boost/metaparse/fail_at_first_char_expected.hpp>
[h1 Expression semantics]
For any `p` parser, `s` compile-time string and `pos` source position:
When `is_error<p::apply<s, pos>>::type` is false, the following are equivalent:
fail_at_first_char_expected<p>::apply<s, pos>::type
reject<error::expected_to_fail, pos>
When `is_error<p::apply<s, pos>>::type` is true and
`boost::mpl::equal_to<pos, get_position<p::apply<s, pos>>::type>::type` is also
true, the following are equivalent:
get_remaining<except<p, c, msg>, s, pos>::type
accept</* unspecified */, s, pos>
Otherwise the following are equivalent:
get_remaining<except<p, c, msg>, s, pos>::type
p::apply<s, pos>::type
[h1 Example]
#include <boost/metaparse/fail_at_first_char_expected.hpp>
#include <boost/metaparse/int_.hpp>
#include <boost/metaparse/lit_c.hpp>
#include <boost/metaparse/foldl_start_with_parser.hpp>
#include <boost/metaparse/first_of.hpp>
#include <boost/metaparse/last_of.hpp>
#include <boost/metaparse/string.hpp>
#include <boost/metaparse/start.hpp>
#include <boost/metaparse/is_error.hpp>
#include <boost/metaparse/get_result.hpp>
#include <boost/mpl/lambda.hpp>
#include <boost/mpl/plus.hpp>
using namespace boost::metaparse;
using plus_int = last_of<lit_c<'+'>, int_>;
using plus_exp =
first_of<
foldl_start_with_parser<
plus_int,
int_,
boost::mpl::lambda<boost::mpl::plus<boost::mpl::_1, boost::mpl::_2>>::type
>,
fail_at_first_char_expected<plus_int>
>;
static_assert(
get_result<
plus_exp::apply<BOOST_METAPARSE_STRING("1+2+3"), start>
>::type::value == 6,
"it should accept the input when it is a list of '+' separated ints"
);
static_assert(
is_error<
plus_exp::apply<BOOST_METAPARSE_STRING("1+2+3+"), start>
>::type::value,
"it should reject the input when it has an extra +"
);
[endsect]