1 //===-- llvm/SymbolTableListTraits.h - Traits for iplist --------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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.
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.
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...
23 //===----------------------------------------------------------------------===//
25 #ifndef LLVM_SYMBOLTABLELISTTRAITS_H
26 #define LLVM_SYMBOLTABLELISTTRAITS_H
28 #include "llvm/ADT/ilist.h"
32 template<typename NodeTy> class ilist_iterator;
33 template<typename NodeTy, typename Traits> class iplist;
34 template<typename Ty> struct ilist_traits;
36 // ValueSubClass - The type of objects that I hold, e.g. Instruction.
37 // ItemParentType - The type of object that owns the list, e.g. BasicBlock.
38 // TraitBaseClass - The class this trait should inherit from, it should
39 // inherit from ilist_traits<ValueSubClass>
41 template<typename ValueSubClass, typename ItemParentClass>
42 class SymbolTableListTraits : public ilist_default_traits<ValueSubClass> {
43 typedef ilist_traits<ValueSubClass> TraitsClass;
45 SymbolTableListTraits() {}
47 /// getListOwner - Return the object that owns this list. If this is a list
48 /// of instructions, it returns the BasicBlock that owns them.
49 ItemParentClass *getListOwner() {
50 return reinterpret_cast<ItemParentClass*>(reinterpret_cast<char*>(this)-
51 TraitsClass::getListOffset());
54 void deleteNode(ValueSubClass *V) {
58 void addNodeToList(ValueSubClass *V);
59 void removeNodeFromList(ValueSubClass *V);
60 void transferNodesFromList(ilist_traits<ValueSubClass> &L2,
61 ilist_iterator<ValueSubClass> first,
62 ilist_iterator<ValueSubClass> last);
64 template<typename TPtr>
65 void setSymTabObject(TPtr *, TPtr);
68 } // End llvm namespace