blob: c832eff46de6688849e13fcfcb2cdf2820497e26 [file] [log] [blame]
Ted Kremenek6a340832008-03-18 21:19:49 +00001//== HTMLRewrite.cpp - Translate source code into prettified HTML --*- C++ -*-//
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// This file defines the HTMLRewriter clas, which is used to translate the
11// text of a source file into prettified HTML.
12//
13//===----------------------------------------------------------------------===//
14
15#include "clang/Rewrite/Rewriter.h"
16#include "clang/Rewrite/HTMLRewrite.h"
17#include "clang/Basic/SourceManager.h"
18#include "llvm/Support/MemoryBuffer.h"
19#include <sstream>
20
21using namespace clang;
22
23void html::EscapeText(Rewriter& R, unsigned FileID, bool EscapeSpaces) {
24
25 const llvm::MemoryBuffer *Buf = R.getSourceMgr().getBuffer(FileID);
26 const char* C = Buf->getBufferStart();
27 const char* FileEnd = Buf->getBufferEnd();
28
29 assert (C <= FileEnd);
30
31 for (unsigned FilePos = 0; C != FileEnd ; ++C, ++FilePos) {
Ted Kremenek49cd6352008-04-03 07:12:29 +000032
Ted Kremenek6a340832008-03-18 21:19:49 +000033 switch (*C) {
34 default: break;
35
36 case ' ':
Ted Kremenek49cd6352008-04-03 07:12:29 +000037 if (EscapeSpaces) {
38 SourceLocation Loc = SourceLocation::getFileLoc(FileID, FilePos);
39 R.ReplaceText(Loc, 1, "&nbsp;", 6);
40 }
Ted Kremenek6a340832008-03-18 21:19:49 +000041 break;
42
Ted Kremenek49cd6352008-04-03 07:12:29 +000043 case '\t': {
44 SourceLocation Loc = SourceLocation::getFileLoc(FileID, FilePos);
45 R.ReplaceText(Loc, 1, "&nbsp;&nbsp;&nbsp;&nbsp;", 6*4);
46 break;
47 }
48
49 case '<': {
50 SourceLocation Loc = SourceLocation::getFileLoc(FileID, FilePos);
51 R.ReplaceText(Loc, 1, "&lt;", 4);
52 break;
53 }
54
55 case '>': {
56 SourceLocation Loc = SourceLocation::getFileLoc(FileID, FilePos);
57 R.ReplaceText(Loc, 1, "&gt;", 4);
58 break;
59 }
60
61 case '&': {
62 SourceLocation Loc = SourceLocation::getFileLoc(FileID, FilePos);
63 R.ReplaceText(Loc, 1, "&amp;", 5);
64 break;
65 }
Ted Kremenek6a340832008-03-18 21:19:49 +000066 }
67 }
68}
69
Ted Kremenek053ef592008-03-27 17:15:29 +000070std::string html::EscapeText(const std::string& s, bool EscapeSpaces) {
71
72 unsigned len = s.size();
73 std::ostringstream os;
74
75 for (unsigned i = 0 ; i < len; ++i) {
76
77 char c = s[i];
78
79 switch (c) {
80 default:
81 os << c; break;
82
83 case ' ':
Ted Kremenek8fb00162008-03-31 23:14:05 +000084 if (EscapeSpaces) os << "&nbsp;";
Ted Kremenek487f8272008-03-27 17:28:58 +000085 else os << ' ';
Ted Kremenek053ef592008-03-27 17:15:29 +000086 break;
87
Ted Kremenek8fb00162008-03-31 23:14:05 +000088 case '\t': for (unsigned i = 0; i < 4; ++i) os << "&nbsp;"; break;
Ted Kremenek053ef592008-03-27 17:15:29 +000089 case '<': os << "&lt;"; break;
90 case '>': os << "&gt;"; break;
91 case '&': os << "&amp;"; break;
92 }
93 }
94
95 return os.str();
96}
97
Ted Kremenekb485cd12008-03-18 23:08:51 +000098static void AddLineNumber(Rewriter& R, unsigned LineNo,
99 SourceLocation B, SourceLocation E) {
Ted Kremenekf8309972008-03-19 01:30:02 +0000100
Ted Kremenekb485cd12008-03-18 23:08:51 +0000101 std::ostringstream os;
Ted Kremenek49cd6352008-04-03 07:12:29 +0000102 os << "<tr><td class=\"num\">" << LineNo << "</td><td class=\"line\">";
Ted Kremenek13e479b2008-03-19 07:53:42 +0000103
Ted Kremenek49cd6352008-04-03 07:12:29 +0000104 if (B == E) { // Handle empty lines.
105 os << " </td></tr>";
106 R.InsertStrBefore(B, os.str());
107 }
108 else {
109 R.InsertStrBefore(B, os.str());
110 R.InsertCStrBefore(E, "</td></tr>");
111 }
Ted Kremenekb485cd12008-03-18 23:08:51 +0000112}
113
114void html::AddLineNumbers(Rewriter& R, unsigned FileID) {
115
116 const llvm::MemoryBuffer *Buf = R.getSourceMgr().getBuffer(FileID);
117 const char* FileBeg = Buf->getBufferStart();
118 const char* FileEnd = Buf->getBufferEnd();
119 const char* C = FileBeg;
120
121 assert (C <= FileEnd);
122
123 unsigned LineNo = 0;
124 unsigned FilePos = 0;
125
126 while (C != FileEnd) {
127
128 ++LineNo;
129 unsigned LineStartPos = FilePos;
130 unsigned LineEndPos = FileEnd - FileBeg;
131
132 assert (FilePos <= LineEndPos);
133 assert (C < FileEnd);
134
135 // Scan until the newline (or end-of-file).
136
Ted Kremenek49cd6352008-04-03 07:12:29 +0000137 while (C != FileEnd) {
138 char c = *C;
139 ++C;
140
141 if (c == '\n') {
142 LineEndPos = FilePos++;
Ted Kremenekb485cd12008-03-18 23:08:51 +0000143 break;
144 }
Ted Kremenek49cd6352008-04-03 07:12:29 +0000145
146 ++FilePos;
147 }
Ted Kremenekb485cd12008-03-18 23:08:51 +0000148
149 AddLineNumber(R, LineNo,
150 SourceLocation::getFileLoc(FileID, LineStartPos),
Ted Kremenek49cd6352008-04-03 07:12:29 +0000151 SourceLocation::getFileLoc(FileID, LineEndPos));
Ted Kremenekd6c13602008-03-19 05:07:26 +0000152 }
153
154 // Add one big div tag that surrounds all of the code.
155
156 R.InsertCStrBefore(SourceLocation::getFileLoc(FileID, 0),
Ted Kremeneke8e019e2008-03-19 21:59:05 +0000157 "<table class=\"code\">\n");
Ted Kremenekd6c13602008-03-19 05:07:26 +0000158
159 R.InsertCStrAfter(SourceLocation::getFileLoc(FileID, FileEnd - FileBeg),
Ted Kremeneke8e019e2008-03-19 21:59:05 +0000160 "</table>");
Ted Kremenekb485cd12008-03-18 23:08:51 +0000161}
Ted Kremenekad0a2032008-03-19 06:14:37 +0000162
163void html::AddHeaderFooterInternalBuiltinCSS(Rewriter& R, unsigned FileID) {
164
165 const llvm::MemoryBuffer *Buf = R.getSourceMgr().getBuffer(FileID);
166 const char* FileStart = Buf->getBufferStart();
167 const char* FileEnd = Buf->getBufferEnd();
168
169 SourceLocation StartLoc = SourceLocation::getFileLoc(FileID, 0);
170 SourceLocation EndLoc = SourceLocation::getFileLoc(FileID, FileEnd-FileStart);
171
172 // Generate header
173
174 {
175 std::ostringstream os;
176
177 os << "<html>\n<head>\n"
Ted Kremenekeeacc522008-03-19 22:44:21 +0000178 << "<style type=\"text/css\">\n"
179 << " body { color:#000000; background-color:#ffffff }\n"
Ted Kremenek487f8272008-03-27 17:28:58 +0000180 << " body { font-family:Helvetica, sans-serif; font-size:10pt }\n"
181 << " h1 { font-size:12pt }\n"
Ted Kremeneke8e019e2008-03-19 21:59:05 +0000182 << " .code { border-spacing:0px; width:100%; }\n"
183 << " .code { font-family: \"Andale Mono\", fixed; font-size:10pt }\n"
184 << " .code { line-height: 1.2em }\n"
185 << " .num { width:2.5em; padding-right:2ex; background-color:#eeeeee }\n"
186 << " .num { text-align:right; font-size: smaller }\n"
Ted Kremenek0f1b67b2008-03-19 23:55:53 +0000187 << " .num { color:#444444 }\n"
Ted Kremeneke8e019e2008-03-19 21:59:05 +0000188 << " .line { padding-left: 1ex; border-left: 3px solid #ccc }\n"
189 << " .line { white-space: pre }\n"
Ted Kremenek9e628a02008-04-02 22:50:50 +0000190 << " .msg { background-color:#6F9DBE; color:#000000 }\n"
Ted Kremenek9d4e6592008-03-24 23:38:32 +0000191 << " .msg { -webkit-box-shadow:1px 1px 7px #000 }\n"
192 << " .msg { -webkit-border-radius:5px }\n"
Ted Kremeneke8e019e2008-03-19 21:59:05 +0000193 << " .msg { font-family:Helvetica, sans-serif; font-size: smaller }\n"
Ted Kremenekdb87ca02008-03-19 22:06:25 +0000194 << " .msg { font-weight: bold }\n"
Ted Kremeneke8e019e2008-03-19 21:59:05 +0000195 << " .msg { float:left }\n"
Ted Kremenekeeacc522008-03-19 22:44:21 +0000196 << " .msg { padding:0.5em 1ex 0.5em 1ex }\n"
197 << " .msg { margin-top:10px; margin-bottom:10px }\n"
Ted Kremenekf23621f2008-04-02 21:14:04 +0000198 << " .mrange { background-color:#dfddf3 }\n"
Ted Kremenek9e628a02008-04-02 22:50:50 +0000199 << " .mrange { border-bottom:1px solid #6F9DBE }\n"
Ted Kremenek718ceb12008-04-02 21:04:20 +0000200 << " .PathIndex { font-weight: bold }\n"
Ted Kremeneke8e019e2008-03-19 21:59:05 +0000201 << "</style>\n</head>\n<body>";
Ted Kremenekad0a2032008-03-19 06:14:37 +0000202
203 R.InsertStrBefore(StartLoc, os.str());
204 }
205
206 // Generate footer
207
208 {
209 std::ostringstream os;
210
211 os << "</body></html>\n";
212 R.InsertStrAfter(EndLoc, os.str());
213 }
214}
215
216