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 Value;
  23 class GlobalValue;
  24 template <typename T> class SmallVectorImpl;
  25 class MCAsmInfo;
  26
  27 class Mangler {
  28 public:
  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
  35 private:
  36   const MCAsmInfo &MAI;
  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   DenseMap<const GlobalValue*, unsigned> AnonGlobalIDs;
  43
  44   /// NextAnonGlobalID - This simple counter is used to unique value names.
  45   ///
  46   unsigned NextAnonGlobalID;
  47
  48 public:
  49   // Mangler ctor - if a prefix is specified, it will be prepended onto all
  50   // symbols.
  51   Mangler(const MCAsmInfo &mai) : MAI(mai) {}
  52
  53   /// getNameWithPrefix - Fill OutName with the name of the appropriate prefix
  54   /// and the specified global variable's name.  If the global variable doesn't
  55   /// have a name, this fills in a unique name for the global.
  56   void getNameWithPrefix(SmallVectorImpl<char> &OutName, const GlobalValue *GV,
  57                          bool isImplicitlyPrivate);
  58
  59   /// getNameWithPrefix - Fill OutName with the name of the appropriate prefix
  60   /// and the specified name as the global variable name.  GVName must not be
  61   /// empty.
  62   void getNameWithPrefix(SmallVectorImpl<char> &OutName, const Twine &GVName,
  63                          ManglerPrefixTy PrefixTy = Mangler::Default);
  64
  65   /// getNameWithPrefix - Return 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   std::string getNameWithPrefix(const GlobalValue *GV,
  69                                 bool isImplicitlyPrivate = false);
  70 };
  71
  72 } // End llvm namespace
  73
  74 #endif // LLVM_SUPPORT_MANGLER_H