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