xref: /freebsd/contrib/llvm-project/clang/include/clang/Frontend/TextDiagnosticBuffer.h (revision 0b57cec536236d46e3dba9bd041533462f33dbb7)
1 //===- TextDiagnosticBuffer.h - Buffer Text Diagnostics ---------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This is a concrete diagnostic client, which buffers the diagnostic messages.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #ifndef LLVM_CLANG_FRONTEND_TEXTDIAGNOSTICBUFFER_H
14 #define LLVM_CLANG_FRONTEND_TEXTDIAGNOSTICBUFFER_H
15 
16 #include "clang/Basic/Diagnostic.h"
17 #include "clang/Basic/SourceLocation.h"
18 #include <cstddef>
19 #include <string>
20 #include <utility>
21 #include <vector>
22 
23 namespace clang {
24 
25 class TextDiagnosticBuffer : public DiagnosticConsumer {
26 public:
27   using DiagList = std::vector<std::pair<SourceLocation, std::string>>;
28   using iterator = DiagList::iterator;
29   using const_iterator = DiagList::const_iterator;
30 
31 private:
32   DiagList Errors, Warnings, Remarks, Notes;
33 
34   /// All - All diagnostics in the order in which they were generated.  That
35   /// order likely doesn't correspond to user input order, but it at least
36   /// keeps notes in the right places.  Each pair in the vector is a diagnostic
37   /// level and an index into the corresponding DiagList above.
38   std::vector<std::pair<DiagnosticsEngine::Level, size_t>> All;
39 
40 public:
err_begin()41   const_iterator err_begin() const { return Errors.begin(); }
err_end()42   const_iterator err_end() const { return Errors.end(); }
43 
warn_begin()44   const_iterator warn_begin() const { return Warnings.begin(); }
warn_end()45   const_iterator warn_end() const { return Warnings.end(); }
46 
remark_begin()47   const_iterator remark_begin() const { return Remarks.begin(); }
remark_end()48   const_iterator remark_end() const { return Remarks.end(); }
49 
note_begin()50   const_iterator note_begin() const { return Notes.begin(); }
note_end()51   const_iterator note_end() const { return Notes.end(); }
52 
53   void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel,
54                         const Diagnostic &Info) override;
55 
56   /// FlushDiagnostics - Flush the buffered diagnostics to an given
57   /// diagnostic engine.
58   void FlushDiagnostics(DiagnosticsEngine &Diags) const;
59 };
60 
61 } // namespace clang
62 
63 #endif // LLVM_CLANG_FRONTEND_TEXTDIAGNOSTICBUFFER_H
64