Diagnostic.h revision cabe66811fe43835b8c5a0854552768fc53261e3
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 { 34182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner class CustomDiagInfo; 35182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner 365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// diag::kind - All of the diagnostics that can be emitted by the frontend. 375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer enum kind { 385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#define DIAG(ENUM,FLAGS,DESC) ENUM, 395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include "DiagnosticKinds.def" 400750618b0beacdc9b0a9e210a661e4746823ced7Chris Lattner NUM_BUILTIN_DIAGNOSTICS 415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Enum values that allow the client to map NOTEs, WARNINGs, and EXTENSIONs 445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to either MAP_IGNORE (nothing), MAP_WARNING (emit a warning), MAP_ERROR 455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// (emit as an error), or MAP_DEFAULT (handle the default way). 465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer enum Mapping { 475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer MAP_DEFAULT = 0, //< Do not map this diagnostic. 485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer MAP_IGNORE = 1, //< Map this diagnostic to nothing, ignore it. 495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer MAP_WARNING = 2, //< Map this diagnostic to a warning. 505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer MAP_ERROR = 3 //< Map this diagnostic to an error. 515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// Diagnostic - This concrete class is used by the front-end to report 555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// problems and issues. It massages the diagnostics (e.g. handling things like 565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// "report warnings as errors" and passes them off to the DiagnosticClient for 575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// reporting to the user. 585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass Diagnostic { 59182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattnerpublic: 60182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// Level - The level of the diagnostic, after it has been through mapping. 61182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner enum Level { 6232b939b51b3cc5e4c4d61e31a59aa902de2525b8Chris Lattner Ignored, Note, Warning, Error 63182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner }; 64182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner 653fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner enum ArgumentKind { 663fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ak_std_string, // std::string 673fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ak_c_string, // const char * 683fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ak_sint, // int 693fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ak_uint, // unsigned 703fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ak_identifierinfo, // IdentifierInfo 71011bb4edf731d529da1cbf71c7c2696aaf5a054fChris Lattner ak_qualtype, // QualType 72011bb4edf731d529da1cbf71c7c2696aaf5a054fChris Lattner ak_declarationname // DeclarationName 733fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner }; 743fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner 75182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattnerprivate: 765b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner bool IgnoreAllWarnings; // Ignore all warnings: -w 775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool WarningsAsErrors; // Treat warnings like errors: 785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool WarnOnExtensions; // Enables warnings for gcc extensions: -pedantic. 795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ErrorOnExtensions; // Error on extensions: -pedantic-errors. 802fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar bool SuppressSystemWarnings;// Suppress warnings in system headers. 81b4398aa27da4d6919c3ae448d1ae66ba6cafc048Ted Kremenek DiagnosticClient *Client; 825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// DiagMappings - Mapping information for diagnostics. Mapping info is 845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// packed into two bits per diagnostic. 850750618b0beacdc9b0a9e210a661e4746823ced7Chris Lattner unsigned char DiagMappings[(diag::NUM_BUILTIN_DIAGNOSTICS+3)/4]; 865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ErrorOccurred - This is set to true when an error is emitted, and is 885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// sticky. 895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ErrorOccurred; 905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumDiagnostics; // Number of diagnostics reported 925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumErrors; // Number of diagnostics that are errors 93182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner 94182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// CustomDiagInfo - Information for uniquing and looking up custom diags. 95182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner diag::CustomDiagInfo *CustomDiagInfo; 967bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber 973fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// ArgToStringFn - A function pointer that converts an opaque diagnostic 983fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// argument to a strings. This takes the modifiers and argument that was 993fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// present in the diagnostic. 10022caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner /// This is a hack to avoid a layering violation between libbasic and libsema. 1013fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner typedef void (*ArgToStringFnTy)(ArgumentKind Kind, intptr_t Val, 1023fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Modifier, unsigned ModifierLen, 1033fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Argument, unsigned ArgumentLen, 1043fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner llvm::SmallVectorImpl<char> &Output); 1053fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ArgToStringFnTy ArgToStringFn; 1065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 1077bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber explicit Diagnostic(DiagnosticClient *client = 0); 108182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner ~Diagnostic(); 1095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 1115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Diagnostic characterization methods, used by a client to customize how 1125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // 1132bf78fba7a37a42d4295999706053fdf4c9625e2Ted Kremenek 1147bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber DiagnosticClient *getClient() { return Client; }; 1157bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber const DiagnosticClient *getClient() const { return Client; }; 116b4398aa27da4d6919c3ae448d1ae66ba6cafc048Ted Kremenek 117b4398aa27da4d6919c3ae448d1ae66ba6cafc048Ted Kremenek void setClient(DiagnosticClient* client) { Client = client; } 1185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1195b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner /// setIgnoreAllWarnings - When set to true, any unmapped warnings are 1205b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner /// ignored. If this and WarningsAsErrors are both set, then this one wins. 1215b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner void setIgnoreAllWarnings(bool Val) { IgnoreAllWarnings = Val; } 1225b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner bool getIgnoreAllWarnings() const { return IgnoreAllWarnings; } 1235b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner 1245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setWarningsAsErrors - When set to true, any warnings reported are issued 1255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// as errors. 1265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setWarningsAsErrors(bool Val) { WarningsAsErrors = Val; } 1275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getWarningsAsErrors() const { return WarningsAsErrors; } 1285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setWarnOnExtensions - When set to true, issue warnings on GCC extensions, 1305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the equivalent of GCC's -pedantic. 1315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setWarnOnExtensions(bool Val) { WarnOnExtensions = Val; } 1325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getWarnOnExtensions() const { return WarnOnExtensions; } 1335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setErrorOnExtensions - When set to true issue errors for GCC extensions 1355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// instead of warnings. This is the equivalent to GCC's -pedantic-errors. 1365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setErrorOnExtensions(bool Val) { ErrorOnExtensions = Val; } 1375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getErrorOnExtensions() const { return ErrorOnExtensions; } 1385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1392fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar /// setSuppressSystemWarnings - When set to true mask warnings that 1402fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar /// come from system headers. 1412fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar void setSuppressSystemWarnings(bool Val) { SuppressSystemWarnings = Val; } 1422fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar bool getSuppressSystemWarnings() const { return SuppressSystemWarnings; } 1432fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar 1445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setDiagnosticMapping - This allows the client to specify that certain 1455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// warnings are ignored. Only NOTEs, WARNINGs, and EXTENSIONs can be mapped. 1465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setDiagnosticMapping(diag::kind Diag, diag::Mapping Map) { 1470750618b0beacdc9b0a9e210a661e4746823ced7Chris Lattner assert(Diag < diag::NUM_BUILTIN_DIAGNOSTICS && 1480750618b0beacdc9b0a9e210a661e4746823ced7Chris Lattner "Can only map builtin diagnostics"); 1490750618b0beacdc9b0a9e210a661e4746823ced7Chris Lattner assert(isBuiltinNoteWarningOrExtension(Diag) && "Cannot map errors!"); 1505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned char &Slot = DiagMappings[Diag/4]; 1515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned Bits = (Diag & 3)*2; 1525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Slot &= ~(3 << Bits); 1535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Slot |= Map << Bits; 1545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 1555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getDiagnosticMapping - Return the mapping currently set for the specified 1575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// diagnostic. 1585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer diag::Mapping getDiagnosticMapping(diag::kind Diag) const { 1595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return (diag::Mapping)((DiagMappings[Diag/4] >> (Diag & 3)*2) & 3); 1605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 1615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool hasErrorOccurred() const { return ErrorOccurred; } 1635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned getNumErrors() const { return NumErrors; } 1655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned getNumDiagnostics() const { return NumDiagnostics; } 1665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 167182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// getCustomDiagID - Return an ID for a diagnostic with the specified message 168182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// and level. If this is the first request for this diagnosic, it is 169182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// registered and created, otherwise the existing ID is returned. 170182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner unsigned getCustomDiagID(Level L, const char *Message); 171182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner 17222caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner 1733fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// ConvertArgToString - This method converts a diagnostic argument (as an 1743fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// intptr_t) into the string that represents it. 1753fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner void ConvertArgToString(ArgumentKind Kind, intptr_t Val, 1763fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Modifier, unsigned ModLen, 1773fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Argument, unsigned ArgLen, 1783fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner llvm::SmallVectorImpl<char> &Output) const { 1793fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ArgToStringFn(Kind, Val, Modifier, ModLen, Argument, ArgLen, Output); 18022caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 18122caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner 1823fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner void SetArgToStringFn(ArgToStringFnTy Fn) { 1833fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ArgToStringFn = Fn; 18422caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 18522caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner 1865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 1875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Diagnostic classification and reporting interfaces. 1885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // 1895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getDescription - Given a diagnostic ID, return a description of the 1915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// issue. 1920a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const char *getDescription(unsigned DiagID) const; 1935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1940750618b0beacdc9b0a9e210a661e4746823ced7Chris Lattner /// isBuiltinNoteWarningOrExtension - Return true if the unmapped diagnostic 1950750618b0beacdc9b0a9e210a661e4746823ced7Chris Lattner /// level of the specified diagnostic ID is a Note, Warning, or Extension. 1960750618b0beacdc9b0a9e210a661e4746823ced7Chris Lattner /// Note that this only works on builtin diagnostics, not custom ones. 1970750618b0beacdc9b0a9e210a661e4746823ced7Chris Lattner static bool isBuiltinNoteWarningOrExtension(unsigned DiagID); 1985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getDiagnosticLevel - Based on the way the client configured the Diagnostic 2005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// object, classify the specified diagnostic ID into a Level, consumable by 2015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the DiagnosticClient. 2025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Level getDiagnosticLevel(unsigned DiagID) const; 2035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2040a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 2055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Report - Issue the message to the client. DiagID is a member of the 2063cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// diag::kind enum. This actually returns aninstance of DiagnosticBuilder 2070a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// which emits the diagnostics (through ProcessDiag) when it is destroyed. 2083cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner inline DiagnosticBuilder Report(FullSourceLoc Pos, unsigned DiagID); 2090a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 2100a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattnerprivate: 2113cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner // This is private state used by DiagnosticBuilder. We put it here instead of 2123cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner // in DiagnosticBuilder in order to keep DiagnosticBuilder a small lightweight 2130a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // object. This implementation choice means that we can only have one 2140a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // diagnostic "in flight" at a time, but this seems to be a reasonable 2150a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // tradeoff to keep these objects small. Assertions verify that only one 2160a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // diagnostic is in flight at a time. 2173cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner friend class DiagnosticBuilder; 2180a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner friend class DiagnosticInfo; 219b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner 220b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner /// CurDiagLoc - This is the location of the current diagnostic that is in 221b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner /// flight. 222b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner FullSourceLoc CurDiagLoc; 2230a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 224b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner /// CurDiagID - This is the ID of the current diagnostic that is in flight. 2253cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// This is set to ~0U when there is no diagnostic in flight. 226b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner unsigned CurDiagID; 227b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner 22873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner enum { 22973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// MaxArguments - The maximum number of arguments we can hold. We currently 23073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// only support up to 10 arguments (%0-%9). A single diagnostic with more 23173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// than that almost certainly has to be simplified anyway. 23273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner MaxArguments = 10 23373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner }; 23473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 2353cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// NumDiagArgs - This contains the number of entries in Arguments. 236730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner signed char NumDiagArgs; 237730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner /// NumRanges - This is the number of ranges in the DiagRanges array. 238730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner unsigned char NumDiagRanges; 239730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner 24073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsKind - This is an array of ArgumentKind::ArgumentKind enum 24173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// values, with one for each argument. This specifies whether the argument 24273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// is in DiagArgumentsStr or in DiagArguments. 24373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner unsigned char DiagArgumentsKind[MaxArguments]; 24473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 24573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsStr - This holds the values of each string argument for the 24673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// current diagnostic. This value is only used when the corresponding 24773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// ArgumentKind is ak_std_string. 24873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner std::string DiagArgumentsStr[MaxArguments]; 24973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 25073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsVal - The values for the various substitution positions. This 25173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// is used when the argument is not an std::string. The specific value is 25273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// mangled into an intptr_t and the intepretation depends on exactly what 25373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// sort of argument kind it is. 25473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner intptr_t DiagArgumentsVal[MaxArguments]; 25573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 2560a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// DiagRanges - The list of ranges added to this diagnostic. It currently 2570a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// only support 10 ranges, could easily be extended if needed. 2580a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const SourceRange *DiagRanges[10]; 2590a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 2600a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// ProcessDiag - This is the method used to report a diagnostic that is 2610a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// finally fully formed. 2623cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void ProcessDiag(); 2633cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}; 2643cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 2653cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 2663cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner// DiagnosticBuilder 2673cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 2683cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 2693cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// DiagnosticBuilder - This is a little helper class used to produce 2703cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// diagnostics. This is constructed by the Diagnostic::Report method, and 2713cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// allows insertion of extra information (arguments and source ranges) into the 2723cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// currently "in flight" diagnostic. When the temporary for the builder is 2733cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// destroyed, the diagnostic is issued. 2743cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// 2753cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// Note that many of these will be created as temporary objects (many call 2763cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// sites), so we want them to be small and we never want their address taken. 2773cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// This ensures that compilers with somewhat reasonable optimizers will promote 2783cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// the common fields to registers, eliminating increments of the NumArgs field, 2793cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// for example. 2803cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerclass DiagnosticBuilder { 2813cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner mutable Diagnostic *DiagObj; 2823cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner mutable unsigned NumArgs, NumRanges; 28373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 2843cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void operator=(const DiagnosticBuilder&); // DO NOT IMPLEMENT 2853cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner friend class Diagnostic; 2863cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner explicit DiagnosticBuilder(Diagnostic *diagObj) 2873cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner : DiagObj(diagObj), NumArgs(0), NumRanges(0) {} 2883cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerpublic: 2890a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 2900a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// Copy constructor. When copied, this "takes" the diagnostic info from the 2910a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// input and neuters it. 2923cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagnosticBuilder(const DiagnosticBuilder &D) { 2930a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner DiagObj = D.DiagObj; 2940a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner D.DiagObj = 0; 2950a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 2960a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 2970a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// Destructor - The dtor emits the diagnostic. 2983cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner ~DiagnosticBuilder() { 2990a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // If DiagObj is null, then its soul was stolen by the copy ctor. 3003cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner if (DiagObj == 0) return; 30122caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner 30222caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner // When destroyed, the ~DiagnosticBuilder sets the final argument count into 30322caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner // the Diagnostic object. 3043cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->NumDiagArgs = NumArgs; 3053cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->NumDiagRanges = NumRanges; 3063cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 30722caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner // Process the diagnostic, sending the accumulated information to the 30822caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner // DiagnosticClient. 3093cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->ProcessDiag(); 3100a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 3110a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // This diagnostic is no longer in flight. 3123cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->CurDiagID = ~0U; 3133cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner } 3143cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 3153cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// Operator bool: conversion of DiagnosticBuilder to bool always returns 3163cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// true. This allows is to be used in boolean error contexts like: 3173cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// return Diag(...); 3183cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner operator bool() const { return true; } 3193cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 3203cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void AddString(const std::string &S) const { 3213cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(NumArgs < Diagnostic::MaxArguments && 3223cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 3233cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->DiagArgumentsKind[NumArgs] = Diagnostic::ak_std_string; 3243cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->DiagArgumentsStr[NumArgs++] = S; 3253cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner } 3263cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 3273cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void AddTaggedVal(intptr_t V, Diagnostic::ArgumentKind Kind) const { 3283cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(NumArgs < Diagnostic::MaxArguments && 3293cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 3303cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->DiagArgumentsKind[NumArgs] = Kind; 3313cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->DiagArgumentsVal[NumArgs++] = V; 3320a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 3330a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 3343cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void AddSourceRange(const SourceRange &R) const { 3353cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(NumRanges < 3363cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner sizeof(DiagObj->DiagRanges)/sizeof(DiagObj->DiagRanges[0]) && 3373cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 3383cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->DiagRanges[NumRanges++] = &R; 3393cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner } 3403cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}; 3413cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 3423cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 3433cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const std::string &S) { 3443cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddString(S); 3453cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 3463cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 3473cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 3483cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 3493cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const char *Str) { 3503cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(reinterpret_cast<intptr_t>(Str), 3513cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner Diagnostic::ak_c_string); 3523cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 3533cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 3543cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 3553cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, int I) { 3563cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(I, Diagnostic::ak_sint); 3573cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 3583cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 3593cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 3603bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidisinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,bool I) { 3613bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis DB.AddTaggedVal(I, Diagnostic::ak_sint); 3623bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis return DB; 3633bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis} 3643bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis 3653cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 3663cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner unsigned I) { 3673cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(I, Diagnostic::ak_uint); 3683cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 3693cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 3703cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 3713cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 3723cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const IdentifierInfo *II) { 3733cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(reinterpret_cast<intptr_t>(II), 3743cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner Diagnostic::ak_identifierinfo); 3753cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 3763cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 3773cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 3783cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 3793cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const SourceRange &R) { 3803cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddSourceRange(R); 3813cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 3823cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 3833cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 3843cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 3853cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// Report - Issue the message to the client. DiagID is a member of the 3863cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// diag::kind enum. This actually returns a new instance of DiagnosticBuilder 3873cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// which emits the diagnostics (through ProcessDiag) when it is destroyed. 3883cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline DiagnosticBuilder Diagnostic::Report(FullSourceLoc Loc, unsigned DiagID){ 3893cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(CurDiagID == ~0U && "Multiple diagnostics in flight at once!"); 3903cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner CurDiagLoc = Loc; 3913cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner CurDiagID = DiagID; 3923cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DiagnosticBuilder(this); 3933cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 3943cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 3953cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 3963cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner// DiagnosticInfo 3973cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 3983cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 3993cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// DiagnosticInfo - This is a little helper class (which is basically a smart 4003cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// pointer that forward info from Diagnostic) that allows clients ot enquire 4013cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// about the currently in-flight diagnostic. 4023cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerclass DiagnosticInfo { 4033cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const Diagnostic *DiagObj; 4043cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerpublic: 4053cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner explicit DiagnosticInfo(const Diagnostic *DO) : DiagObj(DO) {} 4063cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 4070a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const Diagnostic *getDiags() const { return DiagObj; } 408b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner unsigned getID() const { return DiagObj->CurDiagID; } 409b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner const FullSourceLoc &getLocation() const { return DiagObj->CurDiagLoc; } 41095d1ba492c3191f49392e53acbf878e39fc8ba0aChris Lattner 4110a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned getNumArgs() const { return DiagObj->NumDiagArgs; } 4120a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 41373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgKind - Return the kind of the specified index. Based on the kind 41473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// of argument, the accessors below can be used to get the value. 4153cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner Diagnostic::ArgumentKind getArgKind(unsigned Idx) const { 4163cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(Idx < getNumArgs() && "Argument index out of range!"); 4173cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return (Diagnostic::ArgumentKind)DiagObj->DiagArgumentsKind[Idx]; 41873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner } 41973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 42073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgStdStr - Return the provided argument string specified by Idx. 42173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner const std::string &getArgStdStr(unsigned Idx) const { 4223cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_std_string && 4233cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 42473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner return DiagObj->DiagArgumentsStr[Idx]; 42573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner } 4263cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 42773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgCStr - Return the specified C string argument. 42873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner const char *getArgCStr(unsigned Idx) const { 4293cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_c_string && 4303cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 43173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner return reinterpret_cast<const char*>(DiagObj->DiagArgumentsVal[Idx]); 4320a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 4330a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 43430bc96544346bea42921cf6837e66cef80d664b4Chris Lattner /// getArgSInt - Return the specified signed integer argument. 43530bc96544346bea42921cf6837e66cef80d664b4Chris Lattner int getArgSInt(unsigned Idx) const { 4363cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_sint && 4373cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 43830bc96544346bea42921cf6837e66cef80d664b4Chris Lattner return (int)DiagObj->DiagArgumentsVal[Idx]; 43930bc96544346bea42921cf6837e66cef80d664b4Chris Lattner } 4403cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 44130bc96544346bea42921cf6837e66cef80d664b4Chris Lattner /// getArgUInt - Return the specified unsigned integer argument. 44230bc96544346bea42921cf6837e66cef80d664b4Chris Lattner unsigned getArgUInt(unsigned Idx) const { 4433cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_uint && 4443cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 44530bc96544346bea42921cf6837e66cef80d664b4Chris Lattner return (unsigned)DiagObj->DiagArgumentsVal[Idx]; 44630bc96544346bea42921cf6837e66cef80d664b4Chris Lattner } 44730bc96544346bea42921cf6837e66cef80d664b4Chris Lattner 44843b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner /// getArgIdentifier - Return the specified IdentifierInfo argument. 44943b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner const IdentifierInfo *getArgIdentifier(unsigned Idx) const { 4503cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_identifierinfo && 4513cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 4529634379265855f1628190e926d9aaf1fb4a5d90eChris Lattner return reinterpret_cast<IdentifierInfo*>(DiagObj->DiagArgumentsVal[Idx]); 45343b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner } 45443b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner 45522caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner /// getRawArg - Return the specified non-string argument in an opaque form. 45622caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner intptr_t getRawArg(unsigned Idx) const { 45722caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner assert(getArgKind(Idx) != Diagnostic::ak_std_string && 45822caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner "invalid argument accessor!"); 45922caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner return DiagObj->DiagArgumentsVal[Idx]; 46022caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 46122caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner 46222caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner 4630a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// getNumRanges - Return the number of source ranges associated with this 4640a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// diagnostic. 4650a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned getNumRanges() const { 4660a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner return DiagObj->NumDiagRanges; 4670a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 4680a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 4690a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const SourceRange &getRange(unsigned Idx) const { 4700a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner assert(Idx < DiagObj->NumDiagRanges && "Invalid diagnostic range index!"); 4710a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner return *DiagObj->DiagRanges[Idx]; 4720a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 473520987fc4e5e60c80bcce613b0f8813ffb2fdca0Chris Lattner 4740a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 475f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// FormatDiagnostic - Format this diagnostic into a string, substituting the 476f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// formal arguments into the %0 slots. The result is appended onto the Str 477f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// array. 478f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner void FormatDiagnostic(llvm::SmallVectorImpl<char> &OutStr) const; 4795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 4800a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 4810a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 4825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// DiagnosticClient - This is an abstract interface implemented by clients of 4835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// the front-end, which formats and prints fully processed diagnostics. 4845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass DiagnosticClient { 4855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 4865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer virtual ~DiagnosticClient(); 487cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek 488cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek /// IncludeInDiagnosticCounts - This method (whose default implementation 489cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek /// returns true) indicates whether the diagnostics handled by this 490cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek /// DiagnosticClient should be included in the number of diagnostics 491cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek /// reported by Diagnostic. 492cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek virtual bool IncludeInDiagnosticCounts() const; 4935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleDiagnostic - Handle this diagnostic, reporting it to the user or 4955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// capturing it to a log as needed. 4960a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner virtual void HandleDiagnostic(Diagnostic::Level DiagLevel, 4970a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const DiagnosticInfo &Info) = 0; 4985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 4995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 5005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 5015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 5025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 503