Diagnostic.h revision 0b60d9e0097e2d6a1a5e62396967e207c4a772f2
15f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===--- Diagnostic.h - C Language Family Diagnostic Handling ---*- C++ -*-===// 25f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 35f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// The LLVM Compiler Infrastructure 45f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 50bc735ffcfb223c0186419547abaa5c84482663eChris Lattner// This file is distributed under the University of Illinois Open Source 60bc735ffcfb223c0186419547abaa5c84482663eChris Lattner// License. See LICENSE.TXT for details. 75f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 85f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===----------------------------------------------------------------------===// 95f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// This file defines the Diagnostic-related interfaces. 115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===----------------------------------------------------------------------===// 135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#ifndef LLVM_CLANG_DIAGNOSTIC_H 155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#define LLVM_CLANG_DIAGNOSTIC_H 165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 172eefd8657c233bc7c9330acfe475fc270bbe7cabTed Kremenek#include "clang/Basic/SourceLocation.h" 185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include <string> 1904ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner#include <vector> 20f86638365f4801ec2d2970f7c0663e94590618b8Chris Lattner#include <cassert> 215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 22f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattnernamespace llvm { 23f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner template <typename T> class SmallVectorImpl; 24f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner} 25f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner 265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang { 273cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner class DiagnosticBuilder; 28b2153946fff330e54abfdc740c0a83aedd485b33Anders Carlsson class DiagnosticClient; 29d42ffbd22fc7eb61321f6a88173ee424991f01c6Ted Kremenek class IdentifierInfo; 3040469651a3f8379dc0f32df69e9bade06a2aad36Chris Lattner class LangOptions; 31b2153946fff330e54abfdc740c0a83aedd485b33Anders Carlsson class PartialDiagnostic; 32b2153946fff330e54abfdc740c0a83aedd485b33Anders Carlsson class SourceRange; 331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Import the diagnostic enums themselves. 355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer namespace diag { 3619e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner // Start position for diagnostics. 3719e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner enum { 384ad4b3ebbe5769143389dccfcfadb666a4ba5940Daniel Dunbar DIAG_START_DRIVER = 300, 3950f4f469024928670f2d634c445686d00eeb89b7Daniel Dunbar DIAG_START_FRONTEND = DIAG_START_DRIVER + 100, 4050f4f469024928670f2d634c445686d00eeb89b7Daniel Dunbar DIAG_START_LEX = DIAG_START_FRONTEND + 100, 4119e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_START_PARSE = DIAG_START_LEX + 300, 4219e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_START_AST = DIAG_START_PARSE + 300, 4319e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_START_SEMA = DIAG_START_AST + 100, 4419e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_START_ANALYSIS = DIAG_START_SEMA + 1000, 4519e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner DIAG_UPPER_LIMIT = DIAG_START_ANALYSIS + 100 4619e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner }; 4719e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner 48182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner class CustomDiagInfo; 491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// diag::kind - All of the diagnostics that can be emitted by the frontend. 5120c6b3b85e186cd52d5d99489132d71d498159ebChris Lattner typedef unsigned kind; 5220c6b3b85e186cd52d5d99489132d71d498159ebChris Lattner 5388eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner // Get typedefs for common diagnostics. 5488eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner enum { 555e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor#define DIAG(ENUM,FLAGS,DEFAULT_MAPPING,DESC,GROUP,SFINAE) ENUM, 564d7a089144f336b11e5e8ce437b3b27bce2b310dSebastian Redl#include "clang/Basic/DiagnosticCommonKinds.inc" 5788eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner NUM_BUILTIN_COMMON_DIAGNOSTICS 5888eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner#undef DIAG 5988eccaf06f9d88191723e71bdf5ca68409393be6Chris Lattner }; 601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Enum values that allow the client to map NOTEs, WARNINGs, and EXTENSIONs 625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to either MAP_IGNORE (nothing), MAP_WARNING (emit a warning), MAP_ERROR 6327ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// (emit as an error). It allows clients to map errors to 6427ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// MAP_ERROR/MAP_DEFAULT or MAP_FATAL (stop emitting diagnostics after this 6527ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// one). 665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer enum Mapping { 67691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner // NOTE: 0 means "uncomputed". 68691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner MAP_IGNORE = 1, //< Map this diagnostic to nothing, ignore it. 69691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner MAP_WARNING = 2, //< Map this diagnostic to a warning. 70691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner MAP_ERROR = 3, //< Map this diagnostic to an error. 712b07d8fe9e8a8ba12d64066632e17a9a5308a12eChris Lattner MAP_FATAL = 4, //< Map this diagnostic to a fatal error. 721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 73b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// Map this diagnostic to "warning", but make it immune to -Werror. This 74b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// happens when you specify -Wno-error=foo. 75b54b276a920246c595a0498da281821eb9d22996Chris Lattner MAP_WARNING_NO_WERROR = 5 765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 794b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// \brief Annotates a diagnostic with some code that should be 804b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// inserted, removed, or replaced to fix the problem. 814b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// 824b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// This kind of hint should be used when we are certain that the 834b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// introduction, removal, or modification of a particular (small!) 844b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// amount of code will correct a compilation error. The compiler 854b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// should also provide full recovery from such errors, such that 86b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor/// suppressing the diagnostic output can still result in successful 874b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// compilation. 884b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregorclass CodeModificationHint { 894b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregorpublic: 904b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Tokens that should be removed to correct the error. 914b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor SourceRange RemoveRange; 924b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 934b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief The location at which we should insert code to correct 944b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// the error. 954b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor SourceLocation InsertionLoc; 964b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 974b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief The actual code to insert at the insertion location, as a 984b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// string. 994b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor std::string CodeToInsert; 1004b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1014b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Empty code modification hint, indicating that no code 1024b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// modification is known. 1034b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor CodeModificationHint() : RemoveRange(), InsertionLoc() { } 1044b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1054b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that inserts the given 1064b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// code string at a specific location. 1071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump static CodeModificationHint CreateInsertion(SourceLocation InsertionLoc, 108b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor const std::string &Code) { 109b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor CodeModificationHint Hint; 110b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.InsertionLoc = InsertionLoc; 111b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.CodeToInsert = Code; 112b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 113b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 1144b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1154b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that removes the given 1164b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// source range. 117b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor static CodeModificationHint CreateRemoval(SourceRange RemoveRange) { 118b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor CodeModificationHint Hint; 119b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.RemoveRange = RemoveRange; 120b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 121b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 1224b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1234b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that replaces the given 1244b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// source range with the given code string. 1251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump static CodeModificationHint CreateReplacement(SourceRange RemoveRange, 126b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor const std::string &Code) { 127b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor CodeModificationHint Hint; 128b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.RemoveRange = RemoveRange; 129b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.InsertionLoc = RemoveRange.getBegin(); 130b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.CodeToInsert = Code; 131b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 132b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 1334b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor}; 1344b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// Diagnostic - This concrete class is used by the front-end to report 1365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// problems and issues. It massages the diagnostics (e.g. handling things like 1375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// "report warnings as errors" and passes them off to the DiagnosticClient for 1385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// reporting to the user. 1395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass Diagnostic { 140182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattnerpublic: 141182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// Level - The level of the diagnostic, after it has been through mapping. 142182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner enum Level { 143da0cbc1ad4a553c4de111c1181ec7b42c5ddefceChris Lattner Ignored, Note, Warning, Error, Fatal 144182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner }; 1451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 146b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// ExtensionHandling - How do we handle otherwise-unmapped extension? This 147b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// is controlled by -pedantic and -pedantic-errors. 148b54b276a920246c595a0498da281821eb9d22996Chris Lattner enum ExtensionHandling { 149b54b276a920246c595a0498da281821eb9d22996Chris Lattner Ext_Ignore, Ext_Warn, Ext_Error 150b54b276a920246c595a0498da281821eb9d22996Chris Lattner }; 1511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1523fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner enum ArgumentKind { 15347b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_std_string, // std::string 15447b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_c_string, // const char * 15547b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_sint, // int 15647b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_uint, // unsigned 15747b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_identifierinfo, // IdentifierInfo 15847b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_qualtype, // QualType 15947b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_declarationname, // DeclarationName 160dacd434c49658286c380c7b4c357d76d53cb4aa1Douglas Gregor ak_nameddecl, // NamedDecl * 161dacd434c49658286c380c7b4c357d76d53cb4aa1Douglas Gregor ak_nestednamespec // NestedNameSpecifier * 1623fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner }; 163ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 1641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumpprivate: 16527ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner unsigned char AllExtensionsSilenced; // Used by __extension__ 166b54b276a920246c595a0498da281821eb9d22996Chris Lattner bool IgnoreAllWarnings; // Ignore all warnings: -w 1671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump bool WarningsAsErrors; // Treat warnings like errors: 168b54b276a920246c595a0498da281821eb9d22996Chris Lattner bool SuppressSystemWarnings; // Suppress warnings in system headers. 16981b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor bool SuppressAllDiagnostics; // Suppress all diagnostics. 170b54b276a920246c595a0498da281821eb9d22996Chris Lattner ExtensionHandling ExtBehavior; // Map extensions onto warnings or errors? 171b4398aa27da4d6919c3ae448d1ae66ba6cafc048Ted Kremenek DiagnosticClient *Client; 1725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// DiagMappings - Mapping information for diagnostics. Mapping info is 174691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// packed into four bits per diagnostic. The low three bits are the mapping 175691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// (an instance of diag::Mapping), or zero if unset. The high bit is set 176691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// when the mapping was established as a user mapping. If the high bit is 177691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// clear, then the low bits are set to the default value, and should be 178691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// mapped with -pedantic, -Werror, etc. 17904ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 18004ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner typedef std::vector<unsigned char> DiagMappings; 18104ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner mutable std::vector<DiagMappings> DiagMappingsStack; 18204ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 18315221422eda7bac679e38b07512feda49715ef66Chris Lattner /// ErrorOccurred / FatalErrorOccurred - This is set to true when an error or 18415221422eda7bac679e38b07512feda49715ef66Chris Lattner /// fatal error is emitted, and is sticky. 1855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ErrorOccurred; 18615221422eda7bac679e38b07512feda49715ef66Chris Lattner bool FatalErrorOccurred; 1871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 188f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// LastDiagLevel - This is the level of the last diagnostic emitted. This is 189f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// used to emit continuation diagnostics with the same level as the 190f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// diagnostic that they follow. 191f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner Diagnostic::Level LastDiagLevel; 1925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumDiagnostics; // Number of diagnostics reported 1945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumErrors; // Number of diagnostics that are errors 195182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner 196182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// CustomDiagInfo - Information for uniquing and looking up custom diags. 197182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner diag::CustomDiagInfo *CustomDiagInfo; 1987bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber 1993fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// ArgToStringFn - A function pointer that converts an opaque diagnostic 2003fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// argument to a strings. This takes the modifiers and argument that was 2013fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// present in the diagnostic. 20222caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner /// This is a hack to avoid a layering violation between libbasic and libsema. 2033fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner typedef void (*ArgToStringFnTy)(ArgumentKind Kind, intptr_t Val, 2043fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Modifier, unsigned ModifierLen, 2053fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Argument, unsigned ArgumentLen, 20692dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner llvm::SmallVectorImpl<char> &Output, 20792dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner void *Cookie); 20892dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner void *ArgToStringCookie; 2093fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ArgToStringFnTy ArgToStringFn; 2105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 2117bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber explicit Diagnostic(DiagnosticClient *client = 0); 212182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner ~Diagnostic(); 2131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 2155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Diagnostic characterization methods, used by a client to customize how 2165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // 2171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2187bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber DiagnosticClient *getClient() { return Client; }; 2197bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber const DiagnosticClient *getClient() const { return Client; }; 22004ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 2211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// pushMappings - Copies the current DiagMappings and pushes the new copy 22304ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// onto the top of the stack. 22404ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner void pushMappings(); 22504ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 22604ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// popMappings - Pops the current DiagMappings off the top of the stack 22704ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// causing the new top of the stack to be the active mappings. Returns 22804ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// true if the pop happens, false if there is only one DiagMapping on the 22904ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// stack. 23004ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner bool popMappings(); 23104ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 232b4398aa27da4d6919c3ae448d1ae66ba6cafc048Ted Kremenek void setClient(DiagnosticClient* client) { Client = client; } 2335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2345b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner /// setIgnoreAllWarnings - When set to true, any unmapped warnings are 2355b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner /// ignored. If this and WarningsAsErrors are both set, then this one wins. 2365b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner void setIgnoreAllWarnings(bool Val) { IgnoreAllWarnings = Val; } 2375b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner bool getIgnoreAllWarnings() const { return IgnoreAllWarnings; } 2381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setWarningsAsErrors - When set to true, any warnings reported are issued 2405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// as errors. 2415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setWarningsAsErrors(bool Val) { WarningsAsErrors = Val; } 2425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getWarningsAsErrors() const { return WarningsAsErrors; } 2431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2442fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar /// setSuppressSystemWarnings - When set to true mask warnings that 2452fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar /// come from system headers. 2462fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar void setSuppressSystemWarnings(bool Val) { SuppressSystemWarnings = Val; } 2472fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar bool getSuppressSystemWarnings() const { return SuppressSystemWarnings; } 2482fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar 24981b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor /// \brief Suppress all diagnostics, to silence the front end when we 25081b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor /// know that we don't want any more diagnostics to be passed along to the 25181b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor /// client 25281b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor void setSuppressAllDiagnostics(bool Val = true) { 25381b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor SuppressAllDiagnostics = Val; 25481b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor } 25581b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor bool getSuppressAllDiagnostics() const { return SuppressAllDiagnostics; } 25681b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor 2570b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor /// \brief Pretend that the last diagnostic issued was ignored. This can 2580b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor /// be used by clients who suppress diagnostics themselves. 2590b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor void setLastDiagnosticIgnored() { 2600b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor LastDiagLevel = Ignored; 2610b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor } 2620b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor 263b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// setExtensionHandlingBehavior - This controls whether otherwise-unmapped 264b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// extension diagnostics are mapped onto ignore/warning/error. This 265b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// corresponds to the GCC -pedantic and -pedantic-errors option. 266b54b276a920246c595a0498da281821eb9d22996Chris Lattner void setExtensionHandlingBehavior(ExtensionHandling H) { 267b54b276a920246c595a0498da281821eb9d22996Chris Lattner ExtBehavior = H; 268b54b276a920246c595a0498da281821eb9d22996Chris Lattner } 2691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 27027ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// AllExtensionsSilenced - This is a counter bumped when an __extension__ 27127ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// block is encountered. When non-zero, all extension diagnostics are 27227ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// entirely silenced, no matter how they are mapped. 27327ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner void IncrementAllExtensionsSilenced() { ++AllExtensionsSilenced; } 27427ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner void DecrementAllExtensionsSilenced() { --AllExtensionsSilenced; } 27591a2886d558ea6ca7a0bed73ab5acea5ae78eac2Douglas Gregor bool hasAllExtensionsSilenced() { return AllExtensionsSilenced != 0; } 2761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setDiagnosticMapping - This allows the client to specify that certain 278691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// warnings are ignored. Notes can never be mapped, errors can only be 279691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// mapped to fatal, and WARNINGs and EXTENSIONs can be mapped arbitrarily. 2805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setDiagnosticMapping(diag::kind Diag, diag::Mapping Map) { 28119e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner assert(Diag < diag::DIAG_UPPER_LIMIT && 2820750618b0beacdc9b0a9e210a661e4746823ced7Chris Lattner "Can only map builtin diagnostics"); 283f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner assert((isBuiltinWarningOrExtension(Diag) || Map == diag::MAP_FATAL) && 2847fc24e2d47e1cdf03e655ed212d282635d755591Chris Lattner "Cannot map errors!"); 285691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner setDiagnosticMappingInternal(Diag, Map, true); 28627ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner } 2871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2883bc172bc6a787842db6fea351cf6929539fca70dChris Lattner /// setDiagnosticGroupMapping - Change an entire diagnostic group (e.g. 2893bc172bc6a787842db6fea351cf6929539fca70dChris Lattner /// "unknown-pragmas" to have the specified mapping. This returns true and 2903bc172bc6a787842db6fea351cf6929539fca70dChris Lattner /// ignores the request if "Group" was unknown, false otherwise. 2913bc172bc6a787842db6fea351cf6929539fca70dChris Lattner bool setDiagnosticGroupMapping(const char *Group, diag::Mapping Map); 2925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool hasErrorOccurred() const { return ErrorOccurred; } 29415221422eda7bac679e38b07512feda49715ef66Chris Lattner bool hasFatalErrorOccurred() const { return FatalErrorOccurred; } 2955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned getNumErrors() const { return NumErrors; } 2975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned getNumDiagnostics() const { return NumDiagnostics; } 2981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 299182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// getCustomDiagID - Return an ID for a diagnostic with the specified message 300182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// and level. If this is the first request for this diagnosic, it is 301182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// registered and created, otherwise the existing ID is returned. 302182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner unsigned getCustomDiagID(Level L, const char *Message); 3031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3053fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// ConvertArgToString - This method converts a diagnostic argument (as an 3063fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// intptr_t) into the string that represents it. 3073fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner void ConvertArgToString(ArgumentKind Kind, intptr_t Val, 3083fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Modifier, unsigned ModLen, 3093fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Argument, unsigned ArgLen, 3103fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner llvm::SmallVectorImpl<char> &Output) const { 31192dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner ArgToStringFn(Kind, Val, Modifier, ModLen, Argument, ArgLen, Output, 31292dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner ArgToStringCookie); 31322caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 3141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 31592dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner void SetArgToStringFn(ArgToStringFnTy Fn, void *Cookie) { 3163fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ArgToStringFn = Fn; 31792dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner ArgToStringCookie = Cookie; 31822caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 3191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 3215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Diagnostic classification and reporting interfaces. 3225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // 3235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getDescription - Given a diagnostic ID, return a description of the 3255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// issue. 3260a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const char *getDescription(unsigned DiagID) const; 3271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 328f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// isNoteWarningOrExtension - Return true if the unmapped diagnostic 329f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// level of the specified diagnostic ID is a Warning or Extension. 330f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// This only works on builtin diagnostics, not custom ones, and is not legal to 331f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// call on NOTEs. 332f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner static bool isBuiltinWarningOrExtension(unsigned DiagID); 3335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 334ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor /// \brief Determine whether the given built-in diagnostic ID is a 335ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor /// Note. 336ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor static bool isBuiltinNote(unsigned DiagID); 3371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 33827ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// isBuiltinExtensionDiag - Determine whether the given built-in diagnostic 33927ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// ID is for an extension of some sort. 34027ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// 34127ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner static bool isBuiltinExtensionDiag(unsigned DiagID); 3421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 343d51d74a3e89c5e5fc9bfd2814996a5feab6dc932Chris Lattner /// getWarningOptionForDiag - Return the lowest-level warning option that 344d51d74a3e89c5e5fc9bfd2814996a5feab6dc932Chris Lattner /// enables the specified diagnostic. If there is no -Wfoo flag that controls 345d51d74a3e89c5e5fc9bfd2814996a5feab6dc932Chris Lattner /// the diagnostic, this returns null. 346d51d74a3e89c5e5fc9bfd2814996a5feab6dc932Chris Lattner static const char *getWarningOptionForDiag(unsigned DiagID); 347ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 3485e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// \brief Determines whether the given built-in diagnostic ID is 3495e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// for an error that is suppressed if it occurs during C++ template 3505e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// argument deduction. 3515e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// 3525e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// When an error is suppressed due to SFINAE, the template argument 3535e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// deduction fails but no diagnostic is emitted. Certain classes of 3545e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// errors, such as those errors that involve C++ access control, 3555e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// are not SFINAE errors. 3565e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor static bool isBuiltinSFINAEDiag(unsigned DiagID); 3575e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor 3585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getDiagnosticLevel - Based on the way the client configured the Diagnostic 3595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// object, classify the specified diagnostic ID into a Level, consumable by 3605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the DiagnosticClient. 3611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump Level getDiagnosticLevel(unsigned DiagID) const; 3621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 363509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// Report - Issue the message to the client. @c DiagID is a member of the 364509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// @c diag::kind enum. This actually returns aninstance of DiagnosticBuilder 365509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// which emits the diagnostics (through @c ProcessDiag) when it is destroyed. 366509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// @c Pos represents the source location associated with the diagnostic, 367509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// which can be an invalid location if no position information is available. 3683cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner inline DiagnosticBuilder Report(FullSourceLoc Pos, unsigned DiagID); 369de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor 370de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor /// \brief Clear out the current diagnostic. 371de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor void Clear() { CurDiagID = ~0U; } 3721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3730a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattnerprivate: 374691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// getDiagnosticMappingInfo - Return the mapping info currently set for the 375691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// specified builtin diagnostic. This returns the high bit encoding, or zero 376691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// if the field is completely uninitialized. 377691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner unsigned getDiagnosticMappingInfo(diag::kind Diag) const { 37804ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner const DiagMappings ¤tMappings = DiagMappingsStack.back(); 37904ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner return (diag::Mapping)((currentMappings[Diag/2] >> (Diag & 1)*4) & 15); 380691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner } 3811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 382691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner void setDiagnosticMappingInternal(unsigned DiagId, unsigned Map, 383691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner bool isUser) const { 384691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner if (isUser) Map |= 8; // Set the high bit for user mappings. 38504ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner unsigned char &Slot = DiagMappingsStack.back()[DiagId/2]; 386691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner unsigned Shift = (DiagId & 1)*4; 387691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner Slot &= ~(15 << Shift); 388691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner Slot |= Map << Shift; 3899faf50e62ddcd2535b472abc8daafd7042120caaChris Lattner } 3901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 391f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// getDiagnosticLevel - This is an internal implementation helper used when 392f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// DiagClass is already known. 393f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner Level getDiagnosticLevel(unsigned DiagID, unsigned DiagClass) const; 394f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner 3953cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner // This is private state used by DiagnosticBuilder. We put it here instead of 3963cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner // in DiagnosticBuilder in order to keep DiagnosticBuilder a small lightweight 3970a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // object. This implementation choice means that we can only have one 3980a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // diagnostic "in flight" at a time, but this seems to be a reasonable 3990a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // tradeoff to keep these objects small. Assertions verify that only one 4000a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // diagnostic is in flight at a time. 4013cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner friend class DiagnosticBuilder; 4020a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner friend class DiagnosticInfo; 403b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner 404b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner /// CurDiagLoc - This is the location of the current diagnostic that is in 405b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner /// flight. 406b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner FullSourceLoc CurDiagLoc; 4071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 408b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner /// CurDiagID - This is the ID of the current diagnostic that is in flight. 4093cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// This is set to ~0U when there is no diagnostic in flight. 410b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner unsigned CurDiagID; 411b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner 41273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner enum { 41373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// MaxArguments - The maximum number of arguments we can hold. We currently 41473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// only support up to 10 arguments (%0-%9). A single diagnostic with more 41573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// than that almost certainly has to be simplified anyway. 41673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner MaxArguments = 10 41773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner }; 4181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4193cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// NumDiagArgs - This contains the number of entries in Arguments. 420730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner signed char NumDiagArgs; 421730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner /// NumRanges - This is the number of ranges in the DiagRanges array. 422730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner unsigned char NumDiagRanges; 4234b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief The number of code modifications hints in the 4244b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// CodeModificationHints array. 4254b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor unsigned char NumCodeModificationHints; 426ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 42773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsKind - This is an array of ArgumentKind::ArgumentKind enum 42873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// values, with one for each argument. This specifies whether the argument 42973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// is in DiagArgumentsStr or in DiagArguments. 43073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner unsigned char DiagArgumentsKind[MaxArguments]; 4311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 43273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsStr - This holds the values of each string argument for the 43373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// current diagnostic. This value is only used when the corresponding 43473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// ArgumentKind is ak_std_string. 43573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner std::string DiagArgumentsStr[MaxArguments]; 43673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 43773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsVal - The values for the various substitution positions. This 43873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// is used when the argument is not an std::string. The specific value is 43973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// mangled into an intptr_t and the intepretation depends on exactly what 44073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// sort of argument kind it is. 44173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner intptr_t DiagArgumentsVal[MaxArguments]; 4421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4430a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// DiagRanges - The list of ranges added to this diagnostic. It currently 4440a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// only support 10 ranges, could easily be extended if needed. 4450a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const SourceRange *DiagRanges[10]; 4461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4474b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor enum { MaxCodeModificationHints = 3 }; 4484b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 4494b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// CodeModificationHints - If valid, provides a hint with some code 4504b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// to insert, remove, or modify at a particular position. 4514b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor CodeModificationHint CodeModificationHints[MaxCodeModificationHints]; 4524b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 4530a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// ProcessDiag - This is the method used to report a diagnostic that is 4540a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// finally fully formed. 4555e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// 4565e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// \returns true if the diagnostic was emitted, false if it was 4575e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// suppressed. 4585e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor bool ProcessDiag(); 4593cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}; 4603cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 4613cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 4623cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner// DiagnosticBuilder 4633cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 4643cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 4653cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// DiagnosticBuilder - This is a little helper class used to produce 4663cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// diagnostics. This is constructed by the Diagnostic::Report method, and 4673cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// allows insertion of extra information (arguments and source ranges) into the 4683cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// currently "in flight" diagnostic. When the temporary for the builder is 4693cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// destroyed, the diagnostic is issued. 4703cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// 4713cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// Note that many of these will be created as temporary objects (many call 4723cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// sites), so we want them to be small and we never want their address taken. 4733cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// This ensures that compilers with somewhat reasonable optimizers will promote 4743cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// the common fields to registers, eliminating increments of the NumArgs field, 4753cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// for example. 4763cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerclass DiagnosticBuilder { 4773cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner mutable Diagnostic *DiagObj; 47825a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor mutable unsigned NumArgs, NumRanges, NumCodeModificationHints; 4791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4803cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void operator=(const DiagnosticBuilder&); // DO NOT IMPLEMENT 4813cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner friend class Diagnostic; 4823cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner explicit DiagnosticBuilder(Diagnostic *diagObj) 4831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump : DiagObj(diagObj), NumArgs(0), NumRanges(0), 48425a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor NumCodeModificationHints(0) {} 485ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 4861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumppublic: 4870a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// Copy constructor. When copied, this "takes" the diagnostic info from the 4880a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// input and neuters it. 4893cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagnosticBuilder(const DiagnosticBuilder &D) { 4900a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner DiagObj = D.DiagObj; 4910a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner D.DiagObj = 0; 49225a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor NumArgs = D.NumArgs; 49325a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor NumRanges = D.NumRanges; 49425a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor NumCodeModificationHints = D.NumCodeModificationHints; 4950a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 49625a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor 4975e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// \brief Simple enumeration value used to give a name to the 4985e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// suppress-diagnostic constructor. 4995e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor enum SuppressKind { Suppress }; 5005e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor 5015e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// \brief Create an empty DiagnosticBuilder object that represents 5025e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// no actual diagnostic. 5031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump explicit DiagnosticBuilder(SuppressKind) 5045e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor : DiagObj(0), NumArgs(0), NumRanges(0), NumCodeModificationHints(0) { } 5055e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor 50625a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// \brief Force the diagnostic builder to emit the diagnostic now. 50725a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// 50825a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// Once this function has been called, the DiagnosticBuilder object 50925a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// should not be used again before it is destroyed. 5105e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// 5115e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// \returns true if a diagnostic was emitted, false if the 5125e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// diagnostic was suppressed. 5135e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor bool Emit() { 51425a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor // If DiagObj is null, then its soul was stolen by the copy ctor 51525a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor // or the user called Emit(). 5165e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor if (DiagObj == 0) return false; 51722caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner 51825a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor // When emitting diagnostics, we set the final argument count into 51922caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner // the Diagnostic object. 5203cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->NumDiagArgs = NumArgs; 5213cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagObj->NumDiagRanges = NumRanges; 5224b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor DiagObj->NumCodeModificationHints = NumCodeModificationHints; 5233cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 52422caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner // Process the diagnostic, sending the accumulated information to the 52522caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner // DiagnosticClient. 5265e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor bool Emitted = DiagObj->ProcessDiag(); 5270a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner 528de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor // Clear out the current diagnostic object. 529de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor DiagObj->Clear(); 53025a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor 53125a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor // This diagnostic is dead. 53225a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor DiagObj = 0; 5335e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor 5345e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor return Emitted; 5353cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner } 53625a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor 53725a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// Destructor - The dtor emits the diagnostic if it hasn't already 53825a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// been emitted. 53925a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor ~DiagnosticBuilder() { Emit(); } 5401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5413cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// Operator bool: conversion of DiagnosticBuilder to bool always returns 5423cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// true. This allows is to be used in boolean error contexts like: 5433cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// return Diag(...); 5443cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner operator bool() const { return true; } 5453cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 5463cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void AddString(const std::string &S) const { 5473cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(NumArgs < Diagnostic::MaxArguments && 5483cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 5495e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor if (DiagObj) { 5505e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor DiagObj->DiagArgumentsKind[NumArgs] = Diagnostic::ak_std_string; 5515e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor DiagObj->DiagArgumentsStr[NumArgs++] = S; 5525e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor } 5533cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner } 5541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5553cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void AddTaggedVal(intptr_t V, Diagnostic::ArgumentKind Kind) const { 5563cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(NumArgs < Diagnostic::MaxArguments && 5573cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 5585e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor if (DiagObj) { 5595e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor DiagObj->DiagArgumentsKind[NumArgs] = Kind; 5605e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor DiagObj->DiagArgumentsVal[NumArgs++] = V; 5615e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor } 5620a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 5631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5643cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void AddSourceRange(const SourceRange &R) const { 5651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump assert(NumRanges < 5663cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner sizeof(DiagObj->DiagRanges)/sizeof(DiagObj->DiagRanges[0]) && 5673cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 5685e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor if (DiagObj) 5695e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor DiagObj->DiagRanges[NumRanges++] = &R; 5701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 5714b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 5724b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor void AddCodeModificationHint(const CodeModificationHint &Hint) const { 5734b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor assert(NumCodeModificationHints < Diagnostic::MaxCodeModificationHints && 5744b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor "Too many code modification hints!"); 5755e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor if (DiagObj) 5765e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor DiagObj->CodeModificationHints[NumCodeModificationHints++] = Hint; 5774b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 5783cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}; 5793cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 5803cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 5813cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const std::string &S) { 5823cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddString(S); 5833cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 5843cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 5853cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 5863cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 5873cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const char *Str) { 5883cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(reinterpret_cast<intptr_t>(Str), 5893cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner Diagnostic::ak_c_string); 5903cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 5913cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 5923cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 5933cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, int I) { 5943cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(I, Diagnostic::ak_sint); 5953cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 5963cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 5973cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 5983bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidisinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,bool I) { 5993bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis DB.AddTaggedVal(I, Diagnostic::ak_sint); 6003bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis return DB; 6013bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis} 6023bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis 6033cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 6043cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner unsigned I) { 6053cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(I, Diagnostic::ak_uint); 6063cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 6073cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 6083cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 6093cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 6103cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const IdentifierInfo *II) { 6113cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(reinterpret_cast<intptr_t>(II), 6123cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner Diagnostic::ak_identifierinfo); 6133cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 6143cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 6151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6163cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 6173cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const SourceRange &R) { 6183cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddSourceRange(R); 6193cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 6203cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 6214b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 6224b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregorinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 6234b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor const CodeModificationHint &Hint) { 6244b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor DB.AddCodeModificationHint(Hint); 6254b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor return DB; 6264b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor} 627ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 6283cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// Report - Issue the message to the client. DiagID is a member of the 6293cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// diag::kind enum. This actually returns a new instance of DiagnosticBuilder 6303cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// which emits the diagnostics (through ProcessDiag) when it is destroyed. 6313cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline DiagnosticBuilder Diagnostic::Report(FullSourceLoc Loc, unsigned DiagID){ 6323cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(CurDiagID == ~0U && "Multiple diagnostics in flight at once!"); 6333cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner CurDiagLoc = Loc; 6343cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner CurDiagID = DiagID; 6353cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DiagnosticBuilder(this); 6363cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 6373cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 6383cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 6393cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner// DiagnosticInfo 6403cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 6411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6423cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// DiagnosticInfo - This is a little helper class (which is basically a smart 6434b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// pointer that forward info from Diagnostic) that allows clients to enquire 6443cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// about the currently in-flight diagnostic. 6453cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerclass DiagnosticInfo { 6463cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const Diagnostic *DiagObj; 6473cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerpublic: 6483cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner explicit DiagnosticInfo(const Diagnostic *DO) : DiagObj(DO) {} 6491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6500a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const Diagnostic *getDiags() const { return DiagObj; } 651b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner unsigned getID() const { return DiagObj->CurDiagID; } 652b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner const FullSourceLoc &getLocation() const { return DiagObj->CurDiagLoc; } 6531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6540a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned getNumArgs() const { return DiagObj->NumDiagArgs; } 6551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 65673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgKind - Return the kind of the specified index. Based on the kind 65773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// of argument, the accessors below can be used to get the value. 6583cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner Diagnostic::ArgumentKind getArgKind(unsigned Idx) const { 6593cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(Idx < getNumArgs() && "Argument index out of range!"); 6603cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return (Diagnostic::ArgumentKind)DiagObj->DiagArgumentsKind[Idx]; 66173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner } 6621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 66373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgStdStr - Return the provided argument string specified by Idx. 66473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner const std::string &getArgStdStr(unsigned Idx) const { 6653cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_std_string && 6663cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 66773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner return DiagObj->DiagArgumentsStr[Idx]; 66873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner } 6691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 67073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgCStr - Return the specified C string argument. 67173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner const char *getArgCStr(unsigned Idx) const { 6723cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_c_string && 6733cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 67473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner return reinterpret_cast<const char*>(DiagObj->DiagArgumentsVal[Idx]); 6750a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 6761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 67730bc96544346bea42921cf6837e66cef80d664b4Chris Lattner /// getArgSInt - Return the specified signed integer argument. 67830bc96544346bea42921cf6837e66cef80d664b4Chris Lattner int getArgSInt(unsigned Idx) const { 6793cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_sint && 6803cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 68130bc96544346bea42921cf6837e66cef80d664b4Chris Lattner return (int)DiagObj->DiagArgumentsVal[Idx]; 68230bc96544346bea42921cf6837e66cef80d664b4Chris Lattner } 6831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 68430bc96544346bea42921cf6837e66cef80d664b4Chris Lattner /// getArgUInt - Return the specified unsigned integer argument. 68530bc96544346bea42921cf6837e66cef80d664b4Chris Lattner unsigned getArgUInt(unsigned Idx) const { 6863cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_uint && 6873cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 68830bc96544346bea42921cf6837e66cef80d664b4Chris Lattner return (unsigned)DiagObj->DiagArgumentsVal[Idx]; 68930bc96544346bea42921cf6837e66cef80d664b4Chris Lattner } 6901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 69143b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner /// getArgIdentifier - Return the specified IdentifierInfo argument. 69243b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner const IdentifierInfo *getArgIdentifier(unsigned Idx) const { 6933cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_identifierinfo && 6943cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 6959634379265855f1628190e926d9aaf1fb4a5d90eChris Lattner return reinterpret_cast<IdentifierInfo*>(DiagObj->DiagArgumentsVal[Idx]); 69643b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner } 6971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 69822caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner /// getRawArg - Return the specified non-string argument in an opaque form. 69922caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner intptr_t getRawArg(unsigned Idx) const { 70022caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner assert(getArgKind(Idx) != Diagnostic::ak_std_string && 70122caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner "invalid argument accessor!"); 70222caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner return DiagObj->DiagArgumentsVal[Idx]; 70322caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 7041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7060a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// getNumRanges - Return the number of source ranges associated with this 7070a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// diagnostic. 7080a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned getNumRanges() const { 7090a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner return DiagObj->NumDiagRanges; 7100a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 7111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7120a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const SourceRange &getRange(unsigned Idx) const { 7130a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner assert(Idx < DiagObj->NumDiagRanges && "Invalid diagnostic range index!"); 7140a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner return *DiagObj->DiagRanges[Idx]; 7150a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 7161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7174b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor unsigned getNumCodeModificationHints() const { 7184b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor return DiagObj->NumCodeModificationHints; 7194b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 7204b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 7214b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor const CodeModificationHint &getCodeModificationHint(unsigned Idx) const { 7224b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor return DiagObj->CodeModificationHints[Idx]; 7234b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 7244b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 7254b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor const CodeModificationHint *getCodeModificationHints() const { 7261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return DiagObj->NumCodeModificationHints? 7274b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor &DiagObj->CodeModificationHints[0] : 0; 7284b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 7294b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 730f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// FormatDiagnostic - Format this diagnostic into a string, substituting the 731f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// formal arguments into the %0 slots. The result is appended onto the Str 732f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// array. 733f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner void FormatDiagnostic(llvm::SmallVectorImpl<char> &OutStr) const; 7345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 7351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// DiagnosticClient - This is an abstract interface implemented by clients of 7375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// the front-end, which formats and prints fully processed diagnostics. 7385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass DiagnosticClient { 7395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 7405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer virtual ~DiagnosticClient(); 7411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 74240469651a3f8379dc0f32df69e9bade06a2aad36Chris Lattner /// setLangOptions - This is set by clients of diagnostics when they know the 74340469651a3f8379dc0f32df69e9bade06a2aad36Chris Lattner /// language parameters of the diagnostics that may be sent through. Note 74440469651a3f8379dc0f32df69e9bade06a2aad36Chris Lattner /// that this can change over time if a DiagClient has multiple languages sent 74540469651a3f8379dc0f32df69e9bade06a2aad36Chris Lattner /// through it. It may also be set to null (e.g. when processing command line 74640469651a3f8379dc0f32df69e9bade06a2aad36Chris Lattner /// options). 74740469651a3f8379dc0f32df69e9bade06a2aad36Chris Lattner virtual void setLangOptions(const LangOptions *LO) {} 7481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 749cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek /// IncludeInDiagnosticCounts - This method (whose default implementation 750cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek /// returns true) indicates whether the diagnostics handled by this 751cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek /// DiagnosticClient should be included in the number of diagnostics 752cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek /// reported by Diagnostic. 753cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek virtual bool IncludeInDiagnosticCounts() const; 7545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 7555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleDiagnostic - Handle this diagnostic, reporting it to the user or 7565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// capturing it to a log as needed. 7570a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner virtual void HandleDiagnostic(Diagnostic::Level DiagLevel, 7580a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const DiagnosticInfo &Info) = 0; 7595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 7605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 7615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 7625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 7635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 764