Demangle.h 2.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  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. #pragma once
  17. #include <folly/FBString.h>
  18. namespace folly {
  19. /**
  20. * Return the demangled (prettyfied) version of a C++ type.
  21. *
  22. * This function tries to produce a human-readable type, but the type name will
  23. * be returned unchanged in case of error or if demangling isn't supported on
  24. * your system.
  25. *
  26. * Use for debugging -- do not rely on demangle() returning anything useful.
  27. *
  28. * This function may allocate memory (and therefore throw std::bad_alloc).
  29. */
  30. fbstring demangle(const char* name);
  31. inline fbstring demangle(const std::type_info& type) {
  32. return demangle(type.name());
  33. }
  34. /**
  35. * Return the demangled (prettyfied) version of a C++ type in a user-provided
  36. * buffer.
  37. *
  38. * The semantics are the same as for snprintf or strlcpy: bufSize is the size
  39. * of the buffer, the string is always null-terminated, and the return value is
  40. * the number of characters (not including the null terminator) that would have
  41. * been written if the buffer was big enough. (So a return value >= bufSize
  42. * indicates that the output was truncated)
  43. *
  44. * This function does not allocate memory and is async-signal-safe.
  45. *
  46. * Note that the underlying function for the fbstring-returning demangle is
  47. * somewhat standard (abi::__cxa_demangle, which uses malloc), the underlying
  48. * function for this version is less so (cplus_demangle_v3_callback from
  49. * libiberty), so it is possible for the fbstring version to work, while this
  50. * version returns the original, mangled name.
  51. */
  52. size_t demangle(const char* name, char* buf, size_t bufSize);
  53. inline size_t demangle(const std::type_info& type, char* buf, size_t bufSize) {
  54. return demangle(type.name(), buf, bufSize);
  55. }
  56. // glibc doesn't have strlcpy
  57. size_t strlcpy(char* dest, const char* const src, size_t size);
  58. } // namespace folly