Diagnostic.h revision f5d2328fc849288c3a62e43d065685f516d57091
15f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===--- Diagnostic.h - C Language Family Diagnostic Handling ---*- C++ -*-===// 25f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 35f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// The LLVM Compiler Infrastructure 45f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 50bc735ffcfb223c0186419547abaa5c84482663eChris Lattner// This file is distributed under the University of Illinois Open Source 60bc735ffcfb223c0186419547abaa5c84482663eChris Lattner// License. See LICENSE.TXT for details. 75f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 85f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===----------------------------------------------------------------------===// 95f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// This file defines the Diagnostic-related interfaces. 115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===----------------------------------------------------------------------===// 135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#ifndef LLVM_CLANG_DIAGNOSTIC_H 155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#define LLVM_CLANG_DIAGNOSTIC_H 165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 172eefd8657c233bc7c9330acfe475fc270bbe7cabTed Kremenek#include "clang/Basic/SourceLocation.h" 185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include <string> 19f86638365f4801ec2d2970f7c0663e94590618b8Chris Lattner#include <cassert> 205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 21f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattnernamespace llvm { 22f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner template <typename T> class SmallVectorImpl; 23f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner} 24f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner 255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang { 265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer class DiagnosticClient; 275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer class SourceRange; 287a9d49fd2bfac00e905b361ba76d26ab5b6c3b09Ted Kremenek class SourceManager; 293cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner class DiagnosticBuilder; 3043b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner class IdentifierInfo; 315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Import the diagnostic enums themselves. 335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer namespace diag { 3419e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner // Start position for diagnostics. 3519e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner enum { 3619e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_START_LEX = 300, 3719e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_START_PARSE = DIAG_START_LEX + 300, 3819e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_START_AST = DIAG_START_PARSE + 300, 3919e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_START_SEMA = DIAG_START_AST + 100, 4019e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_START_ANALYSIS = DIAG_START_SEMA + 1000, 4119e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_UPPER_LIMIT = DIAG_START_ANALYSIS + 100 4219e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner }; 4319e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner 44182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner class CustomDiagInfo; 45182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner 465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// diag::kind - All of the diagnostics that can be emitted by the frontend. 4720c6b3b85e186cd52d5d99489132d71d498159ebChris Lattner typedef unsigned kind; 4820c6b3b85e186cd52d5d99489132d71d498159ebChris Lattner 4988eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner // Get typedefs for common diagnostics. 5088eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner enum { 5188eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner#define DIAG(ENUM,FLAGS,DESC) ENUM, 5288eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner#include "clang/Basic/DiagnosticCommonKinds.def" 5388eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner NUM_BUILTIN_COMMON_DIAGNOSTICS 5488eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner#undef DIAG 5588eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner }; 5688eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner 575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Enum values that allow the client to map NOTEs, WARNINGs, and EXTENSIONs 585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to either MAP_IGNORE (nothing), MAP_WARNING (emit a warning), MAP_ERROR 59da0cbc1ad4a553c4de111c1181ec7b42c5ddefceChris Lattner /// (emit as an error), or MAP_DEFAULT (handle the default way). It allows 60da0cbc1ad4a553c4de111c1181ec7b42c5ddefceChris Lattner /// clients to map errors to MAP_ERROR/MAP_DEFAULT or MAP_FATAL (stop 61da0cbc1ad4a553c4de111c1181ec7b42c5ddefceChris Lattner /// emitting diagnostics after this one). 625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer enum Mapping { 635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer MAP_DEFAULT = 0, //< Do not map this diagnostic. 645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer MAP_IGNORE = 1, //< Map this diagnostic to nothing, ignore it. 655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer MAP_WARNING = 2, //< Map this diagnostic to a warning. 66da0cbc1ad4a553c4de111c1181ec7b42c5ddefceChris Lattner MAP_ERROR = 3, //< Map this diagnostic to an error. 67da0cbc1ad4a553c4de111c1181ec7b42c5ddefceChris Lattner MAP_FATAL = 4 //< Map this diagnostic to a fatal error. 685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// Diagnostic - This concrete class is used by the front-end to report 725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// problems and issues. It massages the diagnostics (e.g. handling things like 735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// "report warnings as errors" and passes them off to the DiagnosticClient for 745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// reporting to the user. 755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass Diagnostic { 76182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattnerpublic: 77182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// Level - The level of the diagnostic, after it has been through mapping. 78182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner enum Level { 79da0cbc1ad4a553c4de111c1181ec7b42c5ddefceChris Lattner Ignored, Note, Warning, Error, Fatal 80182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner }; 81182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner 823fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner enum ArgumentKind { 8347b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_std_string, // std::string 8447b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_c_string, // const char * 8547b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_sint, // int 8647b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_uint, // unsigned 8747b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_identifierinfo, // IdentifierInfo 8847b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_qualtype, // QualType 8947b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_declarationname, // DeclarationName 9047b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_nameddecl // NamedDecl * 913fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner }; 923fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner 93182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattnerprivate: 945b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner bool IgnoreAllWarnings; // Ignore all warnings: -w 955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool WarningsAsErrors; // Treat warnings like errors: 965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool WarnOnExtensions; // Enables warnings for gcc extensions: -pedantic. 975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ErrorOnExtensions; // Error on extensions: -pedantic-errors. 982fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar bool SuppressSystemWarnings;// Suppress warnings in system headers. 99b4398aa27da4d6919c3ae448d1ae66ba6cafc048Ted Kremenek DiagnosticClient *Client; 1005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// DiagMappings - Mapping information for diagnostics. Mapping info is 102da0cbc1ad4a553c4de111c1181ec7b42c5ddefceChris Lattner /// packed into four bits per diagnostic. 103da0cbc1ad4a553c4de111c1181ec7b42c5ddefceChris Lattner unsigned char DiagMappings[diag::DIAG_UPPER_LIMIT/2]; 1045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 10515221422eda7bac679e38b07512feda49715ef66Chris Lattner /// ErrorOccurred / FatalErrorOccurred - This is set to true when an error or 10615221422eda7bac679e38b07512feda49715ef66Chris Lattner /// fatal error is emitted, and is sticky. 1075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ErrorOccurred; 10815221422eda7bac679e38b07512feda49715ef66Chris Lattner bool FatalErrorOccurred; 109f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner 110f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// LastDiagLevel - This is the level of the last diagnostic emitted. This is 111f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// used to emit continuation diagnostics with the same level as the 112f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// diagnostic that they follow. 113f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner Diagnostic::Level LastDiagLevel; 1145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumDiagnostics; // Number of diagnostics reported 1165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumErrors; // Number of diagnostics that are errors 117182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner 118182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// CustomDiagInfo - Information for uniquing and looking up custom diags. 119182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner diag::CustomDiagInfo *CustomDiagInfo; 1207bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber 1213fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// ArgToStringFn - A function pointer that converts an opaque diagnostic 1223fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// argument to a strings. This takes the modifiers and argument that was 1233fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// present in the diagnostic. 12422caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner /// This is a hack to avoid a layering violation between libbasic and libsema. 1253fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner typedef void (*ArgToStringFnTy)(ArgumentKind Kind, intptr_t Val, 1263fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Modifier, unsigned ModifierLen, 1273fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Argument, unsigned ArgumentLen, 1283fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner llvm::SmallVectorImpl<char> &Output); 1293fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ArgToStringFnTy ArgToStringFn; 1305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 1317bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber explicit Diagnostic(DiagnosticClient *client = 0); 132182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner ~Diagnostic(); 1335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 1355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Diagnostic characterization methods, used by a client to customize how 1365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // 1372bf78fba7a37a42d4295999706053fdf4c9625e2Ted Kremenek 1387bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber DiagnosticClient *getClient() { return Client; }; 1397bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber const DiagnosticClient *getClient() const { return Client; }; 140b4398aa27da4d6919c3ae448d1ae66ba6cafc048Ted Kremenek 141b4398aa27da4d6919c3ae448d1ae66ba6cafc048Ted Kremenek void setClient(DiagnosticClient* client) { Client = client; } 1425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1435b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner /// setIgnoreAllWarnings - When set to true, any unmapped warnings are 1445b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner /// ignored. If this and WarningsAsErrors are both set, then this one wins. 1455b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner void setIgnoreAllWarnings(bool Val) { IgnoreAllWarnings = Val; } 1465b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner bool getIgnoreAllWarnings() const { return IgnoreAllWarnings; } 1475b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner 1485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setWarningsAsErrors - When set to true, any warnings reported are issued 1495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// as errors. 1505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setWarningsAsErrors(bool Val) { WarningsAsErrors = Val; } 1515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getWarningsAsErrors() const { return WarningsAsErrors; } 1525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setWarnOnExtensions - When set to true, issue warnings on GCC extensions, 1545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the equivalent of GCC's -pedantic. 1555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setWarnOnExtensions(bool Val) { WarnOnExtensions = Val; } 1565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getWarnOnExtensions() const { return WarnOnExtensions; } 1575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setErrorOnExtensions - When set to true issue errors for GCC extensions 1595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// instead of warnings. This is the equivalent to GCC's -pedantic-errors. 1605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setErrorOnExtensions(bool Val) { ErrorOnExtensions = Val; } 1615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getErrorOnExtensions() const { return ErrorOnExtensions; } 1625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1632fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar /// setSuppressSystemWarnings - When set to true mask warnings that 1642fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar /// come from system headers. 1652fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar void setSuppressSystemWarnings(bool Val) { SuppressSystemWarnings = Val; } 1662fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar bool getSuppressSystemWarnings() const { return SuppressSystemWarnings; } 1672fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar 1685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setDiagnosticMapping - This allows the client to specify that certain 169f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// warnings are ignored. Only WARNINGs and EXTENSIONs can be mapped. 1705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setDiagnosticMapping(diag::kind Diag, diag::Mapping Map) { 17119e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner assert(Diag < diag::DIAG_UPPER_LIMIT && 1720750618b0beacdc9b0a9e210a661e4746823ced7Chris Lattner "Can only map builtin diagnostics"); 173f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner assert((isBuiltinWarningOrExtension(Diag) || Map == diag::MAP_FATAL) && 1747fc24e2d47e1cdf03e655ed212d282635d755591Chris Lattner "Cannot map errors!"); 175da0cbc1ad4a553c4de111c1181ec7b42c5ddefceChris Lattner unsigned char &Slot = DiagMappings[Diag/2]; 176da0cbc1ad4a553c4de111c1181ec7b42c5ddefceChris Lattner unsigned Bits = (Diag & 1)*4; 177da0cbc1ad4a553c4de111c1181ec7b42c5ddefceChris Lattner Slot &= ~(7 << Bits); 1785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Slot |= Map << Bits; 1795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 1805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getDiagnosticMapping - Return the mapping currently set for the specified 1825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// diagnostic. 1835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer diag::Mapping getDiagnosticMapping(diag::kind Diag) const { 184da0cbc1ad4a553c4de111c1181ec7b42c5ddefceChris Lattner return (diag::Mapping)((DiagMappings[Diag/2] >> (Diag & 1)*4) & 7); 1855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 1865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool hasErrorOccurred() const { return ErrorOccurred; } 18815221422eda7bac679e38b07512feda49715ef66Chris Lattner bool hasFatalErrorOccurred() const { return FatalErrorOccurred; } 1895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned getNumErrors() const { return NumErrors; } 1915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned getNumDiagnostics() const { return NumDiagnostics; } 1925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 193182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// getCustomDiagID - Return an ID for a diagnostic with the specified message 194182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// and level. If this is the first request for this diagnosic, it is 195182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// registered and created, otherwise the existing ID is returned. 196182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner unsigned getCustomDiagID(Level L, const char *Message); 197182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner 19822caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner 1993fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// ConvertArgToString - This method converts a diagnostic argument (as an 2003fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// intptr_t) into the string that represents it. 2013fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner void ConvertArgToString(ArgumentKind Kind, intptr_t Val, 2023fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Modifier, unsigned ModLen, 2033fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Argument, unsigned ArgLen, 2043fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner llvm::SmallVectorImpl<char> &Output) const { 2053fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ArgToStringFn(Kind, Val, Modifier, ModLen, Argument, ArgLen, Output); 20622caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 20722caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner 2083fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner void SetArgToStringFn(ArgToStringFnTy Fn) { 2093fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ArgToStringFn = Fn; 21022caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 21122caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner 2125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 2135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Diagnostic classification and reporting interfaces. 2145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // 2155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getDescription - Given a diagnostic ID, return a description of the 2175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// issue. 2180a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const char *getDescription(unsigned DiagID) const; 2195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 220f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// isNoteWarningOrExtension - Return true if the unmapped diagnostic 221f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// level of the specified diagnostic ID is a Warning or Extension. 222f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// This only works on builtin diagnostics, not custom ones, and is not legal to 223f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// call on NOTEs. 224f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner static bool isBuiltinWarningOrExtension(unsigned DiagID); 2255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getDiagnosticLevel - Based on the way the client configured the Diagnostic 2275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// object, classify the specified diagnostic ID into a Level, consumable by 2285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the DiagnosticClient. 229f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner Level getDiagnosticLevel(unsigned DiagID) const; 2300a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 231509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// Report - Issue the message to the client. @c DiagID is a member of the 232509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// @c diag::kind enum. This actually returns aninstance of DiagnosticBuilder 233509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// which emits the diagnostics (through @c ProcessDiag) when it is destroyed. 234509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// @c Pos represents the source location associated with the diagnostic, 235509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// which can be an invalid location if no position information is available. 2363cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner inline DiagnosticBuilder Report(FullSourceLoc Pos, unsigned DiagID); 2370a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 2380a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattnerprivate: 239f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// getDiagnosticLevel - This is an internal implementation helper used when 240f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// DiagClass is already known. 241f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner Level getDiagnosticLevel(unsigned DiagID, unsigned DiagClass) const; 242f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner 2433cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner // This is private state used by DiagnosticBuilder. We put it here instead of 2443cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner // in DiagnosticBuilder in order to keep DiagnosticBuilder a small lightweight 2450a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // object. This implementation choice means that we can only have one 2460a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // diagnostic "in flight" at a time, but this seems to be a reasonable 2470a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // tradeoff to keep these objects small. Assertions verify that only one 2480a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // diagnostic is in flight at a time. 2493cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner friend class DiagnosticBuilder; 2500a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner friend class DiagnosticInfo; 251b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner 252b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner /// CurDiagLoc - This is the location of the current diagnostic that is in 253b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner /// flight. 254b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner FullSourceLoc CurDiagLoc; 2550a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 256b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner /// CurDiagID - This is the ID of the current diagnostic that is in flight. 2573cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// This is set to ~0U when there is no diagnostic in flight. 258b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner unsigned CurDiagID; 259b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner 26073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner enum { 26173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// MaxArguments - The maximum number of arguments we can hold. We currently 26273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// only support up to 10 arguments (%0-%9). A single diagnostic with more 26373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// than that almost certainly has to be simplified anyway. 26473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner MaxArguments = 10 26573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner }; 26673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 2673cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// NumDiagArgs - This contains the number of entries in Arguments. 268730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner signed char NumDiagArgs; 269730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner /// NumRanges - This is the number of ranges in the DiagRanges array. 270730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner unsigned char NumDiagRanges; 271730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner 27273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsKind - This is an array of ArgumentKind::ArgumentKind enum 27373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// values, with one for each argument. This specifies whether the argument 27473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// is in DiagArgumentsStr or in DiagArguments. 27573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner unsigned char DiagArgumentsKind[MaxArguments]; 27673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 27773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsStr - This holds the values of each string argument for the 27873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// current diagnostic. This value is only used when the corresponding 27973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// ArgumentKind is ak_std_string. 28073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner std::string DiagArgumentsStr[MaxArguments]; 28173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 28273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsVal - The values for the various substitution positions. This 28373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// is used when the argument is not an std::string. The specific value is 28473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// mangled into an intptr_t and the intepretation depends on exactly what 28573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// sort of argument kind it is. 28673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner intptr_t DiagArgumentsVal[MaxArguments]; 28773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 2880a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// DiagRanges - The list of ranges added to this diagnostic. It currently 2890a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// only support 10 ranges, could easily be extended if needed. 2900a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const SourceRange *DiagRanges[10]; 2910a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 2920a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// ProcessDiag - This is the method used to report a diagnostic that is 2930a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// finally fully formed. 2943cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void ProcessDiag(); 2953cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}; 2963cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 2973cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 2983cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner// DiagnosticBuilder 2993cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 3003cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 3013cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// DiagnosticBuilder - This is a little helper class used to produce 3023cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// diagnostics. This is constructed by the Diagnostic::Report method, and 3033cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// allows insertion of extra information (arguments and source ranges) into the 3043cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// currently "in flight" diagnostic. When the temporary for the builder is 3053cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// destroyed, the diagnostic is issued. 3063cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// 3073cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// Note that many of these will be created as temporary objects (many call 3083cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// sites), so we want them to be small and we never want their address taken. 3093cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// This ensures that compilers with somewhat reasonable optimizers will promote 3103cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// the common fields to registers, eliminating increments of the NumArgs field, 3113cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// for example. 3123cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerclass DiagnosticBuilder { 3133cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner mutable Diagnostic *DiagObj; 3143cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner mutable unsigned NumArgs, NumRanges; 31573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 3163cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void operator=(const DiagnosticBuilder&); // DO NOT IMPLEMENT 3173cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner friend class Diagnostic; 3183cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner explicit DiagnosticBuilder(Diagnostic *diagObj) 3193cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner : DiagObj(diagObj), NumArgs(0), NumRanges(0) {} 3203cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerpublic: 3210a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 3220a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// Copy constructor. When copied, this "takes" the diagnostic info from the 3230a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// input and neuters it. 3243cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagnosticBuilder(const DiagnosticBuilder &D) { 3250a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner DiagObj = D.DiagObj; 3260a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner D.DiagObj = 0; 3270a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 3280a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 3290a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// Destructor - The dtor emits the diagnostic. 3303cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner ~DiagnosticBuilder() { 3310a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // If DiagObj is null, then its soul was stolen by the copy ctor. 3323cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner if (DiagObj == 0) return; 33322caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner 33422caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner // When destroyed, the ~DiagnosticBuilder sets the final argument count into 33522caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner // the Diagnostic object. 3363cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->NumDiagArgs = NumArgs; 3373cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->NumDiagRanges = NumRanges; 3383cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 33922caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner // Process the diagnostic, sending the accumulated information to the 34022caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner // DiagnosticClient. 3413cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->ProcessDiag(); 3420a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 3430a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // This diagnostic is no longer in flight. 3443cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->CurDiagID = ~0U; 3453cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner } 3463cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 3473cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// Operator bool: conversion of DiagnosticBuilder to bool always returns 3483cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// true. This allows is to be used in boolean error contexts like: 3493cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// return Diag(...); 3503cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner operator bool() const { return true; } 3513cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 3523cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void AddString(const std::string &S) const { 3533cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(NumArgs < Diagnostic::MaxArguments && 3543cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 3553cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->DiagArgumentsKind[NumArgs] = Diagnostic::ak_std_string; 3563cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->DiagArgumentsStr[NumArgs++] = S; 3573cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner } 3583cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 3593cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void AddTaggedVal(intptr_t V, Diagnostic::ArgumentKind Kind) const { 3603cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(NumArgs < Diagnostic::MaxArguments && 3613cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 3623cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->DiagArgumentsKind[NumArgs] = Kind; 3633cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->DiagArgumentsVal[NumArgs++] = V; 3640a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 3650a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 3663cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void AddSourceRange(const SourceRange &R) const { 3673cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(NumRanges < 3683cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner sizeof(DiagObj->DiagRanges)/sizeof(DiagObj->DiagRanges[0]) && 3693cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 3703cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->DiagRanges[NumRanges++] = &R; 3713cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner } 3723cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}; 3733cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 3743cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 3753cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const std::string &S) { 3763cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddString(S); 3773cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 3783cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 3793cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 3803cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 3813cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const char *Str) { 3823cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(reinterpret_cast<intptr_t>(Str), 3833cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner Diagnostic::ak_c_string); 3843cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 3853cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 3863cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 3873cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, int I) { 3883cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(I, Diagnostic::ak_sint); 3893cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 3903cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 3913cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 3923bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidisinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,bool I) { 3933bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis DB.AddTaggedVal(I, Diagnostic::ak_sint); 3943bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis return DB; 3953bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis} 3963bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis 3973cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 3983cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner unsigned I) { 3993cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(I, Diagnostic::ak_uint); 4003cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 4013cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 4023cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 4033cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 4043cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const IdentifierInfo *II) { 4053cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(reinterpret_cast<intptr_t>(II), 4063cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner Diagnostic::ak_identifierinfo); 4073cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 4083cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 4093cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 4103cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 4113cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const SourceRange &R) { 4123cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddSourceRange(R); 4133cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 4143cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 4153cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 4163cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 4173cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// Report - Issue the message to the client. DiagID is a member of the 4183cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// diag::kind enum. This actually returns a new instance of DiagnosticBuilder 4193cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// which emits the diagnostics (through ProcessDiag) when it is destroyed. 4203cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline DiagnosticBuilder Diagnostic::Report(FullSourceLoc Loc, unsigned DiagID){ 4213cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(CurDiagID == ~0U && "Multiple diagnostics in flight at once!"); 4223cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner CurDiagLoc = Loc; 4233cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner CurDiagID = DiagID; 4243cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DiagnosticBuilder(this); 4253cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 4263cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 4273cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 4283cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner// DiagnosticInfo 4293cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 4303cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 4313cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// DiagnosticInfo - This is a little helper class (which is basically a smart 4323cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// pointer that forward info from Diagnostic) that allows clients ot enquire 4333cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// about the currently in-flight diagnostic. 4343cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerclass DiagnosticInfo { 4353cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const Diagnostic *DiagObj; 4363cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerpublic: 4373cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner explicit DiagnosticInfo(const Diagnostic *DO) : DiagObj(DO) {} 4383cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 4390a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const Diagnostic *getDiags() const { return DiagObj; } 440b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner unsigned getID() const { return DiagObj->CurDiagID; } 441b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner const FullSourceLoc &getLocation() const { return DiagObj->CurDiagLoc; } 44295d1ba492c3191f49392e53acbf878e39fc8ba0aChris Lattner 4430a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned getNumArgs() const { return DiagObj->NumDiagArgs; } 4440a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 44573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgKind - Return the kind of the specified index. Based on the kind 44673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// of argument, the accessors below can be used to get the value. 4473cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner Diagnostic::ArgumentKind getArgKind(unsigned Idx) const { 4483cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(Idx < getNumArgs() && "Argument index out of range!"); 4493cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return (Diagnostic::ArgumentKind)DiagObj->DiagArgumentsKind[Idx]; 45073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner } 45173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 45273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgStdStr - Return the provided argument string specified by Idx. 45373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner const std::string &getArgStdStr(unsigned Idx) const { 4543cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_std_string && 4553cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 45673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner return DiagObj->DiagArgumentsStr[Idx]; 45773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner } 4583cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 45973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgCStr - Return the specified C string argument. 46073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner const char *getArgCStr(unsigned Idx) const { 4613cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_c_string && 4623cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 46373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner return reinterpret_cast<const char*>(DiagObj->DiagArgumentsVal[Idx]); 4640a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 4650a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 46630bc96544346bea42921cf6837e66cef80d664b4Chris Lattner /// getArgSInt - Return the specified signed integer argument. 46730bc96544346bea42921cf6837e66cef80d664b4Chris Lattner int getArgSInt(unsigned Idx) const { 4683cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_sint && 4693cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 47030bc96544346bea42921cf6837e66cef80d664b4Chris Lattner return (int)DiagObj->DiagArgumentsVal[Idx]; 47130bc96544346bea42921cf6837e66cef80d664b4Chris Lattner } 4723cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 47330bc96544346bea42921cf6837e66cef80d664b4Chris Lattner /// getArgUInt - Return the specified unsigned integer argument. 47430bc96544346bea42921cf6837e66cef80d664b4Chris Lattner unsigned getArgUInt(unsigned Idx) const { 4753cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_uint && 4763cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 47730bc96544346bea42921cf6837e66cef80d664b4Chris Lattner return (unsigned)DiagObj->DiagArgumentsVal[Idx]; 47830bc96544346bea42921cf6837e66cef80d664b4Chris Lattner } 47930bc96544346bea42921cf6837e66cef80d664b4Chris Lattner 48043b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner /// getArgIdentifier - Return the specified IdentifierInfo argument. 48143b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner const IdentifierInfo *getArgIdentifier(unsigned Idx) const { 4823cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_identifierinfo && 4833cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 4849634379265855f1628190e926d9aaf1fb4a5d90eChris Lattner return reinterpret_cast<IdentifierInfo*>(DiagObj->DiagArgumentsVal[Idx]); 48543b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner } 48643b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner 48722caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner /// getRawArg - Return the specified non-string argument in an opaque form. 48822caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner intptr_t getRawArg(unsigned Idx) const { 48922caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner assert(getArgKind(Idx) != Diagnostic::ak_std_string && 49022caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner "invalid argument accessor!"); 49122caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner return DiagObj->DiagArgumentsVal[Idx]; 49222caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 49322caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner 49422caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner 4950a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// getNumRanges - Return the number of source ranges associated with this 4960a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// diagnostic. 4970a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned getNumRanges() const { 4980a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner return DiagObj->NumDiagRanges; 4990a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 5000a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 5010a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const SourceRange &getRange(unsigned Idx) const { 5020a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner assert(Idx < DiagObj->NumDiagRanges && "Invalid diagnostic range index!"); 5030a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner return *DiagObj->DiagRanges[Idx]; 5040a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 505520987fc4e5e60c80bcce613b0f8813ffb2fdca0Chris Lattner 5060a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 507f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// FormatDiagnostic - Format this diagnostic into a string, substituting the 508f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// formal arguments into the %0 slots. The result is appended onto the Str 509f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// array. 510f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner void FormatDiagnostic(llvm::SmallVectorImpl<char> &OutStr) const; 5115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 5120a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 5130a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 5145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// DiagnosticClient - This is an abstract interface implemented by clients of 5155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// the front-end, which formats and prints fully processed diagnostics. 5165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass DiagnosticClient { 5175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 5185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer virtual ~DiagnosticClient(); 519cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek 520cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek /// IncludeInDiagnosticCounts - This method (whose default implementation 521cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek /// returns true) indicates whether the diagnostics handled by this 522cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek /// DiagnosticClient should be included in the number of diagnostics 523cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek /// reported by Diagnostic. 524cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek virtual bool IncludeInDiagnosticCounts() const; 5255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 5265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleDiagnostic - Handle this diagnostic, reporting it to the user or 5275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// capturing it to a log as needed. 5280a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner virtual void HandleDiagnostic(Diagnostic::Level DiagLevel, 5290a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const DiagnosticInfo &Info) = 0; 5305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 5315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 5325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 5335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 5345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 535