以期望提升精神 x3 错误处理程序

Question

我想使用 boost::spirit::x3 为基于行的文件创建一个解析器，例如每一行都具有相同的结构并且可以重复。此外，我想要一些详细的错误描述，以防出现错误。最后，文件应该有可能以换行符结尾。

现在，如果我在该行的第一个元素上使用 x3::expect，我会遇到一些奇怪的行为。错误处理程序打印错误，但整体解析不会失败。为什么会这样？以及如何修复？如果我不期望行的第一个元素，我不会得到详细的错误描述。

下面是重现此问题的示例：

#include <boost/spirit/home/x3.hpp>
#include <boost/spirit/home/x3/support/utility/annotate_on_success.hpp>
#include <boost/spirit/home/x3/support/utility/error_reporting.hpp>
#include <boost/fusion/include/define_struct.hpp>

#include <iostream>

namespace x3 = boost::spirit::x3;

struct error_handler
{
    template<typename Iterator, typename Exception, typename Context>
    x3::error_handler_result on_error(Iterator& first, Iterator const& last,
                                      Exception const& x,
                                      Context const& context)
    {
        auto& error_handler = x3::get<x3::error_handler_tag>(context).get();
        std::string message = "Error! Expecting: " + x.which() + " here:";
        error_handler(x.where(), message);
        return x3::error_handler_result::fail;
    }
};

namespace boost::spirit::x3 {
    template<>
    struct get_info<int_type>
    {
        std::string operator()(int_type const&) const
        { return "integral number"; }
    };

    template<>
    struct get_info<char_type>
    {
        std::string operator()(char_type const&) const
        { return "character"; }
    };
}  // namespace boost::spirit::x3

struct Line_tag : error_handler
{
};
struct File_tag : error_handler
{
};

BOOST_FUSION_DEFINE_STRUCT((), Data, (char, c)(int, x))
BOOST_FUSION_DEFINE_STRUCT((), DataContainer, (std::vector<Data>, data))

template<bool ExpectFirstElementOfLine>
DataContainer parse(std::string_view input)
{
    auto iter = input.cbegin();
    auto const end = input.cend();

    const auto charParser = []() {
        if constexpr (ExpectFirstElementOfLine)
            return x3::expect[x3::char_("a-zA-Z")];
        else
            return x3::char_("a-zA-Z");
    }();

    const auto line = x3::rule<Line_tag, Data>{"line"} = charParser > x3::int_;
    const auto file = x3::rule<File_tag, DataContainer>{"file"} = (line % x3::eol) >> -x3::eol >> x3::eoi;

    x3::error_handler<decltype(iter)> error_handler(iter, end, std::cout);
    DataContainer container;
    if (parse(iter, end, x3::with<x3::error_handler_tag>(std::ref(error_handler))[file], container))
    {
        if (iter != end)
            throw std::runtime_error("Remaining unparsed");
    }
    else
        throw std::runtime_error("Parse failed");

    return container;
}

template<bool ExpectFirstElementOfLine>
void testParse(std::string_view input)
{
    try
    {
        std::cout << "=========================" << std::endl;
        const auto container = parse<ExpectFirstElementOfLine>(input);
        std::cout << "Parsed [OK]: " << container.data.size() << std::endl;
    }
    catch (const std::exception& ex)
    {
        std::cout << "EXCEPTION: " << ex.what() << std::endl;
    }
}

int main()
{
    const std::string_view input1 = "x1\nx456";
    const std::string_view input2 = "x1\nx456\n";
    const std::string_view input3 = "x1\n456\n";
    // OK
    testParse<true>(input1);
    testParse<false>(input1);

    // parse succeeds but error handler prints message if expectation on first element of line is used
    testParse<true>(input2);
    testParse<false>(input2);

    // parsing fails but detailed error description only works if first element of line was expected
    testParse<true>(input3);
    testParse<false>(input3);
}

产生：

=========================
Parsed [OK]: 2
=========================
Parsed [OK]: 2
=========================
In line 3:
Error! Expecting: char-set here:

^_
Parsed [OK]: 2
=========================
Parsed [OK]: 2
=========================
In line 2:
Error! Expecting: char-set here:
456
^_
EXCEPTION: Parse failed
=========================
EXCEPTION: Parse failed

Answer 1

为什么 testParse<true>("x1\nx456\n"); 的预期失败？

对于该输入，(line % x3::eol) 将运行三次：
1. 尝试line -- ok（消耗x1），尝试x3::eol -- ok（消耗\n），重复
2. 尝试line -- ok（消耗x456），尝试x3::eol -- ok（消耗\n），重复
3. 尝试 line，它尝试 x3::expect[x3::char_("a-zA-Z")]，但失败了——期望失败
错误处理程序打印错误，但整体解析没有失败。为什么会这样？

当期望解析器失败时——它抛出一个 expectation_failure 异常。但是，当您为规则设置错误处理程序时——该规则将为您捕获异常，并调用您的错误处理程序。错误处理程序通过 returning 适当的 error_handler_result 枚举类型值来向规则发出错误处理结果信号。

您的错误处理程序 returns error_handler_result::fail -- 这表示规则解析失败，有效地将 expect[x] 变成 x。换句话说，您的错误处理程序只是对失败的语义操作（而不是对通常的语义操作的成功）。

列表解析器 line % x3::eol 只是 line >> *(x3::eol >> line)。因为您的错误处理程序将任何预期失败转变为常规失败，所以很明显，在第一次成功解析后 line 任何失败都不会导致整个解析失败。
如何修复？

你没有说清楚你想要什么。如果您只是希望 expectation_failure 异常从您的错误处理程序中传播 - return 一个 error_handler_result::rethrow。

以期望提升精神 x3 错误处理程序

boost spirit x3 error handler with expectations

c++

boost-spirit-x3