libstdc++-v3/python/libstdcxx/v6/printers.py

   1 # Pretty-printers for libstc++.
   2
   3 # Copyright (C) 2008-2013 Free Software Foundation, Inc.
   4
   5 # This program is free software; you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 3 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 import gdb
  19 import itertools
  20 import re
  21
  22 # Try to use the new-style pretty-printing if available.
  23 _use_gdb_pp = True
  24 try:
  25     import gdb.printing
  26 except ImportError:
  27     _use_gdb_pp = False
  28
  29 # Try to install type-printers.
  30 _use_type_printing = False
  31 try:
  32     import gdb.types
  33     if hasattr(gdb.types, 'TypePrinter'):
  34         _use_type_printing = True
  35 except ImportError:
  36     pass
  37
  38 # Starting with the type ORIG, search for the member type NAME.  This
  39 # handles searching upward through superclasses.  This is needed to
  40 # work around http://sourceware.org/bugzilla/show_bug.cgi?id=13615.
  41 def find_type(orig, name):
  42     typ = orig.strip_typedefs()
  43     while True:
  44         search = str(typ) + '::' + name
  45         try:
  46             return gdb.lookup_type(search)
  47         except RuntimeError:
  48             pass
  49         # The type was not found, so try the superclass.  We only need
  50         # to check the first superclass, so we don't bother with
  51         # anything fancier here.
  52         field = typ.fields()[0]
  53         if not field.is_base_class:
  54             raise ValueError, "Cannot find type %s::%s" % (str(orig), name)
  55         typ = field.type
  56
  57 class SharedPointerPrinter:
  58     "Print a shared_ptr or weak_ptr"
  59
  60     def __init__ (self, typename, val):
  61         self.typename = typename
  62         self.val = val
  63
  64     def to_string (self):
  65         state = 'empty'
  66         refcounts = self.val['_M_refcount']['_M_pi']
  67         if refcounts != 0:
  68             usecount = refcounts['_M_use_count']
  69             weakcount = refcounts['_M_weak_count']
  70             if usecount == 0:
  71                 state = 'expired, weak %d' % weakcount
  72             else:
  73                 state = 'count %d, weak %d' % (usecount, weakcount - 1)
  74         return '%s (%s) %s' % (self.typename, state, self.val['_M_ptr'])
  75
  76 class UniquePointerPrinter:
  77     "Print a unique_ptr"
  78
  79     def __init__ (self, typename, val):
  80         self.val = val
  81
  82     def to_string (self):
  83         v = self.val['_M_t']['_M_head_impl']
  84         return ('std::unique_ptr<%s> containing %s' % (str(v.type.target()),
  85                                                        str(v)))
  86
  87 class StdListPrinter:
  88     "Print a std::list"
  89
  90     class _iterator:
  91         def __init__(self, nodetype, head):
  92             self.nodetype = nodetype
  93             self.base = head['_M_next']
  94             self.head = head.address
  95             self.count = 0
  96
  97         def __iter__(self):
  98             return self
  99
 100         def next(self):
 101             if self.base == self.head:
 102                 raise StopIteration
 103             elt = self.base.cast(self.nodetype).dereference()
 104             self.base = elt['_M_next']
 105             count = self.count
 106             self.count = self.count + 1
 107             return ('[%d]' % count, elt['_M_data'])
 108
 109     def __init__(self, typename, val):
 110         self.typename = typename
 111         self.val = val
 112
 113     def children(self):
 114         nodetype = find_type(self.val.type, '_Node')
 115         nodetype = nodetype.strip_typedefs().pointer()
 116         return self._iterator(nodetype, self.val['_M_impl']['_M_node'])
 117
 118     def to_string(self):
 119         if self.val['_M_impl']['_M_node'].address == self.val['_M_impl']['_M_node']['_M_next']:
 120             return 'empty %s' % (self.typename)
 121         return '%s' % (self.typename)
 122
 123 class StdListIteratorPrinter:
 124     "Print std::list::iterator"
 125
 126     def __init__(self, typename, val):
 127         self.val = val
 128         self.typename = typename
 129
 130     def to_string(self):
 131         nodetype = find_type(self.val.type, '_Node')
 132         nodetype = nodetype.strip_typedefs().pointer()
 133         return self.val['_M_node'].cast(nodetype).dereference()['_M_data']
 134
 135 class StdSlistPrinter:
 136     "Print a __gnu_cxx::slist"
 137
 138     class _iterator:
 139         def __init__(self, nodetype, head):
 140             self.nodetype = nodetype
 141             self.base = head['_M_head']['_M_next']
 142             self.count = 0
 143
 144         def __iter__(self):
 145             return self
 146
 147         def next(self):
 148             if self.base == 0:
 149                 raise StopIteration
 150             elt = self.base.cast(self.nodetype).dereference()
 151             self.base = elt['_M_next']
 152             count = self.count
 153             self.count = self.count + 1
 154             return ('[%d]' % count, elt['_M_data'])
 155
 156     def __init__(self, typename, val):
 157         self.val = val
 158
 159     def children(self):
 160         nodetype = find_type(self.val.type, '_Node')
 161         nodetype = nodetype.strip_typedefs().pointer()
 162         return self._iterator(nodetype, self.val)
 163
 164     def to_string(self):
 165         if self.val['_M_head']['_M_next'] == 0:
 166             return 'empty __gnu_cxx::slist'
 167         return '__gnu_cxx::slist'
 168
 169 class StdSlistIteratorPrinter:
 170     "Print __gnu_cxx::slist::iterator"
 171
 172     def __init__(self, typename, val):
 173         self.val = val
 174
 175     def to_string(self):
 176         nodetype = find_type(self.val.type, '_Node')
 177         nodetype = nodetype.strip_typedefs().pointer()
 178         return self.val['_M_node'].cast(nodetype).dereference()['_M_data']
 179
 180 class StdVectorPrinter:
 181     "Print a std::vector"
 182
 183     class _iterator:
 184         def __init__ (self, start, finish, bitvec):
 185             self.bitvec = bitvec
 186             if bitvec:
 187                 self.item   = start['_M_p']
 188                 self.so     = start['_M_offset']
 189                 self.finish = finish['_M_p']
 190                 self.fo     = finish['_M_offset']
 191                 itype = self.item.dereference().type
 192                 self.isize = 8 * itype.sizeof
 193             else:
 194                 self.item = start
 195                 self.finish = finish
 196             self.count = 0
 197
 198         def __iter__(self):
 199             return self
 200
 201         def next(self):
 202             count = self.count
 203             self.count = self.count + 1
 204             if self.bitvec:
 205                 if self.item == self.finish and self.so >= self.fo:
 206                     raise StopIteration
 207                 elt = self.item.dereference()
 208                 if elt & (1 << self.so):
 209                     obit = 1
 210                 else:
 211                     obit = 0
 212                 self.so = self.so + 1
 213                 if self.so >= self.isize:
 214                     self.item = self.item + 1
 215                     self.so = 0
 216                 return ('[%d]' % count, obit)
 217             else:
 218                 if self.item == self.finish:
 219                     raise StopIteration
 220                 elt = self.item.dereference()
 221                 self.item = self.item + 1
 222                 return ('[%d]' % count, elt)
 223
 224     def __init__(self, typename, val):
 225         self.typename = typename
 226         self.val = val
 227         self.is_bool = val.type.template_argument(0).code  == gdb.TYPE_CODE_BOOL
 228
 229     def children(self):
 230         return self._iterator(self.val['_M_impl']['_M_start'],
 231                               self.val['_M_impl']['_M_finish'],
 232                               self.is_bool)
 233
 234     def to_string(self):
 235         start = self.val['_M_impl']['_M_start']
 236         finish = self.val['_M_impl']['_M_finish']
 237         end = self.val['_M_impl']['_M_end_of_storage']
 238         if self.is_bool:
 239             start = self.val['_M_impl']['_M_start']['_M_p']
 240             so    = self.val['_M_impl']['_M_start']['_M_offset']
 241             finish = self.val['_M_impl']['_M_finish']['_M_p']
 242             fo     = self.val['_M_impl']['_M_finish']['_M_offset']
 243             itype = start.dereference().type
 244             bl = 8 * itype.sizeof
 245             length   = (bl - so) + bl * ((finish - start) - 1) + fo
 246             capacity = bl * (end - start)
 247             return ('%s<bool> of length %d, capacity %d'
 248                     % (self.typename, int (length), int (capacity)))
 249         else:
 250             return ('%s of length %d, capacity %d'
 251                     % (self.typename, int (finish - start), int (end - start)))
 252
 253     def display_hint(self):
 254         return 'array'
 255
 256 class StdVectorIteratorPrinter:
 257     "Print std::vector::iterator"
 258
 259     def __init__(self, typename, val):
 260         self.val = val
 261
 262     def to_string(self):
 263         return self.val['_M_current'].dereference()
 264
 265 class StdTuplePrinter:
 266     "Print a std::tuple"
 267
 268     class _iterator:
 269         def __init__ (self, head):
 270             self.head = head
 271
 272             # Set the base class as the initial head of the
 273             # tuple.
 274             nodes = self.head.type.fields ()
 275             if len (nodes) == 1:
 276                 # Set the actual head to the first pair.
 277                 self.head  = self.head.cast (nodes[0].type)
 278             elif len (nodes) != 0:
 279                 raise ValueError, "Top of tuple tree does not consist of a single node."
 280             self.count = 0
 281
 282         def __iter__ (self):
 283             return self
 284
 285         def next (self):
 286             nodes = self.head.type.fields ()
 287             # Check for further recursions in the inheritance tree.
 288             if len (nodes) == 0:
 289                 raise StopIteration
 290             # Check that this iteration has an expected structure.
 291             if len (nodes) != 2:
 292                 raise ValueError, "Cannot parse more than 2 nodes in a tuple tree."
 293
 294             # - Left node is the next recursion parent.
 295             # - Right node is the actual class contained in the tuple.
 296
 297             # Process right node.
 298             impl = self.head.cast (nodes[1].type)
 299
 300             # Process left node and set it as head.
 301             self.head  = self.head.cast (nodes[0].type)
 302             self.count = self.count + 1
 303
 304             # Finally, check the implementation.  If it is
 305             # wrapped in _M_head_impl return that, otherwise return
 306             # the value "as is".
 307             fields = impl.type.fields ()
 308             if len (fields) < 1 or fields[0].name != "_M_head_impl":
 309                 return ('[%d]' % self.count, impl)
 310             else:
 311                 return ('[%d]' % self.count, impl['_M_head_impl'])
 312
 313     def __init__ (self, typename, val):
 314         self.typename = typename
 315         self.val = val;
 316
 317     def children (self):
 318         return self._iterator (self.val)
 319
 320     def to_string (self):
 321         if len (self.val.type.fields ()) == 0:
 322             return 'empty %s' % (self.typename)
 323         return '%s containing' % (self.typename)
 324
 325 class StdStackOrQueuePrinter:
 326     "Print a std::stack or std::queue"
 327
 328     def __init__ (self, typename, val):
 329         self.typename = typename
 330         self.visualizer = gdb.default_visualizer(val['c'])
 331
 332     def children (self):
 333         return self.visualizer.children()
 334
 335     def to_string (self):
 336         return '%s wrapping: %s' % (self.typename,
 337                                     self.visualizer.to_string())
 338
 339     def display_hint (self):
 340         if hasattr (self.visualizer, 'display_hint'):
 341             return self.visualizer.display_hint ()
 342         return None
 343
 344 class RbtreeIterator:
 345     def __init__(self, rbtree):
 346         self.size = rbtree['_M_t']['_M_impl']['_M_node_count']
 347         self.node = rbtree['_M_t']['_M_impl']['_M_header']['_M_left']
 348         self.count = 0
 349
 350     def __iter__(self):
 351         return self
 352
 353     def __len__(self):
 354         return int (self.size)
 355
 356     def next(self):
 357         if self.count == self.size:
 358             raise StopIteration
 359         result = self.node
 360         self.count = self.count + 1
 361         if self.count < self.size:
 362             # Compute the next node.
 363             node = self.node
 364             if node.dereference()['_M_right']:
 365                 node = node.dereference()['_M_right']
 366                 while node.dereference()['_M_left']:
 367                     node = node.dereference()['_M_left']
 368             else:
 369                 parent = node.dereference()['_M_parent']
 370                 while node == parent.dereference()['_M_right']:
 371                     node = parent
 372                     parent = parent.dereference()['_M_parent']
 373                 if node.dereference()['_M_right'] != parent:
 374                     node = parent
 375             self.node = node
 376         return result
 377
 378 # This is a pretty printer for std::_Rb_tree_iterator (which is
 379 # std::map::iterator), and has nothing to do with the RbtreeIterator
 380 # class above.
 381 class StdRbtreeIteratorPrinter:
 382     "Print std::map::iterator"
 383
 384     def __init__ (self, typename, val):
 385         self.val = val
 386
 387     def to_string (self):
 388         typename = str(self.val.type.strip_typedefs()) + '::_Link_type'
 389         nodetype = gdb.lookup_type(typename).strip_typedefs()
 390         return self.val.cast(nodetype).dereference()['_M_value_field']
 391
 392 class StdDebugIteratorPrinter:
 393     "Print a debug enabled version of an iterator"
 394
 395     def __init__ (self, typename, val):
 396         self.val = val
 397
 398     # Just strip away the encapsulating __gnu_debug::_Safe_iterator
 399     # and return the wrapped iterator value.
 400     def to_string (self):
 401         itype = self.val.type.template_argument(0)
 402         return self.val['_M_current'].cast(itype)
 403
 404 class StdMapPrinter:
 405     "Print a std::map or std::multimap"
 406
 407     # Turn an RbtreeIterator into a pretty-print iterator.
 408     class _iter:
 409         def __init__(self, rbiter, type):
 410             self.rbiter = rbiter
 411             self.count = 0
 412             self.type = type
 413
 414         def __iter__(self):
 415             return self
 416
 417         def next(self):
 418             if self.count % 2 == 0:
 419                 n = self.rbiter.next()
 420                 n = n.cast(self.type).dereference()['_M_value_field']
 421                 self.pair = n
 422                 item = n['first']
 423             else:
 424                 item = self.pair['second']
 425             result = ('[%d]' % self.count, item)
 426             self.count = self.count + 1
 427             return result
 428
 429     def __init__ (self, typename, val):
 430         self.typename = typename
 431         self.val = val
 432
 433     def to_string (self):
 434         return '%s with %d elements' % (self.typename,
 435                                         len (RbtreeIterator (self.val)))
 436
 437     def children (self):
 438         rep_type = find_type(self.val.type, '_Rep_type')
 439         node = find_type(rep_type, '_Link_type')
 440         node = node.strip_typedefs()
 441         return self._iter (RbtreeIterator (self.val), node)
 442
 443     def display_hint (self):
 444         return 'map'
 445
 446 class StdSetPrinter:
 447     "Print a std::set or std::multiset"
 448
 449     # Turn an RbtreeIterator into a pretty-print iterator.
 450     class _iter:
 451         def __init__(self, rbiter, type):
 452             self.rbiter = rbiter
 453             self.count = 0
 454             self.type = type
 455
 456         def __iter__(self):
 457             return self
 458
 459         def next(self):
 460             item = self.rbiter.next()
 461             item = item.cast(self.type).dereference()['_M_value_field']
 462             # FIXME: this is weird ... what to do?
 463             # Maybe a 'set' display hint?
 464             result = ('[%d]' % self.count, item)
 465             self.count = self.count + 1
 466             return result
 467
 468     def __init__ (self, typename, val):
 469         self.typename = typename
 470         self.val = val
 471
 472     def to_string (self):
 473         return '%s with %d elements' % (self.typename,
 474                                         len (RbtreeIterator (self.val)))
 475
 476     def children (self):
 477         rep_type = find_type(self.val.type, '_Rep_type')
 478         node = find_type(rep_type, '_Link_type')
 479         node = node.strip_typedefs()
 480         return self._iter (RbtreeIterator (self.val), node)
 481
 482 class StdBitsetPrinter:
 483     "Print a std::bitset"
 484
 485     def __init__(self, typename, val):
 486         self.typename = typename
 487         self.val = val
 488
 489     def to_string (self):
 490         # If template_argument handled values, we could print the
 491         # size.  Or we could use a regexp on the type.
 492         return '%s' % (self.typename)
 493
 494     def children (self):
 495         words = self.val['_M_w']
 496         wtype = words.type
 497
 498         # The _M_w member can be either an unsigned long, or an
 499         # array.  This depends on the template specialization used.
 500         # If it is a single long, convert to a single element list.
 501         if wtype.code == gdb.TYPE_CODE_ARRAY:
 502             tsize = wtype.target ().sizeof
 503         else:
 504             words = [words]
 505             tsize = wtype.sizeof
 506
 507         nwords = wtype.sizeof / tsize
 508         result = []
 509         byte = 0
 510         while byte < nwords:
 511             w = words[byte]
 512             bit = 0
 513             while w != 0:
 514                 if (w & 1) != 0:
 515                     # Another spot where we could use 'set'?
 516                     result.append(('[%d]' % (byte * tsize * 8 + bit), 1))
 517                 bit = bit + 1
 518                 w = w >> 1
 519             byte = byte + 1
 520         return result
 521
 522 class StdDequePrinter:
 523     "Print a std::deque"
 524
 525     class _iter:
 526         def __init__(self, node, start, end, last, buffer_size):
 527             self.node = node
 528             self.p = start
 529             self.end = end
 530             self.last = last
 531             self.buffer_size = buffer_size
 532             self.count = 0
 533
 534         def __iter__(self):
 535             return self
 536
 537         def next(self):
 538             if self.p == self.last:
 539                 raise StopIteration
 540
 541             result = ('[%d]' % self.count, self.p.dereference())
 542             self.count = self.count + 1
 543
 544             # Advance the 'cur' pointer.
 545             self.p = self.p + 1
 546             if self.p == self.end:
 547                 # If we got to the end of this bucket, move to the
 548                 # next bucket.
 549                 self.node = self.node + 1
 550                 self.p = self.node[0]
 551                 self.end = self.p + self.buffer_size
 552
 553             return result
 554
 555     def __init__(self, typename, val):
 556         self.typename = typename
 557         self.val = val
 558         self.elttype = val.type.template_argument(0)
 559         size = self.elttype.sizeof
 560         if size < 512:
 561             self.buffer_size = int (512 / size)
 562         else:
 563             self.buffer_size = 1
 564
 565     def to_string(self):
 566         start = self.val['_M_impl']['_M_start']
 567         end = self.val['_M_impl']['_M_finish']
 568
 569         delta_n = end['_M_node'] - start['_M_node'] - 1
 570         delta_s = start['_M_last'] - start['_M_cur']
 571         delta_e = end['_M_cur'] - end['_M_first']
 572
 573         size = self.buffer_size * delta_n + delta_s + delta_e
 574
 575         return '%s with %d elements' % (self.typename, long (size))
 576
 577     def children(self):
 578         start = self.val['_M_impl']['_M_start']
 579         end = self.val['_M_impl']['_M_finish']
 580         return self._iter(start['_M_node'], start['_M_cur'], start['_M_last'],
 581                           end['_M_cur'], self.buffer_size)
 582
 583     def display_hint (self):
 584         return 'array'
 585
 586 class StdDequeIteratorPrinter:
 587     "Print std::deque::iterator"
 588
 589     def __init__(self, typename, val):
 590         self.val = val
 591
 592     def to_string(self):
 593         return self.val['_M_cur'].dereference()
 594
 595 class StdStringPrinter:
 596     "Print a std::basic_string of some kind"
 597
 598     def __init__(self, typename, val):
 599         self.val = val
 600
 601     def to_string(self):
 602         # Make sure &string works, too.
 603         type = self.val.type
 604         if type.code == gdb.TYPE_CODE_REF:
 605             type = type.target ()
 606
 607         # Calculate the length of the string so that to_string returns
 608         # the string according to length, not according to first null
 609         # encountered.
 610         ptr = self.val ['_M_dataplus']['_M_p']
 611         realtype = type.unqualified ().strip_typedefs ()
 612         reptype = gdb.lookup_type (str (realtype) + '::_Rep').pointer ()
 613         header = ptr.cast(reptype) - 1
 614         len = header.dereference ()['_M_length']
 615         if hasattr(ptr, "lazy_string"):
 616             return ptr.lazy_string (length = len)
 617         return ptr.string (length = len)
 618
 619     def display_hint (self):
 620         return 'string'
 621
 622 class Tr1HashtableIterator:
 623     def __init__ (self, hash):
 624         self.buckets = hash['_M_buckets']
 625         self.bucket = 0
 626         self.bucket_count = hash['_M_bucket_count']
 627         self.node_type = find_type(hash.type, '_Node').pointer()
 628         self.node = 0
 629         while self.bucket != self.bucket_count:
 630             self.node = self.buckets[self.bucket]
 631             if self.node:
 632                 break
 633             self.bucket = self.bucket + 1
 634
 635     def __iter__ (self):
 636         return self
 637
 638     def next (self):
 639         if self.node == 0:
 640             raise StopIteration
 641         node = self.node.cast(self.node_type)
 642         result = node.dereference()['_M_v']
 643         self.node = node.dereference()['_M_next'];
 644         if self.node == 0:
 645             self.bucket = self.bucket + 1
 646             while self.bucket != self.bucket_count:
 647                 self.node = self.buckets[self.bucket]
 648                 if self.node:
 649                     break
 650                 self.bucket = self.bucket + 1
 651         return result
 652
 653 class StdHashtableIterator:
 654     def __init__(self, hash):
 655         self.node = hash['_M_before_begin']['_M_nxt']
 656         self.node_type = find_type(hash.type, '__node_type').pointer()
 657
 658     def __iter__(self):
 659         return self
 660
 661     def next(self):
 662         if self.node == 0:
 663             raise StopIteration
 664         elt = self.node.cast(self.node_type).dereference()
 665         self.node = elt['_M_nxt']
 666         valptr = elt['_M_storage'].address
 667         valptr = valptr.cast(elt.type.template_argument(0).pointer())
 668         return valptr.dereference()
 669
 670 class Tr1UnorderedSetPrinter:
 671     "Print a tr1::unordered_set"
 672
 673     def __init__ (self, typename, val):
 674         self.typename = typename
 675         self.val = val
 676
 677     def hashtable (self):
 678         if self.typename.startswith('std::tr1'):
 679             return self.val
 680         return self.val['_M_h']
 681
 682     def to_string (self):
 683         return '%s with %d elements' % (self.typename, self.hashtable()['_M_element_count'])
 684
 685     @staticmethod
 686     def format_count (i):
 687         return '[%d]' % i
 688
 689     def children (self):
 690         counter = itertools.imap (self.format_count, itertools.count())
 691         if self.typename.startswith('std::tr1'):
 692             return itertools.izip (counter, Tr1HashtableIterator (self.hashtable()))
 693         return itertools.izip (counter, StdHashtableIterator (self.hashtable()))
 694
 695 class Tr1UnorderedMapPrinter:
 696     "Print a tr1::unordered_map"
 697
 698     def __init__ (self, typename, val):
 699         self.typename = typename
 700         self.val = val
 701
 702     def hashtable (self):
 703         if self.typename.startswith('std::tr1'):
 704             return self.val
 705         return self.val['_M_h']
 706
 707     def to_string (self):
 708         return '%s with %d elements' % (self.typename, self.hashtable()['_M_element_count'])
 709
 710     @staticmethod
 711     def flatten (list):
 712         for elt in list:
 713             for i in elt:
 714                 yield i
 715
 716     @staticmethod
 717     def format_one (elt):
 718         return (elt['first'], elt['second'])
 719
 720     @staticmethod
 721     def format_count (i):
 722         return '[%d]' % i
 723
 724     def children (self):
 725         counter = itertools.imap (self.format_count, itertools.count())
 726         # Map over the hash table and flatten the result.
 727         if self.typename.startswith('std::tr1'):
 728             data = self.flatten (itertools.imap (self.format_one, Tr1HashtableIterator (self.hashtable())))
 729             # Zip the two iterators together.
 730             return itertools.izip (counter, data)
 731         data = self.flatten (itertools.imap (self.format_one, StdHashtableIterator (self.hashtable())))
 732         # Zip the two iterators together.
 733         return itertools.izip (counter, data)
 734
 735
 736     def display_hint (self):
 737         return 'map'
 738
 739 class StdForwardListPrinter:
 740     "Print a std::forward_list"
 741
 742     class _iterator:
 743         def __init__(self, nodetype, head):
 744             self.nodetype = nodetype
 745             self.base = head['_M_next']
 746             self.count = 0
 747
 748         def __iter__(self):
 749             return self
 750
 751         def next(self):
 752             if self.base == 0:
 753                 raise StopIteration
 754             elt = self.base.cast(self.nodetype).dereference()
 755             self.base = elt['_M_next']
 756             count = self.count
 757             self.count = self.count + 1
 758             valptr = elt['_M_storage'].address
 759             valptr = valptr.cast(elt.type.template_argument(0).pointer())
 760             return ('[%d]' % count, valptr.dereference())
 761
 762     def __init__(self, typename, val):
 763         self.val = val
 764         self.typename = typename
 765
 766     def children(self):
 767         nodetype = find_type(self.val.type, '_Node')
 768         nodetype = nodetype.strip_typedefs().pointer()
 769         return self._iterator(nodetype, self.val['_M_impl']['_M_head'])
 770
 771     def to_string(self):
 772         if self.val['_M_impl']['_M_head']['_M_next'] == 0:
 773             return 'empty %s' % (self.typename)
 774         return '%s' % (self.typename)
 775
 776
 777 # A "regular expression" printer which conforms to the
 778 # "SubPrettyPrinter" protocol from gdb.printing.
 779 class RxPrinter(object):
 780     def __init__(self, name, function):
 781         super(RxPrinter, self).__init__()
 782         self.name = name
 783         self.function = function
 784         self.enabled = True
 785
 786     def invoke(self, value):
 787         if not self.enabled:
 788             return None
 789         return self.function(self.name, value)
 790
 791 # A pretty-printer that conforms to the "PrettyPrinter" protocol from
 792 # gdb.printing.  It can also be used directly as an old-style printer.
 793 class Printer(object):
 794     def __init__(self, name):
 795         super(Printer, self).__init__()
 796         self.name = name
 797         self.subprinters = []
 798         self.lookup = {}
 799         self.enabled = True
 800         self.compiled_rx = re.compile('^([a-zA-Z0-9_:]+)<.*>$')
 801
 802     def add(self, name, function):
 803         # A small sanity check.
 804         # FIXME
 805         if not self.compiled_rx.match(name + '<>'):
 806             raise ValueError, 'libstdc++ programming error: "%s" does not match' % name
 807         printer = RxPrinter(name, function)
 808         self.subprinters.append(printer)
 809         self.lookup[name] = printer
 810
 811     # Add a name using _GLIBCXX_BEGIN_NAMESPACE_VERSION.
 812     def add_version(self, base, name, function):
 813         self.add(base + name, function)
 814         self.add(base + '__7::' + name, function)
 815
 816     # Add a name using _GLIBCXX_BEGIN_NAMESPACE_CONTAINER.
 817     def add_container(self, base, name, function):
 818         self.add_version(base, name, function)
 819         self.add_version(base + '__cxx1998::', name, function)
 820
 821     @staticmethod
 822     def get_basic_type(type):
 823         # If it points to a reference, get the reference.
 824         if type.code == gdb.TYPE_CODE_REF:
 825             type = type.target ()
 826
 827         # Get the unqualified type, stripped of typedefs.
 828         type = type.unqualified ().strip_typedefs ()
 829
 830         return type.tag
 831
 832     def __call__(self, val):
 833         typename = self.get_basic_type(val.type)
 834         if not typename:
 835             return None
 836
 837         # All the types we match are template types, so we can use a
 838         # dictionary.
 839         match = self.compiled_rx.match(typename)
 840         if not match:
 841             return None
 842
 843         basename = match.group(1)
 844         if basename in self.lookup:
 845             return self.lookup[basename].invoke(val)
 846
 847         # Cannot find a pretty printer.  Return None.
 848         return None
 849
 850 libstdcxx_printer = None
 851
 852 class FilteringTypePrinter(object):
 853     def __init__(self, match, name):
 854         self.match = match
 855         self.name = name
 856         self.enabled = True
 857
 858     class _recognizer(object):
 859         def __init__(self, match, name):
 860             self.match = match
 861             self.name = name
 862             self.type_obj = None
 863
 864         def recognize(self, type_obj):
 865             if type_obj.tag is None:
 866                 return None
 867
 868             if self.type_obj is None:
 869                 if not self.match in type_obj.tag:
 870                     # Filter didn't match.
 871                     return None
 872                 try:
 873                     self.type_obj = gdb.lookup_type(self.name).strip_typedefs()
 874                 except:
 875                     pass
 876             if self.type_obj == type_obj:
 877                 return self.name
 878             return None
 879
 880     def instantiate(self):
 881         return self._recognizer(self.match, self.name)
 882
 883 def add_one_type_printer(obj, match, name):
 884     printer = FilteringTypePrinter(match, 'std::' + name)
 885     gdb.types.register_type_printer(obj, printer)
 886
 887 def register_type_printers(obj):
 888     global _use_type_printing
 889
 890     if not _use_type_printing:
 891         return
 892
 893     for pfx in ('', 'w'):
 894         add_one_type_printer(obj, 'basic_string', pfx + 'string')
 895         add_one_type_printer(obj, 'basic_ios', pfx + 'ios')
 896         add_one_type_printer(obj, 'basic_streambuf', pfx + 'streambuf')
 897         add_one_type_printer(obj, 'basic_istream', pfx + 'istream')
 898         add_one_type_printer(obj, 'basic_ostream', pfx + 'ostream')
 899         add_one_type_printer(obj, 'basic_iostream', pfx + 'iostream')
 900         add_one_type_printer(obj, 'basic_stringbuf', pfx + 'stringbuf')
 901         add_one_type_printer(obj, 'basic_istringstream',
 902                                  pfx + 'istringstream')
 903         add_one_type_printer(obj, 'basic_ostringstream',
 904                                  pfx + 'ostringstream')
 905         add_one_type_printer(obj, 'basic_stringstream',
 906                                  pfx + 'stringstream')
 907         add_one_type_printer(obj, 'basic_filebuf', pfx + 'filebuf')
 908         add_one_type_printer(obj, 'basic_ifstream', pfx + 'ifstream')
 909         add_one_type_printer(obj, 'basic_ofstream', pfx + 'ofstream')
 910         add_one_type_printer(obj, 'basic_fstream', pfx + 'fstream')
 911         add_one_type_printer(obj, 'basic_regex', pfx + 'regex')
 912         add_one_type_printer(obj, 'sub_match', pfx + 'csub_match')
 913         add_one_type_printer(obj, 'sub_match', pfx + 'ssub_match')
 914         add_one_type_printer(obj, 'match_results', pfx + 'cmatch')
 915         add_one_type_printer(obj, 'match_results', pfx + 'smatch')
 916         add_one_type_printer(obj, 'regex_iterator', pfx + 'cregex_iterator')
 917         add_one_type_printer(obj, 'regex_iterator', pfx + 'sregex_iterator')
 918         add_one_type_printer(obj, 'regex_token_iterator',
 919                                  pfx + 'cregex_token_iterator')
 920         add_one_type_printer(obj, 'regex_token_iterator',
 921                                  pfx + 'sregex_token_iterator')
 922
 923     # Note that we can't have a printer for std::wstreampos, because
 924     # it shares the same underlying type as std::streampos.
 925     add_one_type_printer(obj, 'fpos', 'streampos')
 926     add_one_type_printer(obj, 'basic_string', 'u16string')
 927     add_one_type_printer(obj, 'basic_string', 'u32string')
 928
 929     for dur in ('nanoseconds', 'microseconds', 'milliseconds',
 930                 'seconds', 'minutes', 'hours'):
 931         add_one_type_printer(obj, 'duration', dur)
 932
 933     add_one_type_printer(obj, 'linear_congruential_engine', 'minstd_rand0')
 934     add_one_type_printer(obj, 'linear_congruential_engine', 'minstd_rand')
 935     add_one_type_printer(obj, 'mersenne_twister_engine', 'mt19937')
 936     add_one_type_printer(obj, 'mersenne_twister_engine', 'mt19937_64')
 937     add_one_type_printer(obj, 'subtract_with_carry_engine', 'ranlux24_base')
 938     add_one_type_printer(obj, 'subtract_with_carry_engine', 'ranlux48_base')
 939     add_one_type_printer(obj, 'discard_block_engine', 'ranlux24')
 940     add_one_type_printer(obj, 'discard_block_engine', 'ranlux48')
 941     add_one_type_printer(obj, 'shuffle_order_engine', 'knuth_b')
 942
 943 def register_libstdcxx_printers (obj):
 944     "Register libstdc++ pretty-printers with objfile Obj."
 945
 946     global _use_gdb_pp
 947     global libstdcxx_printer
 948
 949     if _use_gdb_pp:
 950         gdb.printing.register_pretty_printer(obj, libstdcxx_printer)
 951     else:
 952         if obj is None:
 953             obj = gdb
 954         obj.pretty_printers.append(libstdcxx_printer)
 955
 956     register_type_printers(obj)
 957
 958 def build_libstdcxx_dictionary ():
 959     global libstdcxx_printer
 960
 961     libstdcxx_printer = Printer("libstdc++-v6")
 962
 963     # For _GLIBCXX_BEGIN_NAMESPACE_VERSION.
 964     vers = '(__7::)?'
 965     # For _GLIBCXX_BEGIN_NAMESPACE_CONTAINER.
 966     container = '(__cxx1998::' + vers + ')?'
 967
 968     # libstdc++ objects requiring pretty-printing.
 969     # In order from:
 970     # http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01847.html
 971     libstdcxx_printer.add_version('std::', 'basic_string', StdStringPrinter)
 972     libstdcxx_printer.add_container('std::', 'bitset', StdBitsetPrinter)
 973     libstdcxx_printer.add_container('std::', 'deque', StdDequePrinter)
 974     libstdcxx_printer.add_container('std::', 'list', StdListPrinter)
 975     libstdcxx_printer.add_container('std::', 'map', StdMapPrinter)
 976     libstdcxx_printer.add_container('std::', 'multimap', StdMapPrinter)
 977     libstdcxx_printer.add_container('std::', 'multiset', StdSetPrinter)
 978     libstdcxx_printer.add_version('std::', 'priority_queue',
 979                                   StdStackOrQueuePrinter)
 980     libstdcxx_printer.add_version('std::', 'queue', StdStackOrQueuePrinter)
 981     libstdcxx_printer.add_version('std::', 'tuple', StdTuplePrinter)
 982     libstdcxx_printer.add_container('std::', 'set', StdSetPrinter)
 983     libstdcxx_printer.add_version('std::', 'stack', StdStackOrQueuePrinter)
 984     libstdcxx_printer.add_version('std::', 'unique_ptr', UniquePointerPrinter)
 985     libstdcxx_printer.add_container('std::', 'vector', StdVectorPrinter)
 986     # vector<bool>
 987
 988     # Printer registrations for classes compiled with -D_GLIBCXX_DEBUG.
 989     libstdcxx_printer.add('std::__debug::bitset', StdBitsetPrinter)
 990     libstdcxx_printer.add('std::__debug::deque', StdDequePrinter)
 991     libstdcxx_printer.add('std::__debug::list', StdListPrinter)
 992     libstdcxx_printer.add('std::__debug::map', StdMapPrinter)
 993     libstdcxx_printer.add('std::__debug::multimap', StdMapPrinter)
 994     libstdcxx_printer.add('std::__debug::multiset', StdSetPrinter)
 995     libstdcxx_printer.add('std::__debug::priority_queue',
 996                           StdStackOrQueuePrinter)
 997     libstdcxx_printer.add('std::__debug::queue', StdStackOrQueuePrinter)
 998     libstdcxx_printer.add('std::__debug::set', StdSetPrinter)
 999     libstdcxx_printer.add('std::__debug::stack', StdStackOrQueuePrinter)
