clang  10.0.0svn
HTMLPrint.cpp
Go to the documentation of this file.
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"
19 #include "clang/Lex/Preprocessor.h"
23 #include "llvm/Support/raw_ostream.h"
24 using namespace clang;
25 
26 //===----------------------------------------------------------------------===//
27 // Functional HTML pretty-printing.
28 //===----------------------------------------------------------------------===//
29 
30 namespace {
31  class HTMLPrinter : public ASTConsumer {
32  Rewriter R;
33  std::unique_ptr<raw_ostream> Out;
34  Preprocessor &PP;
36 
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) {}
42 
43  void Initialize(ASTContext &context) override;
44  void HandleTranslationUnit(ASTContext &Ctx) override;
45  };
46 }
47 
48 std::unique_ptr<ASTConsumer>
49 clang::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,
53 }
54 
55 void HTMLPrinter::Initialize(ASTContext &context) {
56  R.setSourceMgr(context.getSourceManager(), context.getLangOpts());
57 }
58 
59 void HTMLPrinter::HandleTranslationUnit(ASTContext &Ctx) {
60  if (PP.getDiagnostics().hasErrorOccurred())
61  return;
62 
63  // Format the file.
64  FileID FID = R.getSourceMgr().getMainFileID();
65  const FileEntry* Entry = R.getSourceMgr().getFileEntryForID(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().getBuffer(FID)->getBufferIdentifier();
74 
75  html::AddLineNumbers(R, FID);
77 
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.
81 
82  if (SyntaxHighlight) html::SyntaxHighlight(R, FID, PP);
83  if (HighlightMacros) html::HighlightMacros(R, FID, PP);
84  html::EscapeText(R, FID, false, true);
85 
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());
91 }
Defines the clang::ASTContext interface.
ASTConsumer - This is an abstract interface that should be implemented by clients that read ASTs...
Definition: ASTConsumer.h:33
Defines the clang::FileManager interface and associated types.
Defines the SourceManager interface.
RewriteBuffer - As code is rewritten, SourceBuffer&#39;s from the original input with modifications get a...
Definition: RewriteBuffer.h:25
iterator end() const
Definition: RewriteBuffer.h:38
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
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
Definition: ASTContext.h:160
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 AddLineNumbers(Rewriter &R, FileID FID)
Definition: Format.h:2392
Defines the Diagnostic-related interfaces.
void SyntaxHighlight(Rewriter &R, FileID FID, const Preprocessor &PP)
SyntaxHighlight - Relex the specified FileID and annotate the HTML with information about keywords...
Defines the clang::Preprocessor interface.
iterator begin() const
Definition: RewriteBuffer.h:37
raw_ostream & write(raw_ostream &Stream) const
Write to Stream the result of applying all changes to the original buffer.
Definition: Rewriter.cpp:37
StringRef getName() const
Definition: FileManager.h:102
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 ...
Cached information about one file (either on disk or in the virtual file system). ...
Definition: FileManager.h:78
An opaque identifier used by SourceManager which refers to a source file (MemoryBuffer) along with it...
Dataflow Directional Tag Classes.
void AddHeaderFooterInternalBuiltinCSS(Rewriter &R, FileID FID, StringRef title)
unsigned size() const
Definition: RewriteBuffer.h:39
SourceManager & getSourceManager()
Definition: ASTContext.h:678
Rewriter - This is the main interface to the rewrite buffers.
Definition: Rewriter.h:32
const LangOptions & getLangOpts() const
Definition: ASTContext.h:723
Engages in a tight little dance with the lexer to efficiently preprocess tokens.
Definition: Preprocessor.h:125