1/*
2 * Copyright 2014-present Facebook, Inc.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#pragma once
18
19#include <folly/FBString.h>
20
21namespace folly {
22
23/**
24 * Return the demangled (prettyfied) version of a C++ type.
25 *
26 * This function tries to produce a human-readable type, but the type name will
27 * be returned unchanged in case of error or if demangling isn't supported on
28 * your system.
29 *
30 * Use for debugging -- do not rely on demangle() returning anything useful.
31 *
32 * This function may allocate memory (and therefore throw std::bad_alloc).
33 */
34fbstring demangle(const char* name);
35inline fbstring demangle(const std::type_info& type) {
36 return demangle(type.name());
37}
38
39/**
40 * Return the demangled (prettyfied) version of a C++ type in a user-provided
41 * buffer.
42 *
43 * The semantics are the same as for snprintf or strlcpy: bufSize is the size
44 * of the buffer, the string is always null-terminated, and the return value is
45 * the number of characters (not including the null terminator) that would have
46 * been written if the buffer was big enough. (So a return value >= bufSize
47 * indicates that the output was truncated)
48 *
49 * This function does not allocate memory and is async-signal-safe.
50 *
51 * Note that the underlying function for the fbstring-returning demangle is
52 * somewhat standard (abi::__cxa_demangle, which uses malloc), the underlying
53 * function for this version is less so (cplus_demangle_v3_callback from
54 * libiberty), so it is possible for the fbstring version to work, while this
55 * version returns the original, mangled name.
56 */
57size_t demangle(const char* name, char* buf, size_t bufSize);
58inline size_t demangle(const std::type_info& type, char* buf, size_t bufSize) {
59 return demangle(type.name(), buf, bufSize);
60}
61
62// glibc doesn't have strlcpy
63size_t strlcpy(char* dest, const char* const src, size_t size);
64
65} // namespace folly
66