Diagnostic.h revision b54b276a920246c595a0498da281821eb9d22996
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 { 354ad4b3ebbe5769143389dccfcfadb666a4ba5940Daniel Dunbar DIAG_START_DRIVER = 300, 3650f4f469024928670f2d634c445686d00eeb89b7Daniel Dunbar DIAG_START_FRONTEND = DIAG_START_DRIVER + 100, 3750f4f469024928670f2d634c445686d00eeb89b7Daniel Dunbar DIAG_START_LEX = DIAG_START_FRONTEND + 100, 3819e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_START_PARSE = DIAG_START_LEX + 300, 3919e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_START_AST = DIAG_START_PARSE + 300, 4019e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_START_SEMA = DIAG_START_AST + 100, 4119e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_START_ANALYSIS = DIAG_START_SEMA + 1000, 4219e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_UPPER_LIMIT = DIAG_START_ANALYSIS + 100 4319e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner }; 4419e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner 45182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner class CustomDiagInfo; 46182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner 475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// diag::kind - All of the diagnostics that can be emitted by the frontend. 4820c6b3b85e186cd52d5d99489132d71d498159ebChris Lattner typedef unsigned kind; 4920c6b3b85e186cd52d5d99489132d71d498159ebChris Lattner 5088eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner // Get typedefs for common diagnostics. 5188eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner enum { 524ac072aceb9c68f7a023050e2ab9ccacb4fe6e5bChris Lattner#define DIAG(ENUM,FLAGS,DEFAULT_MAPPING,DESC) ENUM, 534d7a089144f336b11e5e8ce437b3b27bce2b310dSebastian Redl#include "clang/Basic/DiagnosticCommonKinds.inc" 5488eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner NUM_BUILTIN_COMMON_DIAGNOSTICS 5588eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner#undef DIAG 5688eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner }; 5788eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner 585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Enum values that allow the client to map NOTEs, WARNINGs, and EXTENSIONs 595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to either MAP_IGNORE (nothing), MAP_WARNING (emit a warning), MAP_ERROR 6027ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// (emit as an error). It allows clients to map errors to 6127ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// MAP_ERROR/MAP_DEFAULT or MAP_FATAL (stop emitting diagnostics after this 6227ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// one). 635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer enum Mapping { 64691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner // NOTE: 0 means "uncomputed". 65691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner MAP_IGNORE = 1, //< Map this diagnostic to nothing, ignore it. 66691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner MAP_WARNING = 2, //< Map this diagnostic to a warning. 67691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner MAP_ERROR = 3, //< Map this diagnostic to an error. 682b07d8fe9e8a8ba12d64066632e17a9a5308a12eChris Lattner MAP_FATAL = 4, //< Map this diagnostic to a fatal error. 692b07d8fe9e8a8ba12d64066632e17a9a5308a12eChris Lattner 70b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// Map this diagnostic to "warning", but make it immune to -Werror. This 71b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// happens when you specify -Wno-error=foo. 72b54b276a920246c595a0498da281821eb9d22996Chris Lattner MAP_WARNING_NO_WERROR = 5 735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 764b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// \brief Annotates a diagnostic with some code that should be 774b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// inserted, removed, or replaced to fix the problem. 784b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// 794b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// This kind of hint should be used when we are certain that the 804b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// introduction, removal, or modification of a particular (small!) 814b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// amount of code will correct a compilation error. The compiler 824b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// should also provide full recovery from such errors, such that 83b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor/// suppressing the diagnostic output can still result in successful 844b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// compilation. 854b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregorclass CodeModificationHint { 864b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregorpublic: 874b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Tokens that should be removed to correct the error. 884b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor SourceRange RemoveRange; 894b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 904b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief The location at which we should insert code to correct 914b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// the error. 924b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor SourceLocation InsertionLoc; 934b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 944b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief The actual code to insert at the insertion location, as a 954b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// string. 964b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor std::string CodeToInsert; 974b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 984b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Empty code modification hint, indicating that no code 994b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// modification is known. 1004b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor CodeModificationHint() : RemoveRange(), InsertionLoc() { } 1014b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1024b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that inserts the given 1034b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// code string at a specific location. 104b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor static CodeModificationHint CreateInsertion(SourceLocation InsertionLoc, 105b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor const std::string &Code) { 106b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor CodeModificationHint Hint; 107b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.InsertionLoc = InsertionLoc; 108b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.CodeToInsert = Code; 109b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 110b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 1114b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1124b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that removes the given 1134b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// source range. 114b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor static CodeModificationHint CreateRemoval(SourceRange RemoveRange) { 115b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor CodeModificationHint Hint; 116b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.RemoveRange = RemoveRange; 117b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 118b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 1194b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1204b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that replaces the given 1214b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// source range with the given code string. 122b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor static CodeModificationHint CreateReplacement(SourceRange RemoveRange, 123b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor const std::string &Code) { 124b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor CodeModificationHint Hint; 125b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.RemoveRange = RemoveRange; 126b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.InsertionLoc = RemoveRange.getBegin(); 127b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.CodeToInsert = Code; 128b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 129b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 1304b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor}; 1314b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// Diagnostic - This concrete class is used by the front-end to report 1335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// problems and issues. It massages the diagnostics (e.g. handling things like 1345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// "report warnings as errors" and passes them off to the DiagnosticClient for 1355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// reporting to the user. 1365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass Diagnostic { 137182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattnerpublic: 138182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// Level - The level of the diagnostic, after it has been through mapping. 139182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner enum Level { 140da0cbc1ad4a553c4de111c1181ec7b42c5ddefceChris Lattner Ignored, Note, Warning, Error, Fatal 141182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner }; 142182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner 143b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// ExtensionHandling - How do we handle otherwise-unmapped extension? This 144b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// is controlled by -pedantic and -pedantic-errors. 145b54b276a920246c595a0498da281821eb9d22996Chris Lattner enum ExtensionHandling { 146b54b276a920246c595a0498da281821eb9d22996Chris Lattner Ext_Ignore, Ext_Warn, Ext_Error 147b54b276a920246c595a0498da281821eb9d22996Chris Lattner }; 148b54b276a920246c595a0498da281821eb9d22996Chris Lattner 1493fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner enum ArgumentKind { 15047b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_std_string, // std::string 15147b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_c_string, // const char * 15247b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_sint, // int 15347b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_uint, // unsigned 15447b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_identifierinfo, // IdentifierInfo 15547b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_qualtype, // QualType 15647b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_declarationname, // DeclarationName 1575bf17cd277db2a253f6012968471064c4f4537a3Anders Carlsson ak_nameddecl // NamedDecl * 1583fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner }; 159ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 16027ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattnerprivate: 16127ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner unsigned char AllExtensionsSilenced; // Used by __extension__ 162b54b276a920246c595a0498da281821eb9d22996Chris Lattner bool IgnoreAllWarnings; // Ignore all warnings: -w 163b54b276a920246c595a0498da281821eb9d22996Chris Lattner bool WarningsAsErrors; // Treat warnings like errors: 164b54b276a920246c595a0498da281821eb9d22996Chris Lattner bool SuppressSystemWarnings; // Suppress warnings in system headers. 165b54b276a920246c595a0498da281821eb9d22996Chris Lattner ExtensionHandling ExtBehavior; // Map extensions onto warnings or errors? 166b4398aa27da4d6919c3ae448d1ae66ba6cafc048Ted Kremenek DiagnosticClient *Client; 1675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// DiagMappings - Mapping information for diagnostics. Mapping info is 169691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// packed into four bits per diagnostic. The low three bits are the mapping 170691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// (an instance of diag::Mapping), or zero if unset. The high bit is set 171691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// when the mapping was established as a user mapping. If the high bit is 172691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// clear, then the low bits are set to the default value, and should be 173691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// mapped with -pedantic, -Werror, etc. 174691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner mutable unsigned char DiagMappings[diag::DIAG_UPPER_LIMIT/2]; 1755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 17615221422eda7bac679e38b07512feda49715ef66Chris Lattner /// ErrorOccurred / FatalErrorOccurred - This is set to true when an error or 17715221422eda7bac679e38b07512feda49715ef66Chris Lattner /// fatal error is emitted, and is sticky. 1785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ErrorOccurred; 17915221422eda7bac679e38b07512feda49715ef66Chris Lattner bool FatalErrorOccurred; 180f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner 181f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// LastDiagLevel - This is the level of the last diagnostic emitted. This is 182f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// used to emit continuation diagnostics with the same level as the 183f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// diagnostic that they follow. 184f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner Diagnostic::Level LastDiagLevel; 1855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumDiagnostics; // Number of diagnostics reported 1875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumErrors; // Number of diagnostics that are errors 188182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner 189182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// CustomDiagInfo - Information for uniquing and looking up custom diags. 190182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner diag::CustomDiagInfo *CustomDiagInfo; 1917bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber 1923fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// ArgToStringFn - A function pointer that converts an opaque diagnostic 1933fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// argument to a strings. This takes the modifiers and argument that was 1943fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// present in the diagnostic. 19522caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner /// This is a hack to avoid a layering violation between libbasic and libsema. 1963fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner typedef void (*ArgToStringFnTy)(ArgumentKind Kind, intptr_t Val, 1973fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Modifier, unsigned ModifierLen, 1983fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Argument, unsigned ArgumentLen, 19992dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner llvm::SmallVectorImpl<char> &Output, 20092dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner void *Cookie); 20192dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner void *ArgToStringCookie; 2023fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ArgToStringFnTy ArgToStringFn; 2035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 2047bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber explicit Diagnostic(DiagnosticClient *client = 0); 205182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner ~Diagnostic(); 2065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 2085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Diagnostic characterization methods, used by a client to customize how 2095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // 2102bf78fba7a37a42d4295999706053fdf4c9625e2Ted Kremenek 2117bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber DiagnosticClient *getClient() { return Client; }; 2127bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber const DiagnosticClient *getClient() const { return Client; }; 213b4398aa27da4d6919c3ae448d1ae66ba6cafc048Ted Kremenek 214b4398aa27da4d6919c3ae448d1ae66ba6cafc048Ted Kremenek void setClient(DiagnosticClient* client) { Client = client; } 2155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2165b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner /// setIgnoreAllWarnings - When set to true, any unmapped warnings are 2175b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner /// ignored. If this and WarningsAsErrors are both set, then this one wins. 2185b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner void setIgnoreAllWarnings(bool Val) { IgnoreAllWarnings = Val; } 2195b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner bool getIgnoreAllWarnings() const { return IgnoreAllWarnings; } 2205b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner 2215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setWarningsAsErrors - When set to true, any warnings reported are issued 2225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// as errors. 2235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setWarningsAsErrors(bool Val) { WarningsAsErrors = Val; } 2245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getWarningsAsErrors() const { return WarningsAsErrors; } 2255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2262fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar /// setSuppressSystemWarnings - When set to true mask warnings that 2272fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar /// come from system headers. 2282fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar void setSuppressSystemWarnings(bool Val) { SuppressSystemWarnings = Val; } 2292fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar bool getSuppressSystemWarnings() const { return SuppressSystemWarnings; } 2302fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar 231b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// setExtensionHandlingBehavior - This controls whether otherwise-unmapped 232b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// extension diagnostics are mapped onto ignore/warning/error. This 233b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// corresponds to the GCC -pedantic and -pedantic-errors option. 234b54b276a920246c595a0498da281821eb9d22996Chris Lattner void setExtensionHandlingBehavior(ExtensionHandling H) { 235b54b276a920246c595a0498da281821eb9d22996Chris Lattner ExtBehavior = H; 236b54b276a920246c595a0498da281821eb9d22996Chris Lattner } 237b54b276a920246c595a0498da281821eb9d22996Chris Lattner 23827ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// AllExtensionsSilenced - This is a counter bumped when an __extension__ 23927ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// block is encountered. When non-zero, all extension diagnostics are 24027ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// entirely silenced, no matter how they are mapped. 24127ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner void IncrementAllExtensionsSilenced() { ++AllExtensionsSilenced; } 24227ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner void DecrementAllExtensionsSilenced() { --AllExtensionsSilenced; } 24327ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner 2445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setDiagnosticMapping - This allows the client to specify that certain 245691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// warnings are ignored. Notes can never be mapped, errors can only be 246691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// mapped to fatal, and WARNINGs and EXTENSIONs can be mapped arbitrarily. 2475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setDiagnosticMapping(diag::kind Diag, diag::Mapping Map) { 24819e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner assert(Diag < diag::DIAG_UPPER_LIMIT && 2490750618b0beacdc9b0a9e210a661e4746823ced7Chris Lattner "Can only map builtin diagnostics"); 250f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner assert((isBuiltinWarningOrExtension(Diag) || Map == diag::MAP_FATAL) && 2517fc24e2d47e1cdf03e655ed212d282635d755591Chris Lattner "Cannot map errors!"); 252691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner setDiagnosticMappingInternal(Diag, Map, true); 25327ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner } 2545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool hasErrorOccurred() const { return ErrorOccurred; } 25615221422eda7bac679e38b07512feda49715ef66Chris Lattner bool hasFatalErrorOccurred() const { return FatalErrorOccurred; } 2575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned getNumErrors() const { return NumErrors; } 2595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned getNumDiagnostics() const { return NumDiagnostics; } 2605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 261182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// getCustomDiagID - Return an ID for a diagnostic with the specified message 262182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// and level. If this is the first request for this diagnosic, it is 263182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// registered and created, otherwise the existing ID is returned. 264182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner unsigned getCustomDiagID(Level L, const char *Message); 265182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner 26622caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner 2673fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// ConvertArgToString - This method converts a diagnostic argument (as an 2683fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// intptr_t) into the string that represents it. 2693fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner void ConvertArgToString(ArgumentKind Kind, intptr_t Val, 2703fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Modifier, unsigned ModLen, 2713fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Argument, unsigned ArgLen, 2723fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner llvm::SmallVectorImpl<char> &Output) const { 27392dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner ArgToStringFn(Kind, Val, Modifier, ModLen, Argument, ArgLen, Output, 27492dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner ArgToStringCookie); 27522caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 27622caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner 27792dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner void SetArgToStringFn(ArgToStringFnTy Fn, void *Cookie) { 2783fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ArgToStringFn = Fn; 27992dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner ArgToStringCookie = Cookie; 28022caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 28122caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner 2825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 2835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Diagnostic classification and reporting interfaces. 2845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // 2855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getDescription - Given a diagnostic ID, return a description of the 2875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// issue. 2880a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const char *getDescription(unsigned DiagID) const; 2895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 290f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// isNoteWarningOrExtension - Return true if the unmapped diagnostic 291f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// level of the specified diagnostic ID is a Warning or Extension. 292f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// This only works on builtin diagnostics, not custom ones, and is not legal to 293f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// call on NOTEs. 294f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner static bool isBuiltinWarningOrExtension(unsigned DiagID); 2955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 296ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor /// \brief Determine whether the given built-in diagnostic ID is a 297ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor /// Note. 298ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor static bool isBuiltinNote(unsigned DiagID); 29927ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner 30027ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// isBuiltinExtensionDiag - Determine whether the given built-in diagnostic 30127ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// ID is for an extension of some sort. 30227ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// 30327ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner static bool isBuiltinExtensionDiag(unsigned DiagID); 30427ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner 305ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 3065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getDiagnosticLevel - Based on the way the client configured the Diagnostic 3075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// object, classify the specified diagnostic ID into a Level, consumable by 3085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the DiagnosticClient. 309f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner Level getDiagnosticLevel(unsigned DiagID) const; 3100a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 311509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// Report - Issue the message to the client. @c DiagID is a member of the 312509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// @c diag::kind enum. This actually returns aninstance of DiagnosticBuilder 313509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// which emits the diagnostics (through @c ProcessDiag) when it is destroyed. 314509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// @c Pos represents the source location associated with the diagnostic, 315509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// which can be an invalid location if no position information is available. 3163cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner inline DiagnosticBuilder Report(FullSourceLoc Pos, unsigned DiagID); 317de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor 318de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor /// \brief Clear out the current diagnostic. 319de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor void Clear() { CurDiagID = ~0U; } 3200a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 3210a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattnerprivate: 322691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// getDiagnosticMappingInfo - Return the mapping info currently set for the 323691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// specified builtin diagnostic. This returns the high bit encoding, or zero 324691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// if the field is completely uninitialized. 325691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner unsigned getDiagnosticMappingInfo(diag::kind Diag) const { 326691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner return (diag::Mapping)((DiagMappings[Diag/2] >> (Diag & 1)*4) & 15); 327691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner } 328691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner 329691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner void setDiagnosticMappingInternal(unsigned DiagId, unsigned Map, 330691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner bool isUser) const { 331691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner if (isUser) Map |= 8; // Set the high bit for user mappings. 332691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner unsigned char &Slot = DiagMappings[DiagId/2]; 333691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner unsigned Shift = (DiagId & 1)*4; 334691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner Slot &= ~(15 << Shift); 335691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner Slot |= Map << Shift; 3369faf50e62ddcd2535b472abc8daafd7042120caaChris Lattner } 3379faf50e62ddcd2535b472abc8daafd7042120caaChris Lattner 338f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// getDiagnosticLevel - This is an internal implementation helper used when 339f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// DiagClass is already known. 340f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner Level getDiagnosticLevel(unsigned DiagID, unsigned DiagClass) const; 341f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner 3423cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner // This is private state used by DiagnosticBuilder. We put it here instead of 3433cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner // in DiagnosticBuilder in order to keep DiagnosticBuilder a small lightweight 3440a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // object. This implementation choice means that we can only have one 3450a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // diagnostic "in flight" at a time, but this seems to be a reasonable 3460a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // tradeoff to keep these objects small. Assertions verify that only one 3470a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // diagnostic is in flight at a time. 3483cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner friend class DiagnosticBuilder; 3490a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner friend class DiagnosticInfo; 350b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner 351b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner /// CurDiagLoc - This is the location of the current diagnostic that is in 352b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner /// flight. 353b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner FullSourceLoc CurDiagLoc; 3540a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 355b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner /// CurDiagID - This is the ID of the current diagnostic that is in flight. 3563cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// This is set to ~0U when there is no diagnostic in flight. 357b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner unsigned CurDiagID; 358b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner 35973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner enum { 36073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// MaxArguments - The maximum number of arguments we can hold. We currently 36173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// only support up to 10 arguments (%0-%9). A single diagnostic with more 36273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// than that almost certainly has to be simplified anyway. 36373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner MaxArguments = 10 36473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner }; 36573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 3663cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// NumDiagArgs - This contains the number of entries in Arguments. 367730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner signed char NumDiagArgs; 368730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner /// NumRanges - This is the number of ranges in the DiagRanges array. 369730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner unsigned char NumDiagRanges; 3704b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief The number of code modifications hints in the 3714b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// CodeModificationHints array. 3724b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor unsigned char NumCodeModificationHints; 373ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 37473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsKind - This is an array of ArgumentKind::ArgumentKind enum 37573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// values, with one for each argument. This specifies whether the argument 37673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// is in DiagArgumentsStr or in DiagArguments. 37773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner unsigned char DiagArgumentsKind[MaxArguments]; 37873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 37973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsStr - This holds the values of each string argument for the 38073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// current diagnostic. This value is only used when the corresponding 38173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// ArgumentKind is ak_std_string. 38273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner std::string DiagArgumentsStr[MaxArguments]; 38373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 38473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsVal - The values for the various substitution positions. This 38573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// is used when the argument is not an std::string. The specific value is 38673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// mangled into an intptr_t and the intepretation depends on exactly what 38773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// sort of argument kind it is. 38873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner intptr_t DiagArgumentsVal[MaxArguments]; 38973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 3900a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// DiagRanges - The list of ranges added to this diagnostic. It currently 3910a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// only support 10 ranges, could easily be extended if needed. 3920a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const SourceRange *DiagRanges[10]; 3930a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 3944b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor enum { MaxCodeModificationHints = 3 }; 3954b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 3964b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// CodeModificationHints - If valid, provides a hint with some code 3974b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// to insert, remove, or modify at a particular position. 3984b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor CodeModificationHint CodeModificationHints[MaxCodeModificationHints]; 3994b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 4000a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// ProcessDiag - This is the method used to report a diagnostic that is 4010a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// finally fully formed. 4023cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void ProcessDiag(); 4033cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}; 4043cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 4053cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 4063cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner// DiagnosticBuilder 4073cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 4083cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 4093cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// DiagnosticBuilder - This is a little helper class used to produce 4103cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// diagnostics. This is constructed by the Diagnostic::Report method, and 4113cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// allows insertion of extra information (arguments and source ranges) into the 4123cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// currently "in flight" diagnostic. When the temporary for the builder is 4133cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// destroyed, the diagnostic is issued. 4143cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// 4153cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// Note that many of these will be created as temporary objects (many call 4163cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// sites), so we want them to be small and we never want their address taken. 4173cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// This ensures that compilers with somewhat reasonable optimizers will promote 4183cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// the common fields to registers, eliminating increments of the NumArgs field, 4193cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// for example. 4203cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerclass DiagnosticBuilder { 4213cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner mutable Diagnostic *DiagObj; 42225a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor mutable unsigned NumArgs, NumRanges, NumCodeModificationHints; 42373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 4243cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void operator=(const DiagnosticBuilder&); // DO NOT IMPLEMENT 4253cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner friend class Diagnostic; 4263cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner explicit DiagnosticBuilder(Diagnostic *diagObj) 4274b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor : DiagObj(diagObj), NumArgs(0), NumRanges(0), 42825a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor NumCodeModificationHints(0) {} 429ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 430ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregorpublic: 4310a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// Copy constructor. When copied, this "takes" the diagnostic info from the 4320a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// input and neuters it. 4333cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagnosticBuilder(const DiagnosticBuilder &D) { 4340a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner DiagObj = D.DiagObj; 4350a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner D.DiagObj = 0; 43625a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor NumArgs = D.NumArgs; 43725a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor NumRanges = D.NumRanges; 43825a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor NumCodeModificationHints = D.NumCodeModificationHints; 4390a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 44025a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor 44125a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// \brief Force the diagnostic builder to emit the diagnostic now. 44225a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// 44325a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// Once this function has been called, the DiagnosticBuilder object 44425a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// should not be used again before it is destroyed. 44525a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor void Emit() { 44625a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor // If DiagObj is null, then its soul was stolen by the copy ctor 44725a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor // or the user called Emit(). 4483cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner if (DiagObj == 0) return; 44922caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner 45025a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor // When emitting diagnostics, we set the final argument count into 45122caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner // the Diagnostic object. 4523cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->NumDiagArgs = NumArgs; 4533cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->NumDiagRanges = NumRanges; 4544b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor DiagObj->NumCodeModificationHints = NumCodeModificationHints; 4553cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 45622caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner // Process the diagnostic, sending the accumulated information to the 45722caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner // DiagnosticClient. 4583cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->ProcessDiag(); 4590a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 460de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor // Clear out the current diagnostic object. 461de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor DiagObj->Clear(); 46225a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor 46325a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor // This diagnostic is dead. 46425a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor DiagObj = 0; 4653cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner } 46625a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor 46725a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// Destructor - The dtor emits the diagnostic if it hasn't already 46825a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// been emitted. 46925a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor ~DiagnosticBuilder() { Emit(); } 4703cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 4713cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// Operator bool: conversion of DiagnosticBuilder to bool always returns 4723cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// true. This allows is to be used in boolean error contexts like: 4733cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// return Diag(...); 4743cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner operator bool() const { return true; } 4753cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 4763cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void AddString(const std::string &S) const { 4773cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(NumArgs < Diagnostic::MaxArguments && 4783cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 4793cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->DiagArgumentsKind[NumArgs] = Diagnostic::ak_std_string; 4803cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->DiagArgumentsStr[NumArgs++] = S; 4813cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner } 4823cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 4833cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void AddTaggedVal(intptr_t V, Diagnostic::ArgumentKind Kind) const { 4843cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(NumArgs < Diagnostic::MaxArguments && 4853cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 4863cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->DiagArgumentsKind[NumArgs] = Kind; 4873cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->DiagArgumentsVal[NumArgs++] = V; 4880a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 4890a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 4903cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void AddSourceRange(const SourceRange &R) const { 4913cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(NumRanges < 4923cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner sizeof(DiagObj->DiagRanges)/sizeof(DiagObj->DiagRanges[0]) && 4933cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 4943cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->DiagRanges[NumRanges++] = &R; 4953cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner } 4964b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 4974b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor void AddCodeModificationHint(const CodeModificationHint &Hint) const { 4984b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor assert(NumCodeModificationHints < Diagnostic::MaxCodeModificationHints && 4994b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor "Too many code modification hints!"); 5004b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor DiagObj->CodeModificationHints[NumCodeModificationHints++] = Hint; 5014b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas 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 5523cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// Report - Issue the message to the client. DiagID is a member of the 5533cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// diag::kind enum. This actually returns a new instance of DiagnosticBuilder 5543cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// which emits the diagnostics (through ProcessDiag) when it is destroyed. 5553cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline DiagnosticBuilder Diagnostic::Report(FullSourceLoc Loc, unsigned DiagID){ 5563cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(CurDiagID == ~0U && "Multiple diagnostics in flight at once!"); 5573cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner CurDiagLoc = Loc; 5583cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner CurDiagID = DiagID; 5593cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DiagnosticBuilder(this); 5603cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 5613cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 5623cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 5633cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner// DiagnosticInfo 5643cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 5653cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 5663cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// DiagnosticInfo - This is a little helper class (which is basically a smart 5674b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// pointer that forward info from Diagnostic) that allows clients to enquire 5683cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// about the currently in-flight diagnostic. 5693cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerclass DiagnosticInfo { 5703cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const Diagnostic *DiagObj; 5713cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerpublic: 5723cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner explicit DiagnosticInfo(const Diagnostic *DO) : DiagObj(DO) {} 5733cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 5740a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const Diagnostic *getDiags() const { return DiagObj; } 575b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner unsigned getID() const { return DiagObj->CurDiagID; } 576b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner const FullSourceLoc &getLocation() const { return DiagObj->CurDiagLoc; } 57795d1ba492c3191f49392e53acbf878e39fc8ba0aChris Lattner 5780a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned getNumArgs() const { return DiagObj->NumDiagArgs; } 5790a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 58073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgKind - Return the kind of the specified index. Based on the kind 58173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// of argument, the accessors below can be used to get the value. 5823cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner Diagnostic::ArgumentKind getArgKind(unsigned Idx) const { 5833cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(Idx < getNumArgs() && "Argument index out of range!"); 5843cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return (Diagnostic::ArgumentKind)DiagObj->DiagArgumentsKind[Idx]; 58573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner } 58673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 58773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgStdStr - Return the provided argument string specified by Idx. 58873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner const std::string &getArgStdStr(unsigned Idx) const { 5893cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_std_string && 5903cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 59173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner return DiagObj->DiagArgumentsStr[Idx]; 59273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner } 5933cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 59473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgCStr - Return the specified C string argument. 59573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner const char *getArgCStr(unsigned Idx) const { 5963cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_c_string && 5973cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 59873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner return reinterpret_cast<const char*>(DiagObj->DiagArgumentsVal[Idx]); 5990a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 6000a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 60130bc96544346bea42921cf6837e66cef80d664b4Chris Lattner /// getArgSInt - Return the specified signed integer argument. 60230bc96544346bea42921cf6837e66cef80d664b4Chris Lattner int getArgSInt(unsigned Idx) const { 6033cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_sint && 6043cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 60530bc96544346bea42921cf6837e66cef80d664b4Chris Lattner return (int)DiagObj->DiagArgumentsVal[Idx]; 60630bc96544346bea42921cf6837e66cef80d664b4Chris Lattner } 6073cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 60830bc96544346bea42921cf6837e66cef80d664b4Chris Lattner /// getArgUInt - Return the specified unsigned integer argument. 60930bc96544346bea42921cf6837e66cef80d664b4Chris Lattner unsigned getArgUInt(unsigned Idx) const { 6103cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_uint && 6113cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 61230bc96544346bea42921cf6837e66cef80d664b4Chris Lattner return (unsigned)DiagObj->DiagArgumentsVal[Idx]; 61330bc96544346bea42921cf6837e66cef80d664b4Chris Lattner } 61430bc96544346bea42921cf6837e66cef80d664b4Chris Lattner 61543b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner /// getArgIdentifier - Return the specified IdentifierInfo argument. 61643b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner const IdentifierInfo *getArgIdentifier(unsigned Idx) const { 6173cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_identifierinfo && 6183cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 6199634379265855f1628190e926d9aaf1fb4a5d90eChris Lattner return reinterpret_cast<IdentifierInfo*>(DiagObj->DiagArgumentsVal[Idx]); 62043b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner } 62143b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner 62222caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner /// getRawArg - Return the specified non-string argument in an opaque form. 62322caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner intptr_t getRawArg(unsigned Idx) const { 62422caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner assert(getArgKind(Idx) != Diagnostic::ak_std_string && 62522caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner "invalid argument accessor!"); 62622caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner return DiagObj->DiagArgumentsVal[Idx]; 62722caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 62822caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner 62922caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner 6300a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// getNumRanges - Return the number of source ranges associated with this 6310a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// diagnostic. 6320a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned getNumRanges() const { 6330a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner return DiagObj->NumDiagRanges; 6340a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 6350a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 6360a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const SourceRange &getRange(unsigned Idx) const { 6370a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner assert(Idx < DiagObj->NumDiagRanges && "Invalid diagnostic range index!"); 6380a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner return *DiagObj->DiagRanges[Idx]; 6390a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 640520987fc4e5e60c80bcce613b0f8813ffb2fdca0Chris Lattner 6414b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor unsigned getNumCodeModificationHints() const { 6424b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor return DiagObj->NumCodeModificationHints; 6434b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 6444b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 6454b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor const CodeModificationHint &getCodeModificationHint(unsigned Idx) const { 6464b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor return DiagObj->CodeModificationHints[Idx]; 6474b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 6484b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 6494b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor const CodeModificationHint *getCodeModificationHints() const { 6504b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor return DiagObj->NumCodeModificationHints? 6514b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor &DiagObj->CodeModificationHints[0] : 0; 6524b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 6534b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 654f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// FormatDiagnostic - Format this diagnostic into a string, substituting the 655f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// formal arguments into the %0 slots. The result is appended onto the Str 656f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// array. 657f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner void FormatDiagnostic(llvm::SmallVectorImpl<char> &OutStr) const; 6585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 6590a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 6605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// DiagnosticClient - This is an abstract interface implemented by clients of 6615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// the front-end, which formats and prints fully processed diagnostics. 6625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass DiagnosticClient { 6635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 6645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer virtual ~DiagnosticClient(); 665cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek 666cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek /// IncludeInDiagnosticCounts - This method (whose default implementation 667cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek /// returns true) indicates whether the diagnostics handled by this 668cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek /// DiagnosticClient should be included in the number of diagnostics 669cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek /// reported by Diagnostic. 670cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek virtual bool IncludeInDiagnosticCounts() const; 6715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 6725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleDiagnostic - Handle this diagnostic, reporting it to the user or 6735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// capturing it to a log as needed. 6740a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner virtual void HandleDiagnostic(Diagnostic::Level DiagLevel, 6750a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const DiagnosticInfo &Info) = 0; 6765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 6775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 6785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 6795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 6805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 681