src/mem/slicc/generate/html.py

   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
  28 from m5.util.code_formatter import code_formatter
  29
  30 def createSymbol(symbol, title):
  31     code = code_formatter()
  32     code('''
  33 <HTML><BODY><BIG>
  34 $title: ${{formatShorthand(symbol.short)}} - ${{symbol.desc}}
  35 </BIG></BODY></HTML>
  36 ''')
  37     return code
  38
  39 def formatShorthand(short):
  40     munged_shorthand = ""
  41     mode_is_normal = True
  42
  43     # -- Walk over the string, processing superscript directives
  44     gen = enumerate(short)
  45     for i,c in gen:
  46         if c == '!':
  47             # -- Reached logical end of shorthand name
  48             break
  49         elif c == '_':
  50             munged_shorthand += " "
  51         elif c == '^':
  52             # -- Process super/subscript formatting
  53             mode_is_normal = not mode_is_normal
  54             if mode_is_normal:
  55                 # -- Back to normal mode
  56                 munged_shorthand += "</SUP>"
  57             else:
  58                 # -- Going to superscript mode
  59                 munged_shorthand += "<SUP>"
  60         elif c == '\\':
  61             # -- Process Symbol character set
  62             if i + 1 < len(short):
  63                 # -- Proceed to next char. Yes I know that changing
  64                 # the loop var is ugly!
  65                 i,c = next(gen)
  66                 munged_shorthand += "<B><FONT size=+1>"
  67                 munged_shorthand += c
  68                 munged_shorthand += "</FONT></B>"
  69             else:
  70                 # -- FIXME: Add line number info later
  71                 panic("Encountered a `\\` without anything following it!")
  72         else:
  73             # -- Pass on un-munged
  74             munged_shorthand += c
  75
  76     # -- Do any other munging
  77     if not mode_is_normal:
  78         # -- Back to normal mode
  79         munged_shorthand += "</SUP>"
  80
  81     return munged_shorthand
  82