/
errors.d
909 lines (841 loc) · 26.4 KB
/
errors.d
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
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
/**
* Functions for raising errors.
*
* Copyright: Copyright (C) 1999-2024 by The D Language Foundation, All Rights Reserved
* Authors: $(LINK2 https://www.digitalmars.com, Walter Bright)
* License: $(LINK2 https://www.boost.org/LICENSE_1_0.txt, Boost License 1.0)
* Source: $(LINK2 https://github.com/dlang/dmd/blob/master/src/dmd/errors.d, _errors.d)
* Documentation: https://dlang.org/phobos/dmd_errors.html
* Coverage: https://codecov.io/gh/dlang/dmd/src/master/src/dmd/errors.d
*/
module dmd.errors;
public import core.stdc.stdarg;
import core.stdc.stdio;
import core.stdc.stdlib;
import core.stdc.string;
import dmd.errorsink;
import dmd.globals;
import dmd.location;
import dmd.common.outbuffer;
import dmd.root.rmem;
import dmd.root.string;
import dmd.console;
nothrow:
/// Constants used to discriminate kinds of error messages.
enum ErrorKind
{
warning,
deprecation,
error,
tip,
message,
}
/***************************
* Error message sink for D compiler.
*/
class ErrorSinkCompiler : ErrorSink
{
nothrow:
extern (C++):
override:
void error(const ref Loc loc, const(char)* format, ...)
{
va_list ap;
va_start(ap, format);
verrorReport(loc, format, ap, ErrorKind.error);
va_end(ap);
}
void errorSupplemental(const ref Loc loc, const(char)* format, ...)
{
va_list ap;
va_start(ap, format);
verrorReportSupplemental(loc, format, ap, ErrorKind.error);
va_end(ap);
}
void warning(const ref Loc loc, const(char)* format, ...)
{
va_list ap;
va_start(ap, format);
verrorReport(loc, format, ap, ErrorKind.warning);
va_end(ap);
}
void warningSupplemental(const ref Loc loc, const(char)* format, ...)
{
va_list ap;
va_start(ap, format);
verrorReportSupplemental(loc, format, ap, ErrorKind.warning);
va_end(ap);
}
void deprecation(const ref Loc loc, const(char)* format, ...)
{
va_list ap;
va_start(ap, format);
verrorReport(loc, format, ap, ErrorKind.deprecation);
va_end(ap);
}
void deprecationSupplemental(const ref Loc loc, const(char)* format, ...)
{
va_list ap;
va_start(ap, format);
verrorReportSupplemental(loc, format, ap, ErrorKind.deprecation);
va_end(ap);
}
void message(const ref Loc loc, const(char)* format, ...)
{
va_list ap;
va_start(ap, format);
verrorReport(loc, format, ap, ErrorKind.message);
va_end(ap);
}
}
/**
* Color highlighting to classify messages
*/
enum Classification : Color
{
error = Color.brightRed, /// for errors
gagged = Color.brightBlue, /// for gagged errors
warning = Color.brightYellow, /// for warnings
deprecation = Color.brightCyan, /// for deprecations
tip = Color.brightGreen, /// for tip messages
}
static if (__VERSION__ < 2092)
private extern (C++) void noop(const ref Loc loc, const(char)* format, ...) {}
else
pragma(printf) private extern (C++) void noop(const ref Loc loc, const(char)* format, ...) {}
package auto previewErrorFunc(bool isDeprecated, FeatureState featureState) @safe @nogc pure nothrow
{
with (FeatureState) final switch (featureState)
{
case enabled:
return &error;
case disabled:
return &noop;
case default_:
return isDeprecated ? &noop : &deprecation;
}
}
package auto previewSupplementalFunc(bool isDeprecated, FeatureState featureState) @safe @nogc pure nothrow
{
with (FeatureState) final switch (featureState)
{
case enabled:
return &errorSupplemental;
case disabled:
return &noop;
case default_:
return isDeprecated ? &noop : &deprecationSupplemental;
}
}
/**
* Print an error message, increasing the global error count.
* Params:
* loc = location of error
* format = printf-style format specification
* ... = printf-style variadic arguments
*/
static if (__VERSION__ < 2092)
extern (C++) void error(const ref Loc loc, const(char)* format, ...)
{
va_list ap;
va_start(ap, format);
verrorReport(loc, format, ap, ErrorKind.error);
va_end(ap);
}
else
pragma(printf) extern (C++) void error(const ref Loc loc, const(char)* format, ...)
{
va_list ap;
va_start(ap, format);
verrorReport(loc, format, ap, ErrorKind.error);
va_end(ap);
}
/**
* Same as above, but takes a filename and line information arguments as separate parameters.
* Params:
* filename = source file of error
* linnum = line in the source file
* charnum = column number on the line
* format = printf-style format specification
* ... = printf-style variadic arguments
*/
static if (__VERSION__ < 2092)
extern (C++) void error(const(char)* filename, uint linnum, uint charnum, const(char)* format, ...)
{
const loc = Loc(filename, linnum, charnum);
va_list ap;
va_start(ap, format);
verrorReport(loc, format, ap, ErrorKind.error);
va_end(ap);
}
else
pragma(printf) extern (C++) void error(const(char)* filename, uint linnum, uint charnum, const(char)* format, ...)
{
const loc = Loc(filename, linnum, charnum);
va_list ap;
va_start(ap, format);
verrorReport(loc, format, ap, ErrorKind.error);
va_end(ap);
}
/**
* Print additional details about an error message.
* Doesn't increase the error count or print an additional error prefix.
* Params:
* loc = location of error
* format = printf-style format specification
* ... = printf-style variadic arguments
*/
static if (__VERSION__ < 2092)
extern (C++) void errorSupplemental(const ref Loc loc, const(char)* format, ...)
{
va_list ap;
va_start(ap, format);
verrorReportSupplemental(loc, format, ap, ErrorKind.error);
va_end(ap);
}
else
pragma(printf) extern (C++) void errorSupplemental(const ref Loc loc, const(char)* format, ...)
{
va_list ap;
va_start(ap, format);
verrorReportSupplemental(loc, format, ap, ErrorKind.error);
va_end(ap);
}
/**
* Print a warning message, increasing the global warning count.
* Params:
* loc = location of warning
* format = printf-style format specification
* ... = printf-style variadic arguments
*/
static if (__VERSION__ < 2092)
extern (C++) void warning(const ref Loc loc, const(char)* format, ...)
{
va_list ap;
va_start(ap, format);
verrorReport(loc, format, ap, ErrorKind.warning);
va_end(ap);
}
else
pragma(printf) extern (C++) void warning(const ref Loc loc, const(char)* format, ...)
{
va_list ap;
va_start(ap, format);
verrorReport(loc, format, ap, ErrorKind.warning);
va_end(ap);
}
/**
* Print additional details about a warning message.
* Doesn't increase the warning count or print an additional warning prefix.
* Params:
* loc = location of warning
* format = printf-style format specification
* ... = printf-style variadic arguments
*/
static if (__VERSION__ < 2092)
extern (C++) void warningSupplemental(const ref Loc loc, const(char)* format, ...)
{
va_list ap;
va_start(ap, format);
verrorReportSupplemental(loc, format, ap, ErrorKind.warning);
va_end(ap);
}
else
pragma(printf) extern (C++) void warningSupplemental(const ref Loc loc, const(char)* format, ...)
{
va_list ap;
va_start(ap, format);
verrorReportSupplemental(loc, format, ap, ErrorKind.warning);
va_end(ap);
}
/**
* Print a deprecation message, may increase the global warning or error count
* depending on whether deprecations are ignored.
* Params:
* loc = location of deprecation
* format = printf-style format specification
* ... = printf-style variadic arguments
*/
static if (__VERSION__ < 2092)
extern (C++) void deprecation(const ref Loc loc, const(char)* format, ...)
{
va_list ap;
va_start(ap, format);
verrorReport(loc, format, ap, ErrorKind.deprecation);
va_end(ap);
}
else
pragma(printf) extern (C++) void deprecation(const ref Loc loc, const(char)* format, ...)
{
va_list ap;
va_start(ap, format);
verrorReport(loc, format, ap, ErrorKind.deprecation);
va_end(ap);
}
/**
* Print additional details about a deprecation message.
* Doesn't increase the error count, or print an additional deprecation prefix.
* Params:
* loc = location of deprecation
* format = printf-style format specification
* ... = printf-style variadic arguments
*/
static if (__VERSION__ < 2092)
extern (C++) void deprecationSupplemental(const ref Loc loc, const(char)* format, ...)
{
va_list ap;
va_start(ap, format);
verrorReportSupplemental(loc, format, ap, ErrorKind.deprecation);
va_end(ap);
}
else
pragma(printf) extern (C++) void deprecationSupplemental(const ref Loc loc, const(char)* format, ...)
{
va_list ap;
va_start(ap, format);
verrorReportSupplemental(loc, format, ap, ErrorKind.deprecation);
va_end(ap);
}
/**
* Print a verbose message.
* Doesn't prefix or highlight messages.
* Params:
* loc = location of message
* format = printf-style format specification
* ... = printf-style variadic arguments
*/
static if (__VERSION__ < 2092)
extern (C++) void message(const ref Loc loc, const(char)* format, ...)
{
va_list ap;
va_start(ap, format);
verrorReport(loc, format, ap, ErrorKind.message);
va_end(ap);
}
else
pragma(printf) extern (C++) void message(const ref Loc loc, const(char)* format, ...)
{
va_list ap;
va_start(ap, format);
verrorReport(loc, format, ap, ErrorKind.message);
va_end(ap);
}
/**
* Same as above, but doesn't take a location argument.
* Params:
* format = printf-style format specification
* ... = printf-style variadic arguments
*/
static if (__VERSION__ < 2092)
extern (C++) void message(const(char)* format, ...)
{
va_list ap;
va_start(ap, format);
verrorReport(Loc.initial, format, ap, ErrorKind.message);
va_end(ap);
}
else
pragma(printf) extern (C++) void message(const(char)* format, ...)
{
va_list ap;
va_start(ap, format);
verrorReport(Loc.initial, format, ap, ErrorKind.message);
va_end(ap);
}
/**
* The type of the diagnostic handler
* see verrorReport for arguments
* Returns: true if error handling is done, false to continue printing to stderr
*/
alias DiagnosticHandler = bool delegate(const ref Loc location, Color headerColor, const(char)* header, const(char)* messageFormat, va_list args, const(char)* prefix1, const(char)* prefix2);
/**
* The diagnostic handler.
* If non-null it will be called for every diagnostic message issued by the compiler.
* If it returns false, the message will be printed to stderr as usual.
*/
__gshared DiagnosticHandler diagnosticHandler;
/**
* Print a tip message with the prefix and highlighting.
* Params:
* format = printf-style format specification
* ... = printf-style variadic arguments
*/
static if (__VERSION__ < 2092)
extern (C++) void tip(const(char)* format, ...)
{
va_list ap;
va_start(ap, format);
verrorReport(Loc.initial, format, ap, ErrorKind.tip);
va_end(ap);
}
else
pragma(printf) extern (C++) void tip(const(char)* format, ...)
{
va_list ap;
va_start(ap, format);
verrorReport(Loc.initial, format, ap, ErrorKind.tip);
va_end(ap);
}
// Encapsulates an error as described by its location, format message, and kind.
private struct ErrorInfo
{
this(const ref Loc loc, const ErrorKind kind, const(char)* p1 = null, const(char)* p2 = null) @safe @nogc pure nothrow
{
this.loc = loc;
this.p1 = p1;
this.p2 = p2;
this.kind = kind;
}
const Loc loc; // location of error
Classification headerColor; // color to set `header` output to
const(char)* p1; // additional message prefix
const(char)* p2; // additional message prefix
const ErrorKind kind; // kind of error being printed
bool supplemental; // true if supplemental error
}
/**
* Implements $(D error), $(D warning), $(D deprecation), $(D message), and
* $(D tip). Report a diagnostic error, taking a va_list parameter, and
* optionally additional message prefixes. Whether the message gets printed
* depends on runtime values of DiagnosticReporting and global gagging.
* Params:
* loc = location of error
* format = printf-style format specification
* ap = printf-style variadic arguments
* kind = kind of error being printed
* p1 = additional message prefix
* p2 = additional message prefix
*/
extern (C++) void verrorReport(const ref Loc loc, const(char)* format, va_list ap, ErrorKind kind, const(char)* p1 = null, const(char)* p2 = null)
{
auto info = ErrorInfo(loc, kind, p1, p2);
final switch (info.kind)
{
case ErrorKind.error:
global.errors++;
if (!global.gag)
{
info.headerColor = Classification.error;
verrorPrint(format, ap, info);
if (global.params.v.errorLimit && global.errors >= global.params.v.errorLimit)
fatal(); // moderate blizzard of cascading messages
}
else
{
if (global.params.v.showGaggedErrors)
{
info.headerColor = Classification.gagged;
verrorPrint(format, ap, info);
}
global.gaggedErrors++;
}
break;
case ErrorKind.deprecation:
if (global.params.useDeprecated == DiagnosticReporting.error)
goto case ErrorKind.error;
else if (global.params.useDeprecated == DiagnosticReporting.inform)
{
if (!global.gag)
{
info.headerColor = Classification.deprecation;
verrorPrint(format, ap, info);
}
else
{
global.gaggedWarnings++;
}
}
break;
case ErrorKind.warning:
if (global.params.warnings != DiagnosticReporting.off)
{
if (!global.gag)
{
info.headerColor = Classification.warning;
verrorPrint(format, ap, info);
if (global.params.warnings == DiagnosticReporting.error)
global.warnings++;
}
else
{
global.gaggedWarnings++;
}
}
break;
case ErrorKind.tip:
if (!global.gag)
{
info.headerColor = Classification.tip;
verrorPrint(format, ap, info);
}
break;
case ErrorKind.message:
const p = info.loc.toChars();
if (*p)
{
fprintf(stdout, "%s: ", p);
mem.xfree(cast(void*)p);
}
OutBuffer tmp;
tmp.vprintf(format, ap);
fputs(tmp.peekChars(), stdout);
fputc('\n', stdout);
fflush(stdout); // ensure it gets written out in case of compiler aborts
break;
}
}
/**
* Implements $(D errorSupplemental), $(D warningSupplemental), and
* $(D deprecationSupplemental). Report an addition diagnostic error, taking a
* va_list parameter. Whether the message gets printed depends on runtime
* values of DiagnosticReporting and global gagging.
* Params:
* loc = location of error
* format = printf-style format specification
* ap = printf-style variadic arguments
* kind = kind of error being printed
*/
extern (C++) void verrorReportSupplemental(const ref Loc loc, const(char)* format, va_list ap, ErrorKind kind)
{
auto info = ErrorInfo(loc, kind);
info.supplemental = true;
switch (info.kind)
{
case ErrorKind.error:
if (global.gag)
{
if (!global.params.v.showGaggedErrors)
return;
info.headerColor = Classification.gagged;
}
else
info.headerColor = Classification.error;
verrorPrint(format, ap, info);
break;
case ErrorKind.deprecation:
if (global.params.useDeprecated == DiagnosticReporting.error)
goto case ErrorKind.error;
else if (global.params.useDeprecated == DiagnosticReporting.inform && !global.gag)
{
info.headerColor = Classification.deprecation;
verrorPrint(format, ap, info);
}
break;
case ErrorKind.warning:
if (global.params.warnings != DiagnosticReporting.off && !global.gag)
{
info.headerColor = Classification.warning;
verrorPrint(format, ap, info);
}
break;
default:
assert(false, "internal error: unhandled kind in error report");
}
}
/**
* Just print to stderr, doesn't care about gagging.
* (format,ap) text within backticks gets syntax highlighted.
* Params:
* format = printf-style format specification
* ap = printf-style variadic arguments
* info = context of error
*/
private void verrorPrint(const(char)* format, va_list ap, ref ErrorInfo info)
{
const(char)* header; // title of error message
if (info.supplemental)
header = " ";
else
{
final switch (info.kind)
{
case ErrorKind.error: header = "Error: "; break;
case ErrorKind.deprecation: header = "Deprecation: "; break;
case ErrorKind.warning: header = "Warning: "; break;
case ErrorKind.tip: header = " Tip: "; break;
case ErrorKind.message: assert(0);
}
}
if (diagnosticHandler !is null &&
diagnosticHandler(info.loc, info.headerColor, header, format, ap, info.p1, info.p2))
return;
if (global.params.v.showGaggedErrors && global.gag)
fprintf(stderr, "(spec:%d) ", global.gag);
Console con = cast(Console) global.console;
const p = info.loc.toChars();
if (con)
con.setColorBright(true);
if (*p)
{
fprintf(stderr, "%s: ", p);
mem.xfree(cast(void*)p);
}
if (con)
con.setColor(info.headerColor);
fputs(header, stderr);
if (con)
con.resetColor();
OutBuffer tmp;
if (info.p1)
{
tmp.writestring(info.p1);
tmp.writestring(" ");
}
if (info.p2)
{
tmp.writestring(info.p2);
tmp.writestring(" ");
}
tmp.vprintf(format, ap);
if (con && strchr(tmp.peekChars(), '`'))
{
colorSyntaxHighlight(tmp);
writeHighlights(con, tmp);
}
else
fputs(tmp.peekChars(), stderr);
fputc('\n', stderr);
__gshared Loc old_loc;
Loc loc = info.loc;
if (global.params.v.printErrorContext &&
// ignore supplemental messages with same loc
(loc != old_loc || !info.supplemental) &&
// ignore invalid files
loc != Loc.initial &&
// ignore mixins for now
!loc.filename.strstr(".d-mixin-") &&
!global.params.mixinOut.doOutput)
{
import dmd.root.filename : FileName;
const fileName = FileName(loc.filename.toDString);
if (auto text = global.fileManager.lookup(fileName))
{
auto range = global.fileManager.splitLines(cast(const(char[])) text);
size_t linnum;
foreach (line; range)
{
++linnum;
if (linnum != loc.linnum)
continue;
if (loc.charnum < line.length)
{
fprintf(stderr, "%.*s\n", cast(int)line.length, line.ptr);
// The number of column bytes and the number of display columns
// occupied by a character are not the same for non-ASCII charaters.
// https://issues.dlang.org/show_bug.cgi?id=21849
size_t col = 0;
while (col < loc.charnum - 1)
{
import dmd.root.utf : utf_decodeChar;
dchar u;
const msg = utf_decodeChar(line, col, u);
assert(msg is null, msg);
fputc(' ', stderr);
}
fputc('^', stderr);
fputc('\n', stderr);
}
break;
}
}
}
old_loc = loc;
fflush(stderr); // ensure it gets written out in case of compiler aborts
}
/**
* The type of the fatal error handler
* Returns: true if error handling is done, false to do exit(EXIT_FAILURE)
*/
alias FatalErrorHandler = bool delegate();
/**
* The fatal error handler.
* If non-null it will be called for every fatal() call issued by the compiler.
*/
__gshared FatalErrorHandler fatalErrorHandler;
/**
* Call this after printing out fatal error messages to clean up and exit the
* compiler. You can also set a fatalErrorHandler to override this behaviour.
*/
extern (C++) void fatal()
{
if (fatalErrorHandler && fatalErrorHandler())
return;
exit(EXIT_FAILURE);
}
/**
* Try to stop forgetting to remove the breakpoints from
* release builds.
*/
extern (C++) void halt() @safe
{
assert(0);
}
/**
* Scan characters in `buf`. Assume text enclosed by `...`
* is D source code, and color syntax highlight it.
* Modify contents of `buf` with highlighted result.
* Many parallels to ddoc.highlightText().
* Params:
* buf = text containing `...` code to highlight
*/
private void colorSyntaxHighlight(ref OutBuffer buf)
{
//printf("colorSyntaxHighlight('%.*s')\n", cast(int)buf.length, buf[].ptr);
bool inBacktick = false;
size_t iCodeStart = 0;
size_t offset = 0;
for (size_t i = offset; i < buf.length; ++i)
{
char c = buf[i];
switch (c)
{
case '`':
if (inBacktick)
{
inBacktick = false;
OutBuffer codebuf;
codebuf.write(buf[iCodeStart .. i]);
codebuf.writeByte(0);
// escape the contents, but do not perform highlighting except for DDOC_PSYMBOL
colorHighlightCode(codebuf);
buf.remove(iCodeStart, i - iCodeStart);
immutable pre = "";
i = buf.insert(iCodeStart, pre);
i = buf.insert(i, codebuf[]);
break;
}
inBacktick = true;
iCodeStart = i + 1;
break;
default:
break;
}
}
}
/**
* Embed these highlighting commands in the text stream.
* HIGHLIGHT.Escape indicates a Color follows.
*/
enum HIGHLIGHT : ubyte
{
Default = Color.black, // back to whatever the console is set at
Escape = '\xFF', // highlight Color follows
Identifier = Color.white,
Keyword = Color.white,
Literal = Color.white,
Comment = Color.darkGray,
Other = Color.cyan, // other tokens
}
/**
* Highlight code for CODE section.
* Rewrite the contents of `buf` with embedded highlights.
* Analogous to doc.highlightCode2()
*/
private void colorHighlightCode(ref OutBuffer buf)
{
import dmd.lexer;
import dmd.tokens;
__gshared int nested;
if (nested)
{
// Should never happen, but don't infinitely recurse if it does
--nested;
return;
}
++nested;
scope Lexer lex = new Lexer(null, cast(char*)buf[].ptr, 0, buf.length - 1, 0, 1, global.errorSinkNull, &global.compileEnv);
OutBuffer res;
const(char)* lastp = cast(char*)buf[].ptr;
//printf("colorHighlightCode('%.*s')\n", cast(int)(buf.length - 1), buf[].ptr);
res.reserve(buf.length);
res.writeByte(HIGHLIGHT.Escape);
res.writeByte(HIGHLIGHT.Other);
while (1)
{
Token tok;
lex.scan(&tok);
res.writestring(lastp[0 .. tok.ptr - lastp]);
HIGHLIGHT highlight;
switch (tok.value)
{
case TOK.identifier:
highlight = HIGHLIGHT.Identifier;
break;
case TOK.comment:
highlight = HIGHLIGHT.Comment;
break;
case TOK.int32Literal:
..
case TOK.dcharLiteral:
case TOK.string_:
highlight = HIGHLIGHT.Literal;
break;
default:
if (tok.isKeyword())
highlight = HIGHLIGHT.Keyword;
break;
}
if (highlight != HIGHLIGHT.Default)
{
res.writeByte(HIGHLIGHT.Escape);
res.writeByte(highlight);
res.writestring(tok.ptr[0 .. lex.p - tok.ptr]);
res.writeByte(HIGHLIGHT.Escape);
res.writeByte(HIGHLIGHT.Other);
}
else
res.writestring(tok.ptr[0 .. lex.p - tok.ptr]);
if (tok.value == TOK.endOfFile)
break;
lastp = lex.p;
}
res.writeByte(HIGHLIGHT.Escape);
res.writeByte(HIGHLIGHT.Default);
//printf("res = '%.*s'\n", cast(int)buf.length, buf[].ptr);
buf.setsize(0);
buf.write(&res);
--nested;
}
/**
* Write the buffer contents with embedded highlights to stderr.
* Params:
* buf = highlighted text
*/
private void writeHighlights(Console con, ref const OutBuffer buf)
{
bool colors;
scope (exit)
{
/* Do not mess up console if highlighting aborts
*/
if (colors)
con.resetColor();
}
for (size_t i = 0; i < buf.length; ++i)
{
const c = buf[i];
if (c == HIGHLIGHT.Escape)
{
const color = buf[++i];
if (color == HIGHLIGHT.Default)
{
con.resetColor();
colors = false;
}
else
if (color == Color.white)
{
con.resetColor();
con.setColorBright(true);
colors = true;
}
else
{
con.setColor(cast(Color)color);
colors = true;
}
}
else
fputc(c, con.fp);
}
}