LLVM  9.0.0svn
Demangle.h
Go to the documentation of this file.
1 //===--- Demangle.h ---------------------------------------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #ifndef LLVM_DEMANGLE_DEMANGLE_H
10 #define LLVM_DEMANGLE_DEMANGLE_H
11 
12 #include <cstddef>
13 #include <string>
14 
15 namespace llvm {
16 /// This is a llvm local version of __cxa_demangle. Other than the name and
17 /// being in the llvm namespace it is identical.
18 ///
19 /// The mangled_name is demangled into buf and returned. If the buffer is not
20 /// large enough, realloc is used to expand it.
21 ///
22 /// The *status will be set to a value from the following enumeration
23 enum : int {
29 };
30 
31 char *itaniumDemangle(const char *mangled_name, char *buf, size_t *n,
32  int *status);
33 
34 
36 char *microsoftDemangle(const char *mangled_name, char *buf, size_t *n,
37  int *status, MSDemangleFlags Flags = MSDF_None);
38 
39 /// Attempt to demangle a string using different demangling schemes.
40 /// The function uses heuristics to determine which demangling scheme to use.
41 /// \param MangledName - reference to string to demangle.
42 /// \returns - the demangled string, or a copy of the input string if no
43 /// demangling occurred.
44 std::string demangle(const std::string &MangledName);
45 
46 /// "Partial" demangler. This supports demangling a string into an AST
47 /// (typically an intermediate stage in itaniumDemangle) and querying certain
48 /// properties or partially printing the demangled name.
51 
54 
55  /// Demangle into an AST. Subsequent calls to the rest of the member functions
56  /// implicitly operate on the AST this produces.
57  /// \return true on error, false otherwise
58  bool partialDemangle(const char *MangledName);
59 
60  /// Just print the entire mangled name into Buf. Buf and N behave like the
61  /// second and third parameters to itaniumDemangle.
62  char *finishDemangle(char *Buf, size_t *N) const;
63 
64  /// Get the base name of a function. This doesn't include trailing template
65  /// arguments, ie for "a::b<int>" this function returns "b".
66  char *getFunctionBaseName(char *Buf, size_t *N) const;
67 
68  /// Get the context name for a function. For "a::b::c", this function returns
69  /// "a::b".
70  char *getFunctionDeclContextName(char *Buf, size_t *N) const;
71 
72  /// Get the entire name of this function.
73  char *getFunctionName(char *Buf, size_t *N) const;
74 
75  /// Get the parameters for this function.
76  char *getFunctionParameters(char *Buf, size_t *N) const;
77  char *getFunctionReturnType(char *Buf, size_t *N) const;
78 
79  /// If this function has any any cv or reference qualifiers. These imply that
80  /// the function is a non-static member function.
81  bool hasFunctionQualifiers() const;
82 
83  /// If this symbol describes a constructor or destructor.
84  bool isCtorOrDtor() const;
85 
86  /// If this symbol describes a function.
87  bool isFunction() const;
88 
89  /// If this symbol describes a variable.
90  bool isData() const;
91 
92  /// If this symbol is a <special-name>. These are generally implicitly
93  /// generated by the implementation, such as vtables and typeinfo names.
94  bool isSpecialName() const;
95 
97 private:
98  void *RootNode;
99  void *Context;
100 };
101 } // namespace llvm
102 
103 #endif
char * itaniumDemangle(const char *mangled_name, char *buf, size_t *n, int *status)
ItaniumPartialDemangler & operator=(ItaniumPartialDemangler &&Other)
This class represents lattice values for constants.
Definition: AllocatorList.h:23
bool isData() const
If this symbol describes a variable.
bool isFunction() const
If this symbol describes a function.
char * getFunctionName(char *Buf, size_t *N) const
Get the entire name of this function.
ELFYAML::ELF_STO Other
Definition: ELFYAML.cpp:870
bool isCtorOrDtor() const
If this symbol describes a constructor or destructor.
std::error_code status(const Twine &path, file_status &result, bool follow=true)
Get file status as if by POSIX stat().
MSDemangleFlags
Definition: Demangle.h:35
char * getFunctionBaseName(char *Buf, size_t *N) const
Get the base name of a function.
bool partialDemangle(const char *MangledName)
Demangle into an AST.
char * getFunctionDeclContextName(char *Buf, size_t *N) const
Get the context name for a function.
std::string demangle(const std::string &MangledName)
Attempt to demangle a string using different demangling schemes.
Definition: Demangle.cpp:22
char * getFunctionParameters(char *Buf, size_t *N) const
Get the parameters for this function.
char * getFunctionReturnType(char *Buf, size_t *N) const
bool isSpecialName() const
If this symbol is a <special-name>.
bool hasFunctionQualifiers() const
If this function has any any cv or reference qualifiers.
char * finishDemangle(char *Buf, size_t *N) const
Just print the entire mangled name into Buf.
#define N
"Partial" demangler.
Definition: Demangle.h:49
char * microsoftDemangle(const char *mangled_name, char *buf, size_t *n, int *status, MSDemangleFlags Flags=MSDF_None)