-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathInvalidIteratorDereferenceRule.cpp
More file actions
281 lines (237 loc) · 8.28 KB
/
Copy pathInvalidIteratorDereferenceRule.cpp
File metadata and controls
281 lines (237 loc) · 8.28 KB
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
/**
*
* @file InvalidIteratorDereferenceRule.cpp
* @author Gaspard Kirira
*
* Copyright 2025, Gaspard Kirira. All rights reserved.
* https://github.com/vixcpp/vix
* Use of this source code is governed by a MIT license
* that can be found in the License file.
*
* Vix.cpp
*
*/
#include <vix/cli/errors/runtime/IRuntimeErrorRule.hpp>
#include <vix/cli/errors/runtime/RuntimeRuleUtils.hpp>
#include <filesystem>
#include <iostream>
#include <memory>
#include <string>
#include <vector>
#include <vix/cli/Style.hpp>
using namespace vix::cli::style;
namespace vix::cli::errors::runtime
{
namespace
{
enum class IteratorDereferenceKind
{
EndIterator,
SingularIterator,
PastTheEndIterator,
DefaultConstructedIterator,
NonDereferenceableIterator,
InvalidatedIterator,
NullIterator,
GenericInvalidDereference,
};
IteratorDereferenceKind classify_issue(const std::string &log)
{
if (icontains(log, "end iterator") ||
icontains(log, "dereference of end"))
{
return IteratorDereferenceKind::EndIterator;
}
if (icontains(log, "past-the-end") ||
icontains(log, "past the end"))
{
return IteratorDereferenceKind::PastTheEndIterator;
}
if (icontains(log, "singular iterator") ||
icontains(log, "singular"))
{
return IteratorDereferenceKind::SingularIterator;
}
if (icontains(log, "default-constructed") ||
icontains(log, "default constructed"))
{
return IteratorDereferenceKind::DefaultConstructedIterator;
}
if (icontains(log, "not dereferenceable") ||
icontains(log, "non-dereferenceable"))
{
return IteratorDereferenceKind::NonDereferenceableIterator;
}
if (icontains(log, "invalidated") ||
icontains(log, "invalid iterator"))
{
return IteratorDereferenceKind::InvalidatedIterator;
}
if (icontains(log, "null iterator") ||
icontains(log, "nullptr iterator"))
{
return IteratorDereferenceKind::NullIterator;
}
return IteratorDereferenceKind::GenericInvalidDereference;
}
std::string choose_title(const std::string &log)
{
switch (classify_issue(log))
{
case IteratorDereferenceKind::EndIterator:
return "runtime error: end iterator dereference";
case IteratorDereferenceKind::SingularIterator:
return "runtime error: singular iterator dereference";
case IteratorDereferenceKind::PastTheEndIterator:
return "runtime error: past-the-end iterator dereference";
case IteratorDereferenceKind::DefaultConstructedIterator:
return "runtime error: default-constructed iterator dereference";
case IteratorDereferenceKind::NonDereferenceableIterator:
return "runtime error: non-dereferenceable iterator";
case IteratorDereferenceKind::InvalidatedIterator:
return "runtime error: invalidated iterator dereference";
case IteratorDereferenceKind::NullIterator:
return "runtime error: null iterator dereference";
case IteratorDereferenceKind::GenericInvalidDereference:
default:
return "runtime error: invalid iterator dereference";
}
}
std::string choose_hint(const std::string &log)
{
switch (classify_issue(log))
{
case IteratorDereferenceKind::EndIterator:
return "compare the iterator with end() before using *it or it->member";
case IteratorDereferenceKind::SingularIterator:
return "initialize the iterator and refresh it after erase, insert, resize, reserve, or container reallocation";
case IteratorDereferenceKind::PastTheEndIterator:
return "do not dereference an iterator equal to end(); check it != container.end() first";
case IteratorDereferenceKind::DefaultConstructedIterator:
return "assign the iterator from a real container before dereferencing it";
case IteratorDereferenceKind::NonDereferenceableIterator:
return "only dereference iterators that currently point to a valid container element";
case IteratorDereferenceKind::InvalidatedIterator:
return "refresh iterators after operations that may invalidate them, such as erase, insert, push_back, resize, or reserve";
case IteratorDereferenceKind::NullIterator:
return "do not dereference a null or uninitialized iterator-like object";
case IteratorDereferenceKind::GenericInvalidDereference:
default:
return "check the iterator before dereferencing and avoid using invalidated iterators";
}
}
std::vector<std::string> source_patterns_for_iterator_dereference()
{
return {
"*it",
"it->",
"++it",
"it++",
"--it",
"it--",
"*iter",
"iter->",
"++iter",
"iter++",
"--iter",
"iter--",
"*iterator",
"iterator->",
"++iterator",
"iterator++",
"--iterator",
"iterator--",
".begin(",
".begin()",
".end(",
".end()",
".find(",
".erase(",
".insert(",
".push_back(",
".reserve(",
".resize(",
};
}
bool looks_like_invalid_iterator_dereference_log(const std::string &log)
{
const bool hasDereferenceSignal =
icontains(log, "cannot dereference") ||
icontains(log, "attempt to dereference") ||
icontains(log, "dereference of") ||
icontains(log, "not dereferenceable") ||
icontains(log, "non-dereferenceable");
const bool hasIteratorSignal =
icontains(log, "iterator") ||
icontains(log, "normal_iterator") ||
icontains(log, "safe_iterator") ||
icontains(log, "_Safe_iterator");
const bool hasSpecificIteratorBug =
icontains(log, "dereference of end iterator") ||
icontains(log, "dereference of singular iterator") ||
icontains(log, "attempt to dereference a singular iterator") ||
icontains(log, "past-the-end iterator") ||
icontains(log, "past the end iterator") ||
icontains(log, "invalid iterator") ||
icontains(log, "default-constructed iterator");
return hasSpecificIteratorBug ||
(hasDereferenceSignal && hasIteratorSignal) ||
(icontains(log, "iterator") && icontains(log, "not dereferenceable"));
}
} // namespace
class InvalidIteratorDereferenceRule final : public IRuntimeErrorRule
{
public:
bool match(
const std::string &log,
const std::filesystem::path &sourceFile) const override
{
(void)sourceFile;
return looks_like_invalid_iterator_dereference_log(log);
}
bool handle(
const std::string &log,
const std::filesystem::path &sourceFile) const override
{
RuntimeLocation location =
find_best_runtime_location(log, sourceFile);
if (!location.valid())
{
location =
find_best_runtime_location_or_source_hint(
log,
sourceFile,
source_patterns_for_iterator_dereference());
}
const std::string title = choose_title(log);
const std::string message =
title.rfind("runtime error: ", 0) == 0
? title.substr(std::string("runtime error: ").size())
: title;
std::cerr << RED
<< title
<< RESET << "\n";
if (location.valid())
{
const auto err = make_runtime_location(
location.file,
location.line,
location.column,
message);
print_runtime_codeframe(err);
}
print_runtime_hints_and_at(
{
choose_hint(log),
"do not ignore the runtime log: iterator diagnostics often explain whether the iterator is end, singular, or invalidated",
},
make_at_text(location, sourceFile));
print_runtime_log_excerpt(log, 20);
return true;
}
};
std::unique_ptr<IRuntimeErrorRule> makeInvalidIteratorDereferenceRule()
{
return std::make_unique<InvalidIteratorDereferenceRule>();
}
} // namespace vix::cli::errors::runtime