Diagnostic.h revision 6c1cb9916e9988dcdd65b9266dbe24afd173427a
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" 1828019772db70d4547be05a042eb950bc910f134fDouglas Gregor#include "llvm/ADT/IntrusiveRefCntPtr.h" 19eaea925e70e3ee85809e572aa8474b8dfc491af7Daniel Dunbar#include "llvm/ADT/StringRef.h" 203f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor#include "llvm/Support/type_traits.h" 215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include <string> 2204ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner#include <vector> 23f86638365f4801ec2d2970f7c0663e94590618b8Chris Lattner#include <cassert> 245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 25f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattnernamespace llvm { 26f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner template <typename T> class SmallVectorImpl; 27d93256e55673a17d18543397ec462416acb13792Douglas Gregor class raw_ostream; 28f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner} 29f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner 305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang { 313f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor class DeclContext; 323cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner class DiagnosticBuilder; 33b2153946fff330e54abfdc740c0a83aedd485b33Anders Carlsson class DiagnosticClient; 34d93256e55673a17d18543397ec462416acb13792Douglas Gregor class FileManager; 35d42ffbd22fc7eb61321f6a88173ee424991f01c6Ted Kremenek class IdentifierInfo; 3640469651a3f8379dc0f32df69e9bade06a2aad36Chris Lattner class LangOptions; 37b2153946fff330e54abfdc740c0a83aedd485b33Anders Carlsson class PartialDiagnostic; 387d90199f109290e9d587479a481a2850d390b552Daniel Dunbar class Preprocessor; 39d93256e55673a17d18543397ec462416acb13792Douglas Gregor class SourceManager; 40b2153946fff330e54abfdc740c0a83aedd485b33Anders Carlsson class SourceRange; 411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Import the diagnostic enums themselves. 435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer namespace diag { 4419e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner // Start position for diagnostics. 4519e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner enum { 464ad4b3ebbe5769143389dccfcfadb666a4ba5940Daniel Dunbar DIAG_START_DRIVER = 300, 4750f4f469024928670f2d634c445686d00eeb89b7Daniel Dunbar DIAG_START_FRONTEND = DIAG_START_DRIVER + 100, 4850f4f469024928670f2d634c445686d00eeb89b7Daniel Dunbar DIAG_START_LEX = DIAG_START_FRONTEND + 100, 4919e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_START_PARSE = DIAG_START_LEX + 300, 5019e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_START_AST = DIAG_START_PARSE + 300, 5119e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_START_SEMA = DIAG_START_AST + 100, 52bb092bafa984e9fa05136b5cef40fd4374dea0f6Douglas Gregor DIAG_START_ANALYSIS = DIAG_START_SEMA + 1500, 5319e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_UPPER_LIMIT = DIAG_START_ANALYSIS + 100 5419e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner }; 5519e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner 56182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner class CustomDiagInfo; 571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// diag::kind - All of the diagnostics that can be emitted by the frontend. 5920c6b3b85e186cd52d5d99489132d71d498159ebChris Lattner typedef unsigned kind; 6020c6b3b85e186cd52d5d99489132d71d498159ebChris Lattner 6188eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner // Get typedefs for common diagnostics. 6288eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner enum { 635e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor#define DIAG(ENUM,FLAGS,DEFAULT_MAPPING,DESC,GROUP,SFINAE) ENUM, 644d7a089144f336b11e5e8ce437b3b27bce2b310dSebastian Redl#include "clang/Basic/DiagnosticCommonKinds.inc" 6588eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner NUM_BUILTIN_COMMON_DIAGNOSTICS 6688eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner#undef DIAG 6788eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner }; 681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Enum values that allow the client to map NOTEs, WARNINGs, and EXTENSIONs 705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to either MAP_IGNORE (nothing), MAP_WARNING (emit a warning), MAP_ERROR 7127ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// (emit as an error). It allows clients to map errors to 7227ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// MAP_ERROR/MAP_DEFAULT or MAP_FATAL (stop emitting diagnostics after this 7327ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// one). 745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer enum Mapping { 75691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner // NOTE: 0 means "uncomputed". 76691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner MAP_IGNORE = 1, //< Map this diagnostic to nothing, ignore it. 77691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner MAP_WARNING = 2, //< Map this diagnostic to a warning. 78691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner MAP_ERROR = 3, //< Map this diagnostic to an error. 792b07d8fe9e8a8ba12d64066632e17a9a5308a12eChris Lattner MAP_FATAL = 4, //< Map this diagnostic to a fatal error. 801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 81b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// Map this diagnostic to "warning", but make it immune to -Werror. This 82b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// happens when you specify -Wno-error=foo. 83e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner MAP_WARNING_NO_WERROR = 5, 84e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner /// Map this diagnostic to "error", but make it immune to -Wfatal-errors. 85e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner /// This happens for -Wno-fatal-errors=foo. 86e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner MAP_ERROR_NO_WFATAL = 6 875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 904b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// \brief Annotates a diagnostic with some code that should be 914b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// inserted, removed, or replaced to fix the problem. 924b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// 934b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// This kind of hint should be used when we are certain that the 944b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// introduction, removal, or modification of a particular (small!) 954b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// amount of code will correct a compilation error. The compiler 964b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// should also provide full recovery from such errors, such that 97b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor/// suppressing the diagnostic output can still result in successful 984b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// compilation. 99849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregorclass FixItHint { 1004b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregorpublic: 1014b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Tokens that should be removed to correct the error. 1024b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor SourceRange RemoveRange; 1034b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1044b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief The location at which we should insert code to correct 1054b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// the error. 1064b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor SourceLocation InsertionLoc; 1074b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1084b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief The actual code to insert at the insertion location, as a 1094b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// string. 1104b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor std::string CodeToInsert; 1114b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1124b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Empty code modification hint, indicating that no code 1134b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// modification is known. 114849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor FixItHint() : RemoveRange(), InsertionLoc() { } 1154b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1162f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson bool isNull() const { 1172f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson return !RemoveRange.isValid() && !InsertionLoc.isValid(); 1182f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson } 1192f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson 1204b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that inserts the given 1214b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// code string at a specific location. 122849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor static FixItHint CreateInsertion(SourceLocation InsertionLoc, 123849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor llvm::StringRef Code) { 124849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor FixItHint Hint; 125b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.InsertionLoc = InsertionLoc; 126b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.CodeToInsert = Code; 127b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 128b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 1294b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1304b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that removes the given 1314b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// source range. 132849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor static FixItHint CreateRemoval(SourceRange RemoveRange) { 133849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor FixItHint Hint; 134b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.RemoveRange = RemoveRange; 135b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 136b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 1374b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1384b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that replaces the given 1394b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// source range with the given code string. 140849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor static FixItHint CreateReplacement(SourceRange RemoveRange, 141849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor llvm::StringRef Code) { 142849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor FixItHint Hint; 143b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.RemoveRange = RemoveRange; 144b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.InsertionLoc = RemoveRange.getBegin(); 145b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.CodeToInsert = Code; 146b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 147b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 1484b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor}; 1494b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// Diagnostic - This concrete class is used by the front-end to report 1515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// problems and issues. It massages the diagnostics (e.g. handling things like 1525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// "report warnings as errors" and passes them off to the DiagnosticClient for 1535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// reporting to the user. 15428019772db70d4547be05a042eb950bc910f134fDouglas Gregorclass Diagnostic : public llvm::RefCountedBase<Diagnostic> { 155182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattnerpublic: 156182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// Level - The level of the diagnostic, after it has been through mapping. 157182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner enum Level { 158da0cbc1ad4a553c4de111c1181ec7b42c5ddefceChris Lattner Ignored, Note, Warning, Error, Fatal 159182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner }; 1601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 161b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// ExtensionHandling - How do we handle otherwise-unmapped extension? This 162b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// is controlled by -pedantic and -pedantic-errors. 163b54b276a920246c595a0498da281821eb9d22996Chris Lattner enum ExtensionHandling { 164b54b276a920246c595a0498da281821eb9d22996Chris Lattner Ext_Ignore, Ext_Warn, Ext_Error 165b54b276a920246c595a0498da281821eb9d22996Chris Lattner }; 1661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1673fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner enum ArgumentKind { 16847b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_std_string, // std::string 16947b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_c_string, // const char * 17047b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_sint, // int 17147b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_uint, // unsigned 17247b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_identifierinfo, // IdentifierInfo 17347b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_qualtype, // QualType 17447b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_declarationname, // DeclarationName 175dacd434c49658286c380c7b4c357d76d53cb4aa1Douglas Gregor ak_nameddecl, // NamedDecl * 1763f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor ak_nestednamespec, // NestedNameSpecifier * 1773f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor ak_declcontext // DeclContext * 1783fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner }; 179b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner 180b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// ArgumentValue - This typedef represents on argument value, which is a 181b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// union discriminated by ArgumentKind, with a value. 182b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner typedef std::pair<ArgumentKind, intptr_t> ArgumentValue; 183ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 1841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumpprivate: 18527ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner unsigned char AllExtensionsSilenced; // Used by __extension__ 186b54b276a920246c595a0498da281821eb9d22996Chris Lattner bool IgnoreAllWarnings; // Ignore all warnings: -w 1871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump bool WarningsAsErrors; // Treat warnings like errors: 188e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner bool ErrorsAsFatal; // Treat errors like fatal errors. 189b54b276a920246c595a0498da281821eb9d22996Chris Lattner bool SuppressSystemWarnings; // Suppress warnings in system headers. 19081b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor bool SuppressAllDiagnostics; // Suppress all diagnostics. 191c100214fdc41a7ea215f75d433eb1cb829fd4330Chris Lattner unsigned ErrorLimit; // Cap of # errors emitted, 0 -> no limit. 192575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor unsigned TemplateBacktraceLimit; // Cap on depth of template backtrace stack, 193575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor // 0 -> no limit. 194b54b276a920246c595a0498da281821eb9d22996Chris Lattner ExtensionHandling ExtBehavior; // Map extensions onto warnings or errors? 195b4398aa27da4d6919c3ae448d1ae66ba6cafc048Ted Kremenek DiagnosticClient *Client; 1965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// DiagMappings - Mapping information for diagnostics. Mapping info is 198691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// packed into four bits per diagnostic. The low three bits are the mapping 199691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// (an instance of diag::Mapping), or zero if unset. The high bit is set 200691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// when the mapping was established as a user mapping. If the high bit is 201691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// clear, then the low bits are set to the default value, and should be 202691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// mapped with -pedantic, -Werror, etc. 20304ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 20404ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner typedef std::vector<unsigned char> DiagMappings; 20504ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner mutable std::vector<DiagMappings> DiagMappingsStack; 20604ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 20715221422eda7bac679e38b07512feda49715ef66Chris Lattner /// ErrorOccurred / FatalErrorOccurred - This is set to true when an error or 20815221422eda7bac679e38b07512feda49715ef66Chris Lattner /// fatal error is emitted, and is sticky. 2095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ErrorOccurred; 21015221422eda7bac679e38b07512feda49715ef66Chris Lattner bool FatalErrorOccurred; 2111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 212f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// LastDiagLevel - This is the level of the last diagnostic emitted. This is 213f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// used to emit continuation diagnostics with the same level as the 214f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// diagnostic that they follow. 215f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner Diagnostic::Level LastDiagLevel; 2165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 21753eee7ba970d21ff15bbd4334164037a3b4cc4b8Chris Lattner unsigned NumWarnings; // Number of warnings reported 21853eee7ba970d21ff15bbd4334164037a3b4cc4b8Chris Lattner unsigned NumErrors; // Number of errors reported 2191864f2eb59471d07db51adfc3e5b1a229eed631aDouglas Gregor unsigned NumErrorsSuppressed; // Number of errors suppressed 2201864f2eb59471d07db51adfc3e5b1a229eed631aDouglas Gregor 221182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// CustomDiagInfo - Information for uniquing and looking up custom diags. 222182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner diag::CustomDiagInfo *CustomDiagInfo; 2237bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber 2243fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// ArgToStringFn - A function pointer that converts an opaque diagnostic 2253fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// argument to a strings. This takes the modifiers and argument that was 2263fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// present in the diagnostic. 227b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// 228b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// The PrevArgs array (whose length is NumPrevArgs) indicates the previous 229b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// arguments formatted for this diagnostic. Implementations of this function 230b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// can use this information to avoid redundancy across arguments. 231b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// 23222caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner /// This is a hack to avoid a layering violation between libbasic and libsema. 2333fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner typedef void (*ArgToStringFnTy)(ArgumentKind Kind, intptr_t Val, 2343fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Modifier, unsigned ModifierLen, 2353fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Argument, unsigned ArgumentLen, 236b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner const ArgumentValue *PrevArgs, 237b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner unsigned NumPrevArgs, 23892dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner llvm::SmallVectorImpl<char> &Output, 23992dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner void *Cookie); 24092dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner void *ArgToStringCookie; 2413fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ArgToStringFnTy ArgToStringFn; 24293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 24393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief ID of the "delayed" diagnostic, which is a (typically 24493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// fatal) diagnostic that had to be delayed because it was found 24593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// while emitting another diagnostic. 24693ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor unsigned DelayedDiagID; 24793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 24893ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief First string argument for the delayed diagnostic. 24993ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor std::string DelayedDiagArg1; 25093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 25193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief Second string argument for the delayed diagnostic. 25293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor std::string DelayedDiagArg2; 25393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 2545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 2557bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber explicit Diagnostic(DiagnosticClient *client = 0); 256182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner ~Diagnostic(); 2571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 2595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Diagnostic characterization methods, used by a client to customize how 2605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // 2611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2626f776b0c943c0065b5148297e61afbe29d54cc51Daniel Dunbar DiagnosticClient *getClient() { return Client; } 2636f776b0c943c0065b5148297e61afbe29d54cc51Daniel Dunbar const DiagnosticClient *getClient() const { return Client; } 26404ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 2651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// pushMappings - Copies the current DiagMappings and pushes the new copy 26604ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// onto the top of the stack. 26704ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner void pushMappings(); 26804ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 26904ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// popMappings - Pops the current DiagMappings off the top of the stack 27004ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// causing the new top of the stack to be the active mappings. Returns 27104ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// true if the pop happens, false if there is only one DiagMapping on the 27204ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// stack. 27304ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner bool popMappings(); 27404ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 275b4398aa27da4d6919c3ae448d1ae66ba6cafc048Ted Kremenek void setClient(DiagnosticClient* client) { Client = client; } 2765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 277c100214fdc41a7ea215f75d433eb1cb829fd4330Chris Lattner /// setErrorLimit - Specify a limit for the number of errors we should 278b205ac9fcd22b87b41697172d1983c5ae9dabaafChris Lattner /// emit before giving up. Zero disables the limit. 279c100214fdc41a7ea215f75d433eb1cb829fd4330Chris Lattner void setErrorLimit(unsigned Limit) { ErrorLimit = Limit; } 280b205ac9fcd22b87b41697172d1983c5ae9dabaafChris Lattner 281575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor /// \brief Specify the maximum number of template instantiation 282575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor /// notes to emit along with a given diagnostic. 283575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor void setTemplateBacktraceLimit(unsigned Limit) { 284575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor TemplateBacktraceLimit = Limit; 285575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor } 2866c1cb9916e9988dcdd65b9266dbe24afd173427aDouglas Gregor 287575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor /// \brief Retrieve the maximum number of template instantiation 288575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor /// nodes to emit along with a given diagnostic. 289575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor unsigned getTemplateBacktraceLimit() const { 290575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor return TemplateBacktraceLimit; 291575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor } 2926c1cb9916e9988dcdd65b9266dbe24afd173427aDouglas Gregor 2935b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner /// setIgnoreAllWarnings - When set to true, any unmapped warnings are 2945b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner /// ignored. If this and WarningsAsErrors are both set, then this one wins. 2955b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner void setIgnoreAllWarnings(bool Val) { IgnoreAllWarnings = Val; } 2965b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner bool getIgnoreAllWarnings() const { return IgnoreAllWarnings; } 2971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setWarningsAsErrors - When set to true, any warnings reported are issued 2995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// as errors. 3005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setWarningsAsErrors(bool Val) { WarningsAsErrors = Val; } 3015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getWarningsAsErrors() const { return WarningsAsErrors; } 3021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 303e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner /// setErrorsAsFatal - When set to true, any error reported is made a 304e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner /// fatal error. 305e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner void setErrorsAsFatal(bool Val) { ErrorsAsFatal = Val; } 306e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner bool getErrorsAsFatal() const { return ErrorsAsFatal; } 307e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner 3082fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar /// setSuppressSystemWarnings - When set to true mask warnings that 3092fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar /// come from system headers. 3102fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar void setSuppressSystemWarnings(bool Val) { SuppressSystemWarnings = Val; } 3112fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar bool getSuppressSystemWarnings() const { return SuppressSystemWarnings; } 3122fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar 31381b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor /// \brief Suppress all diagnostics, to silence the front end when we 31481b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor /// know that we don't want any more diagnostics to be passed along to the 31581b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor /// client 31681b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor void setSuppressAllDiagnostics(bool Val = true) { 31781b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor SuppressAllDiagnostics = Val; 31881b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor } 31981b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor bool getSuppressAllDiagnostics() const { return SuppressAllDiagnostics; } 32081b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor 3210b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor /// \brief Pretend that the last diagnostic issued was ignored. This can 3220b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor /// be used by clients who suppress diagnostics themselves. 3230b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor void setLastDiagnosticIgnored() { 3240b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor LastDiagLevel = Ignored; 3250b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor } 3260b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor 327b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// setExtensionHandlingBehavior - This controls whether otherwise-unmapped 328b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// extension diagnostics are mapped onto ignore/warning/error. This 329b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// corresponds to the GCC -pedantic and -pedantic-errors option. 330b54b276a920246c595a0498da281821eb9d22996Chris Lattner void setExtensionHandlingBehavior(ExtensionHandling H) { 331b54b276a920246c595a0498da281821eb9d22996Chris Lattner ExtBehavior = H; 332b54b276a920246c595a0498da281821eb9d22996Chris Lattner } 3331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 33427ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// AllExtensionsSilenced - This is a counter bumped when an __extension__ 33527ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// block is encountered. When non-zero, all extension diagnostics are 33627ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// entirely silenced, no matter how they are mapped. 33727ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner void IncrementAllExtensionsSilenced() { ++AllExtensionsSilenced; } 33827ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner void DecrementAllExtensionsSilenced() { --AllExtensionsSilenced; } 33991a2886d558ea6ca7a0bed73ab5acea5ae78eac2Douglas Gregor bool hasAllExtensionsSilenced() { return AllExtensionsSilenced != 0; } 3401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setDiagnosticMapping - This allows the client to specify that certain 342691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// warnings are ignored. Notes can never be mapped, errors can only be 343691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// mapped to fatal, and WARNINGs and EXTENSIONs can be mapped arbitrarily. 3445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setDiagnosticMapping(diag::kind Diag, diag::Mapping Map) { 34519e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner assert(Diag < diag::DIAG_UPPER_LIMIT && 3460750618b0beacdc9b0a9e210a661e4746823ced7Chris Lattner "Can only map builtin diagnostics"); 347d0fe3e9a97459477e64ad1df312fd29b86a3c3cbChris Lattner assert((isBuiltinWarningOrExtension(Diag) || 348d0fe3e9a97459477e64ad1df312fd29b86a3c3cbChris Lattner (Map == diag::MAP_FATAL || Map == diag::MAP_ERROR)) && 349d0fe3e9a97459477e64ad1df312fd29b86a3c3cbChris Lattner "Cannot map errors into warnings!"); 350691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner setDiagnosticMappingInternal(Diag, Map, true); 35127ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner } 3521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3533bc172bc6a787842db6fea351cf6929539fca70dChris Lattner /// setDiagnosticGroupMapping - Change an entire diagnostic group (e.g. 3543bc172bc6a787842db6fea351cf6929539fca70dChris Lattner /// "unknown-pragmas" to have the specified mapping. This returns true and 3553bc172bc6a787842db6fea351cf6929539fca70dChris Lattner /// ignores the request if "Group" was unknown, false otherwise. 3563bc172bc6a787842db6fea351cf6929539fca70dChris Lattner bool setDiagnosticGroupMapping(const char *Group, diag::Mapping Map); 3575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool hasErrorOccurred() const { return ErrorOccurred; } 35915221422eda7bac679e38b07512feda49715ef66Chris Lattner bool hasFatalErrorOccurred() const { return FatalErrorOccurred; } 3605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned getNumErrors() const { return NumErrors; } 3621864f2eb59471d07db51adfc3e5b1a229eed631aDouglas Gregor unsigned getNumErrorsSuppressed() const { return NumErrorsSuppressed; } 36353eee7ba970d21ff15bbd4334164037a3b4cc4b8Chris Lattner unsigned getNumWarnings() const { return NumWarnings; } 3641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 365182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// getCustomDiagID - Return an ID for a diagnostic with the specified message 366182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// and level. If this is the first request for this diagnosic, it is 367182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// registered and created, otherwise the existing ID is returned. 36832d4d80c26e8c4c1922cff4661e0b9f44a3aabfcDaniel Dunbar unsigned getCustomDiagID(Level L, llvm::StringRef Message); 3691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3713fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// ConvertArgToString - This method converts a diagnostic argument (as an 3723fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// intptr_t) into the string that represents it. 3733fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner void ConvertArgToString(ArgumentKind Kind, intptr_t Val, 3743fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Modifier, unsigned ModLen, 3753fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Argument, unsigned ArgLen, 376b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner const ArgumentValue *PrevArgs, unsigned NumPrevArgs, 3773fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner llvm::SmallVectorImpl<char> &Output) const { 378b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner ArgToStringFn(Kind, Val, Modifier, ModLen, Argument, ArgLen, 379b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner PrevArgs, NumPrevArgs, Output, ArgToStringCookie); 38022caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 3811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 38292dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner void SetArgToStringFn(ArgToStringFnTy Fn, void *Cookie) { 3833fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ArgToStringFn = Fn; 38492dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner ArgToStringCookie = Cookie; 38522caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 3861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 3885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Diagnostic classification and reporting interfaces. 3895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // 3905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getDescription - Given a diagnostic ID, return a description of the 3925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// issue. 3930a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const char *getDescription(unsigned DiagID) const; 3941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 395f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// isNoteWarningOrExtension - Return true if the unmapped diagnostic 396f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// level of the specified diagnostic ID is a Warning or Extension. 397f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// This only works on builtin diagnostics, not custom ones, and is not legal to 398f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// call on NOTEs. 399f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner static bool isBuiltinWarningOrExtension(unsigned DiagID); 4005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 401ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor /// \brief Determine whether the given built-in diagnostic ID is a 402ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor /// Note. 403ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor static bool isBuiltinNote(unsigned DiagID); 4041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 40527ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// isBuiltinExtensionDiag - Determine whether the given built-in diagnostic 40627ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// ID is for an extension of some sort. 40727ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// 40804e442714c292d9381cad2ac14087991132bddcaChris Lattner static bool isBuiltinExtensionDiag(unsigned DiagID) { 40904e442714c292d9381cad2ac14087991132bddcaChris Lattner bool ignored; 41004e442714c292d9381cad2ac14087991132bddcaChris Lattner return isBuiltinExtensionDiag(DiagID, ignored); 41104e442714c292d9381cad2ac14087991132bddcaChris Lattner } 41204e442714c292d9381cad2ac14087991132bddcaChris Lattner 41304e442714c292d9381cad2ac14087991132bddcaChris Lattner /// isBuiltinExtensionDiag - Determine whether the given built-in diagnostic 41404e442714c292d9381cad2ac14087991132bddcaChris Lattner /// ID is for an extension of some sort. This also returns EnabledByDefault, 41504e442714c292d9381cad2ac14087991132bddcaChris Lattner /// which is set to indicate whether the diagnostic is ignored by default (in 41604e442714c292d9381cad2ac14087991132bddcaChris Lattner /// which case -pedantic enables it) or treated as a warning/error by default. 41704e442714c292d9381cad2ac14087991132bddcaChris Lattner /// 41804e442714c292d9381cad2ac14087991132bddcaChris Lattner static bool isBuiltinExtensionDiag(unsigned DiagID, bool &EnabledByDefault); 41904e442714c292d9381cad2ac14087991132bddcaChris Lattner 4201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 421d51d74a3e89c5e5fc9bfd2814996a5feab6dc932Chris Lattner /// getWarningOptionForDiag - Return the lowest-level warning option that 422d51d74a3e89c5e5fc9bfd2814996a5feab6dc932Chris Lattner /// enables the specified diagnostic. If there is no -Wfoo flag that controls 423d51d74a3e89c5e5fc9bfd2814996a5feab6dc932Chris Lattner /// the diagnostic, this returns null. 424d51d74a3e89c5e5fc9bfd2814996a5feab6dc932Chris Lattner static const char *getWarningOptionForDiag(unsigned DiagID); 425ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 426eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// \brief Enumeration describing how the the emission of a diagnostic should 427eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// be treated when it occurs during C++ template argument deduction. 428eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor enum SFINAEResponse { 429eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// \brief The diagnostic should not be reported, but it should cause 430eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// template argument deduction to fail. 431eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// 432eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// The vast majority of errors that occur during template argument 433eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// deduction fall into this category. 434eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor SFINAE_SubstitutionFailure, 435eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor 436eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// \brief The diagnostic should be suppressed entirely. 437eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// 438eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// Warnings generally fall into this category. 439eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor SFINAE_Suppress, 440eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor 441eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// \brief The diagnostic should be reported. 442eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// 443eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// The diagnostic should be reported. Various fatal errors (e.g., 444eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// template instantiation depth exceeded) fall into this category. 445eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor SFINAE_Report 446eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor }; 447eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor 4485e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// \brief Determines whether the given built-in diagnostic ID is 4495e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// for an error that is suppressed if it occurs during C++ template 4505e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// argument deduction. 4515e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// 4525e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// When an error is suppressed due to SFINAE, the template argument 4535e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// deduction fails but no diagnostic is emitted. Certain classes of 4545e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// errors, such as those errors that involve C++ access control, 4555e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// are not SFINAE errors. 456eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor static SFINAEResponse getDiagnosticSFINAEResponse(unsigned DiagID); 4575e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor 4585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getDiagnosticLevel - Based on the way the client configured the Diagnostic 4595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// object, classify the specified diagnostic ID into a Level, consumable by 4605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the DiagnosticClient. 4611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump Level getDiagnosticLevel(unsigned DiagID) const; 4621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 463509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// Report - Issue the message to the client. @c DiagID is a member of the 464509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// @c diag::kind enum. This actually returns aninstance of DiagnosticBuilder 465509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// which emits the diagnostics (through @c ProcessDiag) when it is destroyed. 466509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// @c Pos represents the source location associated with the diagnostic, 467509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// which can be an invalid location if no position information is available. 4683cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner inline DiagnosticBuilder Report(FullSourceLoc Pos, unsigned DiagID); 4690f9fed70cea107b3f79df554e38bd8e98d48fe47Daniel Dunbar inline DiagnosticBuilder Report(unsigned DiagID); 470de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor 47193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief Determine whethere there is already a diagnostic in flight. 4725800f7ea9cf5621280089d690f677bd28064d6b5Ted Kremenek bool isDiagnosticInFlight() const { return CurDiagID != ~0U; } 47393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 47493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief Set the "delayed" diagnostic that will be emitted once 47593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// the current diagnostic completes. 47693ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// 47793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// If a diagnostic is already in-flight but the front end must 47893ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// report a problem (e.g., with an inconsistent file system 47993ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// state), this routine sets a "delayed" diagnostic that will be 48093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// emitted after the current diagnostic completes. This should 48193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// only be used for fatal errors detected at inconvenient 48293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// times. If emitting a delayed diagnostic causes a second delayed 48393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// diagnostic to be introduced, that second delayed diagnostic 48493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// will be ignored. 48593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// 48693ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \param DiagID The ID of the diagnostic being delayed. 48793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// 48893ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \param Arg1 A string argument that will be provided to the 48993ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// diagnostic. A copy of this string will be stored in the 49093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// Diagnostic object itself. 49193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// 49293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \param Arg2 A string argument that will be provided to the 49393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// diagnostic. A copy of this string will be stored in the 49493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// Diagnostic object itself. 49593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor void SetDelayedDiagnostic(unsigned DiagID, llvm::StringRef Arg1 = "", 49693ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor llvm::StringRef Arg2 = ""); 49793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 498de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor /// \brief Clear out the current diagnostic. 499de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor void Clear() { CurDiagID = ~0U; } 5001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5010a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattnerprivate: 50293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief Report the delayed diagnostic. 50393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor void ReportDelayed(); 50493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 50593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 506691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// getDiagnosticMappingInfo - Return the mapping info currently set for the 507691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// specified builtin diagnostic. This returns the high bit encoding, or zero 508691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// if the field is completely uninitialized. 50904e442714c292d9381cad2ac14087991132bddcaChris Lattner diag::Mapping getDiagnosticMappingInfo(diag::kind Diag) const { 51004ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner const DiagMappings ¤tMappings = DiagMappingsStack.back(); 51104ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner return (diag::Mapping)((currentMappings[Diag/2] >> (Diag & 1)*4) & 15); 512691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner } 5131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 514691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner void setDiagnosticMappingInternal(unsigned DiagId, unsigned Map, 515691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner bool isUser) const { 516691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner if (isUser) Map |= 8; // Set the high bit for user mappings. 51704ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner unsigned char &Slot = DiagMappingsStack.back()[DiagId/2]; 518691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner unsigned Shift = (DiagId & 1)*4; 519691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner Slot &= ~(15 << Shift); 520691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner Slot |= Map << Shift; 5219faf50e62ddcd2535b472abc8daafd7042120caaChris Lattner } 5221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 523f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// getDiagnosticLevel - This is an internal implementation helper used when 524f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// DiagClass is already known. 525f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner Level getDiagnosticLevel(unsigned DiagID, unsigned DiagClass) const; 526f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner 5273cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner // This is private state used by DiagnosticBuilder. We put it here instead of 5283cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner // in DiagnosticBuilder in order to keep DiagnosticBuilder a small lightweight 5290a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // object. This implementation choice means that we can only have one 5300a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // diagnostic "in flight" at a time, but this seems to be a reasonable 5310a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // tradeoff to keep these objects small. Assertions verify that only one 5320a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // diagnostic is in flight at a time. 5333cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner friend class DiagnosticBuilder; 5340a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner friend class DiagnosticInfo; 535b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner 536b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner /// CurDiagLoc - This is the location of the current diagnostic that is in 537b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner /// flight. 538b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner FullSourceLoc CurDiagLoc; 5391eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 540b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner /// CurDiagID - This is the ID of the current diagnostic that is in flight. 5413cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// This is set to ~0U when there is no diagnostic in flight. 542b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner unsigned CurDiagID; 543b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner 54473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner enum { 54573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// MaxArguments - The maximum number of arguments we can hold. We currently 54673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// only support up to 10 arguments (%0-%9). A single diagnostic with more 54773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// than that almost certainly has to be simplified anyway. 54873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner MaxArguments = 10 54973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner }; 5501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5513cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// NumDiagArgs - This contains the number of entries in Arguments. 552730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner signed char NumDiagArgs; 553730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner /// NumRanges - This is the number of ranges in the DiagRanges array. 554730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner unsigned char NumDiagRanges; 5554b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief The number of code modifications hints in the 556849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor /// FixItHints array. 557849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor unsigned char NumFixItHints; 558ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 55973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsKind - This is an array of ArgumentKind::ArgumentKind enum 56073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// values, with one for each argument. This specifies whether the argument 56173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// is in DiagArgumentsStr or in DiagArguments. 56273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner unsigned char DiagArgumentsKind[MaxArguments]; 5631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 56473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsStr - This holds the values of each string argument for the 56573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// current diagnostic. This value is only used when the corresponding 56673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// ArgumentKind is ak_std_string. 56773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner std::string DiagArgumentsStr[MaxArguments]; 56873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 56973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsVal - The values for the various substitution positions. This 57073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// is used when the argument is not an std::string. The specific value is 57173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// mangled into an intptr_t and the intepretation depends on exactly what 57273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// sort of argument kind it is. 57373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner intptr_t DiagArgumentsVal[MaxArguments]; 5741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5750a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// DiagRanges - The list of ranges added to this diagnostic. It currently 5760a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// only support 10 ranges, could easily be extended if needed. 57751c6d384551674facc19f745ecf6e289d28dc55fDouglas Gregor SourceRange DiagRanges[10]; 5781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 579849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor enum { MaxFixItHints = 3 }; 5804b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 581849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor /// FixItHints - If valid, provides a hint with some code 5824b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// to insert, remove, or modify at a particular position. 583849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor FixItHint FixItHints[MaxFixItHints]; 5844b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 5850a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// ProcessDiag - This is the method used to report a diagnostic that is 5860a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// finally fully formed. 5875e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// 5885e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// \returns true if the diagnostic was emitted, false if it was 5895e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// suppressed. 5905e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor bool ProcessDiag(); 5913cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}; 5923cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 5933cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 5943cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner// DiagnosticBuilder 5953cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 5963cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 5973cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// DiagnosticBuilder - This is a little helper class used to produce 5983cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// diagnostics. This is constructed by the Diagnostic::Report method, and 5993cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// allows insertion of extra information (arguments and source ranges) into the 6003cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// currently "in flight" diagnostic. When the temporary for the builder is 6013cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// destroyed, the diagnostic is issued. 6023cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// 6033cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// Note that many of these will be created as temporary objects (many call 6043cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// sites), so we want them to be small and we never want their address taken. 6053cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// This ensures that compilers with somewhat reasonable optimizers will promote 6063cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// the common fields to registers, eliminating increments of the NumArgs field, 6073cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// for example. 6083cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerclass DiagnosticBuilder { 6093cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner mutable Diagnostic *DiagObj; 610849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor mutable unsigned NumArgs, NumRanges, NumFixItHints; 6111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6123cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void operator=(const DiagnosticBuilder&); // DO NOT IMPLEMENT 6133cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner friend class Diagnostic; 6143cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner explicit DiagnosticBuilder(Diagnostic *diagObj) 615849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor : DiagObj(diagObj), NumArgs(0), NumRanges(0), NumFixItHints(0) {} 616ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 6171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumppublic: 6180a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// Copy constructor. When copied, this "takes" the diagnostic info from the 6190a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// input and neuters it. 6203cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagnosticBuilder(const DiagnosticBuilder &D) { 6210a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner DiagObj = D.DiagObj; 6220a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner D.DiagObj = 0; 62325a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor NumArgs = D.NumArgs; 62425a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor NumRanges = D.NumRanges; 625849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor NumFixItHints = D.NumFixItHints; 6260a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 62725a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor 6285e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// \brief Simple enumeration value used to give a name to the 6295e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// suppress-diagnostic constructor. 6305e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor enum SuppressKind { Suppress }; 6315e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor 6325e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// \brief Create an empty DiagnosticBuilder object that represents 6335e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// no actual diagnostic. 6341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump explicit DiagnosticBuilder(SuppressKind) 635849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor : DiagObj(0), NumArgs(0), NumRanges(0), NumFixItHints(0) { } 6365e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor 63725a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// \brief Force the diagnostic builder to emit the diagnostic now. 63825a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// 63925a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// Once this function has been called, the DiagnosticBuilder object 64025a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// should not be used again before it is destroyed. 6415e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// 6425e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// \returns true if a diagnostic was emitted, false if the 6435e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// diagnostic was suppressed. 64493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor bool Emit(); 64525a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor 64625a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// Destructor - The dtor emits the diagnostic if it hasn't already 64725a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// been emitted. 64825a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor ~DiagnosticBuilder() { Emit(); } 6491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 650d93256e55673a17d18543397ec462416acb13792Douglas Gregor /// isActive - Determine whether this diagnostic is still active. 651d93256e55673a17d18543397ec462416acb13792Douglas Gregor bool isActive() const { return DiagObj != 0; } 652d93256e55673a17d18543397ec462416acb13792Douglas Gregor 6533cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// Operator bool: conversion of DiagnosticBuilder to bool always returns 6543cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// true. This allows is to be used in boolean error contexts like: 6553cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// return Diag(...); 6563cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner operator bool() const { return true; } 6573cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 658eaea925e70e3ee85809e572aa8474b8dfc491af7Daniel Dunbar void AddString(llvm::StringRef S) const { 6593cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(NumArgs < Diagnostic::MaxArguments && 6603cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 6615e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor if (DiagObj) { 6625e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor DiagObj->DiagArgumentsKind[NumArgs] = Diagnostic::ak_std_string; 6635e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor DiagObj->DiagArgumentsStr[NumArgs++] = S; 6645e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor } 6653cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner } 6661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6673cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void AddTaggedVal(intptr_t V, Diagnostic::ArgumentKind Kind) const { 6683cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(NumArgs < Diagnostic::MaxArguments && 6693cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 6705e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor if (DiagObj) { 6715e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor DiagObj->DiagArgumentsKind[NumArgs] = Kind; 6725e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor DiagObj->DiagArgumentsVal[NumArgs++] = V; 6735e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor } 6740a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 6751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6763cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void AddSourceRange(const SourceRange &R) const { 6771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump assert(NumRanges < 6783cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner sizeof(DiagObj->DiagRanges)/sizeof(DiagObj->DiagRanges[0]) && 6793cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 6805e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor if (DiagObj) 68151c6d384551674facc19f745ecf6e289d28dc55fDouglas Gregor DiagObj->DiagRanges[NumRanges++] = R; 6821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 6834b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 684849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor void AddFixItHint(const FixItHint &Hint) const { 6852f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson if (Hint.isNull()) 6862f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson return; 6872f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson 688849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor assert(NumFixItHints < Diagnostic::MaxFixItHints && 689849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor "Too many fix-it hints!"); 6905e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor if (DiagObj) 691849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor DiagObj->FixItHints[NumFixItHints++] = Hint; 6924b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 6933cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}; 6943cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 6953cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 696eaea925e70e3ee85809e572aa8474b8dfc491af7Daniel Dunbar llvm::StringRef S) { 6973cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddString(S); 6983cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 6993cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 7003cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 7013cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 7023cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const char *Str) { 7033cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(reinterpret_cast<intptr_t>(Str), 7043cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner Diagnostic::ak_c_string); 7053cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 7063cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 7073cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 7083cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, int I) { 7093cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(I, Diagnostic::ak_sint); 7103cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 7113cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 7123cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 7133bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidisinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,bool I) { 7143bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis DB.AddTaggedVal(I, Diagnostic::ak_sint); 7153bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis return DB; 7163bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis} 7173bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis 7183cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 7193cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner unsigned I) { 7203cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(I, Diagnostic::ak_uint); 7213cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 7223cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 7233cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 7243cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 7253cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const IdentifierInfo *II) { 7263cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(reinterpret_cast<intptr_t>(II), 7273cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner Diagnostic::ak_identifierinfo); 7283cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 7293cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 7301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7313f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// Adds a DeclContext to the diagnostic. The enable_if template magic is here 7323f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// so that we only match those arguments that are (statically) DeclContexts; 7333f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// other arguments that derive from DeclContext (e.g., RecordDecls) will not 7343f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// match. 7353f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregortemplate<typename T> 7363f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregorinline 7373f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregortypename llvm::enable_if<llvm::is_same<T, DeclContext>, 7383f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor const DiagnosticBuilder &>::type 7393f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregoroperator<<(const DiagnosticBuilder &DB, T *DC) { 7403f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor DB.AddTaggedVal(reinterpret_cast<intptr_t>(DC), 7413f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor Diagnostic::ak_declcontext); 7423f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor return DB; 7433f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor} 7443f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor 7453cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 7463cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const SourceRange &R) { 7473cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddSourceRange(R); 7483cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 7493cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 7504b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 7514b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregorinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 752849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor const FixItHint &Hint) { 753849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor DB.AddFixItHint(Hint); 7544b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor return DB; 7554b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor} 756ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 7573cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// Report - Issue the message to the client. DiagID is a member of the 7583cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// diag::kind enum. This actually returns a new instance of DiagnosticBuilder 7593cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// which emits the diagnostics (through ProcessDiag) when it is destroyed. 7603cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline DiagnosticBuilder Diagnostic::Report(FullSourceLoc Loc, unsigned DiagID){ 7613cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(CurDiagID == ~0U && "Multiple diagnostics in flight at once!"); 7623cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner CurDiagLoc = Loc; 7633cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner CurDiagID = DiagID; 7643cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DiagnosticBuilder(this); 7653cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 7660f9fed70cea107b3f79df554e38bd8e98d48fe47Daniel Dunbarinline DiagnosticBuilder Diagnostic::Report(unsigned DiagID) { 7670f9fed70cea107b3f79df554e38bd8e98d48fe47Daniel Dunbar return Report(FullSourceLoc(), DiagID); 7680f9fed70cea107b3f79df554e38bd8e98d48fe47Daniel Dunbar} 7693cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 7703cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 7713cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner// DiagnosticInfo 7723cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 7731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7743cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// DiagnosticInfo - This is a little helper class (which is basically a smart 7754b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// pointer that forward info from Diagnostic) that allows clients to enquire 7763cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// about the currently in-flight diagnostic. 7773cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerclass DiagnosticInfo { 7783cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const Diagnostic *DiagObj; 7793cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerpublic: 7803cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner explicit DiagnosticInfo(const Diagnostic *DO) : DiagObj(DO) {} 7811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7820a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const Diagnostic *getDiags() const { return DiagObj; } 783b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner unsigned getID() const { return DiagObj->CurDiagID; } 784b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner const FullSourceLoc &getLocation() const { return DiagObj->CurDiagLoc; } 7851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7860a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned getNumArgs() const { return DiagObj->NumDiagArgs; } 7871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 78873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgKind - Return the kind of the specified index. Based on the kind 78973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// of argument, the accessors below can be used to get the value. 7903cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner Diagnostic::ArgumentKind getArgKind(unsigned Idx) const { 7913cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(Idx < getNumArgs() && "Argument index out of range!"); 7923cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return (Diagnostic::ArgumentKind)DiagObj->DiagArgumentsKind[Idx]; 79373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner } 7941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 79573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgStdStr - Return the provided argument string specified by Idx. 79673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner const std::string &getArgStdStr(unsigned Idx) const { 7973cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_std_string && 7983cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 79973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner return DiagObj->DiagArgumentsStr[Idx]; 80073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner } 8011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 80273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgCStr - Return the specified C string argument. 80373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner const char *getArgCStr(unsigned Idx) const { 8043cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_c_string && 8053cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 80673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner return reinterpret_cast<const char*>(DiagObj->DiagArgumentsVal[Idx]); 8070a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 8081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 80930bc96544346bea42921cf6837e66cef80d664b4Chris Lattner /// getArgSInt - Return the specified signed integer argument. 81030bc96544346bea42921cf6837e66cef80d664b4Chris Lattner int getArgSInt(unsigned Idx) const { 8113cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_sint && 8123cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 81330bc96544346bea42921cf6837e66cef80d664b4Chris Lattner return (int)DiagObj->DiagArgumentsVal[Idx]; 81430bc96544346bea42921cf6837e66cef80d664b4Chris Lattner } 8151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 81630bc96544346bea42921cf6837e66cef80d664b4Chris Lattner /// getArgUInt - Return the specified unsigned integer argument. 81730bc96544346bea42921cf6837e66cef80d664b4Chris Lattner unsigned getArgUInt(unsigned Idx) const { 8183cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_uint && 8193cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 82030bc96544346bea42921cf6837e66cef80d664b4Chris Lattner return (unsigned)DiagObj->DiagArgumentsVal[Idx]; 82130bc96544346bea42921cf6837e66cef80d664b4Chris Lattner } 8221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 82343b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner /// getArgIdentifier - Return the specified IdentifierInfo argument. 82443b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner const IdentifierInfo *getArgIdentifier(unsigned Idx) const { 8253cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_identifierinfo && 8263cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 8279634379265855f1628190e926d9aaf1fb4a5d90eChris Lattner return reinterpret_cast<IdentifierInfo*>(DiagObj->DiagArgumentsVal[Idx]); 82843b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner } 8291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 83022caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner /// getRawArg - Return the specified non-string argument in an opaque form. 83122caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner intptr_t getRawArg(unsigned Idx) const { 83222caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner assert(getArgKind(Idx) != Diagnostic::ak_std_string && 83322caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner "invalid argument accessor!"); 83422caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner return DiagObj->DiagArgumentsVal[Idx]; 83522caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 8361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8380a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// getNumRanges - Return the number of source ranges associated with this 8390a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// diagnostic. 8400a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned getNumRanges() const { 8410a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner return DiagObj->NumDiagRanges; 8420a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 8431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 84451c6d384551674facc19f745ecf6e289d28dc55fDouglas Gregor SourceRange getRange(unsigned Idx) const { 8450a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner assert(Idx < DiagObj->NumDiagRanges && "Invalid diagnostic range index!"); 84651c6d384551674facc19f745ecf6e289d28dc55fDouglas Gregor return DiagObj->DiagRanges[Idx]; 8470a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 8481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 849849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor unsigned getNumFixItHints() const { 850849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor return DiagObj->NumFixItHints; 8514b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 8524b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 853849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor const FixItHint &getFixItHint(unsigned Idx) const { 854849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor return DiagObj->FixItHints[Idx]; 8554b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 8564b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 857849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor const FixItHint *getFixItHints() const { 858849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor return DiagObj->NumFixItHints? 859849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor &DiagObj->FixItHints[0] : 0; 8604b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 8614b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 862f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// FormatDiagnostic - Format this diagnostic into a string, substituting the 863f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// formal arguments into the %0 slots. The result is appended onto the Str 864f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// array. 865f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner void FormatDiagnostic(llvm::SmallVectorImpl<char> &OutStr) const; 8669f28614bf1a8387000d8df57a713fcf69e198145John McCall 8679f28614bf1a8387000d8df57a713fcf69e198145John McCall /// FormatDiagnostic - Format the given format-string into the 8689f28614bf1a8387000d8df57a713fcf69e198145John McCall /// output buffer using the arguments stored in this diagnostic. 8699f28614bf1a8387000d8df57a713fcf69e198145John McCall void FormatDiagnostic(const char *DiagStr, const char *DiagEnd, 8709f28614bf1a8387000d8df57a713fcf69e198145John McCall llvm::SmallVectorImpl<char> &OutStr) const; 871a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor}; 872a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 873a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor/** 874a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \brief Represents a diagnostic in a form that can be serialized and 875a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * deserialized. 876a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor */ 877a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregorclass StoredDiagnostic { 878a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor Diagnostic::Level Level; 879a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor FullSourceLoc Loc; 880a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor std::string Message; 881a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor std::vector<SourceRange> Ranges; 882849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor std::vector<FixItHint> FixIts; 883a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 884a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregorpublic: 885a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor StoredDiagnostic(); 886a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor StoredDiagnostic(Diagnostic::Level Level, const DiagnosticInfo &Info); 887a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor StoredDiagnostic(Diagnostic::Level Level, llvm::StringRef Message); 888a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor ~StoredDiagnostic(); 889a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 890a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// \brief Evaluates true when this object stores a diagnostic. 891a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor operator bool() const { return Message.size() > 0; } 892a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 893a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor Diagnostic::Level getLevel() const { return Level; } 894a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor const FullSourceLoc &getLocation() const { return Loc; } 895a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor llvm::StringRef getMessage() const { return Message; } 896a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 897a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor typedef std::vector<SourceRange>::const_iterator range_iterator; 898a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor range_iterator range_begin() const { return Ranges.begin(); } 899a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor range_iterator range_end() const { return Ranges.end(); } 900a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned range_size() const { return Ranges.size(); } 901a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 902849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor typedef std::vector<FixItHint>::const_iterator fixit_iterator; 903a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor fixit_iterator fixit_begin() const { return FixIts.begin(); } 904a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor fixit_iterator fixit_end() const { return FixIts.end(); } 905a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned fixit_size() const { return FixIts.size(); } 906d93256e55673a17d18543397ec462416acb13792Douglas Gregor 907d93256e55673a17d18543397ec462416acb13792Douglas Gregor /// Serialize - Serialize the given diagnostic (with its diagnostic 908d93256e55673a17d18543397ec462416acb13792Douglas Gregor /// level) to the given stream. Serialization is a lossy operation, 909d93256e55673a17d18543397ec462416acb13792Douglas Gregor /// since the specific diagnostic ID and any macro-instantiation 910d93256e55673a17d18543397ec462416acb13792Douglas Gregor /// information is lost. 911a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor void Serialize(llvm::raw_ostream &OS) const; 912a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 913a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// Deserialize - Deserialize the first diagnostic within the memory 914a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// [Memory, MemoryEnd), producing a new diagnostic builder describing the 915a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// deserialized diagnostic. If the memory does not contain a 916a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// diagnostic, returns a diagnostic builder with no diagnostic ID. 917a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor static StoredDiagnostic Deserialize(FileManager &FM, SourceManager &SM, 918a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor const char *&Memory, const char *MemoryEnd); 9195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 9201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// DiagnosticClient - This is an abstract interface implemented by clients of 9225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// the front-end, which formats and prints fully processed diagnostics. 9235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass DiagnosticClient { 9245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 9255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer virtual ~DiagnosticClient(); 9261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 927efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// BeginSourceFile - Callback to inform the diagnostic client that processing 928efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// of a source file is beginning. 929efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// 930efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// Note that diagnostics may be emitted outside the processing of a source 931efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// file, for example during the parsing of command line options. However, 932efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// diagnostics with source range information are required to only be emitted 933efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// in between BeginSourceFile() and EndSourceFile(). 934efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// 935efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// \arg LO - The language options for the source file being processed. 936efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// \arg PP - The preprocessor object being used for the source; this optional 937efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// and may not be present, for example when processing AST source files. 9387d90199f109290e9d587479a481a2850d390b552Daniel Dunbar virtual void BeginSourceFile(const LangOptions &LangOpts, 9397d90199f109290e9d587479a481a2850d390b552Daniel Dunbar const Preprocessor *PP = 0) {} 940efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar 941efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// EndSourceFile - Callback to inform the diagnostic client that processing 942efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// of a source file has ended. The diagnostic client should assume that any 943efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// objects made available via \see BeginSourceFile() are inaccessible. 944efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar virtual void EndSourceFile() {} 9451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 946cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek /// IncludeInDiagnosticCounts - This method (whose default implementation 947efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// returns true) indicates whether the diagnostics handled by this 948efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// DiagnosticClient should be included in the number of diagnostics reported 949efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// by Diagnostic. 950cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek virtual bool IncludeInDiagnosticCounts() const; 9515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 9525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleDiagnostic - Handle this diagnostic, reporting it to the user or 9535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// capturing it to a log as needed. 9540a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner virtual void HandleDiagnostic(Diagnostic::Level DiagLevel, 9550a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const DiagnosticInfo &Info) = 0; 9565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 9575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 9585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 9595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 9605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 961