Diagnostic.h revision 33e4e70c8c0a17e0ccb7465d96556b077a68ecb1
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" 1928019772db70d4547be05a042eb950bc910f134fDouglas Gregor#include "llvm/ADT/IntrusiveRefCntPtr.h" 20bdbb004f38978da0c4a75af3294d1c7b5ff84af1Douglas Gregor#include "llvm/ADT/OwningPtr.h" 213f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor#include "llvm/Support/type_traits.h" 225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2333e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis#include <vector> 24f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner 255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang { 26b2153946fff330e54abfdc740c0a83aedd485b33Anders Carlsson class DiagnosticClient; 2733e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis class DiagnosticBuilder; 28d42ffbd22fc7eb61321f6a88173ee424991f01c6Ted Kremenek class IdentifierInfo; 2933e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis class DeclContext; 3040469651a3f8379dc0f32df69e9bade06a2aad36Chris Lattner class LangOptions; 317d90199f109290e9d587479a481a2850d390b552Daniel Dunbar class Preprocessor; 321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 334b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// \brief Annotates a diagnostic with some code that should be 344b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// inserted, removed, or replaced to fix the problem. 354b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// 364b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// This kind of hint should be used when we are certain that the 374b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// introduction, removal, or modification of a particular (small!) 384b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// amount of code will correct a compilation error. The compiler 394b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// should also provide full recovery from such errors, such that 40b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor/// suppressing the diagnostic output can still result in successful 414b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// compilation. 42849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregorclass FixItHint { 434b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregorpublic: 44783c56f47745f719590b17afd7ed937bf2407b53Douglas Gregor /// \brief Code that should be replaced to correct the error. Empty for an 45783c56f47745f719590b17afd7ed937bf2407b53Douglas Gregor /// insertion hint. 460a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner CharSourceRange RemoveRange; 474b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 484b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief The actual code to insert at the insertion location, as a 494b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// string. 504b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor std::string CodeToInsert; 514b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 524b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Empty code modification hint, indicating that no code 534b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// modification is known. 54783c56f47745f719590b17afd7ed937bf2407b53Douglas Gregor FixItHint() : RemoveRange() { } 554b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 562f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson bool isNull() const { 57783c56f47745f719590b17afd7ed937bf2407b53Douglas Gregor return !RemoveRange.isValid(); 582f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson } 592f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson 604b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that inserts the given 614b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// code string at a specific location. 62849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor static FixItHint CreateInsertion(SourceLocation InsertionLoc, 63849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor llvm::StringRef Code) { 64849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor FixItHint Hint; 65783c56f47745f719590b17afd7ed937bf2407b53Douglas Gregor Hint.RemoveRange = 66783c56f47745f719590b17afd7ed937bf2407b53Douglas Gregor CharSourceRange(SourceRange(InsertionLoc, InsertionLoc), false); 67b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.CodeToInsert = Code; 68b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 69b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 704b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 714b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that removes the given 724b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// source range. 730a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner static FixItHint CreateRemoval(CharSourceRange RemoveRange) { 74849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor FixItHint Hint; 75b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.RemoveRange = RemoveRange; 76b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 77b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 780a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner static FixItHint CreateRemoval(SourceRange RemoveRange) { 790a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner return CreateRemoval(CharSourceRange::getTokenRange(RemoveRange)); 800a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner } 810a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner 824b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief Create a code modification hint that replaces the given 834b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// source range with the given code string. 840a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner static FixItHint CreateReplacement(CharSourceRange RemoveRange, 85849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor llvm::StringRef Code) { 86849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor FixItHint Hint; 87b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.RemoveRange = RemoveRange; 88b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor Hint.CodeToInsert = Code; 89b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor return Hint; 90b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor } 910a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner 920a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner static FixItHint CreateReplacement(SourceRange RemoveRange, 930a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner llvm::StringRef Code) { 940a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner return CreateReplacement(CharSourceRange::getTokenRange(RemoveRange), Code); 950a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner } 964b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor}; 974b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// Diagnostic - This concrete class is used by the front-end to report 995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// problems and issues. It massages the diagnostics (e.g. handling things like 1005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// "report warnings as errors" and passes them off to the DiagnosticClient for 10133e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis/// reporting to the user. Diagnostic is tied to one translation unit and 10233e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis/// one SourceManager. 10328019772db70d4547be05a042eb950bc910f134fDouglas Gregorclass Diagnostic : public llvm::RefCountedBase<Diagnostic> { 104182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattnerpublic: 105182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// Level - The level of the diagnostic, after it has been through mapping. 106182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner enum Level { 10733e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis Ignored = DiagnosticIDs::Ignored, 10833e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis Note = DiagnosticIDs::Note, 10933e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis Warning = DiagnosticIDs::Warning, 11033e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis Error = DiagnosticIDs::Error, 11133e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis Fatal = DiagnosticIDs::Fatal 112182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner }; 1131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 114b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// ExtensionHandling - How do we handle otherwise-unmapped extension? This 115b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// is controlled by -pedantic and -pedantic-errors. 116b54b276a920246c595a0498da281821eb9d22996Chris Lattner enum ExtensionHandling { 117b54b276a920246c595a0498da281821eb9d22996Chris Lattner Ext_Ignore, Ext_Warn, Ext_Error 118b54b276a920246c595a0498da281821eb9d22996Chris Lattner }; 1191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1203fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner enum ArgumentKind { 12147b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_std_string, // std::string 12247b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_c_string, // const char * 12347b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_sint, // int 12447b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_uint, // unsigned 12547b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_identifierinfo, // IdentifierInfo 12647b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_qualtype, // QualType 12747b9a1ca55e61e37f5a368740e29de190345acc6Douglas Gregor ak_declarationname, // DeclarationName 128dacd434c49658286c380c7b4c357d76d53cb4aa1Douglas Gregor ak_nameddecl, // NamedDecl * 1293f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor ak_nestednamespec, // NestedNameSpecifier * 1303f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor ak_declcontext // DeclContext * 1313fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner }; 1325edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin 1335edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin /// Specifies which overload candidates to display when overload resolution 1345edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin /// fails. 1355edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin enum OverloadsShown { 1365edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin Ovl_All, ///< Show all overloads. 1375edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin Ovl_Best ///< Show just the "best" overload candidates. 1385edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin }; 1395edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin 140b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// ArgumentValue - This typedef represents on argument value, which is a 141b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// union discriminated by ArgumentKind, with a value. 142b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner typedef std::pair<ArgumentKind, intptr_t> ArgumentValue; 143ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 1441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumpprivate: 14527ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner unsigned char AllExtensionsSilenced; // Used by __extension__ 146b54b276a920246c595a0498da281821eb9d22996Chris Lattner bool IgnoreAllWarnings; // Ignore all warnings: -w 1471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump bool WarningsAsErrors; // Treat warnings like errors: 148e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner bool ErrorsAsFatal; // Treat errors like fatal errors. 149b54b276a920246c595a0498da281821eb9d22996Chris Lattner bool SuppressSystemWarnings; // Suppress warnings in system headers. 15081b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor bool SuppressAllDiagnostics; // Suppress all diagnostics. 1515edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin OverloadsShown ShowOverloads; // Which overload candidates to show. 152c100214fdc41a7ea215f75d433eb1cb829fd4330Chris Lattner unsigned ErrorLimit; // Cap of # errors emitted, 0 -> no limit. 153575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor unsigned TemplateBacktraceLimit; // Cap on depth of template backtrace stack, 154575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor // 0 -> no limit. 155b54b276a920246c595a0498da281821eb9d22996Chris Lattner ExtensionHandling ExtBehavior; // Map extensions onto warnings or errors? 15633e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis llvm::IntrusiveRefCntPtr<DiagnosticIDs> Diags; 15733e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis DiagnosticClient *Client; 15833e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis bool OwnsDiagClient; 15933e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis SourceManager *SourceMgr; 160bdbb004f38978da0c4a75af3294d1c7b5ff84af1Douglas Gregor 1615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// DiagMappings - Mapping information for diagnostics. Mapping info is 162691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// packed into four bits per diagnostic. The low three bits are the mapping 163691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// (an instance of diag::Mapping), or zero if unset. The high bit is set 164691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// when the mapping was established as a user mapping. If the high bit is 165691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// clear, then the low bits are set to the default value, and should be 166691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// mapped with -pedantic, -Werror, etc. 1673c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer class DiagMappings { 1683c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer unsigned char Values[diag::DIAG_UPPER_LIMIT/2]; 1693c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer 1703c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer public: 171bdacf3c64867a132917386ac1c8df77e617d41fcArgyrios Kyrtzidis DiagMappings() : Values() /*zero-initialization of array*/ { } 1723c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer 1733c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer void setMapping(diag::kind Diag, unsigned Map) { 1743c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer size_t Shift = (Diag & 1)*4; 1753c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer Values[Diag/2] = (Values[Diag/2] & ~(15 << Shift)) | (Map << Shift); 1763c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer } 1773c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer 1783c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer diag::Mapping getMapping(diag::kind Diag) const { 1793c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer return (diag::Mapping)((Values[Diag/2] >> (Diag & 1)*4) & 15); 1803c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer } 1813c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer }; 18204ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 18304ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner mutable std::vector<DiagMappings> DiagMappingsStack; 18404ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 18515221422eda7bac679e38b07512feda49715ef66Chris Lattner /// ErrorOccurred / FatalErrorOccurred - This is set to true when an error or 18615221422eda7bac679e38b07512feda49715ef66Chris Lattner /// fatal error is emitted, and is sticky. 1875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool ErrorOccurred; 18815221422eda7bac679e38b07512feda49715ef66Chris Lattner bool FatalErrorOccurred; 1891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 190f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// LastDiagLevel - This is the level of the last diagnostic emitted. This is 191f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// used to emit continuation diagnostics with the same level as the 192f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner /// diagnostic that they follow. 19333e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis DiagnosticIDs::Level LastDiagLevel; 1945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 19553eee7ba970d21ff15bbd4334164037a3b4cc4b8Chris Lattner unsigned NumWarnings; // Number of warnings reported 19653eee7ba970d21ff15bbd4334164037a3b4cc4b8Chris Lattner unsigned NumErrors; // Number of errors reported 1971864f2eb59471d07db51adfc3e5b1a229eed631aDouglas Gregor unsigned NumErrorsSuppressed; // Number of errors suppressed 1987bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber 1993fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// ArgToStringFn - A function pointer that converts an opaque diagnostic 2003fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// argument to a strings. This takes the modifiers and argument that was 2013fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// present in the diagnostic. 202b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// 203b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// The PrevArgs array (whose length is NumPrevArgs) indicates the previous 204b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// arguments formatted for this diagnostic. Implementations of this function 205b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// can use this information to avoid redundancy across arguments. 206b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner /// 20722caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner /// This is a hack to avoid a layering violation between libbasic and libsema. 2083fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner typedef void (*ArgToStringFnTy)(ArgumentKind Kind, intptr_t Val, 2093fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Modifier, unsigned ModifierLen, 2103fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Argument, unsigned ArgumentLen, 211b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner const ArgumentValue *PrevArgs, 212b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner unsigned NumPrevArgs, 21392dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner llvm::SmallVectorImpl<char> &Output, 21492dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner void *Cookie); 21592dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner void *ArgToStringCookie; 2163fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ArgToStringFnTy ArgToStringFn; 21793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 21893ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief ID of the "delayed" diagnostic, which is a (typically 21993ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// fatal) diagnostic that had to be delayed because it was found 22093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// while emitting another diagnostic. 22193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor unsigned DelayedDiagID; 22293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 22393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief First string argument for the delayed diagnostic. 22493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor std::string DelayedDiagArg1; 22593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 22693ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief Second string argument for the delayed diagnostic. 22793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor std::string DelayedDiagArg2; 22893ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 2295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 23033e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis explicit Diagnostic(const llvm::IntrusiveRefCntPtr<DiagnosticIDs> &Diags, 23133e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis DiagnosticClient *client = 0, 23233e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis bool ShouldOwnClient = true); 233182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner ~Diagnostic(); 2341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 23533e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis const llvm::IntrusiveRefCntPtr<DiagnosticIDs> &getDiagnosticIDs() const { 23633e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return Diags; 23733e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis } 23833e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis 23933e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis DiagnosticClient *getClient() { return Client; } 24033e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis const DiagnosticClient *getClient() const { return Client; } 2411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 242bdbb004f38978da0c4a75af3294d1c7b5ff84af1Douglas Gregor /// \brief Return the current diagnostic client along with ownership of that 243bdbb004f38978da0c4a75af3294d1c7b5ff84af1Douglas Gregor /// client. 24433e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis DiagnosticClient *takeClient() { 24533e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis OwnsDiagClient = false; 24633e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return Client; 24733e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis } 24833e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis 24933e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis bool hasSourceManager() const { return SourceMgr != 0; } 25033e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis SourceManager &getSourceManager() const { 25133e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis assert(SourceMgr && "SourceManager not set!"); 25233e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return *SourceMgr; 25333e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis } 25433e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis void setSourceManager(SourceManager *SrcMgr) { SourceMgr = SrcMgr; } 25533e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis 25633e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis //===--------------------------------------------------------------------===// 25733e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis // Diagnostic characterization methods, used by a client to customize how 25833e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis // diagnostics are emitted. 25933e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis // 26004ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 2611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// pushMappings - Copies the current DiagMappings and pushes the new copy 26204ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// onto the top of the stack. 26304ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner void pushMappings(); 26404ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 26504ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// popMappings - Pops the current DiagMappings off the top of the stack 26604ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// causing the new top of the stack to be the active mappings. Returns 26704ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// true if the pop happens, false if there is only one DiagMapping on the 26804ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner /// stack. 26904ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner bool popMappings(); 27004ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner 271bdbb004f38978da0c4a75af3294d1c7b5ff84af1Douglas Gregor /// \brief Set the diagnostic client associated with this diagnostic object. 272bdbb004f38978da0c4a75af3294d1c7b5ff84af1Douglas Gregor /// 27333e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis /// \param ShouldOwnClient true if the diagnostic object should take 27433e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis /// ownership of \c client. 27533e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis void setClient(DiagnosticClient *client, bool ShouldOwnClient = true) { 27633e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis Client = client; 27733e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis OwnsDiagClient = ShouldOwnClient; 27833e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis } 2795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 280c100214fdc41a7ea215f75d433eb1cb829fd4330Chris Lattner /// setErrorLimit - Specify a limit for the number of errors we should 281b205ac9fcd22b87b41697172d1983c5ae9dabaafChris Lattner /// emit before giving up. Zero disables the limit. 282c100214fdc41a7ea215f75d433eb1cb829fd4330Chris Lattner void setErrorLimit(unsigned Limit) { ErrorLimit = Limit; } 283b205ac9fcd22b87b41697172d1983c5ae9dabaafChris Lattner 284575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor /// \brief Specify the maximum number of template instantiation 285575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor /// notes to emit along with a given diagnostic. 286575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor void setTemplateBacktraceLimit(unsigned Limit) { 287575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor TemplateBacktraceLimit = Limit; 288575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor } 2896c1cb9916e9988dcdd65b9266dbe24afd173427aDouglas Gregor 290575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor /// \brief Retrieve the maximum number of template instantiation 291575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor /// nodes to emit along with a given diagnostic. 292575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor unsigned getTemplateBacktraceLimit() const { 293575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor return TemplateBacktraceLimit; 294575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor } 2956c1cb9916e9988dcdd65b9266dbe24afd173427aDouglas Gregor 2965b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner /// setIgnoreAllWarnings - When set to true, any unmapped warnings are 2975b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner /// ignored. If this and WarningsAsErrors are both set, then this one wins. 2985b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner void setIgnoreAllWarnings(bool Val) { IgnoreAllWarnings = Val; } 2995b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner bool getIgnoreAllWarnings() const { return IgnoreAllWarnings; } 3001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setWarningsAsErrors - When set to true, any warnings reported are issued 3025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// as errors. 3035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setWarningsAsErrors(bool Val) { WarningsAsErrors = Val; } 3045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool getWarningsAsErrors() const { return WarningsAsErrors; } 3051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 306e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner /// setErrorsAsFatal - When set to true, any error reported is made a 307e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner /// fatal error. 308e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner void setErrorsAsFatal(bool Val) { ErrorsAsFatal = Val; } 309e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner bool getErrorsAsFatal() const { return ErrorsAsFatal; } 310e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner 3112fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar /// setSuppressSystemWarnings - When set to true mask warnings that 3122fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar /// come from system headers. 3132fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar void setSuppressSystemWarnings(bool Val) { SuppressSystemWarnings = Val; } 3142fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar bool getSuppressSystemWarnings() const { return SuppressSystemWarnings; } 3152fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar 31681b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor /// \brief Suppress all diagnostics, to silence the front end when we 31781b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor /// know that we don't want any more diagnostics to be passed along to the 31881b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor /// client 31981b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor void setSuppressAllDiagnostics(bool Val = true) { 32081b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor SuppressAllDiagnostics = Val; 32181b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor } 32281b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor bool getSuppressAllDiagnostics() const { return SuppressAllDiagnostics; } 32381b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor 3245edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin /// \brief Specify which overload candidates to show when overload resolution 3255edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin /// fails. By default, we show all candidates. 3265edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin void setShowOverloads(OverloadsShown Val) { 3275edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin ShowOverloads = Val; 3285edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin } 3295edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin OverloadsShown getShowOverloads() const { return ShowOverloads; } 3305edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin 3310b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor /// \brief Pretend that the last diagnostic issued was ignored. This can 3320b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor /// be used by clients who suppress diagnostics themselves. 3330b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor void setLastDiagnosticIgnored() { 33433e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis LastDiagLevel = DiagnosticIDs::Ignored; 3350b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor } 3360b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor 337b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// setExtensionHandlingBehavior - This controls whether otherwise-unmapped 338b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// extension diagnostics are mapped onto ignore/warning/error. This 339b54b276a920246c595a0498da281821eb9d22996Chris Lattner /// corresponds to the GCC -pedantic and -pedantic-errors option. 340b54b276a920246c595a0498da281821eb9d22996Chris Lattner void setExtensionHandlingBehavior(ExtensionHandling H) { 341b54b276a920246c595a0498da281821eb9d22996Chris Lattner ExtBehavior = H; 342b54b276a920246c595a0498da281821eb9d22996Chris Lattner } 3431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 34427ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// AllExtensionsSilenced - This is a counter bumped when an __extension__ 34527ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// block is encountered. When non-zero, all extension diagnostics are 34627ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner /// entirely silenced, no matter how they are mapped. 34727ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner void IncrementAllExtensionsSilenced() { ++AllExtensionsSilenced; } 34827ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner void DecrementAllExtensionsSilenced() { --AllExtensionsSilenced; } 34991a2886d558ea6ca7a0bed73ab5acea5ae78eac2Douglas Gregor bool hasAllExtensionsSilenced() { return AllExtensionsSilenced != 0; } 3501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setDiagnosticMapping - This allows the client to specify that certain 352691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// warnings are ignored. Notes can never be mapped, errors can only be 353691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// mapped to fatal, and WARNINGs and EXTENSIONs can be mapped arbitrarily. 3545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setDiagnosticMapping(diag::kind Diag, diag::Mapping Map) { 35519e8e2cffc19606d0f44e7c2897cd126ffd3f9b0Chris Lattner assert(Diag < diag::DIAG_UPPER_LIMIT && 3560750618b0beacdc9b0a9e210a661e4746823ced7Chris Lattner "Can only map builtin diagnostics"); 35733e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis assert((Diags->isBuiltinWarningOrExtension(Diag) || 358d0fe3e9a97459477e64ad1df312fd29b86a3c3cbChris Lattner (Map == diag::MAP_FATAL || Map == diag::MAP_ERROR)) && 359d0fe3e9a97459477e64ad1df312fd29b86a3c3cbChris Lattner "Cannot map errors into warnings!"); 360691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner setDiagnosticMappingInternal(Diag, Map, true); 36127ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner } 3621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3633bc172bc6a787842db6fea351cf6929539fca70dChris Lattner /// setDiagnosticGroupMapping - Change an entire diagnostic group (e.g. 3643bc172bc6a787842db6fea351cf6929539fca70dChris Lattner /// "unknown-pragmas" to have the specified mapping. This returns true and 3653bc172bc6a787842db6fea351cf6929539fca70dChris Lattner /// ignores the request if "Group" was unknown, false otherwise. 36633e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis bool setDiagnosticGroupMapping(const char *Group, diag::Mapping Map) { 36733e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return Diags->setDiagnosticGroupMapping(Group, Map, *this); 36833e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis } 3695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool hasErrorOccurred() const { return ErrorOccurred; } 37115221422eda7bac679e38b07512feda49715ef66Chris Lattner bool hasFatalErrorOccurred() const { return FatalErrorOccurred; } 3725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned getNumErrors() const { return NumErrors; } 3741864f2eb59471d07db51adfc3e5b1a229eed631aDouglas Gregor unsigned getNumErrorsSuppressed() const { return NumErrorsSuppressed; } 37553eee7ba970d21ff15bbd4334164037a3b4cc4b8Chris Lattner unsigned getNumWarnings() const { return NumWarnings; } 3761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 377c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor void setNumWarnings(unsigned NumWarnings) { 378c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor this->NumWarnings = NumWarnings; 379c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor } 380c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 38133e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis void setNumErrors(unsigned NumErrors) { 38233e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis this->NumErrors = NumErrors; 38333e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis } 38433e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis 385182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// getCustomDiagID - Return an ID for a diagnostic with the specified message 386182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// and level. If this is the first request for this diagnosic, it is 387182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner /// registered and created, otherwise the existing ID is returned. 38833e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis unsigned getCustomDiagID(Level L, llvm::StringRef Message) { 38933e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return Diags->getCustomDiagID((DiagnosticIDs::Level)L, Message); 39033e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis } 3911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3923fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// ConvertArgToString - This method converts a diagnostic argument (as an 3933fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner /// intptr_t) into the string that represents it. 3943fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner void ConvertArgToString(ArgumentKind Kind, intptr_t Val, 3953fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Modifier, unsigned ModLen, 3963fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner const char *Argument, unsigned ArgLen, 397b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner const ArgumentValue *PrevArgs, unsigned NumPrevArgs, 3983fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner llvm::SmallVectorImpl<char> &Output) const { 399b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner ArgToStringFn(Kind, Val, Modifier, ModLen, Argument, ArgLen, 400b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner PrevArgs, NumPrevArgs, Output, ArgToStringCookie); 40122caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 4021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 40392dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner void SetArgToStringFn(ArgToStringFnTy Fn, void *Cookie) { 4043fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner ArgToStringFn = Fn; 40592dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner ArgToStringCookie = Cookie; 40622caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 4071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 408abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// \brief Reset the state of the diagnostic object to its initial 409abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor /// configuration. 410abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor void Reset(); 411abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor 4125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer //===--------------------------------------------------------------------===// 4135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Diagnostic classification and reporting interfaces. 4145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // 4155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getDiagnosticLevel - Based on the way the client configured the Diagnostic 4175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// object, classify the specified diagnostic ID into a Level, consumable by 4185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the DiagnosticClient. 41933e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis Level getDiagnosticLevel(unsigned DiagID) const { 42033e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return (Level)Diags->getDiagnosticLevel(DiagID, *this); 42133e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis } 4221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 423509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// Report - Issue the message to the client. @c DiagID is a member of the 424509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// @c diag::kind enum. This actually returns aninstance of DiagnosticBuilder 425509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// which emits the diagnostics (through @c ProcessDiag) when it is destroyed. 426509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// @c Pos represents the source location associated with the diagnostic, 427509355e982d15da4f8f3939493516379665f6275Ted Kremenek /// which can be an invalid location if no position information is available. 42833e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis inline DiagnosticBuilder Report(SourceLocation Pos, unsigned DiagID); 4290f9fed70cea107b3f79df554e38bd8e98d48fe47Daniel Dunbar inline DiagnosticBuilder Report(unsigned DiagID); 430de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor 43193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief Determine whethere there is already a diagnostic in flight. 4325800f7ea9cf5621280089d690f677bd28064d6b5Ted Kremenek bool isDiagnosticInFlight() const { return CurDiagID != ~0U; } 43393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 43493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief Set the "delayed" diagnostic that will be emitted once 43593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// the current diagnostic completes. 43693ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// 43793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// If a diagnostic is already in-flight but the front end must 43893ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// report a problem (e.g., with an inconsistent file system 43993ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// state), this routine sets a "delayed" diagnostic that will be 44093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// emitted after the current diagnostic completes. This should 44193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// only be used for fatal errors detected at inconvenient 44293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// times. If emitting a delayed diagnostic causes a second delayed 44393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// diagnostic to be introduced, that second delayed diagnostic 44493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// will be ignored. 44593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// 44693ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \param DiagID The ID of the diagnostic being delayed. 44793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// 44893ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \param Arg1 A string argument that will be provided to the 44993ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// diagnostic. A copy of this string will be stored in the 45093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// Diagnostic object itself. 45193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// 45293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \param Arg2 A string argument that will be provided to the 45393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// diagnostic. A copy of this string will be stored in the 45493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// Diagnostic object itself. 45593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor void SetDelayedDiagnostic(unsigned DiagID, llvm::StringRef Arg1 = "", 45693ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor llvm::StringRef Arg2 = ""); 45793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 458de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor /// \brief Clear out the current diagnostic. 459de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor void Clear() { CurDiagID = ~0U; } 4601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4610a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattnerprivate: 46293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor /// \brief Report the delayed diagnostic. 46393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor void ReportDelayed(); 46493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 46593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor 466691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// getDiagnosticMappingInfo - Return the mapping info currently set for the 467691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// specified builtin diagnostic. This returns the high bit encoding, or zero 468691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner /// if the field is completely uninitialized. 46904e442714c292d9381cad2ac14087991132bddcaChris Lattner diag::Mapping getDiagnosticMappingInfo(diag::kind Diag) const { 4703c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer return DiagMappingsStack.back().getMapping(Diag); 471691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner } 4721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 473691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner void setDiagnosticMappingInternal(unsigned DiagId, unsigned Map, 474691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner bool isUser) const { 475691f1ae7164ba78c3dd7ac20c487399935b9544bChris Lattner if (isUser) Map |= 8; // Set the high bit for user mappings. 4763c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer DiagMappingsStack.back().setMapping((diag::kind)DiagId, Map); 4779faf50e62ddcd2535b472abc8daafd7042120caaChris Lattner } 4781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4793cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner // This is private state used by DiagnosticBuilder. We put it here instead of 4803cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner // in DiagnosticBuilder in order to keep DiagnosticBuilder a small lightweight 4810a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // object. This implementation choice means that we can only have one 4820a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // diagnostic "in flight" at a time, but this seems to be a reasonable 4830a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // tradeoff to keep these objects small. Assertions verify that only one 4840a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner // diagnostic is in flight at a time. 48533e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis friend class DiagnosticIDs; 4863cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner friend class DiagnosticBuilder; 4870a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner friend class DiagnosticInfo; 4889b623639378d53a675921ddfa7316034d571881eDouglas Gregor friend class PartialDiagnostic; 4899b623639378d53a675921ddfa7316034d571881eDouglas Gregor 490b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner /// CurDiagLoc - This is the location of the current diagnostic that is in 491b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner /// flight. 49233e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis SourceLocation CurDiagLoc; 4931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 494b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner /// CurDiagID - This is the ID of the current diagnostic that is in flight. 4953cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// This is set to ~0U when there is no diagnostic in flight. 496b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner unsigned CurDiagID; 497b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner 49873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner enum { 49973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// MaxArguments - The maximum number of arguments we can hold. We currently 50073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// only support up to 10 arguments (%0-%9). A single diagnostic with more 50173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// than that almost certainly has to be simplified anyway. 50273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner MaxArguments = 10 50373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner }; 5041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5053cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// NumDiagArgs - This contains the number of entries in Arguments. 506730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner signed char NumDiagArgs; 507730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner /// NumRanges - This is the number of ranges in the DiagRanges array. 508730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner unsigned char NumDiagRanges; 5094b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// \brief The number of code modifications hints in the 510849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor /// FixItHints array. 511849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor unsigned char NumFixItHints; 512ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 51373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsKind - This is an array of ArgumentKind::ArgumentKind enum 51473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// values, with one for each argument. This specifies whether the argument 51573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// is in DiagArgumentsStr or in DiagArguments. 51673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner unsigned char DiagArgumentsKind[MaxArguments]; 5171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 51873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsStr - This holds the values of each string argument for the 51973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// current diagnostic. This value is only used when the corresponding 52073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// ArgumentKind is ak_std_string. 52173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner std::string DiagArgumentsStr[MaxArguments]; 52273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner 52373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// DiagArgumentsVal - The values for the various substitution positions. This 52473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// is used when the argument is not an std::string. The specific value is 52573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// mangled into an intptr_t and the intepretation depends on exactly what 52673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// sort of argument kind it is. 52773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner intptr_t DiagArgumentsVal[MaxArguments]; 5281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5290a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// DiagRanges - The list of ranges added to this diagnostic. It currently 5300a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// only support 10 ranges, could easily be extended if needed. 5310a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner CharSourceRange DiagRanges[10]; 5321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 533849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor enum { MaxFixItHints = 3 }; 5344b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 535849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor /// FixItHints - If valid, provides a hint with some code 5364b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor /// to insert, remove, or modify at a particular position. 537849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor FixItHint FixItHints[MaxFixItHints]; 5384b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 5390a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// ProcessDiag - This is the method used to report a diagnostic that is 5400a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// finally fully formed. 5415e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// 5425e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// \returns true if the diagnostic was emitted, false if it was 5435e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// suppressed. 54433e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis bool ProcessDiag() { 54533e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return Diags->ProcessDiag(*this); 54633e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis } 547f41d3be39980d40849850d3fb90403623cc8459eArgyrios Kyrtzidis 548f41d3be39980d40849850d3fb90403623cc8459eArgyrios Kyrtzidis friend class ASTReader; 549f41d3be39980d40849850d3fb90403623cc8459eArgyrios Kyrtzidis friend class ASTWriter; 5503cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}; 5513cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 5523cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 5533cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner// DiagnosticBuilder 5543cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 5553cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 5563cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// DiagnosticBuilder - This is a little helper class used to produce 5573cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// diagnostics. This is constructed by the Diagnostic::Report method, and 5583cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// allows insertion of extra information (arguments and source ranges) into the 5593cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// currently "in flight" diagnostic. When the temporary for the builder is 5603cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// destroyed, the diagnostic is issued. 5613cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// 5623cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// Note that many of these will be created as temporary objects (many call 5633cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// sites), so we want them to be small and we never want their address taken. 5643cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// This ensures that compilers with somewhat reasonable optimizers will promote 5653cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// the common fields to registers, eliminating increments of the NumArgs field, 5663cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// for example. 5673cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerclass DiagnosticBuilder { 5683cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner mutable Diagnostic *DiagObj; 569849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor mutable unsigned NumArgs, NumRanges, NumFixItHints; 5701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5713cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void operator=(const DiagnosticBuilder&); // DO NOT IMPLEMENT 5723cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner friend class Diagnostic; 5733cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner explicit DiagnosticBuilder(Diagnostic *diagObj) 574849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor : DiagObj(diagObj), NumArgs(0), NumRanges(0), NumFixItHints(0) {} 575ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 5769b623639378d53a675921ddfa7316034d571881eDouglas Gregor friend class PartialDiagnostic; 577b535041ee33c5eff255832bc5541c8d52aae8254Douglas Gregor 578b535041ee33c5eff255832bc5541c8d52aae8254Douglas Gregorprotected: 579b535041ee33c5eff255832bc5541c8d52aae8254Douglas Gregor void FlushCounts(); 5809b623639378d53a675921ddfa7316034d571881eDouglas Gregor 5811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumppublic: 5820a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// Copy constructor. When copied, this "takes" the diagnostic info from the 5830a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// input and neuters it. 5843cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DiagnosticBuilder(const DiagnosticBuilder &D) { 5850a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner DiagObj = D.DiagObj; 5860a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner D.DiagObj = 0; 58725a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor NumArgs = D.NumArgs; 58825a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor NumRanges = D.NumRanges; 589849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor NumFixItHints = D.NumFixItHints; 5900a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 59125a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor 5925e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// \brief Simple enumeration value used to give a name to the 5935e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// suppress-diagnostic constructor. 5945e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor enum SuppressKind { Suppress }; 5955e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor 5965e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// \brief Create an empty DiagnosticBuilder object that represents 5975e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// no actual diagnostic. 5981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump explicit DiagnosticBuilder(SuppressKind) 599849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor : DiagObj(0), NumArgs(0), NumRanges(0), NumFixItHints(0) { } 6005e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor 60125a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// \brief Force the diagnostic builder to emit the diagnostic now. 60225a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// 60325a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// Once this function has been called, the DiagnosticBuilder object 60425a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// should not be used again before it is destroyed. 6055e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// 6065e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// \returns true if a diagnostic was emitted, false if the 6075e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor /// diagnostic was suppressed. 60893ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor bool Emit(); 60925a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor 61025a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// Destructor - The dtor emits the diagnostic if it hasn't already 61125a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor /// been emitted. 61225a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor ~DiagnosticBuilder() { Emit(); } 6131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 614d93256e55673a17d18543397ec462416acb13792Douglas Gregor /// isActive - Determine whether this diagnostic is still active. 615d93256e55673a17d18543397ec462416acb13792Douglas Gregor bool isActive() const { return DiagObj != 0; } 616d93256e55673a17d18543397ec462416acb13792Douglas Gregor 6179b623639378d53a675921ddfa7316034d571881eDouglas Gregor /// \brief Retrieve the active diagnostic ID. 6189b623639378d53a675921ddfa7316034d571881eDouglas Gregor /// 6199b623639378d53a675921ddfa7316034d571881eDouglas Gregor /// \pre \c isActive() 6209b623639378d53a675921ddfa7316034d571881eDouglas Gregor unsigned getDiagID() const { 6219b623639378d53a675921ddfa7316034d571881eDouglas Gregor assert(isActive() && "Diagnostic is inactive"); 6229b623639378d53a675921ddfa7316034d571881eDouglas Gregor return DiagObj->CurDiagID; 6239b623639378d53a675921ddfa7316034d571881eDouglas Gregor } 6249b623639378d53a675921ddfa7316034d571881eDouglas Gregor 6259b623639378d53a675921ddfa7316034d571881eDouglas Gregor /// \brief Clear out the current diagnostic. 6269b623639378d53a675921ddfa7316034d571881eDouglas Gregor void Clear() { DiagObj = 0; } 6279b623639378d53a675921ddfa7316034d571881eDouglas Gregor 6283cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// Operator bool: conversion of DiagnosticBuilder to bool always returns 6293cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// true. This allows is to be used in boolean error contexts like: 6303cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner /// return Diag(...); 6313cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner operator bool() const { return true; } 6323cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 633eaea925e70e3ee85809e572aa8474b8dfc491af7Daniel Dunbar void AddString(llvm::StringRef S) const { 6343cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(NumArgs < Diagnostic::MaxArguments && 6353cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 6365e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor if (DiagObj) { 6375e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor DiagObj->DiagArgumentsKind[NumArgs] = Diagnostic::ak_std_string; 6385e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor DiagObj->DiagArgumentsStr[NumArgs++] = S; 6395e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor } 6403cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner } 6411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6423cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner void AddTaggedVal(intptr_t V, Diagnostic::ArgumentKind Kind) const { 6433cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(NumArgs < Diagnostic::MaxArguments && 6443cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 6455e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor if (DiagObj) { 6465e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor DiagObj->DiagArgumentsKind[NumArgs] = Kind; 6475e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor DiagObj->DiagArgumentsVal[NumArgs++] = V; 6485e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor } 6490a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 6501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6510a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner void AddSourceRange(const CharSourceRange &R) const { 6521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump assert(NumRanges < 6533cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner sizeof(DiagObj->DiagRanges)/sizeof(DiagObj->DiagRanges[0]) && 6543cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "Too many arguments to diagnostic!"); 6555e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor if (DiagObj) 65651c6d384551674facc19f745ecf6e289d28dc55fDouglas Gregor DiagObj->DiagRanges[NumRanges++] = R; 6571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 6584b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 659849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor void AddFixItHint(const FixItHint &Hint) const { 6602f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson if (Hint.isNull()) 6612f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson return; 6622f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson 663849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor assert(NumFixItHints < Diagnostic::MaxFixItHints && 664849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor "Too many fix-it hints!"); 6655e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor if (DiagObj) 666849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor DiagObj->FixItHints[NumFixItHints++] = Hint; 6674b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 6683cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}; 6693cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 6703cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 671eaea925e70e3ee85809e572aa8474b8dfc491af7Daniel Dunbar llvm::StringRef S) { 6723cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddString(S); 6733cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 6743cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 6753cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 6763cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 6773cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const char *Str) { 6783cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(reinterpret_cast<intptr_t>(Str), 6793cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner Diagnostic::ak_c_string); 6803cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 6813cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 6823cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 6833cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, int I) { 6843cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(I, Diagnostic::ak_sint); 6853cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 6863cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 6873cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 6883bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidisinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,bool I) { 6893bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis DB.AddTaggedVal(I, Diagnostic::ak_sint); 6903bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis return DB; 6913bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis} 6923bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis 6933cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 6943cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner unsigned I) { 6953cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(I, Diagnostic::ak_uint); 6963cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 6973cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 6983cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 6993cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 7003cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const IdentifierInfo *II) { 7013cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner DB.AddTaggedVal(reinterpret_cast<intptr_t>(II), 7023cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner Diagnostic::ak_identifierinfo); 7033cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 7043cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 7051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7063f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// Adds a DeclContext to the diagnostic. The enable_if template magic is here 7073f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// so that we only match those arguments that are (statically) DeclContexts; 7083f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// other arguments that derive from DeclContext (e.g., RecordDecls) will not 7093f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// match. 7103f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregortemplate<typename T> 7113f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregorinline 7123f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregortypename llvm::enable_if<llvm::is_same<T, DeclContext>, 7133f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor const DiagnosticBuilder &>::type 7143f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregoroperator<<(const DiagnosticBuilder &DB, T *DC) { 7153f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor DB.AddTaggedVal(reinterpret_cast<intptr_t>(DC), 7163f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor Diagnostic::ak_declcontext); 7173f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor return DB; 7183f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor} 7193f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor 7203cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 7213cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const SourceRange &R) { 7220a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner DB.AddSourceRange(CharSourceRange::getTokenRange(R)); 7233cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DB; 7243cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 7254b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 7264b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregorinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 7270a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner const CharSourceRange &R) { 7280a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner DB.AddSourceRange(R); 7290a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner return DB; 7300a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner} 7310a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner 7320a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, 733849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor const FixItHint &Hint) { 734849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor DB.AddFixItHint(Hint); 7354b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor return DB; 7364b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor} 737ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor 7383cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// Report - Issue the message to the client. DiagID is a member of the 7393cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// diag::kind enum. This actually returns a new instance of DiagnosticBuilder 7403cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// which emits the diagnostics (through ProcessDiag) when it is destroyed. 74133e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidisinline DiagnosticBuilder Diagnostic::Report(SourceLocation Loc, 74233e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis unsigned DiagID){ 7433cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(CurDiagID == ~0U && "Multiple diagnostics in flight at once!"); 7443cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner CurDiagLoc = Loc; 7453cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner CurDiagID = DiagID; 7463cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return DiagnosticBuilder(this); 7473cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner} 7480f9fed70cea107b3f79df554e38bd8e98d48fe47Daniel Dunbarinline DiagnosticBuilder Diagnostic::Report(unsigned DiagID) { 74933e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis return Report(SourceLocation(), DiagID); 7500f9fed70cea107b3f79df554e38bd8e98d48fe47Daniel Dunbar} 7513cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner 7523cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 7533cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner// DiagnosticInfo 7543cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===// 7551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7563cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// DiagnosticInfo - This is a little helper class (which is basically a smart 7574b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// pointer that forward info from Diagnostic) that allows clients to enquire 7583cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// about the currently in-flight diagnostic. 7593cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerclass DiagnosticInfo { 7603cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner const Diagnostic *DiagObj; 7613cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerpublic: 7623cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner explicit DiagnosticInfo(const Diagnostic *DO) : DiagObj(DO) {} 7631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7640a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const Diagnostic *getDiags() const { return DiagObj; } 765b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner unsigned getID() const { return DiagObj->CurDiagID; } 76633e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis const SourceLocation &getLocation() const { return DiagObj->CurDiagLoc; } 76733e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis bool hasSourceManager() const { return DiagObj->hasSourceManager(); } 76833e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis SourceManager &getSourceManager() const { return DiagObj->getSourceManager();} 7691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7700a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned getNumArgs() const { return DiagObj->NumDiagArgs; } 7711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 77273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgKind - Return the kind of the specified index. Based on the kind 77373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// of argument, the accessors below can be used to get the value. 7743cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner Diagnostic::ArgumentKind getArgKind(unsigned Idx) const { 7753cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(Idx < getNumArgs() && "Argument index out of range!"); 7763cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner return (Diagnostic::ArgumentKind)DiagObj->DiagArgumentsKind[Idx]; 77773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner } 7781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 77973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgStdStr - Return the provided argument string specified by Idx. 78073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner const std::string &getArgStdStr(unsigned Idx) const { 7813cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_std_string && 7823cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 78373d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner return DiagObj->DiagArgumentsStr[Idx]; 78473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner } 7851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 78673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner /// getArgCStr - Return the specified C string argument. 78773d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner const char *getArgCStr(unsigned Idx) const { 7883cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_c_string && 7893cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 79073d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner return reinterpret_cast<const char*>(DiagObj->DiagArgumentsVal[Idx]); 7910a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 7921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 79330bc96544346bea42921cf6837e66cef80d664b4Chris Lattner /// getArgSInt - Return the specified signed integer argument. 79430bc96544346bea42921cf6837e66cef80d664b4Chris Lattner int getArgSInt(unsigned Idx) const { 7953cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_sint && 7963cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 79730bc96544346bea42921cf6837e66cef80d664b4Chris Lattner return (int)DiagObj->DiagArgumentsVal[Idx]; 79830bc96544346bea42921cf6837e66cef80d664b4Chris Lattner } 7991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 80030bc96544346bea42921cf6837e66cef80d664b4Chris Lattner /// getArgUInt - Return the specified unsigned integer argument. 80130bc96544346bea42921cf6837e66cef80d664b4Chris Lattner unsigned getArgUInt(unsigned Idx) const { 8023cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_uint && 8033cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 80430bc96544346bea42921cf6837e66cef80d664b4Chris Lattner return (unsigned)DiagObj->DiagArgumentsVal[Idx]; 80530bc96544346bea42921cf6837e66cef80d664b4Chris Lattner } 8061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 80743b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner /// getArgIdentifier - Return the specified IdentifierInfo argument. 80843b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner const IdentifierInfo *getArgIdentifier(unsigned Idx) const { 8093cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner assert(getArgKind(Idx) == Diagnostic::ak_identifierinfo && 8103cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner "invalid argument accessor!"); 8119634379265855f1628190e926d9aaf1fb4a5d90eChris Lattner return reinterpret_cast<IdentifierInfo*>(DiagObj->DiagArgumentsVal[Idx]); 81243b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner } 8131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 81422caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner /// getRawArg - Return the specified non-string argument in an opaque form. 81522caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner intptr_t getRawArg(unsigned Idx) const { 81622caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner assert(getArgKind(Idx) != Diagnostic::ak_std_string && 81722caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner "invalid argument accessor!"); 81822caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner return DiagObj->DiagArgumentsVal[Idx]; 81922caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner } 8201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8220a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// getNumRanges - Return the number of source ranges associated with this 8230a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner /// diagnostic. 8240a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner unsigned getNumRanges() const { 8250a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner return DiagObj->NumDiagRanges; 8260a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 8271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8280a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner const CharSourceRange &getRange(unsigned Idx) const { 8290a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner assert(Idx < DiagObj->NumDiagRanges && "Invalid diagnostic range index!"); 83051c6d384551674facc19f745ecf6e289d28dc55fDouglas Gregor return DiagObj->DiagRanges[Idx]; 8310a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner } 8321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 833849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor unsigned getNumFixItHints() const { 834849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor return DiagObj->NumFixItHints; 8354b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 8364b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 837849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor const FixItHint &getFixItHint(unsigned Idx) const { 838849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor return DiagObj->FixItHints[Idx]; 8394b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 8404b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 841849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor const FixItHint *getFixItHints() const { 842849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor return DiagObj->NumFixItHints? 843849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor &DiagObj->FixItHints[0] : 0; 8444b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor } 8454b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor 846f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// FormatDiagnostic - Format this diagnostic into a string, substituting the 847f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// formal arguments into the %0 slots. The result is appended onto the Str 848f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner /// array. 849f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner void FormatDiagnostic(llvm::SmallVectorImpl<char> &OutStr) const; 8509f28614bf1a8387000d8df57a713fcf69e198145John McCall 8519f28614bf1a8387000d8df57a713fcf69e198145John McCall /// FormatDiagnostic - Format the given format-string into the 8529f28614bf1a8387000d8df57a713fcf69e198145John McCall /// output buffer using the arguments stored in this diagnostic. 8539f28614bf1a8387000d8df57a713fcf69e198145John McCall void FormatDiagnostic(const char *DiagStr, const char *DiagEnd, 8549f28614bf1a8387000d8df57a713fcf69e198145John McCall llvm::SmallVectorImpl<char> &OutStr) const; 855a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor}; 856a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 857a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor/** 858d3ab63e0f66429abf2a3e4cde889e420e41e8790Douglas Gregor * \brief Represents a diagnostic in a form that can be retained until its 859d3ab63e0f66429abf2a3e4cde889e420e41e8790Douglas Gregor * corresponding source manager is destroyed. 860a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor */ 861a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregorclass StoredDiagnostic { 862a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor Diagnostic::Level Level; 863a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor FullSourceLoc Loc; 864a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor std::string Message; 8650a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner std::vector<CharSourceRange> Ranges; 866849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor std::vector<FixItHint> FixIts; 867a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 868a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregorpublic: 869a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor StoredDiagnostic(); 870a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor StoredDiagnostic(Diagnostic::Level Level, const DiagnosticInfo &Info); 871a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor StoredDiagnostic(Diagnostic::Level Level, llvm::StringRef Message); 872a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor ~StoredDiagnostic(); 873a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 874a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor /// \brief Evaluates true when this object stores a diagnostic. 875a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor operator bool() const { return Message.size() > 0; } 876a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 877a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor Diagnostic::Level getLevel() const { return Level; } 878a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor const FullSourceLoc &getLocation() const { return Loc; } 879a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor llvm::StringRef getMessage() const { return Message; } 880c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 881c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor void setLocation(FullSourceLoc Loc) { this->Loc = Loc; } 882c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor 8830a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner typedef std::vector<CharSourceRange>::const_iterator range_iterator; 884a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor range_iterator range_begin() const { return Ranges.begin(); } 885a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor range_iterator range_end() const { return Ranges.end(); } 886a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned range_size() const { return Ranges.size(); } 887a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor 888849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor typedef std::vector<FixItHint>::const_iterator fixit_iterator; 889a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor fixit_iterator fixit_begin() const { return FixIts.begin(); } 890a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor fixit_iterator fixit_end() const { return FixIts.end(); } 891a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor unsigned fixit_size() const { return FixIts.size(); } 8925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 8931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// DiagnosticClient - This is an abstract interface implemented by clients of 8955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// the front-end, which formats and prints fully processed diagnostics. 8965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass DiagnosticClient { 8975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 8985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer virtual ~DiagnosticClient(); 8991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 900efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// BeginSourceFile - Callback to inform the diagnostic client that processing 901efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// of a source file is beginning. 902efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// 903efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// Note that diagnostics may be emitted outside the processing of a source 904efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// file, for example during the parsing of command line options. However, 905efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// diagnostics with source range information are required to only be emitted 906efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// in between BeginSourceFile() and EndSourceFile(). 907efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// 908efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// \arg LO - The language options for the source file being processed. 909efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// \arg PP - The preprocessor object being used for the source; this optional 910efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// and may not be present, for example when processing AST source files. 9117d90199f109290e9d587479a481a2850d390b552Daniel Dunbar virtual void BeginSourceFile(const LangOptions &LangOpts, 9127d90199f109290e9d587479a481a2850d390b552Daniel Dunbar const Preprocessor *PP = 0) {} 913efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar 914efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// EndSourceFile - Callback to inform the diagnostic client that processing 915efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// of a source file has ended. The diagnostic client should assume that any 916efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// objects made available via \see BeginSourceFile() are inaccessible. 917efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar virtual void EndSourceFile() {} 9181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 919cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek /// IncludeInDiagnosticCounts - This method (whose default implementation 920efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// returns true) indicates whether the diagnostics handled by this 921efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// DiagnosticClient should be included in the number of diagnostics reported 922efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar /// by Diagnostic. 923cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek virtual bool IncludeInDiagnosticCounts() const; 9245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 9255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// HandleDiagnostic - Handle this diagnostic, reporting it to the user or 9265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// capturing it to a log as needed. 9270a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner virtual void HandleDiagnostic(Diagnostic::Level DiagLevel, 9280a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner const DiagnosticInfo &Info) = 0; 9295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 9305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 9315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 9325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 9335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 934