1//===-- llvm/IR/Mangler.h - Self-contained name mangler ---------*- C++ -*-===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// Unified name mangler for various backends.
11//
12//===----------------------------------------------------------------------===//
13
14#ifndef LLVM_TARGET_MANGLER_H
15#define LLVM_TARGET_MANGLER_H
16
17#include "llvm/ADT/DenseMap.h"
18#include "llvm/Support/raw_ostream.h"
19
20namespace llvm {
21
22class DataLayout;
23class GlobalValue;
24template <typename T> class SmallVectorImpl;
25class Twine;
26
27class Mangler {
28public:
29  enum ManglerPrefixTy {
30    Default,               ///< Emit default string before each symbol.
31    Private,               ///< Emit "private" prefix before each symbol.
32    LinkerPrivate          ///< Emit "linker private" prefix before each symbol.
33  };
34
35private:
36  const DataLayout *DL;
37
38  /// AnonGlobalIDs - We need to give global values the same name every time
39  /// they are mangled.  This keeps track of the number we give to anonymous
40  /// ones.
41  ///
42  mutable DenseMap<const GlobalValue*, unsigned> AnonGlobalIDs;
43
44  /// NextAnonGlobalID - This simple counter is used to unique value names.
45  ///
46  mutable unsigned NextAnonGlobalID;
47
48public:
49  Mangler(const DataLayout *DL) : DL(DL), NextAnonGlobalID(1) {}
50
51  /// Print the appropriate prefix and the specified global variable's name.
52  /// If the global variable doesn't have a name, this fills in a unique name
53  /// for the global.
54  void getNameWithPrefix(raw_ostream &OS, const GlobalValue *GV,
55                         bool CannotUsePrivateLabel) const;
56  void getNameWithPrefix(SmallVectorImpl<char> &OutName, const GlobalValue *GV,
57                         bool CannotUsePrivateLabel) const;
58
59  /// Print the appropriate prefix and the specified name as the global variable
60  /// name. GVName must not be empty.
61  void getNameWithPrefix(raw_ostream &OS, const Twine &GVName,
62                         ManglerPrefixTy PrefixTy = Mangler::Default) const;
63  void getNameWithPrefix(SmallVectorImpl<char> &OutName, const Twine &GVName,
64                         ManglerPrefixTy PrefixTy = Mangler::Default) const;
65};
66
67} // End llvm namespace
68
69#endif // LLVM_TARGET_MANGLER_H
70