xref: /freebsd/contrib/llvm-project/clang/include/clang/Frontend/SerializedDiagnosticPrinter.h (revision bdd1243df58e60e85101c09001d9812a789b6bc4)
1 //===--- SerializedDiagnosticPrinter.h - Diagnostics serializer -*- 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 #ifndef LLVM_CLANG_FRONTEND_SERIALIZEDDIAGNOSTICPRINTER_H
10 #define LLVM_CLANG_FRONTEND_SERIALIZEDDIAGNOSTICPRINTER_H
11 
12 #include "clang/Basic/LLVM.h"
13 #include "clang/Frontend/SerializedDiagnostics.h"
14 #include "llvm/Bitstream/BitstreamWriter.h"
15 
16 namespace llvm {
17 class raw_ostream;
18 }
19 
20 namespace clang {
21 class DiagnosticConsumer;
22 class DiagnosticOptions;
23 
24 namespace serialized_diags {
25 
26 /// Returns a DiagnosticConsumer that serializes diagnostics to
27 ///  a bitcode file.
28 ///
29 /// The created DiagnosticConsumer is designed for quick and lightweight
30 /// transfer of diagnostics to the enclosing build system (e.g., an IDE).
31 /// This allows wrapper tools for Clang to get diagnostics from Clang
32 /// (via libclang) without needing to parse Clang's command line output.
33 ///
34 std::unique_ptr<DiagnosticConsumer> create(StringRef OutputFile,
35                                            DiagnosticOptions *Diags,
36                                            bool MergeChildRecords = false);
37 
38 } // end serialized_diags namespace
39 } // end clang namespace
40 
41 #endif
42