blob: 4f4f94bf3755f6a1de43e88dbc1e6bdf63492d2a [file] [log] [blame]
Peter Collingbournebee583f2011-10-06 13:03:08 +00001//===- ClangAttrEmitter.cpp - Generate Clang attribute handling =-*- C++ -*--=//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// These tablegen backends emit Clang attribute processing code
11//
12//===----------------------------------------------------------------------===//
13
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +000014#include "llvm/ADT/ArrayRef.h"
Alex Lorenz9e7bf162017-04-18 14:33:39 +000015#include "llvm/ADT/DenseMap.h"
George Burgess IV1881a572016-12-01 00:13:18 +000016#include "llvm/ADT/DenseSet.h"
Alex Lorenz3bfe9622017-04-18 10:46:41 +000017#include "llvm/ADT/STLExtras.h"
Alex Lorenz9e7bf162017-04-18 14:33:39 +000018#include "llvm/ADT/SmallString.h"
Aaron Ballman28afa182014-11-17 18:17:19 +000019#include "llvm/ADT/StringExtras.h"
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +000020#include "llvm/ADT/StringRef.h"
Alex Lorenz9e7bf162017-04-18 14:33:39 +000021#include "llvm/ADT/StringSet.h"
Chandler Carruth5553d0d2014-01-07 11:51:46 +000022#include "llvm/ADT/StringSwitch.h"
Alex Lorenz9e7bf162017-04-18 14:33:39 +000023#include "llvm/ADT/iterator_range.h"
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +000024#include "llvm/Support/ErrorHandling.h"
25#include "llvm/Support/raw_ostream.h"
Chandler Carruth5553d0d2014-01-07 11:51:46 +000026#include "llvm/TableGen/Error.h"
Peter Collingbournebee583f2011-10-06 13:03:08 +000027#include "llvm/TableGen/Record.h"
Douglas Gregor377f99b2012-05-02 17:33:51 +000028#include "llvm/TableGen/StringMatcher.h"
Jakob Stoklund Olesen995e0e12012-06-13 05:12:41 +000029#include "llvm/TableGen/TableGenBackend.h"
Peter Collingbournebee583f2011-10-06 13:03:08 +000030#include <algorithm>
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +000031#include <cassert>
Peter Collingbournebee583f2011-10-06 13:03:08 +000032#include <cctype>
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +000033#include <cstddef>
34#include <cstdint>
35#include <map>
Aaron Ballman8f1439b2014-03-05 16:49:55 +000036#include <memory>
Aaron Ballman80469032013-11-29 14:57:58 +000037#include <set>
Chandler Carruth5553d0d2014-01-07 11:51:46 +000038#include <sstream>
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +000039#include <string>
40#include <utility>
41#include <vector>
Peter Collingbournebee583f2011-10-06 13:03:08 +000042
43using namespace llvm;
44
Benjamin Kramerd910d162015-03-10 18:24:01 +000045namespace {
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +000046
Aaron Ballmanc669cc02014-01-27 22:10:04 +000047class FlattenedSpelling {
48 std::string V, N, NS;
49 bool K;
50
51public:
52 FlattenedSpelling(const std::string &Variety, const std::string &Name,
53 const std::string &Namespace, bool KnownToGCC) :
54 V(Variety), N(Name), NS(Namespace), K(KnownToGCC) {}
55 explicit FlattenedSpelling(const Record &Spelling) :
56 V(Spelling.getValueAsString("Variety")),
57 N(Spelling.getValueAsString("Name")) {
58
Aaron Ballmanffc43362017-10-26 12:19:02 +000059 assert(V != "GCC" && V != "Clang" &&
60 "Given a GCC spelling, which means this hasn't been flattened!");
Aaron Ballman606093a2017-10-15 15:01:42 +000061 if (V == "CXX11" || V == "C2x" || V == "Pragma")
Aaron Ballmanc669cc02014-01-27 22:10:04 +000062 NS = Spelling.getValueAsString("Namespace");
63 bool Unset;
64 K = Spelling.getValueAsBitOrUnset("KnownToGCC", Unset);
65 }
66
67 const std::string &variety() const { return V; }
68 const std::string &name() const { return N; }
69 const std::string &nameSpace() const { return NS; }
70 bool knownToGCC() const { return K; }
71};
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +000072
Hans Wennborgdcfba332015-10-06 23:40:43 +000073} // end anonymous namespace
Aaron Ballmanc669cc02014-01-27 22:10:04 +000074
Benjamin Kramerd910d162015-03-10 18:24:01 +000075static std::vector<FlattenedSpelling>
76GetFlattenedSpellings(const Record &Attr) {
Aaron Ballmanc669cc02014-01-27 22:10:04 +000077 std::vector<Record *> Spellings = Attr.getValueAsListOfDefs("Spellings");
78 std::vector<FlattenedSpelling> Ret;
79
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +000080 for (const auto &Spelling : Spellings) {
Aaron Ballmanffc43362017-10-26 12:19:02 +000081 StringRef Variety = Spelling->getValueAsString("Variety");
82 StringRef Name = Spelling->getValueAsString("Name");
83 if (Variety == "GCC") {
Aaron Ballmanc669cc02014-01-27 22:10:04 +000084 // Gin up two new spelling objects to add into the list.
Aaron Ballmanffc43362017-10-26 12:19:02 +000085 Ret.emplace_back("GNU", Name, "", true);
86 Ret.emplace_back("CXX11", Name, "gnu", true);
87 } else if (Variety == "Clang") {
88 Ret.emplace_back("GNU", Name, "", false);
89 Ret.emplace_back("CXX11", Name, "clang", false);
Aaron Ballman10007812018-01-03 22:22:48 +000090 if (Spelling->getValueAsBit("AllowInC"))
91 Ret.emplace_back("C2x", Name, "clang", false);
Aaron Ballmanc669cc02014-01-27 22:10:04 +000092 } else
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +000093 Ret.push_back(FlattenedSpelling(*Spelling));
Aaron Ballmanc669cc02014-01-27 22:10:04 +000094 }
95
96 return Ret;
97}
98
Peter Collingbournebee583f2011-10-06 13:03:08 +000099static std::string ReadPCHRecord(StringRef type) {
100 return StringSwitch<std::string>(type)
David L. Jones267b8842017-01-24 01:04:30 +0000101 .EndsWith("Decl *", "Record.GetLocalDeclAs<"
102 + std::string(type, 0, type.size()-1) + ">(Record.readInt())")
103 .Case("TypeSourceInfo *", "Record.getTypeSourceInfo()")
104 .Case("Expr *", "Record.readExpr()")
105 .Case("IdentifierInfo *", "Record.getIdentifierInfo()")
106 .Case("StringRef", "Record.readString()")
Joel E. Denny81508102018-03-13 14:51:22 +0000107 .Case("ParamIdx", "ParamIdx::deserialize(Record.readInt())")
David L. Jones267b8842017-01-24 01:04:30 +0000108 .Default("Record.readInt()");
Peter Collingbournebee583f2011-10-06 13:03:08 +0000109}
110
Richard Smith19978562016-05-18 00:16:51 +0000111// Get a type that is suitable for storing an object of the specified type.
112static StringRef getStorageType(StringRef type) {
113 return StringSwitch<StringRef>(type)
114 .Case("StringRef", "std::string")
115 .Default(type);
116}
117
Peter Collingbournebee583f2011-10-06 13:03:08 +0000118// Assumes that the way to get the value is SA->getname()
119static std::string WritePCHRecord(StringRef type, StringRef name) {
Richard Smith290d8012016-04-06 17:06:00 +0000120 return "Record." + StringSwitch<std::string>(type)
121 .EndsWith("Decl *", "AddDeclRef(" + std::string(name) + ");\n")
122 .Case("TypeSourceInfo *", "AddTypeSourceInfo(" + std::string(name) + ");\n")
Peter Collingbournebee583f2011-10-06 13:03:08 +0000123 .Case("Expr *", "AddStmt(" + std::string(name) + ");\n")
Richard Smith290d8012016-04-06 17:06:00 +0000124 .Case("IdentifierInfo *", "AddIdentifierRef(" + std::string(name) + ");\n")
125 .Case("StringRef", "AddString(" + std::string(name) + ");\n")
Joel E. Denny81508102018-03-13 14:51:22 +0000126 .Case("ParamIdx", "push_back(" + std::string(name) + ".serialize());\n")
Richard Smith290d8012016-04-06 17:06:00 +0000127 .Default("push_back(" + std::string(name) + ");\n");
Peter Collingbournebee583f2011-10-06 13:03:08 +0000128}
129
Michael Han4a045172012-03-07 00:12:16 +0000130// Normalize attribute name by removing leading and trailing
131// underscores. For example, __foo, foo__, __foo__ would
132// become foo.
133static StringRef NormalizeAttrName(StringRef AttrName) {
George Burgess IV1881a572016-12-01 00:13:18 +0000134 AttrName.consume_front("__");
135 AttrName.consume_back("__");
Michael Han4a045172012-03-07 00:12:16 +0000136 return AttrName;
137}
138
Aaron Ballman36a53502014-01-16 13:03:14 +0000139// Normalize the name by removing any and all leading and trailing underscores.
140// This is different from NormalizeAttrName in that it also handles names like
141// _pascal and __pascal.
142static StringRef NormalizeNameForSpellingComparison(StringRef Name) {
Benjamin Kramer5c404072015-04-10 21:37:21 +0000143 return Name.trim("_");
Aaron Ballman36a53502014-01-16 13:03:14 +0000144}
145
Justin Lebar4086fe52017-01-05 16:51:54 +0000146// Normalize the spelling of a GNU attribute (i.e. "x" in "__attribute__((x))"),
147// removing "__" if it appears at the beginning and end of the attribute's name.
148static StringRef NormalizeGNUAttrSpelling(StringRef AttrSpelling) {
Michael Han4a045172012-03-07 00:12:16 +0000149 if (AttrSpelling.startswith("__") && AttrSpelling.endswith("__")) {
150 AttrSpelling = AttrSpelling.substr(2, AttrSpelling.size() - 4);
151 }
152
153 return AttrSpelling;
154}
155
Aaron Ballman2f22b942014-05-20 19:47:14 +0000156typedef std::vector<std::pair<std::string, const Record *>> ParsedAttrMap;
Aaron Ballman64e69862013-12-15 13:05:48 +0000157
Aaron Ballmanab7691c2014-01-09 22:48:32 +0000158static ParsedAttrMap getParsedAttrList(const RecordKeeper &Records,
Craig Topper8ae12032014-05-07 06:21:57 +0000159 ParsedAttrMap *Dupes = nullptr) {
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +0000160 std::vector<Record *> Attrs = Records.getAllDerivedDefinitions("Attr");
Aaron Ballman64e69862013-12-15 13:05:48 +0000161 std::set<std::string> Seen;
162 ParsedAttrMap R;
Aaron Ballman2f22b942014-05-20 19:47:14 +0000163 for (const auto *Attr : Attrs) {
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +0000164 if (Attr->getValueAsBit("SemaHandler")) {
Aaron Ballman64e69862013-12-15 13:05:48 +0000165 std::string AN;
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +0000166 if (Attr->isSubClassOf("TargetSpecificAttr") &&
167 !Attr->isValueUnset("ParseKind")) {
168 AN = Attr->getValueAsString("ParseKind");
Aaron Ballman64e69862013-12-15 13:05:48 +0000169
170 // If this attribute has already been handled, it does not need to be
171 // handled again.
Aaron Ballmanab7691c2014-01-09 22:48:32 +0000172 if (Seen.find(AN) != Seen.end()) {
173 if (Dupes)
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +0000174 Dupes->push_back(std::make_pair(AN, Attr));
Aaron Ballman64e69862013-12-15 13:05:48 +0000175 continue;
Aaron Ballmanab7691c2014-01-09 22:48:32 +0000176 }
Aaron Ballman64e69862013-12-15 13:05:48 +0000177 Seen.insert(AN);
178 } else
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +0000179 AN = NormalizeAttrName(Attr->getName()).str();
Aaron Ballman64e69862013-12-15 13:05:48 +0000180
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +0000181 R.push_back(std::make_pair(AN, Attr));
Aaron Ballman64e69862013-12-15 13:05:48 +0000182 }
183 }
184 return R;
185}
186
Peter Collingbournebee583f2011-10-06 13:03:08 +0000187namespace {
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000188
Peter Collingbournebee583f2011-10-06 13:03:08 +0000189 class Argument {
190 std::string lowerName, upperName;
191 StringRef attrName;
Aaron Ballman8ee40b72013-09-09 23:33:17 +0000192 bool isOpt;
John McCalla62c1a92015-10-28 00:17:34 +0000193 bool Fake;
Peter Collingbournebee583f2011-10-06 13:03:08 +0000194
195 public:
Aaron Ballman2f22b942014-05-20 19:47:14 +0000196 Argument(const Record &Arg, StringRef Attr)
Peter Collingbournebee583f2011-10-06 13:03:08 +0000197 : lowerName(Arg.getValueAsString("Name")), upperName(lowerName),
John McCalla62c1a92015-10-28 00:17:34 +0000198 attrName(Attr), isOpt(false), Fake(false) {
Peter Collingbournebee583f2011-10-06 13:03:08 +0000199 if (!lowerName.empty()) {
200 lowerName[0] = std::tolower(lowerName[0]);
201 upperName[0] = std::toupper(upperName[0]);
202 }
Reid Klecknerebeb0ca2016-05-31 17:42:56 +0000203 // Work around MinGW's macro definition of 'interface' to 'struct'. We
204 // have an attribute argument called 'Interface', so only the lower case
205 // name conflicts with the macro definition.
206 if (lowerName == "interface")
207 lowerName = "interface_";
Peter Collingbournebee583f2011-10-06 13:03:08 +0000208 }
Hans Wennborgdcfba332015-10-06 23:40:43 +0000209 virtual ~Argument() = default;
Peter Collingbournebee583f2011-10-06 13:03:08 +0000210
211 StringRef getLowerName() const { return lowerName; }
212 StringRef getUpperName() const { return upperName; }
213 StringRef getAttrName() const { return attrName; }
214
Aaron Ballman8ee40b72013-09-09 23:33:17 +0000215 bool isOptional() const { return isOpt; }
216 void setOptional(bool set) { isOpt = set; }
217
John McCalla62c1a92015-10-28 00:17:34 +0000218 bool isFake() const { return Fake; }
219 void setFake(bool fake) { Fake = fake; }
220
Peter Collingbournebee583f2011-10-06 13:03:08 +0000221 // These functions print the argument contents formatted in different ways.
222 virtual void writeAccessors(raw_ostream &OS) const = 0;
223 virtual void writeAccessorDefinitions(raw_ostream &OS) const {}
DeLesley Hutchinsc4a82432013-12-30 17:24:36 +0000224 virtual void writeASTVisitorTraversal(raw_ostream &OS) const {}
Peter Collingbournebee583f2011-10-06 13:03:08 +0000225 virtual void writeCloneArgs(raw_ostream &OS) const = 0;
DeLesley Hutchinsceec3062012-01-20 22:37:06 +0000226 virtual void writeTemplateInstantiationArgs(raw_ostream &OS) const = 0;
Daniel Dunbardc51baa2012-02-10 06:00:29 +0000227 virtual void writeTemplateInstantiation(raw_ostream &OS) const {}
Peter Collingbournebee583f2011-10-06 13:03:08 +0000228 virtual void writeCtorBody(raw_ostream &OS) const {}
229 virtual void writeCtorInitializers(raw_ostream &OS) const = 0;
Aaron Ballman8ee40b72013-09-09 23:33:17 +0000230 virtual void writeCtorDefaultInitializers(raw_ostream &OS) const = 0;
Peter Collingbournebee583f2011-10-06 13:03:08 +0000231 virtual void writeCtorParameters(raw_ostream &OS) const = 0;
232 virtual void writeDeclarations(raw_ostream &OS) const = 0;
233 virtual void writePCHReadArgs(raw_ostream &OS) const = 0;
234 virtual void writePCHReadDecls(raw_ostream &OS) const = 0;
235 virtual void writePCHWrite(raw_ostream &OS) const = 0;
Aaron Ballman48a533d2018-02-27 23:49:28 +0000236 virtual std::string getIsOmitted() const { return "false"; }
Douglas Gregor49ccfaa2011-11-19 19:22:57 +0000237 virtual void writeValue(raw_ostream &OS) const = 0;
Alexander Kornienko5bc364e2013-01-07 17:53:08 +0000238 virtual void writeDump(raw_ostream &OS) const = 0;
239 virtual void writeDumpChildren(raw_ostream &OS) const {}
Richard Trieude5cc7d2013-01-31 01:44:26 +0000240 virtual void writeHasChildren(raw_ostream &OS) const { OS << "false"; }
Aaron Ballman682ee422013-09-11 19:47:58 +0000241
242 virtual bool isEnumArg() const { return false; }
DeLesley Hutchins210791a2013-10-04 21:28:06 +0000243 virtual bool isVariadicEnumArg() const { return false; }
Aaron Ballman8ed8dbd2014-07-31 16:37:04 +0000244 virtual bool isVariadic() const { return false; }
Aaron Ballman36a53502014-01-16 13:03:14 +0000245
246 virtual void writeImplicitCtorArgs(raw_ostream &OS) const {
247 OS << getUpperName();
248 }
Peter Collingbournebee583f2011-10-06 13:03:08 +0000249 };
250
251 class SimpleArgument : public Argument {
252 std::string type;
253
254 public:
Aaron Ballman2f22b942014-05-20 19:47:14 +0000255 SimpleArgument(const Record &Arg, StringRef Attr, std::string T)
Benjamin Kramercfeacf52016-05-27 14:27:13 +0000256 : Argument(Arg, Attr), type(std::move(T)) {}
Peter Collingbournebee583f2011-10-06 13:03:08 +0000257
DeLesley Hutchinsceec3062012-01-20 22:37:06 +0000258 std::string getType() const { return type; }
259
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000260 void writeAccessors(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +0000261 OS << " " << type << " get" << getUpperName() << "() const {\n";
262 OS << " return " << getLowerName() << ";\n";
263 OS << " }";
264 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000265
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000266 void writeCloneArgs(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +0000267 OS << getLowerName();
268 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000269
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000270 void writeTemplateInstantiationArgs(raw_ostream &OS) const override {
DeLesley Hutchinsceec3062012-01-20 22:37:06 +0000271 OS << "A->get" << getUpperName() << "()";
272 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000273
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000274 void writeCtorInitializers(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +0000275 OS << getLowerName() << "(" << getUpperName() << ")";
276 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000277
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000278 void writeCtorDefaultInitializers(raw_ostream &OS) const override {
Aaron Ballman8ee40b72013-09-09 23:33:17 +0000279 OS << getLowerName() << "()";
280 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000281
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000282 void writeCtorParameters(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +0000283 OS << type << " " << getUpperName();
284 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000285
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000286 void writeDeclarations(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +0000287 OS << type << " " << getLowerName() << ";";
288 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000289
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000290 void writePCHReadDecls(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +0000291 std::string read = ReadPCHRecord(type);
292 OS << " " << type << " " << getLowerName() << " = " << read << ";\n";
293 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000294
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000295 void writePCHReadArgs(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +0000296 OS << getLowerName();
297 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000298
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000299 void writePCHWrite(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +0000300 OS << " " << WritePCHRecord(type, "SA->get" +
301 std::string(getUpperName()) + "()");
302 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000303
Aaron Ballman48a533d2018-02-27 23:49:28 +0000304 std::string getIsOmitted() const override {
305 if (type == "IdentifierInfo *")
306 return "!get" + getUpperName().str() + "()";
Joel E. Denny81508102018-03-13 14:51:22 +0000307 if (type == "ParamIdx")
308 return "!get" + getUpperName().str() + "().isValid()";
Aaron Ballman48a533d2018-02-27 23:49:28 +0000309 return "false";
310 }
311
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000312 void writeValue(raw_ostream &OS) const override {
Aaron Ballman48a533d2018-02-27 23:49:28 +0000313 if (type == "FunctionDecl *")
Richard Smithb87c4652013-10-31 21:23:20 +0000314 OS << "\" << get" << getUpperName()
315 << "()->getNameInfo().getAsString() << \"";
Aaron Ballman48a533d2018-02-27 23:49:28 +0000316 else if (type == "IdentifierInfo *")
317 // Some non-optional (comma required) identifier arguments can be the
318 // empty string but are then recorded as a nullptr.
319 OS << "\" << (get" << getUpperName() << "() ? get" << getUpperName()
320 << "()->getName() : \"\") << \"";
321 else if (type == "TypeSourceInfo *")
Douglas Gregor49ccfaa2011-11-19 19:22:57 +0000322 OS << "\" << get" << getUpperName() << "().getAsString() << \"";
Joel E. Denny81508102018-03-13 14:51:22 +0000323 else if (type == "ParamIdx")
324 OS << "\" << get" << getUpperName() << "().getSourceIndex() << \"";
Aaron Ballman48a533d2018-02-27 23:49:28 +0000325 else
Douglas Gregor49ccfaa2011-11-19 19:22:57 +0000326 OS << "\" << get" << getUpperName() << "() << \"";
Douglas Gregor49ccfaa2011-11-19 19:22:57 +0000327 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000328
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000329 void writeDump(raw_ostream &OS) const override {
Argyrios Kyrtzidisa7233bd2017-05-24 00:46:27 +0000330 if (type == "FunctionDecl *" || type == "NamedDecl *") {
Alexander Kornienko5bc364e2013-01-07 17:53:08 +0000331 OS << " OS << \" \";\n";
332 OS << " dumpBareDeclRef(SA->get" << getUpperName() << "());\n";
333 } else if (type == "IdentifierInfo *") {
Aaron Ballman48a533d2018-02-27 23:49:28 +0000334 // Some non-optional (comma required) identifier arguments can be the
335 // empty string but are then recorded as a nullptr.
336 OS << " if (SA->get" << getUpperName() << "())\n"
337 << " OS << \" \" << SA->get" << getUpperName()
Alexander Kornienko5bc364e2013-01-07 17:53:08 +0000338 << "()->getName();\n";
Richard Smithb87c4652013-10-31 21:23:20 +0000339 } else if (type == "TypeSourceInfo *") {
Alexander Kornienko5bc364e2013-01-07 17:53:08 +0000340 OS << " OS << \" \" << SA->get" << getUpperName()
341 << "().getAsString();\n";
Alexander Kornienko5bc364e2013-01-07 17:53:08 +0000342 } else if (type == "bool") {
343 OS << " if (SA->get" << getUpperName() << "()) OS << \" "
344 << getUpperName() << "\";\n";
345 } else if (type == "int" || type == "unsigned") {
346 OS << " OS << \" \" << SA->get" << getUpperName() << "();\n";
Joel E. Denny81508102018-03-13 14:51:22 +0000347 } else if (type == "ParamIdx") {
348 if (isOptional())
349 OS << " if (SA->get" << getUpperName() << "().isValid())\n ";
350 OS << " OS << \" \" << SA->get" << getUpperName()
351 << "().getSourceIndex();\n";
Alexander Kornienko5bc364e2013-01-07 17:53:08 +0000352 } else {
353 llvm_unreachable("Unknown SimpleArgument type!");
354 }
355 }
Peter Collingbournebee583f2011-10-06 13:03:08 +0000356 };
357
Aaron Ballman18a78382013-11-21 00:28:23 +0000358 class DefaultSimpleArgument : public SimpleArgument {
359 int64_t Default;
360
361 public:
Aaron Ballman2f22b942014-05-20 19:47:14 +0000362 DefaultSimpleArgument(const Record &Arg, StringRef Attr,
Aaron Ballman18a78382013-11-21 00:28:23 +0000363 std::string T, int64_t Default)
364 : SimpleArgument(Arg, Attr, T), Default(Default) {}
365
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000366 void writeAccessors(raw_ostream &OS) const override {
Aaron Ballman18a78382013-11-21 00:28:23 +0000367 SimpleArgument::writeAccessors(OS);
368
369 OS << "\n\n static const " << getType() << " Default" << getUpperName()
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000370 << " = ";
371 if (getType() == "bool")
372 OS << (Default != 0 ? "true" : "false");
373 else
374 OS << Default;
375 OS << ";";
Aaron Ballman18a78382013-11-21 00:28:23 +0000376 }
377 };
378
Peter Collingbournebee583f2011-10-06 13:03:08 +0000379 class StringArgument : public Argument {
380 public:
Aaron Ballman2f22b942014-05-20 19:47:14 +0000381 StringArgument(const Record &Arg, StringRef Attr)
Peter Collingbournebee583f2011-10-06 13:03:08 +0000382 : Argument(Arg, Attr)
383 {}
384
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000385 void writeAccessors(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +0000386 OS << " llvm::StringRef get" << getUpperName() << "() const {\n";
387 OS << " return llvm::StringRef(" << getLowerName() << ", "
388 << getLowerName() << "Length);\n";
389 OS << " }\n";
390 OS << " unsigned get" << getUpperName() << "Length() const {\n";
391 OS << " return " << getLowerName() << "Length;\n";
392 OS << " }\n";
393 OS << " void set" << getUpperName()
394 << "(ASTContext &C, llvm::StringRef S) {\n";
395 OS << " " << getLowerName() << "Length = S.size();\n";
396 OS << " this->" << getLowerName() << " = new (C, 1) char ["
397 << getLowerName() << "Length];\n";
Chandler Carruth38a45cc2015-08-04 03:53:01 +0000398 OS << " if (!S.empty())\n";
399 OS << " std::memcpy(this->" << getLowerName() << ", S.data(), "
Peter Collingbournebee583f2011-10-06 13:03:08 +0000400 << getLowerName() << "Length);\n";
401 OS << " }";
402 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000403
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000404 void writeCloneArgs(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +0000405 OS << "get" << getUpperName() << "()";
406 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000407
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000408 void writeTemplateInstantiationArgs(raw_ostream &OS) const override {
DeLesley Hutchinsceec3062012-01-20 22:37:06 +0000409 OS << "A->get" << getUpperName() << "()";
410 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000411
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000412 void writeCtorBody(raw_ostream &OS) const override {
Chandler Carruth38a45cc2015-08-04 03:53:01 +0000413 OS << " if (!" << getUpperName() << ".empty())\n";
414 OS << " std::memcpy(" << getLowerName() << ", " << getUpperName()
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000415 << ".data(), " << getLowerName() << "Length);\n";
Peter Collingbournebee583f2011-10-06 13:03:08 +0000416 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000417
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000418 void writeCtorInitializers(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +0000419 OS << getLowerName() << "Length(" << getUpperName() << ".size()),"
420 << getLowerName() << "(new (Ctx, 1) char[" << getLowerName()
421 << "Length])";
422 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000423
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000424 void writeCtorDefaultInitializers(raw_ostream &OS) const override {
Hans Wennborg59dbe862015-09-29 20:56:43 +0000425 OS << getLowerName() << "Length(0)," << getLowerName() << "(nullptr)";
Aaron Ballman8ee40b72013-09-09 23:33:17 +0000426 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000427
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000428 void writeCtorParameters(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +0000429 OS << "llvm::StringRef " << getUpperName();
430 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000431
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000432 void writeDeclarations(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +0000433 OS << "unsigned " << getLowerName() << "Length;\n";
434 OS << "char *" << getLowerName() << ";";
435 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000436
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000437 void writePCHReadDecls(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +0000438 OS << " std::string " << getLowerName()
David L. Jones267b8842017-01-24 01:04:30 +0000439 << "= Record.readString();\n";
Peter Collingbournebee583f2011-10-06 13:03:08 +0000440 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000441
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000442 void writePCHReadArgs(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +0000443 OS << getLowerName();
444 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000445
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000446 void writePCHWrite(raw_ostream &OS) const override {
Richard Smith290d8012016-04-06 17:06:00 +0000447 OS << " Record.AddString(SA->get" << getUpperName() << "());\n";
Peter Collingbournebee583f2011-10-06 13:03:08 +0000448 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000449
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000450 void writeValue(raw_ostream &OS) const override {
Douglas Gregor49ccfaa2011-11-19 19:22:57 +0000451 OS << "\\\"\" << get" << getUpperName() << "() << \"\\\"";
452 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000453
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000454 void writeDump(raw_ostream &OS) const override {
Alexander Kornienko5bc364e2013-01-07 17:53:08 +0000455 OS << " OS << \" \\\"\" << SA->get" << getUpperName()
456 << "() << \"\\\"\";\n";
457 }
Peter Collingbournebee583f2011-10-06 13:03:08 +0000458 };
459
460 class AlignedArgument : public Argument {
461 public:
Aaron Ballman2f22b942014-05-20 19:47:14 +0000462 AlignedArgument(const Record &Arg, StringRef Attr)
Peter Collingbournebee583f2011-10-06 13:03:08 +0000463 : Argument(Arg, Attr)
464 {}
465
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000466 void writeAccessors(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +0000467 OS << " bool is" << getUpperName() << "Dependent() const;\n";
468
469 OS << " unsigned get" << getUpperName() << "(ASTContext &Ctx) const;\n";
470
471 OS << " bool is" << getUpperName() << "Expr() const {\n";
472 OS << " return is" << getLowerName() << "Expr;\n";
473 OS << " }\n";
474
475 OS << " Expr *get" << getUpperName() << "Expr() const {\n";
476 OS << " assert(is" << getLowerName() << "Expr);\n";
477 OS << " return " << getLowerName() << "Expr;\n";
478 OS << " }\n";
479
480 OS << " TypeSourceInfo *get" << getUpperName() << "Type() const {\n";
481 OS << " assert(!is" << getLowerName() << "Expr);\n";
482 OS << " return " << getLowerName() << "Type;\n";
483 OS << " }";
484 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000485
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000486 void writeAccessorDefinitions(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +0000487 OS << "bool " << getAttrName() << "Attr::is" << getUpperName()
488 << "Dependent() const {\n";
489 OS << " if (is" << getLowerName() << "Expr)\n";
490 OS << " return " << getLowerName() << "Expr && (" << getLowerName()
491 << "Expr->isValueDependent() || " << getLowerName()
492 << "Expr->isTypeDependent());\n";
493 OS << " else\n";
494 OS << " return " << getLowerName()
495 << "Type->getType()->isDependentType();\n";
496 OS << "}\n";
497
498 // FIXME: Do not do the calculation here
499 // FIXME: Handle types correctly
500 // A null pointer means maximum alignment
Peter Collingbournebee583f2011-10-06 13:03:08 +0000501 OS << "unsigned " << getAttrName() << "Attr::get" << getUpperName()
502 << "(ASTContext &Ctx) const {\n";
503 OS << " assert(!is" << getUpperName() << "Dependent());\n";
504 OS << " if (is" << getLowerName() << "Expr)\n";
Ulrich Weigandca3cb7f2015-04-21 17:29:35 +0000505 OS << " return " << getLowerName() << "Expr ? " << getLowerName()
506 << "Expr->EvaluateKnownConstInt(Ctx).getZExtValue()"
507 << " * Ctx.getCharWidth() : "
508 << "Ctx.getTargetDefaultAlignForAttributeAligned();\n";
Peter Collingbournebee583f2011-10-06 13:03:08 +0000509 OS << " else\n";
510 OS << " return 0; // FIXME\n";
511 OS << "}\n";
512 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000513
Richard Smithf26d5512017-08-15 22:58:45 +0000514 void writeASTVisitorTraversal(raw_ostream &OS) const override {
515 StringRef Name = getUpperName();
516 OS << " if (A->is" << Name << "Expr()) {\n"
517 << " if (!getDerived().TraverseStmt(A->get" << Name << "Expr()))\n"
518 << " return false;\n"
519 << " } else if (auto *TSI = A->get" << Name << "Type()) {\n"
520 << " if (!getDerived().TraverseTypeLoc(TSI->getTypeLoc()))\n"
521 << " return false;\n"
522 << " }\n";
523 }
524
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000525 void writeCloneArgs(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +0000526 OS << "is" << getLowerName() << "Expr, is" << getLowerName()
527 << "Expr ? static_cast<void*>(" << getLowerName()
528 << "Expr) : " << getLowerName()
529 << "Type";
530 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000531
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000532 void writeTemplateInstantiationArgs(raw_ostream &OS) const override {
DeLesley Hutchinsceec3062012-01-20 22:37:06 +0000533 // FIXME: move the definition in Sema::InstantiateAttrs to here.
534 // In the meantime, aligned attributes are cloned.
535 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000536
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000537 void writeCtorBody(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +0000538 OS << " if (is" << getLowerName() << "Expr)\n";
539 OS << " " << getLowerName() << "Expr = reinterpret_cast<Expr *>("
540 << getUpperName() << ");\n";
541 OS << " else\n";
542 OS << " " << getLowerName()
543 << "Type = reinterpret_cast<TypeSourceInfo *>(" << getUpperName()
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000544 << ");\n";
Peter Collingbournebee583f2011-10-06 13:03:08 +0000545 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000546
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000547 void writeCtorInitializers(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +0000548 OS << "is" << getLowerName() << "Expr(Is" << getUpperName() << "Expr)";
549 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000550
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000551 void writeCtorDefaultInitializers(raw_ostream &OS) const override {
Aaron Ballman8ee40b72013-09-09 23:33:17 +0000552 OS << "is" << getLowerName() << "Expr(false)";
553 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000554
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000555 void writeCtorParameters(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +0000556 OS << "bool Is" << getUpperName() << "Expr, void *" << getUpperName();
557 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000558
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000559 void writeImplicitCtorArgs(raw_ostream &OS) const override {
Aaron Ballman36a53502014-01-16 13:03:14 +0000560 OS << "Is" << getUpperName() << "Expr, " << getUpperName();
561 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000562
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000563 void writeDeclarations(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +0000564 OS << "bool is" << getLowerName() << "Expr;\n";
565 OS << "union {\n";
566 OS << "Expr *" << getLowerName() << "Expr;\n";
567 OS << "TypeSourceInfo *" << getLowerName() << "Type;\n";
568 OS << "};";
569 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000570
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000571 void writePCHReadArgs(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +0000572 OS << "is" << getLowerName() << "Expr, " << getLowerName() << "Ptr";
573 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000574
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000575 void writePCHReadDecls(raw_ostream &OS) const override {
David L. Jones267b8842017-01-24 01:04:30 +0000576 OS << " bool is" << getLowerName() << "Expr = Record.readInt();\n";
Peter Collingbournebee583f2011-10-06 13:03:08 +0000577 OS << " void *" << getLowerName() << "Ptr;\n";
578 OS << " if (is" << getLowerName() << "Expr)\n";
David L. Jones267b8842017-01-24 01:04:30 +0000579 OS << " " << getLowerName() << "Ptr = Record.readExpr();\n";
Peter Collingbournebee583f2011-10-06 13:03:08 +0000580 OS << " else\n";
581 OS << " " << getLowerName()
David L. Jones267b8842017-01-24 01:04:30 +0000582 << "Ptr = Record.getTypeSourceInfo();\n";
Peter Collingbournebee583f2011-10-06 13:03:08 +0000583 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000584
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000585 void writePCHWrite(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +0000586 OS << " Record.push_back(SA->is" << getUpperName() << "Expr());\n";
587 OS << " if (SA->is" << getUpperName() << "Expr())\n";
Richard Smith290d8012016-04-06 17:06:00 +0000588 OS << " Record.AddStmt(SA->get" << getUpperName() << "Expr());\n";
Peter Collingbournebee583f2011-10-06 13:03:08 +0000589 OS << " else\n";
Richard Smith290d8012016-04-06 17:06:00 +0000590 OS << " Record.AddTypeSourceInfo(SA->get" << getUpperName()
591 << "Type());\n";
Peter Collingbournebee583f2011-10-06 13:03:08 +0000592 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000593
Aaron Ballman48a533d2018-02-27 23:49:28 +0000594 std::string getIsOmitted() const override {
595 return "!is" + getLowerName().str() + "Expr || !" + getLowerName().str()
596 + "Expr";
597 }
598
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000599 void writeValue(raw_ostream &OS) const override {
Richard Trieuddd01ce2014-06-09 22:53:25 +0000600 OS << "\";\n";
Aaron Ballman48a533d2018-02-27 23:49:28 +0000601 OS << " " << getLowerName()
602 << "Expr->printPretty(OS, nullptr, Policy);\n";
Richard Trieuddd01ce2014-06-09 22:53:25 +0000603 OS << " OS << \"";
Douglas Gregor49ccfaa2011-11-19 19:22:57 +0000604 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000605
606 void writeDump(raw_ostream &OS) const override {}
607
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000608 void writeDumpChildren(raw_ostream &OS) const override {
Richard Smithf7514452014-10-30 21:02:37 +0000609 OS << " if (SA->is" << getUpperName() << "Expr())\n";
Alexander Kornienko5bc364e2013-01-07 17:53:08 +0000610 OS << " dumpStmt(SA->get" << getUpperName() << "Expr());\n";
Richard Smithf7514452014-10-30 21:02:37 +0000611 OS << " else\n";
Alexander Kornienko5bc364e2013-01-07 17:53:08 +0000612 OS << " dumpType(SA->get" << getUpperName()
613 << "Type()->getType());\n";
614 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000615
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000616 void writeHasChildren(raw_ostream &OS) const override {
Richard Trieude5cc7d2013-01-31 01:44:26 +0000617 OS << "SA->is" << getUpperName() << "Expr()";
618 }
Peter Collingbournebee583f2011-10-06 13:03:08 +0000619 };
620
621 class VariadicArgument : public Argument {
Aaron Ballmana82eaa72014-05-02 13:35:42 +0000622 std::string Type, ArgName, ArgSizeName, RangeName;
Peter Collingbournebee583f2011-10-06 13:03:08 +0000623
Aaron Ballman25a2cb92014-09-15 15:14:13 +0000624 protected:
625 // Assumed to receive a parameter: raw_ostream OS.
626 virtual void writeValueImpl(raw_ostream &OS) const {
627 OS << " OS << Val;\n";
628 }
Joel E. Denny81508102018-03-13 14:51:22 +0000629 // Assumed to receive a parameter: raw_ostream OS.
630 virtual void writeDumpImpl(raw_ostream &OS) const {
631 OS << " OS << \" \" << Val;\n";
632 }
Aaron Ballman25a2cb92014-09-15 15:14:13 +0000633
Peter Collingbournebee583f2011-10-06 13:03:08 +0000634 public:
Aaron Ballman2f22b942014-05-20 19:47:14 +0000635 VariadicArgument(const Record &Arg, StringRef Attr, std::string T)
Benjamin Kramercfeacf52016-05-27 14:27:13 +0000636 : Argument(Arg, Attr), Type(std::move(T)),
637 ArgName(getLowerName().str() + "_"), ArgSizeName(ArgName + "Size"),
638 RangeName(getLowerName()) {}
Peter Collingbournebee583f2011-10-06 13:03:08 +0000639
Benjamin Kramer1b582012016-02-13 18:11:49 +0000640 const std::string &getType() const { return Type; }
641 const std::string &getArgName() const { return ArgName; }
642 const std::string &getArgSizeName() const { return ArgSizeName; }
Aaron Ballman8ed8dbd2014-07-31 16:37:04 +0000643 bool isVariadic() const override { return true; }
Peter Collingbournebee583f2011-10-06 13:03:08 +0000644
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000645 void writeAccessors(raw_ostream &OS) const override {
Aaron Ballmana82eaa72014-05-02 13:35:42 +0000646 std::string IteratorType = getLowerName().str() + "_iterator";
647 std::string BeginFn = getLowerName().str() + "_begin()";
648 std::string EndFn = getLowerName().str() + "_end()";
649
650 OS << " typedef " << Type << "* " << IteratorType << ";\n";
651 OS << " " << IteratorType << " " << BeginFn << " const {"
652 << " return " << ArgName << "; }\n";
653 OS << " " << IteratorType << " " << EndFn << " const {"
654 << " return " << ArgName << " + " << ArgSizeName << "; }\n";
655 OS << " unsigned " << getLowerName() << "_size() const {"
656 << " return " << ArgSizeName << "; }\n";
657 OS << " llvm::iterator_range<" << IteratorType << "> " << RangeName
658 << "() const { return llvm::make_range(" << BeginFn << ", " << EndFn
659 << "); }\n";
Peter Collingbournebee583f2011-10-06 13:03:08 +0000660 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000661
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000662 void writeCloneArgs(raw_ostream &OS) const override {
Aaron Ballmana82eaa72014-05-02 13:35:42 +0000663 OS << ArgName << ", " << ArgSizeName;
Peter Collingbournebee583f2011-10-06 13:03:08 +0000664 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000665
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000666 void writeTemplateInstantiationArgs(raw_ostream &OS) const override {
DeLesley Hutchinsceec3062012-01-20 22:37:06 +0000667 // This isn't elegant, but we have to go through public methods...
668 OS << "A->" << getLowerName() << "_begin(), "
669 << "A->" << getLowerName() << "_size()";
670 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000671
Richard Smithf26d5512017-08-15 22:58:45 +0000672 void writeASTVisitorTraversal(raw_ostream &OS) const override {
673 // FIXME: Traverse the elements.
674 }
675
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000676 void writeCtorBody(raw_ostream &OS) const override {
Aaron Ballmand6459e52014-05-01 15:21:03 +0000677 OS << " std::copy(" << getUpperName() << ", " << getUpperName()
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000678 << " + " << ArgSizeName << ", " << ArgName << ");\n";
Peter Collingbournebee583f2011-10-06 13:03:08 +0000679 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000680
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000681 void writeCtorInitializers(raw_ostream &OS) const override {
Aaron Ballmana82eaa72014-05-02 13:35:42 +0000682 OS << ArgSizeName << "(" << getUpperName() << "Size), "
683 << ArgName << "(new (Ctx, 16) " << getType() << "["
684 << ArgSizeName << "])";
Peter Collingbournebee583f2011-10-06 13:03:08 +0000685 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000686
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000687 void writeCtorDefaultInitializers(raw_ostream &OS) const override {
Aaron Ballmana82eaa72014-05-02 13:35:42 +0000688 OS << ArgSizeName << "(0), " << ArgName << "(nullptr)";
Aaron Ballman8ee40b72013-09-09 23:33:17 +0000689 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000690
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000691 void writeCtorParameters(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +0000692 OS << getType() << " *" << getUpperName() << ", unsigned "
693 << getUpperName() << "Size";
694 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000695
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000696 void writeImplicitCtorArgs(raw_ostream &OS) const override {
Aaron Ballman36a53502014-01-16 13:03:14 +0000697 OS << getUpperName() << ", " << getUpperName() << "Size";
698 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000699
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000700 void writeDeclarations(raw_ostream &OS) const override {
Aaron Ballmana82eaa72014-05-02 13:35:42 +0000701 OS << " unsigned " << ArgSizeName << ";\n";
702 OS << " " << getType() << " *" << ArgName << ";";
Peter Collingbournebee583f2011-10-06 13:03:08 +0000703 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000704
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000705 void writePCHReadDecls(raw_ostream &OS) const override {
David L. Jones267b8842017-01-24 01:04:30 +0000706 OS << " unsigned " << getLowerName() << "Size = Record.readInt();\n";
Richard Smith19978562016-05-18 00:16:51 +0000707 OS << " SmallVector<" << getType() << ", 4> "
708 << getLowerName() << ";\n";
709 OS << " " << getLowerName() << ".reserve(" << getLowerName()
Peter Collingbournebee583f2011-10-06 13:03:08 +0000710 << "Size);\n";
Richard Smith19978562016-05-18 00:16:51 +0000711
712 // If we can't store the values in the current type (if it's something
713 // like StringRef), store them in a different type and convert the
714 // container afterwards.
715 std::string StorageType = getStorageType(getType());
716 std::string StorageName = getLowerName();
717 if (StorageType != getType()) {
718 StorageName += "Storage";
719 OS << " SmallVector<" << StorageType << ", 4> "
720 << StorageName << ";\n";
721 OS << " " << StorageName << ".reserve(" << getLowerName()
722 << "Size);\n";
723 }
724
725 OS << " for (unsigned i = 0; i != " << getLowerName() << "Size; ++i)\n";
Aaron Ballmana82eaa72014-05-02 13:35:42 +0000726 std::string read = ReadPCHRecord(Type);
Richard Smith19978562016-05-18 00:16:51 +0000727 OS << " " << StorageName << ".push_back(" << read << ");\n";
728
729 if (StorageType != getType()) {
730 OS << " for (unsigned i = 0; i != " << getLowerName() << "Size; ++i)\n";
731 OS << " " << getLowerName() << ".push_back("
732 << StorageName << "[i]);\n";
733 }
Peter Collingbournebee583f2011-10-06 13:03:08 +0000734 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000735
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000736 void writePCHReadArgs(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +0000737 OS << getLowerName() << ".data(), " << getLowerName() << "Size";
738 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000739
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000740 void writePCHWrite(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +0000741 OS << " Record.push_back(SA->" << getLowerName() << "_size());\n";
Aaron Ballmana82eaa72014-05-02 13:35:42 +0000742 OS << " for (auto &Val : SA->" << RangeName << "())\n";
743 OS << " " << WritePCHRecord(Type, "Val");
Peter Collingbournebee583f2011-10-06 13:03:08 +0000744 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000745
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000746 void writeValue(raw_ostream &OS) const override {
Douglas Gregor49ccfaa2011-11-19 19:22:57 +0000747 OS << "\";\n";
748 OS << " bool isFirst = true;\n"
Aaron Ballmana82eaa72014-05-02 13:35:42 +0000749 << " for (const auto &Val : " << RangeName << "()) {\n"
Douglas Gregor49ccfaa2011-11-19 19:22:57 +0000750 << " if (isFirst) isFirst = false;\n"
Aaron Ballman25a2cb92014-09-15 15:14:13 +0000751 << " else OS << \", \";\n";
752 writeValueImpl(OS);
753 OS << " }\n";
Douglas Gregor49ccfaa2011-11-19 19:22:57 +0000754 OS << " OS << \"";
755 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000756
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000757 void writeDump(raw_ostream &OS) const override {
Aaron Ballmana82eaa72014-05-02 13:35:42 +0000758 OS << " for (const auto &Val : SA->" << RangeName << "())\n";
Joel E. Denny81508102018-03-13 14:51:22 +0000759 writeDumpImpl(OS);
760 }
761 };
762
763 class VariadicParamIdxArgument : public VariadicArgument {
764 public:
765 VariadicParamIdxArgument(const Record &Arg, StringRef Attr)
766 : VariadicArgument(Arg, Attr, "ParamIdx") {}
767
768 public:
769 void writeValueImpl(raw_ostream &OS) const override {
770 OS << " OS << Val.getSourceIndex();\n";
771 }
772
773 void writeDumpImpl(raw_ostream &OS) const override {
774 OS << " OS << \" \" << Val.getSourceIndex();\n";
Alexander Kornienko5bc364e2013-01-07 17:53:08 +0000775 }
Peter Collingbournebee583f2011-10-06 13:03:08 +0000776 };
777
Reid Klecknerf526b9482014-02-12 18:22:18 +0000778 // Unique the enums, but maintain the original declaration ordering.
Craig Topper00648582017-05-31 19:01:22 +0000779 std::vector<StringRef>
780 uniqueEnumsInOrder(const std::vector<StringRef> &enums) {
781 std::vector<StringRef> uniques;
George Burgess IV1881a572016-12-01 00:13:18 +0000782 SmallDenseSet<StringRef, 8> unique_set;
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +0000783 for (const auto &i : enums) {
George Burgess IV1881a572016-12-01 00:13:18 +0000784 if (unique_set.insert(i).second)
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +0000785 uniques.push_back(i);
Reid Klecknerf526b9482014-02-12 18:22:18 +0000786 }
787 return uniques;
788 }
789
Peter Collingbournebee583f2011-10-06 13:03:08 +0000790 class EnumArgument : public Argument {
791 std::string type;
Craig Topper00648582017-05-31 19:01:22 +0000792 std::vector<StringRef> values, enums, uniques;
793
Peter Collingbournebee583f2011-10-06 13:03:08 +0000794 public:
Aaron Ballman2f22b942014-05-20 19:47:14 +0000795 EnumArgument(const Record &Arg, StringRef Attr)
Peter Collingbournebee583f2011-10-06 13:03:08 +0000796 : Argument(Arg, Attr), type(Arg.getValueAsString("Type")),
Aaron Ballman0e468c02014-01-05 21:08:29 +0000797 values(Arg.getValueAsListOfStrings("Values")),
798 enums(Arg.getValueAsListOfStrings("Enums")),
Reid Klecknerf526b9482014-02-12 18:22:18 +0000799 uniques(uniqueEnumsInOrder(enums))
Alexander Kornienko5bc364e2013-01-07 17:53:08 +0000800 {
Alexander Kornienko5bc364e2013-01-07 17:53:08 +0000801 // FIXME: Emit a proper error
802 assert(!uniques.empty());
803 }
Peter Collingbournebee583f2011-10-06 13:03:08 +0000804
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000805 bool isEnumArg() const override { return true; }
Aaron Ballman682ee422013-09-11 19:47:58 +0000806
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000807 void writeAccessors(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +0000808 OS << " " << type << " get" << getUpperName() << "() const {\n";
809 OS << " return " << getLowerName() << ";\n";
810 OS << " }";
811 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000812
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000813 void writeCloneArgs(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +0000814 OS << getLowerName();
815 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000816
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000817 void writeTemplateInstantiationArgs(raw_ostream &OS) const override {
DeLesley Hutchinsceec3062012-01-20 22:37:06 +0000818 OS << "A->get" << getUpperName() << "()";
819 }
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000820 void writeCtorInitializers(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +0000821 OS << getLowerName() << "(" << getUpperName() << ")";
822 }
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000823 void writeCtorDefaultInitializers(raw_ostream &OS) const override {
Aaron Ballman8ee40b72013-09-09 23:33:17 +0000824 OS << getLowerName() << "(" << type << "(0))";
825 }
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000826 void writeCtorParameters(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +0000827 OS << type << " " << getUpperName();
828 }
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000829 void writeDeclarations(raw_ostream &OS) const override {
Eugene Zelenko5f02b772015-12-08 18:49:01 +0000830 auto i = uniques.cbegin(), e = uniques.cend();
Peter Collingbournebee583f2011-10-06 13:03:08 +0000831 // The last one needs to not have a comma.
832 --e;
833
834 OS << "public:\n";
835 OS << " enum " << type << " {\n";
836 for (; i != e; ++i)
837 OS << " " << *i << ",\n";
838 OS << " " << *e << "\n";
839 OS << " };\n";
840 OS << "private:\n";
841 OS << " " << type << " " << getLowerName() << ";";
842 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000843
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000844 void writePCHReadDecls(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +0000845 OS << " " << getAttrName() << "Attr::" << type << " " << getLowerName()
846 << "(static_cast<" << getAttrName() << "Attr::" << type
David L. Jones267b8842017-01-24 01:04:30 +0000847 << ">(Record.readInt()));\n";
Peter Collingbournebee583f2011-10-06 13:03:08 +0000848 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000849
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000850 void writePCHReadArgs(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +0000851 OS << getLowerName();
852 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000853
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000854 void writePCHWrite(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +0000855 OS << "Record.push_back(SA->get" << getUpperName() << "());\n";
856 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000857
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000858 void writeValue(raw_ostream &OS) const override {
Aaron Ballman36d79102014-09-15 16:16:14 +0000859 // FIXME: this isn't 100% correct -- some enum arguments require printing
860 // as a string literal, while others require printing as an identifier.
861 // Tablegen currently does not distinguish between the two forms.
Aaron Ballman25a2cb92014-09-15 15:14:13 +0000862 OS << "\\\"\" << " << getAttrName() << "Attr::Convert" << type << "ToStr(get"
863 << getUpperName() << "()) << \"\\\"";
Douglas Gregor49ccfaa2011-11-19 19:22:57 +0000864 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000865
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000866 void writeDump(raw_ostream &OS) const override {
Alexander Kornienko5bc364e2013-01-07 17:53:08 +0000867 OS << " switch(SA->get" << getUpperName() << "()) {\n";
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +0000868 for (const auto &I : uniques) {
869 OS << " case " << getAttrName() << "Attr::" << I << ":\n";
870 OS << " OS << \" " << I << "\";\n";
Alexander Kornienko5bc364e2013-01-07 17:53:08 +0000871 OS << " break;\n";
872 }
873 OS << " }\n";
874 }
Aaron Ballman682ee422013-09-11 19:47:58 +0000875
876 void writeConversion(raw_ostream &OS) const {
877 OS << " static bool ConvertStrTo" << type << "(StringRef Val, ";
878 OS << type << " &Out) {\n";
879 OS << " Optional<" << type << "> R = llvm::StringSwitch<Optional<";
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +0000880 OS << type << ">>(Val)\n";
Aaron Ballman682ee422013-09-11 19:47:58 +0000881 for (size_t I = 0; I < enums.size(); ++I) {
882 OS << " .Case(\"" << values[I] << "\", ";
883 OS << getAttrName() << "Attr::" << enums[I] << ")\n";
884 }
885 OS << " .Default(Optional<" << type << ">());\n";
886 OS << " if (R) {\n";
887 OS << " Out = *R;\n return true;\n }\n";
888 OS << " return false;\n";
Aaron Ballman25a2cb92014-09-15 15:14:13 +0000889 OS << " }\n\n";
890
891 // Mapping from enumeration values back to enumeration strings isn't
892 // trivial because some enumeration values have multiple named
893 // enumerators, such as type_visibility(internal) and
894 // type_visibility(hidden) both mapping to TypeVisibilityAttr::Hidden.
895 OS << " static const char *Convert" << type << "ToStr("
896 << type << " Val) {\n"
897 << " switch(Val) {\n";
George Burgess IV1881a572016-12-01 00:13:18 +0000898 SmallDenseSet<StringRef, 8> Uniques;
Aaron Ballman25a2cb92014-09-15 15:14:13 +0000899 for (size_t I = 0; I < enums.size(); ++I) {
900 if (Uniques.insert(enums[I]).second)
901 OS << " case " << getAttrName() << "Attr::" << enums[I]
902 << ": return \"" << values[I] << "\";\n";
903 }
904 OS << " }\n"
905 << " llvm_unreachable(\"No enumerator with that value\");\n"
906 << " }\n";
Aaron Ballman682ee422013-09-11 19:47:58 +0000907 }
Peter Collingbournebee583f2011-10-06 13:03:08 +0000908 };
DeLesley Hutchins210791a2013-10-04 21:28:06 +0000909
910 class VariadicEnumArgument: public VariadicArgument {
911 std::string type, QualifiedTypeName;
Craig Topper00648582017-05-31 19:01:22 +0000912 std::vector<StringRef> values, enums, uniques;
Aaron Ballman25a2cb92014-09-15 15:14:13 +0000913
914 protected:
915 void writeValueImpl(raw_ostream &OS) const override {
Aaron Ballman36d79102014-09-15 16:16:14 +0000916 // FIXME: this isn't 100% correct -- some enum arguments require printing
917 // as a string literal, while others require printing as an identifier.
918 // Tablegen currently does not distinguish between the two forms.
Aaron Ballman25a2cb92014-09-15 15:14:13 +0000919 OS << " OS << \"\\\"\" << " << getAttrName() << "Attr::Convert" << type
920 << "ToStr(Val)" << "<< \"\\\"\";\n";
921 }
922
DeLesley Hutchins210791a2013-10-04 21:28:06 +0000923 public:
Aaron Ballman2f22b942014-05-20 19:47:14 +0000924 VariadicEnumArgument(const Record &Arg, StringRef Attr)
DeLesley Hutchins210791a2013-10-04 21:28:06 +0000925 : VariadicArgument(Arg, Attr, Arg.getValueAsString("Type")),
926 type(Arg.getValueAsString("Type")),
Aaron Ballman0e468c02014-01-05 21:08:29 +0000927 values(Arg.getValueAsListOfStrings("Values")),
928 enums(Arg.getValueAsListOfStrings("Enums")),
Reid Klecknerf526b9482014-02-12 18:22:18 +0000929 uniques(uniqueEnumsInOrder(enums))
DeLesley Hutchins210791a2013-10-04 21:28:06 +0000930 {
DeLesley Hutchins210791a2013-10-04 21:28:06 +0000931 QualifiedTypeName = getAttrName().str() + "Attr::" + type;
932
933 // FIXME: Emit a proper error
934 assert(!uniques.empty());
935 }
936
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000937 bool isVariadicEnumArg() const override { return true; }
DeLesley Hutchins210791a2013-10-04 21:28:06 +0000938
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000939 void writeDeclarations(raw_ostream &OS) const override {
Eugene Zelenko5f02b772015-12-08 18:49:01 +0000940 auto i = uniques.cbegin(), e = uniques.cend();
DeLesley Hutchins210791a2013-10-04 21:28:06 +0000941 // The last one needs to not have a comma.
942 --e;
943
944 OS << "public:\n";
945 OS << " enum " << type << " {\n";
946 for (; i != e; ++i)
947 OS << " " << *i << ",\n";
948 OS << " " << *e << "\n";
949 OS << " };\n";
950 OS << "private:\n";
951
952 VariadicArgument::writeDeclarations(OS);
953 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000954
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000955 void writeDump(raw_ostream &OS) const override {
DeLesley Hutchins210791a2013-10-04 21:28:06 +0000956 OS << " for (" << getAttrName() << "Attr::" << getLowerName()
957 << "_iterator I = SA->" << getLowerName() << "_begin(), E = SA->"
958 << getLowerName() << "_end(); I != E; ++I) {\n";
959 OS << " switch(*I) {\n";
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +0000960 for (const auto &UI : uniques) {
961 OS << " case " << getAttrName() << "Attr::" << UI << ":\n";
962 OS << " OS << \" " << UI << "\";\n";
DeLesley Hutchins210791a2013-10-04 21:28:06 +0000963 OS << " break;\n";
964 }
965 OS << " }\n";
966 OS << " }\n";
967 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000968
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000969 void writePCHReadDecls(raw_ostream &OS) const override {
David L. Jones267b8842017-01-24 01:04:30 +0000970 OS << " unsigned " << getLowerName() << "Size = Record.readInt();\n";
DeLesley Hutchins210791a2013-10-04 21:28:06 +0000971 OS << " SmallVector<" << QualifiedTypeName << ", 4> " << getLowerName()
972 << ";\n";
973 OS << " " << getLowerName() << ".reserve(" << getLowerName()
974 << "Size);\n";
975 OS << " for (unsigned i = " << getLowerName() << "Size; i; --i)\n";
976 OS << " " << getLowerName() << ".push_back(" << "static_cast<"
David L. Jones267b8842017-01-24 01:04:30 +0000977 << QualifiedTypeName << ">(Record.readInt()));\n";
DeLesley Hutchins210791a2013-10-04 21:28:06 +0000978 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000979
Aaron Ballman8cbf6332014-03-06 15:09:50 +0000980 void writePCHWrite(raw_ostream &OS) const override {
DeLesley Hutchins210791a2013-10-04 21:28:06 +0000981 OS << " Record.push_back(SA->" << getLowerName() << "_size());\n";
982 OS << " for (" << getAttrName() << "Attr::" << getLowerName()
983 << "_iterator i = SA->" << getLowerName() << "_begin(), e = SA->"
984 << getLowerName() << "_end(); i != e; ++i)\n";
985 OS << " " << WritePCHRecord(QualifiedTypeName, "(*i)");
986 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +0000987
DeLesley Hutchins210791a2013-10-04 21:28:06 +0000988 void writeConversion(raw_ostream &OS) const {
989 OS << " static bool ConvertStrTo" << type << "(StringRef Val, ";
990 OS << type << " &Out) {\n";
991 OS << " Optional<" << type << "> R = llvm::StringSwitch<Optional<";
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +0000992 OS << type << ">>(Val)\n";
DeLesley Hutchins210791a2013-10-04 21:28:06 +0000993 for (size_t I = 0; I < enums.size(); ++I) {
994 OS << " .Case(\"" << values[I] << "\", ";
995 OS << getAttrName() << "Attr::" << enums[I] << ")\n";
996 }
997 OS << " .Default(Optional<" << type << ">());\n";
998 OS << " if (R) {\n";
999 OS << " Out = *R;\n return true;\n }\n";
1000 OS << " return false;\n";
Aaron Ballman25a2cb92014-09-15 15:14:13 +00001001 OS << " }\n\n";
1002
1003 OS << " static const char *Convert" << type << "ToStr("
1004 << type << " Val) {\n"
1005 << " switch(Val) {\n";
George Burgess IV1881a572016-12-01 00:13:18 +00001006 SmallDenseSet<StringRef, 8> Uniques;
Aaron Ballman25a2cb92014-09-15 15:14:13 +00001007 for (size_t I = 0; I < enums.size(); ++I) {
1008 if (Uniques.insert(enums[I]).second)
1009 OS << " case " << getAttrName() << "Attr::" << enums[I]
1010 << ": return \"" << values[I] << "\";\n";
1011 }
1012 OS << " }\n"
1013 << " llvm_unreachable(\"No enumerator with that value\");\n"
1014 << " }\n";
DeLesley Hutchins210791a2013-10-04 21:28:06 +00001015 }
1016 };
Peter Collingbournebee583f2011-10-06 13:03:08 +00001017
1018 class VersionArgument : public Argument {
1019 public:
Aaron Ballman2f22b942014-05-20 19:47:14 +00001020 VersionArgument(const Record &Arg, StringRef Attr)
Peter Collingbournebee583f2011-10-06 13:03:08 +00001021 : Argument(Arg, Attr)
1022 {}
1023
Aaron Ballman8cbf6332014-03-06 15:09:50 +00001024 void writeAccessors(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +00001025 OS << " VersionTuple get" << getUpperName() << "() const {\n";
1026 OS << " return " << getLowerName() << ";\n";
1027 OS << " }\n";
1028 OS << " void set" << getUpperName()
1029 << "(ASTContext &C, VersionTuple V) {\n";
1030 OS << " " << getLowerName() << " = V;\n";
1031 OS << " }";
1032 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +00001033
Aaron Ballman8cbf6332014-03-06 15:09:50 +00001034 void writeCloneArgs(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +00001035 OS << "get" << getUpperName() << "()";
1036 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +00001037
Aaron Ballman8cbf6332014-03-06 15:09:50 +00001038 void writeTemplateInstantiationArgs(raw_ostream &OS) const override {
DeLesley Hutchinsceec3062012-01-20 22:37:06 +00001039 OS << "A->get" << getUpperName() << "()";
1040 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +00001041
Aaron Ballman8cbf6332014-03-06 15:09:50 +00001042 void writeCtorInitializers(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +00001043 OS << getLowerName() << "(" << getUpperName() << ")";
1044 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +00001045
Aaron Ballman8cbf6332014-03-06 15:09:50 +00001046 void writeCtorDefaultInitializers(raw_ostream &OS) const override {
Aaron Ballman8ee40b72013-09-09 23:33:17 +00001047 OS << getLowerName() << "()";
1048 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +00001049
Aaron Ballman8cbf6332014-03-06 15:09:50 +00001050 void writeCtorParameters(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +00001051 OS << "VersionTuple " << getUpperName();
1052 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +00001053
Aaron Ballman8cbf6332014-03-06 15:09:50 +00001054 void writeDeclarations(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +00001055 OS << "VersionTuple " << getLowerName() << ";\n";
1056 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +00001057
Aaron Ballman8cbf6332014-03-06 15:09:50 +00001058 void writePCHReadDecls(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +00001059 OS << " VersionTuple " << getLowerName()
David L. Jones267b8842017-01-24 01:04:30 +00001060 << "= Record.readVersionTuple();\n";
Peter Collingbournebee583f2011-10-06 13:03:08 +00001061 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +00001062
Aaron Ballman8cbf6332014-03-06 15:09:50 +00001063 void writePCHReadArgs(raw_ostream &OS) const override {
Peter Collingbournebee583f2011-10-06 13:03:08 +00001064 OS << getLowerName();
1065 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +00001066
Aaron Ballman8cbf6332014-03-06 15:09:50 +00001067 void writePCHWrite(raw_ostream &OS) const override {
Richard Smith290d8012016-04-06 17:06:00 +00001068 OS << " Record.AddVersionTuple(SA->get" << getUpperName() << "());\n";
Peter Collingbournebee583f2011-10-06 13:03:08 +00001069 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +00001070
Aaron Ballman8cbf6332014-03-06 15:09:50 +00001071 void writeValue(raw_ostream &OS) const override {
Douglas Gregor49ccfaa2011-11-19 19:22:57 +00001072 OS << getLowerName() << "=\" << get" << getUpperName() << "() << \"";
1073 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +00001074
Aaron Ballman8cbf6332014-03-06 15:09:50 +00001075 void writeDump(raw_ostream &OS) const override {
Alexander Kornienko5bc364e2013-01-07 17:53:08 +00001076 OS << " OS << \" \" << SA->get" << getUpperName() << "();\n";
1077 }
Peter Collingbournebee583f2011-10-06 13:03:08 +00001078 };
DeLesley Hutchinsceec3062012-01-20 22:37:06 +00001079
1080 class ExprArgument : public SimpleArgument {
1081 public:
Aaron Ballman2f22b942014-05-20 19:47:14 +00001082 ExprArgument(const Record &Arg, StringRef Attr)
DeLesley Hutchinsceec3062012-01-20 22:37:06 +00001083 : SimpleArgument(Arg, Attr, "Expr *")
1084 {}
1085
Aaron Ballman8cbf6332014-03-06 15:09:50 +00001086 void writeASTVisitorTraversal(raw_ostream &OS) const override {
DeLesley Hutchinsc4a82432013-12-30 17:24:36 +00001087 OS << " if (!"
1088 << "getDerived().TraverseStmt(A->get" << getUpperName() << "()))\n";
1089 OS << " return false;\n";
1090 }
1091
Aaron Ballman8cbf6332014-03-06 15:09:50 +00001092 void writeTemplateInstantiationArgs(raw_ostream &OS) const override {
DeLesley Hutchinsceec3062012-01-20 22:37:06 +00001093 OS << "tempInst" << getUpperName();
1094 }
1095
Aaron Ballman8cbf6332014-03-06 15:09:50 +00001096 void writeTemplateInstantiation(raw_ostream &OS) const override {
DeLesley Hutchinsceec3062012-01-20 22:37:06 +00001097 OS << " " << getType() << " tempInst" << getUpperName() << ";\n";
1098 OS << " {\n";
1099 OS << " EnterExpressionEvaluationContext "
Faisal Valid143a0c2017-04-01 21:30:49 +00001100 << "Unevaluated(S, Sema::ExpressionEvaluationContext::Unevaluated);\n";
DeLesley Hutchinsceec3062012-01-20 22:37:06 +00001101 OS << " ExprResult " << "Result = S.SubstExpr("
1102 << "A->get" << getUpperName() << "(), TemplateArgs);\n";
1103 OS << " tempInst" << getUpperName() << " = "
Nikola Smiljanic01a75982014-05-29 10:55:11 +00001104 << "Result.getAs<Expr>();\n";
DeLesley Hutchinsceec3062012-01-20 22:37:06 +00001105 OS << " }\n";
1106 }
Alexander Kornienko5bc364e2013-01-07 17:53:08 +00001107
Craig Topper3164f332014-03-11 03:39:26 +00001108 void writeDump(raw_ostream &OS) const override {}
Alexander Kornienko5bc364e2013-01-07 17:53:08 +00001109
Aaron Ballman8cbf6332014-03-06 15:09:50 +00001110 void writeDumpChildren(raw_ostream &OS) const override {
Alexander Kornienko5bc364e2013-01-07 17:53:08 +00001111 OS << " dumpStmt(SA->get" << getUpperName() << "());\n";
1112 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +00001113
Aaron Ballman8cbf6332014-03-06 15:09:50 +00001114 void writeHasChildren(raw_ostream &OS) const override { OS << "true"; }
DeLesley Hutchinsceec3062012-01-20 22:37:06 +00001115 };
1116
1117 class VariadicExprArgument : public VariadicArgument {
1118 public:
Aaron Ballman2f22b942014-05-20 19:47:14 +00001119 VariadicExprArgument(const Record &Arg, StringRef Attr)
DeLesley Hutchinsceec3062012-01-20 22:37:06 +00001120 : VariadicArgument(Arg, Attr, "Expr *")
1121 {}
1122
Aaron Ballman8cbf6332014-03-06 15:09:50 +00001123 void writeASTVisitorTraversal(raw_ostream &OS) const override {
DeLesley Hutchinsc4a82432013-12-30 17:24:36 +00001124 OS << " {\n";
1125 OS << " " << getType() << " *I = A->" << getLowerName()
1126 << "_begin();\n";
1127 OS << " " << getType() << " *E = A->" << getLowerName()
1128 << "_end();\n";
1129 OS << " for (; I != E; ++I) {\n";
1130 OS << " if (!getDerived().TraverseStmt(*I))\n";
1131 OS << " return false;\n";
1132 OS << " }\n";
1133 OS << " }\n";
1134 }
1135
Aaron Ballman8cbf6332014-03-06 15:09:50 +00001136 void writeTemplateInstantiationArgs(raw_ostream &OS) const override {
DeLesley Hutchinsceec3062012-01-20 22:37:06 +00001137 OS << "tempInst" << getUpperName() << ", "
1138 << "A->" << getLowerName() << "_size()";
1139 }
1140
Aaron Ballman8cbf6332014-03-06 15:09:50 +00001141 void writeTemplateInstantiation(raw_ostream &OS) const override {
Eugene Zelenko5f02b772015-12-08 18:49:01 +00001142 OS << " auto *tempInst" << getUpperName()
DeLesley Hutchinsceec3062012-01-20 22:37:06 +00001143 << " = new (C, 16) " << getType()
1144 << "[A->" << getLowerName() << "_size()];\n";
1145 OS << " {\n";
1146 OS << " EnterExpressionEvaluationContext "
Faisal Valid143a0c2017-04-01 21:30:49 +00001147 << "Unevaluated(S, Sema::ExpressionEvaluationContext::Unevaluated);\n";
DeLesley Hutchinsceec3062012-01-20 22:37:06 +00001148 OS << " " << getType() << " *TI = tempInst" << getUpperName()
1149 << ";\n";
1150 OS << " " << getType() << " *I = A->" << getLowerName()
1151 << "_begin();\n";
1152 OS << " " << getType() << " *E = A->" << getLowerName()
1153 << "_end();\n";
1154 OS << " for (; I != E; ++I, ++TI) {\n";
1155 OS << " ExprResult Result = S.SubstExpr(*I, TemplateArgs);\n";
Nikola Smiljanic01a75982014-05-29 10:55:11 +00001156 OS << " *TI = Result.getAs<Expr>();\n";
DeLesley Hutchinsceec3062012-01-20 22:37:06 +00001157 OS << " }\n";
1158 OS << " }\n";
1159 }
Alexander Kornienko5bc364e2013-01-07 17:53:08 +00001160
Craig Topper3164f332014-03-11 03:39:26 +00001161 void writeDump(raw_ostream &OS) const override {}
Alexander Kornienko5bc364e2013-01-07 17:53:08 +00001162
Aaron Ballman8cbf6332014-03-06 15:09:50 +00001163 void writeDumpChildren(raw_ostream &OS) const override {
Alexander Kornienko5bc364e2013-01-07 17:53:08 +00001164 OS << " for (" << getAttrName() << "Attr::" << getLowerName()
1165 << "_iterator I = SA->" << getLowerName() << "_begin(), E = SA->"
Richard Smithf7514452014-10-30 21:02:37 +00001166 << getLowerName() << "_end(); I != E; ++I)\n";
Alexander Kornienko5bc364e2013-01-07 17:53:08 +00001167 OS << " dumpStmt(*I);\n";
Richard Trieude5cc7d2013-01-31 01:44:26 +00001168 }
1169
Aaron Ballman8cbf6332014-03-06 15:09:50 +00001170 void writeHasChildren(raw_ostream &OS) const override {
Richard Trieude5cc7d2013-01-31 01:44:26 +00001171 OS << "SA->" << getLowerName() << "_begin() != "
1172 << "SA->" << getLowerName() << "_end()";
Alexander Kornienko5bc364e2013-01-07 17:53:08 +00001173 }
DeLesley Hutchinsceec3062012-01-20 22:37:06 +00001174 };
Richard Smithb87c4652013-10-31 21:23:20 +00001175
Peter Collingbourne915df992015-05-15 18:33:32 +00001176 class VariadicStringArgument : public VariadicArgument {
1177 public:
1178 VariadicStringArgument(const Record &Arg, StringRef Attr)
Benjamin Kramer1b582012016-02-13 18:11:49 +00001179 : VariadicArgument(Arg, Attr, "StringRef")
Peter Collingbourne915df992015-05-15 18:33:32 +00001180 {}
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +00001181
Benjamin Kramer1b582012016-02-13 18:11:49 +00001182 void writeCtorBody(raw_ostream &OS) const override {
1183 OS << " for (size_t I = 0, E = " << getArgSizeName() << "; I != E;\n"
1184 " ++I) {\n"
1185 " StringRef Ref = " << getUpperName() << "[I];\n"
1186 " if (!Ref.empty()) {\n"
1187 " char *Mem = new (Ctx, 1) char[Ref.size()];\n"
1188 " std::memcpy(Mem, Ref.data(), Ref.size());\n"
1189 " " << getArgName() << "[I] = StringRef(Mem, Ref.size());\n"
1190 " }\n"
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +00001191 " }\n";
Benjamin Kramer1b582012016-02-13 18:11:49 +00001192 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +00001193
Peter Collingbourne915df992015-05-15 18:33:32 +00001194 void writeValueImpl(raw_ostream &OS) const override {
1195 OS << " OS << \"\\\"\" << Val << \"\\\"\";\n";
1196 }
1197 };
1198
Richard Smithb87c4652013-10-31 21:23:20 +00001199 class TypeArgument : public SimpleArgument {
1200 public:
Aaron Ballman2f22b942014-05-20 19:47:14 +00001201 TypeArgument(const Record &Arg, StringRef Attr)
Richard Smithb87c4652013-10-31 21:23:20 +00001202 : SimpleArgument(Arg, Attr, "TypeSourceInfo *")
1203 {}
1204
Aaron Ballman8cbf6332014-03-06 15:09:50 +00001205 void writeAccessors(raw_ostream &OS) const override {
Richard Smithb87c4652013-10-31 21:23:20 +00001206 OS << " QualType get" << getUpperName() << "() const {\n";
1207 OS << " return " << getLowerName() << "->getType();\n";
1208 OS << " }";
1209 OS << " " << getType() << " get" << getUpperName() << "Loc() const {\n";
1210 OS << " return " << getLowerName() << ";\n";
1211 OS << " }";
1212 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +00001213
Richard Smithf26d5512017-08-15 22:58:45 +00001214 void writeASTVisitorTraversal(raw_ostream &OS) const override {
1215 OS << " if (auto *TSI = A->get" << getUpperName() << "Loc())\n";
1216 OS << " if (!getDerived().TraverseTypeLoc(TSI->getTypeLoc()))\n";
1217 OS << " return false;\n";
1218 }
1219
Aaron Ballman8cbf6332014-03-06 15:09:50 +00001220 void writeTemplateInstantiationArgs(raw_ostream &OS) const override {
Richard Smithb87c4652013-10-31 21:23:20 +00001221 OS << "A->get" << getUpperName() << "Loc()";
1222 }
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +00001223
Aaron Ballman8cbf6332014-03-06 15:09:50 +00001224 void writePCHWrite(raw_ostream &OS) const override {
Richard Smithb87c4652013-10-31 21:23:20 +00001225 OS << " " << WritePCHRecord(
1226 getType(), "SA->get" + std::string(getUpperName()) + "Loc()");
1227 }
1228 };
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +00001229
Hans Wennborgdcfba332015-10-06 23:40:43 +00001230} // end anonymous namespace
Peter Collingbournebee583f2011-10-06 13:03:08 +00001231
Aaron Ballman2f22b942014-05-20 19:47:14 +00001232static std::unique_ptr<Argument>
1233createArgument(const Record &Arg, StringRef Attr,
1234 const Record *Search = nullptr) {
Peter Collingbournebee583f2011-10-06 13:03:08 +00001235 if (!Search)
1236 Search = &Arg;
1237
David Blaikie28f30ca2014-08-08 23:59:38 +00001238 std::unique_ptr<Argument> Ptr;
Peter Collingbournebee583f2011-10-06 13:03:08 +00001239 llvm::StringRef ArgName = Search->getName();
1240
David Blaikie28f30ca2014-08-08 23:59:38 +00001241 if (ArgName == "AlignedArgument")
1242 Ptr = llvm::make_unique<AlignedArgument>(Arg, Attr);
1243 else if (ArgName == "EnumArgument")
1244 Ptr = llvm::make_unique<EnumArgument>(Arg, Attr);
1245 else if (ArgName == "ExprArgument")
1246 Ptr = llvm::make_unique<ExprArgument>(Arg, Attr);
Peter Collingbournebee583f2011-10-06 13:03:08 +00001247 else if (ArgName == "FunctionArgument")
David Blaikie28f30ca2014-08-08 23:59:38 +00001248 Ptr = llvm::make_unique<SimpleArgument>(Arg, Attr, "FunctionDecl *");
Argyrios Kyrtzidisa7233bd2017-05-24 00:46:27 +00001249 else if (ArgName == "NamedArgument")
1250 Ptr = llvm::make_unique<SimpleArgument>(Arg, Attr, "NamedDecl *");
Peter Collingbournebee583f2011-10-06 13:03:08 +00001251 else if (ArgName == "IdentifierArgument")
David Blaikie28f30ca2014-08-08 23:59:38 +00001252 Ptr = llvm::make_unique<SimpleArgument>(Arg, Attr, "IdentifierInfo *");
David Majnemer4bb09802014-02-10 19:50:15 +00001253 else if (ArgName == "DefaultBoolArgument")
David Blaikie28f30ca2014-08-08 23:59:38 +00001254 Ptr = llvm::make_unique<DefaultSimpleArgument>(
1255 Arg, Attr, "bool", Arg.getValueAsBit("Default"));
1256 else if (ArgName == "BoolArgument")
1257 Ptr = llvm::make_unique<SimpleArgument>(Arg, Attr, "bool");
Aaron Ballman18a78382013-11-21 00:28:23 +00001258 else if (ArgName == "DefaultIntArgument")
David Blaikie28f30ca2014-08-08 23:59:38 +00001259 Ptr = llvm::make_unique<DefaultSimpleArgument>(
1260 Arg, Attr, "int", Arg.getValueAsInt("Default"));
1261 else if (ArgName == "IntArgument")
1262 Ptr = llvm::make_unique<SimpleArgument>(Arg, Attr, "int");
1263 else if (ArgName == "StringArgument")
1264 Ptr = llvm::make_unique<StringArgument>(Arg, Attr);
1265 else if (ArgName == "TypeArgument")
1266 Ptr = llvm::make_unique<TypeArgument>(Arg, Attr);
Peter Collingbournebee583f2011-10-06 13:03:08 +00001267 else if (ArgName == "UnsignedArgument")
David Blaikie28f30ca2014-08-08 23:59:38 +00001268 Ptr = llvm::make_unique<SimpleArgument>(Arg, Attr, "unsigned");
Peter Collingbournebee583f2011-10-06 13:03:08 +00001269 else if (ArgName == "VariadicUnsignedArgument")
David Blaikie28f30ca2014-08-08 23:59:38 +00001270 Ptr = llvm::make_unique<VariadicArgument>(Arg, Attr, "unsigned");
Peter Collingbourne915df992015-05-15 18:33:32 +00001271 else if (ArgName == "VariadicStringArgument")
1272 Ptr = llvm::make_unique<VariadicStringArgument>(Arg, Attr);
DeLesley Hutchins210791a2013-10-04 21:28:06 +00001273 else if (ArgName == "VariadicEnumArgument")
David Blaikie28f30ca2014-08-08 23:59:38 +00001274 Ptr = llvm::make_unique<VariadicEnumArgument>(Arg, Attr);
Peter Collingbournebee583f2011-10-06 13:03:08 +00001275 else if (ArgName == "VariadicExprArgument")
David Blaikie28f30ca2014-08-08 23:59:38 +00001276 Ptr = llvm::make_unique<VariadicExprArgument>(Arg, Attr);
Joel E. Denny81508102018-03-13 14:51:22 +00001277 else if (ArgName == "VariadicParamIdxArgument")
1278 Ptr = llvm::make_unique<VariadicParamIdxArgument>(Arg, Attr);
1279 else if (ArgName == "ParamIdxArgument")
1280 Ptr = llvm::make_unique<SimpleArgument>(Arg, Attr, "ParamIdx");
Peter Collingbournebee583f2011-10-06 13:03:08 +00001281 else if (ArgName == "VersionArgument")
David Blaikie28f30ca2014-08-08 23:59:38 +00001282 Ptr = llvm::make_unique<VersionArgument>(Arg, Attr);
Peter Collingbournebee583f2011-10-06 13:03:08 +00001283
1284 if (!Ptr) {
Aaron Ballman18a78382013-11-21 00:28:23 +00001285 // Search in reverse order so that the most-derived type is handled first.
Craig Topper25761242016-01-18 19:52:54 +00001286 ArrayRef<std::pair<Record*, SMRange>> Bases = Search->getSuperClasses();
David Majnemerf7e36092016-06-23 00:15:04 +00001287 for (const auto &Base : llvm::reverse(Bases)) {
Craig Topper25761242016-01-18 19:52:54 +00001288 if ((Ptr = createArgument(Arg, Attr, Base.first)))
Peter Collingbournebee583f2011-10-06 13:03:08 +00001289 break;
1290 }
1291 }
Aaron Ballman8ee40b72013-09-09 23:33:17 +00001292
1293 if (Ptr && Arg.getValueAsBit("Optional"))
1294 Ptr->setOptional(true);
1295
John McCalla62c1a92015-10-28 00:17:34 +00001296 if (Ptr && Arg.getValueAsBit("Fake"))
1297 Ptr->setFake(true);
1298
David Blaikie28f30ca2014-08-08 23:59:38 +00001299 return Ptr;
Peter Collingbournebee583f2011-10-06 13:03:08 +00001300}
1301
Douglas Gregor49ccfaa2011-11-19 19:22:57 +00001302static void writeAvailabilityValue(raw_ostream &OS) {
1303 OS << "\" << getPlatform()->getName();\n"
Manman Ren42e09eb2016-03-10 23:54:12 +00001304 << " if (getStrict()) OS << \", strict\";\n"
Douglas Gregor49ccfaa2011-11-19 19:22:57 +00001305 << " if (!getIntroduced().empty()) OS << \", introduced=\" << getIntroduced();\n"
1306 << " if (!getDeprecated().empty()) OS << \", deprecated=\" << getDeprecated();\n"
1307 << " if (!getObsoleted().empty()) OS << \", obsoleted=\" << getObsoleted();\n"
1308 << " if (getUnavailable()) OS << \", unavailable\";\n"
1309 << " OS << \"";
1310}
1311
Manman Renc7890fe2016-03-16 18:50:49 +00001312static void writeDeprecatedAttrValue(raw_ostream &OS, std::string &Variety) {
1313 OS << "\\\"\" << getMessage() << \"\\\"\";\n";
1314 // Only GNU deprecated has an optional fixit argument at the second position.
1315 if (Variety == "GNU")
1316 OS << " if (!getReplacement().empty()) OS << \", \\\"\""
1317 " << getReplacement() << \"\\\"\";\n";
1318 OS << " OS << \"";
1319}
1320
Aaron Ballman3e424b52013-12-26 18:30:57 +00001321static void writeGetSpellingFunction(Record &R, raw_ostream &OS) {
Aaron Ballmanc669cc02014-01-27 22:10:04 +00001322 std::vector<FlattenedSpelling> Spellings = GetFlattenedSpellings(R);
Aaron Ballman3e424b52013-12-26 18:30:57 +00001323
1324 OS << "const char *" << R.getName() << "Attr::getSpelling() const {\n";
1325 if (Spellings.empty()) {
1326 OS << " return \"(No spelling)\";\n}\n\n";
1327 return;
1328 }
1329
1330 OS << " switch (SpellingListIndex) {\n"
1331 " default:\n"
1332 " llvm_unreachable(\"Unknown attribute spelling!\");\n"
1333 " return \"(No spelling)\";\n";
1334
1335 for (unsigned I = 0; I < Spellings.size(); ++I)
1336 OS << " case " << I << ":\n"
Aaron Ballmanc669cc02014-01-27 22:10:04 +00001337 " return \"" << Spellings[I].name() << "\";\n";
Aaron Ballman3e424b52013-12-26 18:30:57 +00001338 // End of the switch statement.
1339 OS << " }\n";
1340 // End of the getSpelling function.
1341 OS << "}\n\n";
1342}
1343
Aaron Ballman8f1439b2014-03-05 16:49:55 +00001344static void
1345writePrettyPrintFunction(Record &R,
1346 const std::vector<std::unique_ptr<Argument>> &Args,
1347 raw_ostream &OS) {
Aaron Ballmanc669cc02014-01-27 22:10:04 +00001348 std::vector<FlattenedSpelling> Spellings = GetFlattenedSpellings(R);
Michael Han99315932013-01-24 16:46:58 +00001349
1350 OS << "void " << R.getName() << "Attr::printPretty("
1351 << "raw_ostream &OS, const PrintingPolicy &Policy) const {\n";
1352
Tyler Nowickie8b07ed2014-06-13 17:57:25 +00001353 if (Spellings.empty()) {
Michael Han99315932013-01-24 16:46:58 +00001354 OS << "}\n\n";
1355 return;
1356 }
1357
1358 OS <<
1359 " switch (SpellingListIndex) {\n"
1360 " default:\n"
1361 " llvm_unreachable(\"Unknown attribute spelling!\");\n"
1362 " break;\n";
1363
1364 for (unsigned I = 0; I < Spellings.size(); ++ I) {
1365 llvm::SmallString<16> Prefix;
1366 llvm::SmallString<8> Suffix;
1367 // The actual spelling of the name and namespace (if applicable)
1368 // of an attribute without considering prefix and suffix.
1369 llvm::SmallString<64> Spelling;
Aaron Ballmanc669cc02014-01-27 22:10:04 +00001370 std::string Name = Spellings[I].name();
1371 std::string Variety = Spellings[I].variety();
Michael Han99315932013-01-24 16:46:58 +00001372
1373 if (Variety == "GNU") {
1374 Prefix = " __attribute__((";
1375 Suffix = "))";
Aaron Ballman606093a2017-10-15 15:01:42 +00001376 } else if (Variety == "CXX11" || Variety == "C2x") {
Michael Han99315932013-01-24 16:46:58 +00001377 Prefix = " [[";
1378 Suffix = "]]";
Aaron Ballmanc669cc02014-01-27 22:10:04 +00001379 std::string Namespace = Spellings[I].nameSpace();
Tyler Nowickie8b07ed2014-06-13 17:57:25 +00001380 if (!Namespace.empty()) {
Michael Han99315932013-01-24 16:46:58 +00001381 Spelling += Namespace;
1382 Spelling += "::";
1383 }
1384 } else if (Variety == "Declspec") {
1385 Prefix = " __declspec(";
1386 Suffix = ")";
Nico Weber20e08042016-09-03 02:55:10 +00001387 } else if (Variety == "Microsoft") {
1388 Prefix = "[";
1389 Suffix = "]";
Richard Smith0cdcc982013-01-29 01:24:26 +00001390 } else if (Variety == "Keyword") {
1391 Prefix = " ";
1392 Suffix = "";
Tyler Nowickie8b07ed2014-06-13 17:57:25 +00001393 } else if (Variety == "Pragma") {
1394 Prefix = "#pragma ";
1395 Suffix = "\n";
1396 std::string Namespace = Spellings[I].nameSpace();
1397 if (!Namespace.empty()) {
1398 Spelling += Namespace;
1399 Spelling += " ";
1400 }
Michael Han99315932013-01-24 16:46:58 +00001401 } else {
Richard Smith0cdcc982013-01-29 01:24:26 +00001402 llvm_unreachable("Unknown attribute syntax variety!");
Michael Han99315932013-01-24 16:46:58 +00001403 }
1404
1405 Spelling += Name;
1406
1407 OS <<
1408 " case " << I << " : {\n"
Yaron Keren09fb7c62015-03-10 07:33:23 +00001409 " OS << \"" << Prefix << Spelling;
Michael Han99315932013-01-24 16:46:58 +00001410
Tyler Nowickie8b07ed2014-06-13 17:57:25 +00001411 if (Variety == "Pragma") {
Alexey Bataevcbecfdf2018-02-14 17:38:47 +00001412 OS << "\";\n";
Tyler Nowickie8b07ed2014-06-13 17:57:25 +00001413 OS << " printPrettyPragma(OS, Policy);\n";
Alexey Bataev6d455322015-10-12 06:59:48 +00001414 OS << " OS << \"\\n\";";
Tyler Nowickie8b07ed2014-06-13 17:57:25 +00001415 OS << " break;\n";
1416 OS << " }\n";
1417 continue;
1418 }
1419
Michael Han99315932013-01-24 16:46:58 +00001420 if (Spelling == "availability") {
Aaron Ballman48a533d2018-02-27 23:49:28 +00001421 OS << "(";
Michael Han99315932013-01-24 16:46:58 +00001422 writeAvailabilityValue(OS);
Aaron Ballman48a533d2018-02-27 23:49:28 +00001423 OS << ")";
Manman Renc7890fe2016-03-16 18:50:49 +00001424 } else if (Spelling == "deprecated" || Spelling == "gnu::deprecated") {
Aaron Ballman48a533d2018-02-27 23:49:28 +00001425 OS << "(";
1426 writeDeprecatedAttrValue(OS, Variety);
1427 OS << ")";
Michael Han99315932013-01-24 16:46:58 +00001428 } else {
Aaron Ballman48a533d2018-02-27 23:49:28 +00001429 // To avoid printing parentheses around an empty argument list or
1430 // printing spurious commas at the end of an argument list, we need to
1431 // determine where the last provided non-fake argument is.
1432 unsigned NonFakeArgs = 0;
1433 unsigned TrailingOptArgs = 0;
1434 bool FoundNonOptArg = false;
1435 for (const auto &arg : llvm::reverse(Args)) {
1436 if (arg->isFake())
1437 continue;
1438 ++NonFakeArgs;
1439 if (FoundNonOptArg)
1440 continue;
1441 // FIXME: arg->getIsOmitted() == "false" means we haven't implemented
1442 // any way to detect whether the argument was omitted.
1443 if (!arg->isOptional() || arg->getIsOmitted() == "false") {
1444 FoundNonOptArg = true;
1445 continue;
1446 }
1447 if (!TrailingOptArgs++)
1448 OS << "\";\n"
1449 << " unsigned TrailingOmittedArgs = 0;\n";
1450 OS << " if (" << arg->getIsOmitted() << ")\n"
1451 << " ++TrailingOmittedArgs;\n";
Michael Han99315932013-01-24 16:46:58 +00001452 }
Aaron Ballman48a533d2018-02-27 23:49:28 +00001453 if (TrailingOptArgs)
1454 OS << " OS << \"";
1455 if (TrailingOptArgs < NonFakeArgs)
1456 OS << "(";
1457 else if (TrailingOptArgs)
1458 OS << "\";\n"
1459 << " if (TrailingOmittedArgs < " << NonFakeArgs << ")\n"
1460 << " OS << \"(\";\n"
1461 << " OS << \"";
1462 unsigned ArgIndex = 0;
1463 for (const auto &arg : Args) {
1464 if (arg->isFake())
1465 continue;
1466 if (ArgIndex) {
1467 if (ArgIndex >= NonFakeArgs - TrailingOptArgs)
1468 OS << "\";\n"
1469 << " if (" << ArgIndex << " < " << NonFakeArgs
1470 << " - TrailingOmittedArgs)\n"
1471 << " OS << \", \";\n"
1472 << " OS << \"";
1473 else
1474 OS << ", ";
1475 }
1476 std::string IsOmitted = arg->getIsOmitted();
1477 if (arg->isOptional() && IsOmitted != "false")
1478 OS << "\";\n"
1479 << " if (!(" << IsOmitted << ")) {\n"
1480 << " OS << \"";
1481 arg->writeValue(OS);
1482 if (arg->isOptional() && IsOmitted != "false")
1483 OS << "\";\n"
1484 << " }\n"
1485 << " OS << \"";
1486 ++ArgIndex;
1487 }
1488 if (TrailingOptArgs < NonFakeArgs)
1489 OS << ")";
1490 else if (TrailingOptArgs)
1491 OS << "\";\n"
1492 << " if (TrailingOmittedArgs < " << NonFakeArgs << ")\n"
1493 << " OS << \")\";\n"
1494 << " OS << \"";
Michael Han99315932013-01-24 16:46:58 +00001495 }
1496
Yaron Keren09fb7c62015-03-10 07:33:23 +00001497 OS << Suffix + "\";\n";
Michael Han99315932013-01-24 16:46:58 +00001498
1499 OS <<
1500 " break;\n"
1501 " }\n";
1502 }
1503
1504 // End of the switch statement.
1505 OS << "}\n";
1506 // End of the print function.
1507 OS << "}\n\n";
1508}
1509
Michael Hanaf02bbe2013-02-01 01:19:17 +00001510/// \brief Return the index of a spelling in a spelling list.
Aaron Ballmanc669cc02014-01-27 22:10:04 +00001511static unsigned
1512getSpellingListIndex(const std::vector<FlattenedSpelling> &SpellingList,
1513 const FlattenedSpelling &Spelling) {
Alexander Kornienko6ee521c2015-01-23 15:36:10 +00001514 assert(!SpellingList.empty() && "Spelling list is empty!");
Michael Hanaf02bbe2013-02-01 01:19:17 +00001515
1516 for (unsigned Index = 0; Index < SpellingList.size(); ++Index) {
Aaron Ballmanc669cc02014-01-27 22:10:04 +00001517 const FlattenedSpelling &S = SpellingList[Index];
1518 if (S.variety() != Spelling.variety())
Michael Hanaf02bbe2013-02-01 01:19:17 +00001519 continue;
Aaron Ballmanc669cc02014-01-27 22:10:04 +00001520 if (S.nameSpace() != Spelling.nameSpace())
Michael Hanaf02bbe2013-02-01 01:19:17 +00001521 continue;
Aaron Ballmanc669cc02014-01-27 22:10:04 +00001522 if (S.name() != Spelling.name())
Michael Hanaf02bbe2013-02-01 01:19:17 +00001523 continue;
1524
1525 return Index;
1526 }
1527
1528 llvm_unreachable("Unknown spelling!");
1529}
1530
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +00001531static void writeAttrAccessorDefinition(const Record &R, raw_ostream &OS) {
Michael Hanaf02bbe2013-02-01 01:19:17 +00001532 std::vector<Record*> Accessors = R.getValueAsListOfDefs("Accessors");
George Burgess IV1881a572016-12-01 00:13:18 +00001533 if (Accessors.empty())
1534 return;
1535
1536 const std::vector<FlattenedSpelling> SpellingList = GetFlattenedSpellings(R);
1537 assert(!SpellingList.empty() &&
1538 "Attribute with empty spelling list can't have accessors!");
Aaron Ballman2f22b942014-05-20 19:47:14 +00001539 for (const auto *Accessor : Accessors) {
Erich Keane3bff4142017-10-16 23:25:24 +00001540 const StringRef Name = Accessor->getValueAsString("Name");
George Burgess IV1881a572016-12-01 00:13:18 +00001541 std::vector<FlattenedSpelling> Spellings = GetFlattenedSpellings(*Accessor);
Michael Hanaf02bbe2013-02-01 01:19:17 +00001542
1543 OS << " bool " << Name << "() const { return SpellingListIndex == ";
1544 for (unsigned Index = 0; Index < Spellings.size(); ++Index) {
Aaron Ballmanc669cc02014-01-27 22:10:04 +00001545 OS << getSpellingListIndex(SpellingList, Spellings[Index]);
George Burgess IV1881a572016-12-01 00:13:18 +00001546 if (Index != Spellings.size() - 1)
Michael Hanaf02bbe2013-02-01 01:19:17 +00001547 OS << " ||\n SpellingListIndex == ";
1548 else
1549 OS << "; }\n";
1550 }
1551 }
1552}
1553
Aaron Ballmanc669cc02014-01-27 22:10:04 +00001554static bool
1555SpellingNamesAreCommon(const std::vector<FlattenedSpelling>& Spellings) {
Aaron Ballman36a53502014-01-16 13:03:14 +00001556 assert(!Spellings.empty() && "An empty list of spellings was provided");
1557 std::string FirstName = NormalizeNameForSpellingComparison(
Aaron Ballmanc669cc02014-01-27 22:10:04 +00001558 Spellings.front().name());
Aaron Ballman2f22b942014-05-20 19:47:14 +00001559 for (const auto &Spelling :
1560 llvm::make_range(std::next(Spellings.begin()), Spellings.end())) {
1561 std::string Name = NormalizeNameForSpellingComparison(Spelling.name());
Aaron Ballman36a53502014-01-16 13:03:14 +00001562 if (Name != FirstName)
1563 return false;
1564 }
1565 return true;
1566}
1567
Aaron Ballman81cb8cb2014-01-24 21:32:49 +00001568typedef std::map<unsigned, std::string> SemanticSpellingMap;
1569static std::string
Aaron Ballmanc669cc02014-01-27 22:10:04 +00001570CreateSemanticSpellings(const std::vector<FlattenedSpelling> &Spellings,
Aaron Ballman81cb8cb2014-01-24 21:32:49 +00001571 SemanticSpellingMap &Map) {
1572 // The enumerants are automatically generated based on the variety,
1573 // namespace (if present) and name for each attribute spelling. However,
1574 // care is taken to avoid trampling on the reserved namespace due to
1575 // underscores.
1576 std::string Ret(" enum Spelling {\n");
1577 std::set<std::string> Uniques;
1578 unsigned Idx = 0;
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +00001579 for (auto I = Spellings.begin(), E = Spellings.end(); I != E; ++I, ++Idx) {
Aaron Ballmanc669cc02014-01-27 22:10:04 +00001580 const FlattenedSpelling &S = *I;
Benjamin Kramer2e018ef2016-05-27 13:36:58 +00001581 const std::string &Variety = S.variety();
1582 const std::string &Spelling = S.name();
1583 const std::string &Namespace = S.nameSpace();
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +00001584 std::string EnumName;
Aaron Ballman81cb8cb2014-01-24 21:32:49 +00001585
Aaron Ballman81cb8cb2014-01-24 21:32:49 +00001586 EnumName += (Variety + "_");
1587 if (!Namespace.empty())
1588 EnumName += (NormalizeNameForSpellingComparison(Namespace).str() +
1589 "_");
1590 EnumName += NormalizeNameForSpellingComparison(Spelling);
1591
1592 // Even if the name is not unique, this spelling index corresponds to a
1593 // particular enumerant name that we've calculated.
1594 Map[Idx] = EnumName;
1595
1596 // Since we have been stripping underscores to avoid trampling on the
1597 // reserved namespace, we may have inadvertently created duplicate
1598 // enumerant names. These duplicates are not considered part of the
1599 // semantic spelling, and can be elided.
1600 if (Uniques.find(EnumName) != Uniques.end())
1601 continue;
1602
1603 Uniques.insert(EnumName);
1604 if (I != Spellings.begin())
1605 Ret += ",\n";
Aaron Ballman9bf6b752015-03-10 17:19:18 +00001606 // Duplicate spellings are not considered part of the semantic spelling
1607 // enumeration, but the spelling index and semantic spelling values are
1608 // meant to be equivalent, so we must specify a concrete value for each
1609 // enumerator.
1610 Ret += " " + EnumName + " = " + llvm::utostr(Idx);
Aaron Ballman81cb8cb2014-01-24 21:32:49 +00001611 }
1612 Ret += "\n };\n\n";
1613 return Ret;
1614}
1615
1616void WriteSemanticSpellingSwitch(const std::string &VarName,
1617 const SemanticSpellingMap &Map,
1618 raw_ostream &OS) {
1619 OS << " switch (" << VarName << ") {\n default: "
1620 << "llvm_unreachable(\"Unknown spelling list index\");\n";
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +00001621 for (const auto &I : Map)
1622 OS << " case " << I.first << ": return " << I.second << ";\n";
Aaron Ballman81cb8cb2014-01-24 21:32:49 +00001623 OS << " }\n";
1624}
1625
Aaron Ballman35db2b32014-01-29 22:13:45 +00001626// Emits the LateParsed property for attributes.
1627static void emitClangAttrLateParsedList(RecordKeeper &Records, raw_ostream &OS) {
1628 OS << "#if defined(CLANG_ATTR_LATE_PARSED_LIST)\n";
1629 std::vector<Record*> Attrs = Records.getAllDerivedDefinitions("Attr");
1630
Aaron Ballman2f22b942014-05-20 19:47:14 +00001631 for (const auto *Attr : Attrs) {
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +00001632 bool LateParsed = Attr->getValueAsBit("LateParsed");
Aaron Ballman35db2b32014-01-29 22:13:45 +00001633
1634 if (LateParsed) {
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +00001635 std::vector<FlattenedSpelling> Spellings = GetFlattenedSpellings(*Attr);
Aaron Ballman35db2b32014-01-29 22:13:45 +00001636
1637 // FIXME: Handle non-GNU attributes
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +00001638 for (const auto &I : Spellings) {
1639 if (I.variety() != "GNU")
Aaron Ballman35db2b32014-01-29 22:13:45 +00001640 continue;
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +00001641 OS << ".Case(\"" << I.name() << "\", " << LateParsed << ")\n";
Aaron Ballman35db2b32014-01-29 22:13:45 +00001642 }
1643 }
1644 }
1645 OS << "#endif // CLANG_ATTR_LATE_PARSED_LIST\n\n";
1646}
1647
Alex Lorenz9e7bf162017-04-18 14:33:39 +00001648static bool hasGNUorCXX11Spelling(const Record &Attribute) {
1649 std::vector<FlattenedSpelling> Spellings = GetFlattenedSpellings(Attribute);
1650 for (const auto &I : Spellings) {
1651 if (I.variety() == "GNU" || I.variety() == "CXX11")
1652 return true;
1653 }
1654 return false;
1655}
1656
1657namespace {
1658
1659struct AttributeSubjectMatchRule {
1660 const Record *MetaSubject;
1661 const Record *Constraint;
1662
1663 AttributeSubjectMatchRule(const Record *MetaSubject, const Record *Constraint)
1664 : MetaSubject(MetaSubject), Constraint(Constraint) {
1665 assert(MetaSubject && "Missing subject");
1666 }
1667
1668 bool isSubRule() const { return Constraint != nullptr; }
1669
1670 std::vector<Record *> getSubjects() const {
1671 return (Constraint ? Constraint : MetaSubject)
1672 ->getValueAsListOfDefs("Subjects");
1673 }
1674
1675 std::vector<Record *> getLangOpts() const {
1676 if (Constraint) {
1677 // Lookup the options in the sub-rule first, in case the sub-rule
1678 // overrides the rules options.
1679 std::vector<Record *> Opts = Constraint->getValueAsListOfDefs("LangOpts");
1680 if (!Opts.empty())
1681 return Opts;
1682 }
1683 return MetaSubject->getValueAsListOfDefs("LangOpts");
1684 }
1685
1686 // Abstract rules are used only for sub-rules
1687 bool isAbstractRule() const { return getSubjects().empty(); }
1688
Erich Keane3bff4142017-10-16 23:25:24 +00001689 StringRef getName() const {
Alex Lorenz9e7bf162017-04-18 14:33:39 +00001690 return (Constraint ? Constraint : MetaSubject)->getValueAsString("Name");
1691 }
1692
1693 bool isNegatedSubRule() const {
1694 assert(isSubRule() && "Not a sub-rule");
1695 return Constraint->getValueAsBit("Negated");
1696 }
1697
1698 std::string getSpelling() const {
1699 std::string Result = MetaSubject->getValueAsString("Name");
1700 if (isSubRule()) {
1701 Result += '(';
1702 if (isNegatedSubRule())
1703 Result += "unless(";
1704 Result += getName();
1705 if (isNegatedSubRule())
1706 Result += ')';
1707 Result += ')';
1708 }
1709 return Result;
1710 }
1711
1712 std::string getEnumValueName() const {
Craig Topper00648582017-05-31 19:01:22 +00001713 SmallString<128> Result;
1714 Result += "SubjectMatchRule_";
1715 Result += MetaSubject->getValueAsString("Name");
Alex Lorenz9e7bf162017-04-18 14:33:39 +00001716 if (isSubRule()) {
1717 Result += "_";
1718 if (isNegatedSubRule())
1719 Result += "not_";
1720 Result += Constraint->getValueAsString("Name");
1721 }
1722 if (isAbstractRule())
1723 Result += "_abstract";
Craig Topper00648582017-05-31 19:01:22 +00001724 return Result.str();
Alex Lorenz9e7bf162017-04-18 14:33:39 +00001725 }
1726
1727 std::string getEnumValue() const { return "attr::" + getEnumValueName(); }
1728
1729 static const char *EnumName;
1730};
1731
1732const char *AttributeSubjectMatchRule::EnumName = "attr::SubjectMatchRule";
1733
1734struct PragmaClangAttributeSupport {
1735 std::vector<AttributeSubjectMatchRule> Rules;
Alex Lorenz24952fb2017-04-19 15:52:11 +00001736
1737 class RuleOrAggregateRuleSet {
1738 std::vector<AttributeSubjectMatchRule> Rules;
1739 bool IsRule;
1740 RuleOrAggregateRuleSet(ArrayRef<AttributeSubjectMatchRule> Rules,
1741 bool IsRule)
1742 : Rules(Rules), IsRule(IsRule) {}
1743
1744 public:
1745 bool isRule() const { return IsRule; }
1746
1747 const AttributeSubjectMatchRule &getRule() const {
1748 assert(IsRule && "not a rule!");
1749 return Rules[0];
1750 }
1751
1752 ArrayRef<AttributeSubjectMatchRule> getAggregateRuleSet() const {
1753 return Rules;
1754 }
1755
1756 static RuleOrAggregateRuleSet
1757 getRule(const AttributeSubjectMatchRule &Rule) {
1758 return RuleOrAggregateRuleSet(Rule, /*IsRule=*/true);
1759 }
1760 static RuleOrAggregateRuleSet
1761 getAggregateRuleSet(ArrayRef<AttributeSubjectMatchRule> Rules) {
1762 return RuleOrAggregateRuleSet(Rules, /*IsRule=*/false);
1763 }
1764 };
1765 llvm::DenseMap<const Record *, RuleOrAggregateRuleSet> SubjectsToRules;
Alex Lorenz9e7bf162017-04-18 14:33:39 +00001766
1767 PragmaClangAttributeSupport(RecordKeeper &Records);
1768
1769 bool isAttributedSupported(const Record &Attribute);
1770
1771 void emitMatchRuleList(raw_ostream &OS);
1772
1773 std::string generateStrictConformsTo(const Record &Attr, raw_ostream &OS);
1774
1775 void generateParsingHelpers(raw_ostream &OS);
1776};
1777
1778} // end anonymous namespace
1779
Alex Lorenz24952fb2017-04-19 15:52:11 +00001780static bool doesDeclDeriveFrom(const Record *D, const Record *Base) {
1781 const Record *CurrentBase = D->getValueAsDef("Base");
1782 if (!CurrentBase)
1783 return false;
1784 if (CurrentBase == Base)
1785 return true;
1786 return doesDeclDeriveFrom(CurrentBase, Base);
1787}
1788
Alex Lorenz9e7bf162017-04-18 14:33:39 +00001789PragmaClangAttributeSupport::PragmaClangAttributeSupport(
1790 RecordKeeper &Records) {
1791 std::vector<Record *> MetaSubjects =
1792 Records.getAllDerivedDefinitions("AttrSubjectMatcherRule");
1793 auto MapFromSubjectsToRules = [this](const Record *SubjectContainer,
1794 const Record *MetaSubject,
Saleem Abdulrasoolbe4773c2017-05-01 00:26:59 +00001795 const Record *Constraint) {
Alex Lorenz9e7bf162017-04-18 14:33:39 +00001796 Rules.emplace_back(MetaSubject, Constraint);
1797 std::vector<Record *> ApplicableSubjects =
1798 SubjectContainer->getValueAsListOfDefs("Subjects");
1799 for (const auto *Subject : ApplicableSubjects) {
1800 bool Inserted =
Alex Lorenz24952fb2017-04-19 15:52:11 +00001801 SubjectsToRules
1802 .try_emplace(Subject, RuleOrAggregateRuleSet::getRule(
1803 AttributeSubjectMatchRule(MetaSubject,
1804 Constraint)))
1805 .second;
Alex Lorenz9e7bf162017-04-18 14:33:39 +00001806 if (!Inserted) {
1807 PrintFatalError("Attribute subject match rules should not represent"
1808 "same attribute subjects.");
1809 }
1810 }
1811 };
1812 for (const auto *MetaSubject : MetaSubjects) {
Saleem Abdulrasoolbe4773c2017-05-01 00:26:59 +00001813 MapFromSubjectsToRules(MetaSubject, MetaSubject, /*Constraints=*/nullptr);
Alex Lorenz9e7bf162017-04-18 14:33:39 +00001814 std::vector<Record *> Constraints =
1815 MetaSubject->getValueAsListOfDefs("Constraints");
1816 for (const auto *Constraint : Constraints)
1817 MapFromSubjectsToRules(Constraint, MetaSubject, Constraint);
1818 }
Alex Lorenz24952fb2017-04-19 15:52:11 +00001819
1820 std::vector<Record *> Aggregates =
1821 Records.getAllDerivedDefinitions("AttrSubjectMatcherAggregateRule");
1822 std::vector<Record *> DeclNodes = Records.getAllDerivedDefinitions("DDecl");
1823 for (const auto *Aggregate : Aggregates) {
1824 Record *SubjectDecl = Aggregate->getValueAsDef("Subject");
1825
1826 // Gather sub-classes of the aggregate subject that act as attribute
1827 // subject rules.
1828 std::vector<AttributeSubjectMatchRule> Rules;
1829 for (const auto *D : DeclNodes) {
1830 if (doesDeclDeriveFrom(D, SubjectDecl)) {
1831 auto It = SubjectsToRules.find(D);
1832 if (It == SubjectsToRules.end())
1833 continue;
1834 if (!It->second.isRule() || It->second.getRule().isSubRule())
1835 continue; // Assume that the rule will be included as well.
1836 Rules.push_back(It->second.getRule());
1837 }
1838 }
1839
1840 bool Inserted =
1841 SubjectsToRules
1842 .try_emplace(SubjectDecl,
1843 RuleOrAggregateRuleSet::getAggregateRuleSet(Rules))
1844 .second;
1845 if (!Inserted) {
1846 PrintFatalError("Attribute subject match rules should not represent"
1847 "same attribute subjects.");
1848 }
1849 }
Alex Lorenz9e7bf162017-04-18 14:33:39 +00001850}
1851
1852static PragmaClangAttributeSupport &
1853getPragmaAttributeSupport(RecordKeeper &Records) {
1854 static PragmaClangAttributeSupport Instance(Records);
1855 return Instance;
1856}
1857
1858void PragmaClangAttributeSupport::emitMatchRuleList(raw_ostream &OS) {
1859 OS << "#ifndef ATTR_MATCH_SUB_RULE\n";
1860 OS << "#define ATTR_MATCH_SUB_RULE(Value, Spelling, IsAbstract, Parent, "
1861 "IsNegated) "
1862 << "ATTR_MATCH_RULE(Value, Spelling, IsAbstract)\n";
1863 OS << "#endif\n";
1864 for (const auto &Rule : Rules) {
1865 OS << (Rule.isSubRule() ? "ATTR_MATCH_SUB_RULE" : "ATTR_MATCH_RULE") << '(';
1866 OS << Rule.getEnumValueName() << ", \"" << Rule.getSpelling() << "\", "
1867 << Rule.isAbstractRule();
1868 if (Rule.isSubRule())
1869 OS << ", "
1870 << AttributeSubjectMatchRule(Rule.MetaSubject, nullptr).getEnumValue()
1871 << ", " << Rule.isNegatedSubRule();
1872 OS << ")\n";
1873 }
1874 OS << "#undef ATTR_MATCH_SUB_RULE\n";
1875}
1876
1877bool PragmaClangAttributeSupport::isAttributedSupported(
1878 const Record &Attribute) {
1879 if (Attribute.getValueAsBit("ForcePragmaAttributeSupport"))
1880 return true;
1881 // Opt-out rules:
1882 // FIXME: The documentation check should be moved before
1883 // the ForcePragmaAttributeSupport check after annotate is documented.
1884 // No documentation present.
1885 if (Attribute.isValueUnset("Documentation"))
1886 return false;
1887 std::vector<Record *> Docs = Attribute.getValueAsListOfDefs("Documentation");
1888 if (Docs.empty())
1889 return false;
1890 if (Docs.size() == 1 && Docs[0]->getName() == "Undocumented")
1891 return false;
1892 // An attribute requires delayed parsing (LateParsed is on)
1893 if (Attribute.getValueAsBit("LateParsed"))
1894 return false;
1895 // An attribute has no GNU/CXX11 spelling
1896 if (!hasGNUorCXX11Spelling(Attribute))
1897 return false;
1898 // An attribute subject list has a subject that isn't covered by one of the
1899 // subject match rules or has no subjects at all.
1900 if (Attribute.isValueUnset("Subjects"))
1901 return false;
1902 const Record *SubjectObj = Attribute.getValueAsDef("Subjects");
1903 std::vector<Record *> Subjects = SubjectObj->getValueAsListOfDefs("Subjects");
1904 if (Subjects.empty())
1905 return false;
1906 for (const auto *Subject : Subjects) {
1907 if (SubjectsToRules.find(Subject) == SubjectsToRules.end())
1908 return false;
1909 }
1910 return true;
1911}
1912
1913std::string
1914PragmaClangAttributeSupport::generateStrictConformsTo(const Record &Attr,
1915 raw_ostream &OS) {
1916 if (!isAttributedSupported(Attr))
1917 return "nullptr";
1918 // Generate a function that constructs a set of matching rules that describe
1919 // to which declarations the attribute should apply to.
1920 std::string FnName = "matchRulesFor" + Attr.getName().str();
Erich Keane3bff4142017-10-16 23:25:24 +00001921 OS << "static void " << FnName << "(llvm::SmallVectorImpl<std::pair<"
Alex Lorenz9e7bf162017-04-18 14:33:39 +00001922 << AttributeSubjectMatchRule::EnumName
1923 << ", bool>> &MatchRules, const LangOptions &LangOpts) {\n";
1924 if (Attr.isValueUnset("Subjects")) {
Erich Keane3bff4142017-10-16 23:25:24 +00001925 OS << "}\n\n";
Alex Lorenz9e7bf162017-04-18 14:33:39 +00001926 return FnName;
1927 }
1928 const Record *SubjectObj = Attr.getValueAsDef("Subjects");
1929 std::vector<Record *> Subjects = SubjectObj->getValueAsListOfDefs("Subjects");
1930 for (const auto *Subject : Subjects) {
1931 auto It = SubjectsToRules.find(Subject);
1932 assert(It != SubjectsToRules.end() &&
1933 "This attribute is unsupported by #pragma clang attribute");
Alex Lorenz24952fb2017-04-19 15:52:11 +00001934 for (const auto &Rule : It->getSecond().getAggregateRuleSet()) {
1935 // The rule might be language specific, so only subtract it from the given
1936 // rules if the specific language options are specified.
1937 std::vector<Record *> LangOpts = Rule.getLangOpts();
Erich Keane3bff4142017-10-16 23:25:24 +00001938 OS << " MatchRules.push_back(std::make_pair(" << Rule.getEnumValue()
Alex Lorenz24952fb2017-04-19 15:52:11 +00001939 << ", /*IsSupported=*/";
1940 if (!LangOpts.empty()) {
1941 for (auto I = LangOpts.begin(), E = LangOpts.end(); I != E; ++I) {
Erich Keane3bff4142017-10-16 23:25:24 +00001942 const StringRef Part = (*I)->getValueAsString("Name");
Alex Lorenz24952fb2017-04-19 15:52:11 +00001943 if ((*I)->getValueAsBit("Negated"))
Erich Keane3bff4142017-10-16 23:25:24 +00001944 OS << "!";
1945 OS << "LangOpts." << Part;
Alex Lorenz24952fb2017-04-19 15:52:11 +00001946 if (I + 1 != E)
Erich Keane3bff4142017-10-16 23:25:24 +00001947 OS << " || ";
Alex Lorenz24952fb2017-04-19 15:52:11 +00001948 }
1949 } else
Erich Keane3bff4142017-10-16 23:25:24 +00001950 OS << "true";
1951 OS << "));\n";
Alex Lorenz24952fb2017-04-19 15:52:11 +00001952 }
Alex Lorenz9e7bf162017-04-18 14:33:39 +00001953 }
Erich Keane3bff4142017-10-16 23:25:24 +00001954 OS << "}\n\n";
Alex Lorenz9e7bf162017-04-18 14:33:39 +00001955 return FnName;
1956}
1957
1958void PragmaClangAttributeSupport::generateParsingHelpers(raw_ostream &OS) {
1959 // Generate routines that check the names of sub-rules.
1960 OS << "Optional<attr::SubjectMatchRule> "
1961 "defaultIsAttributeSubjectMatchSubRuleFor(StringRef, bool) {\n";
1962 OS << " return None;\n";
1963 OS << "}\n\n";
1964
1965 std::map<const Record *, std::vector<AttributeSubjectMatchRule>>
1966 SubMatchRules;
1967 for (const auto &Rule : Rules) {
1968 if (!Rule.isSubRule())
1969 continue;
1970 SubMatchRules[Rule.MetaSubject].push_back(Rule);
1971 }
1972
1973 for (const auto &SubMatchRule : SubMatchRules) {
1974 OS << "Optional<attr::SubjectMatchRule> isAttributeSubjectMatchSubRuleFor_"
1975 << SubMatchRule.first->getValueAsString("Name")
1976 << "(StringRef Name, bool IsUnless) {\n";
1977 OS << " if (IsUnless)\n";
1978 OS << " return "
1979 "llvm::StringSwitch<Optional<attr::SubjectMatchRule>>(Name).\n";
1980 for (const auto &Rule : SubMatchRule.second) {
1981 if (Rule.isNegatedSubRule())
1982 OS << " Case(\"" << Rule.getName() << "\", " << Rule.getEnumValue()
1983 << ").\n";
1984 }
1985 OS << " Default(None);\n";
1986 OS << " return "
1987 "llvm::StringSwitch<Optional<attr::SubjectMatchRule>>(Name).\n";
1988 for (const auto &Rule : SubMatchRule.second) {
1989 if (!Rule.isNegatedSubRule())
1990 OS << " Case(\"" << Rule.getName() << "\", " << Rule.getEnumValue()
1991 << ").\n";
1992 }
1993 OS << " Default(None);\n";
1994 OS << "}\n\n";
1995 }
1996
1997 // Generate the function that checks for the top-level rules.
1998 OS << "std::pair<Optional<attr::SubjectMatchRule>, "
1999 "Optional<attr::SubjectMatchRule> (*)(StringRef, "
2000 "bool)> isAttributeSubjectMatchRule(StringRef Name) {\n";
2001 OS << " return "
2002 "llvm::StringSwitch<std::pair<Optional<attr::SubjectMatchRule>, "
2003 "Optional<attr::SubjectMatchRule> (*) (StringRef, "
2004 "bool)>>(Name).\n";
2005 for (const auto &Rule : Rules) {
2006 if (Rule.isSubRule())
2007 continue;
2008 std::string SubRuleFunction;
2009 if (SubMatchRules.count(Rule.MetaSubject))
Erich Keane3bff4142017-10-16 23:25:24 +00002010 SubRuleFunction =
2011 ("isAttributeSubjectMatchSubRuleFor_" + Rule.getName()).str();
Alex Lorenz9e7bf162017-04-18 14:33:39 +00002012 else
2013 SubRuleFunction = "defaultIsAttributeSubjectMatchSubRuleFor";
2014 OS << " Case(\"" << Rule.getName() << "\", std::make_pair("
2015 << Rule.getEnumValue() << ", " << SubRuleFunction << ")).\n";
2016 }
2017 OS << " Default(std::make_pair(None, "
2018 "defaultIsAttributeSubjectMatchSubRuleFor));\n";
2019 OS << "}\n\n";
2020
2021 // Generate the function that checks for the submatch rules.
2022 OS << "const char *validAttributeSubjectMatchSubRules("
2023 << AttributeSubjectMatchRule::EnumName << " Rule) {\n";
2024 OS << " switch (Rule) {\n";
2025 for (const auto &SubMatchRule : SubMatchRules) {
2026 OS << " case "
2027 << AttributeSubjectMatchRule(SubMatchRule.first, nullptr).getEnumValue()
2028 << ":\n";
2029 OS << " return \"'";
2030 bool IsFirst = true;
2031 for (const auto &Rule : SubMatchRule.second) {
2032 if (!IsFirst)
2033 OS << ", '";
2034 IsFirst = false;
2035 if (Rule.isNegatedSubRule())
2036 OS << "unless(";
2037 OS << Rule.getName();
2038 if (Rule.isNegatedSubRule())
2039 OS << ')';
2040 OS << "'";
2041 }
2042 OS << "\";\n";
2043 }
2044 OS << " default: return nullptr;\n";
2045 OS << " }\n";
2046 OS << "}\n\n";
2047}
2048
George Burgess IV1881a572016-12-01 00:13:18 +00002049template <typename Fn>
2050static void forEachUniqueSpelling(const Record &Attr, Fn &&F) {
2051 std::vector<FlattenedSpelling> Spellings = GetFlattenedSpellings(Attr);
2052 SmallDenseSet<StringRef, 8> Seen;
2053 for (const FlattenedSpelling &S : Spellings) {
2054 if (Seen.insert(S.name()).second)
2055 F(S);
2056 }
2057}
2058
Aaron Ballman35db2b32014-01-29 22:13:45 +00002059/// \brief Emits the first-argument-is-type property for attributes.
2060static void emitClangAttrTypeArgList(RecordKeeper &Records, raw_ostream &OS) {
2061 OS << "#if defined(CLANG_ATTR_TYPE_ARG_LIST)\n";
2062 std::vector<Record *> Attrs = Records.getAllDerivedDefinitions("Attr");
2063
Aaron Ballman2f22b942014-05-20 19:47:14 +00002064 for (const auto *Attr : Attrs) {
Aaron Ballman35db2b32014-01-29 22:13:45 +00002065 // Determine whether the first argument is a type.
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +00002066 std::vector<Record *> Args = Attr->getValueAsListOfDefs("Args");
Aaron Ballman35db2b32014-01-29 22:13:45 +00002067 if (Args.empty())
2068 continue;
2069
Craig Topper25761242016-01-18 19:52:54 +00002070 if (Args[0]->getSuperClasses().back().first->getName() != "TypeArgument")
Aaron Ballman35db2b32014-01-29 22:13:45 +00002071 continue;
2072
2073 // All these spellings take a single type argument.
George Burgess IV1881a572016-12-01 00:13:18 +00002074 forEachUniqueSpelling(*Attr, [&](const FlattenedSpelling &S) {
2075 OS << ".Case(\"" << S.name() << "\", " << "true" << ")\n";
2076 });
Aaron Ballman35db2b32014-01-29 22:13:45 +00002077 }
2078 OS << "#endif // CLANG_ATTR_TYPE_ARG_LIST\n\n";
2079}
2080
2081/// \brief Emits the parse-arguments-in-unevaluated-context property for
2082/// attributes.
2083static void emitClangAttrArgContextList(RecordKeeper &Records, raw_ostream &OS) {
2084 OS << "#if defined(CLANG_ATTR_ARG_CONTEXT_LIST)\n";
2085 ParsedAttrMap Attrs = getParsedAttrList(Records);
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +00002086 for (const auto &I : Attrs) {
2087 const Record &Attr = *I.second;
Aaron Ballman35db2b32014-01-29 22:13:45 +00002088
2089 if (!Attr.getValueAsBit("ParseArgumentsAsUnevaluated"))
2090 continue;
2091
2092 // All these spellings take are parsed unevaluated.
George Burgess IV1881a572016-12-01 00:13:18 +00002093 forEachUniqueSpelling(Attr, [&](const FlattenedSpelling &S) {
2094 OS << ".Case(\"" << S.name() << "\", " << "true" << ")\n";
2095 });
Aaron Ballman35db2b32014-01-29 22:13:45 +00002096 }
2097 OS << "#endif // CLANG_ATTR_ARG_CONTEXT_LIST\n\n";
2098}
2099
2100static bool isIdentifierArgument(Record *Arg) {
2101 return !Arg->getSuperClasses().empty() &&
Craig Topper25761242016-01-18 19:52:54 +00002102 llvm::StringSwitch<bool>(Arg->getSuperClasses().back().first->getName())
Aaron Ballman35db2b32014-01-29 22:13:45 +00002103 .Case("IdentifierArgument", true)
2104 .Case("EnumArgument", true)
Aaron Ballman55ef1512014-12-19 16:42:04 +00002105 .Case("VariadicEnumArgument", true)
Aaron Ballman35db2b32014-01-29 22:13:45 +00002106 .Default(false);
2107}
2108
2109// Emits the first-argument-is-identifier property for attributes.
2110static void emitClangAttrIdentifierArgList(RecordKeeper &Records, raw_ostream &OS) {
2111 OS << "#if defined(CLANG_ATTR_IDENTIFIER_ARG_LIST)\n";
2112 std::vector<Record*> Attrs = Records.getAllDerivedDefinitions("Attr");
2113
Aaron Ballman2f22b942014-05-20 19:47:14 +00002114 for (const auto *Attr : Attrs) {
Aaron Ballman35db2b32014-01-29 22:13:45 +00002115 // Determine whether the first argument is an identifier.
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +00002116 std::vector<Record *> Args = Attr->getValueAsListOfDefs("Args");
Aaron Ballman35db2b32014-01-29 22:13:45 +00002117 if (Args.empty() || !isIdentifierArgument(Args[0]))
2118 continue;
2119
2120 // All these spellings take an identifier argument.
George Burgess IV1881a572016-12-01 00:13:18 +00002121 forEachUniqueSpelling(*Attr, [&](const FlattenedSpelling &S) {
2122 OS << ".Case(\"" << S.name() << "\", " << "true" << ")\n";
2123 });
Aaron Ballman35db2b32014-01-29 22:13:45 +00002124 }
2125 OS << "#endif // CLANG_ATTR_IDENTIFIER_ARG_LIST\n\n";
2126}
2127
Jakob Stoklund Olesen995e0e12012-06-13 05:12:41 +00002128namespace clang {
2129
2130// Emits the class definitions for attributes.
2131void EmitClangAttrClass(RecordKeeper &Records, raw_ostream &OS) {
Dmitri Gribenko6b11fca2013-01-30 21:54:20 +00002132 emitSourceFileHeader("Attribute classes' definitions", OS);
2133
Peter Collingbournebee583f2011-10-06 13:03:08 +00002134 OS << "#ifndef LLVM_CLANG_ATTR_CLASSES_INC\n";
2135 OS << "#define LLVM_CLANG_ATTR_CLASSES_INC\n\n";
2136
2137 std::vector<Record*> Attrs = Records.getAllDerivedDefinitions("Attr");
2138
Aaron Ballman2f22b942014-05-20 19:47:14 +00002139 for (const auto *Attr : Attrs) {
2140 const Record &R = *Attr;
Aaron Ballman06bd44b2014-02-17 18:23:02 +00002141
2142 // FIXME: Currently, documentation is generated as-needed due to the fact
2143 // that there is no way to allow a generated project "reach into" the docs
2144 // directory (for instance, it may be an out-of-tree build). However, we want
2145 // to ensure that every attribute has a Documentation field, and produce an
2146 // error if it has been neglected. Otherwise, the on-demand generation which
2147 // happens server-side will fail. This code is ensuring that functionality,
2148 // even though this Emitter doesn't technically need the documentation.
2149 // When attribute documentation can be generated as part of the build
2150 // itself, this code can be removed.
2151 (void)R.getValueAsListOfDefs("Documentation");
Douglas Gregorb2daf842012-05-02 15:56:52 +00002152
2153 if (!R.getValueAsBit("ASTNode"))
2154 continue;
2155
Craig Topper25761242016-01-18 19:52:54 +00002156 ArrayRef<std::pair<Record *, SMRange>> Supers = R.getSuperClasses();
Aaron Ballman0979e9e2013-07-30 01:44:15 +00002157 assert(!Supers.empty() && "Forgot to specify a superclass for the attr");
Aaron Ballman0979e9e2013-07-30 01:44:15 +00002158 std::string SuperName;
Richard Smith33bddbd2018-01-04 23:42:29 +00002159 bool Inheritable = false;
David Majnemerf7e36092016-06-23 00:15:04 +00002160 for (const auto &Super : llvm::reverse(Supers)) {
Craig Topper25761242016-01-18 19:52:54 +00002161 const Record *R = Super.first;
2162 if (R->getName() != "TargetSpecificAttr" && SuperName.empty())
2163 SuperName = R->getName();
Richard Smith33bddbd2018-01-04 23:42:29 +00002164 if (R->getName() == "InheritableAttr")
2165 Inheritable = true;
Aaron Ballman0979e9e2013-07-30 01:44:15 +00002166 }
Peter Collingbournebee583f2011-10-06 13:03:08 +00002167
2168 OS << "class " << R.getName() << "Attr : public " << SuperName << " {\n";
2169
2170 std::vector<Record*> ArgRecords = R.getValueAsListOfDefs("Args");
Aaron Ballman8f1439b2014-03-05 16:49:55 +00002171 std::vector<std::unique_ptr<Argument>> Args;
Peter Collingbournebee583f2011-10-06 13:03:08 +00002172 Args.reserve(ArgRecords.size());
2173
John McCalla62c1a92015-10-28 00:17:34 +00002174 bool HasOptArg = false;
2175 bool HasFakeArg = false;
Aaron Ballman2f22b942014-05-20 19:47:14 +00002176 for (const auto *ArgRecord : ArgRecords) {
Aaron Ballman8f1439b2014-03-05 16:49:55 +00002177 Args.emplace_back(createArgument(*ArgRecord, R.getName()));
2178 Args.back()->writeDeclarations(OS);
Peter Collingbournebee583f2011-10-06 13:03:08 +00002179 OS << "\n\n";
John McCalla62c1a92015-10-28 00:17:34 +00002180
2181 // For these purposes, fake takes priority over optional.
2182 if (Args.back()->isFake()) {
2183 HasFakeArg = true;
2184 } else if (Args.back()->isOptional()) {
2185 HasOptArg = true;
2186 }
Peter Collingbournebee583f2011-10-06 13:03:08 +00002187 }
2188
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +00002189 OS << "public:\n";
Aaron Ballman36a53502014-01-16 13:03:14 +00002190
Aaron Ballmanc669cc02014-01-27 22:10:04 +00002191 std::vector<FlattenedSpelling> Spellings = GetFlattenedSpellings(R);
Aaron Ballman36a53502014-01-16 13:03:14 +00002192
2193 // If there are zero or one spellings, all spelling-related functionality
2194 // can be elided. If all of the spellings share the same name, the spelling
2195 // functionality can also be elided.
2196 bool ElideSpelling = (Spellings.size() <= 1) ||
2197 SpellingNamesAreCommon(Spellings);
2198
Aaron Ballman81cb8cb2014-01-24 21:32:49 +00002199 // This maps spelling index values to semantic Spelling enumerants.
2200 SemanticSpellingMap SemanticToSyntacticMap;
Aaron Ballman36a53502014-01-16 13:03:14 +00002201
Aaron Ballman81cb8cb2014-01-24 21:32:49 +00002202 if (!ElideSpelling)
2203 OS << CreateSemanticSpellings(Spellings, SemanticToSyntacticMap);
Aaron Ballman36a53502014-01-16 13:03:14 +00002204
John McCalla62c1a92015-10-28 00:17:34 +00002205 // Emit CreateImplicit factory methods.
2206 auto emitCreateImplicit = [&](bool emitFake) {
2207 OS << " static " << R.getName() << "Attr *CreateImplicit(";
2208 OS << "ASTContext &Ctx";
2209 if (!ElideSpelling)
2210 OS << ", Spelling S";
2211 for (auto const &ai : Args) {
2212 if (ai->isFake() && !emitFake) continue;
2213 OS << ", ";
2214 ai->writeCtorParameters(OS);
2215 }
2216 OS << ", SourceRange Loc = SourceRange()";
2217 OS << ") {\n";
Eugene Zelenko5f02b772015-12-08 18:49:01 +00002218 OS << " auto *A = new (Ctx) " << R.getName();
John McCalla62c1a92015-10-28 00:17:34 +00002219 OS << "Attr(Loc, Ctx, ";
2220 for (auto const &ai : Args) {
2221 if (ai->isFake() && !emitFake) continue;
2222 ai->writeImplicitCtorArgs(OS);
2223 OS << ", ";
2224 }
2225 OS << (ElideSpelling ? "0" : "S") << ");\n";
2226 OS << " A->setImplicit(true);\n";
2227 OS << " return A;\n }\n\n";
2228 };
Aaron Ballman36a53502014-01-16 13:03:14 +00002229
John McCalla62c1a92015-10-28 00:17:34 +00002230 // Emit a CreateImplicit that takes all the arguments.
2231 emitCreateImplicit(true);
2232
2233 // Emit a CreateImplicit that takes all the non-fake arguments.
2234 if (HasFakeArg) {
2235 emitCreateImplicit(false);
Peter Collingbournebee583f2011-10-06 13:03:08 +00002236 }
Michael Han99315932013-01-24 16:46:58 +00002237
John McCalla62c1a92015-10-28 00:17:34 +00002238 // Emit constructors.
2239 auto emitCtor = [&](bool emitOpt, bool emitFake) {
2240 auto shouldEmitArg = [=](const std::unique_ptr<Argument> &arg) {
2241 if (arg->isFake()) return emitFake;
2242 if (arg->isOptional()) return emitOpt;
2243 return true;
2244 };
Michael Han99315932013-01-24 16:46:58 +00002245
Aaron Ballman8ee40b72013-09-09 23:33:17 +00002246 OS << " " << R.getName() << "Attr(SourceRange R, ASTContext &Ctx\n";
Aaron Ballman8f1439b2014-03-05 16:49:55 +00002247 for (auto const &ai : Args) {
John McCalla62c1a92015-10-28 00:17:34 +00002248 if (!shouldEmitArg(ai)) continue;
2249 OS << " , ";
2250 ai->writeCtorParameters(OS);
2251 OS << "\n";
Aaron Ballman8ee40b72013-09-09 23:33:17 +00002252 }
2253
2254 OS << " , ";
Aaron Ballman36a53502014-01-16 13:03:14 +00002255 OS << "unsigned SI\n";
Aaron Ballman8ee40b72013-09-09 23:33:17 +00002256
2257 OS << " )\n";
Benjamin Kramer845e32c2015-03-19 16:06:49 +00002258 OS << " : " << SuperName << "(attr::" << R.getName() << ", R, SI, "
Richard Smith33bddbd2018-01-04 23:42:29 +00002259 << ( R.getValueAsBit("LateParsed") ? "true" : "false" );
2260 if (Inheritable) {
2261 OS << ", "
2262 << (R.getValueAsBit("InheritEvenIfAlreadyPresent") ? "true"
2263 : "false");
2264 }
2265 OS << ")\n";
Aaron Ballman8ee40b72013-09-09 23:33:17 +00002266
Aaron Ballman8f1439b2014-03-05 16:49:55 +00002267 for (auto const &ai : Args) {
Aaron Ballman8ee40b72013-09-09 23:33:17 +00002268 OS << " , ";
John McCalla62c1a92015-10-28 00:17:34 +00002269 if (!shouldEmitArg(ai)) {
2270 ai->writeCtorDefaultInitializers(OS);
2271 } else {
2272 ai->writeCtorInitializers(OS);
2273 }
Aaron Ballman8ee40b72013-09-09 23:33:17 +00002274 OS << "\n";
2275 }
2276
2277 OS << " {\n";
2278
Aaron Ballman8f1439b2014-03-05 16:49:55 +00002279 for (auto const &ai : Args) {
John McCalla62c1a92015-10-28 00:17:34 +00002280 if (!shouldEmitArg(ai)) continue;
2281 ai->writeCtorBody(OS);
Aaron Ballman8ee40b72013-09-09 23:33:17 +00002282 }
2283 OS << " }\n\n";
John McCalla62c1a92015-10-28 00:17:34 +00002284 };
2285
2286 // Emit a constructor that includes all the arguments.
2287 // This is necessary for cloning.
2288 emitCtor(true, true);
2289
2290 // Emit a constructor that takes all the non-fake arguments.
2291 if (HasFakeArg) {
2292 emitCtor(true, false);
2293 }
2294
2295 // Emit a constructor that takes all the non-fake, non-optional arguments.
2296 if (HasOptArg) {
2297 emitCtor(false, false);
Aaron Ballman8ee40b72013-09-09 23:33:17 +00002298 }
2299
Benjamin Kramer845e32c2015-03-19 16:06:49 +00002300 OS << " " << R.getName() << "Attr *clone(ASTContext &C) const;\n";
Craig Toppercbce6e92014-03-11 06:22:39 +00002301 OS << " void printPretty(raw_ostream &OS,\n"
Benjamin Kramer845e32c2015-03-19 16:06:49 +00002302 << " const PrintingPolicy &Policy) const;\n";
2303 OS << " const char *getSpelling() const;\n";
Aaron Ballman81cb8cb2014-01-24 21:32:49 +00002304
2305 if (!ElideSpelling) {
2306 assert(!SemanticToSyntacticMap.empty() && "Empty semantic mapping list");
2307 OS << " Spelling getSemanticSpelling() const {\n";
2308 WriteSemanticSpellingSwitch("SpellingListIndex", SemanticToSyntacticMap,
2309 OS);
2310 OS << " }\n";
2311 }
Peter Collingbournebee583f2011-10-06 13:03:08 +00002312
Michael Hanaf02bbe2013-02-01 01:19:17 +00002313 writeAttrAccessorDefinition(R, OS);
2314
Aaron Ballman8f1439b2014-03-05 16:49:55 +00002315 for (auto const &ai : Args) {
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +00002316 ai->writeAccessors(OS);
Peter Collingbournebee583f2011-10-06 13:03:08 +00002317 OS << "\n\n";
Aaron Ballman682ee422013-09-11 19:47:58 +00002318
John McCalla62c1a92015-10-28 00:17:34 +00002319 // Don't write conversion routines for fake arguments.
2320 if (ai->isFake()) continue;
2321
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +00002322 if (ai->isEnumArg())
Aaron Ballman8f1439b2014-03-05 16:49:55 +00002323 static_cast<const EnumArgument *>(ai.get())->writeConversion(OS);
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +00002324 else if (ai->isVariadicEnumArg())
Aaron Ballman8f1439b2014-03-05 16:49:55 +00002325 static_cast<const VariadicEnumArgument *>(ai.get())
2326 ->writeConversion(OS);
Peter Collingbournebee583f2011-10-06 13:03:08 +00002327 }
2328
Jakob Stoklund Olesen6f2288b62012-01-13 04:57:47 +00002329 OS << R.getValueAsString("AdditionalMembers");
Peter Collingbournebee583f2011-10-06 13:03:08 +00002330 OS << "\n\n";
2331
2332 OS << " static bool classof(const Attr *A) { return A->getKind() == "
2333 << "attr::" << R.getName() << "; }\n";
DeLesley Hutchins30398dd2012-01-20 22:50:54 +00002334
Peter Collingbournebee583f2011-10-06 13:03:08 +00002335 OS << "};\n\n";
2336 }
2337
Eugene Zelenko5f02b772015-12-08 18:49:01 +00002338 OS << "#endif // LLVM_CLANG_ATTR_CLASSES_INC\n";
Peter Collingbournebee583f2011-10-06 13:03:08 +00002339}
2340
Jakob Stoklund Olesen995e0e12012-06-13 05:12:41 +00002341// Emits the class method definitions for attributes.
2342void EmitClangAttrImpl(RecordKeeper &Records, raw_ostream &OS) {
Dmitri Gribenko6b11fca2013-01-30 21:54:20 +00002343 emitSourceFileHeader("Attribute classes' member function definitions", OS);
Peter Collingbournebee583f2011-10-06 13:03:08 +00002344
2345 std::vector<Record*> Attrs = Records.getAllDerivedDefinitions("Attr");
Peter Collingbournebee583f2011-10-06 13:03:08 +00002346
Aaron Ballman2f22b942014-05-20 19:47:14 +00002347 for (auto *Attr : Attrs) {
2348 Record &R = *Attr;
Douglas Gregorb2daf842012-05-02 15:56:52 +00002349
2350 if (!R.getValueAsBit("ASTNode"))
2351 continue;
Peter Collingbournebee583f2011-10-06 13:03:08 +00002352
Aaron Ballman8f1439b2014-03-05 16:49:55 +00002353 std::vector<Record*> ArgRecords = R.getValueAsListOfDefs("Args");
2354 std::vector<std::unique_ptr<Argument>> Args;
Aaron Ballman2f22b942014-05-20 19:47:14 +00002355 for (const auto *Arg : ArgRecords)
2356 Args.emplace_back(createArgument(*Arg, R.getName()));
Aaron Ballman8f1439b2014-03-05 16:49:55 +00002357
2358 for (auto const &ai : Args)
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +00002359 ai->writeAccessorDefinitions(OS);
Peter Collingbournebee583f2011-10-06 13:03:08 +00002360
2361 OS << R.getName() << "Attr *" << R.getName()
2362 << "Attr::clone(ASTContext &C) const {\n";
Hans Wennborg613807b2014-05-31 01:30:30 +00002363 OS << " auto *A = new (C) " << R.getName() << "Attr(getLocation(), C";
Aaron Ballman8f1439b2014-03-05 16:49:55 +00002364 for (auto const &ai : Args) {
Peter Collingbournebee583f2011-10-06 13:03:08 +00002365 OS << ", ";
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +00002366 ai->writeCloneArgs(OS);
Peter Collingbournebee583f2011-10-06 13:03:08 +00002367 }
Hans Wennborg613807b2014-05-31 01:30:30 +00002368 OS << ", getSpellingListIndex());\n";
2369 OS << " A->Inherited = Inherited;\n";
2370 OS << " A->IsPackExpansion = IsPackExpansion;\n";
2371 OS << " A->Implicit = Implicit;\n";
2372 OS << " return A;\n}\n\n";
Douglas Gregor49ccfaa2011-11-19 19:22:57 +00002373
Michael Han99315932013-01-24 16:46:58 +00002374 writePrettyPrintFunction(R, Args, OS);
Aaron Ballman3e424b52013-12-26 18:30:57 +00002375 writeGetSpellingFunction(R, OS);
Peter Collingbournebee583f2011-10-06 13:03:08 +00002376 }
Benjamin Kramer845e32c2015-03-19 16:06:49 +00002377
2378 // Instead of relying on virtual dispatch we just create a huge dispatch
2379 // switch. This is both smaller and faster than virtual functions.
2380 auto EmitFunc = [&](const char *Method) {
2381 OS << " switch (getKind()) {\n";
2382 for (const auto *Attr : Attrs) {
2383 const Record &R = *Attr;
2384 if (!R.getValueAsBit("ASTNode"))
2385 continue;
2386
2387 OS << " case attr::" << R.getName() << ":\n";
2388 OS << " return cast<" << R.getName() << "Attr>(this)->" << Method
2389 << ";\n";
2390 }
Benjamin Kramer845e32c2015-03-19 16:06:49 +00002391 OS << " }\n";
2392 OS << " llvm_unreachable(\"Unexpected attribute kind!\");\n";
2393 OS << "}\n\n";
2394 };
2395
2396 OS << "const char *Attr::getSpelling() const {\n";
2397 EmitFunc("getSpelling()");
2398
2399 OS << "Attr *Attr::clone(ASTContext &C) const {\n";
2400 EmitFunc("clone(C)");
2401
2402 OS << "void Attr::printPretty(raw_ostream &OS, "
2403 "const PrintingPolicy &Policy) const {\n";
2404 EmitFunc("printPretty(OS, Policy)");
Peter Collingbournebee583f2011-10-06 13:03:08 +00002405}
2406
Jakob Stoklund Olesen995e0e12012-06-13 05:12:41 +00002407} // end namespace clang
2408
John McCall2225c8b2016-03-01 00:18:05 +00002409static void emitAttrList(raw_ostream &OS, StringRef Class,
Peter Collingbournebee583f2011-10-06 13:03:08 +00002410 const std::vector<Record*> &AttrList) {
John McCall2225c8b2016-03-01 00:18:05 +00002411 for (auto Cur : AttrList) {
2412 OS << Class << "(" << Cur->getName() << ")\n";
Peter Collingbournebee583f2011-10-06 13:03:08 +00002413 }
2414}
2415
Tyler Nowickic724a83e2014-10-12 20:46:07 +00002416// Determines if an attribute has a Pragma spelling.
2417static bool AttrHasPragmaSpelling(const Record *R) {
2418 std::vector<FlattenedSpelling> Spellings = GetFlattenedSpellings(*R);
George Burgess IV1881a572016-12-01 00:13:18 +00002419 return llvm::find_if(Spellings, [](const FlattenedSpelling &S) {
Tyler Nowickic724a83e2014-10-12 20:46:07 +00002420 return S.variety() == "Pragma";
2421 }) != Spellings.end();
2422}
Jakob Stoklund Olesen995e0e12012-06-13 05:12:41 +00002423
John McCall2225c8b2016-03-01 00:18:05 +00002424namespace {
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +00002425
John McCall2225c8b2016-03-01 00:18:05 +00002426 struct AttrClassDescriptor {
2427 const char * const MacroName;
2428 const char * const TableGenName;
2429 };
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +00002430
2431} // end anonymous namespace
John McCall2225c8b2016-03-01 00:18:05 +00002432
2433static const AttrClassDescriptor AttrClassDescriptors[] = {
2434 { "ATTR", "Attr" },
Richard Smith4f902c72016-03-08 00:32:55 +00002435 { "STMT_ATTR", "StmtAttr" },
John McCall2225c8b2016-03-01 00:18:05 +00002436 { "INHERITABLE_ATTR", "InheritableAttr" },
John McCall477f2bb2016-03-03 06:39:32 +00002437 { "INHERITABLE_PARAM_ATTR", "InheritableParamAttr" },
2438 { "PARAMETER_ABI_ATTR", "ParameterABIAttr" }
John McCall2225c8b2016-03-01 00:18:05 +00002439};
2440
2441static void emitDefaultDefine(raw_ostream &OS, StringRef name,
2442 const char *superName) {
2443 OS << "#ifndef " << name << "\n";
2444 OS << "#define " << name << "(NAME) ";
2445 if (superName) OS << superName << "(NAME)";
2446 OS << "\n#endif\n\n";
2447}
2448
2449namespace {
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +00002450
John McCall2225c8b2016-03-01 00:18:05 +00002451 /// A class of attributes.
2452 struct AttrClass {
2453 const AttrClassDescriptor &Descriptor;
2454 Record *TheRecord;
2455 AttrClass *SuperClass = nullptr;
2456 std::vector<AttrClass*> SubClasses;
2457 std::vector<Record*> Attrs;
2458
2459 AttrClass(const AttrClassDescriptor &Descriptor, Record *R)
2460 : Descriptor(Descriptor), TheRecord(R) {}
2461
2462 void emitDefaultDefines(raw_ostream &OS) const {
2463 // Default the macro unless this is a root class (i.e. Attr).
2464 if (SuperClass) {
2465 emitDefaultDefine(OS, Descriptor.MacroName,
2466 SuperClass->Descriptor.MacroName);
2467 }
2468 }
2469
2470 void emitUndefs(raw_ostream &OS) const {
2471 OS << "#undef " << Descriptor.MacroName << "\n";
2472 }
2473
2474 void emitAttrList(raw_ostream &OS) const {
2475 for (auto SubClass : SubClasses) {
2476 SubClass->emitAttrList(OS);
2477 }
2478
2479 ::emitAttrList(OS, Descriptor.MacroName, Attrs);
2480 }
2481
2482 void classifyAttrOnRoot(Record *Attr) {
2483 bool result = classifyAttr(Attr);
2484 assert(result && "failed to classify on root"); (void) result;
2485 }
2486
2487 void emitAttrRange(raw_ostream &OS) const {
2488 OS << "ATTR_RANGE(" << Descriptor.TableGenName
2489 << ", " << getFirstAttr()->getName()
2490 << ", " << getLastAttr()->getName() << ")\n";
2491 }
2492
2493 private:
2494 bool classifyAttr(Record *Attr) {
2495 // Check all the subclasses.
2496 for (auto SubClass : SubClasses) {
2497 if (SubClass->classifyAttr(Attr))
2498 return true;
2499 }
2500
2501 // It's not more specific than this class, but it might still belong here.
2502 if (Attr->isSubClassOf(TheRecord)) {
2503 Attrs.push_back(Attr);
2504 return true;
2505 }
2506
2507 return false;
2508 }
2509
2510 Record *getFirstAttr() const {
2511 if (!SubClasses.empty())
2512 return SubClasses.front()->getFirstAttr();
2513 return Attrs.front();
2514 }
2515
2516 Record *getLastAttr() const {
2517 if (!Attrs.empty())
2518 return Attrs.back();
2519 return SubClasses.back()->getLastAttr();
2520 }
2521 };
2522
2523 /// The entire hierarchy of attribute classes.
2524 class AttrClassHierarchy {
2525 std::vector<std::unique_ptr<AttrClass>> Classes;
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +00002526
John McCall2225c8b2016-03-01 00:18:05 +00002527 public:
2528 AttrClassHierarchy(RecordKeeper &Records) {
2529 // Find records for all the classes.
2530 for (auto &Descriptor : AttrClassDescriptors) {
2531 Record *ClassRecord = Records.getClass(Descriptor.TableGenName);
2532 AttrClass *Class = new AttrClass(Descriptor, ClassRecord);
2533 Classes.emplace_back(Class);
2534 }
2535
2536 // Link up the hierarchy.
2537 for (auto &Class : Classes) {
2538 if (AttrClass *SuperClass = findSuperClass(Class->TheRecord)) {
2539 Class->SuperClass = SuperClass;
2540 SuperClass->SubClasses.push_back(Class.get());
2541 }
2542 }
2543
2544#ifndef NDEBUG
2545 for (auto i = Classes.begin(), e = Classes.end(); i != e; ++i) {
2546 assert((i == Classes.begin()) == ((*i)->SuperClass == nullptr) &&
2547 "only the first class should be a root class!");
2548 }
2549#endif
2550 }
2551
2552 void emitDefaultDefines(raw_ostream &OS) const {
2553 for (auto &Class : Classes) {
2554 Class->emitDefaultDefines(OS);
2555 }
2556 }
2557
2558 void emitUndefs(raw_ostream &OS) const {
2559 for (auto &Class : Classes) {
2560 Class->emitUndefs(OS);
2561 }
2562 }
2563
2564 void emitAttrLists(raw_ostream &OS) const {
2565 // Just start from the root class.
2566 Classes[0]->emitAttrList(OS);
2567 }
2568
2569 void emitAttrRanges(raw_ostream &OS) const {
2570 for (auto &Class : Classes)
2571 Class->emitAttrRange(OS);
2572 }
2573
2574 void classifyAttr(Record *Attr) {
2575 // Add the attribute to the root class.
2576 Classes[0]->classifyAttrOnRoot(Attr);
2577 }
2578
2579 private:
2580 AttrClass *findClassByRecord(Record *R) const {
2581 for (auto &Class : Classes) {
2582 if (Class->TheRecord == R)
2583 return Class.get();
2584 }
2585 return nullptr;
2586 }
2587
2588 AttrClass *findSuperClass(Record *R) const {
2589 // TableGen flattens the superclass list, so we just need to walk it
2590 // in reverse.
2591 auto SuperClasses = R->getSuperClasses();
2592 for (signed i = 0, e = SuperClasses.size(); i != e; ++i) {
2593 auto SuperClass = findClassByRecord(SuperClasses[e - i - 1].first);
2594 if (SuperClass) return SuperClass;
2595 }
2596 return nullptr;
2597 }
2598 };
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +00002599
2600} // end anonymous namespace
John McCall2225c8b2016-03-01 00:18:05 +00002601
Tyler Nowickic724a83e2014-10-12 20:46:07 +00002602namespace clang {
Eugene Zelenkoa9f3e902016-05-12 22:27:08 +00002603
Jakob Stoklund Olesen995e0e12012-06-13 05:12:41 +00002604// Emits the enumeration list for attributes.
2605void EmitClangAttrList(RecordKeeper &Records, raw_ostream &OS) {
Dmitri Gribenko6b11fca2013-01-30 21:54:20 +00002606 emitSourceFileHeader("List of all attributes that Clang recognizes", OS);
Peter Collingbournebee583f2011-10-06 13:03:08 +00002607
John McCall2225c8b2016-03-01 00:18:05 +00002608 AttrClassHierarchy Hierarchy(Records);
Peter Collingbournebee583f2011-10-06 13:03:08 +00002609
John McCall2225c8b2016-03-01 00:18:05 +00002610 // Add defaulting macro definitions.
2611 Hierarchy.emitDefaultDefines(OS);
2612 emitDefaultDefine(OS, "PRAGMA_SPELLING_ATTR", nullptr);
Peter Collingbournebee583f2011-10-06 13:03:08 +00002613
John McCall2225c8b2016-03-01 00:18:05 +00002614 std::vector<Record *> Attrs = Records.getAllDerivedDefinitions("Attr");
2615 std::vector<Record *> PragmaAttrs;
Aaron Ballman2f22b942014-05-20 19:47:14 +00002616 for (auto *Attr : Attrs) {
2617 if (!Attr->getValueAsBit("ASTNode"))
Douglas Gregorb2daf842012-05-02 15:56:52 +00002618 continue;
Tyler Nowickic724a83e2014-10-12 20:46:07 +00002619
John McCall2225c8b2016-03-01 00:18:05 +00002620 // Add the attribute to the ad-hoc groups.
Tyler Nowickic724a83e2014-10-12 20:46:07 +00002621 if (AttrHasPragmaSpelling(Attr))
2622 PragmaAttrs.push_back(Attr);
2623
John McCall2225c8b2016-03-01 00:18:05 +00002624 // Place it in the hierarchy.
2625 Hierarchy.classifyAttr(Attr);
Peter Collingbournebee583f2011-10-06 13:03:08 +00002626 }
2627
John McCall2225c8b2016-03-01 00:18:05 +00002628 // Emit the main attribute list.
2629 Hierarchy.emitAttrLists(OS);
Peter Collingbournebee583f2011-10-06 13:03:08 +00002630
John McCall2225c8b2016-03-01 00:18:05 +00002631 // Emit the ad hoc groups.
2632 emitAttrList(OS, "PRAGMA_SPELLING_ATTR", PragmaAttrs);
2633
2634 // Emit the attribute ranges.
2635 OS << "#ifdef ATTR_RANGE\n";
2636 Hierarchy.emitAttrRanges(OS);
2637 OS << "#undef ATTR_RANGE\n";
2638 OS << "#endif\n";
2639
2640 Hierarchy.emitUndefs(OS);
Tyler Nowickic724a83e2014-10-12 20:46:07 +00002641 OS << "#undef PRAGMA_SPELLING_ATTR\n";
Peter Collingbournebee583f2011-10-06 13:03:08 +00002642}
2643
Alex Lorenz9e7bf162017-04-18 14:33:39 +00002644// Emits the enumeration list for attributes.
2645void EmitClangAttrSubjectMatchRuleList(RecordKeeper &Records, raw_ostream &OS) {
2646 emitSourceFileHeader(
2647 "List of all attribute subject matching rules that Clang recognizes", OS);
2648 PragmaClangAttributeSupport &PragmaAttributeSupport =
2649 getPragmaAttributeSupport(Records);
2650 emitDefaultDefine(OS, "ATTR_MATCH_RULE", nullptr);
2651 PragmaAttributeSupport.emitMatchRuleList(OS);
2652 OS << "#undef ATTR_MATCH_RULE\n";
2653}
2654
Jakob Stoklund Olesen995e0e12012-06-13 05:12:41 +00002655// Emits the code to read an attribute from a precompiled header.
2656void EmitClangAttrPCHRead(RecordKeeper &Records, raw_ostream &OS) {
Dmitri Gribenko6b11fca2013-01-30 21:54:20 +00002657 emitSourceFileHeader("Attribute deserialization code", OS);
Peter Collingbournebee583f2011-10-06 13:03:08 +00002658
2659 Record *InhClass = Records.getClass("InheritableAttr");
2660 std::vector<Record*> Attrs = Records.getAllDerivedDefinitions("Attr"),
2661 ArgRecords;
Aaron Ballman8f1439b2014-03-05 16:49:55 +00002662 std::vector<std::unique_ptr<Argument>> Args;
Peter Collingbournebee583f2011-10-06 13:03:08 +00002663
2664 OS << " switch (Kind) {\n";
Aaron Ballman2f22b942014-05-20 19:47:14 +00002665 for (const auto *Attr : Attrs) {
2666 const Record &R = *Attr;
Douglas Gregorb2daf842012-05-02 15:56:52 +00002667 if (!R.getValueAsBit("ASTNode"))
2668 continue;
2669
Peter Collingbournebee583f2011-10-06 13:03:08 +00002670 OS << " case attr::" << R.getName() << ": {\n";
2671 if (R.isSubClassOf(InhClass))
David L. Jones267b8842017-01-24 01:04:30 +00002672 OS << " bool isInherited = Record.readInt();\n";
2673 OS << " bool isImplicit = Record.readInt();\n";
2674 OS << " unsigned Spelling = Record.readInt();\n";
Peter Collingbournebee583f2011-10-06 13:03:08 +00002675 ArgRecords = R.getValueAsListOfDefs("Args");
2676 Args.clear();
Aaron Ballman2f22b942014-05-20 19:47:14 +00002677 for (const auto *Arg : ArgRecords) {
2678 Args.emplace_back(createArgument(*Arg, R.getName()));
Aaron Ballman8f1439b2014-03-05 16:49:55 +00002679 Args.back()->writePCHReadDecls(OS);
Peter Collingbournebee583f2011-10-06 13:03:08 +00002680 }
2681 OS << " New = new (Context) " << R.getName() << "Attr(Range, Context";
Aaron Ballman8f1439b2014-03-05 16:49:55 +00002682 for (auto const &ri : Args) {
Peter Collingbournebee583f2011-10-06 13:03:08 +00002683 OS << ", ";
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +00002684 ri->writePCHReadArgs(OS);
Peter Collingbournebee583f2011-10-06 13:03:08 +00002685 }
Aaron Ballman36a53502014-01-16 13:03:14 +00002686 OS << ", Spelling);\n";
Peter Collingbournebee583f2011-10-06 13:03:08 +00002687 if (R.isSubClassOf(InhClass))
2688 OS << " cast<InheritableAttr>(New)->setInherited(isInherited);\n";
Aaron Ballman36a53502014-01-16 13:03:14 +00002689 OS << " New->setImplicit(isImplicit);\n";
Peter Collingbournebee583f2011-10-06 13:03:08 +00002690 OS << " break;\n";
2691 OS << " }\n";
2692 }
2693 OS << " }\n";
2694}
2695
Jakob Stoklund Olesen995e0e12012-06-13 05:12:41 +00002696// Emits the code to write an attribute to a precompiled header.
2697void EmitClangAttrPCHWrite(RecordKeeper &Records, raw_ostream &OS) {
Dmitri Gribenko6b11fca2013-01-30 21:54:20 +00002698 emitSourceFileHeader("Attribute serialization code", OS);
2699
Peter Collingbournebee583f2011-10-06 13:03:08 +00002700 Record *InhClass = Records.getClass("InheritableAttr");
2701 std::vector<Record*> Attrs = Records.getAllDerivedDefinitions("Attr"), Args;
Peter Collingbournebee583f2011-10-06 13:03:08 +00002702
2703 OS << " switch (A->getKind()) {\n";
Aaron Ballman2f22b942014-05-20 19:47:14 +00002704 for (const auto *Attr : Attrs) {
2705 const Record &R = *Attr;
Douglas Gregorb2daf842012-05-02 15:56:52 +00002706 if (!R.getValueAsBit("ASTNode"))
2707 continue;
Peter Collingbournebee583f2011-10-06 13:03:08 +00002708 OS << " case attr::" << R.getName() << ": {\n";
2709 Args = R.getValueAsListOfDefs("Args");
2710 if (R.isSubClassOf(InhClass) || !Args.empty())
Eugene Zelenko5f02b772015-12-08 18:49:01 +00002711 OS << " const auto *SA = cast<" << R.getName()
Peter Collingbournebee583f2011-10-06 13:03:08 +00002712 << "Attr>(A);\n";
2713 if (R.isSubClassOf(InhClass))
2714 OS << " Record.push_back(SA->isInherited());\n";
Aaron Ballman36a53502014-01-16 13:03:14 +00002715 OS << " Record.push_back(A->isImplicit());\n";
2716 OS << " Record.push_back(A->getSpellingListIndex());\n";
2717
Aaron Ballman2f22b942014-05-20 19:47:14 +00002718 for (const auto *Arg : Args)
2719 createArgument(*Arg, R.getName())->writePCHWrite(OS);
Peter Collingbournebee583f2011-10-06 13:03:08 +00002720 OS << " break;\n";
2721 OS << " }\n";
2722 }
2723 OS << " }\n";
2724}
2725
Erich Keane75449672017-12-20 18:51:08 +00002726// Helper function for GenerateTargetSpecificAttrChecks that alters the 'Test'
2727// parameter with only a single check type, if applicable.
2728static void GenerateTargetSpecificAttrCheck(const Record *R, std::string &Test,
2729 std::string *FnName,
2730 StringRef ListName,
2731 StringRef CheckAgainst,
2732 StringRef Scope) {
2733 if (!R->isValueUnset(ListName)) {
2734 Test += " && (";
2735 std::vector<StringRef> Items = R->getValueAsListOfStrings(ListName);
2736 for (auto I = Items.begin(), E = Items.end(); I != E; ++I) {
2737 StringRef Part = *I;
2738 Test += CheckAgainst;
2739 Test += " == ";
2740 Test += Scope;
2741 Test += Part;
2742 if (I + 1 != E)
2743 Test += " || ";
2744 if (FnName)
2745 *FnName += Part;
2746 }
2747 Test += ")";
2748 }
2749}
2750
Bob Wilson0058b822015-07-20 22:57:36 +00002751// Generate a conditional expression to check if the current target satisfies
2752// the conditions for a TargetSpecificAttr record, and append the code for
2753// those checks to the Test string. If the FnName string pointer is non-null,
2754// append a unique suffix to distinguish this set of target checks from other
2755// TargetSpecificAttr records.
2756static void GenerateTargetSpecificAttrChecks(const Record *R,
Craig Topper00648582017-05-31 19:01:22 +00002757 std::vector<StringRef> &Arches,
Bob Wilson0058b822015-07-20 22:57:36 +00002758 std::string &Test,
2759 std::string *FnName) {
2760 // It is assumed that there will be an llvm::Triple object
2761 // named "T" and a TargetInfo object named "Target" within
2762 // scope that can be used to determine whether the attribute exists in
2763 // a given target.
Erich Keane75449672017-12-20 18:51:08 +00002764 Test += "true";
2765 // If one or more architectures is specified, check those. Arches are handled
2766 // differently because GenerateTargetRequirements needs to combine the list
2767 // with ParseKind.
2768 if (!Arches.empty()) {
2769 Test += " && (";
2770 for (auto I = Arches.begin(), E = Arches.end(); I != E; ++I) {
2771 StringRef Part = *I;
2772 Test += "T.getArch() == llvm::Triple::";
2773 Test += Part;
2774 if (I + 1 != E)
2775 Test += " || ";
2776 if (FnName)
2777 *FnName += Part;
2778 }
2779 Test += ")";
Bob Wilson0058b822015-07-20 22:57:36 +00002780 }
Bob Wilson0058b822015-07-20 22:57:36 +00002781
2782 // If the attribute is specific to particular OSes, check those.
Erich Keane75449672017-12-20 18:51:08 +00002783 GenerateTargetSpecificAttrCheck(R, Test, FnName, "OSes", "T.getOS()",
2784 "llvm::Triple::");
Bob Wilson0058b822015-07-20 22:57:36 +00002785
2786 // If one or more CXX ABIs are specified, check those as well.
Erich Keane75449672017-12-20 18:51:08 +00002787 GenerateTargetSpecificAttrCheck(R, Test, FnName, "CXXABIs",
2788 "Target.getCXXABI().getKind()",
2789 "TargetCXXABI::");
2790 // If one or more object formats is specified, check those.
2791 GenerateTargetSpecificAttrCheck(R, Test, FnName, "ObjectFormats",
2792 "T.getObjectFormat()", "llvm::Triple::");
Bob Wilson0058b822015-07-20 22:57:36 +00002793}
2794
Aaron Ballman2fbf9942014-03-31 13:14:44 +00002795static void GenerateHasAttrSpellingStringSwitch(
2796 const std::vector<Record *> &Attrs, raw_ostream &OS,
2797 const std::string &Variety = "", const std::string &Scope = "") {
2798 for (const auto *Attr : Attrs) {
Aaron Ballmana0344c52014-11-14 13:44:02 +00002799 // C++11-style attributes have specific version information associated with
2800 // them. If the attribute has no scope, the version information must not
2801 // have the default value (1), as that's incorrect. Instead, the unscoped
2802 // attribute version information should be taken from the SD-6 standing
2803 // document, which can be found at:
2804 // https://isocpp.org/std/standing-documents/sd-6-sg10-feature-test-recommendations
2805 int Version = 1;
2806
2807 if (Variety == "CXX11") {
2808 std::vector<Record *> Spellings = Attr->getValueAsListOfDefs("Spellings");
2809 for (const auto &Spelling : Spellings) {
2810 if (Spelling->getValueAsString("Variety") == "CXX11") {
2811 Version = static_cast<int>(Spelling->getValueAsInt("Version"));
2812 if (Scope.empty() && Version == 1)
2813 PrintError(Spelling->getLoc(), "C++ standard attributes must "
2814 "have valid version information.");
2815 break;
2816 }
2817 }
2818 }
2819
Aaron Ballman0fa06d82014-01-09 22:57:44 +00002820 std::string Test;
Aaron Ballman2fbf9942014-03-31 13:14:44 +00002821 if (Attr->isSubClassOf("TargetSpecificAttr")) {
2822 const Record *R = Attr->getValueAsDef("Target");
Craig Topper00648582017-05-31 19:01:22 +00002823 std::vector<StringRef> Arches = R->getValueAsListOfStrings("Arches");
Hans Wennborgdcfba332015-10-06 23:40:43 +00002824 GenerateTargetSpecificAttrChecks(R, Arches, Test, nullptr);
Bob Wilson7c730832015-07-20 22:57:31 +00002825
Aaron Ballman2fbf9942014-03-31 13:14:44 +00002826 // If this is the C++11 variety, also add in the LangOpts test.
2827 if (Variety == "CXX11")
2828 Test += " && LangOpts.CPlusPlus11";
Aaron Ballman606093a2017-10-15 15:01:42 +00002829 else if (Variety == "C2x")
2830 Test += " && LangOpts.DoubleSquareBracketAttributes";
Aaron Ballman2fbf9942014-03-31 13:14:44 +00002831 } else if (Variety == "CXX11")
2832 // C++11 mode should be checked against LangOpts, which is presumed to be
2833 // present in the caller.
2834 Test = "LangOpts.CPlusPlus11";
Aaron Ballman606093a2017-10-15 15:01:42 +00002835 else if (Variety == "C2x")
2836 Test = "LangOpts.DoubleSquareBracketAttributes";
Aaron Ballman0fa06d82014-01-09 22:57:44 +00002837
Aaron Ballmana0344c52014-11-14 13:44:02 +00002838 std::string TestStr =
Aaron Ballman28afa182014-11-17 18:17:19 +00002839 !Test.empty() ? Test + " ? " + llvm::itostr(Version) + " : 0" : "1";
Aaron Ballman2fbf9942014-03-31 13:14:44 +00002840 std::vector<FlattenedSpelling> Spellings = GetFlattenedSpellings(*Attr);
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +00002841 for (const auto &S : Spellings)
Aaron Ballman2fbf9942014-03-31 13:14:44 +00002842 if (Variety.empty() || (Variety == S.variety() &&
2843 (Scope.empty() || Scope == S.nameSpace())))
Aaron Ballmana0344c52014-11-14 13:44:02 +00002844 OS << " .Case(\"" << S.name() << "\", " << TestStr << ")\n";
Peter Collingbournebee583f2011-10-06 13:03:08 +00002845 }
Aaron Ballmana0344c52014-11-14 13:44:02 +00002846 OS << " .Default(0);\n";
Aaron Ballman2fbf9942014-03-31 13:14:44 +00002847}
2848
2849// Emits the list of spellings for attributes.
2850void EmitClangAttrHasAttrImpl(RecordKeeper &Records, raw_ostream &OS) {
2851 emitSourceFileHeader("Code to implement the __has_attribute logic", OS);
2852
2853 // Separate all of the attributes out into four group: generic, C++11, GNU,
2854 // and declspecs. Then generate a big switch statement for each of them.
2855 std::vector<Record *> Attrs = Records.getAllDerivedDefinitions("Attr");
Nico Weber20e08042016-09-03 02:55:10 +00002856 std::vector<Record *> Declspec, Microsoft, GNU, Pragma;
Aaron Ballman606093a2017-10-15 15:01:42 +00002857 std::map<std::string, std::vector<Record *>> CXX, C2x;
Aaron Ballman2fbf9942014-03-31 13:14:44 +00002858
2859 // Walk over the list of all attributes, and split them out based on the
2860 // spelling variety.
2861 for (auto *R : Attrs) {
2862 std::vector<FlattenedSpelling> Spellings = GetFlattenedSpellings(*R);
2863 for (const auto &SI : Spellings) {
Benjamin Kramer2e018ef2016-05-27 13:36:58 +00002864 const std::string &Variety = SI.variety();
Aaron Ballman2fbf9942014-03-31 13:14:44 +00002865 if (Variety == "GNU")
2866 GNU.push_back(R);
2867 else if (Variety == "Declspec")
2868 Declspec.push_back(R);
Nico Weber20e08042016-09-03 02:55:10 +00002869 else if (Variety == "Microsoft")
2870 Microsoft.push_back(R);
Tyler Nowickie8b07ed2014-06-13 17:57:25 +00002871 else if (Variety == "CXX11")
Aaron Ballman2fbf9942014-03-31 13:14:44 +00002872 CXX[SI.nameSpace()].push_back(R);
Aaron Ballman606093a2017-10-15 15:01:42 +00002873 else if (Variety == "C2x")
2874 C2x[SI.nameSpace()].push_back(R);
Tyler Nowickie8b07ed2014-06-13 17:57:25 +00002875 else if (Variety == "Pragma")
2876 Pragma.push_back(R);
Aaron Ballman2fbf9942014-03-31 13:14:44 +00002877 }
2878 }
2879
Bob Wilson7c730832015-07-20 22:57:31 +00002880 OS << "const llvm::Triple &T = Target.getTriple();\n";
Aaron Ballman2fbf9942014-03-31 13:14:44 +00002881 OS << "switch (Syntax) {\n";
Aaron Ballman2fbf9942014-03-31 13:14:44 +00002882 OS << "case AttrSyntax::GNU:\n";
Aaron Ballmana0344c52014-11-14 13:44:02 +00002883 OS << " return llvm::StringSwitch<int>(Name)\n";
Aaron Ballman2fbf9942014-03-31 13:14:44 +00002884 GenerateHasAttrSpellingStringSwitch(GNU, OS, "GNU");
2885 OS << "case AttrSyntax::Declspec:\n";
Aaron Ballmana0344c52014-11-14 13:44:02 +00002886 OS << " return llvm::StringSwitch<int>(Name)\n";
Aaron Ballman2fbf9942014-03-31 13:14:44 +00002887 GenerateHasAttrSpellingStringSwitch(Declspec, OS, "Declspec");
Nico Weber20e08042016-09-03 02:55:10 +00002888 OS << "case AttrSyntax::Microsoft:\n";
2889 OS << " return llvm::StringSwitch<int>(Name)\n";
2890 GenerateHasAttrSpellingStringSwitch(Microsoft, OS, "Microsoft");
Tyler Nowickie8b07ed2014-06-13 17:57:25 +00002891 OS << "case AttrSyntax::Pragma:\n";
Aaron Ballmana0344c52014-11-14 13:44:02 +00002892 OS << " return llvm::StringSwitch<int>(Name)\n";
Tyler Nowickie8b07ed2014-06-13 17:57:25 +00002893 GenerateHasAttrSpellingStringSwitch(Pragma, OS, "Pragma");
Aaron Ballman606093a2017-10-15 15:01:42 +00002894 auto fn = [&OS](const char *Spelling, const char *Variety,
2895 const std::map<std::string, std::vector<Record *>> &List) {
2896 OS << "case AttrSyntax::" << Variety << ": {\n";
2897 // C++11-style attributes are further split out based on the Scope.
2898 for (auto I = List.cbegin(), E = List.cend(); I != E; ++I) {
2899 if (I != List.cbegin())
2900 OS << " else ";
2901 if (I->first.empty())
2902 OS << "if (!Scope || Scope->getName() == \"\") {\n";
2903 else
2904 OS << "if (Scope->getName() == \"" << I->first << "\") {\n";
2905 OS << " return llvm::StringSwitch<int>(Name)\n";
2906 GenerateHasAttrSpellingStringSwitch(I->second, OS, Spelling, I->first);
2907 OS << "}";
2908 }
Aaron Ballman4ff3b5ab2017-10-18 12:11:58 +00002909 OS << "\n} break;\n";
Aaron Ballman606093a2017-10-15 15:01:42 +00002910 };
2911 fn("CXX11", "CXX", CXX);
2912 fn("C2x", "C", C2x);
Aaron Ballman2fbf9942014-03-31 13:14:44 +00002913 OS << "}\n";
Peter Collingbournebee583f2011-10-06 13:03:08 +00002914}
2915
Michael Han99315932013-01-24 16:46:58 +00002916void EmitClangAttrSpellingListIndex(RecordKeeper &Records, raw_ostream &OS) {
Dmitri Gribenko6b11fca2013-01-30 21:54:20 +00002917 emitSourceFileHeader("Code to translate different attribute spellings "
2918 "into internal identifiers", OS);
Michael Han99315932013-01-24 16:46:58 +00002919
John McCall2225c8b2016-03-01 00:18:05 +00002920 OS << " switch (AttrKind) {\n";
Michael Han99315932013-01-24 16:46:58 +00002921
Aaron Ballman64e69862013-12-15 13:05:48 +00002922 ParsedAttrMap Attrs = getParsedAttrList(Records);
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +00002923 for (const auto &I : Attrs) {
Aaron Ballman2f22b942014-05-20 19:47:14 +00002924 const Record &R = *I.second;
Aaron Ballmanc669cc02014-01-27 22:10:04 +00002925 std::vector<FlattenedSpelling> Spellings = GetFlattenedSpellings(R);
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +00002926 OS << " case AT_" << I.first << ": {\n";
Richard Smith852e9ce2013-11-27 01:46:48 +00002927 for (unsigned I = 0; I < Spellings.size(); ++ I) {
Tyler Nowickie8b07ed2014-06-13 17:57:25 +00002928 OS << " if (Name == \"" << Spellings[I].name() << "\" && "
2929 << "SyntaxUsed == "
2930 << StringSwitch<unsigned>(Spellings[I].variety())
2931 .Case("GNU", 0)
2932 .Case("CXX11", 1)
Aaron Ballman606093a2017-10-15 15:01:42 +00002933 .Case("C2x", 2)
2934 .Case("Declspec", 3)
2935 .Case("Microsoft", 4)
2936 .Case("Keyword", 5)
2937 .Case("Pragma", 6)
Tyler Nowickie8b07ed2014-06-13 17:57:25 +00002938 .Default(0)
2939 << " && Scope == \"" << Spellings[I].nameSpace() << "\")\n"
2940 << " return " << I << ";\n";
Michael Han99315932013-01-24 16:46:58 +00002941 }
Richard Smith852e9ce2013-11-27 01:46:48 +00002942
2943 OS << " break;\n";
2944 OS << " }\n";
Michael Han99315932013-01-24 16:46:58 +00002945 }
2946
2947 OS << " }\n";
Aaron Ballman64e69862013-12-15 13:05:48 +00002948 OS << " return 0;\n";
Michael Han99315932013-01-24 16:46:58 +00002949}
2950
DeLesley Hutchinsc4a82432013-12-30 17:24:36 +00002951// Emits code used by RecursiveASTVisitor to visit attributes
2952void EmitClangAttrASTVisitor(RecordKeeper &Records, raw_ostream &OS) {
2953 emitSourceFileHeader("Used by RecursiveASTVisitor to visit attributes.", OS);
2954
2955 std::vector<Record*> Attrs = Records.getAllDerivedDefinitions("Attr");
2956
2957 // Write method declarations for Traverse* methods.
2958 // We emit this here because we only generate methods for attributes that
2959 // are declared as ASTNodes.
2960 OS << "#ifdef ATTR_VISITOR_DECLS_ONLY\n\n";
Aaron Ballman2f22b942014-05-20 19:47:14 +00002961 for (const auto *Attr : Attrs) {
2962 const Record &R = *Attr;
DeLesley Hutchinsc4a82432013-12-30 17:24:36 +00002963 if (!R.getValueAsBit("ASTNode"))
2964 continue;
2965 OS << " bool Traverse"
2966 << R.getName() << "Attr(" << R.getName() << "Attr *A);\n";
2967 OS << " bool Visit"
2968 << R.getName() << "Attr(" << R.getName() << "Attr *A) {\n"
2969 << " return true; \n"
Hans Wennborg4afe5042015-07-22 20:46:26 +00002970 << " }\n";
DeLesley Hutchinsc4a82432013-12-30 17:24:36 +00002971 }
2972 OS << "\n#else // ATTR_VISITOR_DECLS_ONLY\n\n";
2973
2974 // Write individual Traverse* methods for each attribute class.
Aaron Ballman2f22b942014-05-20 19:47:14 +00002975 for (const auto *Attr : Attrs) {
2976 const Record &R = *Attr;
DeLesley Hutchinsc4a82432013-12-30 17:24:36 +00002977 if (!R.getValueAsBit("ASTNode"))
2978 continue;
2979
2980 OS << "template <typename Derived>\n"
DeLesley Hutchinsbb79c332013-12-30 21:03:02 +00002981 << "bool VISITORCLASS<Derived>::Traverse"
DeLesley Hutchinsc4a82432013-12-30 17:24:36 +00002982 << R.getName() << "Attr(" << R.getName() << "Attr *A) {\n"
2983 << " if (!getDerived().VisitAttr(A))\n"
2984 << " return false;\n"
2985 << " if (!getDerived().Visit" << R.getName() << "Attr(A))\n"
2986 << " return false;\n";
2987
2988 std::vector<Record*> ArgRecords = R.getValueAsListOfDefs("Args");
Aaron Ballman2f22b942014-05-20 19:47:14 +00002989 for (const auto *Arg : ArgRecords)
2990 createArgument(*Arg, R.getName())->writeASTVisitorTraversal(OS);
DeLesley Hutchinsc4a82432013-12-30 17:24:36 +00002991
2992 OS << " return true;\n";
2993 OS << "}\n\n";
2994 }
2995
2996 // Write generic Traverse routine
2997 OS << "template <typename Derived>\n"
DeLesley Hutchinsbb79c332013-12-30 21:03:02 +00002998 << "bool VISITORCLASS<Derived>::TraverseAttr(Attr *A) {\n"
DeLesley Hutchinsc4a82432013-12-30 17:24:36 +00002999 << " if (!A)\n"
3000 << " return true;\n"
3001 << "\n"
John McCall2225c8b2016-03-01 00:18:05 +00003002 << " switch (A->getKind()) {\n";
DeLesley Hutchinsc4a82432013-12-30 17:24:36 +00003003
Aaron Ballman2f22b942014-05-20 19:47:14 +00003004 for (const auto *Attr : Attrs) {
3005 const Record &R = *Attr;
DeLesley Hutchinsc4a82432013-12-30 17:24:36 +00003006 if (!R.getValueAsBit("ASTNode"))
3007 continue;
3008
3009 OS << " case attr::" << R.getName() << ":\n"
3010 << " return getDerived().Traverse" << R.getName() << "Attr("
3011 << "cast<" << R.getName() << "Attr>(A));\n";
3012 }
John McCall5d7cf772016-03-01 02:09:20 +00003013 OS << " }\n"; // end switch
3014 OS << " llvm_unreachable(\"bad attribute kind\");\n";
DeLesley Hutchinsc4a82432013-12-30 17:24:36 +00003015 OS << "}\n"; // end function
3016 OS << "#endif // ATTR_VISITOR_DECLS_ONLY\n";
3017}
3018
Erich Keanea32910d2017-03-23 18:51:54 +00003019void EmitClangAttrTemplateInstantiateHelper(const std::vector<Record *> &Attrs,
3020 raw_ostream &OS,
3021 bool AppliesToDecl) {
DeLesley Hutchinsceec3062012-01-20 22:37:06 +00003022
Erich Keanea32910d2017-03-23 18:51:54 +00003023 OS << " switch (At->getKind()) {\n";
Aaron Ballman2f22b942014-05-20 19:47:14 +00003024 for (const auto *Attr : Attrs) {
3025 const Record &R = *Attr;
Douglas Gregorb2daf842012-05-02 15:56:52 +00003026 if (!R.getValueAsBit("ASTNode"))
3027 continue;
DeLesley Hutchinsceec3062012-01-20 22:37:06 +00003028 OS << " case attr::" << R.getName() << ": {\n";
Erich Keanea32910d2017-03-23 18:51:54 +00003029 bool ShouldClone = R.getValueAsBit("Clone") &&
3030 (!AppliesToDecl ||
3031 R.getValueAsBit("MeaningfulToClassTemplateDefinition"));
Rafael Espindola7f90b7d2012-05-15 14:09:55 +00003032
3033 if (!ShouldClone) {
Hans Wennborg59dbe862015-09-29 20:56:43 +00003034 OS << " return nullptr;\n";
Rafael Espindola7f90b7d2012-05-15 14:09:55 +00003035 OS << " }\n";
3036 continue;
3037 }
3038
Eugene Zelenko5f02b772015-12-08 18:49:01 +00003039 OS << " const auto *A = cast<"
DeLesley Hutchinsceec3062012-01-20 22:37:06 +00003040 << R.getName() << "Attr>(At);\n";
3041 bool TDependent = R.getValueAsBit("TemplateDependent");
3042
3043 if (!TDependent) {
3044 OS << " return A->clone(C);\n";
3045 OS << " }\n";
3046 continue;
3047 }
3048
3049 std::vector<Record*> ArgRecords = R.getValueAsListOfDefs("Args");
Aaron Ballman8f1439b2014-03-05 16:49:55 +00003050 std::vector<std::unique_ptr<Argument>> Args;
DeLesley Hutchinsceec3062012-01-20 22:37:06 +00003051 Args.reserve(ArgRecords.size());
3052
Aaron Ballman2f22b942014-05-20 19:47:14 +00003053 for (const auto *ArgRecord : ArgRecords)
Aaron Ballman8f1439b2014-03-05 16:49:55 +00003054 Args.emplace_back(createArgument(*ArgRecord, R.getName()));
DeLesley Hutchinsceec3062012-01-20 22:37:06 +00003055
Aaron Ballman8f1439b2014-03-05 16:49:55 +00003056 for (auto const &ai : Args)
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +00003057 ai->writeTemplateInstantiation(OS);
Aaron Ballman8f1439b2014-03-05 16:49:55 +00003058
DeLesley Hutchinsceec3062012-01-20 22:37:06 +00003059 OS << " return new (C) " << R.getName() << "Attr(A->getLocation(), C";
Aaron Ballman8f1439b2014-03-05 16:49:55 +00003060 for (auto const &ai : Args) {
DeLesley Hutchinsceec3062012-01-20 22:37:06 +00003061 OS << ", ";
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +00003062 ai->writeTemplateInstantiationArgs(OS);
DeLesley Hutchinsceec3062012-01-20 22:37:06 +00003063 }
Aaron Ballman36a53502014-01-16 13:03:14 +00003064 OS << ", A->getSpellingListIndex());\n }\n";
DeLesley Hutchinsceec3062012-01-20 22:37:06 +00003065 }
3066 OS << " } // end switch\n"
3067 << " llvm_unreachable(\"Unknown attribute!\");\n"
Erich Keanea32910d2017-03-23 18:51:54 +00003068 << " return nullptr;\n";
3069}
3070
3071// Emits code to instantiate dependent attributes on templates.
3072void EmitClangAttrTemplateInstantiate(RecordKeeper &Records, raw_ostream &OS) {
3073 emitSourceFileHeader("Template instantiation code for attributes", OS);
3074
3075 std::vector<Record*> Attrs = Records.getAllDerivedDefinitions("Attr");
3076
3077 OS << "namespace clang {\n"
3078 << "namespace sema {\n\n"
3079 << "Attr *instantiateTemplateAttribute(const Attr *At, ASTContext &C, "
3080 << "Sema &S,\n"
3081 << " const MultiLevelTemplateArgumentList &TemplateArgs) {\n";
3082 EmitClangAttrTemplateInstantiateHelper(Attrs, OS, /*AppliesToDecl*/false);
3083 OS << "}\n\n"
3084 << "Attr *instantiateTemplateAttributeForDecl(const Attr *At,\n"
3085 << " ASTContext &C, Sema &S,\n"
3086 << " const MultiLevelTemplateArgumentList &TemplateArgs) {\n";
3087 EmitClangAttrTemplateInstantiateHelper(Attrs, OS, /*AppliesToDecl*/true);
3088 OS << "}\n\n"
Benjamin Kramerbf8da9d2012-02-06 11:13:08 +00003089 << "} // end namespace sema\n"
3090 << "} // end namespace clang\n";
DeLesley Hutchinsceec3062012-01-20 22:37:06 +00003091}
3092
Aaron Ballman8ee40b72013-09-09 23:33:17 +00003093// Emits the list of parsed attributes.
3094void EmitClangAttrParsedAttrList(RecordKeeper &Records, raw_ostream &OS) {
3095 emitSourceFileHeader("List of all attributes that Clang recognizes", OS);
3096
3097 OS << "#ifndef PARSED_ATTR\n";
3098 OS << "#define PARSED_ATTR(NAME) NAME\n";
3099 OS << "#endif\n\n";
3100
3101 ParsedAttrMap Names = getParsedAttrList(Records);
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +00003102 for (const auto &I : Names) {
3103 OS << "PARSED_ATTR(" << I.first << ")\n";
Aaron Ballman8ee40b72013-09-09 23:33:17 +00003104 }
3105}
3106
Aaron Ballman8ed8dbd2014-07-31 16:37:04 +00003107static bool isArgVariadic(const Record &R, StringRef AttrName) {
3108 return createArgument(R, AttrName)->isVariadic();
3109}
3110
Erich Keanedf9e8ae2017-10-16 22:47:26 +00003111static void emitArgInfo(const Record &R, raw_ostream &OS) {
Aaron Ballman8ee40b72013-09-09 23:33:17 +00003112 // This function will count the number of arguments specified for the
3113 // attribute and emit the number of required arguments followed by the
3114 // number of optional arguments.
3115 std::vector<Record *> Args = R.getValueAsListOfDefs("Args");
3116 unsigned ArgCount = 0, OptCount = 0;
Aaron Ballman8ed8dbd2014-07-31 16:37:04 +00003117 bool HasVariadic = false;
Aaron Ballman2f22b942014-05-20 19:47:14 +00003118 for (const auto *Arg : Args) {
George Burgess IV8a36ace2016-12-01 17:52:39 +00003119 // If the arg is fake, it's the user's job to supply it: general parsing
3120 // logic shouldn't need to know anything about it.
3121 if (Arg->getValueAsBit("Fake"))
3122 continue;
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +00003123 Arg->getValueAsBit("Optional") ? ++OptCount : ++ArgCount;
Aaron Ballman8ed8dbd2014-07-31 16:37:04 +00003124 if (!HasVariadic && isArgVariadic(*Arg, R.getName()))
3125 HasVariadic = true;
Aaron Ballman8ee40b72013-09-09 23:33:17 +00003126 }
Aaron Ballman8ed8dbd2014-07-31 16:37:04 +00003127
3128 // If there is a variadic argument, we will set the optional argument count
3129 // to its largest value. Since it's currently a 4-bit number, we set it to 15.
3130 OS << ArgCount << ", " << (HasVariadic ? 15 : OptCount);
Aaron Ballman8ee40b72013-09-09 23:33:17 +00003131}
3132
Aaron Ballman74eeeae2013-11-27 13:27:02 +00003133static void GenerateDefaultAppertainsTo(raw_ostream &OS) {
Aaron Ballman93b5cc62013-12-02 19:36:42 +00003134 OS << "static bool defaultAppertainsTo(Sema &, const AttributeList &,";
Aaron Ballman74eeeae2013-11-27 13:27:02 +00003135 OS << "const Decl *) {\n";
3136 OS << " return true;\n";
3137 OS << "}\n\n";
3138}
3139
Aaron Ballmanadf66b62017-11-26 20:01:12 +00003140static std::string GetDiagnosticSpelling(const Record &R) {
3141 std::string Ret = R.getValueAsString("DiagSpelling");
3142 if (!Ret.empty())
3143 return Ret;
3144
3145 // If we couldn't find the DiagSpelling in this object, we can check to see
3146 // if the object is one that has a base, and if it is, loop up to the Base
3147 // member recursively.
3148 std::string Super = R.getSuperClasses().back().first->getName();
3149 if (Super == "DDecl" || Super == "DStmt")
3150 return GetDiagnosticSpelling(*R.getValueAsDef("Base"));
3151
3152 return "";
3153}
3154
Aaron Ballman74eeeae2013-11-27 13:27:02 +00003155static std::string CalculateDiagnostic(const Record &S) {
3156 // If the SubjectList object has a custom diagnostic associated with it,
3157 // return that directly.
Erich Keane3bff4142017-10-16 23:25:24 +00003158 const StringRef CustomDiag = S.getValueAsString("CustomDiag");
Aaron Ballman74eeeae2013-11-27 13:27:02 +00003159 if (!CustomDiag.empty())
Aaron Ballmanadf66b62017-11-26 20:01:12 +00003160 return ("\"" + Twine(CustomDiag) + "\"").str();
Aaron Ballman74eeeae2013-11-27 13:27:02 +00003161
Aaron Ballmanadf66b62017-11-26 20:01:12 +00003162 std::vector<std::string> DiagList;
Aaron Ballman74eeeae2013-11-27 13:27:02 +00003163 std::vector<Record *> Subjects = S.getValueAsListOfDefs("Subjects");
Aaron Ballman2f22b942014-05-20 19:47:14 +00003164 for (const auto *Subject : Subjects) {
3165 const Record &R = *Subject;
Aaron Ballmanadf66b62017-11-26 20:01:12 +00003166 // Get the diagnostic text from the Decl or Stmt node given.
3167 std::string V = GetDiagnosticSpelling(R);
3168 if (V.empty()) {
3169 PrintError(R.getLoc(),
3170 "Could not determine diagnostic spelling for the node: " +
3171 R.getName() + "; please add one to DeclNodes.td");
3172 } else {
3173 // The node may contain a list of elements itself, so split the elements
3174 // by a comma, and trim any whitespace.
3175 SmallVector<StringRef, 2> Frags;
3176 llvm::SplitString(V, Frags, ",");
3177 for (auto Str : Frags) {
3178 DiagList.push_back(Str.trim());
3179 }
Aaron Ballman74eeeae2013-11-27 13:27:02 +00003180 }
Aaron Ballman74eeeae2013-11-27 13:27:02 +00003181 }
3182
Aaron Ballmanadf66b62017-11-26 20:01:12 +00003183 if (DiagList.empty()) {
3184 PrintFatalError(S.getLoc(),
3185 "Could not deduce diagnostic argument for Attr subjects");
3186 return "";
Aaron Ballman74eeeae2013-11-27 13:27:02 +00003187 }
3188
Aaron Ballmanadf66b62017-11-26 20:01:12 +00003189 // FIXME: this is not particularly good for localization purposes and ideally
3190 // should be part of the diagnostics engine itself with some sort of list
3191 // specifier.
Aaron Ballman74eeeae2013-11-27 13:27:02 +00003192
Aaron Ballmanadf66b62017-11-26 20:01:12 +00003193 // A single member of the list can be returned directly.
3194 if (DiagList.size() == 1)
3195 return '"' + DiagList.front() + '"';
3196
3197 if (DiagList.size() == 2)
3198 return '"' + DiagList[0] + " and " + DiagList[1] + '"';
3199
3200 // If there are more than two in the list, we serialize the first N - 1
3201 // elements with a comma. This leaves the string in the state: foo, bar,
3202 // baz (but misses quux). We can then add ", and " for the last element
3203 // manually.
3204 std::string Diag = llvm::join(DiagList.begin(), DiagList.end() - 1, ", ");
3205 return '"' + Diag + ", and " + *(DiagList.end() - 1) + '"';
Aaron Ballman74eeeae2013-11-27 13:27:02 +00003206}
3207
Aaron Ballman12b9f652014-01-16 13:55:42 +00003208static std::string GetSubjectWithSuffix(const Record *R) {
George Burgess IV1881a572016-12-01 00:13:18 +00003209 const std::string &B = R->getName();
Aaron Ballman12b9f652014-01-16 13:55:42 +00003210 if (B == "DeclBase")
3211 return "Decl";
3212 return B + "Decl";
3213}
Hans Wennborgdcfba332015-10-06 23:40:43 +00003214
Alex Lorenz9e7bf162017-04-18 14:33:39 +00003215static std::string functionNameForCustomAppertainsTo(const Record &Subject) {
3216 return "is" + Subject.getName().str();
3217}
3218
Aaron Ballman80469032013-11-29 14:57:58 +00003219static std::string GenerateCustomAppertainsTo(const Record &Subject,
3220 raw_ostream &OS) {
Alex Lorenz9e7bf162017-04-18 14:33:39 +00003221 std::string FnName = functionNameForCustomAppertainsTo(Subject);
Aaron Ballmana358c902013-12-02 14:58:17 +00003222
Aaron Ballman80469032013-11-29 14:57:58 +00003223 // If this code has already been generated, simply return the previous
3224 // instance of it.
3225 static std::set<std::string> CustomSubjectSet;
Eugene Zelenko5f02b772015-12-08 18:49:01 +00003226 auto I = CustomSubjectSet.find(FnName);
Aaron Ballman80469032013-11-29 14:57:58 +00003227 if (I != CustomSubjectSet.end())
3228 return *I;
3229
3230 Record *Base = Subject.getValueAsDef("Base");
3231
3232 // Not currently support custom subjects within custom subjects.
3233 if (Base->isSubClassOf("SubsetSubject")) {
3234 PrintFatalError(Subject.getLoc(),
3235 "SubsetSubjects within SubsetSubjects is not supported");
3236 return "";
3237 }
3238
Aaron Ballman80469032013-11-29 14:57:58 +00003239 OS << "static bool " << FnName << "(const Decl *D) {\n";
Eugene Zelenko5f02b772015-12-08 18:49:01 +00003240 OS << " if (const auto *S = dyn_cast<";
Aaron Ballman12b9f652014-01-16 13:55:42 +00003241 OS << GetSubjectWithSuffix(Base);
Aaron Ballman47553042014-01-16 14:32:03 +00003242 OS << ">(D))\n";
3243 OS << " return " << Subject.getValueAsString("CheckCode") << ";\n";
3244 OS << " return false;\n";
Aaron Ballman80469032013-11-29 14:57:58 +00003245 OS << "}\n\n";
3246
3247 CustomSubjectSet.insert(FnName);
3248 return FnName;
3249}
3250
Aaron Ballman74eeeae2013-11-27 13:27:02 +00003251static std::string GenerateAppertainsTo(const Record &Attr, raw_ostream &OS) {
3252 // If the attribute does not contain a Subjects definition, then use the
3253 // default appertainsTo logic.
3254 if (Attr.isValueUnset("Subjects"))
Aaron Ballman93b5cc62013-12-02 19:36:42 +00003255 return "defaultAppertainsTo";
Aaron Ballman74eeeae2013-11-27 13:27:02 +00003256
3257 const Record *SubjectObj = Attr.getValueAsDef("Subjects");
3258 std::vector<Record*> Subjects = SubjectObj->getValueAsListOfDefs("Subjects");
3259
3260 // If the list of subjects is empty, it is assumed that the attribute
3261 // appertains to everything.
3262 if (Subjects.empty())
Aaron Ballman93b5cc62013-12-02 19:36:42 +00003263 return "defaultAppertainsTo";
Aaron Ballman74eeeae2013-11-27 13:27:02 +00003264
Aaron Ballman74eeeae2013-11-27 13:27:02 +00003265 bool Warn = SubjectObj->getValueAsDef("Diag")->getValueAsBit("Warn");
3266
3267 // Otherwise, generate an appertainsTo check specific to this attribute which
3268 // checks all of the given subjects against the Decl passed in. Return the
3269 // name of that check to the caller.
Matthias Braunbbbf5d42016-12-04 05:55:09 +00003270 std::string FnName = "check" + Attr.getName().str() + "AppertainsTo";
Aaron Ballman74eeeae2013-11-27 13:27:02 +00003271 std::stringstream SS;
3272 SS << "static bool " << FnName << "(Sema &S, const AttributeList &Attr, ";
3273 SS << "const Decl *D) {\n";
3274 SS << " if (";
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +00003275 for (auto I = Subjects.begin(), E = Subjects.end(); I != E; ++I) {
Aaron Ballman80469032013-11-29 14:57:58 +00003276 // If the subject has custom code associated with it, generate a function
3277 // for it. The function cannot be inlined into this check (yet) because it
3278 // requires the subject to be of a specific type, and were that information
3279 // inlined here, it would not support an attribute with multiple custom
3280 // subjects.
3281 if ((*I)->isSubClassOf("SubsetSubject")) {
3282 SS << "!" << GenerateCustomAppertainsTo(**I, OS) << "(D)";
3283 } else {
Aaron Ballman12b9f652014-01-16 13:55:42 +00003284 SS << "!isa<" << GetSubjectWithSuffix(*I) << ">(D)";
Aaron Ballman80469032013-11-29 14:57:58 +00003285 }
Aaron Ballman74eeeae2013-11-27 13:27:02 +00003286
Aaron Ballman74eeeae2013-11-27 13:27:02 +00003287 if (I + 1 != E)
3288 SS << " && ";
3289 }
3290 SS << ") {\n";
3291 SS << " S.Diag(Attr.getLoc(), diag::";
Aaron Ballmanadf66b62017-11-26 20:01:12 +00003292 SS << (Warn ? "warn_attribute_wrong_decl_type_str" :
3293 "err_attribute_wrong_decl_type_str");
Aaron Ballman74eeeae2013-11-27 13:27:02 +00003294 SS << ")\n";
3295 SS << " << Attr.getName() << ";
3296 SS << CalculateDiagnostic(*SubjectObj) << ";\n";
3297 SS << " return false;\n";
3298 SS << " }\n";
3299 SS << " return true;\n";
3300 SS << "}\n\n";
3301
Aaron Ballman74eeeae2013-11-27 13:27:02 +00003302 OS << SS.str();
3303 return FnName;
3304}
3305
Alex Lorenz9e7bf162017-04-18 14:33:39 +00003306static void
3307emitAttributeMatchRules(PragmaClangAttributeSupport &PragmaAttributeSupport,
3308 raw_ostream &OS) {
3309 OS << "static bool checkAttributeMatchRuleAppliesTo(const Decl *D, "
3310 << AttributeSubjectMatchRule::EnumName << " rule) {\n";
3311 OS << " switch (rule) {\n";
3312 for (const auto &Rule : PragmaAttributeSupport.Rules) {
3313 if (Rule.isAbstractRule()) {
3314 OS << " case " << Rule.getEnumValue() << ":\n";
3315 OS << " assert(false && \"Abstract matcher rule isn't allowed\");\n";
3316 OS << " return false;\n";
3317 continue;
3318 }
3319 std::vector<Record *> Subjects = Rule.getSubjects();
3320 assert(!Subjects.empty() && "Missing subjects");
3321 OS << " case " << Rule.getEnumValue() << ":\n";
3322 OS << " return ";
3323 for (auto I = Subjects.begin(), E = Subjects.end(); I != E; ++I) {
3324 // If the subject has custom code associated with it, use the function
3325 // that was generated for GenerateAppertainsTo to check if the declaration
3326 // is valid.
3327 if ((*I)->isSubClassOf("SubsetSubject"))
3328 OS << functionNameForCustomAppertainsTo(**I) << "(D)";
3329 else
3330 OS << "isa<" << GetSubjectWithSuffix(*I) << ">(D)";
3331
3332 if (I + 1 != E)
3333 OS << " || ";
3334 }
3335 OS << ";\n";
3336 }
3337 OS << " }\n";
3338 OS << " llvm_unreachable(\"Invalid match rule\");\nreturn false;\n";
3339 OS << "}\n\n";
3340}
3341
Aaron Ballman3aff6332013-12-02 19:30:36 +00003342static void GenerateDefaultLangOptRequirements(raw_ostream &OS) {
3343 OS << "static bool defaultDiagnoseLangOpts(Sema &, ";
3344 OS << "const AttributeList &) {\n";
3345 OS << " return true;\n";
3346 OS << "}\n\n";
3347}
3348
3349static std::string GenerateLangOptRequirements(const Record &R,
3350 raw_ostream &OS) {
3351 // If the attribute has an empty or unset list of language requirements,
3352 // return the default handler.
3353 std::vector<Record *> LangOpts = R.getValueAsListOfDefs("LangOpts");
3354 if (LangOpts.empty())
3355 return "defaultDiagnoseLangOpts";
3356
3357 // Generate the test condition, as well as a unique function name for the
3358 // diagnostic test. The list of options should usually be short (one or two
3359 // options), and the uniqueness isn't strictly necessary (it is just for
3360 // codegen efficiency).
3361 std::string FnName = "check", Test;
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +00003362 for (auto I = LangOpts.begin(), E = LangOpts.end(); I != E; ++I) {
Erich Keane3bff4142017-10-16 23:25:24 +00003363 const StringRef Part = (*I)->getValueAsString("Name");
Eric Fiselier341e8252016-09-02 18:53:31 +00003364 if ((*I)->getValueAsBit("Negated")) {
3365 FnName += "Not";
Alexis Hunt724f14e2014-11-28 00:53:20 +00003366 Test += "!";
Eric Fiselier341e8252016-09-02 18:53:31 +00003367 }
Erich Keane3bff4142017-10-16 23:25:24 +00003368 Test += "S.LangOpts.";
3369 Test += Part;
Aaron Ballman3aff6332013-12-02 19:30:36 +00003370 if (I + 1 != E)
3371 Test += " || ";
3372 FnName += Part;
3373 }
3374 FnName += "LangOpts";
3375
3376 // If this code has already been generated, simply return the previous
3377 // instance of it.
3378 static std::set<std::string> CustomLangOptsSet;
Eugene Zelenko5f02b772015-12-08 18:49:01 +00003379 auto I = CustomLangOptsSet.find(FnName);
Aaron Ballman3aff6332013-12-02 19:30:36 +00003380 if (I != CustomLangOptsSet.end())
3381 return *I;
3382
3383 OS << "static bool " << FnName << "(Sema &S, const AttributeList &Attr) {\n";
3384 OS << " if (" << Test << ")\n";
3385 OS << " return true;\n\n";
3386 OS << " S.Diag(Attr.getLoc(), diag::warn_attribute_ignored) ";
3387 OS << "<< Attr.getName();\n";
3388 OS << " return false;\n";
3389 OS << "}\n\n";
3390
3391 CustomLangOptsSet.insert(FnName);
3392 return FnName;
3393}
3394
Aaron Ballmanab7691c2014-01-09 22:48:32 +00003395static void GenerateDefaultTargetRequirements(raw_ostream &OS) {
Bob Wilson7c730832015-07-20 22:57:31 +00003396 OS << "static bool defaultTargetRequirements(const TargetInfo &) {\n";
Aaron Ballmanab7691c2014-01-09 22:48:32 +00003397 OS << " return true;\n";
3398 OS << "}\n\n";
3399}
3400
3401static std::string GenerateTargetRequirements(const Record &Attr,
3402 const ParsedAttrMap &Dupes,
3403 raw_ostream &OS) {
3404 // If the attribute is not a target specific attribute, return the default
3405 // target handler.
3406 if (!Attr.isSubClassOf("TargetSpecificAttr"))
3407 return "defaultTargetRequirements";
3408
3409 // Get the list of architectures to be tested for.
3410 const Record *R = Attr.getValueAsDef("Target");
Craig Topper00648582017-05-31 19:01:22 +00003411 std::vector<StringRef> Arches = R->getValueAsListOfStrings("Arches");
Aaron Ballmanab7691c2014-01-09 22:48:32 +00003412
3413 // If there are other attributes which share the same parsed attribute kind,
3414 // such as target-specific attributes with a shared spelling, collapse the
3415 // duplicate architectures. This is required because a shared target-specific
3416 // attribute has only one AttributeList::Kind enumeration value, but it
3417 // applies to multiple target architectures. In order for the attribute to be
3418 // considered valid, all of its architectures need to be included.
3419 if (!Attr.isValueUnset("ParseKind")) {
Erich Keane3bff4142017-10-16 23:25:24 +00003420 const StringRef APK = Attr.getValueAsString("ParseKind");
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +00003421 for (const auto &I : Dupes) {
3422 if (I.first == APK) {
Craig Topper00648582017-05-31 19:01:22 +00003423 std::vector<StringRef> DA =
3424 I.second->getValueAsDef("Target")->getValueAsListOfStrings(
3425 "Arches");
3426 Arches.insert(Arches.end(), DA.begin(), DA.end());
Aaron Ballmanab7691c2014-01-09 22:48:32 +00003427 }
3428 }
3429 }
3430
Bob Wilson0058b822015-07-20 22:57:36 +00003431 std::string FnName = "isTarget";
3432 std::string Test;
3433 GenerateTargetSpecificAttrChecks(R, Arches, Test, &FnName);
Bob Wilson7c730832015-07-20 22:57:31 +00003434
Aaron Ballmanab7691c2014-01-09 22:48:32 +00003435 // If this code has already been generated, simply return the previous
3436 // instance of it.
3437 static std::set<std::string> CustomTargetSet;
Eugene Zelenko5f02b772015-12-08 18:49:01 +00003438 auto I = CustomTargetSet.find(FnName);
Aaron Ballmanab7691c2014-01-09 22:48:32 +00003439 if (I != CustomTargetSet.end())
3440 return *I;
3441
Bob Wilson7c730832015-07-20 22:57:31 +00003442 OS << "static bool " << FnName << "(const TargetInfo &Target) {\n";
3443 OS << " const llvm::Triple &T = Target.getTriple();\n";
Aaron Ballmanab7691c2014-01-09 22:48:32 +00003444 OS << " return " << Test << ";\n";
3445 OS << "}\n\n";
3446
3447 CustomTargetSet.insert(FnName);
3448 return FnName;
3449}
3450
Aaron Ballman81cb8cb2014-01-24 21:32:49 +00003451static void GenerateDefaultSpellingIndexToSemanticSpelling(raw_ostream &OS) {
3452 OS << "static unsigned defaultSpellingIndexToSemanticSpelling("
3453 << "const AttributeList &Attr) {\n";
3454 OS << " return UINT_MAX;\n";
3455 OS << "}\n\n";
3456}
3457
3458static std::string GenerateSpellingIndexToSemanticSpelling(const Record &Attr,
3459 raw_ostream &OS) {
3460 // If the attribute does not have a semantic form, we can bail out early.
3461 if (!Attr.getValueAsBit("ASTNode"))
3462 return "defaultSpellingIndexToSemanticSpelling";
3463
Aaron Ballmanc669cc02014-01-27 22:10:04 +00003464 std::vector<FlattenedSpelling> Spellings = GetFlattenedSpellings(Attr);
Aaron Ballman81cb8cb2014-01-24 21:32:49 +00003465
3466 // If there are zero or one spellings, or all of the spellings share the same
3467 // name, we can also bail out early.
3468 if (Spellings.size() <= 1 || SpellingNamesAreCommon(Spellings))
3469 return "defaultSpellingIndexToSemanticSpelling";
3470
3471 // Generate the enumeration we will use for the mapping.
3472 SemanticSpellingMap SemanticToSyntacticMap;
3473 std::string Enum = CreateSemanticSpellings(Spellings, SemanticToSyntacticMap);
Matthias Braunbbbf5d42016-12-04 05:55:09 +00003474 std::string Name = Attr.getName().str() + "AttrSpellingMap";
Aaron Ballman81cb8cb2014-01-24 21:32:49 +00003475
3476 OS << "static unsigned " << Name << "(const AttributeList &Attr) {\n";
3477 OS << Enum;
3478 OS << " unsigned Idx = Attr.getAttributeSpellingListIndex();\n";
3479 WriteSemanticSpellingSwitch("Idx", SemanticToSyntacticMap, OS);
3480 OS << "}\n\n";
3481
3482 return Name;
3483}
3484
Aaron Ballmanc669cc02014-01-27 22:10:04 +00003485static bool IsKnownToGCC(const Record &Attr) {
3486 // Look at the spellings for this subject; if there are any spellings which
3487 // claim to be known to GCC, the attribute is known to GCC.
George Burgess IV1881a572016-12-01 00:13:18 +00003488 return llvm::any_of(
3489 GetFlattenedSpellings(Attr),
3490 [](const FlattenedSpelling &S) { return S.knownToGCC(); });
Aaron Ballman9a99e0d2014-01-20 17:18:35 +00003491}
3492
Aaron Ballman8ee40b72013-09-09 23:33:17 +00003493/// Emits the parsed attribute helpers
3494void EmitClangAttrParsedAttrImpl(RecordKeeper &Records, raw_ostream &OS) {
3495 emitSourceFileHeader("Parsed attribute helpers", OS);
3496
Alex Lorenz9e7bf162017-04-18 14:33:39 +00003497 PragmaClangAttributeSupport &PragmaAttributeSupport =
3498 getPragmaAttributeSupport(Records);
3499
Aaron Ballmanab7691c2014-01-09 22:48:32 +00003500 // Get the list of parsed attributes, and accept the optional list of
3501 // duplicates due to the ParseKind.
3502 ParsedAttrMap Dupes;
3503 ParsedAttrMap Attrs = getParsedAttrList(Records, &Dupes);
Aaron Ballman8ee40b72013-09-09 23:33:17 +00003504
Aaron Ballman81cb8cb2014-01-24 21:32:49 +00003505 // Generate the default appertainsTo, target and language option diagnostic,
3506 // and spelling list index mapping methods.
Aaron Ballman74eeeae2013-11-27 13:27:02 +00003507 GenerateDefaultAppertainsTo(OS);
Aaron Ballman3aff6332013-12-02 19:30:36 +00003508 GenerateDefaultLangOptRequirements(OS);
Aaron Ballmanab7691c2014-01-09 22:48:32 +00003509 GenerateDefaultTargetRequirements(OS);
Aaron Ballman81cb8cb2014-01-24 21:32:49 +00003510 GenerateDefaultSpellingIndexToSemanticSpelling(OS);
Aaron Ballman74eeeae2013-11-27 13:27:02 +00003511
3512 // Generate the appertainsTo diagnostic methods and write their names into
3513 // another mapping. At the same time, generate the AttrInfoMap object
3514 // contents. Due to the reliance on generated code, use separate streams so
3515 // that code will not be interleaved.
Erich Keanedf9e8ae2017-10-16 22:47:26 +00003516 std::string Buffer;
3517 raw_string_ostream SS {Buffer};
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +00003518 for (auto I = Attrs.begin(), E = Attrs.end(); I != E; ++I) {
Aaron Ballmanab7691c2014-01-09 22:48:32 +00003519 // TODO: If the attribute's kind appears in the list of duplicates, that is
3520 // because it is a target-specific attribute that appears multiple times.
3521 // It would be beneficial to test whether the duplicates are "similar
3522 // enough" to each other to not cause problems. For instance, check that
Alp Toker96cf7582014-01-18 21:49:37 +00003523 // the spellings are identical, and custom parsing rules match, etc.
Aaron Ballmanab7691c2014-01-09 22:48:32 +00003524
Aaron Ballman8ee40b72013-09-09 23:33:17 +00003525 // We need to generate struct instances based off ParsedAttrInfo from
3526 // AttributeList.cpp.
Aaron Ballman74eeeae2013-11-27 13:27:02 +00003527 SS << " { ";
3528 emitArgInfo(*I->second, SS);
3529 SS << ", " << I->second->getValueAsBit("HasCustomParsing");
Aaron Ballmanab7691c2014-01-09 22:48:32 +00003530 SS << ", " << I->second->isSubClassOf("TargetSpecificAttr");
3531 SS << ", " << I->second->isSubClassOf("TypeAttr");
Richard Smith4f902c72016-03-08 00:32:55 +00003532 SS << ", " << I->second->isSubClassOf("StmtAttr");
Aaron Ballmanc669cc02014-01-27 22:10:04 +00003533 SS << ", " << IsKnownToGCC(*I->second);
Alex Lorenz9e7bf162017-04-18 14:33:39 +00003534 SS << ", " << PragmaAttributeSupport.isAttributedSupported(*I->second);
Aaron Ballman74eeeae2013-11-27 13:27:02 +00003535 SS << ", " << GenerateAppertainsTo(*I->second, OS);
Aaron Ballman3aff6332013-12-02 19:30:36 +00003536 SS << ", " << GenerateLangOptRequirements(*I->second, OS);
Aaron Ballmanab7691c2014-01-09 22:48:32 +00003537 SS << ", " << GenerateTargetRequirements(*I->second, Dupes, OS);
Aaron Ballman81cb8cb2014-01-24 21:32:49 +00003538 SS << ", " << GenerateSpellingIndexToSemanticSpelling(*I->second, OS);
Alex Lorenz9e7bf162017-04-18 14:33:39 +00003539 SS << ", "
3540 << PragmaAttributeSupport.generateStrictConformsTo(*I->second, OS);
Aaron Ballman74eeeae2013-11-27 13:27:02 +00003541 SS << " }";
Aaron Ballman8ee40b72013-09-09 23:33:17 +00003542
3543 if (I + 1 != E)
Aaron Ballman74eeeae2013-11-27 13:27:02 +00003544 SS << ",";
3545
3546 SS << " // AT_" << I->first << "\n";
Aaron Ballman8ee40b72013-09-09 23:33:17 +00003547 }
Aaron Ballman74eeeae2013-11-27 13:27:02 +00003548
3549 OS << "static const ParsedAttrInfo AttrInfoMap[AttributeList::UnknownAttribute + 1] = {\n";
3550 OS << SS.str();
Aaron Ballman8ee40b72013-09-09 23:33:17 +00003551 OS << "};\n\n";
Alex Lorenz9e7bf162017-04-18 14:33:39 +00003552
3553 // Generate the attribute match rules.
3554 emitAttributeMatchRules(PragmaAttributeSupport, OS);
Michael Han4a045172012-03-07 00:12:16 +00003555}
3556
Jakob Stoklund Olesen995e0e12012-06-13 05:12:41 +00003557// Emits the kind list of parsed attributes
3558void EmitClangAttrParsedAttrKinds(RecordKeeper &Records, raw_ostream &OS) {
Dmitri Gribenko6b11fca2013-01-30 21:54:20 +00003559 emitSourceFileHeader("Attribute name matcher", OS);
3560
Aaron Ballman09e98ff2014-01-13 21:42:39 +00003561 std::vector<Record *> Attrs = Records.getAllDerivedDefinitions("Attr");
Nico Weber20e08042016-09-03 02:55:10 +00003562 std::vector<StringMatcher::StringPair> GNU, Declspec, Microsoft, CXX11,
Aaron Ballman606093a2017-10-15 15:01:42 +00003563 Keywords, Pragma, C2x;
Aaron Ballman64e69862013-12-15 13:05:48 +00003564 std::set<std::string> Seen;
Aaron Ballman2f22b942014-05-20 19:47:14 +00003565 for (const auto *A : Attrs) {
3566 const Record &Attr = *A;
Richard Smith852e9ce2013-11-27 01:46:48 +00003567
Michael Han4a045172012-03-07 00:12:16 +00003568 bool SemaHandler = Attr.getValueAsBit("SemaHandler");
Douglas Gregor19fbb8f2012-05-02 16:18:45 +00003569 bool Ignored = Attr.getValueAsBit("Ignored");
Douglas Gregor19fbb8f2012-05-02 16:18:45 +00003570 if (SemaHandler || Ignored) {
Aaron Ballman09e98ff2014-01-13 21:42:39 +00003571 // Attribute spellings can be shared between target-specific attributes,
3572 // and can be shared between syntaxes for the same attribute. For
3573 // instance, an attribute can be spelled GNU<"interrupt"> for an ARM-
3574 // specific attribute, or MSP430-specific attribute. Additionally, an
3575 // attribute can be spelled GNU<"dllexport"> and Declspec<"dllexport">
3576 // for the same semantic attribute. Ultimately, we need to map each of
3577 // these to a single AttributeList::Kind value, but the StringMatcher
3578 // class cannot handle duplicate match strings. So we generate a list of
3579 // string to match based on the syntax, and emit multiple string matchers
3580 // depending on the syntax used.
Aaron Ballman64e69862013-12-15 13:05:48 +00003581 std::string AttrName;
3582 if (Attr.isSubClassOf("TargetSpecificAttr") &&
3583 !Attr.isValueUnset("ParseKind")) {
3584 AttrName = Attr.getValueAsString("ParseKind");
3585 if (Seen.find(AttrName) != Seen.end())
3586 continue;
3587 Seen.insert(AttrName);
3588 } else
3589 AttrName = NormalizeAttrName(StringRef(Attr.getName())).str();
3590
Aaron Ballmanc669cc02014-01-27 22:10:04 +00003591 std::vector<FlattenedSpelling> Spellings = GetFlattenedSpellings(Attr);
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +00003592 for (const auto &S : Spellings) {
Benjamin Kramer2e018ef2016-05-27 13:36:58 +00003593 const std::string &RawSpelling = S.name();
Craig Topper8ae12032014-05-07 06:21:57 +00003594 std::vector<StringMatcher::StringPair> *Matches = nullptr;
Benjamin Kramer2e018ef2016-05-27 13:36:58 +00003595 std::string Spelling;
3596 const std::string &Variety = S.variety();
Aaron Ballman09e98ff2014-01-13 21:42:39 +00003597 if (Variety == "CXX11") {
3598 Matches = &CXX11;
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +00003599 Spelling += S.nameSpace();
Alexis Hunt3bc72c12012-06-19 23:57:03 +00003600 Spelling += "::";
Aaron Ballman606093a2017-10-15 15:01:42 +00003601 } else if (Variety == "C2x") {
3602 Matches = &C2x;
3603 Spelling += S.nameSpace();
3604 Spelling += "::";
Aaron Ballman09e98ff2014-01-13 21:42:39 +00003605 } else if (Variety == "GNU")
3606 Matches = &GNU;
3607 else if (Variety == "Declspec")
3608 Matches = &Declspec;
Nico Weber20e08042016-09-03 02:55:10 +00003609 else if (Variety == "Microsoft")
3610 Matches = &Microsoft;
Aaron Ballman09e98ff2014-01-13 21:42:39 +00003611 else if (Variety == "Keyword")
3612 Matches = &Keywords;
Tyler Nowickie8b07ed2014-06-13 17:57:25 +00003613 else if (Variety == "Pragma")
3614 Matches = &Pragma;
Alexis Hunta0e54d42012-06-18 16:13:52 +00003615
Aaron Ballman09e98ff2014-01-13 21:42:39 +00003616 assert(Matches && "Unsupported spelling variety found");
3617
Justin Lebar4086fe52017-01-05 16:51:54 +00003618 if (Variety == "GNU")
3619 Spelling += NormalizeGNUAttrSpelling(RawSpelling);
3620 else
3621 Spelling += RawSpelling;
3622
Douglas Gregor19fbb8f2012-05-02 16:18:45 +00003623 if (SemaHandler)
Aaron Ballman09e98ff2014-01-13 21:42:39 +00003624 Matches->push_back(StringMatcher::StringPair(Spelling,
3625 "return AttributeList::AT_" + AttrName + ";"));
Douglas Gregor19fbb8f2012-05-02 16:18:45 +00003626 else
Aaron Ballman09e98ff2014-01-13 21:42:39 +00003627 Matches->push_back(StringMatcher::StringPair(Spelling,
3628 "return AttributeList::IgnoredAttribute;"));
Michael Han4a045172012-03-07 00:12:16 +00003629 }
3630 }
3631 }
Douglas Gregor377f99b2012-05-02 17:33:51 +00003632
Aaron Ballman09e98ff2014-01-13 21:42:39 +00003633 OS << "static AttributeList::Kind getAttrKind(StringRef Name, ";
3634 OS << "AttributeList::Syntax Syntax) {\n";
3635 OS << " if (AttributeList::AS_GNU == Syntax) {\n";
3636 StringMatcher("Name", GNU, OS).Emit();
3637 OS << " } else if (AttributeList::AS_Declspec == Syntax) {\n";
3638 StringMatcher("Name", Declspec, OS).Emit();
Nico Weber20e08042016-09-03 02:55:10 +00003639 OS << " } else if (AttributeList::AS_Microsoft == Syntax) {\n";
3640 StringMatcher("Name", Microsoft, OS).Emit();
Aaron Ballman09e98ff2014-01-13 21:42:39 +00003641 OS << " } else if (AttributeList::AS_CXX11 == Syntax) {\n";
3642 StringMatcher("Name", CXX11, OS).Emit();
Aaron Ballman606093a2017-10-15 15:01:42 +00003643 OS << " } else if (AttributeList::AS_C2x == Syntax) {\n";
3644 StringMatcher("Name", C2x, OS).Emit();
Douglas Gregorbec595a2015-06-19 18:27:45 +00003645 OS << " } else if (AttributeList::AS_Keyword == Syntax || ";
3646 OS << "AttributeList::AS_ContextSensitiveKeyword == Syntax) {\n";
Aaron Ballman09e98ff2014-01-13 21:42:39 +00003647 StringMatcher("Name", Keywords, OS).Emit();
Tyler Nowickie8b07ed2014-06-13 17:57:25 +00003648 OS << " } else if (AttributeList::AS_Pragma == Syntax) {\n";
3649 StringMatcher("Name", Pragma, OS).Emit();
Aaron Ballman09e98ff2014-01-13 21:42:39 +00003650 OS << " }\n";
3651 OS << " return AttributeList::UnknownAttribute;\n"
Douglas Gregor377f99b2012-05-02 17:33:51 +00003652 << "}\n";
Michael Han4a045172012-03-07 00:12:16 +00003653}
3654
Alexander Kornienko5bc364e2013-01-07 17:53:08 +00003655// Emits the code to dump an attribute.
3656void EmitClangAttrDump(RecordKeeper &Records, raw_ostream &OS) {
Dmitri Gribenko6b11fca2013-01-30 21:54:20 +00003657 emitSourceFileHeader("Attribute dumper", OS);
3658
John McCall2225c8b2016-03-01 00:18:05 +00003659 OS << " switch (A->getKind()) {\n";
Alexander Kornienko5bc364e2013-01-07 17:53:08 +00003660 std::vector<Record*> Attrs = Records.getAllDerivedDefinitions("Attr"), Args;
Aaron Ballman2f22b942014-05-20 19:47:14 +00003661 for (const auto *Attr : Attrs) {
3662 const Record &R = *Attr;
Alexander Kornienko5bc364e2013-01-07 17:53:08 +00003663 if (!R.getValueAsBit("ASTNode"))
3664 continue;
3665 OS << " case attr::" << R.getName() << ": {\n";
Aaron Ballmanbc909612014-01-22 21:51:20 +00003666
3667 // If the attribute has a semantically-meaningful name (which is determined
3668 // by whether there is a Spelling enumeration for it), then write out the
3669 // spelling used for the attribute.
Aaron Ballmanc669cc02014-01-27 22:10:04 +00003670 std::vector<FlattenedSpelling> Spellings = GetFlattenedSpellings(R);
Aaron Ballmanbc909612014-01-22 21:51:20 +00003671 if (Spellings.size() > 1 && !SpellingNamesAreCommon(Spellings))
3672 OS << " OS << \" \" << A->getSpelling();\n";
3673
Alexander Kornienko5bc364e2013-01-07 17:53:08 +00003674 Args = R.getValueAsListOfDefs("Args");
3675 if (!Args.empty()) {
Eugene Zelenko5f02b772015-12-08 18:49:01 +00003676 OS << " const auto *SA = cast<" << R.getName()
Alexander Kornienko5bc364e2013-01-07 17:53:08 +00003677 << "Attr>(A);\n";
Aaron Ballman2f22b942014-05-20 19:47:14 +00003678 for (const auto *Arg : Args)
3679 createArgument(*Arg, R.getName())->writeDump(OS);
Richard Trieude5cc7d2013-01-31 01:44:26 +00003680
Eugene Zelenko5f02b772015-12-08 18:49:01 +00003681 for (const auto *AI : Args)
3682 createArgument(*AI, R.getName())->writeDumpChildren(OS);
Alexander Kornienko5bc364e2013-01-07 17:53:08 +00003683 }
3684 OS <<
3685 " break;\n"
3686 " }\n";
3687 }
3688 OS << " }\n";
3689}
3690
Aaron Ballman35db2b32014-01-29 22:13:45 +00003691void EmitClangAttrParserStringSwitches(RecordKeeper &Records,
3692 raw_ostream &OS) {
3693 emitSourceFileHeader("Parser-related llvm::StringSwitch cases", OS);
3694 emitClangAttrArgContextList(Records, OS);
3695 emitClangAttrIdentifierArgList(Records, OS);
3696 emitClangAttrTypeArgList(Records, OS);
3697 emitClangAttrLateParsedList(Records, OS);
3698}
3699
Alex Lorenz9e7bf162017-04-18 14:33:39 +00003700void EmitClangAttrSubjectMatchRulesParserStringSwitches(RecordKeeper &Records,
3701 raw_ostream &OS) {
3702 getPragmaAttributeSupport(Records).generateParsingHelpers(OS);
3703}
3704
Aaron Ballman97dba042014-02-17 15:27:10 +00003705class DocumentationData {
3706public:
Aaron Ballman1a3e5852014-02-17 16:18:32 +00003707 const Record *Documentation;
3708 const Record *Attribute;
Erich Keanea98a2be2017-10-16 20:31:05 +00003709 std::string Heading;
3710 unsigned SupportedSpellings;
Aaron Ballman97dba042014-02-17 15:27:10 +00003711
Erich Keanea98a2be2017-10-16 20:31:05 +00003712 DocumentationData(const Record &Documentation, const Record &Attribute,
3713 const std::pair<std::string, unsigned> HeadingAndKinds)
3714 : Documentation(&Documentation), Attribute(&Attribute),
3715 Heading(std::move(HeadingAndKinds.first)),
3716 SupportedSpellings(HeadingAndKinds.second) {}
Aaron Ballman97dba042014-02-17 15:27:10 +00003717};
3718
Aaron Ballman4de1b582014-02-19 22:59:32 +00003719static void WriteCategoryHeader(const Record *DocCategory,
Aaron Ballman97dba042014-02-17 15:27:10 +00003720 raw_ostream &OS) {
Erich Keane3bff4142017-10-16 23:25:24 +00003721 const StringRef Name = DocCategory->getValueAsString("Name");
3722 OS << Name << "\n" << std::string(Name.size(), '=') << "\n";
Aaron Ballman4de1b582014-02-19 22:59:32 +00003723
3724 // If there is content, print that as well.
Erich Keane3bff4142017-10-16 23:25:24 +00003725 const StringRef ContentStr = DocCategory->getValueAsString("Content");
Benjamin Kramer5c404072015-04-10 21:37:21 +00003726 // Trim leading and trailing newlines and spaces.
Erich Keane3bff4142017-10-16 23:25:24 +00003727 OS << ContentStr.trim();
Benjamin Kramer5c404072015-04-10 21:37:21 +00003728
Aaron Ballman4de1b582014-02-19 22:59:32 +00003729 OS << "\n\n";
Aaron Ballman97dba042014-02-17 15:27:10 +00003730}
3731
Aaron Ballmana66b5742014-02-17 15:36:08 +00003732enum SpellingKind {
3733 GNU = 1 << 0,
3734 CXX11 = 1 << 1,
Aaron Ballman606093a2017-10-15 15:01:42 +00003735 C2x = 1 << 2,
3736 Declspec = 1 << 3,
3737 Microsoft = 1 << 4,
3738 Keyword = 1 << 5,
3739 Pragma = 1 << 6
Aaron Ballmana66b5742014-02-17 15:36:08 +00003740};
3741
Erich Keanea98a2be2017-10-16 20:31:05 +00003742static std::pair<std::string, unsigned>
3743GetAttributeHeadingAndSpellingKinds(const Record &Documentation,
3744 const Record &Attribute) {
Aaron Ballman97dba042014-02-17 15:27:10 +00003745 // FIXME: there is no way to have a per-spelling category for the attribute
3746 // documentation. This may not be a limiting factor since the spellings
3747 // should generally be consistently applied across the category.
3748
Erich Keanea98a2be2017-10-16 20:31:05 +00003749 std::vector<FlattenedSpelling> Spellings = GetFlattenedSpellings(Attribute);
Aaron Ballman97dba042014-02-17 15:27:10 +00003750
3751 // Determine the heading to be used for this attribute.
Erich Keanea98a2be2017-10-16 20:31:05 +00003752 std::string Heading = Documentation.getValueAsString("Heading");
Aaron Ballmanea6668c2014-02-21 14:14:04 +00003753 bool CustomHeading = !Heading.empty();
Aaron Ballman97dba042014-02-17 15:27:10 +00003754 if (Heading.empty()) {
3755 // If there's only one spelling, we can simply use that.
3756 if (Spellings.size() == 1)
3757 Heading = Spellings.begin()->name();
3758 else {
3759 std::set<std::string> Uniques;
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +00003760 for (auto I = Spellings.begin(), E = Spellings.end();
3761 I != E && Uniques.size() <= 1; ++I) {
Aaron Ballman97dba042014-02-17 15:27:10 +00003762 std::string Spelling = NormalizeNameForSpellingComparison(I->name());
3763 Uniques.insert(Spelling);
3764 }
3765 // If the semantic map has only one spelling, that is sufficient for our
3766 // needs.
3767 if (Uniques.size() == 1)
3768 Heading = *Uniques.begin();
3769 }
3770 }
3771
3772 // If the heading is still empty, it is an error.
3773 if (Heading.empty())
Erich Keanea98a2be2017-10-16 20:31:05 +00003774 PrintFatalError(Attribute.getLoc(),
Aaron Ballman97dba042014-02-17 15:27:10 +00003775 "This attribute requires a heading to be specified");
3776
3777 // Gather a list of unique spellings; this is not the same as the semantic
3778 // spelling for the attribute. Variations in underscores and other non-
3779 // semantic characters are still acceptable.
3780 std::vector<std::string> Names;
3781
Aaron Ballman97dba042014-02-17 15:27:10 +00003782 unsigned SupportedSpellings = 0;
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +00003783 for (const auto &I : Spellings) {
3784 SpellingKind Kind = StringSwitch<SpellingKind>(I.variety())
Tyler Nowickie8b07ed2014-06-13 17:57:25 +00003785 .Case("GNU", GNU)
3786 .Case("CXX11", CXX11)
Aaron Ballman606093a2017-10-15 15:01:42 +00003787 .Case("C2x", C2x)
Tyler Nowickie8b07ed2014-06-13 17:57:25 +00003788 .Case("Declspec", Declspec)
Nico Weber20e08042016-09-03 02:55:10 +00003789 .Case("Microsoft", Microsoft)
Tyler Nowickie8b07ed2014-06-13 17:57:25 +00003790 .Case("Keyword", Keyword)
3791 .Case("Pragma", Pragma);
Aaron Ballman97dba042014-02-17 15:27:10 +00003792
3793 // Mask in the supported spelling.
3794 SupportedSpellings |= Kind;
3795
3796 std::string Name;
Aaron Ballman606093a2017-10-15 15:01:42 +00003797 if ((Kind == CXX11 || Kind == C2x) && !I.nameSpace().empty())
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +00003798 Name = I.nameSpace() + "::";
3799 Name += I.name();
Aaron Ballman97dba042014-02-17 15:27:10 +00003800
3801 // If this name is the same as the heading, do not add it.
3802 if (Name != Heading)
3803 Names.push_back(Name);
3804 }
3805
3806 // Print out the heading for the attribute. If there are alternate spellings,
3807 // then display those after the heading.
Aaron Ballmanea6668c2014-02-21 14:14:04 +00003808 if (!CustomHeading && !Names.empty()) {
Aaron Ballman97dba042014-02-17 15:27:10 +00003809 Heading += " (";
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +00003810 for (auto I = Names.begin(), E = Names.end(); I != E; ++I) {
Aaron Ballman97dba042014-02-17 15:27:10 +00003811 if (I != Names.begin())
3812 Heading += ", ";
3813 Heading += *I;
3814 }
3815 Heading += ")";
3816 }
Aaron Ballman97dba042014-02-17 15:27:10 +00003817 if (!SupportedSpellings)
Erich Keanea98a2be2017-10-16 20:31:05 +00003818 PrintFatalError(Attribute.getLoc(),
Aaron Ballman97dba042014-02-17 15:27:10 +00003819 "Attribute has no supported spellings; cannot be "
3820 "documented");
Erich Keanea98a2be2017-10-16 20:31:05 +00003821 return std::make_pair(std::move(Heading), SupportedSpellings);
3822}
3823
3824static void WriteDocumentation(RecordKeeper &Records,
3825 const DocumentationData &Doc, raw_ostream &OS) {
3826 OS << Doc.Heading << "\n" << std::string(Doc.Heading.length(), '-') << "\n";
Aaron Ballman97dba042014-02-17 15:27:10 +00003827
3828 // List what spelling syntaxes the attribute supports.
3829 OS << ".. csv-table:: Supported Syntaxes\n";
Aaron Ballman606093a2017-10-15 15:01:42 +00003830 OS << " :header: \"GNU\", \"C++11\", \"C2x\", \"__declspec\", \"Keyword\",";
Alex Lorenz9e7bf162017-04-18 14:33:39 +00003831 OS << " \"Pragma\", \"Pragma clang attribute\"\n\n";
Aaron Ballman97dba042014-02-17 15:27:10 +00003832 OS << " \"";
Erich Keanea98a2be2017-10-16 20:31:05 +00003833 if (Doc.SupportedSpellings & GNU) OS << "X";
Aaron Ballman97dba042014-02-17 15:27:10 +00003834 OS << "\",\"";
Erich Keanea98a2be2017-10-16 20:31:05 +00003835 if (Doc.SupportedSpellings & CXX11) OS << "X";
Aaron Ballman97dba042014-02-17 15:27:10 +00003836 OS << "\",\"";
Erich Keanea98a2be2017-10-16 20:31:05 +00003837 if (Doc.SupportedSpellings & C2x) OS << "X";
Aaron Ballman606093a2017-10-15 15:01:42 +00003838 OS << "\",\"";
Erich Keanea98a2be2017-10-16 20:31:05 +00003839 if (Doc.SupportedSpellings & Declspec) OS << "X";
Aaron Ballman97dba042014-02-17 15:27:10 +00003840 OS << "\",\"";
Erich Keanea98a2be2017-10-16 20:31:05 +00003841 if (Doc.SupportedSpellings & Keyword) OS << "X";
Aaron Ballman120c79f2014-06-25 12:48:06 +00003842 OS << "\", \"";
Erich Keanea98a2be2017-10-16 20:31:05 +00003843 if (Doc.SupportedSpellings & Pragma) OS << "X";
Alex Lorenz9e7bf162017-04-18 14:33:39 +00003844 OS << "\", \"";
3845 if (getPragmaAttributeSupport(Records).isAttributedSupported(*Doc.Attribute))
3846 OS << "X";
Tyler Nowickie8b07ed2014-06-13 17:57:25 +00003847 OS << "\"\n\n";
Aaron Ballman97dba042014-02-17 15:27:10 +00003848
3849 // If the attribute is deprecated, print a message about it, and possibly
3850 // provide a replacement attribute.
Aaron Ballman1a3e5852014-02-17 16:18:32 +00003851 if (!Doc.Documentation->isValueUnset("Deprecated")) {
Aaron Ballman97dba042014-02-17 15:27:10 +00003852 OS << "This attribute has been deprecated, and may be removed in a future "
3853 << "version of Clang.";
Aaron Ballman1a3e5852014-02-17 16:18:32 +00003854 const Record &Deprecated = *Doc.Documentation->getValueAsDef("Deprecated");
Erich Keane3bff4142017-10-16 23:25:24 +00003855 const StringRef Replacement = Deprecated.getValueAsString("Replacement");
Aaron Ballman97dba042014-02-17 15:27:10 +00003856 if (!Replacement.empty())
Joel E. Denny6053ec22018-02-28 16:57:33 +00003857 OS << " This attribute has been superseded by ``" << Replacement
3858 << "``.";
Aaron Ballman97dba042014-02-17 15:27:10 +00003859 OS << "\n\n";
3860 }
3861
Erich Keane3bff4142017-10-16 23:25:24 +00003862 const StringRef ContentStr = Doc.Documentation->getValueAsString("Content");
Aaron Ballman97dba042014-02-17 15:27:10 +00003863 // Trim leading and trailing newlines and spaces.
Erich Keane3bff4142017-10-16 23:25:24 +00003864 OS << ContentStr.trim();
Aaron Ballman97dba042014-02-17 15:27:10 +00003865
3866 OS << "\n\n\n";
3867}
3868
3869void EmitClangAttrDocs(RecordKeeper &Records, raw_ostream &OS) {
3870 // Get the documentation introduction paragraph.
3871 const Record *Documentation = Records.getDef("GlobalDocumentation");
3872 if (!Documentation) {
3873 PrintFatalError("The Documentation top-level definition is missing, "
3874 "no documentation will be generated.");
3875 return;
3876 }
3877
Aaron Ballman4de1b582014-02-19 22:59:32 +00003878 OS << Documentation->getValueAsString("Intro") << "\n";
Aaron Ballman97dba042014-02-17 15:27:10 +00003879
Aaron Ballman97dba042014-02-17 15:27:10 +00003880 // Gather the Documentation lists from each of the attributes, based on the
3881 // category provided.
3882 std::vector<Record *> Attrs = Records.getAllDerivedDefinitions("Attr");
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +00003883 std::map<const Record *, std::vector<DocumentationData>> SplitDocs;
Aaron Ballman2f22b942014-05-20 19:47:14 +00003884 for (const auto *A : Attrs) {
3885 const Record &Attr = *A;
Aaron Ballman97dba042014-02-17 15:27:10 +00003886 std::vector<Record *> Docs = Attr.getValueAsListOfDefs("Documentation");
Aaron Ballman2f22b942014-05-20 19:47:14 +00003887 for (const auto *D : Docs) {
3888 const Record &Doc = *D;
Aaron Ballman4de1b582014-02-19 22:59:32 +00003889 const Record *Category = Doc.getValueAsDef("Category");
Aaron Ballman97dba042014-02-17 15:27:10 +00003890 // If the category is "undocumented", then there cannot be any other
3891 // documentation categories (otherwise, the attribute would become
3892 // documented).
Erich Keane3bff4142017-10-16 23:25:24 +00003893 const StringRef Cat = Category->getValueAsString("Name");
Aaron Ballman4de1b582014-02-19 22:59:32 +00003894 bool Undocumented = Cat == "Undocumented";
Aaron Ballman97dba042014-02-17 15:27:10 +00003895 if (Undocumented && Docs.size() > 1)
3896 PrintFatalError(Doc.getLoc(),
3897 "Attribute is \"Undocumented\", but has multiple "
Erich Keanea98a2be2017-10-16 20:31:05 +00003898 "documentation categories");
Aaron Ballman97dba042014-02-17 15:27:10 +00003899
3900 if (!Undocumented)
Erich Keanea98a2be2017-10-16 20:31:05 +00003901 SplitDocs[Category].push_back(DocumentationData(
3902 Doc, Attr, GetAttributeHeadingAndSpellingKinds(Doc, Attr)));
Aaron Ballman97dba042014-02-17 15:27:10 +00003903 }
3904 }
3905
3906 // Having split the attributes out based on what documentation goes where,
3907 // we can begin to generate sections of documentation.
Erich Keanea98a2be2017-10-16 20:31:05 +00003908 for (auto &I : SplitDocs) {
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +00003909 WriteCategoryHeader(I.first, OS);
Aaron Ballman97dba042014-02-17 15:27:10 +00003910
Erich Keanea98a2be2017-10-16 20:31:05 +00003911 std::sort(I.second.begin(), I.second.end(),
3912 [](const DocumentationData &D1, const DocumentationData &D2) {
3913 return D1.Heading < D2.Heading;
3914 });
3915
Aaron Ballman97dba042014-02-17 15:27:10 +00003916 // Walk over each of the attributes in the category and write out their
3917 // documentation.
Aaron Ballmanb097f7fe2014-03-02 17:38:37 +00003918 for (const auto &Doc : I.second)
Alex Lorenz9e7bf162017-04-18 14:33:39 +00003919 WriteDocumentation(Records, Doc, OS);
3920 }
3921}
3922
3923void EmitTestPragmaAttributeSupportedAttributes(RecordKeeper &Records,
3924 raw_ostream &OS) {
3925 PragmaClangAttributeSupport Support = getPragmaAttributeSupport(Records);
3926 ParsedAttrMap Attrs = getParsedAttrList(Records);
3927 unsigned NumAttrs = 0;
3928 for (const auto &I : Attrs) {
3929 if (Support.isAttributedSupported(*I.second))
3930 ++NumAttrs;
3931 }
3932 OS << "#pragma clang attribute supports " << NumAttrs << " attributes:\n";
3933 for (const auto &I : Attrs) {
3934 if (!Support.isAttributedSupported(*I.second))
3935 continue;
3936 OS << I.first;
3937 if (I.second->isValueUnset("Subjects")) {
3938 OS << " ()\n";
3939 continue;
3940 }
3941 const Record *SubjectObj = I.second->getValueAsDef("Subjects");
3942 std::vector<Record *> Subjects =
3943 SubjectObj->getValueAsListOfDefs("Subjects");
3944 OS << " (";
3945 for (const auto &Subject : llvm::enumerate(Subjects)) {
3946 if (Subject.index())
3947 OS << ", ";
Alex Lorenz24952fb2017-04-19 15:52:11 +00003948 PragmaClangAttributeSupport::RuleOrAggregateRuleSet &RuleSet =
3949 Support.SubjectsToRules.find(Subject.value())->getSecond();
3950 if (RuleSet.isRule()) {
3951 OS << RuleSet.getRule().getEnumValueName();
3952 continue;
3953 }
3954 OS << "(";
3955 for (const auto &Rule : llvm::enumerate(RuleSet.getAggregateRuleSet())) {
3956 if (Rule.index())
3957 OS << ", ";
3958 OS << Rule.value().getEnumValueName();
3959 }
3960 OS << ")";
Alex Lorenz9e7bf162017-04-18 14:33:39 +00003961 }
3962 OS << ")\n";
Aaron Ballman97dba042014-02-17 15:27:10 +00003963 }
3964}
3965
Jakob Stoklund Olesen995e0e12012-06-13 05:12:41 +00003966} // end namespace clang