gdb/testsuite/gdb.python/py-prettyprint.py

   1 # Copyright (C) 2008, 2009, 2010 Free Software Foundation, Inc.
   2
   3 # This program is free software; you can redistribute it and/or modify
   4 # it under the terms of the GNU General Public License as published by
   5 # the Free Software Foundation; either version 3 of the License, or
   6 # (at your option) any later version.
   7 #
   8 # This program is distributed in the hope that it will be useful,
   9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 # GNU General Public License for more details.
  12 #
  13 # You should have received a copy of the GNU General Public License
  14 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  15
  16 # This file is part of the GDB testsuite.  It tests python pretty
  17 # printers.
  18
  19 import re
  20
  21 # Test returning a Value from a printer.
  22 class string_print:
  23     def __init__(self, val):
  24         self.val = val
  25
  26     def to_string(self):
  27         return self.val['whybother']['contents']
  28
  29 # Test a class-based printer.
  30 class ContainerPrinter:
  31     class _iterator:
  32         def __init__ (self, pointer, len):
  33             self.start = pointer
  34             self.pointer = pointer
  35             self.end = pointer + len
  36
  37         def __iter__(self):
  38             return self
  39
  40         def next(self):
  41             if self.pointer == self.end:
  42                 raise StopIteration
  43             result = self.pointer
  44             self.pointer = self.pointer + 1
  45             return ('[%d]' % int (result - self.start), result.dereference())
  46
  47     def __init__(self, val):
  48         self.val = val
  49
  50     def to_string(self):
  51         return 'container %s with %d elements' % (self.val['name'], self.val['len'])
  52
  53     def children(self):
  54         return self._iterator(self.val['elements'], self.val['len'])
  55
  56 class pp_s:
  57     def __init__(self, val):
  58         self.val = val
  59
  60     def to_string(self):
  61         a = self.val["a"]
  62         b = self.val["b"]
  63         if a.address != b:
  64             raise Exception("&a(%s) != b(%s)" % (str(a.address), str(b)))
  65         return " a=<" + str(self.val["a"]) + "> b=<" + str(self.val["b"]) + ">"
  66
  67 class pp_ss:
  68     def __init__(self, val):
  69         self.val = val
  70
  71     def to_string(self):
  72         return "a=<" + str(self.val["a"]) + "> b=<" + str(self.val["b"]) + ">"
  73
  74 class pp_sss:
  75     def __init__(self, val):
  76         self.val = val
  77
  78     def to_string(self):
  79         return "a=<" + str(self.val['a']) + "> b=<" + str(self.val["b"]) + ">"
  80
  81 class pp_multiple_virtual:
  82     def __init__ (self, val):
  83         self.val = val
  84
  85     def to_string (self):
  86         return "pp value variable is: " + str (self.val['value'])
  87
  88 class pp_vbase1:
  89     def __init__ (self, val):
  90         self.val = val
  91
  92     def to_string (self):
  93         return "pp class name: " + self.val.type.tag
  94
  95 class pp_nullstr:
  96     def __init__(self, val):
  97         self.val = val
  98
  99     def to_string(self):
 100         return self.val['s'].string(gdb.parameter('target-charset'))
 101
 102 class pp_ns:
 103     "Print a std::basic_string of some kind"
 104
 105     def __init__(self, val):
 106         self.val = val
 107
 108     def to_string(self):
 109         len = self.val['length']
 110         return self.val['null_str'].string (gdb.parameter ('target-charset'), length = len)
 111
 112     def display_hint (self):
 113         return 'string'
 114
 115 class pp_outer:
 116     "Print struct outer"
 117
 118     def __init__ (self, val):
 119         self.val = val
 120
 121     def to_string (self):
 122         return "x = %s" % self.val['x']
 123
 124     def children (self):
 125         yield 's', self.val['s']
 126         yield 'x', self.val['x']
 127
 128 def lookup_function (val):
 129     "Look-up and return a pretty-printer that can print val."
 130
 131     # Get the type.
 132     type = val.type
 133
 134     # If it points to a reference, get the reference.
 135     if type.code == gdb.TYPE_CODE_REF:
 136         type = type.target ()
 137
 138     # Get the unqualified type, stripped of typedefs.
 139     type = type.unqualified ().strip_typedefs ()
 140
 141     # Get the type name.
 142     typename = type.tag
 143
 144     if typename == None:
 145         return None
 146
 147     # Iterate over local dictionary of types to determine
 148     # if a printer is registered for that type.  Return an
 149     # instantiation of the printer if found.
 150     for function in pretty_printers_dict:
 151         if function.match (typename):
 152             return pretty_printers_dict[function] (val)
 153
 154     # Cannot find a pretty printer.  Return None.
 155
 156     return None
 157
 158
 159 def register_pretty_printers ():
 160     pretty_printers_dict[re.compile ('^struct s$')]   = pp_s
 161     pretty_printers_dict[re.compile ('^s$')]   = pp_s
 162     pretty_printers_dict[re.compile ('^S$')]   = pp_s
 163
 164     pretty_printers_dict[re.compile ('^struct ss$')]  = pp_ss
 165     pretty_printers_dict[re.compile ('^ss$')]  = pp_ss
 166     pretty_printers_dict[re.compile ('^const S &$')]   = pp_s
 167     pretty_printers_dict[re.compile ('^SSS$')]  = pp_sss
 168
 169     pretty_printers_dict[re.compile ('^VirtualTest$')] =  pp_multiple_virtual
 170     pretty_printers_dict[re.compile ('^Vbase1$')] =  pp_vbase1
 171
 172     pretty_printers_dict[re.compile ('^struct nullstr$')] = pp_nullstr
 173     pretty_printers_dict[re.compile ('^nullstr$')] = pp_nullstr
 174
 175     # Note that we purposely omit the typedef names here.
 176     # Printer lookup is based on canonical name.
 177     # However, we do need both tagged and untagged variants, to handle
 178     # both the C and C++ cases.
 179     pretty_printers_dict[re.compile ('^struct string_repr$')] = string_print
 180     pretty_printers_dict[re.compile ('^struct container$')] = ContainerPrinter
 181     pretty_printers_dict[re.compile ('^string_repr$')] = string_print
 182     pretty_printers_dict[re.compile ('^container$')] = ContainerPrinter
 183
 184     pretty_printers_dict[re.compile ('^struct ns$')]  = pp_ns
 185     pretty_printers_dict[re.compile ('^ns$')]  = pp_ns
 186
 187     pretty_printers_dict[re.compile ('^struct outerstruct$')]  = pp_outer
 188     pretty_printers_dict[re.compile ('^outerstruct$')]  = pp_outer
 189
 190 pretty_printers_dict = {}
 191
 192 register_pretty_printers ()
 193 gdb.pretty_printers.append (lookup_function)