-
Notifications
You must be signed in to change notification settings - Fork 33
/
Copy pathsyntax_highlight.cpp
633 lines (544 loc) · 23.8 KB
/
syntax_highlight.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
/*=============================================================================
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)
=============================================================================*/
#include "syntax_highlight.hpp"
#include <boost/spirit/include/classic_chset.hpp>
#include <boost/spirit/include/classic_confix.hpp>
#include <boost/spirit/include/classic_core.hpp>
#include <boost/spirit/include/classic_loops.hpp>
#include <boost/spirit/include/classic_symbols.hpp>
#include "actions.hpp"
#include "files.hpp"
#include "grammar.hpp"
#include "phrase_tags.hpp"
#include "state.hpp"
#include "stream.hpp"
#include "utils.hpp"
namespace quickbook
{
namespace cl = boost::spirit::classic;
// Syntax Highlight Actions
struct syntax_highlight_actions
{
quickbook::state& state;
do_macro_action do_macro_impl;
// State
bool support_callouts;
quickbook::string_view marked_text;
syntax_highlight_actions(quickbook::state& state_, bool is_block_)
: state(state_)
, do_macro_impl(state_)
, support_callouts(
is_block_ && (qbk_version_n >= 107u ||
state.current_file->is_code_snippets))
, marked_text()
{
}
void span(parse_iterator, parse_iterator, char const*);
void span_start(parse_iterator, parse_iterator, char const*);
void span_end(parse_iterator, parse_iterator);
void unexpected_char(parse_iterator, parse_iterator);
void plain_char(parse_iterator, parse_iterator);
void pre_escape_back(parse_iterator, parse_iterator);
void post_escape_back(parse_iterator, parse_iterator);
void do_macro(std::string const&);
void mark_text(parse_iterator, parse_iterator);
void callout(parse_iterator, parse_iterator);
};
void syntax_highlight_actions::span(
parse_iterator first, parse_iterator last, char const* name)
{
state.phrase << "<phrase role=\"" << name << "\">";
while (first != last)
detail::print_char(*first++, state.phrase.get());
state.phrase << "</phrase>";
}
void syntax_highlight_actions::span_start(
parse_iterator first, parse_iterator last, char const* name)
{
state.phrase << "<phrase role=\"" << name << "\">";
while (first != last)
detail::print_char(*first++, state.phrase.get());
}
void syntax_highlight_actions::span_end(
parse_iterator first, parse_iterator last)
{
while (first != last)
detail::print_char(*first++, state.phrase.get());
state.phrase << "</phrase>";
}
void syntax_highlight_actions::unexpected_char(
parse_iterator first, parse_iterator last)
{
file_position const pos = state.current_file->position_of(first.base());
detail::outwarn(state.current_file->path, pos.line)
<< "in column:" << pos.column << ", unexpected character: "
<< std::string(first.base(), last.base()) << "\n";
// print out an unexpected character
state.phrase << "<phrase role=\"error\">";
while (first != last)
detail::print_char(*first++, state.phrase.get());
state.phrase << "</phrase>";
}
void syntax_highlight_actions::plain_char(
parse_iterator first, parse_iterator last)
{
while (first != last)
detail::print_char(*first++, state.phrase.get());
}
void syntax_highlight_actions::pre_escape_back(
parse_iterator, parse_iterator)
{
state.push_output(); // save the stream
}
void syntax_highlight_actions::post_escape_back(
parse_iterator, parse_iterator)
{
std::string tmp;
state.phrase.swap(tmp);
state.pop_output(); // restore the stream
state.phrase << tmp;
}
void syntax_highlight_actions::do_macro(std::string const& v)
{
do_macro_impl(v);
}
void syntax_highlight_actions::mark_text(
parse_iterator first, parse_iterator last)
{
marked_text =
quickbook::string_view(first.base(), last.base() - first.base());
}
void syntax_highlight_actions::callout(parse_iterator, parse_iterator)
{
state.phrase << state.add_callout(qbk_value(
state.current_file, marked_text.begin(), marked_text.end()));
marked_text.clear();
}
// Syntax
struct keywords_holder
{
cl::symbols<> cpp, python;
keywords_holder()
{
// clang-format off
cpp
= "alignas", "alignof", "and_eq", "and", "asm", "auto",
"bitand", "bitor", "bool", "break", "case", "catch",
"char", "char16_t", "char32_t", "class", "compl",
"const", "const_cast", "constexpr", "continue",
"decltype", "default", "delete", "do", "double",
"dynamic_cast", "else", "enum", "explicit", "export",
"extern", "false", "float", "for", "friend", "goto",
"if", "inline", "int", "long", "mutable", "namespace",
"new", "noexcept", "not_eq", "not", "nullptr",
"operator", "or_eq", "or", "private", "protected",
"public", "register", "reinterpret_cast", "return",
"short", "signed", "sizeof", "static", "static_assert",
"static_cast", "struct", "switch", "template", "this",
"thread_local", "throw", "true", "try", "typedef",
"typeid", "typename", "union", "unsigned", "using",
"virtual", "void", "volatile", "wchar_t", "while",
"xor_eq", "xor"
;
python
=
"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"
;
// clang-format on
}
};
namespace
{
keywords_holder keywords;
}
// Grammar for C++ highlighting
struct cpp_highlight : public cl::grammar<cpp_highlight>
{
explicit cpp_highlight(syntax_highlight_actions& actions_)
: actions(actions_)
{
}
template <typename Scanner> struct definition
{
definition(cpp_highlight const& self)
: g(self.actions.state.grammar())
{
// clang-format off
member_action1<syntax_highlight_actions, char const*>
span(self.actions, &syntax_highlight_actions::span),
span_start(self.actions, &syntax_highlight_actions::span_start);
member_action<syntax_highlight_actions>
span_end(self.actions, &syntax_highlight_actions::span_end),
unexpected_char(self.actions, &syntax_highlight_actions::unexpected_char),
plain_char(self.actions, &syntax_highlight_actions::plain_char),
pre_escape_back(self.actions, &syntax_highlight_actions::pre_escape_back),
post_escape_back(self.actions, &syntax_highlight_actions::post_escape_back),
mark_text(self.actions, &syntax_highlight_actions::mark_text),
callout(self.actions, &syntax_highlight_actions::callout);
member_action_value<syntax_highlight_actions, std::string const&>
do_macro(self.actions, &syntax_highlight_actions::do_macro);
error_action error(self.actions.state);
program =
*( (*cl::space_p) [plain_char]
>> (line_start | rest_of_line)
>> *rest_of_line
)
;
line_start =
preprocessor [span("preprocessor")]
;
rest_of_line =
(+cl::blank_p) [plain_char]
| macro
| escape
| cl::eps_p(ph::var(self.actions.support_callouts))
>> ( line_callout [callout]
| inline_callout [callout]
)
| comment
| keyword [span("keyword")]
| identifier [span("identifier")]
| special [span("special")]
| string_ [span("string")]
| char_ [span("char")]
| number [span("number")]
| ~cl::eps_p(cl::eol_p)
>> u8_codepoint_p [unexpected_char]
;
macro =
// must not be followed by alpha or underscore
cl::eps_p(self.actions.state.macro
>> (cl::eps_p - (cl::alpha_p | '_')))
>> self.actions.state.macro
[do_macro]
;
escape =
cl::str_p("``") [pre_escape_back]
>>
(
(
(
(+(cl::anychar_p - "``") >> cl::eps_p("``"))
& g.phrase_start
)
>> cl::str_p("``")
)
|
(
cl::eps_p [error]
>> *cl::anychar_p
)
) [post_escape_back]
;
preprocessor
= '#' >> *cl::space_p >> ((cl::alpha_p | '_') >> *(cl::alnum_p | '_'))
;
inline_callout
= cl::confix_p(
"/*<" >> *cl::space_p,
(*cl::anychar_p) [mark_text],
">*/"
)
;
line_callout
= cl::confix_p(
"/*<<" >> *cl::space_p,
(*cl::anychar_p) [mark_text],
">>*/"
)
>> *cl::space_p
;
comment
= cl::str_p("//") [span_start("comment")]
>> *( escape
| (+(cl::anychar_p - (cl::eol_p | "``")))
[plain_char]
)
>> cl::eps_p [span_end]
| cl::str_p("/*") [span_start("comment")]
>> *( escape
| (+(cl::anychar_p - (cl::str_p("*/") | "``")))
[plain_char]
)
>> (!cl::str_p("*/")) [span_end]
;
keyword
= keywords.cpp >> (cl::eps_p - (cl::alnum_p | '_'))
; // make sure we recognize whole words only
special
= +cl::chset_p("~!%^&*()+={[}]:;,<.>?/|\\#-")
;
string_char = ('\\' >> u8_codepoint_p) | (cl::anychar_p - '\\');
string_
= !cl::as_lower_d['l'] >> cl::confix_p('"', *string_char, '"')
;
char_
= !cl::as_lower_d['l'] >> cl::confix_p('\'', *string_char, '\'')
;
number
= (
cl::as_lower_d["0x"] >> cl::hex_p
| '0' >> cl::oct_p
| cl::real_p
)
>> *cl::as_lower_d[cl::chset_p("ldfu")]
;
identifier
= (cl::alpha_p | '_') >> *(cl::alnum_p | '_')
;
// clang-format on
}
cl::rule<Scanner> program, line_start, rest_of_line, macro,
preprocessor, inline_callout, line_callout, comment, special,
string_, char_, number, identifier, keyword, escape,
string_char;
quickbook_grammar& g;
cl::rule<Scanner> const& start() const { return program; }
};
syntax_highlight_actions& actions;
};
// Grammar for Python highlighting
// See also: The Python Reference Manual
// http://docs.python.org/ref/ref.html
struct python_highlight : public cl::grammar<python_highlight>
{
explicit python_highlight(syntax_highlight_actions& actions_)
: actions(actions_)
{
}
template <typename Scanner> struct definition
{
definition(python_highlight const& self)
: g(self.actions.state.grammar())
{
// clang-format off
member_action1<syntax_highlight_actions, char const*>
span(self.actions, &syntax_highlight_actions::span),
span_start(self.actions, &syntax_highlight_actions::span_start);
member_action<syntax_highlight_actions>
span_end(self.actions, &syntax_highlight_actions::span_end),
unexpected_char(self.actions, &syntax_highlight_actions::unexpected_char),
plain_char(self.actions, &syntax_highlight_actions::plain_char),
pre_escape_back(self.actions, &syntax_highlight_actions::pre_escape_back),
post_escape_back(self.actions, &syntax_highlight_actions::post_escape_back),
mark_text(self.actions, &syntax_highlight_actions::mark_text),
callout(self.actions, &syntax_highlight_actions::callout);
member_action_value<syntax_highlight_actions, std::string const&>
do_macro(self.actions, &syntax_highlight_actions::do_macro);
error_action error(self.actions.state);
program
=
*( (+cl::space_p) [plain_char]
| macro
| escape
| cl::eps_p(ph::var(self.actions.support_callouts))
>> ( line_callout [callout]
| inline_callout [callout]
)
| comment
| keyword [span("keyword")]
| identifier [span("identifier")]
| special [span("special")]
| string_ [span("string")]
| number [span("number")]
| u8_codepoint_p [unexpected_char]
)
;
macro =
// must not be followed by alpha or underscore
cl::eps_p(self.actions.state.macro
>> (cl::eps_p - (cl::alpha_p | '_')))
>> self.actions.state.macro
[do_macro]
;
escape =
cl::str_p("``") [pre_escape_back]
>>
(
(
(
(+(cl::anychar_p - "``") >> cl::eps_p("``"))
& g.phrase_start
)
>> cl::str_p("``")
)
|
(
cl::eps_p [error]
>> *cl::anychar_p
)
) [post_escape_back]
;
inline_callout
= "#<" >> *cl::space_p >>
(*(cl::anychar_p - cl::eol_p)) [mark_text]
;
line_callout
= cl::confix_p(
"#<<" >> *cl::space_p,
(*cl::anychar_p) [mark_text],
(cl::eol_p | cl::end_p)
)
;
comment
= cl::str_p("#") [span_start("comment")]
>> *( escape
| (+(cl::anychar_p - (cl::eol_p | "``")))
[plain_char]
)
>> cl::eps_p [span_end]
;
keyword
= keywords.python >> (cl::eps_p - (cl::alnum_p | '_'))
; // make sure we recognize whole words only
special
= +cl::chset_p("~!%^&*()+={[}]:;,<.>/|\\-")
;
string_prefix
= cl::as_lower_d[cl::str_p("u") >> ! cl::str_p("r")]
;
string_
= ! string_prefix >> (long_string | short_string)
;
string_char = ('\\' >> u8_codepoint_p) | (cl::anychar_p - '\\');
short_string
= cl::confix_p('\'', * string_char, '\'') |
cl::confix_p('"', * string_char, '"')
;
long_string
// Note: the "cl::str_p" on the next two lines work around
// an INTERNAL COMPILER ERROR when using VC7.1
= cl::confix_p(cl::str_p("'''"), * string_char, "'''") |
cl::confix_p(cl::str_p("\"\"\""), * string_char, "\"\"\"")
;
number
= (
cl::as_lower_d["0x"] >> cl::hex_p
| '0' >> cl::oct_p
| cl::real_p
)
>> *cl::as_lower_d[cl::chset_p("lj")]
;
identifier
= (cl::alpha_p | '_') >> *(cl::alnum_p | '_')
;
// clang-format on
}
cl::rule<Scanner> program, macro, inline_callout, line_callout,
comment, special, string_, string_prefix, short_string,
long_string, number, identifier, keyword, escape, string_char;
quickbook_grammar& g;
cl::rule<Scanner> const& start() const { return program; }
};
syntax_highlight_actions& actions;
};
// Grammar for plain text (no actual highlighting)
struct teletype_highlight : public cl::grammar<teletype_highlight>
{
teletype_highlight(syntax_highlight_actions& actions_)
: actions(actions_)
{
}
template <typename Scanner> struct definition
{
definition(teletype_highlight const& self)
: g(self.actions.state.grammar())
{
member_action<syntax_highlight_actions> plain_char(
self.actions, &syntax_highlight_actions::plain_char),
pre_escape_back(
self.actions,
&syntax_highlight_actions::pre_escape_back),
post_escape_back(
self.actions,
&syntax_highlight_actions::post_escape_back);
member_action_value<
syntax_highlight_actions, std::string const&>
do_macro(self.actions, &syntax_highlight_actions::do_macro);
error_action error(self.actions.state);
// clang-format off
program
=
*( macro
| escape
| u8_codepoint_p [plain_char]
)
;
macro =
// must not be followed by alpha or underscore
cl::eps_p(self.actions.state.macro
>> (cl::eps_p - (cl::alpha_p | '_')))
>> self.actions.state.macro
[do_macro]
;
escape =
cl::str_p("``") [pre_escape_back]
>>
(
(
(
(+(cl::anychar_p - "``") >> cl::eps_p("``"))
& g.phrase_start
)
>> cl::str_p("``")
)
|
(
cl::eps_p [error]
>> *cl::anychar_p
)
) [post_escape_back]
;
// clang-format on
}
cl::rule<Scanner> program, macro, escape;
quickbook_grammar& g;
cl::rule<Scanner> const& start() const { return program; }
};
syntax_highlight_actions& actions;
};
void syntax_highlight(
parse_iterator first,
parse_iterator last,
quickbook::state& state,
source_mode_type source_mode,
bool is_block)
{
syntax_highlight_actions syn_actions(state, is_block);
// print the code with syntax coloring
switch (source_mode) {
case source_mode_tags::cpp: {
cpp_highlight cpp_p(syn_actions);
boost::spirit::classic::parse(first, last, cpp_p);
break;
}
case source_mode_tags::python: {
python_highlight python_p(syn_actions);
boost::spirit::classic::parse(first, last, python_p);
break;
}
case source_mode_tags::teletype: {
teletype_highlight teletype_p(syn_actions);
boost::spirit::classic::parse(first, last, teletype_p);
break;
}
default:
BOOST_ASSERT(0);
}
}
}