-
-
Notifications
You must be signed in to change notification settings - Fork 594
/
errors.d
593 lines (559 loc) · 16.7 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
/**
* Compiler implementation of the
* $(LINK2 http://www.dlang.org, D programming language).
*
* Copyright: Copyright (C) 1999-2018 by The D Language Foundation, All Rights Reserved
* Authors: $(LINK2 http://www.digitalmars.com, Walter Bright)
* License: $(LINK2 http://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;
import core.stdc.stdarg;
import core.stdc.stdio;
import core.stdc.stdlib;
import core.stdc.string;
import dmd.globals;
import dmd.root.outbuffer;
import dmd.root.rmem;
import dmd.console;
/**
* Color highlighting to classify messages
*/
enum Classification
{
error = Color.brightRed, /// for errors
gagged = Color.brightBlue, /// for gagged errors
warning = Color.brightYellow, /// for warnings
deprecation = Color.brightCyan, /// for deprecations
}
/**
* Print an error message, increasing the global error count.
* Params:
* loc = location of error
* format = printf-style format specification
* ... = printf-style variadic arguments
*/
extern (C++) void error(const ref Loc loc, const(char)* format, ...)
{
va_list ap;
va_start(ap, format);
verror(loc, format, ap);
va_end(ap);
}
/**
* Same as above, but allows Loc() literals to be passed.
* Params:
* loc = location of error
* format = printf-style format specification
* ... = printf-style variadic arguments
*/
extern (D) void error(Loc loc, const(char)* format, ...)
{
va_list ap;
va_start(ap, format);
verror(loc, format, ap);
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
*/
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);
verror(loc, format, ap);
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
*/
extern (C++) void errorSupplemental(const ref Loc loc, const(char)* format, ...)
{
va_list ap;
va_start(ap, format);
verrorSupplemental(loc, format, ap);
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
*/
extern (C++) void warning(const ref Loc loc, const(char)* format, ...)
{
va_list ap;
va_start(ap, format);
vwarning(loc, format, ap);
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
*/
extern (C++) void warningSupplemental(const ref Loc loc, const(char)* format, ...)
{
va_list ap;
va_start(ap, format);
vwarningSupplemental(loc, format, ap);
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
*/
extern (C++) void deprecation(const ref Loc loc, const(char)* format, ...)
{
va_list ap;
va_start(ap, format);
vdeprecation(loc, format, ap);
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
*/
extern (C++) void deprecationSupplemental(const ref Loc loc, const(char)* format, ...)
{
va_list ap;
va_start(ap, format);
vdeprecationSupplemental(loc, format, ap);
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
*/
extern (C++) void message(const ref Loc loc, const(char)* format, ...)
{
va_list ap;
va_start(ap, format);
vmessage(loc, format, ap);
va_end(ap);
}
/**
* Same as above, but doesn't take a location argument.
* Params:
* format = printf-style format specification
* ... = printf-style variadic arguments
*/
extern (C++) void message(const(char)* format, ...)
{
va_list ap;
va_start(ap, format);
vmessage(Loc.initial, format, ap);
va_end(ap);
}
/**
* Just print to stderr, doesn't care about gagging.
* (format,ap) text within backticks gets syntax highlighted.
* Params:
* loc = location of error
* headerColor = color to set `header` output to
* header = title of error message
* format = printf-style format specification
* ap = printf-style variadic arguments
* p1 = additional message prefix
* p2 = additional message prefix
*/
private void verrorPrint(const ref Loc loc, Color headerColor, const(char)* header,
const(char)* format, va_list ap, const(char)* p1 = null, const(char)* p2 = null)
{
Console* con = cast(Console*)global.console;
const p = loc.toChars();
if (con)
con.setColorBright(true);
if (*p)
{
fprintf(stderr, "%s: ", p);
mem.xfree(cast(void*)p);
}
if (con)
con.setColor(headerColor);
fputs(header, stderr);
if (con)
con.resetColor();
if (p1)
fprintf(stderr, "%s ", p1);
if (p2)
fprintf(stderr, "%s ", p2);
OutBuffer tmp;
tmp.vprintf(format, ap);
if (con && strchr(tmp.peekString(), '`'))
{
colorSyntaxHighlight(&tmp);
writeHighlights(con, &tmp);
}
else
fputs(tmp.peekString(), stderr);
fputc('\n', stderr);
fflush(stderr); // ensure it gets written out in case of compiler aborts
}
/**
* Same as $(D error), but takes a va_list parameter, and optionally additional message prefixes.
* Params:
* loc = location of error
* format = printf-style format specification
* ap = printf-style variadic arguments
* p1 = additional message prefix
* p2 = additional message prefix
* header = title of error message
*/
extern (C++) void verror(const ref Loc loc, const(char)* format, va_list ap, const(char)* p1 = null, const(char)* p2 = null, const(char)* header = "Error: ")
{
global.errors++;
if (!global.gag)
{
verrorPrint(loc, Classification.error, header, format, ap, p1, p2);
if (global.params.errorLimit && global.errors >= global.params.errorLimit)
fatal(); // moderate blizzard of cascading messages
}
else
{
if (global.params.showGaggedErrors)
{
fprintf(stderr, "(spec:%d) ", global.gag);
verrorPrint(loc, Classification.gagged, header, format, ap, p1, p2);
}
global.gaggedErrors++;
}
}
/**
* Same as $(D errorSupplemental), but takes a va_list parameter.
* Params:
* loc = location of error
* format = printf-style format specification
* ap = printf-style variadic arguments
*/
extern (C++) void verrorSupplemental(const ref Loc loc, const(char)* format, va_list ap)
{
Color color;
if (global.gag)
{
if (!global.params.showGaggedErrors)
return;
color = Classification.gagged;
}
else
color = Classification.error;
verrorPrint(loc, color, " ", format, ap);
}
/**
* Same as $(D warning), but takes a va_list parameter.
* Params:
* loc = location of warning
* format = printf-style format specification
* ap = printf-style variadic arguments
*/
extern (C++) void vwarning(const ref Loc loc, const(char)* format, va_list ap)
{
if (global.params.warnings)
{
if (!global.gag)
{
verrorPrint(loc, Classification.warning, "Warning: ", format, ap);
if (global.params.warnings == 1)
global.warnings++;
}
else
{
global.gaggedWarnings++;
}
}
}
/**
* Same as $(D warningSupplemental), but takes a va_list parameter.
* Params:
* loc = location of warning
* format = printf-style format specification
* ap = printf-style variadic arguments
*/
extern (C++) void vwarningSupplemental(const ref Loc loc, const(char)* format, va_list ap)
{
if (global.params.warnings && !global.gag)
verrorPrint(loc, Classification.warning, " ", format, ap);
}
/**
* Same as $(D deprecation), but takes a va_list parameter, and optionally additional message prefixes.
* Params:
* loc = location of deprecation
* format = printf-style format specification
* ap = printf-style variadic arguments
* p1 = additional message prefix
* p2 = additional message prefix
*/
extern (C++) void vdeprecation(const ref Loc loc, const(char)* format, va_list ap, const(char)* p1 = null, const(char)* p2 = null)
{
__gshared const(char)* header = "Deprecation: ";
if (global.params.useDeprecated == 0)
verror(loc, format, ap, p1, p2, header);
else if (global.params.useDeprecated == 2)
{
if (!global.gag)
{
verrorPrint(loc, Classification.deprecation, header, format, ap, p1, p2);
}
else
{
global.gaggedWarnings++;
}
}
}
/**
* Same as $(D message), but takes a va_list parameter.
* Params:
* loc = location of message
* format = printf-style format specification
* ap = printf-style variadic arguments
*/
extern (C++) void vmessage(const ref Loc loc, const(char)* format, va_list ap)
{
const p = loc.toChars();
if (*p)
{
fprintf(stdout, "%s: ", p);
mem.xfree(cast(void*)p);
}
OutBuffer tmp;
tmp.vprintf(format, ap);
fputs(tmp.peekString(), stdout);
fputc('\n', stdout);
fflush(stdout); // ensure it gets written out in case of compiler aborts
}
/**
* Same as $(D deprecationSupplemental), but takes a va_list parameter.
* Params:
* loc = location of deprecation
* format = printf-style format specification
* ap = printf-style variadic arguments
*/
extern (C++) void vdeprecationSupplemental(const ref Loc loc, const(char)* format, va_list ap)
{
if (global.params.useDeprecated == 0)
verrorSupplemental(loc, format, ap);
else if (global.params.useDeprecated == 2 && !global.gag)
verrorPrint(loc, Classification.deprecation, " ", format, ap);
}
/**
* Call this after printing out fatal error messages to clean up and exit
* the compiler.
*/
extern (C++) void fatal()
{
version (none)
{
halt();
}
exit(EXIT_FAILURE);
}
/**
* Try to stop forgetting to remove the breakpoints from
* release builds.
*/
extern (C++) void halt()
{
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(OutBuffer* buf)
{
//printf("colorSyntaxHighlight('%.*s')\n", buf.offset, buf.data);
bool inBacktick = false;
size_t iCodeStart = 0;
size_t offset = 0;
for (size_t i = offset; i < buf.offset; ++i)
{
char c = buf.data[i];
switch (c)
{
case '`':
if (inBacktick)
{
inBacktick = false;
OutBuffer codebuf;
codebuf.write(buf.peekSlice().ptr + iCodeStart + 1, i - (iCodeStart + 1));
codebuf.writeByte(0);
// escape the contents, but do not perform highlighting except for DDOC_PSYMBOL
colorHighlightCode(&codebuf);
buf.remove(iCodeStart, i - iCodeStart + 1); // also trimming off the current `
immutable pre = "";
i = buf.insert(iCodeStart, pre);
i = buf.insert(i, codebuf.peekSlice());
i--; // point to the ending ) so when the for loop does i++, it will see the next character
break;
}
inBacktick = true;
iCodeStart = i;
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(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;
auto gaggedErrorsSave = global.startGagging();
scope Lexer lex = new Lexer(null, cast(char*)buf.data, 0, buf.offset - 1, 0, 1);
OutBuffer res;
const(char)* lastp = cast(char*)buf.data;
//printf("colorHighlightCode('%.*s')\n", buf.offset - 1, buf.data);
res.reserve(buf.offset);
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", buf.offset, buf.data);
buf.setsize(0);
buf.write(&res);
global.endGagging(gaggedErrorsSave);
--nested;
}
/**
* Write the buffer contents with embedded highlights to stderr.
* Params:
* buf = highlighted text
*/
private void writeHighlights(Console* con, 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.offset; ++i)
{
const c = buf.data[i];
if (c == HIGHLIGHT.Escape)
{
const color = buf.data[++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);
}
}