Skip to content

Commit ec0c26f

Browse files
harlanhaskinsharlanhaskins
committed
Updated docs for new README
1 parent 34c98fa commit ec0c26f

File tree

142 files changed

+1124
-14
lines changed

Some content is hidden

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

142 files changed

+1124
-14
lines changed

‎docs/Classes.html

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,9 @@
4444
<li class="nav-group-task">
4545
<a href="Classes/JIT.html">JIT</a>
4646
</li>
47+
<li class="nav-group-task">
48+
<a href="Classes/MemoryBuffer.html">MemoryBuffer</a>
49+
</li>
4750
<li class="nav-group-task">
4851
<a href="Classes/Module.html">Module</a>
4952
</li>
@@ -94,6 +97,9 @@
9497
<li class="nav-group-task">
9598
<a href="Enums/Linkage.html">Linkage</a>
9699
</li>
100+
<li class="nav-group-task">
101+
<a href="Enums/MemoryBufferError.html">MemoryBufferError</a>
102+
</li>
97103
<li class="nav-group-task">
98104
<a href="Enums/ModuleError.html">ModuleError</a>
99105
</li>
@@ -412,6 +418,47 @@ <h4>Declaration</h4>
412418
</li>
413419
</ul>
414420
</div>
421+
<div class="task-group">
422+
<ul>
423+
<li class="item">
424+
<div>
425+
<code>
426+
<a name="/s:C4LLVM12MemoryBuffer"></a>
427+
<a name="//apple_ref/swift/Class/MemoryBuffer" class="dashAnchor"></a>
428+
<a class="token" href="#/s:C4LLVM12MemoryBuffer">MemoryBuffer</a>
429+
</code>
430+
</div>
431+
<div class="height-container">
432+
<div class="pointer-container"></div>
433+
<section class="section">
434+
<div class="pointer"></div>
435+
<div class="abstract">
436+
<p><code>MemoryBuffer</code> provides simple read-only access to a block of memory, and
437+
provides simple methods for reading files and standard input into a memory
438+
buffer. In addition to basic access to the characters in the file, this
439+
interface guarantees you can read one character past the end of the file,
440+
and that this character will read as &rsquo;\0&rsquo;.</p>
441+
442+
<p>The &rsquo;\0&rsquo; guarantee is needed to support an optimization &ndash; it&rsquo;s intended to
443+
be more efficient for clients which are reading all the data to stop
444+
reading when they encounter a &rsquo;\0&rsquo; than to continually check the file
445+
position to see if it has reached the end of the file.</p>
446+
447+
<a href="Classes/MemoryBuffer.html" class="slightly-smaller">See more</a>
448+
</div>
449+
<div class="declaration">
450+
<h4>Declaration</h4>
451+
<div class="language">
452+
<p class="aside-title">Swift</p>
453+
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">MemoryBuffer</span><span class="p">:</span> <span class="kt">Sequence</span></code></pre>
454+
455+
</div>
456+
</div>
457+
</section>
458+
</div>
459+
</li>
460+
</ul>
461+
</div>
415462
<div class="task-group">
416463
<ul>
417464
<li class="item">

‎docs/Classes/Context.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,9 @@
4545
<li class="nav-group-task">
4646
<a href="../Classes/JIT.html">JIT</a>
4747
</li>
48+
<li class="nav-group-task">
49+
<a href="../Classes/MemoryBuffer.html">MemoryBuffer</a>
50+
</li>
4851
<li class="nav-group-task">
4952
<a href="../Classes/Module.html">Module</a>
5053
</li>
@@ -95,6 +98,9 @@
9598
<li class="nav-group-task">
9699
<a href="../Enums/Linkage.html">Linkage</a>
97100
</li>
101+
<li class="nav-group-task">
102+
<a href="../Enums/MemoryBufferError.html">MemoryBufferError</a>
103+
</li>
98104
<li class="nav-group-task">
99105
<a href="../Enums/ModuleError.html">ModuleError</a>
100106
</li>

