include/llvm/GlobalAlias.h

   1 //===-------- llvm/GlobalAlias.h - GlobalAlias class ------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by Anton Korobeynikov and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file contains the declaration of the GlobalAlias class, which
  11 // represents a single function or variable alias in the IR.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_GLOBAL_ALIAS_H
  16 #define LLVM_GLOBAL_ALIAS_H
  17
  18 #include "llvm/GlobalValue.h"
  19
  20 namespace llvm {
  21
  22 class Module;
  23 class Constant;
  24 class PointerType;
  25 template<typename ValueSubClass, typename ItemParentClass>
  26   class SymbolTableListTraits;
  27
  28 class GlobalAlias : public GlobalValue {
  29   friend class SymbolTableListTraits<GlobalAlias, Module>;
  30   void operator=(const GlobalAlias &);     // Do not implement
  31   GlobalAlias(const GlobalAlias &);     // Do not implement
  32
  33   void setParent(Module *parent);
  34
  35   GlobalAlias *Prev, *Next;
  36   void setNext(GlobalAlias *N) { Next = N; }
  37   void setPrev(GlobalAlias *N) { Prev = N; }
  38
  39   // getNext/Prev - Return the next or previous alias in the list.
  40         GlobalAlias *getNext()       { return Next; }
  41   const GlobalAlias *getNext() const { return Next; }
  42         GlobalAlias *getPrev()       { return Prev; }
  43   const GlobalAlias *getPrev() const { return Prev; }
  44
  45   Use Aliasee;
  46 protected:
  47   static void destroyThis(GlobalAlias*v) {
  48     GlobalValue::destroyThis(v);
  49   }
  50   friend class Value;
  51 public:
  52   /// GlobalAlias ctor - If a parent module is specified, the alias is
  53   /// automatically inserted into the end of the specified module's alias list.
  54   GlobalAlias(const Type *Ty, LinkageTypes Linkage, const std::string &Name = "",
  55               Constant* Aliasee = 0, Module *Parent = 0);
  56
  57   /// isDeclaration - Is this global variable lacking an initializer?  If so,
  58   /// the global variable is defined in some other translation unit, and is thus
  59   /// only a declaration here.
  60   virtual bool isDeclaration() const;
  61
  62   /// removeFromParent - This method unlinks 'this' from the containing module,
  63   /// but does not delete it.
  64   ///
  65   void removeFromParent();
  66
  67   /// eraseFromParent - This method unlinks 'this' from the containing module
  68   /// and deletes it.
  69   ///
  70   void eraseFromParent();
  71
  72   virtual void print(std::ostream &OS) const;
  73   void print(std::ostream *OS) const { if (OS) print(*OS); }
  74
  75   /// set/getAliasee - These methods retrive and set alias target.
  76   void setAliasee(Constant* GV);
  77   const Constant* getAliasee() const {
  78     return cast_or_null<Constant>(getOperand(0));
  79   }
  80   Constant* getAliasee() {
  81     return cast_or_null<Constant>(getOperand(0));
  82   }
  83   /// getAliasedGlobal() - Aliasee can be either global or bitcast of
  84   /// global. This method retrives the global for both aliasee flavours.
  85   const GlobalValue* getAliasedGlobal() const;
  86
  87   // Methods for support type inquiry through isa, cast, and dyn_cast:
  88   static inline bool classof(const GlobalAlias *) { return true; }
  89   static inline bool classof(const Value *V) {
  90     return V->getValueID() == Value::GlobalAliasVal;
  91   }
  92 };
  93
  94 } // End llvm namespace
  95
  96 #endif