Diagnostic.h revision 02c23ebf41ae2f70da0ba7337e05c51fbfe35f7f
15f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===--- Diagnostic.h - C Language Family Diagnostic Handling ---*- C++ -*-===// 25f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 35f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// The LLVM Compiler Infrastructure 45f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 50bc735ffcfb223c0186419547abaa5c84482663eChris Lattner// This file is distributed under the University of Illinois Open Source 60bc735ffcfb223c0186419547abaa5c84482663eChris Lattner// License. See LICENSE.TXT for details. 75f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 85f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===----------------------------------------------------------------------===// 92f7f5b1f5ff023cb8c4008ae53a12b09e3ea2622James Dennett/// 102f7f5b1f5ff023cb8c4008ae53a12b09e3ea2622James Dennett/// \file 112f7f5b1f5ff023cb8c4008ae53a12b09e3ea2622James Dennett/// \brief Defines the Diagnostic-related interfaces. 122f7f5b1f5ff023cb8c4008ae53a12b09e3ea2622James Dennett/// 135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===----------------------------------------------------------------------===// 145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#ifndef LLVM_CLANG_DIAGNOSTIC_H 165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#define LLVM_CLANG_DIAGNOSTIC_H 175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1833e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis#include "clang/Basic/DiagnosticIDs.h" 192eefd8657c233bc7c9330acfe475fc270bbe7cabTed Kremenek#include "clang/Basic/SourceLocation.h" 20f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor#include "llvm/ADT/ArrayRef.h" 210827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis#include "llvm/ADT/DenseMap.h" 2228019772db70d4547be05a042eb950bc910f134fDouglas Gregor#include "llvm/ADT/IntrusiveRefCntPtr.h" 23bdbb004f38978da0c4a75af3294d1c7b5ff84af1Douglas Gregor#include "llvm/ADT/OwningPtr.h" 243f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor#include "llvm/Support/type_traits.h" 255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2633e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis#include <vector> 270827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis#include <list> 28f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner 295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang { 3078ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie class DiagnosticConsumer; 3133e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis class DiagnosticBuilder; 3202c23ebf41ae2f70da0ba7337e05c51fbfe35f7fDouglas Gregor class DiagnosticOptions; 33d42ffbd22fc7eb61321f6a88173ee424991f01c6Ted Kremenek class IdentifierInfo; 3433e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis class DeclContext; 3540469651a3f8379dc0f32df69e9bade06a2aad36Chris Lattner class LangOptions; 367d90199f109290e9d587479a481a2850d390b552Daniel Dunbar class Preprocessor; 379c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis class DiagnosticErrorTrap; 38e59abb56ce0e1c206fb80bd945a0c358b0abe1efArgyrios Kyrtzidis class StoredDiagnostic; 391eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 404b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// \brief Annotates a diagnostic with some code that should be 414b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// inserted, removed, or replaced to fix the problem. 424b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// 434b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// This kind of hint should be used when we are certain that the 444b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// introduction, removal, or modification of a particular (small!) 454b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// amount of code will correct a compilation error. The compiler 464b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// should also provide full recovery from such errors, such that 47b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor/// suppressing the diagnostic output can still result in successful 484b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// compilation. 49849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregorclass FixItHint { 504b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregorpublic: 51783c56f47745f719590b17afd7ed937bf2407b53Douglas Gregor /// \brief Code that should be replaced to correct the error. Empty for an 52783c56f47745f719590b17afd7ed937bf2407b53Douglas Gregor /// insertion hint. 530a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner CharSourceRange RemoveRange; 544b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 5530660a898545416f0fea2d717f16f75640001e38Ted Kremenek /// \brief Code in the specific range that should be inserted in the insertion 5630660a898545416f0fea2d717f16f75640001e38Ted Kremenek /// location. 5730660a898545416f0fea2d717f16f75640001e38Ted Kremenek CharSourceRange InsertFromRange; 5830660a898545416f0fea2d717f16f75640001e38Ted Kremenek 594b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief The actual code to insert at the insertion location, as a 604b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// string. 614b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor std::string CodeToInsert; 624b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 6330660a898545416f0fea2d717f16f75640001e38Ted Kremenek bool BeforePreviousInsertions; 6430660a898545416f0fea2d717f16f75640001e38Ted Kremenek 654b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Empty code modification hint, indicating that no code 664b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// modification is known. 6730660a898545416f0fea2d717f16f75640001e38Ted Kremenek FixItHint() : BeforePreviousInsertions(false) { } 684b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 692f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson bool isNull() const { 70783c56f47745f719590b17afd7ed937bf2407b53Douglas Gregor return !RemoveRange.isValid(); 712f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson } 722f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson 734b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that inserts the given 744b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// code string at a specific location. 75849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor static FixItHint CreateInsertion(SourceLocation InsertionLoc, 7630660a898545416f0fea2d717f16f75640001e38Ted Kremenek StringRef Code, 7730660a898545416f0fea2d717f16f75640001e38Ted Kremenek bool BeforePreviousInsertions = false) { 78849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor FixItHint Hint; 79783c56f47745f719590b17afd7ed937bf2407b53Douglas Gregor Hint.RemoveRange = 80783c56f47745f719590b17afd7ed937bf2407b53Douglas Gregor CharSourceRange(SourceRange(InsertionLoc, InsertionLoc), false); 81b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.CodeToInsert = Code; 8230660a898545416f0fea2d717f16f75640001e38Ted Kremenek Hint.BeforePreviousInsertions = BeforePreviousInsertions; 8330660a898545416f0fea2d717f16f75640001e38Ted Kremenek return Hint; 8430660a898545416f0fea2d717f16f75640001e38Ted Kremenek } 8530660a898545416f0fea2d717f16f75640001e38Ted Kremenek 8630660a898545416f0fea2d717f16f75640001e38Ted Kremenek /// \brief Create a code modification hint that inserts the given 87af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// code from \p FromRange at a specific location. 8830660a898545416f0fea2d717f16f75640001e38Ted Kremenek static FixItHint CreateInsertionFromRange(SourceLocation InsertionLoc, 8930660a898545416f0fea2d717f16f75640001e38Ted Kremenek CharSourceRange FromRange, 9030660a898545416f0fea2d717f16f75640001e38Ted Kremenek bool BeforePreviousInsertions = false) { 9130660a898545416f0fea2d717f16f75640001e38Ted Kremenek FixItHint Hint; 9230660a898545416f0fea2d717f16f75640001e38Ted Kremenek Hint.RemoveRange = 9330660a898545416f0fea2d717f16f75640001e38Ted Kremenek CharSourceRange(SourceRange(InsertionLoc, InsertionLoc), false); 9430660a898545416f0fea2d717f16f75640001e38Ted Kremenek Hint.InsertFromRange = FromRange; 9530660a898545416f0fea2d717f16f75640001e38Ted Kremenek Hint.BeforePreviousInsertions = BeforePreviousInsertions; 96b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 97b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 984b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 994b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that removes the given 1004b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// source range. 1010a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner static FixItHint CreateRemoval(CharSourceRange RemoveRange) { 102849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor FixItHint Hint; 103b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.RemoveRange = RemoveRange; 104b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 105b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 1060a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner static FixItHint CreateRemoval(SourceRange RemoveRange) { 1070a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner return CreateRemoval(CharSourceRange::getTokenRange(RemoveRange)); 1080a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner } 1090a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner 1104b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that replaces the given 1114b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// source range with the given code string. 1120a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner static FixItHint CreateReplacement(CharSourceRange RemoveRange, 113686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef Code) { 114849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor FixItHint Hint; 115b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.RemoveRange = RemoveRange; 116b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.CodeToInsert = Code; 117b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 118b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 1190a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner 1200a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner static FixItHint CreateReplacement(SourceRange RemoveRange, 121686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef Code) { 1220a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner return CreateReplacement(CharSourceRange::getTokenRange(RemoveRange), Code); 1230a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner } 1244b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor}; 1254b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 126af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// \brief Concrete class used by the front-end to report problems and issues. 127af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// 128af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// This massages the diagnostics (e.g. handling things like "report warnings 129af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// as errors" and passes them off to the DiagnosticConsumer for reporting to 130af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// the user. DiagnosticsEngine is tied to one translation unit and one 131af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// SourceManager. 132c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmithclass DiagnosticsEngine : public RefCountedBase<DiagnosticsEngine> { 133182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattnerpublic: 134af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief The level of the diagnostic, after it has been through mapping. 135182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner enum Level { 13633e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis Ignored = DiagnosticIDs::Ignored, 13733e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis Note = DiagnosticIDs::Note, 13833e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis Warning = DiagnosticIDs::Warning, 13933e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis Error = DiagnosticIDs::Error, 14033e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis Fatal = DiagnosticIDs::Fatal 141182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner }; 1421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 143af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief How do we handle otherwise-unmapped extension? 144af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 145af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// This is controlled by -pedantic and -pedantic-errors. 146b54b276a920246c595a0498da281821eb9d22996Chris Lattner enum ExtensionHandling { 147b54b276a920246c595a0498da281821eb9d22996Chris Lattner Ext_Ignore, Ext_Warn, Ext_Error 148b54b276a920246c595a0498da281821eb9d22996Chris 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 155af50aab0c317462129d73ae8000c6394c718598dJames Dennett ak_identifierinfo, ///< IdentifierInfo 156af50aab0c317462129d73ae8000c6394c718598dJames Dennett ak_qualtype, ///< QualType 157af50aab0c317462129d73ae8000c6394c718598dJames Dennett ak_declarationname, ///< DeclarationName 158af50aab0c317462129d73ae8000c6394c718598dJames Dennett ak_nameddecl, ///< NamedDecl * 159af50aab0c317462129d73ae8000c6394c718598dJames Dennett ak_nestednamespec, ///< NestedNameSpecifier * 160af50aab0c317462129d73ae8000c6394c718598dJames Dennett ak_declcontext, ///< DeclContext * 161af50aab0c317462129d73ae8000c6394c718598dJames Dennett ak_qualtype_pair ///< pair<QualType, QualType> 1623fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner }; 1635edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin 164af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Specifies which overload candidates to display when overload 165af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// resolution fails. 1665edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin enum OverloadsShown { 1675edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin Ovl_All, ///< Show all overloads. 1685edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin Ovl_Best ///< Show just the "best" overload candidates. 1695edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin }; 1705edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin 171af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Represents on argument value, which is a union discriminated 172af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// by ArgumentKind, with a value. 173b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner typedef std::pair<ArgumentKind, intptr_t> ArgumentValue; 174ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 1751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumpprivate: 17627ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner unsigned char AllExtensionsSilenced; // Used by __extension__ 177b54b276a920246c595a0498da281821eb9d22996Chris Lattner bool IgnoreAllWarnings; // Ignore all warnings: -w 1781e473ccb0e0f6fd1954bef330f7193c1a3fb3ba1Ted Kremenek bool WarningsAsErrors; // Treat warnings like errors. 1791e473ccb0e0f6fd1954bef330f7193c1a3fb3ba1Ted Kremenek bool EnableAllWarnings; // Enable all warnings. 180e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner bool ErrorsAsFatal; // Treat errors like fatal errors. 181b54b276a920246c595a0498da281821eb9d22996Chris Lattner bool SuppressSystemWarnings; // Suppress warnings in system headers. 18281b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor bool SuppressAllDiagnostics; // Suppress all diagnostics. 183246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu bool ElideType; // Elide common types of templates. 184246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu bool PrintTemplateTree; // Print a tree when comparing templates. 185246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu bool ShowColors; // Color printing is enabled. 1865edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin OverloadsShown ShowOverloads; // Which overload candidates to show. 187c100214fdc41a7ea215f75d433eb1cb829fd4330Chris Lattner unsigned ErrorLimit; // Cap of # errors emitted, 0 -> no limit. 188575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor unsigned TemplateBacktraceLimit; // Cap on depth of template backtrace stack, 189575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor // 0 -> no limit. 19008d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith unsigned ConstexprBacktraceLimit; // Cap on depth of constexpr evaluation 19108d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith // backtrace stack, 0 -> no limit. 192b54b276a920246c595a0498da281821eb9d22996Chris Lattner ExtensionHandling ExtBehavior; // Map extensions onto warnings or errors? 193c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<DiagnosticIDs> Diags; 19402c23ebf41ae2f70da0ba7337e05c51fbfe35f7fDouglas Gregor IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts; 19578ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie DiagnosticConsumer *Client; 19633e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis bool OwnsDiagClient; 19733e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis SourceManager *SourceMgr; 1980827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 199af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Mapping information for diagnostics. 200af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 201af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// Mapping info is packed into four bits per diagnostic. The low three 202af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// bits are the mapping (an instance of diag::Mapping), or zero if unset. 203af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// The high bit is set when the mapping was established as a user mapping. 204af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// If the high bit is clear, then the low bits are set to the default 205af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// value, and should be mapped with -pedantic, -Werror, etc. 2060827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// 2073efd52cf8f4e57c5571bd8cc3168264c3bc46a1eArgyrios Kyrtzidis /// A new DiagState is created and kept around when diagnostic pragmas modify 2083efd52cf8f4e57c5571bd8cc3168264c3bc46a1eArgyrios Kyrtzidis /// the state so that we know what is the diagnostic state at any given 2093efd52cf8f4e57c5571bd8cc3168264c3bc46a1eArgyrios Kyrtzidis /// source location. 2100827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis class DiagState { 211b1c99c679adb53be8f478d08be83af6c9c22ae4bDaniel Dunbar llvm::DenseMap<unsigned, DiagnosticMappingInfo> DiagMap; 2123c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer 2133c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer public: 214ba494c64365d78b1cdb6baea4d1e79263389fda9Daniel Dunbar typedef llvm::DenseMap<unsigned, DiagnosticMappingInfo>::iterator 215b1c99c679adb53be8f478d08be83af6c9c22ae4bDaniel Dunbar iterator; 216ba494c64365d78b1cdb6baea4d1e79263389fda9Daniel Dunbar typedef llvm::DenseMap<unsigned, DiagnosticMappingInfo>::const_iterator 217ba494c64365d78b1cdb6baea4d1e79263389fda9Daniel Dunbar const_iterator; 2183efd52cf8f4e57c5571bd8cc3168264c3bc46a1eArgyrios Kyrtzidis 219b1c99c679adb53be8f478d08be83af6c9c22ae4bDaniel Dunbar void setMappingInfo(diag::kind Diag, DiagnosticMappingInfo Info) { 220b1c99c679adb53be8f478d08be83af6c9c22ae4bDaniel Dunbar DiagMap[Diag] = Info; 221b1c99c679adb53be8f478d08be83af6c9c22ae4bDaniel Dunbar } 2223c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer 223ba494c64365d78b1cdb6baea4d1e79263389fda9Daniel Dunbar DiagnosticMappingInfo &getOrAddMappingInfo(diag::kind Diag); 224ba494c64365d78b1cdb6baea4d1e79263389fda9Daniel Dunbar 225ba494c64365d78b1cdb6baea4d1e79263389fda9Daniel Dunbar const_iterator begin() const { return DiagMap.begin(); } 226ba494c64365d78b1cdb6baea4d1e79263389fda9Daniel Dunbar const_iterator end() const { return DiagMap.end(); } 2270827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis }; 2283c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer 2290827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \brief Keeps and automatically disposes all DiagStates that we create. 2300827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis std::list<DiagState> DiagStates; 2310827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 2320827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \brief Represents a point in source where the diagnostic state was 233af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// modified because of a pragma. 234af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 235af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 'Loc' can be null if the point represents the diagnostic state 236af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// modifications done through the command-line. 2370827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis struct DiagStatePoint { 2380827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis DiagState *State; 2390827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis FullSourceLoc Loc; 2400827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis DiagStatePoint(DiagState *State, FullSourceLoc Loc) 2410827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis : State(State), Loc(Loc) { } 2420827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 2430827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis bool operator<(const DiagStatePoint &RHS) const { 2440827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis // If Loc is invalid it means it came from <command-line>, in which case 2450827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis // we regard it as coming before any valid source location. 2460827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis if (RHS.Loc.isInvalid()) 2470827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis return false; 2480827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis if (Loc.isInvalid()) 2490827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis return true; 2500827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis return Loc.isBeforeInTranslationUnitThan(RHS.Loc); 2513c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer } 2523c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer }; 25304ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 254af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief A sorted vector of all DiagStatePoints representing changes in 255af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// diagnostic state due to diagnostic pragmas. 256af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 257af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// The vector is always sorted according to the SourceLocation of the 258af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// DiagStatePoint. 2590827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis typedef std::vector<DiagStatePoint> DiagStatePointsTy; 2600827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis mutable DiagStatePointsTy DiagStatePoints; 2610827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 2620827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \brief Keeps the DiagState that was active during each diagnostic 'push' 2630827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// so we can get back at it when we 'pop'. 2640827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis std::vector<DiagState *> DiagStateOnPushStack; 2650827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 2660827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis DiagState *GetCurDiagState() const { 2670827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis assert(!DiagStatePoints.empty()); 2680827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis return DiagStatePoints.back().State; 2690827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis } 2700827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 2710827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis void PushDiagStatePoint(DiagState *State, SourceLocation L) { 27200aae5243d965aa7bcee81a39ba0900c7869be21Richard Smith FullSourceLoc Loc(L, getSourceManager()); 2730827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis // Make sure that DiagStatePoints is always sorted according to Loc. 27400aae5243d965aa7bcee81a39ba0900c7869be21Richard Smith assert(Loc.isValid() && "Adding invalid loc point"); 27500aae5243d965aa7bcee81a39ba0900c7869be21Richard Smith assert(!DiagStatePoints.empty() && 27600aae5243d965aa7bcee81a39ba0900c7869be21Richard Smith (DiagStatePoints.back().Loc.isInvalid() || 2770827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis DiagStatePoints.back().Loc.isBeforeInTranslationUnitThan(Loc)) && 2780827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis "Previous point loc comes after or is the same as new one"); 27900aae5243d965aa7bcee81a39ba0900c7869be21Richard Smith DiagStatePoints.push_back(DiagStatePoint(State, Loc)); 2800827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis } 2810827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 2820827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \brief Finds the DiagStatePoint that contains the diagnostic state of 2830827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// the given source location. 2840827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis DiagStatePointsTy::iterator GetDiagStatePointForLoc(SourceLocation Loc) const; 28504ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 286af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Sticky flag set to \c true when an error is emitted. 2875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ErrorOccurred; 288af50aab0c317462129d73ae8000c6394c718598dJames Dennett 289af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Sticky flag set to \c true when a fatal error is emitted. 29015221422eda7bac679e38b07512feda49715ef66Chris Lattner bool FatalErrorOccurred; 2911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 29285bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor /// \brief Indicates that an unrecoverable error has occurred. 29385bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor bool UnrecoverableErrorOccurred; 29485bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor 295c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis /// \brief Counts for DiagnosticErrorTrap to check whether an error occurred 296add80bb3957dba1d9389304453c0a4c975768bd7John McCall /// during a parsing section, e.g. during parsing a function. 297c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis unsigned TrapNumErrorsOccurred; 298c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis unsigned TrapNumUnrecoverableErrorsOccurred; 299add80bb3957dba1d9389304453c0a4c975768bd7John McCall 300af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief The level of the last diagnostic emitted. 301af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 302af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// This is used to emit continuation diagnostics with the same level as the 303f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// diagnostic that they follow. 30433e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis DiagnosticIDs::Level LastDiagLevel; 3055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 306af50aab0c317462129d73ae8000c6394c718598dJames Dennett unsigned NumWarnings; ///< Number of warnings reported 307af50aab0c317462129d73ae8000c6394c718598dJames Dennett unsigned NumErrors; ///< Number of errors reported 308af50aab0c317462129d73ae8000c6394c718598dJames Dennett unsigned NumErrorsSuppressed; ///< Number of errors suppressed 3097bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber 310af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief A function pointer that converts an opaque diagnostic 311af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// argument to a strings. 312af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 313af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// This takes the modifiers and argument that was present in the diagnostic. 314b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// 315b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// The PrevArgs array (whose length is NumPrevArgs) indicates the previous 316b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// arguments formatted for this diagnostic. Implementations of this function 317b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// can use this information to avoid redundancy across arguments. 318b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// 31922caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner /// This is a hack to avoid a layering violation between libbasic and libsema. 3200673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth typedef void (*ArgToStringFnTy)( 3210673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth ArgumentKind Kind, intptr_t Val, 3220673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth const char *Modifier, unsigned ModifierLen, 3230673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth const char *Argument, unsigned ArgumentLen, 3240673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth const ArgumentValue *PrevArgs, 3250673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth unsigned NumPrevArgs, 326686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<char> &Output, 3270673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth void *Cookie, 328341785ec52f87c0803ba52dc88faac4e136f8593Bill Wendling ArrayRef<intptr_t> QualTypeVals); 32992dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner void *ArgToStringCookie; 3303fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ArgToStringFnTy ArgToStringFn; 33193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 33293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief ID of the "delayed" diagnostic, which is a (typically 33393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// fatal) diagnostic that had to be delayed because it was found 33493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// while emitting another diagnostic. 33593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor unsigned DelayedDiagID; 33693ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 33793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief First string argument for the delayed diagnostic. 33893ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor std::string DelayedDiagArg1; 33993ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 34093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief Second string argument for the delayed diagnostic. 34193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor std::string DelayedDiagArg2; 34293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 3435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 344d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie explicit DiagnosticsEngine( 345c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith const IntrusiveRefCntPtr<DiagnosticIDs> &Diags, 34602c23ebf41ae2f70da0ba7337e05c51fbfe35f7fDouglas Gregor DiagnosticOptions *DiagOpts, 34778ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie DiagnosticConsumer *client = 0, 34833e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis bool ShouldOwnClient = true); 349d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie ~DiagnosticsEngine(); 3501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 351c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith const IntrusiveRefCntPtr<DiagnosticIDs> &getDiagnosticIDs() const { 35233e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return Diags; 35333e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis } 35433e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis 35502c23ebf41ae2f70da0ba7337e05c51fbfe35f7fDouglas Gregor /// \brief Retrieve the diagnostic options. 35602c23ebf41ae2f70da0ba7337e05c51fbfe35f7fDouglas Gregor DiagnosticOptions &getDiagnosticOptions() const { return *DiagOpts; } 35702c23ebf41ae2f70da0ba7337e05c51fbfe35f7fDouglas Gregor 35878ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie DiagnosticConsumer *getClient() { return Client; } 35978ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie const DiagnosticConsumer *getClient() const { return Client; } 3601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 361d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie /// \brief Determine whether this \c DiagnosticsEngine object own its client. 36278243658c533168d51fd076fba328437932ba6f1Douglas Gregor bool ownsClient() const { return OwnsDiagClient; } 36378243658c533168d51fd076fba328437932ba6f1Douglas Gregor 364bdbb004f38978da0c4a75af3294d1c7b5ff84af1Douglas Gregor /// \brief Return the current diagnostic client along with ownership of that 365bdbb004f38978da0c4a75af3294d1c7b5ff84af1Douglas Gregor /// client. 36678ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie DiagnosticConsumer *takeClient() { 36733e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis OwnsDiagClient = false; 36833e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return Client; 36933e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis } 37033e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis 37133e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis bool hasSourceManager() const { return SourceMgr != 0; } 37233e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis SourceManager &getSourceManager() const { 37333e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis assert(SourceMgr && "SourceManager not set!"); 37433e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return *SourceMgr; 37533e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis } 37633e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis void setSourceManager(SourceManager *SrcMgr) { SourceMgr = SrcMgr; } 37733e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis 37833e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis //===--------------------------------------------------------------------===// 379d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie // DiagnosticsEngine characterization methods, used by a client to customize 380d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie // how diagnostics are emitted. 38133e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis // 38204ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 383af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Copies the current DiagMappings and pushes the new copy 38404ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// onto the top of the stack. 3850827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis void pushMappings(SourceLocation Loc); 38604ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 387af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Pops the current DiagMappings off the top of the stack, 388af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// causing the new top of the stack to be the active mappings. 389af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 390af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \returns \c true if the pop happens, \c false if there is only one 391af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// DiagMapping on the stack. 3920827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis bool popMappings(SourceLocation Loc); 39304ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 394bdbb004f38978da0c4a75af3294d1c7b5ff84af1Douglas Gregor /// \brief Set the diagnostic client associated with this diagnostic object. 395bdbb004f38978da0c4a75af3294d1c7b5ff84af1Douglas Gregor /// 39633e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis /// \param ShouldOwnClient true if the diagnostic object should take 39733e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis /// ownership of \c client. 39878ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie void setClient(DiagnosticConsumer *client, bool ShouldOwnClient = true); 3995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 400af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Specify a limit for the number of errors we should 401af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// emit before giving up. 402af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 403af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// Zero disables the limit. 404c100214fdc41a7ea215f75d433eb1cb829fd4330Chris Lattner void setErrorLimit(unsigned Limit) { ErrorLimit = Limit; } 405b205ac9fcd22b87b41697172d1983c5ae9dabaafChris Lattner 406575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor /// \brief Specify the maximum number of template instantiation 407575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor /// notes to emit along with a given diagnostic. 408575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor void setTemplateBacktraceLimit(unsigned Limit) { 409575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor TemplateBacktraceLimit = Limit; 410575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor } 41108d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith 412575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor /// \brief Retrieve the maximum number of template instantiation 41308d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith /// notes to emit along with a given diagnostic. 414575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor unsigned getTemplateBacktraceLimit() const { 415575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor return TemplateBacktraceLimit; 416575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor } 41708d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith 41808d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith /// \brief Specify the maximum number of constexpr evaluation 41908d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith /// notes to emit along with a given diagnostic. 42008d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith void setConstexprBacktraceLimit(unsigned Limit) { 42108d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith ConstexprBacktraceLimit = Limit; 42208d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith } 42308d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith 42408d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith /// \brief Retrieve the maximum number of constexpr evaluation 42508d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith /// notes to emit along with a given diagnostic. 42608d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith unsigned getConstexprBacktraceLimit() const { 42708d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith return ConstexprBacktraceLimit; 42808d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith } 42908d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith 430af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief When set to true, any unmapped warnings are ignored. 431af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 432af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// If this and WarningsAsErrors are both set, then this one wins. 4335b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner void setIgnoreAllWarnings(bool Val) { IgnoreAllWarnings = Val; } 4345b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner bool getIgnoreAllWarnings() const { return IgnoreAllWarnings; } 4351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 436af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief When set to true, any unmapped ignored warnings are no longer 437af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// ignored. 438af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 439af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// If this and IgnoreAllWarnings are both set, then that one wins. 4401e473ccb0e0f6fd1954bef330f7193c1a3fb3ba1Ted Kremenek void setEnableAllWarnings(bool Val) { EnableAllWarnings = Val; } 4411e473ccb0e0f6fd1954bef330f7193c1a3fb3ba1Ted Kremenek bool getEnableAllWarnngs() const { return EnableAllWarnings; } 4421e473ccb0e0f6fd1954bef330f7193c1a3fb3ba1Ted Kremenek 443af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief When set to true, any warnings reported are issued as errors. 4445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setWarningsAsErrors(bool Val) { WarningsAsErrors = Val; } 4455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getWarningsAsErrors() const { return WarningsAsErrors; } 4461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 447af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief When set to true, any error reported is made a fatal error. 448e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner void setErrorsAsFatal(bool Val) { ErrorsAsFatal = Val; } 449e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner bool getErrorsAsFatal() const { return ErrorsAsFatal; } 450e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner 451af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief When set to true mask warnings that come from system headers. 4522fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar void setSuppressSystemWarnings(bool Val) { SuppressSystemWarnings = Val; } 4532fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar bool getSuppressSystemWarnings() const { return SuppressSystemWarnings; } 4542fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar 45581b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor /// \brief Suppress all diagnostics, to silence the front end when we 45681b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor /// know that we don't want any more diagnostics to be passed along to the 45781b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor /// client 45881b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor void setSuppressAllDiagnostics(bool Val = true) { 45981b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor SuppressAllDiagnostics = Val; 46081b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor } 46181b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor bool getSuppressAllDiagnostics() const { return SuppressAllDiagnostics; } 462246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu 463246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu /// \brief Set type eliding, to skip outputting same types occurring in 464246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu /// template types. 465246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu void setElideType(bool Val = true) { ElideType = Val; } 466246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu bool getElideType() { return ElideType; } 467246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu 468246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu /// \brief Set tree printing, to outputting the template difference in a 469246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu /// tree format. 470246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu void setPrintTemplateTree(bool Val = false) { PrintTemplateTree = Val; } 471246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu bool getPrintTemplateTree() { return PrintTemplateTree; } 472246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu 473246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu /// \brief Set color printing, so the type diffing will inject color markers 474246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu /// into the output. 475246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu void setShowColors(bool Val = false) { ShowColors = Val; } 476246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu bool getShowColors() { return ShowColors; } 477246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu 4785edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin /// \brief Specify which overload candidates to show when overload resolution 479af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// fails. 480af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 481af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// By default, we show all candidates. 4825edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin void setShowOverloads(OverloadsShown Val) { 4835edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin ShowOverloads = Val; 4845edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin } 4855edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin OverloadsShown getShowOverloads() const { return ShowOverloads; } 4865edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin 4875d99a252c63a7745bcd71231ca5240d2a65e4f1dRichard Smith /// \brief Pretend that the last diagnostic issued was ignored, so any 4885d99a252c63a7745bcd71231ca5240d2a65e4f1dRichard Smith /// subsequent notes will be suppressed. 489af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 490af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// This can be used by clients who suppress diagnostics themselves. 4910b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor void setLastDiagnosticIgnored() { 4925d99a252c63a7745bcd71231ca5240d2a65e4f1dRichard Smith if (LastDiagLevel == DiagnosticIDs::Fatal) 4935d99a252c63a7745bcd71231ca5240d2a65e4f1dRichard Smith FatalErrorOccurred = true; 49433e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis LastDiagLevel = DiagnosticIDs::Ignored; 4950b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor } 4960b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor 497af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Controls whether otherwise-unmapped extension diagnostics are 498af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// mapped onto ignore/warning/error. 499af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 500af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// This corresponds to the GCC -pedantic and -pedantic-errors option. 501b54b276a920246c595a0498da281821eb9d22996Chris Lattner void setExtensionHandlingBehavior(ExtensionHandling H) { 502b54b276a920246c595a0498da281821eb9d22996Chris Lattner ExtBehavior = H; 503b54b276a920246c595a0498da281821eb9d22996Chris Lattner } 504c1b5fa41f09512c74030b9a2a0d1564535e22a76Peter Collingbourne ExtensionHandling getExtensionHandlingBehavior() const { return ExtBehavior; } 5051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 506af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Counter bumped when an __extension__ block is/ encountered. 507af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 508af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// When non-zero, all extension diagnostics are entirely silenced, no 509af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// matter how they are mapped. 51027ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner void IncrementAllExtensionsSilenced() { ++AllExtensionsSilenced; } 51127ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner void DecrementAllExtensionsSilenced() { --AllExtensionsSilenced; } 51291a2886d558ea6ca7a0bed73ab5acea5ae78eac2Douglas Gregor bool hasAllExtensionsSilenced() { return AllExtensionsSilenced != 0; } 5131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 514697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief This allows the client to specify that certain warnings are 515697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// ignored. 516697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 517697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// Notes can never be mapped, errors can only be mapped to fatal, and 518697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// WARNINGs and EXTENSIONs can be mapped arbitrarily. 5190827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// 5200827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \param Loc The source location that this change of diagnostic state should 5210827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// take affect. It can be null if we are setting the latest state. 5220827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis void setDiagnosticMapping(diag::kind Diag, diag::Mapping Map, 5230827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis SourceLocation Loc); 5241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 525697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Change an entire diagnostic group (e.g. "unknown-pragmas") to 526697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// have the specified mapping. 527697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 528697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \returns true (and ignores the request) if "Group" was unknown, false 529697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// otherwise. 5300827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// 531697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \param Loc The source location that this change of diagnostic state should 5320827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// take affect. It can be null if we are setting the state from command-line. 533686775deca8b8685eb90801495880e3abdd844c2Chris Lattner bool setDiagnosticGroupMapping(StringRef Group, diag::Mapping Map, 5343f8394669673451061f57ced81f0a2cae087f119Daniel Dunbar SourceLocation Loc = SourceLocation()); 5355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 536697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Set the warning-as-error flag for the given diagnostic. 537697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 538697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// This function always only operates on the current diagnostic state. 5393f22509ebf91aa96658ca6e5c5c0b926d8d62e34Chad Rosier void setDiagnosticWarningAsError(diag::kind Diag, bool Enabled); 5403f22509ebf91aa96658ca6e5c5c0b926d8d62e34Chad Rosier 541697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Set the warning-as-error flag for the given diagnostic group. 542697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 543697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// This function always only operates on the current diagnostic state. 5444aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar /// 5454aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar /// \returns True if the given group is unknown, false otherwise. 5464aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar bool setDiagnosticGroupWarningAsError(StringRef Group, bool Enabled); 5474aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar 548697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Set the error-as-fatal flag for the given diagnostic. 549697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 550697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// This function always only operates on the current diagnostic state. 5513f22509ebf91aa96658ca6e5c5c0b926d8d62e34Chad Rosier void setDiagnosticErrorAsFatal(diag::kind Diag, bool Enabled); 5523f22509ebf91aa96658ca6e5c5c0b926d8d62e34Chad Rosier 553697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Set the error-as-fatal flag for the given diagnostic group. 554697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 555697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// This function always only operates on the current diagnostic state. 5564aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar /// 5574aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar /// \returns True if the given group is unknown, false otherwise. 5584aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar bool setDiagnosticGroupErrorAsFatal(StringRef Group, bool Enabled); 5594aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar 560697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Add the specified mapping to all diagnostics. 561697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 562697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// Mainly to be used by -Wno-everything to disable all warnings but allow 563697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// subsequent -W options to enable specific warnings. 56482e6411d004064a29f03a3ea8b8919f297bfa843Argyrios Kyrtzidis void setMappingToAllDiagnostics(diag::Mapping Map, 56511583c757bac6ce5c342f2eb572055dd2619a657Argyrios Kyrtzidis SourceLocation Loc = SourceLocation()); 56611583c757bac6ce5c342f2eb572055dd2619a657Argyrios Kyrtzidis 5675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool hasErrorOccurred() const { return ErrorOccurred; } 56815221422eda7bac679e38b07512feda49715ef66Chris Lattner bool hasFatalErrorOccurred() const { return FatalErrorOccurred; } 56985bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor 57085bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor /// \brief Determine whether any kind of unrecoverable error has occurred. 57185bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor bool hasUnrecoverableErrorOccurred() const { 57285bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor return FatalErrorOccurred || UnrecoverableErrorOccurred; 57385bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor } 57485bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor 57553eee7ba970d21ff15bbd4334164037a3b4cc4b8Chris Lattner unsigned getNumWarnings() const { return NumWarnings; } 5761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 577c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor void setNumWarnings(unsigned NumWarnings) { 578c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor this->NumWarnings = NumWarnings; 579c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor } 580c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 581697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Return an ID for a diagnostic with the specified message and level. 582697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 583697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// If this is the first request for this diagnosic, it is registered and 584697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// created, otherwise the existing ID is returned. 585686775deca8b8685eb90801495880e3abdd844c2Chris Lattner unsigned getCustomDiagID(Level L, StringRef Message) { 58633e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return Diags->getCustomDiagID((DiagnosticIDs::Level)L, Message); 58733e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis } 5881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 589697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Converts a diagnostic argument (as an intptr_t) into the string 590697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// that represents it. 5913fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner void ConvertArgToString(ArgumentKind Kind, intptr_t Val, 5923fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Modifier, unsigned ModLen, 5933fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Argument, unsigned ArgLen, 594b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner const ArgumentValue *PrevArgs, unsigned NumPrevArgs, 595686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<char> &Output, 5964def70d3040e73707c738f7c366737a986135edfRichard Smith ArrayRef<intptr_t> QualTypeVals) const { 597b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner ArgToStringFn(Kind, Val, Modifier, ModLen, Argument, ArgLen, 5980673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth PrevArgs, NumPrevArgs, Output, ArgToStringCookie, 5990673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth QualTypeVals); 60022caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 6011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 60292dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner void SetArgToStringFn(ArgToStringFnTy Fn, void *Cookie) { 6033fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ArgToStringFn = Fn; 60492dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner ArgToStringCookie = Cookie; 60522caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 6061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 607abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \brief Reset the state of the diagnostic object to its initial 608abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// configuration. 609abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor void Reset(); 610abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor 6115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 612d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie // DiagnosticsEngine classification and reporting interfaces. 6135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // 6145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 615d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie /// \brief Based on the way the client configured the DiagnosticsEngine 6165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// object, classify the specified diagnostic ID into a Level, consumable by 61778ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie /// the DiagnosticConsumer. 6180827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// 6190827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \param Loc The source location we are interested in finding out the 6200827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// diagnostic state. Can be null in order to query the latest state. 6211656aaec223949245fdbebf306b719cba0b687caDaniel Dunbar Level getDiagnosticLevel(unsigned DiagID, SourceLocation Loc) const { 6221656aaec223949245fdbebf306b719cba0b687caDaniel Dunbar return (Level)Diags->getDiagnosticLevel(DiagID, Loc, *this); 62333e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis } 6241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 625697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Issue the message to the client. 626697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 627697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// This actually returns an instance of DiagnosticBuilder which emits the 628697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// diagnostics (through @c ProcessDiag) when it is destroyed. 629697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 630697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \param DiagID A member of the @c diag::kind enum. 631efce31f51d6e7e31e125f96c20f6cdab3ead0a47James Dennett /// \param Loc Represents the source location associated with the diagnostic, 632509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// which can be an invalid location if no position information is available. 633efce31f51d6e7e31e125f96c20f6cdab3ead0a47James Dennett inline DiagnosticBuilder Report(SourceLocation Loc, unsigned DiagID); 6340f9fed70cea107b3f79df554e38bd8e98d48fe47Daniel Dunbar inline DiagnosticBuilder Report(unsigned DiagID); 635de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor 636e59abb56ce0e1c206fb80bd945a0c358b0abe1efArgyrios Kyrtzidis void Report(const StoredDiagnostic &storedDiag); 637e59abb56ce0e1c206fb80bd945a0c358b0abe1efArgyrios Kyrtzidis 63893ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief Determine whethere there is already a diagnostic in flight. 6395800f7ea9cf5621280089d690f677bd28064d6b5Ted Kremenek bool isDiagnosticInFlight() const { return CurDiagID != ~0U; } 64093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 64193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief Set the "delayed" diagnostic that will be emitted once 64293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// the current diagnostic completes. 64393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// 64493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// If a diagnostic is already in-flight but the front end must 64593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// report a problem (e.g., with an inconsistent file system 64693ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// state), this routine sets a "delayed" diagnostic that will be 64793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// emitted after the current diagnostic completes. This should 64893ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// only be used for fatal errors detected at inconvenient 64993ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// times. If emitting a delayed diagnostic causes a second delayed 65093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// diagnostic to be introduced, that second delayed diagnostic 65193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// will be ignored. 65293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// 65393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \param DiagID The ID of the diagnostic being delayed. 65493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// 65593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \param Arg1 A string argument that will be provided to the 65693ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// diagnostic. A copy of this string will be stored in the 657d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie /// DiagnosticsEngine object itself. 65893ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// 65993ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \param Arg2 A string argument that will be provided to the 66093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// diagnostic. A copy of this string will be stored in the 661d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie /// DiagnosticsEngine object itself. 662686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void SetDelayedDiagnostic(unsigned DiagID, StringRef Arg1 = "", 663686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef Arg2 = ""); 66493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 665de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor /// \brief Clear out the current diagnostic. 666de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor void Clear() { CurDiagID = ~0U; } 6671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6680a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattnerprivate: 66993ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief Report the delayed diagnostic. 67093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor void ReportDelayed(); 67193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 6723cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner // This is private state used by DiagnosticBuilder. We put it here instead of 6733cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner // in DiagnosticBuilder in order to keep DiagnosticBuilder a small lightweight 6740a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // object. This implementation choice means that we can only have one 6750a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // diagnostic "in flight" at a time, but this seems to be a reasonable 6760a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // tradeoff to keep these objects small. Assertions verify that only one 6770a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // diagnostic is in flight at a time. 67833e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis friend class DiagnosticIDs; 6793cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner friend class DiagnosticBuilder; 68040847cfb58acc3cac7d68727df9455ac45f2e118David Blaikie friend class Diagnostic; 6819b623639378d53a675921ddfa7316034d571881eDouglas Gregor friend class PartialDiagnostic; 6829c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis friend class DiagnosticErrorTrap; 6839b623639378d53a675921ddfa7316034d571881eDouglas Gregor 684697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief The location of the current diagnostic that is in flight. 68533e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis SourceLocation CurDiagLoc; 6861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 687697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief The ID of the current diagnostic that is in flight. 688697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 6893cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// This is set to ~0U when there is no diagnostic in flight. 690b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner unsigned CurDiagID; 691b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner 69273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner enum { 693697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief The maximum number of arguments we can hold. 694697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 695af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// We currently only support up to 10 arguments (%0-%9). A single 696af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// diagnostic with more than that almost certainly has to be simplified 697af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// anyway. 698981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar MaxArguments = 10, 699981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar 700697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief The maximum number of ranges we can hold. 701981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar MaxRanges = 10, 702981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar 703697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief The maximum number of ranges we can hold. 704981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar MaxFixItHints = 10 70573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner }; 7061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 707697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief The number of entries in Arguments. 708730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner signed char NumDiagArgs; 709697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief The number of ranges in the DiagRanges array. 710730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner unsigned char NumDiagRanges; 711697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief The number of hints in the DiagFixItHints array. 712981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar unsigned char NumDiagFixItHints; 713ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 714af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Specifies whether an argument is in DiagArgumentsStr or 715af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// in DiagArguments. 716af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 717af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// This is an array of ArgumentKind::ArgumentKind enum values, one for each 718af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// argument. 71973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner unsigned char DiagArgumentsKind[MaxArguments]; 7201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 721af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Holds the values of each string argument for the current 722697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// diagnostic. 723697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 724697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// This is only used when the corresponding ArgumentKind is ak_std_string. 72573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner std::string DiagArgumentsStr[MaxArguments]; 72673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 727697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief The values for the various substitution positions. 728697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 729697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// This is used when the argument is not an std::string. The specific 730697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// value is mangled into an intptr_t and the interpretation depends on 731697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// exactly what sort of argument kind it is. 73273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner intptr_t DiagArgumentsVal[MaxArguments]; 7331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 734697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief The list of ranges added to this diagnostic. 735981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar CharSourceRange DiagRanges[MaxRanges]; 7361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 737697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief If valid, provides a hint with some code to insert, remove, 738981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar /// or modify at a particular position. 739981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar FixItHint DiagFixItHints[MaxFixItHints]; 7404b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 74187429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis DiagnosticMappingInfo makeMappingInfo(diag::Mapping Map, SourceLocation L) { 74287429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis bool isPragma = L.isValid(); 74387429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis DiagnosticMappingInfo MappingInfo = DiagnosticMappingInfo::Make( 74487429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis Map, /*IsUser=*/true, isPragma); 74587429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis 74687429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis // If this is a pragma mapping, then set the diagnostic mapping flags so 74787429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis // that we override command line options. 74887429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis if (isPragma) { 74987429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis MappingInfo.setNoWarningAsError(true); 75087429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis MappingInfo.setNoErrorAsFatal(true); 75187429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis } 75287429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis 75387429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis return MappingInfo; 75487429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis } 75587429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis 756697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Used to report a diagnostic that is finally fully formed. 7575e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// 758697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \returns true if the diagnostic was emitted, false if it was suppressed. 75933e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis bool ProcessDiag() { 76033e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return Diags->ProcessDiag(*this); 76133e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis } 762f41d3be39980d40849850d3fb90403623cc8459eArgyrios Kyrtzidis 763393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar /// @name Diagnostic Emission 764393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar /// @{ 765393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbarprotected: 766393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar // Sema requires access to the following functions because the current design 767393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar // of SFINAE requires it to use its own SemaDiagnosticBuilder, which needs to 768393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar // access us directly to ensure we minimize the emitted code for the common 769393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar // Sema::Diag() patterns. 770393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar friend class Sema; 771393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar 7723054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar /// \brief Emit the current diagnostic and clear the diagnostic state. 773c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose /// 774c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose /// \param Force Emit the diagnostic regardless of suppression settings. 775c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose bool EmitCurrentDiagnostic(bool Force = false); 7763054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar 777393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar unsigned getCurrentDiagID() const { return CurDiagID; } 778393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar 779393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar SourceLocation getCurrentDiagLoc() const { return CurDiagLoc; } 780393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar 781393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar /// @} 782393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar 783f41d3be39980d40849850d3fb90403623cc8459eArgyrios Kyrtzidis friend class ASTReader; 784f41d3be39980d40849850d3fb90403623cc8459eArgyrios Kyrtzidis friend class ASTWriter; 7853cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}; 7863cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 7879c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis/// \brief RAII class that determines when any errors have occurred 7889c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis/// between the time the instance was created and the time it was 7899c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis/// queried. 7909c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidisclass DiagnosticErrorTrap { 791d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine &Diag; 792c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis unsigned NumErrors; 793c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis unsigned NumUnrecoverableErrors; 7949c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis 7959c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidispublic: 796d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie explicit DiagnosticErrorTrap(DiagnosticsEngine &Diag) 797add80bb3957dba1d9389304453c0a4c975768bd7John McCall : Diag(Diag) { reset(); } 7989c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis 7999c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis /// \brief Determine whether any errors have occurred since this 8009c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis /// object instance was created. 8019c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis bool hasErrorOccurred() const { 802c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis return Diag.TrapNumErrorsOccurred > NumErrors; 803add80bb3957dba1d9389304453c0a4c975768bd7John McCall } 804add80bb3957dba1d9389304453c0a4c975768bd7John McCall 805add80bb3957dba1d9389304453c0a4c975768bd7John McCall /// \brief Determine whether any unrecoverable errors have occurred since this 806add80bb3957dba1d9389304453c0a4c975768bd7John McCall /// object instance was created. 807add80bb3957dba1d9389304453c0a4c975768bd7John McCall bool hasUnrecoverableErrorOccurred() const { 808c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis return Diag.TrapNumUnrecoverableErrorsOccurred > NumUnrecoverableErrors; 8099c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis } 8109c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis 811af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Set to initial state of "no errors occurred". 812add80bb3957dba1d9389304453c0a4c975768bd7John McCall void reset() { 813c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis NumErrors = Diag.TrapNumErrorsOccurred; 814c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis NumUnrecoverableErrors = Diag.TrapNumUnrecoverableErrorsOccurred; 815add80bb3957dba1d9389304453c0a4c975768bd7John McCall } 8169c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis}; 8179c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis 8183cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 8193cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner// DiagnosticBuilder 8203cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 8213cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 822697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// \brief A little helper class used to produce diagnostics. 823697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// 824697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// This is constructed by the DiagnosticsEngine::Report method, and 825697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// allows insertion of extra information (arguments and source ranges) into 826697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// the currently "in flight" diagnostic. When the temporary for the builder 827697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// is destroyed, the diagnostic is issued. 8283cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// 8293cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// Note that many of these will be created as temporary objects (many call 8303cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// sites), so we want them to be small and we never want their address taken. 8313cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// This ensures that compilers with somewhat reasonable optimizers will promote 8323cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// the common fields to registers, eliminating increments of the NumArgs field, 8333cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// for example. 8343cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerclass DiagnosticBuilder { 835d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie mutable DiagnosticsEngine *DiagObj; 836981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar mutable unsigned NumArgs, NumRanges, NumFixits; 8371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8387059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar /// \brief Status variable indicating if this diagnostic is still active. 8397059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar /// 840f3477c13eeaf11b32a41f181398fb5deffd0dd73Sylvestre Ledru // NOTE: This field is redundant with DiagObj (IsActive iff (DiagObj == 0)), 8417059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar // but LLVM is not currently smart enough to eliminate the null check that 8427059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar // Emit() would end up with if we used that as our status variable. 8437059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar mutable bool IsActive; 8447059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar 845c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose /// \brief Flag indicating that this diagnostic is being emitted via a 846c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose /// call to ForceEmit. 847c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose mutable bool IsForceEmit; 848c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose 849f56faa01936b9cf909623d7f06e3c2569ca4a78eDmitri Gribenko void operator=(const DiagnosticBuilder &) LLVM_DELETED_FUNCTION; 850d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie friend class DiagnosticsEngine; 851ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor 852ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor DiagnosticBuilder() 853c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose : DiagObj(0), NumArgs(0), NumRanges(0), NumFixits(0), IsActive(false), 854c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose IsForceEmit(false) { } 855ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor 856d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie explicit DiagnosticBuilder(DiagnosticsEngine *diagObj) 857c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose : DiagObj(diagObj), NumArgs(0), NumRanges(0), NumFixits(0), IsActive(true), 858c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose IsForceEmit(false) { 859981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar assert(diagObj && "DiagnosticBuilder requires a valid DiagnosticsEngine!"); 860cbf46a0b2bb2b47d6e13437e0d52cc583c5ce539Argyrios Kyrtzidis } 861ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 8629b623639378d53a675921ddfa7316034d571881eDouglas Gregor friend class PartialDiagnostic; 863ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor 864b535041ee33c5eff255832bc5541c8d52aae8254Douglas Gregorprotected: 8653054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar void FlushCounts() { 8663054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar DiagObj->NumDiagArgs = NumArgs; 8673054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar DiagObj->NumDiagRanges = NumRanges; 8683054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar DiagObj->NumDiagFixItHints = NumFixits; 8693054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar } 87006265bd82073c06294a02a0bd891951fafb484a5Daniel Dunbar 871cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// \brief Clear out the current diagnostic. 8727059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar void Clear() const { 8737059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar DiagObj = 0; 8747059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar IsActive = false; 875c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose IsForceEmit = false; 8767059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar } 877cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar 878697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Determine whether this diagnostic is still active. 8797059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar bool isActive() const { return IsActive; } 88006265bd82073c06294a02a0bd891951fafb484a5Daniel Dunbar 881cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// \brief Force the diagnostic builder to emit the diagnostic now. 882cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// 883cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// Once this function has been called, the DiagnosticBuilder object 884cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// should not be used again before it is destroyed. 885cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// 886cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// \returns true if a diagnostic was emitted, false if the 887cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// diagnostic was suppressed. 8883054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar bool Emit() { 8897059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar // If this diagnostic is inactive, then its soul was stolen by the copy ctor 8907059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar // (or by a subclass, as in SemaDiagnosticBuilder). 8917059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar if (!isActive()) return false; 8923054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar 8933054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar // When emitting diagnostics, we set the final argument count into 8943054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar // the DiagnosticsEngine object. 8953054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar FlushCounts(); 8963054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar 8973054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar // Process the diagnostic. 898c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose bool Result = DiagObj->EmitCurrentDiagnostic(IsForceEmit); 8993054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar 9003054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar // This diagnostic is dead. 9017059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar Clear(); 9023054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar 9033054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar return Result; 9043054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar } 9059b623639378d53a675921ddfa7316034d571881eDouglas Gregor 9061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumppublic: 9070a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// Copy constructor. When copied, this "takes" the diagnostic info from the 9080a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// input and neuters it. 9093cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagnosticBuilder(const DiagnosticBuilder &D) { 9100a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner DiagObj = D.DiagObj; 9117059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar IsActive = D.IsActive; 912c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose IsForceEmit = D.IsForceEmit; 9137059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar D.Clear(); 91425a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor NumArgs = D.NumArgs; 91525a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor NumRanges = D.NumRanges; 916981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar NumFixits = D.NumFixits; 9170a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 91825a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor 919ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor /// \brief Retrieve an empty diagnostic builder. 920ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor static DiagnosticBuilder getEmpty() { 921ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor return DiagnosticBuilder(); 922ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor } 923ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor 924697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Emits the diagnostic. 92553c83b32550b3f29db2419160fa2e3684e420556Daniel Dunbar ~DiagnosticBuilder() { 9263054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar Emit(); 92753c83b32550b3f29db2419160fa2e3684e420556Daniel Dunbar } 9289b623639378d53a675921ddfa7316034d571881eDouglas Gregor 929c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose /// \brief Forces the diagnostic to be emitted. 930c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose const DiagnosticBuilder &setForceEmit() const { 931c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose IsForceEmit = true; 932c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose return *this; 933c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose } 934c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose 935af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Conversion of DiagnosticBuilder to bool always returns \c true. 936af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 937af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// This allows is to be used in boolean error contexts (where \c true is 938af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// used to indicate that an error has occurred), like: 939af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \code 9403cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// return Diag(...); 941af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \endcode 9423cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner operator bool() const { return true; } 9433cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 944686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void AddString(StringRef S) const { 945cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar assert(isActive() && "Clients must not add to cleared diagnostic!"); 946d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(NumArgs < DiagnosticsEngine::MaxArguments && 9473cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 948cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar DiagObj->DiagArgumentsKind[NumArgs] = DiagnosticsEngine::ak_std_string; 949cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar DiagObj->DiagArgumentsStr[NumArgs++] = S; 9503cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner } 9511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 952d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie void AddTaggedVal(intptr_t V, DiagnosticsEngine::ArgumentKind Kind) const { 953cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar assert(isActive() && "Clients must not add to cleared diagnostic!"); 954d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(NumArgs < DiagnosticsEngine::MaxArguments && 9553cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 956cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar DiagObj->DiagArgumentsKind[NumArgs] = Kind; 957cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar DiagObj->DiagArgumentsVal[NumArgs++] = V; 9580a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 9591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9600a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner void AddSourceRange(const CharSourceRange &R) const { 961cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar assert(isActive() && "Clients must not add to cleared diagnostic!"); 962981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar assert(NumRanges < DiagnosticsEngine::MaxRanges && 9633cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 964cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar DiagObj->DiagRanges[NumRanges++] = R; 9651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 9664b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 967849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor void AddFixItHint(const FixItHint &Hint) const { 968cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar assert(isActive() && "Clients must not add to cleared diagnostic!"); 969981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar assert(NumFixits < DiagnosticsEngine::MaxFixItHints && 970981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar "Too many arguments to diagnostic!"); 971cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar DiagObj->DiagFixItHints[NumFixits++] = Hint; 9724b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 9733cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}; 9743cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 9753cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 976686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef S) { 9773cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddString(S); 9783cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 9793cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 9803cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 9813cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 9823cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const char *Str) { 9833cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(reinterpret_cast<intptr_t>(Str), 984d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine::ak_c_string); 9853cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 9863cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 9873cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 9883cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, int I) { 989d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DB.AddTaggedVal(I, DiagnosticsEngine::ak_sint); 9903cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 9913cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 9923cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 9933bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidisinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,bool I) { 994d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DB.AddTaggedVal(I, DiagnosticsEngine::ak_sint); 9953bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis return DB; 9963bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis} 9973bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis 9983cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 9993cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner unsigned I) { 1000d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DB.AddTaggedVal(I, DiagnosticsEngine::ak_uint); 10013cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 10023cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 10033cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 10043cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 10053cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const IdentifierInfo *II) { 10063cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(reinterpret_cast<intptr_t>(II), 1007d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine::ak_identifierinfo); 10083cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 10093cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 10101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10113f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// Adds a DeclContext to the diagnostic. The enable_if template magic is here 10123f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// so that we only match those arguments that are (statically) DeclContexts; 10133f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// other arguments that derive from DeclContext (e.g., RecordDecls) will not 10143f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// match. 10153f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregortemplate<typename T> 10163f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregorinline 10173f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregortypename llvm::enable_if<llvm::is_same<T, DeclContext>, 10183f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor const DiagnosticBuilder &>::type 10193f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregoroperator<<(const DiagnosticBuilder &DB, T *DC) { 10203f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor DB.AddTaggedVal(reinterpret_cast<intptr_t>(DC), 1021d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine::ak_declcontext); 10223f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor return DB; 10233f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor} 10243f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor 10253cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 10263cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const SourceRange &R) { 10270a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner DB.AddSourceRange(CharSourceRange::getTokenRange(R)); 10283cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 10293cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 10304b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 10314b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregorinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 10320a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner const CharSourceRange &R) { 10330a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner DB.AddSourceRange(R); 10340a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner return DB; 10350a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner} 10360a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner 10370a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 1038849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor const FixItHint &Hint) { 10393739b32a01b9778176757425e62252c288b85383Ted Kremenek if (!Hint.isNull()) 10403739b32a01b9778176757425e62252c288b85383Ted Kremenek DB.AddFixItHint(Hint); 10414b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor return DB; 10424b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor} 1043ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 1044d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikieinline DiagnosticBuilder DiagnosticsEngine::Report(SourceLocation Loc, 104533e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis unsigned DiagID){ 10463cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(CurDiagID == ~0U && "Multiple diagnostics in flight at once!"); 10473cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner CurDiagLoc = Loc; 10483cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner CurDiagID = DiagID; 10493cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DiagnosticBuilder(this); 10503cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 1051d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikieinline DiagnosticBuilder DiagnosticsEngine::Report(unsigned DiagID) { 105233e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return Report(SourceLocation(), DiagID); 10530f9fed70cea107b3f79df554e38bd8e98d48fe47Daniel Dunbar} 10543cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 10553cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 105640847cfb58acc3cac7d68727df9455ac45f2e118David Blaikie// Diagnostic 10573cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 10581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1059697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// A little helper class (which is basically a smart pointer that forwards 1060697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// info from DiagnosticsEngine) that allows clients to enquire about the 1061697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// currently in-flight diagnostic. 106240847cfb58acc3cac7d68727df9455ac45f2e118David Blaikieclass Diagnostic { 1063d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie const DiagnosticsEngine *DiagObj; 1064686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef StoredDiagMessage; 10653cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerpublic: 106640847cfb58acc3cac7d68727df9455ac45f2e118David Blaikie explicit Diagnostic(const DiagnosticsEngine *DO) : DiagObj(DO) {} 106740847cfb58acc3cac7d68727df9455ac45f2e118David Blaikie Diagnostic(const DiagnosticsEngine *DO, StringRef storedDiagMessage) 1068e59abb56ce0e1c206fb80bd945a0c358b0abe1efArgyrios Kyrtzidis : DiagObj(DO), StoredDiagMessage(storedDiagMessage) {} 10691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1070d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie const DiagnosticsEngine *getDiags() const { return DiagObj; } 1071b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner unsigned getID() const { return DiagObj->CurDiagID; } 107233e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis const SourceLocation &getLocation() const { return DiagObj->CurDiagLoc; } 107333e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis bool hasSourceManager() const { return DiagObj->hasSourceManager(); } 107433e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis SourceManager &getSourceManager() const { return DiagObj->getSourceManager();} 10751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10760a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned getNumArgs() const { return DiagObj->NumDiagArgs; } 10771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1078af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Return the kind of the specified index. 1079af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 1080af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// Based on the kind of argument, the accessors below can be used to get 1081af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// the value. 1082af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 1083af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \pre Idx < getNumArgs() 1084d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine::ArgumentKind getArgKind(unsigned Idx) const { 10853cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(Idx < getNumArgs() && "Argument index out of range!"); 1086d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie return (DiagnosticsEngine::ArgumentKind)DiagObj->DiagArgumentsKind[Idx]; 108773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner } 10881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1089af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Return the provided argument string specified by \p Idx. 1090af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_std_string 109173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner const std::string &getArgStdStr(unsigned Idx) const { 1092d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(getArgKind(Idx) == DiagnosticsEngine::ak_std_string && 10933cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 109473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner return DiagObj->DiagArgumentsStr[Idx]; 109573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner } 10961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1097af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Return the specified C string argument. 1098af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_c_string 109973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner const char *getArgCStr(unsigned Idx) const { 1100d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(getArgKind(Idx) == DiagnosticsEngine::ak_c_string && 11013cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 110273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner return reinterpret_cast<const char*>(DiagObj->DiagArgumentsVal[Idx]); 11030a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 11041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1105af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Return the specified signed integer argument. 1106af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_sint 110730bc96544346bea42921cf6837e66cef80d664b4Chris Lattner int getArgSInt(unsigned Idx) const { 1108d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(getArgKind(Idx) == DiagnosticsEngine::ak_sint && 11093cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 111030bc96544346bea42921cf6837e66cef80d664b4Chris Lattner return (int)DiagObj->DiagArgumentsVal[Idx]; 111130bc96544346bea42921cf6837e66cef80d664b4Chris Lattner } 11121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1113af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Return the specified unsigned integer argument. 1114af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_uint 111530bc96544346bea42921cf6837e66cef80d664b4Chris Lattner unsigned getArgUInt(unsigned Idx) const { 1116d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(getArgKind(Idx) == DiagnosticsEngine::ak_uint && 11173cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 111830bc96544346bea42921cf6837e66cef80d664b4Chris Lattner return (unsigned)DiagObj->DiagArgumentsVal[Idx]; 111930bc96544346bea42921cf6837e66cef80d664b4Chris Lattner } 11201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1121af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Return the specified IdentifierInfo argument. 1122af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_identifierinfo 112343b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner const IdentifierInfo *getArgIdentifier(unsigned Idx) const { 1124d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(getArgKind(Idx) == DiagnosticsEngine::ak_identifierinfo && 11253cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 11269634379265855f1628190e926d9aaf1fb4a5d90eChris Lattner return reinterpret_cast<IdentifierInfo*>(DiagObj->DiagArgumentsVal[Idx]); 112743b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner } 11281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1129af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Return the specified non-string argument in an opaque form. 1130af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \pre getArgKind(Idx) != DiagnosticsEngine::ak_std_string 113122caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner intptr_t getRawArg(unsigned Idx) const { 1132d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(getArgKind(Idx) != DiagnosticsEngine::ak_std_string && 113322caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner "invalid argument accessor!"); 113422caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner return DiagObj->DiagArgumentsVal[Idx]; 113522caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 11361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1137af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Return the number of source ranges associated with this diagnostic. 11380a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned getNumRanges() const { 11390a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner return DiagObj->NumDiagRanges; 11400a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 11411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1142af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \pre Idx < getNumRanges() 11430a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner const CharSourceRange &getRange(unsigned Idx) const { 11440a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner assert(Idx < DiagObj->NumDiagRanges && "Invalid diagnostic range index!"); 114551c6d384551674facc19f745ecf6e289d28dc55fDouglas Gregor return DiagObj->DiagRanges[Idx]; 11460a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 11471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 114828409289193afca1a3178a9796f8e8aebcb76896Chandler Carruth /// \brief Return an array reference for this diagnostic's ranges. 114928409289193afca1a3178a9796f8e8aebcb76896Chandler Carruth ArrayRef<CharSourceRange> getRanges() const { 115028409289193afca1a3178a9796f8e8aebcb76896Chandler Carruth return llvm::makeArrayRef(DiagObj->DiagRanges, DiagObj->NumDiagRanges); 115128409289193afca1a3178a9796f8e8aebcb76896Chandler Carruth } 115228409289193afca1a3178a9796f8e8aebcb76896Chandler Carruth 1153849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor unsigned getNumFixItHints() const { 1154981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar return DiagObj->NumDiagFixItHints; 11554b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 11564b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1157849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor const FixItHint &getFixItHint(unsigned Idx) const { 1158981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar assert(Idx < getNumFixItHints() && "Invalid index!"); 1159981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar return DiagObj->DiagFixItHints[Idx]; 11604b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 11614b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1162849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor const FixItHint *getFixItHints() const { 1163981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar return getNumFixItHints()? DiagObj->DiagFixItHints : 0; 11644b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 11654b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1166af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Format this diagnostic into a string, substituting the 1167af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// formal arguments into the %0 slots. 1168af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 1169af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// The result is appended onto the \p OutStr array. 1170686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void FormatDiagnostic(SmallVectorImpl<char> &OutStr) const; 11719f28614bf1a8387000d8df57a713fcf69e198145John McCall 1172af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Format the given format-string into the output buffer using the 1173af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// arguments stored in this diagnostic. 11749f28614bf1a8387000d8df57a713fcf69e198145John McCall void FormatDiagnostic(const char *DiagStr, const char *DiagEnd, 1175686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<char> &OutStr) const; 1176a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor}; 1177a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 1178a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor/** 1179d3ab63e0f66429abf2a3e4cde889e420e41e8790Douglas Gregor * \brief Represents a diagnostic in a form that can be retained until its 1180d3ab63e0f66429abf2a3e4cde889e420e41e8790Douglas Gregor * corresponding source manager is destroyed. 1181a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor */ 1182a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregorclass StoredDiagnostic { 1183aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor unsigned ID; 1184d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine::Level Level; 1185a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor FullSourceLoc Loc; 1186a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor std::string Message; 11870a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner std::vector<CharSourceRange> Ranges; 1188849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor std::vector<FixItHint> FixIts; 1189a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 1190a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregorpublic: 1191a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor StoredDiagnostic(); 119240847cfb58acc3cac7d68727df9455ac45f2e118David Blaikie StoredDiagnostic(DiagnosticsEngine::Level Level, const Diagnostic &Info); 1193d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie StoredDiagnostic(DiagnosticsEngine::Level Level, unsigned ID, 1194686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef Message); 1195d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie StoredDiagnostic(DiagnosticsEngine::Level Level, unsigned ID, 1196686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef Message, FullSourceLoc Loc, 11972d3ba4f5a923a90c3fc290ddfba5e36c2d0a9b46Chris Lattner ArrayRef<CharSourceRange> Ranges, 11982d3ba4f5a923a90c3fc290ddfba5e36c2d0a9b46Chris Lattner ArrayRef<FixItHint> Fixits); 1199a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor ~StoredDiagnostic(); 1200a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 1201a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// \brief Evaluates true when this object stores a diagnostic. 1202a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor operator bool() const { return Message.size() > 0; } 1203a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 1204aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor unsigned getID() const { return ID; } 1205d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine::Level getLevel() const { return Level; } 1206a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor const FullSourceLoc &getLocation() const { return Loc; } 1207686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef getMessage() const { return Message; } 1208c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 1209c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor void setLocation(FullSourceLoc Loc) { this->Loc = Loc; } 1210c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 12110a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner typedef std::vector<CharSourceRange>::const_iterator range_iterator; 1212a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor range_iterator range_begin() const { return Ranges.begin(); } 1213a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor range_iterator range_end() const { return Ranges.end(); } 1214a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned range_size() const { return Ranges.size(); } 12156700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek 12166700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek ArrayRef<CharSourceRange> getRanges() const { 12176700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek return llvm::makeArrayRef(Ranges); 12186700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek } 12196700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek 1220a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 1221849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor typedef std::vector<FixItHint>::const_iterator fixit_iterator; 1222a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor fixit_iterator fixit_begin() const { return FixIts.begin(); } 1223a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor fixit_iterator fixit_end() const { return FixIts.end(); } 1224a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned fixit_size() const { return FixIts.size(); } 12256700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek 12266700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek ArrayRef<FixItHint> getFixIts() const { 12276700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek return llvm::makeArrayRef(FixIts); 12286700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek } 12295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 12301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1231af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// \brief Abstract interface, implemented by clients of the front-end, which 1232af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// formats and prints fully processed diagnostics. 123378ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikieclass DiagnosticConsumer { 1234ab41b97c3cddf1bcdd8bf82ab09ed3ceafcd05b1Argyrios Kyrtzidisprotected: 1235af50aab0c317462129d73ae8000c6394c718598dJames Dennett unsigned NumWarnings; ///< Number of warnings reported 1236af50aab0c317462129d73ae8000c6394c718598dJames Dennett unsigned NumErrors; ///< Number of errors reported 1237f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis 12385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 123978ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie DiagnosticConsumer() : NumWarnings(0), NumErrors(0) { } 1240f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis 1241f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis unsigned getNumErrors() const { return NumErrors; } 1242f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis unsigned getNumWarnings() const { return NumWarnings; } 124361d679ab2831b161c857cf3f974312fbd4ef1efdArgyrios Kyrtzidis virtual void clear() { NumWarnings = NumErrors = 0; } 1244f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis 124578ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie virtual ~DiagnosticConsumer(); 12461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1247af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Callback to inform the diagnostic client that processing 1248efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// of a source file is beginning. 1249efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// 1250efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// Note that diagnostics may be emitted outside the processing of a source 1251efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// file, for example during the parsing of command line options. However, 1252efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// diagnostics with source range information are required to only be emitted 1253efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// in between BeginSourceFile() and EndSourceFile(). 1254efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// 1255af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \param LangOpts The language options for the source file being processed. 1256af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \param PP The preprocessor object being used for the source; this is 1257af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// optional, e.g., it may not be present when processing AST source files. 12587d90199f109290e9d587479a481a2850d390b552Daniel Dunbar virtual void BeginSourceFile(const LangOptions &LangOpts, 12597d90199f109290e9d587479a481a2850d390b552Daniel Dunbar const Preprocessor *PP = 0) {} 1260efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar 1261af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Callback to inform the diagnostic client that processing 1262af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// of a source file has ended. 1263af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 1264af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// The diagnostic client should assume that any objects made available via 1265af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// BeginSourceFile() are inaccessible. 1266efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar virtual void EndSourceFile() {} 12671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 126829f2787b6da552018a7716f18f5bd8f67bd6edb5Argyrios Kyrtzidis /// \brief Callback to inform the diagnostic client that processing of all 126929f2787b6da552018a7716f18f5bd8f67bd6edb5Argyrios Kyrtzidis /// source files has ended. 127029f2787b6da552018a7716f18f5bd8f67bd6edb5Argyrios Kyrtzidis virtual void finish() {} 127129f2787b6da552018a7716f18f5bd8f67bd6edb5Argyrios Kyrtzidis 1272af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Indicates whether the diagnostics handled by this 127378ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie /// DiagnosticConsumer should be included in the number of diagnostics 127478ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie /// reported by DiagnosticsEngine. 1275af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 1276af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// The default implementation returns true. 1277cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek virtual bool IncludeInDiagnosticCounts() const; 12785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1279af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Handle this diagnostic, reporting it to the user or 12805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// capturing it to a log as needed. 1281f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis /// 1282af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// The default implementation just keeps track of the total number of 1283af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// warnings and errors. 1284d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie virtual void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel, 128540847cfb58acc3cac7d68727df9455ac45f2e118David Blaikie const Diagnostic &Info); 1286aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor 1287aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor /// \brief Clone the diagnostic consumer, producing an equivalent consumer 1288aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor /// that can be used in a different context. 1289aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor virtual DiagnosticConsumer *clone(DiagnosticsEngine &Diags) const = 0; 1290aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor}; 1291aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor 1292af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// \brief A diagnostic client that ignores all diagnostics. 1293aee526e77657afd1600276450e9c346953ad51d7Douglas Gregorclass IgnoringDiagConsumer : public DiagnosticConsumer { 129499ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie virtual void anchor(); 1295aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel, 1296aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor const Diagnostic &Info) { 1297aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor // Just ignore it. 1298aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor } 1299aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor DiagnosticConsumer *clone(DiagnosticsEngine &Diags) const { 1300aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor return new IgnoringDiagConsumer(); 1301aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor } 13025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 13035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1304246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu// Struct used for sending info about how a type should be printed. 1305246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieustruct TemplateDiffTypes { 1306246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu intptr_t FromType; 1307246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu intptr_t ToType; 1308246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu unsigned PrintTree : 1; 1309246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu unsigned PrintFromType : 1; 1310246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu unsigned ElideType : 1; 1311246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu unsigned ShowColors : 1; 13125409d28b6167032696f4915bb765a6f7db579f3fRichard Trieu // The printer sets this variable to true if the template diff was used. 13135409d28b6167032696f4915bb765a6f7db579f3fRichard Trieu unsigned TemplateDiffUsed : 1; 1314246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu}; 1315246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu 1316246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu/// Special character that the diagnostic printer will use to toggle the bold 1317246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu/// attribute. The character itself will be not be printed. 1318246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieuconst char ToggleHighlight = 127; 1319246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu 13205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 13215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 13225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 1323