1 //===- ClangAttrEmitter.cpp - Generate Clang attribute handling =-*- C++ -*--=//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // These tablegen backends emit Clang attribute processing code
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "llvm/ADT/ArrayRef.h"
14 #include "llvm/ADT/DenseMap.h"
15 #include "llvm/ADT/DenseSet.h"
16 #include "llvm/ADT/STLExtras.h"
17 #include "llvm/ADT/SmallString.h"
18 #include "llvm/ADT/StringExtras.h"
19 #include "llvm/ADT/StringRef.h"
20 #include "llvm/ADT/StringSet.h"
21 #include "llvm/ADT/StringSwitch.h"
22 #include "llvm/ADT/iterator_range.h"
23 #include "llvm/Support/ErrorHandling.h"
24 #include "llvm/Support/raw_ostream.h"
25 #include "llvm/TableGen/Error.h"
26 #include "llvm/TableGen/Record.h"
27 #include "llvm/TableGen/StringMatcher.h"
28 #include "llvm/TableGen/TableGenBackend.h"
29 #include <algorithm>
30 #include <cassert>
31 #include <cctype>
32 #include <cstddef>
33 #include <cstdint>
34 #include <map>
35 #include <memory>
36 #include <set>
37 #include <sstream>
38 #include <string>
39 #include <utility>
40 #include <vector>
41 
42 using namespace llvm;
43 
44 namespace {
45 
46 class FlattenedSpelling {
47   std::string V, N, NS;
48   bool K;
49 
50 public:
51   FlattenedSpelling(const std::string &Variety, const std::string &Name,
52                     const std::string &Namespace, bool KnownToGCC) :
53     V(Variety), N(Name), NS(Namespace), K(KnownToGCC) {}
54   explicit FlattenedSpelling(const Record &Spelling) :
55     V(Spelling.getValueAsString("Variety")),
56     N(Spelling.getValueAsString("Name")) {
57 
58     assert(V != "GCC" && V != "Clang" &&
59            "Given a GCC spelling, which means this hasn't been flattened!");
60     if (V == "CXX11" || V == "C2x" || V == "Pragma")
61       NS = Spelling.getValueAsString("Namespace");
62     bool Unset;
63     K = Spelling.getValueAsBitOrUnset("KnownToGCC", Unset);
64   }
65 
66   const std::string &variety() const { return V; }
67   const std::string &name() const { return N; }
68   const std::string &nameSpace() const { return NS; }
69   bool knownToGCC() const { return K; }
70 };
71 
72 } // end anonymous namespace
73 
74 static std::vector<FlattenedSpelling>
75 GetFlattenedSpellings(const Record &Attr) {
76   std::vector<Record *> Spellings = Attr.getValueAsListOfDefs("Spellings");
77   std::vector<FlattenedSpelling> Ret;
78 
79   for (const auto &Spelling : Spellings) {
80     StringRef Variety = Spelling->getValueAsString("Variety");
81     StringRef Name = Spelling->getValueAsString("Name");
82     if (Variety == "GCC") {
83       // Gin up two new spelling objects to add into the list.
84       Ret.emplace_back("GNU", Name, "", true);
85       Ret.emplace_back("CXX11", Name, "gnu", true);
86     } else if (Variety == "Clang") {
87       Ret.emplace_back("GNU", Name, "", false);
88       Ret.emplace_back("CXX11", Name, "clang", false);
89       if (Spelling->getValueAsBit("AllowInC"))
90         Ret.emplace_back("C2x", Name, "clang", false);
91     } else
92       Ret.push_back(FlattenedSpelling(*Spelling));
93   }
94 
95   return Ret;
96 }
97 
98 static std::string ReadPCHRecord(StringRef type) {
99   return StringSwitch<std::string>(type)
100     .EndsWith("Decl *", "Record.GetLocalDeclAs<"
101               + std::string(type, 0, type.size()-1) + ">(Record.readInt())")
102     .Case("TypeSourceInfo *", "Record.getTypeSourceInfo()")
103     .Case("Expr *", "Record.readExpr()")
104     .Case("IdentifierInfo *", "Record.getIdentifierInfo()")
105     .Case("StringRef", "Record.readString()")
106     .Case("ParamIdx", "ParamIdx::deserialize(Record.readInt())")
107     .Default("Record.readInt()");
108 }
109 
110 // Get a type that is suitable for storing an object of the specified type.
111 static StringRef getStorageType(StringRef type) {
112   return StringSwitch<StringRef>(type)
113     .Case("StringRef", "std::string")
114     .Default(type);
115 }
116 
117 // Assumes that the way to get the value is SA->getname()
118 static std::string WritePCHRecord(StringRef type, StringRef name) {
119   return "Record." + StringSwitch<std::string>(type)
120     .EndsWith("Decl *", "AddDeclRef(" + std::string(name) + ");\n")
121     .Case("TypeSourceInfo *", "AddTypeSourceInfo(" + std::string(name) + ");\n")
122     .Case("Expr *", "AddStmt(" + std::string(name) + ");\n")
123     .Case("IdentifierInfo *", "AddIdentifierRef(" + std::string(name) + ");\n")
124     .Case("StringRef", "AddString(" + std::string(name) + ");\n")
125     .Case("ParamIdx", "push_back(" + std::string(name) + ".serialize());\n")
126     .Default("push_back(" + std::string(name) + ");\n");
127 }
128 
129 // Normalize attribute name by removing leading and trailing
130 // underscores. For example, __foo, foo__, __foo__ would
131 // become foo.
132 static StringRef NormalizeAttrName(StringRef AttrName) {
133   AttrName.consume_front("__");
134   AttrName.consume_back("__");
135   return AttrName;
136 }
137 
138 // Normalize the name by removing any and all leading and trailing underscores.
139 // This is different from NormalizeAttrName in that it also handles names like
140 // _pascal and __pascal.
141 static StringRef NormalizeNameForSpellingComparison(StringRef Name) {
142   return Name.trim("_");
143 }
144 
145 // Normalize the spelling of a GNU attribute (i.e. "x" in "__attribute__((x))"),
146 // removing "__" if it appears at the beginning and end of the attribute's name.
147 static StringRef NormalizeGNUAttrSpelling(StringRef AttrSpelling) {
148   if (AttrSpelling.startswith("__") && AttrSpelling.endswith("__")) {
149     AttrSpelling = AttrSpelling.substr(2, AttrSpelling.size() - 4);
150   }
151 
152   return AttrSpelling;
153 }
154 
155 typedef std::vector<std::pair<std::string, const Record *>> ParsedAttrMap;
156 
157 static ParsedAttrMap getParsedAttrList(const RecordKeeper &Records,
158                                        ParsedAttrMap *Dupes = nullptr) {
159   std::vector<Record *> Attrs = Records.getAllDerivedDefinitions("Attr");
160   std::set<std::string> Seen;
161   ParsedAttrMap R;
162   for (const auto *Attr : Attrs) {
163     if (Attr->getValueAsBit("SemaHandler")) {
164       std::string AN;
165       if (Attr->isSubClassOf("TargetSpecificAttr") &&
166           !Attr->isValueUnset("ParseKind")) {
167         AN = Attr->getValueAsString("ParseKind");
168 
169         // If this attribute has already been handled, it does not need to be
170         // handled again.
171         if (Seen.find(AN) != Seen.end()) {
172           if (Dupes)
173             Dupes->push_back(std::make_pair(AN, Attr));
174           continue;
175         }
176         Seen.insert(AN);
177       } else
178         AN = NormalizeAttrName(Attr->getName()).str();
179 
180       R.push_back(std::make_pair(AN, Attr));
181     }
182   }
183   return R;
184 }
185 
186 namespace {
187 
188   class Argument {
189     std::string lowerName, upperName;
190     StringRef attrName;
191     bool isOpt;
192     bool Fake;
193 
194   public:
195     Argument(const Record &Arg, StringRef Attr)
196       : lowerName(Arg.getValueAsString("Name")), upperName(lowerName),
197         attrName(Attr), isOpt(false), Fake(false) {
198       if (!lowerName.empty()) {
199         lowerName[0] = std::tolower(lowerName[0]);
200         upperName[0] = std::toupper(upperName[0]);
201       }
202       // Work around MinGW's macro definition of 'interface' to 'struct'. We
203       // have an attribute argument called 'Interface', so only the lower case
204       // name conflicts with the macro definition.
205       if (lowerName == "interface")
206         lowerName = "interface_";
207     }
208     virtual ~Argument() = default;
209 
210     StringRef getLowerName() const { return lowerName; }
211     StringRef getUpperName() const { return upperName; }
212     StringRef getAttrName() const { return attrName; }
213 
214     bool isOptional() const { return isOpt; }
215     void setOptional(bool set) { isOpt = set; }
216 
217     bool isFake() const { return Fake; }
218     void setFake(bool fake) { Fake = fake; }
219 
220     // These functions print the argument contents formatted in different ways.
221     virtual void writeAccessors(raw_ostream &OS) const = 0;
222     virtual void writeAccessorDefinitions(raw_ostream &OS) const {}
223     virtual void writeASTVisitorTraversal(raw_ostream &OS) const {}
224     virtual void writeCloneArgs(raw_ostream &OS) const = 0;
225     virtual void writeTemplateInstantiationArgs(raw_ostream &OS) const = 0;
226     virtual void writeTemplateInstantiation(raw_ostream &OS) const {}
227     virtual void writeCtorBody(raw_ostream &OS) const {}
228     virtual void writeCtorInitializers(raw_ostream &OS) const = 0;
229     virtual void writeCtorDefaultInitializers(raw_ostream &OS) const = 0;
230     virtual void writeCtorParameters(raw_ostream &OS) const = 0;
231     virtual void writeDeclarations(raw_ostream &OS) const = 0;
232     virtual void writePCHReadArgs(raw_ostream &OS) const = 0;
233     virtual void writePCHReadDecls(raw_ostream &OS) const = 0;
234     virtual void writePCHWrite(raw_ostream &OS) const = 0;
235     virtual std::string getIsOmitted() const { return "false"; }
236     virtual void writeValue(raw_ostream &OS) const = 0;
237     virtual void writeDump(raw_ostream &OS) const = 0;
238     virtual void writeDumpChildren(raw_ostream &OS) const {}
239     virtual void writeHasChildren(raw_ostream &OS) const { OS << "false"; }
240 
241     virtual bool isEnumArg() const { return false; }
242     virtual bool isVariadicEnumArg() const { return false; }
243     virtual bool isVariadic() const { return false; }
244 
245     virtual void writeImplicitCtorArgs(raw_ostream &OS) const {
246       OS << getUpperName();
247     }
248   };
249 
250   class SimpleArgument : public Argument {
251     std::string type;
252 
253   public:
254     SimpleArgument(const Record &Arg, StringRef Attr, std::string T)
255         : Argument(Arg, Attr), type(std::move(T)) {}
256 
257     std::string getType() const { return type; }
258 
259     void writeAccessors(raw_ostream &OS) const override {
260       OS << "  " << type << " get" << getUpperName() << "() const {\n";
261       OS << "    return " << getLowerName() << ";\n";
262       OS << "  }";
263     }
264 
265     void writeCloneArgs(raw_ostream &OS) const override {
266       OS << getLowerName();
267     }
268 
269     void writeTemplateInstantiationArgs(raw_ostream &OS) const override {
270       OS << "A->get" << getUpperName() << "()";
271     }
272 
273     void writeCtorInitializers(raw_ostream &OS) const override {
274       OS << getLowerName() << "(" << getUpperName() << ")";
275     }
276 
277     void writeCtorDefaultInitializers(raw_ostream &OS) const override {
278       OS << getLowerName() << "()";
279     }
280 
281     void writeCtorParameters(raw_ostream &OS) const override {
282       OS << type << " " << getUpperName();
283     }
284 
285     void writeDeclarations(raw_ostream &OS) const override {
286       OS << type << " " << getLowerName() << ";";
287     }
288 
289     void writePCHReadDecls(raw_ostream &OS) const override {
290       std::string read = ReadPCHRecord(type);
291       OS << "    " << type << " " << getLowerName() << " = " << read << ";\n";
292     }
293 
294     void writePCHReadArgs(raw_ostream &OS) const override {
295       OS << getLowerName();
296     }
297 
298     void writePCHWrite(raw_ostream &OS) const override {
299       OS << "    " << WritePCHRecord(type, "SA->get" +
300                                            std::string(getUpperName()) + "()");
301     }
302 
303     std::string getIsOmitted() const override {
304       if (type == "IdentifierInfo *")
305         return "!get" + getUpperName().str() + "()";
306       if (type == "TypeSourceInfo *")
307         return "!get" + getUpperName().str() + "Loc()";
308       if (type == "ParamIdx")
309         return "!get" + getUpperName().str() + "().isValid()";
310       return "false";
311     }
312 
313     void writeValue(raw_ostream &OS) const override {
314       if (type == "FunctionDecl *")
315         OS << "\" << get" << getUpperName()
316            << "()->getNameInfo().getAsString() << \"";
317       else if (type == "IdentifierInfo *")
318         // Some non-optional (comma required) identifier arguments can be the
319         // empty string but are then recorded as a nullptr.
320         OS << "\" << (get" << getUpperName() << "() ? get" << getUpperName()
321            << "()->getName() : \"\") << \"";
322       else if (type == "TypeSourceInfo *")
323         OS << "\" << get" << getUpperName() << "().getAsString() << \"";
324       else if (type == "ParamIdx")
325         OS << "\" << get" << getUpperName() << "().getSourceIndex() << \"";
326       else
327         OS << "\" << get" << getUpperName() << "() << \"";
328     }
329 
330     void writeDump(raw_ostream &OS) const override {
331       if (type == "FunctionDecl *" || type == "NamedDecl *") {
332         OS << "    OS << \" \";\n";
333         OS << "    dumpBareDeclRef(SA->get" << getUpperName() << "());\n";
334       } else if (type == "IdentifierInfo *") {
335         // Some non-optional (comma required) identifier arguments can be the
336         // empty string but are then recorded as a nullptr.
337         OS << "    if (SA->get" << getUpperName() << "())\n"
338            << "      OS << \" \" << SA->get" << getUpperName()
339            << "()->getName();\n";
340       } else if (type == "TypeSourceInfo *") {
341         if (isOptional())
342           OS << "    if (SA->get" << getUpperName() << "Loc())";
343         OS << "    OS << \" \" << SA->get" << getUpperName()
344            << "().getAsString();\n";
345       } else if (type == "bool") {
346         OS << "    if (SA->get" << getUpperName() << "()) OS << \" "
347            << getUpperName() << "\";\n";
348       } else if (type == "int" || type == "unsigned") {
349         OS << "    OS << \" \" << SA->get" << getUpperName() << "();\n";
350       } else if (type == "ParamIdx") {
351         if (isOptional())
352           OS << "    if (SA->get" << getUpperName() << "().isValid())\n  ";
353         OS << "    OS << \" \" << SA->get" << getUpperName()
354            << "().getSourceIndex();\n";
355       } else {
356         llvm_unreachable("Unknown SimpleArgument type!");
357       }
358     }
359   };
360 
361   class DefaultSimpleArgument : public SimpleArgument {
362     int64_t Default;
363 
364   public:
365     DefaultSimpleArgument(const Record &Arg, StringRef Attr,
366                           std::string T, int64_t Default)
367       : SimpleArgument(Arg, Attr, T), Default(Default) {}
368 
369     void writeAccessors(raw_ostream &OS) const override {
370       SimpleArgument::writeAccessors(OS);
371 
372       OS << "\n\n  static const " << getType() << " Default" << getUpperName()
373          << " = ";
374       if (getType() == "bool")
375         OS << (Default != 0 ? "true" : "false");
376       else
377         OS << Default;
378       OS << ";";
379     }
380   };
381 
382   class StringArgument : public Argument {
383   public:
384     StringArgument(const Record &Arg, StringRef Attr)
385       : Argument(Arg, Attr)
386     {}
387 
388     void writeAccessors(raw_ostream &OS) const override {
389       OS << "  llvm::StringRef get" << getUpperName() << "() const {\n";
390       OS << "    return llvm::StringRef(" << getLowerName() << ", "
391          << getLowerName() << "Length);\n";
392       OS << "  }\n";
393       OS << "  unsigned get" << getUpperName() << "Length() const {\n";
394       OS << "    return " << getLowerName() << "Length;\n";
395       OS << "  }\n";
396       OS << "  void set" << getUpperName()
397          << "(ASTContext &C, llvm::StringRef S) {\n";
398       OS << "    " << getLowerName() << "Length = S.size();\n";
399       OS << "    this->" << getLowerName() << " = new (C, 1) char ["
400          << getLowerName() << "Length];\n";
401       OS << "    if (!S.empty())\n";
402       OS << "      std::memcpy(this->" << getLowerName() << ", S.data(), "
403          << getLowerName() << "Length);\n";
404       OS << "  }";
405     }
406 
407     void writeCloneArgs(raw_ostream &OS) const override {
408       OS << "get" << getUpperName() << "()";
409     }
410 
411     void writeTemplateInstantiationArgs(raw_ostream &OS) const override {
412       OS << "A->get" << getUpperName() << "()";
413     }
414 
415     void writeCtorBody(raw_ostream &OS) const override {
416       OS << "      if (!" << getUpperName() << ".empty())\n";
417       OS << "        std::memcpy(" << getLowerName() << ", " << getUpperName()
418          << ".data(), " << getLowerName() << "Length);\n";
419     }
420 
421     void writeCtorInitializers(raw_ostream &OS) const override {
422       OS << getLowerName() << "Length(" << getUpperName() << ".size()),"
423          << getLowerName() << "(new (Ctx, 1) char[" << getLowerName()
424          << "Length])";
425     }
426 
427     void writeCtorDefaultInitializers(raw_ostream &OS) const override {
428       OS << getLowerName() << "Length(0)," << getLowerName() << "(nullptr)";
429     }
430 
431     void writeCtorParameters(raw_ostream &OS) const override {
432       OS << "llvm::StringRef " << getUpperName();
433     }
434 
435     void writeDeclarations(raw_ostream &OS) const override {
436       OS << "unsigned " << getLowerName() << "Length;\n";
437       OS << "char *" << getLowerName() << ";";
438     }
439 
440     void writePCHReadDecls(raw_ostream &OS) const override {
441       OS << "    std::string " << getLowerName()
442          << "= Record.readString();\n";
443     }
444 
445     void writePCHReadArgs(raw_ostream &OS) const override {
446       OS << getLowerName();
447     }
448 
449     void writePCHWrite(raw_ostream &OS) const override {
450       OS << "    Record.AddString(SA->get" << getUpperName() << "());\n";
451     }
452 
453     void writeValue(raw_ostream &OS) const override {
454       OS << "\\\"\" << get" << getUpperName() << "() << \"\\\"";
455     }
456 
457     void writeDump(raw_ostream &OS) const override {
458       OS << "    OS << \" \\\"\" << SA->get" << getUpperName()
459          << "() << \"\\\"\";\n";
460     }
461   };
462 
463   class AlignedArgument : public Argument {
464   public:
465     AlignedArgument(const Record &Arg, StringRef Attr)
466       : Argument(Arg, Attr)
467     {}
468 
469     void writeAccessors(raw_ostream &OS) const override {
470       OS << "  bool is" << getUpperName() << "Dependent() const;\n";
471 
472       OS << "  unsigned get" << getUpperName() << "(ASTContext &Ctx) const;\n";
473 
474       OS << "  bool is" << getUpperName() << "Expr() const {\n";
475       OS << "    return is" << getLowerName() << "Expr;\n";
476       OS << "  }\n";
477 
478       OS << "  Expr *get" << getUpperName() << "Expr() const {\n";
479       OS << "    assert(is" << getLowerName() << "Expr);\n";
480       OS << "    return " << getLowerName() << "Expr;\n";
481       OS << "  }\n";
482 
483       OS << "  TypeSourceInfo *get" << getUpperName() << "Type() const {\n";
484       OS << "    assert(!is" << getLowerName() << "Expr);\n";
485       OS << "    return " << getLowerName() << "Type;\n";
486       OS << "  }";
487     }
488 
489     void writeAccessorDefinitions(raw_ostream &OS) const override {
490       OS << "bool " << getAttrName() << "Attr::is" << getUpperName()
491          << "Dependent() const {\n";
492       OS << "  if (is" << getLowerName() << "Expr)\n";
493       OS << "    return " << getLowerName() << "Expr && (" << getLowerName()
494          << "Expr->isValueDependent() || " << getLowerName()
495          << "Expr->isTypeDependent());\n";
496       OS << "  else\n";
497       OS << "    return " << getLowerName()
498          << "Type->getType()->isDependentType();\n";
499       OS << "}\n";
500 
501       // FIXME: Do not do the calculation here
502       // FIXME: Handle types correctly
503       // A null pointer means maximum alignment
504       OS << "unsigned " << getAttrName() << "Attr::get" << getUpperName()
505          << "(ASTContext &Ctx) const {\n";
506       OS << "  assert(!is" << getUpperName() << "Dependent());\n";
507       OS << "  if (is" << getLowerName() << "Expr)\n";
508       OS << "    return " << getLowerName() << "Expr ? " << getLowerName()
509          << "Expr->EvaluateKnownConstInt(Ctx).getZExtValue()"
510          << " * Ctx.getCharWidth() : "
511          << "Ctx.getTargetDefaultAlignForAttributeAligned();\n";
512       OS << "  else\n";
513       OS << "    return 0; // FIXME\n";
514       OS << "}\n";
515     }
516 
517     void writeASTVisitorTraversal(raw_ostream &OS) const override {
518       StringRef Name = getUpperName();
519       OS << "  if (A->is" << Name << "Expr()) {\n"
520          << "    if (!getDerived().TraverseStmt(A->get" << Name << "Expr()))\n"
521          << "      return false;\n"
522          << "  } else if (auto *TSI = A->get" << Name << "Type()) {\n"
523          << "    if (!getDerived().TraverseTypeLoc(TSI->getTypeLoc()))\n"
524          << "      return false;\n"
525          << "  }\n";
526     }
527 
528     void writeCloneArgs(raw_ostream &OS) const override {
529       OS << "is" << getLowerName() << "Expr, is" << getLowerName()
530          << "Expr ? static_cast<void*>(" << getLowerName()
531          << "Expr) : " << getLowerName()
532          << "Type";
533     }
534 
535     void writeTemplateInstantiationArgs(raw_ostream &OS) const override {
536       // FIXME: move the definition in Sema::InstantiateAttrs to here.
537       // In the meantime, aligned attributes are cloned.
538     }
539 
540     void writeCtorBody(raw_ostream &OS) const override {
541       OS << "    if (is" << getLowerName() << "Expr)\n";
542       OS << "       " << getLowerName() << "Expr = reinterpret_cast<Expr *>("
543          << getUpperName() << ");\n";
544       OS << "    else\n";
545       OS << "       " << getLowerName()
546          << "Type = reinterpret_cast<TypeSourceInfo *>(" << getUpperName()
547          << ");\n";
548     }
549 
550     void writeCtorInitializers(raw_ostream &OS) const override {
551       OS << "is" << getLowerName() << "Expr(Is" << getUpperName() << "Expr)";
552     }
553 
554     void writeCtorDefaultInitializers(raw_ostream &OS) const override {
555       OS << "is" << getLowerName() << "Expr(false)";
556     }
557 
558     void writeCtorParameters(raw_ostream &OS) const override {
559       OS << "bool Is" << getUpperName() << "Expr, void *" << getUpperName();
560     }
561 
562     void writeImplicitCtorArgs(raw_ostream &OS) const override {
563       OS << "Is" << getUpperName() << "Expr, " << getUpperName();
564     }
565 
566     void writeDeclarations(raw_ostream &OS) const override {
567       OS << "bool is" << getLowerName() << "Expr;\n";
568       OS << "union {\n";
569       OS << "Expr *" << getLowerName() << "Expr;\n";
570       OS << "TypeSourceInfo *" << getLowerName() << "Type;\n";
571       OS << "};";
572     }
573 
574     void writePCHReadArgs(raw_ostream &OS) const override {
575       OS << "is" << getLowerName() << "Expr, " << getLowerName() << "Ptr";
576     }
577 
578     void writePCHReadDecls(raw_ostream &OS) const override {
579       OS << "    bool is" << getLowerName() << "Expr = Record.readInt();\n";
580       OS << "    void *" << getLowerName() << "Ptr;\n";
581       OS << "    if (is" << getLowerName() << "Expr)\n";
582       OS << "      " << getLowerName() << "Ptr = Record.readExpr();\n";
583       OS << "    else\n";
584       OS << "      " << getLowerName()
585          << "Ptr = Record.getTypeSourceInfo();\n";
586     }
587 
588     void writePCHWrite(raw_ostream &OS) const override {
589       OS << "    Record.push_back(SA->is" << getUpperName() << "Expr());\n";
590       OS << "    if (SA->is" << getUpperName() << "Expr())\n";
591       OS << "      Record.AddStmt(SA->get" << getUpperName() << "Expr());\n";
592       OS << "    else\n";
593       OS << "      Record.AddTypeSourceInfo(SA->get" << getUpperName()
594          << "Type());\n";
595     }
596 
597     std::string getIsOmitted() const override {
598       return "!is" + getLowerName().str() + "Expr || !" + getLowerName().str()
599              + "Expr";
600     }
601 
602     void writeValue(raw_ostream &OS) const override {
603       OS << "\";\n";
604       OS << "    " << getLowerName()
605          << "Expr->printPretty(OS, nullptr, Policy);\n";
606       OS << "    OS << \"";
607     }
608 
609     void writeDump(raw_ostream &OS) const override {
610       OS << "    if (!SA->is" << getUpperName() << "Expr())\n";
611       OS << "      dumpType(SA->get" << getUpperName()
612          << "Type()->getType());\n";
613     }
614 
615     void writeDumpChildren(raw_ostream &OS) const override {
616       OS << "    if (SA->is" << getUpperName() << "Expr())\n";
617       OS << "      Visit(SA->get" << getUpperName() << "Expr());\n";
618     }
619 
620     void writeHasChildren(raw_ostream &OS) const override {
621       OS << "SA->is" << getUpperName() << "Expr()";
622     }
623   };
624 
625   class VariadicArgument : public Argument {
626     std::string Type, ArgName, ArgSizeName, RangeName;
627 
628   protected:
629     // Assumed to receive a parameter: raw_ostream OS.
630     virtual void writeValueImpl(raw_ostream &OS) const {
631       OS << "    OS << Val;\n";
632     }
633     // Assumed to receive a parameter: raw_ostream OS.
634     virtual void writeDumpImpl(raw_ostream &OS) const {
635       OS << "      OS << \" \" << Val;\n";
636     }
637 
638   public:
639     VariadicArgument(const Record &Arg, StringRef Attr, std::string T)
640         : Argument(Arg, Attr), Type(std::move(T)),
641           ArgName(getLowerName().str() + "_"), ArgSizeName(ArgName + "Size"),
642           RangeName(getLowerName()) {}
643 
644     const std::string &getType() const { return Type; }
645     const std::string &getArgName() const { return ArgName; }
646     const std::string &getArgSizeName() const { return ArgSizeName; }
647     bool isVariadic() const override { return true; }
648 
649     void writeAccessors(raw_ostream &OS) const override {
650       std::string IteratorType = getLowerName().str() + "_iterator";
651       std::string BeginFn = getLowerName().str() + "_begin()";
652       std::string EndFn = getLowerName().str() + "_end()";
653 
654       OS << "  typedef " << Type << "* " << IteratorType << ";\n";
655       OS << "  " << IteratorType << " " << BeginFn << " const {"
656          << " return " << ArgName << "; }\n";
657       OS << "  " << IteratorType << " " << EndFn << " const {"
658          << " return " << ArgName << " + " << ArgSizeName << "; }\n";
659       OS << "  unsigned " << getLowerName() << "_size() const {"
660          << " return " << ArgSizeName << "; }\n";
661       OS << "  llvm::iterator_range<" << IteratorType << "> " << RangeName
662          << "() const { return llvm::make_range(" << BeginFn << ", " << EndFn
663          << "); }\n";
664     }
665 
666     void writeCloneArgs(raw_ostream &OS) const override {
667       OS << ArgName << ", " << ArgSizeName;
668     }
669 
670     void writeTemplateInstantiationArgs(raw_ostream &OS) const override {
671       // This isn't elegant, but we have to go through public methods...
672       OS << "A->" << getLowerName() << "_begin(), "
673          << "A->" << getLowerName() << "_size()";
674     }
675 
676     void writeASTVisitorTraversal(raw_ostream &OS) const override {
677       // FIXME: Traverse the elements.
678     }
679 
680     void writeCtorBody(raw_ostream &OS) const override {
681       OS << "    std::copy(" << getUpperName() << ", " << getUpperName()
682          << " + " << ArgSizeName << ", " << ArgName << ");\n";
683     }
684 
685     void writeCtorInitializers(raw_ostream &OS) const override {
686       OS << ArgSizeName << "(" << getUpperName() << "Size), "
687          << ArgName << "(new (Ctx, 16) " << getType() << "["
688          << ArgSizeName << "])";
689     }
690 
691     void writeCtorDefaultInitializers(raw_ostream &OS) const override {
692       OS << ArgSizeName << "(0), " << ArgName << "(nullptr)";
693     }
694 
695     void writeCtorParameters(raw_ostream &OS) const override {
696       OS << getType() << " *" << getUpperName() << ", unsigned "
697          << getUpperName() << "Size";
698     }
699 
700     void writeImplicitCtorArgs(raw_ostream &OS) const override {
701       OS << getUpperName() << ", " << getUpperName() << "Size";
702     }
703 
704     void writeDeclarations(raw_ostream &OS) const override {
705       OS << "  unsigned " << ArgSizeName << ";\n";
706       OS << "  " << getType() << " *" << ArgName << ";";
707     }
708 
709     void writePCHReadDecls(raw_ostream &OS) const override {
710       OS << "    unsigned " << getLowerName() << "Size = Record.readInt();\n";
711       OS << "    SmallVector<" << getType() << ", 4> "
712          << getLowerName() << ";\n";
713       OS << "    " << getLowerName() << ".reserve(" << getLowerName()
714          << "Size);\n";
715 
716       // If we can't store the values in the current type (if it's something
717       // like StringRef), store them in a different type and convert the
718       // container afterwards.
719       std::string StorageType = getStorageType(getType());
720       std::string StorageName = getLowerName();
721       if (StorageType != getType()) {
722         StorageName += "Storage";
723         OS << "    SmallVector<" << StorageType << ", 4> "
724            << StorageName << ";\n";
725         OS << "    " << StorageName << ".reserve(" << getLowerName()
726            << "Size);\n";
727       }
728 
729       OS << "    for (unsigned i = 0; i != " << getLowerName() << "Size; ++i)\n";
730       std::string read = ReadPCHRecord(Type);
731       OS << "      " << StorageName << ".push_back(" << read << ");\n";
732 
733       if (StorageType != getType()) {
734         OS << "    for (unsigned i = 0; i != " << getLowerName() << "Size; ++i)\n";
735         OS << "      " << getLowerName() << ".push_back("
736            << StorageName << "[i]);\n";
737       }
738     }
739 
740     void writePCHReadArgs(raw_ostream &OS) const override {
741       OS << getLowerName() << ".data(), " << getLowerName() << "Size";
742     }
743 
744     void writePCHWrite(raw_ostream &OS) const override {
745       OS << "    Record.push_back(SA->" << getLowerName() << "_size());\n";
746       OS << "    for (auto &Val : SA->" << RangeName << "())\n";
747       OS << "      " << WritePCHRecord(Type, "Val");
748     }
749 
750     void writeValue(raw_ostream &OS) const override {
751       OS << "\";\n";
752       OS << "  bool isFirst = true;\n"
753          << "  for (const auto &Val : " << RangeName << "()) {\n"
754          << "    if (isFirst) isFirst = false;\n"
755          << "    else OS << \", \";\n";
756       writeValueImpl(OS);
757       OS << "  }\n";
758       OS << "  OS << \"";
759     }
760 
761     void writeDump(raw_ostream &OS) const override {
762       OS << "    for (const auto &Val : SA->" << RangeName << "())\n";
763       writeDumpImpl(OS);
764     }
765   };
766 
767   class VariadicParamIdxArgument : public VariadicArgument {
768   public:
769     VariadicParamIdxArgument(const Record &Arg, StringRef Attr)
770         : VariadicArgument(Arg, Attr, "ParamIdx") {}
771 
772   public:
773     void writeValueImpl(raw_ostream &OS) const override {
774       OS << "    OS << Val.getSourceIndex();\n";
775     }
776 
777     void writeDumpImpl(raw_ostream &OS) const override {
778       OS << "      OS << \" \" << Val.getSourceIndex();\n";
779     }
780   };
781 
782   struct VariadicParamOrParamIdxArgument : public VariadicArgument {
783     VariadicParamOrParamIdxArgument(const Record &Arg, StringRef Attr)
784         : VariadicArgument(Arg, Attr, "int") {}
785   };
786 
787   // Unique the enums, but maintain the original declaration ordering.
788   std::vector<StringRef>
789   uniqueEnumsInOrder(const std::vector<StringRef> &enums) {
790     std::vector<StringRef> uniques;
791     SmallDenseSet<StringRef, 8> unique_set;
792     for (const auto &i : enums) {
793       if (unique_set.insert(i).second)
794         uniques.push_back(i);
795     }
796     return uniques;
797   }
798 
799   class EnumArgument : public Argument {
800     std::string type;
801     std::vector<StringRef> values, enums, uniques;
802 
803   public:
804     EnumArgument(const Record &Arg, StringRef Attr)
805       : Argument(Arg, Attr), type(Arg.getValueAsString("Type")),
806         values(Arg.getValueAsListOfStrings("Values")),
807         enums(Arg.getValueAsListOfStrings("Enums")),
808         uniques(uniqueEnumsInOrder(enums))
809     {
810       // FIXME: Emit a proper error
811       assert(!uniques.empty());
812     }
813 
814     bool isEnumArg() const override { return true; }
815 
816     void writeAccessors(raw_ostream &OS) const override {
817       OS << "  " << type << " get" << getUpperName() << "() const {\n";
818       OS << "    return " << getLowerName() << ";\n";
819       OS << "  }";
820     }
821 
822     void writeCloneArgs(raw_ostream &OS) const override {
823       OS << getLowerName();
824     }
825 
826     void writeTemplateInstantiationArgs(raw_ostream &OS) const override {
827       OS << "A->get" << getUpperName() << "()";
828     }
829     void writeCtorInitializers(raw_ostream &OS) const override {
830       OS << getLowerName() << "(" << getUpperName() << ")";
831     }
832     void writeCtorDefaultInitializers(raw_ostream &OS) const override {
833       OS << getLowerName() << "(" << type << "(0))";
834     }
835     void writeCtorParameters(raw_ostream &OS) const override {
836       OS << type << " " << getUpperName();
837     }
838     void writeDeclarations(raw_ostream &OS) const override {
839       auto i = uniques.cbegin(), e = uniques.cend();
840       // The last one needs to not have a comma.
841       --e;
842 
843       OS << "public:\n";
844       OS << "  enum " << type << " {\n";
845       for (; i != e; ++i)
846         OS << "    " << *i << ",\n";
847       OS << "    " << *e << "\n";
848       OS << "  };\n";
849       OS << "private:\n";
850       OS << "  " << type << " " << getLowerName() << ";";
851     }
852 
853     void writePCHReadDecls(raw_ostream &OS) const override {
854       OS << "    " << getAttrName() << "Attr::" << type << " " << getLowerName()
855          << "(static_cast<" << getAttrName() << "Attr::" << type
856          << ">(Record.readInt()));\n";
857     }
858 
859     void writePCHReadArgs(raw_ostream &OS) const override {
860       OS << getLowerName();
861     }
862 
863     void writePCHWrite(raw_ostream &OS) const override {
864       OS << "Record.push_back(SA->get" << getUpperName() << "());\n";
865     }
866 
867     void writeValue(raw_ostream &OS) const override {
868       // FIXME: this isn't 100% correct -- some enum arguments require printing
869       // as a string literal, while others require printing as an identifier.
870       // Tablegen currently does not distinguish between the two forms.
871       OS << "\\\"\" << " << getAttrName() << "Attr::Convert" << type << "ToStr(get"
872          << getUpperName() << "()) << \"\\\"";
873     }
874 
875     void writeDump(raw_ostream &OS) const override {
876       OS << "    switch(SA->get" << getUpperName() << "()) {\n";
877       for (const auto &I : uniques) {
878         OS << "    case " << getAttrName() << "Attr::" << I << ":\n";
879         OS << "      OS << \" " << I << "\";\n";
880         OS << "      break;\n";
881       }
882       OS << "    }\n";
883     }
884 
885     void writeConversion(raw_ostream &OS) const {
886       OS << "  static bool ConvertStrTo" << type << "(StringRef Val, ";
887       OS << type << " &Out) {\n";
888       OS << "    Optional<" << type << "> R = llvm::StringSwitch<Optional<";
889       OS << type << ">>(Val)\n";
890       for (size_t I = 0; I < enums.size(); ++I) {
891         OS << "      .Case(\"" << values[I] << "\", ";
892         OS << getAttrName() << "Attr::" << enums[I] << ")\n";
893       }
894       OS << "      .Default(Optional<" << type << ">());\n";
895       OS << "    if (R) {\n";
896       OS << "      Out = *R;\n      return true;\n    }\n";
897       OS << "    return false;\n";
898       OS << "  }\n\n";
899 
900       // Mapping from enumeration values back to enumeration strings isn't
901       // trivial because some enumeration values have multiple named
902       // enumerators, such as type_visibility(internal) and
903       // type_visibility(hidden) both mapping to TypeVisibilityAttr::Hidden.
904       OS << "  static const char *Convert" << type << "ToStr("
905          << type << " Val) {\n"
906          << "    switch(Val) {\n";
907       SmallDenseSet<StringRef, 8> Uniques;
908       for (size_t I = 0; I < enums.size(); ++I) {
909         if (Uniques.insert(enums[I]).second)
910           OS << "    case " << getAttrName() << "Attr::" << enums[I]
911              << ": return \"" << values[I] << "\";\n";
912       }
913       OS << "    }\n"
914          << "    llvm_unreachable(\"No enumerator with that value\");\n"
915          << "  }\n";
916     }
917   };
918 
919   class VariadicEnumArgument: public VariadicArgument {
920     std::string type, QualifiedTypeName;
921     std::vector<StringRef> values, enums, uniques;
922 
923   protected:
924     void writeValueImpl(raw_ostream &OS) const override {
925       // FIXME: this isn't 100% correct -- some enum arguments require printing
926       // as a string literal, while others require printing as an identifier.
927       // Tablegen currently does not distinguish between the two forms.
928       OS << "    OS << \"\\\"\" << " << getAttrName() << "Attr::Convert" << type
929          << "ToStr(Val)" << "<< \"\\\"\";\n";
930     }
931 
932   public:
933     VariadicEnumArgument(const Record &Arg, StringRef Attr)
934       : VariadicArgument(Arg, Attr, Arg.getValueAsString("Type")),
935         type(Arg.getValueAsString("Type")),
936         values(Arg.getValueAsListOfStrings("Values")),
937         enums(Arg.getValueAsListOfStrings("Enums")),
938         uniques(uniqueEnumsInOrder(enums))
939     {
940       QualifiedTypeName = getAttrName().str() + "Attr::" + type;
941 
942       // FIXME: Emit a proper error
943       assert(!uniques.empty());
944     }
945 
946     bool isVariadicEnumArg() const override { return true; }
947 
948     void writeDeclarations(raw_ostream &OS) const override {
949       auto i = uniques.cbegin(), e = uniques.cend();
950       // The last one needs to not have a comma.
951       --e;
952 
953       OS << "public:\n";
954       OS << "  enum " << type << " {\n";
955       for (; i != e; ++i)
956         OS << "    " << *i << ",\n";
957       OS << "    " << *e << "\n";
958       OS << "  };\n";
959       OS << "private:\n";
960 
961       VariadicArgument::writeDeclarations(OS);
962     }
963 
964     void writeDump(raw_ostream &OS) const override {
965       OS << "    for (" << getAttrName() << "Attr::" << getLowerName()
966          << "_iterator I = SA->" << getLowerName() << "_begin(), E = SA->"
967          << getLowerName() << "_end(); I != E; ++I) {\n";
968       OS << "      switch(*I) {\n";
969       for (const auto &UI : uniques) {
970         OS << "    case " << getAttrName() << "Attr::" << UI << ":\n";
971         OS << "      OS << \" " << UI << "\";\n";
972         OS << "      break;\n";
973       }
974       OS << "      }\n";
975       OS << "    }\n";
976     }
977 
978     void writePCHReadDecls(raw_ostream &OS) const override {
979       OS << "    unsigned " << getLowerName() << "Size = Record.readInt();\n";
980       OS << "    SmallVector<" << QualifiedTypeName << ", 4> " << getLowerName()
981          << ";\n";
982       OS << "    " << getLowerName() << ".reserve(" << getLowerName()
983          << "Size);\n";
984       OS << "    for (unsigned i = " << getLowerName() << "Size; i; --i)\n";
985       OS << "      " << getLowerName() << ".push_back(" << "static_cast<"
986          << QualifiedTypeName << ">(Record.readInt()));\n";
987     }
988 
989     void writePCHWrite(raw_ostream &OS) const override {
990       OS << "    Record.push_back(SA->" << getLowerName() << "_size());\n";
991       OS << "    for (" << getAttrName() << "Attr::" << getLowerName()
992          << "_iterator i = SA->" << getLowerName() << "_begin(), e = SA->"
993          << getLowerName() << "_end(); i != e; ++i)\n";
994       OS << "      " << WritePCHRecord(QualifiedTypeName, "(*i)");
995     }
996 
997     void writeConversion(raw_ostream &OS) const {
998       OS << "  static bool ConvertStrTo" << type << "(StringRef Val, ";
999       OS << type << " &Out) {\n";
1000       OS << "    Optional<" << type << "> R = llvm::StringSwitch<Optional<";
1001       OS << type << ">>(Val)\n";
1002       for (size_t I = 0; I < enums.size(); ++I) {
1003         OS << "      .Case(\"" << values[I] << "\", ";
1004         OS << getAttrName() << "Attr::" << enums[I] << ")\n";
1005       }
1006       OS << "      .Default(Optional<" << type << ">());\n";
1007       OS << "    if (R) {\n";
1008       OS << "      Out = *R;\n      return true;\n    }\n";
1009       OS << "    return false;\n";
1010       OS << "  }\n\n";
1011 
1012       OS << "  static const char *Convert" << type << "ToStr("
1013         << type << " Val) {\n"
1014         << "    switch(Val) {\n";
1015       SmallDenseSet<StringRef, 8> Uniques;
1016       for (size_t I = 0; I < enums.size(); ++I) {
1017         if (Uniques.insert(enums[I]).second)
1018           OS << "    case " << getAttrName() << "Attr::" << enums[I]
1019           << ": return \"" << values[I] << "\";\n";
1020       }
1021       OS << "    }\n"
1022         << "    llvm_unreachable(\"No enumerator with that value\");\n"
1023         << "  }\n";
1024     }
1025   };
1026 
1027   class VersionArgument : public Argument {
1028   public:
1029     VersionArgument(const Record &Arg, StringRef Attr)
1030       : Argument(Arg, Attr)
1031     {}
1032 
1033     void writeAccessors(raw_ostream &OS) const override {
1034       OS << "  VersionTuple get" << getUpperName() << "() const {\n";
1035       OS << "    return " << getLowerName() << ";\n";
1036       OS << "  }\n";
1037       OS << "  void set" << getUpperName()
1038          << "(ASTContext &C, VersionTuple V) {\n";
1039       OS << "    " << getLowerName() << " = V;\n";
1040       OS << "  }";
1041     }
1042 
1043     void writeCloneArgs(raw_ostream &OS) const override {
1044       OS << "get" << getUpperName() << "()";
1045     }
1046 
1047     void writeTemplateInstantiationArgs(raw_ostream &OS) const override {
1048       OS << "A->get" << getUpperName() << "()";
1049     }
1050 
1051     void writeCtorInitializers(raw_ostream &OS) const override {
1052       OS << getLowerName() << "(" << getUpperName() << ")";
1053     }
1054 
1055     void writeCtorDefaultInitializers(raw_ostream &OS) const override {
1056       OS << getLowerName() << "()";
1057     }
1058 
1059     void writeCtorParameters(raw_ostream &OS) const override {
1060       OS << "VersionTuple " << getUpperName();
1061     }
1062 
1063     void writeDeclarations(raw_ostream &OS) const override {
1064       OS << "VersionTuple " << getLowerName() << ";\n";
1065     }
1066 
1067     void writePCHReadDecls(raw_ostream &OS) const override {
1068       OS << "    VersionTuple " << getLowerName()
1069          << "= Record.readVersionTuple();\n";
1070     }
1071 
1072     void writePCHReadArgs(raw_ostream &OS) const override {
1073       OS << getLowerName();
1074     }
1075 
1076     void writePCHWrite(raw_ostream &OS) const override {
1077       OS << "    Record.AddVersionTuple(SA->get" << getUpperName() << "());\n";
1078     }
1079 
1080     void writeValue(raw_ostream &OS) const override {
1081       OS << getLowerName() << "=\" << get" << getUpperName() << "() << \"";
1082     }
1083 
1084     void writeDump(raw_ostream &OS) const override {
1085       OS << "    OS << \" \" << SA->get" << getUpperName() << "();\n";
1086     }
1087   };
1088 
1089   class ExprArgument : public SimpleArgument {
1090   public:
1091     ExprArgument(const Record &Arg, StringRef Attr)
1092       : SimpleArgument(Arg, Attr, "Expr *")
1093     {}
1094 
1095     void writeASTVisitorTraversal(raw_ostream &OS) const override {
1096       OS << "  if (!"
1097          << "getDerived().TraverseStmt(A->get" << getUpperName() << "()))\n";
1098       OS << "    return false;\n";
1099     }
1100 
1101     void writeTemplateInstantiationArgs(raw_ostream &OS) const override {
1102       OS << "tempInst" << getUpperName();
1103     }
1104 
1105     void writeTemplateInstantiation(raw_ostream &OS) const override {
1106       OS << "      " << getType() << " tempInst" << getUpperName() << ";\n";
1107       OS << "      {\n";
1108       OS << "        EnterExpressionEvaluationContext "
1109          << "Unevaluated(S, Sema::ExpressionEvaluationContext::Unevaluated);\n";
1110       OS << "        ExprResult " << "Result = S.SubstExpr("
1111          << "A->get" << getUpperName() << "(), TemplateArgs);\n";
1112       OS << "        tempInst" << getUpperName() << " = "
1113          << "Result.getAs<Expr>();\n";
1114       OS << "      }\n";
1115     }
1116 
1117     void writeDump(raw_ostream &OS) const override {}
1118 
1119     void writeDumpChildren(raw_ostream &OS) const override {
1120       OS << "    Visit(SA->get" << getUpperName() << "());\n";
1121     }
1122 
1123     void writeHasChildren(raw_ostream &OS) const override { OS << "true"; }
1124   };
1125 
1126   class VariadicExprArgument : public VariadicArgument {
1127   public:
1128     VariadicExprArgument(const Record &Arg, StringRef Attr)
1129       : VariadicArgument(Arg, Attr, "Expr *")
1130     {}
1131 
1132     void writeASTVisitorTraversal(raw_ostream &OS) const override {
1133       OS << "  {\n";
1134       OS << "    " << getType() << " *I = A->" << getLowerName()
1135          << "_begin();\n";
1136       OS << "    " << getType() << " *E = A->" << getLowerName()
1137          << "_end();\n";
1138       OS << "    for (; I != E; ++I) {\n";
1139       OS << "      if (!getDerived().TraverseStmt(*I))\n";
1140       OS << "        return false;\n";
1141       OS << "    }\n";
1142       OS << "  }\n";
1143     }
1144 
1145     void writeTemplateInstantiationArgs(raw_ostream &OS) const override {
1146       OS << "tempInst" << getUpperName() << ", "
1147          << "A->" << getLowerName() << "_size()";
1148     }
1149 
1150     void writeTemplateInstantiation(raw_ostream &OS) const override {
1151       OS << "      auto *tempInst" << getUpperName()
1152          << " = new (C, 16) " << getType()
1153          << "[A->" << getLowerName() << "_size()];\n";
1154       OS << "      {\n";
1155       OS << "        EnterExpressionEvaluationContext "
1156          << "Unevaluated(S, Sema::ExpressionEvaluationContext::Unevaluated);\n";
1157       OS << "        " << getType() << " *TI = tempInst" << getUpperName()
1158          << ";\n";
1159       OS << "        " << getType() << " *I = A->" << getLowerName()
1160          << "_begin();\n";
1161       OS << "        " << getType() << " *E = A->" << getLowerName()
1162          << "_end();\n";
1163       OS << "        for (; I != E; ++I, ++TI) {\n";
1164       OS << "          ExprResult Result = S.SubstExpr(*I, TemplateArgs);\n";
1165       OS << "          *TI = Result.getAs<Expr>();\n";
1166       OS << "        }\n";
1167       OS << "      }\n";
1168     }
1169 
1170     void writeDump(raw_ostream &OS) const override {}
1171 
1172     void writeDumpChildren(raw_ostream &OS) const override {
1173       OS << "    for (" << getAttrName() << "Attr::" << getLowerName()
1174          << "_iterator I = SA->" << getLowerName() << "_begin(), E = SA->"
1175          << getLowerName() << "_end(); I != E; ++I)\n";
1176       OS << "      Visit(*I);\n";
1177     }
1178 
1179     void writeHasChildren(raw_ostream &OS) const override {
1180       OS << "SA->" << getLowerName() << "_begin() != "
1181          << "SA->" << getLowerName() << "_end()";
1182     }
1183   };
1184 
1185   class VariadicIdentifierArgument : public VariadicArgument {
1186   public:
1187     VariadicIdentifierArgument(const Record &Arg, StringRef Attr)
1188       : VariadicArgument(Arg, Attr, "IdentifierInfo *")
1189     {}
1190   };
1191 
1192   class VariadicStringArgument : public VariadicArgument {
1193   public:
1194     VariadicStringArgument(const Record &Arg, StringRef Attr)
1195       : VariadicArgument(Arg, Attr, "StringRef")
1196     {}
1197 
1198     void writeCtorBody(raw_ostream &OS) const override {
1199       OS << "    for (size_t I = 0, E = " << getArgSizeName() << "; I != E;\n"
1200             "         ++I) {\n"
1201             "      StringRef Ref = " << getUpperName() << "[I];\n"
1202             "      if (!Ref.empty()) {\n"
1203             "        char *Mem = new (Ctx, 1) char[Ref.size()];\n"
1204             "        std::memcpy(Mem, Ref.data(), Ref.size());\n"
1205             "        " << getArgName() << "[I] = StringRef(Mem, Ref.size());\n"
1206             "      }\n"
1207             "    }\n";
1208     }
1209 
1210     void writeValueImpl(raw_ostream &OS) const override {
1211       OS << "    OS << \"\\\"\" << Val << \"\\\"\";\n";
1212     }
1213   };
1214 
1215   class TypeArgument : public SimpleArgument {
1216   public:
1217     TypeArgument(const Record &Arg, StringRef Attr)
1218       : SimpleArgument(Arg, Attr, "TypeSourceInfo *")
1219     {}
1220 
1221     void writeAccessors(raw_ostream &OS) const override {
1222       OS << "  QualType get" << getUpperName() << "() const {\n";
1223       OS << "    return " << getLowerName() << "->getType();\n";
1224       OS << "  }";
1225       OS << "  " << getType() << " get" << getUpperName() << "Loc() const {\n";
1226       OS << "    return " << getLowerName() << ";\n";
1227       OS << "  }";
1228     }
1229 
1230     void writeASTVisitorTraversal(raw_ostream &OS) const override {
1231       OS << "  if (auto *TSI = A->get" << getUpperName() << "Loc())\n";
1232       OS << "    if (!getDerived().TraverseTypeLoc(TSI->getTypeLoc()))\n";
1233       OS << "      return false;\n";
1234     }
1235 
1236     void writeTemplateInstantiationArgs(raw_ostream &OS) const override {
1237       OS << "A->get" << getUpperName() << "Loc()";
1238     }
1239 
1240     void writePCHWrite(raw_ostream &OS) const override {
1241       OS << "    " << WritePCHRecord(
1242           getType(), "SA->get" + std::string(getUpperName()) + "Loc()");
1243     }
1244   };
1245 
1246 } // end anonymous namespace
1247 
1248 static std::unique_ptr<Argument>
1249 createArgument(const Record &Arg, StringRef Attr,
1250                const Record *Search = nullptr) {
1251   if (!Search)
1252     Search = &Arg;
1253 
1254   std::unique_ptr<Argument> Ptr;
1255   llvm::StringRef ArgName = Search->getName();
1256 
1257   if (ArgName == "AlignedArgument")
1258     Ptr = llvm::make_unique<AlignedArgument>(Arg, Attr);
1259   else if (ArgName == "EnumArgument")
1260     Ptr = llvm::make_unique<EnumArgument>(Arg, Attr);
1261   else if (ArgName == "ExprArgument")
1262     Ptr = llvm::make_unique<ExprArgument>(Arg, Attr);
1263   else if (ArgName == "FunctionArgument")
1264     Ptr = llvm::make_unique<SimpleArgument>(Arg, Attr, "FunctionDecl *");
1265   else if (ArgName == "NamedArgument")
1266     Ptr = llvm::make_unique<SimpleArgument>(Arg, Attr, "NamedDecl *");
1267   else if (ArgName == "IdentifierArgument")
1268     Ptr = llvm::make_unique<SimpleArgument>(Arg, Attr, "IdentifierInfo *");
1269   else if (ArgName == "DefaultBoolArgument")
1270     Ptr = llvm::make_unique<DefaultSimpleArgument>(
1271         Arg, Attr, "bool", Arg.getValueAsBit("Default"));
1272   else if (ArgName == "BoolArgument")
1273     Ptr = llvm::make_unique<SimpleArgument>(Arg, Attr, "bool");
1274   else if (ArgName == "DefaultIntArgument")
1275     Ptr = llvm::make_unique<DefaultSimpleArgument>(
1276         Arg, Attr, "int", Arg.getValueAsInt("Default"));
1277   else if (ArgName == "IntArgument")
1278     Ptr = llvm::make_unique<SimpleArgument>(Arg, Attr, "int");
1279   else if (ArgName == "StringArgument")
1280     Ptr = llvm::make_unique<StringArgument>(Arg, Attr);
1281   else if (ArgName == "TypeArgument")
1282     Ptr = llvm::make_unique<TypeArgument>(Arg, Attr);
1283   else if (ArgName == "UnsignedArgument")
1284     Ptr = llvm::make_unique<SimpleArgument>(Arg, Attr, "unsigned");
1285   else if (ArgName == "VariadicUnsignedArgument")
1286     Ptr = llvm::make_unique<VariadicArgument>(Arg, Attr, "unsigned");
1287   else if (ArgName == "VariadicStringArgument")
1288     Ptr = llvm::make_unique<VariadicStringArgument>(Arg, Attr);
1289   else if (ArgName == "VariadicEnumArgument")
1290     Ptr = llvm::make_unique<VariadicEnumArgument>(Arg, Attr);
1291   else if (ArgName == "VariadicExprArgument")
1292     Ptr = llvm::make_unique<VariadicExprArgument>(Arg, Attr);
1293   else if (ArgName == "VariadicParamIdxArgument")
1294     Ptr = llvm::make_unique<VariadicParamIdxArgument>(Arg, Attr);
1295   else if (ArgName == "VariadicParamOrParamIdxArgument")
1296     Ptr = llvm::make_unique<VariadicParamOrParamIdxArgument>(Arg, Attr);
1297   else if (ArgName == "ParamIdxArgument")
1298     Ptr = llvm::make_unique<SimpleArgument>(Arg, Attr, "ParamIdx");
1299   else if (ArgName == "VariadicIdentifierArgument")
1300     Ptr = llvm::make_unique<VariadicIdentifierArgument>(Arg, Attr);
1301   else if (ArgName == "VersionArgument")
1302     Ptr = llvm::make_unique<VersionArgument>(Arg, Attr);
1303 
1304   if (!Ptr) {
1305     // Search in reverse order so that the most-derived type is handled first.
1306     ArrayRef<std::pair<Record*, SMRange>> Bases = Search->getSuperClasses();
1307     for (const auto &Base : llvm::reverse(Bases)) {
1308       if ((Ptr = createArgument(Arg, Attr, Base.first)))
1309         break;
1310     }
1311   }
1312 
1313   if (Ptr && Arg.getValueAsBit("Optional"))
1314     Ptr->setOptional(true);
1315 
1316   if (Ptr && Arg.getValueAsBit("Fake"))
1317     Ptr->setFake(true);
1318 
1319   return Ptr;
1320 }
1321 
1322 static void writeAvailabilityValue(raw_ostream &OS) {
1323   OS << "\" << getPlatform()->getName();\n"
1324      << "  if (getStrict()) OS << \", strict\";\n"
1325      << "  if (!getIntroduced().empty()) OS << \", introduced=\" << getIntroduced();\n"
1326      << "  if (!getDeprecated().empty()) OS << \", deprecated=\" << getDeprecated();\n"
1327      << "  if (!getObsoleted().empty()) OS << \", obsoleted=\" << getObsoleted();\n"
1328      << "  if (getUnavailable()) OS << \", unavailable\";\n"
1329      << "  OS << \"";
1330 }
1331 
1332 static void writeDeprecatedAttrValue(raw_ostream &OS, std::string &Variety) {
1333   OS << "\\\"\" << getMessage() << \"\\\"\";\n";
1334   // Only GNU deprecated has an optional fixit argument at the second position.
1335   if (Variety == "GNU")
1336      OS << "    if (!getReplacement().empty()) OS << \", \\\"\""
1337            " << getReplacement() << \"\\\"\";\n";
1338   OS << "    OS << \"";
1339 }
1340 
1341 static void writeGetSpellingFunction(Record &R, raw_ostream &OS) {
1342   std::vector<FlattenedSpelling> Spellings = GetFlattenedSpellings(R);
1343 
1344   OS << "const char *" << R.getName() << "Attr::getSpelling() const {\n";
1345   if (Spellings.empty()) {
1346     OS << "  return \"(No spelling)\";\n}\n\n";
1347     return;
1348   }
1349 
1350   OS << "  switch (SpellingListIndex) {\n"
1351         "  default:\n"
1352         "    llvm_unreachable(\"Unknown attribute spelling!\");\n"
1353         "    return \"(No spelling)\";\n";
1354 
1355   for (unsigned I = 0; I < Spellings.size(); ++I)
1356     OS << "  case " << I << ":\n"
1357           "    return \"" << Spellings[I].name() << "\";\n";
1358   // End of the switch statement.
1359   OS << "  }\n";
1360   // End of the getSpelling function.
1361   OS << "}\n\n";
1362 }
1363 
1364 static void
1365 writePrettyPrintFunction(Record &R,
1366                          const std::vector<std::unique_ptr<Argument>> &Args,
1367                          raw_ostream &OS) {
1368   std::vector<FlattenedSpelling> Spellings = GetFlattenedSpellings(R);
1369 
1370   OS << "void " << R.getName() << "Attr::printPretty("
1371     << "raw_ostream &OS, const PrintingPolicy &Policy) const {\n";
1372 
1373   if (Spellings.empty()) {
1374     OS << "}\n\n";
1375     return;
1376   }
1377 
1378   OS <<
1379     "  switch (SpellingListIndex) {\n"
1380     "  default:\n"
1381     "    llvm_unreachable(\"Unknown attribute spelling!\");\n"
1382     "    break;\n";
1383 
1384   for (unsigned I = 0; I < Spellings.size(); ++ I) {
1385     llvm::SmallString<16> Prefix;
1386     llvm::SmallString<8> Suffix;
1387     // The actual spelling of the name and namespace (if applicable)
1388     // of an attribute without considering prefix and suffix.
1389     llvm::SmallString<64> Spelling;
1390     std::string Name = Spellings[I].name();
1391     std::string Variety = Spellings[I].variety();
1392 
1393     if (Variety == "GNU") {
1394       Prefix = " __attribute__((";
1395       Suffix = "))";
1396     } else if (Variety == "CXX11" || Variety == "C2x") {
1397       Prefix = " [[";
1398       Suffix = "]]";
1399       std::string Namespace = Spellings[I].nameSpace();
1400       if (!Namespace.empty()) {
1401         Spelling += Namespace;
1402         Spelling += "::";
1403       }
1404     } else if (Variety == "Declspec") {
1405       Prefix = " __declspec(";
1406       Suffix = ")";
1407     } else if (Variety == "Microsoft") {
1408       Prefix = "[";
1409       Suffix = "]";
1410     } else if (Variety == "Keyword") {
1411       Prefix = " ";
1412       Suffix = "";
1413     } else if (Variety == "Pragma") {
1414       Prefix = "#pragma ";
1415       Suffix = "\n";
1416       std::string Namespace = Spellings[I].nameSpace();
1417       if (!Namespace.empty()) {
1418         Spelling += Namespace;
1419         Spelling += " ";
1420       }
1421     } else {
1422       llvm_unreachable("Unknown attribute syntax variety!");
1423     }
1424 
1425     Spelling += Name;
1426 
1427     OS <<
1428       "  case " << I << " : {\n"
1429       "    OS << \"" << Prefix << Spelling;
1430 
1431     if (Variety == "Pragma") {
1432       OS << "\";\n";
1433       OS << "    printPrettyPragma(OS, Policy);\n";
1434       OS << "    OS << \"\\n\";";
1435       OS << "    break;\n";
1436       OS << "  }\n";
1437       continue;
1438     }
1439 
1440     if (Spelling == "availability") {
1441       OS << "(";
1442       writeAvailabilityValue(OS);
1443       OS << ")";
1444     } else if (Spelling == "deprecated" || Spelling == "gnu::deprecated") {
1445       OS << "(";
1446       writeDeprecatedAttrValue(OS, Variety);
1447       OS << ")";
1448     } else {
1449       // To avoid printing parentheses around an empty argument list or
1450       // printing spurious commas at the end of an argument list, we need to
1451       // determine where the last provided non-fake argument is.
1452       unsigned NonFakeArgs = 0;
1453       unsigned TrailingOptArgs = 0;
1454       bool FoundNonOptArg = false;
1455       for (const auto &arg : llvm::reverse(Args)) {
1456         if (arg->isFake())
1457           continue;
1458         ++NonFakeArgs;
1459         if (FoundNonOptArg)
1460           continue;
1461         // FIXME: arg->getIsOmitted() == "false" means we haven't implemented
1462         // any way to detect whether the argument was omitted.
1463         if (!arg->isOptional() || arg->getIsOmitted() == "false") {
1464           FoundNonOptArg = true;
1465           continue;
1466         }
1467         if (!TrailingOptArgs++)
1468           OS << "\";\n"
1469              << "    unsigned TrailingOmittedArgs = 0;\n";
1470         OS << "    if (" << arg->getIsOmitted() << ")\n"
1471            << "      ++TrailingOmittedArgs;\n";
1472       }
1473       if (TrailingOptArgs)
1474         OS << "    OS << \"";
1475       if (TrailingOptArgs < NonFakeArgs)
1476         OS << "(";
1477       else if (TrailingOptArgs)
1478         OS << "\";\n"
1479            << "    if (TrailingOmittedArgs < " << NonFakeArgs << ")\n"
1480            << "       OS << \"(\";\n"
1481            << "    OS << \"";
1482       unsigned ArgIndex = 0;
1483       for (const auto &arg : Args) {
1484         if (arg->isFake())
1485           continue;
1486         if (ArgIndex) {
1487           if (ArgIndex >= NonFakeArgs - TrailingOptArgs)
1488             OS << "\";\n"
1489                << "    if (" << ArgIndex << " < " << NonFakeArgs
1490                << " - TrailingOmittedArgs)\n"
1491                << "      OS << \", \";\n"
1492                << "    OS << \"";
1493           else
1494             OS << ", ";
1495         }
1496         std::string IsOmitted = arg->getIsOmitted();
1497         if (arg->isOptional() && IsOmitted != "false")
1498           OS << "\";\n"
1499              << "    if (!(" << IsOmitted << ")) {\n"
1500              << "      OS << \"";
1501         arg->writeValue(OS);
1502         if (arg->isOptional() && IsOmitted != "false")
1503           OS << "\";\n"
1504              << "    }\n"
1505              << "    OS << \"";
1506         ++ArgIndex;
1507       }
1508       if (TrailingOptArgs < NonFakeArgs)
1509         OS << ")";
1510       else if (TrailingOptArgs)
1511         OS << "\";\n"
1512            << "    if (TrailingOmittedArgs < " << NonFakeArgs << ")\n"
1513            << "       OS << \")\";\n"
1514            << "    OS << \"";
1515     }
1516 
1517     OS << Suffix + "\";\n";
1518 
1519     OS <<
1520       "    break;\n"
1521       "  }\n";
1522   }
1523 
1524   // End of the switch statement.
1525   OS << "}\n";
1526   // End of the print function.
1527   OS << "}\n\n";
1528 }
1529 
1530 /// Return the index of a spelling in a spelling list.
1531 static unsigned
1532 getSpellingListIndex(const std::vector<FlattenedSpelling> &SpellingList,
1533                      const FlattenedSpelling &Spelling) {
1534   assert(!SpellingList.empty() && "Spelling list is empty!");
1535 
1536   for (unsigned Index = 0; Index < SpellingList.size(); ++Index) {
1537     const FlattenedSpelling &S = SpellingList[Index];
1538     if (S.variety() != Spelling.variety())
1539       continue;
1540     if (S.nameSpace() != Spelling.nameSpace())
1541       continue;
1542     if (S.name() != Spelling.name())
1543       continue;
1544 
1545     return Index;
1546   }
1547 
1548   llvm_unreachable("Unknown spelling!");
1549 }
1550 
1551 static void writeAttrAccessorDefinition(const Record &R, raw_ostream &OS) {
1552   std::vector<Record*> Accessors = R.getValueAsListOfDefs("Accessors");
1553   if (Accessors.empty())
1554     return;
1555 
1556   const std::vector<FlattenedSpelling> SpellingList = GetFlattenedSpellings(R);
1557   assert(!SpellingList.empty() &&
1558          "Attribute with empty spelling list can't have accessors!");
1559   for (const auto *Accessor : Accessors) {
1560     const StringRef Name = Accessor->getValueAsString("Name");
1561     std::vector<FlattenedSpelling> Spellings = GetFlattenedSpellings(*Accessor);
1562 
1563     OS << "  bool " << Name << "() const { return SpellingListIndex == ";
1564     for (unsigned Index = 0; Index < Spellings.size(); ++Index) {
1565       OS << getSpellingListIndex(SpellingList, Spellings[Index]);
1566       if (Index != Spellings.size() - 1)
1567         OS << " ||\n    SpellingListIndex == ";
1568       else
1569         OS << "; }\n";
1570     }
1571   }
1572 }
1573 
1574 static bool
1575 SpellingNamesAreCommon(const std::vector<FlattenedSpelling>& Spellings) {
1576   assert(!Spellings.empty() && "An empty list of spellings was provided");
1577   std::string FirstName = NormalizeNameForSpellingComparison(
1578     Spellings.front().name());
1579   for (const auto &Spelling :
1580        llvm::make_range(std::next(Spellings.begin()), Spellings.end())) {
1581     std::string Name = NormalizeNameForSpellingComparison(Spelling.name());
1582     if (Name != FirstName)
1583       return false;
1584   }
1585   return true;
1586 }
1587 
1588 typedef std::map<unsigned, std::string> SemanticSpellingMap;
1589 static std::string
1590 CreateSemanticSpellings(const std::vector<FlattenedSpelling> &Spellings,
1591                         SemanticSpellingMap &Map) {
1592   // The enumerants are automatically generated based on the variety,
1593   // namespace (if present) and name for each attribute spelling. However,
1594   // care is taken to avoid trampling on the reserved namespace due to
1595   // underscores.
1596   std::string Ret("  enum Spelling {\n");
1597   std::set<std::string> Uniques;
1598   unsigned Idx = 0;
1599   for (auto I = Spellings.begin(), E = Spellings.end(); I != E; ++I, ++Idx) {
1600     const FlattenedSpelling &S = *I;
1601     const std::string &Variety = S.variety();
1602     const std::string &Spelling = S.name();
1603     const std::string &Namespace = S.nameSpace();
1604     std::string EnumName;
1605 
1606     EnumName += (Variety + "_");
1607     if (!Namespace.empty())
1608       EnumName += (NormalizeNameForSpellingComparison(Namespace).str() +
1609       "_");
1610     EnumName += NormalizeNameForSpellingComparison(Spelling);
1611 
1612     // Even if the name is not unique, this spelling index corresponds to a
1613     // particular enumerant name that we've calculated.
1614     Map[Idx] = EnumName;
1615 
1616     // Since we have been stripping underscores to avoid trampling on the
1617     // reserved namespace, we may have inadvertently created duplicate
1618     // enumerant names. These duplicates are not considered part of the
1619     // semantic spelling, and can be elided.
1620     if (Uniques.find(EnumName) != Uniques.end())
1621       continue;
1622 
1623     Uniques.insert(EnumName);
1624     if (I != Spellings.begin())
1625       Ret += ",\n";
1626     // Duplicate spellings are not considered part of the semantic spelling
1627     // enumeration, but the spelling index and semantic spelling values are
1628     // meant to be equivalent, so we must specify a concrete value for each
1629     // enumerator.
1630     Ret += "    " + EnumName + " = " + llvm::utostr(Idx);
1631   }
1632   Ret += "\n  };\n\n";
1633   return Ret;
1634 }
1635 
1636 void WriteSemanticSpellingSwitch(const std::string &VarName,
1637                                  const SemanticSpellingMap &Map,
1638                                  raw_ostream &OS) {
1639   OS << "  switch (" << VarName << ") {\n    default: "
1640     << "llvm_unreachable(\"Unknown spelling list index\");\n";
1641   for (const auto &I : Map)
1642     OS << "    case " << I.first << ": return " << I.second << ";\n";
1643   OS << "  }\n";
1644 }
1645 
1646 // Emits the LateParsed property for attributes.
1647 static void emitClangAttrLateParsedList(RecordKeeper &Records, raw_ostream &OS) {
1648   OS << "#if defined(CLANG_ATTR_LATE_PARSED_LIST)\n";
1649   std::vector<Record*> Attrs = Records.getAllDerivedDefinitions("Attr");
1650 
1651   for (const auto *Attr : Attrs) {
1652     bool LateParsed = Attr->getValueAsBit("LateParsed");
1653 
1654     if (LateParsed) {
1655       std::vector<FlattenedSpelling> Spellings = GetFlattenedSpellings(*Attr);
1656 
1657       // FIXME: Handle non-GNU attributes
1658       for (const auto &I : Spellings) {
1659         if (I.variety() != "GNU")
1660           continue;
1661         OS << ".Case(\"" << I.name() << "\", " << LateParsed << ")\n";
1662       }
1663     }
1664   }
1665   OS << "#endif // CLANG_ATTR_LATE_PARSED_LIST\n\n";
1666 }
1667 
1668 static bool hasGNUorCXX11Spelling(const Record &Attribute) {
1669   std::vector<FlattenedSpelling> Spellings = GetFlattenedSpellings(Attribute);
1670   for (const auto &I : Spellings) {
1671     if (I.variety() == "GNU" || I.variety() == "CXX11")
1672       return true;
1673   }
1674   return false;
1675 }
1676 
1677 namespace {
1678 
1679 struct AttributeSubjectMatchRule {
1680   const Record *MetaSubject;
1681   const Record *Constraint;
1682 
1683   AttributeSubjectMatchRule(const Record *MetaSubject, const Record *Constraint)
1684       : MetaSubject(MetaSubject), Constraint(Constraint) {
1685     assert(MetaSubject && "Missing subject");
1686   }
1687 
1688   bool isSubRule() const { return Constraint != nullptr; }
1689 
1690   std::vector<Record *> getSubjects() const {
1691     return (Constraint ? Constraint : MetaSubject)
1692         ->getValueAsListOfDefs("Subjects");
1693   }
1694 
1695   std::vector<Record *> getLangOpts() const {
1696     if (Constraint) {
1697       // Lookup the options in the sub-rule first, in case the sub-rule
1698       // overrides the rules options.
1699       std::vector<Record *> Opts = Constraint->getValueAsListOfDefs("LangOpts");
1700       if (!Opts.empty())
1701         return Opts;
1702     }
1703     return MetaSubject->getValueAsListOfDefs("LangOpts");
1704   }
1705 
1706   // Abstract rules are used only for sub-rules
1707   bool isAbstractRule() const { return getSubjects().empty(); }
1708 
1709   StringRef getName() const {
1710     return (Constraint ? Constraint : MetaSubject)->getValueAsString("Name");
1711   }
1712 
1713   bool isNegatedSubRule() const {
1714     assert(isSubRule() && "Not a sub-rule");
1715     return Constraint->getValueAsBit("Negated");
1716   }
1717 
1718   std::string getSpelling() const {
1719     std::string Result = MetaSubject->getValueAsString("Name");
1720     if (isSubRule()) {
1721       Result += '(';
1722       if (isNegatedSubRule())
1723         Result += "unless(";
1724       Result += getName();
1725       if (isNegatedSubRule())
1726         Result += ')';
1727       Result += ')';
1728     }
1729     return Result;
1730   }
1731 
1732   std::string getEnumValueName() const {
1733     SmallString<128> Result;
1734     Result += "SubjectMatchRule_";
1735     Result += MetaSubject->getValueAsString("Name");
1736     if (isSubRule()) {
1737       Result += "_";
1738       if (isNegatedSubRule())
1739         Result += "not_";
1740       Result += Constraint->getValueAsString("Name");
1741     }
1742     if (isAbstractRule())
1743       Result += "_abstract";
1744     return Result.str();
1745   }
1746 
1747   std::string getEnumValue() const { return "attr::" + getEnumValueName(); }
1748 
1749   static const char *EnumName;
1750 };
1751 
1752 const char *AttributeSubjectMatchRule::EnumName = "attr::SubjectMatchRule";
1753 
1754 struct PragmaClangAttributeSupport {
1755   std::vector<AttributeSubjectMatchRule> Rules;
1756 
1757   class RuleOrAggregateRuleSet {
1758     std::vector<AttributeSubjectMatchRule> Rules;
1759     bool IsRule;
1760     RuleOrAggregateRuleSet(ArrayRef<AttributeSubjectMatchRule> Rules,
1761                            bool IsRule)
1762         : Rules(Rules), IsRule(IsRule) {}
1763 
1764   public:
1765     bool isRule() const { return IsRule; }
1766 
1767     const AttributeSubjectMatchRule &getRule() const {
1768       assert(IsRule && "not a rule!");
1769       return Rules[0];
1770     }
1771 
1772     ArrayRef<AttributeSubjectMatchRule> getAggregateRuleSet() const {
1773       return Rules;
1774     }
1775 
1776     static RuleOrAggregateRuleSet
1777     getRule(const AttributeSubjectMatchRule &Rule) {
1778       return RuleOrAggregateRuleSet(Rule, /*IsRule=*/true);
1779     }
1780     static RuleOrAggregateRuleSet
1781     getAggregateRuleSet(ArrayRef<AttributeSubjectMatchRule> Rules) {
1782       return RuleOrAggregateRuleSet(Rules, /*IsRule=*/false);
1783     }
1784   };
1785   llvm::DenseMap<const Record *, RuleOrAggregateRuleSet> SubjectsToRules;
1786 
1787   PragmaClangAttributeSupport(RecordKeeper &Records);
1788 
1789   bool isAttributedSupported(const Record &Attribute);
1790 
1791   void emitMatchRuleList(raw_ostream &OS);
1792 
1793   std::string generateStrictConformsTo(const Record &Attr, raw_ostream &OS);
1794 
1795   void generateParsingHelpers(raw_ostream &OS);
1796 };
1797 
1798 } // end anonymous namespace
1799 
1800 static bool doesDeclDeriveFrom(const Record *D, const Record *Base) {
1801   const Record *CurrentBase = D->getValueAsDef("Base");
1802   if (!CurrentBase)
1803     return false;
1804   if (CurrentBase == Base)
1805     return true;
1806   return doesDeclDeriveFrom(CurrentBase, Base);
1807 }
1808 
1809 PragmaClangAttributeSupport::PragmaClangAttributeSupport(
1810     RecordKeeper &Records) {
1811   std::vector<Record *> MetaSubjects =
1812       Records.getAllDerivedDefinitions("AttrSubjectMatcherRule");
1813   auto MapFromSubjectsToRules = [this](const Record *SubjectContainer,
1814                                        const Record *MetaSubject,
1815                                        const Record *Constraint) {
1816     Rules.emplace_back(MetaSubject, Constraint);
1817     std::vector<Record *> ApplicableSubjects =
1818         SubjectContainer->getValueAsListOfDefs("Subjects");
1819     for (const auto *Subject : ApplicableSubjects) {
1820       bool Inserted =
1821           SubjectsToRules
1822               .try_emplace(Subject, RuleOrAggregateRuleSet::getRule(
1823                                         AttributeSubjectMatchRule(MetaSubject,
1824                                                                   Constraint)))
1825               .second;
1826       if (!Inserted) {
1827         PrintFatalError("Attribute subject match rules should not represent"
1828                         "same attribute subjects.");
1829       }
1830     }
1831   };
1832   for (const auto *MetaSubject : MetaSubjects) {
1833     MapFromSubjectsToRules(MetaSubject, MetaSubject, /*Constraints=*/nullptr);
1834     std::vector<Record *> Constraints =
1835         MetaSubject->getValueAsListOfDefs("Constraints");
1836     for (const auto *Constraint : Constraints)
1837       MapFromSubjectsToRules(Constraint, MetaSubject, Constraint);
1838   }
1839 
1840   std::vector<Record *> Aggregates =
1841       Records.getAllDerivedDefinitions("AttrSubjectMatcherAggregateRule");
1842   std::vector<Record *> DeclNodes = Records.getAllDerivedDefinitions("DDecl");
1843   for (const auto *Aggregate : Aggregates) {
1844     Record *SubjectDecl = Aggregate->getValueAsDef("Subject");
1845 
1846     // Gather sub-classes of the aggregate subject that act as attribute
1847     // subject rules.
1848     std::vector<AttributeSubjectMatchRule> Rules;
1849     for (const auto *D : DeclNodes) {
1850       if (doesDeclDeriveFrom(D, SubjectDecl)) {
1851         auto It = SubjectsToRules.find(D);
1852         if (It == SubjectsToRules.end())
1853           continue;
1854         if (!It->second.isRule() || It->second.getRule().isSubRule())
1855           continue; // Assume that the rule will be included as well.
1856         Rules.push_back(It->second.getRule());
1857       }
1858     }
1859 
1860     bool Inserted =
1861         SubjectsToRules
1862             .try_emplace(SubjectDecl,
1863                          RuleOrAggregateRuleSet::getAggregateRuleSet(Rules))
1864             .second;
1865     if (!Inserted) {
1866       PrintFatalError("Attribute subject match rules should not represent"
1867                       "same attribute subjects.");
1868     }
1869   }
1870 }
1871 
1872 static PragmaClangAttributeSupport &
1873 getPragmaAttributeSupport(RecordKeeper &Records) {
1874   static PragmaClangAttributeSupport Instance(Records);
1875   return Instance;
1876 }
1877 
1878 void PragmaClangAttributeSupport::emitMatchRuleList(raw_ostream &OS) {
1879   OS << "#ifndef ATTR_MATCH_SUB_RULE\n";
1880   OS << "#define ATTR_MATCH_SUB_RULE(Value, Spelling, IsAbstract, Parent, "
1881         "IsNegated) "
1882      << "ATTR_MATCH_RULE(Value, Spelling, IsAbstract)\n";
1883   OS << "#endif\n";
1884   for (const auto &Rule : Rules) {
1885     OS << (Rule.isSubRule() ? "ATTR_MATCH_SUB_RULE" : "ATTR_MATCH_RULE") << '(';
1886     OS << Rule.getEnumValueName() << ", \"" << Rule.getSpelling() << "\", "
1887        << Rule.isAbstractRule();
1888     if (Rule.isSubRule())
1889       OS << ", "
1890          << AttributeSubjectMatchRule(Rule.MetaSubject, nullptr).getEnumValue()
1891          << ", " << Rule.isNegatedSubRule();
1892     OS << ")\n";
1893   }
1894   OS << "#undef ATTR_MATCH_SUB_RULE\n";
1895 }
1896 
1897 bool PragmaClangAttributeSupport::isAttributedSupported(
1898     const Record &Attribute) {
1899   // If the attribute explicitly specified whether to support #pragma clang
1900   // attribute, use that setting.
1901   bool Unset;
1902   bool SpecifiedResult =
1903     Attribute.getValueAsBitOrUnset("PragmaAttributeSupport", Unset);
1904   if (!Unset)
1905     return SpecifiedResult;
1906 
1907   // Opt-out rules:
1908   // An attribute requires delayed parsing (LateParsed is on)
1909   if (Attribute.getValueAsBit("LateParsed"))
1910     return false;
1911   // An attribute has no GNU/CXX11 spelling
1912   if (!hasGNUorCXX11Spelling(Attribute))
1913     return false;
1914   // An attribute subject list has a subject that isn't covered by one of the
1915   // subject match rules or has no subjects at all.
1916   if (Attribute.isValueUnset("Subjects"))
1917     return false;
1918   const Record *SubjectObj = Attribute.getValueAsDef("Subjects");
1919   std::vector<Record *> Subjects = SubjectObj->getValueAsListOfDefs("Subjects");
1920   if (Subjects.empty())
1921     return false;
1922   for (const auto *Subject : Subjects) {
1923     if (SubjectsToRules.find(Subject) == SubjectsToRules.end())
1924       return false;
1925   }
1926   return true;
1927 }
1928 
1929 static std::string GenerateTestExpression(ArrayRef<Record *> LangOpts) {
1930   std::string Test;
1931 
1932   for (auto *E : LangOpts) {
1933     if (!Test.empty())
1934       Test += " || ";
1935 
1936     const StringRef Code = E->getValueAsString("CustomCode");
1937     if (!Code.empty()) {
1938       Test += "(";
1939       Test += Code;
1940       Test += ")";
1941     } else {
1942       Test += "LangOpts.";
1943       Test += E->getValueAsString("Name");
1944     }
1945   }
1946 
1947   if (Test.empty())
1948     return "true";
1949 
1950   return Test;
1951 }
1952 
1953 std::string
1954 PragmaClangAttributeSupport::generateStrictConformsTo(const Record &Attr,
1955                                                       raw_ostream &OS) {
1956   if (!isAttributedSupported(Attr))
1957     return "nullptr";
1958   // Generate a function that constructs a set of matching rules that describe
1959   // to which declarations the attribute should apply to.
1960   std::string FnName = "matchRulesFor" + Attr.getName().str();
1961   OS << "static void " << FnName << "(llvm::SmallVectorImpl<std::pair<"
1962      << AttributeSubjectMatchRule::EnumName
1963      << ", bool>> &MatchRules, const LangOptions &LangOpts) {\n";
1964   if (Attr.isValueUnset("Subjects")) {
1965     OS << "}\n\n";
1966     return FnName;
1967   }
1968   const Record *SubjectObj = Attr.getValueAsDef("Subjects");
1969   std::vector<Record *> Subjects = SubjectObj->getValueAsListOfDefs("Subjects");
1970   for (const auto *Subject : Subjects) {
1971     auto It = SubjectsToRules.find(Subject);
1972     assert(It != SubjectsToRules.end() &&
1973            "This attribute is unsupported by #pragma clang attribute");
1974     for (const auto &Rule : It->getSecond().getAggregateRuleSet()) {
1975       // The rule might be language specific, so only subtract it from the given
1976       // rules if the specific language options are specified.
1977       std::vector<Record *> LangOpts = Rule.getLangOpts();
1978       OS << "  MatchRules.push_back(std::make_pair(" << Rule.getEnumValue()
1979          << ", /*IsSupported=*/" << GenerateTestExpression(LangOpts)
1980          << "));\n";
1981     }
1982   }
1983   OS << "}\n\n";
1984   return FnName;
1985 }
1986 
1987 void PragmaClangAttributeSupport::generateParsingHelpers(raw_ostream &OS) {
1988   // Generate routines that check the names of sub-rules.
1989   OS << "Optional<attr::SubjectMatchRule> "
1990         "defaultIsAttributeSubjectMatchSubRuleFor(StringRef, bool) {\n";
1991   OS << "  return None;\n";
1992   OS << "}\n\n";
1993 
1994   std::map<const Record *, std::vector<AttributeSubjectMatchRule>>
1995       SubMatchRules;
1996   for (const auto &Rule : Rules) {
1997     if (!Rule.isSubRule())
1998       continue;
1999     SubMatchRules[Rule.MetaSubject].push_back(Rule);
2000   }
2001 
2002   for (const auto &SubMatchRule : SubMatchRules) {
2003     OS << "Optional<attr::SubjectMatchRule> isAttributeSubjectMatchSubRuleFor_"
2004        << SubMatchRule.first->getValueAsString("Name")
2005        << "(StringRef Name, bool IsUnless) {\n";
2006     OS << "  if (IsUnless)\n";
2007     OS << "    return "
2008           "llvm::StringSwitch<Optional<attr::SubjectMatchRule>>(Name).\n";
2009     for (const auto &Rule : SubMatchRule.second) {
2010       if (Rule.isNegatedSubRule())
2011         OS << "    Case(\"" << Rule.getName() << "\", " << Rule.getEnumValue()
2012            << ").\n";
2013     }
2014     OS << "    Default(None);\n";
2015     OS << "  return "
2016           "llvm::StringSwitch<Optional<attr::SubjectMatchRule>>(Name).\n";
2017     for (const auto &Rule : SubMatchRule.second) {
2018       if (!Rule.isNegatedSubRule())
2019         OS << "  Case(\"" << Rule.getName() << "\", " << Rule.getEnumValue()
2020            << ").\n";
2021     }
2022     OS << "  Default(None);\n";
2023     OS << "}\n\n";
2024   }
2025 
2026   // Generate the function that checks for the top-level rules.
2027   OS << "std::pair<Optional<attr::SubjectMatchRule>, "
2028         "Optional<attr::SubjectMatchRule> (*)(StringRef, "
2029         "bool)> isAttributeSubjectMatchRule(StringRef Name) {\n";
2030   OS << "  return "
2031         "llvm::StringSwitch<std::pair<Optional<attr::SubjectMatchRule>, "
2032         "Optional<attr::SubjectMatchRule> (*) (StringRef, "
2033         "bool)>>(Name).\n";
2034   for (const auto &Rule : Rules) {
2035     if (Rule.isSubRule())
2036       continue;
2037     std::string SubRuleFunction;
2038     if (SubMatchRules.count(Rule.MetaSubject))
2039       SubRuleFunction =
2040           ("isAttributeSubjectMatchSubRuleFor_" + Rule.getName()).str();
2041     else
2042       SubRuleFunction = "defaultIsAttributeSubjectMatchSubRuleFor";
2043     OS << "  Case(\"" << Rule.getName() << "\", std::make_pair("
2044        << Rule.getEnumValue() << ", " << SubRuleFunction << ")).\n";
2045   }
2046   OS << "  Default(std::make_pair(None, "
2047         "defaultIsAttributeSubjectMatchSubRuleFor));\n";
2048   OS << "}\n\n";
2049 
2050   // Generate the function that checks for the submatch rules.
2051   OS << "const char *validAttributeSubjectMatchSubRules("
2052      << AttributeSubjectMatchRule::EnumName << " Rule) {\n";
2053   OS << "  switch (Rule) {\n";
2054   for (const auto &SubMatchRule : SubMatchRules) {
2055     OS << "  case "
2056        << AttributeSubjectMatchRule(SubMatchRule.first, nullptr).getEnumValue()
2057        << ":\n";
2058     OS << "  return \"'";
2059     bool IsFirst = true;
2060     for (const auto &Rule : SubMatchRule.second) {
2061       if (!IsFirst)
2062         OS << ", '";
2063       IsFirst = false;
2064       if (Rule.isNegatedSubRule())
2065         OS << "unless(";
2066       OS << Rule.getName();
2067       if (Rule.isNegatedSubRule())
2068         OS << ')';
2069       OS << "'";
2070     }
2071     OS << "\";\n";
2072   }
2073   OS << "  default: return nullptr;\n";
2074   OS << "  }\n";
2075   OS << "}\n\n";
2076 }
2077 
2078 template <typename Fn>
2079 static void forEachUniqueSpelling(const Record &Attr, Fn &&F) {
2080   std::vector<FlattenedSpelling> Spellings = GetFlattenedSpellings(Attr);
2081   SmallDenseSet<StringRef, 8> Seen;
2082   for (const FlattenedSpelling &S : Spellings) {
2083     if (Seen.insert(S.name()).second)
2084       F(S);
2085   }
2086 }
2087 
2088 /// Emits the first-argument-is-type property for attributes.
2089 static void emitClangAttrTypeArgList(RecordKeeper &Records, raw_ostream &OS) {
2090   OS << "#if defined(CLANG_ATTR_TYPE_ARG_LIST)\n";
2091   std::vector<Record *> Attrs = Records.getAllDerivedDefinitions("Attr");
2092 
2093   for (const auto *Attr : Attrs) {
2094     // Determine whether the first argument is a type.
2095     std::vector<Record *> Args = Attr->getValueAsListOfDefs("Args");
2096     if (Args.empty())
2097       continue;
2098 
2099     if (Args[0]->getSuperClasses().back().first->getName() != "TypeArgument")
2100       continue;
2101 
2102     // All these spellings take a single type argument.
2103     forEachUniqueSpelling(*Attr, [&](const FlattenedSpelling &S) {
2104       OS << ".Case(\"" << S.name() << "\", " << "true" << ")\n";
2105     });
2106   }
2107   OS << "#endif // CLANG_ATTR_TYPE_ARG_LIST\n\n";
2108 }
2109 
2110 /// Emits the parse-arguments-in-unevaluated-context property for
2111 /// attributes.
2112 static void emitClangAttrArgContextList(RecordKeeper &Records, raw_ostream &OS) {
2113   OS << "#if defined(CLANG_ATTR_ARG_CONTEXT_LIST)\n";
2114   ParsedAttrMap Attrs = getParsedAttrList(Records);
2115   for (const auto &I : Attrs) {
2116     const Record &Attr = *I.second;
2117 
2118     if (!Attr.getValueAsBit("ParseArgumentsAsUnevaluated"))
2119       continue;
2120 
2121     // All these spellings take are parsed unevaluated.
2122     forEachUniqueSpelling(Attr, [&](const FlattenedSpelling &S) {
2123       OS << ".Case(\"" << S.name() << "\", " << "true" << ")\n";
2124     });
2125   }
2126   OS << "#endif // CLANG_ATTR_ARG_CONTEXT_LIST\n\n";
2127 }
2128 
2129 static bool isIdentifierArgument(Record *Arg) {
2130   return !Arg->getSuperClasses().empty() &&
2131     llvm::StringSwitch<bool>(Arg->getSuperClasses().back().first->getName())
2132     .Case("IdentifierArgument", true)
2133     .Case("EnumArgument", true)
2134     .Case("VariadicEnumArgument", true)
2135     .Default(false);
2136 }
2137 
2138 static bool isVariadicIdentifierArgument(Record *Arg) {
2139   return !Arg->getSuperClasses().empty() &&
2140          llvm::StringSwitch<bool>(
2141              Arg->getSuperClasses().back().first->getName())
2142              .Case("VariadicIdentifierArgument", true)
2143              .Case("VariadicParamOrParamIdxArgument", true)
2144              .Default(false);
2145 }
2146 
2147 static void emitClangAttrVariadicIdentifierArgList(RecordKeeper &Records,
2148                                                    raw_ostream &OS) {
2149   OS << "#if defined(CLANG_ATTR_VARIADIC_IDENTIFIER_ARG_LIST)\n";
2150   std::vector<Record *> Attrs = Records.getAllDerivedDefinitions("Attr");
2151   for (const auto *A : Attrs) {
2152     // Determine whether the first argument is a variadic identifier.
2153     std::vector<Record *> Args = A->getValueAsListOfDefs("Args");
2154     if (Args.empty() || !isVariadicIdentifierArgument(Args[0]))
2155       continue;
2156 
2157     // All these spellings take an identifier argument.
2158     forEachUniqueSpelling(*A, [&](const FlattenedSpelling &S) {
2159       OS << ".Case(\"" << S.name() << "\", "
2160          << "true"
2161          << ")\n";
2162     });
2163   }
2164   OS << "#endif // CLANG_ATTR_VARIADIC_IDENTIFIER_ARG_LIST\n\n";
2165 }
2166 
2167 // Emits the first-argument-is-identifier property for attributes.
2168 static void emitClangAttrIdentifierArgList(RecordKeeper &Records, raw_ostream &OS) {
2169   OS << "#if defined(CLANG_ATTR_IDENTIFIER_ARG_LIST)\n";
2170   std::vector<Record*> Attrs = Records.getAllDerivedDefinitions("Attr");
2171 
2172   for (const auto *Attr : Attrs) {
2173     // Determine whether the first argument is an identifier.
2174     std::vector<Record *> Args = Attr->getValueAsListOfDefs("Args");
2175     if (Args.empty() || !isIdentifierArgument(Args[0]))
2176       continue;
2177 
2178     // All these spellings take an identifier argument.
2179     forEachUniqueSpelling(*Attr, [&](const FlattenedSpelling &S) {
2180       OS << ".Case(\"" << S.name() << "\", " << "true" << ")\n";
2181     });
2182   }
2183   OS << "#endif // CLANG_ATTR_IDENTIFIER_ARG_LIST\n\n";
2184 }
2185 
2186 static bool keywordThisIsaIdentifierInArgument(const Record *Arg) {
2187   return !Arg->getSuperClasses().empty() &&
2188          llvm::StringSwitch<bool>(
2189              Arg->getSuperClasses().back().first->getName())
2190              .Case("VariadicParamOrParamIdxArgument", true)
2191              .Default(false);
2192 }
2193 
2194 static void emitClangAttrThisIsaIdentifierArgList(RecordKeeper &Records,
2195                                                   raw_ostream &OS) {
2196   OS << "#if defined(CLANG_ATTR_THIS_ISA_IDENTIFIER_ARG_LIST)\n";
2197   std::vector<Record *> Attrs = Records.getAllDerivedDefinitions("Attr");
2198   for (const auto *A : Attrs) {
2199     // Determine whether the first argument is a variadic identifier.
2200     std::vector<Record *> Args = A->getValueAsListOfDefs("Args");
2201     if (Args.empty() || !keywordThisIsaIdentifierInArgument(Args[0]))
2202       continue;
2203 
2204     // All these spellings take an identifier argument.
2205     forEachUniqueSpelling(*A, [&](const FlattenedSpelling &S) {
2206       OS << ".Case(\"" << S.name() << "\", "
2207          << "true"
2208          << ")\n";
2209     });
2210   }
2211   OS << "#endif // CLANG_ATTR_THIS_ISA_IDENTIFIER_ARG_LIST\n\n";
2212 }
2213 
2214 namespace clang {
2215 
2216 // Emits the class definitions for attributes.
2217 void EmitClangAttrClass(RecordKeeper &Records, raw_ostream &OS) {
2218   emitSourceFileHeader("Attribute classes' definitions", OS);
2219 
2220   OS << "#ifndef LLVM_CLANG_ATTR_CLASSES_INC\n";
2221   OS << "#define LLVM_CLANG_ATTR_CLASSES_INC\n\n";
2222 
2223   std::vector<Record*> Attrs = Records.getAllDerivedDefinitions("Attr");
2224 
2225   for (const auto *Attr : Attrs) {
2226     const Record &R = *Attr;
2227 
2228     // FIXME: Currently, documentation is generated as-needed due to the fact
2229     // that there is no way to allow a generated project "reach into" the docs
2230     // directory (for instance, it may be an out-of-tree build). However, we want
2231     // to ensure that every attribute has a Documentation field, and produce an
2232     // error if it has been neglected. Otherwise, the on-demand generation which
2233     // happens server-side will fail. This code is ensuring that functionality,
2234     // even though this Emitter doesn't technically need the documentation.
2235     // When attribute documentation can be generated as part of the build
2236     // itself, this code can be removed.
2237     (void)R.getValueAsListOfDefs("Documentation");
2238 
2239     if (!R.getValueAsBit("ASTNode"))
2240       continue;
2241 
2242     ArrayRef<std::pair<Record *, SMRange>> Supers = R.getSuperClasses();
2243     assert(!Supers.empty() && "Forgot to specify a superclass for the attr");
2244     std::string SuperName;
2245     bool Inheritable = false;
2246     for (const auto &Super : llvm::reverse(Supers)) {
2247       const Record *R = Super.first;
2248       if (R->getName() != "TargetSpecificAttr" &&
2249           R->getName() != "DeclOrTypeAttr" && SuperName.empty())
2250         SuperName = R->getName();
2251       if (R->getName() == "InheritableAttr")
2252         Inheritable = true;
2253     }
2254 
2255     OS << "class " << R.getName() << "Attr : public " << SuperName << " {\n";
2256 
2257     std::vector<Record*> ArgRecords = R.getValueAsListOfDefs("Args");
2258     std::vector<std::unique_ptr<Argument>> Args;
2259     Args.reserve(ArgRecords.size());
2260 
2261     bool HasOptArg = false;
2262     bool HasFakeArg = false;
2263     for (const auto *ArgRecord : ArgRecords) {
2264       Args.emplace_back(createArgument(*ArgRecord, R.getName()));
2265       Args.back()->writeDeclarations(OS);
2266       OS << "\n\n";
2267 
2268       // For these purposes, fake takes priority over optional.
2269       if (Args.back()->isFake()) {
2270         HasFakeArg = true;
2271       } else if (Args.back()->isOptional()) {
2272         HasOptArg = true;
2273       }
2274     }
2275 
2276     OS << "public:\n";
2277 
2278     std::vector<FlattenedSpelling> Spellings = GetFlattenedSpellings(R);
2279 
2280     // If there are zero or one spellings, all spelling-related functionality
2281     // can be elided. If all of the spellings share the same name, the spelling
2282     // functionality can also be elided.
2283     bool ElideSpelling = (Spellings.size() <= 1) ||
2284                          SpellingNamesAreCommon(Spellings);
2285 
2286     // This maps spelling index values to semantic Spelling enumerants.
2287     SemanticSpellingMap SemanticToSyntacticMap;
2288 
2289     if (!ElideSpelling)
2290       OS << CreateSemanticSpellings(Spellings, SemanticToSyntacticMap);
2291 
2292     // Emit CreateImplicit factory methods.
2293     auto emitCreateImplicit = [&](bool emitFake) {
2294       OS << "  static " << R.getName() << "Attr *CreateImplicit(";
2295       OS << "ASTContext &Ctx";
2296       if (!ElideSpelling)
2297         OS << ", Spelling S";
2298       for (auto const &ai : Args) {
2299         if (ai->isFake() && !emitFake) continue;
2300         OS << ", ";
2301         ai->writeCtorParameters(OS);
2302       }
2303       OS << ", SourceRange Loc = SourceRange()";
2304       OS << ") {\n";
2305       OS << "    auto *A = new (Ctx) " << R.getName();
2306       OS << "Attr(Loc, Ctx, ";
2307       for (auto const &ai : Args) {
2308         if (ai->isFake() && !emitFake) continue;
2309         ai->writeImplicitCtorArgs(OS);
2310         OS << ", ";
2311       }
2312       OS << (ElideSpelling ? "0" : "S") << ");\n";
2313       OS << "    A->setImplicit(true);\n";
2314       OS << "    return A;\n  }\n\n";
2315     };
2316 
2317     // Emit a CreateImplicit that takes all the arguments.
2318     emitCreateImplicit(true);
2319 
2320     // Emit a CreateImplicit that takes all the non-fake arguments.
2321     if (HasFakeArg) {
2322       emitCreateImplicit(false);
2323     }
2324 
2325     // Emit constructors.
2326     auto emitCtor = [&](bool emitOpt, bool emitFake) {
2327       auto shouldEmitArg = [=](const std::unique_ptr<Argument> &arg) {
2328         if (arg->isFake()) return emitFake;
2329         if (arg->isOptional()) return emitOpt;
2330         return true;
2331       };
2332 
2333       OS << "  " << R.getName() << "Attr(SourceRange R, ASTContext &Ctx\n";
2334       for (auto const &ai : Args) {
2335         if (!shouldEmitArg(ai)) continue;
2336         OS << "              , ";
2337         ai->writeCtorParameters(OS);
2338         OS << "\n";
2339       }
2340 
2341       OS << "              , ";
2342       OS << "unsigned SI\n";
2343 
2344       OS << "             )\n";
2345       OS << "    : " << SuperName << "(attr::" << R.getName() << ", R, SI, "
2346          << ( R.getValueAsBit("LateParsed") ? "true" : "false" );
2347       if (Inheritable) {
2348         OS << ", "
2349            << (R.getValueAsBit("InheritEvenIfAlreadyPresent") ? "true"
2350                                                               : "false");
2351       }
2352       OS << ")\n";
2353 
2354       for (auto const &ai : Args) {
2355         OS << "              , ";
2356         if (!shouldEmitArg(ai)) {
2357           ai->writeCtorDefaultInitializers(OS);
2358         } else {
2359           ai->writeCtorInitializers(OS);
2360         }
2361         OS << "\n";
2362       }
2363 
2364       OS << "  {\n";
2365 
2366       for (auto const &ai : Args) {
2367         if (!shouldEmitArg(ai)) continue;
2368         ai->writeCtorBody(OS);
2369       }
2370       OS << "  }\n\n";
2371     };
2372 
2373     // Emit a constructor that includes all the arguments.
2374     // This is necessary for cloning.
2375     emitCtor(true, true);
2376 
2377     // Emit a constructor that takes all the non-fake arguments.
2378     if (HasFakeArg) {
2379       emitCtor(true, false);
2380     }
2381 
2382     // Emit a constructor that takes all the non-fake, non-optional arguments.
2383     if (HasOptArg) {
2384       emitCtor(false, false);
2385     }
2386 
2387     OS << "  " << R.getName() << "Attr *clone(ASTContext &C) const;\n";
2388     OS << "  void printPretty(raw_ostream &OS,\n"
2389        << "                   const PrintingPolicy &Policy) const;\n";
2390     OS << "  const char *getSpelling() const;\n";
2391 
2392     if (!ElideSpelling) {
2393       assert(!SemanticToSyntacticMap.empty() && "Empty semantic mapping list");
2394       OS << "  Spelling getSemanticSpelling() const {\n";
2395       WriteSemanticSpellingSwitch("SpellingListIndex", SemanticToSyntacticMap,
2396                                   OS);
2397       OS << "  }\n";
2398     }
2399 
2400     writeAttrAccessorDefinition(R, OS);
2401 
2402     for (auto const &ai : Args) {
2403       ai->writeAccessors(OS);
2404       OS << "\n\n";
2405 
2406       // Don't write conversion routines for fake arguments.
2407       if (ai->isFake()) continue;
2408 
2409       if (ai->isEnumArg())
2410         static_cast<const EnumArgument *>(ai.get())->writeConversion(OS);
2411       else if (ai->isVariadicEnumArg())
2412         static_cast<const VariadicEnumArgument *>(ai.get())
2413             ->writeConversion(OS);
2414     }
2415 
2416     OS << R.getValueAsString("AdditionalMembers");
2417     OS << "\n\n";
2418 
2419     OS << "  static bool classof(const Attr *A) { return A->getKind() == "
2420        << "attr::" << R.getName() << "; }\n";
2421 
2422     OS << "};\n\n";
2423   }
2424 
2425   OS << "#endif // LLVM_CLANG_ATTR_CLASSES_INC\n";
2426 }
2427 
2428 // Emits the class method definitions for attributes.
2429 void EmitClangAttrImpl(RecordKeeper &Records, raw_ostream &OS) {
2430   emitSourceFileHeader("Attribute classes' member function definitions", OS);
2431 
2432   std::vector<Record*> Attrs = Records.getAllDerivedDefinitions("Attr");
2433 
2434   for (auto *Attr : Attrs) {
2435     Record &R = *Attr;
2436 
2437     if (!R.getValueAsBit("ASTNode"))
2438       continue;
2439 
2440     std::vector<Record*> ArgRecords = R.getValueAsListOfDefs("Args");
2441     std::vector<std::unique_ptr<Argument>> Args;
2442     for (const auto *Arg : ArgRecords)
2443       Args.emplace_back(createArgument(*Arg, R.getName()));
2444 
2445     for (auto const &ai : Args)
2446       ai->writeAccessorDefinitions(OS);
2447 
2448     OS << R.getName() << "Attr *" << R.getName()
2449        << "Attr::clone(ASTContext &C) const {\n";
2450     OS << "  auto *A = new (C) " << R.getName() << "Attr(getLocation(), C";
2451     for (auto const &ai : Args) {
2452       OS << ", ";
2453       ai->writeCloneArgs(OS);
2454     }
2455     OS << ", getSpellingListIndex());\n";
2456     OS << "  A->Inherited = Inherited;\n";
2457     OS << "  A->IsPackExpansion = IsPackExpansion;\n";
2458     OS << "  A->Implicit = Implicit;\n";
2459     OS << "  return A;\n}\n\n";
2460 
2461     writePrettyPrintFunction(R, Args, OS);
2462     writeGetSpellingFunction(R, OS);
2463   }
2464 
2465   // Instead of relying on virtual dispatch we just create a huge dispatch
2466   // switch. This is both smaller and faster than virtual functions.
2467   auto EmitFunc = [&](const char *Method) {
2468     OS << "  switch (getKind()) {\n";
2469     for (const auto *Attr : Attrs) {
2470       const Record &R = *Attr;
2471       if (!R.getValueAsBit("ASTNode"))
2472         continue;
2473 
2474       OS << "  case attr::" << R.getName() << ":\n";
2475       OS << "    return cast<" << R.getName() << "Attr>(this)->" << Method
2476          << ";\n";
2477     }
2478     OS << "  }\n";
2479     OS << "  llvm_unreachable(\"Unexpected attribute kind!\");\n";
2480     OS << "}\n\n";
2481   };
2482 
2483   OS << "const char *Attr::getSpelling() const {\n";
2484   EmitFunc("getSpelling()");
2485 
2486   OS << "Attr *Attr::clone(ASTContext &C) const {\n";
2487   EmitFunc("clone(C)");
2488 
2489   OS << "void Attr::printPretty(raw_ostream &OS, "
2490         "const PrintingPolicy &Policy) const {\n";
2491   EmitFunc("printPretty(OS, Policy)");
2492 }
2493 
2494 } // end namespace clang
2495 
2496 static void emitAttrList(raw_ostream &OS, StringRef Class,
2497                          const std::vector<Record*> &AttrList) {
2498   for (auto Cur : AttrList) {
2499     OS << Class << "(" << Cur->getName() << ")\n";
2500   }
2501 }
2502 
2503 // Determines if an attribute has a Pragma spelling.
2504 static bool AttrHasPragmaSpelling(const Record *R) {
2505   std::vector<FlattenedSpelling> Spellings = GetFlattenedSpellings(*R);
2506   return llvm::find_if(Spellings, [](const FlattenedSpelling &S) {
2507            return S.variety() == "Pragma";
2508          }) != Spellings.end();
2509 }
2510 
2511 namespace {
2512 
2513   struct AttrClassDescriptor {
2514     const char * const MacroName;
2515     const char * const TableGenName;
2516   };
2517 
2518 } // end anonymous namespace
2519 
2520 static const AttrClassDescriptor AttrClassDescriptors[] = {
2521   { "ATTR", "Attr" },
2522   { "TYPE_ATTR", "TypeAttr" },
2523   { "STMT_ATTR", "StmtAttr" },
2524   { "INHERITABLE_ATTR", "InheritableAttr" },
2525   { "DECL_OR_TYPE_ATTR", "DeclOrTypeAttr" },
2526   { "INHERITABLE_PARAM_ATTR", "InheritableParamAttr" },
2527   { "PARAMETER_ABI_ATTR", "ParameterABIAttr" }
2528 };
2529 
2530 static void emitDefaultDefine(raw_ostream &OS, StringRef name,
2531                               const char *superName) {
2532   OS << "#ifndef " << name << "\n";
2533   OS << "#define " << name << "(NAME) ";
2534   if (superName) OS << superName << "(NAME)";
2535   OS << "\n#endif\n\n";
2536 }
2537 
2538 namespace {
2539 
2540   /// A class of attributes.
2541   struct AttrClass {
2542     const AttrClassDescriptor &Descriptor;
2543     Record *TheRecord;
2544     AttrClass *SuperClass = nullptr;
2545     std::vector<AttrClass*> SubClasses;
2546     std::vector<Record*> Attrs;
2547 
2548     AttrClass(const AttrClassDescriptor &Descriptor, Record *R)
2549       : Descriptor(Descriptor), TheRecord(R) {}
2550 
2551     void emitDefaultDefines(raw_ostream &OS) const {
2552       // Default the macro unless this is a root class (i.e. Attr).
2553       if (SuperClass) {
2554         emitDefaultDefine(OS, Descriptor.MacroName,
2555                           SuperClass->Descriptor.MacroName);
2556       }
2557     }
2558 
2559     void emitUndefs(raw_ostream &OS) const {
2560       OS << "#undef " << Descriptor.MacroName << "\n";
2561     }
2562 
2563     void emitAttrList(raw_ostream &OS) const {
2564       for (auto SubClass : SubClasses) {
2565         SubClass->emitAttrList(OS);
2566       }
2567 
2568       ::emitAttrList(OS, Descriptor.MacroName, Attrs);
2569     }
2570 
2571     void classifyAttrOnRoot(Record *Attr) {
2572       bool result = classifyAttr(Attr);
2573       assert(result && "failed to classify on root"); (void) result;
2574     }
2575 
2576     void emitAttrRange(raw_ostream &OS) const {
2577       OS << "ATTR_RANGE(" << Descriptor.TableGenName
2578          << ", " << getFirstAttr()->getName()
2579          << ", " << getLastAttr()->getName() << ")\n";
2580     }
2581 
2582   private:
2583     bool classifyAttr(Record *Attr) {
2584       // Check all the subclasses.
2585       for (auto SubClass : SubClasses) {
2586         if (SubClass->classifyAttr(Attr))
2587           return true;
2588       }
2589 
2590       // It's not more specific than this class, but it might still belong here.
2591       if (Attr->isSubClassOf(TheRecord)) {
2592         Attrs.push_back(Attr);
2593         return true;
2594       }
2595 
2596       return false;
2597     }
2598 
2599     Record *getFirstAttr() const {
2600       if (!SubClasses.empty())
2601         return SubClasses.front()->getFirstAttr();
2602       return Attrs.front();
2603     }
2604 
2605     Record *getLastAttr() const {
2606       if (!Attrs.empty())
2607         return Attrs.back();
2608       return SubClasses.back()->getLastAttr();
2609     }
2610   };
2611 
2612   /// The entire hierarchy of attribute classes.
2613   class AttrClassHierarchy {
2614     std::vector<std::unique_ptr<AttrClass>> Classes;
2615 
2616   public:
2617     AttrClassHierarchy(RecordKeeper &Records) {
2618       // Find records for all the classes.
2619       for (auto &Descriptor : AttrClassDescriptors) {
2620         Record *ClassRecord = Records.getClass(Descriptor.TableGenName);
2621         AttrClass *Class = new AttrClass(Descriptor, ClassRecord);
2622         Classes.emplace_back(Class);
2623       }
2624 
2625       // Link up the hierarchy.
2626       for (auto &Class : Classes) {
2627         if (AttrClass *SuperClass = findSuperClass(Class->TheRecord)) {
2628           Class->SuperClass = SuperClass;
2629           SuperClass->SubClasses.push_back(Class.get());
2630         }
2631       }
2632 
2633 #ifndef NDEBUG
2634       for (auto i = Classes.begin(), e = Classes.end(); i != e; ++i) {
2635         assert((i == Classes.begin()) == ((*i)->SuperClass == nullptr) &&
2636                "only the first class should be a root class!");
2637       }
2638 #endif
2639     }
2640 
2641     void emitDefaultDefines(raw_ostream &OS) const {
2642       for (auto &Class : Classes) {
2643         Class->emitDefaultDefines(OS);
2644       }
2645     }
2646 
2647     void emitUndefs(raw_ostream &OS) const {
2648       for (auto &Class : Classes) {
2649         Class->emitUndefs(OS);
2650       }
2651     }
2652 
2653     void emitAttrLists(raw_ostream &OS) const {
2654       // Just start from the root class.
2655       Classes[0]->emitAttrList(OS);
2656     }
2657 
2658     void emitAttrRanges(raw_ostream &OS) const {
2659       for (auto &Class : Classes)
2660         Class->emitAttrRange(OS);
2661     }
2662 
2663     void classifyAttr(Record *Attr) {
2664       // Add the attribute to the root class.
2665       Classes[0]->classifyAttrOnRoot(Attr);
2666     }
2667 
2668   private:
2669     AttrClass *findClassByRecord(Record *R) const {
2670       for (auto &Class : Classes) {
2671         if (Class->TheRecord == R)
2672           return Class.get();
2673       }
2674       return nullptr;
2675     }
2676 
2677     AttrClass *findSuperClass(Record *R) const {
2678       // TableGen flattens the superclass list, so we just need to walk it
2679       // in reverse.
2680       auto SuperClasses = R->getSuperClasses();
2681       for (signed i = 0, e = SuperClasses.size(); i != e; ++i) {
2682         auto SuperClass = findClassByRecord(SuperClasses[e - i - 1].first);
2683         if (SuperClass) return SuperClass;
2684       }
2685       return nullptr;
2686     }
2687   };
2688 
2689 } // end anonymous namespace
2690 
2691 namespace clang {
2692 
2693 // Emits the enumeration list for attributes.
2694 void EmitClangAttrList(RecordKeeper &Records, raw_ostream &OS) {
2695   emitSourceFileHeader("List of all attributes that Clang recognizes", OS);
2696 
2697   AttrClassHierarchy Hierarchy(Records);
2698 
2699   // Add defaulting macro definitions.
2700   Hierarchy.emitDefaultDefines(OS);
2701   emitDefaultDefine(OS, "PRAGMA_SPELLING_ATTR", nullptr);
2702 
2703   std::vector<Record *> Attrs = Records.getAllDerivedDefinitions("Attr");
2704   std::vector<Record *> PragmaAttrs;
2705   for (auto *Attr : Attrs) {
2706     if (!Attr->getValueAsBit("ASTNode"))
2707       continue;
2708 
2709     // Add the attribute to the ad-hoc groups.
2710     if (AttrHasPragmaSpelling(Attr))
2711       PragmaAttrs.push_back(Attr);
2712 
2713     // Place it in the hierarchy.
2714     Hierarchy.classifyAttr(Attr);
2715   }
2716 
2717   // Emit the main attribute list.
2718   Hierarchy.emitAttrLists(OS);
2719 
2720   // Emit the ad hoc groups.
2721   emitAttrList(OS, "PRAGMA_SPELLING_ATTR", PragmaAttrs);
2722 
2723   // Emit the attribute ranges.
2724   OS << "#ifdef ATTR_RANGE\n";
2725   Hierarchy.emitAttrRanges(OS);
2726   OS << "#undef ATTR_RANGE\n";
2727   OS << "#endif\n";
2728 
2729   Hierarchy.emitUndefs(OS);
2730   OS << "#undef PRAGMA_SPELLING_ATTR\n";
2731 }
2732 
2733 // Emits the enumeration list for attributes.
2734 void EmitClangAttrSubjectMatchRuleList(RecordKeeper &Records, raw_ostream &OS) {
2735   emitSourceFileHeader(
2736       "List of all attribute subject matching rules that Clang recognizes", OS);
2737   PragmaClangAttributeSupport &PragmaAttributeSupport =
2738       getPragmaAttributeSupport(Records);
2739   emitDefaultDefine(OS, "ATTR_MATCH_RULE", nullptr);
2740   PragmaAttributeSupport.emitMatchRuleList(OS);
2741   OS << "#undef ATTR_MATCH_RULE\n";
2742 }
2743 
2744 // Emits the code to read an attribute from a precompiled header.
2745 void EmitClangAttrPCHRead(RecordKeeper &Records, raw_ostream &OS) {
2746   emitSourceFileHeader("Attribute deserialization code", OS);
2747 
2748   Record *InhClass = Records.getClass("InheritableAttr");
2749   std::vector<Record*> Attrs = Records.getAllDerivedDefinitions("Attr"),
2750                        ArgRecords;
2751   std::vector<std::unique_ptr<Argument>> Args;
2752 
2753   OS << "  switch (Kind) {\n";
2754   for (const auto *Attr : Attrs) {
2755     const Record &R = *Attr;
2756     if (!R.getValueAsBit("ASTNode"))
2757       continue;
2758 
2759     OS << "  case attr::" << R.getName() << ": {\n";
2760     if (R.isSubClassOf(InhClass))
2761       OS << "    bool isInherited = Record.readInt();\n";
2762     OS << "    bool isImplicit = Record.readInt();\n";
2763     OS << "    unsigned Spelling = Record.readInt();\n";
2764     ArgRecords = R.getValueAsListOfDefs("Args");
2765     Args.clear();
2766     for (const auto *Arg : ArgRecords) {
2767       Args.emplace_back(createArgument(*Arg, R.getName()));
2768       Args.back()->writePCHReadDecls(OS);
2769     }
2770     OS << "    New = new (Context) " << R.getName() << "Attr(Range, Context";
2771     for (auto const &ri : Args) {
2772       OS << ", ";
2773       ri->writePCHReadArgs(OS);
2774     }
2775     OS << ", Spelling);\n";
2776     if (R.isSubClassOf(InhClass))
2777       OS << "    cast<InheritableAttr>(New)->setInherited(isInherited);\n";
2778     OS << "    New->setImplicit(isImplicit);\n";
2779     OS << "    break;\n";
2780     OS << "  }\n";
2781   }
2782   OS << "  }\n";
2783 }
2784 
2785 // Emits the code to write an attribute to a precompiled header.
2786 void EmitClangAttrPCHWrite(RecordKeeper &Records, raw_ostream &OS) {
2787   emitSourceFileHeader("Attribute serialization code", OS);
2788 
2789   Record *InhClass = Records.getClass("InheritableAttr");
2790   std::vector<Record*> Attrs = Records.getAllDerivedDefinitions("Attr"), Args;
2791 
2792   OS << "  switch (A->getKind()) {\n";
2793   for (const auto *Attr : Attrs) {
2794     const Record &R = *Attr;
2795     if (!R.getValueAsBit("ASTNode"))
2796       continue;
2797     OS << "  case attr::" << R.getName() << ": {\n";
2798     Args = R.getValueAsListOfDefs("Args");
2799     if (R.isSubClassOf(InhClass) || !Args.empty())
2800       OS << "    const auto *SA = cast<" << R.getName()
2801          << "Attr>(A);\n";
2802     if (R.isSubClassOf(InhClass))
2803       OS << "    Record.push_back(SA->isInherited());\n";
2804     OS << "    Record.push_back(A->isImplicit());\n";
2805     OS << "    Record.push_back(A->getSpellingListIndex());\n";
2806 
2807     for (const auto *Arg : Args)
2808       createArgument(*Arg, R.getName())->writePCHWrite(OS);
2809     OS << "    break;\n";
2810     OS << "  }\n";
2811   }
2812   OS << "  }\n";
2813 }
2814 
2815 // Helper function for GenerateTargetSpecificAttrChecks that alters the 'Test'
2816 // parameter with only a single check type, if applicable.
2817 static bool GenerateTargetSpecificAttrCheck(const Record *R, std::string &Test,
2818                                             std::string *FnName,
2819                                             StringRef ListName,
2820                                             StringRef CheckAgainst,
2821                                             StringRef Scope) {
2822   if (!R->isValueUnset(ListName)) {
2823     Test += " && (";
2824     std::vector<StringRef> Items = R->getValueAsListOfStrings(ListName);
2825     for (auto I = Items.begin(), E = Items.end(); I != E; ++I) {
2826       StringRef Part = *I;
2827       Test += CheckAgainst;
2828       Test += " == ";
2829       Test += Scope;
2830       Test += Part;
2831       if (I + 1 != E)
2832         Test += " || ";
2833       if (FnName)
2834         *FnName += Part;
2835     }
2836     Test += ")";
2837     return true;
2838   }
2839   return false;
2840 }
2841 
2842 // Generate a conditional expression to check if the current target satisfies
2843 // the conditions for a TargetSpecificAttr record, and append the code for
2844 // those checks to the Test string. If the FnName string pointer is non-null,
2845 // append a unique suffix to distinguish this set of target checks from other
2846 // TargetSpecificAttr records.
2847 static bool GenerateTargetSpecificAttrChecks(const Record *R,
2848                                              std::vector<StringRef> &Arches,
2849                                              std::string &Test,
2850                                              std::string *FnName) {
2851   bool AnyTargetChecks = false;
2852 
2853   // It is assumed that there will be an llvm::Triple object
2854   // named "T" and a TargetInfo object named "Target" within
2855   // scope that can be used to determine whether the attribute exists in
2856   // a given target.
2857   Test += "true";
2858   // If one or more architectures is specified, check those.  Arches are handled
2859   // differently because GenerateTargetRequirements needs to combine the list
2860   // with ParseKind.
2861   if (!Arches.empty()) {
2862     AnyTargetChecks = true;
2863     Test += " && (";
2864     for (auto I = Arches.begin(), E = Arches.end(); I != E; ++I) {
2865       StringRef Part = *I;
2866       Test += "T.getArch() == llvm::Triple::";
2867       Test += Part;
2868       if (I + 1 != E)
2869         Test += " || ";
2870       if (FnName)
2871         *FnName += Part;
2872     }
2873     Test += ")";
2874   }
2875 
2876   // If the attribute is specific to particular OSes, check those.
2877   AnyTargetChecks |= GenerateTargetSpecificAttrCheck(
2878       R, Test, FnName, "OSes", "T.getOS()", "llvm::Triple::");
2879 
2880   // If one or more object formats is specified, check those.
2881   AnyTargetChecks |=
2882       GenerateTargetSpecificAttrCheck(R, Test, FnName, "ObjectFormats",
2883                                       "T.getObjectFormat()", "llvm::Triple::");
2884 
2885   // If custom code is specified, emit it.
2886   StringRef Code = R->getValueAsString("CustomCode");
2887   if (!Code.empty()) {
2888     AnyTargetChecks = true;
2889     Test += " && (";
2890     Test += Code;
2891     Test += ")";
2892   }
2893 
2894   return AnyTargetChecks;
2895 }
2896 
2897 static void GenerateHasAttrSpellingStringSwitch(
2898     const std::vector<Record *> &Attrs, raw_ostream &OS,
2899     const std::string &Variety = "", const std::string &Scope = "") {
2900   for (const auto *Attr : Attrs) {
2901     // C++11-style attributes have specific version information associated with
2902     // them. If the attribute has no scope, the version information must not
2903     // have the default value (1), as that's incorrect. Instead, the unscoped
2904     // attribute version information should be taken from the SD-6 standing
2905     // document, which can be found at:
2906     // https://isocpp.org/std/standing-documents/sd-6-sg10-feature-test-recommendations
2907     int Version = 1;
2908 
2909     if (Variety == "CXX11") {
2910         std::vector<Record *> Spellings = Attr->getValueAsListOfDefs("Spellings");
2911         for (const auto &Spelling : Spellings) {
2912           if (Spelling->getValueAsString("Variety") == "CXX11") {
2913             Version = static_cast<int>(Spelling->getValueAsInt("Version"));
2914             if (Scope.empty() && Version == 1)
2915               PrintError(Spelling->getLoc(), "C++ standard attributes must "
2916               "have valid version information.");
2917             break;
2918           }
2919       }
2920     }
2921 
2922     std::string Test;
2923     if (Attr->isSubClassOf("TargetSpecificAttr")) {
2924       const Record *R = Attr->getValueAsDef("Target");
2925       std::vector<StringRef> Arches = R->getValueAsListOfStrings("Arches");
2926       GenerateTargetSpecificAttrChecks(R, Arches, Test, nullptr);
2927 
2928       // If this is the C++11 variety, also add in the LangOpts test.
2929       if (Variety == "CXX11")
2930         Test += " && LangOpts.CPlusPlus11";
2931       else if (Variety == "C2x")
2932         Test += " && LangOpts.DoubleSquareBracketAttributes";
2933     } else if (Variety == "CXX11")
2934       // C++11 mode should be checked against LangOpts, which is presumed to be
2935       // present in the caller.
2936       Test = "LangOpts.CPlusPlus11";
2937     else if (Variety == "C2x")
2938       Test = "LangOpts.DoubleSquareBracketAttributes";
2939 
2940     std::string TestStr =
2941         !Test.empty() ? Test + " ? " + llvm::itostr(Version) + " : 0" : "1";
2942     std::vector<FlattenedSpelling> Spellings = GetFlattenedSpellings(*Attr);
2943     for (const auto &S : Spellings)
2944       if (Variety.empty() || (Variety == S.variety() &&
2945                               (Scope.empty() || Scope == S.nameSpace())))
2946         OS << "    .Case(\"" << S.name() << "\", " << TestStr << ")\n";
2947   }
2948   OS << "    .Default(0);\n";
2949 }
2950 
2951 // Emits the list of spellings for attributes.
2952 void EmitClangAttrHasAttrImpl(RecordKeeper &Records, raw_ostream &OS) {
2953   emitSourceFileHeader("Code to implement the __has_attribute logic", OS);
2954 
2955   // Separate all of the attributes out into four group: generic, C++11, GNU,
2956   // and declspecs. Then generate a big switch statement for each of them.
2957   std::vector<Record *> Attrs = Records.getAllDerivedDefinitions("Attr");
2958   std::vector<Record *> Declspec, Microsoft, GNU, Pragma;
2959   std::map<std::string, std::vector<Record *>> CXX, C2x;
2960 
2961   // Walk over the list of all attributes, and split them out based on the
2962   // spelling variety.
2963   for (auto *R : Attrs) {
2964     std::vector<FlattenedSpelling> Spellings = GetFlattenedSpellings(*R);
2965     for (const auto &SI : Spellings) {
2966       const std::string &Variety = SI.variety();
2967       if (Variety == "GNU")
2968         GNU.push_back(R);
2969       else if (Variety == "Declspec")
2970         Declspec.push_back(R);
2971       else if (Variety == "Microsoft")
2972         Microsoft.push_back(R);
2973       else if (Variety == "CXX11")
2974         CXX[SI.nameSpace()].push_back(R);
2975       else if (Variety == "C2x")
2976         C2x[SI.nameSpace()].push_back(R);
2977       else if (Variety == "Pragma")
2978         Pragma.push_back(R);
2979     }
2980   }
2981 
2982   OS << "const llvm::Triple &T = Target.getTriple();\n";
2983   OS << "switch (Syntax) {\n";
2984   OS << "case AttrSyntax::GNU:\n";
2985   OS << "  return llvm::StringSwitch<int>(Name)\n";
2986   GenerateHasAttrSpellingStringSwitch(GNU, OS, "GNU");
2987   OS << "case AttrSyntax::Declspec:\n";
2988   OS << "  return llvm::StringSwitch<int>(Name)\n";
2989   GenerateHasAttrSpellingStringSwitch(Declspec, OS, "Declspec");
2990   OS << "case AttrSyntax::Microsoft:\n";
2991   OS << "  return llvm::StringSwitch<int>(Name)\n";
2992   GenerateHasAttrSpellingStringSwitch(Microsoft, OS, "Microsoft");
2993   OS << "case AttrSyntax::Pragma:\n";
2994   OS << "  return llvm::StringSwitch<int>(Name)\n";
2995   GenerateHasAttrSpellingStringSwitch(Pragma, OS, "Pragma");
2996   auto fn = [&OS](const char *Spelling, const char *Variety,
2997                   const std::map<std::string, std::vector<Record *>> &List) {
2998     OS << "case AttrSyntax::" << Variety << ": {\n";
2999     // C++11-style attributes are further split out based on the Scope.
3000     for (auto I = List.cbegin(), E = List.cend(); I != E; ++I) {
3001       if (I != List.cbegin())
3002         OS << " else ";
3003       if (I->first.empty())
3004         OS << "if (ScopeName == \"\") {\n";
3005       else
3006         OS << "if (ScopeName == \"" << I->first << "\") {\n";
3007       OS << "  return llvm::StringSwitch<int>(Name)\n";
3008       GenerateHasAttrSpellingStringSwitch(I->second, OS, Spelling, I->first);
3009       OS << "}";
3010     }
3011     OS << "\n} break;\n";
3012   };
3013   fn("CXX11", "CXX", CXX);
3014   fn("C2x", "C", C2x);
3015   OS << "}\n";
3016 }
3017 
3018 void EmitClangAttrSpellingListIndex(RecordKeeper &Records, raw_ostream &OS) {
3019   emitSourceFileHeader("Code to translate different attribute spellings "
3020                        "into internal identifiers", OS);
3021 
3022   OS << "  switch (AttrKind) {\n";
3023 
3024   ParsedAttrMap Attrs = getParsedAttrList(Records);
3025   for (const auto &I : Attrs) {
3026     const Record &R = *I.second;
3027     std::vector<FlattenedSpelling> Spellings = GetFlattenedSpellings(R);
3028     OS << "  case AT_" << I.first << ": {\n";
3029     for (unsigned I = 0; I < Spellings.size(); ++ I) {
3030       OS << "    if (Name == \"" << Spellings[I].name() << "\" && "
3031          << "SyntaxUsed == "
3032          << StringSwitch<unsigned>(Spellings[I].variety())
3033                 .Case("GNU", 0)
3034                 .Case("CXX11", 1)
3035                 .Case("C2x", 2)
3036                 .Case("Declspec", 3)
3037                 .Case("Microsoft", 4)
3038                 .Case("Keyword", 5)
3039                 .Case("Pragma", 6)
3040                 .Default(0)
3041          << " && Scope == \"" << Spellings[I].nameSpace() << "\")\n"
3042          << "        return " << I << ";\n";
3043     }
3044 
3045     OS << "    break;\n";
3046     OS << "  }\n";
3047   }
3048 
3049   OS << "  }\n";
3050   OS << "  return 0;\n";
3051 }
3052 
3053 // Emits code used by RecursiveASTVisitor to visit attributes
3054 void EmitClangAttrASTVisitor(RecordKeeper &Records, raw_ostream &OS) {
3055   emitSourceFileHeader("Used by RecursiveASTVisitor to visit attributes.", OS);
3056 
3057   std::vector<Record*> Attrs = Records.getAllDerivedDefinitions("Attr");
3058 
3059   // Write method declarations for Traverse* methods.
3060   // We emit this here because we only generate methods for attributes that
3061   // are declared as ASTNodes.
3062   OS << "#ifdef ATTR_VISITOR_DECLS_ONLY\n\n";
3063   for (const auto *Attr : Attrs) {
3064     const Record &R = *Attr;
3065     if (!R.getValueAsBit("ASTNode"))
3066       continue;
3067     OS << "  bool Traverse"
3068        << R.getName() << "Attr(" << R.getName() << "Attr *A);\n";
3069     OS << "  bool Visit"
3070        << R.getName() << "Attr(" << R.getName() << "Attr *A) {\n"
3071        << "    return true; \n"
3072        << "  }\n";
3073   }
3074   OS << "\n#else // ATTR_VISITOR_DECLS_ONLY\n\n";
3075 
3076   // Write individual Traverse* methods for each attribute class.
3077   for (const auto *Attr : Attrs) {
3078     const Record &R = *Attr;
3079     if (!R.getValueAsBit("ASTNode"))
3080       continue;
3081 
3082     OS << "template <typename Derived>\n"
3083        << "bool VISITORCLASS<Derived>::Traverse"
3084        << R.getName() << "Attr(" << R.getName() << "Attr *A) {\n"
3085        << "  if (!getDerived().VisitAttr(A))\n"
3086        << "    return false;\n"
3087        << "  if (!getDerived().Visit" << R.getName() << "Attr(A))\n"
3088        << "    return false;\n";
3089 
3090     std::vector<Record*> ArgRecords = R.getValueAsListOfDefs("Args");
3091     for (const auto *Arg : ArgRecords)
3092       createArgument(*Arg, R.getName())->writeASTVisitorTraversal(OS);
3093 
3094     OS << "  return true;\n";
3095     OS << "}\n\n";
3096   }
3097 
3098   // Write generic Traverse routine
3099   OS << "template <typename Derived>\n"
3100      << "bool VISITORCLASS<Derived>::TraverseAttr(Attr *A) {\n"
3101      << "  if (!A)\n"
3102      << "    return true;\n"
3103      << "\n"
3104      << "  switch (A->getKind()) {\n";
3105 
3106   for (const auto *Attr : Attrs) {
3107     const Record &R = *Attr;
3108     if (!R.getValueAsBit("ASTNode"))
3109       continue;
3110 
3111     OS << "    case attr::" << R.getName() << ":\n"
3112        << "      return getDerived().Traverse" << R.getName() << "Attr("
3113        << "cast<" << R.getName() << "Attr>(A));\n";
3114   }
3115   OS << "  }\n";  // end switch
3116   OS << "  llvm_unreachable(\"bad attribute kind\");\n";
3117   OS << "}\n";  // end function
3118   OS << "#endif  // ATTR_VISITOR_DECLS_ONLY\n";
3119 }
3120 
3121 void EmitClangAttrTemplateInstantiateHelper(const std::vector<Record *> &Attrs,
3122                                             raw_ostream &OS,
3123                                             bool AppliesToDecl) {
3124 
3125   OS << "  switch (At->getKind()) {\n";
3126   for (const auto *Attr : Attrs) {
3127     const Record &R = *Attr;
3128     if (!R.getValueAsBit("ASTNode"))
3129       continue;
3130     OS << "    case attr::" << R.getName() << ": {\n";
3131     bool ShouldClone = R.getValueAsBit("Clone") &&
3132                        (!AppliesToDecl ||
3133                         R.getValueAsBit("MeaningfulToClassTemplateDefinition"));
3134 
3135     if (!ShouldClone) {
3136       OS << "      return nullptr;\n";
3137       OS << "    }\n";
3138       continue;
3139     }
3140 
3141     OS << "      const auto *A = cast<"
3142        << R.getName() << "Attr>(At);\n";
3143     bool TDependent = R.getValueAsBit("TemplateDependent");
3144 
3145     if (!TDependent) {
3146       OS << "      return A->clone(C);\n";
3147       OS << "    }\n";
3148       continue;
3149     }
3150 
3151     std::vector<Record*> ArgRecords = R.getValueAsListOfDefs("Args");
3152     std::vector<std::unique_ptr<Argument>> Args;
3153     Args.reserve(ArgRecords.size());
3154 
3155     for (const auto *ArgRecord : ArgRecords)
3156       Args.emplace_back(createArgument(*ArgRecord, R.getName()));
3157 
3158     for (auto const &ai : Args)
3159       ai->writeTemplateInstantiation(OS);
3160 
3161     OS << "      return new (C) " << R.getName() << "Attr(A->getLocation(), C";
3162     for (auto const &ai : Args) {
3163       OS << ", ";
3164       ai->writeTemplateInstantiationArgs(OS);
3165     }
3166     OS << ", A->getSpellingListIndex());\n    }\n";
3167   }
3168   OS << "  } // end switch\n"
3169      << "  llvm_unreachable(\"Unknown attribute!\");\n"
3170      << "  return nullptr;\n";
3171 }
3172 
3173 // Emits code to instantiate dependent attributes on templates.
3174 void EmitClangAttrTemplateInstantiate(RecordKeeper &Records, raw_ostream &OS) {
3175   emitSourceFileHeader("Template instantiation code for attributes", OS);
3176 
3177   std::vector<Record*> Attrs = Records.getAllDerivedDefinitions("Attr");
3178 
3179   OS << "namespace clang {\n"
3180      << "namespace sema {\n\n"
3181      << "Attr *instantiateTemplateAttribute(const Attr *At, ASTContext &C, "
3182      << "Sema &S,\n"
3183      << "        const MultiLevelTemplateArgumentList &TemplateArgs) {\n";
3184   EmitClangAttrTemplateInstantiateHelper(Attrs, OS, /*AppliesToDecl*/false);
3185   OS << "}\n\n"
3186      << "Attr *instantiateTemplateAttributeForDecl(const Attr *At,\n"
3187      << " ASTContext &C, Sema &S,\n"
3188      << "        const MultiLevelTemplateArgumentList &TemplateArgs) {\n";
3189   EmitClangAttrTemplateInstantiateHelper(Attrs, OS, /*AppliesToDecl*/true);
3190   OS << "}\n\n"
3191      << "} // end namespace sema\n"
3192      << "} // end namespace clang\n";
3193 }
3194 
3195 // Emits the list of parsed attributes.
3196 void EmitClangAttrParsedAttrList(RecordKeeper &Records, raw_ostream &OS) {
3197   emitSourceFileHeader("List of all attributes that Clang recognizes", OS);
3198 
3199   OS << "#ifndef PARSED_ATTR\n";
3200   OS << "#define PARSED_ATTR(NAME) NAME\n";
3201   OS << "#endif\n\n";
3202 
3203   ParsedAttrMap Names = getParsedAttrList(Records);
3204   for (const auto &I : Names) {
3205     OS << "PARSED_ATTR(" << I.first << ")\n";
3206   }
3207 }
3208 
3209 static bool isArgVariadic(const Record &R, StringRef AttrName) {
3210   return createArgument(R, AttrName)->isVariadic();
3211 }
3212 
3213 static void emitArgInfo(const Record &R, raw_ostream &OS) {
3214   // This function will count the number of arguments specified for the
3215   // attribute and emit the number of required arguments followed by the
3216   // number of optional arguments.
3217   std::vector<Record *> Args = R.getValueAsListOfDefs("Args");
3218   unsigned ArgCount = 0, OptCount = 0;
3219   bool HasVariadic = false;
3220   for (const auto *Arg : Args) {
3221     // If the arg is fake, it's the user's job to supply it: general parsing
3222     // logic shouldn't need to know anything about it.
3223     if (Arg->getValueAsBit("Fake"))
3224       continue;
3225     Arg->getValueAsBit("Optional") ? ++OptCount : ++ArgCount;
3226     if (!HasVariadic && isArgVariadic(*Arg, R.getName()))
3227       HasVariadic = true;
3228   }
3229 
3230   // If there is a variadic argument, we will set the optional argument count
3231   // to its largest value. Since it's currently a 4-bit number, we set it to 15.
3232   OS << ArgCount << ", " << (HasVariadic ? 15 : OptCount);
3233 }
3234 
3235 static void GenerateDefaultAppertainsTo(raw_ostream &OS) {
3236   OS << "static bool defaultAppertainsTo(Sema &, const ParsedAttr &,";
3237   OS << "const Decl *) {\n";
3238   OS << "  return true;\n";
3239   OS << "}\n\n";
3240 }
3241 
3242 static std::string GetDiagnosticSpelling(const Record &R) {
3243   std::string Ret = R.getValueAsString("DiagSpelling");
3244   if (!Ret.empty())
3245     return Ret;
3246 
3247   // If we couldn't find the DiagSpelling in this object, we can check to see
3248   // if the object is one that has a base, and if it is, loop up to the Base
3249   // member recursively.
3250   std::string Super = R.getSuperClasses().back().first->getName();
3251   if (Super == "DDecl" || Super == "DStmt")
3252     return GetDiagnosticSpelling(*R.getValueAsDef("Base"));
3253 
3254   return "";
3255 }
3256 
3257 static std::string CalculateDiagnostic(const Record &S) {
3258   // If the SubjectList object has a custom diagnostic associated with it,
3259   // return that directly.
3260   const StringRef CustomDiag = S.getValueAsString("CustomDiag");
3261   if (!CustomDiag.empty())
3262     return ("\"" + Twine(CustomDiag) + "\"").str();
3263 
3264   std::vector<std::string> DiagList;
3265   std::vector<Record *> Subjects = S.getValueAsListOfDefs("Subjects");
3266   for (const auto *Subject : Subjects) {
3267     const Record &R = *Subject;
3268     // Get the diagnostic text from the Decl or Stmt node given.
3269     std::string V = GetDiagnosticSpelling(R);
3270     if (V.empty()) {
3271       PrintError(R.getLoc(),
3272                  "Could not determine diagnostic spelling for the node: " +
3273                      R.getName() + "; please add one to DeclNodes.td");
3274     } else {
3275       // The node may contain a list of elements itself, so split the elements
3276       // by a comma, and trim any whitespace.
3277       SmallVector<StringRef, 2> Frags;
3278       llvm::SplitString(V, Frags, ",");
3279       for (auto Str : Frags) {
3280         DiagList.push_back(Str.trim());
3281       }
3282     }
3283   }
3284 
3285   if (DiagList.empty()) {
3286     PrintFatalError(S.getLoc(),
3287                     "Could not deduce diagnostic argument for Attr subjects");
3288     return "";
3289   }
3290 
3291   // FIXME: this is not particularly good for localization purposes and ideally
3292   // should be part of the diagnostics engine itself with some sort of list
3293   // specifier.
3294 
3295   // A single member of the list can be returned directly.
3296   if (DiagList.size() == 1)
3297     return '"' + DiagList.front() + '"';
3298 
3299   if (DiagList.size() == 2)
3300     return '"' + DiagList[0] + " and " + DiagList[1] + '"';
3301 
3302   // If there are more than two in the list, we serialize the first N - 1
3303   // elements with a comma. This leaves the string in the state: foo, bar,
3304   // baz (but misses quux). We can then add ", and " for the last element
3305   // manually.
3306   std::string Diag = llvm::join(DiagList.begin(), DiagList.end() - 1, ", ");
3307   return '"' + Diag + ", and " + *(DiagList.end() - 1) + '"';
3308 }
3309 
3310 static std::string GetSubjectWithSuffix(const Record *R) {
3311   const std::string &B = R->getName();
3312   if (B == "DeclBase")
3313     return "Decl";
3314   return B + "Decl";
3315 }
3316 
3317 static std::string functionNameForCustomAppertainsTo(const Record &Subject) {
3318   return "is" + Subject.getName().str();
3319 }
3320 
3321 static std::string GenerateCustomAppertainsTo(const Record &Subject,
3322                                               raw_ostream &OS) {
3323   std::string FnName = functionNameForCustomAppertainsTo(Subject);
3324 
3325   // If this code has already been generated, simply return the previous
3326   // instance of it.
3327   static std::set<std::string> CustomSubjectSet;
3328   auto I = CustomSubjectSet.find(FnName);
3329   if (I != CustomSubjectSet.end())
3330     return *I;
3331 
3332   Record *Base = Subject.getValueAsDef("Base");
3333 
3334   // Not currently support custom subjects within custom subjects.
3335   if (Base->isSubClassOf("SubsetSubject")) {
3336     PrintFatalError(Subject.getLoc(),
3337                     "SubsetSubjects within SubsetSubjects is not supported");
3338     return "";
3339   }
3340 
3341   OS << "static bool " << FnName << "(const Decl *D) {\n";
3342   OS << "  if (const auto *S = dyn_cast<";
3343   OS << GetSubjectWithSuffix(Base);
3344   OS << ">(D))\n";
3345   OS << "    return " << Subject.getValueAsString("CheckCode") << ";\n";
3346   OS << "  return false;\n";
3347   OS << "}\n\n";
3348 
3349   CustomSubjectSet.insert(FnName);
3350   return FnName;
3351 }
3352 
3353 static std::string GenerateAppertainsTo(const Record &Attr, raw_ostream &OS) {
3354   // If the attribute does not contain a Subjects definition, then use the
3355   // default appertainsTo logic.
3356   if (Attr.isValueUnset("Subjects"))
3357     return "defaultAppertainsTo";
3358 
3359   const Record *SubjectObj = Attr.getValueAsDef("Subjects");
3360   std::vector<Record*> Subjects = SubjectObj->getValueAsListOfDefs("Subjects");
3361 
3362   // If the list of subjects is empty, it is assumed that the attribute
3363   // appertains to everything.
3364   if (Subjects.empty())
3365     return "defaultAppertainsTo";
3366 
3367   bool Warn = SubjectObj->getValueAsDef("Diag")->getValueAsBit("Warn");
3368 
3369   // Otherwise, generate an appertainsTo check specific to this attribute which
3370   // checks all of the given subjects against the Decl passed in. Return the
3371   // name of that check to the caller.
3372   //
3373   // If D is null, that means the attribute was not applied to a declaration
3374   // at all (for instance because it was applied to a type), or that the caller
3375   // has determined that the check should fail (perhaps prior to the creation
3376   // of the declaration).
3377   std::string FnName = "check" + Attr.getName().str() + "AppertainsTo";
3378   std::stringstream SS;
3379   SS << "static bool " << FnName << "(Sema &S, const ParsedAttr &Attr, ";
3380   SS << "const Decl *D) {\n";
3381   SS << "  if (!D || (";
3382   for (auto I = Subjects.begin(), E = Subjects.end(); I != E; ++I) {
3383     // If the subject has custom code associated with it, generate a function
3384     // for it. The function cannot be inlined into this check (yet) because it
3385     // requires the subject to be of a specific type, and were that information
3386     // inlined here, it would not support an attribute with multiple custom
3387     // subjects.
3388     if ((*I)->isSubClassOf("SubsetSubject")) {
3389       SS << "!" << GenerateCustomAppertainsTo(**I, OS) << "(D)";
3390     } else {
3391       SS << "!isa<" << GetSubjectWithSuffix(*I) << ">(D)";
3392     }
3393 
3394     if (I + 1 != E)
3395       SS << " && ";
3396   }
3397   SS << ")) {\n";
3398   SS << "    S.Diag(Attr.getLoc(), diag::";
3399   SS << (Warn ? "warn_attribute_wrong_decl_type_str" :
3400                "err_attribute_wrong_decl_type_str");
3401   SS << ")\n";
3402   SS << "      << Attr << ";
3403   SS << CalculateDiagnostic(*SubjectObj) << ";\n";
3404   SS << "    return false;\n";
3405   SS << "  }\n";
3406   SS << "  return true;\n";
3407   SS << "}\n\n";
3408 
3409   OS << SS.str();
3410   return FnName;
3411 }
3412 
3413 static void
3414 emitAttributeMatchRules(PragmaClangAttributeSupport &PragmaAttributeSupport,
3415                         raw_ostream &OS) {
3416   OS << "static bool checkAttributeMatchRuleAppliesTo(const Decl *D, "
3417      << AttributeSubjectMatchRule::EnumName << " rule) {\n";
3418   OS << "  switch (rule) {\n";
3419   for (const auto &Rule : PragmaAttributeSupport.Rules) {
3420     if (Rule.isAbstractRule()) {
3421       OS << "  case " << Rule.getEnumValue() << ":\n";
3422       OS << "    assert(false && \"Abstract matcher rule isn't allowed\");\n";
3423       OS << "    return false;\n";
3424       continue;
3425     }
3426     std::vector<Record *> Subjects = Rule.getSubjects();
3427     assert(!Subjects.empty() && "Missing subjects");
3428     OS << "  case " << Rule.getEnumValue() << ":\n";
3429     OS << "    return ";
3430     for (auto I = Subjects.begin(), E = Subjects.end(); I != E; ++I) {
3431       // If the subject has custom code associated with it, use the function
3432       // that was generated for GenerateAppertainsTo to check if the declaration
3433       // is valid.
3434       if ((*I)->isSubClassOf("SubsetSubject"))
3435         OS << functionNameForCustomAppertainsTo(**I) << "(D)";
3436       else
3437         OS << "isa<" << GetSubjectWithSuffix(*I) << ">(D)";
3438 
3439       if (I + 1 != E)
3440         OS << " || ";
3441     }
3442     OS << ";\n";
3443   }
3444   OS << "  }\n";
3445   OS << "  llvm_unreachable(\"Invalid match rule\");\nreturn false;\n";
3446   OS << "}\n\n";
3447 }
3448 
3449 static void GenerateDefaultLangOptRequirements(raw_ostream &OS) {
3450   OS << "static bool defaultDiagnoseLangOpts(Sema &, ";
3451   OS << "const ParsedAttr &) {\n";
3452   OS << "  return true;\n";
3453   OS << "}\n\n";
3454 }
3455 
3456 static std::string GenerateLangOptRequirements(const Record &R,
3457                                                raw_ostream &OS) {
3458   // If the attribute has an empty or unset list of language requirements,
3459   // return the default handler.
3460   std::vector<Record *> LangOpts = R.getValueAsListOfDefs("LangOpts");
3461   if (LangOpts.empty())
3462     return "defaultDiagnoseLangOpts";
3463 
3464   // Generate a unique function name for the diagnostic test. The list of
3465   // options should usually be short (one or two options), and the
3466   // uniqueness isn't strictly necessary (it is just for codegen efficiency).
3467   std::string FnName = "check";
3468   for (auto I = LangOpts.begin(), E = LangOpts.end(); I != E; ++I)
3469     FnName += (*I)->getValueAsString("Name");
3470   FnName += "LangOpts";
3471 
3472   // If this code has already been generated, simply return the previous
3473   // instance of it.
3474   static std::set<std::string> CustomLangOptsSet;
3475   auto I = CustomLangOptsSet.find(FnName);
3476   if (I != CustomLangOptsSet.end())
3477     return *I;
3478 
3479   OS << "static bool " << FnName << "(Sema &S, const ParsedAttr &Attr) {\n";
3480   OS << "  auto &LangOpts = S.LangOpts;\n";
3481   OS << "  if (" << GenerateTestExpression(LangOpts) << ")\n";
3482   OS << "    return true;\n\n";
3483   OS << "  S.Diag(Attr.getLoc(), diag::warn_attribute_ignored) ";
3484   OS << "<< Attr.getName();\n";
3485   OS << "  return false;\n";
3486   OS << "}\n\n";
3487 
3488   CustomLangOptsSet.insert(FnName);
3489   return FnName;
3490 }
3491 
3492 static void GenerateDefaultTargetRequirements(raw_ostream &OS) {
3493   OS << "static bool defaultTargetRequirements(const TargetInfo &) {\n";
3494   OS << "  return true;\n";
3495   OS << "}\n\n";
3496 }
3497 
3498 static std::string GenerateTargetRequirements(const Record &Attr,
3499                                               const ParsedAttrMap &Dupes,
3500                                               raw_ostream &OS) {
3501   // If the attribute is not a target specific attribute, return the default
3502   // target handler.
3503   if (!Attr.isSubClassOf("TargetSpecificAttr"))
3504     return "defaultTargetRequirements";
3505 
3506   // Get the list of architectures to be tested for.
3507   const Record *R = Attr.getValueAsDef("Target");
3508   std::vector<StringRef> Arches = R->getValueAsListOfStrings("Arches");
3509 
3510   // If there are other attributes which share the same parsed attribute kind,
3511   // such as target-specific attributes with a shared spelling, collapse the
3512   // duplicate architectures. This is required because a shared target-specific
3513   // attribute has only one ParsedAttr::Kind enumeration value, but it
3514   // applies to multiple target architectures. In order for the attribute to be
3515   // considered valid, all of its architectures need to be included.
3516   if (!Attr.isValueUnset("ParseKind")) {
3517     const StringRef APK = Attr.getValueAsString("ParseKind");
3518     for (const auto &I : Dupes) {
3519       if (I.first == APK) {
3520         std::vector<StringRef> DA =
3521             I.second->getValueAsDef("Target")->getValueAsListOfStrings(
3522                 "Arches");
3523         Arches.insert(Arches.end(), DA.begin(), DA.end());
3524       }
3525     }
3526   }
3527 
3528   std::string FnName = "isTarget";
3529   std::string Test;
3530   bool UsesT = GenerateTargetSpecificAttrChecks(R, Arches, Test, &FnName);
3531 
3532   // If this code has already been generated, simply return the previous
3533   // instance of it.
3534   static std::set<std::string> CustomTargetSet;
3535   auto I = CustomTargetSet.find(FnName);
3536   if (I != CustomTargetSet.end())
3537     return *I;
3538 
3539   OS << "static bool " << FnName << "(const TargetInfo &Target) {\n";
3540   if (UsesT)
3541     OS << "  const llvm::Triple &T = Target.getTriple(); (void)T;\n";
3542   OS << "  return " << Test << ";\n";
3543   OS << "}\n\n";
3544 
3545   CustomTargetSet.insert(FnName);
3546   return FnName;
3547 }
3548 
3549 static void GenerateDefaultSpellingIndexToSemanticSpelling(raw_ostream &OS) {
3550   OS << "static unsigned defaultSpellingIndexToSemanticSpelling("
3551      << "const ParsedAttr &Attr) {\n";
3552   OS << "  return UINT_MAX;\n";
3553   OS << "}\n\n";
3554 }
3555 
3556 static std::string GenerateSpellingIndexToSemanticSpelling(const Record &Attr,
3557                                                            raw_ostream &OS) {
3558   // If the attribute does not have a semantic form, we can bail out early.
3559   if (!Attr.getValueAsBit("ASTNode"))
3560     return "defaultSpellingIndexToSemanticSpelling";
3561 
3562   std::vector<FlattenedSpelling> Spellings = GetFlattenedSpellings(Attr);
3563 
3564   // If there are zero or one spellings, or all of the spellings share the same
3565   // name, we can also bail out early.
3566   if (Spellings.size() <= 1 || SpellingNamesAreCommon(Spellings))
3567     return "defaultSpellingIndexToSemanticSpelling";
3568 
3569   // Generate the enumeration we will use for the mapping.
3570   SemanticSpellingMap SemanticToSyntacticMap;
3571   std::string Enum = CreateSemanticSpellings(Spellings, SemanticToSyntacticMap);
3572   std::string Name = Attr.getName().str() + "AttrSpellingMap";
3573 
3574   OS << "static unsigned " << Name << "(const ParsedAttr &Attr) {\n";
3575   OS << Enum;
3576   OS << "  unsigned Idx = Attr.getAttributeSpellingListIndex();\n";
3577   WriteSemanticSpellingSwitch("Idx", SemanticToSyntacticMap, OS);
3578   OS << "}\n\n";
3579 
3580   return Name;
3581 }
3582 
3583 static bool IsKnownToGCC(const Record &Attr) {
3584   // Look at the spellings for this subject; if there are any spellings which
3585   // claim to be known to GCC, the attribute is known to GCC.
3586   return llvm::any_of(
3587       GetFlattenedSpellings(Attr),
3588       [](const FlattenedSpelling &S) { return S.knownToGCC(); });
3589 }
3590 
3591 /// Emits the parsed attribute helpers
3592 void EmitClangAttrParsedAttrImpl(RecordKeeper &Records, raw_ostream &OS) {
3593   emitSourceFileHeader("Parsed attribute helpers", OS);
3594 
3595   PragmaClangAttributeSupport &PragmaAttributeSupport =
3596       getPragmaAttributeSupport(Records);
3597 
3598   // Get the list of parsed attributes, and accept the optional list of
3599   // duplicates due to the ParseKind.
3600   ParsedAttrMap Dupes;
3601   ParsedAttrMap Attrs = getParsedAttrList(Records, &Dupes);
3602 
3603   // Generate the default appertainsTo, target and language option diagnostic,
3604   // and spelling list index mapping methods.
3605   GenerateDefaultAppertainsTo(OS);
3606   GenerateDefaultLangOptRequirements(OS);
3607   GenerateDefaultTargetRequirements(OS);
3608   GenerateDefaultSpellingIndexToSemanticSpelling(OS);
3609 
3610   // Generate the appertainsTo diagnostic methods and write their names into
3611   // another mapping. At the same time, generate the AttrInfoMap object
3612   // contents. Due to the reliance on generated code, use separate streams so
3613   // that code will not be interleaved.
3614   std::string Buffer;
3615   raw_string_ostream SS {Buffer};
3616   for (auto I = Attrs.begin(), E = Attrs.end(); I != E; ++I) {
3617     // TODO: If the attribute's kind appears in the list of duplicates, that is
3618     // because it is a target-specific attribute that appears multiple times.
3619     // It would be beneficial to test whether the duplicates are "similar
3620     // enough" to each other to not cause problems. For instance, check that
3621     // the spellings are identical, and custom parsing rules match, etc.
3622 
3623     // We need to generate struct instances based off ParsedAttrInfo from
3624     // ParsedAttr.cpp.
3625     SS << "  { ";
3626     emitArgInfo(*I->second, SS);
3627     SS << ", " << I->second->getValueAsBit("HasCustomParsing");
3628     SS << ", " << I->second->isSubClassOf("TargetSpecificAttr");
3629     SS << ", "
3630        << (I->second->isSubClassOf("TypeAttr") ||
3631            I->second->isSubClassOf("DeclOrTypeAttr"));
3632     SS << ", " << I->second->isSubClassOf("StmtAttr");
3633     SS << ", " << IsKnownToGCC(*I->second);
3634     SS << ", " << PragmaAttributeSupport.isAttributedSupported(*I->second);
3635     SS << ", " << GenerateAppertainsTo(*I->second, OS);
3636     SS << ", " << GenerateLangOptRequirements(*I->second, OS);
3637     SS << ", " << GenerateTargetRequirements(*I->second, Dupes, OS);
3638     SS << ", " << GenerateSpellingIndexToSemanticSpelling(*I->second, OS);
3639     SS << ", "
3640        << PragmaAttributeSupport.generateStrictConformsTo(*I->second, OS);
3641     SS << " }";
3642 
3643     if (I + 1 != E)
3644       SS << ",";
3645 
3646     SS << "  // AT_" << I->first << "\n";
3647   }
3648 
3649   OS << "static const ParsedAttrInfo AttrInfoMap[ParsedAttr::UnknownAttribute "
3650         "+ 1] = {\n";
3651   OS << SS.str();
3652   OS << "};\n\n";
3653 
3654   // Generate the attribute match rules.
3655   emitAttributeMatchRules(PragmaAttributeSupport, OS);
3656 }
3657 
3658 // Emits the kind list of parsed attributes
3659 void EmitClangAttrParsedAttrKinds(RecordKeeper &Records, raw_ostream &OS) {
3660   emitSourceFileHeader("Attribute name matcher", OS);
3661 
3662   std::vector<Record *> Attrs = Records.getAllDerivedDefinitions("Attr");
3663   std::vector<StringMatcher::StringPair> GNU, Declspec, Microsoft, CXX11,
3664       Keywords, Pragma, C2x;
3665   std::set<std::string> Seen;
3666   for (const auto *A : Attrs) {
3667     const Record &Attr = *A;
3668 
3669     bool SemaHandler = Attr.getValueAsBit("SemaHandler");
3670     bool Ignored = Attr.getValueAsBit("Ignored");
3671     if (SemaHandler || Ignored) {
3672       // Attribute spellings can be shared between target-specific attributes,
3673       // and can be shared between syntaxes for the same attribute. For
3674       // instance, an attribute can be spelled GNU<"interrupt"> for an ARM-
3675       // specific attribute, or MSP430-specific attribute. Additionally, an
3676       // attribute can be spelled GNU<"dllexport"> and Declspec<"dllexport">
3677       // for the same semantic attribute. Ultimately, we need to map each of
3678       // these to a single ParsedAttr::Kind value, but the StringMatcher
3679       // class cannot handle duplicate match strings. So we generate a list of
3680       // string to match based on the syntax, and emit multiple string matchers
3681       // depending on the syntax used.
3682       std::string AttrName;
3683       if (Attr.isSubClassOf("TargetSpecificAttr") &&
3684           !Attr.isValueUnset("ParseKind")) {
3685         AttrName = Attr.getValueAsString("ParseKind");
3686         if (Seen.find(AttrName) != Seen.end())
3687           continue;
3688         Seen.insert(AttrName);
3689       } else
3690         AttrName = NormalizeAttrName(StringRef(Attr.getName())).str();
3691 
3692       std::vector<FlattenedSpelling> Spellings = GetFlattenedSpellings(Attr);
3693       for (const auto &S : Spellings) {
3694         const std::string &RawSpelling = S.name();
3695         std::vector<StringMatcher::StringPair> *Matches = nullptr;
3696         std::string Spelling;
3697         const std::string &Variety = S.variety();
3698         if (Variety == "CXX11") {
3699           Matches = &CXX11;
3700           Spelling += S.nameSpace();
3701           Spelling += "::";
3702         } else if (Variety == "C2x") {
3703           Matches = &C2x;
3704           Spelling += S.nameSpace();
3705           Spelling += "::";
3706         } else if (Variety == "GNU")
3707           Matches = &GNU;
3708         else if (Variety == "Declspec")
3709           Matches = &Declspec;
3710         else if (Variety == "Microsoft")
3711           Matches = &Microsoft;
3712         else if (Variety == "Keyword")
3713           Matches = &Keywords;
3714         else if (Variety == "Pragma")
3715           Matches = &Pragma;
3716 
3717         assert(Matches && "Unsupported spelling variety found");
3718 
3719         if (Variety == "GNU")
3720           Spelling += NormalizeGNUAttrSpelling(RawSpelling);
3721         else
3722           Spelling += RawSpelling;
3723 
3724         if (SemaHandler)
3725           Matches->push_back(StringMatcher::StringPair(
3726               Spelling, "return ParsedAttr::AT_" + AttrName + ";"));
3727         else
3728           Matches->push_back(StringMatcher::StringPair(
3729               Spelling, "return ParsedAttr::IgnoredAttribute;"));
3730       }
3731     }
3732   }
3733 
3734   OS << "static ParsedAttr::Kind getAttrKind(StringRef Name, ";
3735   OS << "ParsedAttr::Syntax Syntax) {\n";
3736   OS << "  if (ParsedAttr::AS_GNU == Syntax) {\n";
3737   StringMatcher("Name", GNU, OS).Emit();
3738   OS << "  } else if (ParsedAttr::AS_Declspec == Syntax) {\n";
3739   StringMatcher("Name", Declspec, OS).Emit();
3740   OS << "  } else if (ParsedAttr::AS_Microsoft == Syntax) {\n";
3741   StringMatcher("Name", Microsoft, OS).Emit();
3742   OS << "  } else if (ParsedAttr::AS_CXX11 == Syntax) {\n";
3743   StringMatcher("Name", CXX11, OS).Emit();
3744   OS << "  } else if (ParsedAttr::AS_C2x == Syntax) {\n";
3745   StringMatcher("Name", C2x, OS).Emit();
3746   OS << "  } else if (ParsedAttr::AS_Keyword == Syntax || ";
3747   OS << "ParsedAttr::AS_ContextSensitiveKeyword == Syntax) {\n";
3748   StringMatcher("Name", Keywords, OS).Emit();
3749   OS << "  } else if (ParsedAttr::AS_Pragma == Syntax) {\n";
3750   StringMatcher("Name", Pragma, OS).Emit();
3751   OS << "  }\n";
3752   OS << "  return ParsedAttr::UnknownAttribute;\n"
3753      << "}\n";
3754 }
3755 
3756 // Emits the code to dump an attribute.
3757 void EmitClangAttrTextNodeDump(RecordKeeper &Records, raw_ostream &OS) {
3758   emitSourceFileHeader("Attribute text node dumper", OS);
3759 
3760   std::vector<Record*> Attrs = Records.getAllDerivedDefinitions("Attr"), Args;
3761   for (const auto *Attr : Attrs) {
3762     const Record &R = *Attr;
3763     if (!R.getValueAsBit("ASTNode"))
3764       continue;
3765 
3766     // If the attribute has a semantically-meaningful name (which is determined
3767     // by whether there is a Spelling enumeration for it), then write out the
3768     // spelling used for the attribute.
3769 
3770     std::string FunctionContent;
3771     llvm::raw_string_ostream SS(FunctionContent);
3772 
3773     std::vector<FlattenedSpelling> Spellings = GetFlattenedSpellings(R);
3774     if (Spellings.size() > 1 && !SpellingNamesAreCommon(Spellings))
3775       SS << "    OS << \" \" << A->getSpelling();\n";
3776 
3777     Args = R.getValueAsListOfDefs("Args");
3778     for (const auto *Arg : Args)
3779       createArgument(*Arg, R.getName())->writeDump(SS);
3780 
3781     if (SS.tell()) {
3782       OS << "  void Visit" << R.getName() << "Attr(const " << R.getName()
3783          << "Attr *A) {\n";
3784       if (!Args.empty())
3785         OS << "    const auto *SA = cast<" << R.getName()
3786            << "Attr>(A); (void)SA;\n";
3787       OS << SS.str();
3788       OS << "  }\n";
3789     }
3790   }
3791 }
3792 
3793 void EmitClangAttrNodeTraverse(RecordKeeper &Records, raw_ostream &OS) {
3794   emitSourceFileHeader("Attribute text node traverser", OS);
3795 
3796   std::vector<Record *> Attrs = Records.getAllDerivedDefinitions("Attr"), Args;
3797   for (const auto *Attr : Attrs) {
3798     const Record &R = *Attr;
3799     if (!R.getValueAsBit("ASTNode"))
3800       continue;
3801 
3802     std::string FunctionContent;
3803     llvm::raw_string_ostream SS(FunctionContent);
3804 
3805     Args = R.getValueAsListOfDefs("Args");
3806     for (const auto *Arg : Args)
3807       createArgument(*Arg, R.getName())->writeDumpChildren(SS);
3808     if (SS.tell()) {
3809       OS << "  void Visit" << R.getName() << "Attr(const " << R.getName()
3810          << "Attr *A) {\n";
3811       if (!Args.empty())
3812         OS << "    const auto *SA = cast<" << R.getName()
3813            << "Attr>(A); (void)SA;\n";
3814       OS << SS.str();
3815       OS << "  }\n";
3816     }
3817   }
3818 }
3819 
3820 void EmitClangAttrParserStringSwitches(RecordKeeper &Records,
3821                                        raw_ostream &OS) {
3822   emitSourceFileHeader("Parser-related llvm::StringSwitch cases", OS);
3823   emitClangAttrArgContextList(Records, OS);
3824   emitClangAttrIdentifierArgList(Records, OS);
3825   emitClangAttrVariadicIdentifierArgList(Records, OS);
3826   emitClangAttrThisIsaIdentifierArgList(Records, OS);
3827   emitClangAttrTypeArgList(Records, OS);
3828   emitClangAttrLateParsedList(Records, OS);
3829 }
3830 
3831 void EmitClangAttrSubjectMatchRulesParserStringSwitches(RecordKeeper &Records,
3832                                                         raw_ostream &OS) {
3833   getPragmaAttributeSupport(Records).generateParsingHelpers(OS);
3834 }
3835 
3836 enum class SpellingKind {
3837   GNU,
3838   CXX11,
3839   C2x,
3840   Declspec,
3841   Microsoft,
3842   Keyword,
3843   Pragma,
3844 };
3845 static const size_t NumSpellingKinds = (size_t)SpellingKind::Pragma + 1;
3846 
3847 class SpellingList {
3848   std::vector<std::string> Spellings[NumSpellingKinds];
3849 
3850 public:
3851   ArrayRef<std::string> operator[](SpellingKind K) const {
3852     return Spellings[(size_t)K];
3853   }
3854 
3855   void add(const Record &Attr, FlattenedSpelling Spelling) {
3856     SpellingKind Kind = StringSwitch<SpellingKind>(Spelling.variety())
3857                             .Case("GNU", SpellingKind::GNU)
3858                             .Case("CXX11", SpellingKind::CXX11)
3859                             .Case("C2x", SpellingKind::C2x)
3860                             .Case("Declspec", SpellingKind::Declspec)
3861                             .Case("Microsoft", SpellingKind::Microsoft)
3862                             .Case("Keyword", SpellingKind::Keyword)
3863                             .Case("Pragma", SpellingKind::Pragma);
3864     std::string Name;
3865     if (!Spelling.nameSpace().empty()) {
3866       switch (Kind) {
3867       case SpellingKind::CXX11:
3868       case SpellingKind::C2x:
3869         Name = Spelling.nameSpace() + "::";
3870         break;
3871       case SpellingKind::Pragma:
3872         Name = Spelling.nameSpace() + " ";
3873         break;
3874       default:
3875         PrintFatalError(Attr.getLoc(), "Unexpected namespace in spelling");
3876       }
3877     }
3878     Name += Spelling.name();
3879 
3880     Spellings[(size_t)Kind].push_back(Name);
3881   }
3882 };
3883 
3884 class DocumentationData {
3885 public:
3886   const Record *Documentation;
3887   const Record *Attribute;
3888   std::string Heading;
3889   SpellingList SupportedSpellings;
3890 
3891   DocumentationData(const Record &Documentation, const Record &Attribute,
3892                     std::pair<std::string, SpellingList> HeadingAndSpellings)
3893       : Documentation(&Documentation), Attribute(&Attribute),
3894         Heading(std::move(HeadingAndSpellings.first)),
3895         SupportedSpellings(std::move(HeadingAndSpellings.second)) {}
3896 };
3897 
3898 static void WriteCategoryHeader(const Record *DocCategory,
3899                                 raw_ostream &OS) {
3900   const StringRef Name = DocCategory->getValueAsString("Name");
3901   OS << Name << "\n" << std::string(Name.size(), '=') << "\n";
3902 
3903   // If there is content, print that as well.
3904   const StringRef ContentStr = DocCategory->getValueAsString("Content");
3905   // Trim leading and trailing newlines and spaces.
3906   OS << ContentStr.trim();
3907 
3908   OS << "\n\n";
3909 }
3910 
3911 static std::pair<std::string, SpellingList>
3912 GetAttributeHeadingAndSpellings(const Record &Documentation,
3913                                 const Record &Attribute) {
3914   // FIXME: there is no way to have a per-spelling category for the attribute
3915   // documentation. This may not be a limiting factor since the spellings
3916   // should generally be consistently applied across the category.
3917 
3918   std::vector<FlattenedSpelling> Spellings = GetFlattenedSpellings(Attribute);
3919   if (Spellings.empty())
3920     PrintFatalError(Attribute.getLoc(),
3921                     "Attribute has no supported spellings; cannot be "
3922                     "documented");
3923 
3924   // Determine the heading to be used for this attribute.
3925   std::string Heading = Documentation.getValueAsString("Heading");
3926   if (Heading.empty()) {
3927     // If there's only one spelling, we can simply use that.
3928     if (Spellings.size() == 1)
3929       Heading = Spellings.begin()->name();
3930     else {
3931       std::set<std::string> Uniques;
3932       for (auto I = Spellings.begin(), E = Spellings.end();
3933            I != E && Uniques.size() <= 1; ++I) {
3934         std::string Spelling = NormalizeNameForSpellingComparison(I->name());
3935         Uniques.insert(Spelling);
3936       }
3937       // If the semantic map has only one spelling, that is sufficient for our
3938       // needs.
3939       if (Uniques.size() == 1)
3940         Heading = *Uniques.begin();
3941     }
3942   }
3943 
3944   // If the heading is still empty, it is an error.
3945   if (Heading.empty())
3946     PrintFatalError(Attribute.getLoc(),
3947                     "This attribute requires a heading to be specified");
3948 
3949   SpellingList SupportedSpellings;
3950   for (const auto &I : Spellings)
3951     SupportedSpellings.add(Attribute, I);
3952 
3953   return std::make_pair(std::move(Heading), std::move(SupportedSpellings));
3954 }
3955 
3956 static void WriteDocumentation(RecordKeeper &Records,
3957                                const DocumentationData &Doc, raw_ostream &OS) {
3958   OS << Doc.Heading << "\n" << std::string(Doc.Heading.length(), '-') << "\n";
3959 
3960   // List what spelling syntaxes the attribute supports.
3961   OS << ".. csv-table:: Supported Syntaxes\n";
3962   OS << "   :header: \"GNU\", \"C++11\", \"C2x\", \"``__declspec``\",";
3963   OS << " \"Keyword\", \"``#pragma``\", \"``#pragma clang attribute``\"\n\n";
3964   OS << "   \"";
3965   for (size_t Kind = 0; Kind != NumSpellingKinds; ++Kind) {
3966     SpellingKind K = (SpellingKind)Kind;
3967     // TODO: List Microsoft (IDL-style attribute) spellings once we fully
3968     // support them.
3969     if (K == SpellingKind::Microsoft)
3970       continue;
3971 
3972     bool PrintedAny = false;
3973     for (StringRef Spelling : Doc.SupportedSpellings[K]) {
3974       if (PrintedAny)
3975         OS << " |br| ";
3976       OS << "``" << Spelling << "``";
3977       PrintedAny = true;
3978     }
3979 
3980     OS << "\",\"";
3981   }
3982 
3983   if (getPragmaAttributeSupport(Records).isAttributedSupported(
3984           *Doc.Attribute))
3985     OS << "Yes";
3986   OS << "\"\n\n";
3987 
3988   // If the attribute is deprecated, print a message about it, and possibly
3989   // provide a replacement attribute.
3990   if (!Doc.Documentation->isValueUnset("Deprecated")) {
3991     OS << "This attribute has been deprecated, and may be removed in a future "
3992        << "version of Clang.";
3993     const Record &Deprecated = *Doc.Documentation->getValueAsDef("Deprecated");
3994     const StringRef Replacement = Deprecated.getValueAsString("Replacement");
3995     if (!Replacement.empty())
3996       OS << "  This attribute has been superseded by ``" << Replacement
3997          << "``.";
3998     OS << "\n\n";
3999   }
4000 
4001   const StringRef ContentStr = Doc.Documentation->getValueAsString("Content");
4002   // Trim leading and trailing newlines and spaces.
4003   OS << ContentStr.trim();
4004 
4005   OS << "\n\n\n";
4006 }
4007 
4008 void EmitClangAttrDocs(RecordKeeper &Records, raw_ostream &OS) {
4009   // Get the documentation introduction paragraph.
4010   const Record *Documentation = Records.getDef("GlobalDocumentation");
4011   if (!Documentation) {
4012     PrintFatalError("The Documentation top-level definition is missing, "
4013                     "no documentation will be generated.");
4014     return;
4015   }
4016 
4017   OS << Documentation->getValueAsString("Intro") << "\n";
4018 
4019   // Gather the Documentation lists from each of the attributes, based on the
4020   // category provided.
4021   std::vector<Record *> Attrs = Records.getAllDerivedDefinitions("Attr");
4022   std::map<const Record *, std::vector<DocumentationData>> SplitDocs;
4023   for (const auto *A : Attrs) {
4024     const Record &Attr = *A;
4025     std::vector<Record *> Docs = Attr.getValueAsListOfDefs("Documentation");
4026     for (const auto *D : Docs) {
4027       const Record &Doc = *D;
4028       const Record *Category = Doc.getValueAsDef("Category");
4029       // If the category is "undocumented", then there cannot be any other
4030       // documentation categories (otherwise, the attribute would become
4031       // documented).
4032       const StringRef Cat = Category->getValueAsString("Name");
4033       bool Undocumented = Cat == "Undocumented";
4034       if (Undocumented && Docs.size() > 1)
4035         PrintFatalError(Doc.getLoc(),
4036                         "Attribute is \"Undocumented\", but has multiple "
4037                         "documentation categories");
4038 
4039       if (!Undocumented)
4040         SplitDocs[Category].push_back(DocumentationData(
4041             Doc, Attr, GetAttributeHeadingAndSpellings(Doc, Attr)));
4042     }
4043   }
4044 
4045   // Having split the attributes out based on what documentation goes where,
4046   // we can begin to generate sections of documentation.
4047   for (auto &I : SplitDocs) {
4048     WriteCategoryHeader(I.first, OS);
4049 
4050     llvm::sort(I.second,
4051                [](const DocumentationData &D1, const DocumentationData &D2) {
4052                  return D1.Heading < D2.Heading;
4053                });
4054 
4055     // Walk over each of the attributes in the category and write out their
4056     // documentation.
4057     for (const auto &Doc : I.second)
4058       WriteDocumentation(Records, Doc, OS);
4059   }
4060 }
4061 
4062 void EmitTestPragmaAttributeSupportedAttributes(RecordKeeper &Records,
4063                                                 raw_ostream &OS) {
4064   PragmaClangAttributeSupport Support = getPragmaAttributeSupport(Records);
4065   ParsedAttrMap Attrs = getParsedAttrList(Records);
4066   OS << "#pragma clang attribute supports the following attributes:\n";
4067   for (const auto &I : Attrs) {
4068     if (!Support.isAttributedSupported(*I.second))
4069       continue;
4070     OS << I.first;
4071     if (I.second->isValueUnset("Subjects")) {
4072       OS << " ()\n";
4073       continue;
4074     }
4075     const Record *SubjectObj = I.second->getValueAsDef("Subjects");
4076     std::vector<Record *> Subjects =
4077         SubjectObj->getValueAsListOfDefs("Subjects");
4078     OS << " (";
4079     for (const auto &Subject : llvm::enumerate(Subjects)) {
4080       if (Subject.index())
4081         OS << ", ";
4082       PragmaClangAttributeSupport::RuleOrAggregateRuleSet &RuleSet =
4083           Support.SubjectsToRules.find(Subject.value())->getSecond();
4084       if (RuleSet.isRule()) {
4085         OS << RuleSet.getRule().getEnumValueName();
4086         continue;
4087       }
4088       OS << "(";
4089       for (const auto &Rule : llvm::enumerate(RuleSet.getAggregateRuleSet())) {
4090         if (Rule.index())
4091           OS << ", ";
4092         OS << Rule.value().getEnumValueName();
4093       }
4094       OS << ")";
4095     }
4096     OS << ")\n";
4097   }
4098   OS << "End of supported attributes.\n";
4099 }
4100 
4101 } // end namespace clang
4102