<!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 to the Rust file `/home/jule/.cargo/git/checkouts/glib-928cf7b282977403/be23d10/src/wrapper.rs`."> <meta name="keywords" content="rust, rustlang, rust-lang"> <title>wrapper.rs.html -- source</title> <link rel="stylesheet" type="text/css" href="../../normalize.css"> <link rel="stylesheet" type="text/css" href="../../rustdoc.css"> <link rel="stylesheet" type="text/css" href="../../main.css"> </head> <body class="rustdoc source"> <!--[if lte IE 8]> <div class="warning"> This old browser is unsupported and will most likely display funky things. </div> <![endif]--> <nav class="sidebar"> </nav> <nav class="sub"> <form class="search-form js-only"> <div class="search-container"> <input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"> </div> </form> </nav> <section id='main' class="content"><pre class="line-numbers"><span id="1"> 1</span> <span id="2"> 2</span> <span id="3"> 3</span> <span id="4"> 4</span> <span id="5"> 5</span> <span id="6"> 6</span> <span id="7"> 7</span> <span id="8"> 8</span> <span id="9"> 9</span> <span id="10"> 10</span> <span id="11"> 11</span> <span id="12"> 12</span> <span id="13"> 13</span> <span id="14"> 14</span> <span id="15"> 15</span> <span id="16"> 16</span> <span id="17"> 17</span> <span id="18"> 18</span> <span id="19"> 19</span> <span id="20"> 20</span> <span id="21"> 21</span> <span id="22"> 22</span> <span id="23"> 23</span> <span id="24"> 24</span> <span id="25"> 25</span> <span id="26"> 26</span> <span id="27"> 27</span> <span id="28"> 28</span> <span id="29"> 29</span> <span id="30"> 30</span> <span id="31"> 31</span> <span id="32"> 32</span> <span id="33"> 33</span> <span id="34"> 34</span> <span id="35"> 35</span> <span id="36"> 36</span> <span id="37"> 37</span> <span id="38"> 38</span> <span id="39"> 39</span> <span id="40"> 40</span> <span id="41"> 41</span> <span id="42"> 42</span> <span id="43"> 43</span> <span id="44"> 44</span> <span id="45"> 45</span> <span id="46"> 46</span> <span id="47"> 47</span> <span id="48"> 48</span> <span id="49"> 49</span> <span id="50"> 50</span> <span id="51"> 51</span> <span id="52"> 52</span> <span id="53"> 53</span> <span id="54"> 54</span> <span id="55"> 55</span> <span id="56"> 56</span> <span id="57"> 57</span> <span id="58"> 58</span> <span id="59"> 59</span> <span id="60"> 60</span> <span id="61"> 61</span> <span id="62"> 62</span> <span id="63"> 63</span> <span id="64"> 64</span> <span id="65"> 65</span> <span id="66"> 66</span> <span id="67"> 67</span> <span id="68"> 68</span> <span id="69"> 69</span> <span id="70"> 70</span> <span id="71"> 71</span> <span id="72"> 72</span> <span id="73"> 73</span> <span id="74"> 74</span> <span id="75"> 75</span> <span id="76"> 76</span> <span id="77"> 77</span> <span id="78"> 78</span> <span id="79"> 79</span> <span id="80"> 80</span> <span id="81"> 81</span> <span id="82"> 82</span> <span id="83"> 83</span> <span id="84"> 84</span> <span id="85"> 85</span> <span id="86"> 86</span> <span id="87"> 87</span> <span id="88"> 88</span> <span id="89"> 89</span> <span id="90"> 90</span> <span id="91"> 91</span> <span id="92"> 92</span> <span id="93"> 93</span> <span id="94"> 94</span> <span id="95"> 95</span> <span id="96"> 96</span> <span id="97"> 97</span> <span id="98"> 98</span> <span id="99"> 99</span> <span id="100">100</span> <span id="101">101</span> <span id="102">102</span> <span id="103">103</span> <span id="104">104</span> <span id="105">105</span> <span id="106">106</span> <span id="107">107</span> <span id="108">108</span> <span id="109">109</span> <span id="110">110</span> <span id="111">111</span> <span id="112">112</span> <span id="113">113</span> <span id="114">114</span> <span id="115">115</span> <span id="116">116</span> <span id="117">117</span> <span id="118">118</span> <span id="119">119</span> <span id="120">120</span> <span id="121">121</span> <span id="122">122</span> <span id="123">123</span> <span id="124">124</span> <span id="125">125</span> <span id="126">126</span> <span id="127">127</span> <span id="128">128</span> <span id="129">129</span> <span id="130">130</span> <span id="131">131</span> <span id="132">132</span> <span id="133">133</span> <span id="134">134</span> <span id="135">135</span> <span id="136">136</span> <span id="137">137</span> <span id="138">138</span> <span id="139">139</span> <span id="140">140</span> <span id="141">141</span> <span id="142">142</span> <span id="143">143</span> <span id="144">144</span> <span id="145">145</span> <span id="146">146</span> <span id="147">147</span> <span id="148">148</span> <span id="149">149</span> <span id="150">150</span> <span id="151">151</span> <span id="152">152</span> <span id="153">153</span> <span id="154">154</span> <span id="155">155</span> <span id="156">156</span> <span id="157">157</span> <span id="158">158</span> <span id="159">159</span> <span id="160">160</span> <span id="161">161</span> <span id="162">162</span> <span id="163">163</span> <span id="164">164</span> <span id="165">165</span> <span id="166">166</span> <span id="167">167</span> <span id="168">168</span> <span id="169">169</span> <span id="170">170</span> <span id="171">171</span> <span id="172">172</span> <span id="173">173</span> <span id="174">174</span> <span id="175">175</span> <span id="176">176</span> <span id="177">177</span> <span id="178">178</span> <span id="179">179</span> <span id="180">180</span> <span id="181">181</span> <span id="182">182</span> <span id="183">183</span> <span id="184">184</span> </pre><pre class="rust "> <span class="comment">// Copyright 2015-2016, The Gtk-rs Project Developers.</span> <span class="comment">// See the COPYRIGHT file at the top-level directory of this distribution.</span> <span class="comment">// Licensed under the MIT license, see the LICENSE file or <http://opensource.org/licenses/MIT></span> <span class="doccomment">//! `IMPL` The `glib_wrapper!` macro and miscellaneous wrapper traits.</span> <span class="doccomment">/// Defines a wrapper type and implements the appropriate traits.</span> <span class="doccomment">///</span> <span class="doccomment">/// The basic syntax is</span> <span class="doccomment">///</span> <span class="doccomment">/// ```ignore</span> <span class="doccomment">/// glib_wrapper! {</span> <span class="doccomment">/// /// Documentation</span> <span class="doccomment">/// pub struct $name($kind<$foreign>);</span> <span class="doccomment">///</span> <span class="doccomment">/// match fn {</span> <span class="doccomment">/// $fn_name => /* a closure-like expression */,</span> <span class="doccomment">/// ...</span> <span class="doccomment">/// }</span> <span class="doccomment">/// }</span> <span class="doccomment">/// ```</span> <span class="doccomment">///</span> <span class="doccomment">/// This creates a wrapper named `$name` around the foreign type `$foreign`</span> <span class="doccomment">/// of `$kind` (one of `Boxed`, `Shared`, `Object`) using expressions from the `match fn`</span> <span class="doccomment">/// block to implement type-specific low-level operations (the expression</span> <span class="doccomment">/// will be evaluated in `unsafe` context).</span> <span class="doccomment">///</span> <span class="doccomment">/// ### Boxed</span> <span class="doccomment">///</span> <span class="doccomment">/// Boxed records with single ownership.</span> <span class="doccomment">///</span> <span class="doccomment">/// ```ignore</span> <span class="doccomment">/// glib_wrapper! {</span> <span class="doccomment">/// /// Text buffer iterator</span> <span class="doccomment">/// pub struct TextIter(Boxed<ffi::GtkTextIter>);</span> <span class="doccomment">///</span> <span class="doccomment">/// match fn {</span> <span class="doccomment">/// copy => |ptr| ffi::gtk_text_iter_copy(ptr),</span> <span class="doccomment">/// free => |ptr| ffi::gtk_text_iter_free(ptr),</span> <span class="doccomment">/// }</span> <span class="doccomment">/// }</span> <span class="doccomment">/// ```</span> <span class="doccomment">///</span> <span class="doccomment">/// `copy`: `|*const $foreign| -> *mut $foreign` creates a copy of the value.</span> <span class="doccomment">///</span> <span class="doccomment">/// `free`: `|*mut $foreign|` frees the value.</span> <span class="doccomment">///</span> <span class="doccomment">/// ### Shared</span> <span class="doccomment">///</span> <span class="doccomment">/// Records with reference counted shared ownership.</span> <span class="doccomment">///</span> <span class="doccomment">/// ```ignore</span> <span class="doccomment">/// glib_wrapper! {</span> <span class="doccomment">/// /// Object holding timing information for a single frame.</span> <span class="doccomment">/// pub struct FrameTimings(Shared<ffi::GdkFrameTimings>);</span> <span class="doccomment">///</span> <span class="doccomment">/// match fn {</span> <span class="doccomment">/// ref => |ptr| ffi::gdk_frame_timings_ref(ptr),</span> <span class="doccomment">/// unref => |ptr| ffi::gdk_frame_timings_unref(ptr),</span> <span class="doccomment">/// }</span> <span class="doccomment">/// }</span> <span class="doccomment">/// ```</span> <span class="doccomment">///</span> <span class="doccomment">/// `ref`: `|*mut $foreign|` increases the refcount.</span> <span class="doccomment">///</span> <span class="doccomment">/// `unref`: `|*mut $foreign|` decreases the refcount.</span> <span class="doccomment">///</span> <span class="doccomment">/// ### Object</span> <span class="doccomment">///</span> <span class="doccomment">/// Objects -- classes and interfaces.</span> <span class="doccomment">///</span> <span class="doccomment">/// ```ignore</span> <span class="doccomment">/// glib_wrapper! {</span> <span class="doccomment">/// /// Object representing an input device.</span> <span class="doccomment">/// pub struct Device(Object<ffi::GdkDevice>);</span> <span class="doccomment">///</span> <span class="doccomment">/// match fn {</span> <span class="doccomment">/// get_type => || ffi::gdk_device_get_type(),</span> <span class="doccomment">/// }</span> <span class="doccomment">/// }</span> <span class="doccomment">/// ```</span> <span class="doccomment">///</span> <span class="doccomment">/// ```ignore</span> <span class="doccomment">/// glib_wrapper! {</span> <span class="doccomment">/// /// A container with just one child.</span> <span class="doccomment">/// pub struct Bin(Object<ffi::GtkBin>): Container, Widget, Buildable;</span> <span class="doccomment">///</span> <span class="doccomment">/// match fn {</span> <span class="doccomment">/// get_type => || ffi::gtk_bin_get_type(),</span> <span class="doccomment">/// }</span> <span class="doccomment">/// }</span> <span class="doccomment">/// ```</span> <span class="doccomment">///</span> <span class="doccomment">/// Implementing types from other crates requires specifying their FFI</span> <span class="doccomment">/// counterparts as well:</span> <span class="doccomment">///</span> <span class="doccomment">/// ```ignore</span> <span class="doccomment">/// glib_wrapper! {</span> <span class="doccomment">/// pub struct Application(Object<ffi::GtkApplication>): [</span> <span class="doccomment">/// gio::Application => gio_ffi::GApplication,</span> <span class="doccomment">/// gio::ActionGroup => gio_ffi::GActionGroup,</span> <span class="doccomment">/// gio::ActionMap => gio_ffi::GActionMap,</span> <span class="doccomment">/// ];</span> <span class="doccomment">///</span> <span class="doccomment">/// match fn {</span> <span class="doccomment">/// get_type => || ffi::gtk_application_get_type(),</span> <span class="doccomment">/// }</span> <span class="doccomment">/// }</span> <span class="doccomment">/// ```</span> <span class="doccomment">///</span> <span class="doccomment">/// `get_type: || -> GType` returns the type identifier of the class or interface.</span> <span class="attribute">#[<span class="ident">macro_export</span>]</span> <span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">glib_wrapper</span> { ( $(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>:<span class="ident">meta</span>]</span>)<span class="op">*</span> <span class="kw">pub</span> <span class="kw">struct</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span>(<span class="ident">Boxed</span><span class="op"><</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">ffi_name</span>:<span class="ident">path</span><span class="op">></span>); <span class="kw">match</span> <span class="kw">fn</span> { <span class="ident">copy</span> <span class="op">=></span> <span class="op">|</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">copy_arg</span>:<span class="ident">ident</span><span class="op">|</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">copy_expr</span>:<span class="ident">expr</span>, <span class="ident">free</span> <span class="op">=></span> <span class="op">|</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">free_arg</span>:<span class="ident">ident</span><span class="op">|</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">free_expr</span>:<span class="ident">expr</span>, } ) <span class="op">=></span> { <span class="macro">glib_boxed_wrapper</span><span class="macro">!</span>([$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>)<span class="kw-2">*</span>] <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ffi_name</span>, @<span class="ident">copy</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">copy_arg</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">copy_expr</span>, @<span class="ident">free</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">free_arg</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">free_expr</span>); }; ( $(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>:<span class="ident">meta</span>]</span>)<span class="op">*</span> <span class="kw">pub</span> <span class="kw">struct</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span>(<span class="ident">Shared</span><span class="op"><</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">ffi_name</span>:<span class="ident">path</span><span class="op">></span>); <span class="kw">match</span> <span class="kw">fn</span> { <span class="kw-2">ref</span> <span class="op">=></span> <span class="op">|</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">ref_arg</span>:<span class="ident">ident</span><span class="op">|</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ref_expr</span>:<span class="ident">expr</span>, <span class="ident">unref</span> <span class="op">=></span> <span class="op">|</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">unref_arg</span>:<span class="ident">ident</span><span class="op">|</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">unref_expr</span>:<span class="ident">expr</span>, } ) <span class="op">=></span> { <span class="macro">glib_shared_wrapper</span><span class="macro">!</span>([$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>)<span class="kw-2">*</span>] <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ffi_name</span>, @<span class="kw-2">ref</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ref_arg</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ref_expr</span>, @<span class="ident">unref</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">unref_arg</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">unref_expr</span>); }; ( $(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>:<span class="ident">meta</span>]</span>)<span class="op">*</span> <span class="kw">pub</span> <span class="kw">struct</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span>(<span class="ident">Object</span><span class="op"><</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">ffi_name</span>:<span class="ident">path</span><span class="op">></span>); <span class="kw">match</span> <span class="kw">fn</span> { <span class="ident">get_type</span> <span class="op">=></span> <span class="op">||</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">get_type_expr</span>:<span class="ident">expr</span>, } ) <span class="op">=></span> { <span class="macro">glib_object_wrapper</span><span class="macro">!</span>([$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>)<span class="kw-2">*</span>] <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ffi_name</span>, @<span class="ident">get_type</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">get_type_expr</span>, []); }; ( $(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>:<span class="ident">meta</span>]</span>)<span class="op">*</span> <span class="kw">pub</span> <span class="kw">struct</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span>(<span class="ident">Object</span><span class="op"><</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">ffi_name</span>:<span class="ident">path</span><span class="op">></span>): [$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">implements</span>:<span class="ident">tt</span>)<span class="op">+</span>]; <span class="kw">match</span> <span class="kw">fn</span> { <span class="ident">get_type</span> <span class="op">=></span> <span class="op">||</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">get_type_expr</span>:<span class="ident">expr</span>, } ) <span class="op">=></span> { <span class="macro">glib_object_wrapper</span><span class="macro">!</span>([$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>)<span class="kw-2">*</span>] <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ffi_name</span>, @<span class="ident">get_type</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">get_type_expr</span>, @<span class="ident">implements</span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">implements</span>)<span class="op">+</span>); }; ( $(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>:<span class="ident">meta</span>]</span>)<span class="op">*</span> <span class="kw">pub</span> <span class="kw">struct</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span>(<span class="ident">Object</span><span class="op"><</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">ffi_name</span>:<span class="ident">path</span><span class="op">></span>): $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">implements</span>:<span class="ident">path</span>),<span class="op">+</span>; <span class="kw">match</span> <span class="kw">fn</span> { <span class="ident">get_type</span> <span class="op">=></span> <span class="op">||</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">get_type_expr</span>:<span class="ident">expr</span>, } ) <span class="op">=></span> { <span class="macro">glib_object_wrapper</span><span class="macro">!</span>([$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>)<span class="kw-2">*</span>] <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">ffi_name</span>, @<span class="ident">get_type</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">get_type_expr</span>, [$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">implements</span>),<span class="op">+</span>]); }; } <span class="doccomment">/// A wrapper struct.</span> <span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">Wrapper</span> { <span class="doccomment">/// Foreign type represented by the struct.</span> <span class="kw">type</span> <span class="ident">GlibType</span>: <span class="lifetime">'static</span>; } <span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">UnsafeFrom</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> { <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">t</span>: <span class="ident">T</span>) <span class="op">-></span> <span class="self">Self</span>; } </pre> </section> <section id='search' class="content hidden"></section> <section class="footer"></section> <aside id="help" class="hidden"> <div> <h1 class="hidden">Help</h1> <div class="shortcuts"> <h2>Keyboard Shortcuts</h2> <dl> <dt>?</dt> <dd>Show this help dialog</dd> <dt>S</dt> <dd>Focus the search field</dd> <dt>⇤</dt> <dd>Move up in search results</dd> <dt>⇥</dt> <dd>Move down in search results</dd> <dt>⏎</dt> <dd>Go to active search result</dd> <dt>+</dt> <dd>Collapse/expand all sections</dd> </dl> </div> <div class="infos"> <h2>Search Tricks</h2> <p> Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type. </p> <p> Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>. </p> <p> Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>) </p> </div> </div> </aside> <script> window.rootPath = "../../"; window.currentCrate = "glib"; </script> <script src="../../main.js"></script> <script defer src="../../search-index.js"></script> </body> </html>