clang  3.9.0
HTMLPrint.cpp
Go to the documentation of this file.
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 
15 #include "clang/AST/ASTConsumer.h"
16 #include "clang/AST/ASTContext.h"
17 #include "clang/AST/Decl.h"
18 #include "clang/Basic/Diagnostic.h"
21 #include "clang/Lex/Preprocessor.h"
24 #include "llvm/Support/MemoryBuffer.h"
25 #include "llvm/Support/raw_ostream.h"
26 using namespace clang;
27 
28 //===----------------------------------------------------------------------===//
29 // Functional HTML pretty-printing.
30 //===----------------------------------------------------------------------===//
31 
32 namespace {
33  class HTMLPrinter : public ASTConsumer {
34  Rewriter R;
35  std::unique_ptr<raw_ostream> Out;
36  Preprocessor &PP;
38 
39  public:
40  HTMLPrinter(std::unique_ptr<raw_ostream> OS, Preprocessor &pp,
41  bool _SyntaxHighlight, bool _HighlightMacros)
42  : Out(std::move(OS)), PP(pp), SyntaxHighlight(_SyntaxHighlight),
43  HighlightMacros(_HighlightMacros) {}
44 
45  void Initialize(ASTContext &context) override;
46  void HandleTranslationUnit(ASTContext &Ctx) override;
47  };
48 }
49 
50 std::unique_ptr<ASTConsumer>
51 clang::CreateHTMLPrinter(std::unique_ptr<raw_ostream> OS, Preprocessor &PP,
52  bool SyntaxHighlight, bool HighlightMacros) {
53  return llvm::make_unique<HTMLPrinter>(std::move(OS), PP, SyntaxHighlight,
55 }
56 
57 void HTMLPrinter::Initialize(ASTContext &context) {
58  R.setSourceMgr(context.getSourceManager(), context.getLangOpts());
59 }
60 
61 void HTMLPrinter::HandleTranslationUnit(ASTContext &Ctx) {
62  if (PP.getDiagnostics().hasErrorOccurred())
63  return;
64 
65  // Format the file.
66  FileID FID = R.getSourceMgr().getMainFileID();
67  const FileEntry* Entry = R.getSourceMgr().getFileEntryForID(FID);
68  const char* Name;
69  // In some cases, in particular the case where the input is from stdin,
70  // there is no entry. Fall back to the memory buffer for a name in those
71  // cases.
72  if (Entry)
73  Name = Entry->getName();
74  else
75  Name = R.getSourceMgr().getBuffer(FID)->getBufferIdentifier();
76 
77  html::AddLineNumbers(R, FID);
79 
80  // If we have a preprocessor, relex the file and syntax highlight.
81  // We might not have a preprocessor if we come from a deserialized AST file,
82  // for example.
83 
84  if (SyntaxHighlight) html::SyntaxHighlight(R, FID, PP);
85  if (HighlightMacros) html::HighlightMacros(R, FID, PP);
86  html::EscapeText(R, FID, false, true);
87 
88  // Emit the HTML.
89  const RewriteBuffer &RewriteBuf = R.getEditBuffer(FID);
90  char *Buffer = (char*)malloc(RewriteBuf.size());
91  std::copy(RewriteBuf.begin(), RewriteBuf.end(), Buffer);
92  Out->write(Buffer, RewriteBuf.size());
93  free(Buffer);
94 }
Defines the clang::ASTContext interface.
ASTConsumer - This is an abstract interface that should be implemented by clients that read ASTs...
Definition: ASTConsumer.h:36
Defines the clang::FileManager interface and associated types.
Defines the SourceManager interface.
std::unique_ptr< llvm::MemoryBuffer > Buffer
RewriteBuffer - As code is rewritten, SourceBuffer's from the original input with modifications get a...
Definition: RewriteBuffer.h:27
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:51
class LLVM_ALIGNAS(8) DependentTemplateSpecializationType const IdentifierInfo * Name
Represents a template specialization type whose template cannot be resolved, e.g. ...
Definition: Type.h:4549
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
Definition: ASTContext.h:92
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)
iterator end() const
Definition: RewriteBuffer.h:36
const LangOptions & getLangOpts() const
Definition: ASTContext.h:604
void SyntaxHighlight(Rewriter &R, FileID FID, const Preprocessor &PP)
SyntaxHighlight - Relex the specified FileID and annotate the HTML with information about keywords...
iterator begin() const
Definition: RewriteBuffer.h:35
Defines the clang::Preprocessor interface.
void AddHeaderFooterInternalBuiltinCSS(Rewriter &R, FileID FID, const char *title=nullptr)
const char * getName() const
Definition: FileManager.h:85
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:53
An opaque identifier used by SourceManager which refers to a source file (MemoryBuffer) along with it...
Defines the Diagnostic-related interfaces.
SourceManager & getSourceManager()
Definition: ASTContext.h:561
Rewriter - This is the main interface to the rewrite buffers.
Definition: Rewriter.h:31
unsigned size() const
Definition: RewriteBuffer.h:37
Engages in a tight little dance with the lexer to efficiently preprocess tokens.
Definition: Preprocessor.h:97