parser/test/lexer_and_parser.cpp

/**
 *   Copyright (C) 2024 T. Zachary Laine
 *
 *   Distributed under the Boost Software License, Version 1.0. (See
 *   accompanying file LICENSE_1_0.txt or copy at
 *   http://www.boost.org/LICENSE_1_0.txt)
 */

#define BOOST_PARSER_TESTING
//[ tokens_basics_headers
#include <boost/parser/lexer.hpp>
#include <boost/parser/parser.hpp>
//]

#include <boost/core/lightweight_test.hpp>

#include "adobe_lexer.hpp"


namespace bp = boost::parser;

int main()
{
    // Minimal test; just instantiate the member functions, without involving
    // the parse() API.
    {
        bp::token<char> tokens[1] = {};
        auto p = bp::token_spec<"12", 12, int>;
        auto first = std::begin(tokens);
        auto const last = std::end(tokens);

        bp::detail::nope globals;
        bp::default_error_handler error_handler;

        // From parse_impl().
        bool success = true;
        int trace_indent = 0;
        bp::detail::symbol_table_tries_t symbol_table_tries;
        bp::detail::pending_symbol_table_operations_t
            pending_symbol_table_operations;
        bp::detail::scoped_apply_pending_symbol_table_operations apply_pending(
            pending_symbol_table_operations);
        auto context = bp::detail::make_context<false, false>(
            first,
            last,
            success,
            trace_indent,
            error_handler,
            globals,
            symbol_table_tries,
            pending_symbol_table_operations);
        auto const flags = bp::detail::flags::gen_attrs;

        std::optional<int> result =
            p(first, last, context, bp::ws, flags, success);
        (void)result;
    }

    // Minimal tests of building parsers from token_parser and token_spec.
    {
        auto parser1 = true_false(true);
        auto parser2 = true_false(false);
        (void)parser1;
        (void)parser2;
    }
    {
        auto parser = identifier("foo") >> '=' >> true_false >> ';';
        (void)parser;
    }

    // Minimal tests of using a lexer and parser together.
    {
        auto parser = identifier("foo") >> '=' >> true_false >> ';';
        auto r = "some input" | bp::to_tokens(adobe_lexer);
        auto result = bp::parse(r, parser);
        BOOST_TEST(!result);

        static_assert(!std::same_as<
                      std::remove_cvref_t<
                          decltype(bp::detail::tokens_view_or_nope(r))>,
                      bp::detail::nope>);

        auto const & cr = r;
        static_assert(!std::same_as<
                      std::remove_cvref_t<
                          decltype(bp::detail::tokens_view_or_nope(cr))>,
                      bp::detail::nope>);
    }
    {
        auto parser = identifier >> '=' >> true_false >> ';';
        auto r = "foo = false;" | bp::to_tokens(adobe_lexer);
        auto result = bp::parse(r, parser);
        BOOST_TEST(result);
        BOOST_TEST(std::get<0>(*result) == "foo");
        BOOST_TEST(std::get<1>(*result) == false);
    }

    // Test the use of an external token cache.
    {
        auto parser = identifier >> '=' >> true_false >> ';';
        std::vector<bp::token<char>> cache;
        auto r = "foo = false;" | bp::to_tokens(adobe_lexer, std::ref(cache));
        auto result = bp::parse(r, parser);
        BOOST_TEST(std::get<0>(*result) == "foo");
        BOOST_TEST(std::get<1>(*result) == false);
        BOOST_TEST(cache.size() == 4u);
    }

    // Test the clearing of the token cache at expectation points.
    {
        auto parser = identifier >> '=' > true_false >> ';';
        std::vector<bp::token<char>> cache;
        auto r = "foo = false;" | bp::to_tokens(adobe_lexer, std::ref(cache));
        auto result = bp::parse(r, parser);
        BOOST_TEST(std::get<0>(*result) == "foo");
        BOOST_TEST(std::get<1>(*result) == false);
        BOOST_TEST(cache.size() == 2u);
    }

    // TODO: Add API tests exercising all the *parse() overloads that accept
    // tokens_views.

    // TODO: Add tests exercising all terminal parsers (esp. character
    // parsers) that are compat. w/token parsing.

    // TODO: Adapt symbols for use with token parsing; test here.

    // TODO: Adapt the string literal parser to match against
    // string_view-providing tokens.

    // doc examples
    // clang-format off
    {
    //[ tokens_basics_lexer
    auto const foo = bp::token_spec<"foo", 0>;
    auto const bar = bp::token_spec<"b.r", 1>;
    auto const baz = bp::token_spec<"b.z", 2>;

    auto const lexer = bp::lexer<char, int> | foo | bar | baz;
    //]

    //[ tokens_basics_input_range
    auto r = "foobazbar" | bp::to_tokens(lexer);
    //]

    //[ tokens_basics_parser
    auto parser = foo >> baz >> bar;
    //]

    //[ tokens_basics_parse
    auto result = bp::parse(r, parser);
    assert(result);
    assert(std::get<0>(*result) == "foo");
    assert(std::get<1>(*result) == "baz");
    assert(std::get<2>(*result) == "bar");
    //]
    }

    {
    //[ tokens_attrs
    constexpr auto true_false = bp::token_spec<"true|false", 0, bool>;
    constexpr auto identifier = bp::token_spec<"[a-zA-Z]\\w*", 1>;
    constexpr auto number = bp::token_spec<"\\d+(?:\\.\\d*)?", 2, double>;
    //]
    (void)true_false;
    (void)identifier;
    (void)number;
    }

    {
    //[ tokens_token_char
    constexpr auto true_false = bp::token_spec<"true|false", 0, bool>;
    constexpr auto identifier = bp::token_spec<"[a-zA-Z]\\w*", 1>;

    constexpr auto lexer =
        bp::lexer<char, int> | true_false | identifier | bp::token_chars<'=', ';'>;

    auto parser = identifier >> '=' >> true_false >> ';';
    auto r = "foo = false;" | bp::to_tokens(lexer);
    auto result = bp::parse(r, parser);
    assert(result);
    assert(std::get<0>(*result) == "foo");
    assert(std::get<1>(*result) == false);
    //]
    }

    {
    //[ tokens_caching_simple
    constexpr auto true_false = bp::token_spec<"true|false", 0, bool>;
    constexpr auto identifier = bp::token_spec<"[a-zA-Z]\\w*", 1>;

    constexpr auto lexer =
        bp::lexer<char, int> | true_false | identifier | bp::token_chars<'=', ';'>;

    auto parser = identifier >> '=' >> true_false >> ';';
    std::vector<bp::token<char>> cache;
    auto r = "foo = false;" | bp::to_tokens(lexer, std::ref(cache));
    auto result = bp::parse(r, parser);
    assert(result);
    assert(std::get<0>(*result) == "foo");
    assert(std::get<1>(*result) == false);
    assert(cache.size() == 4u);
    //]
    }

    {
    constexpr auto true_false = bp::token_spec<"true|false", 0, bool>;
    constexpr auto identifier = bp::token_spec<"[a-zA-Z]\\w*", 1>;

    constexpr auto lexer =
        bp::lexer<char, int> | true_false | identifier | bp::token_chars<'=', ';'>;

    //[ tokens_caching_expectation_point
    auto parser = identifier >> '=' > true_false >> ';';
    std::vector<bp::token<char>> cache;
    auto r = "foo = false;" | bp::to_tokens(lexer, std::ref(cache));
    auto result = bp::parse(r, parser);
    assert(result);
    assert(std::get<0>(*result) == "foo");
    assert(std::get<1>(*result) == false);
    assert(cache.size() == 2u);
    //]
    }
    // clang-format on

    return boost::report_errors();
}