‎docs/Classes/Function.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,9 @@
4545
<li class="nav-group-task">
4646
<a href="../Classes/JIT.html">JIT</a>
4747
</li>
48+
<li class="nav-group-task">
49+
<a href="../Classes/MemoryBuffer.html">MemoryBuffer</a>
50+
</li>
4851
<li class="nav-group-task">
4952
<a href="../Classes/Module.html">Module</a>
5053
</li>
@@ -95,6 +98,9 @@
9598
<li class="nav-group-task">
9699
<a href="../Enums/Linkage.html">Linkage</a>
97100
</li>
101+
<li class="nav-group-task">
102+
<a href="../Enums/MemoryBufferError.html">MemoryBufferError</a>
103+
</li>
98104
<li class="nav-group-task">
99105
<a href="../Enums/ModuleError.html">ModuleError</a>
100106
</li>

‎docs/Classes/FunctionPassManager.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,9 @@
4545
<li class="nav-group-task">
4646
<a href="../Classes/JIT.html">JIT</a>
4747
</li>
48+
<li class="nav-group-task">
49+
<a href="../Classes/MemoryBuffer.html">MemoryBuffer</a>
50+
</li>
4851
<li class="nav-group-task">
4952
<a href="../Classes/Module.html">Module</a>
5053
</li>
@@ -95,6 +98,9 @@
9598
<li class="nav-group-task">
9699
<a href="../Enums/Linkage.html">Linkage</a>
97100
</li>
101+
<li class="nav-group-task">
102+
<a href="../Enums/MemoryBufferError.html">MemoryBufferError</a>
103+
</li>
98104
<li class="nav-group-task">
99105
<a href="../Enums/ModuleError.html">ModuleError</a>
100106
</li>

‎docs/Classes/IRBuilder.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,9 @@
4545
<li class="nav-group-task">
4646
<a href="../Classes/JIT.html">JIT</a>
4747
</li>
48+
<li class="nav-group-task">
49+
<a href="../Classes/MemoryBuffer.html">MemoryBuffer</a>
50+
</li>
4851
<li class="nav-group-task">
4952
<a href="../Classes/Module.html">Module</a>
5053
</li>
@@ -95,6 +98,9 @@
9598
<li class="nav-group-task">
9699
<a href="../Enums/Linkage.html">Linkage</a>
97100
</li>
101+
<li class="nav-group-task">
102+
<a href="../Enums/MemoryBufferError.html">MemoryBufferError</a>
103+
</li>
98104
<li class="nav-group-task">
99105
<a href="../Enums/ModuleError.html">ModuleError</a>
100106
</li>

‎docs/Classes/JIT.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,9 @@
4545
<li class="nav-group-task">
4646
<a href="../Classes/JIT.html">JIT</a>
4747
</li>
48+
<li class="nav-group-task">
49+
<a href="../Classes/MemoryBuffer.html">MemoryBuffer</a>
50+
</li>
4851
<li class="nav-group-task">
4952
<a href="../Classes/Module.html">Module</a>
5053
</li>
@@ -95,6 +98,9 @@
9598
<li class="nav-group-task">
9699
<a href="../Enums/Linkage.html">Linkage</a>
97100
</li>
101+
<li class="nav-group-task">
102+
<a href="../Enums/MemoryBufferError.html">MemoryBufferError</a>
103+
</li>
98104
<li class="nav-group-task">
99105
<a href="../Enums/ModuleError.html">ModuleError</a>
100106
</li>

‎docs/Classes/MemoryBuffer.html

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,16 @@ <h1>MemoryBuffer</h1>
256256

257257
</div>
258258
</div>
259-
<p>A <code>MemoryBuffer</code> is used to efficiently handle large buffers of binary data.</p>
259+
<p><code>MemoryBuffer</code> provides simple read-only access to a block of memory, and
260+
provides simple methods for reading files and standard input into a memory
261+
buffer. In addition to basic access to the characters in the file, this
262+
interface guarantees you can read one character past the end of the file,
263+
and that this character will read as &rsquo;\0&rsquo;.</p>
264+
265+
<p>The &rsquo;\0&rsquo; guarantee is needed to support an optimization &ndash; it&rsquo;s intended to
266+
be more efficient for clients which are reading all the data to stop
267+
reading when they encounter a &rsquo;\0&rsquo; than to continually check the file
268+
position to see if it has reached the end of the file.</p>
260269

