libkern/kxld/kxld_demangle.h

   1 /*
   2  * Copyright (c) 2009 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28
  29 #ifndef _KXLD_DEMANGLE_H_
  30 #define _KXLD_DEMANGLE_H_
  31
  32 #include <sys/types.h>
  33
  34 /* @function kxld_demangle
  35  *
  36  * @abstract Demangles c++ symbols.
  37  *
  38  * @param str           The C-string to be demangled.
  39  * @param buffer        A pointer to a character buffer for storing the result.
  40  *                      If NULL, a buffer will be malloc'd and stored here.
  41  *                      If the buffer is not large enough, it will be realloc'd.
  42  *
  43  * @param length        The length of the buffer.
  44  *
  45  * @result              If the input string could be demangled, it returns the
  46  *                      demangled string.  Otherwise, returns the input string.
  47  *
  48  */
  49 const char * kxld_demangle(const char *str, char **buffer, size_t *length)
  50 __attribute__((nonnull(1), visibility("hidden")));
  51
  52 #endif /* !_KXLD_DEMANGLE_H_ */