include/llvm/SymbolTableListTraits.h

   1 //===-- llvm/SymbolTableListTraits.h - Traits for iplist --------*- 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 // This file defines a generic class that is used to implement the automatic
  11 // symbol table manipulation that occurs when you put (for example) a named
  12 // instruction into a basic block.
  13 //
  14 // The way that this is implemented is by using a special traits class with the
  15 // intrusive list that makes up the list of instructions in a basic block.  When
  16 // a new element is added to the list of instructions, the traits class is
  17 // notified, allowing the symbol table to be updated.
  18 //
  19 // This generic class implements the traits class.  It must be generic so that
  20 // it can work for all uses it, which include lists of instructions, basic
  21 // blocks, arguments, functions, global variables, etc...
  22 //
  23 //===----------------------------------------------------------------------===//
  24
  25 #ifndef LLVM_SYMBOLTABLELISTTRAITS_H
  26 #define LLVM_SYMBOLTABLELISTTRAITS_H
  27
  28 namespace llvm {
  29
  30 template<typename NodeTy> class ilist_iterator;
  31 template<typename NodeTy, typename Traits> class iplist;
  32 template<typename Ty> struct ilist_traits;
  33
  34 // ValueSubClass  - The type of objects that I hold, e.g. Instruction.
  35 // ItemParentType - The type of object that owns the list, e.g. BasicBlock.
  36 // TraitBaseClass - The class this trait should inherit from, it should
  37 //                  inherit from ilist_traits<ValueSubClass>
  38 //
  39 template<typename ValueSubClass, typename ItemParentClass>
  40 class SymbolTableListTraits {
  41   typedef ilist_traits<ValueSubClass> TraitsClass;
  42 public:
  43   SymbolTableListTraits() {}
  44
  45   /// getListOwner - Return the object that owns this list.  If this is a list
  46   /// of instructions, it returns the BasicBlock that owns them.
  47   ItemParentClass *getListOwner() {
  48     return reinterpret_cast<ItemParentClass*>(reinterpret_cast<char*>(this)-
  49                                               TraitsClass::getListOffset());
  50   }
  51   static ValueSubClass *getPrev(ValueSubClass *V) { return V->getPrev(); }
  52   static ValueSubClass *getNext(ValueSubClass *V) { return V->getNext(); }
  53   static const ValueSubClass *getPrev(const ValueSubClass *V) {
  54     return V->getPrev();
  55   }
  56   static const ValueSubClass *getNext(const ValueSubClass *V) {
  57     return V->getNext();
  58   }
  59
  60   static void setPrev(ValueSubClass *V, ValueSubClass *P) { V->setPrev(P); }
  61   static void setNext(ValueSubClass *V, ValueSubClass *N) { V->setNext(N); }
  62
  63   void addNodeToList(ValueSubClass *V);
  64   void removeNodeFromList(ValueSubClass *V);
  65   void transferNodesFromList(iplist<ValueSubClass,
  66                              ilist_traits<ValueSubClass> > &L2,
  67                              ilist_iterator<ValueSubClass> first,
  68                              ilist_iterator<ValueSubClass> last);
  69 //private:
  70   template<typename TPtr>
  71   void setSymTabObject(TPtr *, TPtr);
  72 };
  73
  74 } // End llvm namespace
  75
  76 #endif