coregrind/pub_core_demangle.h

   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@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, see <http://www.gnu.org/licenses/>.
  25
  26    The GNU General Public License is contained in the file COPYING.
  27 */
  28
  29 #ifndef __PUB_CORE_DEMANGLE_H
  30 #define __PUB_CORE_DEMANGLE_H
  31
  32 #include "pub_core_basics.h"      // VG_ macro
  33
  34 //--------------------------------------------------------------------
  35 // PURPOSE: This module exports functions for demangling C++ and
  36 // Z-encoded names.
  37 //--------------------------------------------------------------------
  38
  39 /* This is the main, standard demangler entry point.  It does two things:
  40  * (1) undoes Z-encoding, if "do_z_demangle" is True;
  41  * (2) undoes C++ demangling, if 'do_cxx_demangle' is True.  */
  42 extern
  43 void VG_(demangle) ( Bool do_cxx_demangling, Bool do_z_demangling,
  44                      const HChar* orig, const HChar** result );
  45
  46 /* Demangle a Z-encoded name as described in pub_tool_redir.h.
  47    Z-encoded names are used by Valgrind for doing function
  48    interception/wrapping.
  49
  50    Demangle 'sym' into its soname and fnname parts, putting them in
  51    the specified buffers.  Returns a Bool indicating whether the
  52    demangled failed or not.  A failure can occur because the prefix
  53    isn't recognised, the internal Z-escaping is wrong, or because one
  54    or the other (or both) of the output buffers becomes full.  Passing
  55    'so' as NULL is acceptable if the caller is only interested in the
  56    function name part. */
  57
  58 extern
  59 Bool VG_(maybe_Z_demangle) ( const HChar* sym,
  60                              /*OUT*/const HChar** so,    // may be NULL
  61                              /*OUT*/const HChar** fn,
  62                              /*OUT*/Bool* isWrap,        // may be NULL
  63                              /*OUT*/Int*  eclassTag,     // may be NULL
  64                              /*OUT*/Int*  eclassPrio );  // may be NULL
  65
  66 #endif   // __PUB_CORE_DEMANGLE_H
  67
  68 /*--------------------------------------------------------------------*/
  69 /*--- end                                                          ---*/
  70 /*--------------------------------------------------------------------*/