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
|
/**
* Encapsulates file/line/column locations.
*
* 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/location.d, _location.d)
* Documentation: https://dlang.org/phobos/dmd_location.html
* Coverage: https://codecov.io/gh/dlang/dmd/src/master/src/dmd/location.d
*/
module dmd.location;
import core.stdc.stdio;
import dmd.common.outbuffer;
import dmd.root.array;
import dmd.root.filename;
version (DMDLIB)
{
version = LocOffset;
}
/// How code locations are formatted for diagnostic reporting
enum MessageStyle : ubyte
{
digitalmars, /// filename.d(line): message
gnu, /// filename.d:line: message, see https://www.gnu.org/prep/standards/html_node/Errors.html
}
/**
A source code location
Used for error messages, `__FILE__` and `__LINE__` tokens, `__traits(getLocation, XXX)`,
debug info etc.
*/
struct Loc
{
private uint _linnum;
private uint _charnum;
private uint fileIndex; // index into filenames[], starting from 1 (0 means no filename)
version (LocOffset)
uint fileOffset; /// utf8 code unit index relative to start of file, starting from 0
static immutable Loc initial; /// use for default initialization of const ref Loc's
extern (C++) __gshared bool showColumns;
extern (C++) __gshared MessageStyle messageStyle;
__gshared Array!(const(char)*) filenames;
nothrow:
/*******************************
* Configure how display is done
* Params:
* showColumns = when to display columns
* messageStyle = digitalmars or gnu style messages
*/
extern (C++) static void set(bool showColumns, MessageStyle messageStyle)
{
this.showColumns = showColumns;
this.messageStyle = messageStyle;
}
extern (C++) this(const(char)* filename, uint linnum, uint charnum) @safe
{
this._linnum = linnum;
this._charnum = charnum;
this.filename = filename;
}
/// utf8 code unit index relative to start of line, starting from 1
extern (C++) uint charnum() const @nogc @safe
{
return _charnum;
}
/// ditto
extern (C++) uint charnum(uint num) @nogc @safe
{
return _charnum = num;
}
/// line number, starting from 1
extern (C++) uint linnum() const @nogc @safe
{
return _linnum;
}
/// ditto
extern (C++) uint linnum(uint num) @nogc @safe
{
return _linnum = num;
}
/***
* Returns: filename for this location, null if none
*/
extern (C++) const(char)* filename() const @nogc
{
return fileIndex ? filenames[fileIndex - 1] : null;
}
/***
* Set file name for this location
* Params:
* name = file name for location, null for no file name
*/
extern (C++) void filename(const(char)* name) @trusted
{
if (name)
{
//printf("setting %s\n", name);
filenames.push(name);
fileIndex = cast(uint)filenames.length;
if (!fileIndex)
{
import dmd.globals : global;
import dmd.errors : error, fatal;
global.gag = 0; // ensure error message gets printed
error(Loc.initial, "internal compiler error: file name index overflow!");
fatal();
}
}
else
fileIndex = 0;
}
extern (C++) const(char)* toChars(
bool showColumns = Loc.showColumns,
MessageStyle messageStyle = Loc.messageStyle) const nothrow
{
OutBuffer buf;
if (fileIndex)
{
buf.writestring(filename);
}
if (linnum)
{
final switch (messageStyle)
{
case MessageStyle.digitalmars:
buf.writeByte('(');
buf.print(linnum);
if (showColumns && charnum)
{
buf.writeByte(',');
buf.print(charnum);
}
buf.writeByte(')');
break;
case MessageStyle.gnu: // https://www.gnu.org/prep/standards/html_node/Errors.html
buf.writeByte(':');
buf.print(linnum);
if (showColumns && charnum)
{
buf.writeByte(':');
buf.print(charnum);
}
break;
}
}
return buf.extractChars();
}
/**
* Checks for equivalence by comparing the filename contents (not the pointer) and character location.
*
* Note:
* - Uses case-insensitive comparison on Windows
* - Ignores `charnum` if `Columns` is false.
*/
extern (C++) bool equals(ref const(Loc) loc) const
{
return (!showColumns || charnum == loc.charnum) &&
linnum == loc.linnum &&
FileName.equals(filename, loc.filename);
}
/**
* `opEquals()` / `toHash()` for AA key usage
*
* Compare filename contents (case-sensitively on Windows too), not
* the pointer - a static foreach loop repeatedly mixing in a mixin
* may lead to multiple equivalent filenames (`foo.d-mixin-<line>`),
* e.g., for test/runnable/test18880.d.
*/
extern (D) bool opEquals(ref const(Loc) loc) const @trusted nothrow @nogc
{
import core.stdc.string : strcmp;
return charnum == loc.charnum &&
linnum == loc.linnum &&
(filename == loc.filename ||
(filename && loc.filename && strcmp(filename, loc.filename) == 0));
}
/// ditto
extern (D) size_t toHash() const @trusted nothrow
{
import dmd.root.string : toDString;
auto hash = hashOf(linnum);
hash = hashOf(charnum, hash);
hash = hashOf(filename.toDString, hash);
return hash;
}
/******************
* Returns:
* true if Loc has been set to other than the default initialization
*/
bool isValid() const pure @safe
{
return fileIndex != 0;
}
}
|
