search

boostorg / spirit

Boost.org spirit module
http://boost.org/libs/spirit
393 stars 161 forks source link

Custom debug handler support for X3 #576

Open saki7 opened 4 years ago

saki7 commented 4 years ago

In Spirit.Qi, we had qi::debug(...) function for specifying custom debug handler. https://github.com/boostorg/spirit/blob/889babc3839e12ac0bba448ecd7150956d17c783/include/boost/spirit/home/qi/nonterminal/debug_handler.hpp#L75-L123

However in X3's current implementation, simple_trace is hard-coded:

https://github.com/boostorg/spirit/blob/889babc3839e12ac0bba448ecd7150956d17c783/include/boost/spirit/home/x3/nonterminal/detail/rule.hpp#L60-L91

I'd love to see custom debug handler support in X3.

EDIT: The reason why I need this functionality is because X3's default debug handler prints Unicode strings as an array of integer code points. What I expected to see was e.g. ['H', 'e', 'l', 'l', 'o'], but instead I get [72, 101, 108, 108, 111]. Perhaps this specific issue is more suited to be handled in a separate issue...

theodelrieu commented 3 years ago

I have the same need, it's very hard to debug what's going on with all those numbers

djowel commented 3 years ago

Would anyone care to submit a PR?

theodelrieu commented 3 years ago

Sure, I wonder if one should be able to fully customize the handler, or if it's sufficient to add a customization point for token_printer_debug (in support/traits/print_token.hpp).

djowel commented 3 years ago

I'd personally prefer customization points. Start with something usable but simple, then we can improve the API as needed.

theodelrieu commented 3 years ago

I'll tackle this next week, I have to write a patch to make char32_t the char_type of the unicode encoding, which can have an impact on how to solve this unicode debug handler problem.