utils/TableGen/ClangDiagnosticsEmitter.cpp

   1 //=- ClangDiagnosticsEmitter.cpp - Generate Clang diagnostics tables -*- C++ -*-
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // These tablegen backends emit Clang diagnostics tables.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "ClangDiagnosticsEmitter.h"
  15 #include "Record.h"
  16 #include "llvm/Support/Debug.h"
  17 #include "llvm/Support/Compiler.h"
  18 #include "llvm/ADT/DenseSet.h"
  19 #include "llvm/ADT/StringExtras.h"
  20 #include "llvm/ADT/StringMap.h"
  21 #include "llvm/ADT/VectorExtras.h"
  22 #include <map>
  23 #include <algorithm>
  24 #include <functional>
  25 using namespace llvm;
  26
  27 //===----------------------------------------------------------------------===//
  28 // Diagnostic category computation code.
  29 //===----------------------------------------------------------------------===//
  30
  31 namespace {
  32 class DiagGroupParentMap {
  33   RecordKeeper &Records;
  34   std::map<const Record*, std::vector<Record*> > Mapping;
  35 public:
  36   DiagGroupParentMap(RecordKeeper &records) : Records(records) {
  37     std::vector<Record*> DiagGroups
  38       = Records.getAllDerivedDefinitions("DiagGroup");
  39     for (unsigned i = 0, e = DiagGroups.size(); i != e; ++i) {
  40       std::vector<Record*> SubGroups =
  41         DiagGroups[i]->getValueAsListOfDefs("SubGroups");
  42       for (unsigned j = 0, e = SubGroups.size(); j != e; ++j)
  43         Mapping[SubGroups[j]].push_back(DiagGroups[i]);
  44     }
  45   }
  46
  47   const std::vector<Record*> &getParents(const Record *Group) {
  48     return Mapping[Group];
  49   }
  50 };
  51 } // end anonymous namespace.
  52
  53
  54 static std::string
  55 getCategoryFromDiagGroup(const Record *Group,
  56                          DiagGroupParentMap &DiagGroupParents) {
  57   // If the DiagGroup has a category, return it.
  58   std::string CatName = Group->getValueAsString("CategoryName");
  59   if (!CatName.empty()) return CatName;
  60
  61   // The diag group may the subgroup of one or more other diagnostic groups,
  62   // check these for a category as well.
  63   const std::vector<Record*> &Parents = DiagGroupParents.getParents(Group);
  64   for (unsigned i = 0, e = Parents.size(); i != e; ++i) {
  65     CatName = getCategoryFromDiagGroup(Parents[i], DiagGroupParents);
  66     if (!CatName.empty()) return CatName;
  67   }
  68   return "";
  69 }
  70
  71 /// getDiagnosticCategory - Return the category that the specified diagnostic
  72 /// lives in.
  73 static std::string getDiagnosticCategory(const Record *R,
  74                                          DiagGroupParentMap &DiagGroupParents) {
  75   // If the diagnostic is in a group, and that group has a category, use it.
  76   if (DefInit *Group = dynamic_cast<DefInit*>(R->getValueInit("Group"))) {
  77     // Check the diagnostic's diag group for a category.
  78     std::string CatName = getCategoryFromDiagGroup(Group->getDef(),
  79                                                    DiagGroupParents);
  80     if (!CatName.empty()) return CatName;
  81   }
  82
  83   // If the diagnostic itself has a category, get it.
  84   return R->getValueAsString("CategoryName");
  85 }
  86
  87 namespace {
  88   class DiagCategoryIDMap {
  89     RecordKeeper &Records;
  90     StringMap<unsigned> CategoryIDs;
  91     std::vector<std::string> CategoryStrings;
  92   public:
  93     DiagCategoryIDMap(RecordKeeper &records) : Records(records) {
  94       DiagGroupParentMap ParentInfo(Records);
  95
  96       // The zero'th category is "".
  97       CategoryStrings.push_back("");
  98       CategoryIDs[""] = 0;
  99
 100       std::vector<Record*> Diags =
 101       Records.getAllDerivedDefinitions("Diagnostic");
 102       for (unsigned i = 0, e = Diags.size(); i != e; ++i) {
 103         std::string Category = getDiagnosticCategory(Diags[i], ParentInfo);
 104         if (Category.empty()) continue;  // Skip diags with no category.
 105
 106         unsigned &ID = CategoryIDs[Category];
 107         if (ID != 0) continue;  // Already seen.
 108
 109         ID = CategoryStrings.size();
 110         CategoryStrings.push_back(Category);
 111       }
 112     }
 113
 114     unsigned getID(StringRef CategoryString) {
 115       return CategoryIDs[CategoryString];
 116     }
 117
 118     typedef std::vector<std::string>::iterator iterator;
 119     iterator begin() { return CategoryStrings.begin(); }
 120     iterator end() { return CategoryStrings.end(); }
 121   };
 122 } // end anonymous namespace.
 123
 124
 125 //===----------------------------------------------------------------------===//
 126 // Warning Tables (.inc file) generation.
 127 //===----------------------------------------------------------------------===//
 128
 129 void ClangDiagsDefsEmitter::run(raw_ostream &OS) {
 130   // Write the #if guard
 131   if (!Component.empty()) {
 132     std::string ComponentName = UppercaseString(Component);
 133     OS << "#ifdef " << ComponentName << "START\n";
 134     OS << "__" << ComponentName << "START = DIAG_START_" << ComponentName
 135        << ",\n";
 136     OS << "#undef " << ComponentName << "START\n";
 137     OS << "#endif\n\n";
 138   }
 139
 140   const std::vector<Record*> &Diags =
 141     Records.getAllDerivedDefinitions("Diagnostic");
 142
 143   DiagCategoryIDMap CategoryIDs(Records);
 144   DiagGroupParentMap DGParentMap(Records);
 145
 146   for (unsigned i = 0, e = Diags.size(); i != e; ++i) {
 147     const Record &R = *Diags[i];
 148     // Filter by component.
 149     if (!Component.empty() && Component != R.getValueAsString("Component"))
 150       continue;
 151
 152     OS << "DIAG(" << R.getName() << ", ";
 153     OS << R.getValueAsDef("Class")->getName();
 154     OS << ", diag::" << R.getValueAsDef("DefaultMapping")->getName();
 155
 156     // Description string.
 157     OS << ", \"";
 158     OS.write_escaped(R.getValueAsString("Text")) << '"';
 159
 160     // Warning associated with the diagnostic.
 161     if (DefInit *DI = dynamic_cast<DefInit*>(R.getValueInit("Group"))) {
 162       OS << ", \"";
 163       OS.write_escaped(DI->getDef()->getValueAsString("GroupName")) << '"';
 164     } else {
 165       OS << ", \"\"";
 166     }
 167
 168     // SFINAE bit
 169     if (R.getValueAsBit("SFINAE"))
 170       OS << ", true";
 171     else
 172       OS << ", false";
 173
 174     // Access control bit
 175     if (R.getValueAsBit("AccessControl"))
 176       OS << ", true";
 177     else
 178       OS << ", false";
 179
 180     // Category number.
 181     OS << ", " << CategoryIDs.getID(getDiagnosticCategory(&R, DGParentMap));
 182
 183     // Brief
 184     OS << ", \"";
 185     OS.write_escaped(R.getValueAsString("Brief")) << '"';
 186
 187     // Explanation
 188     OS << ", \"";
 189     OS.write_escaped(R.getValueAsString("Explanation")) << '"';
 190     OS << ")\n";
 191   }
 192 }
 193
 194 //===----------------------------------------------------------------------===//
 195 // Warning Group Tables generation
 196 //===----------------------------------------------------------------------===//
 197
 198 namespace {
 199 struct GroupInfo {
 200   std::vector<const Record*> DiagsInGroup;
 201   std::vector<std::string> SubGroups;
 202   unsigned IDNo;
 203 };
 204 } // end anonymous namespace.
 205
 206 void ClangDiagGroupsEmitter::run(raw_ostream &OS) {
 207   // Compute a mapping from a DiagGroup to all of its parents.
 208   DiagGroupParentMap DGParentMap(Records);
 209
 210   // Invert the 1-[0/1] mapping of diags to group into a one to many mapping of
 211   // groups to diags in the group.
 212   std::map<std::string, GroupInfo> DiagsInGroup;
 213
 214   std::vector<Record*> Diags =
 215     Records.getAllDerivedDefinitions("Diagnostic");
 216   for (unsigned i = 0, e = Diags.size(); i != e; ++i) {
 217     const Record *R = Diags[i];
 218     DefInit *DI = dynamic_cast<DefInit*>(R->getValueInit("Group"));
 219     if (DI == 0) continue;
 220     std::string GroupName = DI->getDef()->getValueAsString("GroupName");
 221     DiagsInGroup[GroupName].DiagsInGroup.push_back(R);
 222   }
 223
 224   // Add all DiagGroup's to the DiagsInGroup list to make sure we pick up empty
 225   // groups (these are warnings that GCC supports that clang never produces).
 226   std::vector<Record*> DiagGroups
 227     = Records.getAllDerivedDefinitions("DiagGroup");
 228   for (unsigned i = 0, e = DiagGroups.size(); i != e; ++i) {
 229     Record *Group = DiagGroups[i];
 230     GroupInfo &GI = DiagsInGroup[Group->getValueAsString("GroupName")];
 231
 232     std::vector<Record*> SubGroups = Group->getValueAsListOfDefs("SubGroups");
 233     for (unsigned j = 0, e = SubGroups.size(); j != e; ++j)
 234       GI.SubGroups.push_back(SubGroups[j]->getValueAsString("GroupName"));
 235   }
 236
 237   // Assign unique ID numbers to the groups.
 238   unsigned IDNo = 0;
 239   for (std::map<std::string, GroupInfo>::iterator
 240        I = DiagsInGroup.begin(), E = DiagsInGroup.end(); I != E; ++I, ++IDNo)
 241     I->second.IDNo = IDNo;
 242
 243   // Walk through the groups emitting an array for each diagnostic of the diags
 244   // that are mapped to.
 245   OS << "\n#ifdef GET_DIAG_ARRAYS\n";
 246   unsigned MaxLen = 0;
 247   for (std::map<std::string, GroupInfo>::iterator
 248        I = DiagsInGroup.begin(), E = DiagsInGroup.end(); I != E; ++I) {
 249     MaxLen = std::max(MaxLen, (unsigned)I->first.size());
 250
 251     std::vector<const Record*> &V = I->second.DiagsInGroup;
 252     if (!V.empty()) {
 253       OS << "static const short DiagArray" << I->second.IDNo << "[] = { ";
 254       for (unsigned i = 0, e = V.size(); i != e; ++i)
 255         OS << "diag::" << V[i]->getName() << ", ";
 256       OS << "-1 };\n";
 257     }
 258
 259     const std::vector<std::string> &SubGroups = I->second.SubGroups;
 260     if (!SubGroups.empty()) {
 261       OS << "static const short DiagSubGroup" << I->second.IDNo << "[] = { ";
 262       for (unsigned i = 0, e = SubGroups.size(); i != e; ++i) {
 263         std::map<std::string, GroupInfo>::iterator RI =
 264           DiagsInGroup.find(SubGroups[i]);
 265         assert(RI != DiagsInGroup.end() && "Referenced without existing?");
 266         OS << RI->second.IDNo << ", ";
 267       }
 268       OS << "-1 };\n";
 269     }
 270   }
 271   OS << "#endif // GET_DIAG_ARRAYS\n\n";
 272
 273   // Emit the table now.
 274   OS << "\n#ifdef GET_DIAG_TABLE\n";
 275   for (std::map<std::string, GroupInfo>::iterator
 276        I = DiagsInGroup.begin(), E = DiagsInGroup.end(); I != E; ++I) {
 277     // Group option string.
 278     OS << "  { ";
 279     OS << I->first.size() << ", ";
 280     OS << "\"";
 281     OS.write_escaped(I->first) << "\","
 282                                << std::string(MaxLen-I->first.size()+1, ' ');
 283
 284     // Diagnostics in the group.
 285     if (I->second.DiagsInGroup.empty())
 286       OS << "0, ";
 287     else
 288       OS << "DiagArray" << I->second.IDNo << ", ";
 289
 290     // Subgroups.
 291     if (I->second.SubGroups.empty())
 292       OS << 0;
 293     else
 294       OS << "DiagSubGroup" << I->second.IDNo;
 295     OS << " },\n";
 296   }
 297   OS << "#endif // GET_DIAG_TABLE\n\n";
 298
 299   // Emit the category table next.
 300   DiagCategoryIDMap CategoriesByID(Records);
 301   OS << "\n#ifdef GET_CATEGORY_TABLE\n";
 302   for (DiagCategoryIDMap::iterator I = CategoriesByID.begin(),
 303        E = CategoriesByID.end(); I != E; ++I)
 304     OS << "CATEGORY(\"" << *I << "\")\n";
 305   OS << "#endif // GET_CATEGORY_TABLE\n\n";
 306 }
 307
 308 //===----------------------------------------------------------------------===//
 309 // Diagnostic name index generation
 310 //===----------------------------------------------------------------------===//
 311
 312 namespace {
 313 struct RecordIndexElement
 314 {
 315   RecordIndexElement() {}
 316   explicit RecordIndexElement(Record const &R):
 317     Name(R.getName()) {}
 318
 319   std::string Name;
 320 };
 321
 322 struct RecordIndexElementSorter :
 323   public std::binary_function<RecordIndexElement, RecordIndexElement, bool> {
 324
 325   bool operator()(RecordIndexElement const &Lhs,
 326                   RecordIndexElement const &Rhs) const {
 327     return Lhs.Name < Rhs.Name;
 328   }
 329
 330 };
 331
 332 } // end anonymous namespace.
 333
 334 void ClangDiagsIndexNameEmitter::run(raw_ostream &OS) {
 335   const std::vector<Record*> &Diags =
 336     Records.getAllDerivedDefinitions("Diagnostic");
 337
 338   std::vector<RecordIndexElement> Index;
 339   Index.reserve(Diags.size());
 340   for (unsigned i = 0, e = Diags.size(); i != e; ++i) {
 341     const Record &R = *(Diags[i]);
 342     Index.push_back(RecordIndexElement(R));
 343   }
 344
 345   std::sort(Index.begin(), Index.end(), RecordIndexElementSorter());
 346
 347   for (unsigned i = 0, e = Index.size(); i != e; ++i) {
 348     const RecordIndexElement &R = Index[i];
 349
 350     OS << "DIAG_NAME_INDEX(" << R.Name << ")\n";
 351   }
 352 }