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//===----------------------------------------------------------------------===// 92f7f5b1f5ff023cb8c4008ae53a12b09e3ea2622James Dennett/// 102f7f5b1f5ff023cb8c4008ae53a12b09e3ea2622James Dennett/// \file 112f7f5b1f5ff023cb8c4008ae53a12b09e3ea2622James Dennett/// \brief Defines the Diagnostic-related interfaces. 122f7f5b1f5ff023cb8c4008ae53a12b09e3ea2622James Dennett/// 135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===----------------------------------------------------------------------===// 145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#ifndef LLVM_CLANG_DIAGNOSTIC_H 165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#define LLVM_CLANG_DIAGNOSTIC_H 175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1833e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis#include "clang/Basic/DiagnosticIDs.h" 19dc7b641574a733624489bd87fc7061771edf2113Douglas Gregor#include "clang/Basic/DiagnosticOptions.h" 202eefd8657c233bc7c9330acfe475fc270bbe7cabTed Kremenek#include "clang/Basic/SourceLocation.h" 21f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor#include "llvm/ADT/ArrayRef.h" 220827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis#include "llvm/ADT/DenseMap.h" 2328019772db70d4547be05a042eb950bc910f134fDouglas Gregor#include "llvm/ADT/IntrusiveRefCntPtr.h" 246bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines#include "llvm/ADT/iterator_range.h" 250827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis#include <list> 2630a2e16f6c27f888dd11eba6bbbae1e980078fcbChandler Carruth#include <vector> 27f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner 285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang { 296bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines class DeclContext; 3033e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis class DiagnosticBuilder; 316bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines class DiagnosticConsumer; 326bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines class DiagnosticErrorTrap; 3302c23ebf41ae2f70da0ba7337e05c51fbfe35f7fDouglas Gregor class DiagnosticOptions; 34d42ffbd22fc7eb61321f6a88173ee424991f01c6Ted Kremenek class IdentifierInfo; 3540469651a3f8379dc0f32df69e9bade06a2aad36Chris Lattner class LangOptions; 367d90199f109290e9d587479a481a2850d390b552Daniel Dunbar class Preprocessor; 37e59abb56ce0e1c206fb80bd945a0c358b0abe1efArgyrios Kyrtzidis class StoredDiagnostic; 38651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines namespace tok { 39651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines enum TokenKind : unsigned short; 40651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines } 411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 424b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// \brief Annotates a diagnostic with some code that should be 434b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// inserted, removed, or replaced to fix the problem. 444b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// 454b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// This kind of hint should be used when we are certain that the 464b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// introduction, removal, or modification of a particular (small!) 474b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// amount of code will correct a compilation error. The compiler 484b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// should also provide full recovery from such errors, such that 49b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor/// suppressing the diagnostic output can still result in successful 504b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// compilation. 51849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregorclass FixItHint { 524b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregorpublic: 53783c56f47745f719590b17afd7ed937bf2407b53Douglas Gregor /// \brief Code that should be replaced to correct the error. Empty for an 54783c56f47745f719590b17afd7ed937bf2407b53Douglas Gregor /// insertion hint. 550a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner CharSourceRange RemoveRange; 564b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 5730660a898545416f0fea2d717f16f75640001e38Ted Kremenek /// \brief Code in the specific range that should be inserted in the insertion 5830660a898545416f0fea2d717f16f75640001e38Ted Kremenek /// location. 5930660a898545416f0fea2d717f16f75640001e38Ted Kremenek CharSourceRange InsertFromRange; 6030660a898545416f0fea2d717f16f75640001e38Ted Kremenek 614b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief The actual code to insert at the insertion location, as a 624b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// string. 634b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor std::string CodeToInsert; 644b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 6530660a898545416f0fea2d717f16f75640001e38Ted Kremenek bool BeforePreviousInsertions; 6630660a898545416f0fea2d717f16f75640001e38Ted Kremenek 674b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Empty code modification hint, indicating that no code 684b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// modification is known. 6930660a898545416f0fea2d717f16f75640001e38Ted Kremenek FixItHint() : BeforePreviousInsertions(false) { } 704b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 712f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson bool isNull() const { 72783c56f47745f719590b17afd7ed937bf2407b53Douglas Gregor return !RemoveRange.isValid(); 732f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson } 742f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson 754b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that inserts the given 764b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// code string at a specific location. 77849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor static FixItHint CreateInsertion(SourceLocation InsertionLoc, 7830660a898545416f0fea2d717f16f75640001e38Ted Kremenek StringRef Code, 7930660a898545416f0fea2d717f16f75640001e38Ted Kremenek bool BeforePreviousInsertions = false) { 80849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor FixItHint Hint; 81783c56f47745f719590b17afd7ed937bf2407b53Douglas Gregor Hint.RemoveRange = 824a2ef80d896c1bac38ce113ec19a8d509a619288Nico Weber CharSourceRange::getCharRange(InsertionLoc, InsertionLoc); 83b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.CodeToInsert = Code; 8430660a898545416f0fea2d717f16f75640001e38Ted Kremenek Hint.BeforePreviousInsertions = BeforePreviousInsertions; 8530660a898545416f0fea2d717f16f75640001e38Ted Kremenek return Hint; 8630660a898545416f0fea2d717f16f75640001e38Ted Kremenek } 8730660a898545416f0fea2d717f16f75640001e38Ted Kremenek 8830660a898545416f0fea2d717f16f75640001e38Ted Kremenek /// \brief Create a code modification hint that inserts the given 89af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// code from \p FromRange at a specific location. 9030660a898545416f0fea2d717f16f75640001e38Ted Kremenek static FixItHint CreateInsertionFromRange(SourceLocation InsertionLoc, 9130660a898545416f0fea2d717f16f75640001e38Ted Kremenek CharSourceRange FromRange, 9230660a898545416f0fea2d717f16f75640001e38Ted Kremenek bool BeforePreviousInsertions = false) { 9330660a898545416f0fea2d717f16f75640001e38Ted Kremenek FixItHint Hint; 9430660a898545416f0fea2d717f16f75640001e38Ted Kremenek Hint.RemoveRange = 954a2ef80d896c1bac38ce113ec19a8d509a619288Nico Weber CharSourceRange::getCharRange(InsertionLoc, InsertionLoc); 9630660a898545416f0fea2d717f16f75640001e38Ted Kremenek Hint.InsertFromRange = FromRange; 9730660a898545416f0fea2d717f16f75640001e38Ted Kremenek Hint.BeforePreviousInsertions = BeforePreviousInsertions; 98b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 99b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 1004b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1014b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that removes the given 1024b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// source range. 1030a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner static FixItHint CreateRemoval(CharSourceRange RemoveRange) { 104849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor FixItHint Hint; 105b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.RemoveRange = RemoveRange; 106b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 107b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 1080a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner static FixItHint CreateRemoval(SourceRange RemoveRange) { 1090a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner return CreateRemoval(CharSourceRange::getTokenRange(RemoveRange)); 1100a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner } 1110a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner 1124b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that replaces the given 1134b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// source range with the given code string. 1140a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner static FixItHint CreateReplacement(CharSourceRange RemoveRange, 115686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef Code) { 116849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor FixItHint Hint; 117b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.RemoveRange = RemoveRange; 118b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.CodeToInsert = Code; 119b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 120b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 1210a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner 1220a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner static FixItHint CreateReplacement(SourceRange RemoveRange, 123686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef Code) { 1240a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner return CreateReplacement(CharSourceRange::getTokenRange(RemoveRange), Code); 1250a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner } 1264b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor}; 1274b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 128af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// \brief Concrete class used by the front-end to report problems and issues. 129af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// 130af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// This massages the diagnostics (e.g. handling things like "report warnings 131af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// as errors" and passes them off to the DiagnosticConsumer for reporting to 132af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// the user. DiagnosticsEngine is tied to one translation unit and one 133af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// SourceManager. 134c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmithclass DiagnosticsEngine : public RefCountedBase<DiagnosticsEngine> { 1356bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines DiagnosticsEngine(const DiagnosticsEngine &) LLVM_DELETED_FUNCTION; 1366bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines void operator=(const DiagnosticsEngine &) LLVM_DELETED_FUNCTION; 1376bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 138182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattnerpublic: 139af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief The level of the diagnostic, after it has been through mapping. 140182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner enum Level { 14133e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis Ignored = DiagnosticIDs::Ignored, 14233e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis Note = DiagnosticIDs::Note, 143651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines Remark = DiagnosticIDs::Remark, 14433e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis Warning = DiagnosticIDs::Warning, 14533e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis Error = DiagnosticIDs::Error, 14633e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis Fatal = DiagnosticIDs::Fatal 147182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner }; 1481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1493fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner enum ArgumentKind { 150af50aab0c317462129d73ae8000c6394c718598dJames Dennett ak_std_string, ///< std::string 151af50aab0c317462129d73ae8000c6394c718598dJames Dennett ak_c_string, ///< const char * 152af50aab0c317462129d73ae8000c6394c718598dJames Dennett ak_sint, ///< int 153af50aab0c317462129d73ae8000c6394c718598dJames Dennett ak_uint, ///< unsigned 154651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines ak_tokenkind, ///< enum TokenKind : unsigned 155af50aab0c317462129d73ae8000c6394c718598dJames Dennett ak_identifierinfo, ///< IdentifierInfo 156af50aab0c317462129d73ae8000c6394c718598dJames Dennett ak_qualtype, ///< QualType 157af50aab0c317462129d73ae8000c6394c718598dJames Dennett ak_declarationname, ///< DeclarationName 158af50aab0c317462129d73ae8000c6394c718598dJames Dennett ak_nameddecl, ///< NamedDecl * 159af50aab0c317462129d73ae8000c6394c718598dJames Dennett ak_nestednamespec, ///< NestedNameSpecifier * 160af50aab0c317462129d73ae8000c6394c718598dJames Dennett ak_declcontext, ///< DeclContext * 161651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines ak_qualtype_pair, ///< pair<QualType, QualType> 162651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines ak_attr ///< Attr * 1633fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner }; 1645edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin 165af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Represents on argument value, which is a union discriminated 166af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// by ArgumentKind, with a value. 167b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner typedef std::pair<ArgumentKind, intptr_t> ArgumentValue; 168ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 1691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumpprivate: 17027ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner unsigned char AllExtensionsSilenced; // Used by __extension__ 171b54b276a920246c595a0498da281821eb9d22996Chris Lattner bool IgnoreAllWarnings; // Ignore all warnings: -w 1721e473ccb0e0f6fd1954bef330f7193c1a3fb3ba1Ted Kremenek bool WarningsAsErrors; // Treat warnings like errors. 1731e473ccb0e0f6fd1954bef330f7193c1a3fb3ba1Ted Kremenek bool EnableAllWarnings; // Enable all warnings. 174e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner bool ErrorsAsFatal; // Treat errors like fatal errors. 175b54b276a920246c595a0498da281821eb9d22996Chris Lattner bool SuppressSystemWarnings; // Suppress warnings in system headers. 17681b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor bool SuppressAllDiagnostics; // Suppress all diagnostics. 177246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu bool ElideType; // Elide common types of templates. 178246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu bool PrintTemplateTree; // Print a tree when comparing templates. 179246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu bool ShowColors; // Color printing is enabled. 1805edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin OverloadsShown ShowOverloads; // Which overload candidates to show. 181c100214fdc41a7ea215f75d433eb1cb829fd4330Chris Lattner unsigned ErrorLimit; // Cap of # errors emitted, 0 -> no limit. 182575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor unsigned TemplateBacktraceLimit; // Cap on depth of template backtrace stack, 183575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor // 0 -> no limit. 18408d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith unsigned ConstexprBacktraceLimit; // Cap on depth of constexpr evaluation 18508d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith // backtrace stack, 0 -> no limit. 186ef8225444452a1486bd721f3285301fe84643b00Stephen Hines diag::Severity ExtBehavior; // Map extensions to warnings or errors? 187c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<DiagnosticIDs> Diags; 18802c23ebf41ae2f70da0ba7337e05c51fbfe35f7fDouglas Gregor IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts; 18978ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie DiagnosticConsumer *Client; 19033e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis bool OwnsDiagClient; 19133e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis SourceManager *SourceMgr; 1920827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 193af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Mapping information for diagnostics. 194af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 195af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// Mapping info is packed into four bits per diagnostic. The low three 196ef8225444452a1486bd721f3285301fe84643b00Stephen Hines /// bits are the mapping (an instance of diag::Severity), or zero if unset. 197af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// The high bit is set when the mapping was established as a user mapping. 198af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// If the high bit is clear, then the low bits are set to the default 199af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// value, and should be mapped with -pedantic, -Werror, etc. 2000827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// 2013efd52cf8f4e57c5571bd8cc3168264c3bc46a1eArgyrios Kyrtzidis /// A new DiagState is created and kept around when diagnostic pragmas modify 2023efd52cf8f4e57c5571bd8cc3168264c3bc46a1eArgyrios Kyrtzidis /// the state so that we know what is the diagnostic state at any given 2033efd52cf8f4e57c5571bd8cc3168264c3bc46a1eArgyrios Kyrtzidis /// source location. 2040827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis class DiagState { 205ef8225444452a1486bd721f3285301fe84643b00Stephen Hines llvm::DenseMap<unsigned, DiagnosticMapping> DiagMap; 2063c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer 2073c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer public: 208ef8225444452a1486bd721f3285301fe84643b00Stephen Hines typedef llvm::DenseMap<unsigned, DiagnosticMapping>::iterator iterator; 209ef8225444452a1486bd721f3285301fe84643b00Stephen Hines typedef llvm::DenseMap<unsigned, DiagnosticMapping>::const_iterator 210ef8225444452a1486bd721f3285301fe84643b00Stephen Hines const_iterator; 2113efd52cf8f4e57c5571bd8cc3168264c3bc46a1eArgyrios Kyrtzidis 212ef8225444452a1486bd721f3285301fe84643b00Stephen Hines void setMapping(diag::kind Diag, DiagnosticMapping Info) { 213b1c99c679adb53be8f478d08be83af6c9c22ae4bDaniel Dunbar DiagMap[Diag] = Info; 214b1c99c679adb53be8f478d08be83af6c9c22ae4bDaniel Dunbar } 2153c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer 216ef8225444452a1486bd721f3285301fe84643b00Stephen Hines DiagnosticMapping &getOrAddMapping(diag::kind Diag); 217ba494c64365d78b1cdb6baea4d1e79263389fda9Daniel Dunbar 218ba494c64365d78b1cdb6baea4d1e79263389fda9Daniel Dunbar const_iterator begin() const { return DiagMap.begin(); } 219ba494c64365d78b1cdb6baea4d1e79263389fda9Daniel Dunbar const_iterator end() const { return DiagMap.end(); } 2200827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis }; 2213c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer 2220827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \brief Keeps and automatically disposes all DiagStates that we create. 2230827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis std::list<DiagState> DiagStates; 2240827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 2250827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \brief Represents a point in source where the diagnostic state was 226af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// modified because of a pragma. 227af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 228af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 'Loc' can be null if the point represents the diagnostic state 229af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// modifications done through the command-line. 2300827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis struct DiagStatePoint { 2310827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis DiagState *State; 2320827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis FullSourceLoc Loc; 2330827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis DiagStatePoint(DiagState *State, FullSourceLoc Loc) 2340827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis : State(State), Loc(Loc) { } 2350827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 2360827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis bool operator<(const DiagStatePoint &RHS) const { 2370827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis // If Loc is invalid it means it came from <command-line>, in which case 2380827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis // we regard it as coming before any valid source location. 2390827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis if (RHS.Loc.isInvalid()) 2400827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis return false; 2410827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis if (Loc.isInvalid()) 2420827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis return true; 2430827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis return Loc.isBeforeInTranslationUnitThan(RHS.Loc); 2443c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer } 2453c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer }; 24604ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 247af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief A sorted vector of all DiagStatePoints representing changes in 248af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// diagnostic state due to diagnostic pragmas. 249af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 250af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// The vector is always sorted according to the SourceLocation of the 251af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// DiagStatePoint. 2520827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis typedef std::vector<DiagStatePoint> DiagStatePointsTy; 2530827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis mutable DiagStatePointsTy DiagStatePoints; 2540827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 2550827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \brief Keeps the DiagState that was active during each diagnostic 'push' 2560827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// so we can get back at it when we 'pop'. 2570827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis std::vector<DiagState *> DiagStateOnPushStack; 2580827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 2590827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis DiagState *GetCurDiagState() const { 2600827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis assert(!DiagStatePoints.empty()); 2610827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis return DiagStatePoints.back().State; 2620827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis } 2630827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 2640827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis void PushDiagStatePoint(DiagState *State, SourceLocation L) { 26500aae5243d965aa7bcee81a39ba0900c7869be21Richard Smith FullSourceLoc Loc(L, getSourceManager()); 2660827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis // Make sure that DiagStatePoints is always sorted according to Loc. 26700aae5243d965aa7bcee81a39ba0900c7869be21Richard Smith assert(Loc.isValid() && "Adding invalid loc point"); 26800aae5243d965aa7bcee81a39ba0900c7869be21Richard Smith assert(!DiagStatePoints.empty() && 26900aae5243d965aa7bcee81a39ba0900c7869be21Richard Smith (DiagStatePoints.back().Loc.isInvalid() || 2700827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis DiagStatePoints.back().Loc.isBeforeInTranslationUnitThan(Loc)) && 2710827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis "Previous point loc comes after or is the same as new one"); 27200aae5243d965aa7bcee81a39ba0900c7869be21Richard Smith DiagStatePoints.push_back(DiagStatePoint(State, Loc)); 2730827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis } 2740827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 2750827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \brief Finds the DiagStatePoint that contains the diagnostic state of 2760827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// the given source location. 2770827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis DiagStatePointsTy::iterator GetDiagStatePointForLoc(SourceLocation Loc) const; 27804ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 279af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Sticky flag set to \c true when an error is emitted. 2805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ErrorOccurred; 281af50aab0c317462129d73ae8000c6394c718598dJames Dennett 28212f37e411462b8388eb1309357bd62257debacacDeLesley Hutchins /// \brief Sticky flag set to \c true when an "uncompilable error" occurs. 28312f37e411462b8388eb1309357bd62257debacacDeLesley Hutchins /// I.e. an error that was not upgraded from a warning by -Werror. 28412f37e411462b8388eb1309357bd62257debacacDeLesley Hutchins bool UncompilableErrorOccurred; 28512f37e411462b8388eb1309357bd62257debacacDeLesley Hutchins 286af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Sticky flag set to \c true when a fatal error is emitted. 28715221422eda7bac679e38b07512feda49715ef66Chris Lattner bool FatalErrorOccurred; 2881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 28985bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor /// \brief Indicates that an unrecoverable error has occurred. 29085bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor bool UnrecoverableErrorOccurred; 29185bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor 292c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis /// \brief Counts for DiagnosticErrorTrap to check whether an error occurred 293add80bb3957dba1d9389304453c0a4c975768bd7John McCall /// during a parsing section, e.g. during parsing a function. 294c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis unsigned TrapNumErrorsOccurred; 295c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis unsigned TrapNumUnrecoverableErrorsOccurred; 296add80bb3957dba1d9389304453c0a4c975768bd7John McCall 297af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief The level of the last diagnostic emitted. 298af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 299af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// This is used to emit continuation diagnostics with the same level as the 300f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// diagnostic that they follow. 30133e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis DiagnosticIDs::Level LastDiagLevel; 3025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 303af50aab0c317462129d73ae8000c6394c718598dJames Dennett unsigned NumWarnings; ///< Number of warnings reported 304af50aab0c317462129d73ae8000c6394c718598dJames Dennett unsigned NumErrors; ///< Number of errors reported 305af50aab0c317462129d73ae8000c6394c718598dJames Dennett unsigned NumErrorsSuppressed; ///< Number of errors suppressed 3067bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber 307af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief A function pointer that converts an opaque diagnostic 308af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// argument to a strings. 309af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 310af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// This takes the modifiers and argument that was present in the diagnostic. 311b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// 312ef8225444452a1486bd721f3285301fe84643b00Stephen Hines /// The PrevArgs array indicates the previous arguments formatted for this 313ef8225444452a1486bd721f3285301fe84643b00Stephen Hines /// diagnostic. Implementations of this function can use this information to 314ef8225444452a1486bd721f3285301fe84643b00Stephen Hines /// avoid redundancy across arguments. 315b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// 31622caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner /// This is a hack to avoid a layering violation between libbasic and libsema. 3170673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth typedef void (*ArgToStringFnTy)( 3180673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth ArgumentKind Kind, intptr_t Val, 319ef8225444452a1486bd721f3285301fe84643b00Stephen Hines StringRef Modifier, StringRef Argument, 320ef8225444452a1486bd721f3285301fe84643b00Stephen Hines ArrayRef<ArgumentValue> PrevArgs, 321686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<char> &Output, 3220673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth void *Cookie, 323341785ec52f87c0803ba52dc88faac4e136f8593Bill Wendling ArrayRef<intptr_t> QualTypeVals); 32492dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner void *ArgToStringCookie; 3253fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ArgToStringFnTy ArgToStringFn; 32693ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 32793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief ID of the "delayed" diagnostic, which is a (typically 32893ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// fatal) diagnostic that had to be delayed because it was found 32993ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// while emitting another diagnostic. 33093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor unsigned DelayedDiagID; 33193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 33293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief First string argument for the delayed diagnostic. 33393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor std::string DelayedDiagArg1; 33493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 33593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief Second string argument for the delayed diagnostic. 33693ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor std::string DelayedDiagArg2; 33793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 338ef8225444452a1486bd721f3285301fe84643b00Stephen Hines /// \brief Optional flag value. 3396bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines /// 340ef8225444452a1486bd721f3285301fe84643b00Stephen Hines /// Some flags accept values, for instance: -Wframe-larger-than=<value> and 341ef8225444452a1486bd721f3285301fe84643b00Stephen Hines /// -Rpass=<value>. The content of this string is emitted after the flag name 342ef8225444452a1486bd721f3285301fe84643b00Stephen Hines /// and '='. 343ef8225444452a1486bd721f3285301fe84643b00Stephen Hines std::string FlagValue; 3446bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 3455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 346d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie explicit DiagnosticsEngine( 347c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith const IntrusiveRefCntPtr<DiagnosticIDs> &Diags, 34802c23ebf41ae2f70da0ba7337e05c51fbfe35f7fDouglas Gregor DiagnosticOptions *DiagOpts, 3496bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines DiagnosticConsumer *client = nullptr, 35033e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis bool ShouldOwnClient = true); 351d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie ~DiagnosticsEngine(); 3521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 353c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith const IntrusiveRefCntPtr<DiagnosticIDs> &getDiagnosticIDs() const { 35433e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return Diags; 35533e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis } 35633e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis 35702c23ebf41ae2f70da0ba7337e05c51fbfe35f7fDouglas Gregor /// \brief Retrieve the diagnostic options. 35802c23ebf41ae2f70da0ba7337e05c51fbfe35f7fDouglas Gregor DiagnosticOptions &getDiagnosticOptions() const { return *DiagOpts; } 35902c23ebf41ae2f70da0ba7337e05c51fbfe35f7fDouglas Gregor 3606bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines typedef llvm::iterator_range<DiagState::const_iterator> diag_mapping_range; 3616bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 3626bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines /// \brief Get the current set of diagnostic mappings. 3636bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines diag_mapping_range getDiagnosticMappings() const { 3646bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines const DiagState &DS = *GetCurDiagState(); 3656bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines return diag_mapping_range(DS.begin(), DS.end()); 3666bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines } 3676bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 36878ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie DiagnosticConsumer *getClient() { return Client; } 36978ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie const DiagnosticConsumer *getClient() const { return Client; } 3701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 371d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie /// \brief Determine whether this \c DiagnosticsEngine object own its client. 37278243658c533168d51fd076fba328437932ba6f1Douglas Gregor bool ownsClient() const { return OwnsDiagClient; } 37378243658c533168d51fd076fba328437932ba6f1Douglas Gregor 374bdbb004f38978da0c4a75af3294d1c7b5ff84af1Douglas Gregor /// \brief Return the current diagnostic client along with ownership of that 375bdbb004f38978da0c4a75af3294d1c7b5ff84af1Douglas Gregor /// client. 37678ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie DiagnosticConsumer *takeClient() { 37733e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis OwnsDiagClient = false; 37833e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return Client; 37933e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis } 38033e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis 3816bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines bool hasSourceManager() const { return SourceMgr != nullptr; } 38233e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis SourceManager &getSourceManager() const { 38333e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis assert(SourceMgr && "SourceManager not set!"); 38433e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return *SourceMgr; 38533e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis } 38633e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis void setSourceManager(SourceManager *SrcMgr) { SourceMgr = SrcMgr; } 38733e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis 38833e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis //===--------------------------------------------------------------------===// 389d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie // DiagnosticsEngine characterization methods, used by a client to customize 390d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie // how diagnostics are emitted. 39133e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis // 39204ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 393af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Copies the current DiagMappings and pushes the new copy 39404ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// onto the top of the stack. 3950827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis void pushMappings(SourceLocation Loc); 39604ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 397af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Pops the current DiagMappings off the top of the stack, 398af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// causing the new top of the stack to be the active mappings. 399af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 400af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \returns \c true if the pop happens, \c false if there is only one 401af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// DiagMapping on the stack. 4020827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis bool popMappings(SourceLocation Loc); 40304ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 404bdbb004f38978da0c4a75af3294d1c7b5ff84af1Douglas Gregor /// \brief Set the diagnostic client associated with this diagnostic object. 405bdbb004f38978da0c4a75af3294d1c7b5ff84af1Douglas Gregor /// 40633e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis /// \param ShouldOwnClient true if the diagnostic object should take 40733e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis /// ownership of \c client. 40878ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie void setClient(DiagnosticConsumer *client, bool ShouldOwnClient = true); 4095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 410af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Specify a limit for the number of errors we should 411af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// emit before giving up. 412af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 413af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// Zero disables the limit. 414c100214fdc41a7ea215f75d433eb1cb829fd4330Chris Lattner void setErrorLimit(unsigned Limit) { ErrorLimit = Limit; } 415b205ac9fcd22b87b41697172d1983c5ae9dabaafChris Lattner 416575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor /// \brief Specify the maximum number of template instantiation 417575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor /// notes to emit along with a given diagnostic. 418575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor void setTemplateBacktraceLimit(unsigned Limit) { 419575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor TemplateBacktraceLimit = Limit; 420575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor } 42108d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith 422575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor /// \brief Retrieve the maximum number of template instantiation 42308d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith /// notes to emit along with a given diagnostic. 424575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor unsigned getTemplateBacktraceLimit() const { 425575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor return TemplateBacktraceLimit; 426575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor } 42708d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith 42808d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith /// \brief Specify the maximum number of constexpr evaluation 42908d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith /// notes to emit along with a given diagnostic. 43008d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith void setConstexprBacktraceLimit(unsigned Limit) { 43108d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith ConstexprBacktraceLimit = Limit; 43208d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith } 43308d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith 43408d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith /// \brief Retrieve the maximum number of constexpr evaluation 43508d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith /// notes to emit along with a given diagnostic. 43608d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith unsigned getConstexprBacktraceLimit() const { 43708d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith return ConstexprBacktraceLimit; 43808d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith } 43908d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith 440af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief When set to true, any unmapped warnings are ignored. 441af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 442af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// If this and WarningsAsErrors are both set, then this one wins. 4435b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner void setIgnoreAllWarnings(bool Val) { IgnoreAllWarnings = Val; } 4445b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner bool getIgnoreAllWarnings() const { return IgnoreAllWarnings; } 4451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 446af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief When set to true, any unmapped ignored warnings are no longer 447af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// ignored. 448af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 449af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// If this and IgnoreAllWarnings are both set, then that one wins. 4501e473ccb0e0f6fd1954bef330f7193c1a3fb3ba1Ted Kremenek void setEnableAllWarnings(bool Val) { EnableAllWarnings = Val; } 45104863a86d15cb8de3361f8c77cedfd025819f174Benjamin Kramer bool getEnableAllWarnings() const { return EnableAllWarnings; } 45204863a86d15cb8de3361f8c77cedfd025819f174Benjamin Kramer 453af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief When set to true, any warnings reported are issued as errors. 4545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setWarningsAsErrors(bool Val) { WarningsAsErrors = Val; } 4555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getWarningsAsErrors() const { return WarningsAsErrors; } 4561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 457af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief When set to true, any error reported is made a fatal error. 458e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner void setErrorsAsFatal(bool Val) { ErrorsAsFatal = Val; } 459e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner bool getErrorsAsFatal() const { return ErrorsAsFatal; } 460e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner 461af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief When set to true mask warnings that come from system headers. 4622fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar void setSuppressSystemWarnings(bool Val) { SuppressSystemWarnings = Val; } 4632fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar bool getSuppressSystemWarnings() const { return SuppressSystemWarnings; } 4642fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar 46581b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor /// \brief Suppress all diagnostics, to silence the front end when we 46681b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor /// know that we don't want any more diagnostics to be passed along to the 46781b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor /// client 46881b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor void setSuppressAllDiagnostics(bool Val = true) { 46981b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor SuppressAllDiagnostics = Val; 47081b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor } 47181b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor bool getSuppressAllDiagnostics() const { return SuppressAllDiagnostics; } 472246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu 473246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu /// \brief Set type eliding, to skip outputting same types occurring in 474246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu /// template types. 475246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu void setElideType(bool Val = true) { ElideType = Val; } 476246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu bool getElideType() { return ElideType; } 477246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu 478246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu /// \brief Set tree printing, to outputting the template difference in a 479246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu /// tree format. 480246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu void setPrintTemplateTree(bool Val = false) { PrintTemplateTree = Val; } 481246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu bool getPrintTemplateTree() { return PrintTemplateTree; } 482246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu 483246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu /// \brief Set color printing, so the type diffing will inject color markers 484246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu /// into the output. 485246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu void setShowColors(bool Val = false) { ShowColors = Val; } 486246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu bool getShowColors() { return ShowColors; } 487246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu 4885edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin /// \brief Specify which overload candidates to show when overload resolution 489af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// fails. 490af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 491af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// By default, we show all candidates. 4925edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin void setShowOverloads(OverloadsShown Val) { 4935edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin ShowOverloads = Val; 4945edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin } 4955edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin OverloadsShown getShowOverloads() const { return ShowOverloads; } 4965edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin 4975d99a252c63a7745bcd71231ca5240d2a65e4f1dRichard Smith /// \brief Pretend that the last diagnostic issued was ignored, so any 4985d99a252c63a7745bcd71231ca5240d2a65e4f1dRichard Smith /// subsequent notes will be suppressed. 499af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 500af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// This can be used by clients who suppress diagnostics themselves. 5010b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor void setLastDiagnosticIgnored() { 5025d99a252c63a7745bcd71231ca5240d2a65e4f1dRichard Smith if (LastDiagLevel == DiagnosticIDs::Fatal) 5035d99a252c63a7745bcd71231ca5240d2a65e4f1dRichard Smith FatalErrorOccurred = true; 50433e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis LastDiagLevel = DiagnosticIDs::Ignored; 5050b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor } 506cbc820af7193e3ad9c71fbe6e3c8bd3c1166e540Richard Smith 507cbc820af7193e3ad9c71fbe6e3c8bd3c1166e540Richard Smith /// \brief Determine whether the previous diagnostic was ignored. This can 508cbc820af7193e3ad9c71fbe6e3c8bd3c1166e540Richard Smith /// be used by clients that want to determine whether notes attached to a 509cbc820af7193e3ad9c71fbe6e3c8bd3c1166e540Richard Smith /// diagnostic will be suppressed. 510cbc820af7193e3ad9c71fbe6e3c8bd3c1166e540Richard Smith bool isLastDiagnosticIgnored() const { 511cbc820af7193e3ad9c71fbe6e3c8bd3c1166e540Richard Smith return LastDiagLevel == DiagnosticIDs::Ignored; 512cbc820af7193e3ad9c71fbe6e3c8bd3c1166e540Richard Smith } 513cbc820af7193e3ad9c71fbe6e3c8bd3c1166e540Richard Smith 514af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Controls whether otherwise-unmapped extension diagnostics are 515af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// mapped onto ignore/warning/error. 516af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 517af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// This corresponds to the GCC -pedantic and -pedantic-errors option. 518ef8225444452a1486bd721f3285301fe84643b00Stephen Hines void setExtensionHandlingBehavior(diag::Severity H) { ExtBehavior = H; } 519ef8225444452a1486bd721f3285301fe84643b00Stephen Hines diag::Severity getExtensionHandlingBehavior() const { return ExtBehavior; } 5201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 521af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Counter bumped when an __extension__ block is/ encountered. 522af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 523af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// When non-zero, all extension diagnostics are entirely silenced, no 524af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// matter how they are mapped. 52527ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner void IncrementAllExtensionsSilenced() { ++AllExtensionsSilenced; } 52627ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner void DecrementAllExtensionsSilenced() { --AllExtensionsSilenced; } 52791a2886d558ea6ca7a0bed73ab5acea5ae78eac2Douglas Gregor bool hasAllExtensionsSilenced() { return AllExtensionsSilenced != 0; } 5281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 529697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief This allows the client to specify that certain warnings are 530697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// ignored. 531697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 532697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// Notes can never be mapped, errors can only be mapped to fatal, and 533697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// WARNINGs and EXTENSIONs can be mapped arbitrarily. 5340827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// 5350827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \param Loc The source location that this change of diagnostic state should 5360827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// take affect. It can be null if we are setting the latest state. 537ef8225444452a1486bd721f3285301fe84643b00Stephen Hines void setSeverity(diag::kind Diag, diag::Severity Map, SourceLocation Loc); 5381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 539697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Change an entire diagnostic group (e.g. "unknown-pragmas") to 540697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// have the specified mapping. 541697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 542697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \returns true (and ignores the request) if "Group" was unknown, false 543697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// otherwise. 5440827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// 545697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \param Loc The source location that this change of diagnostic state should 5460827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// take affect. It can be null if we are setting the state from command-line. 547ef8225444452a1486bd721f3285301fe84643b00Stephen Hines bool setSeverityForGroup(StringRef Group, diag::Severity Map, 548ef8225444452a1486bd721f3285301fe84643b00Stephen Hines SourceLocation Loc = SourceLocation()); 5495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 550697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Set the warning-as-error flag for the given diagnostic group. 551697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 552697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// This function always only operates on the current diagnostic state. 5534aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar /// 5544aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar /// \returns True if the given group is unknown, false otherwise. 5554aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar bool setDiagnosticGroupWarningAsError(StringRef Group, bool Enabled); 5564aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar 557697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Set the error-as-fatal flag for the given diagnostic group. 558697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 559697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// This function always only operates on the current diagnostic state. 5604aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar /// 5614aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar /// \returns True if the given group is unknown, false otherwise. 5624aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar bool setDiagnosticGroupErrorAsFatal(StringRef Group, bool Enabled); 5634aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar 564697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Add the specified mapping to all diagnostics. 565697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 566697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// Mainly to be used by -Wno-everything to disable all warnings but allow 567697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// subsequent -W options to enable specific warnings. 568ef8225444452a1486bd721f3285301fe84643b00Stephen Hines void setSeverityForAll(diag::Severity Map, 569ef8225444452a1486bd721f3285301fe84643b00Stephen Hines SourceLocation Loc = SourceLocation()); 57011583c757bac6ce5c342f2eb572055dd2619a657Argyrios Kyrtzidis 5715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool hasErrorOccurred() const { return ErrorOccurred; } 57212f37e411462b8388eb1309357bd62257debacacDeLesley Hutchins 57312f37e411462b8388eb1309357bd62257debacacDeLesley Hutchins /// \brief Errors that actually prevent compilation, not those that are 57412f37e411462b8388eb1309357bd62257debacacDeLesley Hutchins /// upgraded from a warning by -Werror. 57512f37e411462b8388eb1309357bd62257debacacDeLesley Hutchins bool hasUncompilableErrorOccurred() const { 57612f37e411462b8388eb1309357bd62257debacacDeLesley Hutchins return UncompilableErrorOccurred; 57712f37e411462b8388eb1309357bd62257debacacDeLesley Hutchins } 57815221422eda7bac679e38b07512feda49715ef66Chris Lattner bool hasFatalErrorOccurred() const { return FatalErrorOccurred; } 57985bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor 58085bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor /// \brief Determine whether any kind of unrecoverable error has occurred. 58185bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor bool hasUnrecoverableErrorOccurred() const { 58285bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor return FatalErrorOccurred || UnrecoverableErrorOccurred; 58385bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor } 58485bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor 58553eee7ba970d21ff15bbd4334164037a3b4cc4b8Chris Lattner unsigned getNumWarnings() const { return NumWarnings; } 5861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 587c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor void setNumWarnings(unsigned NumWarnings) { 588c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor this->NumWarnings = NumWarnings; 589c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor } 590c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 591651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines /// \brief Return an ID for a diagnostic with the specified format string and 592651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines /// level. 593697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 594fc09336a5965040736f9bc63a70416003972364eStefanus Du Toit /// If this is the first request for this diagnostic, it is registered and 595697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// created, otherwise the existing ID is returned. 596651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines /// 597651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines /// \param FormatString A fixed diagnostic format string that will be hashed 598651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines /// and mapped to a unique DiagID. 599651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines template <unsigned N> 600651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines unsigned getCustomDiagID(Level L, const char (&FormatString)[N]) { 601651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines return Diags->getCustomDiagID((DiagnosticIDs::Level)L, 602651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines StringRef(FormatString, N - 1)); 60333e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis } 6041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 605697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Converts a diagnostic argument (as an intptr_t) into the string 606697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// that represents it. 6073fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner void ConvertArgToString(ArgumentKind Kind, intptr_t Val, 608ef8225444452a1486bd721f3285301fe84643b00Stephen Hines StringRef Modifier, StringRef Argument, 609ef8225444452a1486bd721f3285301fe84643b00Stephen Hines ArrayRef<ArgumentValue> PrevArgs, 610686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<char> &Output, 6114def70d3040e73707c738f7c366737a986135edfRichard Smith ArrayRef<intptr_t> QualTypeVals) const { 612ef8225444452a1486bd721f3285301fe84643b00Stephen Hines ArgToStringFn(Kind, Val, Modifier, Argument, PrevArgs, Output, 613ef8225444452a1486bd721f3285301fe84643b00Stephen Hines ArgToStringCookie, QualTypeVals); 61422caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 6151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 61692dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner void SetArgToStringFn(ArgToStringFnTy Fn, void *Cookie) { 6173fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ArgToStringFn = Fn; 61892dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner ArgToStringCookie = Cookie; 61922caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 6201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6215b9268f26ac53a74d2c504279fe577d988d5615dRichard Smith /// \brief Note that the prior diagnostic was emitted by some other 6225b9268f26ac53a74d2c504279fe577d988d5615dRichard Smith /// \c DiagnosticsEngine, and we may be attaching a note to that diagnostic. 6235b9268f26ac53a74d2c504279fe577d988d5615dRichard Smith void notePriorDiagnosticFrom(const DiagnosticsEngine &Other) { 6245b9268f26ac53a74d2c504279fe577d988d5615dRichard Smith LastDiagLevel = Other.LastDiagLevel; 6255b9268f26ac53a74d2c504279fe577d988d5615dRichard Smith } 6265b9268f26ac53a74d2c504279fe577d988d5615dRichard Smith 627abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \brief Reset the state of the diagnostic object to its initial 628abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// configuration. 629abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor void Reset(); 630abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor 6315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 632d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie // DiagnosticsEngine classification and reporting interfaces. 6335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // 6345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 635ef8225444452a1486bd721f3285301fe84643b00Stephen Hines /// \brief Determine whether the diagnostic is known to be ignored. 636ef8225444452a1486bd721f3285301fe84643b00Stephen Hines /// 637ef8225444452a1486bd721f3285301fe84643b00Stephen Hines /// This can be used to opportunistically avoid expensive checks when it's 638ef8225444452a1486bd721f3285301fe84643b00Stephen Hines /// known for certain that the diagnostic has been suppressed at the 639ef8225444452a1486bd721f3285301fe84643b00Stephen Hines /// specified location \p Loc. 640ef8225444452a1486bd721f3285301fe84643b00Stephen Hines /// 641ef8225444452a1486bd721f3285301fe84643b00Stephen Hines /// \param Loc The source location we are interested in finding out the 642ef8225444452a1486bd721f3285301fe84643b00Stephen Hines /// diagnostic state. Can be null in order to query the latest state. 643ef8225444452a1486bd721f3285301fe84643b00Stephen Hines bool isIgnored(unsigned DiagID, SourceLocation Loc) const { 644ef8225444452a1486bd721f3285301fe84643b00Stephen Hines return Diags->getDiagnosticSeverity(DiagID, Loc, *this) == 645ef8225444452a1486bd721f3285301fe84643b00Stephen Hines diag::Severity::Ignored; 646ef8225444452a1486bd721f3285301fe84643b00Stephen Hines } 647ef8225444452a1486bd721f3285301fe84643b00Stephen Hines 648d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie /// \brief Based on the way the client configured the DiagnosticsEngine 6495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// object, classify the specified diagnostic ID into a Level, consumable by 65078ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie /// the DiagnosticConsumer. 6510827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// 652ef8225444452a1486bd721f3285301fe84643b00Stephen Hines /// To preserve invariant assumptions, this function should not be used to 653ef8225444452a1486bd721f3285301fe84643b00Stephen Hines /// influence parse or semantic analysis actions. Instead consider using 654ef8225444452a1486bd721f3285301fe84643b00Stephen Hines /// \c isIgnored(). 655ef8225444452a1486bd721f3285301fe84643b00Stephen Hines /// 6560827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \param Loc The source location we are interested in finding out the 6570827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// diagnostic state. Can be null in order to query the latest state. 6581656aaec223949245fdbebf306b719cba0b687caDaniel Dunbar Level getDiagnosticLevel(unsigned DiagID, SourceLocation Loc) const { 6591656aaec223949245fdbebf306b719cba0b687caDaniel Dunbar return (Level)Diags->getDiagnosticLevel(DiagID, Loc, *this); 66033e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis } 6611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 662697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Issue the message to the client. 663697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 664697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// This actually returns an instance of DiagnosticBuilder which emits the 665697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// diagnostics (through @c ProcessDiag) when it is destroyed. 666697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 667697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \param DiagID A member of the @c diag::kind enum. 668efce31f51d6e7e31e125f96c20f6cdab3ead0a47James Dennett /// \param Loc Represents the source location associated with the diagnostic, 669509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// which can be an invalid location if no position information is available. 670efce31f51d6e7e31e125f96c20f6cdab3ead0a47James Dennett inline DiagnosticBuilder Report(SourceLocation Loc, unsigned DiagID); 6710f9fed70cea107b3f79df554e38bd8e98d48fe47Daniel Dunbar inline DiagnosticBuilder Report(unsigned DiagID); 672de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor 673e59abb56ce0e1c206fb80bd945a0c358b0abe1efArgyrios Kyrtzidis void Report(const StoredDiagnostic &storedDiag); 674e59abb56ce0e1c206fb80bd945a0c358b0abe1efArgyrios Kyrtzidis 67593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief Determine whethere there is already a diagnostic in flight. 6765800f7ea9cf5621280089d690f677bd28064d6b5Ted Kremenek bool isDiagnosticInFlight() const { return CurDiagID != ~0U; } 67793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 67893ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief Set the "delayed" diagnostic that will be emitted once 67993ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// the current diagnostic completes. 68093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// 68193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// If a diagnostic is already in-flight but the front end must 68293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// report a problem (e.g., with an inconsistent file system 68393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// state), this routine sets a "delayed" diagnostic that will be 68493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// emitted after the current diagnostic completes. This should 68593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// only be used for fatal errors detected at inconvenient 68693ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// times. If emitting a delayed diagnostic causes a second delayed 68793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// diagnostic to be introduced, that second delayed diagnostic 68893ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// will be ignored. 68993ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// 69093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \param DiagID The ID of the diagnostic being delayed. 69193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// 69293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \param Arg1 A string argument that will be provided to the 69393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// diagnostic. A copy of this string will be stored in the 694d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie /// DiagnosticsEngine object itself. 69593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// 69693ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \param Arg2 A string argument that will be provided to the 69793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// diagnostic. A copy of this string will be stored in the 698d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie /// DiagnosticsEngine object itself. 699686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void SetDelayedDiagnostic(unsigned DiagID, StringRef Arg1 = "", 700686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef Arg2 = ""); 70193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 702de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor /// \brief Clear out the current diagnostic. 703de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor void Clear() { CurDiagID = ~0U; } 7041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 705ef8225444452a1486bd721f3285301fe84643b00Stephen Hines /// \brief Return the value associated with this diagnostic flag. 706ef8225444452a1486bd721f3285301fe84643b00Stephen Hines StringRef getFlagValue() const { return FlagValue; } 7076bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 7080a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattnerprivate: 70993ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief Report the delayed diagnostic. 71093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor void ReportDelayed(); 71193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 7123cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner // This is private state used by DiagnosticBuilder. We put it here instead of 7133cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner // in DiagnosticBuilder in order to keep DiagnosticBuilder a small lightweight 7140a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // object. This implementation choice means that we can only have one 7150a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // diagnostic "in flight" at a time, but this seems to be a reasonable 7160a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // tradeoff to keep these objects small. Assertions verify that only one 7170a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // diagnostic is in flight at a time. 71833e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis friend class DiagnosticIDs; 7193cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner friend class DiagnosticBuilder; 72040847cfb58acc3cac7d68727df9455ac45f2e118David Blaikie friend class Diagnostic; 7219b623639378d53a675921ddfa7316034d571881eDouglas Gregor friend class PartialDiagnostic; 7229c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis friend class DiagnosticErrorTrap; 7239b623639378d53a675921ddfa7316034d571881eDouglas Gregor 724697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief The location of the current diagnostic that is in flight. 72533e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis SourceLocation CurDiagLoc; 7261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 727697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief The ID of the current diagnostic that is in flight. 728697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 7293cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// This is set to ~0U when there is no diagnostic in flight. 730b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner unsigned CurDiagID; 731b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner 73273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner enum { 733697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief The maximum number of arguments we can hold. 734697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 735af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// We currently only support up to 10 arguments (%0-%9). A single 736af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// diagnostic with more than that almost certainly has to be simplified 737af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// anyway. 738981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar MaxArguments = 10, 73973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner }; 7401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 741697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief The number of entries in Arguments. 742730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner signed char NumDiagArgs; 743ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 744af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Specifies whether an argument is in DiagArgumentsStr or 745af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// in DiagArguments. 746af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 747af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// This is an array of ArgumentKind::ArgumentKind enum values, one for each 748af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// argument. 74973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner unsigned char DiagArgumentsKind[MaxArguments]; 7501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 751af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Holds the values of each string argument for the current 752697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// diagnostic. 753697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 754697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// This is only used when the corresponding ArgumentKind is ak_std_string. 75573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner std::string DiagArgumentsStr[MaxArguments]; 75673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 757697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief The values for the various substitution positions. 758697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 759697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// This is used when the argument is not an std::string. The specific 760697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// value is mangled into an intptr_t and the interpretation depends on 761697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// exactly what sort of argument kind it is. 76273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner intptr_t DiagArgumentsVal[MaxArguments]; 7631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 764697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief The list of ranges added to this diagnostic. 7656bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines SmallVector<CharSourceRange, 8> DiagRanges; 7661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 767697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief If valid, provides a hint with some code to insert, remove, 768981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar /// or modify at a particular position. 7696bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines SmallVector<FixItHint, 8> DiagFixItHints; 7704b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 771ef8225444452a1486bd721f3285301fe84643b00Stephen Hines DiagnosticMapping makeUserMapping(diag::Severity Map, SourceLocation L) { 77287429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis bool isPragma = L.isValid(); 773ef8225444452a1486bd721f3285301fe84643b00Stephen Hines DiagnosticMapping Mapping = 774ef8225444452a1486bd721f3285301fe84643b00Stephen Hines DiagnosticMapping::Make(Map, /*IsUser=*/true, isPragma); 77587429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis 77687429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis // If this is a pragma mapping, then set the diagnostic mapping flags so 77787429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis // that we override command line options. 77887429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis if (isPragma) { 779ef8225444452a1486bd721f3285301fe84643b00Stephen Hines Mapping.setNoWarningAsError(true); 780ef8225444452a1486bd721f3285301fe84643b00Stephen Hines Mapping.setNoErrorAsFatal(true); 78187429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis } 78287429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis 783ef8225444452a1486bd721f3285301fe84643b00Stephen Hines return Mapping; 78487429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis } 78587429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis 786697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Used to report a diagnostic that is finally fully formed. 7875e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// 788697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \returns true if the diagnostic was emitted, false if it was suppressed. 78933e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis bool ProcessDiag() { 79033e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return Diags->ProcessDiag(*this); 79133e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis } 792f41d3be39980d40849850d3fb90403623cc8459eArgyrios Kyrtzidis 793393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar /// @name Diagnostic Emission 794393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar /// @{ 795393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbarprotected: 796393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar // Sema requires access to the following functions because the current design 797393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar // of SFINAE requires it to use its own SemaDiagnosticBuilder, which needs to 798393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar // access us directly to ensure we minimize the emitted code for the common 799393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar // Sema::Diag() patterns. 800393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar friend class Sema; 801393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar 8023054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar /// \brief Emit the current diagnostic and clear the diagnostic state. 803c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose /// 804c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose /// \param Force Emit the diagnostic regardless of suppression settings. 805c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose bool EmitCurrentDiagnostic(bool Force = false); 8063054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar 807393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar unsigned getCurrentDiagID() const { return CurDiagID; } 808393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar 809393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar SourceLocation getCurrentDiagLoc() const { return CurDiagLoc; } 810393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar 811393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar /// @} 812393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar 813f41d3be39980d40849850d3fb90403623cc8459eArgyrios Kyrtzidis friend class ASTReader; 814f41d3be39980d40849850d3fb90403623cc8459eArgyrios Kyrtzidis friend class ASTWriter; 8153cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}; 8163cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 8179c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis/// \brief RAII class that determines when any errors have occurred 8189c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis/// between the time the instance was created and the time it was 8199c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis/// queried. 8209c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidisclass DiagnosticErrorTrap { 821d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine &Diag; 822c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis unsigned NumErrors; 823c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis unsigned NumUnrecoverableErrors; 8249c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis 8259c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidispublic: 826d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie explicit DiagnosticErrorTrap(DiagnosticsEngine &Diag) 827add80bb3957dba1d9389304453c0a4c975768bd7John McCall : Diag(Diag) { reset(); } 8289c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis 8299c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis /// \brief Determine whether any errors have occurred since this 8309c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis /// object instance was created. 8319c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis bool hasErrorOccurred() const { 832c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis return Diag.TrapNumErrorsOccurred > NumErrors; 833add80bb3957dba1d9389304453c0a4c975768bd7John McCall } 834add80bb3957dba1d9389304453c0a4c975768bd7John McCall 835add80bb3957dba1d9389304453c0a4c975768bd7John McCall /// \brief Determine whether any unrecoverable errors have occurred since this 836add80bb3957dba1d9389304453c0a4c975768bd7John McCall /// object instance was created. 837add80bb3957dba1d9389304453c0a4c975768bd7John McCall bool hasUnrecoverableErrorOccurred() const { 838c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis return Diag.TrapNumUnrecoverableErrorsOccurred > NumUnrecoverableErrors; 8399c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis } 8409c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis 841af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Set to initial state of "no errors occurred". 842add80bb3957dba1d9389304453c0a4c975768bd7John McCall void reset() { 843c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis NumErrors = Diag.TrapNumErrorsOccurred; 844c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis NumUnrecoverableErrors = Diag.TrapNumUnrecoverableErrorsOccurred; 845add80bb3957dba1d9389304453c0a4c975768bd7John McCall } 8469c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis}; 8479c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis 8483cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 8493cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner// DiagnosticBuilder 8503cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 8513cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 852697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// \brief A little helper class used to produce diagnostics. 853697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// 854697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// This is constructed by the DiagnosticsEngine::Report method, and 855697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// allows insertion of extra information (arguments and source ranges) into 856697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// the currently "in flight" diagnostic. When the temporary for the builder 857697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// is destroyed, the diagnostic is issued. 8583cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// 8593cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// Note that many of these will be created as temporary objects (many call 8603cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// sites), so we want them to be small and we never want their address taken. 8613cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// This ensures that compilers with somewhat reasonable optimizers will promote 8623cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// the common fields to registers, eliminating increments of the NumArgs field, 8633cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// for example. 8643cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerclass DiagnosticBuilder { 865d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie mutable DiagnosticsEngine *DiagObj; 8666bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines mutable unsigned NumArgs; 8671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8687059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar /// \brief Status variable indicating if this diagnostic is still active. 8697059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar /// 870f3477c13eeaf11b32a41f181398fb5deffd0dd73Sylvestre Ledru // NOTE: This field is redundant with DiagObj (IsActive iff (DiagObj == 0)), 8717059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar // but LLVM is not currently smart enough to eliminate the null check that 8727059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar // Emit() would end up with if we used that as our status variable. 8737059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar mutable bool IsActive; 8747059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar 875c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose /// \brief Flag indicating that this diagnostic is being emitted via a 876c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose /// call to ForceEmit. 877c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose mutable bool IsForceEmit; 878c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose 879f56faa01936b9cf909623d7f06e3c2569ca4a78eDmitri Gribenko void operator=(const DiagnosticBuilder &) LLVM_DELETED_FUNCTION; 880d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie friend class DiagnosticsEngine; 8816bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 882ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor DiagnosticBuilder() 8836bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines : DiagObj(nullptr), NumArgs(0), IsActive(false), IsForceEmit(false) {} 884ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor 885d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie explicit DiagnosticBuilder(DiagnosticsEngine *diagObj) 8866bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines : DiagObj(diagObj), NumArgs(0), IsActive(true), IsForceEmit(false) { 887981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar assert(diagObj && "DiagnosticBuilder requires a valid DiagnosticsEngine!"); 8886bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines diagObj->DiagRanges.clear(); 8896bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines diagObj->DiagFixItHints.clear(); 890cbf46a0b2bb2b47d6e13437e0d52cc583c5ce539Argyrios Kyrtzidis } 891ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 8929b623639378d53a675921ddfa7316034d571881eDouglas Gregor friend class PartialDiagnostic; 893ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor 894b535041ee33c5eff255832bc5541c8d52aae8254Douglas Gregorprotected: 8953054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar void FlushCounts() { 8963054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar DiagObj->NumDiagArgs = NumArgs; 8973054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar } 89806265bd82073c06294a02a0bd891951fafb484a5Daniel Dunbar 899cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// \brief Clear out the current diagnostic. 9007059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar void Clear() const { 9016bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines DiagObj = nullptr; 9027059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar IsActive = false; 903c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose IsForceEmit = false; 9047059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar } 905cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar 906697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Determine whether this diagnostic is still active. 9077059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar bool isActive() const { return IsActive; } 90806265bd82073c06294a02a0bd891951fafb484a5Daniel Dunbar 909cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// \brief Force the diagnostic builder to emit the diagnostic now. 910cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// 911cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// Once this function has been called, the DiagnosticBuilder object 912cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// should not be used again before it is destroyed. 913cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// 914cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// \returns true if a diagnostic was emitted, false if the 915cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// diagnostic was suppressed. 9163054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar bool Emit() { 9177059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar // If this diagnostic is inactive, then its soul was stolen by the copy ctor 9187059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar // (or by a subclass, as in SemaDiagnosticBuilder). 9197059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar if (!isActive()) return false; 9203054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar 9213054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar // When emitting diagnostics, we set the final argument count into 9223054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar // the DiagnosticsEngine object. 9233054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar FlushCounts(); 9243054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar 9253054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar // Process the diagnostic. 926c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose bool Result = DiagObj->EmitCurrentDiagnostic(IsForceEmit); 9273054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar 9283054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar // This diagnostic is dead. 9297059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar Clear(); 9303054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar 9313054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar return Result; 9323054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar } 9339b623639378d53a675921ddfa7316034d571881eDouglas Gregor 9341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumppublic: 9350a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// Copy constructor. When copied, this "takes" the diagnostic info from the 9360a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// input and neuters it. 9373cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagnosticBuilder(const DiagnosticBuilder &D) { 9380a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner DiagObj = D.DiagObj; 9397059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar IsActive = D.IsActive; 940c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose IsForceEmit = D.IsForceEmit; 9417059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar D.Clear(); 94225a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor NumArgs = D.NumArgs; 9430a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 94425a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor 945ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor /// \brief Retrieve an empty diagnostic builder. 946ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor static DiagnosticBuilder getEmpty() { 947ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor return DiagnosticBuilder(); 948ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor } 949ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor 950697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Emits the diagnostic. 95153c83b32550b3f29db2419160fa2e3684e420556Daniel Dunbar ~DiagnosticBuilder() { 9523054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar Emit(); 95353c83b32550b3f29db2419160fa2e3684e420556Daniel Dunbar } 9549b623639378d53a675921ddfa7316034d571881eDouglas Gregor 955c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose /// \brief Forces the diagnostic to be emitted. 956c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose const DiagnosticBuilder &setForceEmit() const { 957c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose IsForceEmit = true; 958c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose return *this; 959c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose } 960c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose 961af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Conversion of DiagnosticBuilder to bool always returns \c true. 962af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 963af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// This allows is to be used in boolean error contexts (where \c true is 964af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// used to indicate that an error has occurred), like: 965af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \code 9663cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// return Diag(...); 967af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \endcode 9683cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner operator bool() const { return true; } 9693cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 970686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void AddString(StringRef S) const { 971cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar assert(isActive() && "Clients must not add to cleared diagnostic!"); 972d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(NumArgs < DiagnosticsEngine::MaxArguments && 9733cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 974cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar DiagObj->DiagArgumentsKind[NumArgs] = DiagnosticsEngine::ak_std_string; 975cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar DiagObj->DiagArgumentsStr[NumArgs++] = S; 9763cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner } 9771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 978d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie void AddTaggedVal(intptr_t V, DiagnosticsEngine::ArgumentKind Kind) const { 979cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar assert(isActive() && "Clients must not add to cleared diagnostic!"); 980d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(NumArgs < DiagnosticsEngine::MaxArguments && 9813cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 982cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar DiagObj->DiagArgumentsKind[NumArgs] = Kind; 983cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar DiagObj->DiagArgumentsVal[NumArgs++] = V; 9840a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 9851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9860a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner void AddSourceRange(const CharSourceRange &R) const { 987cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar assert(isActive() && "Clients must not add to cleared diagnostic!"); 9886bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines DiagObj->DiagRanges.push_back(R); 9891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 9904b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 991849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor void AddFixItHint(const FixItHint &Hint) const { 992cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar assert(isActive() && "Clients must not add to cleared diagnostic!"); 9936bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines DiagObj->DiagFixItHints.push_back(Hint); 9944b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 99582c6dc72adc30e785ce5bc6e8b43ae92070d2e08David Blaikie 996ef8225444452a1486bd721f3285301fe84643b00Stephen Hines void addFlagValue(StringRef V) const { DiagObj->FlagValue = V; } 9976bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines}; 9985940bf33061844c9a61d4d5c1230df9cf9e90342Richard Trieu 9996bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hinesstruct AddFlagValue { 10006bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines explicit AddFlagValue(StringRef V) : Val(V) {} 10016bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines StringRef Val; 10023cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}; 10033cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 10046bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines/// \brief Register a value for the flag in the current diagnostic. This 10056bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines/// value will be shown as the suffix "=value" after the flag name. It is 10066bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines/// useful in cases where the diagnostic flag accepts values (e.g., 10076bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines/// -Rpass or -Wframe-larger-than). 10086bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hinesinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 10096bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines const AddFlagValue V) { 10106bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines DB.addFlagValue(V.Val); 10116bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines return DB; 10126bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines} 10136bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 10143cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 1015686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef S) { 10163cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddString(S); 10173cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 10183cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 10193cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 10203cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 10213cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const char *Str) { 10223cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(reinterpret_cast<intptr_t>(Str), 1023d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine::ak_c_string); 10243cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 10253cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 10263cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 10273cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, int I) { 1028d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DB.AddTaggedVal(I, DiagnosticsEngine::ak_sint); 10293cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 10303cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 10313cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 1032651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines// We use enable_if here to prevent that this overload is selected for 1033651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines// pointers or other arguments that are implicitly convertible to bool. 1034651f13cea278ec967336033dd032faef0e9fc2ecStephen Hinestemplate <typename T> 1035651f13cea278ec967336033dd032faef0e9fc2ecStephen Hinesinline 1036651f13cea278ec967336033dd032faef0e9fc2ecStephen Hinestypename std::enable_if<std::is_same<T, bool>::value, 1037651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines const DiagnosticBuilder &>::type 1038651f13cea278ec967336033dd032faef0e9fc2ecStephen Hinesoperator<<(const DiagnosticBuilder &DB, T I) { 1039d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DB.AddTaggedVal(I, DiagnosticsEngine::ak_sint); 10403bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis return DB; 10413bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis} 10423bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis 10433cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 10443cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner unsigned I) { 1045d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DB.AddTaggedVal(I, DiagnosticsEngine::ak_uint); 10463cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 10473cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 10483cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 10493cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 1050651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines tok::TokenKind I) { 1051651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines DB.AddTaggedVal(static_cast<unsigned>(I), DiagnosticsEngine::ak_tokenkind); 1052651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines return DB; 1053651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines} 1054651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines 1055651f13cea278ec967336033dd032faef0e9fc2ecStephen Hinesinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 10563cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const IdentifierInfo *II) { 10573cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(reinterpret_cast<intptr_t>(II), 1058d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine::ak_identifierinfo); 10593cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 10603cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 10611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10623f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// Adds a DeclContext to the diagnostic. The enable_if template magic is here 10633f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// so that we only match those arguments that are (statically) DeclContexts; 10643f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// other arguments that derive from DeclContext (e.g., RecordDecls) will not 10653f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// match. 10663f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregortemplate<typename T> 10673f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregorinline 1068651f13cea278ec967336033dd032faef0e9fc2ecStephen Hinestypename std::enable_if<std::is_same<T, DeclContext>::value, 1069651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines const DiagnosticBuilder &>::type 10703f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregoroperator<<(const DiagnosticBuilder &DB, T *DC) { 10713f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor DB.AddTaggedVal(reinterpret_cast<intptr_t>(DC), 1072d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine::ak_declcontext); 10733f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor return DB; 10743f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor} 1075651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines 10763cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 10773cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const SourceRange &R) { 10780a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner DB.AddSourceRange(CharSourceRange::getTokenRange(R)); 10793cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 10803cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 10814b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 10824b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregorinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 1083651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines ArrayRef<SourceRange> Ranges) { 1084651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines for (const SourceRange &R: Ranges) 1085651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines DB.AddSourceRange(CharSourceRange::getTokenRange(R)); 1086651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines return DB; 1087651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines} 1088651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines 1089651f13cea278ec967336033dd032faef0e9fc2ecStephen Hinesinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 10900a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner const CharSourceRange &R) { 10910a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner DB.AddSourceRange(R); 10920a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner return DB; 10930a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner} 1094651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines 10950a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 1096849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor const FixItHint &Hint) { 10973739b32a01b9778176757425e62252c288b85383Ted Kremenek if (!Hint.isNull()) 10983739b32a01b9778176757425e62252c288b85383Ted Kremenek DB.AddFixItHint(Hint); 10994b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor return DB; 11004b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor} 1101ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 1102d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikieinline DiagnosticBuilder DiagnosticsEngine::Report(SourceLocation Loc, 1103651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines unsigned DiagID) { 11043cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(CurDiagID == ~0U && "Multiple diagnostics in flight at once!"); 11053cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner CurDiagLoc = Loc; 11063cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner CurDiagID = DiagID; 1107ef8225444452a1486bd721f3285301fe84643b00Stephen Hines FlagValue.clear(); 11083cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DiagnosticBuilder(this); 11093cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 11106bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 1111d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikieinline DiagnosticBuilder DiagnosticsEngine::Report(unsigned DiagID) { 111233e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return Report(SourceLocation(), DiagID); 11130f9fed70cea107b3f79df554e38bd8e98d48fe47Daniel Dunbar} 11143cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 11153cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 111640847cfb58acc3cac7d68727df9455ac45f2e118David Blaikie// Diagnostic 11173cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 11181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1119697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// A little helper class (which is basically a smart pointer that forwards 1120697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// info from DiagnosticsEngine) that allows clients to enquire about the 1121697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// currently in-flight diagnostic. 112240847cfb58acc3cac7d68727df9455ac45f2e118David Blaikieclass Diagnostic { 1123d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie const DiagnosticsEngine *DiagObj; 1124686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef StoredDiagMessage; 11253cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerpublic: 112640847cfb58acc3cac7d68727df9455ac45f2e118David Blaikie explicit Diagnostic(const DiagnosticsEngine *DO) : DiagObj(DO) {} 112740847cfb58acc3cac7d68727df9455ac45f2e118David Blaikie Diagnostic(const DiagnosticsEngine *DO, StringRef storedDiagMessage) 1128e59abb56ce0e1c206fb80bd945a0c358b0abe1efArgyrios Kyrtzidis : DiagObj(DO), StoredDiagMessage(storedDiagMessage) {} 11291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1130d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie const DiagnosticsEngine *getDiags() const { return DiagObj; } 1131b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner unsigned getID() const { return DiagObj->CurDiagID; } 113233e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis const SourceLocation &getLocation() const { return DiagObj->CurDiagLoc; } 113333e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis bool hasSourceManager() const { return DiagObj->hasSourceManager(); } 113433e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis SourceManager &getSourceManager() const { return DiagObj->getSourceManager();} 11351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11360a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned getNumArgs() const { return DiagObj->NumDiagArgs; } 11371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1138af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Return the kind of the specified index. 1139af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 1140af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// Based on the kind of argument, the accessors below can be used to get 1141af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// the value. 1142af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 1143af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \pre Idx < getNumArgs() 1144d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine::ArgumentKind getArgKind(unsigned Idx) const { 11453cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(Idx < getNumArgs() && "Argument index out of range!"); 1146d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie return (DiagnosticsEngine::ArgumentKind)DiagObj->DiagArgumentsKind[Idx]; 114773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner } 11481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1149af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Return the provided argument string specified by \p Idx. 1150af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_std_string 115173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner const std::string &getArgStdStr(unsigned Idx) const { 1152d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(getArgKind(Idx) == DiagnosticsEngine::ak_std_string && 11533cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 115473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner return DiagObj->DiagArgumentsStr[Idx]; 115573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner } 11561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1157af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Return the specified C string argument. 1158af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_c_string 115973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner const char *getArgCStr(unsigned Idx) const { 1160d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(getArgKind(Idx) == DiagnosticsEngine::ak_c_string && 11613cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 116273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner return reinterpret_cast<const char*>(DiagObj->DiagArgumentsVal[Idx]); 11630a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 11641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1165af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Return the specified signed integer argument. 1166af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_sint 116730bc96544346bea42921cf6837e66cef80d664b4Chris Lattner int getArgSInt(unsigned Idx) const { 1168d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(getArgKind(Idx) == DiagnosticsEngine::ak_sint && 11693cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 117030bc96544346bea42921cf6837e66cef80d664b4Chris Lattner return (int)DiagObj->DiagArgumentsVal[Idx]; 117130bc96544346bea42921cf6837e66cef80d664b4Chris Lattner } 11721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1173af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Return the specified unsigned integer argument. 1174af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_uint 117530bc96544346bea42921cf6837e66cef80d664b4Chris Lattner unsigned getArgUInt(unsigned Idx) const { 1176d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(getArgKind(Idx) == DiagnosticsEngine::ak_uint && 11773cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 117830bc96544346bea42921cf6837e66cef80d664b4Chris Lattner return (unsigned)DiagObj->DiagArgumentsVal[Idx]; 117930bc96544346bea42921cf6837e66cef80d664b4Chris Lattner } 11801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1181af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Return the specified IdentifierInfo argument. 1182af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_identifierinfo 118343b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner const IdentifierInfo *getArgIdentifier(unsigned Idx) const { 1184d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(getArgKind(Idx) == DiagnosticsEngine::ak_identifierinfo && 11853cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 11869634379265855f1628190e926d9aaf1fb4a5d90eChris Lattner return reinterpret_cast<IdentifierInfo*>(DiagObj->DiagArgumentsVal[Idx]); 118743b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner } 11881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1189af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Return the specified non-string argument in an opaque form. 1190af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \pre getArgKind(Idx) != DiagnosticsEngine::ak_std_string 119122caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner intptr_t getRawArg(unsigned Idx) const { 1192d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(getArgKind(Idx) != DiagnosticsEngine::ak_std_string && 119322caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner "invalid argument accessor!"); 119422caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner return DiagObj->DiagArgumentsVal[Idx]; 119522caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 11961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1197af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Return the number of source ranges associated with this diagnostic. 11980a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned getNumRanges() const { 11996bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines return DiagObj->DiagRanges.size(); 12000a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 12011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1202af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \pre Idx < getNumRanges() 12030a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner const CharSourceRange &getRange(unsigned Idx) const { 12046bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines assert(Idx < getNumRanges() && "Invalid diagnostic range index!"); 120551c6d384551674facc19f745ecf6e289d28dc55fDouglas Gregor return DiagObj->DiagRanges[Idx]; 12060a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 12071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 120828409289193afca1a3178a9796f8e8aebcb76896Chandler Carruth /// \brief Return an array reference for this diagnostic's ranges. 120928409289193afca1a3178a9796f8e8aebcb76896Chandler Carruth ArrayRef<CharSourceRange> getRanges() const { 12106bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines return DiagObj->DiagRanges; 121128409289193afca1a3178a9796f8e8aebcb76896Chandler Carruth } 121228409289193afca1a3178a9796f8e8aebcb76896Chandler Carruth 1213849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor unsigned getNumFixItHints() const { 12146bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines return DiagObj->DiagFixItHints.size(); 12154b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 12164b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1217849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor const FixItHint &getFixItHint(unsigned Idx) const { 1218981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar assert(Idx < getNumFixItHints() && "Invalid index!"); 1219981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar return DiagObj->DiagFixItHints[Idx]; 12204b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 12214b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 12226bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines ArrayRef<FixItHint> getFixItHints() const { 12236bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines return DiagObj->DiagFixItHints; 12244b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 12254b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1226af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Format this diagnostic into a string, substituting the 1227af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// formal arguments into the %0 slots. 1228af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 1229af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// The result is appended onto the \p OutStr array. 1230686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void FormatDiagnostic(SmallVectorImpl<char> &OutStr) const; 12319f28614bf1a8387000d8df57a713fcf69e198145John McCall 1232af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Format the given format-string into the output buffer using the 1233af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// arguments stored in this diagnostic. 12349f28614bf1a8387000d8df57a713fcf69e198145John McCall void FormatDiagnostic(const char *DiagStr, const char *DiagEnd, 1235686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<char> &OutStr) const; 1236a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor}; 1237a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 1238a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor/** 1239d3ab63e0f66429abf2a3e4cde889e420e41e8790Douglas Gregor * \brief Represents a diagnostic in a form that can be retained until its 1240d3ab63e0f66429abf2a3e4cde889e420e41e8790Douglas Gregor * corresponding source manager is destroyed. 1241a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor */ 1242a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregorclass StoredDiagnostic { 1243aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor unsigned ID; 1244d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine::Level Level; 1245a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor FullSourceLoc Loc; 1246a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor std::string Message; 12470a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner std::vector<CharSourceRange> Ranges; 1248849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor std::vector<FixItHint> FixIts; 1249a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 1250a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregorpublic: 1251a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor StoredDiagnostic(); 125240847cfb58acc3cac7d68727df9455ac45f2e118David Blaikie StoredDiagnostic(DiagnosticsEngine::Level Level, const Diagnostic &Info); 1253d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie StoredDiagnostic(DiagnosticsEngine::Level Level, unsigned ID, 1254686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef Message); 1255d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie StoredDiagnostic(DiagnosticsEngine::Level Level, unsigned ID, 1256686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef Message, FullSourceLoc Loc, 12572d3ba4f5a923a90c3fc290ddfba5e36c2d0a9b46Chris Lattner ArrayRef<CharSourceRange> Ranges, 12582d3ba4f5a923a90c3fc290ddfba5e36c2d0a9b46Chris Lattner ArrayRef<FixItHint> Fixits); 1259a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor ~StoredDiagnostic(); 1260a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 1261a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// \brief Evaluates true when this object stores a diagnostic. 12627247c88d1e41514a41085f83ebf03dd5220e054aDavid Blaikie LLVM_EXPLICIT operator bool() const { return Message.size() > 0; } 1263a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 1264aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor unsigned getID() const { return ID; } 1265d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine::Level getLevel() const { return Level; } 1266a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor const FullSourceLoc &getLocation() const { return Loc; } 1267686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef getMessage() const { return Message; } 1268c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 1269c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor void setLocation(FullSourceLoc Loc) { this->Loc = Loc; } 1270c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 12710a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner typedef std::vector<CharSourceRange>::const_iterator range_iterator; 1272a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor range_iterator range_begin() const { return Ranges.begin(); } 1273a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor range_iterator range_end() const { return Ranges.end(); } 1274a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned range_size() const { return Ranges.size(); } 12756700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek 12766700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek ArrayRef<CharSourceRange> getRanges() const { 12776700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek return llvm::makeArrayRef(Ranges); 12786700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek } 12796700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek 1280a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 1281849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor typedef std::vector<FixItHint>::const_iterator fixit_iterator; 1282a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor fixit_iterator fixit_begin() const { return FixIts.begin(); } 1283a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor fixit_iterator fixit_end() const { return FixIts.end(); } 1284a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned fixit_size() const { return FixIts.size(); } 12856700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek 12866700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek ArrayRef<FixItHint> getFixIts() const { 12876700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek return llvm::makeArrayRef(FixIts); 12886700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek } 12895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 12901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1291af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// \brief Abstract interface, implemented by clients of the front-end, which 1292af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// formats and prints fully processed diagnostics. 129378ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikieclass DiagnosticConsumer { 1294ab41b97c3cddf1bcdd8bf82ab09ed3ceafcd05b1Argyrios Kyrtzidisprotected: 1295af50aab0c317462129d73ae8000c6394c718598dJames Dennett unsigned NumWarnings; ///< Number of warnings reported 1296af50aab0c317462129d73ae8000c6394c718598dJames Dennett unsigned NumErrors; ///< Number of errors reported 1297f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis 12985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 129978ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie DiagnosticConsumer() : NumWarnings(0), NumErrors(0) { } 1300f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis 1301f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis unsigned getNumErrors() const { return NumErrors; } 1302f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis unsigned getNumWarnings() const { return NumWarnings; } 130361d679ab2831b161c857cf3f974312fbd4ef1efdArgyrios Kyrtzidis virtual void clear() { NumWarnings = NumErrors = 0; } 1304f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis 130578ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie virtual ~DiagnosticConsumer(); 13061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1307af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Callback to inform the diagnostic client that processing 1308efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// of a source file is beginning. 1309efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// 1310efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// Note that diagnostics may be emitted outside the processing of a source 1311efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// file, for example during the parsing of command line options. However, 1312efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// diagnostics with source range information are required to only be emitted 1313efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// in between BeginSourceFile() and EndSourceFile(). 1314efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// 1315af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \param LangOpts The language options for the source file being processed. 1316af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \param PP The preprocessor object being used for the source; this is 1317af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// optional, e.g., it may not be present when processing AST source files. 13187d90199f109290e9d587479a481a2850d390b552Daniel Dunbar virtual void BeginSourceFile(const LangOptions &LangOpts, 13196bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines const Preprocessor *PP = nullptr) {} 1320efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar 1321af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Callback to inform the diagnostic client that processing 1322af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// of a source file has ended. 1323af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 1324af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// The diagnostic client should assume that any objects made available via 1325af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// BeginSourceFile() are inaccessible. 1326efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar virtual void EndSourceFile() {} 13271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 132829f2787b6da552018a7716f18f5bd8f67bd6edb5Argyrios Kyrtzidis /// \brief Callback to inform the diagnostic client that processing of all 132929f2787b6da552018a7716f18f5bd8f67bd6edb5Argyrios Kyrtzidis /// source files has ended. 133029f2787b6da552018a7716f18f5bd8f67bd6edb5Argyrios Kyrtzidis virtual void finish() {} 133129f2787b6da552018a7716f18f5bd8f67bd6edb5Argyrios Kyrtzidis 1332af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Indicates whether the diagnostics handled by this 133378ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie /// DiagnosticConsumer should be included in the number of diagnostics 133478ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie /// reported by DiagnosticsEngine. 1335af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 1336af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// The default implementation returns true. 1337cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek virtual bool IncludeInDiagnosticCounts() const; 13385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1339af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Handle this diagnostic, reporting it to the user or 13405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// capturing it to a log as needed. 1341f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis /// 1342af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// The default implementation just keeps track of the total number of 1343af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// warnings and errors. 1344d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie virtual void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel, 134540847cfb58acc3cac7d68727df9455ac45f2e118David Blaikie const Diagnostic &Info); 1346aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor}; 1347aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor 1348af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// \brief A diagnostic client that ignores all diagnostics. 1349aee526e77657afd1600276450e9c346953ad51d7Douglas Gregorclass IgnoringDiagConsumer : public DiagnosticConsumer { 135099ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie virtual void anchor(); 1351aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel, 1352651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines const Diagnostic &Info) override { 1353aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor // Just ignore it. 1354aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor } 13555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 13565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1357a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregor/// \brief Diagnostic consumer that forwards diagnostics along to an 1358a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregor/// existing, already-initialized diagnostic consumer. 1359a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregor/// 1360a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregorclass ForwardingDiagnosticConsumer : public DiagnosticConsumer { 1361a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregor DiagnosticConsumer &Target; 1362a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregor 1363a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregorpublic: 1364a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregor ForwardingDiagnosticConsumer(DiagnosticConsumer &Target) : Target(Target) {} 1365a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregor 1366a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregor virtual ~ForwardingDiagnosticConsumer(); 1367a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregor 1368651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel, 1369651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines const Diagnostic &Info) override; 1370651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines void clear() override; 1371a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregor 1372651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines bool IncludeInDiagnosticCounts() const override; 1373a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregor}; 1374a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregor 1375246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu// Struct used for sending info about how a type should be printed. 1376246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieustruct TemplateDiffTypes { 1377246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu intptr_t FromType; 1378246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu intptr_t ToType; 1379246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu unsigned PrintTree : 1; 1380246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu unsigned PrintFromType : 1; 1381246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu unsigned ElideType : 1; 1382246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu unsigned ShowColors : 1; 13835409d28b6167032696f4915bb765a6f7db579f3fRichard Trieu // The printer sets this variable to true if the template diff was used. 13845409d28b6167032696f4915bb765a6f7db579f3fRichard Trieu unsigned TemplateDiffUsed : 1; 1385246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu}; 1386246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu 1387246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu/// Special character that the diagnostic printer will use to toggle the bold 1388246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu/// attribute. The character itself will be not be printed. 1389246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieuconst char ToggleHighlight = 127; 1390246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu 13916bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 13926bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines/// ProcessWarningOptions - Initialize the diagnostic client and process the 13936bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines/// warning options specified on the command line. 13946bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hinesvoid ProcessWarningOptions(DiagnosticsEngine &Diags, 13956bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines const DiagnosticOptions &Opts, 13966bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines bool ReportDiags = true); 13976bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 13985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 13995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 14005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 1401