Diagnostic.h revision 246b6aa6763de8c617d564ef33123a8f3293a80e
15f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===--- Diagnostic.h - C Language Family Diagnostic Handling ---*- C++ -*-===// 25f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 35f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// The LLVM Compiler Infrastructure 45f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 50bc735ffcfb223c0186419547abaa5c84482663eChris Lattner// This file is distributed under the University of Illinois Open Source 60bc735ffcfb223c0186419547abaa5c84482663eChris Lattner// License. See LICENSE.TXT for details. 75f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 85f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===----------------------------------------------------------------------===// 95f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// This file defines the Diagnostic-related interfaces. 115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===----------------------------------------------------------------------===// 135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#ifndef LLVM_CLANG_DIAGNOSTIC_H 155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#define LLVM_CLANG_DIAGNOSTIC_H 165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1733e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis#include "clang/Basic/DiagnosticIDs.h" 182eefd8657c233bc7c9330acfe475fc270bbe7cabTed Kremenek#include "clang/Basic/SourceLocation.h" 19f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor#include "llvm/ADT/ArrayRef.h" 200827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis#include "llvm/ADT/DenseMap.h" 2128019772db70d4547be05a042eb950bc910f134fDouglas Gregor#include "llvm/ADT/IntrusiveRefCntPtr.h" 22bdbb004f38978da0c4a75af3294d1c7b5ff84af1Douglas Gregor#include "llvm/ADT/OwningPtr.h" 233f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor#include "llvm/Support/type_traits.h" 245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2533e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis#include <vector> 260827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis#include <list> 27f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner 285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang { 2978ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie class DiagnosticConsumer; 3033e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis class DiagnosticBuilder; 31d42ffbd22fc7eb61321f6a88173ee424991f01c6Ted Kremenek class IdentifierInfo; 3233e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis class DeclContext; 3340469651a3f8379dc0f32df69e9bade06a2aad36Chris Lattner class LangOptions; 347d90199f109290e9d587479a481a2850d390b552Daniel Dunbar class Preprocessor; 359c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis class DiagnosticErrorTrap; 36e59abb56ce0e1c206fb80bd945a0c358b0abe1efArgyrios Kyrtzidis class StoredDiagnostic; 371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 384b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// \brief Annotates a diagnostic with some code that should be 394b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// inserted, removed, or replaced to fix the problem. 404b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// 414b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// This kind of hint should be used when we are certain that the 424b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// introduction, removal, or modification of a particular (small!) 434b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// amount of code will correct a compilation error. The compiler 444b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// should also provide full recovery from such errors, such that 45b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor/// suppressing the diagnostic output can still result in successful 464b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// compilation. 47849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregorclass FixItHint { 484b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregorpublic: 49783c56f47745f719590b17afd7ed937bf2407b53Douglas Gregor /// \brief Code that should be replaced to correct the error. Empty for an 50783c56f47745f719590b17afd7ed937bf2407b53Douglas Gregor /// insertion hint. 510a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner CharSourceRange RemoveRange; 524b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 5330660a898545416f0fea2d717f16f75640001e38Ted Kremenek /// \brief Code in the specific range that should be inserted in the insertion 5430660a898545416f0fea2d717f16f75640001e38Ted Kremenek /// location. 5530660a898545416f0fea2d717f16f75640001e38Ted Kremenek CharSourceRange InsertFromRange; 5630660a898545416f0fea2d717f16f75640001e38Ted Kremenek 574b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief The actual code to insert at the insertion location, as a 584b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// string. 594b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor std::string CodeToInsert; 604b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 6130660a898545416f0fea2d717f16f75640001e38Ted Kremenek bool BeforePreviousInsertions; 6230660a898545416f0fea2d717f16f75640001e38Ted Kremenek 634b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Empty code modification hint, indicating that no code 644b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// modification is known. 6530660a898545416f0fea2d717f16f75640001e38Ted Kremenek FixItHint() : BeforePreviousInsertions(false) { } 664b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 672f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson bool isNull() const { 68783c56f47745f719590b17afd7ed937bf2407b53Douglas Gregor return !RemoveRange.isValid(); 692f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson } 702f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson 714b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that inserts the given 724b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// code string at a specific location. 73849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor static FixItHint CreateInsertion(SourceLocation InsertionLoc, 7430660a898545416f0fea2d717f16f75640001e38Ted Kremenek StringRef Code, 7530660a898545416f0fea2d717f16f75640001e38Ted Kremenek bool BeforePreviousInsertions = false) { 76849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor FixItHint Hint; 77783c56f47745f719590b17afd7ed937bf2407b53Douglas Gregor Hint.RemoveRange = 78783c56f47745f719590b17afd7ed937bf2407b53Douglas Gregor CharSourceRange(SourceRange(InsertionLoc, InsertionLoc), false); 79b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.CodeToInsert = Code; 8030660a898545416f0fea2d717f16f75640001e38Ted Kremenek Hint.BeforePreviousInsertions = BeforePreviousInsertions; 8130660a898545416f0fea2d717f16f75640001e38Ted Kremenek return Hint; 8230660a898545416f0fea2d717f16f75640001e38Ted Kremenek } 8330660a898545416f0fea2d717f16f75640001e38Ted Kremenek 8430660a898545416f0fea2d717f16f75640001e38Ted Kremenek /// \brief Create a code modification hint that inserts the given 8530660a898545416f0fea2d717f16f75640001e38Ted Kremenek /// code from \arg FromRange at a specific location. 8630660a898545416f0fea2d717f16f75640001e38Ted Kremenek static FixItHint CreateInsertionFromRange(SourceLocation InsertionLoc, 8730660a898545416f0fea2d717f16f75640001e38Ted Kremenek CharSourceRange FromRange, 8830660a898545416f0fea2d717f16f75640001e38Ted Kremenek bool BeforePreviousInsertions = false) { 8930660a898545416f0fea2d717f16f75640001e38Ted Kremenek FixItHint Hint; 9030660a898545416f0fea2d717f16f75640001e38Ted Kremenek Hint.RemoveRange = 9130660a898545416f0fea2d717f16f75640001e38Ted Kremenek CharSourceRange(SourceRange(InsertionLoc, InsertionLoc), false); 9230660a898545416f0fea2d717f16f75640001e38Ted Kremenek Hint.InsertFromRange = FromRange; 9330660a898545416f0fea2d717f16f75640001e38Ted Kremenek Hint.BeforePreviousInsertions = BeforePreviousInsertions; 94b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 95b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 964b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 974b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that removes the given 984b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// source range. 990a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner static FixItHint CreateRemoval(CharSourceRange RemoveRange) { 100849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor FixItHint Hint; 101b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.RemoveRange = RemoveRange; 102b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 103b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 1040a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner static FixItHint CreateRemoval(SourceRange RemoveRange) { 1050a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner return CreateRemoval(CharSourceRange::getTokenRange(RemoveRange)); 1060a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner } 1070a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner 1084b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that replaces the given 1094b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// source range with the given code string. 1100a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner static FixItHint CreateReplacement(CharSourceRange RemoveRange, 111686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef Code) { 112849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor FixItHint Hint; 113b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.RemoveRange = RemoveRange; 114b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.CodeToInsert = Code; 115b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 116b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 1170a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner 1180a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner static FixItHint CreateReplacement(SourceRange RemoveRange, 119686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef Code) { 1200a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner return CreateReplacement(CharSourceRange::getTokenRange(RemoveRange), Code); 1210a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner } 1224b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor}; 1234b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 124d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie/// DiagnosticsEngine - This concrete class is used by the front-end to report 1255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// problems and issues. It massages the diagnostics (e.g. handling things like 12678ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie/// "report warnings as errors" and passes them off to the DiagnosticConsumer 12778ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie/// for reporting to the user. DiagnosticsEngine is tied to one translation unit 12878ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie/// and one SourceManager. 129c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmithclass DiagnosticsEngine : public RefCountedBase<DiagnosticsEngine> { 130182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattnerpublic: 131182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// Level - The level of the diagnostic, after it has been through mapping. 132182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner enum Level { 13333e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis Ignored = DiagnosticIDs::Ignored, 13433e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis Note = DiagnosticIDs::Note, 13533e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis Warning = DiagnosticIDs::Warning, 13633e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis Error = DiagnosticIDs::Error, 13733e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis Fatal = DiagnosticIDs::Fatal 138182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner }; 1391eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 140b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// ExtensionHandling - How do we handle otherwise-unmapped extension? This 141b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// is controlled by -pedantic and -pedantic-errors. 142b54b276a920246c595a0498da281821eb9d22996Chris Lattner enum ExtensionHandling { 143b54b276a920246c595a0498da281821eb9d22996Chris Lattner Ext_Ignore, Ext_Warn, Ext_Error 144b54b276a920246c595a0498da281821eb9d22996Chris Lattner }; 1451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1463fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner enum ArgumentKind { 14747b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_std_string, // std::string 14847b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_c_string, // const char * 14947b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_sint, // int 15047b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_uint, // unsigned 15147b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_identifierinfo, // IdentifierInfo 15247b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_qualtype, // QualType 15347b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_declarationname, // DeclarationName 154dacd434c49658286c380c7b4c357d76d53cb4aa1Douglas Gregor ak_nameddecl, // NamedDecl * 1553f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor ak_nestednamespec, // NestedNameSpecifier * 156246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu ak_declcontext, // DeclContext * 157246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu ak_qualtype_pair // pair<QualType, QualType> 1583fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner }; 1595edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin 1605edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin /// Specifies which overload candidates to display when overload resolution 1615edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin /// fails. 1625edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin enum OverloadsShown { 1635edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin Ovl_All, ///< Show all overloads. 1645edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin Ovl_Best ///< Show just the "best" overload candidates. 1655edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin }; 1665edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin 167b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// ArgumentValue - This typedef represents on argument value, which is a 168b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// union discriminated by ArgumentKind, with a value. 169b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner typedef std::pair<ArgumentKind, intptr_t> ArgumentValue; 170ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 1711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumpprivate: 17227ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner unsigned char AllExtensionsSilenced; // Used by __extension__ 173b54b276a920246c595a0498da281821eb9d22996Chris Lattner bool IgnoreAllWarnings; // Ignore all warnings: -w 1741e473ccb0e0f6fd1954bef330f7193c1a3fb3ba1Ted Kremenek bool WarningsAsErrors; // Treat warnings like errors. 1751e473ccb0e0f6fd1954bef330f7193c1a3fb3ba1Ted Kremenek bool EnableAllWarnings; // Enable all warnings. 176e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner bool ErrorsAsFatal; // Treat errors like fatal errors. 177b54b276a920246c595a0498da281821eb9d22996Chris Lattner bool SuppressSystemWarnings; // Suppress warnings in system headers. 17881b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor bool SuppressAllDiagnostics; // Suppress all diagnostics. 179246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu bool ElideType; // Elide common types of templates. 180246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu bool PrintTemplateTree; // Print a tree when comparing templates. 181246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu bool ShowColors; // Color printing is enabled. 1825edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin OverloadsShown ShowOverloads; // Which overload candidates to show. 183c100214fdc41a7ea215f75d433eb1cb829fd4330Chris Lattner unsigned ErrorLimit; // Cap of # errors emitted, 0 -> no limit. 184575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor unsigned TemplateBacktraceLimit; // Cap on depth of template backtrace stack, 185575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor // 0 -> no limit. 18608d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith unsigned ConstexprBacktraceLimit; // Cap on depth of constexpr evaluation 18708d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith // backtrace stack, 0 -> no limit. 188b54b276a920246c595a0498da281821eb9d22996Chris Lattner ExtensionHandling ExtBehavior; // Map extensions onto warnings or errors? 189c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<DiagnosticIDs> Diags; 19078ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie DiagnosticConsumer *Client; 19133e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis bool OwnsDiagClient; 19233e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis SourceManager *SourceMgr; 1930827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 1940827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \brief Mapping information for diagnostics. Mapping info is 195691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// packed into four bits per diagnostic. The low three bits are the mapping 196691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// (an instance of diag::Mapping), or zero if unset. The high bit is set 197691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// when the mapping was established as a user mapping. If the high bit is 198691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// clear, then the low bits are set to the default value, and should be 199691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// mapped with -pedantic, -Werror, etc. 2000827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// 2013efd52cf8f4e57c5571bd8cc3168264c3bc46a1eArgyrios Kyrtzidis /// A new DiagState is created and kept around when diagnostic pragmas modify 2023efd52cf8f4e57c5571bd8cc3168264c3bc46a1eArgyrios Kyrtzidis /// the state so that we know what is the diagnostic state at any given 2033efd52cf8f4e57c5571bd8cc3168264c3bc46a1eArgyrios Kyrtzidis /// source location. 2040827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis class DiagState { 205b1c99c679adb53be8f478d08be83af6c9c22ae4bDaniel Dunbar llvm::DenseMap<unsigned, DiagnosticMappingInfo> DiagMap; 2063c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer 2073c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer public: 208ba494c64365d78b1cdb6baea4d1e79263389fda9Daniel Dunbar typedef llvm::DenseMap<unsigned, DiagnosticMappingInfo>::iterator 209b1c99c679adb53be8f478d08be83af6c9c22ae4bDaniel Dunbar iterator; 210ba494c64365d78b1cdb6baea4d1e79263389fda9Daniel Dunbar typedef llvm::DenseMap<unsigned, DiagnosticMappingInfo>::const_iterator 211ba494c64365d78b1cdb6baea4d1e79263389fda9Daniel Dunbar const_iterator; 2123efd52cf8f4e57c5571bd8cc3168264c3bc46a1eArgyrios Kyrtzidis 213b1c99c679adb53be8f478d08be83af6c9c22ae4bDaniel Dunbar void setMappingInfo(diag::kind Diag, DiagnosticMappingInfo Info) { 214b1c99c679adb53be8f478d08be83af6c9c22ae4bDaniel Dunbar DiagMap[Diag] = Info; 215b1c99c679adb53be8f478d08be83af6c9c22ae4bDaniel Dunbar } 2163c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer 217ba494c64365d78b1cdb6baea4d1e79263389fda9Daniel Dunbar DiagnosticMappingInfo &getOrAddMappingInfo(diag::kind Diag); 218ba494c64365d78b1cdb6baea4d1e79263389fda9Daniel Dunbar 219ba494c64365d78b1cdb6baea4d1e79263389fda9Daniel Dunbar const_iterator begin() const { return DiagMap.begin(); } 220ba494c64365d78b1cdb6baea4d1e79263389fda9Daniel Dunbar const_iterator end() const { return DiagMap.end(); } 2210827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis }; 2223c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer 2230827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \brief Keeps and automatically disposes all DiagStates that we create. 2240827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis std::list<DiagState> DiagStates; 2250827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 2260827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \brief Represents a point in source where the diagnostic state was 2270827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// modified because of a pragma. 'Loc' can be null if the point represents 2280827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// the diagnostic state modifications done through the command-line. 2290827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis struct DiagStatePoint { 2300827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis DiagState *State; 2310827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis FullSourceLoc Loc; 2320827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis DiagStatePoint(DiagState *State, FullSourceLoc Loc) 2330827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis : State(State), Loc(Loc) { } 2340827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 2350827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis bool operator<(const DiagStatePoint &RHS) const { 2360827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis // If Loc is invalid it means it came from <command-line>, in which case 2370827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis // we regard it as coming before any valid source location. 2380827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis if (RHS.Loc.isInvalid()) 2390827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis return false; 2400827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis if (Loc.isInvalid()) 2410827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis return true; 2420827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis return Loc.isBeforeInTranslationUnitThan(RHS.Loc); 2433c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer } 2443c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer }; 24504ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 2460827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \brief A vector of all DiagStatePoints representing changes in diagnostic 2470827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// state due to diagnostic pragmas. The vector is always sorted according to 2480827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// the SourceLocation of the DiagStatePoint. 2490827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis typedef std::vector<DiagStatePoint> DiagStatePointsTy; 2500827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis mutable DiagStatePointsTy DiagStatePoints; 2510827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 2520827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \brief Keeps the DiagState that was active during each diagnostic 'push' 2530827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// so we can get back at it when we 'pop'. 2540827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis std::vector<DiagState *> DiagStateOnPushStack; 2550827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 2560827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis DiagState *GetCurDiagState() const { 2570827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis assert(!DiagStatePoints.empty()); 2580827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis return DiagStatePoints.back().State; 2590827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis } 2600827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 2610827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis void PushDiagStatePoint(DiagState *State, SourceLocation L) { 2620827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis FullSourceLoc Loc(L, *SourceMgr); 2630827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis // Make sure that DiagStatePoints is always sorted according to Loc. 2640827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis assert((Loc.isValid() || DiagStatePoints.empty()) && 2650827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis "Adding invalid loc point after another point"); 2660827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis assert((Loc.isInvalid() || DiagStatePoints.empty() || 2670827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis DiagStatePoints.back().Loc.isInvalid() || 2680827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis DiagStatePoints.back().Loc.isBeforeInTranslationUnitThan(Loc)) && 2690827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis "Previous point loc comes after or is the same as new one"); 2700827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis DiagStatePoints.push_back(DiagStatePoint(State, 2710827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis FullSourceLoc(Loc, *SourceMgr))); 2720827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis } 2730827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis 2740827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \brief Finds the DiagStatePoint that contains the diagnostic state of 2750827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// the given source location. 2760827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis DiagStatePointsTy::iterator GetDiagStatePointForLoc(SourceLocation Loc) const; 27704ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 27815221422eda7bac679e38b07512feda49715ef66Chris Lattner /// ErrorOccurred / FatalErrorOccurred - This is set to true when an error or 27915221422eda7bac679e38b07512feda49715ef66Chris Lattner /// fatal error is emitted, and is sticky. 2805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ErrorOccurred; 28115221422eda7bac679e38b07512feda49715ef66Chris Lattner bool FatalErrorOccurred; 2821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 28385bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor /// \brief Indicates that an unrecoverable error has occurred. 28485bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor bool UnrecoverableErrorOccurred; 28585bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor 286c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis /// \brief Counts for DiagnosticErrorTrap to check whether an error occurred 287add80bb3957dba1d9389304453c0a4c975768bd7John McCall /// during a parsing section, e.g. during parsing a function. 288c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis unsigned TrapNumErrorsOccurred; 289c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis unsigned TrapNumUnrecoverableErrorsOccurred; 290add80bb3957dba1d9389304453c0a4c975768bd7John McCall 291f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// LastDiagLevel - This is the level of the last diagnostic emitted. This is 292f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// used to emit continuation diagnostics with the same level as the 293f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// diagnostic that they follow. 29433e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis DiagnosticIDs::Level LastDiagLevel; 2955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 29653eee7ba970d21ff15bbd4334164037a3b4cc4b8Chris Lattner unsigned NumWarnings; // Number of warnings reported 29753eee7ba970d21ff15bbd4334164037a3b4cc4b8Chris Lattner unsigned NumErrors; // Number of errors reported 2981864f2eb59471d07db51adfc3e5b1a229eed631aDouglas Gregor unsigned NumErrorsSuppressed; // Number of errors suppressed 2997bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber 3003fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// ArgToStringFn - A function pointer that converts an opaque diagnostic 3013fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// argument to a strings. This takes the modifiers and argument that was 3023fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// present in the diagnostic. 303b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// 304b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// The PrevArgs array (whose length is NumPrevArgs) indicates the previous 305b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// arguments formatted for this diagnostic. Implementations of this function 306b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// can use this information to avoid redundancy across arguments. 307b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// 30822caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner /// This is a hack to avoid a layering violation between libbasic and libsema. 3090673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth typedef void (*ArgToStringFnTy)( 3100673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth ArgumentKind Kind, intptr_t Val, 3110673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth const char *Modifier, unsigned ModifierLen, 3120673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth const char *Argument, unsigned ArgumentLen, 3130673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth const ArgumentValue *PrevArgs, 3140673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth unsigned NumPrevArgs, 315686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<char> &Output, 3160673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth void *Cookie, 317341785ec52f87c0803ba52dc88faac4e136f8593Bill Wendling ArrayRef<intptr_t> QualTypeVals); 31892dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner void *ArgToStringCookie; 3193fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ArgToStringFnTy ArgToStringFn; 32093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 32193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief ID of the "delayed" diagnostic, which is a (typically 32293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// fatal) diagnostic that had to be delayed because it was found 32393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// while emitting another diagnostic. 32493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor unsigned DelayedDiagID; 32593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 32693ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief First string argument for the delayed diagnostic. 32793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor std::string DelayedDiagArg1; 32893ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 32993ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief Second string argument for the delayed diagnostic. 33093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor std::string DelayedDiagArg2; 33193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 3325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 333d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie explicit DiagnosticsEngine( 334c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith const IntrusiveRefCntPtr<DiagnosticIDs> &Diags, 33578ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie DiagnosticConsumer *client = 0, 33633e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis bool ShouldOwnClient = true); 337d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie ~DiagnosticsEngine(); 3381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 339c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith const IntrusiveRefCntPtr<DiagnosticIDs> &getDiagnosticIDs() const { 34033e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return Diags; 34133e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis } 34233e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis 34378ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie DiagnosticConsumer *getClient() { return Client; } 34478ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie const DiagnosticConsumer *getClient() const { return Client; } 3451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 346d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie /// \brief Determine whether this \c DiagnosticsEngine object own its client. 34778243658c533168d51fd076fba328437932ba6f1Douglas Gregor bool ownsClient() const { return OwnsDiagClient; } 34878243658c533168d51fd076fba328437932ba6f1Douglas Gregor 349bdbb004f38978da0c4a75af3294d1c7b5ff84af1Douglas Gregor /// \brief Return the current diagnostic client along with ownership of that 350bdbb004f38978da0c4a75af3294d1c7b5ff84af1Douglas Gregor /// client. 35178ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie DiagnosticConsumer *takeClient() { 35233e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis OwnsDiagClient = false; 35333e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return Client; 35433e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis } 35533e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis 35633e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis bool hasSourceManager() const { return SourceMgr != 0; } 35733e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis SourceManager &getSourceManager() const { 35833e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis assert(SourceMgr && "SourceManager not set!"); 35933e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return *SourceMgr; 36033e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis } 36133e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis void setSourceManager(SourceManager *SrcMgr) { SourceMgr = SrcMgr; } 36233e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis 36333e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis //===--------------------------------------------------------------------===// 364d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie // DiagnosticsEngine characterization methods, used by a client to customize 365d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie // how diagnostics are emitted. 36633e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis // 36704ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 3681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// pushMappings - Copies the current DiagMappings and pushes the new copy 36904ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// onto the top of the stack. 3700827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis void pushMappings(SourceLocation Loc); 37104ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 37204ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// popMappings - Pops the current DiagMappings off the top of the stack 37304ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// causing the new top of the stack to be the active mappings. Returns 37404ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// true if the pop happens, false if there is only one DiagMapping on the 37504ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// stack. 3760827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis bool popMappings(SourceLocation Loc); 37704ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 378bdbb004f38978da0c4a75af3294d1c7b5ff84af1Douglas Gregor /// \brief Set the diagnostic client associated with this diagnostic object. 379bdbb004f38978da0c4a75af3294d1c7b5ff84af1Douglas Gregor /// 38033e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis /// \param ShouldOwnClient true if the diagnostic object should take 38133e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis /// ownership of \c client. 38278ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie void setClient(DiagnosticConsumer *client, bool ShouldOwnClient = true); 3835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 384c100214fdc41a7ea215f75d433eb1cb829fd4330Chris Lattner /// setErrorLimit - Specify a limit for the number of errors we should 385b205ac9fcd22b87b41697172d1983c5ae9dabaafChris Lattner /// emit before giving up. Zero disables the limit. 386c100214fdc41a7ea215f75d433eb1cb829fd4330Chris Lattner void setErrorLimit(unsigned Limit) { ErrorLimit = Limit; } 387b205ac9fcd22b87b41697172d1983c5ae9dabaafChris Lattner 388575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor /// \brief Specify the maximum number of template instantiation 389575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor /// notes to emit along with a given diagnostic. 390575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor void setTemplateBacktraceLimit(unsigned Limit) { 391575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor TemplateBacktraceLimit = Limit; 392575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor } 39308d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith 394575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor /// \brief Retrieve the maximum number of template instantiation 39508d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith /// notes to emit along with a given diagnostic. 396575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor unsigned getTemplateBacktraceLimit() const { 397575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor return TemplateBacktraceLimit; 398575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor } 39908d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith 40008d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith /// \brief Specify the maximum number of constexpr evaluation 40108d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith /// notes to emit along with a given diagnostic. 40208d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith void setConstexprBacktraceLimit(unsigned Limit) { 40308d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith ConstexprBacktraceLimit = Limit; 40408d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith } 40508d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith 40608d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith /// \brief Retrieve the maximum number of constexpr evaluation 40708d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith /// notes to emit along with a given diagnostic. 40808d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith unsigned getConstexprBacktraceLimit() const { 40908d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith return ConstexprBacktraceLimit; 41008d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith } 41108d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith 4125b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner /// setIgnoreAllWarnings - When set to true, any unmapped warnings are 4135b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner /// ignored. If this and WarningsAsErrors are both set, then this one wins. 4145b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner void setIgnoreAllWarnings(bool Val) { IgnoreAllWarnings = Val; } 4155b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner bool getIgnoreAllWarnings() const { return IgnoreAllWarnings; } 4161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4171e473ccb0e0f6fd1954bef330f7193c1a3fb3ba1Ted Kremenek /// setEnableAllWarnings - When set to true, any unmapped ignored warnings 4181e473ccb0e0f6fd1954bef330f7193c1a3fb3ba1Ted Kremenek /// are no longer ignored. If this and IgnoreAllWarnings are both set, 4191e473ccb0e0f6fd1954bef330f7193c1a3fb3ba1Ted Kremenek /// then that one wins. 4201e473ccb0e0f6fd1954bef330f7193c1a3fb3ba1Ted Kremenek void setEnableAllWarnings(bool Val) { EnableAllWarnings = Val; } 4211e473ccb0e0f6fd1954bef330f7193c1a3fb3ba1Ted Kremenek bool getEnableAllWarnngs() const { return EnableAllWarnings; } 4221e473ccb0e0f6fd1954bef330f7193c1a3fb3ba1Ted Kremenek 4235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setWarningsAsErrors - When set to true, any warnings reported are issued 4245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// as errors. 4255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setWarningsAsErrors(bool Val) { WarningsAsErrors = Val; } 4265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getWarningsAsErrors() const { return WarningsAsErrors; } 4271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 428e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner /// setErrorsAsFatal - When set to true, any error reported is made a 429e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner /// fatal error. 430e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner void setErrorsAsFatal(bool Val) { ErrorsAsFatal = Val; } 431e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner bool getErrorsAsFatal() const { return ErrorsAsFatal; } 432e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner 4332fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar /// setSuppressSystemWarnings - When set to true mask warnings that 4342fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar /// come from system headers. 4352fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar void setSuppressSystemWarnings(bool Val) { SuppressSystemWarnings = Val; } 4362fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar bool getSuppressSystemWarnings() const { return SuppressSystemWarnings; } 4372fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar 43881b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor /// \brief Suppress all diagnostics, to silence the front end when we 43981b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor /// know that we don't want any more diagnostics to be passed along to the 44081b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor /// client 44181b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor void setSuppressAllDiagnostics(bool Val = true) { 44281b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor SuppressAllDiagnostics = Val; 44381b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor } 44481b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor bool getSuppressAllDiagnostics() const { return SuppressAllDiagnostics; } 445246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu 446246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu /// \brief Set type eliding, to skip outputting same types occurring in 447246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu /// template types. 448246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu void setElideType(bool Val = true) { ElideType = Val; } 449246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu bool getElideType() { return ElideType; } 450246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu 451246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu /// \brief Set tree printing, to outputting the template difference in a 452246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu /// tree format. 453246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu void setPrintTemplateTree(bool Val = false) { PrintTemplateTree = Val; } 454246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu bool getPrintTemplateTree() { return PrintTemplateTree; } 455246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu 456246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu /// \brief Set color printing, so the type diffing will inject color markers 457246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu /// into the output. 458246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu void setShowColors(bool Val = false) { ShowColors = Val; } 459246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu bool getShowColors() { return ShowColors; } 460246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu 4615edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin /// \brief Specify which overload candidates to show when overload resolution 4625edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin /// fails. By default, we show all candidates. 4635edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin void setShowOverloads(OverloadsShown Val) { 4645edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin ShowOverloads = Val; 4655edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin } 4665edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin OverloadsShown getShowOverloads() const { return ShowOverloads; } 4675edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin 4680b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor /// \brief Pretend that the last diagnostic issued was ignored. This can 4690b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor /// be used by clients who suppress diagnostics themselves. 4700b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor void setLastDiagnosticIgnored() { 47133e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis LastDiagLevel = DiagnosticIDs::Ignored; 4720b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor } 4730b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor 474b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// setExtensionHandlingBehavior - This controls whether otherwise-unmapped 475b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// extension diagnostics are mapped onto ignore/warning/error. This 476b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// corresponds to the GCC -pedantic and -pedantic-errors option. 477b54b276a920246c595a0498da281821eb9d22996Chris Lattner void setExtensionHandlingBehavior(ExtensionHandling H) { 478b54b276a920246c595a0498da281821eb9d22996Chris Lattner ExtBehavior = H; 479b54b276a920246c595a0498da281821eb9d22996Chris Lattner } 480c1b5fa41f09512c74030b9a2a0d1564535e22a76Peter Collingbourne ExtensionHandling getExtensionHandlingBehavior() const { return ExtBehavior; } 4811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 48227ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// AllExtensionsSilenced - This is a counter bumped when an __extension__ 48327ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// block is encountered. When non-zero, all extension diagnostics are 48427ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// entirely silenced, no matter how they are mapped. 48527ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner void IncrementAllExtensionsSilenced() { ++AllExtensionsSilenced; } 48627ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner void DecrementAllExtensionsSilenced() { --AllExtensionsSilenced; } 48791a2886d558ea6ca7a0bed73ab5acea5ae78eac2Douglas Gregor bool hasAllExtensionsSilenced() { return AllExtensionsSilenced != 0; } 4881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 489697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief This allows the client to specify that certain warnings are 490697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// ignored. 491697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 492697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// Notes can never be mapped, errors can only be mapped to fatal, and 493697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// WARNINGs and EXTENSIONs can be mapped arbitrarily. 4940827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// 4950827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \param Loc The source location that this change of diagnostic state should 4960827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// take affect. It can be null if we are setting the latest state. 4970827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis void setDiagnosticMapping(diag::kind Diag, diag::Mapping Map, 4980827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis SourceLocation Loc); 4991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 500697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Change an entire diagnostic group (e.g. "unknown-pragmas") to 501697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// have the specified mapping. 502697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 503697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \returns true (and ignores the request) if "Group" was unknown, false 504697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// otherwise. 5050827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// 506697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \param Loc The source location that this change of diagnostic state should 5070827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// take affect. It can be null if we are setting the state from command-line. 508686775deca8b8685eb90801495880e3abdd844c2Chris Lattner bool setDiagnosticGroupMapping(StringRef Group, diag::Mapping Map, 5093f8394669673451061f57ced81f0a2cae087f119Daniel Dunbar SourceLocation Loc = SourceLocation()); 5105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 511697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Set the warning-as-error flag for the given diagnostic. 512697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 513697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// This function always only operates on the current diagnostic state. 5143f22509ebf91aa96658ca6e5c5c0b926d8d62e34Chad Rosier void setDiagnosticWarningAsError(diag::kind Diag, bool Enabled); 5153f22509ebf91aa96658ca6e5c5c0b926d8d62e34Chad Rosier 516697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Set the warning-as-error flag for the given diagnostic group. 517697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 518697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// This function always only operates on the current diagnostic state. 5194aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar /// 5204aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar /// \returns True if the given group is unknown, false otherwise. 5214aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar bool setDiagnosticGroupWarningAsError(StringRef Group, bool Enabled); 5224aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar 523697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Set the error-as-fatal flag for the given diagnostic. 524697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 525697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// This function always only operates on the current diagnostic state. 5263f22509ebf91aa96658ca6e5c5c0b926d8d62e34Chad Rosier void setDiagnosticErrorAsFatal(diag::kind Diag, bool Enabled); 5273f22509ebf91aa96658ca6e5c5c0b926d8d62e34Chad Rosier 528697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Set the error-as-fatal flag for the given diagnostic group. 529697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 530697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// This function always only operates on the current diagnostic state. 5314aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar /// 5324aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar /// \returns True if the given group is unknown, false otherwise. 5334aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar bool setDiagnosticGroupErrorAsFatal(StringRef Group, bool Enabled); 5344aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar 535697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Add the specified mapping to all diagnostics. 536697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 537697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// Mainly to be used by -Wno-everything to disable all warnings but allow 538697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// subsequent -W options to enable specific warnings. 53982e6411d004064a29f03a3ea8b8919f297bfa843Argyrios Kyrtzidis void setMappingToAllDiagnostics(diag::Mapping Map, 54011583c757bac6ce5c342f2eb572055dd2619a657Argyrios Kyrtzidis SourceLocation Loc = SourceLocation()); 54111583c757bac6ce5c342f2eb572055dd2619a657Argyrios Kyrtzidis 5425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool hasErrorOccurred() const { return ErrorOccurred; } 54315221422eda7bac679e38b07512feda49715ef66Chris Lattner bool hasFatalErrorOccurred() const { return FatalErrorOccurred; } 54485bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor 54585bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor /// \brief Determine whether any kind of unrecoverable error has occurred. 54685bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor bool hasUnrecoverableErrorOccurred() const { 54785bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor return FatalErrorOccurred || UnrecoverableErrorOccurred; 54885bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor } 54985bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor 55053eee7ba970d21ff15bbd4334164037a3b4cc4b8Chris Lattner unsigned getNumWarnings() const { return NumWarnings; } 5511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 552c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor void setNumWarnings(unsigned NumWarnings) { 553c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor this->NumWarnings = NumWarnings; 554c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor } 555c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 556697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Return an ID for a diagnostic with the specified message and level. 557697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 558697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// If this is the first request for this diagnosic, it is registered and 559697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// created, otherwise the existing ID is returned. 560686775deca8b8685eb90801495880e3abdd844c2Chris Lattner unsigned getCustomDiagID(Level L, StringRef Message) { 56133e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return Diags->getCustomDiagID((DiagnosticIDs::Level)L, Message); 56233e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis } 5631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 564697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Converts a diagnostic argument (as an intptr_t) into the string 565697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// that represents it. 5663fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner void ConvertArgToString(ArgumentKind Kind, intptr_t Val, 5673fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Modifier, unsigned ModLen, 5683fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Argument, unsigned ArgLen, 569b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner const ArgumentValue *PrevArgs, unsigned NumPrevArgs, 570686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<char> &Output, 571686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<intptr_t> &QualTypeVals) const { 572b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner ArgToStringFn(Kind, Val, Modifier, ModLen, Argument, ArgLen, 5730673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth PrevArgs, NumPrevArgs, Output, ArgToStringCookie, 5740673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth QualTypeVals); 57522caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 5761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 57792dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner void SetArgToStringFn(ArgToStringFnTy Fn, void *Cookie) { 5783fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ArgToStringFn = Fn; 57992dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner ArgToStringCookie = Cookie; 58022caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 5811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 582abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \brief Reset the state of the diagnostic object to its initial 583abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// configuration. 584abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor void Reset(); 585abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor 5865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 587d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie // DiagnosticsEngine classification and reporting interfaces. 5885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // 5895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 590d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie /// \brief Based on the way the client configured the DiagnosticsEngine 5915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// object, classify the specified diagnostic ID into a Level, consumable by 59278ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie /// the DiagnosticConsumer. 5930827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// 5940827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// \param Loc The source location we are interested in finding out the 5950827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis /// diagnostic state. Can be null in order to query the latest state. 5961656aaec223949245fdbebf306b719cba0b687caDaniel Dunbar Level getDiagnosticLevel(unsigned DiagID, SourceLocation Loc) const { 5971656aaec223949245fdbebf306b719cba0b687caDaniel Dunbar return (Level)Diags->getDiagnosticLevel(DiagID, Loc, *this); 59833e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis } 5991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 600697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Issue the message to the client. 601697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 602697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// This actually returns an instance of DiagnosticBuilder which emits the 603697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// diagnostics (through @c ProcessDiag) when it is destroyed. 604697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 605697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \param DiagID A member of the @c diag::kind enum. 606efce31f51d6e7e31e125f96c20f6cdab3ead0a47James Dennett /// \param Loc Represents the source location associated with the diagnostic, 607509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// which can be an invalid location if no position information is available. 608efce31f51d6e7e31e125f96c20f6cdab3ead0a47James Dennett inline DiagnosticBuilder Report(SourceLocation Loc, unsigned DiagID); 6090f9fed70cea107b3f79df554e38bd8e98d48fe47Daniel Dunbar inline DiagnosticBuilder Report(unsigned DiagID); 610de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor 611e59abb56ce0e1c206fb80bd945a0c358b0abe1efArgyrios Kyrtzidis void Report(const StoredDiagnostic &storedDiag); 612e59abb56ce0e1c206fb80bd945a0c358b0abe1efArgyrios Kyrtzidis 61393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief Determine whethere there is already a diagnostic in flight. 6145800f7ea9cf5621280089d690f677bd28064d6b5Ted Kremenek bool isDiagnosticInFlight() const { return CurDiagID != ~0U; } 61593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 61693ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief Set the "delayed" diagnostic that will be emitted once 61793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// the current diagnostic completes. 61893ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// 61993ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// If a diagnostic is already in-flight but the front end must 62093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// report a problem (e.g., with an inconsistent file system 62193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// state), this routine sets a "delayed" diagnostic that will be 62293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// emitted after the current diagnostic completes. This should 62393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// only be used for fatal errors detected at inconvenient 62493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// times. If emitting a delayed diagnostic causes a second delayed 62593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// diagnostic to be introduced, that second delayed diagnostic 62693ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// will be ignored. 62793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// 62893ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \param DiagID The ID of the diagnostic being delayed. 62993ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// 63093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \param Arg1 A string argument that will be provided to the 63193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// diagnostic. A copy of this string will be stored in the 632d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie /// DiagnosticsEngine object itself. 63393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// 63493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \param Arg2 A string argument that will be provided to the 63593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// diagnostic. A copy of this string will be stored in the 636d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie /// DiagnosticsEngine object itself. 637686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void SetDelayedDiagnostic(unsigned DiagID, StringRef Arg1 = "", 638686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef Arg2 = ""); 63993ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 640de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor /// \brief Clear out the current diagnostic. 641de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor void Clear() { CurDiagID = ~0U; } 6421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6430a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattnerprivate: 64493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief Report the delayed diagnostic. 64593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor void ReportDelayed(); 64693ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 6473cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner // This is private state used by DiagnosticBuilder. We put it here instead of 6483cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner // in DiagnosticBuilder in order to keep DiagnosticBuilder a small lightweight 6490a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // object. This implementation choice means that we can only have one 6500a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // diagnostic "in flight" at a time, but this seems to be a reasonable 6510a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // tradeoff to keep these objects small. Assertions verify that only one 6520a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // diagnostic is in flight at a time. 65333e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis friend class DiagnosticIDs; 6543cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner friend class DiagnosticBuilder; 65540847cfb58acc3cac7d68727df9455ac45f2e118David Blaikie friend class Diagnostic; 6569b623639378d53a675921ddfa7316034d571881eDouglas Gregor friend class PartialDiagnostic; 6579c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis friend class DiagnosticErrorTrap; 6589b623639378d53a675921ddfa7316034d571881eDouglas Gregor 659697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief The location of the current diagnostic that is in flight. 66033e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis SourceLocation CurDiagLoc; 6611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 662697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief The ID of the current diagnostic that is in flight. 663697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 6643cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// This is set to ~0U when there is no diagnostic in flight. 665b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner unsigned CurDiagID; 666b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner 66773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner enum { 668697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief The maximum number of arguments we can hold. 669697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 670697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// We currently 67173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// only support up to 10 arguments (%0-%9). A single diagnostic with more 67273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// than that almost certainly has to be simplified anyway. 673981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar MaxArguments = 10, 674981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar 675697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief The maximum number of ranges we can hold. 676981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar MaxRanges = 10, 677981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar 678697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief The maximum number of ranges we can hold. 679981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar MaxFixItHints = 10 68073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner }; 6811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 682697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief The number of entries in Arguments. 683730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner signed char NumDiagArgs; 684697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief The number of ranges in the DiagRanges array. 685730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner unsigned char NumDiagRanges; 686697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief The number of hints in the DiagFixItHints array. 687981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar unsigned char NumDiagFixItHints; 688ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 68973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsKind - This is an array of ArgumentKind::ArgumentKind enum 69073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// values, with one for each argument. This specifies whether the argument 69173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// is in DiagArgumentsStr or in DiagArguments. 69273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner unsigned char DiagArgumentsKind[MaxArguments]; 6931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 694697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief holds the values of each string argument for the current 695697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// diagnostic. 696697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 697697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// This is only used when the corresponding ArgumentKind is ak_std_string. 69873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner std::string DiagArgumentsStr[MaxArguments]; 69973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 700697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief The values for the various substitution positions. 701697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// 702697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// This is used when the argument is not an std::string. The specific 703697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// value is mangled into an intptr_t and the interpretation depends on 704697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// exactly what sort of argument kind it is. 70573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner intptr_t DiagArgumentsVal[MaxArguments]; 7061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 707697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief The list of ranges added to this diagnostic. 708981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar CharSourceRange DiagRanges[MaxRanges]; 7091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 710697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief If valid, provides a hint with some code to insert, remove, 711981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar /// or modify at a particular position. 712981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar FixItHint DiagFixItHints[MaxFixItHints]; 7134b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 71487429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis DiagnosticMappingInfo makeMappingInfo(diag::Mapping Map, SourceLocation L) { 71587429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis bool isPragma = L.isValid(); 71687429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis DiagnosticMappingInfo MappingInfo = DiagnosticMappingInfo::Make( 71787429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis Map, /*IsUser=*/true, isPragma); 71887429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis 71987429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis // If this is a pragma mapping, then set the diagnostic mapping flags so 72087429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis // that we override command line options. 72187429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis if (isPragma) { 72287429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis MappingInfo.setNoWarningAsError(true); 72387429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis MappingInfo.setNoErrorAsFatal(true); 72487429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis } 72587429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis 72687429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis return MappingInfo; 72787429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis } 72887429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis 729697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Used to report a diagnostic that is finally fully formed. 7305e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// 731697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \returns true if the diagnostic was emitted, false if it was suppressed. 73233e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis bool ProcessDiag() { 73333e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return Diags->ProcessDiag(*this); 73433e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis } 735f41d3be39980d40849850d3fb90403623cc8459eArgyrios Kyrtzidis 736393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar /// @name Diagnostic Emission 737393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar /// @{ 738393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbarprotected: 739393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar // Sema requires access to the following functions because the current design 740393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar // of SFINAE requires it to use its own SemaDiagnosticBuilder, which needs to 741393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar // access us directly to ensure we minimize the emitted code for the common 742393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar // Sema::Diag() patterns. 743393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar friend class Sema; 744393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar 7453054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar /// \brief Emit the current diagnostic and clear the diagnostic state. 7463054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar bool EmitCurrentDiagnostic(); 7473054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar 748393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar unsigned getCurrentDiagID() const { return CurDiagID; } 749393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar 750393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar SourceLocation getCurrentDiagLoc() const { return CurDiagLoc; } 751393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar 752393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar /// @} 753393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar 754f41d3be39980d40849850d3fb90403623cc8459eArgyrios Kyrtzidis friend class ASTReader; 755f41d3be39980d40849850d3fb90403623cc8459eArgyrios Kyrtzidis friend class ASTWriter; 7563cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}; 7573cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 7589c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis/// \brief RAII class that determines when any errors have occurred 7599c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis/// between the time the instance was created and the time it was 7609c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis/// queried. 7619c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidisclass DiagnosticErrorTrap { 762d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine &Diag; 763c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis unsigned NumErrors; 764c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis unsigned NumUnrecoverableErrors; 7659c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis 7669c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidispublic: 767d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie explicit DiagnosticErrorTrap(DiagnosticsEngine &Diag) 768add80bb3957dba1d9389304453c0a4c975768bd7John McCall : Diag(Diag) { reset(); } 7699c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis 7709c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis /// \brief Determine whether any errors have occurred since this 7719c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis /// object instance was created. 7729c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis bool hasErrorOccurred() const { 773c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis return Diag.TrapNumErrorsOccurred > NumErrors; 774add80bb3957dba1d9389304453c0a4c975768bd7John McCall } 775add80bb3957dba1d9389304453c0a4c975768bd7John McCall 776add80bb3957dba1d9389304453c0a4c975768bd7John McCall /// \brief Determine whether any unrecoverable errors have occurred since this 777add80bb3957dba1d9389304453c0a4c975768bd7John McCall /// object instance was created. 778add80bb3957dba1d9389304453c0a4c975768bd7John McCall bool hasUnrecoverableErrorOccurred() const { 779c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis return Diag.TrapNumUnrecoverableErrorsOccurred > NumUnrecoverableErrors; 7809c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis } 7819c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis 7829c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis // Set to initial state of "no errors occurred". 783add80bb3957dba1d9389304453c0a4c975768bd7John McCall void reset() { 784c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis NumErrors = Diag.TrapNumErrorsOccurred; 785c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis NumUnrecoverableErrors = Diag.TrapNumUnrecoverableErrorsOccurred; 786add80bb3957dba1d9389304453c0a4c975768bd7John McCall } 7879c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis}; 7889c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis 7893cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 7903cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner// DiagnosticBuilder 7913cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 7923cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 793697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// \brief A little helper class used to produce diagnostics. 794697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// 795697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// This is constructed by the DiagnosticsEngine::Report method, and 796697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// allows insertion of extra information (arguments and source ranges) into 797697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// the currently "in flight" diagnostic. When the temporary for the builder 798697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// is destroyed, the diagnostic is issued. 7993cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// 8003cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// Note that many of these will be created as temporary objects (many call 8013cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// sites), so we want them to be small and we never want their address taken. 8023cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// This ensures that compilers with somewhat reasonable optimizers will promote 8033cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// the common fields to registers, eliminating increments of the NumArgs field, 8043cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// for example. 8053cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerclass DiagnosticBuilder { 806d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie mutable DiagnosticsEngine *DiagObj; 807981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar mutable unsigned NumArgs, NumRanges, NumFixits; 8081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8097059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar /// \brief Status variable indicating if this diagnostic is still active. 8107059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar /// 8117059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar // NOTE: This field is redundant with DiagObj (IsActive iff (DiagObj == 0)), 8127059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar // but LLVM is not currently smart enough to eliminate the null check that 8137059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar // Emit() would end up with if we used that as our status variable. 8147059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar mutable bool IsActive; 8157059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar 8163cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void operator=(const DiagnosticBuilder&); // DO NOT IMPLEMENT 817d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie friend class DiagnosticsEngine; 818ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor 819ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor DiagnosticBuilder() 820ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor : DiagObj(0), NumArgs(0), NumRanges(0), NumFixits(0), IsActive(false) { } 821ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor 822d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie explicit DiagnosticBuilder(DiagnosticsEngine *diagObj) 8237059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar : DiagObj(diagObj), NumArgs(0), NumRanges(0), NumFixits(0), IsActive(true) { 824981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar assert(diagObj && "DiagnosticBuilder requires a valid DiagnosticsEngine!"); 825cbf46a0b2bb2b47d6e13437e0d52cc583c5ce539Argyrios Kyrtzidis } 826ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 8279b623639378d53a675921ddfa7316034d571881eDouglas Gregor friend class PartialDiagnostic; 828ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor 829b535041ee33c5eff255832bc5541c8d52aae8254Douglas Gregorprotected: 8303054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar void FlushCounts() { 8313054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar DiagObj->NumDiagArgs = NumArgs; 8323054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar DiagObj->NumDiagRanges = NumRanges; 8333054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar DiagObj->NumDiagFixItHints = NumFixits; 8343054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar } 83506265bd82073c06294a02a0bd891951fafb484a5Daniel Dunbar 836cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// \brief Clear out the current diagnostic. 8377059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar void Clear() const { 8387059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar DiagObj = 0; 8397059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar IsActive = false; 8407059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar } 841cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar 842697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Determine whether this diagnostic is still active. 8437059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar bool isActive() const { return IsActive; } 84406265bd82073c06294a02a0bd891951fafb484a5Daniel Dunbar 845cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// \brief Force the diagnostic builder to emit the diagnostic now. 846cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// 847cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// Once this function has been called, the DiagnosticBuilder object 848cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// should not be used again before it is destroyed. 849cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// 850cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// \returns true if a diagnostic was emitted, false if the 851cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar /// diagnostic was suppressed. 8523054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar bool Emit() { 8537059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar // If this diagnostic is inactive, then its soul was stolen by the copy ctor 8547059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar // (or by a subclass, as in SemaDiagnosticBuilder). 8557059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar if (!isActive()) return false; 8563054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar 8573054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar // When emitting diagnostics, we set the final argument count into 8583054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar // the DiagnosticsEngine object. 8593054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar FlushCounts(); 8603054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar 8613054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar // Process the diagnostic. 8623054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar bool Result = DiagObj->EmitCurrentDiagnostic(); 8633054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar 8643054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar // This diagnostic is dead. 8657059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar Clear(); 8663054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar 8673054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar return Result; 8683054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar } 8699b623639378d53a675921ddfa7316034d571881eDouglas Gregor 8701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumppublic: 8710a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// Copy constructor. When copied, this "takes" the diagnostic info from the 8720a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// input and neuters it. 8733cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagnosticBuilder(const DiagnosticBuilder &D) { 8740a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner DiagObj = D.DiagObj; 8757059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar IsActive = D.IsActive; 8767059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar D.Clear(); 87725a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor NumArgs = D.NumArgs; 87825a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor NumRanges = D.NumRanges; 879981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar NumFixits = D.NumFixits; 8800a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 88125a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor 882ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor /// \brief Retrieve an empty diagnostic builder. 883ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor static DiagnosticBuilder getEmpty() { 884ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor return DiagnosticBuilder(); 885ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor } 886ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor 887697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett /// \brief Emits the diagnostic. 88853c83b32550b3f29db2419160fa2e3684e420556Daniel Dunbar ~DiagnosticBuilder() { 8893054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar Emit(); 89053c83b32550b3f29db2419160fa2e3684e420556Daniel Dunbar } 8919b623639378d53a675921ddfa7316034d571881eDouglas Gregor 8923cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// Operator bool: conversion of DiagnosticBuilder to bool always returns 8933cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// true. This allows is to be used in boolean error contexts like: 8943cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// return Diag(...); 8953cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner operator bool() const { return true; } 8963cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 897686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void AddString(StringRef S) const { 898cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar assert(isActive() && "Clients must not add to cleared diagnostic!"); 899d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(NumArgs < DiagnosticsEngine::MaxArguments && 9003cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 901cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar DiagObj->DiagArgumentsKind[NumArgs] = DiagnosticsEngine::ak_std_string; 902cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar DiagObj->DiagArgumentsStr[NumArgs++] = S; 9033cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner } 9041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 905d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie void AddTaggedVal(intptr_t V, DiagnosticsEngine::ArgumentKind Kind) const { 906cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar assert(isActive() && "Clients must not add to cleared diagnostic!"); 907d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(NumArgs < DiagnosticsEngine::MaxArguments && 9083cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 909cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar DiagObj->DiagArgumentsKind[NumArgs] = Kind; 910cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar DiagObj->DiagArgumentsVal[NumArgs++] = V; 9110a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 9121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9130a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner void AddSourceRange(const CharSourceRange &R) const { 914cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar assert(isActive() && "Clients must not add to cleared diagnostic!"); 915981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar assert(NumRanges < DiagnosticsEngine::MaxRanges && 9163cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 917cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar DiagObj->DiagRanges[NumRanges++] = R; 9181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 9194b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 920849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor void AddFixItHint(const FixItHint &Hint) const { 921cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar assert(isActive() && "Clients must not add to cleared diagnostic!"); 922981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar assert(NumFixits < DiagnosticsEngine::MaxFixItHints && 923981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar "Too many arguments to diagnostic!"); 924cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar DiagObj->DiagFixItHints[NumFixits++] = Hint; 9254b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 9263cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}; 9273cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 9283cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 929686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef S) { 9303cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddString(S); 9313cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 9323cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 9333cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 9343cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 9353cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const char *Str) { 9363cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(reinterpret_cast<intptr_t>(Str), 937d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine::ak_c_string); 9383cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 9393cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 9403cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 9413cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, int I) { 942d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DB.AddTaggedVal(I, DiagnosticsEngine::ak_sint); 9433cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 9443cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 9453cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 9463bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidisinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,bool I) { 947d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DB.AddTaggedVal(I, DiagnosticsEngine::ak_sint); 9483bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis return DB; 9493bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis} 9503bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis 9513cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 9523cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner unsigned I) { 953d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DB.AddTaggedVal(I, DiagnosticsEngine::ak_uint); 9543cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 9553cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 9563cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 9573cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 9583cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const IdentifierInfo *II) { 9593cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(reinterpret_cast<intptr_t>(II), 960d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine::ak_identifierinfo); 9613cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 9623cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 9631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9643f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// Adds a DeclContext to the diagnostic. The enable_if template magic is here 9653f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// so that we only match those arguments that are (statically) DeclContexts; 9663f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// other arguments that derive from DeclContext (e.g., RecordDecls) will not 9673f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// match. 9683f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregortemplate<typename T> 9693f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregorinline 9703f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregortypename llvm::enable_if<llvm::is_same<T, DeclContext>, 9713f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor const DiagnosticBuilder &>::type 9723f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregoroperator<<(const DiagnosticBuilder &DB, T *DC) { 9733f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor DB.AddTaggedVal(reinterpret_cast<intptr_t>(DC), 974d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine::ak_declcontext); 9753f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor return DB; 9763f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor} 9773f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor 9783cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 9793cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const SourceRange &R) { 9800a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner DB.AddSourceRange(CharSourceRange::getTokenRange(R)); 9813cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 9823cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 9834b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 9844b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregorinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 9850a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner const CharSourceRange &R) { 9860a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner DB.AddSourceRange(R); 9870a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner return DB; 9880a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner} 9890a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner 9900a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 991849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor const FixItHint &Hint) { 9923739b32a01b9778176757425e62252c288b85383Ted Kremenek if (!Hint.isNull()) 9933739b32a01b9778176757425e62252c288b85383Ted Kremenek DB.AddFixItHint(Hint); 9944b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor return DB; 9954b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor} 996ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 997d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikieinline DiagnosticBuilder DiagnosticsEngine::Report(SourceLocation Loc, 99833e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis unsigned DiagID){ 9993cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(CurDiagID == ~0U && "Multiple diagnostics in flight at once!"); 10003cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner CurDiagLoc = Loc; 10013cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner CurDiagID = DiagID; 10023cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DiagnosticBuilder(this); 10033cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 1004d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikieinline DiagnosticBuilder DiagnosticsEngine::Report(unsigned DiagID) { 100533e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return Report(SourceLocation(), DiagID); 10060f9fed70cea107b3f79df554e38bd8e98d48fe47Daniel Dunbar} 10073cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 10083cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 100940847cfb58acc3cac7d68727df9455ac45f2e118David Blaikie// Diagnostic 10103cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 10111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1012697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// A little helper class (which is basically a smart pointer that forwards 1013697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// info from DiagnosticsEngine) that allows clients to enquire about the 1014697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// currently in-flight diagnostic. 101540847cfb58acc3cac7d68727df9455ac45f2e118David Blaikieclass Diagnostic { 1016d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie const DiagnosticsEngine *DiagObj; 1017686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef StoredDiagMessage; 10183cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerpublic: 101940847cfb58acc3cac7d68727df9455ac45f2e118David Blaikie explicit Diagnostic(const DiagnosticsEngine *DO) : DiagObj(DO) {} 102040847cfb58acc3cac7d68727df9455ac45f2e118David Blaikie Diagnostic(const DiagnosticsEngine *DO, StringRef storedDiagMessage) 1021e59abb56ce0e1c206fb80bd945a0c358b0abe1efArgyrios Kyrtzidis : DiagObj(DO), StoredDiagMessage(storedDiagMessage) {} 10221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1023d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie const DiagnosticsEngine *getDiags() const { return DiagObj; } 1024b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner unsigned getID() const { return DiagObj->CurDiagID; } 102533e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis const SourceLocation &getLocation() const { return DiagObj->CurDiagLoc; } 102633e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis bool hasSourceManager() const { return DiagObj->hasSourceManager(); } 102733e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis SourceManager &getSourceManager() const { return DiagObj->getSourceManager();} 10281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10290a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned getNumArgs() const { return DiagObj->NumDiagArgs; } 10301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 103173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgKind - Return the kind of the specified index. Based on the kind 103273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// of argument, the accessors below can be used to get the value. 1033d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine::ArgumentKind getArgKind(unsigned Idx) const { 10343cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(Idx < getNumArgs() && "Argument index out of range!"); 1035d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie return (DiagnosticsEngine::ArgumentKind)DiagObj->DiagArgumentsKind[Idx]; 103673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner } 10371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 103873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgStdStr - Return the provided argument string specified by Idx. 103973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner const std::string &getArgStdStr(unsigned Idx) const { 1040d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(getArgKind(Idx) == DiagnosticsEngine::ak_std_string && 10413cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 104273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner return DiagObj->DiagArgumentsStr[Idx]; 104373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner } 10441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 104573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgCStr - Return the specified C string argument. 104673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner const char *getArgCStr(unsigned Idx) const { 1047d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(getArgKind(Idx) == DiagnosticsEngine::ak_c_string && 10483cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 104973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner return reinterpret_cast<const char*>(DiagObj->DiagArgumentsVal[Idx]); 10500a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 10511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 105230bc96544346bea42921cf6837e66cef80d664b4Chris Lattner /// getArgSInt - Return the specified signed integer argument. 105330bc96544346bea42921cf6837e66cef80d664b4Chris Lattner int getArgSInt(unsigned Idx) const { 1054d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(getArgKind(Idx) == DiagnosticsEngine::ak_sint && 10553cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 105630bc96544346bea42921cf6837e66cef80d664b4Chris Lattner return (int)DiagObj->DiagArgumentsVal[Idx]; 105730bc96544346bea42921cf6837e66cef80d664b4Chris Lattner } 10581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 105930bc96544346bea42921cf6837e66cef80d664b4Chris Lattner /// getArgUInt - Return the specified unsigned integer argument. 106030bc96544346bea42921cf6837e66cef80d664b4Chris Lattner unsigned getArgUInt(unsigned Idx) const { 1061d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(getArgKind(Idx) == DiagnosticsEngine::ak_uint && 10623cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 106330bc96544346bea42921cf6837e66cef80d664b4Chris Lattner return (unsigned)DiagObj->DiagArgumentsVal[Idx]; 106430bc96544346bea42921cf6837e66cef80d664b4Chris Lattner } 10651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 106643b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner /// getArgIdentifier - Return the specified IdentifierInfo argument. 106743b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner const IdentifierInfo *getArgIdentifier(unsigned Idx) const { 1068d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(getArgKind(Idx) == DiagnosticsEngine::ak_identifierinfo && 10693cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 10709634379265855f1628190e926d9aaf1fb4a5d90eChris Lattner return reinterpret_cast<IdentifierInfo*>(DiagObj->DiagArgumentsVal[Idx]); 107143b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner } 10721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 107322caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner /// getRawArg - Return the specified non-string argument in an opaque form. 107422caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner intptr_t getRawArg(unsigned Idx) const { 1075d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie assert(getArgKind(Idx) != DiagnosticsEngine::ak_std_string && 107622caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner "invalid argument accessor!"); 107722caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner return DiagObj->DiagArgumentsVal[Idx]; 107822caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 10791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10800a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// getNumRanges - Return the number of source ranges associated with this 10810a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// diagnostic. 10820a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned getNumRanges() const { 10830a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner return DiagObj->NumDiagRanges; 10840a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 10851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10860a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner const CharSourceRange &getRange(unsigned Idx) const { 10870a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner assert(Idx < DiagObj->NumDiagRanges && "Invalid diagnostic range index!"); 108851c6d384551674facc19f745ecf6e289d28dc55fDouglas Gregor return DiagObj->DiagRanges[Idx]; 10890a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 10901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 109128409289193afca1a3178a9796f8e8aebcb76896Chandler Carruth /// \brief Return an array reference for this diagnostic's ranges. 109228409289193afca1a3178a9796f8e8aebcb76896Chandler Carruth ArrayRef<CharSourceRange> getRanges() const { 109328409289193afca1a3178a9796f8e8aebcb76896Chandler Carruth return llvm::makeArrayRef(DiagObj->DiagRanges, DiagObj->NumDiagRanges); 109428409289193afca1a3178a9796f8e8aebcb76896Chandler Carruth } 109528409289193afca1a3178a9796f8e8aebcb76896Chandler Carruth 1096849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor unsigned getNumFixItHints() const { 1097981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar return DiagObj->NumDiagFixItHints; 10984b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 10994b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1100849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor const FixItHint &getFixItHint(unsigned Idx) const { 1101981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar assert(Idx < getNumFixItHints() && "Invalid index!"); 1102981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar return DiagObj->DiagFixItHints[Idx]; 11034b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 11044b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1105849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor const FixItHint *getFixItHints() const { 1106981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar return getNumFixItHints()? DiagObj->DiagFixItHints : 0; 11074b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 11084b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 1109f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// FormatDiagnostic - Format this diagnostic into a string, substituting the 1110f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// formal arguments into the %0 slots. The result is appended onto the Str 1111f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// array. 1112686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void FormatDiagnostic(SmallVectorImpl<char> &OutStr) const; 11139f28614bf1a8387000d8df57a713fcf69e198145John McCall 11149f28614bf1a8387000d8df57a713fcf69e198145John McCall /// FormatDiagnostic - Format the given format-string into the 11159f28614bf1a8387000d8df57a713fcf69e198145John McCall /// output buffer using the arguments stored in this diagnostic. 11169f28614bf1a8387000d8df57a713fcf69e198145John McCall void FormatDiagnostic(const char *DiagStr, const char *DiagEnd, 1117686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<char> &OutStr) const; 1118a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor}; 1119a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 1120a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor/** 1121d3ab63e0f66429abf2a3e4cde889e420e41e8790Douglas Gregor * \brief Represents a diagnostic in a form that can be retained until its 1122d3ab63e0f66429abf2a3e4cde889e420e41e8790Douglas Gregor * corresponding source manager is destroyed. 1123a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor */ 1124a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregorclass StoredDiagnostic { 1125aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor unsigned ID; 1126d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine::Level Level; 1127a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor FullSourceLoc Loc; 1128a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor std::string Message; 11290a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner std::vector<CharSourceRange> Ranges; 1130849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor std::vector<FixItHint> FixIts; 1131a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 1132a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregorpublic: 1133a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor StoredDiagnostic(); 113440847cfb58acc3cac7d68727df9455ac45f2e118David Blaikie StoredDiagnostic(DiagnosticsEngine::Level Level, const Diagnostic &Info); 1135d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie StoredDiagnostic(DiagnosticsEngine::Level Level, unsigned ID, 1136686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef Message); 1137d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie StoredDiagnostic(DiagnosticsEngine::Level Level, unsigned ID, 1138686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef Message, FullSourceLoc Loc, 11392d3ba4f5a923a90c3fc290ddfba5e36c2d0a9b46Chris Lattner ArrayRef<CharSourceRange> Ranges, 11402d3ba4f5a923a90c3fc290ddfba5e36c2d0a9b46Chris Lattner ArrayRef<FixItHint> Fixits); 1141a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor ~StoredDiagnostic(); 1142a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 1143a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// \brief Evaluates true when this object stores a diagnostic. 1144a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor operator bool() const { return Message.size() > 0; } 1145a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 1146aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor unsigned getID() const { return ID; } 1147d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine::Level getLevel() const { return Level; } 1148a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor const FullSourceLoc &getLocation() const { return Loc; } 1149686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef getMessage() const { return Message; } 1150c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 1151c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor void setLocation(FullSourceLoc Loc) { this->Loc = Loc; } 1152c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 11530a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner typedef std::vector<CharSourceRange>::const_iterator range_iterator; 1154a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor range_iterator range_begin() const { return Ranges.begin(); } 1155a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor range_iterator range_end() const { return Ranges.end(); } 1156a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned range_size() const { return Ranges.size(); } 11576700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek 11586700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek ArrayRef<CharSourceRange> getRanges() const { 11596700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek return llvm::makeArrayRef(Ranges); 11606700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek } 11616700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek 1162a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 1163849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor typedef std::vector<FixItHint>::const_iterator fixit_iterator; 1164a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor fixit_iterator fixit_begin() const { return FixIts.begin(); } 1165a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor fixit_iterator fixit_end() const { return FixIts.end(); } 1166a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned fixit_size() const { return FixIts.size(); } 11676700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek 11686700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek ArrayRef<FixItHint> getFixIts() const { 11696700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek return llvm::makeArrayRef(FixIts); 11706700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek } 11715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 11721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 117378ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie/// DiagnosticConsumer - This is an abstract interface implemented by clients of 11745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// the front-end, which formats and prints fully processed diagnostics. 117578ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikieclass DiagnosticConsumer { 1176ab41b97c3cddf1bcdd8bf82ab09ed3ceafcd05b1Argyrios Kyrtzidisprotected: 1177f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis unsigned NumWarnings; // Number of warnings reported 1178f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis unsigned NumErrors; // Number of errors reported 1179f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis 11805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 118178ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie DiagnosticConsumer() : NumWarnings(0), NumErrors(0) { } 1182f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis 1183f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis unsigned getNumErrors() const { return NumErrors; } 1184f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis unsigned getNumWarnings() const { return NumWarnings; } 118561d679ab2831b161c857cf3f974312fbd4ef1efdArgyrios Kyrtzidis virtual void clear() { NumWarnings = NumErrors = 0; } 1186f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis 118778ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie virtual ~DiagnosticConsumer(); 11881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1189efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// BeginSourceFile - Callback to inform the diagnostic client that processing 1190efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// of a source file is beginning. 1191efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// 1192efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// Note that diagnostics may be emitted outside the processing of a source 1193efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// file, for example during the parsing of command line options. However, 1194efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// diagnostics with source range information are required to only be emitted 1195efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// in between BeginSourceFile() and EndSourceFile(). 1196efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// 1197efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// \arg LO - The language options for the source file being processed. 1198efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// \arg PP - The preprocessor object being used for the source; this optional 1199efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// and may not be present, for example when processing AST source files. 12007d90199f109290e9d587479a481a2850d390b552Daniel Dunbar virtual void BeginSourceFile(const LangOptions &LangOpts, 12017d90199f109290e9d587479a481a2850d390b552Daniel Dunbar const Preprocessor *PP = 0) {} 1202efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar 1203efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// EndSourceFile - Callback to inform the diagnostic client that processing 1204efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// of a source file has ended. The diagnostic client should assume that any 1205efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// objects made available via \see BeginSourceFile() are inaccessible. 1206efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar virtual void EndSourceFile() {} 12071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 120829f2787b6da552018a7716f18f5bd8f67bd6edb5Argyrios Kyrtzidis /// \brief Callback to inform the diagnostic client that processing of all 120929f2787b6da552018a7716f18f5bd8f67bd6edb5Argyrios Kyrtzidis /// source files has ended. 121029f2787b6da552018a7716f18f5bd8f67bd6edb5Argyrios Kyrtzidis virtual void finish() {} 121129f2787b6da552018a7716f18f5bd8f67bd6edb5Argyrios Kyrtzidis 1212cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek /// IncludeInDiagnosticCounts - This method (whose default implementation 1213efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// returns true) indicates whether the diagnostics handled by this 121478ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie /// DiagnosticConsumer should be included in the number of diagnostics 121578ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie /// reported by DiagnosticsEngine. 1216cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek virtual bool IncludeInDiagnosticCounts() const; 12175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 12185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleDiagnostic - Handle this diagnostic, reporting it to the user or 12195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// capturing it to a log as needed. 1220f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis /// 1221f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis /// Default implementation just keeps track of the total number of warnings 1222f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis /// and errors. 1223d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie virtual void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel, 122440847cfb58acc3cac7d68727df9455ac45f2e118David Blaikie const Diagnostic &Info); 1225aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor 1226aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor /// \brief Clone the diagnostic consumer, producing an equivalent consumer 1227aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor /// that can be used in a different context. 1228aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor virtual DiagnosticConsumer *clone(DiagnosticsEngine &Diags) const = 0; 1229aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor}; 1230aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor 1231aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor/// IgnoringDiagConsumer - This is a diagnostic client that just ignores all 1232aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor/// diags. 1233aee526e77657afd1600276450e9c346953ad51d7Douglas Gregorclass IgnoringDiagConsumer : public DiagnosticConsumer { 123499ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie virtual void anchor(); 1235aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel, 1236aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor const Diagnostic &Info) { 1237aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor // Just ignore it. 1238aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor } 1239aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor DiagnosticConsumer *clone(DiagnosticsEngine &Diags) const { 1240aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor return new IgnoringDiagConsumer(); 1241aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor } 12425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 12435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1244246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu// Struct used for sending info about how a type should be printed. 1245246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieustruct TemplateDiffTypes { 1246246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu intptr_t FromType; 1247246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu intptr_t ToType; 1248246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu unsigned PrintTree : 1; 1249246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu unsigned PrintFromType : 1; 1250246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu unsigned ElideType : 1; 1251246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu unsigned ShowColors : 1; 1252246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu}; 1253246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu 1254246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu/// Special character that the diagnostic printer will use to toggle the bold 1255246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu/// attribute. The character itself will be not be printed. 1256246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieuconst char ToggleHighlight = 127; 1257246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu 12585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 12595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 12605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 1261