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// 10651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines// This file defines the HTMLRewriter class, which is used to translate the 116a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek// text of a source file into prettified HTML. 126a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek// 136a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek//===----------------------------------------------------------------------===// 146a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek 15305c613af6cfc40e519c75d9d2c84c6fa9a841c0Ted Kremenek#include "clang/Rewrite/Core/HTMLRewrite.h" 166a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek#include "clang/Basic/SourceManager.h" 1755fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "clang/Lex/Preprocessor.h" 1855fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "clang/Lex/TokenConcatenation.h" 1955fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "clang/Rewrite/Core/Rewriter.h" 2055fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "llvm/ADT/SmallString.h" 21c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara#include "llvm/Support/ErrorHandling.h" 226a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek#include "llvm/Support/MemoryBuffer.h" 23a95d3750441ac8ad03e36af8e6e74039c9a3109dTed Kremenek#include "llvm/Support/raw_ostream.h" 24651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines#include <memory> 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(); 35402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth B = SM.getExpansionLoc(B); 36402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth E = SM.getExpansionLoc(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); 421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 435ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner // Include the whole end token in the range. 442c78b873f4f3823ae859c15674cb3d76c8554113Chris Lattner EOffset += Lexer::MeasureTokenLength(E, R.getSourceMgr(), R.getLangOpts()); 451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 46f715ca12bfc9fddfde75f98a197424434428b821Douglas Gregor bool Invalid = false; 47f6ac97b101c8840efa92bf29166077ce4049e293Benjamin Kramer const char *BufferStart = SM.getBufferData(FID, &Invalid).data(); 48f715ca12bfc9fddfde75f98a197424434428b821Douglas Gregor if (Invalid) 49aea67dbd653a2dd6dd5cc2159279e81e855b2482Douglas Gregor return; 50aea67dbd653a2dd6dd5cc2159279e81e855b2482Douglas Gregor 512b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner HighlightRange(R.getEditBuffer(FID), BOffset, EOffset, 52aea67dbd653a2dd6dd5cc2159279e81e855b2482Douglas Gregor BufferStart, StartTag, EndTag); 535ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner} 545ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner 555ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner/// HighlightRange - This is the same as the above method, but takes 565ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner/// decomposed file locations. 575ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattnervoid html::HighlightRange(RewriteBuffer &RB, unsigned B, unsigned E, 585ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner const char *BufferStart, 595ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner const char *StartTag, const char *EndTag) { 609402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner // Insert the tag at the absolute start/end of the range. 61d7407dc92c7d19cafce429e7e1cf9819d3fc0b92Daniel Dunbar RB.InsertTextAfter(B, StartTag); 62d7407dc92c7d19cafce429e7e1cf9819d3fc0b92Daniel Dunbar RB.InsertTextBefore(E, EndTag); 631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 649402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner // Scan the range to see if there is a \r or \n. If so, and if the line is 659402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner // not blank, insert tags on that line as well. 669402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner bool HadOpenTag = true; 671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 689402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner unsigned LastNonWhiteSpace = B; 699402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner for (unsigned i = B; i != E; ++i) { 709402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner switch (BufferStart[i]) { 719402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner case '\r': 729402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner case '\n': 739402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner // Okay, we found a newline in the range. If we have an open tag, we need 749402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner // to insert a close tag at the first non-whitespace before the newline. 759402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner if (HadOpenTag) 76d7407dc92c7d19cafce429e7e1cf9819d3fc0b92Daniel Dunbar RB.InsertTextBefore(LastNonWhiteSpace+1, EndTag); 771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 789402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner // Instead of inserting an open tag immediately after the newline, we 799402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner // wait until we see a non-whitespace character. This prevents us from 809402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner // inserting tags around blank lines, and also allows the open tag to 819402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner // be put *after* whitespace on a non-blank line. 829402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner HadOpenTag = false; 839402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner break; 849402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner case '\0': 859402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner case ' ': 869402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner case '\t': 879402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner case '\f': 889402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner case '\v': 899402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner // Ignore whitespace. 909402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner break; 911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 929402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner default: 939402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner // If there is no tag open, do it now. 949402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner if (!HadOpenTag) { 95d7407dc92c7d19cafce429e7e1cf9819d3fc0b92Daniel Dunbar RB.InsertTextAfter(i, StartTag); 969402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner HadOpenTag = true; 979402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner } 981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 999402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner // Remember this character. 1009402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner LastNonWhiteSpace = i; 1019402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner break; 1029402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner } 1039402b57a0dca4058fe56d7fd84e97fc496421125Chris Lattner } 1045ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner} 1055ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner 1062b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattnervoid html::EscapeText(Rewriter &R, FileID FID, 107fa5be3617294f0e3c341f0ecb6b2076478b1b5acTed Kremenek bool EscapeSpaces, bool ReplaceTabs) { 1081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1092b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner const llvm::MemoryBuffer *Buf = R.getSourceMgr().getBuffer(FID); 1106a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek const char* C = Buf->getBufferStart(); 1116a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek const char* FileEnd = Buf->getBufferEnd(); 1121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1136a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek assert (C <= FileEnd); 1141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1152b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner RewriteBuffer &RB = R.getEditBuffer(FID); 1165c176f7a9ba9f7084b903393845be24f85e091daChris Lattner 1175c176f7a9ba9f7084b903393845be24f85e091daChris Lattner unsigned ColNo = 0; 1186a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek for (unsigned FilePos = 0; C != FileEnd ; ++C, ++FilePos) { 1196a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek switch (*C) { 1205c176f7a9ba9f7084b903393845be24f85e091daChris Lattner default: ++ColNo; break; 1215c176f7a9ba9f7084b903393845be24f85e091daChris Lattner case '\n': 1225c176f7a9ba9f7084b903393845be24f85e091daChris Lattner case '\r': 1235c176f7a9ba9f7084b903393845be24f85e091daChris Lattner ColNo = 0; 1245c176f7a9ba9f7084b903393845be24f85e091daChris Lattner break; 1251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 126735271479ac57c27f744806859efd5b001dea248Chris Lattner case ' ': 127735271479ac57c27f744806859efd5b001dea248Chris Lattner if (EscapeSpaces) 128d7407dc92c7d19cafce429e7e1cf9819d3fc0b92Daniel Dunbar RB.ReplaceText(FilePos, 1, " "); 1295c176f7a9ba9f7084b903393845be24f85e091daChris Lattner ++ColNo; 130735271479ac57c27f744806859efd5b001dea248Chris Lattner break; 131f3d8d19caf6f1a21785eee8d62c45ef5a0a0e72eChris Lattner case '\f': 132d7407dc92c7d19cafce429e7e1cf9819d3fc0b92Daniel Dunbar RB.ReplaceText(FilePos, 1, "<hr>"); 133f3d8d19caf6f1a21785eee8d62c45ef5a0a0e72eChris Lattner ColNo = 0; 134f3d8d19caf6f1a21785eee8d62c45ef5a0a0e72eChris Lattner break; 1351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1365c176f7a9ba9f7084b903393845be24f85e091daChris Lattner case '\t': { 137735271479ac57c27f744806859efd5b001dea248Chris Lattner if (!ReplaceTabs) 13849cd6354d5373245dd2e69ca7b7113e6a795d36eTed Kremenek break; 1395c176f7a9ba9f7084b903393845be24f85e091daChris Lattner unsigned NumSpaces = 8-(ColNo&7); 140735271479ac57c27f744806859efd5b001dea248Chris Lattner if (EscapeSpaces) 141d7407dc92c7d19cafce429e7e1cf9819d3fc0b92Daniel Dunbar RB.ReplaceText(FilePos, 1, 1425f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner StringRef(" " 143d7407dc92c7d19cafce429e7e1cf9819d3fc0b92Daniel Dunbar " ", 6*NumSpaces)); 144735271479ac57c27f744806859efd5b001dea248Chris Lattner else 1455f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner RB.ReplaceText(FilePos, 1, StringRef(" ", NumSpaces)); 1465c176f7a9ba9f7084b903393845be24f85e091daChris Lattner ColNo += NumSpaces; 147735271479ac57c27f744806859efd5b001dea248Chris Lattner break; 1485c176f7a9ba9f7084b903393845be24f85e091daChris Lattner } 149735271479ac57c27f744806859efd5b001dea248Chris Lattner case '<': 150d7407dc92c7d19cafce429e7e1cf9819d3fc0b92Daniel Dunbar RB.ReplaceText(FilePos, 1, "<"); 1515c176f7a9ba9f7084b903393845be24f85e091daChris Lattner ++ColNo; 152735271479ac57c27f744806859efd5b001dea248Chris Lattner break; 1531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 154735271479ac57c27f744806859efd5b001dea248Chris Lattner case '>': 155d7407dc92c7d19cafce429e7e1cf9819d3fc0b92Daniel Dunbar RB.ReplaceText(FilePos, 1, ">"); 1565c176f7a9ba9f7084b903393845be24f85e091daChris Lattner ++ColNo; 157735271479ac57c27f744806859efd5b001dea248Chris Lattner break; 1581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 159735271479ac57c27f744806859efd5b001dea248Chris Lattner case '&': 160d7407dc92c7d19cafce429e7e1cf9819d3fc0b92Daniel Dunbar RB.ReplaceText(FilePos, 1, "&"); 1615c176f7a9ba9f7084b903393845be24f85e091daChris Lattner ++ColNo; 162735271479ac57c27f744806859efd5b001dea248Chris Lattner break; 1636a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek } 1646a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek } 1656a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek} 1666a34083e9f74a45e2f79c9fab66f177809a5db66Ted Kremenek 1671342a4ef62dd7b839c6f09348b246a4f00282f29Benjamin Kramerstd::string html::EscapeText(StringRef s, bool EscapeSpaces, bool ReplaceTabs) { 1681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 169053ef593fa9d2b890645a914eee203231fb34458Ted Kremenek unsigned len = s.size(); 170a95d3750441ac8ad03e36af8e6e74039c9a3109dTed Kremenek std::string Str; 171a95d3750441ac8ad03e36af8e6e74039c9a3109dTed Kremenek llvm::raw_string_ostream os(Str); 1721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 173053ef593fa9d2b890645a914eee203231fb34458Ted Kremenek for (unsigned i = 0 ; i < len; ++i) { 1741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 175053ef593fa9d2b890645a914eee203231fb34458Ted Kremenek char c = s[i]; 176053ef593fa9d2b890645a914eee203231fb34458Ted Kremenek switch (c) { 1778570f0b0fde7ca812f8d37f52305f3df4dd2ce01Chris Lattner default: 1788570f0b0fde7ca812f8d37f52305f3df4dd2ce01Chris Lattner os << c; break; 1791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1808570f0b0fde7ca812f8d37f52305f3df4dd2ce01Chris Lattner case ' ': 1818570f0b0fde7ca812f8d37f52305f3df4dd2ce01Chris Lattner if (EscapeSpaces) os << " "; 1828570f0b0fde7ca812f8d37f52305f3df4dd2ce01Chris Lattner else os << ' '; 1838570f0b0fde7ca812f8d37f52305f3df4dd2ce01Chris Lattner break; 1841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 185c01b46e2f115bed83f2f6f4a55809bf4003ee015Zhongxing Xu case '\t': 186c01b46e2f115bed83f2f6f4a55809bf4003ee015Zhongxing Xu if (ReplaceTabs) { 187c01b46e2f115bed83f2f6f4a55809bf4003ee015Zhongxing Xu if (EscapeSpaces) 188c01b46e2f115bed83f2f6f4a55809bf4003ee015Zhongxing Xu for (unsigned i = 0; i < 4; ++i) 189c01b46e2f115bed83f2f6f4a55809bf4003ee015Zhongxing Xu os << " "; 190c01b46e2f115bed83f2f6f4a55809bf4003ee015Zhongxing Xu else 191c01b46e2f115bed83f2f6f4a55809bf4003ee015Zhongxing Xu for (unsigned i = 0; i < 4; ++i) 192c01b46e2f115bed83f2f6f4a55809bf4003ee015Zhongxing Xu os << " "; 193c01b46e2f115bed83f2f6f4a55809bf4003ee015Zhongxing Xu } 1941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump else 195c01b46e2f115bed83f2f6f4a55809bf4003ee015Zhongxing Xu os << c; 1961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 197c01b46e2f115bed83f2f6f4a55809bf4003ee015Zhongxing Xu break; 1981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 199c01b46e2f115bed83f2f6f4a55809bf4003ee015Zhongxing Xu case '<': os << "<"; break; 200c01b46e2f115bed83f2f6f4a55809bf4003ee015Zhongxing Xu case '>': os << ">"; break; 201c01b46e2f115bed83f2f6f4a55809bf4003ee015Zhongxing Xu case '&': os << "&"; break; 202053ef593fa9d2b890645a914eee203231fb34458Ted Kremenek } 203053ef593fa9d2b890645a914eee203231fb34458Ted Kremenek } 2041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 205053ef593fa9d2b890645a914eee203231fb34458Ted Kremenek return os.str(); 206053ef593fa9d2b890645a914eee203231fb34458Ted Kremenek} 207053ef593fa9d2b890645a914eee203231fb34458Ted Kremenek 2088570f0b0fde7ca812f8d37f52305f3df4dd2ce01Chris Lattnerstatic void AddLineNumber(RewriteBuffer &RB, unsigned LineNo, 2098570f0b0fde7ca812f8d37f52305f3df4dd2ce01Chris Lattner unsigned B, unsigned E) { 210f7ccbad5d9949e7ddd1cbef43d482553b811e026Dylan Noblesmith SmallString<256> Str; 2117e37c818f9f77608c602ffb32c1135e3cd0132a8Daniel Dunbar llvm::raw_svector_ostream OS(Str); 2127e37c818f9f77608c602ffb32c1135e3cd0132a8Daniel Dunbar 2137e37c818f9f77608c602ffb32c1135e3cd0132a8Daniel Dunbar OS << "<tr><td class=\"num\" id=\"LN" 2147e37c818f9f77608c602ffb32c1135e3cd0132a8Daniel Dunbar << LineNo << "\">" 2157e37c818f9f77608c602ffb32c1135e3cd0132a8Daniel Dunbar << LineNo << "</td><td class=\"line\">"; 2161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 21749cd6354d5373245dd2e69ca7b7113e6a795d36eTed Kremenek if (B == E) { // Handle empty lines. 2187e37c818f9f77608c602ffb32c1135e3cd0132a8Daniel Dunbar OS << " </td></tr>"; 219d7407dc92c7d19cafce429e7e1cf9819d3fc0b92Daniel Dunbar RB.InsertTextBefore(B, OS.str()); 22057df3b950061c73d13d3116f747e79d7955a216aChris Lattner } else { 221d7407dc92c7d19cafce429e7e1cf9819d3fc0b92Daniel Dunbar RB.InsertTextBefore(B, OS.str()); 222d7407dc92c7d19cafce429e7e1cf9819d3fc0b92Daniel Dunbar RB.InsertTextBefore(E, "</td></tr>"); 22349cd6354d5373245dd2e69ca7b7113e6a795d36eTed Kremenek } 224b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek} 225b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek 2262b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattnervoid html::AddLineNumbers(Rewriter& R, FileID FID) { 227b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek 2282b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner const llvm::MemoryBuffer *Buf = R.getSourceMgr().getBuffer(FID); 229b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek const char* FileBeg = Buf->getBufferStart(); 230b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek const char* FileEnd = Buf->getBufferEnd(); 231b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek const char* C = FileBeg; 2322b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner RewriteBuffer &RB = R.getEditBuffer(FID); 2331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 234b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek assert (C <= FileEnd); 2351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 236b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek unsigned LineNo = 0; 237b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek unsigned FilePos = 0; 2381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2391eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump while (C != FileEnd) { 2401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 241b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek ++LineNo; 242b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek unsigned LineStartPos = FilePos; 243b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek unsigned LineEndPos = FileEnd - FileBeg; 2441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 245b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek assert (FilePos <= LineEndPos); 246b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek assert (C < FileEnd); 2471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 248b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek // Scan until the newline (or end-of-file). 2491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 25049cd6354d5373245dd2e69ca7b7113e6a795d36eTed Kremenek while (C != FileEnd) { 25149cd6354d5373245dd2e69ca7b7113e6a795d36eTed Kremenek char c = *C; 25249cd6354d5373245dd2e69ca7b7113e6a795d36eTed Kremenek ++C; 2531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 25449cd6354d5373245dd2e69ca7b7113e6a795d36eTed Kremenek if (c == '\n') { 25549cd6354d5373245dd2e69ca7b7113e6a795d36eTed Kremenek LineEndPos = FilePos++; 256b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek break; 257b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek } 2581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 25949cd6354d5373245dd2e69ca7b7113e6a795d36eTed Kremenek ++FilePos; 26049cd6354d5373245dd2e69ca7b7113e6a795d36eTed Kremenek } 2611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2628570f0b0fde7ca812f8d37f52305f3df4dd2ce01Chris Lattner AddLineNumber(RB, LineNo, LineStartPos, LineEndPos); 263d6c1360c2bf234c73572a865f119d0518aca8154Ted Kremenek } 2641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2658570f0b0fde7ca812f8d37f52305f3df4dd2ce01Chris Lattner // Add one big table tag that surrounds all of the code. 266d7407dc92c7d19cafce429e7e1cf9819d3fc0b92Daniel Dunbar RB.InsertTextBefore(0, "<table class=\"code\">\n"); 267d7407dc92c7d19cafce429e7e1cf9819d3fc0b92Daniel Dunbar RB.InsertTextAfter(FileEnd - FileBeg, "</table>"); 268b485cd1e0a5a1e942d0e682b9b1c4bc9df111528Ted Kremenek} 269ad0a203130dc5d1fb7231b88767174511424fa98Ted Kremenek 2701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumpvoid html::AddHeaderFooterInternalBuiltinCSS(Rewriter& R, FileID FID, 271f6f593fae2f0531b4bc06891941f7fbba5217618Ted Kremenek const char *title) { 272ad0a203130dc5d1fb7231b88767174511424fa98Ted Kremenek 2732b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner const llvm::MemoryBuffer *Buf = R.getSourceMgr().getBuffer(FID); 274ad0a203130dc5d1fb7231b88767174511424fa98Ted Kremenek const char* FileStart = Buf->getBufferStart(); 275ad0a203130dc5d1fb7231b88767174511424fa98Ted Kremenek const char* FileEnd = Buf->getBufferEnd(); 276ad0a203130dc5d1fb7231b88767174511424fa98Ted Kremenek 2772b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner SourceLocation StartLoc = R.getSourceMgr().getLocForStartOfFile(FID); 278a64ccefdf0ea4e03ec88805d71b0af74950c7472Argyrios Kyrtzidis SourceLocation EndLoc = StartLoc.getLocWithOffset(FileEnd-FileStart); 279ad0a203130dc5d1fb7231b88767174511424fa98Ted Kremenek 280a95d3750441ac8ad03e36af8e6e74039c9a3109dTed Kremenek std::string s; 281a95d3750441ac8ad03e36af8e6e74039c9a3109dTed Kremenek llvm::raw_string_ostream os(s); 282f6f593fae2f0531b4bc06891941f7fbba5217618Ted Kremenek os << "<!doctype html>\n" // Use HTML 5 doctype 283f6f593fae2f0531b4bc06891941f7fbba5217618Ted Kremenek "<html>\n<head>\n"; 2841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 285f6f593fae2f0531b4bc06891941f7fbba5217618Ted Kremenek if (title) 286f6f593fae2f0531b4bc06891941f7fbba5217618Ted Kremenek os << "<title>" << html::EscapeText(title) << "</title>\n"; 2871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 288f6f593fae2f0531b4bc06891941f7fbba5217618Ted Kremenek os << "<style type=\"text/css\">\n" 28970bcba6030a76edf46c4f941ad9a5297a1f98c47Ted Kremenek " body { color:#000000; background-color:#ffffff }\n" 29070bcba6030a76edf46c4f941ad9a5297a1f98c47Ted Kremenek " body { font-family:Helvetica, sans-serif; font-size:10pt }\n" 2914b0f81323b518429203051bbcd4864bbf4b000a9Ted Kremenek " h1 { font-size:14pt }\n" 292f5016260522e449e9bacdb0e5a87ad3932d9fbd4Ted Kremenek " .code { border-collapse:collapse; width:100%; }\n" 2933eaaa99c7ee85300e2c55dcc2103ebeae19f4d11Ted Kremenek " .code { font-family: \"Monospace\", monospace; font-size:10pt }\n" 29470bcba6030a76edf46c4f941ad9a5297a1f98c47Ted Kremenek " .code { line-height: 1.2em }\n" 295f5016260522e449e9bacdb0e5a87ad3932d9fbd4Ted Kremenek " .comment { color: green; font-style: oblique }\n" 296f5016260522e449e9bacdb0e5a87ad3932d9fbd4Ted Kremenek " .keyword { color: blue }\n" 297cc1b8532a113fa3216096757b3b4e203867bd5e0Ted Kremenek " .string_literal { color: red }\n" 298f5016260522e449e9bacdb0e5a87ad3932d9fbd4Ted Kremenek " .directive { color: darkmagenta }\n" 2996f46be279f4bc8fc24611f060258bcfbe1c175c4Chris Lattner // Macro expansions. 30007339a63b46e38c954fcccbef721c609d0c2040eTed Kremenek " .expansion { display: none; }\n" 30107339a63b46e38c954fcccbef721c609d0c2040eTed Kremenek " .macro:hover .expansion { display: block; border: 2px solid #FF0000; " 302dc5be47542e6d4a28d20abf9c0f0a0edd72939b6Chris Lattner "padding: 2px; background-color:#FFF0F0; font-weight: normal; " 3036f46be279f4bc8fc24611f060258bcfbe1c175c4Chris Lattner " -webkit-border-radius:5px; -webkit-box-shadow:1px 1px 7px #000; " 3048aa06aca8b2d3771a5405d789b2e704149045dd4Chris Lattner "position: absolute; top: -1em; left:10em; z-index: 1 } \n" 305f5016260522e449e9bacdb0e5a87ad3932d9fbd4Ted Kremenek " .macro { color: darkmagenta; background-color:LemonChiffon;" 3066f46be279f4bc8fc24611f060258bcfbe1c175c4Chris Lattner // Macros are position: relative to provide base for expansions. 3076f46be279f4bc8fc24611f060258bcfbe1c175c4Chris Lattner " position: relative }\n" 30870bcba6030a76edf46c4f941ad9a5297a1f98c47Ted Kremenek " .num { width:2.5em; padding-right:2ex; background-color:#eeeeee }\n" 3092223622d113d7cba04c2dfdbe032e2ba6ba10bc4Ted Kremenek " .num { text-align:right; font-size:8pt }\n" 31070bcba6030a76edf46c4f941ad9a5297a1f98c47Ted Kremenek " .num { color:#444444 }\n" 31170bcba6030a76edf46c4f941ad9a5297a1f98c47Ted Kremenek " .line { padding-left: 1ex; border-left: 3px solid #ccc }\n" 31270bcba6030a76edf46c4f941ad9a5297a1f98c47Ted Kremenek " .line { white-space: pre }\n" 31370bcba6030a76edf46c4f941ad9a5297a1f98c47Ted Kremenek " .msg { -webkit-box-shadow:1px 1px 7px #000 }\n" 31470bcba6030a76edf46c4f941ad9a5297a1f98c47Ted Kremenek " .msg { -webkit-border-radius:5px }\n" 3152223622d113d7cba04c2dfdbe032e2ba6ba10bc4Ted Kremenek " .msg { font-family:Helvetica, sans-serif; font-size:8pt }\n" 31670bcba6030a76edf46c4f941ad9a5297a1f98c47Ted Kremenek " .msg { float:left }\n" 3173c59823096fe28a69a81f899c7f9f0e6eb8071a0Ted Kremenek " .msg { padding:0.25em 1ex 0.25em 1ex }\n" 31870bcba6030a76edf46c4f941ad9a5297a1f98c47Ted Kremenek " .msg { margin-top:10px; margin-bottom:10px }\n" 3192f10398814e8d58cce029a7e73af21bb274dcd42Ted Kremenek " .msg { font-weight:bold }\n" 32080bae763da8bf3f3c73379a1e5d10f5bce266bcaTed Kremenek " .msg { max-width:60em; word-wrap: break-word; white-space: pre-wrap }\n" 32180bae763da8bf3f3c73379a1e5d10f5bce266bcaTed Kremenek " .msgT { padding:0x; spacing:0x }\n" 3222f10398814e8d58cce029a7e73af21bb274dcd42Ted Kremenek " .msgEvent { background-color:#fff8b4; color:#000000 }\n" 32380bae763da8bf3f3c73379a1e5d10f5bce266bcaTed Kremenek " .msgControl { background-color:#bbbbbb; color:#000000 }\n" 32470bcba6030a76edf46c4f941ad9a5297a1f98c47Ted Kremenek " .mrange { background-color:#dfddf3 }\n" 32570bcba6030a76edf46c4f941ad9a5297a1f98c47Ted Kremenek " .mrange { border-bottom:1px solid #6F9DBE }\n" 326b23b711ad3dfb96dc9c457bd55c6e959bd1e0b8aJordan Rose " .PathIndex { font-weight: bold; padding:0px 5px; " 3273c59823096fe28a69a81f899c7f9f0e6eb8071a0Ted Kremenek "margin-right:5px; }\n" 32800f01e440573b2bdf6549991e0ca48cc6747e3a2Ted Kremenek " .PathIndex { -webkit-border-radius:8px }\n" 32900f01e440573b2bdf6549991e0ca48cc6747e3a2Ted Kremenek " .PathIndexEvent { background-color:#bfba87 }\n" 33000f01e440573b2bdf6549991e0ca48cc6747e3a2Ted Kremenek " .PathIndexControl { background-color:#8c8c8c }\n" 331b23b711ad3dfb96dc9c457bd55c6e959bd1e0b8aJordan Rose " .PathNav a { text-decoration:none; font-size: larger }\n" 3324b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor " .CodeInsertionHint { font-weight: bold; background-color: #10dd10 }\n" 3334b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor " .CodeRemovalHint { background-color:#de1010 }\n" 3344b2d3f7bcc4df31157df443af1b80bcaa9b58bbaDouglas Gregor " .CodeRemovalHint { border-bottom:1px solid #6F9DBE }\n" 3354b0f81323b518429203051bbcd4864bbf4b000a9Ted Kremenek " table.simpletable {\n" 3364b0f81323b518429203051bbcd4864bbf4b000a9Ted Kremenek " padding: 5px;\n" 3374b0f81323b518429203051bbcd4864bbf4b000a9Ted Kremenek " font-size:12pt;\n" 3384b0f81323b518429203051bbcd4864bbf4b000a9Ted Kremenek " margin:20px;\n" 3394b0f81323b518429203051bbcd4864bbf4b000a9Ted Kremenek " border-collapse: collapse; border-spacing: 0px;\n" 3404b0f81323b518429203051bbcd4864bbf4b000a9Ted Kremenek " }\n" 3414b0f81323b518429203051bbcd4864bbf4b000a9Ted Kremenek " td.rowname {\n" 3424b0f81323b518429203051bbcd4864bbf4b000a9Ted Kremenek " text-align:right; font-weight:bold; color:#444444;\n" 3434b0f81323b518429203051bbcd4864bbf4b000a9Ted Kremenek " padding-right:2ex; }\n" 344f6f593fae2f0531b4bc06891941f7fbba5217618Ted Kremenek "</style>\n</head>\n<body>"; 34570bcba6030a76edf46c4f941ad9a5297a1f98c47Ted Kremenek 346f6f593fae2f0531b4bc06891941f7fbba5217618Ted Kremenek // Generate header 34744ba7bf54434be88bda7a752f857d42cc92b462dDaniel Dunbar R.InsertTextBefore(StartLoc, os.str()); 348ad0a203130dc5d1fb7231b88767174511424fa98Ted Kremenek // Generate footer 3491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 35044ba7bf54434be88bda7a752f857d42cc92b462dDaniel Dunbar R.InsertTextAfter(EndLoc, "</body></html>\n"); 351ad0a203130dc5d1fb7231b88767174511424fa98Ted Kremenek} 3523245a0a1c7a4fd74fca845b2edba275bb126d773Chris Lattner 3533245a0a1c7a4fd74fca845b2edba275bb126d773Chris Lattner/// SyntaxHighlight - Relex the specified FileID and annotate the HTML with 3543245a0a1c7a4fd74fca845b2edba275bb126d773Chris Lattner/// information about keywords, macro expansions etc. This uses the macro 3553245a0a1c7a4fd74fca845b2edba275bb126d773Chris Lattner/// table state from the end of the file, so it won't be perfectly perfect, 3563245a0a1c7a4fd74fca845b2edba275bb126d773Chris Lattner/// but it will be reasonably close. 357ff6912b5a9d5073221956fe4d6367b14f3f4b68fDaniel Dunbarvoid html::SyntaxHighlight(Rewriter &R, FileID FID, const Preprocessor &PP) { 3582b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner RewriteBuffer &RB = R.getEditBuffer(FID); 3593245a0a1c7a4fd74fca845b2edba275bb126d773Chris Lattner 36005db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner const SourceManager &SM = PP.getSourceManager(); 3616e2901407bff59aeb4cc301cc58b034723d0eb49Chris Lattner const llvm::MemoryBuffer *FromFile = SM.getBuffer(FID); 3624e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie Lexer L(FID, FromFile, SM, PP.getLangOpts()); 36349e1d9814a34e4024a347c2fce8e9567c40e6bf5Alexander Kornienko const char *BufferStart = L.getBuffer().data(); 3641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // Inform the preprocessor that we want to retain comments as tokens, so we 3663245a0a1c7a4fd74fca845b2edba275bb126d773Chris Lattner // can highlight them. 367678c6358c8d4e368c78629099142397c63c1ee35Chris Lattner L.SetCommentRetentionState(true); 3681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 369c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner // Lex all the tokens in raw mode, to avoid entering #includes or expanding 370c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner // macros. 3713245a0a1c7a4fd74fca845b2edba275bb126d773Chris Lattner Token Tok; 372590f0cc643274267d4d41125b62557e1d87886c3Chris Lattner L.LexFromRawLexer(Tok); 3731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 37474ea3e5c57c087c046223096a97ea4e365f85eb6Chris Lattner while (Tok.isNot(tok::eof)) { 37574ea3e5c57c087c046223096a97ea4e365f85eb6Chris Lattner // Since we are lexing unexpanded tokens, all tokens are from the main 37674ea3e5c57c087c046223096a97ea4e365f85eb6Chris Lattner // FileID. 37705db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner unsigned TokOffs = SM.getFileOffset(Tok.getLocation()); 3783245a0a1c7a4fd74fca845b2edba275bb126d773Chris Lattner unsigned TokLen = Tok.getLength(); 3793245a0a1c7a4fd74fca845b2edba275bb126d773Chris Lattner switch (Tok.getKind()) { 380a745e8c52839d9c8dd0fd8d5276b4eab182ec7f2Chris Lattner default: break; 381c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara case tok::identifier: 382c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara llvm_unreachable("tok::identifier in raw lexing mode!"); 383c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara case tok::raw_identifier: { 384c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara // Fill in Result.IdentifierInfo and update the token kind, 385c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara // looking up the identifier in the identifier table. 386c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara PP.LookUpIdentifierInfo(Tok); 3871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 388a745e8c52839d9c8dd0fd8d5276b4eab182ec7f2Chris Lattner // If this is a pp-identifier, for a keyword, highlight it as such. 389c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara if (Tok.isNot(tok::identifier)) 3905ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner HighlightRange(RB, TokOffs, TokOffs+TokLen, BufferStart, 3915ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner "<span class='keyword'>", "</span>"); 392c4586c234edd8df0477a895aebcbc3eb220aed6bChris Lattner break; 393a745e8c52839d9c8dd0fd8d5276b4eab182ec7f2Chris Lattner } 3943245a0a1c7a4fd74fca845b2edba275bb126d773Chris Lattner case tok::comment: 3955ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner HighlightRange(RB, TokOffs, TokOffs+TokLen, BufferStart, 3965ef3e2c45f13fccdb0d7bbcf24c1beee8eee6f64Chris Lattner "<span class='comment'>", "</span>"); 3973245a0a1c7a4fd74fca845b2edba275bb126d773Chris Lattner break; 3985cee1195584fa8672253139c86e922daeda69b9eDouglas Gregor case tok::utf8_string_literal: 3995cee1195584fa8672253139c86e922daeda69b9eDouglas Gregor // Chop off the u part of u8 prefix 4005cee1195584fa8672253139c86e922daeda69b9eDouglas Gregor ++TokOffs; 4015cee1195584fa8672253139c86e922daeda69b9eDouglas Gregor --TokLen; 4025cee1195584fa8672253139c86e922daeda69b9eDouglas Gregor // FALL THROUGH to chop the 8 403cc1b8532a113fa3216096757b3b4e203867bd5e0Ted Kremenek case tok::wide_string_literal: 4045cee1195584fa8672253139c86e922daeda69b9eDouglas Gregor case tok::utf16_string_literal: 4055cee1195584fa8672253139c86e922daeda69b9eDouglas Gregor case tok::utf32_string_literal: 4065cee1195584fa8672253139c86e922daeda69b9eDouglas Gregor // Chop off the L, u, U or 8 prefix 407cc1b8532a113fa3216096757b3b4e203867bd5e0Ted Kremenek ++TokOffs; 408cc1b8532a113fa3216096757b3b4e203867bd5e0Ted Kremenek --TokLen; 409cc1b8532a113fa3216096757b3b4e203867bd5e0Ted Kremenek // FALL THROUGH. 410cc1b8532a113fa3216096757b3b4e203867bd5e0Ted Kremenek case tok::string_literal: 41199831e4677a7e2e051af636221694d60ba31fcdbRichard Smith // FIXME: Exclude the optional ud-suffix from the highlighted range. 412cc1b8532a113fa3216096757b3b4e203867bd5e0Ted Kremenek HighlightRange(RB, TokOffs, TokOffs+TokLen, BufferStart, 413cc1b8532a113fa3216096757b3b4e203867bd5e0Ted Kremenek "<span class='string_literal'>", "</span>"); 414cc1b8532a113fa3216096757b3b4e203867bd5e0Ted Kremenek break; 4155deb96d06583abb751463427457d46041af262d0Chris Lattner case tok::hash: { 41674ea3e5c57c087c046223096a97ea4e365f85eb6Chris Lattner // If this is a preprocessor directive, all tokens to end of line are too. 4175deb96d06583abb751463427457d46041af262d0Chris Lattner if (!Tok.isAtStartOfLine()) 4185deb96d06583abb751463427457d46041af262d0Chris Lattner break; 4191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4205deb96d06583abb751463427457d46041af262d0Chris Lattner // Eat all of the tokens until we get to the next one at the start of 4215deb96d06583abb751463427457d46041af262d0Chris Lattner // line. 4225deb96d06583abb751463427457d46041af262d0Chris Lattner unsigned TokEnd = TokOffs+TokLen; 423590f0cc643274267d4d41125b62557e1d87886c3Chris Lattner L.LexFromRawLexer(Tok); 4245deb96d06583abb751463427457d46041af262d0Chris Lattner while (!Tok.isAtStartOfLine() && Tok.isNot(tok::eof)) { 42505db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner TokEnd = SM.getFileOffset(Tok.getLocation())+Tok.getLength(); 426590f0cc643274267d4d41125b62557e1d87886c3Chris Lattner L.LexFromRawLexer(Tok); 42774ea3e5c57c087c046223096a97ea4e365f85eb6Chris Lattner } 4281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4295deb96d06583abb751463427457d46041af262d0Chris Lattner // Find end of line. This is a hack. 4305deb96d06583abb751463427457d46041af262d0Chris Lattner HighlightRange(RB, TokOffs, TokEnd, BufferStart, 4315deb96d06583abb751463427457d46041af262d0Chris Lattner "<span class='directive'>", "</span>"); 4321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4335deb96d06583abb751463427457d46041af262d0Chris Lattner // Don't skip the next token. 4345deb96d06583abb751463427457d46041af262d0Chris Lattner continue; 4355deb96d06583abb751463427457d46041af262d0Chris Lattner } 4363245a0a1c7a4fd74fca845b2edba275bb126d773Chris Lattner } 4371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 438590f0cc643274267d4d41125b62557e1d87886c3Chris Lattner L.LexFromRawLexer(Tok); 43974ea3e5c57c087c046223096a97ea4e365f85eb6Chris Lattner } 4403245a0a1c7a4fd74fca845b2edba275bb126d773Chris Lattner} 441c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner 442c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner/// HighlightMacros - This uses the macro table state from the end of the 44305db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner/// file, to re-expand macros and insert (into the HTML) information about the 444c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner/// macro expansions. This won't be perfectly perfect, but it will be 445c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner/// reasonably close. 446ff6912b5a9d5073221956fe4d6367b14f3f4b68fDaniel Dunbarvoid html::HighlightMacros(Rewriter &R, FileID FID, const Preprocessor& PP) { 44705db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner // Re-lex the raw token stream into a token buffer. 44805db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner const SourceManager &SM = PP.getSourceManager(); 44905db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner std::vector<Token> TokenStream; 4501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4516e2901407bff59aeb4cc301cc58b034723d0eb49Chris Lattner const llvm::MemoryBuffer *FromFile = SM.getBuffer(FID); 4524e4d08403ca5cfd4d558fa2936215d3a4e5a528dDavid Blaikie Lexer L(FID, FromFile, SM, PP.getLangOpts()); 4531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 45405db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner // Lex all the tokens in raw mode, to avoid entering #includes or expanding 45505db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner // macros. 45605db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner while (1) { 45705db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner Token Tok; 45805db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner L.LexFromRawLexer(Tok); 4591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 46005db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner // If this is a # at the start of a line, discard it from the token stream. 46105db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner // We don't want the re-preprocess step to see #defines, #includes or other 46205db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner // preprocessor directives. 46305db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner if (Tok.is(tok::hash) && Tok.isAtStartOfLine()) 46405db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner continue; 465f0b26b1d9dee57c84e55f05200802658a7312683Chris Lattner 466f0b26b1d9dee57c84e55f05200802658a7312683Chris Lattner // If this is a ## token, change its kind to unknown so that repreprocessing 467f0b26b1d9dee57c84e55f05200802658a7312683Chris Lattner // it will not produce an error. 468f0b26b1d9dee57c84e55f05200802658a7312683Chris Lattner if (Tok.is(tok::hashhash)) 469f0b26b1d9dee57c84e55f05200802658a7312683Chris Lattner Tok.setKind(tok::unknown); 4701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 47105db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner // If this raw token is an identifier, the raw lexer won't have looked up 47205db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner // the corresponding identifier info for it. Do this now so that it will be 47305db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner // macro expanded when we re-preprocess it. 474c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara if (Tok.is(tok::raw_identifier)) 475c4bf2b9afb7d47445a9dc6bc848657098a4e3851Abramo Bagnara PP.LookUpIdentifierInfo(Tok); 4761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 47705db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner TokenStream.push_back(Tok); 4781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 47905db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner if (Tok.is(tok::eof)) break; 48005db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner } 4811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4827c175fb196a2bc3dbc86ea3865c713e1875f3f6dChris Lattner // Temporarily change the diagnostics object so that we ignore any generated 4837c175fb196a2bc3dbc86ea3865c713e1875f3f6dChris Lattner // diagnostics from this pass. 484d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine TmpDiags(PP.getDiagnostics().getDiagnosticIDs(), 48502c23ebf41ae2f70da0ba7337e05c51fbfe35f7fDouglas Gregor &PP.getDiagnostics().getDiagnosticOptions(), 486f40c0ac1238a0ef2010238a43cb078465401239aDavid Blaikie new IgnoringDiagConsumer); 4871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 488ff6912b5a9d5073221956fe4d6367b14f3f4b68fDaniel Dunbar // FIXME: This is a huge hack; we reuse the input preprocessor because we want 489ff6912b5a9d5073221956fe4d6367b14f3f4b68fDaniel Dunbar // its state, but we aren't actually changing it (we hope). This should really 490ff6912b5a9d5073221956fe4d6367b14f3f4b68fDaniel Dunbar // construct a copy of the preprocessor. 491ff6912b5a9d5073221956fe4d6367b14f3f4b68fDaniel Dunbar Preprocessor &TmpPP = const_cast<Preprocessor&>(PP); 492d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine *OldDiags = &TmpPP.getDiagnostics(); 493ff6912b5a9d5073221956fe4d6367b14f3f4b68fDaniel Dunbar TmpPP.setDiagnostics(TmpDiags); 4941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 495c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner // Inform the preprocessor that we don't want comments. 496ff6912b5a9d5073221956fe4d6367b14f3f4b68fDaniel Dunbar TmpPP.SetCommentRetentionState(false, false); 49705db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner 4986fe6a49c4058211ff4489023c78615ec0266c5ffJordan Rose // We don't want pragmas either. Although we filtered out #pragma, removing 4996fe6a49c4058211ff4489023c78615ec0266c5ffJordan Rose // _Pragma and __pragma is much harder. 5006fe6a49c4058211ff4489023c78615ec0266c5ffJordan Rose bool PragmasPreviouslyEnabled = TmpPP.getPragmasEnabled(); 5016fe6a49c4058211ff4489023c78615ec0266c5ffJordan Rose TmpPP.setPragmasEnabled(false); 5026fe6a49c4058211ff4489023c78615ec0266c5ffJordan Rose 50305db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner // Enter the tokens we just lexed. This will cause them to be macro expanded 50405db4278ecd193edcff63fb8c54818226fceaad2Chris Lattner // but won't enter sub-files (because we removed #'s). 505ff6912b5a9d5073221956fe4d6367b14f3f4b68fDaniel Dunbar TmpPP.EnterTokenStream(&TokenStream[0], TokenStream.size(), false, false); 5061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 507ff6912b5a9d5073221956fe4d6367b14f3f4b68fDaniel Dunbar TokenConcatenation ConcatInfo(TmpPP); 5081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 509c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner // Lex all the tokens. 510c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner Token Tok; 511ff6912b5a9d5073221956fe4d6367b14f3f4b68fDaniel Dunbar TmpPP.Lex(Tok); 512c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner while (Tok.isNot(tok::eof)) { 513c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner // Ignore non-macro tokens. 514c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner if (!Tok.getLocation().isMacroID()) { 515ff6912b5a9d5073221956fe4d6367b14f3f4b68fDaniel Dunbar TmpPP.Lex(Tok); 516c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner continue; 517c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner } 5181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 519b7949a9a91ad8e49124cd6a82ff98972d7efaadcChris Lattner // Okay, we have the first token of a macro expansion: highlight the 5207c5c6764e9c0d5b27b37194fb80aa15cbf78c3e9Chandler Carruth // expansion by inserting a start tag before the macro expansion and 521b7949a9a91ad8e49124cd6a82ff98972d7efaadcChris Lattner // end tag after it. 522b7949a9a91ad8e49124cd6a82ff98972d7efaadcChris Lattner std::pair<SourceLocation, SourceLocation> LLoc = 523edc3dccece244a584f8ebdb81da6c962c08e79beChandler Carruth SM.getExpansionRange(Tok.getLocation()); 5241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 525b7949a9a91ad8e49124cd6a82ff98972d7efaadcChris Lattner // Ignore tokens whose instantiation location was not the main file. 526b7949a9a91ad8e49124cd6a82ff98972d7efaadcChris Lattner if (SM.getFileID(LLoc.first) != FID) { 527ff6912b5a9d5073221956fe4d6367b14f3f4b68fDaniel Dunbar TmpPP.Lex(Tok); 528c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner continue; 529c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner } 530b7949a9a91ad8e49124cd6a82ff98972d7efaadcChris Lattner 531b7949a9a91ad8e49124cd6a82ff98972d7efaadcChris Lattner assert(SM.getFileID(LLoc.second) == FID && 532b7949a9a91ad8e49124cd6a82ff98972d7efaadcChris Lattner "Start and end of expansion must be in the same ultimate file!"); 533e9e6cb93afa51eee1f83abc7e2cb7d8a0453d810Chris Lattner 534ff6912b5a9d5073221956fe4d6367b14f3f4b68fDaniel Dunbar std::string Expansion = EscapeText(TmpPP.getSpelling(Tok)); 5356f46be279f4bc8fc24611f060258bcfbe1c175c4Chris Lattner unsigned LineLen = Expansion.size(); 5361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5378877321ca66b2887c2f377a7f724a62f34fdf1cdChris Lattner Token PrevPrevTok; 538867924dbeca06870573fd58d620032da6994b223Chris Lattner Token PrevTok = Tok; 539c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner // Okay, eat this token, getting the next one. 540ff6912b5a9d5073221956fe4d6367b14f3f4b68fDaniel Dunbar TmpPP.Lex(Tok); 5411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 542c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner // Skip all the rest of the tokens that are part of this macro 543c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner // instantiation. It would be really nice to pop up a window with all the 544c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner // spelling of the tokens or something. 545c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner while (!Tok.is(tok::eof) && 546402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth SM.getExpansionLoc(Tok.getLocation()) == LLoc.first) { 5476f46be279f4bc8fc24611f060258bcfbe1c175c4Chris Lattner // Insert a newline if the macro expansion is getting large. 5486f46be279f4bc8fc24611f060258bcfbe1c175c4Chris Lattner if (LineLen > 60) { 5496f46be279f4bc8fc24611f060258bcfbe1c175c4Chris Lattner Expansion += "<br>"; 5506f46be279f4bc8fc24611f060258bcfbe1c175c4Chris Lattner LineLen = 0; 5516f46be279f4bc8fc24611f060258bcfbe1c175c4Chris Lattner } 5521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5536f46be279f4bc8fc24611f060258bcfbe1c175c4Chris Lattner LineLen -= Expansion.size(); 5541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 555867924dbeca06870573fd58d620032da6994b223Chris Lattner // If the tokens were already space separated, or if they must be to avoid 556867924dbeca06870573fd58d620032da6994b223Chris Lattner // them being implicitly pasted, add a space between them. 557867924dbeca06870573fd58d620032da6994b223Chris Lattner if (Tok.hasLeadingSpace() || 5588877321ca66b2887c2f377a7f724a62f34fdf1cdChris Lattner ConcatInfo.AvoidConcat(PrevPrevTok, PrevTok, Tok)) 559867924dbeca06870573fd58d620032da6994b223Chris Lattner Expansion += ' '; 5601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5619227c6953497be34281354f949d6f4cd34a696ccChris Lattner // Escape any special characters in the token text. 562ff6912b5a9d5073221956fe4d6367b14f3f4b68fDaniel Dunbar Expansion += EscapeText(TmpPP.getSpelling(Tok)); 5636f46be279f4bc8fc24611f060258bcfbe1c175c4Chris Lattner LineLen += Expansion.size(); 5641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5658877321ca66b2887c2f377a7f724a62f34fdf1cdChris Lattner PrevPrevTok = PrevTok; 566867924dbeca06870573fd58d620032da6994b223Chris Lattner PrevTok = Tok; 567ff6912b5a9d5073221956fe4d6367b14f3f4b68fDaniel Dunbar TmpPP.Lex(Tok); 5686f46be279f4bc8fc24611f060258bcfbe1c175c4Chris Lattner } 5691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 570e9e6cb93afa51eee1f83abc7e2cb7d8a0453d810Chris Lattner 571e9e6cb93afa51eee1f83abc7e2cb7d8a0453d810Chris Lattner // Insert the expansion as the end tag, so that multi-line macros all get 572e9e6cb93afa51eee1f83abc7e2cb7d8a0453d810Chris Lattner // highlighted. 573e9e6cb93afa51eee1f83abc7e2cb7d8a0453d810Chris Lattner Expansion = "<span class='expansion'>" + Expansion + "</span></span>"; 574e9e6cb93afa51eee1f83abc7e2cb7d8a0453d810Chris Lattner 575e9e6cb93afa51eee1f83abc7e2cb7d8a0453d810Chris Lattner HighlightRange(R, LLoc.first, LLoc.second, 576e9e6cb93afa51eee1f83abc7e2cb7d8a0453d810Chris Lattner "<span class='macro'>", Expansion.c_str()); 577c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner } 5787c175fb196a2bc3dbc86ea3865c713e1875f3f6dChris Lattner 5796fe6a49c4058211ff4489023c78615ec0266c5ffJordan Rose // Restore the preprocessor's old state. 580ff6912b5a9d5073221956fe4d6367b14f3f4b68fDaniel Dunbar TmpPP.setDiagnostics(*OldDiags); 5816fe6a49c4058211ff4489023c78615ec0266c5ffJordan Rose TmpPP.setPragmasEnabled(PragmasPreviouslyEnabled); 582c54d50a4180520370c12dd7d06d035263d357d56Chris Lattner} 583