clang  16.0.0git
SerializedDiagnosticPrinter.h
Go to the documentation of this file.
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"
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
llvm
YAML serialization mapping.
Definition: Dominators.h:30
SerializedDiagnostics.h
clang::serialized_diags::create
std::unique_ptr< DiagnosticConsumer > create(StringRef OutputFile, DiagnosticOptions *Diags, bool MergeChildRecords=false)
Returns a DiagnosticConsumer that serializes diagnostics to a bitcode file.
Definition: SerializedDiagnosticPrinter.cpp:301
LLVM.h
clang
Definition: CalledOnceCheck.h:17
clang::DiagnosticOptions
Options for controlling the compiler diagnostics engine.
Definition: DiagnosticOptions.h:70