1 //===--- LogDiagnosticPrinter.cpp - Log Diagnostic Printer ----------------===//
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
7 //===----------------------------------------------------------------------===//
9 #include "clang/Frontend/LogDiagnosticPrinter.h"
10 #include "clang/Basic/DiagnosticOptions.h"
11 #include "clang/Basic/FileManager.h"
12 #include "clang/Basic/PlistSupport.h"
13 #include "clang/Basic/SourceManager.h"
14 #include "llvm/ADT/SmallString.h"
15 #include "llvm/Support/ErrorHandling.h"
16 #include "llvm/Support/raw_ostream.h"
17 using namespace clang;
18 using namespace markup;
20 LogDiagnosticPrinter::LogDiagnosticPrinter(
21 raw_ostream &os, DiagnosticOptions *diags,
22 std::unique_ptr<raw_ostream> StreamOwner)
23 : OS(os), StreamOwner(std::move(StreamOwner)), LangOpts(nullptr),
26 static StringRef getLevelName(DiagnosticsEngine::Level Level) {
28 case DiagnosticsEngine::Ignored: return "ignored";
29 case DiagnosticsEngine::Remark: return "remark";
30 case DiagnosticsEngine::Note: return "note";
31 case DiagnosticsEngine::Warning: return "warning";
32 case DiagnosticsEngine::Error: return "error";
33 case DiagnosticsEngine::Fatal: return "fatal error";
35 llvm_unreachable("Invalid DiagnosticsEngine level!");
39 LogDiagnosticPrinter::EmitDiagEntry(llvm::raw_ostream &OS,
40 const LogDiagnosticPrinter::DiagEntry &DE) {
42 OS << " <key>level</key>\n"
44 EmitString(OS, getLevelName(DE.DiagnosticLevel)) << '\n';
45 if (!DE.Filename.empty()) {
46 OS << " <key>filename</key>\n"
48 EmitString(OS, DE.Filename) << '\n';
51 OS << " <key>line</key>\n"
53 EmitInteger(OS, DE.Line) << '\n';
56 OS << " <key>column</key>\n"
58 EmitInteger(OS, DE.Column) << '\n';
60 if (!DE.Message.empty()) {
61 OS << " <key>message</key>\n"
63 EmitString(OS, DE.Message) << '\n';
65 OS << " <key>ID</key>\n"
67 EmitInteger(OS, DE.DiagnosticID) << '\n';
68 if (!DE.WarningOption.empty()) {
69 OS << " <key>WarningOption</key>\n"
71 EmitString(OS, DE.WarningOption) << '\n';
76 void LogDiagnosticPrinter::EndSourceFile() {
77 // We emit all the diagnostics in EndSourceFile. However, we don't emit any
78 // entry if no diagnostics were present.
80 // Note that DiagnosticConsumer has no "end-of-compilation" callback, so we
81 // will miss any diagnostics which are emitted after and outside the
82 // translation unit processing.
86 // Write to a temporary string to ensure atomic write of diagnostic object.
88 llvm::raw_svector_ostream OS(Msg);
91 if (!MainFilename.empty()) {
92 OS << " <key>main-file</key>\n"
94 EmitString(OS, MainFilename) << '\n';
96 if (!DwarfDebugFlags.empty()) {
97 OS << " <key>dwarf-debug-flags</key>\n"
99 EmitString(OS, DwarfDebugFlags) << '\n';
101 OS << " <key>diagnostics</key>\n";
103 for (auto &DE : Entries)
104 EmitDiagEntry(OS, DE);
108 this->OS << OS.str();
111 void LogDiagnosticPrinter::HandleDiagnostic(DiagnosticsEngine::Level Level,
112 const Diagnostic &Info) {
113 // Default implementation (Warnings/errors count).
114 DiagnosticConsumer::HandleDiagnostic(Level, Info);
116 // Initialize the main file name, if we haven't already fetched it.
117 if (MainFilename.empty() && Info.hasSourceManager()) {
118 const SourceManager &SM = Info.getSourceManager();
119 FileID FID = SM.getMainFileID();
121 const FileEntry *FE = SM.getFileEntryForID(FID);
122 if (FE && FE->isValid())
123 MainFilename = FE->getName();
127 // Create the diag entry.
129 DE.DiagnosticID = Info.getID();
130 DE.DiagnosticLevel = Level;
132 DE.WarningOption = DiagnosticIDs::getWarningOptionForDiag(DE.DiagnosticID);
134 // Format the message.
135 SmallString<100> MessageStr;
136 Info.FormatDiagnostic(MessageStr);
137 DE.Message = MessageStr.str();
139 // Set the location information.
141 DE.Line = DE.Column = 0;
142 if (Info.getLocation().isValid() && Info.hasSourceManager()) {
143 const SourceManager &SM = Info.getSourceManager();
144 PresumedLoc PLoc = SM.getPresumedLoc(Info.getLocation());
146 if (PLoc.isInvalid()) {
147 // At least print the file name if available:
148 FileID FID = SM.getFileID(Info.getLocation());
150 const FileEntry *FE = SM.getFileEntryForID(FID);
151 if (FE && FE->isValid())
152 DE.Filename = FE->getName();
155 DE.Filename = PLoc.getFilename();
156 DE.Line = PLoc.getLine();
157 DE.Column = PLoc.getColumn();
161 // Record the diagnostic entry.
162 Entries.push_back(DE);