aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/llvm_kaleidoscope_rs/llvm/basic_block.rs.html
blob: b8fcab4333cda9990fdcfc1b6603e448e039a462 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `src/llvm/basic_block.rs`."><title>basic_block.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-17e279919966e8e4.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="llvm_kaleidoscope_rs" data-themes="" data-resource-suffix="" data-rustdoc-version="1.75.0 (82e1608df 2023-12-21) (built from a source tarball)" data-channel="1.75.0" data-search-js="search-8fbf244ebcf71464.js" data-settings-js="settings-74424d7eec62a23e.js" ><script src="../../../static.files/storage-fec3eaa3851e447d.js"></script><script defer src="../../../static.files/src-script-3280b574d94e47b4.js"></script><script defer src="../../../src-files.js"></script><script defer src="../../../static.files/main-9dd44ab47b99a0fb.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-5d8b3c7633ad77ba.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"></nav><main><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><div data-nosnippet><pre class="src-line-numbers"><a href="#1" id="1">1</a>
<a href="#2" id="2">2</a>
<a href="#3" id="3">3</a>
<a href="#4" id="4">4</a>
<a href="#5" id="5">5</a>
<a href="#6" id="6">6</a>
<a href="#7" id="7">7</a>
<a href="#8" id="8">8</a>
<a href="#9" id="9">9</a>
<a href="#10" id="10">10</a>
<a href="#11" id="11">11</a>
<a href="#12" id="12">12</a>
<a href="#13" id="13">13</a>
<a href="#14" id="14">14</a>
<a href="#15" id="15">15</a>
<a href="#16" id="16">16</a>
<a href="#17" id="17">17</a>
<a href="#18" id="18">18</a>
<a href="#19" id="19">19</a>
<a href="#20" id="20">20</a>
<a href="#21" id="21">21</a>
<a href="#22" id="22">22</a>
<a href="#23" id="23">23</a>
<a href="#24" id="24">24</a>
<a href="#25" id="25">25</a>
<a href="#26" id="26">26</a>
<a href="#27" id="27">27</a>
<a href="#28" id="28">28</a>
<a href="#29" id="29">29</a>
<a href="#30" id="30">30</a>
<a href="#31" id="31">31</a>
<a href="#32" id="32">32</a>
<a href="#33" id="33">33</a>
<a href="#34" id="34">34</a>
<a href="#35" id="35">35</a>
<a href="#36" id="36">36</a>
<a href="#37" id="37">37</a>
<a href="#38" id="38">38</a>
<a href="#39" id="39">39</a>
</pre></div><pre class="rust"><code><span class="kw">use </span>llvm_sys::{core::LLVMGetBasicBlockParent, prelude::LLVMBasicBlockRef};

<span class="kw">use </span>std::marker::PhantomData;

<span class="kw">use </span><span class="kw">super</span>::FnValue;

<span class="doccomment">/// Wrapper for a LLVM Basic Block.
</span><span class="attr">#[derive(Copy, Clone)]
</span><span class="kw">pub struct </span>BasicBlock&lt;<span class="lifetime">&#39;llvm</span>&gt;(LLVMBasicBlockRef, PhantomData&lt;<span class="kw-2">&amp;</span><span class="lifetime">&#39;llvm </span>()&gt;);

<span class="kw">impl</span>&lt;<span class="lifetime">&#39;llvm</span>&gt; BasicBlock&lt;<span class="lifetime">&#39;llvm</span>&gt; {
    <span class="doccomment">/// Create a new BasicBlock instance.
    ///
    /// # Panics
    ///
    /// Panics if `bb_ref` is a null pointer.
    </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>new(bb_ref: LLVMBasicBlockRef) -&gt; BasicBlock&lt;<span class="lifetime">&#39;llvm</span>&gt; {
        <span class="macro">assert!</span>(!bb_ref.is_null());
        BasicBlock(bb_ref, PhantomData)
    }

    <span class="doccomment">/// Get the raw LLVM value reference.
    </span><span class="attr">#[inline]
    </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>bb_ref(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; LLVMBasicBlockRef {
        <span class="self">self</span>.<span class="number">0
    </span>}

    <span class="doccomment">/// Get the function to which the basic block belongs.
    ///
    /// # Panics
    ///
    /// Panics if LLVM API returns a `null` pointer.
    </span><span class="kw">pub fn </span>get_parent(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; FnValue&lt;<span class="lifetime">&#39;llvm</span>&gt; {
        <span class="kw">let </span>value_ref = <span class="kw">unsafe </span>{ LLVMGetBasicBlockParent(<span class="self">self</span>.bb_ref()) };
        <span class="macro">assert!</span>(!value_ref.is_null());

        FnValue::new(value_ref)
    }
}
</code></pre></div></section></main></body></html>