Diagnostic.h revision f4c839657742b823cea1a95b18422f1ba74d3ddd
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; 290a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner class DiagnosticInfo; 305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Import the diagnostic enums themselves. 325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer namespace diag { 33182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner class CustomDiagInfo; 34182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner 355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// diag::kind - All of the diagnostics that can be emitted by the frontend. 365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer enum kind { 375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#define DIAG(ENUM,FLAGS,DESC) ENUM, 385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include "DiagnosticKinds.def" 390750618b0beacdc9b0a9e210a661e4746823ced7Chris Lattner NUM_BUILTIN_DIAGNOSTICS 405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Enum values that allow the client to map NOTEs, WARNINGs, and EXTENSIONs 435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to either MAP_IGNORE (nothing), MAP_WARNING (emit a warning), MAP_ERROR 445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// (emit as an error), or MAP_DEFAULT (handle the default way). 455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer enum Mapping { 465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer MAP_DEFAULT = 0, //< Do not map this diagnostic. 475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer MAP_IGNORE = 1, //< Map this diagnostic to nothing, ignore it. 485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer MAP_WARNING = 2, //< Map this diagnostic to a warning. 495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer MAP_ERROR = 3 //< Map this diagnostic to an error. 505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// Diagnostic - This concrete class is used by the front-end to report 545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// problems and issues. It massages the diagnostics (e.g. handling things like 555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// "report warnings as errors" and passes them off to the DiagnosticClient for 565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// reporting to the user. 575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass Diagnostic { 58182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattnerpublic: 59182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// Level - The level of the diagnostic, after it has been through mapping. 60182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner enum Level { 61182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner Ignored, Note, Warning, Error, Fatal 62182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner }; 63182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner 64182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattnerprivate: 655b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner bool IgnoreAllWarnings; // Ignore all warnings: -w 665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool WarningsAsErrors; // Treat warnings like errors: 675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool WarnOnExtensions; // Enables warnings for gcc extensions: -pedantic. 685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ErrorOnExtensions; // Error on extensions: -pedantic-errors. 692fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar bool SuppressSystemWarnings;// Suppress warnings in system headers. 70b4398aa27da4d6919c3ae448d1ae66ba6cafc048Ted Kremenek DiagnosticClient *Client; 715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// DiagMappings - Mapping information for diagnostics. Mapping info is 735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// packed into two bits per diagnostic. 740750618b0beacdc9b0a9e210a661e4746823ced7Chris Lattner unsigned char DiagMappings[(diag::NUM_BUILTIN_DIAGNOSTICS+3)/4]; 755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ErrorOccurred - This is set to true when an error is emitted, and is 775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// sticky. 785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ErrorOccurred; 795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumDiagnostics; // Number of diagnostics reported 815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumErrors; // Number of diagnostics that are errors 82182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner 83182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// CustomDiagInfo - Information for uniquing and looking up custom diags. 84182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner diag::CustomDiagInfo *CustomDiagInfo; 857bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber 865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 877bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber explicit Diagnostic(DiagnosticClient *client = 0); 88182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner ~Diagnostic(); 895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Diagnostic characterization methods, used by a client to customize how 925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // 932bf78fba7a37a42d4295999706053fdf4c9625e2Ted Kremenek 947bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber DiagnosticClient *getClient() { return Client; }; 957bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber const DiagnosticClient *getClient() const { return Client; }; 96b4398aa27da4d6919c3ae448d1ae66ba6cafc048Ted Kremenek 97b4398aa27da4d6919c3ae448d1ae66ba6cafc048Ted Kremenek void setClient(DiagnosticClient* client) { Client = client; } 985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 995b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner /// setIgnoreAllWarnings - When set to true, any unmapped warnings are 1005b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner /// ignored. If this and WarningsAsErrors are both set, then this one wins. 1015b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner void setIgnoreAllWarnings(bool Val) { IgnoreAllWarnings = Val; } 1025b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner bool getIgnoreAllWarnings() const { return IgnoreAllWarnings; } 1035b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner 1045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setWarningsAsErrors - When set to true, any warnings reported are issued 1055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// as errors. 1065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setWarningsAsErrors(bool Val) { WarningsAsErrors = Val; } 1075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getWarningsAsErrors() const { return WarningsAsErrors; } 1085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setWarnOnExtensions - When set to true, issue warnings on GCC extensions, 1105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the equivalent of GCC's -pedantic. 1115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setWarnOnExtensions(bool Val) { WarnOnExtensions = Val; } 1125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getWarnOnExtensions() const { return WarnOnExtensions; } 1135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setErrorOnExtensions - When set to true issue errors for GCC extensions 1155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// instead of warnings. This is the equivalent to GCC's -pedantic-errors. 1165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setErrorOnExtensions(bool Val) { ErrorOnExtensions = Val; } 1175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getErrorOnExtensions() const { return ErrorOnExtensions; } 1185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1192fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar /// setSuppressSystemWarnings - When set to true mask warnings that 1202fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar /// come from system headers. 1212fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar void setSuppressSystemWarnings(bool Val) { SuppressSystemWarnings = Val; } 1222fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar bool getSuppressSystemWarnings() const { return SuppressSystemWarnings; } 1232fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar 1245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setDiagnosticMapping - This allows the client to specify that certain 1255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// warnings are ignored. Only NOTEs, WARNINGs, and EXTENSIONs can be mapped. 1265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setDiagnosticMapping(diag::kind Diag, diag::Mapping Map) { 1270750618b0beacdc9b0a9e210a661e4746823ced7Chris Lattner assert(Diag < diag::NUM_BUILTIN_DIAGNOSTICS && 1280750618b0beacdc9b0a9e210a661e4746823ced7Chris Lattner "Can only map builtin diagnostics"); 1290750618b0beacdc9b0a9e210a661e4746823ced7Chris Lattner assert(isBuiltinNoteWarningOrExtension(Diag) && "Cannot map errors!"); 1305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned char &Slot = DiagMappings[Diag/4]; 1315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned Bits = (Diag & 3)*2; 1325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Slot &= ~(3 << Bits); 1335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Slot |= Map << Bits; 1345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 1355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getDiagnosticMapping - Return the mapping currently set for the specified 1375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// diagnostic. 1385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer diag::Mapping getDiagnosticMapping(diag::kind Diag) const { 1395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return (diag::Mapping)((DiagMappings[Diag/4] >> (Diag & 3)*2) & 3); 1405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 1415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool hasErrorOccurred() const { return ErrorOccurred; } 1435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned getNumErrors() const { return NumErrors; } 1455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned getNumDiagnostics() const { return NumDiagnostics; } 1465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 147182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// getCustomDiagID - Return an ID for a diagnostic with the specified message 148182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// and level. If this is the first request for this diagnosic, it is 149182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// registered and created, otherwise the existing ID is returned. 150182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner unsigned getCustomDiagID(Level L, const char *Message); 151182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner 1525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 1535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Diagnostic classification and reporting interfaces. 1545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // 1555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getDescription - Given a diagnostic ID, return a description of the 1575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// issue. 1580a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const char *getDescription(unsigned DiagID) const; 1595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1600750618b0beacdc9b0a9e210a661e4746823ced7Chris Lattner /// isBuiltinNoteWarningOrExtension - Return true if the unmapped diagnostic 1610750618b0beacdc9b0a9e210a661e4746823ced7Chris Lattner /// level of the specified diagnostic ID is a Note, Warning, or Extension. 1620750618b0beacdc9b0a9e210a661e4746823ced7Chris Lattner /// Note that this only works on builtin diagnostics, not custom ones. 1630750618b0beacdc9b0a9e210a661e4746823ced7Chris Lattner static bool isBuiltinNoteWarningOrExtension(unsigned DiagID); 1645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getDiagnosticLevel - Based on the way the client configured the Diagnostic 1665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// object, classify the specified diagnostic ID into a Level, consumable by 1675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the DiagnosticClient. 1685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Level getDiagnosticLevel(unsigned DiagID) const; 1695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1700a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 1715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Report - Issue the message to the client. DiagID is a member of the 1720a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// diag::kind enum. This actually returns a new instance of DiagnosticInfo 1730a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// which emits the diagnostics (through ProcessDiag) when it is destroyed. 1740a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner inline DiagnosticInfo Report(FullSourceLoc Pos, unsigned DiagID); 1750a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 1760a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattnerprivate: 1770a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // This is private state used by DiagnosticInfo. We put it here instead of 1780a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // in DiagnosticInfo in order to keep DiagnosticInfo a small light-weight 1790a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // object. This implementation choice means that we can only have one 1800a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // diagnostic "in flight" at a time, but this seems to be a reasonable 1810a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // tradeoff to keep these objects small. Assertions verify that only one 1820a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // diagnostic is in flight at a time. 1830a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner friend class DiagnosticInfo; 1840a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 18573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner enum { 18673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// MaxArguments - The maximum number of arguments we can hold. We currently 18773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// only support up to 10 arguments (%0-%9). A single diagnostic with more 18873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// than that almost certainly has to be simplified anyway. 18973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner MaxArguments = 10 19073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner }; 19173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 19273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsKind - This is an array of ArgumentKind::ArgumentKind enum 19373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// values, with one for each argument. This specifies whether the argument 19473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// is in DiagArgumentsStr or in DiagArguments. 19573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner unsigned char DiagArgumentsKind[MaxArguments]; 19673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 19773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsStr - This holds the values of each string argument for the 19873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// current diagnostic. This value is only used when the corresponding 19973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// ArgumentKind is ak_std_string. 20073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner std::string DiagArgumentsStr[MaxArguments]; 20173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 20273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsVal - The values for the various substitution positions. This 20373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// is used when the argument is not an std::string. The specific value is 20473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// mangled into an intptr_t and the intepretation depends on exactly what 20573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// sort of argument kind it is. 20673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner intptr_t DiagArgumentsVal[MaxArguments]; 20773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 2080a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// DiagRanges - The list of ranges added to this diagnostic. It currently 2090a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// only support 10 ranges, could easily be extended if needed. 2100a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const SourceRange *DiagRanges[10]; 2110a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 2120a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// NumDiagArgs - This is set to -1 when no diag is in flight. Otherwise it 2130a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// is the number of entries in Arguments. 2140a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner signed char NumDiagArgs; 2150a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// NumRanges - This is the number of ranges in the DiagRanges array. 2160a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned char NumDiagRanges; 2170a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 2180a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// ProcessDiag - This is the method used to report a diagnostic that is 2190a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// finally fully formed. 2200a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner void ProcessDiag(const DiagnosticInfo &Info); 2210a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner}; 2220a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 2230a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner/// DiagnosticInfo - This is a little helper class used to produce diagnostics. 2240a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner/// This is constructed with an ID and location, and then has some number of 2250a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner/// arguments (for %0 substitution) and SourceRanges added to it with the 2260a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner/// overloaded operator<<. Once it is destroyed, it emits the diagnostic with 2270a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner/// the accumulated information. 2280a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner/// 2290a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner/// Note that many of these will be created as temporary objects (many call 2300a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner/// sites), so we want them to be small to reduce stack space usage etc. For 2310a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner/// this reason, we stick state in the Diagnostic class, see the comment there 2320a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner/// for more info. 2330a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattnerclass DiagnosticInfo { 234520987fc4e5e60c80bcce613b0f8813ffb2fdca0Chris Lattner mutable Diagnostic *DiagObj; 2350a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner FullSourceLoc Loc; 2360a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned DiagID; 2370a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner void operator=(const DiagnosticInfo&); // DO NOT IMPLEMENT 2380a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattnerpublic: 23973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner enum ArgumentKind { 24073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner ak_std_string, // std::string 24173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner ak_c_string // const char * 24273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner }; 24373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 24473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 2450a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner DiagnosticInfo(Diagnostic *diagObj, FullSourceLoc loc, unsigned diagID) : 2460a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner DiagObj(diagObj), Loc(loc), DiagID(diagID) { 247aabb54e1ee8e2c2ef89e7c5cbbb9a89872e96f67Chris Lattner if (DiagObj == 0) return; 2480a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner assert(DiagObj->NumDiagArgs == -1 && 2490a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner "Multiple diagnostics in flight at once!"); 2500a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner DiagObj->NumDiagArgs = DiagObj->NumDiagRanges = 0; 2510a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 2520a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 2530a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// Copy constructor. When copied, this "takes" the diagnostic info from the 2540a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// input and neuters it. 255520987fc4e5e60c80bcce613b0f8813ffb2fdca0Chris Lattner DiagnosticInfo(const DiagnosticInfo &D) { 2560a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner DiagObj = D.DiagObj; 2570a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner Loc = D.Loc; 2580a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner DiagID = D.DiagID; 2590a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner D.DiagObj = 0; 2600a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 2610a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 2620a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// Destructor - The dtor emits the diagnostic. 2630a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner ~DiagnosticInfo() { 2640a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // If DiagObj is null, then its soul was stolen by the copy ctor. 2650a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner if (!DiagObj) return; 2660a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 2670a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner DiagObj->ProcessDiag(*this); 2680a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 2690a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // This diagnostic is no longer in flight. 2700a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner DiagObj->NumDiagArgs = -1; 2710a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 2720a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 2730a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const Diagnostic *getDiags() const { return DiagObj; } 2740a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned getID() const { return DiagID; } 2750a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const FullSourceLoc &getLocation() const { return Loc; } 27695d1ba492c3191f49392e53acbf878e39fc8ba0aChris Lattner 27795d1ba492c3191f49392e53acbf878e39fc8ba0aChris Lattner /// Operator bool: conversion of DiagnosticInfo to bool always returns true. 27895d1ba492c3191f49392e53acbf878e39fc8ba0aChris Lattner /// This allows is to be used in boolean error contexts like: 27995d1ba492c3191f49392e53acbf878e39fc8ba0aChris Lattner /// return Diag(...); 28095d1ba492c3191f49392e53acbf878e39fc8ba0aChris Lattner operator bool() const { return true; } 2810a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 2820a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned getNumArgs() const { return DiagObj->NumDiagArgs; } 2830a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 28473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 28573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgKind - Return the kind of the specified index. Based on the kind 28673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// of argument, the accessors below can be used to get the value. 28773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner ArgumentKind getArgKind(unsigned Idx) const { 2880a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner assert((signed char)Idx < DiagObj->NumDiagArgs && 28973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner "Argument index out of range!"); 29073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner return (ArgumentKind)DiagObj->DiagArgumentsKind[Idx]; 29173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner } 29273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 29373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgStdStr - Return the provided argument string specified by Idx. 29473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner const std::string &getArgStdStr(unsigned Idx) const { 29573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner assert(getArgKind(Idx) == ak_std_string && "invalid argument accessor!"); 29673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner return DiagObj->DiagArgumentsStr[Idx]; 29773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner } 29873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 29973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgCStr - Return the specified C string argument. 30073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner const char *getArgCStr(unsigned Idx) const { 30173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner assert(getArgKind(Idx) == ak_c_string && "invalid argument accessor!"); 30273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner return reinterpret_cast<const char*>(DiagObj->DiagArgumentsVal[Idx]); 3030a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 3040a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 3050a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// getNumRanges - Return the number of source ranges associated with this 3060a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// diagnostic. 3070a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned getNumRanges() const { 3080a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner return DiagObj->NumDiagRanges; 3090a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 3100a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 3110a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const SourceRange &getRange(unsigned Idx) const { 3120a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner assert(Idx < DiagObj->NumDiagRanges && "Invalid diagnostic range index!"); 3130a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner return *DiagObj->DiagRanges[Idx]; 3140a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 315520987fc4e5e60c80bcce613b0f8813ffb2fdca0Chris Lattner 3160a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner DiagnosticInfo &operator<<(const std::string &S) { 31773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner assert((unsigned)DiagObj->NumDiagArgs < Diagnostic::MaxArguments && 31873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner "Too many arguments to diagnostic!"); 31973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner DiagObj->DiagArgumentsKind[DiagObj->NumDiagArgs] = ak_std_string; 32073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner DiagObj->DiagArgumentsStr[DiagObj->NumDiagArgs++] = S; 32173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner return *this; 32273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner } 32373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 32473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner DiagnosticInfo &operator<<(const char *Str) { 32573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner assert((unsigned)DiagObj->NumDiagArgs < Diagnostic::MaxArguments && 3260a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner "Too many arguments to diagnostic!"); 32773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner DiagObj->DiagArgumentsKind[DiagObj->NumDiagArgs] = ak_c_string; 32873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner DiagObj->DiagArgumentsVal[DiagObj->NumDiagArgs++] = 32973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner reinterpret_cast<intptr_t>(Str); 3300a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner return *this; 3310a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 3320a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 3330a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner DiagnosticInfo &operator<<(const SourceRange &R) { 3340a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner assert((unsigned)DiagObj->NumDiagArgs < 3350a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner sizeof(DiagObj->DiagRanges)/sizeof(DiagObj->DiagRanges[0]) && 3360a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner "Too many arguments to diagnostic!"); 3370a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner DiagObj->DiagRanges[DiagObj->NumDiagRanges++] = &R; 3380a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner return *this; 3390a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 3400a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 341f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// FormatDiagnostic - Format this diagnostic into a string, substituting the 342f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// formal arguments into the %0 slots. The result is appended onto the Str 343f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// array. 344f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner void FormatDiagnostic(llvm::SmallVectorImpl<char> &OutStr) const; 3455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 3465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3470a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 3480a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner/// Report - Issue the message to the client. DiagID is a member of the 3490a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner/// diag::kind enum. This actually returns a new instance of DiagnosticInfo 3500a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner/// which emits the diagnostics (through ProcessDiag) when it is destroyed. 3510a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattnerinline DiagnosticInfo Diagnostic::Report(FullSourceLoc Pos, unsigned DiagID) { 352f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner return DiagnosticInfo(this, Pos, DiagID); 3530a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner} 3540a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 3550a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 3565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// DiagnosticClient - This is an abstract interface implemented by clients of 3575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// the front-end, which formats and prints fully processed diagnostics. 3585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass DiagnosticClient { 3595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 3605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer virtual ~DiagnosticClient(); 3615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleDiagnostic - Handle this diagnostic, reporting it to the user or 3635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// capturing it to a log as needed. 3640a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner virtual void HandleDiagnostic(Diagnostic::Level DiagLevel, 3650a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const DiagnosticInfo &Info) = 0; 3665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 3675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 3695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 371