261270
</section>
262271
<section class="section task-group-section">
@@ -313,8 +322,8 @@ <h4>Declaration</h4>
313322
<div class="language">
314323
<p class="aside-title">Swift</p>
315324
<pre class="highlight"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">buffer</span><span class="p">:</span> <span class="kt">UnsafeBufferPointer</span><span class="o">&lt;</span><span class="kt">Int8</span><span class="o">&gt;</span><span class="p">,</span>
316-
<span class="nv">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span>
317-
<span class="nv">requiresNullTerminator</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">false</span><span class="p">)</span></code></pre>
325+
<span class="nv">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span>
326+
<span class="nv">requiresNullTerminator</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">false</span><span class="p">)</span></code></pre>
318327

319328
</div>
320329
</div>
@@ -389,7 +398,7 @@ <h4>Declaration</h4>
389398
<div class="language">
390399
<p class="aside-title">Swift</p>
391400
<pre class="highlight"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="n">copyingBuffer</span> <span class="nv">buffer</span><span class="p">:</span> <span class="kt">UnsafeBufferPointer</span><span class="o">&lt;</span><span class="kt">Int8</span><span class="o">&gt;</span><span class="p">,</span>
392-
<span class="nv">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>
401+
<span class="nv">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>
393402

394403
</div>
395404
</div>

‎docs/Classes/Module.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,9 @@
4545
<li class="nav-group-task">
4646
<a href="../Classes/JIT.html">JIT</a>
4747
</li>
48+
<li class="nav-group-task">
49+
<a href="../Classes/MemoryBuffer.html">MemoryBuffer</a>
50+
</li>
4851
<li class="nav-group-task">
4952
<a href="../Classes/Module.html">Module</a>
5053
</li>
@@ -95,6 +98,9 @@
9598
<li class="nav-group-task">
9699
<a href="../Enums/Linkage.html">Linkage</a>
97100
</li>
101+
<li class="nav-group-task">
102+
<a href="../Enums/MemoryBufferError.html">MemoryBufferError</a>
103+
</li>
98104
<li class="nav-group-task">
99105
<a href="../Enums/ModuleError.html">ModuleError</a>
100106
</li>

‎docs/Classes/Target.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,9 @@
4545
<li class="nav-group-task">
4646
<a href="../Classes/JIT.html">JIT</a>
4747
</li>
48+
<li class="nav-group-task">
49+
<a href="../Classes/MemoryBuffer.html">MemoryBuffer</a>
50+
</li>
4851
<li class="nav-group-task">
4952
<a href="../Classes/Module.html">Module</a>
5053
</li>
@@ -95,6 +98,9 @@
9598
<li class="nav-group-task">
9699
<a href="../Enums/Linkage.html">Linkage</a>
97100
</li>
101+
<li class="nav-group-task">
102+
<a href="../Enums/MemoryBufferError.html">MemoryBufferError</a>
103+
</li>
98104
<li class="nav-group-task">
99105
<a href="../Enums/ModuleError.html">ModuleError</a>
100106
</li>

‎docs/Classes/TargetData.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,9 @@
4545
<li class="nav-group-task">
4646
<a href="../Classes/JIT.html">JIT</a>
4747
</li>
48+
<li class="nav-group-task">
49+
<a href="../Classes/MemoryBuffer.html">MemoryBuffer</a>
50+
</li>
4851
<li class="nav-group-task">
4952
<a href="../Classes/Module.html">Module</a>
5053
</li>
@@ -95,6 +98,9 @@
9598
<li class="nav-group-task">
9699
<a href="../Enums/Linkage.html">Linkage</a>
97100
</li>
101+
<li class="nav-group-task">
102+
<a href="../Enums/MemoryBufferError.html">MemoryBufferError</a>
103+
</li>
98104
<li class="nav-group-task">
99105
<a href="../Enums/ModuleError.html">ModuleError</a>
100106
</li>

