File: C:/Ruby27-x64/share/doc/ruby/html/Fiddle/CStructEntity.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Fiddle::CStructEntity - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="Pointer.html">Fiddle::Pointer</a>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-malloc">::malloc</a>
<li class="calls-super" ><a href="#method-c-new">::new</a>
<li ><a href="#method-c-size">::size</a>
<li class="calls-super" ><a href="#method-i-5B-5D">#[]</a>
<li class="calls-super" ><a href="#method-i-5B-5D-3D">#[]=</a>
<li ><a href="#method-i-assign_names">#assign_names</a>
<li ><a href="#method-i-set_ctypes">#set_ctypes</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Fiddle::CStructEntity">
<h1 id="class-Fiddle::CStructEntity" class="class">
class Fiddle::CStructEntity
</h1>
<section class="description">
<p>A C struct wrapper</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-malloc" class="method-detail ">
<div class="method-heading">
<span class="method-name">malloc</span><span
class="method-args">(types, func = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Allocates a C struct with the <code>types</code> provided.</p>
<p>When the instance is garbage collected, the C function <code>func</code> is called.</p>
<div class="method-source-code" id="malloc-source">
<pre><span class="ruby-comment"># File ext/fiddle/lib/fiddle/struct.rb, line 87</span>
<span class="ruby-keyword">def</span> <span class="ruby-constant">CStructEntity</span>.<span class="ruby-identifier ruby-title">malloc</span>(<span class="ruby-identifier">types</span>, <span class="ruby-identifier">func</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">addr</span> = <span class="ruby-constant">Fiddle</span>.<span class="ruby-identifier">malloc</span>(<span class="ruby-constant">CStructEntity</span>.<span class="ruby-identifier">size</span>(<span class="ruby-identifier">types</span>))
<span class="ruby-constant">CStructEntity</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">addr</span>, <span class="ruby-identifier">types</span>, <span class="ruby-identifier">func</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(addr, types, func = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Wraps the C pointer <code>addr</code> as a C struct with the given <code>types</code>.</p>
<p>When the instance is garbage collected, the C function <code>func</code> is called.</p>
<p>See also <a href="Pointer.html#method-c-new"><code>Fiddle::Pointer.new</code></a></p>
<div class="method-calls-super">
Calls superclass method
<a href="Pointer.html#method-c-new"><code>Fiddle::Pointer::new</code></a>
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File ext/fiddle/lib/fiddle/struct.rb, line 120</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">addr</span>, <span class="ruby-identifier">types</span>, <span class="ruby-identifier">func</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">set_ctypes</span>(<span class="ruby-identifier">types</span>)
<span class="ruby-keyword">super</span>(<span class="ruby-identifier">addr</span>, <span class="ruby-ivar">@size</span>, <span class="ruby-identifier">func</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-size" class="method-detail ">
<div class="method-heading">
<span class="method-name">size</span><span
class="method-args">(types)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the offset for the packed sizes for the given <code>types</code>.</p>
<pre class="ruby"><span class="ruby-constant">Fiddle</span><span class="ruby-operator">::</span><span class="ruby-constant">CStructEntity</span>.<span class="ruby-identifier">size</span>(
[ <span class="ruby-constant">Fiddle</span><span class="ruby-operator">::</span><span class="ruby-constant">TYPE_DOUBLE</span>,
<span class="ruby-constant">Fiddle</span><span class="ruby-operator">::</span><span class="ruby-constant">TYPE_INT</span>,
<span class="ruby-constant">Fiddle</span><span class="ruby-operator">::</span><span class="ruby-constant">TYPE_CHAR</span>,
<span class="ruby-constant">Fiddle</span><span class="ruby-operator">::</span><span class="ruby-constant">TYPE_VOIDP</span> ]) <span class="ruby-comment">#=> 24</span>
</pre>
<div class="method-source-code" id="size-source">
<pre><span class="ruby-comment"># File ext/fiddle/lib/fiddle/struct.rb, line 99</span>
<span class="ruby-keyword">def</span> <span class="ruby-constant">CStructEntity</span>.<span class="ruby-identifier ruby-title">size</span>(<span class="ruby-identifier">types</span>)
<span class="ruby-identifier">offset</span> = <span class="ruby-value">0</span>
<span class="ruby-identifier">max_align</span> = <span class="ruby-identifier">types</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">type</span>, <span class="ruby-identifier">count</span> = <span class="ruby-value">1</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">last_offset</span> = <span class="ruby-identifier">offset</span>
<span class="ruby-identifier">align</span> = <span class="ruby-constant">PackInfo</span><span class="ruby-operator">::</span><span class="ruby-constant">ALIGN_MAP</span>[<span class="ruby-identifier">type</span>]
<span class="ruby-identifier">offset</span> = <span class="ruby-constant">PackInfo</span>.<span class="ruby-identifier">align</span>(<span class="ruby-identifier">last_offset</span>, <span class="ruby-identifier">align</span>) <span class="ruby-operator">+</span>
(<span class="ruby-constant">PackInfo</span><span class="ruby-operator">::</span><span class="ruby-constant">SIZE_MAP</span>[<span class="ruby-identifier">type</span>] <span class="ruby-operator">*</span> <span class="ruby-identifier">count</span>)
<span class="ruby-identifier">align</span>
}.<span class="ruby-identifier">max</span>
<span class="ruby-constant">PackInfo</span>.<span class="ruby-identifier">align</span>(<span class="ruby-identifier">offset</span>, <span class="ruby-identifier">max_align</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-5B-5D" class="method-detail ">
<div class="method-heading">
<span class="method-name">[]</span><span
class="method-args">(name)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Fetch struct member <code>name</code></p>
<div class="method-calls-super">
Calls superclass method
<a href="Pointer.html#method-c-5B-5D"><code>Fiddle::Pointer::[]</code></a>
</div>
<div class="method-source-code" id="5B-5D-source">
<pre><span class="ruby-comment"># File ext/fiddle/lib/fiddle/struct.rb, line 152</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">[]</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-identifier">idx</span> = <span class="ruby-ivar">@members</span>.<span class="ruby-identifier">index</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-keyword">if</span>( <span class="ruby-identifier">idx</span>.<span class="ruby-identifier">nil?</span> )
<span class="ruby-identifier">raise</span>(<span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">"no such member: #{name}"</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">ty</span> = <span class="ruby-ivar">@ctypes</span>[<span class="ruby-identifier">idx</span>]
<span class="ruby-keyword">if</span>( <span class="ruby-identifier">ty</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Array</span>) )
<span class="ruby-identifier">r</span> = <span class="ruby-keyword">super</span>(<span class="ruby-ivar">@offset</span>[<span class="ruby-identifier">idx</span>], <span class="ruby-constant">SIZE_MAP</span>[<span class="ruby-identifier">ty</span>[<span class="ruby-value">0</span>]] <span class="ruby-operator">*</span> <span class="ruby-identifier">ty</span>[<span class="ruby-value">1</span>])
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">r</span> = <span class="ruby-keyword">super</span>(<span class="ruby-ivar">@offset</span>[<span class="ruby-identifier">idx</span>], <span class="ruby-constant">SIZE_MAP</span>[<span class="ruby-identifier">ty</span>.<span class="ruby-identifier">abs</span>])
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">packer</span> = <span class="ruby-constant">Packer</span>.<span class="ruby-identifier">new</span>([<span class="ruby-identifier">ty</span>])
<span class="ruby-identifier">val</span> = <span class="ruby-identifier">packer</span>.<span class="ruby-identifier">unpack</span>([<span class="ruby-identifier">r</span>])
<span class="ruby-keyword">case</span> <span class="ruby-identifier">ty</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">Array</span>
<span class="ruby-keyword">case</span> <span class="ruby-identifier">ty</span>[<span class="ruby-value">0</span>]
<span class="ruby-keyword">when</span> <span class="ruby-constant">TYPE_VOIDP</span>
<span class="ruby-identifier">val</span> = <span class="ruby-identifier">val</span>.<span class="ruby-identifier">collect</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-constant">Pointer</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">v</span>)}
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">TYPE_VOIDP</span>
<span class="ruby-identifier">val</span> = <span class="ruby-constant">Pointer</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">val</span>[<span class="ruby-value">0</span>])
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">val</span> = <span class="ruby-identifier">val</span>[<span class="ruby-value">0</span>]
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span>( <span class="ruby-identifier">ty</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Integer</span>) <span class="ruby-operator">&&</span> (<span class="ruby-identifier">ty</span> <span class="ruby-operator"><</span> <span class="ruby-value">0</span>) )
<span class="ruby-keyword">return</span> <span class="ruby-identifier">unsigned_value</span>(<span class="ruby-identifier">val</span>, <span class="ruby-identifier">ty</span>)
<span class="ruby-keyword">elsif</span>( <span class="ruby-identifier">ty</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Array</span>) <span class="ruby-operator">&&</span> (<span class="ruby-identifier">ty</span>[<span class="ruby-value">0</span>] <span class="ruby-operator"><</span> <span class="ruby-value">0</span>) )
<span class="ruby-keyword">return</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">collect</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">unsigned_value</span>(<span class="ruby-identifier">v</span>,<span class="ruby-identifier">ty</span>[<span class="ruby-value">0</span>])}
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">val</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-5B-5D-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">[]=</span><span
class="method-args">(name, val)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p><a href="../Set.html"><code>Set</code></a> struct member <code>name</code>, to value <code>val</code></p>
<div class="method-calls-super">
Calls superclass method
<a href="Pointer.html#method-i-5B-5D-3D"><code>Fiddle::Pointer#[]=</code></a>
</div>
<div class="method-source-code" id="5B-5D-3D-source">
<pre><span class="ruby-comment"># File ext/fiddle/lib/fiddle/struct.rb, line 186</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">[]=</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">val</span>)
<span class="ruby-identifier">idx</span> = <span class="ruby-ivar">@members</span>.<span class="ruby-identifier">index</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-keyword">if</span>( <span class="ruby-identifier">idx</span>.<span class="ruby-identifier">nil?</span> )
<span class="ruby-identifier">raise</span>(<span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">"no such member: #{name}"</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">ty</span> = <span class="ruby-ivar">@ctypes</span>[<span class="ruby-identifier">idx</span>]
<span class="ruby-identifier">packer</span> = <span class="ruby-constant">Packer</span>.<span class="ruby-identifier">new</span>([<span class="ruby-identifier">ty</span>])
<span class="ruby-identifier">val</span> = <span class="ruby-identifier">wrap_arg</span>(<span class="ruby-identifier">val</span>, <span class="ruby-identifier">ty</span>, [])
<span class="ruby-identifier">buff</span> = <span class="ruby-identifier">packer</span>.<span class="ruby-identifier">pack</span>([<span class="ruby-identifier">val</span>].<span class="ruby-identifier">flatten</span>())
<span class="ruby-keyword">super</span>(<span class="ruby-ivar">@offset</span>[<span class="ruby-identifier">idx</span>], <span class="ruby-identifier">buff</span>.<span class="ruby-identifier">size</span>, <span class="ruby-identifier">buff</span>)
<span class="ruby-keyword">if</span>( <span class="ruby-identifier">ty</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Integer</span>) <span class="ruby-operator">&&</span> (<span class="ruby-identifier">ty</span> <span class="ruby-operator"><</span> <span class="ruby-value">0</span>) )
<span class="ruby-keyword">return</span> <span class="ruby-identifier">unsigned_value</span>(<span class="ruby-identifier">val</span>, <span class="ruby-identifier">ty</span>)
<span class="ruby-keyword">elsif</span>( <span class="ruby-identifier">ty</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Array</span>) <span class="ruby-operator">&&</span> (<span class="ruby-identifier">ty</span>[<span class="ruby-value">0</span>] <span class="ruby-operator"><</span> <span class="ruby-value">0</span>) )
<span class="ruby-keyword">return</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">collect</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">unsigned_value</span>(<span class="ruby-identifier">v</span>,<span class="ruby-identifier">ty</span>[<span class="ruby-value">0</span>])}
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">val</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-assign_names" class="method-detail ">
<div class="method-heading">
<span class="method-name">assign_names</span><span
class="method-args">(members)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p><a href="../Set.html"><code>Set</code></a> the names of the <code>members</code> in this C struct</p>
<div class="method-source-code" id="assign_names-source">
<pre><span class="ruby-comment"># File ext/fiddle/lib/fiddle/struct.rb, line 126</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">assign_names</span>(<span class="ruby-identifier">members</span>)
<span class="ruby-ivar">@members</span> = <span class="ruby-identifier">members</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-set_ctypes" class="method-detail ">
<div class="method-heading">
<span class="method-name">set_ctypes</span><span
class="method-args">(types)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Calculates the offsets and sizes for the given <code>types</code> in the struct.</p>
<div class="method-source-code" id="set_ctypes-source">
<pre><span class="ruby-comment"># File ext/fiddle/lib/fiddle/struct.rb, line 131</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">set_ctypes</span>(<span class="ruby-identifier">types</span>)
<span class="ruby-ivar">@ctypes</span> = <span class="ruby-identifier">types</span>
<span class="ruby-ivar">@offset</span> = []
<span class="ruby-identifier">offset</span> = <span class="ruby-value">0</span>
<span class="ruby-identifier">max_align</span> = <span class="ruby-identifier">types</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">type</span>, <span class="ruby-identifier">count</span> = <span class="ruby-value">1</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">orig_offset</span> = <span class="ruby-identifier">offset</span>
<span class="ruby-identifier">align</span> = <span class="ruby-constant">ALIGN_MAP</span>[<span class="ruby-identifier">type</span>]
<span class="ruby-identifier">offset</span> = <span class="ruby-constant">PackInfo</span>.<span class="ruby-identifier">align</span>(<span class="ruby-identifier">orig_offset</span>, <span class="ruby-identifier">align</span>)
<span class="ruby-ivar">@offset</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">offset</span>
<span class="ruby-identifier">offset</span> <span class="ruby-operator">+=</span> (<span class="ruby-constant">SIZE_MAP</span>[<span class="ruby-identifier">type</span>] <span class="ruby-operator">*</span> <span class="ruby-identifier">count</span>)
<span class="ruby-identifier">align</span>
}.<span class="ruby-identifier">max</span>
<span class="ruby-ivar">@size</span> = <span class="ruby-constant">PackInfo</span>.<span class="ruby-identifier">align</span>(<span class="ruby-identifier">offset</span>, <span class="ruby-identifier">max_align</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>