Skip to content

Commit fdae6cd

Browse files
harlanhaskinsharlanhaskins
committed
Updated docs
1 parent f5c0e5f commit fdae6cd

File tree

152 files changed

+4884
-504
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

152 files changed

+4884
-504
lines changed

‎docs/Classes.html

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,9 @@
127127
<li class="nav-group-task">
128128
<a href="Enums/TargetMachineError.html">TargetMachineError</a>
129129
</li>
130+
<li class="nav-group-task">
131+
<a href="Enums/ThreadLocalModel.html">ThreadLocalModel</a>
132+
</li>
130133
<li class="nav-group-task">
131134
<a href="Enums.html#/s:O4LLVM8Unsigned">Unsigned</a>
132135
</li>
@@ -222,6 +225,9 @@
222225
<li class="nav-group-task">
223226
<a href="Structs/BasicBlock.html">BasicBlock</a>
224227
</li>
228+
<li class="nav-group-task">
229+
<a href="Structs/BasicBlock/Address.html">– Address</a>
230+
</li>
225231
<li class="nav-group-task">
226232
<a href="Structs/Constant.html">Constant</a>
227233
</li>
@@ -469,11 +475,11 @@ <h4>Declaration</h4>
469475
provides simple methods for reading files and standard input into a memory
470476
buffer. In addition to basic access to the characters in the file, this
471477
interface guarantees you can read one character past the end of the file,
472-
and that this character will read as &lsquo;\0&rsquo;.</p>
478+
and that this character will read as &rsquo;\0&rsquo;.</p>
473479

474-
<p>The &lsquo;\0&rsquo; guarantee is needed to support an optimization &ndash; it&rsquo;s intended to
480+
<p>The &rsquo;\0&rsquo; guarantee is needed to support an optimization &ndash; it&rsquo;s intended to
475481
be more efficient for clients which are reading all the data to stop
476-
reading when they encounter a &lsquo;\0&rsquo; than to continually check the file
482+
reading when they encounter a &rsquo;\0&rsquo; than to continually check the file
477483
position to see if it has reached the end of the file.</p>
478484

479485
<a href="Classes/MemoryBuffer.html" class="slightly-smaller">See more</a>
@@ -625,7 +631,7 @@ <h4>Declaration</h4>
625631
</section>
626632
</section>
627633
<section id="footer">
628-
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-01-27)</p>
634+
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-02-13)</p>
629635
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
630636
</section>
631637
</article>

‎docs/Classes/Context.html

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,9 @@
128128
<li class="nav-group-task">
129129
<a href="../Enums/TargetMachineError.html">TargetMachineError</a>
130130
</li>
131+
<li class="nav-group-task">
132+
<a href="../Enums/ThreadLocalModel.html">ThreadLocalModel</a>
133+
</li>
131134
<li class="nav-group-task">
132135
<a href="../Enums.html#/s:O4LLVM8Unsigned">Unsigned</a>
133136
</li>
@@ -223,6 +226,9 @@
223226
<li class="nav-group-task">
224227
<a href="../Structs/BasicBlock.html">BasicBlock</a>
225228
</li>
229+
<li class="nav-group-task">
230+
<a href="../Structs/BasicBlock/Address.html">– Address</a>
231+
</li>
226232
<li class="nav-group-task">
227233
<a href="../Structs/Constant.html">Constant</a>
228234
</li>
@@ -353,7 +359,7 @@ <h4>Declaration</h4>
353359
</section>
354360
</section>
355361
<section id="footer">
356-
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-01-27)</p>
362+
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-02-13)</p>
357363
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
358364
</section>
359365
</article>

‎docs/Classes/Function.html

