Fixed a nasty layering violation in the edis source
[oota-llvm.git] / utils / TableGen / ClangDiagnosticsEmitter.cpp
index 38c4eeb39d472149b872c4c4673cef8053fcf9df..27b16544ce1d795c12f5cbbafa6c1e2d5abf9940 100644 (file)
 #include "Record.h"
 #include "llvm/Support/Debug.h"
 #include "llvm/Support/Compiler.h"
-#include "llvm/Support/Streams.h"
-#include "llvm/ADT/VectorExtras.h"
 #include "llvm/ADT/DenseSet.h"
+#include "llvm/ADT/StringExtras.h"
+#include "llvm/ADT/VectorExtras.h"
 #include <set>
 #include <map>
 using namespace llvm;
 
-//===----------------------------------------------------------------------===//
-// Generic routines for all Clang TableGen backends.
-//===----------------------------------------------------------------------===//
-
-typedef std::vector<Record*> RecordVector;
-typedef std::vector<Record*> SuperClassVector;
-typedef std::vector<RecordVal> RecordValVector;
-
-static const RecordVal* findRecordVal(const Record& R, const std::string &key) {  
-  const RecordValVector &Vals = R.getValues();
-  for (RecordValVector::const_iterator I=Vals.begin(), E=Vals.end(); I!=E; ++I)
-    if ((*I).getName() == key)
-      return &*I;
-  
-  return 0;
-}
-
-static void EmitEscaped(std::ostream& OS, const std::string &s) {
-  for (std::string::const_iterator I=s.begin(), E=s.end(); I!=E; ++I)
-    switch (*I) {
-      default: OS << *I; break;
-      case '\"': OS << "\\" << *I; break;
-      case '\\': OS << "\\\\"; break;
-    }
-}
-
-static void EmitAllCaps(std::ostream& OS, const std::string &s) {
-  for (std::string::const_iterator I=s.begin(), E=s.end(); I!=E; ++I)
-    OS << char(toupper(*I));  
-}
-
 //===----------------------------------------------------------------------===//
 // Warning Tables (.inc file) generation.
 //===----------------------------------------------------------------------===//
 
