Home | History | Annotate | Download | only in coregrind
      1 
      2 /*--------------------------------------------------------------------*/
      3 /*--- The C++ name demangler.                  pub_core_demangle.h ---*/
      4 /*--------------------------------------------------------------------*/
      5 
      6 /*
      7    This file is part of Valgrind, a dynamic binary instrumentation
      8    framework.
      9 
     10    Copyright (C) 2000-2017 Julian Seward
     11       jseward (at) acm.org
     12 
     13    This program is free software; you can redistribute it and/or
     14    modify it under the terms of the GNU General Public License as
     15    published by the Free Software Foundation; either version 2 of the
     16    License, or (at your option) any later version.
     17 
     18    This program is distributed in the hope that it will be useful, but
     19    WITHOUT ANY WARRANTY; without even the implied warranty of
     20    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     21    General Public License for more details.
     22 
     23    You should have received a copy of the GNU General Public License
     24    along with this program; if not, write to the Free Software
     25    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
     26    02111-1307, USA.
     27 
     28    The GNU General Public License is contained in the file COPYING.
     29 */
     30 
     31 #ifndef __PUB_CORE_DEMANGLE_H
     32 #define __PUB_CORE_DEMANGLE_H
     33 
     34 #include "pub_core_basics.h"      // VG_ macro
     35 
     36 //--------------------------------------------------------------------
     37 // PURPOSE: This module exports functions for demangling C++ and
     38 // Z-encoded names.
     39 //--------------------------------------------------------------------
     40 
     41 /* This is the main, standard demangler entry point.  It does two things:
     42  * (1) undoes Z-encoding, if "do_z_demangle" is True;
     43  * (2) undoes C++ demangling, if 'do_cxx_demangle' is True.  */
     44 extern
     45 void VG_(demangle) ( Bool do_cxx_demangling, Bool do_z_demangling,
     46                      const HChar* orig, const HChar** result );
     47 
     48 /* Demangle a Z-encoded name as described in pub_tool_redir.h.
     49    Z-encoded names are used by Valgrind for doing function
     50    interception/wrapping.
     51 
     52    Demangle 'sym' into its soname and fnname parts, putting them in
     53    the specified buffers.  Returns a Bool indicating whether the
     54    demangled failed or not.  A failure can occur because the prefix
     55    isn't recognised, the internal Z-escaping is wrong, or because one
     56    or the other (or both) of the output buffers becomes full.  Passing
     57    'so' as NULL is acceptable if the caller is only interested in the
     58    function name part. */
     59 
     60 extern
     61 Bool VG_(maybe_Z_demangle) ( const HChar* sym,
     62                              /*OUT*/const HChar** so,    // may be NULL
     63                              /*OUT*/const HChar** fn,
     64                              /*OUT*/Bool* isWrap,        // may be NULL
     65                              /*OUT*/Int*  eclassTag,     // may be NULL
     66                              /*OUT*/Int*  eclassPrio );  // may be NULL
     67 
     68 #endif   // __PUB_CORE_DEMANGLE_H
     69 
     70 /*--------------------------------------------------------------------*/
     71 /*--- end                                                          ---*/
     72 /*--------------------------------------------------------------------*/
     73