include/llvm/IR/Mangler.h

   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_IR_MANGLER_H
  15 #define LLVM_IR_MANGLER_H
  16
  17 #include "llvm/ADT/DenseMap.h"
  18 #include "llvm/Support/raw_ostream.h"
  19
  20 namespace llvm {
  21
  22 class DataLayout;
  23 class GlobalValue;
  24 template <typename T> class SmallVectorImpl;
  25 class Twine;
  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   /// We need to give global values the same name every time they are mangled.
  37   /// This keeps track of the number we give to anonymous ones.
  38   mutable DenseMap<const GlobalValue*, unsigned> AnonGlobalIDs;
  39
  40   /// This simple counter is used to unique value names.
  41   mutable unsigned NextAnonGlobalID;
  42
  43 public:
  44   Mangler() : NextAnonGlobalID(1) {}
  45
  46   /// Print the appropriate prefix and the specified global variable's name.
  47   /// If the global variable doesn't have a name, this fills in a unique name
  48   /// for the global.
  49   void getNameWithPrefix(raw_ostream &OS, const GlobalValue *GV,
  50                          bool CannotUsePrivateLabel) const;
  51   void getNameWithPrefix(SmallVectorImpl<char> &OutName, const GlobalValue *GV,
  52                          bool CannotUsePrivateLabel) const;
  53
  54   /// Print the appropriate prefix and the specified name as the global variable
  55   /// name. GVName must not be empty.
  56   static void getNameWithPrefix(raw_ostream &OS, const Twine &GVName,
  57                                 const DataLayout &DL,
  58                                 ManglerPrefixTy PrefixTy = Mangler::Default);
  59   static void getNameWithPrefix(SmallVectorImpl<char> &OutName,
  60                                 const Twine &GVName, const DataLayout &DL,
  61                                 ManglerPrefixTy PrefixTy = Mangler::Default);
  62 };
  63
  64 } // End llvm namespace
  65
  66 #endif