-static void ProcessDiag(std::ostream &OS, const Record *DiagClass,
-                        const Record &R) {
-  OS << "DIAG(" << R.getName() << ", ";
-  OS << R.getValueAsDef("Class")->getName();
-  OS << ", diag::" << R.getValueAsDef("DefaultMapping")->getName();
-  OS << ", \"";
-  EmitEscaped(OS, R.getValueAsString("Text"));
-  OS << "\")\n";
-}
-
-void ClangDiagsDefsEmitter::run(std::ostream &OS) {
-  const RecordVector &Diags = Records.getAllDerivedDefinitions("Diagnostic");
-  
-  const Record* DiagClass = Records.getClass("Diagnostic");
-  assert(DiagClass && "No Diagnostic class defined.");  
-  
+void ClangDiagsDefsEmitter::run(raw_ostream &OS) {
   // Write the #if guard
   if (!Component.empty()) {
-    OS << "#ifdef ";
-    EmitAllCaps(OS, Component);
-    OS << "START\n__";
-    EmitAllCaps(OS, Component);
-    OS << "START = DIAG_START_";
-    EmitAllCaps(OS, Component);
-    OS << ",\n#undef ";
-    EmitAllCaps(OS, Component);
-    OS << "START\n#endif\n";
+    std::string ComponentName = UppercaseString(Component);
+    OS << "#ifdef " << ComponentName << "START\n";
+    OS << "__" << ComponentName << "START = DIAG_START_" << ComponentName
+       << ",\n";
+    OS << "#undef " << ComponentName << "START\n";
+    OS << "#endif\n\n";
   }
+
+  const std::vector<Record*> &Diags =
+    Records.getAllDerivedDefinitions("Diagnostic");
   
-  for (RecordVector::const_iterator I=Diags.begin(), E=Diags.end(); I!=E; ++I) {
-    const Record &R = **I;
+  for (unsigned i = 0, e = Diags.size(); i != e; ++i) {
+    const Record &R = *Diags[i];
     // Filter by component.
     if (!Component.empty() && Component != R.getValueAsString("Component"))
       continue;
     
-    ProcessDiag(OS, DiagClass, R);
+    OS << "DIAG(" << R.getName() << ", ";
+    OS << R.getValueAsDef("Class")->getName();
+    OS << ", diag::" << R.getValueAsDef("DefaultMapping")->getName();
+    
+    // Description string.
+    OS << ", \"";
+    OS.write_escaped(R.getValueAsString("Text")) << '"';
+    
+    // Warning associated with the diagnostic.
+    if (DefInit *DI = dynamic_cast<DefInit*>(R.getValueInit("Group"))) {
+      OS << ", \"";
+      OS.write_escaped(DI->getDef()->getValueAsString("GroupName")) << '"';
+    } else {
+      OS << ", 0";
+    }
+
+    // SFINAE bit
+    if (R.getValueAsBit("SFINAE"))
+      OS << ", true";
+    else
+      OS << ", false";
+    OS << ")\n";
   }
 }
 
 //===----------------------------------------------------------------------===//
-// Warning Group Tables generation.
+// Warning Group Tables generation
 //===----------------------------------------------------------------------===//
 
-static const std::string &getOptName(const Record *R) {
-  const RecordVal *V = findRecordVal(*R, "Name");
-  assert(V && "Options must have a 'Name' value.");
-  const StringInit* SV = dynamic_cast<const StringInit*>(V->getValue());
-  assert(SV && "'Name' entry must be a string.");
-  return SV->getValue();
-}  
-
-namespace {
-struct VISIBILITY_HIDDEN CompareOptName {  
-  bool operator()(const Record* A, const Record* B) const {
-    return getOptName(A) < getOptName(B);
-  }
+struct GroupInfo {
+  std::vector<const Record*> DiagsInGroup;
+  std::vector<std::string> SubGroups;
+  unsigned IDNo;
 };
-}
-
-typedef std::set<const Record*> DiagnosticSet;
-typedef std::map<const Record*, DiagnosticSet, CompareOptName> OptionMap;
-typedef llvm::DenseSet<const ListInit*> VisitedLists;
 
-static void BuildGroup(DiagnosticSet& DS, VisitedLists &Visited, const Init* X);
-
-static void BuildGroup(DiagnosticSet &DS, VisitedLists &Visited,
-                       const ListInit* LV) {
-
-  // Simple hack to prevent including a list multiple times.  This may be useful
-  // if one declares an Option by including a bunch of other Options that
-  // include other Options, etc.
-  if (Visited.count(LV))
-    return;
-  
-  Visited.insert(LV);
+void ClangDiagGroupsEmitter::run(raw_ostream &OS) {
+  // Invert the 1-[0/1] mapping of diags to group into a one to many mapping of
+  // groups to diags in the group.
+  std::map<std::string, GroupInfo> DiagsInGroup;
   
-  // Iterate through the list and grab all DiagnosticControlled.
-  for (ListInit::const_iterator I = LV->begin(), E = LV->end(); I!=E; ++I)
-    BuildGroup(DS, Visited, *I);
-}
-
-static void BuildGroup(DiagnosticSet& DS, VisitedLists &Visited,
-                       const Record *Def) {
-
-  // If an Option includes another Option, inline the Diagnostics of the
-  // included Option.
-  if (Def->isSubClassOf("Option")) {
-    if (const RecordVal *V = findRecordVal(*Def, "Members"))
-      if (const ListInit *LV = dynamic_cast<const ListInit*>(V->getValue()))
-        BuildGroup(DS, Visited, LV);
-
-    return;
+  std::vector<Record*> Diags =
+    Records.getAllDerivedDefinitions("Diagnostic");
+  for (unsigned i = 0, e = Diags.size(); i != e; ++i) {
+    const Record *R = Diags[i];
+    DefInit *DI = dynamic_cast<DefInit*>(R->getValueInit("Group"));
+    if (DI == 0) continue;
+    std::string GroupName = DI->getDef()->getValueAsString("GroupName");
+    DiagsInGroup[GroupName].DiagsInGroup.push_back(R);
   }
   
-  if (Def->isSubClassOf("DiagnosticControlled"))
-    DS.insert(Def);
-}
-
-static void BuildGroup(DiagnosticSet& DS, VisitedLists &Visited,
-                       const Init* X) {
-
-  if (const DefInit *D = dynamic_cast<const DefInit*>(X))
-    BuildGroup(DS, Visited, D->getDef());
+  // Add all DiagGroup's to the DiagsInGroup list to make sure we pick up empty
+  // groups (these are warnings that GCC supports that clang never produces).
+  Diags = Records.getAllDerivedDefinitions("DiagGroup");
+  for (unsigned i = 0, e = Diags.size(); i != e; ++i) {
+    Record *Group = Diags[i];
+    GroupInfo &GI = DiagsInGroup[Group->getValueAsString("GroupName")];
+    
+    std::vector<Record*> SubGroups = Group->getValueAsListOfDefs("SubGroups");
+    for (unsigned j = 0, e = SubGroups.size(); j != e; ++j)
+      GI.SubGroups.push_back(SubGroups[j]->getValueAsString("GroupName"));
+  }
   
-  // We may have some other cases here in the future.
-}
-
-
-void ClangDiagGroupsEmitter::run(std::ostream &OS) {
-  // Build up a map from options to controlled diagnostics.
-  OptionMap OM;
-       
-  const RecordVector &Opts = Records.getAllDerivedDefinitions("Option");
-  for (RecordVector::const_iterator I=Opts.begin(), E=Opts.end(); I != E; ++I)
-    if (const RecordVal* V = findRecordVal(**I, "Members"))
-      if (const ListInit* LV = dynamic_cast<const ListInit*>(V->getValue())) {        
-        VisitedLists Visited;
-        BuildGroup(OM[*I], Visited, LV);
-      }
+  // Assign unique ID numbers to the groups.
+  unsigned IDNo = 0;
+  for (std::map<std::string, GroupInfo>::iterator
+       I = DiagsInGroup.begin(), E = DiagsInGroup.end(); I != E; ++I, ++IDNo)
+    I->second.IDNo = IDNo;
   
-  // Iterate through the OptionMap and emit the declarations.
-  for (OptionMap::iterator I = OM.begin(), E = OM.end(); I!=E; ++I) {    
-    // Output the option.
-    OS << "static const diag::kind " << I->first->getName() << "[] = { ";
+  // Walk through the groups emitting an array for each diagnostic of the diags
+  // that are mapped to.
+  OS << "\n#ifdef GET_DIAG_ARRAYS\n";
+  unsigned MaxLen = 0;
+  for (std::map<std::string, GroupInfo>::iterator
+       I = DiagsInGroup.begin(), E = DiagsInGroup.end(); I != E; ++I) {
+    MaxLen = std::max(MaxLen, (unsigned)I->first.size());
+    
+    std::vector<const Record*> &V = I->second.DiagsInGroup;
+    if (!V.empty()) {
+      OS << "static const short DiagArray" << I->second.IDNo << "[] = { ";
+      for (unsigned i = 0, e = V.size(); i != e; ++i)
+        OS << "diag::" << V[i]->getName() << ", ";
+      OS << "-1 };\n";
+    }
     
-    DiagnosticSet &DS = I->second;
-    bool first = true;
-    for (DiagnosticSet::iterator I2 = DS.begin(), E2 = DS.end(); I2!=E2; ++I2) {
-      if (first)
-        first = false;
-      else
-        OS << ", ";
-        
-      OS << "diag::" << (*I2)->getName();
+    const std::vector<std::string> &SubGroups = I->second.SubGroups;
+    if (!SubGroups.empty()) {
+      OS << "static const char DiagSubGroup" << I->second.IDNo << "[] = { ";
+      for (unsigned i = 0, e = SubGroups.size(); i != e; ++i) {
+        std::map<std::string, GroupInfo>::iterator RI =
+          DiagsInGroup.find(SubGroups[i]);
+        assert(RI != DiagsInGroup.end() && "Referenced without existing?");
+        OS << RI->second.IDNo << ", ";
+      }
+      OS << "-1 };\n";
     }
-    OS << " };\n";
   }
+  OS << "#endif // GET_DIAG_ARRAYS\n\n";
+  
+  // Emit the table now.
+  OS << "\n#ifdef GET_DIAG_TABLE\n";
+  for (std::map<std::string, GroupInfo>::iterator
+       I = DiagsInGroup.begin(), E = DiagsInGroup.end(); I != E; ++I) {
+    // Group option string.
+    OS << "  { \"";
+    OS.write_escaped(I->first) << "\","
+                               << std::string(MaxLen-I->first.size()+1, ' ');
     
-  // Now emit the OptionTable table.
-  OS << "\nstatic const WarningOption OptionTable[] = {";
-  bool first = true;
-  for (OptionMap::iterator I = OM.begin(), E = OM.end(); I!=E; ++I) {
-    if (first)
-      first = false;
+    // Diagnostics in the group.
+    if (I->second.DiagsInGroup.empty())
+      OS << "0, ";
     else
-      OS << ',';
+      OS << "DiagArray" << I->second.IDNo << ", ";
     
-    OS << "\n  {\"" << getOptName(I->first)
-       << "\", DIAGS(" << I->first->getName() << ")}";
+    // Subgroups.
+    if (I->second.SubGroups.empty())
+      OS << 0;
+    else
+      OS << "DiagSubGroup" << I->second.IDNo;
+    OS << " },\n";
   }
-  OS << "\n};\n";
+  OS << "#endif // GET_DIAG_TABLE\n\n";
 }