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/Support/Streams.h"
  19 #include "llvm/ADT/VectorExtras.h"
  20 #include "llvm/ADT/DenseSet.h"
  21 #include <set>
  22 #include <map>
  23
  24 using namespace llvm;
  25
  26 //===----------------------------------------------------------------------===//
  27 // Generic routines for all Clang TableGen backens.
  28 //===----------------------------------------------------------------------===//
  29
  30 typedef std::vector<Record*> RecordVector;
  31 typedef std::vector<Record*> SuperClassVector;
  32 typedef std::vector<RecordVal> RecordValVector;
  33
  34 static const RecordVal* findRecordVal(const Record& R, const std::string &key) {
  35   const RecordValVector &Vals = R.getValues();
  36   for (RecordValVector::const_iterator I=Vals.begin(), E=Vals.end(); I!=E; ++I)
  37     if ((*I).getName() == key)
  38       return &*I;
  39
  40   return 0;
  41 }
  42
  43 static const Record* getDiagKind(const Record* DiagClass, const Record &R) {
  44   const SuperClassVector &SC = R.getSuperClasses();
  45   for (SuperClassVector::const_iterator I=SC.begin(), E=SC.end(); I!=E; ++I)
  46     if ((*I)->isSubClassOf(DiagClass))
  47       return *I;
  48
  49   return 0;
  50 }
  51
  52 static void EmitEscaped(std::ostream& OS, const std::string &s) {
  53   for (std::string::const_iterator I=s.begin(), E=s.end(); I!=E; ++I)
  54     switch (*I) {
  55       default: OS << *I; break;
  56       case '\"': OS << "\\" << *I; break;
  57       case '\\': OS << "\\\\"; break;
  58     }
  59 }
  60
  61 static void EmitAllCaps(std::ostream& OS, const std::string &s) {
  62   for (std::string::const_iterator I=s.begin(), E=s.end(); I!=E; ++I)
  63     OS << char(toupper(*I));
  64 }
  65
  66 //===----------------------------------------------------------------------===//
  67 // Warning Tables (.inc file) generation.
  68 //===----------------------------------------------------------------------===//
  69
  70 static void ProcessDiag(std::ostream& OS, const Record* DiagClass,
  71                         const Record& R) {
  72
  73   const Record* DiagKind = getDiagKind(DiagClass, R);
  74   if (!DiagKind)
  75     return;
  76
  77   OS << "DIAG(" << R.getName() << ", ";
  78   EmitAllCaps(OS, DiagKind->getName());
  79
  80   const RecordVal* Text = findRecordVal(R, "Text");
  81   assert(Text && "No 'Text' entry in Diagnostic.");
  82   const StringInit* TextVal = dynamic_cast<const StringInit*>(Text->getValue());
  83   assert(TextVal && "Value 'Text' must be a string.");
  84   OS << ", \"";
  85   EmitEscaped(OS, TextVal->getValue());
  86   OS << "\")\n";
  87 }
  88
  89 void ClangDiagsDefsEmitter::run(std::ostream &OS) {
  90   const RecordVector &Diags = Records.getAllDerivedDefinitions("Diagnostic");
  91
  92   const Record* DiagClass = Records.getClass("Diagnostic");
  93   assert(DiagClass && "No Diagnostic class defined.");
  94
  95   // Write the #if guard
  96   if (!Component.empty()) {
  97     OS << "#ifdef ";
  98     EmitAllCaps(OS, Component);
  99     OS << "START\n__";
 100     EmitAllCaps(OS, Component);
 101     OS << "START = DIAG_START_";
 102     EmitAllCaps(OS, Component);
 103     OS << ",\n#undef ";
 104     EmitAllCaps(OS, Component);
 105     OS << "START\n#endif\n";
 106   }
 107
 108   for (RecordVector::const_iterator I=Diags.begin(), E=Diags.end(); I!=E; ++I) {
 109     if (!Component.empty()) {
 110       const RecordVal* V = findRecordVal(**I, "Component");
 111       if (!V)
 112         continue;
 113
 114       const StringInit* SV = dynamic_cast<const StringInit*>(V->getValue());
 115       if (SV->getValue() != Component)
 116         continue;
 117     }
 118
 119     ProcessDiag(OS, DiagClass, **I);
 120   }
 121 }
 122
 123 //===----------------------------------------------------------------------===//
 124 // Warning Group Tables generation.
 125 //===----------------------------------------------------------------------===//
 126
 127 static const std::string &getOptName(const Record *R) {
 128   const RecordVal *V = findRecordVal(*R, "Name");
 129   assert(V && "Options must have a 'Name' value.");
 130   const StringInit* SV = dynamic_cast<const StringInit*>(V->getValue());
 131   assert(SV && "'Name' entry must be a string.");
 132   return SV->getValue();
 133 }
 134
 135 namespace {
 136 struct VISIBILITY_HIDDEN CompareOptName {
 137   bool operator()(const Record* A, const Record* B) {
 138     return getOptName(A) < getOptName(B);
 139   }
 140 };
 141 }
 142
 143 typedef std::set<const Record*> DiagnosticSet;
 144 typedef std::map<const Record*, DiagnosticSet, CompareOptName> OptionMap;
 145 typedef llvm::DenseSet<const ListInit*> VisitedLists;
 146
 147 static void BuildGroup(DiagnosticSet& DS, VisitedLists &Visited, const Init* X);
 148
 149 static void BuildGroup(DiagnosticSet &DS, VisitedLists &Visited,
 150                        const ListInit* LV) {
 151
 152   // Simple hack to prevent including a list multiple times.  This may be useful
 153   // if one declares an Option by including a bunch of other Options that
 154   // include other Options, etc.
 155   if (Visited.count(LV))
 156     return;
 157
 158   Visited.insert(LV);
 159
 160   // Iterate through the list and grab all DiagnosticControlled.
 161   for (ListInit::const_iterator I = LV->begin(), E = LV->end(); I!=E; ++I)
 162     BuildGroup(DS, Visited, *I);
 163 }
 164
 165 static void BuildGroup(DiagnosticSet& DS, VisitedLists &Visited,
 166                        const Record *Def) {
 167
 168   // If an Option includes another Option, inline the Diagnostics of the
 169   // included Option.
 170   if (Def->isSubClassOf("Option")) {
 171     if (const RecordVal* V = findRecordVal(*Def, "Members"))
 172       if (const ListInit* LV = dynamic_cast<const ListInit*>(V->getValue()))
 173         BuildGroup(DS, Visited, LV);
 174
 175     return;
 176   }
 177
 178   if (Def->isSubClassOf("DiagnosticControlled"))
 179     DS.insert(Def);
 180 }
 181
 182 static void BuildGroup(DiagnosticSet& DS, VisitedLists &Visited,
 183                        const Init* X) {
 184
 185   if (const DefInit *D = dynamic_cast<const DefInit*>(X))
 186     BuildGroup(DS, Visited, D->getDef());
 187
 188   // We may have some other cases here in the future.
 189 }
 190
 191
 192 void ClangOptionsEmitter::run(std::ostream &OS) {
 193   // Build up a map from options to controlled diagnostics.
 194   OptionMap OM;
 195
 196   const RecordVector &Opts = Records.getAllDerivedDefinitions("Option");
 197   for (RecordVector::const_iterator I=Opts.begin(), E=Opts.end(); I!=E; ++I)
 198     if (const RecordVal* V = findRecordVal(**I, "Members"))
 199       if (const ListInit* LV = dynamic_cast<const ListInit*>(V->getValue())) {
 200         VisitedLists Visited;
 201         BuildGroup(OM[*I], Visited, LV);
 202       }
 203
 204   // Iterate through the OptionMap and emit the declarations.
 205   for (OptionMap::iterator I = OM.begin(), E = OM.end(); I!=E; ++I) {
 206     // Output the option.
 207     OS << "static const diag::kind " << I->first->getName() << "[] = { ";
 208
 209     DiagnosticSet &DS = I->second;
 210     bool first = true;
 211     for (DiagnosticSet::iterator I2 = DS.begin(), E2 = DS.end(); I2!=E2; ++I2) {
 212       if (first)
 213         first = false;
 214       else
 215         OS << ", ";
 216
 217       OS << "diag::" << (*I2)->getName();
 218     }
 219     OS << " };\n";
 220   }
 221
 222   // Now emit the OptionTable table.
 223   OS << "\nstatic const WarningOption OptionTable[] = {";
 224   bool first = true;
 225   for (OptionMap::iterator I = OM.begin(), E = OM.end(); I!=E; ++I) {
 226     if (first)
 227       first = false;
 228     else
 229       OS << ',';
 230
 231     OS << "\n  {\"" << getOptName(I->first)
 232        << "\", DIAGS(" << I->first->getName() << ")}";
 233   }
 234   OS << "\n};\n";
 235 }