1 //=- ClangDiagnosticsEmitter.cpp - Generate Clang diagnostics tables -*- C++ -*-
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // These tablegen backends emit Clang diagnostics tables.
12 //===----------------------------------------------------------------------===//
14 #include "ClangDiagnosticsEmitter.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"
25 //===----------------------------------------------------------------------===//
26 // Generic routines for all Clang TableGen backends.
27 //===----------------------------------------------------------------------===//
29 typedef std::vector<Record*> RecordVector;
30 typedef std::vector<Record*> SuperClassVector;
31 typedef std::vector<RecordVal> RecordValVector;
33 static const RecordVal* findRecordVal(const Record& R, const std::string &key) {
34 const RecordValVector &Vals = R.getValues();
35 for (RecordValVector::const_iterator I=Vals.begin(), E=Vals.end(); I!=E; ++I)
36 if ((*I).getName() == key)
42 static const Record* getDiagKind(const Record* DiagClass, const Record &R) {
43 const SuperClassVector &SC = R.getSuperClasses();
44 for (SuperClassVector::const_iterator I=SC.begin(), E=SC.end(); I!=E; ++I)
45 if ((*I)->isSubClassOf(DiagClass) &&
46 (*I)->getName() != "DiagnosticControlled")
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)
55 default: OS << *I; break;
56 case '\"': OS << "\\" << *I; break;
57 case '\\': OS << "\\\\"; break;
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));
66 //===----------------------------------------------------------------------===//
67 // Warning Tables (.inc file) generation.
68 //===----------------------------------------------------------------------===//
70 static void ProcessDiag(std::ostream &OS, const Record *DiagClass,
73 const Record* DiagKind = getDiagKind(DiagClass, R);
77 OS << "DIAG(" << R.getName() << ", ";
78 EmitAllCaps(OS, DiagKind->getName());
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.");
85 EmitEscaped(OS, TextVal->getValue());
89 void ClangDiagsDefsEmitter::run(std::ostream &OS) {
90 const RecordVector &Diags = Records.getAllDerivedDefinitions("Diagnostic");
92 const Record* DiagClass = Records.getClass("Diagnostic");
93 assert(DiagClass && "No Diagnostic class defined.");
95 // Write the #if guard
96 if (!Component.empty()) {
98 EmitAllCaps(OS, Component);
100 EmitAllCaps(OS, Component);
101 OS << "START = DIAG_START_";
102 EmitAllCaps(OS, Component);
104 EmitAllCaps(OS, Component);
105 OS << "START\n#endif\n";
108 for (RecordVector::const_iterator I=Diags.begin(), E=Diags.end(); I!=E; ++I) {
109 const Record &R = **I;
110 // Filter by component.
111 if (!Component.empty() && Component != R.getValueAsString("Component"))
114 ProcessDiag(OS, DiagClass, R);
118 //===----------------------------------------------------------------------===//
119 // Warning Group Tables generation.
120 //===----------------------------------------------------------------------===//
122 static const std::string &getOptName(const Record *R) {
123 const RecordVal *V = findRecordVal(*R, "Name");
124 assert(V && "Options must have a 'Name' value.");
125 const StringInit* SV = dynamic_cast<const StringInit*>(V->getValue());
126 assert(SV && "'Name' entry must be a string.");
127 return SV->getValue();
131 struct VISIBILITY_HIDDEN CompareOptName {
132 bool operator()(const Record* A, const Record* B) const {
133 return getOptName(A) < getOptName(B);
138 typedef std::set<const Record*> DiagnosticSet;
139 typedef std::map<const Record*, DiagnosticSet, CompareOptName> OptionMap;
140 typedef llvm::DenseSet<const ListInit*> VisitedLists;
142 static void BuildGroup(DiagnosticSet& DS, VisitedLists &Visited, const Init* X);
144 static void BuildGroup(DiagnosticSet &DS, VisitedLists &Visited,
145 const ListInit* LV) {
147 // Simple hack to prevent including a list multiple times. This may be useful
148 // if one declares an Option by including a bunch of other Options that
149 // include other Options, etc.
150 if (Visited.count(LV))
155 // Iterate through the list and grab all DiagnosticControlled.
156 for (ListInit::const_iterator I = LV->begin(), E = LV->end(); I!=E; ++I)
157 BuildGroup(DS, Visited, *I);
160 static void BuildGroup(DiagnosticSet& DS, VisitedLists &Visited,
163 // If an Option includes another Option, inline the Diagnostics of the
165 if (Def->isSubClassOf("Option")) {
166 if (const RecordVal *V = findRecordVal(*Def, "Members"))
167 if (const ListInit *LV = dynamic_cast<const ListInit*>(V->getValue()))
168 BuildGroup(DS, Visited, LV);
173 if (Def->isSubClassOf("DiagnosticControlled"))
177 static void BuildGroup(DiagnosticSet& DS, VisitedLists &Visited,
180 if (const DefInit *D = dynamic_cast<const DefInit*>(X))
181 BuildGroup(DS, Visited, D->getDef());
183 // We may have some other cases here in the future.
187 void ClangOptionsEmitter::run(std::ostream &OS) {
188 // Build up a map from options to controlled diagnostics.
191 const RecordVector &Opts = Records.getAllDerivedDefinitions("Option");
192 for (RecordVector::const_iterator I=Opts.begin(), E=Opts.end(); I != E; ++I)
193 if (const RecordVal* V = findRecordVal(**I, "Members"))
194 if (const ListInit* LV = dynamic_cast<const ListInit*>(V->getValue())) {
195 VisitedLists Visited;
196 BuildGroup(OM[*I], Visited, LV);
199 // Iterate through the OptionMap and emit the declarations.
200 for (OptionMap::iterator I = OM.begin(), E = OM.end(); I!=E; ++I) {
201 // Output the option.
202 OS << "static const diag::kind " << I->first->getName() << "[] = { ";
204 DiagnosticSet &DS = I->second;
206 for (DiagnosticSet::iterator I2 = DS.begin(), E2 = DS.end(); I2!=E2; ++I2) {
212 OS << "diag::" << (*I2)->getName();
217 // Now emit the OptionTable table.
218 OS << "\nstatic const WarningOption OptionTable[] = {";
220 for (OptionMap::iterator I = OM.begin(), E = OM.end(); I!=E; ++I) {
226 OS << "\n {\"" << getOptName(I->first)
227 << "\", DIAGS(" << I->first->getName() << ")}";