clang 18.0.0git
Go to the documentation of this file.
1//===--- HTMLPrint.cpp - Source code -> HTML pretty-printing --------------===//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
9// Pretty-printing of source code to HTML.
15#include "clang/AST/Decl.h"
23#include "llvm/Support/raw_ostream.h"
24using namespace clang;
27// Functional HTML pretty-printing.
30namespace {
31 class HTMLPrinter : public ASTConsumer {
32 Rewriter R;
33 std::unique_ptr<raw_ostream> Out;
34 Preprocessor &PP;
37 public:
38 HTMLPrinter(std::unique_ptr<raw_ostream> OS, Preprocessor &pp,
39 bool _SyntaxHighlight, bool _HighlightMacros)
40 : Out(std::move(OS)), PP(pp), SyntaxHighlight(_SyntaxHighlight),
41 HighlightMacros(_HighlightMacros) {}
43 void Initialize(ASTContext &context) override;
44 void HandleTranslationUnit(ASTContext &Ctx) override;
45 };
49clang::CreateHTMLPrinter(std::unique_ptr<raw_ostream> OS, Preprocessor &PP,
50 bool SyntaxHighlight, bool HighlightMacros) {
51 return std::make_unique<HTMLPrinter>(std::move(OS), PP, SyntaxHighlight,
52 HighlightMacros);
55void HTMLPrinter::Initialize(ASTContext &context) {
56 R.setSourceMgr(context.getSourceManager(), context.getLangOpts());
59void HTMLPrinter::HandleTranslationUnit(ASTContext &Ctx) {
60 if (PP.getDiagnostics().hasErrorOccurred())
61 return;
63 // Format the file.
64 FileID FID = R.getSourceMgr().getMainFileID();
65 OptionalFileEntryRef Entry = R.getSourceMgr().getFileEntryRefForID(FID);
66 StringRef Name;
67 // In some cases, in particular the case where the input is from stdin,
68 // there is no entry. Fall back to the memory buffer for a name in those
69 // cases.
70 if (Entry)
71 Name = Entry->getName();
72 else
73 Name = R.getSourceMgr().getBufferOrFake(FID).getBufferIdentifier();
78 // If we have a preprocessor, relex the file and syntax highlight.
79 // We might not have a preprocessor if we come from a deserialized AST file,
80 // for example.
82 if (SyntaxHighlight) html::SyntaxHighlight(R, FID, PP);
83 if (HighlightMacros) html::HighlightMacros(R, FID, PP);
84 html::EscapeText(R, FID, false, true);
86 // Emit the HTML.
87 const RewriteBuffer &RewriteBuf = R.getEditBuffer(FID);
88 std::unique_ptr<char[]> Buffer(new char[RewriteBuf.size()]);
89 std::copy(RewriteBuf.begin(), RewriteBuf.end(), Buffer.get());
90 Out->write(Buffer.get(), RewriteBuf.size());
Defines the clang::ASTContext interface.
Defines the Diagnostic-related interfaces.
Defines the clang::FileManager interface and associated types.
Defines the clang::Preprocessor interface.
Defines the SourceManager interface.
ASTConsumer - This is an abstract interface that should be implemented by clients that read ASTs.
Definition: ASTConsumer.h:33
virtual void HandleTranslationUnit(ASTContext &Ctx)
HandleTranslationUnit - This method is called when the ASTs for entire translation unit have been par...
Definition: ASTConsumer.h:66
virtual void Initialize(ASTContext &Context)
Initialize - This is called to initialize the consumer, providing the ASTContext.
Definition: ASTConsumer.h:47
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
Definition: ASTContext.h:182
SourceManager & getSourceManager()
Definition: ASTContext.h:691
const LangOptions & getLangOpts() const
Definition: ASTContext.h:761
StringRef getName() const
The name of this FileEntry.
Definition: FileEntry.h:61
An opaque identifier used by SourceManager which refers to a source file (MemoryBuffer) along with it...
Engages in a tight little dance with the lexer to efficiently preprocess tokens.
Definition: Preprocessor.h:128
RewriteBuffer - As code is rewritten, SourceBuffer's from the original input with modifications get a...
Definition: RewriteBuffer.h:25
iterator end() const
Definition: RewriteBuffer.h:38
unsigned size() const
Definition: RewriteBuffer.h:39
iterator begin() const
Definition: RewriteBuffer.h:37
Rewriter - This is the main interface to the rewrite buffers.
Definition: Rewriter.h:32
void AddHeaderFooterInternalBuiltinCSS(Rewriter &R, FileID FID, StringRef title)
void SyntaxHighlight(Rewriter &R, FileID FID, const Preprocessor &PP)
SyntaxHighlight - Relex the specified FileID and annotate the HTML with information about keywords,...
void AddLineNumbers(Rewriter &R, FileID FID)
void HighlightMacros(Rewriter &R, FileID FID, const Preprocessor &PP)
HighlightMacros - This uses the macro table state from the end of the file, to reexpand macros and in...
void EscapeText(Rewriter &R, FileID FID, bool EscapeSpaces=false, bool ReplaceTabs=false)
EscapeText - HTMLize a specified file so that special characters are are translated so that they are ...
std::unique_ptr< ASTConsumer > CreateHTMLPrinter(std::unique_ptr< raw_ostream > OS, Preprocessor &PP, bool SyntaxHighlight=true, bool HighlightMacros=true)
CreateHTMLPrinter - Create an AST consumer which rewrites source code to HTML with syntax highlightin...
Definition: HTMLPrint.cpp:49
Definition: Format.h:5078