This is an archive of the discontinued LLVM Phabricator instance.

Differential D30132

opt-viewer: Fix syntax highlighting
ClosedPublic

Authored by bcain on Feb 17 2017, 8:32 PM.

Details

Reviewers
anemet
fhahn
Summary

Syntax highlighting has been done line-at-a-time. Done this way, the lexer resets the context at each line, distorting the formatting.

This change will render the whole file at once and feed the highlighted text line-at-a-time to be wrapped by the SourceFileRenderer.

Leading/trailing newlines were being ignored by Pygments but since each line was rendered in its own row, it didn't matter. This bug was masked by the line-at-a-time algorithm. So now we need to add "stripnl=False" to the CppLexer to change its behavior to match the expectation.

Diff Detail

Repository
rL LLVM

Event Timeline

bcain created this revision.Feb 17 2017, 8:32 PM
anemet accepted this revision.Feb 17 2017, 11:24 PM

LGTM, thanks!

This revision is now accepted and ready to land.Feb 17 2017, 11:24 PM
bcain closed this revision.Feb 19 2017, 1:26 PM

Revision Contents

PathSize
utils/
opt-viewer/
27 lines

Diff 89009

utils/opt-viewer/opt-viewer.py

Show First 20 Lines • Show All 178 Lines • ▼ Show 20 Lines def __init__(self, source_dir, output_dir, filename):
self.source_stream = None self.source_stream = None
print(''' print('''
<html> <html>
<h1>Unable to locate file {}</h1> <h1>Unable to locate file {}</h1>
</html> </html>
'''.format(filename), file=self.stream) '''.format(filename), file=self.stream)
self.html_formatter = HtmlFormatter(encoding='utf-8') self.html_formatter = HtmlFormatter(encoding='utf-8')
self.cpp_lexer = CppLexer() self.cpp_lexer = CppLexer(stripnl=False)
def render_source_line(self, linenum, line): def render_source_lines(self, stream, line_remarks):
html_line = highlight(line, self.cpp_lexer, self.html_formatter) file_text = stream.read()
html_highlighted = highlight(file_text, self.cpp_lexer, self.html_formatter)
# Take off the header and footer, these must be
# reapplied line-wise, within the page structure
html_highlighted = html_highlighted.replace('<div class="highlight"><pre>', '')
html_highlighted = html_highlighted.replace('</pre></div>', '')
for (linenum, html_line) in enumerate(html_highlighted.split('\n'), start=1):
print(''' print('''
<tr> <tr>
<td><a name=\"L{linenum}\">{linenum}</a></td> <td><a name=\"L{linenum}\">{linenum}</a></td>
<td></td> <td></td>
<td></td> <td></td>
<td>{html_line}</td> <td><div class="highlight"><pre>{html_line}</pre></div></td>
</tr>'''.format(**locals()), file=self.stream) </tr>'''.format(**locals()), file=self.stream)
for remark in line_remarks.get(linenum, []):
self.render_inline_remarks(remark, html_line)
def render_inline_remarks(self, r, line): def render_inline_remarks(self, r, line):
inlining_context = r.DemangledFunctionName inlining_context = r.DemangledFunctionName
print print
dl = context.caller_loc.get(r.Function) dl = context.caller_loc.get(r.Function)
if dl: if dl:
link = Remark.make_link(dl['File'], dl['Line'] - 2) link = Remark.make_link(dl['File'], dl['Line'] - 2)
inlining_context = "<a href={link}>{r.DemangledFunctionName}</a>".format(**locals()) inlining_context = "<a href={link}>{r.DemangledFunctionName}</a>".format(**locals())
Show All 25 Lines
<table> <table>
<tr> <tr>
<td>Line</td> <td>Line</td>
<td>Hotness</td> <td>Hotness</td>
<td>Optimization</td> <td>Optimization</td>
<td>Source</td> <td>Source</td>
<td>Inline Context</td> <td>Inline Context</td>
</tr>''', file=self.stream) </tr>''', file=self.stream)
for (linenum, line) in enumerate(self.source_stream.readlines(), start=1): self.render_source_lines(self.source_stream, line_remarks)
self.render_source_line(linenum, line)
for remark in line_remarks.get(linenum, []):
self.render_inline_remarks(remark, line)
print(''' print('''
</table> </table>
</body> </body>
</html>''', file=self.stream) </html>''', file=self.stream)
@classmethod @classmethod
def html_file_name(cls, filename): def html_file_name(cls, filename):
return filename.replace('/', '_') + ".html" return filename.replace('/', '_') + ".html"
▲ Show 20 Lines • Show All 153 Lines • Show Last 20 Lines