Diagnostic.h revision ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295
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; 283cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner class DiagnosticBuilder; 29d42ffbd22fc7eb61321f6a88173ee424991f01c6Ted Kremenek class IdentifierInfo; 305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Import the diagnostic enums themselves. 325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer namespace diag { 3319e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner // Start position for diagnostics. 3419e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner enum { 3519e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_START_LEX = 300, 3619e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_START_PARSE = DIAG_START_LEX + 300, 3719e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_START_AST = DIAG_START_PARSE + 300, 3819e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_START_SEMA = DIAG_START_AST + 100, 3919e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_START_ANALYSIS = DIAG_START_SEMA + 1000, 4019e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_UPPER_LIMIT = DIAG_START_ANALYSIS + 100 4119e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner }; 4219e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner 43182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner class CustomDiagInfo; 44182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner 455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// diag::kind - All of the diagnostics that can be emitted by the frontend. 4620c6b3b85e186cd52d5d99489132d71d498159ebChris Lattner typedef unsigned kind; 4720c6b3b85e186cd52d5d99489132d71d498159ebChris Lattner 4888eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner // Get typedefs for common diagnostics. 4988eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner enum { 5088eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner#define DIAG(ENUM,FLAGS,DESC) ENUM, 5188eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner#include "clang/Basic/DiagnosticCommonKinds.def" 5288eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner NUM_BUILTIN_COMMON_DIAGNOSTICS 5388eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner#undef DIAG 5488eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner }; 5588eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner 565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Enum values that allow the client to map NOTEs, WARNINGs, and EXTENSIONs 575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to either MAP_IGNORE (nothing), MAP_WARNING (emit a warning), MAP_ERROR 58da0cbc1ad4a553c4de111c1181ec7b42c5ddefceChris Lattner /// (emit as an error), or MAP_DEFAULT (handle the default way). It allows 59da0cbc1ad4a553c4de111c1181ec7b42c5ddefceChris Lattner /// clients to map errors to MAP_ERROR/MAP_DEFAULT or MAP_FATAL (stop 60da0cbc1ad4a553c4de111c1181ec7b42c5ddefceChris Lattner /// emitting diagnostics after this one). 615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer enum Mapping { 625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer MAP_DEFAULT = 0, //< Do not map this diagnostic. 635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer MAP_IGNORE = 1, //< Map this diagnostic to nothing, ignore it. 645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer MAP_WARNING = 2, //< Map this diagnostic to a warning. 65da0cbc1ad4a553c4de111c1181ec7b42c5ddefceChris Lattner MAP_ERROR = 3, //< Map this diagnostic to an error. 66da0cbc1ad4a553c4de111c1181ec7b42c5ddefceChris Lattner MAP_FATAL = 4 //< Map this diagnostic to a fatal error. 675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 704b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// \brief Annotates a diagnostic with some code that should be 714b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// inserted, removed, or replaced to fix the problem. 724b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// 734b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// This kind of hint should be used when we are certain that the 744b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// introduction, removal, or modification of a particular (small!) 754b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// amount of code will correct a compilation error. The compiler 764b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// should also provide full recovery from such errors, such that 77b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor/// suppressing the diagnostic output can still result in successful 784b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// compilation. 794b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregorclass CodeModificationHint { 804b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregorpublic: 814b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Tokens that should be removed to correct the error. 824b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor SourceRange RemoveRange; 834b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 844b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief The location at which we should insert code to correct 854b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// the error. 864b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor SourceLocation InsertionLoc; 874b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 884b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief The actual code to insert at the insertion location, as a 894b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// string. 904b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor std::string CodeToInsert; 914b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 924b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Empty code modification hint, indicating that no code 934b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// modification is known. 944b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor CodeModificationHint() : RemoveRange(), InsertionLoc() { } 954b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 964b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that inserts the given 974b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// code string at a specific location. 98b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor static CodeModificationHint CreateInsertion(SourceLocation InsertionLoc, 99b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor const std::string &Code) { 100b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor CodeModificationHint Hint; 101b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.InsertionLoc = InsertionLoc; 102b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.CodeToInsert = Code; 103b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 104b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 1054b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1064b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that removes the given 1074b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// source range. 108b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor static CodeModificationHint CreateRemoval(SourceRange RemoveRange) { 109b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor CodeModificationHint Hint; 110b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.RemoveRange = RemoveRange; 111b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 112b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 1134b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1144b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that replaces the given 1154b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// source range with the given code string. 116b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor static CodeModificationHint CreateReplacement(SourceRange RemoveRange, 117b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor const std::string &Code) { 118b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor CodeModificationHint Hint; 119b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.RemoveRange = RemoveRange; 120b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.InsertionLoc = RemoveRange.getBegin(); 121b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.CodeToInsert = Code; 122b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 123b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 1244b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor}; 1254b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 126ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor/// \brief A hook function that will be invoked after we have 127ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor/// completed processing of the current diagnostic. 128ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor/// 129ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor/// Hook functions are typically used to emit further diagnostics 130ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor/// (typically notes) that give more information about this 131ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor/// diagnostic. 132ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregorstruct PostDiagnosticHook { 133ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor /// \brief The type of the hook function itself. 134ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor /// 135ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor /// DiagID is the ID of the diagnostic to which the hook was 136ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor /// attached, and Cookie is a user-specified value that can be used 137ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor /// to store extra data for the hook. 138ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor typedef void (*HookTy)(unsigned DiagID, void *Cookie); 139ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 140ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor PostDiagnosticHook() {} 141ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 142ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor PostDiagnosticHook(HookTy Hook, void *Cookie) : Hook(Hook), Cookie(Cookie) { 143ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor assert(Hook && "No hook provided!"); 144ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor } 145ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 146ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor /// \brief The hook function. 147ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor HookTy Hook; 148ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 149ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor /// \brief The cookie that will be passed along to the hook function. 150ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor void *Cookie; 151ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor}; 152ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 1535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// Diagnostic - This concrete class is used by the front-end to report 1545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// problems and issues. It massages the diagnostics (e.g. handling things like 1555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// "report warnings as errors" and passes them off to the DiagnosticClient for 1565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// reporting to the user. 1575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass Diagnostic { 158182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattnerpublic: 159182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// Level - The level of the diagnostic, after it has been through mapping. 160182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner enum Level { 161da0cbc1ad4a553c4de111c1181ec7b42c5ddefceChris Lattner Ignored, Note, Warning, Error, Fatal 162182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner }; 163182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner 1643fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner enum ArgumentKind { 16547b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_std_string, // std::string 16647b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_c_string, // const char * 16747b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_sint, // int 16847b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_uint, // unsigned 16947b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_identifierinfo, // IdentifierInfo 17047b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_qualtype, // QualType 17147b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_declarationname, // DeclarationName 172d42ffbd22fc7eb61321f6a88173ee424991f01c6Ted Kremenek ak_nameddecl // NamedDecl * 1733fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner }; 174ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 175182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattnerprivate: 1765b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner bool IgnoreAllWarnings; // Ignore all warnings: -w 1775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool WarningsAsErrors; // Treat warnings like errors: 1785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool WarnOnExtensions; // Enables warnings for gcc extensions: -pedantic. 1795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ErrorOnExtensions; // Error on extensions: -pedantic-errors. 1802fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar bool SuppressSystemWarnings;// Suppress warnings in system headers. 181b4398aa27da4d6919c3ae448d1ae66ba6cafc048Ted Kremenek DiagnosticClient *Client; 1825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// DiagMappings - Mapping information for diagnostics. Mapping info is 184da0cbc1ad4a553c4de111c1181ec7b42c5ddefceChris Lattner /// packed into four bits per diagnostic. 185da0cbc1ad4a553c4de111c1181ec7b42c5ddefceChris Lattner unsigned char DiagMappings[diag::DIAG_UPPER_LIMIT/2]; 1865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 18715221422eda7bac679e38b07512feda49715ef66Chris Lattner /// ErrorOccurred / FatalErrorOccurred - This is set to true when an error or 18815221422eda7bac679e38b07512feda49715ef66Chris Lattner /// fatal error is emitted, and is sticky. 1895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ErrorOccurred; 19015221422eda7bac679e38b07512feda49715ef66Chris Lattner bool FatalErrorOccurred; 191f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner 192f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// LastDiagLevel - This is the level of the last diagnostic emitted. This is 193f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// used to emit continuation diagnostics with the same level as the 194f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// diagnostic that they follow. 195f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner Diagnostic::Level LastDiagLevel; 1965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumDiagnostics; // Number of diagnostics reported 1985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumErrors; // Number of diagnostics that are errors 199182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner 200182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// CustomDiagInfo - Information for uniquing and looking up custom diags. 201182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner diag::CustomDiagInfo *CustomDiagInfo; 2027bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber 2033fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// ArgToStringFn - A function pointer that converts an opaque diagnostic 2043fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// argument to a strings. This takes the modifiers and argument that was 2053fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// present in the diagnostic. 20622caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner /// This is a hack to avoid a layering violation between libbasic and libsema. 2073fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner typedef void (*ArgToStringFnTy)(ArgumentKind Kind, intptr_t Val, 2083fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Modifier, unsigned ModifierLen, 2093fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Argument, unsigned ArgumentLen, 21092dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner llvm::SmallVectorImpl<char> &Output, 21192dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner void *Cookie); 21292dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner void *ArgToStringCookie; 2133fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ArgToStringFnTy ArgToStringFn; 2145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 2157bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber explicit Diagnostic(DiagnosticClient *client = 0); 216182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner ~Diagnostic(); 2175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 2195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Diagnostic characterization methods, used by a client to customize how 2205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // 2212bf78fba7a37a42d4295999706053fdf4c9625e2Ted Kremenek 2227bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber DiagnosticClient *getClient() { return Client; }; 2237bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber const DiagnosticClient *getClient() const { return Client; }; 224b4398aa27da4d6919c3ae448d1ae66ba6cafc048Ted Kremenek 225b4398aa27da4d6919c3ae448d1ae66ba6cafc048Ted Kremenek void setClient(DiagnosticClient* client) { Client = client; } 2265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2275b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner /// setIgnoreAllWarnings - When set to true, any unmapped warnings are 2285b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner /// ignored. If this and WarningsAsErrors are both set, then this one wins. 2295b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner void setIgnoreAllWarnings(bool Val) { IgnoreAllWarnings = Val; } 2305b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner bool getIgnoreAllWarnings() const { return IgnoreAllWarnings; } 2315b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner 2325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setWarningsAsErrors - When set to true, any warnings reported are issued 2335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// as errors. 2345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setWarningsAsErrors(bool Val) { WarningsAsErrors = Val; } 2355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getWarningsAsErrors() const { return WarningsAsErrors; } 2365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setWarnOnExtensions - When set to true, issue warnings on GCC extensions, 2385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the equivalent of GCC's -pedantic. 2395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setWarnOnExtensions(bool Val) { WarnOnExtensions = Val; } 2405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getWarnOnExtensions() const { return WarnOnExtensions; } 2415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setErrorOnExtensions - When set to true issue errors for GCC extensions 2435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// instead of warnings. This is the equivalent to GCC's -pedantic-errors. 2445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setErrorOnExtensions(bool Val) { ErrorOnExtensions = Val; } 2455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getErrorOnExtensions() const { return ErrorOnExtensions; } 2465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2472fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar /// setSuppressSystemWarnings - When set to true mask warnings that 2482fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar /// come from system headers. 2492fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar void setSuppressSystemWarnings(bool Val) { SuppressSystemWarnings = Val; } 2502fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar bool getSuppressSystemWarnings() const { return SuppressSystemWarnings; } 2512fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar 2525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setDiagnosticMapping - This allows the client to specify that certain 253f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// warnings are ignored. Only WARNINGs and EXTENSIONs can be mapped. 2545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setDiagnosticMapping(diag::kind Diag, diag::Mapping Map) { 25519e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner assert(Diag < diag::DIAG_UPPER_LIMIT && 2560750618b0beacdc9b0a9e210a661e4746823ced7Chris Lattner "Can only map builtin diagnostics"); 257f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner assert((isBuiltinWarningOrExtension(Diag) || Map == diag::MAP_FATAL) && 2587fc24e2d47e1cdf03e655ed212d282635d755591Chris Lattner "Cannot map errors!"); 259da0cbc1ad4a553c4de111c1181ec7b42c5ddefceChris Lattner unsigned char &Slot = DiagMappings[Diag/2]; 260da0cbc1ad4a553c4de111c1181ec7b42c5ddefceChris Lattner unsigned Bits = (Diag & 1)*4; 261da0cbc1ad4a553c4de111c1181ec7b42c5ddefceChris Lattner Slot &= ~(7 << Bits); 2625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer Slot |= Map << Bits; 2635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 2645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getDiagnosticMapping - Return the mapping currently set for the specified 2665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// diagnostic. 2675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer diag::Mapping getDiagnosticMapping(diag::kind Diag) const { 268da0cbc1ad4a553c4de111c1181ec7b42c5ddefceChris Lattner return (diag::Mapping)((DiagMappings[Diag/2] >> (Diag & 1)*4) & 7); 2695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 2705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool hasErrorOccurred() const { return ErrorOccurred; } 27215221422eda7bac679e38b07512feda49715ef66Chris Lattner bool hasFatalErrorOccurred() const { return FatalErrorOccurred; } 2735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned getNumErrors() const { return NumErrors; } 2755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned getNumDiagnostics() const { return NumDiagnostics; } 2765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 277182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// getCustomDiagID - Return an ID for a diagnostic with the specified message 278182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// and level. If this is the first request for this diagnosic, it is 279182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// registered and created, otherwise the existing ID is returned. 280182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner unsigned getCustomDiagID(Level L, const char *Message); 281182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner 28222caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner 2833fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// ConvertArgToString - This method converts a diagnostic argument (as an 2843fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// intptr_t) into the string that represents it. 2853fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner void ConvertArgToString(ArgumentKind Kind, intptr_t Val, 2863fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Modifier, unsigned ModLen, 2873fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Argument, unsigned ArgLen, 2883fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner llvm::SmallVectorImpl<char> &Output) const { 28992dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner ArgToStringFn(Kind, Val, Modifier, ModLen, Argument, ArgLen, Output, 29092dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner ArgToStringCookie); 29122caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 29222caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner 29392dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner void SetArgToStringFn(ArgToStringFnTy Fn, void *Cookie) { 2943fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ArgToStringFn = Fn; 29592dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner ArgToStringCookie = Cookie; 29622caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 29722caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner 2985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 2995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Diagnostic classification and reporting interfaces. 3005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // 3015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getDescription - Given a diagnostic ID, return a description of the 3035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// issue. 3040a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const char *getDescription(unsigned DiagID) const; 3055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 306f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// isNoteWarningOrExtension - Return true if the unmapped diagnostic 307f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// level of the specified diagnostic ID is a Warning or Extension. 308f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// This only works on builtin diagnostics, not custom ones, and is not legal to 309f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// call on NOTEs. 310f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner static bool isBuiltinWarningOrExtension(unsigned DiagID); 3115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 312ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor /// \brief Determine whether the given built-in diagnostic ID is a 313ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor /// Note. 314ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor static bool isBuiltinNote(unsigned DiagID); 315ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 3165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getDiagnosticLevel - Based on the way the client configured the Diagnostic 3175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// object, classify the specified diagnostic ID into a Level, consumable by 3185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the DiagnosticClient. 319f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner Level getDiagnosticLevel(unsigned DiagID) const; 3200a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 321509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// Report - Issue the message to the client. @c DiagID is a member of the 322509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// @c diag::kind enum. This actually returns aninstance of DiagnosticBuilder 323509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// which emits the diagnostics (through @c ProcessDiag) when it is destroyed. 324509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// @c Pos represents the source location associated with the diagnostic, 325509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// which can be an invalid location if no position information is available. 3263cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner inline DiagnosticBuilder Report(FullSourceLoc Pos, unsigned DiagID); 3270a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 3280a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattnerprivate: 329f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// getDiagnosticLevel - This is an internal implementation helper used when 330f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// DiagClass is already known. 331f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner Level getDiagnosticLevel(unsigned DiagID, unsigned DiagClass) const; 332f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner 3333cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner // This is private state used by DiagnosticBuilder. We put it here instead of 3343cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner // in DiagnosticBuilder in order to keep DiagnosticBuilder a small lightweight 3350a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // object. This implementation choice means that we can only have one 3360a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // diagnostic "in flight" at a time, but this seems to be a reasonable 3370a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // tradeoff to keep these objects small. Assertions verify that only one 3380a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // diagnostic is in flight at a time. 3393cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner friend class DiagnosticBuilder; 3400a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner friend class DiagnosticInfo; 341b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner 342b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner /// CurDiagLoc - This is the location of the current diagnostic that is in 343b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner /// flight. 344b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner FullSourceLoc CurDiagLoc; 3450a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 346b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner /// CurDiagID - This is the ID of the current diagnostic that is in flight. 3473cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// This is set to ~0U when there is no diagnostic in flight. 348b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner unsigned CurDiagID; 349b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner 35073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner enum { 35173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// MaxArguments - The maximum number of arguments we can hold. We currently 35273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// only support up to 10 arguments (%0-%9). A single diagnostic with more 35373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// than that almost certainly has to be simplified anyway. 35473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner MaxArguments = 10 35573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner }; 35673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 3573cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// NumDiagArgs - This contains the number of entries in Arguments. 358730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner signed char NumDiagArgs; 359730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner /// NumRanges - This is the number of ranges in the DiagRanges array. 360730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner unsigned char NumDiagRanges; 3614b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief The number of code modifications hints in the 3624b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// CodeModificationHints array. 3634b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor unsigned char NumCodeModificationHints; 364ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor /// \brief The number of post-diagnostic hooks in the 365ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor /// PostDiagnosticHooks array. 366ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor unsigned char NumPostDiagnosticHooks; 367ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 36873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsKind - This is an array of ArgumentKind::ArgumentKind enum 36973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// values, with one for each argument. This specifies whether the argument 37073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// is in DiagArgumentsStr or in DiagArguments. 37173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner unsigned char DiagArgumentsKind[MaxArguments]; 37273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 37373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsStr - This holds the values of each string argument for the 37473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// current diagnostic. This value is only used when the corresponding 37573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// ArgumentKind is ak_std_string. 37673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner std::string DiagArgumentsStr[MaxArguments]; 37773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 37873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsVal - The values for the various substitution positions. This 37973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// is used when the argument is not an std::string. The specific value is 38073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// mangled into an intptr_t and the intepretation depends on exactly what 38173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// sort of argument kind it is. 38273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner intptr_t DiagArgumentsVal[MaxArguments]; 38373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 3840a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// DiagRanges - The list of ranges added to this diagnostic. It currently 3850a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// only support 10 ranges, could easily be extended if needed. 3860a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const SourceRange *DiagRanges[10]; 3870a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 3884b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor enum { MaxCodeModificationHints = 3 }; 3894b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 3904b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// CodeModificationHints - If valid, provides a hint with some code 3914b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// to insert, remove, or modify at a particular position. 3924b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor CodeModificationHint CodeModificationHints[MaxCodeModificationHints]; 3934b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 394ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor enum { MaxPostDiagnosticHooks = 10 }; 395ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 396ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor /// \brief Functions that will be invoked after the diagnostic has 397ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor /// been emitted. 398ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor PostDiagnosticHook PostDiagnosticHooks[MaxPostDiagnosticHooks]; 399ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 400ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor /// \brief Whether we're already within a post-diagnostic hook. 401ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor bool InPostDiagnosticHook; 402ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 4030a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// ProcessDiag - This is the method used to report a diagnostic that is 4040a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// finally fully formed. 4053cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void ProcessDiag(); 4063cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}; 4073cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 4083cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 4093cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner// DiagnosticBuilder 4103cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 4113cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 4123cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// DiagnosticBuilder - This is a little helper class used to produce 4133cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// diagnostics. This is constructed by the Diagnostic::Report method, and 4143cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// allows insertion of extra information (arguments and source ranges) into the 4153cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// currently "in flight" diagnostic. When the temporary for the builder is 4163cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// destroyed, the diagnostic is issued. 4173cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// 4183cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// Note that many of these will be created as temporary objects (many call 4193cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// sites), so we want them to be small and we never want their address taken. 4203cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// This ensures that compilers with somewhat reasonable optimizers will promote 4213cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// the common fields to registers, eliminating increments of the NumArgs field, 4223cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// for example. 4233cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerclass DiagnosticBuilder { 4243cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner mutable Diagnostic *DiagObj; 425ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor mutable unsigned NumArgs, NumRanges, NumCodeModificationHints, 426ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor NumPostDiagnosticHooks; 42773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 4283cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void operator=(const DiagnosticBuilder&); // DO NOT IMPLEMENT 4293cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner friend class Diagnostic; 4303cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner explicit DiagnosticBuilder(Diagnostic *diagObj) 4314b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor : DiagObj(diagObj), NumArgs(0), NumRanges(0), 432ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor NumCodeModificationHints(0), NumPostDiagnosticHooks(0) {} 433ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 434ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregorpublic: 4350a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// Copy constructor. When copied, this "takes" the diagnostic info from the 4360a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// input and neuters it. 4373cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagnosticBuilder(const DiagnosticBuilder &D) { 4380a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner DiagObj = D.DiagObj; 4390a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner D.DiagObj = 0; 4400a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 4410a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 4420a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// Destructor - The dtor emits the diagnostic. 4433cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner ~DiagnosticBuilder() { 4440a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // If DiagObj is null, then its soul was stolen by the copy ctor. 4453cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner if (DiagObj == 0) return; 44622caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner 44722caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner // When destroyed, the ~DiagnosticBuilder sets the final argument count into 44822caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner // the Diagnostic object. 4493cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->NumDiagArgs = NumArgs; 4503cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->NumDiagRanges = NumRanges; 4514b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor DiagObj->NumCodeModificationHints = NumCodeModificationHints; 452ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor DiagObj->NumPostDiagnosticHooks = NumPostDiagnosticHooks; 4533cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 45422caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner // Process the diagnostic, sending the accumulated information to the 45522caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner // DiagnosticClient. 4563cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->ProcessDiag(); 4570a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 4580a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // This diagnostic is no longer in flight. 4593cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->CurDiagID = ~0U; 4603cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner } 4613cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 4623cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// Operator bool: conversion of DiagnosticBuilder to bool always returns 4633cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// true. This allows is to be used in boolean error contexts like: 4643cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// return Diag(...); 4653cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner operator bool() const { return true; } 4663cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 4673cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void AddString(const std::string &S) const { 4683cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(NumArgs < Diagnostic::MaxArguments && 4693cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 4703cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->DiagArgumentsKind[NumArgs] = Diagnostic::ak_std_string; 4713cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->DiagArgumentsStr[NumArgs++] = S; 4723cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner } 4733cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 4743cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void AddTaggedVal(intptr_t V, Diagnostic::ArgumentKind Kind) const { 4753cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(NumArgs < Diagnostic::MaxArguments && 4763cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 4773cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->DiagArgumentsKind[NumArgs] = Kind; 4783cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->DiagArgumentsVal[NumArgs++] = V; 4790a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 4800a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 4813cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void AddSourceRange(const SourceRange &R) const { 4823cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(NumRanges < 4833cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner sizeof(DiagObj->DiagRanges)/sizeof(DiagObj->DiagRanges[0]) && 4843cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 4853cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->DiagRanges[NumRanges++] = &R; 4863cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner } 4874b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 4884b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor void AddCodeModificationHint(const CodeModificationHint &Hint) const { 4894b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor assert(NumCodeModificationHints < Diagnostic::MaxCodeModificationHints && 4904b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor "Too many code modification hints!"); 4914b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor DiagObj->CodeModificationHints[NumCodeModificationHints++] = Hint; 4924b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 493ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 494ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor void AddPostDiagnosticHook(const PostDiagnosticHook &Hook) const { 495ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor assert(!DiagObj->InPostDiagnosticHook && 496ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor "Can't add a post-diagnostic hook to a diagnostic inside " 497ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor "a post-diagnostic hook"); 498ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor assert(NumPostDiagnosticHooks < Diagnostic::MaxPostDiagnosticHooks && 499ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor "Too many post-diagnostic hooks"); 500ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor DiagObj->PostDiagnosticHooks[NumPostDiagnosticHooks++] = Hook; 501ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor } 5023cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}; 5033cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 5043cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 5053cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const std::string &S) { 5063cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddString(S); 5073cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 5083cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 5093cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 5103cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 5113cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const char *Str) { 5123cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(reinterpret_cast<intptr_t>(Str), 5133cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner Diagnostic::ak_c_string); 5143cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 5153cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 5163cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 5173cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, int I) { 5183cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(I, Diagnostic::ak_sint); 5193cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 5203cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 5213cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 5223bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidisinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,bool I) { 5233bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis DB.AddTaggedVal(I, Diagnostic::ak_sint); 5243bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis return DB; 5253bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis} 5263bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis 5273cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 5283cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner unsigned I) { 5293cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(I, Diagnostic::ak_uint); 5303cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 5313cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 5323cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 5333cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 5343cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const IdentifierInfo *II) { 5353cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(reinterpret_cast<intptr_t>(II), 5363cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner Diagnostic::ak_identifierinfo); 5373cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 5383cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 5393cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 5403cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 5413cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const SourceRange &R) { 5423cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddSourceRange(R); 5433cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 5443cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 5454b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 5464b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregorinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 5474b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor const CodeModificationHint &Hint) { 5484b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor DB.AddCodeModificationHint(Hint); 5494b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor return DB; 5504b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor} 551ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 552ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregorinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 553ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor const PostDiagnosticHook &Hook) { 554ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor DB.AddPostDiagnosticHook(Hook); 555ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor return DB; 556ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor} 5573cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 5583cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 5593cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// Report - Issue the message to the client. DiagID is a member of the 5603cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// diag::kind enum. This actually returns a new instance of DiagnosticBuilder 5613cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// which emits the diagnostics (through ProcessDiag) when it is destroyed. 5623cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline DiagnosticBuilder Diagnostic::Report(FullSourceLoc Loc, unsigned DiagID){ 5633cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(CurDiagID == ~0U && "Multiple diagnostics in flight at once!"); 5643cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner CurDiagLoc = Loc; 5653cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner CurDiagID = DiagID; 5663cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DiagnosticBuilder(this); 5673cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 5683cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 5693cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 5703cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner// DiagnosticInfo 5713cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 5723cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 5733cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// DiagnosticInfo - This is a little helper class (which is basically a smart 5744b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// pointer that forward info from Diagnostic) that allows clients to enquire 5753cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// about the currently in-flight diagnostic. 5763cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerclass DiagnosticInfo { 5773cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const Diagnostic *DiagObj; 5783cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerpublic: 5793cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner explicit DiagnosticInfo(const Diagnostic *DO) : DiagObj(DO) {} 5803cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 5810a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const Diagnostic *getDiags() const { return DiagObj; } 582b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner unsigned getID() const { return DiagObj->CurDiagID; } 583b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner const FullSourceLoc &getLocation() const { return DiagObj->CurDiagLoc; } 58495d1ba492c3191f49392e53acbf878e39fc8ba0aChris Lattner 5850a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned getNumArgs() const { return DiagObj->NumDiagArgs; } 5860a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 58773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgKind - Return the kind of the specified index. Based on the kind 58873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// of argument, the accessors below can be used to get the value. 5893cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner Diagnostic::ArgumentKind getArgKind(unsigned Idx) const { 5903cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(Idx < getNumArgs() && "Argument index out of range!"); 5913cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return (Diagnostic::ArgumentKind)DiagObj->DiagArgumentsKind[Idx]; 59273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner } 59373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 59473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgStdStr - Return the provided argument string specified by Idx. 59573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner const std::string &getArgStdStr(unsigned Idx) const { 5963cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_std_string && 5973cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 59873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner return DiagObj->DiagArgumentsStr[Idx]; 59973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner } 6003cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 60173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgCStr - Return the specified C string argument. 60273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner const char *getArgCStr(unsigned Idx) const { 6033cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_c_string && 6043cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 60573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner return reinterpret_cast<const char*>(DiagObj->DiagArgumentsVal[Idx]); 6060a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 6070a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 60830bc96544346bea42921cf6837e66cef80d664b4Chris Lattner /// getArgSInt - Return the specified signed integer argument. 60930bc96544346bea42921cf6837e66cef80d664b4Chris Lattner int getArgSInt(unsigned Idx) const { 6103cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_sint && 6113cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 61230bc96544346bea42921cf6837e66cef80d664b4Chris Lattner return (int)DiagObj->DiagArgumentsVal[Idx]; 61330bc96544346bea42921cf6837e66cef80d664b4Chris Lattner } 6143cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 61530bc96544346bea42921cf6837e66cef80d664b4Chris Lattner /// getArgUInt - Return the specified unsigned integer argument. 61630bc96544346bea42921cf6837e66cef80d664b4Chris Lattner unsigned getArgUInt(unsigned Idx) const { 6173cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_uint && 6183cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 61930bc96544346bea42921cf6837e66cef80d664b4Chris Lattner return (unsigned)DiagObj->DiagArgumentsVal[Idx]; 62030bc96544346bea42921cf6837e66cef80d664b4Chris Lattner } 62130bc96544346bea42921cf6837e66cef80d664b4Chris Lattner 62243b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner /// getArgIdentifier - Return the specified IdentifierInfo argument. 62343b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner const IdentifierInfo *getArgIdentifier(unsigned Idx) const { 6243cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_identifierinfo && 6253cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 6269634379265855f1628190e926d9aaf1fb4a5d90eChris Lattner return reinterpret_cast<IdentifierInfo*>(DiagObj->DiagArgumentsVal[Idx]); 62743b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner } 62843b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner 62922caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner /// getRawArg - Return the specified non-string argument in an opaque form. 63022caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner intptr_t getRawArg(unsigned Idx) const { 63122caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner assert(getArgKind(Idx) != Diagnostic::ak_std_string && 63222caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner "invalid argument accessor!"); 63322caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner return DiagObj->DiagArgumentsVal[Idx]; 63422caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 63522caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner 63622caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner 6370a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// getNumRanges - Return the number of source ranges associated with this 6380a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// diagnostic. 6390a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned getNumRanges() const { 6400a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner return DiagObj->NumDiagRanges; 6410a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 6420a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 6430a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const SourceRange &getRange(unsigned Idx) const { 6440a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner assert(Idx < DiagObj->NumDiagRanges && "Invalid diagnostic range index!"); 6450a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner return *DiagObj->DiagRanges[Idx]; 6460a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 647520987fc4e5e60c80bcce613b0f8813ffb2fdca0Chris Lattner 6484b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor unsigned getNumCodeModificationHints() const { 6494b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor return DiagObj->NumCodeModificationHints; 6504b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 6514b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 6524b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor const CodeModificationHint &getCodeModificationHint(unsigned Idx) const { 6534b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor return DiagObj->CodeModificationHints[Idx]; 6544b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 6554b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 6564b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor const CodeModificationHint *getCodeModificationHints() const { 6574b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor return DiagObj->NumCodeModificationHints? 6584b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor &DiagObj->CodeModificationHints[0] : 0; 6594b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 6604b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 661f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// FormatDiagnostic - Format this diagnostic into a string, substituting the 662f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// formal arguments into the %0 slots. The result is appended onto the Str 663f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// array. 664f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner void FormatDiagnostic(llvm::SmallVectorImpl<char> &OutStr) const; 6655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 6660a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 6675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// DiagnosticClient - This is an abstract interface implemented by clients of 6685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// the front-end, which formats and prints fully processed diagnostics. 6695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass DiagnosticClient { 6705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 6715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer virtual ~DiagnosticClient(); 672cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek 673cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek /// IncludeInDiagnosticCounts - This method (whose default implementation 674cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek /// returns true) indicates whether the diagnostics handled by this 675cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek /// DiagnosticClient should be included in the number of diagnostics 676cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek /// reported by Diagnostic. 677cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek virtual bool IncludeInDiagnosticCounts() const; 6785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 6795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleDiagnostic - Handle this diagnostic, reporting it to the user or 6805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// capturing it to a log as needed. 6810a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner virtual void HandleDiagnostic(Diagnostic::Level DiagLevel, 6820a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const DiagnosticInfo &Info) = 0; 6835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 6845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 6855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 6865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 6875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 688