include/llvm/SymbolTableListTraits.h

   1 //===-- llvm/SymbolTableListTraits.h - Traits for iplist --------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source 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
  35 // ItemParentType - I call setParent() on all of my "ValueSubclass" items, and
  36 //                  this is the value that I pass in.
  37 // SymTabType     - This is the class type, whose symtab I insert my
  38 //                  ValueSubClass items into.  Most of the time it is
  39 //                  ItemParentType, but Instructions have item parents of BB's
  40 //                  but symtabtype's of a Function
  41 //
  42 template<typename ValueSubClass, typename ItemParentClass, typename SymTabClass,
  43          typename SubClass=ilist_traits<ValueSubClass> >
  44 class SymbolTableListTraits {
  45   SymTabClass     *SymTabObject;
  46   ItemParentClass *ItemParent;
  47 public:
  48   SymbolTableListTraits() : SymTabObject(0), ItemParent(0) {}
  49
  50         SymTabClass *getParent()       { return SymTabObject; }
  51   const SymTabClass *getParent() const { return SymTabObject; }
  52
  53   static ValueSubClass *getPrev(ValueSubClass *V) { return V->getPrev(); }
  54   static ValueSubClass *getNext(ValueSubClass *V) { return V->getNext(); }
  55   static const ValueSubClass *getPrev(const ValueSubClass *V) {
  56     return V->getPrev();
  57   }
  58   static const ValueSubClass *getNext(const ValueSubClass *V) {
  59     return V->getNext();
  60   }
  61
  62   static void setPrev(ValueSubClass *V, ValueSubClass *P) { V->setPrev(P); }
  63   static void setNext(ValueSubClass *V, ValueSubClass *N) { V->setNext(N); }
  64
  65   void addNodeToList(ValueSubClass *V);
  66   void removeNodeFromList(ValueSubClass *V);
  67   void transferNodesFromList(iplist<ValueSubClass,
  68                              ilist_traits<ValueSubClass> > &L2,
  69                              ilist_iterator<ValueSubClass> first,
  70                              ilist_iterator<ValueSubClass> last);
  71
  72 //private:
  73   void setItemParent(ItemParentClass *IP) { ItemParent = IP; }//This is private!
  74   void setParent(SymTabClass *Parent);  // This is private!
  75 };
  76
  77 } // End llvm namespace
  78
  79 #endif