Diagnostic.h revision dacd434c49658286c380c7b4c357d76d53cb4aa1
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> 1904ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner#include <vector> 20f86638365f4801ec2d2970f7c0663e94590618b8Chris Lattner#include <cassert> 215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 22f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattnernamespace llvm { 23f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner template <typename T> class SmallVectorImpl; 24f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner} 25f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner 265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang { 275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer class DiagnosticClient; 285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer class SourceRange; 293cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner class DiagnosticBuilder; 30d42ffbd22fc7eb61321f6a88173ee424991f01c6Ted Kremenek class IdentifierInfo; 3140469651a3f8379dc0f32df69e9bade06a2aad36Chris Lattner class LangOptions; 325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Import the diagnostic enums themselves. 345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer namespace diag { 3519e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner // Start position for diagnostics. 3619e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner enum { 374ad4b3ebbe5769143389dccfcfadb666a4ba5940Daniel Dunbar DIAG_START_DRIVER = 300, 3850f4f469024928670f2d634c445686d00eeb89b7Daniel Dunbar DIAG_START_FRONTEND = DIAG_START_DRIVER + 100, 3950f4f469024928670f2d634c445686d00eeb89b7Daniel Dunbar DIAG_START_LEX = DIAG_START_FRONTEND + 100, 4019e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_START_PARSE = DIAG_START_LEX + 300, 4119e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_START_AST = DIAG_START_PARSE + 300, 4219e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_START_SEMA = DIAG_START_AST + 100, 4319e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_START_ANALYSIS = DIAG_START_SEMA + 1000, 4419e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_UPPER_LIMIT = DIAG_START_ANALYSIS + 100 4519e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner }; 4619e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner 47182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner class CustomDiagInfo; 48182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner 495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// diag::kind - All of the diagnostics that can be emitted by the frontend. 5020c6b3b85e186cd52d5d99489132d71d498159ebChris Lattner typedef unsigned kind; 5120c6b3b85e186cd52d5d99489132d71d498159ebChris Lattner 5288eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner // Get typedefs for common diagnostics. 5388eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner enum { 545e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor#define DIAG(ENUM,FLAGS,DEFAULT_MAPPING,DESC,GROUP,SFINAE) ENUM, 554d7a089144f336b11e5e8ce437b3b27bce2b310dSebastian Redl#include "clang/Basic/DiagnosticCommonKinds.inc" 5688eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner NUM_BUILTIN_COMMON_DIAGNOSTICS 5788eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner#undef DIAG 5888eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner }; 5988eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner 605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Enum values that allow the client to map NOTEs, WARNINGs, and EXTENSIONs 615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to either MAP_IGNORE (nothing), MAP_WARNING (emit a warning), MAP_ERROR 6227ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// (emit as an error). It allows clients to map errors to 6327ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// MAP_ERROR/MAP_DEFAULT or MAP_FATAL (stop emitting diagnostics after this 6427ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// one). 655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer enum Mapping { 66691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner // NOTE: 0 means "uncomputed". 67691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner MAP_IGNORE = 1, //< Map this diagnostic to nothing, ignore it. 68691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner MAP_WARNING = 2, //< Map this diagnostic to a warning. 69691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner MAP_ERROR = 3, //< Map this diagnostic to an error. 702b07d8fe9e8a8ba12d64066632e17a9a5308a12eChris Lattner MAP_FATAL = 4, //< Map this diagnostic to a fatal error. 712b07d8fe9e8a8ba12d64066632e17a9a5308a12eChris Lattner 72b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// Map this diagnostic to "warning", but make it immune to -Werror. This 73b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// happens when you specify -Wno-error=foo. 74b54b276a920246c595a0498da281821eb9d22996Chris Lattner MAP_WARNING_NO_WERROR = 5 755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 784b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// \brief Annotates a diagnostic with some code that should be 794b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// inserted, removed, or replaced to fix the problem. 804b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// 814b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// This kind of hint should be used when we are certain that the 824b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// introduction, removal, or modification of a particular (small!) 834b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// amount of code will correct a compilation error. The compiler 844b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// should also provide full recovery from such errors, such that 85b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor/// suppressing the diagnostic output can still result in successful 864b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// compilation. 874b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregorclass CodeModificationHint { 884b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregorpublic: 894b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Tokens that should be removed to correct the error. 904b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor SourceRange RemoveRange; 914b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 924b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief The location at which we should insert code to correct 934b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// the error. 944b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor SourceLocation InsertionLoc; 954b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 964b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief The actual code to insert at the insertion location, as a 974b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// string. 984b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor std::string CodeToInsert; 994b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1004b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Empty code modification hint, indicating that no code 1014b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// modification is known. 1024b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor CodeModificationHint() : RemoveRange(), InsertionLoc() { } 1034b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1044b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that inserts the given 1054b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// code string at a specific location. 106b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor static CodeModificationHint CreateInsertion(SourceLocation InsertionLoc, 107b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor const std::string &Code) { 108b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor CodeModificationHint Hint; 109b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.InsertionLoc = InsertionLoc; 110b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.CodeToInsert = Code; 111b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 112b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 1134b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1144b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that removes the given 1154b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// source range. 116b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor static CodeModificationHint CreateRemoval(SourceRange RemoveRange) { 117b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor CodeModificationHint Hint; 118b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.RemoveRange = RemoveRange; 119b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 120b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 1214b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1224b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that replaces the given 1234b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// source range with the given code string. 124b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor static CodeModificationHint CreateReplacement(SourceRange RemoveRange, 125b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor const std::string &Code) { 126b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor CodeModificationHint Hint; 127b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.RemoveRange = RemoveRange; 128b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.InsertionLoc = RemoveRange.getBegin(); 129b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.CodeToInsert = Code; 130b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 131b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 1324b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor}; 1334b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// Diagnostic - This concrete class is used by the front-end to report 1355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// problems and issues. It massages the diagnostics (e.g. handling things like 1365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// "report warnings as errors" and passes them off to the DiagnosticClient for 1375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// reporting to the user. 1385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass Diagnostic { 139182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattnerpublic: 140182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// Level - The level of the diagnostic, after it has been through mapping. 141182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner enum Level { 142da0cbc1ad4a553c4de111c1181ec7b42c5ddefceChris Lattner Ignored, Note, Warning, Error, Fatal 143182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner }; 144182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner 145b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// ExtensionHandling - How do we handle otherwise-unmapped extension? This 146b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// is controlled by -pedantic and -pedantic-errors. 147b54b276a920246c595a0498da281821eb9d22996Chris Lattner enum ExtensionHandling { 148b54b276a920246c595a0498da281821eb9d22996Chris Lattner Ext_Ignore, Ext_Warn, Ext_Error 149b54b276a920246c595a0498da281821eb9d22996Chris Lattner }; 150b54b276a920246c595a0498da281821eb9d22996Chris Lattner 1513fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner enum ArgumentKind { 15247b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_std_string, // std::string 15347b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_c_string, // const char * 15447b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_sint, // int 15547b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_uint, // unsigned 15647b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_identifierinfo, // IdentifierInfo 15747b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_qualtype, // QualType 15847b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_declarationname, // DeclarationName 159dacd434c49658286c380c7b4c357d76d53cb4aa1Douglas Gregor ak_nameddecl, // NamedDecl * 160dacd434c49658286c380c7b4c357d76d53cb4aa1Douglas Gregor ak_nestednamespec // NestedNameSpecifier * 1613fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner }; 162ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 16327ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattnerprivate: 16427ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner unsigned char AllExtensionsSilenced; // Used by __extension__ 165b54b276a920246c595a0498da281821eb9d22996Chris Lattner bool IgnoreAllWarnings; // Ignore all warnings: -w 166b54b276a920246c595a0498da281821eb9d22996Chris Lattner bool WarningsAsErrors; // Treat warnings like errors: 167b54b276a920246c595a0498da281821eb9d22996Chris Lattner bool SuppressSystemWarnings; // Suppress warnings in system headers. 168b54b276a920246c595a0498da281821eb9d22996Chris Lattner ExtensionHandling ExtBehavior; // Map extensions onto warnings or errors? 169b4398aa27da4d6919c3ae448d1ae66ba6cafc048Ted Kremenek DiagnosticClient *Client; 1705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// DiagMappings - Mapping information for diagnostics. Mapping info is 172691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// packed into four bits per diagnostic. The low three bits are the mapping 173691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// (an instance of diag::Mapping), or zero if unset. The high bit is set 174691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// when the mapping was established as a user mapping. If the high bit is 175691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// clear, then the low bits are set to the default value, and should be 176691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// mapped with -pedantic, -Werror, etc. 17704ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 17804ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner typedef std::vector<unsigned char> DiagMappings; 17904ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner mutable std::vector<DiagMappings> DiagMappingsStack; 18004ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 18115221422eda7bac679e38b07512feda49715ef66Chris Lattner /// ErrorOccurred / FatalErrorOccurred - This is set to true when an error or 18215221422eda7bac679e38b07512feda49715ef66Chris Lattner /// fatal error is emitted, and is sticky. 1835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ErrorOccurred; 18415221422eda7bac679e38b07512feda49715ef66Chris Lattner bool FatalErrorOccurred; 185f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner 186f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// LastDiagLevel - This is the level of the last diagnostic emitted. This is 187f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// used to emit continuation diagnostics with the same level as the 188f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// diagnostic that they follow. 189f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner Diagnostic::Level LastDiagLevel; 1905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumDiagnostics; // Number of diagnostics reported 1925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumErrors; // Number of diagnostics that are errors 193182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner 194182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// CustomDiagInfo - Information for uniquing and looking up custom diags. 195182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner diag::CustomDiagInfo *CustomDiagInfo; 1967bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber 1973fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// ArgToStringFn - A function pointer that converts an opaque diagnostic 1983fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// argument to a strings. This takes the modifiers and argument that was 1993fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// present in the diagnostic. 20022caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner /// This is a hack to avoid a layering violation between libbasic and libsema. 2013fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner typedef void (*ArgToStringFnTy)(ArgumentKind Kind, intptr_t Val, 2023fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Modifier, unsigned ModifierLen, 2033fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Argument, unsigned ArgumentLen, 20492dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner llvm::SmallVectorImpl<char> &Output, 20592dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner void *Cookie); 20692dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner void *ArgToStringCookie; 2073fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ArgToStringFnTy ArgToStringFn; 2085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 2097bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber explicit Diagnostic(DiagnosticClient *client = 0); 210182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner ~Diagnostic(); 2115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 2135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Diagnostic characterization methods, used by a client to customize how 2145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // 2152bf78fba7a37a42d4295999706053fdf4c9625e2Ted Kremenek 2167bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber DiagnosticClient *getClient() { return Client; }; 2177bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber const DiagnosticClient *getClient() const { return Client; }; 218b4398aa27da4d6919c3ae448d1ae66ba6cafc048Ted Kremenek 21904ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 22004ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// pushMappings - Copies the current DiagMappings and pushes the new copy 22104ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// onto the top of the stack. 22204ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner void pushMappings(); 22304ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 22404ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// popMappings - Pops the current DiagMappings off the top of the stack 22504ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// causing the new top of the stack to be the active mappings. Returns 22604ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// true if the pop happens, false if there is only one DiagMapping on the 22704ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// stack. 22804ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner bool popMappings(); 22904ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 230b4398aa27da4d6919c3ae448d1ae66ba6cafc048Ted Kremenek void setClient(DiagnosticClient* client) { Client = client; } 2315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2325b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner /// setIgnoreAllWarnings - When set to true, any unmapped warnings are 2335b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner /// ignored. If this and WarningsAsErrors are both set, then this one wins. 2345b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner void setIgnoreAllWarnings(bool Val) { IgnoreAllWarnings = Val; } 2355b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner bool getIgnoreAllWarnings() const { return IgnoreAllWarnings; } 2365b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner 2375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setWarningsAsErrors - When set to true, any warnings reported are issued 2385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// as errors. 2395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setWarningsAsErrors(bool Val) { WarningsAsErrors = Val; } 2405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getWarningsAsErrors() const { return WarningsAsErrors; } 2415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2422fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar /// setSuppressSystemWarnings - When set to true mask warnings that 2432fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar /// come from system headers. 2442fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar void setSuppressSystemWarnings(bool Val) { SuppressSystemWarnings = Val; } 2452fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar bool getSuppressSystemWarnings() const { return SuppressSystemWarnings; } 2462fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar 247b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// setExtensionHandlingBehavior - This controls whether otherwise-unmapped 248b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// extension diagnostics are mapped onto ignore/warning/error. This 249b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// corresponds to the GCC -pedantic and -pedantic-errors option. 250b54b276a920246c595a0498da281821eb9d22996Chris Lattner void setExtensionHandlingBehavior(ExtensionHandling H) { 251b54b276a920246c595a0498da281821eb9d22996Chris Lattner ExtBehavior = H; 252b54b276a920246c595a0498da281821eb9d22996Chris Lattner } 253b54b276a920246c595a0498da281821eb9d22996Chris Lattner 25427ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// AllExtensionsSilenced - This is a counter bumped when an __extension__ 25527ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// block is encountered. When non-zero, all extension diagnostics are 25627ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// entirely silenced, no matter how they are mapped. 25727ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner void IncrementAllExtensionsSilenced() { ++AllExtensionsSilenced; } 25827ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner void DecrementAllExtensionsSilenced() { --AllExtensionsSilenced; } 25927ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner 2605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setDiagnosticMapping - This allows the client to specify that certain 261691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// warnings are ignored. Notes can never be mapped, errors can only be 262691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// mapped to fatal, and WARNINGs and EXTENSIONs can be mapped arbitrarily. 2635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setDiagnosticMapping(diag::kind Diag, diag::Mapping Map) { 26419e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner assert(Diag < diag::DIAG_UPPER_LIMIT && 2650750618b0beacdc9b0a9e210a661e4746823ced7Chris Lattner "Can only map builtin diagnostics"); 266f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner assert((isBuiltinWarningOrExtension(Diag) || Map == diag::MAP_FATAL) && 2677fc24e2d47e1cdf03e655ed212d282635d755591Chris Lattner "Cannot map errors!"); 268691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner setDiagnosticMappingInternal(Diag, Map, true); 26927ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner } 2703bc172bc6a787842db6fea351cf6929539fca70dChris Lattner 2713bc172bc6a787842db6fea351cf6929539fca70dChris Lattner /// setDiagnosticGroupMapping - Change an entire diagnostic group (e.g. 2723bc172bc6a787842db6fea351cf6929539fca70dChris Lattner /// "unknown-pragmas" to have the specified mapping. This returns true and 2733bc172bc6a787842db6fea351cf6929539fca70dChris Lattner /// ignores the request if "Group" was unknown, false otherwise. 2743bc172bc6a787842db6fea351cf6929539fca70dChris Lattner bool setDiagnosticGroupMapping(const char *Group, diag::Mapping Map); 2755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool hasErrorOccurred() const { return ErrorOccurred; } 27715221422eda7bac679e38b07512feda49715ef66Chris Lattner bool hasFatalErrorOccurred() const { return FatalErrorOccurred; } 2785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned getNumErrors() const { return NumErrors; } 2805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned getNumDiagnostics() const { return NumDiagnostics; } 2815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 282182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// getCustomDiagID - Return an ID for a diagnostic with the specified message 283182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// and level. If this is the first request for this diagnosic, it is 284182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// registered and created, otherwise the existing ID is returned. 285182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner unsigned getCustomDiagID(Level L, const char *Message); 286182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner 28722caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner 2883fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// ConvertArgToString - This method converts a diagnostic argument (as an 2893fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// intptr_t) into the string that represents it. 2903fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner void ConvertArgToString(ArgumentKind Kind, intptr_t Val, 2913fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Modifier, unsigned ModLen, 2923fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Argument, unsigned ArgLen, 2933fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner llvm::SmallVectorImpl<char> &Output) const { 29492dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner ArgToStringFn(Kind, Val, Modifier, ModLen, Argument, ArgLen, Output, 29592dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner ArgToStringCookie); 29622caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 29722caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner 29892dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner void SetArgToStringFn(ArgToStringFnTy Fn, void *Cookie) { 2993fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ArgToStringFn = Fn; 30092dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner ArgToStringCookie = Cookie; 30122caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 30222caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner 3035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 3045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Diagnostic classification and reporting interfaces. 3055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // 3065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getDescription - Given a diagnostic ID, return a description of the 3085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// issue. 3090a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const char *getDescription(unsigned DiagID) const; 3105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 311f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// isNoteWarningOrExtension - Return true if the unmapped diagnostic 312f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// level of the specified diagnostic ID is a Warning or Extension. 313f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// This only works on builtin diagnostics, not custom ones, and is not legal to 314f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// call on NOTEs. 315f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner static bool isBuiltinWarningOrExtension(unsigned DiagID); 3165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 317ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor /// \brief Determine whether the given built-in diagnostic ID is a 318ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor /// Note. 319ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor static bool isBuiltinNote(unsigned DiagID); 32027ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner 32127ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// isBuiltinExtensionDiag - Determine whether the given built-in diagnostic 32227ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// ID is for an extension of some sort. 32327ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// 32427ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner static bool isBuiltinExtensionDiag(unsigned DiagID); 32527ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner 326d51d74a3e89c5e5fc9bfd2814996a5feab6dc932Chris Lattner /// getWarningOptionForDiag - Return the lowest-level warning option that 327d51d74a3e89c5e5fc9bfd2814996a5feab6dc932Chris Lattner /// enables the specified diagnostic. If there is no -Wfoo flag that controls 328d51d74a3e89c5e5fc9bfd2814996a5feab6dc932Chris Lattner /// the diagnostic, this returns null. 329d51d74a3e89c5e5fc9bfd2814996a5feab6dc932Chris Lattner static const char *getWarningOptionForDiag(unsigned DiagID); 330ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 3315e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// \brief Determines whether the given built-in diagnostic ID is 3325e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// for an error that is suppressed if it occurs during C++ template 3335e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// argument deduction. 3345e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// 3355e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// When an error is suppressed due to SFINAE, the template argument 3365e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// deduction fails but no diagnostic is emitted. Certain classes of 3375e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// errors, such as those errors that involve C++ access control, 3385e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// are not SFINAE errors. 3395e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor static bool isBuiltinSFINAEDiag(unsigned DiagID); 3405e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor 3415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getDiagnosticLevel - Based on the way the client configured the Diagnostic 3425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// object, classify the specified diagnostic ID into a Level, consumable by 3435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the DiagnosticClient. 344f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner Level getDiagnosticLevel(unsigned DiagID) const; 3450a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 346509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// Report - Issue the message to the client. @c DiagID is a member of the 347509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// @c diag::kind enum. This actually returns aninstance of DiagnosticBuilder 348509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// which emits the diagnostics (through @c ProcessDiag) when it is destroyed. 349509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// @c Pos represents the source location associated with the diagnostic, 350509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// which can be an invalid location if no position information is available. 3513cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner inline DiagnosticBuilder Report(FullSourceLoc Pos, unsigned DiagID); 352de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor 353de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor /// \brief Clear out the current diagnostic. 354de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor void Clear() { CurDiagID = ~0U; } 3550a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 3560a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattnerprivate: 357691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// getDiagnosticMappingInfo - Return the mapping info currently set for the 358691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// specified builtin diagnostic. This returns the high bit encoding, or zero 359691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// if the field is completely uninitialized. 360691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner unsigned getDiagnosticMappingInfo(diag::kind Diag) const { 36104ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner const DiagMappings ¤tMappings = DiagMappingsStack.back(); 36204ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner return (diag::Mapping)((currentMappings[Diag/2] >> (Diag & 1)*4) & 15); 363691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner } 364691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner 365691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner void setDiagnosticMappingInternal(unsigned DiagId, unsigned Map, 366691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner bool isUser) const { 367691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner if (isUser) Map |= 8; // Set the high bit for user mappings. 36804ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner unsigned char &Slot = DiagMappingsStack.back()[DiagId/2]; 369691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner unsigned Shift = (DiagId & 1)*4; 370691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner Slot &= ~(15 << Shift); 371691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner Slot |= Map << Shift; 3729faf50e62ddcd2535b472abc8daafd7042120caaChris Lattner } 3739faf50e62ddcd2535b472abc8daafd7042120caaChris Lattner 374f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// getDiagnosticLevel - This is an internal implementation helper used when 375f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// DiagClass is already known. 376f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner Level getDiagnosticLevel(unsigned DiagID, unsigned DiagClass) const; 377f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner 3783cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner // This is private state used by DiagnosticBuilder. We put it here instead of 3793cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner // in DiagnosticBuilder in order to keep DiagnosticBuilder a small lightweight 3800a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // object. This implementation choice means that we can only have one 3810a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // diagnostic "in flight" at a time, but this seems to be a reasonable 3820a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // tradeoff to keep these objects small. Assertions verify that only one 3830a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // diagnostic is in flight at a time. 3843cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner friend class DiagnosticBuilder; 3850a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner friend class DiagnosticInfo; 386b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner 387b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner /// CurDiagLoc - This is the location of the current diagnostic that is in 388b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner /// flight. 389b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner FullSourceLoc CurDiagLoc; 3900a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 391b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner /// CurDiagID - This is the ID of the current diagnostic that is in flight. 3923cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// This is set to ~0U when there is no diagnostic in flight. 393b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner unsigned CurDiagID; 394b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner 39573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner enum { 39673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// MaxArguments - The maximum number of arguments we can hold. We currently 39773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// only support up to 10 arguments (%0-%9). A single diagnostic with more 39873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// than that almost certainly has to be simplified anyway. 39973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner MaxArguments = 10 40073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner }; 40173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 4023cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// NumDiagArgs - This contains the number of entries in Arguments. 403730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner signed char NumDiagArgs; 404730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner /// NumRanges - This is the number of ranges in the DiagRanges array. 405730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner unsigned char NumDiagRanges; 4064b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief The number of code modifications hints in the 4074b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// CodeModificationHints array. 4084b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor unsigned char NumCodeModificationHints; 409ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 41073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsKind - This is an array of ArgumentKind::ArgumentKind enum 41173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// values, with one for each argument. This specifies whether the argument 41273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// is in DiagArgumentsStr or in DiagArguments. 41373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner unsigned char DiagArgumentsKind[MaxArguments]; 41473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 41573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsStr - This holds the values of each string argument for the 41673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// current diagnostic. This value is only used when the corresponding 41773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// ArgumentKind is ak_std_string. 41873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner std::string DiagArgumentsStr[MaxArguments]; 41973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 42073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsVal - The values for the various substitution positions. This 42173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// is used when the argument is not an std::string. The specific value is 42273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// mangled into an intptr_t and the intepretation depends on exactly what 42373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// sort of argument kind it is. 42473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner intptr_t DiagArgumentsVal[MaxArguments]; 42573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 4260a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// DiagRanges - The list of ranges added to this diagnostic. It currently 4270a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// only support 10 ranges, could easily be extended if needed. 4280a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const SourceRange *DiagRanges[10]; 4290a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 4304b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor enum { MaxCodeModificationHints = 3 }; 4314b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 4324b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// CodeModificationHints - If valid, provides a hint with some code 4334b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// to insert, remove, or modify at a particular position. 4344b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor CodeModificationHint CodeModificationHints[MaxCodeModificationHints]; 4354b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 4360a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// ProcessDiag - This is the method used to report a diagnostic that is 4370a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// finally fully formed. 4385e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// 4395e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// \returns true if the diagnostic was emitted, false if it was 4405e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// suppressed. 4415e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor bool ProcessDiag(); 4423cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}; 4433cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 4443cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 4453cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner// DiagnosticBuilder 4463cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 4473cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 4483cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// DiagnosticBuilder - This is a little helper class used to produce 4493cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// diagnostics. This is constructed by the Diagnostic::Report method, and 4503cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// allows insertion of extra information (arguments and source ranges) into the 4513cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// currently "in flight" diagnostic. When the temporary for the builder is 4523cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// destroyed, the diagnostic is issued. 4533cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// 4543cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// Note that many of these will be created as temporary objects (many call 4553cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// sites), so we want them to be small and we never want their address taken. 4563cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// This ensures that compilers with somewhat reasonable optimizers will promote 4573cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// the common fields to registers, eliminating increments of the NumArgs field, 4583cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// for example. 4593cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerclass DiagnosticBuilder { 4603cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner mutable Diagnostic *DiagObj; 46125a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor mutable unsigned NumArgs, NumRanges, NumCodeModificationHints; 46273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 4633cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void operator=(const DiagnosticBuilder&); // DO NOT IMPLEMENT 4643cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner friend class Diagnostic; 4653cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner explicit DiagnosticBuilder(Diagnostic *diagObj) 4664b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor : DiagObj(diagObj), NumArgs(0), NumRanges(0), 46725a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor NumCodeModificationHints(0) {} 468ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 469ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregorpublic: 4700a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// Copy constructor. When copied, this "takes" the diagnostic info from the 4710a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// input and neuters it. 4723cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagnosticBuilder(const DiagnosticBuilder &D) { 4730a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner DiagObj = D.DiagObj; 4740a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner D.DiagObj = 0; 47525a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor NumArgs = D.NumArgs; 47625a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor NumRanges = D.NumRanges; 47725a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor NumCodeModificationHints = D.NumCodeModificationHints; 4780a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 47925a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor 4805e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// \brief Simple enumeration value used to give a name to the 4815e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// suppress-diagnostic constructor. 4825e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor enum SuppressKind { Suppress }; 4835e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor 4845e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// \brief Create an empty DiagnosticBuilder object that represents 4855e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// no actual diagnostic. 4865e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor explicit DiagnosticBuilder(SuppressKind) 4875e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor : DiagObj(0), NumArgs(0), NumRanges(0), NumCodeModificationHints(0) { } 4885e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor 48925a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// \brief Force the diagnostic builder to emit the diagnostic now. 49025a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// 49125a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// Once this function has been called, the DiagnosticBuilder object 49225a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// should not be used again before it is destroyed. 4935e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// 4945e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// \returns true if a diagnostic was emitted, false if the 4955e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// diagnostic was suppressed. 4965e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor bool Emit() { 49725a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor // If DiagObj is null, then its soul was stolen by the copy ctor 49825a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor // or the user called Emit(). 4995e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor if (DiagObj == 0) return false; 50022caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner 50125a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor // When emitting diagnostics, we set the final argument count into 50222caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner // the Diagnostic object. 5033cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->NumDiagArgs = NumArgs; 5043cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->NumDiagRanges = NumRanges; 5054b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor DiagObj->NumCodeModificationHints = NumCodeModificationHints; 5063cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 50722caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner // Process the diagnostic, sending the accumulated information to the 50822caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner // DiagnosticClient. 5095e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor bool Emitted = DiagObj->ProcessDiag(); 5100a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 511de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor // Clear out the current diagnostic object. 512de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor DiagObj->Clear(); 51325a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor 51425a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor // This diagnostic is dead. 51525a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor DiagObj = 0; 5165e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor 5175e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor return Emitted; 5183cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner } 51925a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor 52025a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// Destructor - The dtor emits the diagnostic if it hasn't already 52125a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// been emitted. 52225a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor ~DiagnosticBuilder() { Emit(); } 5233cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 5243cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// Operator bool: conversion of DiagnosticBuilder to bool always returns 5253cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// true. This allows is to be used in boolean error contexts like: 5263cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// return Diag(...); 5273cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner operator bool() const { return true; } 5283cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 5293cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void AddString(const std::string &S) const { 5303cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(NumArgs < Diagnostic::MaxArguments && 5313cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 5325e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor if (DiagObj) { 5335e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor DiagObj->DiagArgumentsKind[NumArgs] = Diagnostic::ak_std_string; 5345e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor DiagObj->DiagArgumentsStr[NumArgs++] = S; 5355e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor } 5363cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner } 5373cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 5383cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void AddTaggedVal(intptr_t V, Diagnostic::ArgumentKind Kind) const { 5393cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(NumArgs < Diagnostic::MaxArguments && 5403cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 5415e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor if (DiagObj) { 5425e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor DiagObj->DiagArgumentsKind[NumArgs] = Kind; 5435e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor DiagObj->DiagArgumentsVal[NumArgs++] = V; 5445e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor } 5450a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 5460a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 5473cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void AddSourceRange(const SourceRange &R) const { 5483cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(NumRanges < 5493cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner sizeof(DiagObj->DiagRanges)/sizeof(DiagObj->DiagRanges[0]) && 5503cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 5515e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor if (DiagObj) 5525e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor DiagObj->DiagRanges[NumRanges++] = &R; 5533cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner } 5544b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 5554b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor void AddCodeModificationHint(const CodeModificationHint &Hint) const { 5564b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor assert(NumCodeModificationHints < Diagnostic::MaxCodeModificationHints && 5574b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor "Too many code modification hints!"); 5585e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor if (DiagObj) 5595e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor DiagObj->CodeModificationHints[NumCodeModificationHints++] = Hint; 5604b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 5613cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}; 5623cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 5633cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 5643cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const std::string &S) { 5653cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddString(S); 5663cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 5673cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 5683cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 5693cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 5703cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const char *Str) { 5713cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(reinterpret_cast<intptr_t>(Str), 5723cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner Diagnostic::ak_c_string); 5733cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 5743cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 5753cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 5763cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, int I) { 5773cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(I, Diagnostic::ak_sint); 5783cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 5793cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 5803cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 5813bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidisinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,bool I) { 5823bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis DB.AddTaggedVal(I, Diagnostic::ak_sint); 5833bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis return DB; 5843bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis} 5853bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis 5863cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 5873cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner unsigned I) { 5883cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(I, Diagnostic::ak_uint); 5893cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 5903cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 5913cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 5923cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 5933cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const IdentifierInfo *II) { 5943cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(reinterpret_cast<intptr_t>(II), 5953cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner Diagnostic::ak_identifierinfo); 5963cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 5973cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 5983cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 5993cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 6003cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const SourceRange &R) { 6013cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddSourceRange(R); 6023cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 6033cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 6044b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 6054b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregorinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 6064b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor const CodeModificationHint &Hint) { 6074b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor DB.AddCodeModificationHint(Hint); 6084b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor return DB; 6094b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor} 610ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 6113cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// Report - Issue the message to the client. DiagID is a member of the 6123cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// diag::kind enum. This actually returns a new instance of DiagnosticBuilder 6133cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// which emits the diagnostics (through ProcessDiag) when it is destroyed. 6143cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline DiagnosticBuilder Diagnostic::Report(FullSourceLoc Loc, unsigned DiagID){ 6153cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(CurDiagID == ~0U && "Multiple diagnostics in flight at once!"); 6163cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner CurDiagLoc = Loc; 6173cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner CurDiagID = DiagID; 6183cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DiagnosticBuilder(this); 6193cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 6203cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 6213cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 6223cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner// DiagnosticInfo 6233cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 6243cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 6253cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// DiagnosticInfo - This is a little helper class (which is basically a smart 6264b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// pointer that forward info from Diagnostic) that allows clients to enquire 6273cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// about the currently in-flight diagnostic. 6283cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerclass DiagnosticInfo { 6293cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const Diagnostic *DiagObj; 6303cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerpublic: 6313cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner explicit DiagnosticInfo(const Diagnostic *DO) : DiagObj(DO) {} 6323cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 6330a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const Diagnostic *getDiags() const { return DiagObj; } 634b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner unsigned getID() const { return DiagObj->CurDiagID; } 635b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner const FullSourceLoc &getLocation() const { return DiagObj->CurDiagLoc; } 63695d1ba492c3191f49392e53acbf878e39fc8ba0aChris Lattner 6370a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned getNumArgs() const { return DiagObj->NumDiagArgs; } 6380a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 63973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgKind - Return the kind of the specified index. Based on the kind 64073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// of argument, the accessors below can be used to get the value. 6413cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner Diagnostic::ArgumentKind getArgKind(unsigned Idx) const { 6423cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(Idx < getNumArgs() && "Argument index out of range!"); 6433cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return (Diagnostic::ArgumentKind)DiagObj->DiagArgumentsKind[Idx]; 64473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner } 64573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 64673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgStdStr - Return the provided argument string specified by Idx. 64773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner const std::string &getArgStdStr(unsigned Idx) const { 6483cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_std_string && 6493cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 65073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner return DiagObj->DiagArgumentsStr[Idx]; 65173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner } 6523cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 65373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgCStr - Return the specified C string argument. 65473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner const char *getArgCStr(unsigned Idx) const { 6553cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_c_string && 6563cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 65773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner return reinterpret_cast<const char*>(DiagObj->DiagArgumentsVal[Idx]); 6580a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 6590a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 66030bc96544346bea42921cf6837e66cef80d664b4Chris Lattner /// getArgSInt - Return the specified signed integer argument. 66130bc96544346bea42921cf6837e66cef80d664b4Chris Lattner int getArgSInt(unsigned Idx) const { 6623cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_sint && 6633cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 66430bc96544346bea42921cf6837e66cef80d664b4Chris Lattner return (int)DiagObj->DiagArgumentsVal[Idx]; 66530bc96544346bea42921cf6837e66cef80d664b4Chris Lattner } 6663cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 66730bc96544346bea42921cf6837e66cef80d664b4Chris Lattner /// getArgUInt - Return the specified unsigned integer argument. 66830bc96544346bea42921cf6837e66cef80d664b4Chris Lattner unsigned getArgUInt(unsigned Idx) const { 6693cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_uint && 6703cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 67130bc96544346bea42921cf6837e66cef80d664b4Chris Lattner return (unsigned)DiagObj->DiagArgumentsVal[Idx]; 67230bc96544346bea42921cf6837e66cef80d664b4Chris Lattner } 67330bc96544346bea42921cf6837e66cef80d664b4Chris Lattner 67443b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner /// getArgIdentifier - Return the specified IdentifierInfo argument. 67543b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner const IdentifierInfo *getArgIdentifier(unsigned Idx) const { 6763cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_identifierinfo && 6773cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 6789634379265855f1628190e926d9aaf1fb4a5d90eChris Lattner return reinterpret_cast<IdentifierInfo*>(DiagObj->DiagArgumentsVal[Idx]); 67943b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner } 68043b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner 68122caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner /// getRawArg - Return the specified non-string argument in an opaque form. 68222caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner intptr_t getRawArg(unsigned Idx) const { 68322caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner assert(getArgKind(Idx) != Diagnostic::ak_std_string && 68422caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner "invalid argument accessor!"); 68522caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner return DiagObj->DiagArgumentsVal[Idx]; 68622caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 68722caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner 68822caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner 6890a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// getNumRanges - Return the number of source ranges associated with this 6900a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// diagnostic. 6910a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned getNumRanges() const { 6920a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner return DiagObj->NumDiagRanges; 6930a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 6940a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 6950a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const SourceRange &getRange(unsigned Idx) const { 6960a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner assert(Idx < DiagObj->NumDiagRanges && "Invalid diagnostic range index!"); 6970a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner return *DiagObj->DiagRanges[Idx]; 6980a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 699520987fc4e5e60c80bcce613b0f8813ffb2fdca0Chris Lattner 7004b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor unsigned getNumCodeModificationHints() const { 7014b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor return DiagObj->NumCodeModificationHints; 7024b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 7034b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 7044b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor const CodeModificationHint &getCodeModificationHint(unsigned Idx) const { 7054b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor return DiagObj->CodeModificationHints[Idx]; 7064b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 7074b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 7084b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor const CodeModificationHint *getCodeModificationHints() const { 7094b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor return DiagObj->NumCodeModificationHints? 7104b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor &DiagObj->CodeModificationHints[0] : 0; 7114b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 7124b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 713f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// FormatDiagnostic - Format this diagnostic into a string, substituting the 714f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// formal arguments into the %0 slots. The result is appended onto the Str 715f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// array. 716f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner void FormatDiagnostic(llvm::SmallVectorImpl<char> &OutStr) const; 7175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 7180a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 7195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// DiagnosticClient - This is an abstract interface implemented by clients of 7205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// the front-end, which formats and prints fully processed diagnostics. 7215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass DiagnosticClient { 7225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 7235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer virtual ~DiagnosticClient(); 724cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek 72540469651a3f8379dc0f32df69e9bade06a2aad36Chris Lattner /// setLangOptions - This is set by clients of diagnostics when they know the 72640469651a3f8379dc0f32df69e9bade06a2aad36Chris Lattner /// language parameters of the diagnostics that may be sent through. Note 72740469651a3f8379dc0f32df69e9bade06a2aad36Chris Lattner /// that this can change over time if a DiagClient has multiple languages sent 72840469651a3f8379dc0f32df69e9bade06a2aad36Chris Lattner /// through it. It may also be set to null (e.g. when processing command line 72940469651a3f8379dc0f32df69e9bade06a2aad36Chris Lattner /// options). 73040469651a3f8379dc0f32df69e9bade06a2aad36Chris Lattner virtual void setLangOptions(const LangOptions *LO) {} 73140469651a3f8379dc0f32df69e9bade06a2aad36Chris Lattner 732cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek /// IncludeInDiagnosticCounts - This method (whose default implementation 733cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek /// returns true) indicates whether the diagnostics handled by this 734cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek /// DiagnosticClient should be included in the number of diagnostics 735cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek /// reported by Diagnostic. 736cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek virtual bool IncludeInDiagnosticCounts() const; 7375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 7385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleDiagnostic - Handle this diagnostic, reporting it to the user or 7395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// capturing it to a log as needed. 7400a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner virtual void HandleDiagnostic(Diagnostic::Level DiagLevel, 7410a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const DiagnosticInfo &Info) = 0; 7425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 7435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 7445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 7455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 7465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 747