Home | History | Annotate | Download | only in stlport
      1 GDB pretty printers for STLport
      2 ===============================
      3 
      4 This python module provides GDB pretty printers for the containers from
      5 STLport. It is based on a similar python module for libstdc++ [1]. It has
      6 been tested with GDB 7.0.1/7.2 and STLport 4.6.2/5.0.3/5.1.7/5.2.1.
      7 
      8 [1] svn://gcc.gnu.org/svn/gcc/trunk/libstdc++-v3/python
      9 
     10 
     11 Installation
     12 ------------
     13 
     14 To install the python module copy the "stlport" subdirectory to some place.
     15 To enable the pretty printer add the following code to $HOME/.gdbinit:
     16 
     17     python
     18     import sys
     19 
     20     sys.path.insert (0, '/path/to/dir/containing/the/stlport/dir')
     21     import stlport.printers
     22     stlport.printers.register_stlport_printers (None)
     23 
     24     # see the python module for a description of these options
     25     # stlport.printers.stlport_version           = 5.2
     26     # stlport.printers.print_vector_with_indices = False
     27     
     28     end
     29 
     30 
     31 Testing
     32 -------
     33 
     34 To test the pretty printers, go to the test directory and set up the STLport
     35 directory in the Makefile. Calling make should then compile two executables
     36 (with and without -D_STLP_DEBUG) and invoke GDB with the supplied script. If
     37 the pretty printers work the variables from test.cpp should be displayed in a
     38 convenient way.
     39 
     40 Note that GDB prefers python modules from $HOME/.gdbinit over those from
     41 .gdbinit in the current working directory. If you adapted $HOME/.gdbinit as
     42 described above the location there will be used. Otherwise, test/.gdbinit will
     43 load stlport/printers.py.
     44