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 <set>
  23 #include <map>
  24 using namespace llvm;
  25
  26 //===----------------------------------------------------------------------===//
  27 // Diagnostic category computation code.
  28 //===----------------------------------------------------------------------===//
  29
  30 namespace {
  31 class DiagGroupParentMap {
  32   RecordKeeper &Records;
  33   std::map<const Record*, std::vector<Record*> > Mapping;
  34 public:
  35   DiagGroupParentMap(RecordKeeper &records) : Records(records) {
  36     std::vector<Record*> DiagGroups
  37       = Records.getAllDerivedDefinitions("DiagGroup");
  38     for (unsigned i = 0, e = DiagGroups.size(); i != e; ++i) {
  39       std::vector<Record*> SubGroups =
  40         DiagGroups[i]->getValueAsListOfDefs("SubGroups");
  41       for (unsigned j = 0, e = SubGroups.size(); j != e; ++j)
  42         Mapping[SubGroups[j]].push_back(DiagGroups[i]);
  43     }
  44   }
  45
  46   const std::vector<Record*> &getParents(const Record *Group) {
  47     return Mapping[Group];
  48   }
  49 };
  50 } // end anonymous namespace.
  51
  52
  53 static std::string
  54 getCategoryFromDiagGroup(const Record *Group,
  55                          DiagGroupParentMap &DiagGroupParents) {
  56   // If the DiagGroup has a category, return it.
  57   std::string CatName = Group->getValueAsString("CategoryName");
  58   if (!CatName.empty()) return CatName;
  59
  60   // The diag group may the subgroup of one or more other diagnostic groups,
  61   // check these for a category as well.
  62   const std::vector<Record*> &Parents = DiagGroupParents.getParents(Group);
  63   for (unsigned i = 0, e = Parents.size(); i != e; ++i) {
  64     CatName = getCategoryFromDiagGroup(Parents[i], DiagGroupParents);
  65     if (!CatName.empty()) return CatName;
  66   }
  67   return "";
  68 }
  69
  70 /// getDiagnosticCategory - Return the category that the specified diagnostic
  71 /// lives in.
  72 static std::string getDiagnosticCategory(const Record *R,
  73                                          DiagGroupParentMap &DiagGroupParents) {
  74   // If the diagnostic is in a group, and that group has a category, use it.
  75   if (DefInit *Group = dynamic_cast<DefInit*>(R->getValueInit("Group"))) {
  76     // Check the diagnostic's diag group for a category.
  77     std::string CatName = getCategoryFromDiagGroup(Group->getDef(),
  78                                                    DiagGroupParents);
  79     if (!CatName.empty()) return CatName;
  80   }
  81
  82   // If the diagnostic itself has a category, get it.
  83   return R->getValueAsString("CategoryName");
  84 }
  85
  86 namespace {
  87   class DiagCategoryIDMap {
  88     RecordKeeper &Records;
  89     StringMap<unsigned> CategoryIDs;
  90     std::vector<std::string> CategoryStrings;
  91   public:
  92     DiagCategoryIDMap(RecordKeeper &records) : Records(records) {
  93       DiagGroupParentMap ParentInfo(Records);
  94
  95       // The zero'th category is "".
  96       CategoryStrings.push_back("");
  97       CategoryIDs[""] = 0;
  98
  99       std::vector<Record*> Diags =
 100       Records.getAllDerivedDefinitions("Diagnostic");
 101       for (unsigned i = 0, e = Diags.size(); i != e; ++i) {
 102         std::string Category = getDiagnosticCategory(Diags[i], ParentInfo);
 103         if (Category.empty()) continue;  // Skip diags with no category.
 104
 105         unsigned &ID = CategoryIDs[Category];
 106         if (ID != 0) continue;  // Already seen.
 107
 108         ID = CategoryStrings.size();
 109         CategoryStrings.push_back(Category);
 110       }
 111     }
 112
 113     unsigned getID(StringRef CategoryString) {
 114       return CategoryIDs[CategoryString];
 115     }
 116
 117     typedef std::vector<std::string>::iterator iterator;
 118     iterator begin() { return CategoryStrings.begin(); }
 119     iterator end() { return CategoryStrings.end(); }
 120   };
 121 } // end anonymous namespace.
 122
 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 << ", 0";
 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     OS << ")\n";
 183   }
 184 }
 185
 186 //===----------------------------------------------------------------------===//
 187 // Warning Group Tables generation
 188 //===----------------------------------------------------------------------===//
 189
 190 namespace {
 191 struct GroupInfo {
 192   std::vector<const Record*> DiagsInGroup;
 193   std::vector<std::string> SubGroups;
 194   unsigned IDNo;
 195 };
 196 } // end anonymous namespace.
 197
 198 void ClangDiagGroupsEmitter::run(raw_ostream &OS) {
 199   // Compute a mapping from a DiagGroup to all of its parents.
 200   DiagGroupParentMap DGParentMap(Records);
 201
 202   // Invert the 1-[0/1] mapping of diags to group into a one to many mapping of
 203   // groups to diags in the group.
 204   std::map<std::string, GroupInfo> DiagsInGroup;
 205
 206   std::vector<Record*> Diags =
 207     Records.getAllDerivedDefinitions("Diagnostic");
 208   for (unsigned i = 0, e = Diags.size(); i != e; ++i) {
 209     const Record *R = Diags[i];
 210     DefInit *DI = dynamic_cast<DefInit*>(R->getValueInit("Group"));
 211     if (DI == 0) continue;
 212     std::string GroupName = DI->getDef()->getValueAsString("GroupName");
 213     DiagsInGroup[GroupName].DiagsInGroup.push_back(R);
 214   }
 215
 216   // Add all DiagGroup's to the DiagsInGroup list to make sure we pick up empty
 217   // groups (these are warnings that GCC supports that clang never produces).
 218   std::vector<Record*> DiagGroups
 219     = Records.getAllDerivedDefinitions("DiagGroup");
 220   for (unsigned i = 0, e = DiagGroups.size(); i != e; ++i) {
 221     Record *Group = DiagGroups[i];
 222     GroupInfo &GI = DiagsInGroup[Group->getValueAsString("GroupName")];
 223
 224     std::vector<Record*> SubGroups = Group->getValueAsListOfDefs("SubGroups");
 225     for (unsigned j = 0, e = SubGroups.size(); j != e; ++j)
 226       GI.SubGroups.push_back(SubGroups[j]->getValueAsString("GroupName"));
 227   }
 228
 229   // Assign unique ID numbers to the groups.
 230   unsigned IDNo = 0;
 231   for (std::map<std::string, GroupInfo>::iterator
 232        I = DiagsInGroup.begin(), E = DiagsInGroup.end(); I != E; ++I, ++IDNo)
 233     I->second.IDNo = IDNo;
 234
 235   // Walk through the groups emitting an array for each diagnostic of the diags
 236   // that are mapped to.
 237   OS << "\n#ifdef GET_DIAG_ARRAYS\n";
 238   unsigned MaxLen = 0;
 239   for (std::map<std::string, GroupInfo>::iterator
 240        I = DiagsInGroup.begin(), E = DiagsInGroup.end(); I != E; ++I) {
 241     MaxLen = std::max(MaxLen, (unsigned)I->first.size());
 242
 243     std::vector<const Record*> &V = I->second.DiagsInGroup;
 244     if (!V.empty()) {
 245       OS << "static const short DiagArray" << I->second.IDNo << "[] = { ";
 246       for (unsigned i = 0, e = V.size(); i != e; ++i)
 247         OS << "diag::" << V[i]->getName() << ", ";
 248       OS << "-1 };\n";
 249     }
 250
 251     const std::vector<std::string> &SubGroups = I->second.SubGroups;
 252     if (!SubGroups.empty()) {
 253       OS << "static const short DiagSubGroup" << I->second.IDNo << "[] = { ";
 254       for (unsigned i = 0, e = SubGroups.size(); i != e; ++i) {
 255         std::map<std::string, GroupInfo>::iterator RI =
 256           DiagsInGroup.find(SubGroups[i]);
 257         assert(RI != DiagsInGroup.end() && "Referenced without existing?");
 258         OS << RI->second.IDNo << ", ";
 259       }
 260       OS << "-1 };\n";
 261     }
 262   }
 263   OS << "#endif // GET_DIAG_ARRAYS\n\n";
 264
 265   // Emit the table now.
 266   OS << "\n#ifdef GET_DIAG_TABLE\n";
 267   for (std::map<std::string, GroupInfo>::iterator
 268        I = DiagsInGroup.begin(), E = DiagsInGroup.end(); I != E; ++I) {
 269     // Group option string.
 270     OS << "  { \"";
 271     OS.write_escaped(I->first) << "\","
 272                                << std::string(MaxLen-I->first.size()+1, ' ');
 273
 274     // Diagnostics in the group.
 275     if (I->second.DiagsInGroup.empty())
 276       OS << "0, ";
 277     else
 278       OS << "DiagArray" << I->second.IDNo << ", ";
 279
 280     // Subgroups.
 281     if (I->second.SubGroups.empty())
 282       OS << 0;
 283     else
 284       OS << "DiagSubGroup" << I->second.IDNo;
 285     OS << " },\n";
 286   }
 287   OS << "#endif // GET_DIAG_TABLE\n\n";
 288
 289   // Emit the category table next.
 290   DiagCategoryIDMap CategoriesByID(Records);
 291   OS << "\n#ifdef GET_CATEGORY_TABLE\n";
 292   for (DiagCategoryIDMap::iterator I = CategoriesByID.begin(),
 293        E = CategoriesByID.end(); I != E; ++I)
 294     OS << "CATEGORY(\"" << *I << "\")\n";
 295   OS << "#endif // GET_CATEGORY_TABLE\n\n";
 296 }