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 template<typename NodeTy> class ilist_iterator;
  29 template<typename NodeTy, typename Traits> class iplist;
  30 template<typename Ty> struct ilist_traits;
  31
  32 // ValueSubClass  - The type of objects that I hold
  33 // ItemParentType - I call setParent() on all of my "ValueSubclass" items, and
  34 //                  this is the value that I pass in.
  35 // SymTabType     - This is the class type, whose symtab I insert my
  36 //                  ValueSubClass items into.  Most of the time it is
  37 //                  ItemParentType, but Instructions have item parents of BB's
  38 //                  but symtabtype's of a Function
  39 //
  40 template<typename ValueSubClass, typename ItemParentClass, typename SymTabClass,
  41          typename SubClass=ilist_traits<ValueSubClass> >
  42 class SymbolTableListTraits {
  43   SymTabClass     *SymTabObject;
  44   ItemParentClass *ItemParent;
  45 public:
  46   SymbolTableListTraits() : SymTabObject(0), ItemParent(0) {}
  47
  48         SymTabClass *getParent()       { return SymTabObject; }
  49   const SymTabClass *getParent() const { return SymTabObject; }
  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
  70 //private:
  71   void setItemParent(ItemParentClass *IP) { ItemParent = IP; }//This is private!
  72   void setParent(SymTabClass *Parent);  // This is private!
  73 };
  74
  75 #endif