Diagnostic.h revision af50aab0c317462129d73ae8000c6394c718598d
15f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===--- Diagnostic.h - C Language Family Diagnostic Handling ---*- C++ -*-===//
25f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//
35f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//                     The LLVM Compiler Infrastructure
45f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//
50bc735ffcfb223c0186419547abaa5c84482663eChris Lattner// This file is distributed under the University of Illinois Open Source
60bc735ffcfb223c0186419547abaa5c84482663eChris Lattner// License. See LICENSE.TXT for details.
75f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//
85f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===----------------------------------------------------------------------===//
92f7f5b1f5ff023cb8c4008ae53a12b09e3ea2622James Dennett///
102f7f5b1f5ff023cb8c4008ae53a12b09e3ea2622James Dennett/// \file
112f7f5b1f5ff023cb8c4008ae53a12b09e3ea2622James Dennett/// \brief Defines the Diagnostic-related interfaces.
122f7f5b1f5ff023cb8c4008ae53a12b09e3ea2622James Dennett///
135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===----------------------------------------------------------------------===//
145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#ifndef LLVM_CLANG_DIAGNOSTIC_H
165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#define LLVM_CLANG_DIAGNOSTIC_H
175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
1833e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis#include "clang/Basic/DiagnosticIDs.h"
192eefd8657c233bc7c9330acfe475fc270bbe7cabTed Kremenek#include "clang/Basic/SourceLocation.h"
20f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor#include "llvm/ADT/ArrayRef.h"
210827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis#include "llvm/ADT/DenseMap.h"
2228019772db70d4547be05a042eb950bc910f134fDouglas Gregor#include "llvm/ADT/IntrusiveRefCntPtr.h"
23bdbb004f38978da0c4a75af3294d1c7b5ff84af1Douglas Gregor#include "llvm/ADT/OwningPtr.h"
243f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor#include "llvm/Support/type_traits.h"
255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
2633e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis#include <vector>
270827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis#include <list>
28f4c839657742b823cea1a95b18422f1ba74d3dddChris Lattner
295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang {
3078ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie  class DiagnosticConsumer;
3133e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis  class DiagnosticBuilder;
32d42ffbd22fc7eb61321f6a88173ee424991f01c6Ted Kremenek  class IdentifierInfo;
3333e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis  class DeclContext;
3440469651a3f8379dc0f32df69e9bade06a2aad36Chris Lattner  class LangOptions;
357d90199f109290e9d587479a481a2850d390b552Daniel Dunbar  class Preprocessor;
369c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis  class DiagnosticErrorTrap;
37e59abb56ce0e1c206fb80bd945a0c358b0abe1efArgyrios Kyrtzidis  class StoredDiagnostic;
381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
394b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// \brief Annotates a diagnostic with some code that should be
404b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// inserted, removed, or replaced to fix the problem.
414b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor///
424b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// This kind of hint should be used when we are certain that the
434b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// introduction, removal, or modification of a particular (small!)
444b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// amount of code will correct a compilation error. The compiler
454b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// should also provide full recovery from such errors, such that
46b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor/// suppressing the diagnostic output can still result in successful
474b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor/// compilation.
48849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregorclass FixItHint {
494b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregorpublic:
50783c56f47745f719590b17afd7ed937bf2407b53Douglas Gregor  /// \brief Code that should be replaced to correct the error. Empty for an
51783c56f47745f719590b17afd7ed937bf2407b53Douglas Gregor  /// insertion hint.
520a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner  CharSourceRange RemoveRange;
534b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor
5430660a898545416f0fea2d717f16f75640001e38Ted Kremenek  /// \brief Code in the specific range that should be inserted in the insertion
5530660a898545416f0fea2d717f16f75640001e38Ted Kremenek  /// location.
5630660a898545416f0fea2d717f16f75640001e38Ted Kremenek  CharSourceRange InsertFromRange;
5730660a898545416f0fea2d717f16f75640001e38Ted Kremenek
584b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor  /// \brief The actual code to insert at the insertion location, as a
594b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor  /// string.
604b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor  std::string CodeToInsert;
614b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor
6230660a898545416f0fea2d717f16f75640001e38Ted Kremenek  bool BeforePreviousInsertions;
6330660a898545416f0fea2d717f16f75640001e38Ted Kremenek
644b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor  /// \brief Empty code modification hint, indicating that no code
654b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor  /// modification is known.
6630660a898545416f0fea2d717f16f75640001e38Ted Kremenek  FixItHint() : BeforePreviousInsertions(false) { }
674b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor
682f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson  bool isNull() const {
69783c56f47745f719590b17afd7ed937bf2407b53Douglas Gregor    return !RemoveRange.isValid();
702f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson  }
712f019aadc96f8fa3185c684c7150bd596d045064Anders Carlsson
724b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor  /// \brief Create a code modification hint that inserts the given
734b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor  /// code string at a specific location.
74849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor  static FixItHint CreateInsertion(SourceLocation InsertionLoc,
7530660a898545416f0fea2d717f16f75640001e38Ted Kremenek                                   StringRef Code,
7630660a898545416f0fea2d717f16f75640001e38Ted Kremenek                                   bool BeforePreviousInsertions = false) {
77849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor    FixItHint Hint;
78783c56f47745f719590b17afd7ed937bf2407b53Douglas Gregor    Hint.RemoveRange =
79783c56f47745f719590b17afd7ed937bf2407b53Douglas Gregor      CharSourceRange(SourceRange(InsertionLoc, InsertionLoc), false);
80b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor    Hint.CodeToInsert = Code;
8130660a898545416f0fea2d717f16f75640001e38Ted Kremenek    Hint.BeforePreviousInsertions = BeforePreviousInsertions;
8230660a898545416f0fea2d717f16f75640001e38Ted Kremenek    return Hint;
8330660a898545416f0fea2d717f16f75640001e38Ted Kremenek  }
8430660a898545416f0fea2d717f16f75640001e38Ted Kremenek
8530660a898545416f0fea2d717f16f75640001e38Ted Kremenek  /// \brief Create a code modification hint that inserts the given
86af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// code from \p FromRange at a specific location.
8730660a898545416f0fea2d717f16f75640001e38Ted Kremenek  static FixItHint CreateInsertionFromRange(SourceLocation InsertionLoc,
8830660a898545416f0fea2d717f16f75640001e38Ted Kremenek                                            CharSourceRange FromRange,
8930660a898545416f0fea2d717f16f75640001e38Ted Kremenek                                        bool BeforePreviousInsertions = false) {
9030660a898545416f0fea2d717f16f75640001e38Ted Kremenek    FixItHint Hint;
9130660a898545416f0fea2d717f16f75640001e38Ted Kremenek    Hint.RemoveRange =
9230660a898545416f0fea2d717f16f75640001e38Ted Kremenek      CharSourceRange(SourceRange(InsertionLoc, InsertionLoc), false);
9330660a898545416f0fea2d717f16f75640001e38Ted Kremenek    Hint.InsertFromRange = FromRange;
9430660a898545416f0fea2d717f16f75640001e38Ted Kremenek    Hint.BeforePreviousInsertions = BeforePreviousInsertions;
95b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor    return Hint;
96b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor  }
974b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor
984b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor  /// \brief Create a code modification hint that removes the given
994b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor  /// source range.
1000a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner  static FixItHint CreateRemoval(CharSourceRange RemoveRange) {
101849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor    FixItHint Hint;
102b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor    Hint.RemoveRange = RemoveRange;
103b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor    return Hint;
104b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor  }
1050a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner  static FixItHint CreateRemoval(SourceRange RemoveRange) {
1060a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner    return CreateRemoval(CharSourceRange::getTokenRange(RemoveRange));
1070a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner  }
1080a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner
1094b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor  /// \brief Create a code modification hint that replaces the given
1104b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor  /// source range with the given code string.
1110a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner  static FixItHint CreateReplacement(CharSourceRange RemoveRange,
112686775deca8b8685eb90801495880e3abdd844c2Chris Lattner                                     StringRef Code) {
113849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor    FixItHint Hint;
114b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor    Hint.RemoveRange = RemoveRange;
115b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor    Hint.CodeToInsert = Code;
116b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor    return Hint;
117b2fb6de9070fea9abc56c8e8d5469066e964cefeDouglas Gregor  }
1180a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner
1190a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner  static FixItHint CreateReplacement(SourceRange RemoveRange,
120686775deca8b8685eb90801495880e3abdd844c2Chris Lattner                                     StringRef Code) {
1210a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner    return CreateReplacement(CharSourceRange::getTokenRange(RemoveRange), Code);
1220a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner  }
1234b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor};
1244b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor
125af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// \brief Concrete class used by the front-end to report problems and issues.
126af50aab0c317462129d73ae8000c6394c718598dJames Dennett///
127af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// This massages the diagnostics (e.g. handling things like "report warnings
128af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// as errors" and passes them off to the DiagnosticConsumer for reporting to
129af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// the user. DiagnosticsEngine is tied to one translation unit and one
130af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// SourceManager.
131c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmithclass DiagnosticsEngine : public RefCountedBase<DiagnosticsEngine> {
132182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattnerpublic:
133af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief The level of the diagnostic, after it has been through mapping.
134182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner  enum Level {
13533e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis    Ignored = DiagnosticIDs::Ignored,
13633e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis    Note = DiagnosticIDs::Note,
13733e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis    Warning = DiagnosticIDs::Warning,
13833e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis    Error = DiagnosticIDs::Error,
13933e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis    Fatal = DiagnosticIDs::Fatal
140182745ae7892bca0842d9c023370ade5f8d1c6e8Chris Lattner  };
1411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
142af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief How do we handle otherwise-unmapped extension?
143af50aab0c317462129d73ae8000c6394c718598dJames Dennett  ///
144af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// This is controlled by -pedantic and -pedantic-errors.
145b54b276a920246c595a0498da281821eb9d22996Chris Lattner  enum ExtensionHandling {
146b54b276a920246c595a0498da281821eb9d22996Chris Lattner    Ext_Ignore, Ext_Warn, Ext_Error
147b54b276a920246c595a0498da281821eb9d22996Chris Lattner  };
1481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
1493fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner  enum ArgumentKind {
150af50aab0c317462129d73ae8000c6394c718598dJames Dennett    ak_std_string,      ///< std::string
151af50aab0c317462129d73ae8000c6394c718598dJames Dennett    ak_c_string,        ///< const char *
152af50aab0c317462129d73ae8000c6394c718598dJames Dennett    ak_sint,            ///< int
153af50aab0c317462129d73ae8000c6394c718598dJames Dennett    ak_uint,            ///< unsigned
154af50aab0c317462129d73ae8000c6394c718598dJames Dennett    ak_identifierinfo,  ///< IdentifierInfo
155af50aab0c317462129d73ae8000c6394c718598dJames Dennett    ak_qualtype,        ///< QualType
156af50aab0c317462129d73ae8000c6394c718598dJames Dennett    ak_declarationname, ///< DeclarationName
157af50aab0c317462129d73ae8000c6394c718598dJames Dennett    ak_nameddecl,       ///< NamedDecl *
158af50aab0c317462129d73ae8000c6394c718598dJames Dennett    ak_nestednamespec,  ///< NestedNameSpecifier *
159af50aab0c317462129d73ae8000c6394c718598dJames Dennett    ak_declcontext,     ///< DeclContext *
160af50aab0c317462129d73ae8000c6394c718598dJames Dennett    ak_qualtype_pair    ///< pair<QualType, QualType>
1613fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner  };
1625edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin
163af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief Specifies which overload candidates to display when overload
164af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// resolution fails.
1655edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin  enum OverloadsShown {
1665edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin    Ovl_All,  ///< Show all overloads.
1675edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin    Ovl_Best  ///< Show just the "best" overload candidates.
1685edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin  };
1695edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin
170af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief Represents on argument value, which is a union discriminated
171af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// by ArgumentKind, with a value.
172b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner  typedef std::pair<ArgumentKind, intptr_t> ArgumentValue;
173ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor
1741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumpprivate:
17527ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner  unsigned char AllExtensionsSilenced; // Used by __extension__
176b54b276a920246c595a0498da281821eb9d22996Chris Lattner  bool IgnoreAllWarnings;        // Ignore all warnings: -w
1771e473ccb0e0f6fd1954bef330f7193c1a3fb3ba1Ted Kremenek  bool WarningsAsErrors;         // Treat warnings like errors.
1781e473ccb0e0f6fd1954bef330f7193c1a3fb3ba1Ted Kremenek  bool EnableAllWarnings;        // Enable all warnings.
179e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner  bool ErrorsAsFatal;            // Treat errors like fatal errors.
180b54b276a920246c595a0498da281821eb9d22996Chris Lattner  bool SuppressSystemWarnings;   // Suppress warnings in system headers.
18181b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor  bool SuppressAllDiagnostics;   // Suppress all diagnostics.
182246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu  bool ElideType;                // Elide common types of templates.
183246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu  bool PrintTemplateTree;        // Print a tree when comparing templates.
184246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu  bool ShowColors;               // Color printing is enabled.
1855edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin  OverloadsShown ShowOverloads;  // Which overload candidates to show.
186c100214fdc41a7ea215f75d433eb1cb829fd4330Chris Lattner  unsigned ErrorLimit;           // Cap of # errors emitted, 0 -> no limit.
187575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor  unsigned TemplateBacktraceLimit; // Cap on depth of template backtrace stack,
188575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor                                   // 0 -> no limit.
18908d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith  unsigned ConstexprBacktraceLimit; // Cap on depth of constexpr evaluation
19008d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith                                    // backtrace stack, 0 -> no limit.
191b54b276a920246c595a0498da281821eb9d22996Chris Lattner  ExtensionHandling ExtBehavior; // Map extensions onto warnings or errors?
192c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith  IntrusiveRefCntPtr<DiagnosticIDs> Diags;
19378ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie  DiagnosticConsumer *Client;
19433e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis  bool OwnsDiagClient;
19533e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis  SourceManager *SourceMgr;
1960827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis
197af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief Mapping information for diagnostics.
198af50aab0c317462129d73ae8000c6394c718598dJames Dennett  ///
199af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// Mapping info is packed into four bits per diagnostic.  The low three
200af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// bits are the mapping (an instance of diag::Mapping), or zero if unset.
201af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// The high bit is set when the mapping was established as a user mapping.
202af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// If the high bit is clear, then the low bits are set to the default
203af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// value, and should be mapped with -pedantic, -Werror, etc.
2040827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis  ///
2053efd52cf8f4e57c5571bd8cc3168264c3bc46a1eArgyrios Kyrtzidis  /// A new DiagState is created and kept around when diagnostic pragmas modify
2063efd52cf8f4e57c5571bd8cc3168264c3bc46a1eArgyrios Kyrtzidis  /// the state so that we know what is the diagnostic state at any given
2073efd52cf8f4e57c5571bd8cc3168264c3bc46a1eArgyrios Kyrtzidis  /// source location.
2080827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis  class DiagState {
209b1c99c679adb53be8f478d08be83af6c9c22ae4bDaniel Dunbar    llvm::DenseMap<unsigned, DiagnosticMappingInfo> DiagMap;
2103c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer
2113c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer  public:
212ba494c64365d78b1cdb6baea4d1e79263389fda9Daniel Dunbar    typedef llvm::DenseMap<unsigned, DiagnosticMappingInfo>::iterator
213b1c99c679adb53be8f478d08be83af6c9c22ae4bDaniel Dunbar      iterator;
214ba494c64365d78b1cdb6baea4d1e79263389fda9Daniel Dunbar    typedef llvm::DenseMap<unsigned, DiagnosticMappingInfo>::const_iterator
215ba494c64365d78b1cdb6baea4d1e79263389fda9Daniel Dunbar      const_iterator;
2163efd52cf8f4e57c5571bd8cc3168264c3bc46a1eArgyrios Kyrtzidis
217b1c99c679adb53be8f478d08be83af6c9c22ae4bDaniel Dunbar    void setMappingInfo(diag::kind Diag, DiagnosticMappingInfo Info) {
218b1c99c679adb53be8f478d08be83af6c9c22ae4bDaniel Dunbar      DiagMap[Diag] = Info;
219b1c99c679adb53be8f478d08be83af6c9c22ae4bDaniel Dunbar    }
2203c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer
221ba494c64365d78b1cdb6baea4d1e79263389fda9Daniel Dunbar    DiagnosticMappingInfo &getOrAddMappingInfo(diag::kind Diag);
222ba494c64365d78b1cdb6baea4d1e79263389fda9Daniel Dunbar
223ba494c64365d78b1cdb6baea4d1e79263389fda9Daniel Dunbar    const_iterator begin() const { return DiagMap.begin(); }
224ba494c64365d78b1cdb6baea4d1e79263389fda9Daniel Dunbar    const_iterator end() const { return DiagMap.end(); }
2250827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis  };
2263c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer
2270827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis  /// \brief Keeps and automatically disposes all DiagStates that we create.
2280827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis  std::list<DiagState> DiagStates;
2290827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis
2300827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis  /// \brief Represents a point in source where the diagnostic state was
231af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// modified because of a pragma.
232af50aab0c317462129d73ae8000c6394c718598dJames Dennett  ///
233af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// 'Loc' can be null if the point represents the diagnostic state
234af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// modifications done through the command-line.
2350827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis  struct DiagStatePoint {
2360827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis    DiagState *State;
2370827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis    FullSourceLoc Loc;
2380827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis    DiagStatePoint(DiagState *State, FullSourceLoc Loc)
2390827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis      : State(State), Loc(Loc) { }
2400827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis
2410827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis    bool operator<(const DiagStatePoint &RHS) const {
2420827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis      // If Loc is invalid it means it came from <command-line>, in which case
2430827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis      // we regard it as coming before any valid source location.
2440827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis      if (RHS.Loc.isInvalid())
2450827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis        return false;
2460827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis      if (Loc.isInvalid())
2470827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis        return true;
2480827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis      return Loc.isBeforeInTranslationUnitThan(RHS.Loc);
2493c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer    }
2503c2d3016adec79c81c4efff64e208fd3ecdd92aeBenjamin Kramer  };
25104ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner
252af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief A sorted vector of all DiagStatePoints representing changes in
253af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// diagnostic state due to diagnostic pragmas.
254af50aab0c317462129d73ae8000c6394c718598dJames Dennett  ///
255af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// The vector is always sorted according to the SourceLocation of the
256af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// DiagStatePoint.
2570827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis  typedef std::vector<DiagStatePoint> DiagStatePointsTy;
2580827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis  mutable DiagStatePointsTy DiagStatePoints;
2590827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis
2600827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis  /// \brief Keeps the DiagState that was active during each diagnostic 'push'
2610827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis  /// so we can get back at it when we 'pop'.
2620827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis  std::vector<DiagState *> DiagStateOnPushStack;
2630827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis
2640827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis  DiagState *GetCurDiagState() const {
2650827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis    assert(!DiagStatePoints.empty());
2660827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis    return DiagStatePoints.back().State;
2670827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis  }
2680827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis
2690827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis  void PushDiagStatePoint(DiagState *State, SourceLocation L) {
2700827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis    FullSourceLoc Loc(L, *SourceMgr);
2710827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis    // Make sure that DiagStatePoints is always sorted according to Loc.
2720827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis    assert((Loc.isValid() || DiagStatePoints.empty()) &&
2730827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis           "Adding invalid loc point after another point");
2740827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis    assert((Loc.isInvalid() || DiagStatePoints.empty() ||
2750827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis            DiagStatePoints.back().Loc.isInvalid() ||
2760827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis            DiagStatePoints.back().Loc.isBeforeInTranslationUnitThan(Loc)) &&
2770827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis           "Previous point loc comes after or is the same as new one");
2780827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis    DiagStatePoints.push_back(DiagStatePoint(State,
2790827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis                                             FullSourceLoc(Loc, *SourceMgr)));
2800827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis  }
2810827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis
2820827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis  /// \brief Finds the DiagStatePoint that contains the diagnostic state of
2830827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis  /// the given source location.
2840827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis  DiagStatePointsTy::iterator GetDiagStatePointForLoc(SourceLocation Loc) const;
28504ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner
286af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief Sticky flag set to \c true when an error is emitted.
2875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  bool ErrorOccurred;
288af50aab0c317462129d73ae8000c6394c718598dJames Dennett
289af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief Sticky flag set to \c true when a fatal error is emitted.
29015221422eda7bac679e38b07512feda49715ef66Chris Lattner  bool FatalErrorOccurred;
2911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
29285bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor  /// \brief Indicates that an unrecoverable error has occurred.
29385bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor  bool UnrecoverableErrorOccurred;
29485bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor
295c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis  /// \brief Counts for DiagnosticErrorTrap to check whether an error occurred
296add80bb3957dba1d9389304453c0a4c975768bd7John McCall  /// during a parsing section, e.g. during parsing a function.
297c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis  unsigned TrapNumErrorsOccurred;
298c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis  unsigned TrapNumUnrecoverableErrorsOccurred;
299add80bb3957dba1d9389304453c0a4c975768bd7John McCall
300af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief The level of the last diagnostic emitted.
301af50aab0c317462129d73ae8000c6394c718598dJames Dennett  ///
302af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// This is used to emit continuation diagnostics with the same level as the
303f5d2328fc849288c3a62e43d065685f516d57091Chris Lattner  /// diagnostic that they follow.
30433e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis  DiagnosticIDs::Level LastDiagLevel;
3055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
306af50aab0c317462129d73ae8000c6394c718598dJames Dennett  unsigned NumWarnings;         ///< Number of warnings reported
307af50aab0c317462129d73ae8000c6394c718598dJames Dennett  unsigned NumErrors;           ///< Number of errors reported
308af50aab0c317462129d73ae8000c6394c718598dJames Dennett  unsigned NumErrorsSuppressed; ///< Number of errors suppressed
3097bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber
310af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief A function pointer that converts an opaque diagnostic
311af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// argument to a strings.
312af50aab0c317462129d73ae8000c6394c718598dJames Dennett  ///
313af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// This takes the modifiers and argument that was present in the diagnostic.
314b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner  ///
315b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner  /// The PrevArgs array (whose length is NumPrevArgs) indicates the previous
316b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner  /// arguments formatted for this diagnostic.  Implementations of this function
317b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner  /// can use this information to avoid redundancy across arguments.
318b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner  ///
31922caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner  /// This is a hack to avoid a layering violation between libbasic and libsema.
3200673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth  typedef void (*ArgToStringFnTy)(
3210673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth      ArgumentKind Kind, intptr_t Val,
3220673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth      const char *Modifier, unsigned ModifierLen,
3230673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth      const char *Argument, unsigned ArgumentLen,
3240673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth      const ArgumentValue *PrevArgs,
3250673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth      unsigned NumPrevArgs,
326686775deca8b8685eb90801495880e3abdd844c2Chris Lattner      SmallVectorImpl<char> &Output,
3270673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth      void *Cookie,
328341785ec52f87c0803ba52dc88faac4e136f8593Bill Wendling      ArrayRef<intptr_t> QualTypeVals);
32992dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner  void *ArgToStringCookie;
3303fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner  ArgToStringFnTy ArgToStringFn;
33193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor
33293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor  /// \brief ID of the "delayed" diagnostic, which is a (typically
33393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor  /// fatal) diagnostic that had to be delayed because it was found
33493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor  /// while emitting another diagnostic.
33593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor  unsigned DelayedDiagID;
33693ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor
33793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor  /// \brief First string argument for the delayed diagnostic.
33893ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor  std::string DelayedDiagArg1;
33993ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor
34093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor  /// \brief Second string argument for the delayed diagnostic.
34193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor  std::string DelayedDiagArg2;
34293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor
3435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic:
344d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie  explicit DiagnosticsEngine(
345c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith                      const IntrusiveRefCntPtr<DiagnosticIDs> &Diags,
34678ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie                      DiagnosticConsumer *client = 0,
34733e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis                      bool ShouldOwnClient = true);
348d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie  ~DiagnosticsEngine();
3491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
350c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith  const IntrusiveRefCntPtr<DiagnosticIDs> &getDiagnosticIDs() const {
35133e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis    return Diags;
35233e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis  }
35333e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis
35478ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie  DiagnosticConsumer *getClient() { return Client; }
35578ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie  const DiagnosticConsumer *getClient() const { return Client; }
3561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
357d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie  /// \brief Determine whether this \c DiagnosticsEngine object own its client.
35878243658c533168d51fd076fba328437932ba6f1Douglas Gregor  bool ownsClient() const { return OwnsDiagClient; }
35978243658c533168d51fd076fba328437932ba6f1Douglas Gregor
360bdbb004f38978da0c4a75af3294d1c7b5ff84af1Douglas Gregor  /// \brief Return the current diagnostic client along with ownership of that
361bdbb004f38978da0c4a75af3294d1c7b5ff84af1Douglas Gregor  /// client.
36278ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie  DiagnosticConsumer *takeClient() {
36333e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis    OwnsDiagClient = false;
36433e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis    return Client;
36533e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis  }
36633e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis
36733e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis  bool hasSourceManager() const { return SourceMgr != 0; }
36833e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis  SourceManager &getSourceManager() const {
36933e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis    assert(SourceMgr && "SourceManager not set!");
37033e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis    return *SourceMgr;
37133e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis  }
37233e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis  void setSourceManager(SourceManager *SrcMgr) { SourceMgr = SrcMgr; }
37333e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis
37433e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis  //===--------------------------------------------------------------------===//
375d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie  //  DiagnosticsEngine characterization methods, used by a client to customize
376d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie  //  how diagnostics are emitted.
37733e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis  //
37804ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner
379af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief Copies the current DiagMappings and pushes the new copy
38004ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner  /// onto the top of the stack.
3810827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis  void pushMappings(SourceLocation Loc);
38204ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner
383af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief Pops the current DiagMappings off the top of the stack,
384af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// causing the new top of the stack to be the active mappings.
385af50aab0c317462129d73ae8000c6394c718598dJames Dennett  ///
386af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \returns \c true if the pop happens, \c false if there is only one
387af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// DiagMapping on the stack.
3880827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis  bool popMappings(SourceLocation Loc);
38904ae2df026b275aae5dddfc0db5ca55ff4e62179Chris Lattner
390bdbb004f38978da0c4a75af3294d1c7b5ff84af1Douglas Gregor  /// \brief Set the diagnostic client associated with this diagnostic object.
391bdbb004f38978da0c4a75af3294d1c7b5ff84af1Douglas Gregor  ///
39233e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis  /// \param ShouldOwnClient true if the diagnostic object should take
39333e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis  /// ownership of \c client.
39478ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie  void setClient(DiagnosticConsumer *client, bool ShouldOwnClient = true);
3955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
396af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief Specify a limit for the number of errors we should
397af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// emit before giving up.
398af50aab0c317462129d73ae8000c6394c718598dJames Dennett  ///
399af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// Zero disables the limit.
400c100214fdc41a7ea215f75d433eb1cb829fd4330Chris Lattner  void setErrorLimit(unsigned Limit) { ErrorLimit = Limit; }
401b205ac9fcd22b87b41697172d1983c5ae9dabaafChris Lattner
402575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor  /// \brief Specify the maximum number of template instantiation
403575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor  /// notes to emit along with a given diagnostic.
404575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor  void setTemplateBacktraceLimit(unsigned Limit) {
405575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor    TemplateBacktraceLimit = Limit;
406575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor  }
40708d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith
408575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor  /// \brief Retrieve the maximum number of template instantiation
40908d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith  /// notes to emit along with a given diagnostic.
410575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor  unsigned getTemplateBacktraceLimit() const {
411575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor    return TemplateBacktraceLimit;
412575cf3791216c33770ba950430493cdd43099f8fDouglas Gregor  }
41308d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith
41408d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith  /// \brief Specify the maximum number of constexpr evaluation
41508d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith  /// notes to emit along with a given diagnostic.
41608d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith  void setConstexprBacktraceLimit(unsigned Limit) {
41708d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith    ConstexprBacktraceLimit = Limit;
41808d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith  }
41908d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith
42008d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith  /// \brief Retrieve the maximum number of constexpr evaluation
42108d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith  /// notes to emit along with a given diagnostic.
42208d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith  unsigned getConstexprBacktraceLimit() const {
42308d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith    return ConstexprBacktraceLimit;
42408d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith  }
42508d6e032a2a0a8656d12b3b7b93942987bb12eb7Richard Smith
426af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief When set to true, any unmapped warnings are ignored.
427af50aab0c317462129d73ae8000c6394c718598dJames Dennett  ///
428af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// If this and WarningsAsErrors are both set, then this one wins.
4295b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner  void setIgnoreAllWarnings(bool Val) { IgnoreAllWarnings = Val; }
4305b4681c8ef65808ec4d72ab6081efd24d53d4969Chris Lattner  bool getIgnoreAllWarnings() const { return IgnoreAllWarnings; }
4311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
432af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief When set to true, any unmapped ignored warnings are no longer
433af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// ignored.
434af50aab0c317462129d73ae8000c6394c718598dJames Dennett  ///
435af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// If this and IgnoreAllWarnings are both set, then that one wins.
4361e473ccb0e0f6fd1954bef330f7193c1a3fb3ba1Ted Kremenek  void setEnableAllWarnings(bool Val) { EnableAllWarnings = Val; }
4371e473ccb0e0f6fd1954bef330f7193c1a3fb3ba1Ted Kremenek  bool getEnableAllWarnngs() const { return EnableAllWarnings; }
4381e473ccb0e0f6fd1954bef330f7193c1a3fb3ba1Ted Kremenek
439af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief When set to true, any warnings reported are issued as errors.
4405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  void setWarningsAsErrors(bool Val) { WarningsAsErrors = Val; }
4415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  bool getWarningsAsErrors() const { return WarningsAsErrors; }
4421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
443af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief When set to true, any error reported is made a fatal error.
444e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner  void setErrorsAsFatal(bool Val) { ErrorsAsFatal = Val; }
445e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner  bool getErrorsAsFatal() const { return ErrorsAsFatal; }
446e663c720063fc9ff9f75bcbe38cd070c73c78b0eChris Lattner
447af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief When set to true mask warnings that come from system headers.
4482fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar  void setSuppressSystemWarnings(bool Val) { SuppressSystemWarnings = Val; }
4492fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar  bool getSuppressSystemWarnings() const { return SuppressSystemWarnings; }
4502fe0997427d92388e66e7573f4b043e7ba285ef0Daniel Dunbar
45181b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor  /// \brief Suppress all diagnostics, to silence the front end when we
45281b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor  /// know that we don't want any more diagnostics to be passed along to the
45381b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor  /// client
45481b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor  void setSuppressAllDiagnostics(bool Val = true) {
45581b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor    SuppressAllDiagnostics = Val;
45681b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor  }
45781b747b7fcc91c2fba9a3183d8fac80adbfc1d3eDouglas Gregor  bool getSuppressAllDiagnostics() const { return SuppressAllDiagnostics; }
458246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu
459246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu  /// \brief Set type eliding, to skip outputting same types occurring in
460246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu  /// template types.
461246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu  void setElideType(bool Val = true) { ElideType = Val; }
462246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu  bool getElideType() { return ElideType; }
463246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu
464246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu  /// \brief Set tree printing, to outputting the template difference in a
465246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu  /// tree format.
466246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu  void setPrintTemplateTree(bool Val = false) { PrintTemplateTree = Val; }
467246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu  bool getPrintTemplateTree() { return PrintTemplateTree; }
468246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu
469246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu  /// \brief Set color printing, so the type diffing will inject color markers
470246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu  /// into the output.
471246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu  void setShowColors(bool Val = false) { ShowColors = Val; }
472246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu  bool getShowColors() { return ShowColors; }
473246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu
4745edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin  /// \brief Specify which overload candidates to show when overload resolution
475af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// fails.
476af50aab0c317462129d73ae8000c6394c718598dJames Dennett  ///
477af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// By default, we show all candidates.
4785edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin  void setShowOverloads(OverloadsShown Val) {
4795edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin    ShowOverloads = Val;
4805edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin  }
4815edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin  OverloadsShown getShowOverloads() const { return ShowOverloads; }
4825edbdcc62098e305cd55654814dcf783a3f3c477Jeffrey Yasskin
483af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief Pretend that the last diagnostic issued was ignored.
484af50aab0c317462129d73ae8000c6394c718598dJames Dennett  ///
485af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// This can be used by clients who suppress diagnostics themselves.
4860b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor  void setLastDiagnosticIgnored() {
48733e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis    LastDiagLevel = DiagnosticIDs::Ignored;
4880b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor  }
4890b60d9e0097e2d6a1a5e62396967e207c4a772f2Douglas Gregor
490af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief Controls whether otherwise-unmapped extension diagnostics are
491af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// mapped onto ignore/warning/error.
492af50aab0c317462129d73ae8000c6394c718598dJames Dennett  ///
493af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// This corresponds to the GCC -pedantic and -pedantic-errors option.
494b54b276a920246c595a0498da281821eb9d22996Chris Lattner  void setExtensionHandlingBehavior(ExtensionHandling H) {
495b54b276a920246c595a0498da281821eb9d22996Chris Lattner    ExtBehavior = H;
496b54b276a920246c595a0498da281821eb9d22996Chris Lattner  }
497c1b5fa41f09512c74030b9a2a0d1564535e22a76Peter Collingbourne  ExtensionHandling getExtensionHandlingBehavior() const { return ExtBehavior; }
4981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
499af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief Counter bumped when an __extension__  block is/ encountered.
500af50aab0c317462129d73ae8000c6394c718598dJames Dennett  ///
501af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// When non-zero, all extension diagnostics are entirely silenced, no
502af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// matter how they are mapped.
50327ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner  void IncrementAllExtensionsSilenced() { ++AllExtensionsSilenced; }
50427ceb9d77d929f02a8a811d189a96885629c7c0cChris Lattner  void DecrementAllExtensionsSilenced() { --AllExtensionsSilenced; }
50591a2886d558ea6ca7a0bed73ab5acea5ae78eac2Douglas Gregor  bool hasAllExtensionsSilenced() { return AllExtensionsSilenced != 0; }
5061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
507697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// \brief This allows the client to specify that certain warnings are
508697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// ignored.
509697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  ///
510697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// Notes can never be mapped, errors can only be mapped to fatal, and
511697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// WARNINGs and EXTENSIONs can be mapped arbitrarily.
5120827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis  ///
5130827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis  /// \param Loc The source location that this change of diagnostic state should
5140827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis  /// take affect. It can be null if we are setting the latest state.
5150827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis  void setDiagnosticMapping(diag::kind Diag, diag::Mapping Map,
5160827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis                            SourceLocation Loc);
5171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
518697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// \brief Change an entire diagnostic group (e.g. "unknown-pragmas") to
519697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// have the specified mapping.
520697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  ///
521697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// \returns true (and ignores the request) if "Group" was unknown, false
522697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// otherwise.
5230827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis  ///
524697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// \param Loc The source location that this change of diagnostic state should
5250827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis  /// take affect. It can be null if we are setting the state from command-line.
526686775deca8b8685eb90801495880e3abdd844c2Chris Lattner  bool setDiagnosticGroupMapping(StringRef Group, diag::Mapping Map,
5273f8394669673451061f57ced81f0a2cae087f119Daniel Dunbar                                 SourceLocation Loc = SourceLocation());
5285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
529697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// \brief Set the warning-as-error flag for the given diagnostic.
530697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  ///
531697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// This function always only operates on the current diagnostic state.
5323f22509ebf91aa96658ca6e5c5c0b926d8d62e34Chad Rosier  void setDiagnosticWarningAsError(diag::kind Diag, bool Enabled);
5333f22509ebf91aa96658ca6e5c5c0b926d8d62e34Chad Rosier
534697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// \brief Set the warning-as-error flag for the given diagnostic group.
535697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  ///
536697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// This function always only operates on the current diagnostic state.
5374aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar  ///
5384aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar  /// \returns True if the given group is unknown, false otherwise.
5394aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar  bool setDiagnosticGroupWarningAsError(StringRef Group, bool Enabled);
5404aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar
541697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// \brief Set the error-as-fatal flag for the given diagnostic.
542697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  ///
543697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// This function always only operates on the current diagnostic state.
5443f22509ebf91aa96658ca6e5c5c0b926d8d62e34Chad Rosier  void setDiagnosticErrorAsFatal(diag::kind Diag, bool Enabled);
5453f22509ebf91aa96658ca6e5c5c0b926d8d62e34Chad Rosier
546697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// \brief Set the error-as-fatal flag for the given diagnostic group.
547697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  ///
548697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// This function always only operates on the current diagnostic state.
5494aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar  ///
5504aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar  /// \returns True if the given group is unknown, false otherwise.
5514aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar  bool setDiagnosticGroupErrorAsFatal(StringRef Group, bool Enabled);
5524aa8f2bce0f498152d624f748712a991adc23fddDaniel Dunbar
553697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// \brief Add the specified mapping to all diagnostics.
554697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  ///
555697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// Mainly to be used by -Wno-everything to disable all warnings but allow
556697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// subsequent -W options to enable specific warnings.
55782e6411d004064a29f03a3ea8b8919f297bfa843Argyrios Kyrtzidis  void setMappingToAllDiagnostics(diag::Mapping Map,
55811583c757bac6ce5c342f2eb572055dd2619a657Argyrios Kyrtzidis                                  SourceLocation Loc = SourceLocation());
55911583c757bac6ce5c342f2eb572055dd2619a657Argyrios Kyrtzidis
5605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  bool hasErrorOccurred() const { return ErrorOccurred; }
56115221422eda7bac679e38b07512feda49715ef66Chris Lattner  bool hasFatalErrorOccurred() const { return FatalErrorOccurred; }
56285bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor
56385bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor  /// \brief Determine whether any kind of unrecoverable error has occurred.
56485bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor  bool hasUnrecoverableErrorOccurred() const {
56585bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor    return FatalErrorOccurred || UnrecoverableErrorOccurred;
56685bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor  }
56785bea9777d444ccbcc086d98f075fe666c2e865dDouglas Gregor
56853eee7ba970d21ff15bbd4334164037a3b4cc4b8Chris Lattner  unsigned getNumWarnings() const { return NumWarnings; }
5691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
570c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor  void setNumWarnings(unsigned NumWarnings) {
571c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor    this->NumWarnings = NumWarnings;
572c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor  }
573c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor
574697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// \brief Return an ID for a diagnostic with the specified message and level.
575697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  ///
576697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// If this is the first request for this diagnosic, it is registered and
577697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// created, otherwise the existing ID is returned.
578686775deca8b8685eb90801495880e3abdd844c2Chris Lattner  unsigned getCustomDiagID(Level L, StringRef Message) {
57933e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis    return Diags->getCustomDiagID((DiagnosticIDs::Level)L, Message);
58033e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis  }
5811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
582697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// \brief Converts a diagnostic argument (as an intptr_t) into the string
583697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// that represents it.
5843fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner  void ConvertArgToString(ArgumentKind Kind, intptr_t Val,
5853fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner                          const char *Modifier, unsigned ModLen,
5863fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner                          const char *Argument, unsigned ArgLen,
587b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner                          const ArgumentValue *PrevArgs, unsigned NumPrevArgs,
588686775deca8b8685eb90801495880e3abdd844c2Chris Lattner                          SmallVectorImpl<char> &Output,
589686775deca8b8685eb90801495880e3abdd844c2Chris Lattner                          SmallVectorImpl<intptr_t> &QualTypeVals) const {
590b54d8af9a66cc20a6a9a9219c7eaea8df7ee7fd4Chris Lattner    ArgToStringFn(Kind, Val, Modifier, ModLen, Argument, ArgLen,
5910673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth                  PrevArgs, NumPrevArgs, Output, ArgToStringCookie,
5920673cb30340aadaede7b795c763b00f6b64e611cChandler Carruth                  QualTypeVals);
59322caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner  }
5941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
59592dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner  void SetArgToStringFn(ArgToStringFnTy Fn, void *Cookie) {
5963fdf4b071dc79fae778fb5f376485480756c76a3Chris Lattner    ArgToStringFn = Fn;
59792dd386e3f05d176b45a638199d51f536bd9d1c4Chris Lattner    ArgToStringCookie = Cookie;
59822caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner  }
5991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
600abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor  /// \brief Reset the state of the diagnostic object to its initial
601abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor  /// configuration.
602abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor  void Reset();
603abc563f554951259bbe0315055cad92ee14d87e4Douglas Gregor
6045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  //===--------------------------------------------------------------------===//
605d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie  // DiagnosticsEngine classification and reporting interfaces.
6065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  //
6075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
608d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie  /// \brief Based on the way the client configured the DiagnosticsEngine
6095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// object, classify the specified diagnostic ID into a Level, consumable by
61078ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie  /// the DiagnosticConsumer.
6110827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis  ///
6120827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis  /// \param Loc The source location we are interested in finding out the
6130827408865e32789e0ec4b8113a302ccdc531423Argyrios Kyrtzidis  /// diagnostic state. Can be null in order to query the latest state.
6141656aaec223949245fdbebf306b719cba0b687caDaniel Dunbar  Level getDiagnosticLevel(unsigned DiagID, SourceLocation Loc) const {
6151656aaec223949245fdbebf306b719cba0b687caDaniel Dunbar    return (Level)Diags->getDiagnosticLevel(DiagID, Loc, *this);
61633e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis  }
6171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
618697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// \brief Issue the message to the client.
619697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  ///
620697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// This actually returns an instance of DiagnosticBuilder which emits the
621697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// diagnostics (through @c ProcessDiag) when it is destroyed.
622697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  ///
623697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// \param DiagID A member of the @c diag::kind enum.
624efce31f51d6e7e31e125f96c20f6cdab3ead0a47James Dennett  /// \param Loc Represents the source location associated with the diagnostic,
625509355e982d15da4f8f3939493516379665f6275Ted Kremenek  /// which can be an invalid location if no position information is available.
626efce31f51d6e7e31e125f96c20f6cdab3ead0a47James Dennett  inline DiagnosticBuilder Report(SourceLocation Loc, unsigned DiagID);
6270f9fed70cea107b3f79df554e38bd8e98d48fe47Daniel Dunbar  inline DiagnosticBuilder Report(unsigned DiagID);
628de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor
629e59abb56ce0e1c206fb80bd945a0c358b0abe1efArgyrios Kyrtzidis  void Report(const StoredDiagnostic &storedDiag);
630e59abb56ce0e1c206fb80bd945a0c358b0abe1efArgyrios Kyrtzidis
63193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor  /// \brief Determine whethere there is already a diagnostic in flight.
6325800f7ea9cf5621280089d690f677bd28064d6b5Ted Kremenek  bool isDiagnosticInFlight() const { return CurDiagID != ~0U; }
63393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor
63493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor  /// \brief Set the "delayed" diagnostic that will be emitted once
63593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor  /// the current diagnostic completes.
63693ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor  ///
63793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor  ///  If a diagnostic is already in-flight but the front end must
63893ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor  ///  report a problem (e.g., with an inconsistent file system
63993ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor  ///  state), this routine sets a "delayed" diagnostic that will be
64093ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor  ///  emitted after the current diagnostic completes. This should
64193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor  ///  only be used for fatal errors detected at inconvenient
64293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor  ///  times. If emitting a delayed diagnostic causes a second delayed
64393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor  ///  diagnostic to be introduced, that second delayed diagnostic
64493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor  ///  will be ignored.
64593ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor  ///
64693ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor  /// \param DiagID The ID of the diagnostic being delayed.
64793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor  ///
64893ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor  /// \param Arg1 A string argument that will be provided to the
64993ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor  /// diagnostic. A copy of this string will be stored in the
650d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie  /// DiagnosticsEngine object itself.
65193ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor  ///
65293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor  /// \param Arg2 A string argument that will be provided to the
65393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor  /// diagnostic. A copy of this string will be stored in the
654d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie  /// DiagnosticsEngine object itself.
655686775deca8b8685eb90801495880e3abdd844c2Chris Lattner  void SetDelayedDiagnostic(unsigned DiagID, StringRef Arg1 = "",
656686775deca8b8685eb90801495880e3abdd844c2Chris Lattner                            StringRef Arg2 = "");
65793ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor
658de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor  /// \brief Clear out the current diagnostic.
659de4bf6a63219c5b9d3bce1fed3dfe075568098a0Douglas Gregor  void Clear() { CurDiagID = ~0U; }
6601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
6610a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattnerprivate:
66293ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor  /// \brief Report the delayed diagnostic.
66393ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor  void ReportDelayed();
66493ea5cb0edf8e509c5113e70cb05ee247c9bdf6bDouglas Gregor
6653cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner  // This is private state used by DiagnosticBuilder.  We put it here instead of
6663cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner  // in DiagnosticBuilder in order to keep DiagnosticBuilder a small lightweight
6670a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner  // object.  This implementation choice means that we can only have one
6680a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner  // diagnostic "in flight" at a time, but this seems to be a reasonable
6690a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner  // tradeoff to keep these objects small.  Assertions verify that only one
6700a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner  // diagnostic is in flight at a time.
67133e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis  friend class DiagnosticIDs;
6723cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner  friend class DiagnosticBuilder;
67340847cfb58acc3cac7d68727df9455ac45f2e118David Blaikie  friend class Diagnostic;
6749b623639378d53a675921ddfa7316034d571881eDouglas Gregor  friend class PartialDiagnostic;
6759c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis  friend class DiagnosticErrorTrap;
6769b623639378d53a675921ddfa7316034d571881eDouglas Gregor
677697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// \brief The location of the current diagnostic that is in flight.
67833e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis  SourceLocation CurDiagLoc;
6791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
680697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// \brief The ID of the current diagnostic that is in flight.
681697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  ///
6823cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner  /// This is set to ~0U when there is no diagnostic in flight.
683b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner  unsigned CurDiagID;
684b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner
68573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner  enum {
686697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett    /// \brief The maximum number of arguments we can hold.
687697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett    ///
688af50aab0c317462129d73ae8000c6394c718598dJames Dennett    /// We currently only support up to 10 arguments (%0-%9).  A single
689af50aab0c317462129d73ae8000c6394c718598dJames Dennett    /// diagnostic with more than that almost certainly has to be simplified
690af50aab0c317462129d73ae8000c6394c718598dJames Dennett    /// anyway.
691981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar    MaxArguments = 10,
692981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar
693697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett    /// \brief The maximum number of ranges we can hold.
694981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar    MaxRanges = 10,
695981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar
696697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett    /// \brief The maximum number of ranges we can hold.
697981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar    MaxFixItHints = 10
69873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner  };
6991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
700697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// \brief The number of entries in Arguments.
701730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner  signed char NumDiagArgs;
702697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// \brief The number of ranges in the DiagRanges array.
703730e0fdbbf9b315ef834074054ac55af3a4fcc0cChris Lattner  unsigned char NumDiagRanges;
704697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// \brief The number of hints in the DiagFixItHints array.
705981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar  unsigned char NumDiagFixItHints;
706ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor
707af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief Specifies whether an argument is in DiagArgumentsStr or
708af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// in DiagArguments.
709af50aab0c317462129d73ae8000c6394c718598dJames Dennett  ///
710af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// This is an array of ArgumentKind::ArgumentKind enum values, one for each
711af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// argument.
71273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner  unsigned char DiagArgumentsKind[MaxArguments];
7131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
714af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief Holds the values of each string argument for the current
715697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// diagnostic.
716697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  ///
717697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// This is only used when the corresponding ArgumentKind is ak_std_string.
71873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner  std::string DiagArgumentsStr[MaxArguments];
71973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner
720697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// \brief The values for the various substitution positions.
721697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  ///
722697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// This is used when the argument is not an std::string.  The specific
723697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// value is mangled into an intptr_t and the interpretation depends on
724697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// exactly what sort of argument kind it is.
72573d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner  intptr_t DiagArgumentsVal[MaxArguments];
7261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
727697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// \brief The list of ranges added to this diagnostic.
728981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar  CharSourceRange DiagRanges[MaxRanges];
7291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
730697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// \brief If valid, provides a hint with some code to insert, remove,
731981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar  /// or modify at a particular position.
732981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar  FixItHint DiagFixItHints[MaxFixItHints];
7334b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor
73487429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis  DiagnosticMappingInfo makeMappingInfo(diag::Mapping Map, SourceLocation L) {
73587429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis    bool isPragma = L.isValid();
73687429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis    DiagnosticMappingInfo MappingInfo = DiagnosticMappingInfo::Make(
73787429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis      Map, /*IsUser=*/true, isPragma);
73887429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis
73987429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis    // If this is a pragma mapping, then set the diagnostic mapping flags so
74087429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis    // that we override command line options.
74187429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis    if (isPragma) {
74287429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis      MappingInfo.setNoWarningAsError(true);
74387429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis      MappingInfo.setNoErrorAsFatal(true);
74487429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis    }
74587429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis
74687429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis    return MappingInfo;
74787429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis  }
74887429a05ff66fe6460eaa4855fd0da574e26bf7bArgyrios Kyrtzidis
749697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// \brief Used to report a diagnostic that is finally fully formed.
7505e9f35c7cb61aea46f56d46c77cbcf47c0cf28baDouglas Gregor  ///
751697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// \returns true if the diagnostic was emitted, false if it was suppressed.
75233e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis  bool ProcessDiag() {
75333e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis    return Diags->ProcessDiag(*this);
75433e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis  }
755f41d3be39980d40849850d3fb90403623cc8459eArgyrios Kyrtzidis
756393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar  /// @name Diagnostic Emission
757393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar  /// @{
758393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbarprotected:
759393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar  // Sema requires access to the following functions because the current design
760393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar  // of SFINAE requires it to use its own SemaDiagnosticBuilder, which needs to
761393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar  // access us directly to ensure we minimize the emitted code for the common
762393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar  // Sema::Diag() patterns.
763393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar  friend class Sema;
764393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar
7653054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar  /// \brief Emit the current diagnostic and clear the diagnostic state.
7663054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar  bool EmitCurrentDiagnostic();
7673054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar
768393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar  unsigned getCurrentDiagID() const { return CurDiagID; }
769393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar
770393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar  SourceLocation getCurrentDiagLoc() const { return CurDiagLoc; }
771393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar
772393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar  /// @}
773393eed7fb901e49085c8583ff0439d1273b6f2feDaniel Dunbar
774f41d3be39980d40849850d3fb90403623cc8459eArgyrios Kyrtzidis  friend class ASTReader;
775f41d3be39980d40849850d3fb90403623cc8459eArgyrios Kyrtzidis  friend class ASTWriter;
7763cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner};
7773cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner
7789c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis/// \brief RAII class that determines when any errors have occurred
7799c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis/// between the time the instance was created and the time it was
7809c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis/// queried.
7819c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidisclass DiagnosticErrorTrap {
782d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie  DiagnosticsEngine &Diag;
783c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis  unsigned NumErrors;
784c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis  unsigned NumUnrecoverableErrors;
7859c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis
7869c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidispublic:
787d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie  explicit DiagnosticErrorTrap(DiagnosticsEngine &Diag)
788add80bb3957dba1d9389304453c0a4c975768bd7John McCall    : Diag(Diag) { reset(); }
7899c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis
7909c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis  /// \brief Determine whether any errors have occurred since this
7919c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis  /// object instance was created.
7929c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis  bool hasErrorOccurred() const {
793c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis    return Diag.TrapNumErrorsOccurred > NumErrors;
794add80bb3957dba1d9389304453c0a4c975768bd7John McCall  }
795add80bb3957dba1d9389304453c0a4c975768bd7John McCall
796add80bb3957dba1d9389304453c0a4c975768bd7John McCall  /// \brief Determine whether any unrecoverable errors have occurred since this
797add80bb3957dba1d9389304453c0a4c975768bd7John McCall  /// object instance was created.
798add80bb3957dba1d9389304453c0a4c975768bd7John McCall  bool hasUnrecoverableErrorOccurred() const {
799c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis    return Diag.TrapNumUnrecoverableErrorsOccurred > NumUnrecoverableErrors;
8009c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis  }
8019c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis
802af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief Set to initial state of "no errors occurred".
803add80bb3957dba1d9389304453c0a4c975768bd7John McCall  void reset() {
804c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis    NumErrors = Diag.TrapNumErrorsOccurred;
805c0a575f9b791a25c94b1c3c832dd73ec564646bbArgyrios Kyrtzidis    NumUnrecoverableErrors = Diag.TrapNumUnrecoverableErrorsOccurred;
806add80bb3957dba1d9389304453c0a4c975768bd7John McCall  }
8079c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis};
8089c4eb1f3438370355f51dc8c62f2ca4803e3338dArgyrios Kyrtzidis
8093cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===//
8103cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner// DiagnosticBuilder
8113cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===//
8123cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner
813697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// \brief A little helper class used to produce diagnostics.
814697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett///
815697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// This is constructed by the DiagnosticsEngine::Report method, and
816697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// allows insertion of extra information (arguments and source ranges) into
817697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// the currently "in flight" diagnostic.  When the temporary for the builder
818697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// is destroyed, the diagnostic is issued.
8193cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner///
8203cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// Note that many of these will be created as temporary objects (many call
8213cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// sites), so we want them to be small and we never want their address taken.
8223cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// This ensures that compilers with somewhat reasonable optimizers will promote
8233cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// the common fields to registers, eliminating increments of the NumArgs field,
8243cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner/// for example.
8253cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerclass DiagnosticBuilder {
826d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie  mutable DiagnosticsEngine *DiagObj;
827981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar  mutable unsigned NumArgs, NumRanges, NumFixits;
8281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
8297059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar  /// \brief Status variable indicating if this diagnostic is still active.
8307059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar  ///
8317059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar  // NOTE: This field is redundant with DiagObj (IsActive iff (DiagObj == 0)),
8327059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar  // but LLVM is not currently smart enough to eliminate the null check that
8337059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar  // Emit() would end up with if we used that as our status variable.
8347059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar  mutable bool IsActive;
8357059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar
8363cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner  void operator=(const DiagnosticBuilder&); // DO NOT IMPLEMENT
837d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie  friend class DiagnosticsEngine;
838ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor
839ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor  DiagnosticBuilder()
840ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor    : DiagObj(0), NumArgs(0), NumRanges(0), NumFixits(0), IsActive(false) { }
841ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor
842d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie  explicit DiagnosticBuilder(DiagnosticsEngine *diagObj)
8437059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar    : DiagObj(diagObj), NumArgs(0), NumRanges(0), NumFixits(0), IsActive(true) {
844981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar    assert(diagObj && "DiagnosticBuilder requires a valid DiagnosticsEngine!");
845cbf46a0b2bb2b47d6e13437e0d52cc583c5ce539Argyrios Kyrtzidis  }
846ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor
8479b623639378d53a675921ddfa7316034d571881eDouglas Gregor  friend class PartialDiagnostic;
848ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor
849b535041ee33c5eff255832bc5541c8d52aae8254Douglas Gregorprotected:
8503054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar  void FlushCounts() {
8513054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar    DiagObj->NumDiagArgs = NumArgs;
8523054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar    DiagObj->NumDiagRanges = NumRanges;
8533054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar    DiagObj->NumDiagFixItHints = NumFixits;
8543054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar  }
85506265bd82073c06294a02a0bd891951fafb484a5Daniel Dunbar
856cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar  /// \brief Clear out the current diagnostic.
8577059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar  void Clear() const {
8587059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar    DiagObj = 0;
8597059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar    IsActive = false;
8607059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar  }
861cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar
862697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// \brief Determine whether this diagnostic is still active.
8637059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar  bool isActive() const { return IsActive; }
86406265bd82073c06294a02a0bd891951fafb484a5Daniel Dunbar
865cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar  /// \brief Force the diagnostic builder to emit the diagnostic now.
866cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar  ///
867cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar  /// Once this function has been called, the DiagnosticBuilder object
868cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar  /// should not be used again before it is destroyed.
869cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar  ///
870cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar  /// \returns true if a diagnostic was emitted, false if the
871cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar  /// diagnostic was suppressed.
8723054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar  bool Emit() {
8737059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar    // If this diagnostic is inactive, then its soul was stolen by the copy ctor
8747059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar    // (or by a subclass, as in SemaDiagnosticBuilder).
8757059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar    if (!isActive()) return false;
8763054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar
8773054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar    // When emitting diagnostics, we set the final argument count into
8783054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar    // the DiagnosticsEngine object.
8793054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar    FlushCounts();
8803054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar
8813054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar    // Process the diagnostic.
8823054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar    bool Result = DiagObj->EmitCurrentDiagnostic();
8833054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar
8843054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar    // This diagnostic is dead.
8857059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar    Clear();
8863054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar
8873054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar    return Result;
8883054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar  }
8899b623639378d53a675921ddfa7316034d571881eDouglas Gregor
8901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumppublic:
8910a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner  /// Copy constructor.  When copied, this "takes" the diagnostic info from the
8920a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner  /// input and neuters it.
8933cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner  DiagnosticBuilder(const DiagnosticBuilder &D) {
8940a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner    DiagObj = D.DiagObj;
8957059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar    IsActive = D.IsActive;
8967059a1cbc29444bec19380059a62db085eb92964Daniel Dunbar    D.Clear();
89725a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor    NumArgs = D.NumArgs;
89825a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor    NumRanges = D.NumRanges;
899981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar    NumFixits = D.NumFixits;
9000a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner  }
90125a88bbf042317976f0d9cbfa87dfe89426e8393Douglas Gregor
902ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor  /// \brief Retrieve an empty diagnostic builder.
903ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor  static DiagnosticBuilder getEmpty() {
904ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor    return DiagnosticBuilder();
905ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor  }
906ab41fe914f63bb470dfa7e400876ada72f57a931Douglas Gregor
907697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett  /// \brief Emits the diagnostic.
90853c83b32550b3f29db2419160fa2e3684e420556Daniel Dunbar  ~DiagnosticBuilder() {
9093054f097f813d19090bdb23645dcd48df71d1a89Daniel Dunbar    Emit();
91053c83b32550b3f29db2419160fa2e3684e420556Daniel Dunbar  }
9119b623639378d53a675921ddfa7316034d571881eDouglas Gregor
912af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief Conversion of DiagnosticBuilder to bool always returns \c true.
913af50aab0c317462129d73ae8000c6394c718598dJames Dennett  ///
914af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// This allows is to be used in boolean error contexts (where \c true is
915af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// used to indicate that an error has occurred), like:
916af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \code
9173cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner  /// return Diag(...);
918af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \endcode
9193cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner  operator bool() const { return true; }
9203cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner
921686775deca8b8685eb90801495880e3abdd844c2Chris Lattner  void AddString(StringRef S) const {
922cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar    assert(isActive() && "Clients must not add to cleared diagnostic!");
923d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie    assert(NumArgs < DiagnosticsEngine::MaxArguments &&
9243cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner           "Too many arguments to diagnostic!");
925cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar    DiagObj->DiagArgumentsKind[NumArgs] = DiagnosticsEngine::ak_std_string;
926cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar    DiagObj->DiagArgumentsStr[NumArgs++] = S;
9273cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner  }
9281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
929d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie  void AddTaggedVal(intptr_t V, DiagnosticsEngine::ArgumentKind Kind) const {
930cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar    assert(isActive() && "Clients must not add to cleared diagnostic!");
931d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie    assert(NumArgs < DiagnosticsEngine::MaxArguments &&
9323cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner           "Too many arguments to diagnostic!");
933cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar    DiagObj->DiagArgumentsKind[NumArgs] = Kind;
934cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar    DiagObj->DiagArgumentsVal[NumArgs++] = V;
9350a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner  }
9361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
9370a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner  void AddSourceRange(const CharSourceRange &R) const {
938cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar    assert(isActive() && "Clients must not add to cleared diagnostic!");
939981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar    assert(NumRanges < DiagnosticsEngine::MaxRanges &&
9403cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner           "Too many arguments to diagnostic!");
941cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar    DiagObj->DiagRanges[NumRanges++] = R;
9421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump  }
9434b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor
944849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor  void AddFixItHint(const FixItHint &Hint) const {
945cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar    assert(isActive() && "Clients must not add to cleared diagnostic!");
946981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar    assert(NumFixits < DiagnosticsEngine::MaxFixItHints &&
947981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar           "Too many arguments to diagnostic!");
948cefcbef6f3b1e34f31ce0e47214c8b90fedfb9acDaniel Dunbar    DiagObj->DiagFixItHints[NumFixits++] = Hint;
9494b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor  }
9503cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner};
9513cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner
9523cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
953686775deca8b8685eb90801495880e3abdd844c2Chris Lattner                                           StringRef S) {
9543cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner  DB.AddString(S);
9553cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner  return DB;
9563cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}
9573cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner
9583cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
9593cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner                                           const char *Str) {
9603cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner  DB.AddTaggedVal(reinterpret_cast<intptr_t>(Str),
961d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie                  DiagnosticsEngine::ak_c_string);
9623cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner  return DB;
9633cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}
9643cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner
9653cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB, int I) {
966d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie  DB.AddTaggedVal(I, DiagnosticsEngine::ak_sint);
9673cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner  return DB;
9683cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}
9693cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner
9703bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidisinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,bool I) {
971d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie  DB.AddTaggedVal(I, DiagnosticsEngine::ak_sint);
9723bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis  return DB;
9733bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis}
9743bf4a79712fb30dc27692ef2d4214ee7fa6681beArgyrios Kyrtzidis
9753cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
9763cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner                                           unsigned I) {
977d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie  DB.AddTaggedVal(I, DiagnosticsEngine::ak_uint);
9783cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner  return DB;
9793cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}
9803cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner
9813cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
9823cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner                                           const IdentifierInfo *II) {
9833cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner  DB.AddTaggedVal(reinterpret_cast<intptr_t>(II),
984d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie                  DiagnosticsEngine::ak_identifierinfo);
9853cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner  return DB;
9863cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}
9871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
9883f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// Adds a DeclContext to the diagnostic. The enable_if template magic is here
9893f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// so that we only match those arguments that are (statically) DeclContexts;
9903f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// other arguments that derive from DeclContext (e.g., RecordDecls) will not
9913f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor// match.
9923f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregortemplate<typename T>
9933f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregorinline
9943f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregortypename llvm::enable_if<llvm::is_same<T, DeclContext>,
9953f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor                         const DiagnosticBuilder &>::type
9963f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregoroperator<<(const DiagnosticBuilder &DB, T *DC) {
9973f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor  DB.AddTaggedVal(reinterpret_cast<intptr_t>(DC),
998d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie                  DiagnosticsEngine::ak_declcontext);
9993f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor  return DB;
10003f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor}
10013f09327b26033d0a9676d52d80cf92c48f581affDouglas Gregor
10023cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
10033cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner                                           const SourceRange &R) {
10040a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner  DB.AddSourceRange(CharSourceRange::getTokenRange(R));
10053cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner  return DB;
10063cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}
10074b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor
10084b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregorinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
10090a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner                                           const CharSourceRange &R) {
10100a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner  DB.AddSourceRange(R);
10110a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner  return DB;
10120a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner}
10130a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner
10140a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattnerinline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
1015849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor                                           const FixItHint &Hint) {
10163739b32a01b9778176757425e62252c288b85383Ted Kremenek  if (!Hint.isNull())
10173739b32a01b9778176757425e62252c288b85383Ted Kremenek    DB.AddFixItHint(Hint);
10184b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor  return DB;
10194b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor}
1020ee1828a6b5ae1bc4ea300e48f3840ac1ec5be295Douglas Gregor
1021d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikieinline DiagnosticBuilder DiagnosticsEngine::Report(SourceLocation Loc,
102233e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis                                            unsigned DiagID){
10233cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner  assert(CurDiagID == ~0U && "Multiple diagnostics in flight at once!");
10243cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner  CurDiagLoc = Loc;
10253cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner  CurDiagID = DiagID;
10263cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner  return DiagnosticBuilder(this);
10273cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner}
1028d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikieinline DiagnosticBuilder DiagnosticsEngine::Report(unsigned DiagID) {
102933e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis  return Report(SourceLocation(), DiagID);
10300f9fed70cea107b3f79df554e38bd8e98d48fe47Daniel Dunbar}
10313cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner
10323cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===//
103340847cfb58acc3cac7d68727df9455ac45f2e118David Blaikie// Diagnostic
10343cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner//===----------------------------------------------------------------------===//
10351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
1036697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// A little helper class (which is basically a smart pointer that forwards
1037697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// info from DiagnosticsEngine) that allows clients to enquire about the
1038697c7a8af6d090bff2b572553da0957de1724e1eJames Dennett/// currently in-flight diagnostic.
103940847cfb58acc3cac7d68727df9455ac45f2e118David Blaikieclass Diagnostic {
1040d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie  const DiagnosticsEngine *DiagObj;
1041686775deca8b8685eb90801495880e3abdd844c2Chris Lattner  StringRef StoredDiagMessage;
10423cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattnerpublic:
104340847cfb58acc3cac7d68727df9455ac45f2e118David Blaikie  explicit Diagnostic(const DiagnosticsEngine *DO) : DiagObj(DO) {}
104440847cfb58acc3cac7d68727df9455ac45f2e118David Blaikie  Diagnostic(const DiagnosticsEngine *DO, StringRef storedDiagMessage)
1045e59abb56ce0e1c206fb80bd945a0c358b0abe1efArgyrios Kyrtzidis    : DiagObj(DO), StoredDiagMessage(storedDiagMessage) {}
10461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
1047d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie  const DiagnosticsEngine *getDiags() const { return DiagObj; }
1048b7fc3b87d065041a10eaa0603d738df21ff7af3aChris Lattner  unsigned getID() const { return DiagObj->CurDiagID; }
104933e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis  const SourceLocation &getLocation() const { return DiagObj->CurDiagLoc; }
105033e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis  bool hasSourceManager() const { return DiagObj->hasSourceManager(); }
105133e4e70c8c0a17e0ccb7465d96556b077a68ecb1Argyrios Kyrtzidis  SourceManager &getSourceManager() const { return DiagObj->getSourceManager();}
10521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
10530a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner  unsigned getNumArgs() const { return DiagObj->NumDiagArgs; }
10541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
1055af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief Return the kind of the specified index.
1056af50aab0c317462129d73ae8000c6394c718598dJames Dennett  ///
1057af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// Based on the kind of argument, the accessors below can be used to get
1058af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// the value.
1059af50aab0c317462129d73ae8000c6394c718598dJames Dennett  ///
1060af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \pre Idx < getNumArgs()
1061d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie  DiagnosticsEngine::ArgumentKind getArgKind(unsigned Idx) const {
10623cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner    assert(Idx < getNumArgs() && "Argument index out of range!");
1063d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie    return (DiagnosticsEngine::ArgumentKind)DiagObj->DiagArgumentsKind[Idx];
106473d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner  }
10651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
1066af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief Return the provided argument string specified by \p Idx.
1067af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_std_string
106873d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner  const std::string &getArgStdStr(unsigned Idx) const {
1069d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie    assert(getArgKind(Idx) == DiagnosticsEngine::ak_std_string &&
10703cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner           "invalid argument accessor!");
107173d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner    return DiagObj->DiagArgumentsStr[Idx];
107273d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner  }
10731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
1074af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief Return the specified C string argument.
1075af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_c_string
107673d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner  const char *getArgCStr(unsigned Idx) const {
1077d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie    assert(getArgKind(Idx) == DiagnosticsEngine::ak_c_string &&
10783cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner           "invalid argument accessor!");
107973d2a1b05bb04ab0136af374ddaa5d4602d4c939Chris Lattner    return reinterpret_cast<const char*>(DiagObj->DiagArgumentsVal[Idx]);
10800a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner  }
10811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
1082af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief Return the specified signed integer argument.
1083af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_sint
108430bc96544346bea42921cf6837e66cef80d664b4Chris Lattner  int getArgSInt(unsigned Idx) const {
1085d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie    assert(getArgKind(Idx) == DiagnosticsEngine::ak_sint &&
10863cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner           "invalid argument accessor!");
108730bc96544346bea42921cf6837e66cef80d664b4Chris Lattner    return (int)DiagObj->DiagArgumentsVal[Idx];
108830bc96544346bea42921cf6837e66cef80d664b4Chris Lattner  }
10891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
1090af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief Return the specified unsigned integer argument.
1091af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_uint
109230bc96544346bea42921cf6837e66cef80d664b4Chris Lattner  unsigned getArgUInt(unsigned Idx) const {
1093d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie    assert(getArgKind(Idx) == DiagnosticsEngine::ak_uint &&
10943cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner           "invalid argument accessor!");
109530bc96544346bea42921cf6837e66cef80d664b4Chris Lattner    return (unsigned)DiagObj->DiagArgumentsVal[Idx];
109630bc96544346bea42921cf6837e66cef80d664b4Chris Lattner  }
10971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
1098af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief Return the specified IdentifierInfo argument.
1099af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \pre getArgKind(Idx) == DiagnosticsEngine::ak_identifierinfo
110043b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner  const IdentifierInfo *getArgIdentifier(unsigned Idx) const {
1101d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie    assert(getArgKind(Idx) == DiagnosticsEngine::ak_identifierinfo &&
11023cbfe2c4159e0a219ae660d50625c013aa4afbd0Chris Lattner           "invalid argument accessor!");
11039634379265855f1628190e926d9aaf1fb4a5d90eChris Lattner    return reinterpret_cast<IdentifierInfo*>(DiagObj->DiagArgumentsVal[Idx]);
110443b628cd47ecdc3caf640d79b3ad7ecef0f2c285Chris Lattner  }
11051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
1106af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief Return the specified non-string argument in an opaque form.
1107af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \pre getArgKind(Idx) != DiagnosticsEngine::ak_std_string
110822caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner  intptr_t getRawArg(unsigned Idx) const {
1109d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie    assert(getArgKind(Idx) != DiagnosticsEngine::ak_std_string &&
111022caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner           "invalid argument accessor!");
111122caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner    return DiagObj->DiagArgumentsVal[Idx];
111222caddc91d2f6186739c6b20ec58ed38cd68e595Chris Lattner  }
11131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
1114af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief Return the number of source ranges associated with this diagnostic.
11150a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner  unsigned getNumRanges() const {
11160a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner    return DiagObj->NumDiagRanges;
11170a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner  }
11181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
1119af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \pre Idx < getNumRanges()
11200a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner  const CharSourceRange &getRange(unsigned Idx) const {
11210a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner    assert(Idx < DiagObj->NumDiagRanges && "Invalid diagnostic range index!");
112251c6d384551674facc19f745ecf6e289d28dc55fDouglas Gregor    return DiagObj->DiagRanges[Idx];
11230a14eee528a901c16f0e288fbc10a3abc1660d87Chris Lattner  }
11241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
112528409289193afca1a3178a9796f8e8aebcb76896Chandler Carruth  /// \brief Return an array reference for this diagnostic's ranges.
112628409289193afca1a3178a9796f8e8aebcb76896Chandler Carruth  ArrayRef<CharSourceRange> getRanges() const {
112728409289193afca1a3178a9796f8e8aebcb76896Chandler Carruth    return llvm::makeArrayRef(DiagObj->DiagRanges, DiagObj->NumDiagRanges);
112828409289193afca1a3178a9796f8e8aebcb76896Chandler Carruth  }
112928409289193afca1a3178a9796f8e8aebcb76896Chandler Carruth
1130849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor  unsigned getNumFixItHints() const {
1131981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar    return DiagObj->NumDiagFixItHints;
11324b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor  }
11334b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor
1134849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor  const FixItHint &getFixItHint(unsigned Idx) const {
1135981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar    assert(Idx < getNumFixItHints() && "Invalid index!");
1136981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar    return DiagObj->DiagFixItHints[Idx];
11374b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor  }
11384b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor
1139849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor  const FixItHint *getFixItHints() const {
1140981e279b95f3a71e2268124b1abaae050ec200dcDaniel Dunbar    return getNumFixItHints()? DiagObj->DiagFixItHints : 0;
11414b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor  }
11424b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor
1143af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief Format this diagnostic into a string, substituting the
1144af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// formal arguments into the %0 slots.
1145af50aab0c317462129d73ae8000c6394c718598dJames Dennett  ///
1146af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// The result is appended onto the \p OutStr array.
1147686775deca8b8685eb90801495880e3abdd844c2Chris Lattner  void FormatDiagnostic(SmallVectorImpl<char> &OutStr) const;
11489f28614bf1a8387000d8df57a713fcf69e198145John McCall
1149af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief Format the given format-string into the output buffer using the
1150af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// arguments stored in this diagnostic.
11519f28614bf1a8387000d8df57a713fcf69e198145John McCall  void FormatDiagnostic(const char *DiagStr, const char *DiagEnd,
1152686775deca8b8685eb90801495880e3abdd844c2Chris Lattner                        SmallVectorImpl<char> &OutStr) const;
1153a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor};
1154a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor
1155a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor/**
1156d3ab63e0f66429abf2a3e4cde889e420e41e8790Douglas Gregor * \brief Represents a diagnostic in a form that can be retained until its
1157d3ab63e0f66429abf2a3e4cde889e420e41e8790Douglas Gregor * corresponding source manager is destroyed.
1158a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor */
1159a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregorclass StoredDiagnostic {
1160aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor  unsigned ID;
1161d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie  DiagnosticsEngine::Level Level;
1162a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor  FullSourceLoc Loc;
1163a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor  std::string Message;
11640a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner  std::vector<CharSourceRange> Ranges;
1165849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor  std::vector<FixItHint> FixIts;
1166a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor
1167a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregorpublic:
1168a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor  StoredDiagnostic();
116940847cfb58acc3cac7d68727df9455ac45f2e118David Blaikie  StoredDiagnostic(DiagnosticsEngine::Level Level, const Diagnostic &Info);
1170d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie  StoredDiagnostic(DiagnosticsEngine::Level Level, unsigned ID,
1171686775deca8b8685eb90801495880e3abdd844c2Chris Lattner                   StringRef Message);
1172d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie  StoredDiagnostic(DiagnosticsEngine::Level Level, unsigned ID,
1173686775deca8b8685eb90801495880e3abdd844c2Chris Lattner                   StringRef Message, FullSourceLoc Loc,
11742d3ba4f5a923a90c3fc290ddfba5e36c2d0a9b46Chris Lattner                   ArrayRef<CharSourceRange> Ranges,
11752d3ba4f5a923a90c3fc290ddfba5e36c2d0a9b46Chris Lattner                   ArrayRef<FixItHint> Fixits);
1176a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor  ~StoredDiagnostic();
1177a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor
1178a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor  /// \brief Evaluates true when this object stores a diagnostic.
1179a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor  operator bool() const { return Message.size() > 0; }
1180a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor
1181aa5f135f8db82b5e5fb1640fd51f8078e0b2d82dDouglas Gregor  unsigned getID() const { return ID; }
1182d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie  DiagnosticsEngine::Level getLevel() const { return Level; }
1183a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor  const FullSourceLoc &getLocation() const { return Loc; }
1184686775deca8b8685eb90801495880e3abdd844c2Chris Lattner  StringRef getMessage() const { return Message; }
1185c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor
1186c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor  void setLocation(FullSourceLoc Loc) { this->Loc = Loc; }
1187c0659ec614c428c7d15746fcad15d50a2703751dDouglas Gregor
11880a76aae8c03cb7dd7bdbe683485560afaf695959Chris Lattner  typedef std::vector<CharSourceRange>::const_iterator range_iterator;
1189a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor  range_iterator range_begin() const { return Ranges.begin(); }
1190a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor  range_iterator range_end() const { return Ranges.end(); }
1191a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor  unsigned range_size() const { return Ranges.size(); }
11926700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek
11936700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek  ArrayRef<CharSourceRange> getRanges() const {
11946700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek    return llvm::makeArrayRef(Ranges);
11956700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek  }
11966700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek
1197a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor
1198849b243d4065f56742a4677d6dc8277609a151f8Douglas Gregor  typedef std::vector<FixItHint>::const_iterator fixit_iterator;
1199a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor  fixit_iterator fixit_begin() const { return FixIts.begin(); }
1200a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor  fixit_iterator fixit_end() const { return FixIts.end(); }
1201a88084b78fd4ca5d3d858c14b02414f8cc399f02Douglas Gregor  unsigned fixit_size() const { return FixIts.size(); }
12026700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek
12036700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek  ArrayRef<FixItHint> getFixIts() const {
12046700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek    return llvm::makeArrayRef(FixIts);
12056700d67925abd674ecddfc56948967f49b25bf39Ted Kremenek  }
12065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer};
12071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
1208af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// \brief Abstract interface, implemented by clients of the front-end, which
1209af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// formats and prints fully processed diagnostics.
121078ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikieclass DiagnosticConsumer {
1211ab41b97c3cddf1bcdd8bf82ab09ed3ceafcd05b1Argyrios Kyrtzidisprotected:
1212af50aab0c317462129d73ae8000c6394c718598dJames Dennett  unsigned NumWarnings;       ///< Number of warnings reported
1213af50aab0c317462129d73ae8000c6394c718598dJames Dennett  unsigned NumErrors;         ///< Number of errors reported
1214f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis
12155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic:
121678ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie  DiagnosticConsumer() : NumWarnings(0), NumErrors(0) { }
1217f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis
1218f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis  unsigned getNumErrors() const { return NumErrors; }
1219f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis  unsigned getNumWarnings() const { return NumWarnings; }
122061d679ab2831b161c857cf3f974312fbd4ef1efdArgyrios Kyrtzidis  virtual void clear() { NumWarnings = NumErrors = 0; }
1221f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis
122278ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie  virtual ~DiagnosticConsumer();
12231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
1224af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief Callback to inform the diagnostic client that processing
1225efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar  /// of a source file is beginning.
1226efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar  ///
1227efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar  /// Note that diagnostics may be emitted outside the processing of a source
1228efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar  /// file, for example during the parsing of command line options. However,
1229efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar  /// diagnostics with source range information are required to only be emitted
1230efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar  /// in between BeginSourceFile() and EndSourceFile().
1231efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar  ///
1232af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \param LangOpts The language options for the source file being processed.
1233af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \param PP The preprocessor object being used for the source; this is
1234af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// optional, e.g., it may not be present when processing AST source files.
12357d90199f109290e9d587479a481a2850d390b552Daniel Dunbar  virtual void BeginSourceFile(const LangOptions &LangOpts,
12367d90199f109290e9d587479a481a2850d390b552Daniel Dunbar                               const Preprocessor *PP = 0) {}
1237efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar
1238af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief Callback to inform the diagnostic client that processing
1239af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// of a source file has ended.
1240af50aab0c317462129d73ae8000c6394c718598dJames Dennett  ///
1241af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// The diagnostic client should assume that any objects made available via
1242af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// BeginSourceFile() are inaccessible.
1243efcbe9475348ecab6b85153baa21d0e894e39607Daniel Dunbar  virtual void EndSourceFile() {}
12441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
124529f2787b6da552018a7716f18f5bd8f67bd6edb5Argyrios Kyrtzidis  /// \brief Callback to inform the diagnostic client that processing of all
124629f2787b6da552018a7716f18f5bd8f67bd6edb5Argyrios Kyrtzidis  /// source files has ended.
124729f2787b6da552018a7716f18f5bd8f67bd6edb5Argyrios Kyrtzidis  virtual void finish() {}
124829f2787b6da552018a7716f18f5bd8f67bd6edb5Argyrios Kyrtzidis
1249af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief Indicates whether the diagnostics handled by this
125078ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie  /// DiagnosticConsumer should be included in the number of diagnostics
125178ad0b98848c17a0a11847fa1d456e2dfec8aa2fDavid Blaikie  /// reported by DiagnosticsEngine.
1252af50aab0c317462129d73ae8000c6394c718598dJames Dennett  ///
1253af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// The default implementation returns true.
1254cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek  virtual bool IncludeInDiagnosticCounts() const;
12555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
1256af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// \brief Handle this diagnostic, reporting it to the user or
12575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// capturing it to a log as needed.
1258f2224d89a6ae65a3839529e26d0f6d025d83d6bbArgyrios Kyrtzidis  ///
1259af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// The default implementation just keeps track of the total number of
1260af50aab0c317462129d73ae8000c6394c718598dJames Dennett  /// warnings and errors.
1261d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie  virtual void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel,
126240847cfb58acc3cac7d68727df9455ac45f2e118David Blaikie                                const Diagnostic &Info);
1263aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor
1264aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor  /// \brief Clone the diagnostic consumer, producing an equivalent consumer
1265aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor  /// that can be used in a different context.
1266aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor  virtual DiagnosticConsumer *clone(DiagnosticsEngine &Diags) const = 0;
1267aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor};
1268aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor
1269af50aab0c317462129d73ae8000c6394c718598dJames Dennett/// \brief A diagnostic client that ignores all diagnostics.
1270aee526e77657afd1600276450e9c346953ad51d7Douglas Gregorclass IgnoringDiagConsumer : public DiagnosticConsumer {
127199ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie  virtual void anchor();
1272aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor  void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel,
1273aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor                        const Diagnostic &Info) {
1274aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor    // Just ignore it.
1275aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor  }
1276aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor  DiagnosticConsumer *clone(DiagnosticsEngine &Diags) const {
1277aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor    return new IgnoringDiagConsumer();
1278aee526e77657afd1600276450e9c346953ad51d7Douglas Gregor  }
12795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer};
12805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
1281246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu// Struct used for sending info about how a type should be printed.
1282246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieustruct TemplateDiffTypes {
1283246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu  intptr_t FromType;
1284246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu  intptr_t ToType;
1285246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu  unsigned PrintTree : 1;
1286246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu  unsigned PrintFromType : 1;
1287246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu  unsigned ElideType : 1;
1288246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu  unsigned ShowColors : 1;
1289246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu};
1290246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu
1291246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu/// Special character that the diagnostic printer will use to toggle the bold
1292246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu/// attribute.  The character itself will be not be printed.
1293246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieuconst char ToggleHighlight = 127;
1294246b6aa6763de8c617d564ef33123a8f3293a80eRichard Trieu
12955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}  // end namespace clang
12965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
12975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif
1298