‎docs/Classes/TargetMachine.html

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,9 @@
4545
<li class="nav-group-task">
4646
<a href="../Classes/JIT.html">JIT</a>
4747
</li>
48+
<li class="nav-group-task">
49+
<a href="../Classes/MemoryBuffer.html">MemoryBuffer</a>
50+
</li>
4851
<li class="nav-group-task">
4952
<a href="../Classes/Module.html">Module</a>
5053
</li>
@@ -95,6 +98,9 @@
9598
<li class="nav-group-task">
9699
<a href="../Enums/Linkage.html">Linkage</a>
97100
</li>
101+
<li class="nav-group-task">
102+
<a href="../Enums/MemoryBufferError.html">MemoryBufferError</a>
103+
</li>
98104
<li class="nav-group-task">
99105
<a href="../Enums/ModuleError.html">ModuleError</a>
100106
</li>
@@ -540,6 +546,71 @@ <h4>Parameters</h4>
540546
</section>
541547
</div>
542548
</li>
549+
<li class="item">
550+
<div>
551+
<code>
552+
<a name="/s:FC4LLVM13TargetMachine18emitToMemoryBufferFzT6moduleCS_6Module4typeOS_15CodegenFileType_CS_12MemoryBuffer"></a>
553+
<a name="//apple_ref/swift/Method/emitToMemoryBuffer(module:type:)" class="dashAnchor"></a>
554+
<a class="token" href="#/s:FC4LLVM13TargetMachine18emitToMemoryBufferFzT6moduleCS_6Module4typeOS_15CodegenFileType_CS_12MemoryBuffer">emitToMemoryBuffer(module:type:)</a>
555+
</code>
556+
</div>
557+
<div class="height-container">
558+
<div class="pointer-container"></div>
559+
<section class="section">
560+
<div class="pointer"></div>
561+
<div class="abstract">
562+
<p>Emits an LLVM Bitcode, ASM, or object file for the given module to a new
563+
<code><a href="../Classes/MemoryBuffer.html">MemoryBuffer</a></code> containing the contents.</p>
564+
565+
<p>Failure during any part of the compilation process or the process of
566+
writing the results to disk will result in a <code><a href="../Enums/TargetMachineError.html">TargetMachineError</a></code> being
567+
thrown describing the error in detail.</p>
568+
569+
</div>
570+
<div class="declaration">
571+
<h4>Declaration</h4>
572+
<div class="language">
573+
<p class="aside-title">Swift</p>
574+
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">emitToMemoryBuffer</span><span class="p">(</span><span class="nv">module</span><span class="p">:</span> <span class="kt"><a href="../Classes/Module.html">Module</a></span><span class="p">,</span> <span class="nv">type</span><span class="p">:</span> <span class="kt"><a href="../Enums/CodegenFileType.html">CodegenFileType</a></span><span class="p">)</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/MemoryBuffer.html">MemoryBuffer</a></span></code></pre>
575+
576+
</div>
577+
</div>
578+
<div>
579+
<h4>Parameters</h4>
580+
<table class="graybox">
581+
<tbody>
582+
<tr>
583+
<td>
584+
<code>
585+
<em>module</em>
586+
</code>
587+
</td>
588+
<td>
589+
<div>
590+
<p>The module whose contents will be codegened.</p>
591+
592+
</div>
593+
</td>
594+
</tr>
595+
<tr>
596+
<td>
597+
<code>
598+
<em>type</em>
599+
</code>
600+
</td>
601+
<td>
602+
<div>
603+
<p>The type of codegen to perform on the given module.</p>
604+
605+
</div>
606+
</td>
607+
</tr>
608+
</tbody>
609+
</table>
610+
</div>
611+
</section>
612+
</div>
613+
</li>
543614
</ul>
544615
</div>
545616
</section>

0 commit comments

Comments
 (0)