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 15176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines#ifndef LLVM_CLANG_BASIC_DIAGNOSTIC_H 16176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines#define LLVM_CLANG_BASIC_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" 2187d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar#include "clang/Basic/Specifiers.h" 22f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor#include "llvm/ADT/ArrayRef.h" 230827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis#include "llvm/ADT/DenseMap.h" 2428019772db70d4547be05a042eb950bc910f134fDouglas Gregor#include "llvm/ADT/IntrusiveRefCntPtr.h" 256bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines#include "llvm/ADT/iterator_range.h" 260827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis#include <list> 2730a2e16f6c27f888dd11eba6bbbae1e980078fcbChandler Carruth#include <vector> 28f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner 295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang { 306bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines class DeclContext; 3133e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis class DiagnosticBuilder; 326bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines class DiagnosticConsumer; 336bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines class DiagnosticErrorTrap; 3402c23ebf41ae2f70da0ba7337e05c51fbfe35f7fDouglas Gregor class DiagnosticOptions; 35d42ffbd22fc7eb61321f6a88173ee424991f01c6Ted Kremenek class IdentifierInfo; 3640469651a3f8379dc0f32df69e9bade06a2aad36Chris Lattner class LangOptions; 377d90199f109290e9d587479a481a2850d390b552Daniel Dunbar class Preprocessor; 38e59abb56ce0e1c206fb80bd945a0c358b0abe1efArgyrios Kyrtzidis class StoredDiagnostic; 39651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines namespace tok { 40651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines enum TokenKind : unsigned short; 41651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines } 421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 434b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// \brief Annotates a diagnostic with some code that should be 444b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// inserted, removed, or replaced to fix the problem. 454b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// 464b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// This kind of hint should be used when we are certain that the 474b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// introduction, removal, or modification of a particular (small!) 484b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// amount of code will correct a compilation error. The compiler 494b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// should also provide full recovery from such errors, such that 50b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor/// suppressing the diagnostic output can still result in successful 514b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// compilation. 52849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregorclass FixItHint { 534b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregorpublic: 54783c56f47745f719590b17afd7ed937bf2407b53Douglas Gregor /// \brief Code that should be replaced to correct the error. Empty for an 55783c56f47745f719590b17afd7ed937bf2407b53Douglas Gregor /// insertion hint. 560a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner CharSourceRange RemoveRange; 574b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 5830660a898545416f0fea2d717f16f75640001e38Ted Kremenek /// \brief Code in the specific range that should be inserted in the insertion 5930660a898545416f0fea2d717f16f75640001e38Ted Kremenek /// location. 6030660a898545416f0fea2d717f16f75640001e38Ted Kremenek CharSourceRange InsertFromRange; 6130660a898545416f0fea2d717f16f75640001e38Ted Kremenek 624b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief The actual code to insert at the insertion location, as a 634b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// string. 644b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor std::string CodeToInsert; 654b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 6630660a898545416f0fea2d717f16f75640001e38Ted Kremenek bool BeforePreviousInsertions; 6730660a898545416f0fea2d717f16f75640001e38Ted Kremenek 684b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Empty code modification hint, indicating that no code 694b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// modification is known. 7030660a898545416f0fea2d717f16f75640001e38Ted Kremenek FixItHint() : BeforePreviousInsertions(false) { } 714b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 722f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson bool isNull() const { 73783c56f47745f719590b17afd7ed937bf2407b53Douglas Gregor return !RemoveRange.isValid(); 742f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson } 752f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson 764b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that inserts the given 774b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// code string at a specific location. 78849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor static FixItHint CreateInsertion(SourceLocation InsertionLoc, 7930660a898545416f0fea2d717f16f75640001e38Ted Kremenek StringRef Code, 8030660a898545416f0fea2d717f16f75640001e38Ted Kremenek bool BeforePreviousInsertions = false) { 81849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor FixItHint Hint; 82783c56f47745f719590b17afd7ed937bf2407b53Douglas Gregor Hint.RemoveRange = 834a2ef80d896c1bac38ce113ec19a8d509a619288Nico Weber CharSourceRange::getCharRange(InsertionLoc, InsertionLoc); 84b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.CodeToInsert = Code; 8530660a898545416f0fea2d717f16f75640001e38Ted Kremenek Hint.BeforePreviousInsertions = BeforePreviousInsertions; 8630660a898545416f0fea2d717f16f75640001e38Ted Kremenek return Hint; 8730660a898545416f0fea2d717f16f75640001e38Ted Kremenek } 8830660a898545416f0fea2d717f16f75640001e38Ted Kremenek 8930660a898545416f0fea2d717f16f75640001e38Ted Kremenek /// \brief Create a code modification hint that inserts the given 90af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// code from \p FromRange at a specific location. 9130660a898545416f0fea2d717f16f75640001e38Ted Kremenek static FixItHint CreateInsertionFromRange(SourceLocation InsertionLoc, 9230660a898545416f0fea2d717f16f75640001e38Ted Kremenek CharSourceRange FromRange, 9330660a898545416f0fea2d717f16f75640001e38Ted Kremenek bool BeforePreviousInsertions = false) { 9430660a898545416f0fea2d717f16f75640001e38Ted Kremenek FixItHint Hint; 9530660a898545416f0fea2d717f16f75640001e38Ted Kremenek Hint.RemoveRange = 964a2ef80d896c1bac38ce113ec19a8d509a619288Nico Weber CharSourceRange::getCharRange(InsertionLoc, InsertionLoc); 9730660a898545416f0fea2d717f16f75640001e38Ted Kremenek Hint.InsertFromRange = FromRange; 9830660a898545416f0fea2d717f16f75640001e38Ted Kremenek Hint.BeforePreviousInsertions = BeforePreviousInsertions; 99b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 100b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 1014b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1024b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that removes the given 1034b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// source range. 1040a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner static FixItHint CreateRemoval(CharSourceRange RemoveRange) { 105849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor FixItHint Hint; 106b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.RemoveRange = RemoveRange; 107b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 108b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 1090a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner static FixItHint CreateRemoval(SourceRange RemoveRange) { 1100a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner return CreateRemoval(CharSourceRange::getTokenRange(RemoveRange)); 1110a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner } 1120a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner 1134b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that replaces the given 1144b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// source range with the given code string. 1150a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner static FixItHint CreateReplacement(CharSourceRange RemoveRange, 116686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef Code) { 117849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor FixItHint Hint; 118b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.RemoveRange = RemoveRange; 119b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.CodeToInsert = Code; 120b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 121b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 1220a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner 1230a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner static FixItHint CreateReplacement(SourceRange RemoveRange, 124686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef Code) { 1250a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner return CreateReplacement(CharSourceRange::getTokenRange(RemoveRange), Code); 1260a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner } 1274b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor}; 1284b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 129af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// \brief Concrete class used by the front-end to report problems and issues. 130af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// 131af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// This massages the diagnostics (e.g. handling things like "report warnings 132af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// as errors" and passes them off to the DiagnosticConsumer for reporting to 133af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// the user. DiagnosticsEngine is tied to one translation unit and one 134af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// SourceManager. 135c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmithclass DiagnosticsEngine : public RefCountedBase<DiagnosticsEngine> { 1360e2c34f92f00628d48968dfea096d36381f494cbStephen Hines DiagnosticsEngine(const DiagnosticsEngine &) = delete; 1370e2c34f92f00628d48968dfea096d36381f494cbStephen Hines void operator=(const DiagnosticsEngine &) = delete; 1386bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 139182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattnerpublic: 140af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief The level of the diagnostic, after it has been through mapping. 141182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner enum Level { 14233e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis Ignored = DiagnosticIDs::Ignored, 14333e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis Note = DiagnosticIDs::Note, 144651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines Remark = DiagnosticIDs::Remark, 14533e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis Warning = DiagnosticIDs::Warning, 14633e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis Error = DiagnosticIDs::Error, 14733e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis Fatal = DiagnosticIDs::Fatal 148182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner }; 1491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1503fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner enum ArgumentKind { 151af50aab0c317462129d73ae8000c6394c718598dJames Dennett ak_std_string, ///< std::string 152af50aab0c317462129d73ae8000c6394c718598dJames Dennett ak_c_string, ///< const char * 153af50aab0c317462129d73ae8000c6394c718598dJames Dennett ak_sint, ///< int 154af50aab0c317462129d73ae8000c6394c718598dJames Dennett ak_uint, ///< unsigned 155651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines ak_tokenkind, ///< enum TokenKind : unsigned 156af50aab0c317462129d73ae8000c6394c718598dJames Dennett ak_identifierinfo, ///< IdentifierInfo 157af50aab0c317462129d73ae8000c6394c718598dJames Dennett ak_qualtype, ///< QualType 158af50aab0c317462129d73ae8000c6394c718598dJames Dennett ak_declarationname, ///< DeclarationName 159af50aab0c317462129d73ae8000c6394c718598dJames Dennett ak_nameddecl, ///< NamedDecl * 160af50aab0c317462129d73ae8000c6394c718598dJames Dennett ak_nestednamespec, ///< NestedNameSpecifier * 161af50aab0c317462129d73ae8000c6394c718598dJames Dennett ak_declcontext, ///< DeclContext * 162651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines ak_qualtype_pair, ///< pair<QualType, QualType> 163651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines ak_attr ///< Attr * 1643fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner }; 1655edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin 166af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Represents on argument value, which is a union discriminated 167af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// by ArgumentKind, with a value. 168b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner typedef std::pair<ArgumentKind, intptr_t> ArgumentValue; 169ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 1701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumpprivate: 17127ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner unsigned char AllExtensionsSilenced; // Used by __extension__ 172b54b276a920246c595a0498da281821eb9d22996Chris Lattner bool IgnoreAllWarnings; // Ignore all warnings: -w 1731e473ccb0e0f6fd1954bef330f7193c1a3fb3ba1Ted Kremenek bool WarningsAsErrors; // Treat warnings like errors. 1741e473ccb0e0f6fd1954bef330f7193c1a3fb3ba1Ted Kremenek bool EnableAllWarnings; // Enable all warnings. 175e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner bool ErrorsAsFatal; // Treat errors like fatal errors. 1764967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar bool FatalsAsError; // Treat fatal errors like errors. 177b54b276a920246c595a0498da281821eb9d22996Chris Lattner bool SuppressSystemWarnings; // Suppress warnings in system headers. 17881b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor bool SuppressAllDiagnostics; // Suppress all diagnostics. 179246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu bool ElideType; // Elide common types of templates. 180246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu bool PrintTemplateTree; // Print a tree when comparing templates. 181246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu bool ShowColors; // Color printing is enabled. 1825edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin OverloadsShown ShowOverloads; // Which overload candidates to show. 183c100214fdc41a7ea215f75d433eb1cb829fd4330Chris Lattner unsigned ErrorLimit; // Cap of # errors emitted, 0 -> no limit. 184575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor unsigned TemplateBacktraceLimit; // Cap on depth of template backtrace stack, 185575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor // 0 -> no limit. 18608d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith unsigned ConstexprBacktraceLimit; // Cap on depth of constexpr evaluation 18708d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith // backtrace stack, 0 -> no limit. 188c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines diag::Severity ExtBehavior; // Map extensions to warnings or errors? 189c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<DiagnosticIDs> Diags; 19002c23ebf41ae2f70da0ba7337e05c51fbfe35f7fDouglas Gregor IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts; 19178ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie DiagnosticConsumer *Client; 192176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines std::unique_ptr<DiagnosticConsumer> Owner; 19333e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis SourceManager *SourceMgr; 1940827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 195af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Mapping information for diagnostics. 196af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 197af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// Mapping info is packed into four bits per diagnostic. The low three 198c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines /// bits are the mapping (an instance of diag::Severity), or zero if unset. 199af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// The high bit is set when the mapping was established as a user mapping. 200af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// If the high bit is clear, then the low bits are set to the default 201af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// value, and should be mapped with -pedantic, -Werror, etc. 2020827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// 2033efd52cf8f4e57c5571bd8cc3168264c3bc46a1eArgyrios Kyrtzidis /// A new DiagState is created and kept around when diagnostic pragmas modify 2043efd52cf8f4e57c5571bd8cc3168264c3bc46a1eArgyrios Kyrtzidis /// the state so that we know what is the diagnostic state at any given 2053efd52cf8f4e57c5571bd8cc3168264c3bc46a1eArgyrios Kyrtzidis /// source location. 2060827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis class DiagState { 207c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines llvm::DenseMap<unsigned, DiagnosticMapping> DiagMap; 2083c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer 2093c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer public: 210c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines typedef llvm::DenseMap<unsigned, DiagnosticMapping>::iterator iterator; 211c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines typedef llvm::DenseMap<unsigned, DiagnosticMapping>::const_iterator 212c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines const_iterator; 2133efd52cf8f4e57c5571bd8cc3168264c3bc46a1eArgyrios Kyrtzidis 214c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines void setMapping(diag::kind Diag, DiagnosticMapping Info) { 215b1c99c679adb53be8f478d08be83af6c9c22ae4bDaniel Dunbar DiagMap[Diag] = Info; 216b1c99c679adb53be8f478d08be83af6c9c22ae4bDaniel Dunbar } 2173c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer 218c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines DiagnosticMapping &getOrAddMapping(diag::kind Diag); 219ba494c64365d78b1cdb6baea4d1e79263389fda9Daniel Dunbar 220ba494c64365d78b1cdb6baea4d1e79263389fda9Daniel Dunbar const_iterator begin() const { return DiagMap.begin(); } 221ba494c64365d78b1cdb6baea4d1e79263389fda9Daniel Dunbar const_iterator end() const { return DiagMap.end(); } 2220827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis }; 2233c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer 2240827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \brief Keeps and automatically disposes all DiagStates that we create. 2250827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis std::list<DiagState> DiagStates; 2260827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 2270827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \brief Represents a point in source where the diagnostic state was 228af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// modified because of a pragma. 229af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 230af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 'Loc' can be null if the point represents the diagnostic state 231af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// modifications done through the command-line. 2320827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis struct DiagStatePoint { 2330827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis DiagState *State; 2340827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis FullSourceLoc Loc; 2350827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis DiagStatePoint(DiagState *State, FullSourceLoc Loc) 2360827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis : State(State), Loc(Loc) { } 2370827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 2380827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis bool operator<(const DiagStatePoint &RHS) const { 2390827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis // If Loc is invalid it means it came from <command-line>, in which case 2400827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis // we regard it as coming before any valid source location. 2410827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis if (RHS.Loc.isInvalid()) 2420827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis return false; 2430827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis if (Loc.isInvalid()) 2440827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis return true; 2450827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis return Loc.isBeforeInTranslationUnitThan(RHS.Loc); 2463c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer } 2473c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer }; 24804ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 249af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief A sorted vector of all DiagStatePoints representing changes in 250af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// diagnostic state due to diagnostic pragmas. 251af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 252af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// The vector is always sorted according to the SourceLocation of the 253af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// DiagStatePoint. 2540827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis typedef std::vector<DiagStatePoint> DiagStatePointsTy; 2550827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis mutable DiagStatePointsTy DiagStatePoints; 2560827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 2570827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \brief Keeps the DiagState that was active during each diagnostic 'push' 2580827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// so we can get back at it when we 'pop'. 2590827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis std::vector<DiagState *> DiagStateOnPushStack; 2600827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 2610827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis DiagState *GetCurDiagState() const { 2620827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis assert(!DiagStatePoints.empty()); 2630827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis return DiagStatePoints.back().State; 2640827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis } 2650827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 2660827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis void PushDiagStatePoint(DiagState *State, SourceLocation L) { 26700aae5243d965aa7bcee81a39ba0900c7869be21Richard Smith FullSourceLoc Loc(L, getSourceManager()); 2680827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis // Make sure that DiagStatePoints is always sorted according to Loc. 26900aae5243d965aa7bcee81a39ba0900c7869be21Richard Smith assert(Loc.isValid() && "Adding invalid loc point"); 27000aae5243d965aa7bcee81a39ba0900c7869be21Richard Smith assert(!DiagStatePoints.empty() && 27100aae5243d965aa7bcee81a39ba0900c7869be21Richard Smith (DiagStatePoints.back().Loc.isInvalid() || 2720827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis DiagStatePoints.back().Loc.isBeforeInTranslationUnitThan(Loc)) && 2730827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis "Previous point loc comes after or is the same as new one"); 27400aae5243d965aa7bcee81a39ba0900c7869be21Richard Smith DiagStatePoints.push_back(DiagStatePoint(State, Loc)); 2750827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis } 2760827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 2770827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \brief Finds the DiagStatePoint that contains the diagnostic state of 2780827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// the given source location. 2790827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis DiagStatePointsTy::iterator GetDiagStatePointForLoc(SourceLocation Loc) const; 28004ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 281af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Sticky flag set to \c true when an error is emitted. 2825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ErrorOccurred; 283af50aab0c317462129d73ae8000c6394c718598dJames Dennett 28412f37e411462b8388eb1309357bd62257debacacDeLesley Hutchins /// \brief Sticky flag set to \c true when an "uncompilable error" occurs. 28512f37e411462b8388eb1309357bd62257debacacDeLesley Hutchins /// I.e. an error that was not upgraded from a warning by -Werror. 28612f37e411462b8388eb1309357bd62257debacacDeLesley Hutchins bool UncompilableErrorOccurred; 28712f37e411462b8388eb1309357bd62257debacacDeLesley Hutchins 288af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Sticky flag set to \c true when a fatal error is emitted. 28915221422eda7bac679e38b07512feda49715ef66Chris Lattner bool FatalErrorOccurred; 2901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 29185bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor /// \brief Indicates that an unrecoverable error has occurred. 29285bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor bool UnrecoverableErrorOccurred; 29385bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor 294c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis /// \brief Counts for DiagnosticErrorTrap to check whether an error occurred 295add80bb3957dba1d9389304453c0a4c975768bd7John McCall /// during a parsing section, e.g. during parsing a function. 296c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis unsigned TrapNumErrorsOccurred; 297c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis unsigned TrapNumUnrecoverableErrorsOccurred; 298add80bb3957dba1d9389304453c0a4c975768bd7John McCall 299af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief The level of the last diagnostic emitted. 300af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 301af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// This is used to emit continuation diagnostics with the same level as the 302f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// diagnostic that they follow. 30333e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis DiagnosticIDs::Level LastDiagLevel; 3045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 305af50aab0c317462129d73ae8000c6394c718598dJames Dennett unsigned NumWarnings; ///< Number of warnings reported 306af50aab0c317462129d73ae8000c6394c718598dJames Dennett unsigned NumErrors; ///< Number of errors reported 3077bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber 308af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief A function pointer that converts an opaque diagnostic 309af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// argument to a strings. 310af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 311af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// This takes the modifiers and argument that was present in the diagnostic. 312b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// 313c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines /// The PrevArgs array indicates the previous arguments formatted for this 314c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines /// diagnostic. Implementations of this function can use this information to 315c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines /// avoid redundancy across arguments. 316b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// 31722caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner /// This is a hack to avoid a layering violation between libbasic and libsema. 3180673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth typedef void (*ArgToStringFnTy)( 3190673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth ArgumentKind Kind, intptr_t Val, 320c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines StringRef Modifier, StringRef Argument, 321c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines ArrayRef<ArgumentValue> PrevArgs, 322686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<char> &Output, 3230673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth void *Cookie, 324341785ec52f87c0803ba52dc88faac4e136f8593Bill Wendling ArrayRef<intptr_t> QualTypeVals); 32592dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner void *ArgToStringCookie; 3263fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ArgToStringFnTy ArgToStringFn; 32793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 32893ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief ID of the "delayed" diagnostic, which is a (typically 32993ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// fatal) diagnostic that had to be delayed because it was found 33093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// while emitting another diagnostic. 33193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor unsigned DelayedDiagID; 33293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 33393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief First string argument for the delayed diagnostic. 33493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor std::string DelayedDiagArg1; 33593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 33693ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief Second string argument for the delayed diagnostic. 33793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor std::string DelayedDiagArg2; 33893ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 339c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines /// \brief Optional flag value. 3406bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines /// 341c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines /// Some flags accept values, for instance: -Wframe-larger-than=<value> and 342c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines /// -Rpass=<value>. The content of this string is emitted after the flag name 343c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines /// and '='. 344c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines std::string FlagValue; 3456bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 3465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 347d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie explicit DiagnosticsEngine( 348c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith const IntrusiveRefCntPtr<DiagnosticIDs> &Diags, 34902c23ebf41ae2f70da0ba7337e05c51fbfe35f7fDouglas Gregor DiagnosticOptions *DiagOpts, 3506bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines DiagnosticConsumer *client = nullptr, 35133e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis bool ShouldOwnClient = true); 3520e2c34f92f00628d48968dfea096d36381f494cbStephen Hines ~DiagnosticsEngine(); 3531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 354c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith const IntrusiveRefCntPtr<DiagnosticIDs> &getDiagnosticIDs() const { 35533e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return Diags; 35633e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis } 35733e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis 35802c23ebf41ae2f70da0ba7337e05c51fbfe35f7fDouglas Gregor /// \brief Retrieve the diagnostic options. 35902c23ebf41ae2f70da0ba7337e05c51fbfe35f7fDouglas Gregor DiagnosticOptions &getDiagnosticOptions() const { return *DiagOpts; } 36002c23ebf41ae2f70da0ba7337e05c51fbfe35f7fDouglas Gregor 3616bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines typedef llvm::iterator_range<DiagState::const_iterator> diag_mapping_range; 3626bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 3636bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines /// \brief Get the current set of diagnostic mappings. 3646bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines diag_mapping_range getDiagnosticMappings() const { 3656bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines const DiagState &DS = *GetCurDiagState(); 3666bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines return diag_mapping_range(DS.begin(), DS.end()); 3676bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines } 3686bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 36978ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie DiagnosticConsumer *getClient() { return Client; } 37078ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie const DiagnosticConsumer *getClient() const { return Client; } 3711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 372d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie /// \brief Determine whether this \c DiagnosticsEngine object own its client. 373176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines bool ownsClient() const { return Owner != nullptr; } 374176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines 375bdbb004f38978da0c4a75af3294d1c7b5ff84af1Douglas Gregor /// \brief Return the current diagnostic client along with ownership of that 376bdbb004f38978da0c4a75af3294d1c7b5ff84af1Douglas Gregor /// client. 377176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines std::unique_ptr<DiagnosticConsumer> takeClient() { return std::move(Owner); } 37833e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis 3796bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines bool hasSourceManager() const { return SourceMgr != nullptr; } 38033e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis SourceManager &getSourceManager() const { 38133e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis assert(SourceMgr && "SourceManager not set!"); 38233e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return *SourceMgr; 38333e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis } 38433e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis void setSourceManager(SourceManager *SrcMgr) { SourceMgr = SrcMgr; } 38533e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis 38633e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis //===--------------------------------------------------------------------===// 387d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie // DiagnosticsEngine characterization methods, used by a client to customize 388d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie // how diagnostics are emitted. 38933e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis // 39004ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 391af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Copies the current DiagMappings and pushes the new copy 39204ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// onto the top of the stack. 3930827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis void pushMappings(SourceLocation Loc); 39404ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 395af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Pops the current DiagMappings off the top of the stack, 396af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// causing the new top of the stack to be the active mappings. 397af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 398af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \returns \c true if the pop happens, \c false if there is only one 399af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// DiagMapping on the stack. 4000827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis bool popMappings(SourceLocation Loc); 40104ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 402bdbb004f38978da0c4a75af3294d1c7b5ff84af1Douglas Gregor /// \brief Set the diagnostic client associated with this diagnostic object. 403bdbb004f38978da0c4a75af3294d1c7b5ff84af1Douglas Gregor /// 40433e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis /// \param ShouldOwnClient true if the diagnostic object should take 40533e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis /// ownership of \c client. 40678ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie void setClient(DiagnosticConsumer *client, bool ShouldOwnClient = true); 4075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 408af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Specify a limit for the number of errors we should 409af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// emit before giving up. 410af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 411af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// Zero disables the limit. 412c100214fdc41a7ea215f75d433eb1cb829fd4330Chris Lattner void setErrorLimit(unsigned Limit) { ErrorLimit = Limit; } 413b205ac9fcd22b87b41697172d1983c5ae9dabaafChris Lattner 414575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor /// \brief Specify the maximum number of template instantiation 415575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor /// notes to emit along with a given diagnostic. 416575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor void setTemplateBacktraceLimit(unsigned Limit) { 417575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor TemplateBacktraceLimit = Limit; 418575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor } 41908d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith 420575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor /// \brief Retrieve the maximum number of template instantiation 42108d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith /// notes to emit along with a given diagnostic. 422575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor unsigned getTemplateBacktraceLimit() const { 423575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor return TemplateBacktraceLimit; 424575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor } 42508d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith 42608d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith /// \brief Specify the maximum number of constexpr evaluation 42708d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith /// notes to emit along with a given diagnostic. 42808d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith void setConstexprBacktraceLimit(unsigned Limit) { 42908d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith ConstexprBacktraceLimit = Limit; 43008d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith } 43108d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith 43208d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith /// \brief Retrieve the maximum number of constexpr evaluation 43308d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith /// notes to emit along with a given diagnostic. 43408d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith unsigned getConstexprBacktraceLimit() const { 43508d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith return ConstexprBacktraceLimit; 43608d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith } 43708d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith 438af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief When set to true, any unmapped warnings are ignored. 439af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 440af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// If this and WarningsAsErrors are both set, then this one wins. 4415b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner void setIgnoreAllWarnings(bool Val) { IgnoreAllWarnings = Val; } 4425b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner bool getIgnoreAllWarnings() const { return IgnoreAllWarnings; } 4431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 444af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief When set to true, any unmapped ignored warnings are no longer 445af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// ignored. 446af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 447af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// If this and IgnoreAllWarnings are both set, then that one wins. 4481e473ccb0e0f6fd1954bef330f7193c1a3fb3ba1Ted Kremenek void setEnableAllWarnings(bool Val) { EnableAllWarnings = Val; } 44904863a86d15cb8de3361f8c77cedfd025819f174Benjamin Kramer bool getEnableAllWarnings() const { return EnableAllWarnings; } 45004863a86d15cb8de3361f8c77cedfd025819f174Benjamin Kramer 451af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief When set to true, any warnings reported are issued as errors. 4525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setWarningsAsErrors(bool Val) { WarningsAsErrors = Val; } 4535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getWarningsAsErrors() const { return WarningsAsErrors; } 4541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 455af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief When set to true, any error reported is made a fatal error. 456e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner void setErrorsAsFatal(bool Val) { ErrorsAsFatal = Val; } 457e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner bool getErrorsAsFatal() const { return ErrorsAsFatal; } 458e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner 4594967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar /// \brief When set to true, any fatal error reported is made an error. 4604967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar /// 4614967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar /// This setting takes precedence over the setErrorsAsFatal setting above. 4624967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar void setFatalsAsError(bool Val) { FatalsAsError = Val; } 4634967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar bool getFatalsAsError() const { return FatalsAsError; } 4644967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar 465af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief When set to true mask warnings that come from system headers. 4662fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar void setSuppressSystemWarnings(bool Val) { SuppressSystemWarnings = Val; } 4672fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar bool getSuppressSystemWarnings() const { return SuppressSystemWarnings; } 4682fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar 46981b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor /// \brief Suppress all diagnostics, to silence the front end when we 47081b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor /// know that we don't want any more diagnostics to be passed along to the 47181b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor /// client 47281b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor void setSuppressAllDiagnostics(bool Val = true) { 47381b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor SuppressAllDiagnostics = Val; 47481b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor } 47581b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor bool getSuppressAllDiagnostics() const { return SuppressAllDiagnostics; } 476246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu 477246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu /// \brief Set type eliding, to skip outputting same types occurring in 478246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu /// template types. 479246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu void setElideType(bool Val = true) { ElideType = Val; } 480246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu bool getElideType() { return ElideType; } 481246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu 482246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu /// \brief Set tree printing, to outputting the template difference in a 483246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu /// tree format. 484246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu void setPrintTemplateTree(bool Val = false) { PrintTemplateTree = Val; } 485246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu bool getPrintTemplateTree() { return PrintTemplateTree; } 486246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu 487246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu /// \brief Set color printing, so the type diffing will inject color markers 488246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu /// into the output. 489246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu void setShowColors(bool Val = false) { ShowColors = Val; } 490246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu bool getShowColors() { return ShowColors; } 491246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu 4925edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin /// \brief Specify which overload candidates to show when overload resolution 493af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// fails. 494af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 495af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// By default, we show all candidates. 4965edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin void setShowOverloads(OverloadsShown Val) { 4975edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin ShowOverloads = Val; 4985edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin } 4995edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin OverloadsShown getShowOverloads() const { return ShowOverloads; } 5005edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin 5015d99a252c63a7745bcd71231ca5240d2a65e4f1dRichard Smith /// \brief Pretend that the last diagnostic issued was ignored, so any 5025d99a252c63a7745bcd71231ca5240d2a65e4f1dRichard Smith /// subsequent notes will be suppressed. 503af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 504af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// This can be used by clients who suppress diagnostics themselves. 5050b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor void setLastDiagnosticIgnored() { 5065d99a252c63a7745bcd71231ca5240d2a65e4f1dRichard Smith if (LastDiagLevel == DiagnosticIDs::Fatal) 5075d99a252c63a7745bcd71231ca5240d2a65e4f1dRichard Smith FatalErrorOccurred = true; 50833e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis LastDiagLevel = DiagnosticIDs::Ignored; 5090b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor } 510cbc820af7193e3ad9c71fbe6e3c8bd3c1166e540Richard Smith 511cbc820af7193e3ad9c71fbe6e3c8bd3c1166e540Richard Smith /// \brief Determine whether the previous diagnostic was ignored. This can 512cbc820af7193e3ad9c71fbe6e3c8bd3c1166e540Richard Smith /// be used by clients that want to determine whether notes attached to a 513cbc820af7193e3ad9c71fbe6e3c8bd3c1166e540Richard Smith /// diagnostic will be suppressed. 514cbc820af7193e3ad9c71fbe6e3c8bd3c1166e540Richard Smith bool isLastDiagnosticIgnored() const { 515cbc820af7193e3ad9c71fbe6e3c8bd3c1166e540Richard Smith return LastDiagLevel == DiagnosticIDs::Ignored; 516cbc820af7193e3ad9c71fbe6e3c8bd3c1166e540Richard Smith } 517cbc820af7193e3ad9c71fbe6e3c8bd3c1166e540Richard Smith 518af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Controls whether otherwise-unmapped extension diagnostics are 519af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// mapped onto ignore/warning/error. 520af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 521af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// This corresponds to the GCC -pedantic and -pedantic-errors option. 522c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines void setExtensionHandlingBehavior(diag::Severity H) { ExtBehavior = H; } 523c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines diag::Severity getExtensionHandlingBehavior() const { return ExtBehavior; } 5241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 525af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Counter bumped when an __extension__ block is/ encountered. 526af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 527af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// When non-zero, all extension diagnostics are entirely silenced, no 528af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// matter how they are mapped. 52927ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner void IncrementAllExtensionsSilenced() { ++AllExtensionsSilenced; } 53027ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner void DecrementAllExtensionsSilenced() { --AllExtensionsSilenced; } 53191a2886d558ea6ca7a0bed73ab5acea5ae78eac2Douglas Gregor bool hasAllExtensionsSilenced() { return AllExtensionsSilenced != 0; } 5321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 533697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief This allows the client to specify that certain warnings are 534697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// ignored. 535697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 536697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// Notes can never be mapped, errors can only be mapped to fatal, and 537697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// WARNINGs and EXTENSIONs can be mapped arbitrarily. 5380827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// 5390827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \param Loc The source location that this change of diagnostic state should 5400827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// take affect. It can be null if we are setting the latest state. 541c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines void setSeverity(diag::kind Diag, diag::Severity Map, SourceLocation Loc); 5421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 543697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Change an entire diagnostic group (e.g. "unknown-pragmas") to 544697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// have the specified mapping. 545697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 546697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \returns true (and ignores the request) if "Group" was unknown, false 547697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// otherwise. 5480827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// 549176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines /// \param Flavor The flavor of group to affect. -Rfoo does not affect the 550176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines /// state of the -Wfoo group and vice versa. 551176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines /// 552697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \param Loc The source location that this change of diagnostic state should 5530827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// take affect. It can be null if we are setting the state from command-line. 554176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines bool setSeverityForGroup(diag::Flavor Flavor, StringRef Group, 555176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines diag::Severity Map, 556c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines SourceLocation Loc = SourceLocation()); 5575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 558697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Set the warning-as-error flag for the given diagnostic group. 559697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 560697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// This function always only operates on the current diagnostic state. 5614aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar /// 5624aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar /// \returns True if the given group is unknown, false otherwise. 5634aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar bool setDiagnosticGroupWarningAsError(StringRef Group, bool Enabled); 5644aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar 565697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Set the error-as-fatal flag for the given diagnostic group. 566697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 567697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// This function always only operates on the current diagnostic state. 5684aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar /// 5694aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar /// \returns True if the given group is unknown, false otherwise. 5704aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar bool setDiagnosticGroupErrorAsFatal(StringRef Group, bool Enabled); 5714aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar 572176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines /// \brief Add the specified mapping to all diagnostics of the specified 573176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines /// flavor. 574697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 575697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// Mainly to be used by -Wno-everything to disable all warnings but allow 576697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// subsequent -W options to enable specific warnings. 577176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines void setSeverityForAll(diag::Flavor Flavor, diag::Severity Map, 578c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines SourceLocation Loc = SourceLocation()); 57911583c757bac6ce5c342f2eb572055dd2619a657Argyrios Kyrtzidis 5805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool hasErrorOccurred() const { return ErrorOccurred; } 58112f37e411462b8388eb1309357bd62257debacacDeLesley Hutchins 58212f37e411462b8388eb1309357bd62257debacacDeLesley Hutchins /// \brief Errors that actually prevent compilation, not those that are 58312f37e411462b8388eb1309357bd62257debacacDeLesley Hutchins /// upgraded from a warning by -Werror. 58412f37e411462b8388eb1309357bd62257debacacDeLesley Hutchins bool hasUncompilableErrorOccurred() const { 58512f37e411462b8388eb1309357bd62257debacacDeLesley Hutchins return UncompilableErrorOccurred; 58612f37e411462b8388eb1309357bd62257debacacDeLesley Hutchins } 58715221422eda7bac679e38b07512feda49715ef66Chris Lattner bool hasFatalErrorOccurred() const { return FatalErrorOccurred; } 58885bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor 58985bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor /// \brief Determine whether any kind of unrecoverable error has occurred. 59085bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor bool hasUnrecoverableErrorOccurred() const { 59185bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor return FatalErrorOccurred || UnrecoverableErrorOccurred; 59285bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor } 59385bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor 59453eee7ba970d21ff15bbd4334164037a3b4cc4b8Chris Lattner unsigned getNumWarnings() const { return NumWarnings; } 5951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 596c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor void setNumWarnings(unsigned NumWarnings) { 597c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor this->NumWarnings = NumWarnings; 598c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor } 599c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 600651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines /// \brief Return an ID for a diagnostic with the specified format string and 601651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines /// level. 602697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 603fc09336a5965040736f9bc63a70416003972364eStefanus Du Toit /// If this is the first request for this diagnostic, it is registered and 604697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// created, otherwise the existing ID is returned. 605651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines /// 606651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines /// \param FormatString A fixed diagnostic format string that will be hashed 607651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines /// and mapped to a unique DiagID. 608651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines template <unsigned N> 609651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines unsigned getCustomDiagID(Level L, const char (&FormatString)[N]) { 610651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines return Diags->getCustomDiagID((DiagnosticIDs::Level)L, 611651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines StringRef(FormatString, N - 1)); 61233e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis } 6131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 614697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Converts a diagnostic argument (as an intptr_t) into the string 615697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// that represents it. 6163fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner void ConvertArgToString(ArgumentKind Kind, intptr_t Val, 617c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines StringRef Modifier, StringRef Argument, 618c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines ArrayRef<ArgumentValue> PrevArgs, 619686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<char> &Output, 6204def70d3040e73707c738f7c366737a986135edfRichard Smith ArrayRef<intptr_t> QualTypeVals) const { 621c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines ArgToStringFn(Kind, Val, Modifier, Argument, PrevArgs, Output, 622c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines ArgToStringCookie, QualTypeVals); 62322caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 6241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 62592dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner void SetArgToStringFn(ArgToStringFnTy Fn, void *Cookie) { 6263fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ArgToStringFn = Fn; 62792dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner ArgToStringCookie = Cookie; 62822caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 6291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6305b9268f26ac53a74d2c504279fe577d988d5615dRichard Smith /// \brief Note that the prior diagnostic was emitted by some other 6315b9268f26ac53a74d2c504279fe577d988d5615dRichard Smith /// \c DiagnosticsEngine, and we may be attaching a note to that diagnostic. 6325b9268f26ac53a74d2c504279fe577d988d5615dRichard Smith void notePriorDiagnosticFrom(const DiagnosticsEngine &Other) { 6335b9268f26ac53a74d2c504279fe577d988d5615dRichard Smith LastDiagLevel = Other.LastDiagLevel; 6345b9268f26ac53a74d2c504279fe577d988d5615dRichard Smith } 6355b9268f26ac53a74d2c504279fe577d988d5615dRichard Smith 636abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \brief Reset the state of the diagnostic object to its initial 637abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// configuration. 638abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor void Reset(); 639abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor 6405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 641d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie // DiagnosticsEngine classification and reporting interfaces. 6425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // 6435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 644c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines /// \brief Determine whether the diagnostic is known to be ignored. 645c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines /// 646c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines /// This can be used to opportunistically avoid expensive checks when it's 647c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines /// known for certain that the diagnostic has been suppressed at the 648c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines /// specified location \p Loc. 649c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines /// 650c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines /// \param Loc The source location we are interested in finding out the 651c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines /// diagnostic state. Can be null in order to query the latest state. 652c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines bool isIgnored(unsigned DiagID, SourceLocation Loc) const { 653c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines return Diags->getDiagnosticSeverity(DiagID, Loc, *this) == 654c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines diag::Severity::Ignored; 655c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines } 656c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines 657d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie /// \brief Based on the way the client configured the DiagnosticsEngine 6585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// object, classify the specified diagnostic ID into a Level, consumable by 65978ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie /// the DiagnosticConsumer. 6600827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// 661c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines /// To preserve invariant assumptions, this function should not be used to 662c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines /// influence parse or semantic analysis actions. Instead consider using 663c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines /// \c isIgnored(). 664c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines /// 6650827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \param Loc The source location we are interested in finding out the 6660827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// diagnostic state. Can be null in order to query the latest state. 6671656aaec223949245fdbebf306b719cba0b687caDaniel Dunbar Level getDiagnosticLevel(unsigned DiagID, SourceLocation Loc) const { 6681656aaec223949245fdbebf306b719cba0b687caDaniel Dunbar return (Level)Diags->getDiagnosticLevel(DiagID, Loc, *this); 66933e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis } 6701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 671697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Issue the message to the client. 672697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 673697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// This actually returns an instance of DiagnosticBuilder which emits the 674697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// diagnostics (through @c ProcessDiag) when it is destroyed. 675697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 676697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \param DiagID A member of the @c diag::kind enum. 677efce31f51d6e7e31e125f96c20f6cdab3ead0a47James Dennett /// \param Loc Represents the source location associated with the diagnostic, 678509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// which can be an invalid location if no position information is available. 679efce31f51d6e7e31e125f96c20f6cdab3ead0a47James Dennett inline DiagnosticBuilder Report(SourceLocation Loc, unsigned DiagID); 6800f9fed70cea107b3f79df554e38bd8e98d48fe47Daniel Dunbar inline DiagnosticBuilder Report(unsigned DiagID); 681de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor 682e59abb56ce0e1c206fb80bd945a0c358b0abe1efArgyrios Kyrtzidis void Report(const StoredDiagnostic &storedDiag); 683e59abb56ce0e1c206fb80bd945a0c358b0abe1efArgyrios Kyrtzidis 68493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief Determine whethere there is already a diagnostic in flight. 6855800f7ea9cf5621280089d690f677bd28064d6b5Ted Kremenek bool isDiagnosticInFlight() const { return CurDiagID != ~0U; } 68693ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 68793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief Set the "delayed" diagnostic that will be emitted once 68893ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// the current diagnostic completes. 68993ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// 69093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// If a diagnostic is already in-flight but the front end must 69193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// report a problem (e.g., with an inconsistent file system 69293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// state), this routine sets a "delayed" diagnostic that will be 69393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// emitted after the current diagnostic completes. This should 69493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// only be used for fatal errors detected at inconvenient 69593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// times. If emitting a delayed diagnostic causes a second delayed 69693ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// diagnostic to be introduced, that second delayed diagnostic 69793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// will be ignored. 69893ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// 69993ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \param DiagID The ID of the diagnostic being delayed. 70093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// 70193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \param Arg1 A string argument that will be provided to the 70293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// diagnostic. A copy of this string will be stored in the 703d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie /// DiagnosticsEngine object itself. 70493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// 70593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \param Arg2 A string argument that will be provided to the 70693ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// diagnostic. A copy of this string will be stored in the 707d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie /// DiagnosticsEngine object itself. 708686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void SetDelayedDiagnostic(unsigned DiagID, StringRef Arg1 = "", 709686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef Arg2 = ""); 71093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 711de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor /// \brief Clear out the current diagnostic. 712de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor void Clear() { CurDiagID = ~0U; } 7131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 714c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines /// \brief Return the value associated with this diagnostic flag. 715c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines StringRef getFlagValue() const { return FlagValue; } 7166bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 7170a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattnerprivate: 71893ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief Report the delayed diagnostic. 71993ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor void ReportDelayed(); 72093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 7213cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner // This is private state used by DiagnosticBuilder. We put it here instead of 7223cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner // in DiagnosticBuilder in order to keep DiagnosticBuilder a small lightweight 7230a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // object. This implementation choice means that we can only have one 7240a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // diagnostic "in flight" at a time, but this seems to be a reasonable 7250a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // tradeoff to keep these objects small. Assertions verify that only one 7260a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // diagnostic is in flight at a time. 72733e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis friend class DiagnosticIDs; 7283cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner friend class DiagnosticBuilder; 72940847cfb58acc3cac7d68727df9455ac45f2e118David Blaikie friend class Diagnostic; 7309b623639378d53a675921ddfa7316034d571881eDouglas Gregor friend class PartialDiagnostic; 7319c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis friend class DiagnosticErrorTrap; 7329b623639378d53a675921ddfa7316034d571881eDouglas Gregor 733697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief The location of the current diagnostic that is in flight. 73433e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis SourceLocation CurDiagLoc; 7351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 736697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief The ID of the current diagnostic that is in flight. 737697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 7383cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// This is set to ~0U when there is no diagnostic in flight. 739b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner unsigned CurDiagID; 740b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner 74173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner enum { 742697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief The maximum number of arguments we can hold. 743697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 744af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// We currently only support up to 10 arguments (%0-%9). A single 745af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// diagnostic with more than that almost certainly has to be simplified 746af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// anyway. 747981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar MaxArguments = 10, 74873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner }; 7491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 750697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief The number of entries in Arguments. 751730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner signed char NumDiagArgs; 752ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 753af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Specifies whether an argument is in DiagArgumentsStr or 754af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// in DiagArguments. 755af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 756af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// This is an array of ArgumentKind::ArgumentKind enum values, one for each 757af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// argument. 75873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner unsigned char DiagArgumentsKind[MaxArguments]; 7591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 760af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Holds the values of each string argument for the current 761697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// diagnostic. 762697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 763697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// This is only used when the corresponding ArgumentKind is ak_std_string. 76473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner std::string DiagArgumentsStr[MaxArguments]; 76573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 766697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief The values for the various substitution positions. 767697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 768697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// This is used when the argument is not an std::string. The specific 769697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// value is mangled into an intptr_t and the interpretation depends on 770697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// exactly what sort of argument kind it is. 77173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner intptr_t DiagArgumentsVal[MaxArguments]; 7721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 773697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief The list of ranges added to this diagnostic. 7746bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines SmallVector<CharSourceRange, 8> DiagRanges; 7751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 776697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief If valid, provides a hint with some code to insert, remove, 777981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar /// or modify at a particular position. 7786bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines SmallVector<FixItHint, 8> DiagFixItHints; 7794b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 780c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines DiagnosticMapping makeUserMapping(diag::Severity Map, SourceLocation L) { 78187429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis bool isPragma = L.isValid(); 782c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines DiagnosticMapping Mapping = 783c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines DiagnosticMapping::Make(Map, /*IsUser=*/true, isPragma); 78487429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis 78587429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis // If this is a pragma mapping, then set the diagnostic mapping flags so 78687429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis // that we override command line options. 78787429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis if (isPragma) { 788c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines Mapping.setNoWarningAsError(true); 789c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines Mapping.setNoErrorAsFatal(true); 79087429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis } 79187429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis 792c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines return Mapping; 79387429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis } 79487429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis 795697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Used to report a diagnostic that is finally fully formed. 7965e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// 797697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \returns true if the diagnostic was emitted, false if it was suppressed. 79833e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis bool ProcessDiag() { 79933e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return Diags->ProcessDiag(*this); 80033e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis } 801f41d3be39980d40849850d3fb90403623cc8459eArgyrios Kyrtzidis 802393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar /// @name Diagnostic Emission 803393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar /// @{ 804393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbarprotected: 805393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar // Sema requires access to the following functions because the current design 806393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar // of SFINAE requires it to use its own SemaDiagnosticBuilder, which needs to 807393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar // access us directly to ensure we minimize the emitted code for the common 808393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar // Sema::Diag() patterns. 809393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar friend class Sema; 810393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar 8113054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar /// \brief Emit the current diagnostic and clear the diagnostic state. 812c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose /// 813c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose /// \param Force Emit the diagnostic regardless of suppression settings. 814c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose bool EmitCurrentDiagnostic(bool Force = false); 8153054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar 816393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar unsigned getCurrentDiagID() const { return CurDiagID; } 817393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar 818393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar SourceLocation getCurrentDiagLoc() const { return CurDiagLoc; } 819393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar 820393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar /// @} 821393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar 822f41d3be39980d40849850d3fb90403623cc8459eArgyrios Kyrtzidis friend class ASTReader; 823f41d3be39980d40849850d3fb90403623cc8459eArgyrios Kyrtzidis friend class ASTWriter; 8243cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}; 8253cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 8269c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis/// \brief RAII class that determines when any errors have occurred 8279c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis/// between the time the instance was created and the time it was 8289c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis/// queried. 8299c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidisclass DiagnosticErrorTrap { 830d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine &Diag; 831c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis unsigned NumErrors; 832c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis unsigned NumUnrecoverableErrors; 8339c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis 8349c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidispublic: 835d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie explicit DiagnosticErrorTrap(DiagnosticsEngine &Diag) 836add80bb3957dba1d9389304453c0a4c975768bd7John McCall : Diag(Diag) { reset(); } 8379c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis 8389c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis /// \brief Determine whether any errors have occurred since this 8399c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis /// object instance was created. 8409c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis bool hasErrorOccurred() const { 841c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis return Diag.TrapNumErrorsOccurred > NumErrors; 842add80bb3957dba1d9389304453c0a4c975768bd7John McCall } 843add80bb3957dba1d9389304453c0a4c975768bd7John McCall 844add80bb3957dba1d9389304453c0a4c975768bd7John McCall /// \brief Determine whether any unrecoverable errors have occurred since this 845add80bb3957dba1d9389304453c0a4c975768bd7John McCall /// object instance was created. 846add80bb3957dba1d9389304453c0a4c975768bd7John McCall bool hasUnrecoverableErrorOccurred() const { 847c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis return Diag.TrapNumUnrecoverableErrorsOccurred > NumUnrecoverableErrors; 8489c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis } 8499c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis 850af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Set to initial state of "no errors occurred". 851add80bb3957dba1d9389304453c0a4c975768bd7John McCall void reset() { 852c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis NumErrors = Diag.TrapNumErrorsOccurred; 853c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis NumUnrecoverableErrors = Diag.TrapNumUnrecoverableErrorsOccurred; 854add80bb3957dba1d9389304453c0a4c975768bd7John McCall } 8559c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis}; 8569c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis 8573cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 8583cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner// DiagnosticBuilder 8593cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 8603cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 861697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// \brief A little helper class used to produce diagnostics. 862697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// 863697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// This is constructed by the DiagnosticsEngine::Report method, and 864697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// allows insertion of extra information (arguments and source ranges) into 865697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// the currently "in flight" diagnostic. When the temporary for the builder 866697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// is destroyed, the diagnostic is issued. 8673cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// 8683cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// Note that many of these will be created as temporary objects (many call 8693cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// sites), so we want them to be small and we never want their address taken. 8703cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// This ensures that compilers with somewhat reasonable optimizers will promote 8713cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// the common fields to registers, eliminating increments of the NumArgs field, 8723cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// for example. 8733cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerclass DiagnosticBuilder { 87487d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar mutable DiagnosticsEngine *DiagObj = nullptr; 87587d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar mutable unsigned NumArgs = 0; 8761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8777059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar /// \brief Status variable indicating if this diagnostic is still active. 8787059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar /// 879f3477c13eeaf11b32a41f181398fb5deffd0dd73Sylvestre Ledru // NOTE: This field is redundant with DiagObj (IsActive iff (DiagObj == 0)), 8807059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar // but LLVM is not currently smart enough to eliminate the null check that 8817059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar // Emit() would end up with if we used that as our status variable. 88287d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar mutable bool IsActive = false; 8837059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar 884c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose /// \brief Flag indicating that this diagnostic is being emitted via a 885c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose /// call to ForceEmit. 88687d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar mutable bool IsForceEmit = false; 887c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose 8880e2c34f92f00628d48968dfea096d36381f494cbStephen Hines void operator=(const DiagnosticBuilder &) = delete; 889d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie friend class DiagnosticsEngine; 8906bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 89187d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar DiagnosticBuilder() = default; 892ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor 893d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie explicit DiagnosticBuilder(DiagnosticsEngine *diagObj) 89487d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar : DiagObj(diagObj), IsActive(true) { 895981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar assert(diagObj && "DiagnosticBuilder requires a valid DiagnosticsEngine!"); 8966bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines diagObj->DiagRanges.clear(); 8976bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines diagObj->DiagFixItHints.clear(); 898cbf46a0b2bb2b47d6e13437e0d52cc583c5ce539Argyrios Kyrtzidis } 899ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 9009b623639378d53a675921ddfa7316034d571881eDouglas Gregor friend class PartialDiagnostic; 901ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor 902b535041ee33c5eff255832bc5541c8d52aae8254Douglas Gregorprotected: 9033054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar void FlushCounts() { 9043054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar DiagObj->NumDiagArgs = NumArgs; 9053054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar } 90606265bd82073c06294a02a0bd891951fafb484a5Daniel Dunbar 907cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// \brief Clear out the current diagnostic. 9087059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar void Clear() const { 9096bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines DiagObj = nullptr; 9107059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar IsActive = false; 911c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose IsForceEmit = false; 9127059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar } 913cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar 914697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Determine whether this diagnostic is still active. 9157059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar bool isActive() const { return IsActive; } 91606265bd82073c06294a02a0bd891951fafb484a5Daniel Dunbar 917cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// \brief Force the diagnostic builder to emit the diagnostic now. 918cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// 919cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// Once this function has been called, the DiagnosticBuilder object 920cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// should not be used again before it is destroyed. 921cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// 922cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// \returns true if a diagnostic was emitted, false if the 923cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// diagnostic was suppressed. 9243054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar bool Emit() { 9257059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar // If this diagnostic is inactive, then its soul was stolen by the copy ctor 9267059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar // (or by a subclass, as in SemaDiagnosticBuilder). 9277059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar if (!isActive()) return false; 9283054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar 9293054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar // When emitting diagnostics, we set the final argument count into 9303054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar // the DiagnosticsEngine object. 9313054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar FlushCounts(); 9323054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar 9333054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar // Process the diagnostic. 934c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose bool Result = DiagObj->EmitCurrentDiagnostic(IsForceEmit); 9353054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar 9363054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar // This diagnostic is dead. 9377059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar Clear(); 9383054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar 9393054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar return Result; 9403054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar } 9419b623639378d53a675921ddfa7316034d571881eDouglas Gregor 9421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumppublic: 9430a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// Copy constructor. When copied, this "takes" the diagnostic info from the 9440a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// input and neuters it. 9453cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagnosticBuilder(const DiagnosticBuilder &D) { 9460a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner DiagObj = D.DiagObj; 9477059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar IsActive = D.IsActive; 948c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose IsForceEmit = D.IsForceEmit; 9497059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar D.Clear(); 95025a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor NumArgs = D.NumArgs; 9510a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 95225a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor 953ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor /// \brief Retrieve an empty diagnostic builder. 954ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor static DiagnosticBuilder getEmpty() { 955ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor return DiagnosticBuilder(); 956ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor } 957ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor 958697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Emits the diagnostic. 95953c83b32550b3f29db2419160fa2e3684e420556Daniel Dunbar ~DiagnosticBuilder() { 9603054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar Emit(); 96153c83b32550b3f29db2419160fa2e3684e420556Daniel Dunbar } 9629b623639378d53a675921ddfa7316034d571881eDouglas Gregor 963c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose /// \brief Forces the diagnostic to be emitted. 964c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose const DiagnosticBuilder &setForceEmit() const { 965c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose IsForceEmit = true; 966c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose return *this; 967c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose } 968c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose 969af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Conversion of DiagnosticBuilder to bool always returns \c true. 970af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 971af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// This allows is to be used in boolean error contexts (where \c true is 972af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// used to indicate that an error has occurred), like: 973af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \code 9743cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// return Diag(...); 975af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \endcode 9763cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner operator bool() const { return true; } 9773cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 978686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void AddString(StringRef S) 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] = DiagnosticsEngine::ak_std_string; 983cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar DiagObj->DiagArgumentsStr[NumArgs++] = S; 9843cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner } 9851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 986d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie void AddTaggedVal(intptr_t V, DiagnosticsEngine::ArgumentKind Kind) const { 987cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar assert(isActive() && "Clients must not add to cleared diagnostic!"); 988d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(NumArgs < DiagnosticsEngine::MaxArguments && 9893cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 990cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar DiagObj->DiagArgumentsKind[NumArgs] = Kind; 991cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar DiagObj->DiagArgumentsVal[NumArgs++] = V; 9920a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 9931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9940a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner void AddSourceRange(const CharSourceRange &R) const { 995cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar assert(isActive() && "Clients must not add to cleared diagnostic!"); 9966bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines DiagObj->DiagRanges.push_back(R); 9971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 9984b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 999849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor void AddFixItHint(const FixItHint &Hint) const { 1000cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar assert(isActive() && "Clients must not add to cleared diagnostic!"); 10010e2c34f92f00628d48968dfea096d36381f494cbStephen Hines if (!Hint.isNull()) 10020e2c34f92f00628d48968dfea096d36381f494cbStephen Hines DiagObj->DiagFixItHints.push_back(Hint); 10034b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 100482c6dc72adc30e785ce5bc6e8b43ae92070d2e08David Blaikie 1005c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines void addFlagValue(StringRef V) const { DiagObj->FlagValue = V; } 10066bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines}; 10075940bf33061844c9a61d4d5c1230df9cf9e90342Richard Trieu 10086bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hinesstruct AddFlagValue { 10096bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines explicit AddFlagValue(StringRef V) : Val(V) {} 10106bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines StringRef Val; 10113cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}; 10123cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 10136bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines/// \brief Register a value for the flag in the current diagnostic. This 10146bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines/// value will be shown as the suffix "=value" after the flag name. It is 10156bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines/// useful in cases where the diagnostic flag accepts values (e.g., 10166bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines/// -Rpass or -Wframe-larger-than). 10176bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hinesinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 10186bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines const AddFlagValue V) { 10196bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines DB.addFlagValue(V.Val); 10206bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines return DB; 10216bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines} 10226bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 10233cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 1024686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef S) { 10253cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddString(S); 10263cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 10273cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 10283cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 10293cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 10303cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const char *Str) { 10313cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(reinterpret_cast<intptr_t>(Str), 1032d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine::ak_c_string); 10333cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 10343cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 10353cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 10363cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, int I) { 1037d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DB.AddTaggedVal(I, DiagnosticsEngine::ak_sint); 10383cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 10393cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 10403cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 1041651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines// We use enable_if here to prevent that this overload is selected for 1042651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines// pointers or other arguments that are implicitly convertible to bool. 1043651f13cea278ec967336033dd032faef0e9fc2ecStephen Hinestemplate <typename T> 1044651f13cea278ec967336033dd032faef0e9fc2ecStephen Hinesinline 1045651f13cea278ec967336033dd032faef0e9fc2ecStephen Hinestypename std::enable_if<std::is_same<T, bool>::value, 1046651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines const DiagnosticBuilder &>::type 1047651f13cea278ec967336033dd032faef0e9fc2ecStephen Hinesoperator<<(const DiagnosticBuilder &DB, T I) { 1048d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DB.AddTaggedVal(I, DiagnosticsEngine::ak_sint); 10493bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis return DB; 10503bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis} 10513bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis 10523cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 10533cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner unsigned I) { 1054d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DB.AddTaggedVal(I, DiagnosticsEngine::ak_uint); 10553cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 10563cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 10573cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 10583cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 1059651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines tok::TokenKind I) { 1060651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines DB.AddTaggedVal(static_cast<unsigned>(I), DiagnosticsEngine::ak_tokenkind); 1061651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines return DB; 1062651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines} 1063651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines 1064651f13cea278ec967336033dd032faef0e9fc2ecStephen Hinesinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 10653cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const IdentifierInfo *II) { 10663cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(reinterpret_cast<intptr_t>(II), 1067d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine::ak_identifierinfo); 10683cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 10693cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 10701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10713f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// Adds a DeclContext to the diagnostic. The enable_if template magic is here 10723f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// so that we only match those arguments that are (statically) DeclContexts; 10733f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// other arguments that derive from DeclContext (e.g., RecordDecls) will not 10743f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// match. 10754967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainartemplate <typename T> 10764967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainarinline typename std::enable_if< 10774967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar std::is_same<typename std::remove_const<T>::type, DeclContext>::value, 10784967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar const DiagnosticBuilder &>::type 10793f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregoroperator<<(const DiagnosticBuilder &DB, T *DC) { 10803f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor DB.AddTaggedVal(reinterpret_cast<intptr_t>(DC), 1081d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine::ak_declcontext); 10823f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor return DB; 10833f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor} 1084651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines 10853cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 108687d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar SourceRange R) { 10870a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner DB.AddSourceRange(CharSourceRange::getTokenRange(R)); 10883cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 10893cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 10904b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 10914b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregorinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 1092651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines ArrayRef<SourceRange> Ranges) { 109387d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar for (SourceRange R : Ranges) 1094651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines DB.AddSourceRange(CharSourceRange::getTokenRange(R)); 1095651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines return DB; 1096651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines} 1097651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines 1098651f13cea278ec967336033dd032faef0e9fc2ecStephen Hinesinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 10990a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner const CharSourceRange &R) { 11000a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner DB.AddSourceRange(R); 11010a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner return DB; 11020a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner} 1103651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines 11040a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 1105849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor const FixItHint &Hint) { 11060e2c34f92f00628d48968dfea096d36381f494cbStephen Hines DB.AddFixItHint(Hint); 11070e2c34f92f00628d48968dfea096d36381f494cbStephen Hines return DB; 11080e2c34f92f00628d48968dfea096d36381f494cbStephen Hines} 11090e2c34f92f00628d48968dfea096d36381f494cbStephen Hines 11100e2c34f92f00628d48968dfea096d36381f494cbStephen Hinesinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 11110e2c34f92f00628d48968dfea096d36381f494cbStephen Hines ArrayRef<FixItHint> Hints) { 11120e2c34f92f00628d48968dfea096d36381f494cbStephen Hines for (const FixItHint &Hint : Hints) 11133739b32a01b9778176757425e62252c288b85383Ted Kremenek DB.AddFixItHint(Hint); 11144b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor return DB; 11154b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor} 1116ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 111787d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar/// A nullability kind paired with a bit indicating whether it used a 111887d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar/// context-sensitive keyword. 111987d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainartypedef std::pair<NullabilityKind, bool> DiagNullabilityKind; 112087d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 112187d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainarconst DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 112287d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar DiagNullabilityKind nullability); 112387d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 1124d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikieinline DiagnosticBuilder DiagnosticsEngine::Report(SourceLocation Loc, 1125651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines unsigned DiagID) { 11263cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(CurDiagID == ~0U && "Multiple diagnostics in flight at once!"); 11273cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner CurDiagLoc = Loc; 11283cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner CurDiagID = DiagID; 1129c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines FlagValue.clear(); 11303cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DiagnosticBuilder(this); 11313cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 11326bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 1133d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikieinline DiagnosticBuilder DiagnosticsEngine::Report(unsigned DiagID) { 113433e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return Report(SourceLocation(), DiagID); 11350f9fed70cea107b3f79df554e38bd8e98d48fe47Daniel Dunbar} 11363cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 11373cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 113840847cfb58acc3cac7d68727df9455ac45f2e118David Blaikie// Diagnostic 11393cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 11401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1141697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// A little helper class (which is basically a smart pointer that forwards 1142697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// info from DiagnosticsEngine) that allows clients to enquire about the 1143697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// currently in-flight diagnostic. 114440847cfb58acc3cac7d68727df9455ac45f2e118David Blaikieclass Diagnostic { 1145d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie const DiagnosticsEngine *DiagObj; 1146686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef StoredDiagMessage; 11473cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerpublic: 114840847cfb58acc3cac7d68727df9455ac45f2e118David Blaikie explicit Diagnostic(const DiagnosticsEngine *DO) : DiagObj(DO) {} 114940847cfb58acc3cac7d68727df9455ac45f2e118David Blaikie Diagnostic(const DiagnosticsEngine *DO, StringRef storedDiagMessage) 1150e59abb56ce0e1c206fb80bd945a0c358b0abe1efArgyrios Kyrtzidis : DiagObj(DO), StoredDiagMessage(storedDiagMessage) {} 11511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1152d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie const DiagnosticsEngine *getDiags() const { return DiagObj; } 1153b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner unsigned getID() const { return DiagObj->CurDiagID; } 115433e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis const SourceLocation &getLocation() const { return DiagObj->CurDiagLoc; } 115533e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis bool hasSourceManager() const { return DiagObj->hasSourceManager(); } 115633e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis SourceManager &getSourceManager() const { return DiagObj->getSourceManager();} 11571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11580a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned getNumArgs() const { return DiagObj->NumDiagArgs; } 11591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1160af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Return the kind of the specified index. 1161af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 1162af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// Based on the kind of argument, the accessors below can be used to get 1163af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// the value. 1164af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 1165af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \pre Idx < getNumArgs() 1166d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine::ArgumentKind getArgKind(unsigned Idx) const { 11673cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(Idx < getNumArgs() && "Argument index out of range!"); 1168d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie return (DiagnosticsEngine::ArgumentKind)DiagObj->DiagArgumentsKind[Idx]; 116973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner } 11701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1171af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Return the provided argument string specified by \p Idx. 1172af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_std_string 117373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner const std::string &getArgStdStr(unsigned Idx) const { 1174d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(getArgKind(Idx) == DiagnosticsEngine::ak_std_string && 11753cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 117673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner return DiagObj->DiagArgumentsStr[Idx]; 117773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner } 11781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1179af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Return the specified C string argument. 1180af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_c_string 118173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner const char *getArgCStr(unsigned Idx) const { 1182d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(getArgKind(Idx) == DiagnosticsEngine::ak_c_string && 11833cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 118473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner return reinterpret_cast<const char*>(DiagObj->DiagArgumentsVal[Idx]); 11850a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 11861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1187af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Return the specified signed integer argument. 1188af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_sint 118930bc96544346bea42921cf6837e66cef80d664b4Chris Lattner int getArgSInt(unsigned Idx) const { 1190d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(getArgKind(Idx) == DiagnosticsEngine::ak_sint && 11913cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 119230bc96544346bea42921cf6837e66cef80d664b4Chris Lattner return (int)DiagObj->DiagArgumentsVal[Idx]; 119330bc96544346bea42921cf6837e66cef80d664b4Chris Lattner } 11941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1195af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Return the specified unsigned integer argument. 1196af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_uint 119730bc96544346bea42921cf6837e66cef80d664b4Chris Lattner unsigned getArgUInt(unsigned Idx) const { 1198d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(getArgKind(Idx) == DiagnosticsEngine::ak_uint && 11993cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 120030bc96544346bea42921cf6837e66cef80d664b4Chris Lattner return (unsigned)DiagObj->DiagArgumentsVal[Idx]; 120130bc96544346bea42921cf6837e66cef80d664b4Chris Lattner } 12021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1203af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Return the specified IdentifierInfo argument. 1204af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_identifierinfo 120543b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner const IdentifierInfo *getArgIdentifier(unsigned Idx) const { 1206d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(getArgKind(Idx) == DiagnosticsEngine::ak_identifierinfo && 12073cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 12089634379265855f1628190e926d9aaf1fb4a5d90eChris Lattner return reinterpret_cast<IdentifierInfo*>(DiagObj->DiagArgumentsVal[Idx]); 120943b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner } 12101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1211af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Return the specified non-string argument in an opaque form. 1212af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \pre getArgKind(Idx) != DiagnosticsEngine::ak_std_string 121322caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner intptr_t getRawArg(unsigned Idx) const { 1214d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(getArgKind(Idx) != DiagnosticsEngine::ak_std_string && 121522caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner "invalid argument accessor!"); 121622caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner return DiagObj->DiagArgumentsVal[Idx]; 121722caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 12181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1219af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Return the number of source ranges associated with this diagnostic. 12200a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned getNumRanges() const { 12216bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines return DiagObj->DiagRanges.size(); 12220a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 12231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1224af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \pre Idx < getNumRanges() 12250a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner const CharSourceRange &getRange(unsigned Idx) const { 12266bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines assert(Idx < getNumRanges() && "Invalid diagnostic range index!"); 122751c6d384551674facc19f745ecf6e289d28dc55fDouglas Gregor return DiagObj->DiagRanges[Idx]; 12280a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 12291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 123028409289193afca1a3178a9796f8e8aebcb76896Chandler Carruth /// \brief Return an array reference for this diagnostic's ranges. 123128409289193afca1a3178a9796f8e8aebcb76896Chandler Carruth ArrayRef<CharSourceRange> getRanges() const { 12326bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines return DiagObj->DiagRanges; 123328409289193afca1a3178a9796f8e8aebcb76896Chandler Carruth } 123428409289193afca1a3178a9796f8e8aebcb76896Chandler Carruth 1235849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor unsigned getNumFixItHints() const { 12366bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines return DiagObj->DiagFixItHints.size(); 12374b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 12384b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1239849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor const FixItHint &getFixItHint(unsigned Idx) const { 1240981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar assert(Idx < getNumFixItHints() && "Invalid index!"); 1241981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar return DiagObj->DiagFixItHints[Idx]; 12424b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 12434b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 12446bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines ArrayRef<FixItHint> getFixItHints() const { 12456bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines return DiagObj->DiagFixItHints; 12464b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 12474b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1248af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Format this diagnostic into a string, substituting the 1249af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// formal arguments into the %0 slots. 1250af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 1251af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// The result is appended onto the \p OutStr array. 1252686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void FormatDiagnostic(SmallVectorImpl<char> &OutStr) const; 12539f28614bf1a8387000d8df57a713fcf69e198145John McCall 1254af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Format the given format-string into the output buffer using the 1255af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// arguments stored in this diagnostic. 12569f28614bf1a8387000d8df57a713fcf69e198145John McCall void FormatDiagnostic(const char *DiagStr, const char *DiagEnd, 1257686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<char> &OutStr) const; 1258a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor}; 1259a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 1260a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor/** 1261d3ab63e0f66429abf2a3e4cde889e420e41e8790Douglas Gregor * \brief Represents a diagnostic in a form that can be retained until its 1262d3ab63e0f66429abf2a3e4cde889e420e41e8790Douglas Gregor * corresponding source manager is destroyed. 1263a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor */ 1264a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregorclass StoredDiagnostic { 1265aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor unsigned ID; 1266d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine::Level Level; 1267a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor FullSourceLoc Loc; 1268a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor std::string Message; 12690a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner std::vector<CharSourceRange> Ranges; 1270849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor std::vector<FixItHint> FixIts; 1271a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 1272a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregorpublic: 127387d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar StoredDiagnostic() = default; 127440847cfb58acc3cac7d68727df9455ac45f2e118David Blaikie StoredDiagnostic(DiagnosticsEngine::Level Level, const Diagnostic &Info); 1275d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie StoredDiagnostic(DiagnosticsEngine::Level Level, unsigned ID, 1276686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef Message); 1277d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie StoredDiagnostic(DiagnosticsEngine::Level Level, unsigned ID, 1278686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef Message, FullSourceLoc Loc, 12792d3ba4f5a923a90c3fc290ddfba5e36c2d0a9b46Chris Lattner ArrayRef<CharSourceRange> Ranges, 12802d3ba4f5a923a90c3fc290ddfba5e36c2d0a9b46Chris Lattner ArrayRef<FixItHint> Fixits); 1281a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 1282a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// \brief Evaluates true when this object stores a diagnostic. 12830e2c34f92f00628d48968dfea096d36381f494cbStephen Hines explicit operator bool() const { return Message.size() > 0; } 1284a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 1285aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor unsigned getID() const { return ID; } 1286d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine::Level getLevel() const { return Level; } 1287a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor const FullSourceLoc &getLocation() const { return Loc; } 1288686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef getMessage() const { return Message; } 1289c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 1290c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor void setLocation(FullSourceLoc Loc) { this->Loc = Loc; } 1291c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 12920a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner typedef std::vector<CharSourceRange>::const_iterator range_iterator; 1293a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor range_iterator range_begin() const { return Ranges.begin(); } 1294a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor range_iterator range_end() const { return Ranges.end(); } 1295a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned range_size() const { return Ranges.size(); } 12966700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek 12976700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek ArrayRef<CharSourceRange> getRanges() const { 12986700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek return llvm::makeArrayRef(Ranges); 12996700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek } 13006700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek 1301a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 1302849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor typedef std::vector<FixItHint>::const_iterator fixit_iterator; 1303a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor fixit_iterator fixit_begin() const { return FixIts.begin(); } 1304a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor fixit_iterator fixit_end() const { return FixIts.end(); } 1305a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned fixit_size() const { return FixIts.size(); } 13066700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek 13076700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek ArrayRef<FixItHint> getFixIts() const { 13086700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek return llvm::makeArrayRef(FixIts); 13096700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek } 13105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 13111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1312af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// \brief Abstract interface, implemented by clients of the front-end, which 1313af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// formats and prints fully processed diagnostics. 131478ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikieclass DiagnosticConsumer { 1315ab41b97c3cddf1bcdd8bf82ab09ed3ceafcd05b1Argyrios Kyrtzidisprotected: 1316af50aab0c317462129d73ae8000c6394c718598dJames Dennett unsigned NumWarnings; ///< Number of warnings reported 1317af50aab0c317462129d73ae8000c6394c718598dJames Dennett unsigned NumErrors; ///< Number of errors reported 1318f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis 13195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 132078ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie DiagnosticConsumer() : NumWarnings(0), NumErrors(0) { } 1321f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis 1322f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis unsigned getNumErrors() const { return NumErrors; } 1323f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis unsigned getNumWarnings() const { return NumWarnings; } 132461d679ab2831b161c857cf3f974312fbd4ef1efdArgyrios Kyrtzidis virtual void clear() { NumWarnings = NumErrors = 0; } 1325f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis 132678ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie virtual ~DiagnosticConsumer(); 13271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1328af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Callback to inform the diagnostic client that processing 1329efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// of a source file is beginning. 1330efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// 1331efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// Note that diagnostics may be emitted outside the processing of a source 1332efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// file, for example during the parsing of command line options. However, 1333efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// diagnostics with source range information are required to only be emitted 1334efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// in between BeginSourceFile() and EndSourceFile(). 1335efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// 1336af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \param LangOpts The language options for the source file being processed. 1337af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \param PP The preprocessor object being used for the source; this is 1338af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// optional, e.g., it may not be present when processing AST source files. 13397d90199f109290e9d587479a481a2850d390b552Daniel Dunbar virtual void BeginSourceFile(const LangOptions &LangOpts, 13406bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines const Preprocessor *PP = nullptr) {} 1341efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar 1342af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Callback to inform the diagnostic client that processing 1343af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// of a source file has ended. 1344af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 1345af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// The diagnostic client should assume that any objects made available via 1346af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// BeginSourceFile() are inaccessible. 1347efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar virtual void EndSourceFile() {} 13481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 134929f2787b6da552018a7716f18f5bd8f67bd6edb5Argyrios Kyrtzidis /// \brief Callback to inform the diagnostic client that processing of all 135029f2787b6da552018a7716f18f5bd8f67bd6edb5Argyrios Kyrtzidis /// source files has ended. 135129f2787b6da552018a7716f18f5bd8f67bd6edb5Argyrios Kyrtzidis virtual void finish() {} 135229f2787b6da552018a7716f18f5bd8f67bd6edb5Argyrios Kyrtzidis 1353af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Indicates whether the diagnostics handled by this 135478ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie /// DiagnosticConsumer should be included in the number of diagnostics 135578ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie /// reported by DiagnosticsEngine. 1356af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 1357af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// The default implementation returns true. 1358cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek virtual bool IncludeInDiagnosticCounts() const; 13595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1360af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Handle this diagnostic, reporting it to the user or 13615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// capturing it to a log as needed. 1362f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis /// 1363af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// The default implementation just keeps track of the total number of 1364af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// warnings and errors. 1365d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie virtual void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel, 136640847cfb58acc3cac7d68727df9455ac45f2e118David Blaikie const Diagnostic &Info); 1367aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor}; 1368aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor 1369af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// \brief A diagnostic client that ignores all diagnostics. 1370aee526e77657afd1600276450e9c346953ad51d7Douglas Gregorclass IgnoringDiagConsumer : public DiagnosticConsumer { 137199ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie virtual void anchor(); 1372aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel, 1373651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines const Diagnostic &Info) override { 1374aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor // Just ignore it. 1375aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor } 13765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 13775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1378a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregor/// \brief Diagnostic consumer that forwards diagnostics along to an 1379a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregor/// existing, already-initialized diagnostic consumer. 1380a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregor/// 1381a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregorclass ForwardingDiagnosticConsumer : public DiagnosticConsumer { 1382a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregor DiagnosticConsumer &Target; 1383a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregor 1384a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregorpublic: 1385a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregor ForwardingDiagnosticConsumer(DiagnosticConsumer &Target) : Target(Target) {} 1386a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregor 138758878f85ab89b13e9eea4af3ccf055e42c557bc8Pirama Arumuga Nainar ~ForwardingDiagnosticConsumer() override; 1388a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregor 1389651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel, 1390651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines const Diagnostic &Info) override; 1391651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines void clear() override; 1392a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregor 1393651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines bool IncludeInDiagnosticCounts() const override; 1394a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregor}; 1395a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregor 1396246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu// Struct used for sending info about how a type should be printed. 1397246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieustruct TemplateDiffTypes { 1398246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu intptr_t FromType; 1399246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu intptr_t ToType; 1400246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu unsigned PrintTree : 1; 1401246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu unsigned PrintFromType : 1; 1402246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu unsigned ElideType : 1; 1403246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu unsigned ShowColors : 1; 14045409d28b6167032696f4915bb765a6f7db579f3fRichard Trieu // The printer sets this variable to true if the template diff was used. 14055409d28b6167032696f4915bb765a6f7db579f3fRichard Trieu unsigned TemplateDiffUsed : 1; 1406246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu}; 1407246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu 1408246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu/// Special character that the diagnostic printer will use to toggle the bold 1409246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu/// attribute. The character itself will be not be printed. 1410246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieuconst char ToggleHighlight = 127; 1411246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu 14126bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 14136bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines/// ProcessWarningOptions - Initialize the diagnostic client and process the 14146bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines/// warning options specified on the command line. 14156bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hinesvoid ProcessWarningOptions(DiagnosticsEngine &Diags, 14166bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines const DiagnosticOptions &Opts, 14176bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines bool ReportDiags = true); 14186bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 14195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 14205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 14215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 1422