pub_core_demangle.h revision 4d474d086188fd1f29fa97dbd84d8ea2e589a9b8 
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-2008 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, 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//--------------------------------------------------------------------
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. */
40
41extern
42void VG_(demangle) ( Bool do_cxx_demangle,
43                     Char* orig, Char* result, Int result_size );
44
45/* Demangle a Z-encoded name as described in pub_tool_redir.h.
46   Z-encoded names are used by Valgrind for doing function
47   interception/wrapping.
48
49   Demangle 'sym' into its soname and fnname parts, putting them in
50   the specified buffers.  Returns a Bool indicating whether the
51   demangled failed or not.  A failure can occur because the prefix
52   isn't recognised, the internal Z-escaping is wrong, or because one
53   or the other (or both) of the output buffers becomes full.  Passing
54   'so' as NULL is acceptable if the caller is only interested in the
55   function name part. */
56
57extern
58Bool VG_(maybe_Z_demangle) ( const HChar* sym,
59                             /*OUT*/HChar* so, Int soLen,
60                             /*OUT*/HChar* fn, Int fnLen,
61                             /*OUT*/Bool* isWrap );
62
63#endif   // __PUB_CORE_DEMANGLE_H
64
65/*--------------------------------------------------------------------*/
66/*--- end                                                          ---*/
67/*--------------------------------------------------------------------*/
68