1000     libstdcxx_printer.add('std::__debug::unique_ptr', UniquePointerPrinter)
1001     libstdcxx_printer.add('std::__debug::vector', StdVectorPrinter)
1002
1003     # These are the TR1 and C++0x printers.
1004     # For array - the default GDB pretty-printer seems reasonable.
1005     libstdcxx_printer.add_version('std::', 'shared_ptr', SharedPointerPrinter)
1006     libstdcxx_printer.add_version('std::', 'weak_ptr', SharedPointerPrinter)
1007     libstdcxx_printer.add_container('std::', 'unordered_map',
1008                                     Tr1UnorderedMapPrinter)
1009     libstdcxx_printer.add_container('std::', 'unordered_set',
1010                                     Tr1UnorderedSetPrinter)
1011     libstdcxx_printer.add_container('std::', 'unordered_multimap',
1012                                     Tr1UnorderedMapPrinter)
1013     libstdcxx_printer.add_container('std::', 'unordered_multiset',
1014                                     Tr1UnorderedSetPrinter)
1015     libstdcxx_printer.add_container('std::', 'forward_list',
1016                                     StdForwardListPrinter)
1017
1018     libstdcxx_printer.add_version('std::tr1::', 'shared_ptr', SharedPointerPrinter)
1019     libstdcxx_printer.add_version('std::tr1::', 'weak_ptr', SharedPointerPrinter)
1020     libstdcxx_printer.add_version('std::tr1::', 'unordered_map',
1021                                   Tr1UnorderedMapPrinter)
1022     libstdcxx_printer.add_version('std::tr1::', 'unordered_set',
1023                                   Tr1UnorderedSetPrinter)
1024     libstdcxx_printer.add_version('std::tr1::', 'unordered_multimap',
1025                                   Tr1UnorderedMapPrinter)
1026     libstdcxx_printer.add_version('std::tr1::', 'unordered_multiset',
1027                                   Tr1UnorderedSetPrinter)
1028
1029     # These are the C++0x printer registrations for -D_GLIBCXX_DEBUG cases.
1030     # The tr1 namespace printers do not seem to have any debug
1031     # equivalents, so do no register them.
1032     libstdcxx_printer.add('std::__debug::unordered_map',
1033                           Tr1UnorderedMapPrinter)
1034     libstdcxx_printer.add('std::__debug::unordered_set',
1035                           Tr1UnorderedSetPrinter)
1036     libstdcxx_printer.add('std::__debug::unordered_multimap',
1037                           Tr1UnorderedMapPrinter)
1038     libstdcxx_printer.add('std::__debug::unordered_multiset',
1039                           Tr1UnorderedSetPrinter)
1040     libstdcxx_printer.add('std::__debug::forward_list',
1041                           StdForwardListPrinter)
1042
1043
1044     # Extensions.
1045     libstdcxx_printer.add_version('__gnu_cxx::', 'slist', StdSlistPrinter)
1046
1047     if True:
1048         # These shouldn't be necessary, if GDB "print *i" worked.
1049         # But it often doesn't, so here they are.
1050         libstdcxx_printer.add_container('std::', '_List_iterator',
1051                                         StdListIteratorPrinter)
1052         libstdcxx_printer.add_container('std::', '_List_const_iterator',
1053                                         StdListIteratorPrinter)
1054         libstdcxx_printer.add_version('std::', '_Rb_tree_iterator',
1055                                       StdRbtreeIteratorPrinter)
1056         libstdcxx_printer.add_version('std::', '_Rb_tree_const_iterator',
1057                                       StdRbtreeIteratorPrinter)
1058         libstdcxx_printer.add_container('std::', '_Deque_iterator',
1059                                         StdDequeIteratorPrinter)
1060         libstdcxx_printer.add_container('std::', '_Deque_const_iterator',
1061                                         StdDequeIteratorPrinter)
1062         libstdcxx_printer.add_version('__gnu_cxx::', '__normal_iterator',
1063                                       StdVectorIteratorPrinter)
1064         libstdcxx_printer.add_version('__gnu_cxx::', '_Slist_iterator',
1065                                       StdSlistIteratorPrinter)
1066
1067         # Debug (compiled with -D_GLIBCXX_DEBUG) printer
1068         # registrations.  The Rb_tree debug iterator when unwrapped
1069         # from the encapsulating __gnu_debug::_Safe_iterator does not
1070         # have the __norm namespace. Just use the existing printer
1071         # registration for that.
1072         libstdcxx_printer.add('__gnu_debug::_Safe_iterator',
1073                               StdDebugIteratorPrinter)
1074         libstdcxx_printer.add('std::__norm::_List_iterator',
1075                               StdListIteratorPrinter)
1076         libstdcxx_printer.add('std::__norm::_List_const_iterator',
1077                               StdListIteratorPrinter)
1078         libstdcxx_printer.add('std::__norm::_Deque_const_iterator',
1079                               StdDequeIteratorPrinter)
1080         libstdcxx_printer.add('std::__norm::_Deque_iterator',
1081                               StdDequeIteratorPrinter)
1082
1083 build_libstdcxx_dictionary ()