Add a declaration of environ global for Darwin
[oota-llvm.git] / docs / ExtendingLLVM.html
index 810b5a70648d40f68dbbfa11609d250bd82bf591..2e8982b8a50d5473789e15780383fbbf4f854c2e 100644 (file)
@@ -215,7 +215,56 @@ installations.</span> Only add new types if it is absolutely necessary.</p>
 
 <div class="doc_text">
 
-<p>TODO</p>
+<ol>
+<li><tt>llvm/include/llvm/Type.def</tt>:
+    add enum for the type</li>
+
+<li><tt>llvm/include/llvm/Type.h</tt>:
+    add ID number for the new type; add a forward declaration of the type
+    also</li>
+
+<li><tt>llvm/include/llvm/DerivedType.h</tt>:
+    add new class to represent new class in the hierarchy; add forward 
+    declaration to the TypeMap value type</li>
+
+<li><tt>llvm/lib/VMCore/Type.cpp</tt>:
+    add support for derived type to: 
+<div class="doc_code">
+<pre>
+std::string getTypeDescription(const Type &amp;Ty,
+  std::vector&lt;const Type*&gt; &amp;TypeStack)
+bool TypesEqual(const Type *Ty, const Type *Ty2,
+  std::map&lt;const Type*, const Type*&gt; &amp; EqTypes)
+</pre>
+</div>
+    add necessary member functions for type, and factory methods</li>
+
+<li><tt>llvm/lib/AsmReader/Lexer.l</tt>:
+    add ability to parse in the type from text assembly</li>
+
+<li><tt>llvm/lib/ByteCode/Writer/Writer.cpp</tt>:
+    modify <tt>void BytecodeWriter::outputType(const Type *T)</tt> to serialize
+    your type</li>
+
+<li><tt>llvm/lib/ByteCode/Reader/Reader.cpp</tt>:
+    modify <tt>const Type *BytecodeReader::ParseType()</tt> to read your data
+    type</li> 
+
+<li><tt>llvm/lib/VMCore/AsmWriter.cpp</tt>:
+    modify
+<div class="doc_code">
+<pre>
+void calcTypeName(const Type *Ty,
+                  std::vector&lt;const Type*&gt; &amp;TypeStack,
+                  std::map&lt;const Type*,std::string&gt; &amp;TypeNames,
+                  std::string &amp; Result)
+</pre>
+</div>
+    to output the new derived type
+</li>  
+
+</ol>
 
 </div>