Diagnostic.h revision 9f28614bf1a8387000d8df57a713fcf69e198145
15f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===--- Diagnostic.h - C Language Family Diagnostic Handling ---*- C++ -*-===// 25f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 35f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// The LLVM Compiler Infrastructure 45f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 50bc735ffcfb223c0186419547abaa5c84482663eChris Lattner// This file is distributed under the University of Illinois Open Source 60bc735ffcfb223c0186419547abaa5c84482663eChris Lattner// License. See LICENSE.TXT for details. 75f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 85f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===----------------------------------------------------------------------===// 95f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// This file defines the Diagnostic-related interfaces. 115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===----------------------------------------------------------------------===// 135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#ifndef LLVM_CLANG_DIAGNOSTIC_H 155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#define LLVM_CLANG_DIAGNOSTIC_H 165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 172eefd8657c233bc7c9330acfe475fc270bbe7cabTed Kremenek#include "clang/Basic/SourceLocation.h" 18eaea925e70e3ee85809e572aa8474b8dfc491af7Daniel Dunbar#include "llvm/ADT/StringRef.h" 193f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor#include "llvm/Support/type_traits.h" 205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include <string> 2104ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner#include <vector> 22f86638365f4801ec2d2970f7c0663e94590618b8Chris Lattner#include <cassert> 235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 24f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattnernamespace llvm { 25f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner template <typename T> class SmallVectorImpl; 26f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner} 27f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner 285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang { 293f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor class DeclContext; 303cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner class DiagnosticBuilder; 31b2153946fff330e54abfdc740c0a83aedd485b33Anders Carlsson class DiagnosticClient; 32d42ffbd22fc7eb61321f6a88173ee424991f01c6Ted Kremenek class IdentifierInfo; 3340469651a3f8379dc0f32df69e9bade06a2aad36Chris Lattner class LangOptions; 34b2153946fff330e54abfdc740c0a83aedd485b33Anders Carlsson class PartialDiagnostic; 357d90199f109290e9d587479a481a2850d390b552Daniel Dunbar class Preprocessor; 36b2153946fff330e54abfdc740c0a83aedd485b33Anders Carlsson class SourceRange; 371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Import the diagnostic enums themselves. 395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer namespace diag { 4019e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner // Start position for diagnostics. 4119e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner enum { 424ad4b3ebbe5769143389dccfcfadb666a4ba5940Daniel Dunbar DIAG_START_DRIVER = 300, 4350f4f469024928670f2d634c445686d00eeb89b7Daniel Dunbar DIAG_START_FRONTEND = DIAG_START_DRIVER + 100, 4450f4f469024928670f2d634c445686d00eeb89b7Daniel Dunbar DIAG_START_LEX = DIAG_START_FRONTEND + 100, 4519e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_START_PARSE = DIAG_START_LEX + 300, 4619e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_START_AST = DIAG_START_PARSE + 300, 4719e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_START_SEMA = DIAG_START_AST + 100, 48bb092bafa984e9fa05136b5cef40fd4374dea0f6Douglas Gregor DIAG_START_ANALYSIS = DIAG_START_SEMA + 1500, 4919e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_UPPER_LIMIT = DIAG_START_ANALYSIS + 100 5019e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner }; 5119e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner 52182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner class CustomDiagInfo; 531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// diag::kind - All of the diagnostics that can be emitted by the frontend. 5520c6b3b85e186cd52d5d99489132d71d498159ebChris Lattner typedef unsigned kind; 5620c6b3b85e186cd52d5d99489132d71d498159ebChris Lattner 5788eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner // Get typedefs for common diagnostics. 5888eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner enum { 595e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor#define DIAG(ENUM,FLAGS,DEFAULT_MAPPING,DESC,GROUP,SFINAE) ENUM, 604d7a089144f336b11e5e8ce437b3b27bce2b310dSebastian Redl#include "clang/Basic/DiagnosticCommonKinds.inc" 6188eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner NUM_BUILTIN_COMMON_DIAGNOSTICS 6288eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner#undef DIAG 6388eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner }; 641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Enum values that allow the client to map NOTEs, WARNINGs, and EXTENSIONs 665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to either MAP_IGNORE (nothing), MAP_WARNING (emit a warning), MAP_ERROR 6727ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// (emit as an error). It allows clients to map errors to 6827ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// MAP_ERROR/MAP_DEFAULT or MAP_FATAL (stop emitting diagnostics after this 6927ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// one). 705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer enum Mapping { 71691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner // NOTE: 0 means "uncomputed". 72691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner MAP_IGNORE = 1, //< Map this diagnostic to nothing, ignore it. 73691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner MAP_WARNING = 2, //< Map this diagnostic to a warning. 74691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner MAP_ERROR = 3, //< Map this diagnostic to an error. 752b07d8fe9e8a8ba12d64066632e17a9a5308a12eChris Lattner MAP_FATAL = 4, //< Map this diagnostic to a fatal error. 761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 77b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// Map this diagnostic to "warning", but make it immune to -Werror. This 78b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// happens when you specify -Wno-error=foo. 79e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner MAP_WARNING_NO_WERROR = 5, 80e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner /// Map this diagnostic to "error", but make it immune to -Wfatal-errors. 81e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner /// This happens for -Wno-fatal-errors=foo. 82e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner MAP_ERROR_NO_WFATAL = 6 835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 864b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// \brief Annotates a diagnostic with some code that should be 874b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// inserted, removed, or replaced to fix the problem. 884b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// 894b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// This kind of hint should be used when we are certain that the 904b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// introduction, removal, or modification of a particular (small!) 914b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// amount of code will correct a compilation error. The compiler 924b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// should also provide full recovery from such errors, such that 93b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor/// suppressing the diagnostic output can still result in successful 944b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// compilation. 954b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregorclass CodeModificationHint { 964b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregorpublic: 974b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Tokens that should be removed to correct the error. 984b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor SourceRange RemoveRange; 994b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1004b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief The location at which we should insert code to correct 1014b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// the error. 1024b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor SourceLocation InsertionLoc; 1034b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1044b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief The actual code to insert at the insertion location, as a 1054b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// string. 1064b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor std::string CodeToInsert; 1074b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1084b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Empty code modification hint, indicating that no code 1094b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// modification is known. 1104b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor CodeModificationHint() : RemoveRange(), InsertionLoc() { } 1114b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1122f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson bool isNull() const { 1132f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson return !RemoveRange.isValid() && !InsertionLoc.isValid(); 1142f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson } 1152f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson 1164b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that inserts the given 1174b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// code string at a specific location. 1181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump static CodeModificationHint CreateInsertion(SourceLocation InsertionLoc, 119eaea925e70e3ee85809e572aa8474b8dfc491af7Daniel Dunbar llvm::StringRef Code) { 120b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor CodeModificationHint Hint; 121b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.InsertionLoc = InsertionLoc; 122b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.CodeToInsert = Code; 123b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 124b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 1254b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1264b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that removes the given 1274b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// source range. 128b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor static CodeModificationHint CreateRemoval(SourceRange RemoveRange) { 129b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor CodeModificationHint Hint; 130b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.RemoveRange = RemoveRange; 131b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 132b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 1334b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1344b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that replaces the given 1354b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// source range with the given code string. 1361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump static CodeModificationHint CreateReplacement(SourceRange RemoveRange, 137eaea925e70e3ee85809e572aa8474b8dfc491af7Daniel Dunbar llvm::StringRef Code) { 138b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor CodeModificationHint Hint; 139b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.RemoveRange = RemoveRange; 140b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.InsertionLoc = RemoveRange.getBegin(); 141b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.CodeToInsert = Code; 142b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 143b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 1444b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor}; 1454b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// Diagnostic - This concrete class is used by the front-end to report 1475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// problems and issues. It massages the diagnostics (e.g. handling things like 1485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// "report warnings as errors" and passes them off to the DiagnosticClient for 1495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// reporting to the user. 1505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass Diagnostic { 151182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattnerpublic: 152182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// Level - The level of the diagnostic, after it has been through mapping. 153182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner enum Level { 154da0cbc1ad4a553c4de111c1181ec7b42c5ddefceChris Lattner Ignored, Note, Warning, Error, Fatal 155182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner }; 1561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 157b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// ExtensionHandling - How do we handle otherwise-unmapped extension? This 158b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// is controlled by -pedantic and -pedantic-errors. 159b54b276a920246c595a0498da281821eb9d22996Chris Lattner enum ExtensionHandling { 160b54b276a920246c595a0498da281821eb9d22996Chris Lattner Ext_Ignore, Ext_Warn, Ext_Error 161b54b276a920246c595a0498da281821eb9d22996Chris Lattner }; 1621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1633fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner enum ArgumentKind { 16447b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_std_string, // std::string 16547b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_c_string, // const char * 16647b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_sint, // int 16747b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_uint, // unsigned 16847b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_identifierinfo, // IdentifierInfo 16947b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_qualtype, // QualType 17047b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_declarationname, // DeclarationName 171dacd434c49658286c380c7b4c357d76d53cb4aa1Douglas Gregor ak_nameddecl, // NamedDecl * 1723f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor ak_nestednamespec, // NestedNameSpecifier * 1733f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor ak_declcontext // DeclContext * 1743fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner }; 175b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner 176b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// ArgumentValue - This typedef represents on argument value, which is a 177b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// union discriminated by ArgumentKind, with a value. 178b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner typedef std::pair<ArgumentKind, intptr_t> ArgumentValue; 179ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 1801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumpprivate: 18127ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner unsigned char AllExtensionsSilenced; // Used by __extension__ 182b54b276a920246c595a0498da281821eb9d22996Chris Lattner bool IgnoreAllWarnings; // Ignore all warnings: -w 1831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump bool WarningsAsErrors; // Treat warnings like errors: 184e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner bool ErrorsAsFatal; // Treat errors like fatal errors. 185b54b276a920246c595a0498da281821eb9d22996Chris Lattner bool SuppressSystemWarnings; // Suppress warnings in system headers. 18681b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor bool SuppressAllDiagnostics; // Suppress all diagnostics. 187b54b276a920246c595a0498da281821eb9d22996Chris Lattner ExtensionHandling ExtBehavior; // Map extensions onto warnings or errors? 188b4398aa27da4d6919c3ae448d1ae66ba6cafc048Ted Kremenek DiagnosticClient *Client; 1895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// DiagMappings - Mapping information for diagnostics. Mapping info is 191691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// packed into four bits per diagnostic. The low three bits are the mapping 192691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// (an instance of diag::Mapping), or zero if unset. The high bit is set 193691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// when the mapping was established as a user mapping. If the high bit is 194691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// clear, then the low bits are set to the default value, and should be 195691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// mapped with -pedantic, -Werror, etc. 19604ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 19704ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner typedef std::vector<unsigned char> DiagMappings; 19804ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner mutable std::vector<DiagMappings> DiagMappingsStack; 19904ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 20015221422eda7bac679e38b07512feda49715ef66Chris Lattner /// ErrorOccurred / FatalErrorOccurred - This is set to true when an error or 20115221422eda7bac679e38b07512feda49715ef66Chris Lattner /// fatal error is emitted, and is sticky. 2025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ErrorOccurred; 20315221422eda7bac679e38b07512feda49715ef66Chris Lattner bool FatalErrorOccurred; 2041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 205f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// LastDiagLevel - This is the level of the last diagnostic emitted. This is 206f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// used to emit continuation diagnostics with the same level as the 207f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// diagnostic that they follow. 208f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner Diagnostic::Level LastDiagLevel; 2095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumDiagnostics; // Number of diagnostics reported 2115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumErrors; // Number of diagnostics that are errors 212182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner 213182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// CustomDiagInfo - Information for uniquing and looking up custom diags. 214182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner diag::CustomDiagInfo *CustomDiagInfo; 2157bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber 2163fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// ArgToStringFn - A function pointer that converts an opaque diagnostic 2173fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// argument to a strings. This takes the modifiers and argument that was 2183fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// present in the diagnostic. 219b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// 220b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// The PrevArgs array (whose length is NumPrevArgs) indicates the previous 221b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// arguments formatted for this diagnostic. Implementations of this function 222b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// can use this information to avoid redundancy across arguments. 223b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// 22422caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner /// This is a hack to avoid a layering violation between libbasic and libsema. 2253fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner typedef void (*ArgToStringFnTy)(ArgumentKind Kind, intptr_t Val, 2263fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Modifier, unsigned ModifierLen, 2273fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Argument, unsigned ArgumentLen, 228b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner const ArgumentValue *PrevArgs, 229b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner unsigned NumPrevArgs, 23092dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner llvm::SmallVectorImpl<char> &Output, 23192dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner void *Cookie); 23292dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner void *ArgToStringCookie; 2333fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ArgToStringFnTy ArgToStringFn; 2345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 2357bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber explicit Diagnostic(DiagnosticClient *client = 0); 236182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner ~Diagnostic(); 2371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 2395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Diagnostic characterization methods, used by a client to customize how 2405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // 2411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2426f776b0c943c0065b5148297e61afbe29d54cc51Daniel Dunbar DiagnosticClient *getClient() { return Client; } 2436f776b0c943c0065b5148297e61afbe29d54cc51Daniel Dunbar const DiagnosticClient *getClient() const { return Client; } 24404ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 2451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// pushMappings - Copies the current DiagMappings and pushes the new copy 24604ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// onto the top of the stack. 24704ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner void pushMappings(); 24804ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 24904ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// popMappings - Pops the current DiagMappings off the top of the stack 25004ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// causing the new top of the stack to be the active mappings. Returns 25104ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// true if the pop happens, false if there is only one DiagMapping on the 25204ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// stack. 25304ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner bool popMappings(); 25404ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 255b4398aa27da4d6919c3ae448d1ae66ba6cafc048Ted Kremenek void setClient(DiagnosticClient* client) { Client = client; } 2565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2575b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner /// setIgnoreAllWarnings - When set to true, any unmapped warnings are 2585b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner /// ignored. If this and WarningsAsErrors are both set, then this one wins. 2595b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner void setIgnoreAllWarnings(bool Val) { IgnoreAllWarnings = Val; } 2605b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner bool getIgnoreAllWarnings() const { return IgnoreAllWarnings; } 2611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setWarningsAsErrors - When set to true, any warnings reported are issued 2635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// as errors. 2645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setWarningsAsErrors(bool Val) { WarningsAsErrors = Val; } 2655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getWarningsAsErrors() const { return WarningsAsErrors; } 2661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 267e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner /// setErrorsAsFatal - When set to true, any error reported is made a 268e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner /// fatal error. 269e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner void setErrorsAsFatal(bool Val) { ErrorsAsFatal = Val; } 270e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner bool getErrorsAsFatal() const { return ErrorsAsFatal; } 271e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner 2722fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar /// setSuppressSystemWarnings - When set to true mask warnings that 2732fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar /// come from system headers. 2742fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar void setSuppressSystemWarnings(bool Val) { SuppressSystemWarnings = Val; } 2752fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar bool getSuppressSystemWarnings() const { return SuppressSystemWarnings; } 2762fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar 27781b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor /// \brief Suppress all diagnostics, to silence the front end when we 27881b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor /// know that we don't want any more diagnostics to be passed along to the 27981b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor /// client 28081b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor void setSuppressAllDiagnostics(bool Val = true) { 28181b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor SuppressAllDiagnostics = Val; 28281b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor } 28381b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor bool getSuppressAllDiagnostics() const { return SuppressAllDiagnostics; } 28481b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor 2850b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor /// \brief Pretend that the last diagnostic issued was ignored. This can 2860b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor /// be used by clients who suppress diagnostics themselves. 2870b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor void setLastDiagnosticIgnored() { 2880b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor LastDiagLevel = Ignored; 2890b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor } 2900b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor 291b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// setExtensionHandlingBehavior - This controls whether otherwise-unmapped 292b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// extension diagnostics are mapped onto ignore/warning/error. This 293b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// corresponds to the GCC -pedantic and -pedantic-errors option. 294b54b276a920246c595a0498da281821eb9d22996Chris Lattner void setExtensionHandlingBehavior(ExtensionHandling H) { 295b54b276a920246c595a0498da281821eb9d22996Chris Lattner ExtBehavior = H; 296b54b276a920246c595a0498da281821eb9d22996Chris Lattner } 2971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 29827ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// AllExtensionsSilenced - This is a counter bumped when an __extension__ 29927ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// block is encountered. When non-zero, all extension diagnostics are 30027ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// entirely silenced, no matter how they are mapped. 30127ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner void IncrementAllExtensionsSilenced() { ++AllExtensionsSilenced; } 30227ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner void DecrementAllExtensionsSilenced() { --AllExtensionsSilenced; } 30391a2886d558ea6ca7a0bed73ab5acea5ae78eac2Douglas Gregor bool hasAllExtensionsSilenced() { return AllExtensionsSilenced != 0; } 3041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setDiagnosticMapping - This allows the client to specify that certain 306691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// warnings are ignored. Notes can never be mapped, errors can only be 307691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// mapped to fatal, and WARNINGs and EXTENSIONs can be mapped arbitrarily. 3085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setDiagnosticMapping(diag::kind Diag, diag::Mapping Map) { 30919e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner assert(Diag < diag::DIAG_UPPER_LIMIT && 3100750618b0beacdc9b0a9e210a661e4746823ced7Chris Lattner "Can only map builtin diagnostics"); 311f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner assert((isBuiltinWarningOrExtension(Diag) || Map == diag::MAP_FATAL) && 3127fc24e2d47e1cdf03e655ed212d282635d755591Chris Lattner "Cannot map errors!"); 313691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner setDiagnosticMappingInternal(Diag, Map, true); 31427ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner } 3151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3163bc172bc6a787842db6fea351cf6929539fca70dChris Lattner /// setDiagnosticGroupMapping - Change an entire diagnostic group (e.g. 3173bc172bc6a787842db6fea351cf6929539fca70dChris Lattner /// "unknown-pragmas" to have the specified mapping. This returns true and 3183bc172bc6a787842db6fea351cf6929539fca70dChris Lattner /// ignores the request if "Group" was unknown, false otherwise. 3193bc172bc6a787842db6fea351cf6929539fca70dChris Lattner bool setDiagnosticGroupMapping(const char *Group, diag::Mapping Map); 3205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool hasErrorOccurred() const { return ErrorOccurred; } 32215221422eda7bac679e38b07512feda49715ef66Chris Lattner bool hasFatalErrorOccurred() const { return FatalErrorOccurred; } 3235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned getNumErrors() const { return NumErrors; } 3255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned getNumDiagnostics() const { return NumDiagnostics; } 3261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 327182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// getCustomDiagID - Return an ID for a diagnostic with the specified message 328182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// and level. If this is the first request for this diagnosic, it is 329182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// registered and created, otherwise the existing ID is returned. 33032d4d80c26e8c4c1922cff4661e0b9f44a3aabfcDaniel Dunbar unsigned getCustomDiagID(Level L, llvm::StringRef Message); 3311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3333fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// ConvertArgToString - This method converts a diagnostic argument (as an 3343fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// intptr_t) into the string that represents it. 3353fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner void ConvertArgToString(ArgumentKind Kind, intptr_t Val, 3363fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Modifier, unsigned ModLen, 3373fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Argument, unsigned ArgLen, 338b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner const ArgumentValue *PrevArgs, unsigned NumPrevArgs, 3393fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner llvm::SmallVectorImpl<char> &Output) const { 340b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner ArgToStringFn(Kind, Val, Modifier, ModLen, Argument, ArgLen, 341b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner PrevArgs, NumPrevArgs, Output, ArgToStringCookie); 34222caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 3431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 34492dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner void SetArgToStringFn(ArgToStringFnTy Fn, void *Cookie) { 3453fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ArgToStringFn = Fn; 34692dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner ArgToStringCookie = Cookie; 34722caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 3481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 3505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Diagnostic classification and reporting interfaces. 3515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // 3525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getDescription - Given a diagnostic ID, return a description of the 3545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// issue. 3550a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const char *getDescription(unsigned DiagID) const; 3561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 357f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// isNoteWarningOrExtension - Return true if the unmapped diagnostic 358f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// level of the specified diagnostic ID is a Warning or Extension. 359f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// This only works on builtin diagnostics, not custom ones, and is not legal to 360f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// call on NOTEs. 361f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner static bool isBuiltinWarningOrExtension(unsigned DiagID); 3625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 363ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor /// \brief Determine whether the given built-in diagnostic ID is a 364ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor /// Note. 365ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor static bool isBuiltinNote(unsigned DiagID); 3661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 36727ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// isBuiltinExtensionDiag - Determine whether the given built-in diagnostic 36827ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// ID is for an extension of some sort. 36927ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// 37027ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner static bool isBuiltinExtensionDiag(unsigned DiagID); 3711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 372d51d74a3e89c5e5fc9bfd2814996a5feab6dc932Chris Lattner /// getWarningOptionForDiag - Return the lowest-level warning option that 373d51d74a3e89c5e5fc9bfd2814996a5feab6dc932Chris Lattner /// enables the specified diagnostic. If there is no -Wfoo flag that controls 374d51d74a3e89c5e5fc9bfd2814996a5feab6dc932Chris Lattner /// the diagnostic, this returns null. 375d51d74a3e89c5e5fc9bfd2814996a5feab6dc932Chris Lattner static const char *getWarningOptionForDiag(unsigned DiagID); 376ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 3775e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// \brief Determines whether the given built-in diagnostic ID is 3785e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// for an error that is suppressed if it occurs during C++ template 3795e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// argument deduction. 3805e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// 3815e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// When an error is suppressed due to SFINAE, the template argument 3825e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// deduction fails but no diagnostic is emitted. Certain classes of 3835e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// errors, such as those errors that involve C++ access control, 3845e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// are not SFINAE errors. 3855e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor static bool isBuiltinSFINAEDiag(unsigned DiagID); 3865e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor 3875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getDiagnosticLevel - Based on the way the client configured the Diagnostic 3885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// object, classify the specified diagnostic ID into a Level, consumable by 3895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the DiagnosticClient. 3901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump Level getDiagnosticLevel(unsigned DiagID) const; 3911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 392509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// Report - Issue the message to the client. @c DiagID is a member of the 393509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// @c diag::kind enum. This actually returns aninstance of DiagnosticBuilder 394509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// which emits the diagnostics (through @c ProcessDiag) when it is destroyed. 395509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// @c Pos represents the source location associated with the diagnostic, 396509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// which can be an invalid location if no position information is available. 3973cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner inline DiagnosticBuilder Report(FullSourceLoc Pos, unsigned DiagID); 3980f9fed70cea107b3f79df554e38bd8e98d48fe47Daniel Dunbar inline DiagnosticBuilder Report(unsigned DiagID); 399de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor 400de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor /// \brief Clear out the current diagnostic. 401de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor void Clear() { CurDiagID = ~0U; } 4021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4030a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattnerprivate: 404691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// getDiagnosticMappingInfo - Return the mapping info currently set for the 405691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// specified builtin diagnostic. This returns the high bit encoding, or zero 406691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// if the field is completely uninitialized. 407691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner unsigned getDiagnosticMappingInfo(diag::kind Diag) const { 40804ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner const DiagMappings ¤tMappings = DiagMappingsStack.back(); 40904ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner return (diag::Mapping)((currentMappings[Diag/2] >> (Diag & 1)*4) & 15); 410691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner } 4111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 412691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner void setDiagnosticMappingInternal(unsigned DiagId, unsigned Map, 413691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner bool isUser) const { 414691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner if (isUser) Map |= 8; // Set the high bit for user mappings. 41504ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner unsigned char &Slot = DiagMappingsStack.back()[DiagId/2]; 416691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner unsigned Shift = (DiagId & 1)*4; 417691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner Slot &= ~(15 << Shift); 418691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner Slot |= Map << Shift; 4199faf50e62ddcd2535b472abc8daafd7042120caaChris Lattner } 4201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 421f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// getDiagnosticLevel - This is an internal implementation helper used when 422f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// DiagClass is already known. 423f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner Level getDiagnosticLevel(unsigned DiagID, unsigned DiagClass) const; 424f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner 4253cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner // This is private state used by DiagnosticBuilder. We put it here instead of 4263cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner // in DiagnosticBuilder in order to keep DiagnosticBuilder a small lightweight 4270a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // object. This implementation choice means that we can only have one 4280a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // diagnostic "in flight" at a time, but this seems to be a reasonable 4290a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // tradeoff to keep these objects small. Assertions verify that only one 4300a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // diagnostic is in flight at a time. 4313cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner friend class DiagnosticBuilder; 4320a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner friend class DiagnosticInfo; 433b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner 434b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner /// CurDiagLoc - This is the location of the current diagnostic that is in 435b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner /// flight. 436b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner FullSourceLoc CurDiagLoc; 4371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 438b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner /// CurDiagID - This is the ID of the current diagnostic that is in flight. 4393cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// This is set to ~0U when there is no diagnostic in flight. 440b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner unsigned CurDiagID; 441b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner 44273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner enum { 44373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// MaxArguments - The maximum number of arguments we can hold. We currently 44473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// only support up to 10 arguments (%0-%9). A single diagnostic with more 44573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// than that almost certainly has to be simplified anyway. 44673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner MaxArguments = 10 44773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner }; 4481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4493cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// NumDiagArgs - This contains the number of entries in Arguments. 450730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner signed char NumDiagArgs; 451730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner /// NumRanges - This is the number of ranges in the DiagRanges array. 452730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner unsigned char NumDiagRanges; 4534b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief The number of code modifications hints in the 4544b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// CodeModificationHints array. 4554b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor unsigned char NumCodeModificationHints; 456ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 45773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsKind - This is an array of ArgumentKind::ArgumentKind enum 45873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// values, with one for each argument. This specifies whether the argument 45973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// is in DiagArgumentsStr or in DiagArguments. 46073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner unsigned char DiagArgumentsKind[MaxArguments]; 4611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 46273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsStr - This holds the values of each string argument for the 46373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// current diagnostic. This value is only used when the corresponding 46473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// ArgumentKind is ak_std_string. 46573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner std::string DiagArgumentsStr[MaxArguments]; 46673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 46773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsVal - The values for the various substitution positions. This 46873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// is used when the argument is not an std::string. The specific value is 46973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// mangled into an intptr_t and the intepretation depends on exactly what 47073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// sort of argument kind it is. 47173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner intptr_t DiagArgumentsVal[MaxArguments]; 4721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4730a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// DiagRanges - The list of ranges added to this diagnostic. It currently 4740a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// only support 10 ranges, could easily be extended if needed. 4750a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const SourceRange *DiagRanges[10]; 4761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4774b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor enum { MaxCodeModificationHints = 3 }; 4784b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 4794b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// CodeModificationHints - If valid, provides a hint with some code 4804b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// to insert, remove, or modify at a particular position. 4814b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor CodeModificationHint CodeModificationHints[MaxCodeModificationHints]; 4824b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 4830a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// ProcessDiag - This is the method used to report a diagnostic that is 4840a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// finally fully formed. 4855e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// 4865e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// \returns true if the diagnostic was emitted, false if it was 4875e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// suppressed. 4885e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor bool ProcessDiag(); 4893cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}; 4903cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 4913cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 4923cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner// DiagnosticBuilder 4933cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 4943cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 4953cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// DiagnosticBuilder - This is a little helper class used to produce 4963cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// diagnostics. This is constructed by the Diagnostic::Report method, and 4973cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// allows insertion of extra information (arguments and source ranges) into the 4983cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// currently "in flight" diagnostic. When the temporary for the builder is 4993cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// destroyed, the diagnostic is issued. 5003cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// 5013cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// Note that many of these will be created as temporary objects (many call 5023cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// sites), so we want them to be small and we never want their address taken. 5033cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// This ensures that compilers with somewhat reasonable optimizers will promote 5043cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// the common fields to registers, eliminating increments of the NumArgs field, 5053cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// for example. 5063cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerclass DiagnosticBuilder { 5073cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner mutable Diagnostic *DiagObj; 50825a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor mutable unsigned NumArgs, NumRanges, NumCodeModificationHints; 5091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5103cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void operator=(const DiagnosticBuilder&); // DO NOT IMPLEMENT 5113cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner friend class Diagnostic; 5123cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner explicit DiagnosticBuilder(Diagnostic *diagObj) 5131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump : DiagObj(diagObj), NumArgs(0), NumRanges(0), 51425a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor NumCodeModificationHints(0) {} 515ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 5161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumppublic: 5170a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// Copy constructor. When copied, this "takes" the diagnostic info from the 5180a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// input and neuters it. 5193cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagnosticBuilder(const DiagnosticBuilder &D) { 5200a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner DiagObj = D.DiagObj; 5210a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner D.DiagObj = 0; 52225a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor NumArgs = D.NumArgs; 52325a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor NumRanges = D.NumRanges; 52425a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor NumCodeModificationHints = D.NumCodeModificationHints; 5250a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 52625a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor 5275e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// \brief Simple enumeration value used to give a name to the 5285e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// suppress-diagnostic constructor. 5295e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor enum SuppressKind { Suppress }; 5305e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor 5315e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// \brief Create an empty DiagnosticBuilder object that represents 5325e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// no actual diagnostic. 5331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump explicit DiagnosticBuilder(SuppressKind) 5345e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor : DiagObj(0), NumArgs(0), NumRanges(0), NumCodeModificationHints(0) { } 5355e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor 53625a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// \brief Force the diagnostic builder to emit the diagnostic now. 53725a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// 53825a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// Once this function has been called, the DiagnosticBuilder object 53925a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// should not be used again before it is destroyed. 5405e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// 5415e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// \returns true if a diagnostic was emitted, false if the 5425e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// diagnostic was suppressed. 5435e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor bool Emit() { 54425a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor // If DiagObj is null, then its soul was stolen by the copy ctor 54525a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor // or the user called Emit(). 5465e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor if (DiagObj == 0) return false; 54722caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner 54825a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor // When emitting diagnostics, we set the final argument count into 54922caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner // the Diagnostic object. 5503cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->NumDiagArgs = NumArgs; 5513cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->NumDiagRanges = NumRanges; 5524b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor DiagObj->NumCodeModificationHints = NumCodeModificationHints; 5533cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 55422caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner // Process the diagnostic, sending the accumulated information to the 55522caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner // DiagnosticClient. 5565e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor bool Emitted = DiagObj->ProcessDiag(); 5570a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 558de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor // Clear out the current diagnostic object. 559de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor DiagObj->Clear(); 56025a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor 56125a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor // This diagnostic is dead. 56225a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor DiagObj = 0; 5635e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor 5645e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor return Emitted; 5653cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner } 56625a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor 56725a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// Destructor - The dtor emits the diagnostic if it hasn't already 56825a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// been emitted. 56925a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor ~DiagnosticBuilder() { Emit(); } 5701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5713cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// Operator bool: conversion of DiagnosticBuilder to bool always returns 5723cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// true. This allows is to be used in boolean error contexts like: 5733cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// return Diag(...); 5743cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner operator bool() const { return true; } 5753cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 576eaea925e70e3ee85809e572aa8474b8dfc491af7Daniel Dunbar void AddString(llvm::StringRef S) const { 5773cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(NumArgs < Diagnostic::MaxArguments && 5783cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 5795e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor if (DiagObj) { 5805e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor DiagObj->DiagArgumentsKind[NumArgs] = Diagnostic::ak_std_string; 5815e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor DiagObj->DiagArgumentsStr[NumArgs++] = S; 5825e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor } 5833cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner } 5841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5853cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void AddTaggedVal(intptr_t V, Diagnostic::ArgumentKind Kind) const { 5863cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(NumArgs < Diagnostic::MaxArguments && 5873cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 5885e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor if (DiagObj) { 5895e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor DiagObj->DiagArgumentsKind[NumArgs] = Kind; 5905e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor DiagObj->DiagArgumentsVal[NumArgs++] = V; 5915e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor } 5920a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 5931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5943cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void AddSourceRange(const SourceRange &R) const { 5951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump assert(NumRanges < 5963cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner sizeof(DiagObj->DiagRanges)/sizeof(DiagObj->DiagRanges[0]) && 5973cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 5985e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor if (DiagObj) 5995e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor DiagObj->DiagRanges[NumRanges++] = &R; 6001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 6014b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 6024b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor void AddCodeModificationHint(const CodeModificationHint &Hint) const { 6032f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson if (Hint.isNull()) 6042f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson return; 6052f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson 6064b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor assert(NumCodeModificationHints < Diagnostic::MaxCodeModificationHints && 6074b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor "Too many code modification hints!"); 6085e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor if (DiagObj) 6095e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor DiagObj->CodeModificationHints[NumCodeModificationHints++] = Hint; 6104b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 6113cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}; 6123cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 6133cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 614eaea925e70e3ee85809e572aa8474b8dfc491af7Daniel Dunbar llvm::StringRef S) { 6153cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddString(S); 6163cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 6173cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 6183cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 6193cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 6203cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const char *Str) { 6213cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(reinterpret_cast<intptr_t>(Str), 6223cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner Diagnostic::ak_c_string); 6233cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 6243cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 6253cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 6263cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, int I) { 6273cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(I, Diagnostic::ak_sint); 6283cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 6293cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 6303cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 6313bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidisinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,bool I) { 6323bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis DB.AddTaggedVal(I, Diagnostic::ak_sint); 6333bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis return DB; 6343bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis} 6353bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis 6363cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 6373cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner unsigned I) { 6383cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(I, Diagnostic::ak_uint); 6393cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 6403cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 6413cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 6423cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 6433cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const IdentifierInfo *II) { 6443cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(reinterpret_cast<intptr_t>(II), 6453cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner Diagnostic::ak_identifierinfo); 6463cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 6473cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 6481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6493f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// Adds a DeclContext to the diagnostic. The enable_if template magic is here 6503f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// so that we only match those arguments that are (statically) DeclContexts; 6513f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// other arguments that derive from DeclContext (e.g., RecordDecls) will not 6523f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// match. 6533f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregortemplate<typename T> 6543f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregorinline 6553f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregortypename llvm::enable_if<llvm::is_same<T, DeclContext>, 6563f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor const DiagnosticBuilder &>::type 6573f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregoroperator<<(const DiagnosticBuilder &DB, T *DC) { 6583f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor DB.AddTaggedVal(reinterpret_cast<intptr_t>(DC), 6593f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor Diagnostic::ak_declcontext); 6603f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor return DB; 6613f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor} 6623f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor 6633cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 6643cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const SourceRange &R) { 6653cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddSourceRange(R); 6663cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 6673cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 6684b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 6694b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregorinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 6704b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor const CodeModificationHint &Hint) { 6714b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor DB.AddCodeModificationHint(Hint); 6724b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor return DB; 6734b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor} 674ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 6753cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// Report - Issue the message to the client. DiagID is a member of the 6763cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// diag::kind enum. This actually returns a new instance of DiagnosticBuilder 6773cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// which emits the diagnostics (through ProcessDiag) when it is destroyed. 6783cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline DiagnosticBuilder Diagnostic::Report(FullSourceLoc Loc, unsigned DiagID){ 6793cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(CurDiagID == ~0U && "Multiple diagnostics in flight at once!"); 6803cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner CurDiagLoc = Loc; 6813cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner CurDiagID = DiagID; 6823cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DiagnosticBuilder(this); 6833cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 6840f9fed70cea107b3f79df554e38bd8e98d48fe47Daniel Dunbarinline DiagnosticBuilder Diagnostic::Report(unsigned DiagID) { 6850f9fed70cea107b3f79df554e38bd8e98d48fe47Daniel Dunbar return Report(FullSourceLoc(), DiagID); 6860f9fed70cea107b3f79df554e38bd8e98d48fe47Daniel Dunbar} 6873cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 6883cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 6893cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner// DiagnosticInfo 6903cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 6911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6923cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// DiagnosticInfo - This is a little helper class (which is basically a smart 6934b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// pointer that forward info from Diagnostic) that allows clients to enquire 6943cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// about the currently in-flight diagnostic. 6953cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerclass DiagnosticInfo { 6963cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const Diagnostic *DiagObj; 6973cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerpublic: 6983cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner explicit DiagnosticInfo(const Diagnostic *DO) : DiagObj(DO) {} 6991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7000a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const Diagnostic *getDiags() const { return DiagObj; } 701b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner unsigned getID() const { return DiagObj->CurDiagID; } 702b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner const FullSourceLoc &getLocation() const { return DiagObj->CurDiagLoc; } 7031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7040a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned getNumArgs() const { return DiagObj->NumDiagArgs; } 7051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 70673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgKind - Return the kind of the specified index. Based on the kind 70773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// of argument, the accessors below can be used to get the value. 7083cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner Diagnostic::ArgumentKind getArgKind(unsigned Idx) const { 7093cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(Idx < getNumArgs() && "Argument index out of range!"); 7103cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return (Diagnostic::ArgumentKind)DiagObj->DiagArgumentsKind[Idx]; 71173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner } 7121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 71373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgStdStr - Return the provided argument string specified by Idx. 71473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner const std::string &getArgStdStr(unsigned Idx) const { 7153cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_std_string && 7163cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 71773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner return DiagObj->DiagArgumentsStr[Idx]; 71873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner } 7191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 72073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgCStr - Return the specified C string argument. 72173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner const char *getArgCStr(unsigned Idx) const { 7223cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_c_string && 7233cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 72473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner return reinterpret_cast<const char*>(DiagObj->DiagArgumentsVal[Idx]); 7250a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 7261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 72730bc96544346bea42921cf6837e66cef80d664b4Chris Lattner /// getArgSInt - Return the specified signed integer argument. 72830bc96544346bea42921cf6837e66cef80d664b4Chris Lattner int getArgSInt(unsigned Idx) const { 7293cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_sint && 7303cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 73130bc96544346bea42921cf6837e66cef80d664b4Chris Lattner return (int)DiagObj->DiagArgumentsVal[Idx]; 73230bc96544346bea42921cf6837e66cef80d664b4Chris Lattner } 7331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 73430bc96544346bea42921cf6837e66cef80d664b4Chris Lattner /// getArgUInt - Return the specified unsigned integer argument. 73530bc96544346bea42921cf6837e66cef80d664b4Chris Lattner unsigned getArgUInt(unsigned Idx) const { 7363cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_uint && 7373cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 73830bc96544346bea42921cf6837e66cef80d664b4Chris Lattner return (unsigned)DiagObj->DiagArgumentsVal[Idx]; 73930bc96544346bea42921cf6837e66cef80d664b4Chris Lattner } 7401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 74143b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner /// getArgIdentifier - Return the specified IdentifierInfo argument. 74243b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner const IdentifierInfo *getArgIdentifier(unsigned Idx) const { 7433cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_identifierinfo && 7443cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 7459634379265855f1628190e926d9aaf1fb4a5d90eChris Lattner return reinterpret_cast<IdentifierInfo*>(DiagObj->DiagArgumentsVal[Idx]); 74643b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner } 7471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 74822caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner /// getRawArg - Return the specified non-string argument in an opaque form. 74922caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner intptr_t getRawArg(unsigned Idx) const { 75022caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner assert(getArgKind(Idx) != Diagnostic::ak_std_string && 75122caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner "invalid argument accessor!"); 75222caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner return DiagObj->DiagArgumentsVal[Idx]; 75322caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 7541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7560a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// getNumRanges - Return the number of source ranges associated with this 7570a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// diagnostic. 7580a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned getNumRanges() const { 7590a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner return DiagObj->NumDiagRanges; 7600a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 7611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7620a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const SourceRange &getRange(unsigned Idx) const { 7630a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner assert(Idx < DiagObj->NumDiagRanges && "Invalid diagnostic range index!"); 7640a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner return *DiagObj->DiagRanges[Idx]; 7650a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 7661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7674b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor unsigned getNumCodeModificationHints() const { 7684b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor return DiagObj->NumCodeModificationHints; 7694b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 7704b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 7714b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor const CodeModificationHint &getCodeModificationHint(unsigned Idx) const { 7724b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor return DiagObj->CodeModificationHints[Idx]; 7734b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 7744b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 7754b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor const CodeModificationHint *getCodeModificationHints() const { 7761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return DiagObj->NumCodeModificationHints? 7774b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor &DiagObj->CodeModificationHints[0] : 0; 7784b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 7794b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 780f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// FormatDiagnostic - Format this diagnostic into a string, substituting the 781f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// formal arguments into the %0 slots. The result is appended onto the Str 782f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// array. 783f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner void FormatDiagnostic(llvm::SmallVectorImpl<char> &OutStr) const; 7849f28614bf1a8387000d8df57a713fcf69e198145John McCall 7859f28614bf1a8387000d8df57a713fcf69e198145John McCall /// FormatDiagnostic - Format the given format-string into the 7869f28614bf1a8387000d8df57a713fcf69e198145John McCall /// output buffer using the arguments stored in this diagnostic. 7879f28614bf1a8387000d8df57a713fcf69e198145John McCall void FormatDiagnostic(const char *DiagStr, const char *DiagEnd, 7889f28614bf1a8387000d8df57a713fcf69e198145John McCall llvm::SmallVectorImpl<char> &OutStr) const; 7895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 7901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// DiagnosticClient - This is an abstract interface implemented by clients of 7925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// the front-end, which formats and prints fully processed diagnostics. 7935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass DiagnosticClient { 7945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 7955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer virtual ~DiagnosticClient(); 7961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 797efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// BeginSourceFile - Callback to inform the diagnostic client that processing 798efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// of a source file is beginning. 799efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// 800efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// Note that diagnostics may be emitted outside the processing of a source 801efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// file, for example during the parsing of command line options. However, 802efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// diagnostics with source range information are required to only be emitted 803efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// in between BeginSourceFile() and EndSourceFile(). 804efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// 805efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// \arg LO - The language options for the source file being processed. 806efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// \arg PP - The preprocessor object being used for the source; this optional 807efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// and may not be present, for example when processing AST source files. 8087d90199f109290e9d587479a481a2850d390b552Daniel Dunbar virtual void BeginSourceFile(const LangOptions &LangOpts, 8097d90199f109290e9d587479a481a2850d390b552Daniel Dunbar const Preprocessor *PP = 0) {} 810efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar 811efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// EndSourceFile - Callback to inform the diagnostic client that processing 812efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// of a source file has ended. The diagnostic client should assume that any 813efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// objects made available via \see BeginSourceFile() are inaccessible. 814efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar virtual void EndSourceFile() {} 8151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 816cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek /// IncludeInDiagnosticCounts - This method (whose default implementation 817efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// returns true) indicates whether the diagnostics handled by this 818efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// DiagnosticClient should be included in the number of diagnostics reported 819efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// by Diagnostic. 820cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek virtual bool IncludeInDiagnosticCounts() const; 8215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 8225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleDiagnostic - Handle this diagnostic, reporting it to the user or 8235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// capturing it to a log as needed. 8240a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner virtual void HandleDiagnostic(Diagnostic::Level DiagLevel, 8250a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const DiagnosticInfo &Info) = 0; 8265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 8275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 8285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 8295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 8305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 831