mirror of
https://github.com/boostorg/quickbook.git
synced 2026-01-27 07:02:15 +00:00
af25300f1c
Merged revisions 54812-54818 via svnmerge from https://svn.boost.org/svn/boost/trunk ........ r54812 | danieljames | 2009-07-08 22:40:14 +0100 (Wed, 08 Jul 2009) | 1 line Add a couple of tests for quickbook 1.4 behaviour to try to preserve it. ........ r54813 | danieljames | 2009-07-08 22:40:24 +0100 (Wed, 08 Jul 2009) | 1 line Move all the syntax highlighting code into a single class. ........ r54814 | danieljames | 2009-07-08 22:40:33 +0100 (Wed, 08 Jul 2009) | 1 line Move the code actions a bit later in actions.hpp so they can use 'plain_char_action'. ........ r54815 | danieljames | 2009-07-08 22:40:46 +0100 (Wed, 08 Jul 2009) | 1 line Teletype source mode. Refs #1202. ........ r54816 | danieljames | 2009-07-08 22:41:00 +0100 (Wed, 08 Jul 2009) | 14 lines Make sure that a template expansion ends with a ']'. {{{ [template foo 1] [fool] }}} was generating `1[fool]` - the template would be expanded but then when it didn't match the `]` it would fail and just get copied to the output. This change checks for `]` before expanding the template. So it now generates `[fool]` which is an improvement. I'm not including a version switch as I see this as a plain bug fix - I can't imagine this change ever being anything but beneficial. ........ r54817 | danieljames | 2009-07-08 22:41:10 +0100 (Wed, 08 Jul 2009) | 1 line I got a bit confused by this comment, so try to make it clearer. ........ r54818 | danieljames | 2009-07-08 22:53:15 +0100 (Wed, 08 Jul 2009) | 3 lines Support INTERNAL ONLY enums in doxygen/boostbook documenation. Refs #3242. Patch by Mathias Gaunard. ........ [SVN r54910]
408 lines
15 KiB
C++
408 lines
15 KiB
C++
/*=============================================================================
|
|
Copyright (c) 2002 2004 2006 Joel de Guzman
|
|
Copyright (c) 2004 Eric Niebler
|
|
http://spirit.sourceforge.net/
|
|
|
|
Use, modification and distribution is subject to 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)
|
|
=============================================================================*/
|
|
#if !defined(BOOST_SPIRIT_QUICKBOOK_SYNTAX_HIGHLIGHT_HPP)
|
|
#define BOOST_SPIRIT_QUICKBOOK_SYNTAX_HIGHLIGHT_HPP
|
|
|
|
#include <boost/spirit/include/classic_core.hpp>
|
|
#include <boost/spirit/include/classic_confix.hpp>
|
|
#include <boost/spirit/include/classic_chset.hpp>
|
|
#include <boost/spirit/include/classic_symbols.hpp>
|
|
#include <boost/spirit/include/classic_loops.hpp>
|
|
#include "./phrase.hpp"
|
|
|
|
namespace quickbook
|
|
{
|
|
using namespace boost::spirit::classic;
|
|
|
|
// Grammar for C++ highlighting
|
|
template <
|
|
typename Process
|
|
, typename Space
|
|
, typename Macro
|
|
, typename DoMacro
|
|
, typename PreEscape
|
|
, typename PostEscape
|
|
, typename EscapeActions
|
|
, typename Unexpected
|
|
, typename Out>
|
|
struct cpp_highlight
|
|
: public grammar<cpp_highlight<Process, Space, Macro, DoMacro, PreEscape, PostEscape, EscapeActions, Unexpected, Out> >
|
|
{
|
|
cpp_highlight(Out& out, Macro const& macro, DoMacro do_macro, EscapeActions& escape_actions)
|
|
: out(out), macro(macro), do_macro(do_macro), escape_actions(escape_actions) {}
|
|
|
|
template <typename Scanner>
|
|
struct definition
|
|
{
|
|
definition(cpp_highlight const& self)
|
|
: common(self.escape_actions, unused)
|
|
, unused(false)
|
|
{
|
|
program
|
|
=
|
|
*( (+space_p) [Space(self.out)]
|
|
| macro
|
|
| escape
|
|
| preprocessor [Process("preprocessor", self.out)]
|
|
| comment [Process("comment", self.out)]
|
|
| keyword [Process("keyword", self.out)]
|
|
| identifier [Process("identifier", self.out)]
|
|
| special [Process("special", self.out)]
|
|
| string_ [Process("string", self.out)]
|
|
| char_ [Process("char", self.out)]
|
|
| number [Process("number", self.out)]
|
|
| repeat_p(1)[anychar_p] [Unexpected(self.out)]
|
|
)
|
|
;
|
|
|
|
macro =
|
|
eps_p(self.macro // must not be followed by
|
|
>> (eps_p - (alpha_p | '_'))) // alpha or underscore
|
|
>> self.macro [self.do_macro]
|
|
;
|
|
|
|
qbk_phrase =
|
|
*( common
|
|
| (anychar_p - str_p("``")) [self.escape_actions.plain_char]
|
|
)
|
|
;
|
|
|
|
escape =
|
|
str_p("``") [PreEscape(self.escape_actions, save)]
|
|
>>
|
|
(
|
|
(
|
|
(
|
|
(+(anychar_p - "``") >> eps_p("``"))
|
|
& qbk_phrase
|
|
)
|
|
>> str_p("``")
|
|
)
|
|
|
|
|
(
|
|
eps_p [self.escape_actions.error]
|
|
>> *anychar_p
|
|
)
|
|
) [PostEscape(self.out, self.escape_actions, save)]
|
|
;
|
|
|
|
preprocessor
|
|
= '#' >> *space_p >> ((alpha_p | '_') >> *(alnum_p | '_'))
|
|
;
|
|
|
|
comment
|
|
= comment_p("//") | comment_p("/*", "*/")
|
|
;
|
|
|
|
keyword
|
|
= keyword_ >> (eps_p - (alnum_p | '_'))
|
|
; // make sure we recognize whole words only
|
|
|
|
keyword_
|
|
= "and_eq", "and", "asm", "auto", "bitand", "bitor",
|
|
"bool", "break", "case", "catch", "char", "class",
|
|
"compl", "const_cast", "const", "continue", "default",
|
|
"delete", "do", "double", "dynamic_cast", "else",
|
|
"enum", "explicit", "export", "extern", "false",
|
|
"float", "for", "friend", "goto", "if", "inline",
|
|
"int", "long", "mutable", "namespace", "new", "not_eq",
|
|
"not", "operator", "or_eq", "or", "private",
|
|
"protected", "public", "register", "reinterpret_cast",
|
|
"return", "short", "signed", "sizeof", "static",
|
|
"static_cast", "struct", "switch", "template", "this",
|
|
"throw", "true", "try", "typedef", "typeid",
|
|
"typename", "union", "unsigned", "using", "virtual",
|
|
"void", "volatile", "wchar_t", "while", "xor_eq", "xor"
|
|
;
|
|
|
|
special
|
|
= +chset_p("~!%^&*()+={[}]:;,<.>?/|\\-")
|
|
;
|
|
|
|
string_char = ('\\' >> anychar_p) | (anychar_p - '\\');
|
|
|
|
string_
|
|
= !as_lower_d['l'] >> confix_p('"', *string_char, '"')
|
|
;
|
|
|
|
char_
|
|
= !as_lower_d['l'] >> confix_p('\'', *string_char, '\'')
|
|
;
|
|
|
|
number
|
|
= (
|
|
as_lower_d["0x"] >> hex_p
|
|
| '0' >> oct_p
|
|
| real_p
|
|
)
|
|
>> *as_lower_d[chset_p("ldfu")]
|
|
;
|
|
|
|
identifier
|
|
= (alpha_p | '_') >> *(alnum_p | '_')
|
|
;
|
|
}
|
|
|
|
rule<Scanner> program, macro, preprocessor, comment, special, string_,
|
|
char_, number, identifier, keyword, qbk_phrase, escape,
|
|
string_char;
|
|
|
|
symbols<> keyword_;
|
|
phrase_grammar<EscapeActions> common;
|
|
std::string save;
|
|
bool unused;
|
|
|
|
rule<Scanner> const&
|
|
start() const { return program; }
|
|
};
|
|
|
|
Out& out;
|
|
Macro const& macro;
|
|
DoMacro do_macro;
|
|
EscapeActions& escape_actions;
|
|
};
|
|
|
|
// Grammar for Python highlighting
|
|
// See also: The Python Reference Manual
|
|
// http://docs.python.org/ref/ref.html
|
|
template <
|
|
typename Process
|
|
, typename Space
|
|
, typename Macro
|
|
, typename DoMacro
|
|
, typename PreEscape
|
|
, typename PostEscape
|
|
, typename EscapeActions
|
|
, typename Unexpected
|
|
, typename Out>
|
|
struct python_highlight
|
|
: public grammar<python_highlight<Process, Space, Macro, DoMacro, PreEscape, PostEscape, EscapeActions, Unexpected, Out> >
|
|
{
|
|
python_highlight(Out& out, Macro const& macro, DoMacro do_macro, EscapeActions& escape_actions)
|
|
: out(out), macro(macro), do_macro(do_macro), escape_actions(escape_actions) {}
|
|
|
|
template <typename Scanner>
|
|
struct definition
|
|
{
|
|
definition(python_highlight const& self)
|
|
: common(self.escape_actions, unused)
|
|
, unused(false)
|
|
{
|
|
program
|
|
=
|
|
*( (+space_p) [Space(self.out)]
|
|
| macro
|
|
| escape
|
|
| comment [Process("comment", self.out)]
|
|
| keyword [Process("keyword", self.out)]
|
|
| identifier [Process("identifier", self.out)]
|
|
| special [Process("special", self.out)]
|
|
| string_ [Process("string", self.out)]
|
|
| number [Process("number", self.out)]
|
|
| repeat_p(1)[anychar_p] [Unexpected(self.out)]
|
|
)
|
|
;
|
|
|
|
macro =
|
|
eps_p(self.macro // must not be followed by
|
|
>> (eps_p - (alpha_p | '_'))) // alpha or underscore
|
|
>> self.macro [self.do_macro]
|
|
;
|
|
|
|
qbk_phrase =
|
|
*( common
|
|
| (anychar_p - str_p("``")) [self.escape_actions.plain_char]
|
|
)
|
|
;
|
|
|
|
escape =
|
|
str_p("``") [PreEscape(self.escape_actions, save)]
|
|
>>
|
|
(
|
|
(
|
|
(
|
|
(+(anychar_p - "``") >> eps_p("``"))
|
|
& qbk_phrase
|
|
)
|
|
>> str_p("``")
|
|
)
|
|
|
|
|
(
|
|
eps_p [self.escape_actions.error]
|
|
>> *anychar_p
|
|
)
|
|
) [PostEscape(self.out, self.escape_actions, save)]
|
|
;
|
|
|
|
comment
|
|
= comment_p("#")
|
|
;
|
|
|
|
keyword
|
|
= keyword_ >> (eps_p - (alnum_p | '_'))
|
|
; // make sure we recognize whole words only
|
|
|
|
keyword_
|
|
=
|
|
"and", "del", "for", "is", "raise",
|
|
"assert", "elif", "from", "lambda", "return",
|
|
"break", "else", "global", "not", "try",
|
|
"class", "except", "if", "or", "while",
|
|
"continue", "exec", "import", "pass", "yield",
|
|
"def", "finally", "in", "print",
|
|
|
|
// Technically "as" and "None" are not yet keywords (at Python
|
|
// 2.4). They are destined to become keywords, and we treat them
|
|
// as such for syntax highlighting purposes.
|
|
|
|
"as", "None"
|
|
;
|
|
|
|
special
|
|
= +chset_p("~!%^&*()+={[}]:;,<.>/|\\-")
|
|
;
|
|
|
|
string_prefix
|
|
= as_lower_d[str_p("u") >> ! str_p("r")]
|
|
;
|
|
|
|
string_
|
|
= ! string_prefix >> (long_string | short_string)
|
|
;
|
|
|
|
string_char = ('\\' >> anychar_p) | (anychar_p - '\\');
|
|
|
|
short_string
|
|
= confix_p('\'', * string_char, '\'') |
|
|
confix_p('"', * string_char, '"')
|
|
;
|
|
|
|
long_string
|
|
// Note: the "str_p" on the next two lines work around
|
|
// an INTERNAL COMPILER ERROR when using VC7.1
|
|
= confix_p(str_p("'''"), * string_char, "'''") |
|
|
confix_p(str_p("\"\"\""), * string_char, "\"\"\"")
|
|
;
|
|
|
|
number
|
|
= (
|
|
as_lower_d["0x"] >> hex_p
|
|
| '0' >> oct_p
|
|
| real_p
|
|
)
|
|
>> *as_lower_d[chset_p("lj")]
|
|
;
|
|
|
|
identifier
|
|
= (alpha_p | '_') >> *(alnum_p | '_')
|
|
;
|
|
}
|
|
|
|
rule<Scanner> program, macro, comment, special, string_, string_prefix,
|
|
short_string, long_string, number, identifier, keyword,
|
|
qbk_phrase, escape, string_char;
|
|
|
|
symbols<> keyword_;
|
|
phrase_grammar<EscapeActions> common;
|
|
std::string save;
|
|
bool unused;
|
|
|
|
rule<Scanner> const&
|
|
start() const { return program; }
|
|
};
|
|
|
|
Out& out;
|
|
Macro const& macro;
|
|
DoMacro do_macro;
|
|
EscapeActions& escape_actions;
|
|
};
|
|
|
|
// Grammar for plain text (no actual highlighting)
|
|
template <
|
|
typename CharProcess
|
|
, typename Macro
|
|
, typename DoMacro
|
|
, typename PreEscape
|
|
, typename PostEscape
|
|
, typename EscapeActions
|
|
, typename Out>
|
|
struct teletype_highlight
|
|
: public grammar<teletype_highlight<CharProcess, Macro, DoMacro, PreEscape, PostEscape, EscapeActions, Out> >
|
|
{
|
|
teletype_highlight(Out& out, Macro const& macro, DoMacro do_macro, EscapeActions& escape_actions)
|
|
: out(out), macro(macro), do_macro(do_macro), escape_actions(escape_actions) {}
|
|
|
|
template <typename Scanner>
|
|
struct definition
|
|
{
|
|
definition(teletype_highlight const& self)
|
|
: common(self.escape_actions, unused)
|
|
, unused(false)
|
|
{
|
|
program
|
|
=
|
|
*( macro
|
|
| escape
|
|
| repeat_p(1)[anychar_p] [CharProcess(self.out)]
|
|
)
|
|
;
|
|
|
|
macro =
|
|
eps_p(self.macro // must not be followed by
|
|
>> (eps_p - (alpha_p | '_'))) // alpha or underscore
|
|
>> self.macro [self.do_macro]
|
|
;
|
|
|
|
qbk_phrase =
|
|
*( common
|
|
| (anychar_p - str_p("``")) [self.escape_actions.plain_char]
|
|
)
|
|
;
|
|
|
|
escape =
|
|
str_p("``") [PreEscape(self.escape_actions, save)]
|
|
>>
|
|
(
|
|
(
|
|
(
|
|
(+(anychar_p - "``") >> eps_p("``"))
|
|
& qbk_phrase
|
|
)
|
|
>> str_p("``")
|
|
)
|
|
|
|
|
(
|
|
eps_p [self.escape_actions.error]
|
|
>> *anychar_p
|
|
)
|
|
) [PostEscape(self.out, self.escape_actions, save)]
|
|
;
|
|
}
|
|
|
|
rule<Scanner> program, macro, qbk_phrase, escape;
|
|
|
|
phrase_grammar<EscapeActions> common;
|
|
std::string save;
|
|
bool unused;
|
|
|
|
rule<Scanner> const&
|
|
start() const { return program; }
|
|
};
|
|
|
|
Out& out;
|
|
Macro const& macro;
|
|
DoMacro do_macro;
|
|
EscapeActions& escape_actions;
|
|
};
|
|
|
|
}
|
|
|
|
#endif // BOOST_SPIRIT_QUICKBOOK_SYNTAX_HIGHLIGHT_HPP
|