xref: /freebsd/contrib/llvm-project/clang/include/clang/Frontend/SerializedDiagnosticPrinter.h (revision 04eeddc0aa8e0a417a16eaf9d7d095207f4a8623)
1*0b57cec5SDimitry Andric //===--- SerializedDiagnosticPrinter.h - Diagnostics serializer -*- C++ -*-===//
2*0b57cec5SDimitry Andric //
3*0b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4*0b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
5*0b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6*0b57cec5SDimitry Andric //
7*0b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
8*0b57cec5SDimitry Andric 
9*0b57cec5SDimitry Andric #ifndef LLVM_CLANG_FRONTEND_SERIALIZEDDIAGNOSTICPRINTER_H
10*0b57cec5SDimitry Andric #define LLVM_CLANG_FRONTEND_SERIALIZEDDIAGNOSTICPRINTER_H
11*0b57cec5SDimitry Andric 
12*0b57cec5SDimitry Andric #include "clang/Basic/LLVM.h"
13*0b57cec5SDimitry Andric #include "clang/Frontend/SerializedDiagnostics.h"
14*0b57cec5SDimitry Andric #include "llvm/Bitstream/BitstreamWriter.h"
15*0b57cec5SDimitry Andric 
16*0b57cec5SDimitry Andric namespace llvm {
17*0b57cec5SDimitry Andric class raw_ostream;
18*0b57cec5SDimitry Andric }
19*0b57cec5SDimitry Andric 
20*0b57cec5SDimitry Andric namespace clang {
21*0b57cec5SDimitry Andric class DiagnosticConsumer;
22*0b57cec5SDimitry Andric class DiagnosticOptions;
23*0b57cec5SDimitry Andric 
24*0b57cec5SDimitry Andric namespace serialized_diags {
25*0b57cec5SDimitry Andric 
26*0b57cec5SDimitry Andric /// Returns a DiagnosticConsumer that serializes diagnostics to
27*0b57cec5SDimitry Andric ///  a bitcode file.
28*0b57cec5SDimitry Andric ///
29*0b57cec5SDimitry Andric /// The created DiagnosticConsumer is designed for quick and lightweight
30*0b57cec5SDimitry Andric /// transfer of diagnostics to the enclosing build system (e.g., an IDE).
31*0b57cec5SDimitry Andric /// This allows wrapper tools for Clang to get diagnostics from Clang
32*0b57cec5SDimitry Andric /// (via libclang) without needing to parse Clang's command line output.
33*0b57cec5SDimitry Andric ///
34*0b57cec5SDimitry Andric std::unique_ptr<DiagnosticConsumer> create(StringRef OutputFile,
35*0b57cec5SDimitry Andric                                            DiagnosticOptions *Diags,
36*0b57cec5SDimitry Andric                                            bool MergeChildRecords = false);
37*0b57cec5SDimitry Andric 
38*0b57cec5SDimitry Andric } // end serialized_diags namespace
39*0b57cec5SDimitry Andric } // end clang namespace
40*0b57cec5SDimitry Andric 
41*0b57cec5SDimitry Andric #endif
42