Diagnostic.h revision 22caddc91d2f6186739c6b20ec58ed38cd68e595
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 65182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattnerprivate: 665b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner bool IgnoreAllWarnings; // Ignore all warnings: -w 675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool WarningsAsErrors; // Treat warnings like errors: 685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool WarnOnExtensions; // Enables warnings for gcc extensions: -pedantic. 695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ErrorOnExtensions; // Error on extensions: -pedantic-errors. 702fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar bool SuppressSystemWarnings;// Suppress warnings in system headers. 71b4398aa27da4d6919c3ae448d1ae66ba6cafc048Ted Kremenek DiagnosticClient *Client; 725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// DiagMappings - Mapping information for diagnostics. Mapping info is 745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// packed into two bits per diagnostic. 750750618b0beacdc9b0a9e210a661e4746823ced7Chris Lattner unsigned char DiagMappings[(diag::NUM_BUILTIN_DIAGNOSTICS+3)/4]; 765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ErrorOccurred - This is set to true when an error is emitted, and is 785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// sticky. 795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ErrorOccurred; 805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumDiagnostics; // Number of diagnostics reported 825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumErrors; // Number of diagnostics that are errors 83182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner 84182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// CustomDiagInfo - Information for uniquing and looking up custom diags. 85182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner diag::CustomDiagInfo *CustomDiagInfo; 867bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber 8722caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner /// QualTypeToString - A function pointer that converts QualType's to strings. 8822caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner /// This is a hack to avoid a layering violation between libbasic and libsema. 8922caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner typedef void (*QTToStringFnTy)(intptr_t QT, const char *Modifier, unsigned ML, 9022caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner const char *Argument, unsigned ArgLen, 9122caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner llvm::SmallVectorImpl<char> &Output); 9222caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner QTToStringFnTy QualTypeToString; 935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 947bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber explicit Diagnostic(DiagnosticClient *client = 0); 95182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner ~Diagnostic(); 965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Diagnostic characterization methods, used by a client to customize how 995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // 1002bf78fba7a37a42d4295999706053fdf4c9625e2Ted Kremenek 1017bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber DiagnosticClient *getClient() { return Client; }; 1027bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber const DiagnosticClient *getClient() const { return Client; }; 103b4398aa27da4d6919c3ae448d1ae66ba6cafc048Ted Kremenek 104b4398aa27da4d6919c3ae448d1ae66ba6cafc048Ted Kremenek void setClient(DiagnosticClient* client) { Client = client; } 1055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1065b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner /// setIgnoreAllWarnings - When set to true, any unmapped warnings are 1075b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner /// ignored. If this and WarningsAsErrors are both set, then this one wins. 1085b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner void setIgnoreAllWarnings(bool Val) { IgnoreAllWarnings = Val; } 1095b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner bool getIgnoreAllWarnings() const { return IgnoreAllWarnings; } 1105b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner 1115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setWarningsAsErrors - When set to true, any warnings reported are issued 1125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// as errors. 1135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setWarningsAsErrors(bool Val) { WarningsAsErrors = Val; } 1145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getWarningsAsErrors() const { return WarningsAsErrors; } 1155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setWarnOnExtensions - When set to true, issue warnings on GCC extensions, 1175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the equivalent of GCC's -pedantic. 1185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setWarnOnExtensions(bool Val) { WarnOnExtensions = Val; } 1195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getWarnOnExtensions() const { return WarnOnExtensions; } 1205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setErrorOnExtensions - When set to true issue errors for GCC extensions 1225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// instead of warnings. This is the equivalent to GCC's -pedantic-errors. 1235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setErrorOnExtensions(bool Val) { ErrorOnExtensions = Val; } 1245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getErrorOnExtensions() const { return ErrorOnExtensions; } 1255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1262fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar /// setSuppressSystemWarnings - When set to true mask warnings that 1272fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar /// come from system headers. 1282fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar void setSuppressSystemWarnings(bool Val) { SuppressSystemWarnings = Val; } 1292fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar bool getSuppressSystemWarnings() const { return SuppressSystemWarnings; } 1302fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar 1315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setDiagnosticMapping - This allows the client to specify that certain 1325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// warnings are ignored. Only NOTEs, WARNINGs, and EXTENSIONs can be mapped. 1335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setDiagnosticMapping(diag::kind Diag, diag::Mapping Map) { 1340750618b0beacdc9b0a9e210a661e4746823ced7Chris Lattner assert(Diag < diag::NUM_BUILTIN_DIAGNOSTICS && 1350750618b0beacdc9b0a9e210a661e4746823ced7Chris Lattner "Can only map builtin diagnostics"); 1360750618b0beacdc9b0a9e210a661e4746823ced7Chris Lattner assert(isBuiltinNoteWarningOrExtension(Diag) && "Cannot map errors!"); 1375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned char &Slot = DiagMappings[Diag/4]; 1385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned Bits = (Diag & 3)*2; 1395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Slot &= ~(3 << Bits); 1405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Slot |= Map << Bits; 1415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 1425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getDiagnosticMapping - Return the mapping currently set for the specified 1445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// diagnostic. 1455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer diag::Mapping getDiagnosticMapping(diag::kind Diag) const { 1465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return (diag::Mapping)((DiagMappings[Diag/4] >> (Diag & 3)*2) & 3); 1475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 1485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool hasErrorOccurred() const { return ErrorOccurred; } 1505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned getNumErrors() const { return NumErrors; } 1525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned getNumDiagnostics() const { return NumDiagnostics; } 1535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 154182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// getCustomDiagID - Return an ID for a diagnostic with the specified message 155182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// and level. If this is the first request for this diagnosic, it is 156182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// registered and created, otherwise the existing ID is returned. 157182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner unsigned getCustomDiagID(Level L, const char *Message); 158182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner 15922caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner 16022caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner /// ConvertQualTypeToString - This method converts a QualType (as an intptr_t) 16122caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner /// into the string that represents it if possible. 16222caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner void ConvertQualTypeToString(intptr_t QT, const char *Modifier, unsigned ML, 16322caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner const char *Argument, unsigned ArgLen, 16422caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner llvm::SmallVectorImpl<char> &Output) const { 16522caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner QualTypeToString(QT, Modifier, ML, Argument, ArgLen, Output); 16622caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 16722caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner 16822caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner void SetQualTypeToStringFn(QTToStringFnTy Fn) { 16922caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner QualTypeToString = Fn; 17022caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 17122caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner 1725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 1735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Diagnostic classification and reporting interfaces. 1745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // 1755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getDescription - Given a diagnostic ID, return a description of the 1775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// issue. 1780a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const char *getDescription(unsigned DiagID) const; 1795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1800750618b0beacdc9b0a9e210a661e4746823ced7Chris Lattner /// isBuiltinNoteWarningOrExtension - Return true if the unmapped diagnostic 1810750618b0beacdc9b0a9e210a661e4746823ced7Chris Lattner /// level of the specified diagnostic ID is a Note, Warning, or Extension. 1820750618b0beacdc9b0a9e210a661e4746823ced7Chris Lattner /// Note that this only works on builtin diagnostics, not custom ones. 1830750618b0beacdc9b0a9e210a661e4746823ced7Chris Lattner static bool isBuiltinNoteWarningOrExtension(unsigned DiagID); 1845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getDiagnosticLevel - Based on the way the client configured the Diagnostic 1865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// object, classify the specified diagnostic ID into a Level, consumable by 1875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the DiagnosticClient. 1885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Level getDiagnosticLevel(unsigned DiagID) const; 1895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1900a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 1915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Report - Issue the message to the client. DiagID is a member of the 1923cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// diag::kind enum. This actually returns aninstance of DiagnosticBuilder 1930a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// which emits the diagnostics (through ProcessDiag) when it is destroyed. 1943cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner inline DiagnosticBuilder Report(FullSourceLoc Pos, unsigned DiagID); 1950a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 1960a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattnerprivate: 1973cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner // This is private state used by DiagnosticBuilder. We put it here instead of 1983cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner // in DiagnosticBuilder in order to keep DiagnosticBuilder a small lightweight 1990a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // object. This implementation choice means that we can only have one 2000a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // diagnostic "in flight" at a time, but this seems to be a reasonable 2010a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // tradeoff to keep these objects small. Assertions verify that only one 2020a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // diagnostic is in flight at a time. 2033cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner friend class DiagnosticBuilder; 2040a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner friend class DiagnosticInfo; 205b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner 206b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner /// CurDiagLoc - This is the location of the current diagnostic that is in 207b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner /// flight. 208b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner FullSourceLoc CurDiagLoc; 2090a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 210b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner /// CurDiagID - This is the ID of the current diagnostic that is in flight. 2113cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// This is set to ~0U when there is no diagnostic in flight. 212b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner unsigned CurDiagID; 213b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner 21473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner enum { 21573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// MaxArguments - The maximum number of arguments we can hold. We currently 21673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// only support up to 10 arguments (%0-%9). A single diagnostic with more 21773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// than that almost certainly has to be simplified anyway. 21873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner MaxArguments = 10 21973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner }; 22073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 2213cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// NumDiagArgs - This contains the number of entries in Arguments. 222730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner signed char NumDiagArgs; 223730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner /// NumRanges - This is the number of ranges in the DiagRanges array. 224730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner unsigned char NumDiagRanges; 225730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner 22673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsKind - This is an array of ArgumentKind::ArgumentKind enum 22773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// values, with one for each argument. This specifies whether the argument 22873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// is in DiagArgumentsStr or in DiagArguments. 22973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner unsigned char DiagArgumentsKind[MaxArguments]; 23073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 23173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsStr - This holds the values of each string argument for the 23273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// current diagnostic. This value is only used when the corresponding 23373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// ArgumentKind is ak_std_string. 23473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner std::string DiagArgumentsStr[MaxArguments]; 23573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 23673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsVal - The values for the various substitution positions. This 23773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// is used when the argument is not an std::string. The specific value is 23873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// mangled into an intptr_t and the intepretation depends on exactly what 23973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// sort of argument kind it is. 24073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner intptr_t DiagArgumentsVal[MaxArguments]; 24173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 2420a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// DiagRanges - The list of ranges added to this diagnostic. It currently 2430a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// only support 10 ranges, could easily be extended if needed. 2440a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const SourceRange *DiagRanges[10]; 2450a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 2460a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// ProcessDiag - This is the method used to report a diagnostic that is 2470a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// finally fully formed. 2483cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void ProcessDiag(); 2490a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattnerpublic: 25073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner enum ArgumentKind { 25143b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner ak_std_string, // std::string 25243b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner ak_c_string, // const char * 25343b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner ak_sint, // int 25443b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner ak_uint, // unsigned 25522caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner ak_identifierinfo, // IdentifierInfo 25622caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner ak_qualtype // QualType 25773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner }; 2583cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}; 2593cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 2603cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 2613cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner// DiagnosticBuilder 2623cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 2633cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 2643cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// DiagnosticBuilder - This is a little helper class used to produce 2653cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// diagnostics. This is constructed by the Diagnostic::Report method, and 2663cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// allows insertion of extra information (arguments and source ranges) into the 2673cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// currently "in flight" diagnostic. When the temporary for the builder is 2683cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// destroyed, the diagnostic is issued. 2693cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// 2703cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// Note that many of these will be created as temporary objects (many call 2713cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// sites), so we want them to be small and we never want their address taken. 2723cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// This ensures that compilers with somewhat reasonable optimizers will promote 2733cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// the common fields to registers, eliminating increments of the NumArgs field, 2743cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// for example. 2753cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerclass DiagnosticBuilder { 2763cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner mutable Diagnostic *DiagObj; 2773cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner mutable unsigned NumArgs, NumRanges; 27873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 2793cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void operator=(const DiagnosticBuilder&); // DO NOT IMPLEMENT 2803cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner friend class Diagnostic; 2813cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner explicit DiagnosticBuilder(Diagnostic *diagObj) 2823cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner : DiagObj(diagObj), NumArgs(0), NumRanges(0) {} 2833cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerpublic: 2840a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 2850a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// Copy constructor. When copied, this "takes" the diagnostic info from the 2860a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// input and neuters it. 2873cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagnosticBuilder(const DiagnosticBuilder &D) { 2880a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner DiagObj = D.DiagObj; 2890a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner D.DiagObj = 0; 2900a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 2910a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 2920a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// Destructor - The dtor emits the diagnostic. 2933cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner ~DiagnosticBuilder() { 2940a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // If DiagObj is null, then its soul was stolen by the copy ctor. 2953cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner if (DiagObj == 0) return; 29622caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner 29722caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner // When destroyed, the ~DiagnosticBuilder sets the final argument count into 29822caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner // the Diagnostic object. 2993cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->NumDiagArgs = NumArgs; 3003cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->NumDiagRanges = NumRanges; 3013cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 30222caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner // Process the diagnostic, sending the accumulated information to the 30322caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner // DiagnosticClient. 3043cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->ProcessDiag(); 3050a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 3060a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // This diagnostic is no longer in flight. 3073cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->CurDiagID = ~0U; 3083cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner } 3093cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 3103cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// Operator bool: conversion of DiagnosticBuilder to bool always returns 3113cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// true. This allows is to be used in boolean error contexts like: 3123cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// return Diag(...); 3133cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner operator bool() const { return true; } 3143cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 3153cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void AddString(const std::string &S) const { 3163cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(NumArgs < Diagnostic::MaxArguments && 3173cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 3183cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->DiagArgumentsKind[NumArgs] = Diagnostic::ak_std_string; 3193cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->DiagArgumentsStr[NumArgs++] = S; 3203cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner } 3213cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 3223cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void AddTaggedVal(intptr_t V, Diagnostic::ArgumentKind Kind) const { 3233cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(NumArgs < Diagnostic::MaxArguments && 3243cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 3253cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->DiagArgumentsKind[NumArgs] = Kind; 3263cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->DiagArgumentsVal[NumArgs++] = V; 3270a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 3280a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 3293cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void AddSourceRange(const SourceRange &R) const { 3303cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(NumRanges < 3313cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner sizeof(DiagObj->DiagRanges)/sizeof(DiagObj->DiagRanges[0]) && 3323cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 3333cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->DiagRanges[NumRanges++] = &R; 3343cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner } 3353cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}; 3363cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 3373cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 3383cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const std::string &S) { 3393cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddString(S); 3403cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 3413cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 3423cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 3433cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 3443cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const char *Str) { 3453cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(reinterpret_cast<intptr_t>(Str), 3463cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner Diagnostic::ak_c_string); 3473cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 3483cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 3493cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 3503cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, int I) { 3513cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(I, Diagnostic::ak_sint); 3523cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 3533cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 3543cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 3553cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 3563cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner unsigned I) { 3573cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(I, Diagnostic::ak_uint); 3583cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 3593cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 3603cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 3613cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 3623cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const IdentifierInfo *II) { 3633cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(reinterpret_cast<intptr_t>(II), 3643cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner Diagnostic::ak_identifierinfo); 3653cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 3663cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 3673cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 3683cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 3693cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const SourceRange &R) { 3703cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddSourceRange(R); 3713cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 3723cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 3733cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 3743cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 3753cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// Report - Issue the message to the client. DiagID is a member of the 3763cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// diag::kind enum. This actually returns a new instance of DiagnosticBuilder 3773cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// which emits the diagnostics (through ProcessDiag) when it is destroyed. 3783cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline DiagnosticBuilder Diagnostic::Report(FullSourceLoc Loc, unsigned DiagID){ 3793cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(CurDiagID == ~0U && "Multiple diagnostics in flight at once!"); 3803cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner CurDiagLoc = Loc; 3813cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner CurDiagID = DiagID; 3823cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DiagnosticBuilder(this); 3833cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 3843cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 3853cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 3863cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner// DiagnosticInfo 3873cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 3883cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 3893cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// DiagnosticInfo - This is a little helper class (which is basically a smart 3903cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// pointer that forward info from Diagnostic) that allows clients ot enquire 3913cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// about the currently in-flight diagnostic. 3923cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerclass DiagnosticInfo { 3933cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const Diagnostic *DiagObj; 3943cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerpublic: 3953cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner explicit DiagnosticInfo(const Diagnostic *DO) : DiagObj(DO) {} 3963cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 3970a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const Diagnostic *getDiags() const { return DiagObj; } 398b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner unsigned getID() const { return DiagObj->CurDiagID; } 399b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner const FullSourceLoc &getLocation() const { return DiagObj->CurDiagLoc; } 40095d1ba492c3191f49392e53acbf878e39fc8ba0aChris Lattner 4010a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned getNumArgs() const { return DiagObj->NumDiagArgs; } 4020a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 40373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgKind - Return the kind of the specified index. Based on the kind 40473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// of argument, the accessors below can be used to get the value. 4053cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner Diagnostic::ArgumentKind getArgKind(unsigned Idx) const { 4063cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(Idx < getNumArgs() && "Argument index out of range!"); 4073cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return (Diagnostic::ArgumentKind)DiagObj->DiagArgumentsKind[Idx]; 40873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner } 40973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 41073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgStdStr - Return the provided argument string specified by Idx. 41173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner const std::string &getArgStdStr(unsigned Idx) const { 4123cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_std_string && 4133cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 41473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner return DiagObj->DiagArgumentsStr[Idx]; 41573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner } 4163cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 41773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgCStr - Return the specified C string argument. 41873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner const char *getArgCStr(unsigned Idx) const { 4193cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_c_string && 4203cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 42173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner return reinterpret_cast<const char*>(DiagObj->DiagArgumentsVal[Idx]); 4220a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 4230a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 42430bc96544346bea42921cf6837e66cef80d664b4Chris Lattner /// getArgSInt - Return the specified signed integer argument. 42530bc96544346bea42921cf6837e66cef80d664b4Chris Lattner int getArgSInt(unsigned Idx) const { 4263cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_sint && 4273cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 42830bc96544346bea42921cf6837e66cef80d664b4Chris Lattner return (int)DiagObj->DiagArgumentsVal[Idx]; 42930bc96544346bea42921cf6837e66cef80d664b4Chris Lattner } 4303cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 43130bc96544346bea42921cf6837e66cef80d664b4Chris Lattner /// getArgUInt - Return the specified unsigned integer argument. 43230bc96544346bea42921cf6837e66cef80d664b4Chris Lattner unsigned getArgUInt(unsigned Idx) const { 4333cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_uint && 4343cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 43530bc96544346bea42921cf6837e66cef80d664b4Chris Lattner return (unsigned)DiagObj->DiagArgumentsVal[Idx]; 43630bc96544346bea42921cf6837e66cef80d664b4Chris Lattner } 43730bc96544346bea42921cf6837e66cef80d664b4Chris Lattner 43843b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner /// getArgIdentifier - Return the specified IdentifierInfo argument. 43943b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner const IdentifierInfo *getArgIdentifier(unsigned Idx) const { 4403cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_identifierinfo && 4413cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 4429634379265855f1628190e926d9aaf1fb4a5d90eChris Lattner return reinterpret_cast<IdentifierInfo*>(DiagObj->DiagArgumentsVal[Idx]); 44343b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner } 44443b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner 44522caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner /// getRawArg - Return the specified non-string argument in an opaque form. 44622caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner intptr_t getRawArg(unsigned Idx) const { 44722caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner assert(getArgKind(Idx) != Diagnostic::ak_std_string && 44822caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner "invalid argument accessor!"); 44922caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner return DiagObj->DiagArgumentsVal[Idx]; 45022caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 45122caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner 45222caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner 4530a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// getNumRanges - Return the number of source ranges associated with this 4540a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// diagnostic. 4550a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned getNumRanges() const { 4560a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner return DiagObj->NumDiagRanges; 4570a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 4580a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 4590a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const SourceRange &getRange(unsigned Idx) const { 4600a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner assert(Idx < DiagObj->NumDiagRanges && "Invalid diagnostic range index!"); 4610a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner return *DiagObj->DiagRanges[Idx]; 4620a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 463520987fc4e5e60c80bcce613b0f8813ffb2fdca0Chris Lattner 4640a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 465f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// FormatDiagnostic - Format this diagnostic into a string, substituting the 466f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// formal arguments into the %0 slots. The result is appended onto the Str 467f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// array. 468f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner void FormatDiagnostic(llvm::SmallVectorImpl<char> &OutStr) const; 4695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 4700a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 4710a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 4725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// DiagnosticClient - This is an abstract interface implemented by clients of 4735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// the front-end, which formats and prints fully processed diagnostics. 4745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass DiagnosticClient { 4755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 4765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer virtual ~DiagnosticClient(); 4775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleDiagnostic - Handle this diagnostic, reporting it to the user or 4795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// capturing it to a log as needed. 4800a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner virtual void HandleDiagnostic(Diagnostic::Level DiagLevel, 4810a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const DiagnosticInfo &Info) = 0; 4825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 4835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 4855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 487