Diagnostic.h revision 0a76aae8c03cb7dd7bdbe683485560afaf695959
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; 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; 381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Import the diagnostic enums themselves. 405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer namespace diag { 4119e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner // Start position for diagnostics. 4219e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner enum { 434ad4b3ebbe5769143389dccfcfadb666a4ba5940Daniel Dunbar DIAG_START_DRIVER = 300, 4450f4f469024928670f2d634c445686d00eeb89b7Daniel Dunbar DIAG_START_FRONTEND = DIAG_START_DRIVER + 100, 4550f4f469024928670f2d634c445686d00eeb89b7Daniel Dunbar DIAG_START_LEX = DIAG_START_FRONTEND + 100, 4619e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_START_PARSE = DIAG_START_LEX + 300, 4719e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_START_AST = DIAG_START_PARSE + 300, 4819e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_START_SEMA = DIAG_START_AST + 100, 49bb092bafa984e9fa05136b5cef40fd4374dea0f6Douglas Gregor DIAG_START_ANALYSIS = DIAG_START_SEMA + 1500, 5019e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_UPPER_LIMIT = DIAG_START_ANALYSIS + 100 5119e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner }; 5219e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner 53182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner class CustomDiagInfo; 541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// diag::kind - All of the diagnostics that can be emitted by the frontend. 5620c6b3b85e186cd52d5d99489132d71d498159ebChris Lattner typedef unsigned kind; 5720c6b3b85e186cd52d5d99489132d71d498159ebChris Lattner 5888eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner // Get typedefs for common diagnostics. 5988eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner enum { 6027b0f510d1d4f9ed5668eec1195f04b4a74a4426Chris Lattner#define DIAG(ENUM,FLAGS,DEFAULT_MAPPING,DESC,GROUP,SFINAE,CATEGORY) ENUM, 614d7a089144f336b11e5e8ce437b3b27bce2b310dSebastian Redl#include "clang/Basic/DiagnosticCommonKinds.inc" 6288eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner NUM_BUILTIN_COMMON_DIAGNOSTICS 6388eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner#undef DIAG 6488eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner }; 651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Enum values that allow the client to map NOTEs, WARNINGs, and EXTENSIONs 675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to either MAP_IGNORE (nothing), MAP_WARNING (emit a warning), MAP_ERROR 6827ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// (emit as an error). It allows clients to map errors to 6927ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// MAP_ERROR/MAP_DEFAULT or MAP_FATAL (stop emitting diagnostics after this 7027ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// one). 715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer enum Mapping { 72691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner // NOTE: 0 means "uncomputed". 73691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner MAP_IGNORE = 1, //< Map this diagnostic to nothing, ignore it. 74691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner MAP_WARNING = 2, //< Map this diagnostic to a warning. 75691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner MAP_ERROR = 3, //< Map this diagnostic to an error. 762b07d8fe9e8a8ba12d64066632e17a9a5308a12eChris Lattner MAP_FATAL = 4, //< Map this diagnostic to a fatal error. 771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 78b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// Map this diagnostic to "warning", but make it immune to -Werror. This 79b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// happens when you specify -Wno-error=foo. 80e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner MAP_WARNING_NO_WERROR = 5, 81e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner /// Map this diagnostic to "error", but make it immune to -Wfatal-errors. 82e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner /// This happens for -Wno-fatal-errors=foo. 83e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner MAP_ERROR_NO_WFATAL = 6 845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 874b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// \brief Annotates a diagnostic with some code that should be 884b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// inserted, removed, or replaced to fix the problem. 894b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// 904b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// This kind of hint should be used when we are certain that the 914b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// introduction, removal, or modification of a particular (small!) 924b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// amount of code will correct a compilation error. The compiler 934b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// should also provide full recovery from such errors, such that 94b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor/// suppressing the diagnostic output can still result in successful 954b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// compilation. 96849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregorclass FixItHint { 974b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregorpublic: 980a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner /// \brief Code that should be removed to correct the error. 990a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner CharSourceRange RemoveRange; 1004b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1014b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief The location at which we should insert code to correct 1024b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// the error. 1034b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor SourceLocation InsertionLoc; 1044b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1054b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief The actual code to insert at the insertion location, as a 1064b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// string. 1074b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor std::string CodeToInsert; 1084b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1094b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Empty code modification hint, indicating that no code 1104b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// modification is known. 111849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor FixItHint() : RemoveRange(), InsertionLoc() { } 1124b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1132f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson bool isNull() const { 1142f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson return !RemoveRange.isValid() && !InsertionLoc.isValid(); 1152f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson } 1162f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson 1174b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that inserts the given 1184b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// code string at a specific location. 119849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor static FixItHint CreateInsertion(SourceLocation InsertionLoc, 120849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor llvm::StringRef Code) { 121849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor FixItHint Hint; 122b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.InsertionLoc = InsertionLoc; 123b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.CodeToInsert = Code; 124b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 125b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 1264b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1274b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that removes the given 1284b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// source range. 1290a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner static FixItHint CreateRemoval(CharSourceRange RemoveRange) { 130849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor FixItHint Hint; 131b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.RemoveRange = RemoveRange; 132b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 133b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 1340a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner static FixItHint CreateRemoval(SourceRange RemoveRange) { 1350a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner return CreateRemoval(CharSourceRange::getTokenRange(RemoveRange)); 1360a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner } 1370a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner 1384b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that replaces the given 1394b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// source range with the given code string. 1400a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner static FixItHint CreateReplacement(CharSourceRange 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 } 1480a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner 1490a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner static FixItHint CreateReplacement(SourceRange RemoveRange, 1500a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner llvm::StringRef Code) { 1510a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner return CreateReplacement(CharSourceRange::getTokenRange(RemoveRange), Code); 1520a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner } 1534b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor}; 1544b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// Diagnostic - This concrete class is used by the front-end to report 1565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// problems and issues. It massages the diagnostics (e.g. handling things like 1575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// "report warnings as errors" and passes them off to the DiagnosticClient for 1585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// reporting to the user. 15928019772db70d4547be05a042eb950bc910f134fDouglas Gregorclass Diagnostic : public llvm::RefCountedBase<Diagnostic> { 160182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattnerpublic: 161182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// Level - The level of the diagnostic, after it has been through mapping. 162182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner enum Level { 163da0cbc1ad4a553c4de111c1181ec7b42c5ddefceChris Lattner Ignored, Note, Warning, Error, Fatal 164182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner }; 1651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 166b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// ExtensionHandling - How do we handle otherwise-unmapped extension? This 167b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// is controlled by -pedantic and -pedantic-errors. 168b54b276a920246c595a0498da281821eb9d22996Chris Lattner enum ExtensionHandling { 169b54b276a920246c595a0498da281821eb9d22996Chris Lattner Ext_Ignore, Ext_Warn, Ext_Error 170b54b276a920246c595a0498da281821eb9d22996Chris Lattner }; 1711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1723fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner enum ArgumentKind { 17347b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_std_string, // std::string 17447b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_c_string, // const char * 17547b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_sint, // int 17647b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_uint, // unsigned 17747b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_identifierinfo, // IdentifierInfo 17847b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_qualtype, // QualType 17947b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_declarationname, // DeclarationName 180dacd434c49658286c380c7b4c357d76d53cb4aa1Douglas Gregor ak_nameddecl, // NamedDecl * 1813f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor ak_nestednamespec, // NestedNameSpecifier * 1823f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor ak_declcontext // DeclContext * 1833fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner }; 1845edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin 1855edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin /// Specifies which overload candidates to display when overload resolution 1865edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin /// fails. 1875edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin enum OverloadsShown { 1885edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin Ovl_All, ///< Show all overloads. 1895edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin Ovl_Best ///< Show just the "best" overload candidates. 1905edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin }; 1915edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin 192b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// ArgumentValue - This typedef represents on argument value, which is a 193b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// union discriminated by ArgumentKind, with a value. 194b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner typedef std::pair<ArgumentKind, intptr_t> ArgumentValue; 195ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 1961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumpprivate: 19727ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner unsigned char AllExtensionsSilenced; // Used by __extension__ 198b54b276a920246c595a0498da281821eb9d22996Chris Lattner bool IgnoreAllWarnings; // Ignore all warnings: -w 1991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump bool WarningsAsErrors; // Treat warnings like errors: 200e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner bool ErrorsAsFatal; // Treat errors like fatal errors. 201b54b276a920246c595a0498da281821eb9d22996Chris Lattner bool SuppressSystemWarnings; // Suppress warnings in system headers. 20281b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor bool SuppressAllDiagnostics; // Suppress all diagnostics. 2035edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin OverloadsShown ShowOverloads; // Which overload candidates to show. 204c100214fdc41a7ea215f75d433eb1cb829fd4330Chris Lattner unsigned ErrorLimit; // Cap of # errors emitted, 0 -> no limit. 205575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor unsigned TemplateBacktraceLimit; // Cap on depth of template backtrace stack, 206575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor // 0 -> no limit. 207b54b276a920246c595a0498da281821eb9d22996Chris Lattner ExtensionHandling ExtBehavior; // Map extensions onto warnings or errors? 208b4398aa27da4d6919c3ae448d1ae66ba6cafc048Ted Kremenek DiagnosticClient *Client; 2095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// DiagMappings - Mapping information for diagnostics. Mapping info is 211691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// packed into four bits per diagnostic. The low three bits are the mapping 212691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// (an instance of diag::Mapping), or zero if unset. The high bit is set 213691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// when the mapping was established as a user mapping. If the high bit is 214691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// clear, then the low bits are set to the default value, and should be 215691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// mapped with -pedantic, -Werror, etc. 21604ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 21704ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner typedef std::vector<unsigned char> DiagMappings; 21804ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner mutable std::vector<DiagMappings> DiagMappingsStack; 21904ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 22015221422eda7bac679e38b07512feda49715ef66Chris Lattner /// ErrorOccurred / FatalErrorOccurred - This is set to true when an error or 22115221422eda7bac679e38b07512feda49715ef66Chris Lattner /// fatal error is emitted, and is sticky. 2225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ErrorOccurred; 22315221422eda7bac679e38b07512feda49715ef66Chris Lattner bool FatalErrorOccurred; 2241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 225f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// LastDiagLevel - This is the level of the last diagnostic emitted. This is 226f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// used to emit continuation diagnostics with the same level as the 227f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// diagnostic that they follow. 228f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner Diagnostic::Level LastDiagLevel; 2295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 23053eee7ba970d21ff15bbd4334164037a3b4cc4b8Chris Lattner unsigned NumWarnings; // Number of warnings reported 23153eee7ba970d21ff15bbd4334164037a3b4cc4b8Chris Lattner unsigned NumErrors; // Number of errors reported 2321864f2eb59471d07db51adfc3e5b1a229eed631aDouglas Gregor unsigned NumErrorsSuppressed; // Number of errors suppressed 2331864f2eb59471d07db51adfc3e5b1a229eed631aDouglas Gregor 234182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// CustomDiagInfo - Information for uniquing and looking up custom diags. 235182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner diag::CustomDiagInfo *CustomDiagInfo; 2367bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber 2373fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// ArgToStringFn - A function pointer that converts an opaque diagnostic 2383fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// argument to a strings. This takes the modifiers and argument that was 2393fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// present in the diagnostic. 240b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// 241b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// The PrevArgs array (whose length is NumPrevArgs) indicates the previous 242b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// arguments formatted for this diagnostic. Implementations of this function 243b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// can use this information to avoid redundancy across arguments. 244b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// 24522caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner /// This is a hack to avoid a layering violation between libbasic and libsema. 2463fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner typedef void (*ArgToStringFnTy)(ArgumentKind Kind, intptr_t Val, 2473fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Modifier, unsigned ModifierLen, 2483fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Argument, unsigned ArgumentLen, 249b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner const ArgumentValue *PrevArgs, 250b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner unsigned NumPrevArgs, 25192dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner llvm::SmallVectorImpl<char> &Output, 25292dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner void *Cookie); 25392dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner void *ArgToStringCookie; 2543fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ArgToStringFnTy ArgToStringFn; 25593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 25693ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief ID of the "delayed" diagnostic, which is a (typically 25793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// fatal) diagnostic that had to be delayed because it was found 25893ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// while emitting another diagnostic. 25993ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor unsigned DelayedDiagID; 26093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 26193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief First string argument for the delayed diagnostic. 26293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor std::string DelayedDiagArg1; 26393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 26493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief Second string argument for the delayed diagnostic. 26593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor std::string DelayedDiagArg2; 26693ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 2675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 2687bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber explicit Diagnostic(DiagnosticClient *client = 0); 269182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner ~Diagnostic(); 2701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 2725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Diagnostic characterization methods, used by a client to customize how 2735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // 2741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2756f776b0c943c0065b5148297e61afbe29d54cc51Daniel Dunbar DiagnosticClient *getClient() { return Client; } 2766f776b0c943c0065b5148297e61afbe29d54cc51Daniel Dunbar const DiagnosticClient *getClient() const { return Client; } 27704ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 2781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// pushMappings - Copies the current DiagMappings and pushes the new copy 27904ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// onto the top of the stack. 28004ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner void pushMappings(); 28104ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 28204ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// popMappings - Pops the current DiagMappings off the top of the stack 28304ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// causing the new top of the stack to be the active mappings. Returns 28404ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// true if the pop happens, false if there is only one DiagMapping on the 28504ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// stack. 28604ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner bool popMappings(); 28704ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 288b4398aa27da4d6919c3ae448d1ae66ba6cafc048Ted Kremenek void setClient(DiagnosticClient* client) { Client = client; } 2895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 290c100214fdc41a7ea215f75d433eb1cb829fd4330Chris Lattner /// setErrorLimit - Specify a limit for the number of errors we should 291b205ac9fcd22b87b41697172d1983c5ae9dabaafChris Lattner /// emit before giving up. Zero disables the limit. 292c100214fdc41a7ea215f75d433eb1cb829fd4330Chris Lattner void setErrorLimit(unsigned Limit) { ErrorLimit = Limit; } 293b205ac9fcd22b87b41697172d1983c5ae9dabaafChris Lattner 294575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor /// \brief Specify the maximum number of template instantiation 295575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor /// notes to emit along with a given diagnostic. 296575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor void setTemplateBacktraceLimit(unsigned Limit) { 297575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor TemplateBacktraceLimit = Limit; 298575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor } 2996c1cb9916e9988dcdd65b9266dbe24afd173427aDouglas Gregor 300575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor /// \brief Retrieve the maximum number of template instantiation 301575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor /// nodes to emit along with a given diagnostic. 302575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor unsigned getTemplateBacktraceLimit() const { 303575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor return TemplateBacktraceLimit; 304575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor } 3056c1cb9916e9988dcdd65b9266dbe24afd173427aDouglas Gregor 3065b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner /// setIgnoreAllWarnings - When set to true, any unmapped warnings are 3075b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner /// ignored. If this and WarningsAsErrors are both set, then this one wins. 3085b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner void setIgnoreAllWarnings(bool Val) { IgnoreAllWarnings = Val; } 3095b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner bool getIgnoreAllWarnings() const { return IgnoreAllWarnings; } 3101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setWarningsAsErrors - When set to true, any warnings reported are issued 3125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// as errors. 3135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setWarningsAsErrors(bool Val) { WarningsAsErrors = Val; } 3145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getWarningsAsErrors() const { return WarningsAsErrors; } 3151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 316e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner /// setErrorsAsFatal - When set to true, any error reported is made a 317e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner /// fatal error. 318e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner void setErrorsAsFatal(bool Val) { ErrorsAsFatal = Val; } 319e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner bool getErrorsAsFatal() const { return ErrorsAsFatal; } 320e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner 3212fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar /// setSuppressSystemWarnings - When set to true mask warnings that 3222fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar /// come from system headers. 3232fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar void setSuppressSystemWarnings(bool Val) { SuppressSystemWarnings = Val; } 3242fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar bool getSuppressSystemWarnings() const { return SuppressSystemWarnings; } 3252fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar 32681b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor /// \brief Suppress all diagnostics, to silence the front end when we 32781b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor /// know that we don't want any more diagnostics to be passed along to the 32881b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor /// client 32981b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor void setSuppressAllDiagnostics(bool Val = true) { 33081b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor SuppressAllDiagnostics = Val; 33181b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor } 33281b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor bool getSuppressAllDiagnostics() const { return SuppressAllDiagnostics; } 33381b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor 3345edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin /// \brief Specify which overload candidates to show when overload resolution 3355edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin /// fails. By default, we show all candidates. 3365edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin void setShowOverloads(OverloadsShown Val) { 3375edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin ShowOverloads = Val; 3385edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin } 3395edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin OverloadsShown getShowOverloads() const { return ShowOverloads; } 3405edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin 3410b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor /// \brief Pretend that the last diagnostic issued was ignored. This can 3420b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor /// be used by clients who suppress diagnostics themselves. 3430b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor void setLastDiagnosticIgnored() { 3440b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor LastDiagLevel = Ignored; 3450b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor } 3460b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor 347b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// setExtensionHandlingBehavior - This controls whether otherwise-unmapped 348b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// extension diagnostics are mapped onto ignore/warning/error. This 349b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// corresponds to the GCC -pedantic and -pedantic-errors option. 350b54b276a920246c595a0498da281821eb9d22996Chris Lattner void setExtensionHandlingBehavior(ExtensionHandling H) { 351b54b276a920246c595a0498da281821eb9d22996Chris Lattner ExtBehavior = H; 352b54b276a920246c595a0498da281821eb9d22996Chris Lattner } 3531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 35427ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// AllExtensionsSilenced - This is a counter bumped when an __extension__ 35527ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// block is encountered. When non-zero, all extension diagnostics are 35627ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// entirely silenced, no matter how they are mapped. 35727ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner void IncrementAllExtensionsSilenced() { ++AllExtensionsSilenced; } 35827ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner void DecrementAllExtensionsSilenced() { --AllExtensionsSilenced; } 35991a2886d558ea6ca7a0bed73ab5acea5ae78eac2Douglas Gregor bool hasAllExtensionsSilenced() { return AllExtensionsSilenced != 0; } 3601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setDiagnosticMapping - This allows the client to specify that certain 362691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// warnings are ignored. Notes can never be mapped, errors can only be 363691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// mapped to fatal, and WARNINGs and EXTENSIONs can be mapped arbitrarily. 3645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setDiagnosticMapping(diag::kind Diag, diag::Mapping Map) { 36519e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner assert(Diag < diag::DIAG_UPPER_LIMIT && 3660750618b0beacdc9b0a9e210a661e4746823ced7Chris Lattner "Can only map builtin diagnostics"); 367d0fe3e9a97459477e64ad1df312fd29b86a3c3cbChris Lattner assert((isBuiltinWarningOrExtension(Diag) || 368d0fe3e9a97459477e64ad1df312fd29b86a3c3cbChris Lattner (Map == diag::MAP_FATAL || Map == diag::MAP_ERROR)) && 369d0fe3e9a97459477e64ad1df312fd29b86a3c3cbChris Lattner "Cannot map errors into warnings!"); 370691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner setDiagnosticMappingInternal(Diag, Map, true); 37127ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner } 3721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3733bc172bc6a787842db6fea351cf6929539fca70dChris Lattner /// setDiagnosticGroupMapping - Change an entire diagnostic group (e.g. 3743bc172bc6a787842db6fea351cf6929539fca70dChris Lattner /// "unknown-pragmas" to have the specified mapping. This returns true and 3753bc172bc6a787842db6fea351cf6929539fca70dChris Lattner /// ignores the request if "Group" was unknown, false otherwise. 3763bc172bc6a787842db6fea351cf6929539fca70dChris Lattner bool setDiagnosticGroupMapping(const char *Group, diag::Mapping Map); 3775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool hasErrorOccurred() const { return ErrorOccurred; } 37915221422eda7bac679e38b07512feda49715ef66Chris Lattner bool hasFatalErrorOccurred() const { return FatalErrorOccurred; } 3805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned getNumErrors() const { return NumErrors; } 3821864f2eb59471d07db51adfc3e5b1a229eed631aDouglas Gregor unsigned getNumErrorsSuppressed() const { return NumErrorsSuppressed; } 38353eee7ba970d21ff15bbd4334164037a3b4cc4b8Chris Lattner unsigned getNumWarnings() const { return NumWarnings; } 3841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 385182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// getCustomDiagID - Return an ID for a diagnostic with the specified message 386182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// and level. If this is the first request for this diagnosic, it is 387182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// registered and created, otherwise the existing ID is returned. 38832d4d80c26e8c4c1922cff4661e0b9f44a3aabfcDaniel Dunbar unsigned getCustomDiagID(Level L, llvm::StringRef Message); 3891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3913fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// ConvertArgToString - This method converts a diagnostic argument (as an 3923fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// intptr_t) into the string that represents it. 3933fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner void ConvertArgToString(ArgumentKind Kind, intptr_t Val, 3943fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Modifier, unsigned ModLen, 3953fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Argument, unsigned ArgLen, 396b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner const ArgumentValue *PrevArgs, unsigned NumPrevArgs, 3973fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner llvm::SmallVectorImpl<char> &Output) const { 398b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner ArgToStringFn(Kind, Val, Modifier, ModLen, Argument, ArgLen, 399b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner PrevArgs, NumPrevArgs, Output, ArgToStringCookie); 40022caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 4011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 40292dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner void SetArgToStringFn(ArgToStringFnTy Fn, void *Cookie) { 4033fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ArgToStringFn = Fn; 40492dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner ArgToStringCookie = Cookie; 40522caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 4061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 4085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Diagnostic classification and reporting interfaces. 4095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // 4105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getDescription - Given a diagnostic ID, return a description of the 4125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// issue. 4130a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const char *getDescription(unsigned DiagID) const; 4141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 415f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// isNoteWarningOrExtension - Return true if the unmapped diagnostic 416f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// level of the specified diagnostic ID is a Warning or Extension. 417f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// This only works on builtin diagnostics, not custom ones, and is not legal to 418f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// call on NOTEs. 419f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner static bool isBuiltinWarningOrExtension(unsigned DiagID); 4205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 421ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor /// \brief Determine whether the given built-in diagnostic ID is a 422ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor /// Note. 423ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor static bool isBuiltinNote(unsigned DiagID); 4241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 42527ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// isBuiltinExtensionDiag - Determine whether the given built-in diagnostic 42627ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// ID is for an extension of some sort. 42727ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// 42804e442714c292d9381cad2ac14087991132bddcaChris Lattner static bool isBuiltinExtensionDiag(unsigned DiagID) { 42904e442714c292d9381cad2ac14087991132bddcaChris Lattner bool ignored; 43004e442714c292d9381cad2ac14087991132bddcaChris Lattner return isBuiltinExtensionDiag(DiagID, ignored); 43104e442714c292d9381cad2ac14087991132bddcaChris Lattner } 43204e442714c292d9381cad2ac14087991132bddcaChris Lattner 43304e442714c292d9381cad2ac14087991132bddcaChris Lattner /// isBuiltinExtensionDiag - Determine whether the given built-in diagnostic 43404e442714c292d9381cad2ac14087991132bddcaChris Lattner /// ID is for an extension of some sort. This also returns EnabledByDefault, 43504e442714c292d9381cad2ac14087991132bddcaChris Lattner /// which is set to indicate whether the diagnostic is ignored by default (in 43604e442714c292d9381cad2ac14087991132bddcaChris Lattner /// which case -pedantic enables it) or treated as a warning/error by default. 43704e442714c292d9381cad2ac14087991132bddcaChris Lattner /// 43804e442714c292d9381cad2ac14087991132bddcaChris Lattner static bool isBuiltinExtensionDiag(unsigned DiagID, bool &EnabledByDefault); 43904e442714c292d9381cad2ac14087991132bddcaChris Lattner 4401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 441d51d74a3e89c5e5fc9bfd2814996a5feab6dc932Chris Lattner /// getWarningOptionForDiag - Return the lowest-level warning option that 442d51d74a3e89c5e5fc9bfd2814996a5feab6dc932Chris Lattner /// enables the specified diagnostic. If there is no -Wfoo flag that controls 443d51d74a3e89c5e5fc9bfd2814996a5feab6dc932Chris Lattner /// the diagnostic, this returns null. 444d51d74a3e89c5e5fc9bfd2814996a5feab6dc932Chris Lattner static const char *getWarningOptionForDiag(unsigned DiagID); 445ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 446c9b889044c8e1e2d6ab194e34e8b74f6998094faChris Lattner /// getWarningOptionForDiag - Return the category number that a specified 447c9b889044c8e1e2d6ab194e34e8b74f6998094faChris Lattner /// DiagID belongs to, or 0 if no category. 448c9b889044c8e1e2d6ab194e34e8b74f6998094faChris Lattner static unsigned getCategoryNumberForDiag(unsigned DiagID); 449c9b889044c8e1e2d6ab194e34e8b74f6998094faChris Lattner 450c9b889044c8e1e2d6ab194e34e8b74f6998094faChris Lattner /// getCategoryNameFromID - Given a category ID, return the name of the 451c9b889044c8e1e2d6ab194e34e8b74f6998094faChris Lattner /// category. 452c9b889044c8e1e2d6ab194e34e8b74f6998094faChris Lattner static const char *getCategoryNameFromID(unsigned CategoryID); 453c9b889044c8e1e2d6ab194e34e8b74f6998094faChris Lattner 454eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// \brief Enumeration describing how the the emission of a diagnostic should 455eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// be treated when it occurs during C++ template argument deduction. 456eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor enum SFINAEResponse { 457eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// \brief The diagnostic should not be reported, but it should cause 458eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// template argument deduction to fail. 459eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// 460eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// The vast majority of errors that occur during template argument 461eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// deduction fall into this category. 462eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor SFINAE_SubstitutionFailure, 463eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor 464eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// \brief The diagnostic should be suppressed entirely. 465eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// 466eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// Warnings generally fall into this category. 467eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor SFINAE_Suppress, 468eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor 469eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// \brief The diagnostic should be reported. 470eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// 471eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// The diagnostic should be reported. Various fatal errors (e.g., 472eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor /// template instantiation depth exceeded) fall into this category. 473eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor SFINAE_Report 474eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor }; 475eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor 4765e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// \brief Determines whether the given built-in diagnostic ID is 4775e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// for an error that is suppressed if it occurs during C++ template 4785e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// argument deduction. 4795e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// 4805e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// When an error is suppressed due to SFINAE, the template argument 4815e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// deduction fails but no diagnostic is emitted. Certain classes of 4825e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// errors, such as those errors that involve C++ access control, 4835e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// are not SFINAE errors. 484eab5d1eaaa662c849f1f9920dc8c6a31d7c32d47Douglas Gregor static SFINAEResponse getDiagnosticSFINAEResponse(unsigned DiagID); 4855e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor 4865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getDiagnosticLevel - Based on the way the client configured the Diagnostic 4875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// object, classify the specified diagnostic ID into a Level, consumable by 4885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the DiagnosticClient. 4891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump Level getDiagnosticLevel(unsigned DiagID) const; 4901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 491509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// Report - Issue the message to the client. @c DiagID is a member of the 492509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// @c diag::kind enum. This actually returns aninstance of DiagnosticBuilder 493509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// which emits the diagnostics (through @c ProcessDiag) when it is destroyed. 494509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// @c Pos represents the source location associated with the diagnostic, 495509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// which can be an invalid location if no position information is available. 4963cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner inline DiagnosticBuilder Report(FullSourceLoc Pos, unsigned DiagID); 4970f9fed70cea107b3f79df554e38bd8e98d48fe47Daniel Dunbar inline DiagnosticBuilder Report(unsigned DiagID); 498de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor 49993ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief Determine whethere there is already a diagnostic in flight. 5005800f7ea9cf5621280089d690f677bd28064d6b5Ted Kremenek bool isDiagnosticInFlight() const { return CurDiagID != ~0U; } 50193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 50293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief Set the "delayed" diagnostic that will be emitted once 50393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// the current diagnostic completes. 50493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// 50593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// If a diagnostic is already in-flight but the front end must 50693ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// report a problem (e.g., with an inconsistent file system 50793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// state), this routine sets a "delayed" diagnostic that will be 50893ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// emitted after the current diagnostic completes. This should 50993ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// only be used for fatal errors detected at inconvenient 51093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// times. If emitting a delayed diagnostic causes a second delayed 51193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// diagnostic to be introduced, that second delayed diagnostic 51293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// will be ignored. 51393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// 51493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \param DiagID The ID of the diagnostic being delayed. 51593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// 51693ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \param Arg1 A string argument that will be provided to the 51793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// diagnostic. A copy of this string will be stored in the 51893ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// Diagnostic object itself. 51993ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// 52093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \param Arg2 A string argument that will be provided to the 52193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// diagnostic. A copy of this string will be stored in the 52293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// Diagnostic object itself. 52393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor void SetDelayedDiagnostic(unsigned DiagID, llvm::StringRef Arg1 = "", 52493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor llvm::StringRef Arg2 = ""); 52593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 526de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor /// \brief Clear out the current diagnostic. 527de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor void Clear() { CurDiagID = ~0U; } 5281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5290a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattnerprivate: 53093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief Report the delayed diagnostic. 53193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor void ReportDelayed(); 53293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 53393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 534691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// getDiagnosticMappingInfo - Return the mapping info currently set for the 535691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// specified builtin diagnostic. This returns the high bit encoding, or zero 536691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// if the field is completely uninitialized. 53704e442714c292d9381cad2ac14087991132bddcaChris Lattner diag::Mapping getDiagnosticMappingInfo(diag::kind Diag) const { 53804ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner const DiagMappings ¤tMappings = DiagMappingsStack.back(); 53904ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner return (diag::Mapping)((currentMappings[Diag/2] >> (Diag & 1)*4) & 15); 540691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner } 5411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 542691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner void setDiagnosticMappingInternal(unsigned DiagId, unsigned Map, 543691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner bool isUser) const { 544691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner if (isUser) Map |= 8; // Set the high bit for user mappings. 54504ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner unsigned char &Slot = DiagMappingsStack.back()[DiagId/2]; 546691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner unsigned Shift = (DiagId & 1)*4; 547691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner Slot &= ~(15 << Shift); 548691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner Slot |= Map << Shift; 5499faf50e62ddcd2535b472abc8daafd7042120caaChris Lattner } 5501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 551f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// getDiagnosticLevel - This is an internal implementation helper used when 552f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// DiagClass is already known. 553f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner Level getDiagnosticLevel(unsigned DiagID, unsigned DiagClass) const; 554f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner 5553cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner // This is private state used by DiagnosticBuilder. We put it here instead of 5563cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner // in DiagnosticBuilder in order to keep DiagnosticBuilder a small lightweight 5570a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // object. This implementation choice means that we can only have one 5580a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // diagnostic "in flight" at a time, but this seems to be a reasonable 5590a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // tradeoff to keep these objects small. Assertions verify that only one 5600a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // diagnostic is in flight at a time. 5613cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner friend class DiagnosticBuilder; 5620a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner friend class DiagnosticInfo; 563b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner 564b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner /// CurDiagLoc - This is the location of the current diagnostic that is in 565b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner /// flight. 566b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner FullSourceLoc CurDiagLoc; 5671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 568b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner /// CurDiagID - This is the ID of the current diagnostic that is in flight. 5693cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// This is set to ~0U when there is no diagnostic in flight. 570b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner unsigned CurDiagID; 571b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner 57273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner enum { 57373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// MaxArguments - The maximum number of arguments we can hold. We currently 57473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// only support up to 10 arguments (%0-%9). A single diagnostic with more 57573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// than that almost certainly has to be simplified anyway. 57673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner MaxArguments = 10 57773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner }; 5781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5793cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// NumDiagArgs - This contains the number of entries in Arguments. 580730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner signed char NumDiagArgs; 581730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner /// NumRanges - This is the number of ranges in the DiagRanges array. 582730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner unsigned char NumDiagRanges; 5834b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief The number of code modifications hints in the 584849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor /// FixItHints array. 585849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor unsigned char NumFixItHints; 586ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 58773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsKind - This is an array of ArgumentKind::ArgumentKind enum 58873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// values, with one for each argument. This specifies whether the argument 58973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// is in DiagArgumentsStr or in DiagArguments. 59073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner unsigned char DiagArgumentsKind[MaxArguments]; 5911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 59273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsStr - This holds the values of each string argument for the 59373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// current diagnostic. This value is only used when the corresponding 59473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// ArgumentKind is ak_std_string. 59573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner std::string DiagArgumentsStr[MaxArguments]; 59673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 59773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsVal - The values for the various substitution positions. This 59873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// is used when the argument is not an std::string. The specific value is 59973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// mangled into an intptr_t and the intepretation depends on exactly what 60073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// sort of argument kind it is. 60173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner intptr_t DiagArgumentsVal[MaxArguments]; 6021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6030a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// DiagRanges - The list of ranges added to this diagnostic. It currently 6040a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// only support 10 ranges, could easily be extended if needed. 6050a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner CharSourceRange DiagRanges[10]; 6061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 607849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor enum { MaxFixItHints = 3 }; 6084b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 609849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor /// FixItHints - If valid, provides a hint with some code 6104b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// to insert, remove, or modify at a particular position. 611849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor FixItHint FixItHints[MaxFixItHints]; 6124b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 6130a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// ProcessDiag - This is the method used to report a diagnostic that is 6140a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// finally fully formed. 6155e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// 6165e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// \returns true if the diagnostic was emitted, false if it was 6175e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// suppressed. 6185e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor bool ProcessDiag(); 6193cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}; 6203cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 6213cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 6223cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner// DiagnosticBuilder 6233cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 6243cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 6253cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// DiagnosticBuilder - This is a little helper class used to produce 6263cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// diagnostics. This is constructed by the Diagnostic::Report method, and 6273cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// allows insertion of extra information (arguments and source ranges) into the 6283cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// currently "in flight" diagnostic. When the temporary for the builder is 6293cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// destroyed, the diagnostic is issued. 6303cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// 6313cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// Note that many of these will be created as temporary objects (many call 6323cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// sites), so we want them to be small and we never want their address taken. 6333cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// This ensures that compilers with somewhat reasonable optimizers will promote 6343cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// the common fields to registers, eliminating increments of the NumArgs field, 6353cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// for example. 6363cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerclass DiagnosticBuilder { 6373cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner mutable Diagnostic *DiagObj; 638849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor mutable unsigned NumArgs, NumRanges, NumFixItHints; 6391eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6403cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void operator=(const DiagnosticBuilder&); // DO NOT IMPLEMENT 6413cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner friend class Diagnostic; 6423cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner explicit DiagnosticBuilder(Diagnostic *diagObj) 643849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor : DiagObj(diagObj), NumArgs(0), NumRanges(0), NumFixItHints(0) {} 644ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 6451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumppublic: 6460a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// Copy constructor. When copied, this "takes" the diagnostic info from the 6470a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// input and neuters it. 6483cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagnosticBuilder(const DiagnosticBuilder &D) { 6490a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner DiagObj = D.DiagObj; 6500a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner D.DiagObj = 0; 65125a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor NumArgs = D.NumArgs; 65225a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor NumRanges = D.NumRanges; 653849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor NumFixItHints = D.NumFixItHints; 6540a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 65525a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor 6565e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// \brief Simple enumeration value used to give a name to the 6575e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// suppress-diagnostic constructor. 6585e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor enum SuppressKind { Suppress }; 6595e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor 6605e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// \brief Create an empty DiagnosticBuilder object that represents 6615e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// no actual diagnostic. 6621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump explicit DiagnosticBuilder(SuppressKind) 663849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor : DiagObj(0), NumArgs(0), NumRanges(0), NumFixItHints(0) { } 6645e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor 66525a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// \brief Force the diagnostic builder to emit the diagnostic now. 66625a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// 66725a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// Once this function has been called, the DiagnosticBuilder object 66825a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// should not be used again before it is destroyed. 6695e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// 6705e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// \returns true if a diagnostic was emitted, false if the 6715e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// diagnostic was suppressed. 67293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor bool Emit(); 67325a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor 67425a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// Destructor - The dtor emits the diagnostic if it hasn't already 67525a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// been emitted. 67625a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor ~DiagnosticBuilder() { Emit(); } 6771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 678d93256e55673a17d18543397ec462416acb13792Douglas Gregor /// isActive - Determine whether this diagnostic is still active. 679d93256e55673a17d18543397ec462416acb13792Douglas Gregor bool isActive() const { return DiagObj != 0; } 680d93256e55673a17d18543397ec462416acb13792Douglas Gregor 6813cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// Operator bool: conversion of DiagnosticBuilder to bool always returns 6823cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// true. This allows is to be used in boolean error contexts like: 6833cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// return Diag(...); 6843cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner operator bool() const { return true; } 6853cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 686eaea925e70e3ee85809e572aa8474b8dfc491af7Daniel Dunbar void AddString(llvm::StringRef S) const { 6873cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(NumArgs < Diagnostic::MaxArguments && 6883cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 6895e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor if (DiagObj) { 6905e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor DiagObj->DiagArgumentsKind[NumArgs] = Diagnostic::ak_std_string; 6915e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor DiagObj->DiagArgumentsStr[NumArgs++] = S; 6925e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor } 6933cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner } 6941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6953cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void AddTaggedVal(intptr_t V, Diagnostic::ArgumentKind Kind) const { 6963cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(NumArgs < Diagnostic::MaxArguments && 6973cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 6985e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor if (DiagObj) { 6995e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor DiagObj->DiagArgumentsKind[NumArgs] = Kind; 7005e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor DiagObj->DiagArgumentsVal[NumArgs++] = V; 7015e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor } 7020a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 7031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7040a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner void AddSourceRange(const CharSourceRange &R) const { 7051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump assert(NumRanges < 7063cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner sizeof(DiagObj->DiagRanges)/sizeof(DiagObj->DiagRanges[0]) && 7073cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 7085e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor if (DiagObj) 70951c6d384551674facc19f745ecf6e289d28dc55fDouglas Gregor DiagObj->DiagRanges[NumRanges++] = R; 7101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 7114b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 712849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor void AddFixItHint(const FixItHint &Hint) const { 7132f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson if (Hint.isNull()) 7142f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson return; 7152f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson 716849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor assert(NumFixItHints < Diagnostic::MaxFixItHints && 717849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor "Too many fix-it hints!"); 7185e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor if (DiagObj) 719849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor DiagObj->FixItHints[NumFixItHints++] = Hint; 7204b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 7213cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}; 7223cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 7233cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 724eaea925e70e3ee85809e572aa8474b8dfc491af7Daniel Dunbar llvm::StringRef S) { 7253cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddString(S); 7263cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 7273cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 7283cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 7293cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 7303cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const char *Str) { 7313cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(reinterpret_cast<intptr_t>(Str), 7323cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner Diagnostic::ak_c_string); 7333cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 7343cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 7353cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 7363cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, int I) { 7373cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(I, Diagnostic::ak_sint); 7383cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 7393cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 7403cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 7413bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidisinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,bool I) { 7423bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis DB.AddTaggedVal(I, Diagnostic::ak_sint); 7433bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis return DB; 7443bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis} 7453bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis 7463cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 7473cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner unsigned I) { 7483cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(I, Diagnostic::ak_uint); 7493cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 7503cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 7513cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 7523cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 7533cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const IdentifierInfo *II) { 7543cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(reinterpret_cast<intptr_t>(II), 7553cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner Diagnostic::ak_identifierinfo); 7563cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 7573cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 7581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7593f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// Adds a DeclContext to the diagnostic. The enable_if template magic is here 7603f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// so that we only match those arguments that are (statically) DeclContexts; 7613f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// other arguments that derive from DeclContext (e.g., RecordDecls) will not 7623f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// match. 7633f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregortemplate<typename T> 7643f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregorinline 7653f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregortypename llvm::enable_if<llvm::is_same<T, DeclContext>, 7663f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor const DiagnosticBuilder &>::type 7673f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregoroperator<<(const DiagnosticBuilder &DB, T *DC) { 7683f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor DB.AddTaggedVal(reinterpret_cast<intptr_t>(DC), 7693f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor Diagnostic::ak_declcontext); 7703f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor return DB; 7713f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor} 7723f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor 7733cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 7743cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const SourceRange &R) { 7750a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner DB.AddSourceRange(CharSourceRange::getTokenRange(R)); 7763cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 7773cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 7784b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 7794b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregorinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 7800a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner const CharSourceRange &R) { 7810a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner DB.AddSourceRange(R); 7820a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner return DB; 7830a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner} 7840a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner 7850a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 786849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor const FixItHint &Hint) { 787849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor DB.AddFixItHint(Hint); 7884b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor return DB; 7894b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor} 790ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 7913cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// Report - Issue the message to the client. DiagID is a member of the 7923cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// diag::kind enum. This actually returns a new instance of DiagnosticBuilder 7933cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// which emits the diagnostics (through ProcessDiag) when it is destroyed. 7943cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline DiagnosticBuilder Diagnostic::Report(FullSourceLoc Loc, unsigned DiagID){ 7953cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(CurDiagID == ~0U && "Multiple diagnostics in flight at once!"); 7963cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner CurDiagLoc = Loc; 7973cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner CurDiagID = DiagID; 7983cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DiagnosticBuilder(this); 7993cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 8000f9fed70cea107b3f79df554e38bd8e98d48fe47Daniel Dunbarinline DiagnosticBuilder Diagnostic::Report(unsigned DiagID) { 8010f9fed70cea107b3f79df554e38bd8e98d48fe47Daniel Dunbar return Report(FullSourceLoc(), DiagID); 8020f9fed70cea107b3f79df554e38bd8e98d48fe47Daniel Dunbar} 8033cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 8043cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 8053cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner// DiagnosticInfo 8063cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 8071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8083cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// DiagnosticInfo - This is a little helper class (which is basically a smart 8094b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// pointer that forward info from Diagnostic) that allows clients to enquire 8103cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// about the currently in-flight diagnostic. 8113cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerclass DiagnosticInfo { 8123cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const Diagnostic *DiagObj; 8133cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerpublic: 8143cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner explicit DiagnosticInfo(const Diagnostic *DO) : DiagObj(DO) {} 8151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8160a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const Diagnostic *getDiags() const { return DiagObj; } 817b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner unsigned getID() const { return DiagObj->CurDiagID; } 818b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner const FullSourceLoc &getLocation() const { return DiagObj->CurDiagLoc; } 8191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8200a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned getNumArgs() const { return DiagObj->NumDiagArgs; } 8211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 82273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgKind - Return the kind of the specified index. Based on the kind 82373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// of argument, the accessors below can be used to get the value. 8243cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner Diagnostic::ArgumentKind getArgKind(unsigned Idx) const { 8253cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(Idx < getNumArgs() && "Argument index out of range!"); 8263cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return (Diagnostic::ArgumentKind)DiagObj->DiagArgumentsKind[Idx]; 82773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner } 8281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 82973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgStdStr - Return the provided argument string specified by Idx. 83073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner const std::string &getArgStdStr(unsigned Idx) const { 8313cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_std_string && 8323cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 83373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner return DiagObj->DiagArgumentsStr[Idx]; 83473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner } 8351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 83673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgCStr - Return the specified C string argument. 83773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner const char *getArgCStr(unsigned Idx) const { 8383cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_c_string && 8393cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 84073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner return reinterpret_cast<const char*>(DiagObj->DiagArgumentsVal[Idx]); 8410a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 8421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 84330bc96544346bea42921cf6837e66cef80d664b4Chris Lattner /// getArgSInt - Return the specified signed integer argument. 84430bc96544346bea42921cf6837e66cef80d664b4Chris Lattner int getArgSInt(unsigned Idx) const { 8453cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_sint && 8463cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 84730bc96544346bea42921cf6837e66cef80d664b4Chris Lattner return (int)DiagObj->DiagArgumentsVal[Idx]; 84830bc96544346bea42921cf6837e66cef80d664b4Chris Lattner } 8491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 85030bc96544346bea42921cf6837e66cef80d664b4Chris Lattner /// getArgUInt - Return the specified unsigned integer argument. 85130bc96544346bea42921cf6837e66cef80d664b4Chris Lattner unsigned getArgUInt(unsigned Idx) const { 8523cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_uint && 8533cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 85430bc96544346bea42921cf6837e66cef80d664b4Chris Lattner return (unsigned)DiagObj->DiagArgumentsVal[Idx]; 85530bc96544346bea42921cf6837e66cef80d664b4Chris Lattner } 8561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 85743b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner /// getArgIdentifier - Return the specified IdentifierInfo argument. 85843b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner const IdentifierInfo *getArgIdentifier(unsigned Idx) const { 8593cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_identifierinfo && 8603cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 8619634379265855f1628190e926d9aaf1fb4a5d90eChris Lattner return reinterpret_cast<IdentifierInfo*>(DiagObj->DiagArgumentsVal[Idx]); 86243b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner } 8631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 86422caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner /// getRawArg - Return the specified non-string argument in an opaque form. 86522caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner intptr_t getRawArg(unsigned Idx) const { 86622caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner assert(getArgKind(Idx) != Diagnostic::ak_std_string && 86722caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner "invalid argument accessor!"); 86822caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner return DiagObj->DiagArgumentsVal[Idx]; 86922caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 8701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8720a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// getNumRanges - Return the number of source ranges associated with this 8730a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// diagnostic. 8740a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned getNumRanges() const { 8750a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner return DiagObj->NumDiagRanges; 8760a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 8771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8780a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner const CharSourceRange &getRange(unsigned Idx) const { 8790a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner assert(Idx < DiagObj->NumDiagRanges && "Invalid diagnostic range index!"); 88051c6d384551674facc19f745ecf6e289d28dc55fDouglas Gregor return DiagObj->DiagRanges[Idx]; 8810a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 8821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 883849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor unsigned getNumFixItHints() const { 884849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor return DiagObj->NumFixItHints; 8854b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 8864b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 887849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor const FixItHint &getFixItHint(unsigned Idx) const { 888849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor return DiagObj->FixItHints[Idx]; 8894b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 8904b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 891849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor const FixItHint *getFixItHints() const { 892849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor return DiagObj->NumFixItHints? 893849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor &DiagObj->FixItHints[0] : 0; 8944b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 8954b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 896f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// FormatDiagnostic - Format this diagnostic into a string, substituting the 897f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// formal arguments into the %0 slots. The result is appended onto the Str 898f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// array. 899f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner void FormatDiagnostic(llvm::SmallVectorImpl<char> &OutStr) const; 9009f28614bf1a8387000d8df57a713fcf69e198145John McCall 9019f28614bf1a8387000d8df57a713fcf69e198145John McCall /// FormatDiagnostic - Format the given format-string into the 9029f28614bf1a8387000d8df57a713fcf69e198145John McCall /// output buffer using the arguments stored in this diagnostic. 9039f28614bf1a8387000d8df57a713fcf69e198145John McCall void FormatDiagnostic(const char *DiagStr, const char *DiagEnd, 9049f28614bf1a8387000d8df57a713fcf69e198145John McCall llvm::SmallVectorImpl<char> &OutStr) const; 905a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor}; 906a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 907a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor/** 908a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * \brief Represents a diagnostic in a form that can be serialized and 909a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor * deserialized. 910a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor */ 911a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregorclass StoredDiagnostic { 912a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor Diagnostic::Level Level; 913a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor FullSourceLoc Loc; 914a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor std::string Message; 9150a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner std::vector<CharSourceRange> Ranges; 916849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor std::vector<FixItHint> FixIts; 917a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 918a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregorpublic: 919a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor StoredDiagnostic(); 920a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor StoredDiagnostic(Diagnostic::Level Level, const DiagnosticInfo &Info); 921a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor StoredDiagnostic(Diagnostic::Level Level, llvm::StringRef Message); 922a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor ~StoredDiagnostic(); 923a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 924a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// \brief Evaluates true when this object stores a diagnostic. 925a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor operator bool() const { return Message.size() > 0; } 926a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 927a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor Diagnostic::Level getLevel() const { return Level; } 928a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor const FullSourceLoc &getLocation() const { return Loc; } 929a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor llvm::StringRef getMessage() const { return Message; } 930a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 9310a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner typedef std::vector<CharSourceRange>::const_iterator range_iterator; 932a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor range_iterator range_begin() const { return Ranges.begin(); } 933a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor range_iterator range_end() const { return Ranges.end(); } 934a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned range_size() const { return Ranges.size(); } 935a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 936849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor typedef std::vector<FixItHint>::const_iterator fixit_iterator; 937a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor fixit_iterator fixit_begin() const { return FixIts.begin(); } 938a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor fixit_iterator fixit_end() const { return FixIts.end(); } 939a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned fixit_size() const { return FixIts.size(); } 940d93256e55673a17d18543397ec462416acb13792Douglas Gregor 941d93256e55673a17d18543397ec462416acb13792Douglas Gregor /// Serialize - Serialize the given diagnostic (with its diagnostic 942d93256e55673a17d18543397ec462416acb13792Douglas Gregor /// level) to the given stream. Serialization is a lossy operation, 943d93256e55673a17d18543397ec462416acb13792Douglas Gregor /// since the specific diagnostic ID and any macro-instantiation 944d93256e55673a17d18543397ec462416acb13792Douglas Gregor /// information is lost. 945a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor void Serialize(llvm::raw_ostream &OS) const; 946a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 947a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// Deserialize - Deserialize the first diagnostic within the memory 948a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// [Memory, MemoryEnd), producing a new diagnostic builder describing the 949a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// deserialized diagnostic. If the memory does not contain a 950a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// diagnostic, returns a diagnostic builder with no diagnostic ID. 951a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor static StoredDiagnostic Deserialize(FileManager &FM, SourceManager &SM, 952a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor const char *&Memory, const char *MemoryEnd); 9535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 9541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// DiagnosticClient - This is an abstract interface implemented by clients of 9565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// the front-end, which formats and prints fully processed diagnostics. 9575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass DiagnosticClient { 9585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 9595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer virtual ~DiagnosticClient(); 9601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 961efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// BeginSourceFile - Callback to inform the diagnostic client that processing 962efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// of a source file is beginning. 963efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// 964efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// Note that diagnostics may be emitted outside the processing of a source 965efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// file, for example during the parsing of command line options. However, 966efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// diagnostics with source range information are required to only be emitted 967efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// in between BeginSourceFile() and EndSourceFile(). 968efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// 969efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// \arg LO - The language options for the source file being processed. 970efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// \arg PP - The preprocessor object being used for the source; this optional 971efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// and may not be present, for example when processing AST source files. 9727d90199f109290e9d587479a481a2850d390b552Daniel Dunbar virtual void BeginSourceFile(const LangOptions &LangOpts, 9737d90199f109290e9d587479a481a2850d390b552Daniel Dunbar const Preprocessor *PP = 0) {} 974efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar 975efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// EndSourceFile - Callback to inform the diagnostic client that processing 976efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// of a source file has ended. The diagnostic client should assume that any 977efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// objects made available via \see BeginSourceFile() are inaccessible. 978efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar virtual void EndSourceFile() {} 9791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 980cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek /// IncludeInDiagnosticCounts - This method (whose default implementation 981efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// returns true) indicates whether the diagnostics handled by this 982efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// DiagnosticClient should be included in the number of diagnostics reported 983efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// by Diagnostic. 984cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek virtual bool IncludeInDiagnosticCounts() const; 9855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 9865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleDiagnostic - Handle this diagnostic, reporting it to the user or 9875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// capturing it to a log as needed. 9880a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner virtual void HandleDiagnostic(Diagnostic::Level DiagLevel, 9890a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const DiagnosticInfo &Info) = 0; 9905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 9915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 9925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 9935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 9945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 995