Diagnostic.h revision 6bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89
15f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===--- Diagnostic.h - C Language Family Diagnostic Handling ---*- C++ -*-===// 25f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 35f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// The LLVM Compiler Infrastructure 45f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 50bc735ffcfb223c0186419547abaa5c84482663eChris Lattner// This file is distributed under the University of Illinois Open Source 60bc735ffcfb223c0186419547abaa5c84482663eChris Lattner// License. See LICENSE.TXT for details. 75f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 85f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===----------------------------------------------------------------------===// 92f7f5b1f5ff023cb8c4008ae53a12b09e3ea2622James Dennett/// 102f7f5b1f5ff023cb8c4008ae53a12b09e3ea2622James Dennett/// \file 112f7f5b1f5ff023cb8c4008ae53a12b09e3ea2622James Dennett/// \brief Defines the Diagnostic-related interfaces. 122f7f5b1f5ff023cb8c4008ae53a12b09e3ea2622James Dennett/// 135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===----------------------------------------------------------------------===// 145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#ifndef LLVM_CLANG_DIAGNOSTIC_H 165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#define LLVM_CLANG_DIAGNOSTIC_H 175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1833e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis#include "clang/Basic/DiagnosticIDs.h" 19dc7b641574a733624489bd87fc7061771edf2113Douglas Gregor#include "clang/Basic/DiagnosticOptions.h" 202eefd8657c233bc7c9330acfe475fc270bbe7cabTed Kremenek#include "clang/Basic/SourceLocation.h" 21f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor#include "llvm/ADT/ArrayRef.h" 220827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis#include "llvm/ADT/DenseMap.h" 2328019772db70d4547be05a042eb950bc910f134fDouglas Gregor#include "llvm/ADT/IntrusiveRefCntPtr.h" 246bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines#include "llvm/ADT/iterator_range.h" 250827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis#include <list> 2630a2e16f6c27f888dd11eba6bbbae1e980078fcbChandler Carruth#include <vector> 27f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner 285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang { 296bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines class DeclContext; 3033e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis class DiagnosticBuilder; 316bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines class DiagnosticConsumer; 326bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines class DiagnosticErrorTrap; 3302c23ebf41ae2f70da0ba7337e05c51fbfe35f7fDouglas Gregor class DiagnosticOptions; 34d42ffbd22fc7eb61321f6a88173ee424991f01c6Ted Kremenek class IdentifierInfo; 3540469651a3f8379dc0f32df69e9bade06a2aad36Chris Lattner class LangOptions; 367d90199f109290e9d587479a481a2850d390b552Daniel Dunbar class Preprocessor; 37e59abb56ce0e1c206fb80bd945a0c358b0abe1efArgyrios Kyrtzidis class StoredDiagnostic; 38651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines namespace tok { 39651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines enum TokenKind : unsigned short; 40651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines } 411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 424b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// \brief Annotates a diagnostic with some code that should be 434b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// inserted, removed, or replaced to fix the problem. 444b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// 454b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// This kind of hint should be used when we are certain that the 464b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// introduction, removal, or modification of a particular (small!) 474b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// amount of code will correct a compilation error. The compiler 484b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// should also provide full recovery from such errors, such that 49b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor/// suppressing the diagnostic output can still result in successful 504b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// compilation. 51849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregorclass FixItHint { 524b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregorpublic: 53783c56f47745f719590b17afd7ed937bf2407b53Douglas Gregor /// \brief Code that should be replaced to correct the error. Empty for an 54783c56f47745f719590b17afd7ed937bf2407b53Douglas Gregor /// insertion hint. 550a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner CharSourceRange RemoveRange; 564b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 5730660a898545416f0fea2d717f16f75640001e38Ted Kremenek /// \brief Code in the specific range that should be inserted in the insertion 5830660a898545416f0fea2d717f16f75640001e38Ted Kremenek /// location. 5930660a898545416f0fea2d717f16f75640001e38Ted Kremenek CharSourceRange InsertFromRange; 6030660a898545416f0fea2d717f16f75640001e38Ted Kremenek 614b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief The actual code to insert at the insertion location, as a 624b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// string. 634b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor std::string CodeToInsert; 644b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 6530660a898545416f0fea2d717f16f75640001e38Ted Kremenek bool BeforePreviousInsertions; 6630660a898545416f0fea2d717f16f75640001e38Ted Kremenek 674b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Empty code modification hint, indicating that no code 684b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// modification is known. 6930660a898545416f0fea2d717f16f75640001e38Ted Kremenek FixItHint() : BeforePreviousInsertions(false) { } 704b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 712f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson bool isNull() const { 72783c56f47745f719590b17afd7ed937bf2407b53Douglas Gregor return !RemoveRange.isValid(); 732f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson } 742f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson 754b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that inserts the given 764b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// code string at a specific location. 77849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor static FixItHint CreateInsertion(SourceLocation InsertionLoc, 7830660a898545416f0fea2d717f16f75640001e38Ted Kremenek StringRef Code, 7930660a898545416f0fea2d717f16f75640001e38Ted Kremenek bool BeforePreviousInsertions = false) { 80849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor FixItHint Hint; 81783c56f47745f719590b17afd7ed937bf2407b53Douglas Gregor Hint.RemoveRange = 824a2ef80d896c1bac38ce113ec19a8d509a619288Nico Weber CharSourceRange::getCharRange(InsertionLoc, InsertionLoc); 83b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.CodeToInsert = Code; 8430660a898545416f0fea2d717f16f75640001e38Ted Kremenek Hint.BeforePreviousInsertions = BeforePreviousInsertions; 8530660a898545416f0fea2d717f16f75640001e38Ted Kremenek return Hint; 8630660a898545416f0fea2d717f16f75640001e38Ted Kremenek } 8730660a898545416f0fea2d717f16f75640001e38Ted Kremenek 8830660a898545416f0fea2d717f16f75640001e38Ted Kremenek /// \brief Create a code modification hint that inserts the given 89af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// code from \p FromRange at a specific location. 9030660a898545416f0fea2d717f16f75640001e38Ted Kremenek static FixItHint CreateInsertionFromRange(SourceLocation InsertionLoc, 9130660a898545416f0fea2d717f16f75640001e38Ted Kremenek CharSourceRange FromRange, 9230660a898545416f0fea2d717f16f75640001e38Ted Kremenek bool BeforePreviousInsertions = false) { 9330660a898545416f0fea2d717f16f75640001e38Ted Kremenek FixItHint Hint; 9430660a898545416f0fea2d717f16f75640001e38Ted Kremenek Hint.RemoveRange = 954a2ef80d896c1bac38ce113ec19a8d509a619288Nico Weber CharSourceRange::getCharRange(InsertionLoc, InsertionLoc); 9630660a898545416f0fea2d717f16f75640001e38Ted Kremenek Hint.InsertFromRange = FromRange; 9730660a898545416f0fea2d717f16f75640001e38Ted Kremenek Hint.BeforePreviousInsertions = BeforePreviousInsertions; 98b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 99b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 1004b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1014b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that removes the given 1024b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// source range. 1030a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner static FixItHint CreateRemoval(CharSourceRange RemoveRange) { 104849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor FixItHint Hint; 105b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.RemoveRange = RemoveRange; 106b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 107b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 1080a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner static FixItHint CreateRemoval(SourceRange RemoveRange) { 1090a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner return CreateRemoval(CharSourceRange::getTokenRange(RemoveRange)); 1100a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner } 1110a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner 1124b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that replaces the given 1134b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// source range with the given code string. 1140a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner static FixItHint CreateReplacement(CharSourceRange RemoveRange, 115686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef Code) { 116849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor FixItHint Hint; 117b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.RemoveRange = RemoveRange; 118b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.CodeToInsert = Code; 119b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 120b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 1210a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner 1220a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner static FixItHint CreateReplacement(SourceRange RemoveRange, 123686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef Code) { 1240a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner return CreateReplacement(CharSourceRange::getTokenRange(RemoveRange), Code); 1250a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner } 1264b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor}; 1274b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 128af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// \brief Concrete class used by the front-end to report problems and issues. 129af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// 130af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// This massages the diagnostics (e.g. handling things like "report warnings 131af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// as errors" and passes them off to the DiagnosticConsumer for reporting to 132af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// the user. DiagnosticsEngine is tied to one translation unit and one 133af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// SourceManager. 134c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmithclass DiagnosticsEngine : public RefCountedBase<DiagnosticsEngine> { 1356bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines DiagnosticsEngine(const DiagnosticsEngine &) LLVM_DELETED_FUNCTION; 1366bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines void operator=(const DiagnosticsEngine &) LLVM_DELETED_FUNCTION; 1376bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 138182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattnerpublic: 139af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief The level of the diagnostic, after it has been through mapping. 140182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner enum Level { 14133e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis Ignored = DiagnosticIDs::Ignored, 14233e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis Note = DiagnosticIDs::Note, 143651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines Remark = DiagnosticIDs::Remark, 14433e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis Warning = DiagnosticIDs::Warning, 14533e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis Error = DiagnosticIDs::Error, 14633e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis Fatal = DiagnosticIDs::Fatal 147182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner }; 1481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 149af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief How do we handle otherwise-unmapped extension? 150af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 151af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// This is controlled by -pedantic and -pedantic-errors. 152b54b276a920246c595a0498da281821eb9d22996Chris Lattner enum ExtensionHandling { 153b54b276a920246c595a0498da281821eb9d22996Chris Lattner Ext_Ignore, Ext_Warn, Ext_Error 154b54b276a920246c595a0498da281821eb9d22996Chris Lattner }; 1551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1563fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner enum ArgumentKind { 157af50aab0c317462129d73ae8000c6394c718598dJames Dennett ak_std_string, ///< std::string 158af50aab0c317462129d73ae8000c6394c718598dJames Dennett ak_c_string, ///< const char * 159af50aab0c317462129d73ae8000c6394c718598dJames Dennett ak_sint, ///< int 160af50aab0c317462129d73ae8000c6394c718598dJames Dennett ak_uint, ///< unsigned 161651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines ak_tokenkind, ///< enum TokenKind : unsigned 162af50aab0c317462129d73ae8000c6394c718598dJames Dennett ak_identifierinfo, ///< IdentifierInfo 163af50aab0c317462129d73ae8000c6394c718598dJames Dennett ak_qualtype, ///< QualType 164af50aab0c317462129d73ae8000c6394c718598dJames Dennett ak_declarationname, ///< DeclarationName 165af50aab0c317462129d73ae8000c6394c718598dJames Dennett ak_nameddecl, ///< NamedDecl * 166af50aab0c317462129d73ae8000c6394c718598dJames Dennett ak_nestednamespec, ///< NestedNameSpecifier * 167af50aab0c317462129d73ae8000c6394c718598dJames Dennett ak_declcontext, ///< DeclContext * 168651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines ak_qualtype_pair, ///< pair<QualType, QualType> 169651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines ak_attr ///< Attr * 1703fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner }; 1715edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin 172af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Represents on argument value, which is a union discriminated 173af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// by ArgumentKind, with a value. 174b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner typedef std::pair<ArgumentKind, intptr_t> ArgumentValue; 175ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 1761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumpprivate: 17727ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner unsigned char AllExtensionsSilenced; // Used by __extension__ 178b54b276a920246c595a0498da281821eb9d22996Chris Lattner bool IgnoreAllWarnings; // Ignore all warnings: -w 1791e473ccb0e0f6fd1954bef330f7193c1a3fb3ba1Ted Kremenek bool WarningsAsErrors; // Treat warnings like errors. 1801e473ccb0e0f6fd1954bef330f7193c1a3fb3ba1Ted Kremenek bool EnableAllWarnings; // Enable all warnings. 181e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner bool ErrorsAsFatal; // Treat errors like fatal errors. 182b54b276a920246c595a0498da281821eb9d22996Chris Lattner bool SuppressSystemWarnings; // Suppress warnings in system headers. 18381b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor bool SuppressAllDiagnostics; // Suppress all diagnostics. 184246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu bool ElideType; // Elide common types of templates. 185246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu bool PrintTemplateTree; // Print a tree when comparing templates. 186246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu bool ShowColors; // Color printing is enabled. 1875edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin OverloadsShown ShowOverloads; // Which overload candidates to show. 188c100214fdc41a7ea215f75d433eb1cb829fd4330Chris Lattner unsigned ErrorLimit; // Cap of # errors emitted, 0 -> no limit. 189575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor unsigned TemplateBacktraceLimit; // Cap on depth of template backtrace stack, 190575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor // 0 -> no limit. 19108d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith unsigned ConstexprBacktraceLimit; // Cap on depth of constexpr evaluation 19208d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith // backtrace stack, 0 -> no limit. 193b54b276a920246c595a0498da281821eb9d22996Chris Lattner ExtensionHandling ExtBehavior; // Map extensions onto warnings or errors? 194c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<DiagnosticIDs> Diags; 19502c23ebf41ae2f70da0ba7337e05c51fbfe35f7fDouglas Gregor IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts; 19678ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie DiagnosticConsumer *Client; 19733e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis bool OwnsDiagClient; 19833e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis SourceManager *SourceMgr; 1990827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 200af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Mapping information for diagnostics. 201af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 202af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// Mapping info is packed into four bits per diagnostic. The low three 203af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// bits are the mapping (an instance of diag::Mapping), or zero if unset. 204af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// The high bit is set when the mapping was established as a user mapping. 205af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// If the high bit is clear, then the low bits are set to the default 206af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// value, and should be mapped with -pedantic, -Werror, etc. 2070827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// 2083efd52cf8f4e57c5571bd8cc3168264c3bc46a1eArgyrios Kyrtzidis /// A new DiagState is created and kept around when diagnostic pragmas modify 2093efd52cf8f4e57c5571bd8cc3168264c3bc46a1eArgyrios Kyrtzidis /// the state so that we know what is the diagnostic state at any given 2103efd52cf8f4e57c5571bd8cc3168264c3bc46a1eArgyrios Kyrtzidis /// source location. 2110827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis class DiagState { 212b1c99c679adb53be8f478d08be83af6c9c22ae4bDaniel Dunbar llvm::DenseMap<unsigned, DiagnosticMappingInfo> DiagMap; 2133c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer 2143c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer public: 215ba494c64365d78b1cdb6baea4d1e79263389fda9Daniel Dunbar typedef llvm::DenseMap<unsigned, DiagnosticMappingInfo>::iterator 216b1c99c679adb53be8f478d08be83af6c9c22ae4bDaniel Dunbar iterator; 217ba494c64365d78b1cdb6baea4d1e79263389fda9Daniel Dunbar typedef llvm::DenseMap<unsigned, DiagnosticMappingInfo>::const_iterator 218ba494c64365d78b1cdb6baea4d1e79263389fda9Daniel Dunbar const_iterator; 2193efd52cf8f4e57c5571bd8cc3168264c3bc46a1eArgyrios Kyrtzidis 220b1c99c679adb53be8f478d08be83af6c9c22ae4bDaniel Dunbar void setMappingInfo(diag::kind Diag, DiagnosticMappingInfo Info) { 221b1c99c679adb53be8f478d08be83af6c9c22ae4bDaniel Dunbar DiagMap[Diag] = Info; 222b1c99c679adb53be8f478d08be83af6c9c22ae4bDaniel Dunbar } 2233c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer 224ba494c64365d78b1cdb6baea4d1e79263389fda9Daniel Dunbar DiagnosticMappingInfo &getOrAddMappingInfo(diag::kind Diag); 225ba494c64365d78b1cdb6baea4d1e79263389fda9Daniel Dunbar 226ba494c64365d78b1cdb6baea4d1e79263389fda9Daniel Dunbar const_iterator begin() const { return DiagMap.begin(); } 227ba494c64365d78b1cdb6baea4d1e79263389fda9Daniel Dunbar const_iterator end() const { return DiagMap.end(); } 2280827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis }; 2293c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer 2300827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \brief Keeps and automatically disposes all DiagStates that we create. 2310827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis std::list<DiagState> DiagStates; 2320827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 2330827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \brief Represents a point in source where the diagnostic state was 234af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// modified because of a pragma. 235af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 236af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 'Loc' can be null if the point represents the diagnostic state 237af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// modifications done through the command-line. 2380827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis struct DiagStatePoint { 2390827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis DiagState *State; 2400827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis FullSourceLoc Loc; 2410827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis DiagStatePoint(DiagState *State, FullSourceLoc Loc) 2420827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis : State(State), Loc(Loc) { } 2430827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 2440827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis bool operator<(const DiagStatePoint &RHS) const { 2450827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis // If Loc is invalid it means it came from <command-line>, in which case 2460827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis // we regard it as coming before any valid source location. 2470827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis if (RHS.Loc.isInvalid()) 2480827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis return false; 2490827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis if (Loc.isInvalid()) 2500827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis return true; 2510827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis return Loc.isBeforeInTranslationUnitThan(RHS.Loc); 2523c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer } 2533c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer }; 25404ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 255af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief A sorted vector of all DiagStatePoints representing changes in 256af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// diagnostic state due to diagnostic pragmas. 257af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 258af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// The vector is always sorted according to the SourceLocation of the 259af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// DiagStatePoint. 2600827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis typedef std::vector<DiagStatePoint> DiagStatePointsTy; 2610827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis mutable DiagStatePointsTy DiagStatePoints; 2620827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 2630827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \brief Keeps the DiagState that was active during each diagnostic 'push' 2640827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// so we can get back at it when we 'pop'. 2650827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis std::vector<DiagState *> DiagStateOnPushStack; 2660827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 2670827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis DiagState *GetCurDiagState() const { 2680827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis assert(!DiagStatePoints.empty()); 2690827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis return DiagStatePoints.back().State; 2700827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis } 2710827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 2720827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis void PushDiagStatePoint(DiagState *State, SourceLocation L) { 27300aae5243d965aa7bcee81a39ba0900c7869be21Richard Smith FullSourceLoc Loc(L, getSourceManager()); 2740827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis // Make sure that DiagStatePoints is always sorted according to Loc. 27500aae5243d965aa7bcee81a39ba0900c7869be21Richard Smith assert(Loc.isValid() && "Adding invalid loc point"); 27600aae5243d965aa7bcee81a39ba0900c7869be21Richard Smith assert(!DiagStatePoints.empty() && 27700aae5243d965aa7bcee81a39ba0900c7869be21Richard Smith (DiagStatePoints.back().Loc.isInvalid() || 2780827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis DiagStatePoints.back().Loc.isBeforeInTranslationUnitThan(Loc)) && 2790827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis "Previous point loc comes after or is the same as new one"); 28000aae5243d965aa7bcee81a39ba0900c7869be21Richard Smith DiagStatePoints.push_back(DiagStatePoint(State, Loc)); 2810827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis } 2820827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 2830827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \brief Finds the DiagStatePoint that contains the diagnostic state of 2840827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// the given source location. 2850827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis DiagStatePointsTy::iterator GetDiagStatePointForLoc(SourceLocation Loc) const; 28604ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 287af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Sticky flag set to \c true when an error is emitted. 2885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ErrorOccurred; 289af50aab0c317462129d73ae8000c6394c718598dJames Dennett 29012f37e411462b8388eb1309357bd62257debacacDeLesley Hutchins /// \brief Sticky flag set to \c true when an "uncompilable error" occurs. 29112f37e411462b8388eb1309357bd62257debacacDeLesley Hutchins /// I.e. an error that was not upgraded from a warning by -Werror. 29212f37e411462b8388eb1309357bd62257debacacDeLesley Hutchins bool UncompilableErrorOccurred; 29312f37e411462b8388eb1309357bd62257debacacDeLesley Hutchins 294af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Sticky flag set to \c true when a fatal error is emitted. 29515221422eda7bac679e38b07512feda49715ef66Chris Lattner bool FatalErrorOccurred; 2961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 29785bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor /// \brief Indicates that an unrecoverable error has occurred. 29885bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor bool UnrecoverableErrorOccurred; 29985bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor 300c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis /// \brief Counts for DiagnosticErrorTrap to check whether an error occurred 301add80bb3957dba1d9389304453c0a4c975768bd7John McCall /// during a parsing section, e.g. during parsing a function. 302c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis unsigned TrapNumErrorsOccurred; 303c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis unsigned TrapNumUnrecoverableErrorsOccurred; 304add80bb3957dba1d9389304453c0a4c975768bd7John McCall 305af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief The level of the last diagnostic emitted. 306af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 307af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// This is used to emit continuation diagnostics with the same level as the 308f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// diagnostic that they follow. 30933e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis DiagnosticIDs::Level LastDiagLevel; 3105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 311af50aab0c317462129d73ae8000c6394c718598dJames Dennett unsigned NumWarnings; ///< Number of warnings reported 312af50aab0c317462129d73ae8000c6394c718598dJames Dennett unsigned NumErrors; ///< Number of errors reported 313af50aab0c317462129d73ae8000c6394c718598dJames Dennett unsigned NumErrorsSuppressed; ///< Number of errors suppressed 3147bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber 315af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief A function pointer that converts an opaque diagnostic 316af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// argument to a strings. 317af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 318af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// This takes the modifiers and argument that was present in the diagnostic. 319b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// 320b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// The PrevArgs array (whose length is NumPrevArgs) indicates the previous 321b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// arguments formatted for this diagnostic. Implementations of this function 322b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// can use this information to avoid redundancy across arguments. 323b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// 32422caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner /// This is a hack to avoid a layering violation between libbasic and libsema. 3250673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth typedef void (*ArgToStringFnTy)( 3260673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth ArgumentKind Kind, intptr_t Val, 3270673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth const char *Modifier, unsigned ModifierLen, 3280673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth const char *Argument, unsigned ArgumentLen, 3290673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth const ArgumentValue *PrevArgs, 3300673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth unsigned NumPrevArgs, 331686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<char> &Output, 3320673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth void *Cookie, 333341785ec52f87c0803ba52dc88faac4e136f8593Bill Wendling ArrayRef<intptr_t> QualTypeVals); 33492dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner void *ArgToStringCookie; 3353fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ArgToStringFnTy ArgToStringFn; 33693ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 33793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief ID of the "delayed" diagnostic, which is a (typically 33893ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// fatal) diagnostic that had to be delayed because it was found 33993ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// while emitting another diagnostic. 34093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor unsigned DelayedDiagID; 34193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 34293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief First string argument for the delayed diagnostic. 34393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor std::string DelayedDiagArg1; 34493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 34593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief Second string argument for the delayed diagnostic. 34693ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor std::string DelayedDiagArg2; 34793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 3486bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines /// \brief Flag name value. 3496bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines /// 3506bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines /// Some flags accept values. For instance, -Wframe-larger-than or -Rpass. 3516bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines /// When reporting a diagnostic with those flags, it is useful to also 3526bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines /// report the value that actually triggered the flag. The content of this 3536bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines /// string is a value to be emitted after the flag name. 3546bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines std::string FlagNameValue; 3556bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 3565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 357d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie explicit DiagnosticsEngine( 358c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith const IntrusiveRefCntPtr<DiagnosticIDs> &Diags, 35902c23ebf41ae2f70da0ba7337e05c51fbfe35f7fDouglas Gregor DiagnosticOptions *DiagOpts, 3606bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines DiagnosticConsumer *client = nullptr, 36133e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis bool ShouldOwnClient = true); 362d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie ~DiagnosticsEngine(); 3631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 364c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith const IntrusiveRefCntPtr<DiagnosticIDs> &getDiagnosticIDs() const { 36533e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return Diags; 36633e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis } 36733e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis 36802c23ebf41ae2f70da0ba7337e05c51fbfe35f7fDouglas Gregor /// \brief Retrieve the diagnostic options. 36902c23ebf41ae2f70da0ba7337e05c51fbfe35f7fDouglas Gregor DiagnosticOptions &getDiagnosticOptions() const { return *DiagOpts; } 37002c23ebf41ae2f70da0ba7337e05c51fbfe35f7fDouglas Gregor 3716bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines typedef llvm::iterator_range<DiagState::const_iterator> diag_mapping_range; 3726bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 3736bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines /// \brief Get the current set of diagnostic mappings. 3746bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines diag_mapping_range getDiagnosticMappings() const { 3756bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines const DiagState &DS = *GetCurDiagState(); 3766bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines return diag_mapping_range(DS.begin(), DS.end()); 3776bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines } 3786bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 37978ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie DiagnosticConsumer *getClient() { return Client; } 38078ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie const DiagnosticConsumer *getClient() const { return Client; } 3811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 382d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie /// \brief Determine whether this \c DiagnosticsEngine object own its client. 38378243658c533168d51fd076fba328437932ba6f1Douglas Gregor bool ownsClient() const { return OwnsDiagClient; } 38478243658c533168d51fd076fba328437932ba6f1Douglas Gregor 385bdbb004f38978da0c4a75af3294d1c7b5ff84af1Douglas Gregor /// \brief Return the current diagnostic client along with ownership of that 386bdbb004f38978da0c4a75af3294d1c7b5ff84af1Douglas Gregor /// client. 38778ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie DiagnosticConsumer *takeClient() { 38833e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis OwnsDiagClient = false; 38933e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return Client; 39033e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis } 39133e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis 3926bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines bool hasSourceManager() const { return SourceMgr != nullptr; } 39333e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis SourceManager &getSourceManager() const { 39433e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis assert(SourceMgr && "SourceManager not set!"); 39533e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return *SourceMgr; 39633e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis } 39733e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis void setSourceManager(SourceManager *SrcMgr) { SourceMgr = SrcMgr; } 39833e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis 39933e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis //===--------------------------------------------------------------------===// 400d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie // DiagnosticsEngine characterization methods, used by a client to customize 401d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie // how diagnostics are emitted. 40233e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis // 40304ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 404af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Copies the current DiagMappings and pushes the new copy 40504ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// onto the top of the stack. 4060827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis void pushMappings(SourceLocation Loc); 40704ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 408af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Pops the current DiagMappings off the top of the stack, 409af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// causing the new top of the stack to be the active mappings. 410af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 411af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \returns \c true if the pop happens, \c false if there is only one 412af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// DiagMapping on the stack. 4130827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis bool popMappings(SourceLocation Loc); 41404ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 415bdbb004f38978da0c4a75af3294d1c7b5ff84af1Douglas Gregor /// \brief Set the diagnostic client associated with this diagnostic object. 416bdbb004f38978da0c4a75af3294d1c7b5ff84af1Douglas Gregor /// 41733e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis /// \param ShouldOwnClient true if the diagnostic object should take 41833e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis /// ownership of \c client. 41978ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie void setClient(DiagnosticConsumer *client, bool ShouldOwnClient = true); 4205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 421af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Specify a limit for the number of errors we should 422af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// emit before giving up. 423af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 424af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// Zero disables the limit. 425c100214fdc41a7ea215f75d433eb1cb829fd4330Chris Lattner void setErrorLimit(unsigned Limit) { ErrorLimit = Limit; } 426b205ac9fcd22b87b41697172d1983c5ae9dabaafChris Lattner 427575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor /// \brief Specify the maximum number of template instantiation 428575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor /// notes to emit along with a given diagnostic. 429575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor void setTemplateBacktraceLimit(unsigned Limit) { 430575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor TemplateBacktraceLimit = Limit; 431575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor } 43208d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith 433575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor /// \brief Retrieve the maximum number of template instantiation 43408d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith /// notes to emit along with a given diagnostic. 435575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor unsigned getTemplateBacktraceLimit() const { 436575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor return TemplateBacktraceLimit; 437575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor } 43808d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith 43908d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith /// \brief Specify the maximum number of constexpr evaluation 44008d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith /// notes to emit along with a given diagnostic. 44108d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith void setConstexprBacktraceLimit(unsigned Limit) { 44208d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith ConstexprBacktraceLimit = Limit; 44308d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith } 44408d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith 44508d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith /// \brief Retrieve the maximum number of constexpr evaluation 44608d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith /// notes to emit along with a given diagnostic. 44708d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith unsigned getConstexprBacktraceLimit() const { 44808d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith return ConstexprBacktraceLimit; 44908d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith } 45008d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith 451af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief When set to true, any unmapped warnings are ignored. 452af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 453af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// If this and WarningsAsErrors are both set, then this one wins. 4545b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner void setIgnoreAllWarnings(bool Val) { IgnoreAllWarnings = Val; } 4555b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner bool getIgnoreAllWarnings() const { return IgnoreAllWarnings; } 4561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 457af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief When set to true, any unmapped ignored warnings are no longer 458af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// ignored. 459af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 460af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// If this and IgnoreAllWarnings are both set, then that one wins. 4611e473ccb0e0f6fd1954bef330f7193c1a3fb3ba1Ted Kremenek void setEnableAllWarnings(bool Val) { EnableAllWarnings = Val; } 46204863a86d15cb8de3361f8c77cedfd025819f174Benjamin Kramer bool getEnableAllWarnings() const { return EnableAllWarnings; } 46304863a86d15cb8de3361f8c77cedfd025819f174Benjamin Kramer 464af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief When set to true, any warnings reported are issued as errors. 4655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setWarningsAsErrors(bool Val) { WarningsAsErrors = Val; } 4665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getWarningsAsErrors() const { return WarningsAsErrors; } 4671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 468af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief When set to true, any error reported is made a fatal error. 469e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner void setErrorsAsFatal(bool Val) { ErrorsAsFatal = Val; } 470e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner bool getErrorsAsFatal() const { return ErrorsAsFatal; } 471e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner 472af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief When set to true mask warnings that come from system headers. 4732fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar void setSuppressSystemWarnings(bool Val) { SuppressSystemWarnings = Val; } 4742fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar bool getSuppressSystemWarnings() const { return SuppressSystemWarnings; } 4752fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar 47681b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor /// \brief Suppress all diagnostics, to silence the front end when we 47781b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor /// know that we don't want any more diagnostics to be passed along to the 47881b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor /// client 47981b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor void setSuppressAllDiagnostics(bool Val = true) { 48081b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor SuppressAllDiagnostics = Val; 48181b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor } 48281b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor bool getSuppressAllDiagnostics() const { return SuppressAllDiagnostics; } 483246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu 484246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu /// \brief Set type eliding, to skip outputting same types occurring in 485246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu /// template types. 486246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu void setElideType(bool Val = true) { ElideType = Val; } 487246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu bool getElideType() { return ElideType; } 488246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu 489246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu /// \brief Set tree printing, to outputting the template difference in a 490246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu /// tree format. 491246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu void setPrintTemplateTree(bool Val = false) { PrintTemplateTree = Val; } 492246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu bool getPrintTemplateTree() { return PrintTemplateTree; } 493246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu 494246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu /// \brief Set color printing, so the type diffing will inject color markers 495246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu /// into the output. 496246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu void setShowColors(bool Val = false) { ShowColors = Val; } 497246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu bool getShowColors() { return ShowColors; } 498246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu 4995edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin /// \brief Specify which overload candidates to show when overload resolution 500af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// fails. 501af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 502af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// By default, we show all candidates. 5035edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin void setShowOverloads(OverloadsShown Val) { 5045edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin ShowOverloads = Val; 5055edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin } 5065edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin OverloadsShown getShowOverloads() const { return ShowOverloads; } 5075edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin 5085d99a252c63a7745bcd71231ca5240d2a65e4f1dRichard Smith /// \brief Pretend that the last diagnostic issued was ignored, so any 5095d99a252c63a7745bcd71231ca5240d2a65e4f1dRichard Smith /// subsequent notes will be suppressed. 510af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 511af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// This can be used by clients who suppress diagnostics themselves. 5120b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor void setLastDiagnosticIgnored() { 5135d99a252c63a7745bcd71231ca5240d2a65e4f1dRichard Smith if (LastDiagLevel == DiagnosticIDs::Fatal) 5145d99a252c63a7745bcd71231ca5240d2a65e4f1dRichard Smith FatalErrorOccurred = true; 51533e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis LastDiagLevel = DiagnosticIDs::Ignored; 5160b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor } 517cbc820af7193e3ad9c71fbe6e3c8bd3c1166e540Richard Smith 518cbc820af7193e3ad9c71fbe6e3c8bd3c1166e540Richard Smith /// \brief Determine whether the previous diagnostic was ignored. This can 519cbc820af7193e3ad9c71fbe6e3c8bd3c1166e540Richard Smith /// be used by clients that want to determine whether notes attached to a 520cbc820af7193e3ad9c71fbe6e3c8bd3c1166e540Richard Smith /// diagnostic will be suppressed. 521cbc820af7193e3ad9c71fbe6e3c8bd3c1166e540Richard Smith bool isLastDiagnosticIgnored() const { 522cbc820af7193e3ad9c71fbe6e3c8bd3c1166e540Richard Smith return LastDiagLevel == DiagnosticIDs::Ignored; 523cbc820af7193e3ad9c71fbe6e3c8bd3c1166e540Richard Smith } 524cbc820af7193e3ad9c71fbe6e3c8bd3c1166e540Richard Smith 525af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Controls whether otherwise-unmapped extension diagnostics are 526af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// mapped onto ignore/warning/error. 527af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 528af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// This corresponds to the GCC -pedantic and -pedantic-errors option. 529b54b276a920246c595a0498da281821eb9d22996Chris Lattner void setExtensionHandlingBehavior(ExtensionHandling H) { 530b54b276a920246c595a0498da281821eb9d22996Chris Lattner ExtBehavior = H; 531b54b276a920246c595a0498da281821eb9d22996Chris Lattner } 532c1b5fa41f09512c74030b9a2a0d1564535e22a76Peter Collingbourne ExtensionHandling getExtensionHandlingBehavior() const { return ExtBehavior; } 5331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 534af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Counter bumped when an __extension__ block is/ encountered. 535af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 536af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// When non-zero, all extension diagnostics are entirely silenced, no 537af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// matter how they are mapped. 53827ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner void IncrementAllExtensionsSilenced() { ++AllExtensionsSilenced; } 53927ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner void DecrementAllExtensionsSilenced() { --AllExtensionsSilenced; } 54091a2886d558ea6ca7a0bed73ab5acea5ae78eac2Douglas Gregor bool hasAllExtensionsSilenced() { return AllExtensionsSilenced != 0; } 5411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 542697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief This allows the client to specify that certain warnings are 543697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// ignored. 544697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 545697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// Notes can never be mapped, errors can only be mapped to fatal, and 546697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// WARNINGs and EXTENSIONs can be mapped arbitrarily. 5470827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// 5480827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \param Loc The source location that this change of diagnostic state should 5490827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// take affect. It can be null if we are setting the latest state. 5500827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis void setDiagnosticMapping(diag::kind Diag, diag::Mapping Map, 5510827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis SourceLocation Loc); 5521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 553697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Change an entire diagnostic group (e.g. "unknown-pragmas") to 554697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// have the specified mapping. 555697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 556697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \returns true (and ignores the request) if "Group" was unknown, false 557697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// otherwise. 5580827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// 559697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \param Loc The source location that this change of diagnostic state should 5600827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// take affect. It can be null if we are setting the state from command-line. 561686775deca8b8685eb90801495880e3abdd844c2Chris Lattner bool setDiagnosticGroupMapping(StringRef Group, diag::Mapping Map, 5623f8394669673451061f57ced81f0a2cae087f119Daniel Dunbar SourceLocation Loc = SourceLocation()); 5635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 564697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Set the warning-as-error flag for the given diagnostic group. 565697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 566697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// This function always only operates on the current diagnostic state. 5674aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar /// 5684aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar /// \returns True if the given group is unknown, false otherwise. 5694aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar bool setDiagnosticGroupWarningAsError(StringRef Group, bool Enabled); 5704aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar 571697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Set the error-as-fatal flag for the given diagnostic group. 572697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 573697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// This function always only operates on the current diagnostic state. 5744aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar /// 5754aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar /// \returns True if the given group is unknown, false otherwise. 5764aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar bool setDiagnosticGroupErrorAsFatal(StringRef Group, bool Enabled); 5774aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar 578697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Add the specified mapping to all diagnostics. 579697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 580697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// Mainly to be used by -Wno-everything to disable all warnings but allow 581697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// subsequent -W options to enable specific warnings. 58282e6411d004064a29f03a3ea8b8919f297bfa843Argyrios Kyrtzidis void setMappingToAllDiagnostics(diag::Mapping Map, 58311583c757bac6ce5c342f2eb572055dd2619a657Argyrios Kyrtzidis SourceLocation Loc = SourceLocation()); 58411583c757bac6ce5c342f2eb572055dd2619a657Argyrios Kyrtzidis 5855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool hasErrorOccurred() const { return ErrorOccurred; } 58612f37e411462b8388eb1309357bd62257debacacDeLesley Hutchins 58712f37e411462b8388eb1309357bd62257debacacDeLesley Hutchins /// \brief Errors that actually prevent compilation, not those that are 58812f37e411462b8388eb1309357bd62257debacacDeLesley Hutchins /// upgraded from a warning by -Werror. 58912f37e411462b8388eb1309357bd62257debacacDeLesley Hutchins bool hasUncompilableErrorOccurred() const { 59012f37e411462b8388eb1309357bd62257debacacDeLesley Hutchins return UncompilableErrorOccurred; 59112f37e411462b8388eb1309357bd62257debacacDeLesley Hutchins } 59215221422eda7bac679e38b07512feda49715ef66Chris Lattner bool hasFatalErrorOccurred() const { return FatalErrorOccurred; } 59385bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor 59485bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor /// \brief Determine whether any kind of unrecoverable error has occurred. 59585bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor bool hasUnrecoverableErrorOccurred() const { 59685bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor return FatalErrorOccurred || UnrecoverableErrorOccurred; 59785bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor } 59885bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor 59953eee7ba970d21ff15bbd4334164037a3b4cc4b8Chris Lattner unsigned getNumWarnings() const { return NumWarnings; } 6001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 601c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor void setNumWarnings(unsigned NumWarnings) { 602c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor this->NumWarnings = NumWarnings; 603c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor } 604c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 605651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines /// \brief Return an ID for a diagnostic with the specified format string and 606651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines /// level. 607697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 608fc09336a5965040736f9bc63a70416003972364eStefanus Du Toit /// If this is the first request for this diagnostic, it is registered and 609697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// created, otherwise the existing ID is returned. 610651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines /// 611651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines /// \param FormatString A fixed diagnostic format string that will be hashed 612651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines /// and mapped to a unique DiagID. 613651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines template <unsigned N> 614651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines unsigned getCustomDiagID(Level L, const char (&FormatString)[N]) { 615651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines return Diags->getCustomDiagID((DiagnosticIDs::Level)L, 616651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines StringRef(FormatString, N - 1)); 61733e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis } 6181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 619697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Converts a diagnostic argument (as an intptr_t) into the string 620697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// that represents it. 6213fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner void ConvertArgToString(ArgumentKind Kind, intptr_t Val, 6223fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Modifier, unsigned ModLen, 6233fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Argument, unsigned ArgLen, 624b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner const ArgumentValue *PrevArgs, unsigned NumPrevArgs, 625686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<char> &Output, 6264def70d3040e73707c738f7c366737a986135edfRichard Smith ArrayRef<intptr_t> QualTypeVals) const { 627b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner ArgToStringFn(Kind, Val, Modifier, ModLen, Argument, ArgLen, 6280673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth PrevArgs, NumPrevArgs, Output, ArgToStringCookie, 6290673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth QualTypeVals); 63022caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 6311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 63292dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner void SetArgToStringFn(ArgToStringFnTy Fn, void *Cookie) { 6333fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ArgToStringFn = Fn; 63492dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner ArgToStringCookie = Cookie; 63522caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 6361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6375b9268f26ac53a74d2c504279fe577d988d5615dRichard Smith /// \brief Note that the prior diagnostic was emitted by some other 6385b9268f26ac53a74d2c504279fe577d988d5615dRichard Smith /// \c DiagnosticsEngine, and we may be attaching a note to that diagnostic. 6395b9268f26ac53a74d2c504279fe577d988d5615dRichard Smith void notePriorDiagnosticFrom(const DiagnosticsEngine &Other) { 6405b9268f26ac53a74d2c504279fe577d988d5615dRichard Smith LastDiagLevel = Other.LastDiagLevel; 6415b9268f26ac53a74d2c504279fe577d988d5615dRichard Smith } 6425b9268f26ac53a74d2c504279fe577d988d5615dRichard Smith 643abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \brief Reset the state of the diagnostic object to its initial 644abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// configuration. 645abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor void Reset(); 646abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor 6475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 648d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie // DiagnosticsEngine classification and reporting interfaces. 6495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // 6505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 651d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie /// \brief Based on the way the client configured the DiagnosticsEngine 6525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// object, classify the specified diagnostic ID into a Level, consumable by 65378ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie /// the DiagnosticConsumer. 6540827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// 6550827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \param Loc The source location we are interested in finding out the 6560827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// diagnostic state. Can be null in order to query the latest state. 6571656aaec223949245fdbebf306b719cba0b687caDaniel Dunbar Level getDiagnosticLevel(unsigned DiagID, SourceLocation Loc) const { 6581656aaec223949245fdbebf306b719cba0b687caDaniel Dunbar return (Level)Diags->getDiagnosticLevel(DiagID, Loc, *this); 65933e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis } 6601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 661697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Issue the message to the client. 662697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 663697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// This actually returns an instance of DiagnosticBuilder which emits the 664697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// diagnostics (through @c ProcessDiag) when it is destroyed. 665697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 666697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \param DiagID A member of the @c diag::kind enum. 667efce31f51d6e7e31e125f96c20f6cdab3ead0a47James Dennett /// \param Loc Represents the source location associated with the diagnostic, 668509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// which can be an invalid location if no position information is available. 669efce31f51d6e7e31e125f96c20f6cdab3ead0a47James Dennett inline DiagnosticBuilder Report(SourceLocation Loc, unsigned DiagID); 6700f9fed70cea107b3f79df554e38bd8e98d48fe47Daniel Dunbar inline DiagnosticBuilder Report(unsigned DiagID); 671de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor 672e59abb56ce0e1c206fb80bd945a0c358b0abe1efArgyrios Kyrtzidis void Report(const StoredDiagnostic &storedDiag); 673e59abb56ce0e1c206fb80bd945a0c358b0abe1efArgyrios Kyrtzidis 67493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief Determine whethere there is already a diagnostic in flight. 6755800f7ea9cf5621280089d690f677bd28064d6b5Ted Kremenek bool isDiagnosticInFlight() const { return CurDiagID != ~0U; } 67693ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 67793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief Set the "delayed" diagnostic that will be emitted once 67893ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// the current diagnostic completes. 67993ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// 68093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// If a diagnostic is already in-flight but the front end must 68193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// report a problem (e.g., with an inconsistent file system 68293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// state), this routine sets a "delayed" diagnostic that will be 68393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// emitted after the current diagnostic completes. This should 68493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// only be used for fatal errors detected at inconvenient 68593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// times. If emitting a delayed diagnostic causes a second delayed 68693ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// diagnostic to be introduced, that second delayed diagnostic 68793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// will be ignored. 68893ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// 68993ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \param DiagID The ID of the diagnostic being delayed. 69093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// 69193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \param Arg1 A string argument that will be provided to the 69293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// diagnostic. A copy of this string will be stored in the 693d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie /// DiagnosticsEngine object itself. 69493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// 69593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \param Arg2 A string argument that will be provided to the 69693ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// diagnostic. A copy of this string will be stored in the 697d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie /// DiagnosticsEngine object itself. 698686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void SetDelayedDiagnostic(unsigned DiagID, StringRef Arg1 = "", 699686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef Arg2 = ""); 70093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 701de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor /// \brief Clear out the current diagnostic. 702de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor void Clear() { CurDiagID = ~0U; } 7031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7046bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines /// \brief Return the value associated to this diagnostic flag. 7056bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines StringRef getFlagNameValue() const { return StringRef(FlagNameValue); } 7066bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 7076bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines /// \brief Set the value associated to this diagnostic flag. 7086bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines void setFlagNameValue(StringRef V) { FlagNameValue = V; } 7096bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 7100a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattnerprivate: 71193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief Report the delayed diagnostic. 71293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor void ReportDelayed(); 71393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 7143cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner // This is private state used by DiagnosticBuilder. We put it here instead of 7153cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner // in DiagnosticBuilder in order to keep DiagnosticBuilder a small lightweight 7160a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // object. This implementation choice means that we can only have one 7170a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // diagnostic "in flight" at a time, but this seems to be a reasonable 7180a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // tradeoff to keep these objects small. Assertions verify that only one 7190a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // diagnostic is in flight at a time. 72033e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis friend class DiagnosticIDs; 7213cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner friend class DiagnosticBuilder; 72240847cfb58acc3cac7d68727df9455ac45f2e118David Blaikie friend class Diagnostic; 7239b623639378d53a675921ddfa7316034d571881eDouglas Gregor friend class PartialDiagnostic; 7249c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis friend class DiagnosticErrorTrap; 7259b623639378d53a675921ddfa7316034d571881eDouglas Gregor 726697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief The location of the current diagnostic that is in flight. 72733e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis SourceLocation CurDiagLoc; 7281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 729697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief The ID of the current diagnostic that is in flight. 730697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 7313cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// This is set to ~0U when there is no diagnostic in flight. 732b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner unsigned CurDiagID; 733b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner 73473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner enum { 735697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief The maximum number of arguments we can hold. 736697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 737af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// We currently only support up to 10 arguments (%0-%9). A single 738af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// diagnostic with more than that almost certainly has to be simplified 739af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// anyway. 740981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar MaxArguments = 10, 74173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner }; 7421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 743697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief The number of entries in Arguments. 744730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner signed char NumDiagArgs; 745ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 746af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Specifies whether an argument is in DiagArgumentsStr or 747af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// in DiagArguments. 748af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 749af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// This is an array of ArgumentKind::ArgumentKind enum values, one for each 750af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// argument. 75173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner unsigned char DiagArgumentsKind[MaxArguments]; 7521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 753af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Holds the values of each string argument for the current 754697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// diagnostic. 755697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 756697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// This is only used when the corresponding ArgumentKind is ak_std_string. 75773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner std::string DiagArgumentsStr[MaxArguments]; 75873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 759697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief The values for the various substitution positions. 760697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 761697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// This is used when the argument is not an std::string. The specific 762697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// value is mangled into an intptr_t and the interpretation depends on 763697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// exactly what sort of argument kind it is. 76473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner intptr_t DiagArgumentsVal[MaxArguments]; 7651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 766697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief The list of ranges added to this diagnostic. 7676bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines SmallVector<CharSourceRange, 8> DiagRanges; 7681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 769697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief If valid, provides a hint with some code to insert, remove, 770981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar /// or modify at a particular position. 7716bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines SmallVector<FixItHint, 8> DiagFixItHints; 7724b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 77387429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis DiagnosticMappingInfo makeMappingInfo(diag::Mapping Map, SourceLocation L) { 77487429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis bool isPragma = L.isValid(); 77587429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis DiagnosticMappingInfo MappingInfo = DiagnosticMappingInfo::Make( 77687429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis Map, /*IsUser=*/true, isPragma); 77787429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis 77887429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis // If this is a pragma mapping, then set the diagnostic mapping flags so 77987429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis // that we override command line options. 78087429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis if (isPragma) { 78187429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis MappingInfo.setNoWarningAsError(true); 78287429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis MappingInfo.setNoErrorAsFatal(true); 78387429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis } 78487429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis 78587429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis return MappingInfo; 78687429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis } 78787429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis 788697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Used to report a diagnostic that is finally fully formed. 7895e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// 790697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \returns true if the diagnostic was emitted, false if it was suppressed. 79133e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis bool ProcessDiag() { 79233e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return Diags->ProcessDiag(*this); 79333e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis } 794f41d3be39980d40849850d3fb90403623cc8459eArgyrios Kyrtzidis 795393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar /// @name Diagnostic Emission 796393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar /// @{ 797393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbarprotected: 798393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar // Sema requires access to the following functions because the current design 799393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar // of SFINAE requires it to use its own SemaDiagnosticBuilder, which needs to 800393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar // access us directly to ensure we minimize the emitted code for the common 801393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar // Sema::Diag() patterns. 802393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar friend class Sema; 803393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar 8043054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar /// \brief Emit the current diagnostic and clear the diagnostic state. 805c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose /// 806c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose /// \param Force Emit the diagnostic regardless of suppression settings. 807c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose bool EmitCurrentDiagnostic(bool Force = false); 8083054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar 809393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar unsigned getCurrentDiagID() const { return CurDiagID; } 810393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar 811393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar SourceLocation getCurrentDiagLoc() const { return CurDiagLoc; } 812393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar 813393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar /// @} 814393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar 815f41d3be39980d40849850d3fb90403623cc8459eArgyrios Kyrtzidis friend class ASTReader; 816f41d3be39980d40849850d3fb90403623cc8459eArgyrios Kyrtzidis friend class ASTWriter; 8173cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}; 8183cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 8199c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis/// \brief RAII class that determines when any errors have occurred 8209c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis/// between the time the instance was created and the time it was 8219c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis/// queried. 8229c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidisclass DiagnosticErrorTrap { 823d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine &Diag; 824c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis unsigned NumErrors; 825c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis unsigned NumUnrecoverableErrors; 8269c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis 8279c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidispublic: 828d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie explicit DiagnosticErrorTrap(DiagnosticsEngine &Diag) 829add80bb3957dba1d9389304453c0a4c975768bd7John McCall : Diag(Diag) { reset(); } 8309c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis 8319c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis /// \brief Determine whether any errors have occurred since this 8329c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis /// object instance was created. 8339c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis bool hasErrorOccurred() const { 834c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis return Diag.TrapNumErrorsOccurred > NumErrors; 835add80bb3957dba1d9389304453c0a4c975768bd7John McCall } 836add80bb3957dba1d9389304453c0a4c975768bd7John McCall 837add80bb3957dba1d9389304453c0a4c975768bd7John McCall /// \brief Determine whether any unrecoverable errors have occurred since this 838add80bb3957dba1d9389304453c0a4c975768bd7John McCall /// object instance was created. 839add80bb3957dba1d9389304453c0a4c975768bd7John McCall bool hasUnrecoverableErrorOccurred() const { 840c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis return Diag.TrapNumUnrecoverableErrorsOccurred > NumUnrecoverableErrors; 8419c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis } 8429c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis 843af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Set to initial state of "no errors occurred". 844add80bb3957dba1d9389304453c0a4c975768bd7John McCall void reset() { 845c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis NumErrors = Diag.TrapNumErrorsOccurred; 846c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis NumUnrecoverableErrors = Diag.TrapNumUnrecoverableErrorsOccurred; 847add80bb3957dba1d9389304453c0a4c975768bd7John McCall } 8489c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis}; 8499c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis 8503cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 8513cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner// DiagnosticBuilder 8523cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 8533cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 854697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// \brief A little helper class used to produce diagnostics. 855697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// 856697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// This is constructed by the DiagnosticsEngine::Report method, and 857697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// allows insertion of extra information (arguments and source ranges) into 858697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// the currently "in flight" diagnostic. When the temporary for the builder 859697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// is destroyed, the diagnostic is issued. 8603cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// 8613cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// Note that many of these will be created as temporary objects (many call 8623cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// sites), so we want them to be small and we never want their address taken. 8633cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// This ensures that compilers with somewhat reasonable optimizers will promote 8643cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// the common fields to registers, eliminating increments of the NumArgs field, 8653cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// for example. 8663cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerclass DiagnosticBuilder { 867d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie mutable DiagnosticsEngine *DiagObj; 8686bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines mutable unsigned NumArgs; 8691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8707059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar /// \brief Status variable indicating if this diagnostic is still active. 8717059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar /// 872f3477c13eeaf11b32a41f181398fb5deffd0dd73Sylvestre Ledru // NOTE: This field is redundant with DiagObj (IsActive iff (DiagObj == 0)), 8737059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar // but LLVM is not currently smart enough to eliminate the null check that 8747059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar // Emit() would end up with if we used that as our status variable. 8757059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar mutable bool IsActive; 8767059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar 877c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose /// \brief Flag indicating that this diagnostic is being emitted via a 878c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose /// call to ForceEmit. 879c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose mutable bool IsForceEmit; 880c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose 881f56faa01936b9cf909623d7f06e3c2569ca4a78eDmitri Gribenko void operator=(const DiagnosticBuilder &) LLVM_DELETED_FUNCTION; 882d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie friend class DiagnosticsEngine; 8836bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 884ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor DiagnosticBuilder() 8856bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines : DiagObj(nullptr), NumArgs(0), IsActive(false), IsForceEmit(false) {} 886ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor 887d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie explicit DiagnosticBuilder(DiagnosticsEngine *diagObj) 8886bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines : DiagObj(diagObj), NumArgs(0), IsActive(true), IsForceEmit(false) { 889981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar assert(diagObj && "DiagnosticBuilder requires a valid DiagnosticsEngine!"); 8906bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines diagObj->DiagRanges.clear(); 8916bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines diagObj->DiagFixItHints.clear(); 892cbf46a0b2bb2b47d6e13437e0d52cc583c5ce539Argyrios Kyrtzidis } 893ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 8949b623639378d53a675921ddfa7316034d571881eDouglas Gregor friend class PartialDiagnostic; 895ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor 896b535041ee33c5eff255832bc5541c8d52aae8254Douglas Gregorprotected: 8973054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar void FlushCounts() { 8983054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar DiagObj->NumDiagArgs = NumArgs; 8993054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar } 90006265bd82073c06294a02a0bd891951fafb484a5Daniel Dunbar 901cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// \brief Clear out the current diagnostic. 9027059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar void Clear() const { 9036bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines DiagObj = nullptr; 9047059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar IsActive = false; 905c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose IsForceEmit = false; 9067059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar } 907cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar 908697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Determine whether this diagnostic is still active. 9097059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar bool isActive() const { return IsActive; } 91006265bd82073c06294a02a0bd891951fafb484a5Daniel Dunbar 911cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// \brief Force the diagnostic builder to emit the diagnostic now. 912cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// 913cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// Once this function has been called, the DiagnosticBuilder object 914cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// should not be used again before it is destroyed. 915cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// 916cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// \returns true if a diagnostic was emitted, false if the 917cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// diagnostic was suppressed. 9183054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar bool Emit() { 9197059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar // If this diagnostic is inactive, then its soul was stolen by the copy ctor 9207059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar // (or by a subclass, as in SemaDiagnosticBuilder). 9217059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar if (!isActive()) return false; 9223054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar 9233054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar // When emitting diagnostics, we set the final argument count into 9243054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar // the DiagnosticsEngine object. 9253054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar FlushCounts(); 9263054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar 9273054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar // Process the diagnostic. 928c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose bool Result = DiagObj->EmitCurrentDiagnostic(IsForceEmit); 9293054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar 9303054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar // This diagnostic is dead. 9317059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar Clear(); 9323054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar 9333054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar return Result; 9343054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar } 9359b623639378d53a675921ddfa7316034d571881eDouglas Gregor 9361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumppublic: 9370a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// Copy constructor. When copied, this "takes" the diagnostic info from the 9380a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// input and neuters it. 9393cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagnosticBuilder(const DiagnosticBuilder &D) { 9400a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner DiagObj = D.DiagObj; 9417059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar IsActive = D.IsActive; 942c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose IsForceEmit = D.IsForceEmit; 9437059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar D.Clear(); 94425a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor NumArgs = D.NumArgs; 9450a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 94625a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor 947ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor /// \brief Retrieve an empty diagnostic builder. 948ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor static DiagnosticBuilder getEmpty() { 949ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor return DiagnosticBuilder(); 950ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor } 951ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor 952697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Emits the diagnostic. 95353c83b32550b3f29db2419160fa2e3684e420556Daniel Dunbar ~DiagnosticBuilder() { 9543054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar Emit(); 95553c83b32550b3f29db2419160fa2e3684e420556Daniel Dunbar } 9569b623639378d53a675921ddfa7316034d571881eDouglas Gregor 957c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose /// \brief Forces the diagnostic to be emitted. 958c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose const DiagnosticBuilder &setForceEmit() const { 959c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose IsForceEmit = true; 960c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose return *this; 961c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose } 962c6d64a26c28bbeee50e06c94c4f4c08e610327b7Jordan Rose 963af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Conversion of DiagnosticBuilder to bool always returns \c true. 964af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 965af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// This allows is to be used in boolean error contexts (where \c true is 966af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// used to indicate that an error has occurred), like: 967af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \code 9683cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// return Diag(...); 969af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \endcode 9703cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner operator bool() const { return true; } 9713cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 972686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void AddString(StringRef S) const { 973cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar assert(isActive() && "Clients must not add to cleared diagnostic!"); 974d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(NumArgs < DiagnosticsEngine::MaxArguments && 9753cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 976cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar DiagObj->DiagArgumentsKind[NumArgs] = DiagnosticsEngine::ak_std_string; 977cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar DiagObj->DiagArgumentsStr[NumArgs++] = S; 9783cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner } 9791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 980d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie void AddTaggedVal(intptr_t V, DiagnosticsEngine::ArgumentKind Kind) const { 981cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar assert(isActive() && "Clients must not add to cleared diagnostic!"); 982d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(NumArgs < DiagnosticsEngine::MaxArguments && 9833cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 984cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar DiagObj->DiagArgumentsKind[NumArgs] = Kind; 985cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar DiagObj->DiagArgumentsVal[NumArgs++] = V; 9860a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 9871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9880a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner void AddSourceRange(const CharSourceRange &R) const { 989cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar assert(isActive() && "Clients must not add to cleared diagnostic!"); 9906bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines DiagObj->DiagRanges.push_back(R); 9911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 9924b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 993849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor void AddFixItHint(const FixItHint &Hint) const { 994cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar assert(isActive() && "Clients must not add to cleared diagnostic!"); 9956bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines DiagObj->DiagFixItHints.push_back(Hint); 9964b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 99782c6dc72adc30e785ce5bc6e8b43ae92070d2e08David Blaikie 9986bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines void addFlagValue(StringRef V) const { DiagObj->setFlagNameValue(V); } 9996bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines}; 10005940bf33061844c9a61d4d5c1230df9cf9e90342Richard Trieu 10016bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hinesstruct AddFlagValue { 10026bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines explicit AddFlagValue(StringRef V) : Val(V) {} 10036bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines StringRef Val; 10043cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}; 10053cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 10066bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines/// \brief Register a value for the flag in the current diagnostic. This 10076bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines/// value will be shown as the suffix "=value" after the flag name. It is 10086bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines/// useful in cases where the diagnostic flag accepts values (e.g., 10096bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines/// -Rpass or -Wframe-larger-than). 10106bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hinesinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 10116bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines const AddFlagValue V) { 10126bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines DB.addFlagValue(V.Val); 10136bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines return DB; 10146bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines} 10156bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 10163cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 1017686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef S) { 10183cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddString(S); 10193cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 10203cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 10213cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 10223cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 10233cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const char *Str) { 10243cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(reinterpret_cast<intptr_t>(Str), 1025d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine::ak_c_string); 10263cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 10273cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 10283cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 10293cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, int I) { 1030d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DB.AddTaggedVal(I, DiagnosticsEngine::ak_sint); 10313cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 10323cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 10333cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 1034651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines// We use enable_if here to prevent that this overload is selected for 1035651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines// pointers or other arguments that are implicitly convertible to bool. 1036651f13cea278ec967336033dd032faef0e9fc2ecStephen Hinestemplate <typename T> 1037651f13cea278ec967336033dd032faef0e9fc2ecStephen Hinesinline 1038651f13cea278ec967336033dd032faef0e9fc2ecStephen Hinestypename std::enable_if<std::is_same<T, bool>::value, 1039651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines const DiagnosticBuilder &>::type 1040651f13cea278ec967336033dd032faef0e9fc2ecStephen Hinesoperator<<(const DiagnosticBuilder &DB, T I) { 1041d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DB.AddTaggedVal(I, DiagnosticsEngine::ak_sint); 10423bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis return DB; 10433bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis} 10443bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis 10453cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 10463cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner unsigned I) { 1047d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DB.AddTaggedVal(I, DiagnosticsEngine::ak_uint); 10483cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 10493cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 10503cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 10513cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 1052651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines tok::TokenKind I) { 1053651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines DB.AddTaggedVal(static_cast<unsigned>(I), DiagnosticsEngine::ak_tokenkind); 1054651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines return DB; 1055651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines} 1056651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines 1057651f13cea278ec967336033dd032faef0e9fc2ecStephen Hinesinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 10583cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const IdentifierInfo *II) { 10593cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(reinterpret_cast<intptr_t>(II), 1060d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine::ak_identifierinfo); 10613cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 10623cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 10631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10643f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// Adds a DeclContext to the diagnostic. The enable_if template magic is here 10653f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// so that we only match those arguments that are (statically) DeclContexts; 10663f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// other arguments that derive from DeclContext (e.g., RecordDecls) will not 10673f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// match. 10683f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregortemplate<typename T> 10693f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregorinline 1070651f13cea278ec967336033dd032faef0e9fc2ecStephen Hinestypename std::enable_if<std::is_same<T, DeclContext>::value, 1071651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines const DiagnosticBuilder &>::type 10723f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregoroperator<<(const DiagnosticBuilder &DB, T *DC) { 10733f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor DB.AddTaggedVal(reinterpret_cast<intptr_t>(DC), 1074d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine::ak_declcontext); 10753f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor return DB; 10763f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor} 1077651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines 10783cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 10793cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const SourceRange &R) { 10800a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner DB.AddSourceRange(CharSourceRange::getTokenRange(R)); 10813cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 10823cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 10834b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 10844b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregorinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 1085651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines ArrayRef<SourceRange> Ranges) { 1086651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines for (const SourceRange &R: Ranges) 1087651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines DB.AddSourceRange(CharSourceRange::getTokenRange(R)); 1088651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines return DB; 1089651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines} 1090651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines 1091651f13cea278ec967336033dd032faef0e9fc2ecStephen Hinesinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 10920a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner const CharSourceRange &R) { 10930a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner DB.AddSourceRange(R); 10940a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner return DB; 10950a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner} 1096651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines 10970a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 1098849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor const FixItHint &Hint) { 10993739b32a01b9778176757425e62252c288b85383Ted Kremenek if (!Hint.isNull()) 11003739b32a01b9778176757425e62252c288b85383Ted Kremenek DB.AddFixItHint(Hint); 11014b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor return DB; 11024b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor} 1103ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 1104d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikieinline DiagnosticBuilder DiagnosticsEngine::Report(SourceLocation Loc, 1105651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines unsigned DiagID) { 11063cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(CurDiagID == ~0U && "Multiple diagnostics in flight at once!"); 11073cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner CurDiagLoc = Loc; 11083cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner CurDiagID = DiagID; 11096bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines FlagNameValue.clear(); 11103cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DiagnosticBuilder(this); 11113cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 11126bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 1113d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikieinline DiagnosticBuilder DiagnosticsEngine::Report(unsigned DiagID) { 111433e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return Report(SourceLocation(), DiagID); 11150f9fed70cea107b3f79df554e38bd8e98d48fe47Daniel Dunbar} 11163cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 11173cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 111840847cfb58acc3cac7d68727df9455ac45f2e118David Blaikie// Diagnostic 11193cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 11201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1121697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// A little helper class (which is basically a smart pointer that forwards 1122697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// info from DiagnosticsEngine) that allows clients to enquire about the 1123697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// currently in-flight diagnostic. 112440847cfb58acc3cac7d68727df9455ac45f2e118David Blaikieclass Diagnostic { 1125d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie const DiagnosticsEngine *DiagObj; 1126686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef StoredDiagMessage; 11273cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerpublic: 112840847cfb58acc3cac7d68727df9455ac45f2e118David Blaikie explicit Diagnostic(const DiagnosticsEngine *DO) : DiagObj(DO) {} 112940847cfb58acc3cac7d68727df9455ac45f2e118David Blaikie Diagnostic(const DiagnosticsEngine *DO, StringRef storedDiagMessage) 1130e59abb56ce0e1c206fb80bd945a0c358b0abe1efArgyrios Kyrtzidis : DiagObj(DO), StoredDiagMessage(storedDiagMessage) {} 11311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1132d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie const DiagnosticsEngine *getDiags() const { return DiagObj; } 1133b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner unsigned getID() const { return DiagObj->CurDiagID; } 113433e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis const SourceLocation &getLocation() const { return DiagObj->CurDiagLoc; } 113533e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis bool hasSourceManager() const { return DiagObj->hasSourceManager(); } 113633e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis SourceManager &getSourceManager() const { return DiagObj->getSourceManager();} 11371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11380a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned getNumArgs() const { return DiagObj->NumDiagArgs; } 11391eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1140af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Return the kind of the specified index. 1141af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 1142af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// Based on the kind of argument, the accessors below can be used to get 1143af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// the value. 1144af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 1145af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \pre Idx < getNumArgs() 1146d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine::ArgumentKind getArgKind(unsigned Idx) const { 11473cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(Idx < getNumArgs() && "Argument index out of range!"); 1148d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie return (DiagnosticsEngine::ArgumentKind)DiagObj->DiagArgumentsKind[Idx]; 114973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner } 11501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1151af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Return the provided argument string specified by \p Idx. 1152af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_std_string 115373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner const std::string &getArgStdStr(unsigned Idx) const { 1154d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(getArgKind(Idx) == DiagnosticsEngine::ak_std_string && 11553cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 115673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner return DiagObj->DiagArgumentsStr[Idx]; 115773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner } 11581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1159af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Return the specified C string argument. 1160af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_c_string 116173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner const char *getArgCStr(unsigned Idx) const { 1162d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(getArgKind(Idx) == DiagnosticsEngine::ak_c_string && 11633cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 116473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner return reinterpret_cast<const char*>(DiagObj->DiagArgumentsVal[Idx]); 11650a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 11661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1167af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Return the specified signed integer argument. 1168af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_sint 116930bc96544346bea42921cf6837e66cef80d664b4Chris Lattner int getArgSInt(unsigned Idx) const { 1170d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(getArgKind(Idx) == DiagnosticsEngine::ak_sint && 11713cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 117230bc96544346bea42921cf6837e66cef80d664b4Chris Lattner return (int)DiagObj->DiagArgumentsVal[Idx]; 117330bc96544346bea42921cf6837e66cef80d664b4Chris Lattner } 11741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1175af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Return the specified unsigned integer argument. 1176af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_uint 117730bc96544346bea42921cf6837e66cef80d664b4Chris Lattner unsigned getArgUInt(unsigned Idx) const { 1178d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(getArgKind(Idx) == DiagnosticsEngine::ak_uint && 11793cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 118030bc96544346bea42921cf6837e66cef80d664b4Chris Lattner return (unsigned)DiagObj->DiagArgumentsVal[Idx]; 118130bc96544346bea42921cf6837e66cef80d664b4Chris Lattner } 11821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1183af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Return the specified IdentifierInfo argument. 1184af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_identifierinfo 118543b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner const IdentifierInfo *getArgIdentifier(unsigned Idx) const { 1186d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(getArgKind(Idx) == DiagnosticsEngine::ak_identifierinfo && 11873cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 11889634379265855f1628190e926d9aaf1fb4a5d90eChris Lattner return reinterpret_cast<IdentifierInfo*>(DiagObj->DiagArgumentsVal[Idx]); 118943b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner } 11901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1191af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Return the specified non-string argument in an opaque form. 1192af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \pre getArgKind(Idx) != DiagnosticsEngine::ak_std_string 119322caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner intptr_t getRawArg(unsigned Idx) const { 1194d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(getArgKind(Idx) != DiagnosticsEngine::ak_std_string && 119522caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner "invalid argument accessor!"); 119622caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner return DiagObj->DiagArgumentsVal[Idx]; 119722caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 11981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1199af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Return the number of source ranges associated with this diagnostic. 12000a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned getNumRanges() const { 12016bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines return DiagObj->DiagRanges.size(); 12020a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 12031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1204af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \pre Idx < getNumRanges() 12050a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner const CharSourceRange &getRange(unsigned Idx) const { 12066bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines assert(Idx < getNumRanges() && "Invalid diagnostic range index!"); 120751c6d384551674facc19f745ecf6e289d28dc55fDouglas Gregor return DiagObj->DiagRanges[Idx]; 12080a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 12091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 121028409289193afca1a3178a9796f8e8aebcb76896Chandler Carruth /// \brief Return an array reference for this diagnostic's ranges. 121128409289193afca1a3178a9796f8e8aebcb76896Chandler Carruth ArrayRef<CharSourceRange> getRanges() const { 12126bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines return DiagObj->DiagRanges; 121328409289193afca1a3178a9796f8e8aebcb76896Chandler Carruth } 121428409289193afca1a3178a9796f8e8aebcb76896Chandler Carruth 1215849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor unsigned getNumFixItHints() const { 12166bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines return DiagObj->DiagFixItHints.size(); 12174b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 12184b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1219849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor const FixItHint &getFixItHint(unsigned Idx) const { 1220981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar assert(Idx < getNumFixItHints() && "Invalid index!"); 1221981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar return DiagObj->DiagFixItHints[Idx]; 12224b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 12234b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 12246bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines ArrayRef<FixItHint> getFixItHints() const { 12256bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines return DiagObj->DiagFixItHints; 12264b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 12274b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1228af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Format this diagnostic into a string, substituting the 1229af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// formal arguments into the %0 slots. 1230af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 1231af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// The result is appended onto the \p OutStr array. 1232686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void FormatDiagnostic(SmallVectorImpl<char> &OutStr) const; 12339f28614bf1a8387000d8df57a713fcf69e198145John McCall 1234af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Format the given format-string into the output buffer using the 1235af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// arguments stored in this diagnostic. 12369f28614bf1a8387000d8df57a713fcf69e198145John McCall void FormatDiagnostic(const char *DiagStr, const char *DiagEnd, 1237686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<char> &OutStr) const; 1238a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor}; 1239a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 1240a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor/** 1241d3ab63e0f66429abf2a3e4cde889e420e41e8790Douglas Gregor * \brief Represents a diagnostic in a form that can be retained until its 1242d3ab63e0f66429abf2a3e4cde889e420e41e8790Douglas Gregor * corresponding source manager is destroyed. 1243a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor */ 1244a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregorclass StoredDiagnostic { 1245aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor unsigned ID; 1246d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine::Level Level; 1247a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor FullSourceLoc Loc; 1248a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor std::string Message; 12490a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner std::vector<CharSourceRange> Ranges; 1250849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor std::vector<FixItHint> FixIts; 1251a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 1252a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregorpublic: 1253a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor StoredDiagnostic(); 125440847cfb58acc3cac7d68727df9455ac45f2e118David Blaikie StoredDiagnostic(DiagnosticsEngine::Level Level, const Diagnostic &Info); 1255d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie StoredDiagnostic(DiagnosticsEngine::Level Level, unsigned ID, 1256686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef Message); 1257d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie StoredDiagnostic(DiagnosticsEngine::Level Level, unsigned ID, 1258686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef Message, FullSourceLoc Loc, 12592d3ba4f5a923a90c3fc290ddfba5e36c2d0a9b46Chris Lattner ArrayRef<CharSourceRange> Ranges, 12602d3ba4f5a923a90c3fc290ddfba5e36c2d0a9b46Chris Lattner ArrayRef<FixItHint> Fixits); 1261a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor ~StoredDiagnostic(); 1262a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 1263a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// \brief Evaluates true when this object stores a diagnostic. 12647247c88d1e41514a41085f83ebf03dd5220e054aDavid Blaikie LLVM_EXPLICIT operator bool() const { return Message.size() > 0; } 1265a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 1266aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor unsigned getID() const { return ID; } 1267d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine::Level getLevel() const { return Level; } 1268a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor const FullSourceLoc &getLocation() const { return Loc; } 1269686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef getMessage() const { return Message; } 1270c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 1271c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor void setLocation(FullSourceLoc Loc) { this->Loc = Loc; } 1272c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 12730a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner typedef std::vector<CharSourceRange>::const_iterator range_iterator; 1274a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor range_iterator range_begin() const { return Ranges.begin(); } 1275a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor range_iterator range_end() const { return Ranges.end(); } 1276a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned range_size() const { return Ranges.size(); } 12776700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek 12786700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek ArrayRef<CharSourceRange> getRanges() const { 12796700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek return llvm::makeArrayRef(Ranges); 12806700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek } 12816700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek 1282a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 1283849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor typedef std::vector<FixItHint>::const_iterator fixit_iterator; 1284a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor fixit_iterator fixit_begin() const { return FixIts.begin(); } 1285a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor fixit_iterator fixit_end() const { return FixIts.end(); } 1286a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned fixit_size() const { return FixIts.size(); } 12876700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek 12886700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek ArrayRef<FixItHint> getFixIts() const { 12896700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek return llvm::makeArrayRef(FixIts); 12906700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek } 12915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 12921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1293af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// \brief Abstract interface, implemented by clients of the front-end, which 1294af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// formats and prints fully processed diagnostics. 129578ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikieclass DiagnosticConsumer { 1296ab41b97c3cddf1bcdd8bf82ab09ed3ceafcd05b1Argyrios Kyrtzidisprotected: 1297af50aab0c317462129d73ae8000c6394c718598dJames Dennett unsigned NumWarnings; ///< Number of warnings reported 1298af50aab0c317462129d73ae8000c6394c718598dJames Dennett unsigned NumErrors; ///< Number of errors reported 1299f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis 13005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 130178ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie DiagnosticConsumer() : NumWarnings(0), NumErrors(0) { } 1302f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis 1303f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis unsigned getNumErrors() const { return NumErrors; } 1304f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis unsigned getNumWarnings() const { return NumWarnings; } 130561d679ab2831b161c857cf3f974312fbd4ef1efdArgyrios Kyrtzidis virtual void clear() { NumWarnings = NumErrors = 0; } 1306f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis 130778ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie virtual ~DiagnosticConsumer(); 13081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1309af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Callback to inform the diagnostic client that processing 1310efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// of a source file is beginning. 1311efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// 1312efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// Note that diagnostics may be emitted outside the processing of a source 1313efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// file, for example during the parsing of command line options. However, 1314efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// diagnostics with source range information are required to only be emitted 1315efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// in between BeginSourceFile() and EndSourceFile(). 1316efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// 1317af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \param LangOpts The language options for the source file being processed. 1318af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \param PP The preprocessor object being used for the source; this is 1319af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// optional, e.g., it may not be present when processing AST source files. 13207d90199f109290e9d587479a481a2850d390b552Daniel Dunbar virtual void BeginSourceFile(const LangOptions &LangOpts, 13216bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines const Preprocessor *PP = nullptr) {} 1322efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar 1323af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Callback to inform the diagnostic client that processing 1324af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// of a source file has ended. 1325af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 1326af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// The diagnostic client should assume that any objects made available via 1327af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// BeginSourceFile() are inaccessible. 1328efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar virtual void EndSourceFile() {} 13291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 133029f2787b6da552018a7716f18f5bd8f67bd6edb5Argyrios Kyrtzidis /// \brief Callback to inform the diagnostic client that processing of all 133129f2787b6da552018a7716f18f5bd8f67bd6edb5Argyrios Kyrtzidis /// source files has ended. 133229f2787b6da552018a7716f18f5bd8f67bd6edb5Argyrios Kyrtzidis virtual void finish() {} 133329f2787b6da552018a7716f18f5bd8f67bd6edb5Argyrios Kyrtzidis 1334af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Indicates whether the diagnostics handled by this 133578ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie /// DiagnosticConsumer should be included in the number of diagnostics 133678ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie /// reported by DiagnosticsEngine. 1337af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 1338af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// The default implementation returns true. 1339cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek virtual bool IncludeInDiagnosticCounts() const; 13405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1341af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Handle this diagnostic, reporting it to the user or 13425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// capturing it to a log as needed. 1343f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis /// 1344af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// The default implementation just keeps track of the total number of 1345af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// warnings and errors. 1346d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie virtual void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel, 134740847cfb58acc3cac7d68727df9455ac45f2e118David Blaikie const Diagnostic &Info); 1348aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor}; 1349aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor 1350af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// \brief A diagnostic client that ignores all diagnostics. 1351aee526e77657afd1600276450e9c346953ad51d7Douglas Gregorclass IgnoringDiagConsumer : public DiagnosticConsumer { 135299ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie virtual void anchor(); 1353aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel, 1354651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines const Diagnostic &Info) override { 1355aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor // Just ignore it. 1356aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor } 13575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 13585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1359a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregor/// \brief Diagnostic consumer that forwards diagnostics along to an 1360a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregor/// existing, already-initialized diagnostic consumer. 1361a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregor/// 1362a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregorclass ForwardingDiagnosticConsumer : public DiagnosticConsumer { 1363a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregor DiagnosticConsumer &Target; 1364a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregor 1365a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregorpublic: 1366a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregor ForwardingDiagnosticConsumer(DiagnosticConsumer &Target) : Target(Target) {} 1367a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregor 1368a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregor virtual ~ForwardingDiagnosticConsumer(); 1369a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregor 1370651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel, 1371651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines const Diagnostic &Info) override; 1372651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines void clear() override; 1373a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregor 1374651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines bool IncludeInDiagnosticCounts() const override; 1375a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregor}; 1376a4a90cabfa15c900016a7cfaea51a6d4e8ebf4dbDouglas Gregor 1377246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu// Struct used for sending info about how a type should be printed. 1378246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieustruct TemplateDiffTypes { 1379246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu intptr_t FromType; 1380246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu intptr_t ToType; 1381246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu unsigned PrintTree : 1; 1382246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu unsigned PrintFromType : 1; 1383246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu unsigned ElideType : 1; 1384246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu unsigned ShowColors : 1; 13855409d28b6167032696f4915bb765a6f7db579f3fRichard Trieu // The printer sets this variable to true if the template diff was used. 13865409d28b6167032696f4915bb765a6f7db579f3fRichard Trieu unsigned TemplateDiffUsed : 1; 1387246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu}; 1388246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu 1389246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu/// Special character that the diagnostic printer will use to toggle the bold 1390246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu/// attribute. The character itself will be not be printed. 1391246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieuconst char ToggleHighlight = 127; 1392246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu 13936bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 13946bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines/// ProcessWarningOptions - Initialize the diagnostic client and process the 13956bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines/// warning options specified on the command line. 13966bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hinesvoid ProcessWarningOptions(DiagnosticsEngine &Diags, 13976bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines const DiagnosticOptions &Opts, 13986bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines bool ReportDiags = true); 13996bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 14005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 14015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 14025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 1403