1 //===-- llvm/Support/Mangler.h - Self-contained name mangler ----*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source 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/System/IncludeFile.h"
29 /// Prefix - This string is added to each symbol that is emitted, unless the
30 /// symbol is marked as not needing this prefix.
33 /// UseQuotes - If this is set, the target accepts global names in quotes,
34 /// e.g. "foo bar" is a legal name. This syntax is used instead of escaping
35 /// the space character. By default, this is false.
38 /// PreserveAsmNames - If this is set, the asm escape character is not removed
39 /// from names with 'asm' specifiers.
40 bool PreserveAsmNames;
42 /// Memo - This is used to remember the name that we assign a value.
44 std::map<const Value*, std::string> Memo;
46 /// Count - This simple counter is used to unique value names.
50 /// TypeMap - If the client wants us to unique types, this keeps track of the
51 /// current assignments and TypeCounter keeps track of the next id to assign.
52 std::map<const Type*, unsigned> TypeMap;
55 /// This keeps track of which global values have had their names
56 /// mangled in the current module.
58 std::set<const GlobalValue*> MangledGlobals;
60 /// AcceptableChars - This bitfield contains a one for each character that is
61 /// allowed to be part of an unmangled name.
62 unsigned AcceptableChars[256/32];
65 // Mangler ctor - if a prefix is specified, it will be prepended onto all
67 Mangler(Module &M, const char *Prefix = "");
69 /// setUseQuotes - If UseQuotes is set to true, this target accepts quoted
70 /// strings for assembler labels.
71 void setUseQuotes(bool Val) { UseQuotes = Val; }
73 /// setPreserveAsmNames - If the mangler should not strip off the asm name
74 /// @verbatim identifier (\001), this should be set. @endverbatim
75 void setPreserveAsmNames(bool Val) { PreserveAsmNames = Val; }
77 /// Acceptable Characters - This allows the target to specify which characters
78 /// are acceptable to the assembler without being mangled. By default we
79 /// allow letters, numbers, '_', '$', and '.', which is what GAS accepts.
80 void markCharAcceptable(unsigned char X) {
81 AcceptableChars[X/32] |= 1 << (X&31);
83 void markCharUnacceptable(unsigned char X) {
84 AcceptableChars[X/32] &= ~(1 << (X&31));
86 bool isCharAcceptable(unsigned char X) const {
87 return (AcceptableChars[X/32] & (1 << (X&31))) != 0;
90 /// getTypeID - Return a unique ID for the specified LLVM type.
92 unsigned getTypeID(const Type *Ty);
94 /// getValueName - Returns the mangled name of V, an LLVM Value,
95 /// in the current module.
97 std::string getValueName(const GlobalValue *V, const char *Suffix = "");
98 std::string getValueName(const Value *V);
100 /// makeNameProper - We don't want identifier names with ., space, or
101 /// - in them, so we mangle these characters into the strings "d_",
102 /// "s_", and "D_", respectively. This is a very simple mangling that
103 /// doesn't guarantee unique names for values. getValueName already
104 /// does this for you, so there's no point calling it on the result
105 /// from getValueName.
107 std::string makeNameProper(const std::string &x, const char *Prefix = "");
110 void InsertName(GlobalValue *GV, std::map<std::string, GlobalValue*> &Names);
113 } // End llvm namespace
115 // Force the Mangler.cpp file to be linked when this header is #included
116 FORCE_DEFINING_FILE_TO_BE_LINKED(Mangler)
118 #endif // LLVM_SUPPORT_MANGLER_H