1 //===--- HTMLPrint.cpp - Source code -> HTML pretty-printing --------------===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // Pretty-printing of source code to HTML.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #include "clang/AST/ASTConsumer.h"
15 #include "clang/AST/ASTContext.h"
16 #include "clang/AST/Decl.h"
17 #include "clang/Basic/Diagnostic.h"
18 #include "clang/Basic/FileManager.h"
19 #include "clang/Basic/SourceManager.h"
20 #include "clang/Lex/Preprocessor.h"
21 #include "clang/Rewrite/Core/HTMLRewrite.h"
22 #include "clang/Rewrite/Core/Rewriter.h"
23 #include "clang/Rewrite/Frontend/ASTConsumers.h"
24 #include "llvm/Support/raw_ostream.h"
25 using namespace clang;
26
27 //===----------------------------------------------------------------------===//
28 // Functional HTML pretty-printing.
29 //===----------------------------------------------------------------------===//
30
31 namespace {
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:
HTMLPrinter(std::unique_ptr<raw_ostream> OS,Preprocessor & pp,bool _SyntaxHighlight,bool _HighlightMacros)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
49 std::unique_ptr<ASTConsumer>
CreateHTMLPrinter(std::unique_ptr<raw_ostream> OS,Preprocessor & PP,bool SyntaxHighlight,bool HighlightMacros)50 clang::CreateHTMLPrinter(std::unique_ptr<raw_ostream> OS, Preprocessor &PP,
51 bool SyntaxHighlight, bool HighlightMacros) {
52 return llvm::make_unique<HTMLPrinter>(std::move(OS), PP, SyntaxHighlight,
53 HighlightMacros);
54 }
55
Initialize(ASTContext & context)56 void HTMLPrinter::Initialize(ASTContext &context) {
57 R.setSourceMgr(context.getSourceManager(), context.getLangOpts());
58 }
59
HandleTranslationUnit(ASTContext & Ctx)60 void HTMLPrinter::HandleTranslationUnit(ASTContext &Ctx) {
61 if (PP.getDiagnostics().hasErrorOccurred())
62 return;
63
64 // Format the file.
65 FileID FID = R.getSourceMgr().getMainFileID();
66 const FileEntry* Entry = R.getSourceMgr().getFileEntryForID(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().getBuffer(FID)->getBufferIdentifier();
75
76 html::AddLineNumbers(R, FID);
77 html::AddHeaderFooterInternalBuiltinCSS(R, FID, 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, false, 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(RewriteBuf.begin(), RewriteBuf.end(), Buffer.get());
91 Out->write(Buffer.get(), RewriteBuf.size());
92 }
93