HTMLRewrite.cpp revision c01b46e2f115bed83f2f6f4a55809bf4003ee015
16a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek//== HTMLRewrite.cpp - Translate source code into prettified HTML --*- C++ -*-// 26a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek// 36a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek// The LLVM Compiler Infrastructure 46a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek// 56a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek// This file is distributed under the University of Illinois Open Source 66a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek// License. See LICENSE.TXT for details. 76a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek// 86a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek//===----------------------------------------------------------------------===// 96a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek// 106a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek// This file defines the HTMLRewriter clas, which is used to translate the 116a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek// text of a source file into prettified HTML. 126a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek// 136a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek//===----------------------------------------------------------------------===// 146a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek 15339b9c27759d7b6a53e2370f83f66e78b3254595Ted Kremenek#include "clang/Lex/Preprocessor.h" 166a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek#include "clang/Rewrite/Rewriter.h" 176a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek#include "clang/Rewrite/HTMLRewrite.h" 18867924dbeca06870573fd58d620032da6994b223Chris Lattner#include "clang/Lex/TokenConcatenation.h" 193245a0a1c7a4fd74fca845b2edba275bb126d773Chris Lattner#include "clang/Lex/Preprocessor.h" 206a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek#include "clang/Basic/SourceManager.h" 2157df3b950061c73d13d3116f747e79d7955a216aChris Lattner#include "llvm/ADT/SmallString.h" 22339b9c27759d7b6a53e2370f83f66e78b3254595Ted Kremenek#include "llvm/ADT/OwningPtr.h" 236a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek#include "llvm/Support/MemoryBuffer.h" 24a95d3750441ac8ad03e36af8e6e74039c9a3109dTed Kremenek#include "llvm/Support/raw_ostream.h" 256a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenekusing namespace clang; 266a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek 279402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner 285ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner/// HighlightRange - Highlight a range in the source code with the specified 295ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner/// start/end tags. B/E must be in the same file. This ensures that 305ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner/// start/end tags are placed at the start/end of each line if the range is 315ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner/// multiline. 325ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattnervoid html::HighlightRange(Rewriter &R, SourceLocation B, SourceLocation E, 335ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner const char *StartTag, const char *EndTag) { 345ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner SourceManager &SM = R.getSourceMgr(); 35f7cf85b330bedd2877e1371fb0a83e99751ae162Chris Lattner B = SM.getInstantiationLoc(B); 36f7cf85b330bedd2877e1371fb0a83e99751ae162Chris Lattner E = SM.getInstantiationLoc(E); 37a11d61793341fea195c29a0dab3fbd74f2b39a8cChris Lattner FileID FID = SM.getFileID(B); 38a11d61793341fea195c29a0dab3fbd74f2b39a8cChris Lattner assert(SM.getFileID(E) == FID && "B/E not in the same file!"); 395ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner 4052c29081281955d3db9e11d10573b2d38f709099Chris Lattner unsigned BOffset = SM.getFileOffset(B); 4152c29081281955d3db9e11d10573b2d38f709099Chris Lattner unsigned EOffset = SM.getFileOffset(E); 425ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner 435ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner // Include the whole end token in the range. 442c78b873f4f3823ae859c15674cb3d76c8554113Chris Lattner EOffset += Lexer::MeasureTokenLength(E, R.getSourceMgr(), R.getLangOpts()); 455ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner 462b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner HighlightRange(R.getEditBuffer(FID), BOffset, EOffset, 472b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner SM.getBufferData(FID).first, StartTag, EndTag); 485ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner} 495ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner 505ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner/// HighlightRange - This is the same as the above method, but takes 515ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner/// decomposed file locations. 525ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattnervoid html::HighlightRange(RewriteBuffer &RB, unsigned B, unsigned E, 535ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner const char *BufferStart, 545ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner const char *StartTag, const char *EndTag) { 559402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner // Insert the tag at the absolute start/end of the range. 565ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner RB.InsertTextAfter(B, StartTag, strlen(StartTag)); 575ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner RB.InsertTextBefore(E, EndTag, strlen(EndTag)); 585ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner 599402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner // Scan the range to see if there is a \r or \n. If so, and if the line is 609402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner // not blank, insert tags on that line as well. 619402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner bool HadOpenTag = true; 629402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner 639402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner unsigned LastNonWhiteSpace = B; 649402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner for (unsigned i = B; i != E; ++i) { 659402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner switch (BufferStart[i]) { 669402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner case '\r': 679402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner case '\n': 689402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner // Okay, we found a newline in the range. If we have an open tag, we need 699402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner // to insert a close tag at the first non-whitespace before the newline. 709402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner if (HadOpenTag) 719402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner RB.InsertTextBefore(LastNonWhiteSpace+1, EndTag, strlen(EndTag)); 729402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner 739402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner // Instead of inserting an open tag immediately after the newline, we 749402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner // wait until we see a non-whitespace character. This prevents us from 759402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner // inserting tags around blank lines, and also allows the open tag to 769402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner // be put *after* whitespace on a non-blank line. 779402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner HadOpenTag = false; 789402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner break; 799402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner case '\0': 809402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner case ' ': 819402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner case '\t': 829402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner case '\f': 839402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner case '\v': 849402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner // Ignore whitespace. 859402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner break; 869402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner 879402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner default: 889402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner // If there is no tag open, do it now. 899402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner if (!HadOpenTag) { 909402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner RB.InsertTextAfter(i, StartTag, strlen(StartTag)); 919402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner HadOpenTag = true; 929402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner } 939402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner 949402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner // Remember this character. 959402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner LastNonWhiteSpace = i; 969402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner break; 979402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner } 989402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner } 995ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner} 1005ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner 1012b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattnervoid html::EscapeText(Rewriter &R, FileID FID, 102fa5be3617294f0e3c341f0ecb6b2076478b1b5acTed Kremenek bool EscapeSpaces, bool ReplaceTabs) { 1036a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek 1042b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner const llvm::MemoryBuffer *Buf = R.getSourceMgr().getBuffer(FID); 1056a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek const char* C = Buf->getBufferStart(); 1066a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek const char* FileEnd = Buf->getBufferEnd(); 1076a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek 1086a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek assert (C <= FileEnd); 1096a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek 1102b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner RewriteBuffer &RB = R.getEditBuffer(FID); 1115c176f7a9ba9f7084b903393845be24f85e091daChris Lattner 1125c176f7a9ba9f7084b903393845be24f85e091daChris Lattner unsigned ColNo = 0; 1136a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek for (unsigned FilePos = 0; C != FileEnd ; ++C, ++FilePos) { 1146a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek switch (*C) { 1155c176f7a9ba9f7084b903393845be24f85e091daChris Lattner default: ++ColNo; break; 1165c176f7a9ba9f7084b903393845be24f85e091daChris Lattner case '\n': 1175c176f7a9ba9f7084b903393845be24f85e091daChris Lattner case '\r': 1185c176f7a9ba9f7084b903393845be24f85e091daChris Lattner ColNo = 0; 1195c176f7a9ba9f7084b903393845be24f85e091daChris Lattner break; 120735271479ac57c27f744806859efd5b001dea248Chris Lattner 121735271479ac57c27f744806859efd5b001dea248Chris Lattner case ' ': 122735271479ac57c27f744806859efd5b001dea248Chris Lattner if (EscapeSpaces) 123735271479ac57c27f744806859efd5b001dea248Chris Lattner RB.ReplaceText(FilePos, 1, " ", 6); 1245c176f7a9ba9f7084b903393845be24f85e091daChris Lattner ++ColNo; 125735271479ac57c27f744806859efd5b001dea248Chris Lattner break; 126f3d8d19caf6f1a21785eee8d62c45ef5a0a0e72eChris Lattner case '\f': 127f3d8d19caf6f1a21785eee8d62c45ef5a0a0e72eChris Lattner RB.ReplaceText(FilePos, 1, "<hr>", 4); 128f3d8d19caf6f1a21785eee8d62c45ef5a0a0e72eChris Lattner ColNo = 0; 129f3d8d19caf6f1a21785eee8d62c45ef5a0a0e72eChris Lattner break; 130f3d8d19caf6f1a21785eee8d62c45ef5a0a0e72eChris Lattner 1315c176f7a9ba9f7084b903393845be24f85e091daChris Lattner case '\t': { 132735271479ac57c27f744806859efd5b001dea248Chris Lattner if (!ReplaceTabs) 13349cd6354d5373245dd2e69ca7b7113e6a795d36eTed Kremenek break; 1345c176f7a9ba9f7084b903393845be24f85e091daChris Lattner unsigned NumSpaces = 8-(ColNo&7); 135735271479ac57c27f744806859efd5b001dea248Chris Lattner if (EscapeSpaces) 1368aa06aca8b2d3771a5405d789b2e704149045dd4Chris Lattner RB.ReplaceText(FilePos, 1, " " 1375c176f7a9ba9f7084b903393845be24f85e091daChris Lattner " ", 6*NumSpaces); 138735271479ac57c27f744806859efd5b001dea248Chris Lattner else 1395c176f7a9ba9f7084b903393845be24f85e091daChris Lattner RB.ReplaceText(FilePos, 1, " ", NumSpaces); 1405c176f7a9ba9f7084b903393845be24f85e091daChris Lattner ColNo += NumSpaces; 141735271479ac57c27f744806859efd5b001dea248Chris Lattner break; 1425c176f7a9ba9f7084b903393845be24f85e091daChris Lattner } 143735271479ac57c27f744806859efd5b001dea248Chris Lattner case '<': 144735271479ac57c27f744806859efd5b001dea248Chris Lattner RB.ReplaceText(FilePos, 1, "<", 4); 1455c176f7a9ba9f7084b903393845be24f85e091daChris Lattner ++ColNo; 146735271479ac57c27f744806859efd5b001dea248Chris Lattner break; 147735271479ac57c27f744806859efd5b001dea248Chris Lattner 148735271479ac57c27f744806859efd5b001dea248Chris Lattner case '>': 149735271479ac57c27f744806859efd5b001dea248Chris Lattner RB.ReplaceText(FilePos, 1, ">", 4); 1505c176f7a9ba9f7084b903393845be24f85e091daChris Lattner ++ColNo; 151735271479ac57c27f744806859efd5b001dea248Chris Lattner break; 152735271479ac57c27f744806859efd5b001dea248Chris Lattner 153735271479ac57c27f744806859efd5b001dea248Chris Lattner case '&': 154735271479ac57c27f744806859efd5b001dea248Chris Lattner RB.ReplaceText(FilePos, 1, "&", 5); 1555c176f7a9ba9f7084b903393845be24f85e091daChris Lattner ++ColNo; 156735271479ac57c27f744806859efd5b001dea248Chris Lattner break; 1576a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek } 1586a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek } 1596a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek} 1606a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek 161fa5be3617294f0e3c341f0ecb6b2076478b1b5acTed Kremenekstd::string html::EscapeText(const std::string& s, bool EscapeSpaces, 162fa5be3617294f0e3c341f0ecb6b2076478b1b5acTed Kremenek bool ReplaceTabs) { 163053ef593fa9d2b890645a914eee203231fb34458Ted Kremenek 164053ef593fa9d2b890645a914eee203231fb34458Ted Kremenek unsigned len = s.size(); 165a95d3750441ac8ad03e36af8e6e74039c9a3109dTed Kremenek std::string Str; 166a95d3750441ac8ad03e36af8e6e74039c9a3109dTed Kremenek llvm::raw_string_ostream os(Str); 167053ef593fa9d2b890645a914eee203231fb34458Ted Kremenek 168053ef593fa9d2b890645a914eee203231fb34458Ted Kremenek for (unsigned i = 0 ; i < len; ++i) { 169053ef593fa9d2b890645a914eee203231fb34458Ted Kremenek 170053ef593fa9d2b890645a914eee203231fb34458Ted Kremenek char c = s[i]; 171053ef593fa9d2b890645a914eee203231fb34458Ted Kremenek switch (c) { 1728570f0b0fde7ca812f8d37f52305f3df4dd2ce01Chris Lattner default: 1738570f0b0fde7ca812f8d37f52305f3df4dd2ce01Chris Lattner os << c; break; 1748570f0b0fde7ca812f8d37f52305f3df4dd2ce01Chris Lattner 1758570f0b0fde7ca812f8d37f52305f3df4dd2ce01Chris Lattner case ' ': 1768570f0b0fde7ca812f8d37f52305f3df4dd2ce01Chris Lattner if (EscapeSpaces) os << " "; 1778570f0b0fde7ca812f8d37f52305f3df4dd2ce01Chris Lattner else os << ' '; 1788570f0b0fde7ca812f8d37f52305f3df4dd2ce01Chris Lattner break; 1798570f0b0fde7ca812f8d37f52305f3df4dd2ce01Chris Lattner 180c01b46e2f115bed83f2f6f4a55809bf4003ee015Zhongxing Xu case '\t': 181c01b46e2f115bed83f2f6f4a55809bf4003ee015Zhongxing Xu if (ReplaceTabs) { 182c01b46e2f115bed83f2f6f4a55809bf4003ee015Zhongxing Xu if (EscapeSpaces) 183c01b46e2f115bed83f2f6f4a55809bf4003ee015Zhongxing Xu for (unsigned i = 0; i < 4; ++i) 184c01b46e2f115bed83f2f6f4a55809bf4003ee015Zhongxing Xu os << " "; 185c01b46e2f115bed83f2f6f4a55809bf4003ee015Zhongxing Xu else 186c01b46e2f115bed83f2f6f4a55809bf4003ee015Zhongxing Xu for (unsigned i = 0; i < 4; ++i) 187c01b46e2f115bed83f2f6f4a55809bf4003ee015Zhongxing Xu os << " "; 188c01b46e2f115bed83f2f6f4a55809bf4003ee015Zhongxing Xu } 189c01b46e2f115bed83f2f6f4a55809bf4003ee015Zhongxing Xu else 190c01b46e2f115bed83f2f6f4a55809bf4003ee015Zhongxing Xu os << c; 1918570f0b0fde7ca812f8d37f52305f3df4dd2ce01Chris Lattner 192c01b46e2f115bed83f2f6f4a55809bf4003ee015Zhongxing Xu break; 1938570f0b0fde7ca812f8d37f52305f3df4dd2ce01Chris Lattner 194c01b46e2f115bed83f2f6f4a55809bf4003ee015Zhongxing Xu case '<': os << "<"; break; 195c01b46e2f115bed83f2f6f4a55809bf4003ee015Zhongxing Xu case '>': os << ">"; break; 196c01b46e2f115bed83f2f6f4a55809bf4003ee015Zhongxing Xu case '&': os << "&"; break; 197053ef593fa9d2b890645a914eee203231fb34458Ted Kremenek } 198053ef593fa9d2b890645a914eee203231fb34458Ted Kremenek } 199053ef593fa9d2b890645a914eee203231fb34458Ted Kremenek 200053ef593fa9d2b890645a914eee203231fb34458Ted Kremenek return os.str(); 201053ef593fa9d2b890645a914eee203231fb34458Ted Kremenek} 202053ef593fa9d2b890645a914eee203231fb34458Ted Kremenek 2038570f0b0fde7ca812f8d37f52305f3df4dd2ce01Chris Lattnerstatic void AddLineNumber(RewriteBuffer &RB, unsigned LineNo, 2048570f0b0fde7ca812f8d37f52305f3df4dd2ce01Chris Lattner unsigned B, unsigned E) { 20557df3b950061c73d13d3116f747e79d7955a216aChris Lattner llvm::SmallString<100> Str; 20657df3b950061c73d13d3116f747e79d7955a216aChris Lattner Str += "<tr><td class=\"num\" id=\"LN"; 20757df3b950061c73d13d3116f747e79d7955a216aChris Lattner Str.append_uint(LineNo); 20857df3b950061c73d13d3116f747e79d7955a216aChris Lattner Str += "\">"; 20957df3b950061c73d13d3116f747e79d7955a216aChris Lattner Str.append_uint(LineNo); 21057df3b950061c73d13d3116f747e79d7955a216aChris Lattner Str += "</td><td class=\"line\">"; 21157df3b950061c73d13d3116f747e79d7955a216aChris Lattner 21249cd6354d5373245dd2e69ca7b7113e6a795d36eTed Kremenek if (B == E) { // Handle empty lines. 21357df3b950061c73d13d3116f747e79d7955a216aChris Lattner Str += " </td></tr>"; 2148570f0b0fde7ca812f8d37f52305f3df4dd2ce01Chris Lattner RB.InsertTextBefore(B, &Str[0], Str.size()); 21557df3b950061c73d13d3116f747e79d7955a216aChris Lattner } else { 2168570f0b0fde7ca812f8d37f52305f3df4dd2ce01Chris Lattner RB.InsertTextBefore(B, &Str[0], Str.size()); 2178570f0b0fde7ca812f8d37f52305f3df4dd2ce01Chris Lattner RB.InsertTextBefore(E, "</td></tr>", strlen("</td></tr>")); 21849cd6354d5373245dd2e69ca7b7113e6a795d36eTed Kremenek } 219b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek} 220b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek 2212b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattnervoid html::AddLineNumbers(Rewriter& R, FileID FID) { 222b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek 2232b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner const llvm::MemoryBuffer *Buf = R.getSourceMgr().getBuffer(FID); 224b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek const char* FileBeg = Buf->getBufferStart(); 225b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek const char* FileEnd = Buf->getBufferEnd(); 226b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek const char* C = FileBeg; 2272b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner RewriteBuffer &RB = R.getEditBuffer(FID); 228b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek 229b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek assert (C <= FileEnd); 230b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek 231b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek unsigned LineNo = 0; 232b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek unsigned FilePos = 0; 233b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek 234b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek while (C != FileEnd) { 235b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek 236b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek ++LineNo; 237b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek unsigned LineStartPos = FilePos; 238b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek unsigned LineEndPos = FileEnd - FileBeg; 239b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek 240b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek assert (FilePos <= LineEndPos); 241b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek assert (C < FileEnd); 242b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek 243b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek // Scan until the newline (or end-of-file). 244b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek 24549cd6354d5373245dd2e69ca7b7113e6a795d36eTed Kremenek while (C != FileEnd) { 24649cd6354d5373245dd2e69ca7b7113e6a795d36eTed Kremenek char c = *C; 24749cd6354d5373245dd2e69ca7b7113e6a795d36eTed Kremenek ++C; 24849cd6354d5373245dd2e69ca7b7113e6a795d36eTed Kremenek 24949cd6354d5373245dd2e69ca7b7113e6a795d36eTed Kremenek if (c == '\n') { 25049cd6354d5373245dd2e69ca7b7113e6a795d36eTed Kremenek LineEndPos = FilePos++; 251b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek break; 252b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek } 25349cd6354d5373245dd2e69ca7b7113e6a795d36eTed Kremenek 25449cd6354d5373245dd2e69ca7b7113e6a795d36eTed Kremenek ++FilePos; 25549cd6354d5373245dd2e69ca7b7113e6a795d36eTed Kremenek } 256b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek 2578570f0b0fde7ca812f8d37f52305f3df4dd2ce01Chris Lattner AddLineNumber(RB, LineNo, LineStartPos, LineEndPos); 258d6c1360c2bf234c73572a865f119d0518aca8154Ted Kremenek } 259d6c1360c2bf234c73572a865f119d0518aca8154Ted Kremenek 2608570f0b0fde7ca812f8d37f52305f3df4dd2ce01Chris Lattner // Add one big table tag that surrounds all of the code. 2618570f0b0fde7ca812f8d37f52305f3df4dd2ce01Chris Lattner RB.InsertTextBefore(0, "<table class=\"code\">\n", 2628570f0b0fde7ca812f8d37f52305f3df4dd2ce01Chris Lattner strlen("<table class=\"code\">\n")); 263d6c1360c2bf234c73572a865f119d0518aca8154Ted Kremenek 2648570f0b0fde7ca812f8d37f52305f3df4dd2ce01Chris Lattner RB.InsertTextAfter(FileEnd - FileBeg, "</table>", strlen("</table>")); 265b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek} 266ad0a203130dc5d1fb7231b88767174511424fa98Ted Kremenek 2672b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattnervoid html::AddHeaderFooterInternalBuiltinCSS(Rewriter& R, FileID FID, 268f6f593fae2f0531b4bc06891941f7fbba5217618Ted Kremenek const char *title) { 269ad0a203130dc5d1fb7231b88767174511424fa98Ted Kremenek 2702b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner const llvm::MemoryBuffer *Buf = R.getSourceMgr().getBuffer(FID); 271ad0a203130dc5d1fb7231b88767174511424fa98Ted Kremenek const char* FileStart = Buf->getBufferStart(); 272ad0a203130dc5d1fb7231b88767174511424fa98Ted Kremenek const char* FileEnd = Buf->getBufferEnd(); 273ad0a203130dc5d1fb7231b88767174511424fa98Ted Kremenek 2742b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner SourceLocation StartLoc = R.getSourceMgr().getLocForStartOfFile(FID); 2752b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner SourceLocation EndLoc = StartLoc.getFileLocWithOffset(FileEnd-FileStart); 276ad0a203130dc5d1fb7231b88767174511424fa98Ted Kremenek 277a95d3750441ac8ad03e36af8e6e74039c9a3109dTed Kremenek std::string s; 278a95d3750441ac8ad03e36af8e6e74039c9a3109dTed Kremenek llvm::raw_string_ostream os(s); 279f6f593fae2f0531b4bc06891941f7fbba5217618Ted Kremenek os << "<!doctype html>\n" // Use HTML 5 doctype 280f6f593fae2f0531b4bc06891941f7fbba5217618Ted Kremenek "<html>\n<head>\n"; 281f6f593fae2f0531b4bc06891941f7fbba5217618Ted Kremenek 282f6f593fae2f0531b4bc06891941f7fbba5217618Ted Kremenek if (title) 283f6f593fae2f0531b4bc06891941f7fbba5217618Ted Kremenek os << "<title>" << html::EscapeText(title) << "</title>\n"; 284f6f593fae2f0531b4bc06891941f7fbba5217618Ted Kremenek 285f6f593fae2f0531b4bc06891941f7fbba5217618Ted Kremenek os << "<style type=\"text/css\">\n" 28670bcba6030a76edf46c4f941ad9a5297a1f98c47Ted Kremenek " body { color:#000000; background-color:#ffffff }\n" 28770bcba6030a76edf46c4f941ad9a5297a1f98c47Ted Kremenek " body { font-family:Helvetica, sans-serif; font-size:10pt }\n" 2884b0f81323b518429203051bbcd4864bbf4b000a9Ted Kremenek " h1 { font-size:14pt }\n" 289f5016260522e449e9bacdb0e5a87ad3932d9fbd4Ted Kremenek " .code { border-collapse:collapse; width:100%; }\n" 29070bcba6030a76edf46c4f941ad9a5297a1f98c47Ted Kremenek " .code { font-family: \"Andale Mono\", monospace; font-size:10pt }\n" 29170bcba6030a76edf46c4f941ad9a5297a1f98c47Ted Kremenek " .code { line-height: 1.2em }\n" 292f5016260522e449e9bacdb0e5a87ad3932d9fbd4Ted Kremenek " .comment { color: green; font-style: oblique }\n" 293f5016260522e449e9bacdb0e5a87ad3932d9fbd4Ted Kremenek " .keyword { color: blue }\n" 294cc1b8532a113fa3216096757b3b4e203867bd5e0Ted Kremenek " .string_literal { color: red }\n" 295f5016260522e449e9bacdb0e5a87ad3932d9fbd4Ted Kremenek " .directive { color: darkmagenta }\n" 2966f46be279f4bc8fc24611f060258bcfbe1c175c4Chris Lattner // Macro expansions. 29707339a63b46e38c954fcccbef721c609d0c2040eTed Kremenek " .expansion { display: none; }\n" 29807339a63b46e38c954fcccbef721c609d0c2040eTed Kremenek " .macro:hover .expansion { display: block; border: 2px solid #FF0000; " 299dc5be47542e6d4a28d20abf9c0f0a0edd72939b6Chris Lattner "padding: 2px; background-color:#FFF0F0; font-weight: normal; " 3006f46be279f4bc8fc24611f060258bcfbe1c175c4Chris Lattner " -webkit-border-radius:5px; -webkit-box-shadow:1px 1px 7px #000; " 3018aa06aca8b2d3771a5405d789b2e704149045dd4Chris Lattner "position: absolute; top: -1em; left:10em; z-index: 1 } \n" 302f5016260522e449e9bacdb0e5a87ad3932d9fbd4Ted Kremenek " .macro { color: darkmagenta; background-color:LemonChiffon;" 3036f46be279f4bc8fc24611f060258bcfbe1c175c4Chris Lattner // Macros are position: relative to provide base for expansions. 3046f46be279f4bc8fc24611f060258bcfbe1c175c4Chris Lattner " position: relative }\n" 30570bcba6030a76edf46c4f941ad9a5297a1f98c47Ted Kremenek " .num { width:2.5em; padding-right:2ex; background-color:#eeeeee }\n" 3062223622d113d7cba04c2dfdbe032e2ba6ba10bc4Ted Kremenek " .num { text-align:right; font-size:8pt }\n" 30770bcba6030a76edf46c4f941ad9a5297a1f98c47Ted Kremenek " .num { color:#444444 }\n" 30870bcba6030a76edf46c4f941ad9a5297a1f98c47Ted Kremenek " .line { padding-left: 1ex; border-left: 3px solid #ccc }\n" 30970bcba6030a76edf46c4f941ad9a5297a1f98c47Ted Kremenek " .line { white-space: pre }\n" 31070bcba6030a76edf46c4f941ad9a5297a1f98c47Ted Kremenek " .msg { -webkit-box-shadow:1px 1px 7px #000 }\n" 31170bcba6030a76edf46c4f941ad9a5297a1f98c47Ted Kremenek " .msg { -webkit-border-radius:5px }\n" 3122223622d113d7cba04c2dfdbe032e2ba6ba10bc4Ted Kremenek " .msg { font-family:Helvetica, sans-serif; font-size:8pt }\n" 31370bcba6030a76edf46c4f941ad9a5297a1f98c47Ted Kremenek " .msg { float:left }\n" 3143c59823096fe28a69a81f899c7f9f0e6eb8071a0Ted Kremenek " .msg { padding:0.25em 1ex 0.25em 1ex }\n" 31570bcba6030a76edf46c4f941ad9a5297a1f98c47Ted Kremenek " .msg { margin-top:10px; margin-bottom:10px }\n" 3162f10398814e8d58cce029a7e73af21bb274dcd42Ted Kremenek " .msg { font-weight:bold }\n" 31780bae763da8bf3f3c73379a1e5d10f5bce266bcaTed Kremenek " .msg { max-width:60em; word-wrap: break-word; white-space: pre-wrap }\n" 31880bae763da8bf3f3c73379a1e5d10f5bce266bcaTed Kremenek " .msgT { padding:0x; spacing:0x }\n" 3192f10398814e8d58cce029a7e73af21bb274dcd42Ted Kremenek " .msgEvent { background-color:#fff8b4; color:#000000 }\n" 32080bae763da8bf3f3c73379a1e5d10f5bce266bcaTed Kremenek " .msgControl { background-color:#bbbbbb; color:#000000 }\n" 32170bcba6030a76edf46c4f941ad9a5297a1f98c47Ted Kremenek " .mrange { background-color:#dfddf3 }\n" 32270bcba6030a76edf46c4f941ad9a5297a1f98c47Ted Kremenek " .mrange { border-bottom:1px solid #6F9DBE }\n" 3233c59823096fe28a69a81f899c7f9f0e6eb8071a0Ted Kremenek " .PathIndex { font-weight: bold; padding:0px 5px 0px 5px; " 3243c59823096fe28a69a81f899c7f9f0e6eb8071a0Ted Kremenek "margin-right:5px; }\n" 32500f01e440573b2bdf6549991e0ca48cc6747e3a2Ted Kremenek " .PathIndex { -webkit-border-radius:8px }\n" 32600f01e440573b2bdf6549991e0ca48cc6747e3a2Ted Kremenek " .PathIndexEvent { background-color:#bfba87 }\n" 32700f01e440573b2bdf6549991e0ca48cc6747e3a2Ted Kremenek " .PathIndexControl { background-color:#8c8c8c }\n" 3284b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor " .CodeInsertionHint { font-weight: bold; background-color: #10dd10 }\n" 3294b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor " .CodeRemovalHint { background-color:#de1010 }\n" 3304b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor " .CodeRemovalHint { border-bottom:1px solid #6F9DBE }\n" 3314b0f81323b518429203051bbcd4864bbf4b000a9Ted Kremenek " table.simpletable {\n" 3324b0f81323b518429203051bbcd4864bbf4b000a9Ted Kremenek " padding: 5px;\n" 3334b0f81323b518429203051bbcd4864bbf4b000a9Ted Kremenek " font-size:12pt;\n" 3344b0f81323b518429203051bbcd4864bbf4b000a9Ted Kremenek " margin:20px;\n" 3354b0f81323b518429203051bbcd4864bbf4b000a9Ted Kremenek " border-collapse: collapse; border-spacing: 0px;\n" 3364b0f81323b518429203051bbcd4864bbf4b000a9Ted Kremenek " }\n" 3374b0f81323b518429203051bbcd4864bbf4b000a9Ted Kremenek " td.rowname {\n" 3384b0f81323b518429203051bbcd4864bbf4b000a9Ted Kremenek " text-align:right; font-weight:bold; color:#444444;\n" 3394b0f81323b518429203051bbcd4864bbf4b000a9Ted Kremenek " padding-right:2ex; }\n" 340f6f593fae2f0531b4bc06891941f7fbba5217618Ted Kremenek "</style>\n</head>\n<body>"; 34170bcba6030a76edf46c4f941ad9a5297a1f98c47Ted Kremenek 342f6f593fae2f0531b4bc06891941f7fbba5217618Ted Kremenek // Generate header 343f6f593fae2f0531b4bc06891941f7fbba5217618Ted Kremenek R.InsertStrBefore(StartLoc, os.str()); 344ad0a203130dc5d1fb7231b88767174511424fa98Ted Kremenek // Generate footer 345ad0a203130dc5d1fb7231b88767174511424fa98Ted Kremenek 34670bcba6030a76edf46c4f941ad9a5297a1f98c47Ted Kremenek R.InsertCStrAfter(EndLoc, "</body></html>\n"); 347ad0a203130dc5d1fb7231b88767174511424fa98Ted Kremenek} 3483245a0a1c7a4fd74fca845b2edba275bb126d773Chris Lattner 3493245a0a1c7a4fd74fca845b2edba275bb126d773Chris Lattner/// SyntaxHighlight - Relex the specified FileID and annotate the HTML with 3503245a0a1c7a4fd74fca845b2edba275bb126d773Chris Lattner/// information about keywords, macro expansions etc. This uses the macro 3513245a0a1c7a4fd74fca845b2edba275bb126d773Chris Lattner/// table state from the end of the file, so it won't be perfectly perfect, 3523245a0a1c7a4fd74fca845b2edba275bb126d773Chris Lattner/// but it will be reasonably close. 3532b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattnervoid html::SyntaxHighlight(Rewriter &R, FileID FID, Preprocessor &PP) { 3542b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner RewriteBuffer &RB = R.getEditBuffer(FID); 3553245a0a1c7a4fd74fca845b2edba275bb126d773Chris Lattner 35605db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner const SourceManager &SM = PP.getSourceManager(); 35705db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner Lexer L(FID, SM, PP.getLangOptions()); 358025c3a66402fb713c2d9bf5dc174ff264765379aChris Lattner const char *BufferStart = L.getBufferStart(); 359a745e8c52839d9c8dd0fd8d5276b4eab182ec7f2Chris Lattner 3603245a0a1c7a4fd74fca845b2edba275bb126d773Chris Lattner // Inform the preprocessor that we want to retain comments as tokens, so we 3613245a0a1c7a4fd74fca845b2edba275bb126d773Chris Lattner // can highlight them. 362678c6358c8d4e368c78629099142397c63c1ee35Chris Lattner L.SetCommentRetentionState(true); 3633245a0a1c7a4fd74fca845b2edba275bb126d773Chris Lattner 364c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner // Lex all the tokens in raw mode, to avoid entering #includes or expanding 365c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner // macros. 3663245a0a1c7a4fd74fca845b2edba275bb126d773Chris Lattner Token Tok; 367590f0cc643274267d4d41125b62557e1d87886c3Chris Lattner L.LexFromRawLexer(Tok); 36874ea3e5c57c087c046223096a97ea4e365f85eb6Chris Lattner 36974ea3e5c57c087c046223096a97ea4e365f85eb6Chris Lattner while (Tok.isNot(tok::eof)) { 37074ea3e5c57c087c046223096a97ea4e365f85eb6Chris Lattner // Since we are lexing unexpanded tokens, all tokens are from the main 37174ea3e5c57c087c046223096a97ea4e365f85eb6Chris Lattner // FileID. 37205db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner unsigned TokOffs = SM.getFileOffset(Tok.getLocation()); 3733245a0a1c7a4fd74fca845b2edba275bb126d773Chris Lattner unsigned TokLen = Tok.getLength(); 3743245a0a1c7a4fd74fca845b2edba275bb126d773Chris Lattner switch (Tok.getKind()) { 375a745e8c52839d9c8dd0fd8d5276b4eab182ec7f2Chris Lattner default: break; 376a745e8c52839d9c8dd0fd8d5276b4eab182ec7f2Chris Lattner case tok::identifier: { 377a745e8c52839d9c8dd0fd8d5276b4eab182ec7f2Chris Lattner // Fill in Result.IdentifierInfo, looking up the identifier in the 378a745e8c52839d9c8dd0fd8d5276b4eab182ec7f2Chris Lattner // identifier table. 379a745e8c52839d9c8dd0fd8d5276b4eab182ec7f2Chris Lattner IdentifierInfo *II = PP.LookUpIdentifierInfo(Tok, BufferStart+TokOffs); 380a745e8c52839d9c8dd0fd8d5276b4eab182ec7f2Chris Lattner 381a745e8c52839d9c8dd0fd8d5276b4eab182ec7f2Chris Lattner // If this is a pp-identifier, for a keyword, highlight it as such. 3825ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner if (II->getTokenID() != tok::identifier) 3835ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner HighlightRange(RB, TokOffs, TokOffs+TokLen, BufferStart, 3845ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner "<span class='keyword'>", "</span>"); 385c4586c234edd8df0477a895aebcbc3eb220aed6bChris Lattner break; 386a745e8c52839d9c8dd0fd8d5276b4eab182ec7f2Chris Lattner } 3873245a0a1c7a4fd74fca845b2edba275bb126d773Chris Lattner case tok::comment: 3885ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner HighlightRange(RB, TokOffs, TokOffs+TokLen, BufferStart, 3895ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner "<span class='comment'>", "</span>"); 3903245a0a1c7a4fd74fca845b2edba275bb126d773Chris Lattner break; 391cc1b8532a113fa3216096757b3b4e203867bd5e0Ted Kremenek case tok::wide_string_literal: 392cc1b8532a113fa3216096757b3b4e203867bd5e0Ted Kremenek // Chop off the L prefix 393cc1b8532a113fa3216096757b3b4e203867bd5e0Ted Kremenek ++TokOffs; 394cc1b8532a113fa3216096757b3b4e203867bd5e0Ted Kremenek --TokLen; 395cc1b8532a113fa3216096757b3b4e203867bd5e0Ted Kremenek // FALL THROUGH. 396cc1b8532a113fa3216096757b3b4e203867bd5e0Ted Kremenek case tok::string_literal: 397cc1b8532a113fa3216096757b3b4e203867bd5e0Ted Kremenek HighlightRange(RB, TokOffs, TokOffs+TokLen, BufferStart, 398cc1b8532a113fa3216096757b3b4e203867bd5e0Ted Kremenek "<span class='string_literal'>", "</span>"); 399cc1b8532a113fa3216096757b3b4e203867bd5e0Ted Kremenek break; 4005deb96d06583abb751463427457d46041af262d0Chris Lattner case tok::hash: { 40174ea3e5c57c087c046223096a97ea4e365f85eb6Chris Lattner // If this is a preprocessor directive, all tokens to end of line are too. 4025deb96d06583abb751463427457d46041af262d0Chris Lattner if (!Tok.isAtStartOfLine()) 4035deb96d06583abb751463427457d46041af262d0Chris Lattner break; 4045deb96d06583abb751463427457d46041af262d0Chris Lattner 4055deb96d06583abb751463427457d46041af262d0Chris Lattner // Eat all of the tokens until we get to the next one at the start of 4065deb96d06583abb751463427457d46041af262d0Chris Lattner // line. 4075deb96d06583abb751463427457d46041af262d0Chris Lattner unsigned TokEnd = TokOffs+TokLen; 408590f0cc643274267d4d41125b62557e1d87886c3Chris Lattner L.LexFromRawLexer(Tok); 4095deb96d06583abb751463427457d46041af262d0Chris Lattner while (!Tok.isAtStartOfLine() && Tok.isNot(tok::eof)) { 41005db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner TokEnd = SM.getFileOffset(Tok.getLocation())+Tok.getLength(); 411590f0cc643274267d4d41125b62557e1d87886c3Chris Lattner L.LexFromRawLexer(Tok); 41274ea3e5c57c087c046223096a97ea4e365f85eb6Chris Lattner } 4135deb96d06583abb751463427457d46041af262d0Chris Lattner 4145deb96d06583abb751463427457d46041af262d0Chris Lattner // Find end of line. This is a hack. 4155deb96d06583abb751463427457d46041af262d0Chris Lattner HighlightRange(RB, TokOffs, TokEnd, BufferStart, 4165deb96d06583abb751463427457d46041af262d0Chris Lattner "<span class='directive'>", "</span>"); 4175deb96d06583abb751463427457d46041af262d0Chris Lattner 4185deb96d06583abb751463427457d46041af262d0Chris Lattner // Don't skip the next token. 4195deb96d06583abb751463427457d46041af262d0Chris Lattner continue; 4205deb96d06583abb751463427457d46041af262d0Chris Lattner } 4213245a0a1c7a4fd74fca845b2edba275bb126d773Chris Lattner } 4223245a0a1c7a4fd74fca845b2edba275bb126d773Chris Lattner 423590f0cc643274267d4d41125b62557e1d87886c3Chris Lattner L.LexFromRawLexer(Tok); 42474ea3e5c57c087c046223096a97ea4e365f85eb6Chris Lattner } 4253245a0a1c7a4fd74fca845b2edba275bb126d773Chris Lattner} 426c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner 4277c175fb196a2bc3dbc86ea3865c713e1875f3f6dChris Lattnernamespace { 4287c175fb196a2bc3dbc86ea3865c713e1875f3f6dChris Lattner/// IgnoringDiagClient - This is a diagnostic client that just ignores all 4297c175fb196a2bc3dbc86ea3865c713e1875f3f6dChris Lattner/// diags. 4307c175fb196a2bc3dbc86ea3865c713e1875f3f6dChris Lattnerclass IgnoringDiagClient : public DiagnosticClient { 4317c175fb196a2bc3dbc86ea3865c713e1875f3f6dChris Lattner void HandleDiagnostic(Diagnostic::Level DiagLevel, 4327c175fb196a2bc3dbc86ea3865c713e1875f3f6dChris Lattner const DiagnosticInfo &Info) { 4337c175fb196a2bc3dbc86ea3865c713e1875f3f6dChris Lattner // Just ignore it. 4347c175fb196a2bc3dbc86ea3865c713e1875f3f6dChris Lattner } 4357c175fb196a2bc3dbc86ea3865c713e1875f3f6dChris Lattner}; 4367c175fb196a2bc3dbc86ea3865c713e1875f3f6dChris Lattner} 4377c175fb196a2bc3dbc86ea3865c713e1875f3f6dChris Lattner 438c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner/// HighlightMacros - This uses the macro table state from the end of the 43905db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner/// file, to re-expand macros and insert (into the HTML) information about the 440c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner/// macro expansions. This won't be perfectly perfect, but it will be 441c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner/// reasonably close. 4422b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattnervoid html::HighlightMacros(Rewriter &R, FileID FID, Preprocessor& PP) { 44305db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner // Re-lex the raw token stream into a token buffer. 44405db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner const SourceManager &SM = PP.getSourceManager(); 44505db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner std::vector<Token> TokenStream; 44605db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner 44705db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner Lexer L(FID, SM, PP.getLangOptions()); 44805db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner 44905db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner // Lex all the tokens in raw mode, to avoid entering #includes or expanding 45005db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner // macros. 45105db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner while (1) { 45205db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner Token Tok; 45305db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner L.LexFromRawLexer(Tok); 45405db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner 45505db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner // If this is a # at the start of a line, discard it from the token stream. 45605db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner // We don't want the re-preprocess step to see #defines, #includes or other 45705db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner // preprocessor directives. 45805db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner if (Tok.is(tok::hash) && Tok.isAtStartOfLine()) 45905db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner continue; 460f0b26b1d9dee57c84e55f05200802658a7312683Chris Lattner 461f0b26b1d9dee57c84e55f05200802658a7312683Chris Lattner // If this is a ## token, change its kind to unknown so that repreprocessing 462f0b26b1d9dee57c84e55f05200802658a7312683Chris Lattner // it will not produce an error. 463f0b26b1d9dee57c84e55f05200802658a7312683Chris Lattner if (Tok.is(tok::hashhash)) 464f0b26b1d9dee57c84e55f05200802658a7312683Chris Lattner Tok.setKind(tok::unknown); 46505db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner 46605db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner // If this raw token is an identifier, the raw lexer won't have looked up 46705db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner // the corresponding identifier info for it. Do this now so that it will be 46805db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner // macro expanded when we re-preprocess it. 46905db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner if (Tok.is(tok::identifier)) { 47005db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner // Change the kind of this identifier to the appropriate token kind, e.g. 47105db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner // turning "for" into a keyword. 47205db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner Tok.setKind(PP.LookUpIdentifierInfo(Tok)->getTokenID()); 47305db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner } 47405db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner 47505db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner TokenStream.push_back(Tok); 47605db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner 47705db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner if (Tok.is(tok::eof)) break; 47805db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner } 47905db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner 4807c175fb196a2bc3dbc86ea3865c713e1875f3f6dChris Lattner // Temporarily change the diagnostics object so that we ignore any generated 4817c175fb196a2bc3dbc86ea3865c713e1875f3f6dChris Lattner // diagnostics from this pass. 4827c175fb196a2bc3dbc86ea3865c713e1875f3f6dChris Lattner IgnoringDiagClient TmpDC; 4837c175fb196a2bc3dbc86ea3865c713e1875f3f6dChris Lattner Diagnostic TmpDiags(&TmpDC); 4847c175fb196a2bc3dbc86ea3865c713e1875f3f6dChris Lattner 4857c175fb196a2bc3dbc86ea3865c713e1875f3f6dChris Lattner Diagnostic *OldDiags = &PP.getDiagnostics(); 4867c175fb196a2bc3dbc86ea3865c713e1875f3f6dChris Lattner PP.setDiagnostics(TmpDiags); 4877c175fb196a2bc3dbc86ea3865c713e1875f3f6dChris Lattner 488c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner // Inform the preprocessor that we don't want comments. 489fb58609c5b3f0d665ea58e37ef39eb7ea74758a4Ted Kremenek PP.SetCommentRetentionState(false, false); 49005db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner 49105db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner // Enter the tokens we just lexed. This will cause them to be macro expanded 49205db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner // but won't enter sub-files (because we removed #'s). 49305db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner PP.EnterTokenStream(&TokenStream[0], TokenStream.size(), false, false); 494c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner 495867924dbeca06870573fd58d620032da6994b223Chris Lattner TokenConcatenation ConcatInfo(PP); 496867924dbeca06870573fd58d620032da6994b223Chris Lattner 497c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner // Lex all the tokens. 498c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner Token Tok; 499fb58609c5b3f0d665ea58e37ef39eb7ea74758a4Ted Kremenek PP.Lex(Tok); 500c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner while (Tok.isNot(tok::eof)) { 501c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner // Ignore non-macro tokens. 502c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner if (!Tok.getLocation().isMacroID()) { 503fb58609c5b3f0d665ea58e37ef39eb7ea74758a4Ted Kremenek PP.Lex(Tok); 504c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner continue; 505c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner } 506c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner 507b7949a9a91ad8e49124cd6a82ff98972d7efaadcChris Lattner // Okay, we have the first token of a macro expansion: highlight the 508b7949a9a91ad8e49124cd6a82ff98972d7efaadcChris Lattner // instantiation by inserting a start tag before the macro instantiation and 509b7949a9a91ad8e49124cd6a82ff98972d7efaadcChris Lattner // end tag after it. 510b7949a9a91ad8e49124cd6a82ff98972d7efaadcChris Lattner std::pair<SourceLocation, SourceLocation> LLoc = 511b7949a9a91ad8e49124cd6a82ff98972d7efaadcChris Lattner SM.getInstantiationRange(Tok.getLocation()); 512c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner 513b7949a9a91ad8e49124cd6a82ff98972d7efaadcChris Lattner // Ignore tokens whose instantiation location was not the main file. 514b7949a9a91ad8e49124cd6a82ff98972d7efaadcChris Lattner if (SM.getFileID(LLoc.first) != FID) { 515fb58609c5b3f0d665ea58e37ef39eb7ea74758a4Ted Kremenek PP.Lex(Tok); 516c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner continue; 517c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner } 518b7949a9a91ad8e49124cd6a82ff98972d7efaadcChris Lattner 519b7949a9a91ad8e49124cd6a82ff98972d7efaadcChris Lattner assert(SM.getFileID(LLoc.second) == FID && 520b7949a9a91ad8e49124cd6a82ff98972d7efaadcChris Lattner "Start and end of expansion must be in the same ultimate file!"); 521e9e6cb93afa51eee1f83abc7e2cb7d8a0453d810Chris Lattner 522b83ded0db9824b3b0417bf46540ed34d48776673Ted Kremenek std::string Expansion = EscapeText(PP.getSpelling(Tok)); 5236f46be279f4bc8fc24611f060258bcfbe1c175c4Chris Lattner unsigned LineLen = Expansion.size(); 5246f46be279f4bc8fc24611f060258bcfbe1c175c4Chris Lattner 525867924dbeca06870573fd58d620032da6994b223Chris Lattner Token PrevTok = Tok; 526c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner // Okay, eat this token, getting the next one. 527fb58609c5b3f0d665ea58e37ef39eb7ea74758a4Ted Kremenek PP.Lex(Tok); 528c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner 529c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner // Skip all the rest of the tokens that are part of this macro 530c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner // instantiation. It would be really nice to pop up a window with all the 531c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner // spelling of the tokens or something. 532c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner while (!Tok.is(tok::eof) && 533b7949a9a91ad8e49124cd6a82ff98972d7efaadcChris Lattner SM.getInstantiationLoc(Tok.getLocation()) == LLoc.first) { 5346f46be279f4bc8fc24611f060258bcfbe1c175c4Chris Lattner // Insert a newline if the macro expansion is getting large. 5356f46be279f4bc8fc24611f060258bcfbe1c175c4Chris Lattner if (LineLen > 60) { 5366f46be279f4bc8fc24611f060258bcfbe1c175c4Chris Lattner Expansion += "<br>"; 5376f46be279f4bc8fc24611f060258bcfbe1c175c4Chris Lattner LineLen = 0; 5386f46be279f4bc8fc24611f060258bcfbe1c175c4Chris Lattner } 5396f46be279f4bc8fc24611f060258bcfbe1c175c4Chris Lattner 5406f46be279f4bc8fc24611f060258bcfbe1c175c4Chris Lattner LineLen -= Expansion.size(); 541867924dbeca06870573fd58d620032da6994b223Chris Lattner 542867924dbeca06870573fd58d620032da6994b223Chris Lattner // If the tokens were already space separated, or if they must be to avoid 543867924dbeca06870573fd58d620032da6994b223Chris Lattner // them being implicitly pasted, add a space between them. 544867924dbeca06870573fd58d620032da6994b223Chris Lattner if (Tok.hasLeadingSpace() || 545867924dbeca06870573fd58d620032da6994b223Chris Lattner ConcatInfo.AvoidConcat(PrevTok, Tok)) 546867924dbeca06870573fd58d620032da6994b223Chris Lattner Expansion += ' '; 547867924dbeca06870573fd58d620032da6994b223Chris Lattner 5489227c6953497be34281354f949d6f4cd34a696ccChris Lattner // Escape any special characters in the token text. 549867924dbeca06870573fd58d620032da6994b223Chris Lattner Expansion += EscapeText(PP.getSpelling(Tok)); 5506f46be279f4bc8fc24611f060258bcfbe1c175c4Chris Lattner LineLen += Expansion.size(); 551867924dbeca06870573fd58d620032da6994b223Chris Lattner 552867924dbeca06870573fd58d620032da6994b223Chris Lattner PrevTok = Tok; 553fb58609c5b3f0d665ea58e37ef39eb7ea74758a4Ted Kremenek PP.Lex(Tok); 5546f46be279f4bc8fc24611f060258bcfbe1c175c4Chris Lattner } 5559227c6953497be34281354f949d6f4cd34a696ccChris Lattner 556e9e6cb93afa51eee1f83abc7e2cb7d8a0453d810Chris Lattner 557e9e6cb93afa51eee1f83abc7e2cb7d8a0453d810Chris Lattner // Insert the expansion as the end tag, so that multi-line macros all get 558e9e6cb93afa51eee1f83abc7e2cb7d8a0453d810Chris Lattner // highlighted. 559e9e6cb93afa51eee1f83abc7e2cb7d8a0453d810Chris Lattner Expansion = "<span class='expansion'>" + Expansion + "</span></span>"; 560e9e6cb93afa51eee1f83abc7e2cb7d8a0453d810Chris Lattner 561e9e6cb93afa51eee1f83abc7e2cb7d8a0453d810Chris Lattner HighlightRange(R, LLoc.first, LLoc.second, 562e9e6cb93afa51eee1f83abc7e2cb7d8a0453d810Chris Lattner "<span class='macro'>", Expansion.c_str()); 563c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner } 5647c175fb196a2bc3dbc86ea3865c713e1875f3f6dChris Lattner 5657c175fb196a2bc3dbc86ea3865c713e1875f3f6dChris Lattner // Restore diagnostics object back to its own thing. 5667c175fb196a2bc3dbc86ea3865c713e1875f3f6dChris Lattner PP.setDiagnostics(*OldDiags); 567c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner} 568c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner 5692b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattnervoid html::HighlightMacros(Rewriter &R, FileID FID, 570fb58609c5b3f0d665ea58e37ef39eb7ea74758a4Ted Kremenek PreprocessorFactory &PPF) { 571fb58609c5b3f0d665ea58e37ef39eb7ea74758a4Ted Kremenek 572fb58609c5b3f0d665ea58e37ef39eb7ea74758a4Ted Kremenek llvm::OwningPtr<Preprocessor> PP(PPF.CreatePreprocessor()); 5732b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner HighlightMacros(R, FID, *PP); 574fb58609c5b3f0d665ea58e37ef39eb7ea74758a4Ted Kremenek} 575