html.py revision 6657:ef5fae93a3b2
1# Copyright (c) 1999-2008 Mark D. Hill and David A. Wood 2# Copyright (c) 2009 The Hewlett-Packard Development Company 3# All rights reserved. 4# 5# Redistribution and use in source and binary forms, with or without 6# modification, are permitted provided that the following conditions are 7# met: redistributions of source code must retain the above copyright 8# notice, this list of conditions and the following disclaimer; 9# redistributions in binary form must reproduce the above copyright 10# notice, this list of conditions and the following disclaimer in the 11# documentation and/or other materials provided with the distribution; 12# neither the name of the copyright holders nor the names of its 13# contributors may be used to endorse or promote products derived from 14# this software without specific prior written permission. 15# 16# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 17# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 18# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 19# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 20# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 21# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 22# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 23# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 24# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 26# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27 28from m5.util.code_formatter import code_formatter 29 30def createSymbol(symbol, title): 31 code = code_formatter() 32 code('''<HTML><BODY><BIG> 33$title: 34${{formatShorthand(symbol.short)}} - ${{symbol.desc}}</BIG></BODY></HTML>''') 35 return code 36 37def formatShorthand(short): 38 munged_shorthand = "" 39 mode_is_normal = True 40 41 # -- Walk over the string, processing superscript directives 42 gen = enumerate(short) 43 for i,c in gen: 44 if c == '!': 45 # -- Reached logical end of shorthand name 46 break 47 elif c == '_': 48 munged_shorthand += " " 49 elif c == '^': 50 # -- Process super/subscript formatting 51 mode_is_normal = not mode_is_normal 52 if mode_is_normal: 53 # -- Back to normal mode 54 munged_shorthand += "</SUP>" 55 else: 56 # -- Going to superscript mode 57 munged_shorthand += "<SUP>" 58 elif c == '\\': 59 # -- Process Symbol character set 60 if i + 1 < len(short): 61 # -- Proceed to next char. Yes I know that changing 62 # the loop var is ugly! 63 i,c = gen.next() 64 munged_shorthand += "<B><FONT size=+1>" 65 munged_shorthand += c 66 munged_shorthand += "</FONT></B>" 67 else: 68 # -- FIXME: Add line number info later 69 panic("Encountered a `\\` without anything following it!") 70 else: 71 # -- Pass on un-munged 72 munged_shorthand += c 73 74 # -- Do any other munging 75 if not mode_is_normal: 76 # -- Back to normal mode 77 munged_shorthand += "</SUP>" 78 79 return munged_shorthand 80 81