include/llvm/Target/Mangler.h

   1 //===-- llvm/Support/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_SUPPORT_MANGLER_H
  15 #define LLVM_SUPPORT_MANGLER_H
  16
  17 #include "llvm/ADT/DenseMap.h"
  18 #include <string>
  19
  20 namespace llvm {
  21 class Twine;
  22 class Type;
  23 class Module;
  24 class Value;
  25 class GlobalValue;
  26 template <typename T> class SmallVectorImpl;
  27
  28 class Mangler {
  29 public:
  30   enum ManglerPrefixTy {
  31     Default,               ///< Emit default string before each symbol.
  32     Private,               ///< Emit "private" prefix before each symbol.
  33     LinkerPrivate          ///< Emit "linker private" prefix before each symbol.
  34   };
  35
  36 private:
  37   /// Prefix - This string is added to each symbol that is emitted, unless the
  38   /// symbol is marked as not needing this prefix.
  39   const char *Prefix;
  40
  41   /// PrivatePrefix - This string is emitted before each symbol with private
  42   /// linkage.
  43   const char *PrivatePrefix;
  44
  45   /// LinkerPrivatePrefix - This string is emitted before each symbol with
  46   /// "linker_private" linkage.
  47   const char *LinkerPrivatePrefix;
  48
  49   /// AnonGlobalIDs - We need to give global values the same name every time
  50   /// they are mangled.  This keeps track of the number we give to anonymous
  51   /// ones.
  52   ///
  53   DenseMap<const GlobalValue*, unsigned> AnonGlobalIDs;
  54
  55   /// NextAnonGlobalID - This simple counter is used to unique value names.
  56   ///
  57   unsigned NextAnonGlobalID;
  58
  59 public:
  60   // Mangler ctor - if a prefix is specified, it will be prepended onto all
  61   // symbols.
  62   Mangler(Module &M, const char *Prefix = "", const char *privatePrefix = "",
  63           const char *linkerPrivatePrefix = "");
  64
  65   /// getNameWithPrefix - Fill OutName with the name of the appropriate prefix
  66   /// and the specified global variable's name.  If the global variable doesn't
  67   /// have a name, this fills in a unique name for the global.
  68   void getNameWithPrefix(SmallVectorImpl<char> &OutName, const GlobalValue *GV,
  69                          bool isImplicitlyPrivate);
  70
  71   /// getNameWithPrefix - Fill OutName with the name of the appropriate prefix
  72   /// and the specified name as the global variable name.  GVName must not be
  73   /// empty.
  74   void getNameWithPrefix(SmallVectorImpl<char> &OutName, const Twine &GVName,
  75                          ManglerPrefixTy PrefixTy = Mangler::Default);
  76
  77   /// getNameWithPrefix - Return the name of the appropriate prefix
  78   /// and the specified global variable's name.  If the global variable doesn't
  79   /// have a name, this fills in a unique name for the global.
  80   std::string getNameWithPrefix(const GlobalValue *GV,
  81                                 bool isImplicitlyPrivate = false);
  82 };
  83
  84 } // End llvm namespace
  85
  86 #endif // LLVM_SUPPORT_MANGLER_H