0
0
Fork 0
mirror of https://github.com/matrix-construct/construct synced 2024-10-31 10:58:54 +01:00
construct/include/ircd/spirit.h
2020-06-17 22:39:03 -07:00

530 lines
13 KiB
C++

// Matrix Construct
//
// Copyright (C) Matrix Construct Developers, Authors & Contributors
// Copyright (C) 2016-2018 Jason Volk <jason@zemos.net>
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice is present in all copies. The
// full license for this software is available in the LICENSE file.
#ifndef HAVE_IRCD_SPIRIT_H
#define HAVE_IRCD_SPIRIT_H
/// This file is not part of the IRCd standard include list (stdinc.h) because
/// it involves extremely expensive boost headers for creating formal spirit
/// grammars. Include this in a definition file which defines such grammars.
///
/// Note that directly sharing elements of a grammar between two compilation
/// units can be achieved with forward declarations in `ircd/grammar.h`.
// ircd.h is included here so that it can be compiled into this header. Then
// this becomes the single leading precompiled header.
#include <ircd/ircd.h>
// Disables asserts in spirit headers even when we're NDEBUG due to
// some false asserts around boolean character tests in spirit.
#define BOOST_DISABLE_ASSERTS
#pragma GCC visibility push(default)
#include <boost/config.hpp>
#include <boost/function.hpp>
#pragma GCC visibility pop
#pragma GCC visibility push(hidden)
#include <boost/fusion/sequence.hpp>
#include <boost/fusion/iterator.hpp>
#include <boost/fusion/adapted.hpp>
#include <boost/fusion/functional.hpp>
#include <boost/fusion/algorithm.hpp>
#include <boost/fusion/include/std_pair.hpp>
#include <boost/spirit/include/qi.hpp>
#include <boost/spirit/include/karma.hpp>
#include <boost/spirit/include/phoenix.hpp>
#include <boost/spirit/repository/include/qi_seek.hpp>
#include <boost/spirit/repository/include/qi_subrule.hpp>
#pragma GCC visibility pop
namespace ircd {
namespace spirit
__attribute__((visibility("default")))
{
template<class parent_error> struct expectation_failure;
struct substring_view;
IRCD_EXCEPTION(ircd::error, error);
IRCD_EXCEPTION(error, generator_error);
IRCD_EXCEPTION(generator_error, buffer_overrun);
}}
namespace ircd {
namespace spirit
__attribute__((visibility("hidden")))
{
namespace spirit = boost::spirit;
namespace ascii = spirit::ascii;
namespace karma = spirit::karma;
namespace qi = spirit::qi;
namespace phx = boost::phoenix;
using _val_type = phx::actor<spirit::attribute<0>>;
using _r0_type = phx::actor<spirit::attribute<0>>;
using _r1_type = phx::actor<spirit::attribute<1>>;
using _r2_type = phx::actor<spirit::attribute<2>>;
using _r3_type = phx::actor<spirit::attribute<3>>;
using spirit::unused_type;
using spirit::auto_;
using spirit::_pass;
using spirit::_val;
using qi::locals;
using qi::_a;
using qi::_a_type;
using qi::_r1_type;
using qi::raw;
using qi::omit;
using qi::matches;
using qi::hold;
using qi::eoi;
using qi::eps;
using qi::expect;
using qi::attr;
using qi::attr_cast;
using qi::repeat;
using qi::lit;
using qi::char_;
using qi::byte_;
using qi::string;
using qi::short_;
using qi::ushort_;
using qi::word;
using qi::big_word;
using qi::little_word;
using qi::int_;
using qi::uint_;
using qi::dword;
using qi::big_dword;
using qi::little_dword;
using qi::long_;
using qi::ulong_;
using qi::qword;
using qi::big_qword;
using qi::little_qword;
using qi::float_;
using qi::bin_float;
using qi::big_bin_float;
using qi::little_bin_float;
using qi::double_;
using qi::bin_double;
using qi::big_bin_double;
using qi::little_bin_double;
using spirit::repository::qi::seek;
using karma::lit;
using karma::char_;
using karma::long_;
using karma::double_;
using karma::bool_;
using karma::eps;
using karma::attr_cast;
using karma::maxwidth;
using karma::buffer;
using karma::skip;
using prop_mask = mpl_::int_
<
karma::generator_properties::no_properties
| karma::generator_properties::buffering
| karma::generator_properties::counting
| karma::generator_properties::tracking
| karma::generator_properties::disabling
>;
using sink_type = karma::detail::output_iterator<char *, prop_mask, unused_type>;
template<size_t idx,
class semantic_context>
auto &
attr_at(semantic_context&&);
template<size_t idx,
class semantic_context>
auto &
local_at(semantic_context&&);
}}
namespace ircd::spirit::local
{
using qi::_0;
using qi::_1;
using qi::_2;
using qi::_3;
}
namespace ircd {
namespace spirit
__attribute__((visibility("default")))
{
// parse.cc
extern thread_local char rule_buffer[64];
extern thread_local struct generator_state *generator_state;
}}
namespace ircd {
namespace spirit
__attribute__((visibility("internal")))
{
template<class gen,
class... attr>
bool parse(const char *&start, const char *const &stop, gen&&, attr&&...);
template<class parent_error,
size_t error_show_max = 48,
class gen,
class... attr>
bool parse(const char *&start, const char *const &stop, gen&&, attr&&...);
template<bool truncation = false,
class gen,
class... attr>
bool generate(mutable_buffer &out, gen&&, attr&&...);
}}
namespace ircd
{
using spirit::generate;
using spirit::parse;
}
namespace ircd {
namespace spirit
__attribute__((visibility("default")))
{
}}
struct ircd::spirit::substring_view
:ircd::string_view
{
using _iterator = boost::spirit::karma::detail::indirect_iterator<const char *>;
using _iterator_range = boost::iterator_range<_iterator>;
using ircd::string_view::string_view;
explicit substring_view(const _iterator_range &range)
:ircd::string_view
{
std::addressof(*range.begin()), std::addressof(*range.end())
}
{}
};
template<class parent_error>
struct __attribute__((visibility("default")))
ircd::spirit::expectation_failure
:parent_error
{
template<class it = const char *>
expectation_failure(const qi::expectation_failure<it> &e,
const ssize_t &show_max = 64);
template<class it = const char *>
expectation_failure(const qi::expectation_failure<it> &e,
const it &start,
const ssize_t &show_max = 64);
};
template<class parent>
template<class it>
ircd::spirit::expectation_failure<parent>::expectation_failure(const qi::expectation_failure<it> &e,
const ssize_t &show_max)
:parent
{
"Expected %s. You input %zd invalid characters :%s",
ircd::string(rule_buffer, e.what_),
std::distance(e.first, e.last),
string_view{e.first, e.first + std::min(std::distance(e.first, e.last), show_max)}
}
{}
template<class parent>
template<class it>
ircd::spirit::expectation_failure<parent>::expectation_failure(const qi::expectation_failure<it> &e,
const it &start,
const ssize_t &show_max)
:parent
{
"Expected %s. You input %zd invalid characters somewhere between position %zd and %zd :%s",
ircd::string(rule_buffer, e.what_),
std::distance(e.first, e.last),
std::distance(start, e.first),
std::distance(start, e.last),
string_view{e.first, e.first + std::min(std::distance(e.first, e.last), show_max)}
}
{}
struct [[gnu::visibility("hidden")]]
ircd::spirit::generator_state
{
/// Destination buffer (used like window_buffer).
mutable_buffer &out;
/// Current consumption count of the destination buffer.
ssize_t consumed {0};
/// The number of attemtped generated characters to the destination. This
/// can be larger than the consumed counter to indicate the destination
/// buffer is insufficient. Note that characters are otherwise quietly
/// discarded when the destination (out) is full.
ssize_t generated {0};
/// Internal state for buffer_sink::copy()
ssize_t last_generated {0}, last_width {0};
/// Count of rejected from the destination buffer.
ssize_t overflow {0};
};
template<bool truncation,
class gen,
class... attr>
[[using gnu: flatten, always_inline, gnu_inline, artificial]]
extern inline bool
ircd::spirit::generate(mutable_buffer &out,
gen&& g,
attr&&... a)
{
const auto max(size(out));
const auto start(data(out));
struct generator_state state
{
out
};
const scope_restore _state
{
generator_state, &state
};
sink_type sink
{
begin(out)
};
const auto ret
{
karma::generate(sink, std::forward<gen>(g), std::forward<attr>(a)...)
};
if constexpr(truncation)
{
begin(out) = state.overflow? end(out) : begin(out);
assert(!state.overflow || begin(out) == end(out));
assert(begin(out) <= end(out));
return ret;
}
if(unlikely(state.overflow || begin(out) > end(out)))
{
char pbuf[2][48];
const auto required
{
max + state.overflow?:
std::distance(start, begin(out))
};
throw buffer_overrun
{
"Insufficient buffer of %s; required at least %s",
pretty(pbuf[0], iec(max)),
pretty(pbuf[1], iec(required)),
};
}
assert(begin(out) >= end(out) - max);
assert(begin(out) <= end(out));
return ret;
}
template<class parent_error,
size_t error_show_max,
class gen,
class... attr>
[[using gnu: flatten, always_inline, gnu_inline, artificial]]
extern inline bool
ircd::spirit::parse(const char *&start,
const char *const &stop,
gen&& g,
attr&&... a)
try
{
return qi::parse(start, stop, std::forward<gen>(g), std::forward<attr>(a)...);
}
catch(const qi::expectation_failure<const char *> &e)
{
throw expectation_failure<parent_error>
{
e, start, error_show_max
};
}
template<class gen,
class... attr>
[[using gnu: flatten, always_inline, gnu_inline, artificial]]
extern inline bool
ircd::spirit::parse(const char *&start,
const char *const &stop,
gen&& g,
attr&&... a)
{
return qi::parse(start, stop, std::forward<gen>(g), std::forward<attr>(a)...);
}
template<size_t idx,
class semantic_context>
inline auto &
ircd::spirit::local_at(semantic_context&& c)
{
return boost::fusion::at_c<idx>(c.locals);
}
template<size_t idx,
class semantic_context>
inline auto &
ircd::spirit::attr_at(semantic_context&& c)
{
return boost::fusion::at_c<idx>(c.attributes);
}
namespace boost::spirit::karma::detail
{
template<> bool buffer_sink::copy(ircd::spirit::sink_type &, size_t maxwidth) const;
template<> void buffer_sink::output(const char &);
}
template<>
inline void
boost::spirit::karma::detail::position_policy::output(const char &value)
{
}
#if 0
template<>
template<>
inline void
boost::spirit::karma::detail::counting_policy<ircd::spirit::sink_type>::output(const char &value)
{
}
#endif
#if 0
template<>
inline bool
boost::spirit::karma::detail::buffering_policy::output(const char &value)
{
if(likely(this->buffer != nullptr))
{
this->buffer->output(value);
return false;
}
else return true;
}
#endif
template<>
inline void
boost::spirit::karma::detail::buffer_sink::output(const char &value)
{
assert(ircd::spirit::generator_state);
#if __has_builtin(__builtin_assume)
__builtin_assume(ircd::spirit::generator_state != nullptr);
#endif
auto &state
{
*ircd::spirit::generator_state
};
const auto &consumed
{
ircd::consume(state.out, ircd::copy(state.out, value))
};
assert(consumed <= 1UL);
this->width += consumed;
state.overflow += !consumed;
state.generated++;
}
template<>
inline bool
boost::spirit::karma::detail::buffer_sink::copy(ircd::spirit::sink_type &sink,
size_t maxwidth)
const
{
assert(ircd::spirit::generator_state);
#if __has_builtin(__builtin_assume)
__builtin_assume(ircd::spirit::generator_state != nullptr);
#endif
auto &state
{
*ircd::spirit::generator_state
};
assert(state.last_generated >= 0);
assert(state.generated >= state.last_generated);
const auto &width_diff
{
state.last_generated == state.generated?
ssize_t(this->width) - state.last_width:
ssize_t(this->width)
};
assert(width_diff >= -state.consumed);
assert(state.generated >= state.consumed);
state.consumed += width_diff;
assert(state.consumed >= 0);
const auto &rewind_count
{
state.generated - state.consumed
};
const auto &rewind
{
rewind_count >= 0L?
std::min(rewind_count, state.generated):
0L
};
assert(rewind >= 0L);
assert(rewind <= state.generated);
std::get<0>(state.out) -= rewind;
state.generated -= rewind;
assert(state.generated >= 0);
state.last_generated = state.generated;
state.last_width = this->width;
return true; //sink.good();
}
template<>
inline bool
boost::spirit::karma::detail::buffer_sink::copy_rest(ircd::spirit::sink_type &sink,
size_t start_at)
const
{
assert(false);
return true; //sink.good();
}
template<>
inline bool
ircd::spirit::sink_type::good()
const
{
return true;
}
#endif // HAVE_IRCD_SPIRIT_H