1 //===-- llvm/Support/Mangler.h - Self-contained name mangler ----*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // Unified name mangler for various backends.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_SUPPORT_MANGLER_H
15 #define LLVM_SUPPORT_MANGLER_H
17 #include "llvm/ADT/DenseMap.h"
18 #include "llvm/ADT/SmallPtrSet.h"
28 /// Prefix - This string is added to each symbol that is emitted, unless the
29 /// symbol is marked as not needing this prefix.
32 /// PrivatePrefix - This string is emitted before each symbol with private
34 const char *PrivatePrefix;
36 /// UseQuotes - If this is set, the target accepts global names in quotes,
37 /// e.g. "foo bar" is a legal name. This syntax is used instead of escaping
38 /// the space character. By default, this is false.
41 /// PreserveAsmNames - If this is set, the asm escape character is not removed
42 /// from names with 'asm' specifiers.
43 bool PreserveAsmNames;
45 /// AnonGlobalIDs - We need to give global values the same name every time
46 /// they are mangled. This keeps track of the number we give to anonymous
49 DenseMap<const GlobalValue*, unsigned> AnonGlobalIDs;
51 /// NextAnonGlobalID - This simple counter is used to unique value names.
53 unsigned NextAnonGlobalID;
55 /// AcceptableChars - This bitfield contains a one for each character that is
56 /// allowed to be part of an unmangled name.
57 unsigned AcceptableChars[256/32];
60 // Mangler ctor - if a prefix is specified, it will be prepended onto all
62 Mangler(Module &M, const char *Prefix = "", const char *privatePrefix = "");
64 /// setUseQuotes - If UseQuotes is set to true, this target accepts quoted
65 /// strings for assembler labels.
66 void setUseQuotes(bool Val) { UseQuotes = Val; }
68 /// setPreserveAsmNames - If the mangler should not strip off the asm name
69 /// @verbatim identifier (\001), this should be set. @endverbatim
70 void setPreserveAsmNames(bool Val) { PreserveAsmNames = Val; }
72 /// Acceptable Characters - This allows the target to specify which characters
73 /// are acceptable to the assembler without being mangled. By default we
74 /// allow letters, numbers, '_', '$', and '.', which is what GAS accepts.
75 void markCharAcceptable(unsigned char X) {
76 AcceptableChars[X/32] |= 1 << (X&31);
78 void markCharUnacceptable(unsigned char X) {
79 AcceptableChars[X/32] &= ~(1 << (X&31));
81 bool isCharAcceptable(unsigned char X) const {
82 return (AcceptableChars[X/32] & (1 << (X&31))) != 0;
85 /// getMangledName - Returns the mangled name of V, an LLVM Value,
86 /// in the current module. If 'Suffix' is specified, the name ends with the
87 /// specified suffix. If 'ForcePrivate' is specified, the label is specified
88 /// to have a private label prefix.
90 std::string getMangledName(const GlobalValue *V, const char *Suffix = "",
91 bool ForcePrivate = false);
93 /// makeNameProper - We don't want identifier names with ., space, or
94 /// - in them, so we mangle these characters into the strings "d_",
95 /// "s_", and "D_", respectively. This is a very simple mangling that
96 /// doesn't guarantee unique names for values. getValueName already
97 /// does this for you, so there's no point calling it on the result
98 /// from getValueName.
100 std::string makeNameProper(const std::string &x,
101 bool hasPrivateLinkage = false);
104 } // End llvm namespace
106 #endif // LLVM_SUPPORT_MANGLER_H