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

   1 # Copyright (C) 2008, 2009, 2010, 2011 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 # Flag to make NoStringContainerPrinter throw an exception.
  57 exception_flag = False
  58
  59 # Test a printer where to_string is None
  60 class NoStringContainerPrinter:
  61     class _iterator:
  62         def __init__ (self, pointer, len):
  63             self.start = pointer
  64             self.pointer = pointer
  65             self.end = pointer + len
  66
  67         def __iter__(self):
  68             return self
  69
  70         def next(self):
  71             if self.pointer == self.end:
  72                 raise StopIteration
  73             if exception_flag:
  74                 raise gdb.MemoryError, 'hi bob'
  75             result = self.pointer
  76             self.pointer = self.pointer + 1
  77             return ('[%d]' % int (result - self.start), result.dereference())
  78
  79     def __init__(self, val):
  80         self.val = val
  81
  82     def to_string(self):
  83         return None
  84
  85     def children(self):
  86         return self._iterator(self.val['elements'], self.val['len'])
  87
  88 class pp_s:
  89     def __init__(self, val):
  90         self.val = val
  91
  92     def to_string(self):
  93         a = self.val["a"]
  94         b = self.val["b"]
  95         if a.address != b:
  96             raise Exception("&a(%s) != b(%s)" % (str(a.address), str(b)))
  97         return " a=<" + str(self.val["a"]) + "> b=<" + str(self.val["b"]) + ">"
  98
  99 class pp_ss:
 100     def __init__(self, val):
 101         self.val = val
 102
 103     def to_string(self):
 104         return "a=<" + str(self.val["a"]) + "> b=<" + str(self.val["b"]) + ">"
 105
 106 class pp_sss:
 107     def __init__(self, val):
 108         self.val = val
 109
 110     def to_string(self):
 111         return "a=<" + str(self.val['a']) + "> b=<" + str(self.val["b"]) + ">"
 112
 113 class pp_multiple_virtual:
 114     def __init__ (self, val):
 115         self.val = val
 116
 117     def to_string (self):
 118         return "pp value variable is: " + str (self.val['value'])
 119
 120 class pp_vbase1:
 121     def __init__ (self, val):
 122         self.val = val
 123
 124     def to_string (self):
 125         return "pp class name: " + self.val.type.tag
 126
 127 class pp_nullstr:
 128     def __init__(self, val):
 129         self.val = val
 130
 131     def to_string(self):
 132         return self.val['s'].string(gdb.target_charset())
 133
 134 class pp_ns:
 135     "Print a std::basic_string of some kind"
 136
 137     def __init__(self, val):
 138         self.val = val
 139
 140     def to_string(self):
 141         len = self.val['length']
 142         return self.val['null_str'].string (gdb.target_charset(), length = len)
 143
 144     def display_hint (self):
 145         return 'string'
 146
 147 pp_ls_encoding = None
 148
 149 class pp_ls:
 150     "Print a std::basic_string of some kind"
 151
 152     def __init__(self, val):
 153         self.val = val
 154
 155     def to_string(self):
 156         if pp_ls_encoding is not None:
 157             return self.val['lazy_str'].lazy_string(encoding = pp_ls_encoding)
 158         else:
 159             return self.val['lazy_str'].lazy_string()
 160
 161     def display_hint (self):
 162         return 'string'
 163
 164 class pp_outer:
 165     "Print struct outer"
 166
 167     def __init__ (self, val):
 168         self.val = val
 169
 170     def to_string (self):
 171         return "x = %s" % self.val['x']
 172
 173     def children (self):
 174         yield 's', self.val['s']
 175         yield 'x', self.val['x']
 176
 177 def lookup_function (val):
 178     "Look-up and return a pretty-printer that can print val."
 179
 180     # Get the type.
 181     type = val.type
 182
 183     # If it points to a reference, get the reference.
 184     if type.code == gdb.TYPE_CODE_REF:
 185         type = type.target ()
 186
 187     # Get the unqualified type, stripped of typedefs.
 188     type = type.unqualified ().strip_typedefs ()
 189
 190     # Get the type name.
 191     typename = type.tag
 192
 193     if typename == None:
 194         return None
 195
 196     # Iterate over local dictionary of types to determine
 197     # if a printer is registered for that type.  Return an
 198     # instantiation of the printer if found.
 199     for function in pretty_printers_dict:
 200         if function.match (typename):
 201             return pretty_printers_dict[function] (val)
 202
 203     # Cannot find a pretty printer.  Return None.
 204
 205     return None
 206
 207 def disable_lookup_function ():
 208     lookup_function.enabled = False
 209
 210 def enable_lookup_function ():
 211     lookup_function.enabled = True
 212
 213 def register_pretty_printers ():
 214     pretty_printers_dict[re.compile ('^struct s$')]   = pp_s
 215     pretty_printers_dict[re.compile ('^s$')]   = pp_s
 216     pretty_printers_dict[re.compile ('^S$')]   = pp_s
 217
 218     pretty_printers_dict[re.compile ('^struct ss$')]  = pp_ss
 219     pretty_printers_dict[re.compile ('^ss$')]  = pp_ss
 220     pretty_printers_dict[re.compile ('^const S &$')]   = pp_s
 221     pretty_printers_dict[re.compile ('^SSS$')]  = pp_sss
 222
 223     pretty_printers_dict[re.compile ('^VirtualTest$')] =  pp_multiple_virtual
 224     pretty_printers_dict[re.compile ('^Vbase1$')] =  pp_vbase1
 225
 226     pretty_printers_dict[re.compile ('^struct nullstr$')] = pp_nullstr
 227     pretty_printers_dict[re.compile ('^nullstr$')] = pp_nullstr
 228
 229     # Note that we purposely omit the typedef names here.
 230     # Printer lookup is based on canonical name.
 231     # However, we do need both tagged and untagged variants, to handle
 232     # both the C and C++ cases.
 233     pretty_printers_dict[re.compile ('^struct string_repr$')] = string_print
 234     pretty_printers_dict[re.compile ('^struct container$')] = ContainerPrinter
 235     pretty_printers_dict[re.compile ('^struct justchildren$')] = NoStringContainerPrinter
 236     pretty_printers_dict[re.compile ('^string_repr$')] = string_print
 237     pretty_printers_dict[re.compile ('^container$')] = ContainerPrinter
 238     pretty_printers_dict[re.compile ('^justchildren$')] = NoStringContainerPrinter
 239
 240     pretty_printers_dict[re.compile ('^struct ns$')]  = pp_ns
 241     pretty_printers_dict[re.compile ('^ns$')]  = pp_ns
 242
 243     pretty_printers_dict[re.compile ('^struct lazystring$')]  = pp_ls
 244     pretty_printers_dict[re.compile ('^lazystring$')]  = pp_ls
 245
 246     pretty_printers_dict[re.compile ('^struct outerstruct$')]  = pp_outer
 247     pretty_printers_dict[re.compile ('^outerstruct$')]  = pp_outer
 248
 249 pretty_printers_dict = {}
 250
 251 register_pretty_printers ()
 252 gdb.pretty_printers.append (lookup_function)