File: C:/Ruby27-x64/share/doc/ruby/html/Fiddle/CUnionEntity.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Fiddle::CUnionEntity - 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="CStructEntity.html">Fiddle::CStructEntity</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 ><a href="#method-c-size">::size</a>
<li ><a href="#method-i-set_ctypes">#set_ctypes</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Fiddle::CUnionEntity">
<h1 id="class-Fiddle::CUnionEntity" class="class">
class Fiddle::CUnionEntity
</h1>
<section class="description">
<p>A C union 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 union 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 217</span>
<span class="ruby-keyword">def</span> <span class="ruby-constant">CUnionEntity</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">CUnionEntity</span>.<span class="ruby-identifier">size</span>(<span class="ruby-identifier">types</span>))
<span class="ruby-constant">CUnionEntity</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-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 size needed for the union with the given <code>types</code>.</p>
<pre class="ruby"><span class="ruby-constant">Fiddle</span><span class="ruby-operator">::</span><span class="ruby-constant">CUnionEntity</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">#=> 8</span>
</pre>
<div class="method-source-code" id="size-source">
<pre><span class="ruby-comment"># File ext/fiddle/lib/fiddle/struct.rb, line 229</span>
<span class="ruby-keyword">def</span> <span class="ruby-constant">CUnionEntity</span>.<span class="ruby-identifier ruby-title">size</span>(<span class="ruby-identifier">types</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-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">max</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-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>Calculate the necessary offset and for each union member with the given <code>types</code></p>
<div class="method-source-code" id="set_ctypes-source">
<pre><span class="ruby-comment"># File ext/fiddle/lib/fiddle/struct.rb, line 237</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-constant">Array</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">types</span>.<span class="ruby-identifier">length</span>, <span class="ruby-value">0</span>)
<span class="ruby-ivar">@size</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">size</span> <span class="ruby-identifier">types</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>