1//===--- HTMLPrint.cpp - Source code -> HTML pretty-printing --------------===//
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// Pretty-printing of source code to HTML.
10//
11//===----------------------------------------------------------------------===//
12
13#include "clang/AST/ASTConsumer.h"
14#include "clang/AST/ASTContext.h"
15#include "clang/AST/Decl.h"
16#include "clang/Basic/Diagnostic.h"
17#include "clang/Basic/SourceManager.h"
18#include "clang/Lex/Preprocessor.h"
19#include "clang/Rewrite/Core/HTMLRewrite.h"
20#include "clang/Rewrite/Core/Rewriter.h"
21#include "clang/Rewrite/Frontend/ASTConsumers.h"
22#include "llvm/ADT/RewriteBuffer.h"
23#include "llvm/Support/raw_ostream.h"
24using namespace clang;
25using llvm::RewriteBuffer;
26
27//===----------------------------------------------------------------------===//
28// Functional HTML pretty-printing.
29//===----------------------------------------------------------------------===//
30
31namespace {
32 class HTMLPrinter : public ASTConsumer {
33 Rewriter R;
34 std::unique_ptr<raw_ostream> Out;
35 Preprocessor &PP;
36 bool SyntaxHighlight, HighlightMacros;
37
38 public:
39 HTMLPrinter(std::unique_ptr<raw_ostream> OS, Preprocessor &pp,
40 bool _SyntaxHighlight, bool _HighlightMacros)
41 : Out(std::move(OS)), PP(pp), SyntaxHighlight(_SyntaxHighlight),
42 HighlightMacros(_HighlightMacros) {}
43
44 void Initialize(ASTContext &context) override;
45 void HandleTranslationUnit(ASTContext &Ctx) override;
46 };
47}
48
49std::unique_ptr<ASTConsumer>
50clang::CreateHTMLPrinter(std::unique_ptr<raw_ostream> OS, Preprocessor &PP,
51 bool SyntaxHighlight, bool HighlightMacros) {
52 return std::make_unique<HTMLPrinter>(args: std::move(OS), args&: PP, args&: SyntaxHighlight,
53 args&: HighlightMacros);
54}
55
56void HTMLPrinter::Initialize(ASTContext &context) {
57 R.setSourceMgr(SM&: context.getSourceManager(), LO: context.getLangOpts());
58}
59
60void HTMLPrinter::HandleTranslationUnit(ASTContext &Ctx) {
61 if (PP.getDiagnostics().hasErrorOccurred())
62 return;
63
64 // Format the file.
65 FileID FID = R.getSourceMgr().getMainFileID();
66 OptionalFileEntryRef Entry = R.getSourceMgr().getFileEntryRefForID(FID);
67 StringRef Name;
68 // In some cases, in particular the case where the input is from stdin,
69 // there is no entry. Fall back to the memory buffer for a name in those
70 // cases.
71 if (Entry)
72 Name = Entry->getName();
73 else
74 Name = R.getSourceMgr().getBufferOrFake(FID).getBufferIdentifier();
75
76 html::AddLineNumbers(R, FID);
77 html::AddHeaderFooterInternalBuiltinCSS(R, FID, title: Name);
78
79 // If we have a preprocessor, relex the file and syntax highlight.
80 // We might not have a preprocessor if we come from a deserialized AST file,
81 // for example.
82
83 if (SyntaxHighlight) html::SyntaxHighlight(R, FID, PP);
84 if (HighlightMacros) html::HighlightMacros(R, FID, PP);
85 html::EscapeText(R, FID, EscapeSpaces: false, ReplaceTabs: true);
86
87 // Emit the HTML.
88 const RewriteBuffer &RewriteBuf = R.getEditBuffer(FID);
89 std::unique_ptr<char[]> Buffer(new char[RewriteBuf.size()]);
90 std::copy(first: RewriteBuf.begin(), last: RewriteBuf.end(), result: Buffer.get());
91 Out->write(Ptr: Buffer.get(), Size: RewriteBuf.size());
92}
93