njn | 44e1368 | 2005-05-10 04:56:56 +0000 | [diff] [blame] | 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 | |
Elliott Hughes | ed39800 | 2017-06-21 14:41:24 -0700 | [diff] [blame^] | 10 | Copyright (C) 2000-2017 Julian Seward |
njn | 44e1368 | 2005-05-10 04:56:56 +0000 | [diff] [blame] | 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, 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 | |
florian | 535fb1b | 2013-09-15 13:54:34 +0000 | [diff] [blame] | 34 | #include "pub_core_basics.h" // VG_ macro |
| 35 | |
njn | 44e1368 | 2005-05-10 04:56:56 +0000 | [diff] [blame] | 36 | //-------------------------------------------------------------------- |
sewardj | 0ec07f3 | 2006-01-12 12:32:32 +0000 | [diff] [blame] | 37 | // PURPOSE: This module exports functions for demangling C++ and |
| 38 | // Z-encoded names. |
njn | 44e1368 | 2005-05-10 04:56:56 +0000 | [diff] [blame] | 39 | //-------------------------------------------------------------------- |
| 40 | |
njn | 6b7611b | 2009-02-11 06:06:10 +0000 | [diff] [blame] | 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. */ |
sewardj | 0ec07f3 | 2006-01-12 12:32:32 +0000 | [diff] [blame] | 44 | extern |
njn | 6b7611b | 2009-02-11 06:06:10 +0000 | [diff] [blame] | 45 | void VG_(demangle) ( Bool do_cxx_demangling, Bool do_z_demangling, |
florian | 46cc045 | 2014-10-25 19:20:38 +0000 | [diff] [blame] | 46 | const HChar* orig, const HChar** result ); |
sewardj | 0ec07f3 | 2006-01-12 12:32:32 +0000 | [diff] [blame] | 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, |
florian | 46cc045 | 2014-10-25 19:20:38 +0000 | [diff] [blame] | 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 |
njn | 44e1368 | 2005-05-10 04:56:56 +0000 | [diff] [blame] | 67 | |
| 68 | #endif // __PUB_CORE_DEMANGLE_H |
| 69 | |
| 70 | /*--------------------------------------------------------------------*/ |
| 71 | /*--- end ---*/ |
| 72 | /*--------------------------------------------------------------------*/ |