html.py revision 6657 
16657Snate@binkert.org# Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
26657Snate@binkert.org# Copyright (c) 2009 The Hewlett-Packard Development Company
36657Snate@binkert.org# All rights reserved.
46657Snate@binkert.org#
56657Snate@binkert.org# Redistribution and use in source and binary forms, with or without
66657Snate@binkert.org# modification, are permitted provided that the following conditions are
76657Snate@binkert.org# met: redistributions of source code must retain the above copyright
86657Snate@binkert.org# notice, this list of conditions and the following disclaimer;
96657Snate@binkert.org# redistributions in binary form must reproduce the above copyright
106657Snate@binkert.org# notice, this list of conditions and the following disclaimer in the
116657Snate@binkert.org# documentation and/or other materials provided with the distribution;
126657Snate@binkert.org# neither the name of the copyright holders nor the names of its
136657Snate@binkert.org# contributors may be used to endorse or promote products derived from
146657Snate@binkert.org# this software without specific prior written permission.
156657Snate@binkert.org#
166657Snate@binkert.org# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
176657Snate@binkert.org# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
186657Snate@binkert.org# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
196657Snate@binkert.org# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
206657Snate@binkert.org# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
216657Snate@binkert.org# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
226657Snate@binkert.org# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
236657Snate@binkert.org# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
246657Snate@binkert.org# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
256657Snate@binkert.org# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
266657Snate@binkert.org# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
276657Snate@binkert.org
286657Snate@binkert.orgfrom m5.util.code_formatter import code_formatter
296657Snate@binkert.org
306657Snate@binkert.orgdef createSymbol(symbol, title):
316657Snate@binkert.org    code = code_formatter()
326657Snate@binkert.org    code('''<HTML><BODY><BIG>
336657Snate@binkert.org$title:
346657Snate@binkert.org${{formatShorthand(symbol.short)}} - ${{symbol.desc}}</BIG></BODY></HTML>''')
356657Snate@binkert.org    return code
366657Snate@binkert.org
376657Snate@binkert.orgdef formatShorthand(short):
386657Snate@binkert.org    munged_shorthand = ""
396657Snate@binkert.org    mode_is_normal = True
406657Snate@binkert.org
416657Snate@binkert.org    # -- Walk over the string, processing superscript directives
426657Snate@binkert.org    gen = enumerate(short)
436657Snate@binkert.org    for i,c in gen:
446657Snate@binkert.org        if c == '!':
456657Snate@binkert.org            # -- Reached logical end of shorthand name
466657Snate@binkert.org            break
476657Snate@binkert.org        elif c == '_':
486657Snate@binkert.org            munged_shorthand += " "
496657Snate@binkert.org        elif c == '^':
506657Snate@binkert.org            # -- Process super/subscript formatting
516657Snate@binkert.org            mode_is_normal = not mode_is_normal
526657Snate@binkert.org            if mode_is_normal:
536657Snate@binkert.org                # -- Back to normal mode
546657Snate@binkert.org                munged_shorthand += "</SUP>"
556657Snate@binkert.org            else:
566657Snate@binkert.org                # -- Going to superscript mode
576657Snate@binkert.org                munged_shorthand += "<SUP>"
586657Snate@binkert.org        elif c == '\\':
596657Snate@binkert.org            # -- Process Symbol character set
606657Snate@binkert.org            if i + 1 < len(short):
616657Snate@binkert.org                # -- Proceed to next char. Yes I know that changing
626657Snate@binkert.org                # the loop var is ugly!
636657Snate@binkert.org                i,c = gen.next()
646657Snate@binkert.org                munged_shorthand += "<B><FONT size=+1>"
656657Snate@binkert.org                munged_shorthand += c
666657Snate@binkert.org                munged_shorthand += "</FONT></B>"
676657Snate@binkert.org            else:
686657Snate@binkert.org                # -- FIXME: Add line number info later
696657Snate@binkert.org                panic("Encountered a `\\` without anything following it!")
706657Snate@binkert.org        else:
716657Snate@binkert.org            # -- Pass on un-munged
726657Snate@binkert.org            munged_shorthand += c
736657Snate@binkert.org
746657Snate@binkert.org    # -- Do any other munging
756657Snate@binkert.org    if not mode_is_normal:
766657Snate@binkert.org        # -- Back to normal mode
776657Snate@binkert.org        munged_shorthand += "</SUP>"
786657Snate@binkert.org
796657Snate@binkert.org    return munged_shorthand
806657Snate@binkert.org
81