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
| //===- llvm/unittest/TableGen/CodeExpanderTest.cpp - Tests ----------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#include "GlobalISel/CodeExpander.h"
#include "GlobalISel/CodeExpansions.h"
#include "llvm/Support/raw_ostream.h"
#include "llvm/TableGen/Error.h"
#include "gtest/gtest.h"
using namespace llvm;
static StringRef bufferize(StringRef Str) {
std::unique_ptr<MemoryBuffer> Buffer =
MemoryBuffer::getMemBufferCopy(Str, "TestBuffer");
StringRef StrBufferRef = Buffer->getBuffer();
SrcMgr.AddNewSourceBuffer(std::move(Buffer), SMLoc());
return StrBufferRef;
}
class RAIIDiagnosticChecker {
std::string EmittedDiags;
raw_string_ostream OS;
std::vector<SMDiagnostic> Expected;
std::vector<SMDiagnostic> Received;
public:
RAIIDiagnosticChecker() : OS(EmittedDiags) {
SrcMgr.setDiagHandler(handler, this);
}
~RAIIDiagnosticChecker() {
SrcMgr.setDiagHandler(nullptr);
EXPECT_EQ(Received.size(), Expected.size());
for (unsigned i = 0; i < Received.size() && i < Expected.size(); ++i) {
EXPECT_EQ(Received[i].getLoc(), Expected[i].getLoc());
EXPECT_EQ(Received[i].getFilename(), Expected[i].getFilename());
EXPECT_EQ(Received[i].getKind(), Expected[i].getKind());
EXPECT_EQ(Received[i].getLineNo(), Expected[i].getLineNo());
EXPECT_EQ(Received[i].getColumnNo(), Expected[i].getColumnNo());
EXPECT_EQ(Received[i].getMessage(), Expected[i].getMessage());
EXPECT_EQ(Received[i].getLineContents(), Expected[i].getLineContents());
EXPECT_EQ(Received[i].getRanges(), Expected[i].getRanges());
}
if (testing::Test::HasFailure())
errs() << "Emitted diagnostic:\n" << OS.str();
}
void expect(SMDiagnostic D) { Expected.push_back(D); }
void diag(const SMDiagnostic &D) {
Received.push_back(D);
}
static void handler(const SMDiagnostic &D, void *Context) {
RAIIDiagnosticChecker *Self = static_cast<RAIIDiagnosticChecker *>(Context);
Self->diag(D);
SrcMgr.setDiagHandler(nullptr);
SrcMgr.PrintMessage(Self->OS, D);
SrcMgr.setDiagHandler(handler, Context);
};
};
TEST(CodeExpander, NoExpansions) {
std::string Result;
raw_string_ostream OS(Result);
CodeExpansions Expansions;
RAIIDiagnosticChecker DiagChecker;
CodeExpander("No expansions", Expansions, SMLoc(), false).emit(OS);
EXPECT_EQ(OS.str(), "No expansions");
}
// Indentation is applied to all lines except the first
TEST(CodeExpander, Indentation) {
std::string Result;
raw_string_ostream OS(Result);
CodeExpansions Expansions;
RAIIDiagnosticChecker DiagChecker;
CodeExpander("No expansions\nsecond line\nthird line", Expansions, SMLoc(),
false, " ")
.emit(OS);
EXPECT_EQ(OS.str(), "No expansions\n second line\n third line");
}
// \ is an escape character that removes special meanings from the next
// character.
TEST(CodeExpander, Escape) {
std::string Result;
raw_string_ostream OS(Result);
CodeExpansions Expansions;
RAIIDiagnosticChecker DiagChecker;
CodeExpander("\\\\\\a\\$", Expansions, SMLoc(), false).emit(OS);
EXPECT_EQ(OS.str(), "\\a$");
}
// $foo is not an expansion. It should warn though.
TEST(CodeExpander, NotAnExpansion) {
std::string Result;
raw_string_ostream OS(Result);
CodeExpansions Expansions;
RAIIDiagnosticChecker DiagChecker;
StringRef In = bufferize(" $foo");
CodeExpander(" $foo", Expansions, SMLoc::getFromPointer(In.data()), false)
.emit(OS);
EXPECT_EQ(OS.str(), " $foo");
DiagChecker.expect(SMDiagnostic(
SrcMgr, SMLoc::getFromPointer(In.data() + 1), "TestBuffer", 1, 1,
SourceMgr::DK_Warning, "Assuming missing escape character", " $foo", {}));
}
// \$foo is not an expansion but shouldn't warn as it's using the escape.
TEST(CodeExpander, EscapedNotAnExpansion) {
std::string Result;
raw_string_ostream OS(Result);
CodeExpansions Expansions;
RAIIDiagnosticChecker DiagChecker;
CodeExpander("\\$foo", Expansions, SMLoc(), false).emit(OS);
EXPECT_EQ(OS.str(), "$foo");
}
// \${foo is not an expansion but shouldn't warn as it's using the escape.
TEST(CodeExpander, EscapedUnterminatedExpansion) {
std::string Result;
raw_string_ostream OS(Result);
CodeExpansions Expansions;
RAIIDiagnosticChecker DiagChecker;
CodeExpander("\\${foo", Expansions, SMLoc(), false).emit(OS);
EXPECT_EQ(OS.str(), "${foo");
}
// \${foo is not an expansion but shouldn't warn as it's using the escape.
TEST(CodeExpander, EscapedExpansion) {
std::string Result;
raw_string_ostream OS(Result);
CodeExpansions Expansions;
RAIIDiagnosticChecker DiagChecker;
CodeExpander("\\${foo}", Expansions, SMLoc(), false).emit(OS);
EXPECT_EQ(OS.str(), "${foo}");
}
// ${foo} is an undefined expansion and should error.
TEST(CodeExpander, UndefinedExpansion) {
std::string Result;
raw_string_ostream OS(Result);
CodeExpansions Expansions;
Expansions.declare("bar", "expansion");
RAIIDiagnosticChecker DiagChecker;
CodeExpander("${foo}${bar}", Expansions, SMLoc(), false).emit(OS);
EXPECT_EQ(OS.str(), "expansion");
DiagChecker.expect(
SMDiagnostic(SrcMgr, SMLoc(), "<unknown>", 0, -1, SourceMgr::DK_Error,
"Attempting to expand an undeclared variable foo", "", {}));
}
// ${foo} is an undefined expansion and should error. When given a valid
// location for the start of the buffer it should correctly point at the
// expansion being performed.
TEST(CodeExpander, UndefinedExpansionWithLoc) {
std::string Result;
raw_string_ostream OS(Result);
CodeExpansions Expansions;
Expansions.declare("bar", "expansion");
RAIIDiagnosticChecker DiagChecker;
StringRef In = bufferize("Padding ${foo}${bar}");
CodeExpander(In, Expansions, SMLoc::getFromPointer(In.data()), false)
.emit(OS);
EXPECT_EQ(OS.str(), "Padding expansion");
DiagChecker.expect(SMDiagnostic(
SrcMgr, SMLoc::getFromPointer(In.data() + 8), "TestBuffer", 1, 8,
SourceMgr::DK_Error, "Attempting to expand an undeclared variable foo",
"Padding ${foo}${bar}", {}));
}
// ${bar is an unterminated expansion. Warn and implicitly terminate it.
TEST(CodeExpander, UnterminatedExpansion) {
std::string Result;
raw_string_ostream OS(Result);
CodeExpansions Expansions;
Expansions.declare("bar", "expansion");
RAIIDiagnosticChecker DiagChecker;
StringRef In = bufferize(" ${bar");
CodeExpander(In, Expansions, SMLoc::getFromPointer(In.data()), false)
.emit(OS);
EXPECT_EQ(OS.str(), " expansion");
DiagChecker.expect(SMDiagnostic(SrcMgr, SMLoc::getFromPointer(In.data() + 1),
"TestBuffer", 1, 1, SourceMgr::DK_Warning,
"Unterminated expansion", " ${bar", {}));
}
|