Diagnostic.h revision 5800f7ea9cf5621280089d690f677bd28064d6b5
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" 18eaea925e70e3ee85809e572aa8474b8dfc491af7Daniel Dunbar#include "llvm/ADT/StringRef.h" 193f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor#include "llvm/Support/type_traits.h" 205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include <string> 2104ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner#include <vector> 22f86638365f4801ec2d2970f7c0663e94590618b8Chris Lattner#include <cassert> 235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 24f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattnernamespace llvm { 25f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner template <typename T> class SmallVectorImpl; 26d93256e55673a17d18543397ec462416acb13792Douglas Gregor class raw_ostream; 27f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner} 28f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner 295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang { 303f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor class DeclContext; 313cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner class DiagnosticBuilder; 32b2153946fff330e54abfdc740c0a83aedd485b33Anders Carlsson class DiagnosticClient; 33d93256e55673a17d18543397ec462416acb13792Douglas Gregor class FileManager; 34d42ffbd22fc7eb61321f6a88173ee424991f01c6Ted Kremenek class IdentifierInfo; 3540469651a3f8379dc0f32df69e9bade06a2aad36Chris Lattner class LangOptions; 36b2153946fff330e54abfdc740c0a83aedd485b33Anders Carlsson class PartialDiagnostic; 377d90199f109290e9d587479a481a2850d390b552Daniel Dunbar class Preprocessor; 38d93256e55673a17d18543397ec462416acb13792Douglas Gregor class SourceManager; 39b2153946fff330e54abfdc740c0a83aedd485b33Anders Carlsson class SourceRange; 401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Import the diagnostic enums themselves. 425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer namespace diag { 4319e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner // Start position for diagnostics. 4419e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner enum { 454ad4b3ebbe5769143389dccfcfadb666a4ba5940Daniel Dunbar DIAG_START_DRIVER = 300, 4650f4f469024928670f2d634c445686d00eeb89b7Daniel Dunbar DIAG_START_FRONTEND = DIAG_START_DRIVER + 100, 4750f4f469024928670f2d634c445686d00eeb89b7Daniel Dunbar DIAG_START_LEX = DIAG_START_FRONTEND + 100, 4819e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_START_PARSE = DIAG_START_LEX + 300, 4919e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_START_AST = DIAG_START_PARSE + 300, 5019e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_START_SEMA = DIAG_START_AST + 100, 51bb092bafa984e9fa05136b5cef40fd4374dea0f6Douglas Gregor DIAG_START_ANALYSIS = DIAG_START_SEMA + 1500, 5219e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_UPPER_LIMIT = DIAG_START_ANALYSIS + 100 5319e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner }; 5419e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner 55182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner class CustomDiagInfo; 561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// diag::kind - All of the diagnostics that can be emitted by the frontend. 5820c6b3b85e186cd52d5d99489132d71d498159ebChris Lattner typedef unsigned kind; 5920c6b3b85e186cd52d5d99489132d71d498159ebChris Lattner 6088eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner // Get typedefs for common diagnostics. 6188eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner enum { 625e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor#define DIAG(ENUM,FLAGS,DEFAULT_MAPPING,DESC,GROUP,SFINAE) ENUM, 634d7a089144f336b11e5e8ce437b3b27bce2b310dSebastian Redl#include "clang/Basic/DiagnosticCommonKinds.inc" 6488eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner NUM_BUILTIN_COMMON_DIAGNOSTICS 6588eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner#undef DIAG 6688eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner }; 671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Enum values that allow the client to map NOTEs, WARNINGs, and EXTENSIONs 695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to either MAP_IGNORE (nothing), MAP_WARNING (emit a warning), MAP_ERROR 7027ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// (emit as an error). It allows clients to map errors to 7127ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// MAP_ERROR/MAP_DEFAULT or MAP_FATAL (stop emitting diagnostics after this 7227ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// one). 735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer enum Mapping { 74691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner // NOTE: 0 means "uncomputed". 75691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner MAP_IGNORE = 1, //< Map this diagnostic to nothing, ignore it. 76691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner MAP_WARNING = 2, //< Map this diagnostic to a warning. 77691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner MAP_ERROR = 3, //< Map this diagnostic to an error. 782b07d8fe9e8a8ba12d64066632e17a9a5308a12eChris Lattner MAP_FATAL = 4, //< Map this diagnostic to a fatal error. 791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 80b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// Map this diagnostic to "warning", but make it immune to -Werror. This 81b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// happens when you specify -Wno-error=foo. 82e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner MAP_WARNING_NO_WERROR = 5, 83e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner /// Map this diagnostic to "error", but make it immune to -Wfatal-errors. 84e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner /// This happens for -Wno-fatal-errors=foo. 85e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner MAP_ERROR_NO_WFATAL = 6 865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 894b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// \brief Annotates a diagnostic with some code that should be 904b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// inserted, removed, or replaced to fix the problem. 914b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// 924b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// This kind of hint should be used when we are certain that the 934b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// introduction, removal, or modification of a particular (small!) 944b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// amount of code will correct a compilation error. The compiler 954b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// should also provide full recovery from such errors, such that 96b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor/// suppressing the diagnostic output can still result in successful 974b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// compilation. 984b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregorclass CodeModificationHint { 994b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregorpublic: 1004b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Tokens that should be removed to correct the error. 1014b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor SourceRange RemoveRange; 1024b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1034b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief The location at which we should insert code to correct 1044b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// the error. 1054b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor SourceLocation InsertionLoc; 1064b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1074b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief The actual code to insert at the insertion location, as a 1084b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// string. 1094b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor std::string CodeToInsert; 1104b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1114b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Empty code modification hint, indicating that no code 1124b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// modification is known. 1134b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor CodeModificationHint() : RemoveRange(), InsertionLoc() { } 1144b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1152f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson bool isNull() const { 1162f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson return !RemoveRange.isValid() && !InsertionLoc.isValid(); 1172f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson } 1182f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson 1194b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that inserts the given 1204b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// code string at a specific location. 1211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump static CodeModificationHint CreateInsertion(SourceLocation InsertionLoc, 122eaea925e70e3ee85809e572aa8474b8dfc491af7Daniel Dunbar llvm::StringRef Code) { 123b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor CodeModificationHint Hint; 124b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.InsertionLoc = InsertionLoc; 125b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.CodeToInsert = Code; 126b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 127b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 1284b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1294b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that removes the given 1304b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// source range. 131b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor static CodeModificationHint CreateRemoval(SourceRange RemoveRange) { 132b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor CodeModificationHint Hint; 133b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.RemoveRange = RemoveRange; 134b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 135b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 1364b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1374b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that replaces the given 1384b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// source range with the given code string. 1391eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump static CodeModificationHint CreateReplacement(SourceRange RemoveRange, 140eaea925e70e3ee85809e572aa8474b8dfc491af7Daniel Dunbar llvm::StringRef Code) { 141b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor CodeModificationHint Hint; 142b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.RemoveRange = RemoveRange; 143b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.InsertionLoc = RemoveRange.getBegin(); 144b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.CodeToInsert = Code; 145b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 146b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 1474b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor}; 1484b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// Diagnostic - This concrete class is used by the front-end to report 1505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// problems and issues. It massages the diagnostics (e.g. handling things like 1515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// "report warnings as errors" and passes them off to the DiagnosticClient for 1525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// reporting to the user. 1535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass Diagnostic { 154182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattnerpublic: 155182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// Level - The level of the diagnostic, after it has been through mapping. 156182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner enum Level { 157da0cbc1ad4a553c4de111c1181ec7b42c5ddefceChris Lattner Ignored, Note, Warning, Error, Fatal 158182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner }; 1591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 160b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// ExtensionHandling - How do we handle otherwise-unmapped extension? This 161b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// is controlled by -pedantic and -pedantic-errors. 162b54b276a920246c595a0498da281821eb9d22996Chris Lattner enum ExtensionHandling { 163b54b276a920246c595a0498da281821eb9d22996Chris Lattner Ext_Ignore, Ext_Warn, Ext_Error 164b54b276a920246c595a0498da281821eb9d22996Chris Lattner }; 1651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1663fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner enum ArgumentKind { 16747b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_std_string, // std::string 16847b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_c_string, // const char * 16947b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_sint, // int 17047b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_uint, // unsigned 17147b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_identifierinfo, // IdentifierInfo 17247b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_qualtype, // QualType 17347b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_declarationname, // DeclarationName 174dacd434c49658286c380c7b4c357d76d53cb4aa1Douglas Gregor ak_nameddecl, // NamedDecl * 1753f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor ak_nestednamespec, // NestedNameSpecifier * 1763f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor ak_declcontext // DeclContext * 1773fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner }; 178b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner 179b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// ArgumentValue - This typedef represents on argument value, which is a 180b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// union discriminated by ArgumentKind, with a value. 181b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner typedef std::pair<ArgumentKind, intptr_t> ArgumentValue; 182ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 1831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumpprivate: 18427ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner unsigned char AllExtensionsSilenced; // Used by __extension__ 185b54b276a920246c595a0498da281821eb9d22996Chris Lattner bool IgnoreAllWarnings; // Ignore all warnings: -w 1861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump bool WarningsAsErrors; // Treat warnings like errors: 187e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner bool ErrorsAsFatal; // Treat errors like fatal errors. 188b54b276a920246c595a0498da281821eb9d22996Chris Lattner bool SuppressSystemWarnings; // Suppress warnings in system headers. 18981b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor bool SuppressAllDiagnostics; // Suppress all diagnostics. 190b54b276a920246c595a0498da281821eb9d22996Chris Lattner ExtensionHandling ExtBehavior; // Map extensions onto warnings or errors? 191b4398aa27da4d6919c3ae448d1ae66ba6cafc048Ted Kremenek DiagnosticClient *Client; 1925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// DiagMappings - Mapping information for diagnostics. Mapping info is 194691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// packed into four bits per diagnostic. The low three bits are the mapping 195691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// (an instance of diag::Mapping), or zero if unset. The high bit is set 196691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// when the mapping was established as a user mapping. If the high bit is 197691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// clear, then the low bits are set to the default value, and should be 198691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// mapped with -pedantic, -Werror, etc. 19904ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 20004ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner typedef std::vector<unsigned char> DiagMappings; 20104ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner mutable std::vector<DiagMappings> DiagMappingsStack; 20204ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 20315221422eda7bac679e38b07512feda49715ef66Chris Lattner /// ErrorOccurred / FatalErrorOccurred - This is set to true when an error or 20415221422eda7bac679e38b07512feda49715ef66Chris Lattner /// fatal error is emitted, and is sticky. 2055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ErrorOccurred; 20615221422eda7bac679e38b07512feda49715ef66Chris Lattner bool FatalErrorOccurred; 2071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 208f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// LastDiagLevel - This is the level of the last diagnostic emitted. This is 209f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// used to emit continuation diagnostics with the same level as the 210f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// diagnostic that they follow. 211f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner Diagnostic::Level LastDiagLevel; 2125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumDiagnostics; // Number of diagnostics reported 2145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumErrors; // Number of diagnostics that are errors 215182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner 216182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// CustomDiagInfo - Information for uniquing and looking up custom diags. 217182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner diag::CustomDiagInfo *CustomDiagInfo; 2187bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber 2193fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// ArgToStringFn - A function pointer that converts an opaque diagnostic 2203fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// argument to a strings. This takes the modifiers and argument that was 2213fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// present in the diagnostic. 222b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// 223b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// The PrevArgs array (whose length is NumPrevArgs) indicates the previous 224b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// arguments formatted for this diagnostic. Implementations of this function 225b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// can use this information to avoid redundancy across arguments. 226b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// 22722caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner /// This is a hack to avoid a layering violation between libbasic and libsema. 2283fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner typedef void (*ArgToStringFnTy)(ArgumentKind Kind, intptr_t Val, 2293fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Modifier, unsigned ModifierLen, 2303fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Argument, unsigned ArgumentLen, 231b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner const ArgumentValue *PrevArgs, 232b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner unsigned NumPrevArgs, 23392dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner llvm::SmallVectorImpl<char> &Output, 23492dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner void *Cookie); 23592dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner void *ArgToStringCookie; 2363fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ArgToStringFnTy ArgToStringFn; 23793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 23893ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief ID of the "delayed" diagnostic, which is a (typically 23993ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// fatal) diagnostic that had to be delayed because it was found 24093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// while emitting another diagnostic. 24193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor unsigned DelayedDiagID; 24293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 24393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief First string argument for the delayed diagnostic. 24493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor std::string DelayedDiagArg1; 24593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 24693ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief Second string argument for the delayed diagnostic. 24793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor std::string DelayedDiagArg2; 24893ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 2495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 2507bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber explicit Diagnostic(DiagnosticClient *client = 0); 251182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner ~Diagnostic(); 2521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 2545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Diagnostic characterization methods, used by a client to customize how 2555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // 2561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2576f776b0c943c0065b5148297e61afbe29d54cc51Daniel Dunbar DiagnosticClient *getClient() { return Client; } 2586f776b0c943c0065b5148297e61afbe29d54cc51Daniel Dunbar const DiagnosticClient *getClient() const { return Client; } 25904ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 2601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// pushMappings - Copies the current DiagMappings and pushes the new copy 26104ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// onto the top of the stack. 26204ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner void pushMappings(); 26304ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 26404ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// popMappings - Pops the current DiagMappings off the top of the stack 26504ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// causing the new top of the stack to be the active mappings. Returns 26604ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// true if the pop happens, false if there is only one DiagMapping on the 26704ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// stack. 26804ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner bool popMappings(); 26904ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 270b4398aa27da4d6919c3ae448d1ae66ba6cafc048Ted Kremenek void setClient(DiagnosticClient* client) { Client = client; } 2715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2725b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner /// setIgnoreAllWarnings - When set to true, any unmapped warnings are 2735b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner /// ignored. If this and WarningsAsErrors are both set, then this one wins. 2745b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner void setIgnoreAllWarnings(bool Val) { IgnoreAllWarnings = Val; } 2755b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner bool getIgnoreAllWarnings() const { return IgnoreAllWarnings; } 2761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setWarningsAsErrors - When set to true, any warnings reported are issued 2785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// as errors. 2795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setWarningsAsErrors(bool Val) { WarningsAsErrors = Val; } 2805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getWarningsAsErrors() const { return WarningsAsErrors; } 2811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 282e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner /// setErrorsAsFatal - When set to true, any error reported is made a 283e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner /// fatal error. 284e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner void setErrorsAsFatal(bool Val) { ErrorsAsFatal = Val; } 285e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner bool getErrorsAsFatal() const { return ErrorsAsFatal; } 286e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner 2872fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar /// setSuppressSystemWarnings - When set to true mask warnings that 2882fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar /// come from system headers. 2892fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar void setSuppressSystemWarnings(bool Val) { SuppressSystemWarnings = Val; } 2902fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar bool getSuppressSystemWarnings() const { return SuppressSystemWarnings; } 2912fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar 29281b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor /// \brief Suppress all diagnostics, to silence the front end when we 29381b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor /// know that we don't want any more diagnostics to be passed along to the 29481b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor /// client 29581b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor void setSuppressAllDiagnostics(bool Val = true) { 29681b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor SuppressAllDiagnostics = Val; 29781b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor } 29881b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor bool getSuppressAllDiagnostics() const { return SuppressAllDiagnostics; } 29981b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor 3000b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor /// \brief Pretend that the last diagnostic issued was ignored. This can 3010b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor /// be used by clients who suppress diagnostics themselves. 3020b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor void setLastDiagnosticIgnored() { 3030b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor LastDiagLevel = Ignored; 3040b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor } 3050b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor 306b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// setExtensionHandlingBehavior - This controls whether otherwise-unmapped 307b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// extension diagnostics are mapped onto ignore/warning/error. This 308b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// corresponds to the GCC -pedantic and -pedantic-errors option. 309b54b276a920246c595a0498da281821eb9d22996Chris Lattner void setExtensionHandlingBehavior(ExtensionHandling H) { 310b54b276a920246c595a0498da281821eb9d22996Chris Lattner ExtBehavior = H; 311b54b276a920246c595a0498da281821eb9d22996Chris Lattner } 3121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 31327ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// AllExtensionsSilenced - This is a counter bumped when an __extension__ 31427ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// block is encountered. When non-zero, all extension diagnostics are 31527ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// entirely silenced, no matter how they are mapped. 31627ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner void IncrementAllExtensionsSilenced() { ++AllExtensionsSilenced; } 31727ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner void DecrementAllExtensionsSilenced() { --AllExtensionsSilenced; } 31891a2886d558ea6ca7a0bed73ab5acea5ae78eac2Douglas Gregor bool hasAllExtensionsSilenced() { return AllExtensionsSilenced != 0; } 3191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setDiagnosticMapping - This allows the client to specify that certain 321691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// warnings are ignored. Notes can never be mapped, errors can only be 322691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// mapped to fatal, and WARNINGs and EXTENSIONs can be mapped arbitrarily. 3235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setDiagnosticMapping(diag::kind Diag, diag::Mapping Map) { 32419e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner assert(Diag < diag::DIAG_UPPER_LIMIT && 3250750618b0beacdc9b0a9e210a661e4746823ced7Chris Lattner "Can only map builtin diagnostics"); 326f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner assert((isBuiltinWarningOrExtension(Diag) || Map == diag::MAP_FATAL) && 3277fc24e2d47e1cdf03e655ed212d282635d755591Chris Lattner "Cannot map errors!"); 328691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner setDiagnosticMappingInternal(Diag, Map, true); 32927ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner } 3301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3313bc172bc6a787842db6fea351cf6929539fca70dChris Lattner /// setDiagnosticGroupMapping - Change an entire diagnostic group (e.g. 3323bc172bc6a787842db6fea351cf6929539fca70dChris Lattner /// "unknown-pragmas" to have the specified mapping. This returns true and 3333bc172bc6a787842db6fea351cf6929539fca70dChris Lattner /// ignores the request if "Group" was unknown, false otherwise. 3343bc172bc6a787842db6fea351cf6929539fca70dChris Lattner bool setDiagnosticGroupMapping(const char *Group, diag::Mapping Map); 3355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool hasErrorOccurred() const { return ErrorOccurred; } 33715221422eda7bac679e38b07512feda49715ef66Chris Lattner bool hasFatalErrorOccurred() const { return FatalErrorOccurred; } 3385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned getNumErrors() const { return NumErrors; } 3405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned getNumDiagnostics() const { return NumDiagnostics; } 3411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 342182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// getCustomDiagID - Return an ID for a diagnostic with the specified message 343182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// and level. If this is the first request for this diagnosic, it is 344182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// registered and created, otherwise the existing ID is returned. 34532d4d80c26e8c4c1922cff4661e0b9f44a3aabfcDaniel Dunbar unsigned getCustomDiagID(Level L, llvm::StringRef Message); 3461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3483fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// ConvertArgToString - This method converts a diagnostic argument (as an 3493fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// intptr_t) into the string that represents it. 3503fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner void ConvertArgToString(ArgumentKind Kind, intptr_t Val, 3513fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Modifier, unsigned ModLen, 3523fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Argument, unsigned ArgLen, 353b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner const ArgumentValue *PrevArgs, unsigned NumPrevArgs, 3543fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner llvm::SmallVectorImpl<char> &Output) const { 355b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner ArgToStringFn(Kind, Val, Modifier, ModLen, Argument, ArgLen, 356b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner PrevArgs, NumPrevArgs, Output, ArgToStringCookie); 35722caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 3581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 35992dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner void SetArgToStringFn(ArgToStringFnTy Fn, void *Cookie) { 3603fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ArgToStringFn = Fn; 36192dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner ArgToStringCookie = Cookie; 36222caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 3631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 3655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Diagnostic classification and reporting interfaces. 3665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // 3675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getDescription - Given a diagnostic ID, return a description of the 3695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// issue. 3700a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const char *getDescription(unsigned DiagID) const; 3711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 372f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// isNoteWarningOrExtension - Return true if the unmapped diagnostic 373f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// level of the specified diagnostic ID is a Warning or Extension. 374f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// This only works on builtin diagnostics, not custom ones, and is not legal to 375f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// call on NOTEs. 376f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner static bool isBuiltinWarningOrExtension(unsigned DiagID); 3775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 378ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor /// \brief Determine whether the given built-in diagnostic ID is a 379ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor /// Note. 380ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor static bool isBuiltinNote(unsigned DiagID); 3811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 38227ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// isBuiltinExtensionDiag - Determine whether the given built-in diagnostic 38327ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// ID is for an extension of some sort. 38427ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// 38527ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner static bool isBuiltinExtensionDiag(unsigned DiagID); 3861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 387d51d74a3e89c5e5fc9bfd2814996a5feab6dc932Chris Lattner /// getWarningOptionForDiag - Return the lowest-level warning option that 388d51d74a3e89c5e5fc9bfd2814996a5feab6dc932Chris Lattner /// enables the specified diagnostic. If there is no -Wfoo flag that controls 389d51d74a3e89c5e5fc9bfd2814996a5feab6dc932Chris Lattner /// the diagnostic, this returns null. 390d51d74a3e89c5e5fc9bfd2814996a5feab6dc932Chris Lattner static const char *getWarningOptionForDiag(unsigned DiagID); 391ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 392eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// \brief Enumeration describing how the the emission of a diagnostic should 393eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// be treated when it occurs during C++ template argument deduction. 394eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor enum SFINAEResponse { 395eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// \brief The diagnostic should not be reported, but it should cause 396eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// template argument deduction to fail. 397eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// 398eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// The vast majority of errors that occur during template argument 399eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// deduction fall into this category. 400eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor SFINAE_SubstitutionFailure, 401eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor 402eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// \brief The diagnostic should be suppressed entirely. 403eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// 404eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// Warnings generally fall into this category. 405eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor SFINAE_Suppress, 406eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor 407eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// \brief The diagnostic should be reported. 408eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// 409eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// The diagnostic should be reported. Various fatal errors (e.g., 410eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// template instantiation depth exceeded) fall into this category. 411eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor SFINAE_Report 412eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor }; 413eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor 4145e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// \brief Determines whether the given built-in diagnostic ID is 4155e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// for an error that is suppressed if it occurs during C++ template 4165e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// argument deduction. 4175e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// 4185e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// When an error is suppressed due to SFINAE, the template argument 4195e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// deduction fails but no diagnostic is emitted. Certain classes of 4205e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// errors, such as those errors that involve C++ access control, 4215e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// are not SFINAE errors. 422eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor static SFINAEResponse getDiagnosticSFINAEResponse(unsigned DiagID); 4235e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor 4245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getDiagnosticLevel - Based on the way the client configured the Diagnostic 4255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// object, classify the specified diagnostic ID into a Level, consumable by 4265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the DiagnosticClient. 4271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump Level getDiagnosticLevel(unsigned DiagID) const; 4281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 429509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// Report - Issue the message to the client. @c DiagID is a member of the 430509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// @c diag::kind enum. This actually returns aninstance of DiagnosticBuilder 431509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// which emits the diagnostics (through @c ProcessDiag) when it is destroyed. 432509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// @c Pos represents the source location associated with the diagnostic, 433509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// which can be an invalid location if no position information is available. 4343cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner inline DiagnosticBuilder Report(FullSourceLoc Pos, unsigned DiagID); 4350f9fed70cea107b3f79df554e38bd8e98d48fe47Daniel Dunbar inline DiagnosticBuilder Report(unsigned DiagID); 436de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor 43793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief Determine whethere there is already a diagnostic in flight. 4385800f7ea9cf5621280089d690f677bd28064d6b5Ted Kremenek bool isDiagnosticInFlight() const { return CurDiagID != ~0U; } 43993ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 44093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief Set the "delayed" diagnostic that will be emitted once 44193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// the current diagnostic completes. 44293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// 44393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// If a diagnostic is already in-flight but the front end must 44493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// report a problem (e.g., with an inconsistent file system 44593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// state), this routine sets a "delayed" diagnostic that will be 44693ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// emitted after the current diagnostic completes. This should 44793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// only be used for fatal errors detected at inconvenient 44893ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// times. If emitting a delayed diagnostic causes a second delayed 44993ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// diagnostic to be introduced, that second delayed diagnostic 45093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// will be ignored. 45193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// 45293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \param DiagID The ID of the diagnostic being delayed. 45393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// 45493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \param Arg1 A string argument that will be provided to the 45593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// diagnostic. A copy of this string will be stored in the 45693ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// Diagnostic object itself. 45793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// 45893ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \param Arg2 A string argument that will be provided to the 45993ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// diagnostic. A copy of this string will be stored in the 46093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// Diagnostic object itself. 46193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor void SetDelayedDiagnostic(unsigned DiagID, llvm::StringRef Arg1 = "", 46293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor llvm::StringRef Arg2 = ""); 46393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 464de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor /// \brief Clear out the current diagnostic. 465de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor void Clear() { CurDiagID = ~0U; } 4661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4670a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattnerprivate: 46893ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief Report the delayed diagnostic. 46993ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor void ReportDelayed(); 47093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 47193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 472691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// getDiagnosticMappingInfo - Return the mapping info currently set for the 473691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// specified builtin diagnostic. This returns the high bit encoding, or zero 474691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// if the field is completely uninitialized. 475691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner unsigned getDiagnosticMappingInfo(diag::kind Diag) const { 47604ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner const DiagMappings ¤tMappings = DiagMappingsStack.back(); 47704ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner return (diag::Mapping)((currentMappings[Diag/2] >> (Diag & 1)*4) & 15); 478691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner } 4791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 480691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner void setDiagnosticMappingInternal(unsigned DiagId, unsigned Map, 481691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner bool isUser) const { 482691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner if (isUser) Map |= 8; // Set the high bit for user mappings. 48304ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner unsigned char &Slot = DiagMappingsStack.back()[DiagId/2]; 484691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner unsigned Shift = (DiagId & 1)*4; 485691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner Slot &= ~(15 << Shift); 486691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner Slot |= Map << Shift; 4879faf50e62ddcd2535b472abc8daafd7042120caaChris Lattner } 4881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 489f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// getDiagnosticLevel - This is an internal implementation helper used when 490f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// DiagClass is already known. 491f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner Level getDiagnosticLevel(unsigned DiagID, unsigned DiagClass) const; 492f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner 4933cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner // This is private state used by DiagnosticBuilder. We put it here instead of 4943cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner // in DiagnosticBuilder in order to keep DiagnosticBuilder a small lightweight 4950a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // object. This implementation choice means that we can only have one 4960a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // diagnostic "in flight" at a time, but this seems to be a reasonable 4970a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // tradeoff to keep these objects small. Assertions verify that only one 4980a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // diagnostic is in flight at a time. 4993cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner friend class DiagnosticBuilder; 5000a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner friend class DiagnosticInfo; 501b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner 502b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner /// CurDiagLoc - This is the location of the current diagnostic that is in 503b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner /// flight. 504b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner FullSourceLoc CurDiagLoc; 5051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 506b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner /// CurDiagID - This is the ID of the current diagnostic that is in flight. 5073cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// This is set to ~0U when there is no diagnostic in flight. 508b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner unsigned CurDiagID; 509b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner 51073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner enum { 51173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// MaxArguments - The maximum number of arguments we can hold. We currently 51273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// only support up to 10 arguments (%0-%9). A single diagnostic with more 51373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// than that almost certainly has to be simplified anyway. 51473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner MaxArguments = 10 51573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner }; 5161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5173cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// NumDiagArgs - This contains the number of entries in Arguments. 518730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner signed char NumDiagArgs; 519730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner /// NumRanges - This is the number of ranges in the DiagRanges array. 520730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner unsigned char NumDiagRanges; 5214b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief The number of code modifications hints in the 5224b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// CodeModificationHints array. 5234b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor unsigned char NumCodeModificationHints; 524ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 52573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsKind - This is an array of ArgumentKind::ArgumentKind enum 52673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// values, with one for each argument. This specifies whether the argument 52773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// is in DiagArgumentsStr or in DiagArguments. 52873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner unsigned char DiagArgumentsKind[MaxArguments]; 5291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 53073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsStr - This holds the values of each string argument for the 53173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// current diagnostic. This value is only used when the corresponding 53273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// ArgumentKind is ak_std_string. 53373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner std::string DiagArgumentsStr[MaxArguments]; 53473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 53573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsVal - The values for the various substitution positions. This 53673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// is used when the argument is not an std::string. The specific value is 53773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// mangled into an intptr_t and the intepretation depends on exactly what 53873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// sort of argument kind it is. 53973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner intptr_t DiagArgumentsVal[MaxArguments]; 5401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5410a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// DiagRanges - The list of ranges added to this diagnostic. It currently 5420a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// only support 10 ranges, could easily be extended if needed. 54351c6d384551674facc19f745ecf6e289d28dc55fDouglas Gregor SourceRange DiagRanges[10]; 5441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5454b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor enum { MaxCodeModificationHints = 3 }; 5464b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 5474b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// CodeModificationHints - If valid, provides a hint with some code 5484b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// to insert, remove, or modify at a particular position. 5494b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor CodeModificationHint CodeModificationHints[MaxCodeModificationHints]; 5504b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 5510a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// ProcessDiag - This is the method used to report a diagnostic that is 5520a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// finally fully formed. 5535e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// 5545e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// \returns true if the diagnostic was emitted, false if it was 5555e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// suppressed. 5565e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor bool ProcessDiag(); 5573cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}; 5583cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 5593cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 5603cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner// DiagnosticBuilder 5613cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 5623cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 5633cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// DiagnosticBuilder - This is a little helper class used to produce 5643cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// diagnostics. This is constructed by the Diagnostic::Report method, and 5653cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// allows insertion of extra information (arguments and source ranges) into the 5663cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// currently "in flight" diagnostic. When the temporary for the builder is 5673cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// destroyed, the diagnostic is issued. 5683cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// 5693cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// Note that many of these will be created as temporary objects (many call 5703cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// sites), so we want them to be small and we never want their address taken. 5713cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// This ensures that compilers with somewhat reasonable optimizers will promote 5723cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// the common fields to registers, eliminating increments of the NumArgs field, 5733cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// for example. 5743cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerclass DiagnosticBuilder { 5753cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner mutable Diagnostic *DiagObj; 57625a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor mutable unsigned NumArgs, NumRanges, NumCodeModificationHints; 5771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5783cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void operator=(const DiagnosticBuilder&); // DO NOT IMPLEMENT 5793cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner friend class Diagnostic; 5803cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner explicit DiagnosticBuilder(Diagnostic *diagObj) 5811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump : DiagObj(diagObj), NumArgs(0), NumRanges(0), 58225a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor NumCodeModificationHints(0) {} 583ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 5841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumppublic: 5850a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// Copy constructor. When copied, this "takes" the diagnostic info from the 5860a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// input and neuters it. 5873cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagnosticBuilder(const DiagnosticBuilder &D) { 5880a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner DiagObj = D.DiagObj; 5890a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner D.DiagObj = 0; 59025a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor NumArgs = D.NumArgs; 59125a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor NumRanges = D.NumRanges; 59225a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor NumCodeModificationHints = D.NumCodeModificationHints; 5930a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 59425a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor 5955e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// \brief Simple enumeration value used to give a name to the 5965e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// suppress-diagnostic constructor. 5975e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor enum SuppressKind { Suppress }; 5985e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor 5995e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// \brief Create an empty DiagnosticBuilder object that represents 6005e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// no actual diagnostic. 6011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump explicit DiagnosticBuilder(SuppressKind) 6025e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor : DiagObj(0), NumArgs(0), NumRanges(0), NumCodeModificationHints(0) { } 6035e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor 60425a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// \brief Force the diagnostic builder to emit the diagnostic now. 60525a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// 60625a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// Once this function has been called, the DiagnosticBuilder object 60725a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// should not be used again before it is destroyed. 6085e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// 6095e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// \returns true if a diagnostic was emitted, false if the 6105e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// diagnostic was suppressed. 61193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor bool Emit(); 61225a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor 61325a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// Destructor - The dtor emits the diagnostic if it hasn't already 61425a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// been emitted. 61525a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor ~DiagnosticBuilder() { Emit(); } 6161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 617d93256e55673a17d18543397ec462416acb13792Douglas Gregor /// isActive - Determine whether this diagnostic is still active. 618d93256e55673a17d18543397ec462416acb13792Douglas Gregor bool isActive() const { return DiagObj != 0; } 619d93256e55673a17d18543397ec462416acb13792Douglas Gregor 6203cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// Operator bool: conversion of DiagnosticBuilder to bool always returns 6213cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// true. This allows is to be used in boolean error contexts like: 6223cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// return Diag(...); 6233cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner operator bool() const { return true; } 6243cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 625eaea925e70e3ee85809e572aa8474b8dfc491af7Daniel Dunbar void AddString(llvm::StringRef S) const { 6263cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(NumArgs < Diagnostic::MaxArguments && 6273cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 6285e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor if (DiagObj) { 6295e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor DiagObj->DiagArgumentsKind[NumArgs] = Diagnostic::ak_std_string; 6305e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor DiagObj->DiagArgumentsStr[NumArgs++] = S; 6315e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor } 6323cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner } 6331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6343cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void AddTaggedVal(intptr_t V, Diagnostic::ArgumentKind Kind) const { 6353cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(NumArgs < Diagnostic::MaxArguments && 6363cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 6375e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor if (DiagObj) { 6385e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor DiagObj->DiagArgumentsKind[NumArgs] = Kind; 6395e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor DiagObj->DiagArgumentsVal[NumArgs++] = V; 6405e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor } 6410a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 6421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6433cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void AddSourceRange(const SourceRange &R) const { 6441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump assert(NumRanges < 6453cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner sizeof(DiagObj->DiagRanges)/sizeof(DiagObj->DiagRanges[0]) && 6463cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 6475e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor if (DiagObj) 64851c6d384551674facc19f745ecf6e289d28dc55fDouglas Gregor DiagObj->DiagRanges[NumRanges++] = R; 6491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 6504b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 6514b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor void AddCodeModificationHint(const CodeModificationHint &Hint) const { 6522f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson if (Hint.isNull()) 6532f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson return; 6542f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson 6554b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor assert(NumCodeModificationHints < Diagnostic::MaxCodeModificationHints && 6564b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor "Too many code modification hints!"); 6575e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor if (DiagObj) 6585e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor DiagObj->CodeModificationHints[NumCodeModificationHints++] = Hint; 6594b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 6603cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}; 6613cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 6623cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 663eaea925e70e3ee85809e572aa8474b8dfc491af7Daniel Dunbar llvm::StringRef S) { 6643cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddString(S); 6653cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 6663cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 6673cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 6683cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 6693cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const char *Str) { 6703cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(reinterpret_cast<intptr_t>(Str), 6713cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner Diagnostic::ak_c_string); 6723cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 6733cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 6743cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 6753cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, int I) { 6763cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(I, Diagnostic::ak_sint); 6773cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 6783cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 6793cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 6803bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidisinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,bool I) { 6813bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis DB.AddTaggedVal(I, Diagnostic::ak_sint); 6823bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis return DB; 6833bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis} 6843bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis 6853cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 6863cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner unsigned I) { 6873cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(I, Diagnostic::ak_uint); 6883cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 6893cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 6903cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 6913cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 6923cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const IdentifierInfo *II) { 6933cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(reinterpret_cast<intptr_t>(II), 6943cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner Diagnostic::ak_identifierinfo); 6953cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 6963cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 6971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6983f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// Adds a DeclContext to the diagnostic. The enable_if template magic is here 6993f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// so that we only match those arguments that are (statically) DeclContexts; 7003f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// other arguments that derive from DeclContext (e.g., RecordDecls) will not 7013f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// match. 7023f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregortemplate<typename T> 7033f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregorinline 7043f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregortypename llvm::enable_if<llvm::is_same<T, DeclContext>, 7053f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor const DiagnosticBuilder &>::type 7063f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregoroperator<<(const DiagnosticBuilder &DB, T *DC) { 7073f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor DB.AddTaggedVal(reinterpret_cast<intptr_t>(DC), 7083f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor Diagnostic::ak_declcontext); 7093f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor return DB; 7103f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor} 7113f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor 7123cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 7133cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const SourceRange &R) { 7143cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddSourceRange(R); 7153cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 7163cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 7174b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 7184b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregorinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 7194b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor const CodeModificationHint &Hint) { 7204b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor DB.AddCodeModificationHint(Hint); 7214b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor return DB; 7224b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor} 723ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 7243cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// Report - Issue the message to the client. DiagID is a member of the 7253cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// diag::kind enum. This actually returns a new instance of DiagnosticBuilder 7263cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// which emits the diagnostics (through ProcessDiag) when it is destroyed. 7273cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline DiagnosticBuilder Diagnostic::Report(FullSourceLoc Loc, unsigned DiagID){ 7283cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(CurDiagID == ~0U && "Multiple diagnostics in flight at once!"); 7293cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner CurDiagLoc = Loc; 7303cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner CurDiagID = DiagID; 7313cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DiagnosticBuilder(this); 7323cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 7330f9fed70cea107b3f79df554e38bd8e98d48fe47Daniel Dunbarinline DiagnosticBuilder Diagnostic::Report(unsigned DiagID) { 7340f9fed70cea107b3f79df554e38bd8e98d48fe47Daniel Dunbar return Report(FullSourceLoc(), DiagID); 7350f9fed70cea107b3f79df554e38bd8e98d48fe47Daniel Dunbar} 7363cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 7373cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 7383cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner// DiagnosticInfo 7393cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 7401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7413cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// DiagnosticInfo - This is a little helper class (which is basically a smart 7424b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// pointer that forward info from Diagnostic) that allows clients to enquire 7433cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// about the currently in-flight diagnostic. 7443cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerclass DiagnosticInfo { 7453cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const Diagnostic *DiagObj; 7463cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerpublic: 7473cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner explicit DiagnosticInfo(const Diagnostic *DO) : DiagObj(DO) {} 7481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7490a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const Diagnostic *getDiags() const { return DiagObj; } 750b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner unsigned getID() const { return DiagObj->CurDiagID; } 751b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner const FullSourceLoc &getLocation() const { return DiagObj->CurDiagLoc; } 7521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7530a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned getNumArgs() const { return DiagObj->NumDiagArgs; } 7541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 75573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgKind - Return the kind of the specified index. Based on the kind 75673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// of argument, the accessors below can be used to get the value. 7573cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner Diagnostic::ArgumentKind getArgKind(unsigned Idx) const { 7583cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(Idx < getNumArgs() && "Argument index out of range!"); 7593cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return (Diagnostic::ArgumentKind)DiagObj->DiagArgumentsKind[Idx]; 76073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner } 7611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 76273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgStdStr - Return the provided argument string specified by Idx. 76373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner const std::string &getArgStdStr(unsigned Idx) const { 7643cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_std_string && 7653cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 76673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner return DiagObj->DiagArgumentsStr[Idx]; 76773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner } 7681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 76973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgCStr - Return the specified C string argument. 77073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner const char *getArgCStr(unsigned Idx) const { 7713cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_c_string && 7723cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 77373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner return reinterpret_cast<const char*>(DiagObj->DiagArgumentsVal[Idx]); 7740a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 7751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 77630bc96544346bea42921cf6837e66cef80d664b4Chris Lattner /// getArgSInt - Return the specified signed integer argument. 77730bc96544346bea42921cf6837e66cef80d664b4Chris Lattner int getArgSInt(unsigned Idx) const { 7783cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_sint && 7793cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 78030bc96544346bea42921cf6837e66cef80d664b4Chris Lattner return (int)DiagObj->DiagArgumentsVal[Idx]; 78130bc96544346bea42921cf6837e66cef80d664b4Chris Lattner } 7821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 78330bc96544346bea42921cf6837e66cef80d664b4Chris Lattner /// getArgUInt - Return the specified unsigned integer argument. 78430bc96544346bea42921cf6837e66cef80d664b4Chris Lattner unsigned getArgUInt(unsigned Idx) const { 7853cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_uint && 7863cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 78730bc96544346bea42921cf6837e66cef80d664b4Chris Lattner return (unsigned)DiagObj->DiagArgumentsVal[Idx]; 78830bc96544346bea42921cf6837e66cef80d664b4Chris Lattner } 7891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 79043b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner /// getArgIdentifier - Return the specified IdentifierInfo argument. 79143b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner const IdentifierInfo *getArgIdentifier(unsigned Idx) const { 7923cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_identifierinfo && 7933cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 7949634379265855f1628190e926d9aaf1fb4a5d90eChris Lattner return reinterpret_cast<IdentifierInfo*>(DiagObj->DiagArgumentsVal[Idx]); 79543b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner } 7961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 79722caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner /// getRawArg - Return the specified non-string argument in an opaque form. 79822caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner intptr_t getRawArg(unsigned Idx) const { 79922caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner assert(getArgKind(Idx) != Diagnostic::ak_std_string && 80022caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner "invalid argument accessor!"); 80122caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner return DiagObj->DiagArgumentsVal[Idx]; 80222caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 8031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8050a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// getNumRanges - Return the number of source ranges associated with this 8060a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// diagnostic. 8070a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned getNumRanges() const { 8080a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner return DiagObj->NumDiagRanges; 8090a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 8101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 81151c6d384551674facc19f745ecf6e289d28dc55fDouglas Gregor SourceRange getRange(unsigned Idx) const { 8120a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner assert(Idx < DiagObj->NumDiagRanges && "Invalid diagnostic range index!"); 81351c6d384551674facc19f745ecf6e289d28dc55fDouglas Gregor return DiagObj->DiagRanges[Idx]; 8140a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 8151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8164b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor unsigned getNumCodeModificationHints() const { 8174b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor return DiagObj->NumCodeModificationHints; 8184b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 8194b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 8204b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor const CodeModificationHint &getCodeModificationHint(unsigned Idx) const { 8214b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor return DiagObj->CodeModificationHints[Idx]; 8224b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 8234b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 8244b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor const CodeModificationHint *getCodeModificationHints() const { 8251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return DiagObj->NumCodeModificationHints? 8264b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor &DiagObj->CodeModificationHints[0] : 0; 8274b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 8284b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 829f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// FormatDiagnostic - Format this diagnostic into a string, substituting the 830f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// formal arguments into the %0 slots. The result is appended onto the Str 831f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// array. 832f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner void FormatDiagnostic(llvm::SmallVectorImpl<char> &OutStr) const; 8339f28614bf1a8387000d8df57a713fcf69e198145John McCall 8349f28614bf1a8387000d8df57a713fcf69e198145John McCall /// FormatDiagnostic - Format the given format-string into the 8359f28614bf1a8387000d8df57a713fcf69e198145John McCall /// output buffer using the arguments stored in this diagnostic. 8369f28614bf1a8387000d8df57a713fcf69e198145John McCall void FormatDiagnostic(const char *DiagStr, const char *DiagEnd, 8379f28614bf1a8387000d8df57a713fcf69e198145John McCall llvm::SmallVectorImpl<char> &OutStr) const; 838a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor}; 839a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 840a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor/** 841a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \brief Represents a diagnostic in a form that can be serialized and 842a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * deserialized. 843a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor */ 844a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregorclass StoredDiagnostic { 845a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor Diagnostic::Level Level; 846a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor FullSourceLoc Loc; 847a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor std::string Message; 848a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor std::vector<SourceRange> Ranges; 849a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor std::vector<CodeModificationHint> FixIts; 850a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 851a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregorpublic: 852a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor StoredDiagnostic(); 853a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor StoredDiagnostic(Diagnostic::Level Level, const DiagnosticInfo &Info); 854a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor StoredDiagnostic(Diagnostic::Level Level, llvm::StringRef Message); 855a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor ~StoredDiagnostic(); 856a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 857a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// \brief Evaluates true when this object stores a diagnostic. 858a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor operator bool() const { return Message.size() > 0; } 859a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 860a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor Diagnostic::Level getLevel() const { return Level; } 861a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor const FullSourceLoc &getLocation() const { return Loc; } 862a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor llvm::StringRef getMessage() const { return Message; } 863a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 864a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor typedef std::vector<SourceRange>::const_iterator range_iterator; 865a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor range_iterator range_begin() const { return Ranges.begin(); } 866a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor range_iterator range_end() const { return Ranges.end(); } 867a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned range_size() const { return Ranges.size(); } 868a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 869a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor typedef std::vector<CodeModificationHint>::const_iterator fixit_iterator; 870a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor fixit_iterator fixit_begin() const { return FixIts.begin(); } 871a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor fixit_iterator fixit_end() const { return FixIts.end(); } 872a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned fixit_size() const { return FixIts.size(); } 873d93256e55673a17d18543397ec462416acb13792Douglas Gregor 874d93256e55673a17d18543397ec462416acb13792Douglas Gregor /// Serialize - Serialize the given diagnostic (with its diagnostic 875d93256e55673a17d18543397ec462416acb13792Douglas Gregor /// level) to the given stream. Serialization is a lossy operation, 876d93256e55673a17d18543397ec462416acb13792Douglas Gregor /// since the specific diagnostic ID and any macro-instantiation 877d93256e55673a17d18543397ec462416acb13792Douglas Gregor /// information is lost. 878a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor void Serialize(llvm::raw_ostream &OS) const; 879a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 880a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// Deserialize - Deserialize the first diagnostic within the memory 881a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// [Memory, MemoryEnd), producing a new diagnostic builder describing the 882a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// deserialized diagnostic. If the memory does not contain a 883a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// diagnostic, returns a diagnostic builder with no diagnostic ID. 884a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor static StoredDiagnostic Deserialize(FileManager &FM, SourceManager &SM, 885a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor const char *&Memory, const char *MemoryEnd); 8865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 8871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// DiagnosticClient - This is an abstract interface implemented by clients of 8895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// the front-end, which formats and prints fully processed diagnostics. 8905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass DiagnosticClient { 8915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 8925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer virtual ~DiagnosticClient(); 8931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 894efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// BeginSourceFile - Callback to inform the diagnostic client that processing 895efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// of a source file is beginning. 896efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// 897efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// Note that diagnostics may be emitted outside the processing of a source 898efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// file, for example during the parsing of command line options. However, 899efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// diagnostics with source range information are required to only be emitted 900efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// in between BeginSourceFile() and EndSourceFile(). 901efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// 902efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// \arg LO - The language options for the source file being processed. 903efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// \arg PP - The preprocessor object being used for the source; this optional 904efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// and may not be present, for example when processing AST source files. 9057d90199f109290e9d587479a481a2850d390b552Daniel Dunbar virtual void BeginSourceFile(const LangOptions &LangOpts, 9067d90199f109290e9d587479a481a2850d390b552Daniel Dunbar const Preprocessor *PP = 0) {} 907efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar 908efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// EndSourceFile - Callback to inform the diagnostic client that processing 909efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// of a source file has ended. The diagnostic client should assume that any 910efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// objects made available via \see BeginSourceFile() are inaccessible. 911efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar virtual void EndSourceFile() {} 9121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 913cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek /// IncludeInDiagnosticCounts - This method (whose default implementation 914efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// returns true) indicates whether the diagnostics handled by this 915efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// DiagnosticClient should be included in the number of diagnostics reported 916efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// by Diagnostic. 917cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek virtual bool IncludeInDiagnosticCounts() const; 9185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 9195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleDiagnostic - Handle this diagnostic, reporting it to the user or 9205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// capturing it to a log as needed. 9210a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner virtual void HandleDiagnostic(Diagnostic::Level DiagLevel, 9220a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const DiagnosticInfo &Info) = 0; 9235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 9245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 9255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 9265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 9275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 928