<ul>
<li><a href="#Instruction">The <tt>Instruction</tt> class</a>
<ul>
- <li><a href="#GetElementPtrInst">The <tt>GetElementPtrInst</tt>
- class</a></li>
+
<li><a href="#GetElementPtrInst">The <tt>GetElementPtrInst</tt>
+ class</a></li>
</ul></li>
<li><a href="#GlobalValue">The <tt>GlobalValue</tt> class</a>
<ul>
- <li><a href="#BasicBlock">The <tt>BasicBlock</tt>class</a></li>
- <li><a href="#Function">The <tt>Function</tt> class</a></li>
- <li><a href="#GlobalVariable">The <tt>GlobalVariable</tt>
- class</a></li>
+
<li><a href="#BasicBlock">The <tt>BasicBlock</tt>class</a></li>
+
<li><a href="#Function">The <tt>Function</tt> class</a></li>
+ <li><a href="#GlobalVariable">The <tt>GlobalVariable</tt> class
+ </a></li>
</ul></li>
<li><a href="#Module">The <tt>Module</tt> class</a></li>
- <li><a href="#Constant">The <tt>Constant</tt> class</a>
- <ul>
- <li> <br>
- </li>
- <li> <br>
- </li>
- </ul>
- </li>
- </ul>
- </li>
+ <li><a href="#Constant">The <tt>Constant</tt> class</a></li>
<li><a href="#Type">The <tt>Type</tt> class</a> </li>
- <li><a href="#Argument">The <tt>Argument</tt> class</a> </li>
- </ul>
- </li>
- <li>The <tt>SymbolTable</tt> class </li>
- <li>The <tt>ilist</tt> and <tt>iplist</tt> classes
- <ul>
- <li>Creating, inserting, moving and deleting from LLVM lists </li>
- </ul>
- </li>
- <li>Important iterator invalidation semantics to be aware of </li>
- </ul>
+ <li><a href="#Argument">The <tt>Argument</tt> class</a></li>
+ </ul></li>
+ </ul></li>
+ <li><a href="#SymbolTable">The <tt>SymbolTable</tt> class </a></li>
+ <li>The <tt>ilist</tt> and <tt>iplist</tt> classes
+ <ul>
+ <li>Creating, inserting, moving and deleting from LLVM lists </li>
+ </ul>
+ </li>
+ <li>Important iterator invalidation semantics to be aware of.</li>
</li>
</ol>
-<div class="doc_text">
- <p><b>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a>,
- <a href="mailto:dhurjati@cs.uiuc.edu">Dinakar Dhurjati</a>, and <a
- href="mailto:jstanley@cs.uiuc.edu">Joel Stanley</a></b></p>
+<div class="doc_author">
+ <p>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a>,
+ <a href="mailto:dhurjati@cs.uiuc.edu">Dinakar Dhurjati</a>,
+ <a href="mailto:jstanley@cs.uiuc.edu">Joel Stanley</a>, and
+ <a href="mailto:rspencer@x10sys.com">Reid Spencer</a></p>
</div>
<!-- *********************************************************************** -->
<li><a href="http://www.research.att.com/%7Ebs/C++.html">Bjarne Stroustrup's C++
Page</a></li>
+<li><a href="http://www.linux.com.cn/Bruce_Eckel/TICPPv2/Contents.htm">
+Bruce Eckel's Thinking in C++, 2nd ed. Volume 2 Revision 4.0 (even better, get
+the book).</a></li>
+
</ol>
<p>You are also encouraged to take a look at the <a
that something is of the right type. An example of the <tt>isa<></tt>
and <tt>cast<></tt> template is:
- <pre>static bool isLoopInvariant(const <a href="#Value">Value</a> *V, const
- Loop *L) {<br> if (isa<<a href="#Constant">Constant</a>>(V) || isa<<a
- href="#Argument">Argument</a>>(V) || isa<<a
- href="#GlobalValue">GlobalValue</a>>(V))<br> return true;<br><br> <i>//
- Otherwise, it must be an instruction...</i><br> return
- !L->contains(cast<<a
- href="#Instruction">Instruction</a>>(V)->getParent());<br></pre>
+ <pre>
+ static bool isLoopInvariant(const <a href="#Value">Value</a> *V, const Loop *L) {
+ if (isa<<a href="#Constant">Constant</a>>(V) || isa<<a href="#Argument">Argument</a>>(V) || isa<<a href="#GlobalValue">GlobalValue</a>>(V))
+ return true;
+
+ <i>// Otherwise, it must be an instruction...</i>
+ return !L->contains(cast<<a href="#Instruction">Instruction</a>>(V)->getParent());
+ </pre>
<p>Note that you should <b>not</b> use an <tt>isa<></tt> test followed
by a <tt>cast<></tt>, for that use the <tt>dyn_cast<></tt>
same circumstances. Typically, the <tt>dyn_cast<></tt> operator is used
in an <tt>if</tt> statement or some other flow control statement like this:
- <pre> if (<a href="#AllocationInst">AllocationInst</a> *AI = dyn_cast<<a
- href="#AllocationInst">AllocationInst</a>>(Val)) {<br> ...<br> }<br></pre>
+ <pre>
+ if (<a href="#AllocationInst">AllocationInst</a> *AI = dyn_cast<<a href="#AllocationInst">AllocationInst</a>>(Val)) {
+ ...
+ }
+ </pre>
<p> This form of the <tt>if</tt> statement effectively combines together a
call to <tt>isa<></tt> and a call to <tt>cast<></tt> into one
<p> Another common example is:</p>
- <pre> <i>// Loop over all of the phi nodes in a basic block</i><br>
- BasicBlock::iterator BBI = BB->begin();<br> for (; <a
- href="#PhiNode">PHINode</a> *PN = dyn_cast<<a
- href="#PHINode">PHINode</a>>(BBI); ++BBI)<br> cerr << *PN;<br></pre>
+ <pre>
+ <i>// Loop over all of the phi nodes in a basic block</i>
+ BasicBlock::iterator BBI = BB->begin();
+ for (; <a href="#PhiNode">PHINode</a> *PN = dyn_cast<<a href="#PHINode">PHINode</a>>(BBI); ++BBI)
+ std::cerr << *PN;
+ </pre>
<p>Note that the <tt>dyn_cast<></tt> operator, like C++'s
<tt>dynamic_cast</tt> or Java's <tt>instanceof</tt> operator, can be abused.
</div>
<!-- _______________________________________________________________________ -->
-<div class="subsubsection">
+<div class="doc_subsubsection">
<a name="iterate_function">Iterating over the </a><a
href="#BasicBlock"><tt>BasicBlock</tt></a>s in a <a
href="#Function"><tt>Function</tt></a>
</div>
<!-- _______________________________________________________________________ -->
-<div class="subsubsection">
+<div class="doc_subsubsection">
<a name="iterate_basicblock">Iterating over the </a><a
href="#Instruction"><tt>Instruction</tt></a>s in a <a
href="#BasicBlock"><tt>BasicBlock</tt></a>
</div>
<!-- _______________________________________________________________________ -->
-<div class="subsubsection">
+<div class="doc_subsubsection">
<a name="iterate_institer">Iterating over the </a><a
href="#Instruction"><tt>Instruction</tt></a>s in a <a
href="#Function"><tt>Function</tt></a>
<tt>InstIterator</tt> should be used instead. You'll need to include <a
href="/doxygen/InstIterator_8h-source.html"><tt>llvm/Support/InstIterator.h</tt></a>,
and then instantiate <tt>InstIterator</tt>s explicitly in your code. Here's a
-small example that shows how to dump all instructions in a function to stderr
-(<b>Note:</b> Dereferencing an <tt>InstIterator</tt> yields an
-<tt>Instruction*</tt>, <i>not</i> an <tt>Instruction&</tt>!):</p>
+small example that shows how to dump all instructions in a function to the standard error stream:<p>
- <pre>#include "<a href="/doxygen/InstIterator_8h-source.html">llvm/Support/InstIterator.h</a>"<br>...<br>// Suppose F is a ptr to a function<br>for (inst_iterator i = inst_begin(F), e = inst_end(F); i != e; ++i)<br> cerr << **i << "\n";<br></pre>
+ <pre>#include "<a href="/doxygen/InstIterator_8h-source.html">llvm/Support/InstIterator.h</a>"<br>...<br>// Suppose F is a ptr to a function<br>for (inst_iterator i = inst_begin(F), e = inst_end(F); i != e; ++i)<br> cerr << *i << "\n";<br></pre>
Easy, isn't it? You can also use <tt>InstIterator</tt>s to fill a
worklist with its initial contents. For example, if you wanted to
initialize a worklist to contain all instructions in a <tt>Function</tt>
<p>Sometimes, it'll be useful to grab a reference (or pointer) to a class
instance when all you've got at hand is an iterator. Well, extracting
-a reference or a pointer from an iterator is very straightforward.
+a reference or a pointer from an iterator is very straight-forward.
Assuming that <tt>i</tt> is a <tt>BasicBlock::iterator</tt> and <tt>j</tt>
is a <tt>BasicBlock::const_iterator</tt>:</p>
<pre>Instruction* pinst = i;</pre>
-<p>It's also possible to turn a class pointer into the corresponding iterator.
-Usually, this conversion is quite inexpensive. The following code snippet
-illustrates use of the conversion constructors provided by LLVM iterators. By
-using these, you can explicitly grab the iterator of something without actually
-obtaining it via iteration over some structure:</p>
+<p>It's also possible to turn a class pointer into the corresponding iterator,
+and this is a constant time operation (very efficient). The following code
+snippet illustrates use of the conversion constructors provided by LLVM
+iterators. By using these, you can explicitly grab the iterator of something
+without actually obtaining it via iteration over some structure:</p>
<pre>void printNextInstruction(Instruction* inst) {<br> BasicBlock::iterator it(inst);<br> ++it; // after this line, it refers to the instruction after *inst.<br> if (it != inst->getParent()->end()) cerr << *it << "\n";<br>}<br></pre>
-<p>Of course, this example is strictly pedagogical, because it'd be much
-better to explicitly grab the next instruction directly from inst.</p>
-
</div>
<!--_______________________________________________________________________-->
locations in the entire module (that is, across every <tt>Function</tt>) where a
certain function (i.e., some <tt>Function</tt>*) is already in scope. As you'll
learn later, you may want to use an <tt>InstVisitor</tt> to accomplish this in a
-much more straightforward manner, but this example will allow us to explore how
+much more straight-forward manner, but this example will allow us to explore how
you'd do it if you didn't have <tt>InstVisitor</tt> around. In pseudocode, this
is what we want to do:</p>
most-specific common base class is <tt>Instruction</tt>, which includes lots of
less closely-related things. For these cases, LLVM provides a handy wrapper
class called <a
-href="http://llvm.cs.uiuc.edu/doxygen/classCallSite.html"><tt>CallSite
-</tt></a>. It is essentially a wrapper around an <tt>Instruction</tt> pointer,
-with some methods that provide functionality common to <tt>CallInst</tt>s and
+href="http://llvm.cs.uiuc.edu/doxygen/classllvm_1_1CallSite.html"><tt>CallSite</tt></a>.
+It is essentially a wrapper around an <tt>Instruction</tt> pointer, with some
+methods that provide functionality common to <tt>CallInst</tt>s and
<tt>InvokeInst</tt>s.</p>
-<p>This class is supposed to have "value semantics". So it should be passed by
-value, not by reference; it should not be dynamically allocated or deallocated
-using <tt>operator new</tt> or <tt>operator delete</tt>. It is efficiently
-copyable, assignable and constructable, with costs equivalents to that of a bare
-pointer. (You will notice, if you look at its definition, that it has only a
-single data member.)</p>
+<p>This class has "value semantics": it should be passed by value, not by
+reference and it should not be dynamically allocated or deallocated using
+<tt>operator new</tt> or <tt>operator delete</tt>. It is efficiently copyable,
+assignable and constructable, with costs equivalents to that of a bare pointer.
+If you look at its definition, it has only a single pointer member.</p>
</div>
<div class="doc_text">
<p>Frequently, we might have an instance of the <a
-href="/doxygen/classValue.html">Value Class</a> and we want to determine which
-<tt>User</tt>s use the <tt>Value</tt>. The list of all <tt>User</tt>s of a
-particular <tt>Value</tt> is called a <i>def-use</i> chain. For example, let's
-say we have a <tt>Function*</tt> named <tt>F</tt> to a particular function
-<tt>foo</tt>. Finding all of the instructions that <i>use</i> <tt>foo</tt> is as
-simple as iterating over the <i>def-use</i> chain of <tt>F</tt>:</p>
+href="/doxygen/structllvm_1_1Value.html">Value Class</a> and we want to
+determine which <tt>User</tt>s use the <tt>Value</tt>. The list of all
+<tt>User</tt>s of a particular <tt>Value</tt> is called a <i>def-use</i> chain.
+For example, let's say we have a <tt>Function*</tt> named <tt>F</tt> to a
+particular function <tt>foo</tt>. Finding all of the instructions that
+<i>use</i> <tt>foo</tt> is as simple as iterating over the <i>def-use</i> chain
+of <tt>F</tt>:</p>
<pre>Function* F = ...;<br><br>for (Value::use_iterator i = F->use_begin(), e = F->use_end(); i != e; ++i) {<br> if (Instruction *Inst = dyn_cast<Instruction>(*i)) {<br> cerr << "F is used in instruction:\n";<br> cerr << *Inst << "\n";<br> }<br>}<br></pre>
<p>Alternately, it's common to have an instance of the <a
-href="/doxygen/classUser.html">User Class</a> and need to know what
+href="/doxygen/classllvm_1_1User.html">User Class</a> and need to know what
<tt>Value</tt>s are used by it. The list of all <tt>Value</tt>s used by a
<tt>User</tt> is known as a <i>use-def</i> chain. Instances of class
<tt>Instruction</tt> are common <tt>User</tt>s, so we might want to iterate over
<p><i>Instantiating Instructions</i></p>
-<p>Creation of <tt>Instruction</tt>s is straightforward: simply call the
+<p>Creation of <tt>Instruction</tt>s is straight-forward: simply call the
constructor for the kind of instruction to instantiate and provide the necessary
parameters. For example, an <tt>AllocaInst</tt> only <i>requires</i> a
(const-ptr-to) <tt>Type</tt>. Thus:</p>
one integer in the current stack frame, at runtime. Each <tt>Instruction</tt>
subclass is likely to have varying default parameters which change the semantics
of the instruction, so refer to the <a
-href="/doxygen/classInstruction.html">doxygen documentation for the subclass of
+href="/doxygen/classllvm_1_1Instruction.html">doxygen documentation for the subclass of
Instruction</a> that you're interested in instantiating.</p>
<p><i>Naming values</i></p>
<tt>BasicBlock</tt>, and a newly-created instruction we wish to insert
before <tt>*pi</tt>, we do the following: </p>
- <pre> BasicBlock *pb = ...;<br> Instruction *pi = ...;<br> Instruction *newInst = new Instruction(...);<br> pb->getInstList().insert(pi, newInst); // inserts newInst before pi in pb<br></pre></li>
+ <pre> BasicBlock *pb = ...;<br> Instruction *pi = ...;<br> Instruction *newInst = new Instruction(...);<br> pb->getInstList().insert(pi, newInst); // inserts newInst before pi in pb<br></pre>
+
+ <p>Appending to the end of a <tt>BasicBlock</tt> is so common that
+ the <tt>Instruction</tt> class and <tt>Instruction</tt>-derived
+ classes provide constructors which take a pointer to a
+ <tt>BasicBlock</tt> to be appended to. For example code that
+ looked like: </p>
+
+ <pre> BasicBlock *pb = ...;<br> Instruction *newInst = new Instruction(...);<br> pb->getInstList().push_back(newInst); // appends newInst to pb<br></pre>
+
+ <p>becomes: </p>
+
+ <pre> BasicBlock *pb = ...;<br> Instruction *newInst = new Instruction(..., pb);<br></pre>
+
+ <p>which is much cleaner, especially if you are creating
+ long instruction streams.</p></li>
<li>Insertion into an implicit instruction list
<div class="doc_text">
<p>Deleting an instruction from an existing sequence of instructions that form a
-<a href="#BasicBlock"><tt>BasicBlock</tt></a> is very straightforward. First,
+<a href="#BasicBlock"><tt>BasicBlock</tt></a> is very straight-forward. First,
you must have a pointer to the instruction that you wish to delete. Second, you
need to obtain the pointer to that instruction's basic block. You use the
pointer to the basic block to get its list of instructions and then use the
<p>You can use <tt>Value::replaceAllUsesWith</tt> and
<tt>User::replaceUsesOfWith</tt> to change more than one use at a time. See the
-doxygen documentation for the <a href="/doxygen/classValue.html">Value Class</a>
-and <a href="/doxygen/classUser.html">User Class</a>, respectively, for more
+doxygen documentation for the <a href="/doxygen/structllvm_1_1Value.html">Value Class</a>
+and <a href="/doxygen/classllvm_1_1User.html">User Class</a>, respectively, for more
information.</p>
<!-- Value::replaceAllUsesWith User::replaceUsesOfWith Point out:
<p><tt>#include "<a href="/doxygen/Value_8h-source.html">llvm/Value.h</a>"</tt>
<br>
-doxygen info: <a href="/doxygen/classValue.html">Value Class</a></p>
+doxygen info: <a href="/doxygen/structllvm_1_1Value.html">Value Class</a></p>
<p>The <tt>Value</tt> class is the most important class in the LLVM Source
base. It represents a typed value that may be used (among other things) as an
<p>One important aspect of LLVM is that there is no distinction between an SSA
variable and the operation that produces it. Because of this, any reference to
the value produced by an instruction (or the value available as an incoming
-argument, for example) is represented as a direct pointer to the class that
+argument, for example) is represented as a direct pointer to the instance of
+the class that
represents this value. Although this may take some getting used to, it
simplifies the representation and makes it easier to manipulate.</p>
<p>
<tt>#include "<a href="/doxygen/User_8h-source.html">llvm/User.h</a>"</tt><br>
-doxygen info: <a href="/doxygen/classUser.html">User Class</a><br>
+doxygen info: <a href="/doxygen/classllvm_1_1User.html">User Class</a><br>
Superclass: <a href="#Value"><tt>Value</tt></a></p>
<p>The <tt>User</tt> class is the common base class of all LLVM nodes that may
<p><tt>#include "</tt><tt><a
href="/doxygen/Instruction_8h-source.html">llvm/Instruction.h</a>"</tt><br>
-doxygen info: <a href="/doxygen/classInstruction.html">Instruction Class</a><br>
+doxygen info: <a href="/doxygen/classllvm_1_1Instruction.html">Instruction Class</a><br>
Superclasses: <a href="#User"><tt>User</tt></a>, <a
href="#Value"><tt>Value</tt></a></p>
example <tt><a href="#BinaryOperator">BinaryOperator</a></tt> and <tt><a
href="#SetCondInst">SetCondInst</a></tt>). Unfortunately, the use of macros in
this file confuses doxygen, so these enum values don't show up correctly in the
-<a href="/doxygen/classInstruction.html">doxygen output</a>.</p>
+<a href="/doxygen/classllvm_1_1Instruction.html">doxygen output</a>.</p>
</div>
<div class="doc_text">
-<p><tt>#include "<a href="/doxygen/BasicBlock_8h-source.html">llvm/BasicBlock.h</a>"</tt><br>
-doxygen info: <a href="/doxygen/classBasicBlock.html">BasicBlock Class</a><br>
+<p><tt>#include "<a
+href="/doxygen/BasicBlock_8h-source.html">llvm/BasicBlock.h</a>"</tt><br>
+doxygen info: <a href="/doxygen/structllvm_1_1BasicBlock.html">BasicBlock
+Class</a><br>
Superclass: <a href="#Value"><tt>Value</tt></a></p>
<p>This class represents a single entry multiple exit section of the code,
<p><tt>#include "<a
href="/doxygen/GlobalValue_8h-source.html">llvm/GlobalValue.h</a>"</tt><br>
-doxygen info: <a href="/doxygen/classGlobalValue.html">GlobalValue Class</a><br>
+doxygen info: <a href="/doxygen/classllvm_1_1GlobalValue.html">GlobalValue
+Class</a><br>
Superclasses: <a href="#User"><tt>User</tt></a>, <a
href="#Value"><tt>Value</tt></a></p>
<p><tt>#include "<a
href="/doxygen/Function_8h-source.html">llvm/Function.h</a>"</tt><br> doxygen
-info: <a href="/doxygen/classFunction.html">Function Class</a><br> Superclasses:
-<a href="#GlobalValue"><tt>GlobalValue</tt></a>, <a
+info: <a href="/doxygen/classllvm_1_1Function.html">Function Class</a><br>
+
Superclasses: <a href="#GlobalValue"><tt>GlobalValue</tt></a>, <a
href="#User"><tt>User</tt></a>, <a href="#Value"><tt>Value</tt></a></p>
<p>The <tt>Function</tt> class represents a single procedure in LLVM. It is
<p><tt>#include "<a
href="/doxygen/Module_8h-source.html">llvm/Module.h</a>"</tt><br> doxygen info:
-<a href="/doxygen/classModule.html">Module Class</a></p>
+<a href="/doxygen/structllvm_1_1Module.html">Module Class</a></p>
<p>The <tt>Module</tt> class represents the top level structure present in LLVM
programs. An LLVM module is effectively either a translation unit of the
<ul>
- <li><tt>PrimitiveID getPrimitiveID() const</tt>: Returns the base type of the
- type.</li>
-
<li><tt>bool isSigned() const</tt>: Returns whether an integral numeric type
is signed. This is true for SByteTy, ShortTy, IntTy, LongTy. Note that this is
not true for Float and Double. </li>
<li><tt>bool isFloatingPoint()</tt>: Return true if this is one of the two
floating point types.</li>
- <li><tt>bool isRecursive() const</tt>: Returns rue if the type graph contains
- a cycle.</li>
-
<li><tt>isLosslesslyConvertableTo (const Type *Ty) const</tt>: Return true if
this type can be converted to 'Ty' without any reinterpretation of bits. For
- example, uint to int.</li>
-
- <li><tt>bool isPrimitiveType() const</tt>: Returns true if it is a primitive
- type.</li>
-
- <li><tt>bool isDerivedType() const</tt>: Returns true if it is a derived
- type.</li>
-
- <li><tt>const Type * getContainedType (unsigned i) const</tt>: This method is
- used to implement the type iterator. For derived types, this returns the types
- 'contained' in the derived type, returning 0 when 'i' becomes invalid. This
- allows the user to iterate over the types in a struct, for example, really
- easily.</li>
+ example, uint to int or one pointer type to another.</li>
- <li><tt>unsigned getNumContainedTypes() const</tt>: Return the number of types
- in the derived type.
-
- <hr>
+<br>
<p>Derived Types</p>
<ul>
function</li>
<li><tt> const Type * getReturnType() const</tt>: Returns the
return type of the function.</li>
- <li><tt> const ParamTypes &getParamTypes() const</tt>:
- Returns a vector of parameter types.</li>
<li><tt>const Type * getParamType (unsigned i)</tt>: Returns
the type of the ith parameter.</li>
<li><tt> const unsigned getNumParams() const</tt>: Returns the
</div>
+<!-- ======================================================================= -->
+<div class="doc_subsection">
+ <a name="SymbolTable">The <tt>SymbolTable</tt> class</a>
+</div>
+<div class="doc_text">
+<p>This class provides a symbol table that the
+<a href="#Function"><tt>Function</tt></a> and <a href="#Module">
+<tt>Module</tt></a> classes use for naming definitions. The symbol table can
+provide a name for any <a href="#Value"><tt>Value</tt></a> or
+<a href="#Type"><tt>Type</tt></a>. <tt>SymbolTable</tt> is an abstract data
+type. It hides the data it contains and provides access to it through a
+controlled interface.</p>
+
+<p>To use the <tt>SymbolTable</tt> well, you need to understand the
+structure of the information it holds. The class contains two
+<tt>std::map</tt> objects. The first, <tt>pmap</tt>, is a map of
+<tt>Type*</tt> to maps of name (<tt>std::string</tt>) to <tt>Value*</tt>.
+The second, <tt>tmap</tt>, is a map of names to <tt>Type*</tt>. Thus, Values
+are stored in two-dimensions and accessed by <tt>Type</tt> and name. Types,
+however, are stored in a single dimension and accessed only by name.</p>
+
+<p>The interface of this class provides three basic types of operations:
+<ol>
+ <li><em>Accessors</em>. Accessors provide read-only access to information
+ such as finding a value for a name with the
+ <a href="#SymbolTable_lookup">lookup</a> method.</li>
+ <li><em>Mutators</em>. Mutators allow the user to add information to the
+ <tt>SymbolTable</tt> with methods like
+ <a href="#SymbolTable_insert"><tt>insert</tt></a>.</li>
+ <li><em>Iterators</em>. Iterators allow the user to traverse the content
+ of the symbol table in well defined ways, such as the method
+ <a href="#SymbolTable_type_begin"><tt>type_begin</tt></a>.</li>
+</ol>
+
+<h3>Accessors</h3>
+<dl>
+ <dt><tt>Value* lookup(const Type* Ty, const std::string& name) const</tt>:
+ </dt>
+ <dd>The <tt>lookup</tt> method searches the type plane given by the
+ <tt>Ty</tt> parameter for a <tt>Value</tt> with the provided <tt>name</tt>.
+ If a suitable <tt>Value</tt> is not found, null is returned.</dd>
+
+ <dt><tt>Type* lookupType( const std::string& name) const</tt>:</dt>
+ <dd>The <tt>lookupType</tt> method searches through the types for a
+ <tt>Type</tt> with the provided <tt>name</tt>. If a suitable <tt>Type</tt>
+ is not found, null is returned.</dd>
+
+ <dt><tt>bool hasTypes() const</tt>:</dt>
+ <dd>This function returns true if an entry has been made into the type
+ map.</dd>
+
+ <dt><tt>bool isEmpty() const</tt>:</dt>
+ <dd>This function returns true if both the value and types maps are
+ empty</dd>
+
+ <dt><tt>std::string get_name(const Value*) const</tt>:</dt>
+ <dd>This function returns the name of the Value provided or the empty
+ string if the Value is not in the symbol table.</dd>
+
+ <dt><tt>std::string get_name(const Type*) const</tt>:</dt>
+ <dd>This function returns the name of the Type provided or the empty
+ string if the Type is not in the symbol table.</dd>
+</dl>
+
+<h3>Mutators</h3>
+<dl>
+ <dt><tt>void insert(Value *Val)</tt>:</dt>
+ <dd>This method adds the provided value to the symbol table. The Value must
+ have both a name and a type which are extracted and used to place the value
+ in the correct type plane under the value's name.</dd>
+
+ <dt><tt>void insert(const std::string& Name, Value *Val)</tt>:</dt>
+ <dd> Inserts a constant or type into the symbol table with the specified
+ name. There can be a many to one mapping between names and constants
+ or types.</dd>
+
+ <dt><tt>void insert(const std::string& Name, Type *Typ)</tt>:</dt>
+ <dd> Inserts a type into the symbol table with the specified name. There
+ can be a many-to-one mapping between names and types. This method
+ allows a type with an existing entry in the symbol table to get
+ a new name.</dd>
+
+ <dt><tt>void remove(Value* Val)</tt>:</dt>
+ <dd> This method removes a named value from the symbol table. The
+ type and name of the Value are extracted from \p N and used to
+ lookup the Value in the correct type plane. If the Value is
+ not in the symbol table, this method silently ignores the
+ request.</dd>
+
+ <dt><tt>void remove(Type* Typ)</tt>:</dt>
+ <dd> This method removes a named type from the symbol table. The
+ name of the type is extracted from \P T and used to look up
+ the Type in the type map. If the Type is not in the symbol
+ table, this method silently ignores the request.</dd>
+
+ <dt><tt>Value* remove(const std::string& Name, Value *Val)</tt>:</dt>
+ <dd> Remove a constant or type with the specified name from the
+ symbol table.</dd>
+
+ <dt><tt>Type* remove(const std::string& Name, Type* T)</tt>:</dt>
+ <dd> Remove a type with the specified name from the symbol table.
+ Returns the removed Type.</dd>
+
+ <dt><tt>Value *value_remove(const value_iterator& It)</tt>:</dt>
+ <dd> Removes a specific value from the symbol table.
+ Returns the removed value.</dd>
+
+ <dt><tt>bool strip()</tt>:</dt>
+ <dd> This method will strip the symbol table of its names leaving
+ the type and values. </dd>
+
+ <dt><tt>void clear()</tt>:</dt>
+ <dd>Empty the symbol table completely.</dd>
+</dl>
+
+<h3>Iteration</h3>
+<p>The following functions describe three types of iterators you can obtain
+the beginning or end of the sequence for both const and non-const. It is
+important to keep track of the different kinds of iterators. There are
+three idioms worth pointing out:</p>
+<table class="doc_table">
+ <tr><th>Units</th><th>Iterator</th><th>Idiom</th></tr>
+ <tr>
+ <td>Planes Of name/Value maps</td><td>PI</td>
+ <td><tt><pre>
+for (SymbolTable::plane_const_iterator PI = ST.plane_begin(),
+PE = ST.plane_end(); PI != PE; ++PI ) {
+ PI->first // This is the Type* of the plane
+ PI->second // This is the SymbolTable::ValueMap of name/Value pairs
+ </pre></tt></td>
+ </tr>
+ <tr>
+ <td>All name/Type Pairs</td><td>TI</td>
+ <td><tt><pre>
+for (SymbolTable::type_const_iterator TI = ST.type_begin(),
+ TE = ST.type_end(); TI != TE; ++TI )
+ TI->first // This is the name of the type
+ TI->second // This is the Type* value associated with the name
+ </pre></tt></td>
+ </tr>
+ <tr>
+ <td>name/Value pairs in a plane</td><td>VI</td>
+ <td><tt><pre>
+for (SymbolTable::value_const_iterator VI = ST.value_begin(SomeType),
+ VE = ST.value_end(SomeType); VI != VE; ++VI )
+ VI->first // This is the name of the Value
+ VI->second // This is the Value* value associated with the name
+ </pre></tt></td>
+ </tr>
+</table>
+<p>Using the recommended iterator names and idioms will help you avoid
+making mistakes. Of particular note, make sure that whenever you use
+value_begin(SomeType) that you always compare the resulting iterator
+with value_end(SomeType) not value_end(SomeOtherType) or else you
+will loop infinitely.</p>
+
+<dl>
+
+ <dt><tt>plane_iterator plane_begin()</tt>:</dt>
+ <dd>Get an iterator that starts at the beginning of the type planes.
+ The iterator will iterate over the Type/ValueMap pairs in the
+ type planes. </dd>
+
+ <dt><tt>plane_const_iterator plane_begin() const</tt>:</dt>
+ <dd>Get a const_iterator that starts at the beginning of the type
+ planes. The iterator will iterate over the Type/ValueMap pairs
+ in the type planes. </dd>
+
+ <dt><tt>plane_iterator plane_end()</tt>:</dt>
+ <dd>Get an iterator at the end of the type planes. This serves as
+ the marker for end of iteration over the type planes.</dd>
+
+ <dt><tt>plane_const_iterator plane_end() const</tt>:</dt>
+ <dd>Get a const_iterator at the end of the type planes. This serves as
+ the marker for end of iteration over the type planes.</dd>
+
+ <dt><tt>value_iterator value_begin(const Type *Typ)</tt>:</dt>
+ <dd>Get an iterator that starts at the beginning of a type plane.
+ The iterator will iterate over the name/value pairs in the type plane.
+ Note: The type plane must already exist before using this.</dd>
+
+ <dt><tt>value_const_iterator value_begin(const Type *Typ) const</tt>:</dt>
+ <dd>Get a const_iterator that starts at the beginning of a type plane.
+ The iterator will iterate over the name/value pairs in the type plane.
+ Note: The type plane must already exist before using this.</dd>
+
+ <dt><tt>value_iterator value_end(const Type *Typ)</tt>:</dt>
+ <dd>Get an iterator to the end of a type plane. This serves as the marker
+ for end of iteration of the type plane.
+ Note: The type plane must already exist before using this.</dd>
+
+ <dt><tt>value_const_iterator value_end(const Type *Typ) const</tt>:</dt>
+ <dd>Get a const_iterator to the end of a type plane. This serves as the
+ marker for end of iteration of the type plane.
+ Note: the type plane must already exist before using this.</dd>
+
+ <dt><tt>type_iterator type_begin()</tt>:</dt>
+ <dd>Get an iterator to the start of the name/Type map.</dd>
+
+ <dt><tt>type_const_iterator type_begin() cons</tt>:</dt>
+ <dd> Get a const_iterator to the start of the name/Type map.</dd>
+
+ <dt><tt>type_iterator type_end()</tt>:</dt>
+ <dd>Get an iterator to the end of the name/Type map. This serves as the
+ marker for end of iteration of the types.</dd>
+
+ <dt><tt>type_const_iterator type_end() const</tt>:</dt>
+ <dd>Get a const-iterator to the end of the name/Type map. This serves
+ as the marker for end of iteration of the types.</dd>
+
+ <dt><tt>plane_const_iterator find(const Type* Typ ) const</tt>:</dt>
+ <dd>This method returns a plane_const_iterator for iteration over
+ the type planes starting at a specific plane, given by \p Ty.</dd>
+
+ <dt><tt>plane_iterator find( const Type* Typ </tt>:</dt>
+ <dd>This method returns a plane_iterator for iteration over the
+ type planes starting at a specific plane, given by \p Ty.</dd>
+
+ <dt><tt>const ValueMap* findPlane( const Type* Typ ) cons</tt>:</dt>
+ <dd>This method returns a ValueMap* for a specific type plane. This
+ interface is deprecated and may go away in the future.</dd>
+</dl>
+</div>
+
<!-- *********************************************************************** -->
<hr>
<address>
</body>
</html>
+<!-- vim: sw=2 noai
+-->
projects / oota-llvm.git / blobdiff