Lines changed: 73 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,9 @@
128128
<li class="nav-group-task">
129129
<a href="../Enums/TargetMachineError.html">TargetMachineError</a>
130130
</li>
131+
<li class="nav-group-task">
132+
<a href="../Enums/ThreadLocalModel.html">ThreadLocalModel</a>
133+
</li>
131134
<li class="nav-group-task">
132135
<a href="../Enums.html#/s:O4LLVM8Unsigned">Unsigned</a>
133136
</li>
@@ -223,6 +226,9 @@
223226
<li class="nav-group-task">
224227
<a href="../Structs/BasicBlock.html">BasicBlock</a>
225228
</li>
229+
<li class="nav-group-task">
230+
<a href="../Structs/BasicBlock/Address.html">– Address</a>
231+
</li>
226232
<li class="nav-group-task">
227233
<a href="../Structs/Constant.html">Constant</a>
228234
</li>
@@ -443,6 +449,72 @@ <h4>Declaration</h4>
443449
</section>
444450
</div>
445451
</li>
452+
<li class="item">
453+
<div>
454+
<code>
455+
<a name="/s:FC4LLVM8Function7addressFT2ofVS_10BasicBlock_GSqVS1_7Address_"></a>
456+
<a name="//apple_ref/swift/Method/address(of:)" class="dashAnchor"></a>
457+
<a class="token" href="#/s:FC4LLVM8Function7addressFT2ofVS_10BasicBlock_GSqVS1_7Address_">address(of:)</a>
458+
</code>
459+
</div>
460+
<div class="height-container">
461+
<div class="pointer-container"></div>
462+
<section class="section">
463+
<div class="pointer"></div>
464+
<div class="abstract">
465+
<p>Computes the address of the specified basic block in this function.</p>
466+
467+
<p>Taking the address of the entry block is illegal.</p>
468+
469+
<p>This value only has defined behavior when used as an operand to the
470+
<code>indirectbr</code> instruction, or for comparisons against null. Pointer
471+
equality tests between labels addresses results in undefined behavior.
472+
Though, again, comparison against null is ok, and no label is equal to
473+
the null pointer. This may be passed around as an opaque pointer sized
474+
value as long as the bits are not inspected. This allows <code>ptrtoint</code> and
475+
arithmetic to be performed on these values so long as the original value
476+
is reconstituted before the indirectbr instruction.</p>
477+
478+
<p>Finally, some targets may provide defined semantics when using the value
479+
as the operand to an inline assembly, but that is target specific.</p>
480+
481+
</div>
482+
<div class="declaration">
483+
<h4>Declaration</h4>
484+
<div class="language">
485+
<p class="aside-title">Swift</p>
486+
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">address</span><span class="p">(</span><span class="n">of</span> <span class="nv">block</span><span class="p">:</span> <span class="kt"><a href="../Structs/BasicBlock.html">BasicBlock</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/BasicBlock.html">BasicBlock</a></span><span class="o">.</span><span class="kt">Address</span><span class="p">?</span></code></pre>
487+
488+
</div>
489+
</div>
490+
<div>
491+
<h4>Parameters</h4>
492+
<table class="graybox">
493+
<tbody>
494+
<tr>
495+
<td>
496+
<code>
497+
<em>block</em>
498+
</code>
499+
</td>
500+
<td>
501+
<div>
502+
<p>The basic block to compute the address of.</p>
503+
504+
</div>
505+
</td>
506+
</tr>
507+
</tbody>
508+
</table>
509+
</div>
510+
<div>
511+
<h4>Return Value</h4>
512+
<p>An IRValue representing the address of the given basic block in this function, else nil if the address cannot be computed or the basic block does not reside in this function.</p>
513+
514+
</div>
515+
</section>
516+
</div>
517+
</li>
446518
<li class="item">
447519
<div>
448520
<code>
@@ -752,7 +824,7 @@ <h4>Declaration</h4>
752824
</section>
753825
</section>
754826
<section id="footer">
755-
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-01-27)</p>
827+
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-02-13)</p>
756828
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
757829
</section>
758830
</article>

‎docs/Classes/FunctionPassManager.html

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,9 @@
128128
<li class="nav-group-task">
129129
<a href="../Enums/TargetMachineError.html">TargetMachineError</a>
130130
</li>
131+
<li class="nav-group-task">
132+
<a href="../Enums/ThreadLocalModel.html">ThreadLocalModel</a>
133+
</li>
131134
<li class="nav-group-task">
132135
<a href="../Enums.html#/s:O4LLVM8Unsigned">Unsigned</a>
133136
</li>
@@ -223,6 +226,9 @@
223226
<li class="nav-group-task">
224227
<a href="../Structs/BasicBlock.html">BasicBlock</a>
225228
</li>
229+
<li class="nav-group-task">
230+
<a href="../Structs/BasicBlock/Address.html">– Address</a>
231+
</li>
226232
<li class="nav-group-task">
227233
<a href="../Structs/Constant.html">Constant</a>
228234
</li>
@@ -422,7 +428,7 @@ <h4>Parameters</h4>
422428
</section>
423429
</section>
424430
<section id="footer">
425-
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-01-27)</p>
431+
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-02-13)</p>
426432
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
427433
</section>
428434
</article>

0 commit comments

Comments
 (0)