File: C:/Ruby27-x64/share/doc/ruby/html/Fiddle/CStructBuilder.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module Fiddle::CStructBuilder - 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="module">
<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">
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-create">::create</a>
<li ><a href="#method-i-create">#create</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-Fiddle::CStructBuilder">
<h1 id="module-Fiddle::CStructBuilder" class="module">
module Fiddle::CStructBuilder
</h1>
<section class="description">
<p>Used to construct C classes (<a href="CUnion.html"><code>CUnion</code></a>, <a href="CStruct.html"><code>CStruct</code></a>, etc)</p>
<p><a href="Importer.html#method-i-struct"><code>Fiddle::Importer#struct</code></a> and <a href="Importer.html#method-i-union"><code>Fiddle::Importer#union</code></a> wrap this functionality in an easy-to-use manner.</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-create" class="method-detail ">
<div class="method-heading">
<span class="method-name">create</span><span
class="method-args">(klass, types, members)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Construct a new class given a C:</p>
<ul><li>
<p>class <code>klass</code> (<a href="CUnion.html"><code>CUnion</code></a>, <a href="CStruct.html"><code>CStruct</code></a>, or other that provide an entity_class)</p>
</li><li>
<p><code>types</code> (Fiddle::TYPE_INT, Fiddle::TYPE_SIZE_T, etc., see the C types constants)</p>
</li><li>
<p>corresponding <code>members</code></p>
</li></ul>
<p><a href="Importer.html#method-i-struct"><code>Fiddle::Importer#struct</code></a> and <a href="Importer.html#method-i-union"><code>Fiddle::Importer#union</code></a> wrap this functionality in an easy-to-use manner.</p>
<p>Example:</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'fiddle/struct'</span>
<span class="ruby-identifier">require</span> <span class="ruby-string">'fiddle/cparser'</span>
<span class="ruby-identifier">include</span> <span class="ruby-constant">Fiddle</span><span class="ruby-operator">::</span><span class="ruby-constant">CParser</span>
<span class="ruby-identifier">types</span>, <span class="ruby-identifier">members</span> = <span class="ruby-identifier">parse_struct_signature</span>([<span class="ruby-string">'int i'</span>,<span class="ruby-string">'char c'</span>])
<span class="ruby-constant">MyStruct</span> = <span class="ruby-constant">Fiddle</span><span class="ruby-operator">::</span><span class="ruby-constant">CStructBuilder</span>.<span class="ruby-identifier">create</span>(<span class="ruby-constant">Fiddle</span><span class="ruby-operator">::</span><span class="ruby-constant">CUnion</span>, <span class="ruby-identifier">types</span>, <span class="ruby-identifier">members</span>)
<span class="ruby-identifier">obj</span> = <span class="ruby-constant">MyStruct</span>.<span class="ruby-identifier">allocate</span>
</pre>
<div class="method-source-code" id="create-source">
<pre><span class="ruby-comment"># File ext/fiddle/lib/fiddle/struct.rb, line 51</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create</span>(<span class="ruby-identifier">klass</span>, <span class="ruby-identifier">types</span>, <span class="ruby-identifier">members</span>)
<span class="ruby-identifier">new_class</span> = <span class="ruby-constant">Class</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">klass</span>){
<span class="ruby-identifier">define_method</span>(<span class="ruby-value">:initialize</span>){<span class="ruby-operator">|</span><span class="ruby-identifier">addr</span><span class="ruby-operator">|</span>
<span class="ruby-ivar">@entity</span> = <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">entity_class</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">addr</span>, <span class="ruby-identifier">types</span>)
<span class="ruby-ivar">@entity</span>.<span class="ruby-identifier">assign_names</span>(<span class="ruby-identifier">members</span>)
}
<span class="ruby-identifier">define_method</span>(<span class="ruby-value">:to_ptr</span>){ <span class="ruby-ivar">@entity</span> }
<span class="ruby-identifier">define_method</span>(<span class="ruby-value">:to_i</span>){ <span class="ruby-ivar">@entity</span>.<span class="ruby-identifier">to_i</span> }
<span class="ruby-identifier">members</span>.<span class="ruby-identifier">each</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">name</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">define_method</span>(<span class="ruby-identifier">name</span>){ <span class="ruby-ivar">@entity</span>[<span class="ruby-identifier">name</span>] }
<span class="ruby-identifier">define_method</span>(<span class="ruby-identifier">name</span> <span class="ruby-operator">+</span> <span class="ruby-string">"="</span>){<span class="ruby-operator">|</span><span class="ruby-identifier">val</span><span class="ruby-operator">|</span> <span class="ruby-ivar">@entity</span>[<span class="ruby-identifier">name</span>] = <span class="ruby-identifier">val</span> }
}
}
<span class="ruby-identifier">size</span> = <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">entity_class</span>.<span class="ruby-identifier">size</span>(<span class="ruby-identifier">types</span>)
<span class="ruby-identifier">new_class</span>.<span class="ruby-identifier">module_eval</span>(<span class="ruby-identifier"><<-EOS</span>, <span class="ruby-keyword">__FILE__</span>, <span class="ruby-keyword">__LINE__</span><span class="ruby-value">+1</span>)
<span class="ruby-value"> def new_class.size()
#{size}
end
def new_class.malloc()
addr = Fiddle.malloc(#{size})
new(addr)
end
</span><span class="ruby-identifier"> EOS</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">new_class</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="private-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Private Instance Methods</h3>
</header>
<div id="method-i-create" class="method-detail ">
<div class="method-heading">
<span class="method-name">create</span><span
class="method-args">(klass, types, members)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Construct a new class given a C:</p>
<ul><li>
<p>class <code>klass</code> (<a href="CUnion.html"><code>CUnion</code></a>, <a href="CStruct.html"><code>CStruct</code></a>, or other that provide an entity_class)</p>
</li><li>
<p><code>types</code> (Fiddle::TYPE_INT, Fiddle::TYPE_SIZE_T, etc., see the C types constants)</p>
</li><li>
<p>corresponding <code>members</code></p>
</li></ul>
<p><a href="Importer.html#method-i-struct"><code>Fiddle::Importer#struct</code></a> and <a href="Importer.html#method-i-union"><code>Fiddle::Importer#union</code></a> wrap this functionality in an easy-to-use manner.</p>
<p>Example:</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'fiddle/struct'</span>
<span class="ruby-identifier">require</span> <span class="ruby-string">'fiddle/cparser'</span>
<span class="ruby-identifier">include</span> <span class="ruby-constant">Fiddle</span><span class="ruby-operator">::</span><span class="ruby-constant">CParser</span>
<span class="ruby-identifier">types</span>, <span class="ruby-identifier">members</span> = <span class="ruby-identifier">parse_struct_signature</span>([<span class="ruby-string">'int i'</span>,<span class="ruby-string">'char c'</span>])
<span class="ruby-constant">MyStruct</span> = <span class="ruby-constant">Fiddle</span><span class="ruby-operator">::</span><span class="ruby-constant">CStructBuilder</span>.<span class="ruby-identifier">create</span>(<span class="ruby-constant">Fiddle</span><span class="ruby-operator">::</span><span class="ruby-constant">CUnion</span>, <span class="ruby-identifier">types</span>, <span class="ruby-identifier">members</span>)
<span class="ruby-identifier">obj</span> = <span class="ruby-constant">MyStruct</span>.<span class="ruby-identifier">allocate</span>
</pre>
<div class="method-source-code" id="create-source">
<pre><span class="ruby-comment"># File ext/fiddle/lib/fiddle/struct.rb, line 51</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create</span>(<span class="ruby-identifier">klass</span>, <span class="ruby-identifier">types</span>, <span class="ruby-identifier">members</span>)
<span class="ruby-identifier">new_class</span> = <span class="ruby-constant">Class</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">klass</span>){
<span class="ruby-identifier">define_method</span>(<span class="ruby-value">:initialize</span>){<span class="ruby-operator">|</span><span class="ruby-identifier">addr</span><span class="ruby-operator">|</span>
<span class="ruby-ivar">@entity</span> = <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">entity_class</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">addr</span>, <span class="ruby-identifier">types</span>)
<span class="ruby-ivar">@entity</span>.<span class="ruby-identifier">assign_names</span>(<span class="ruby-identifier">members</span>)
}
<span class="ruby-identifier">define_method</span>(<span class="ruby-value">:to_ptr</span>){ <span class="ruby-ivar">@entity</span> }
<span class="ruby-identifier">define_method</span>(<span class="ruby-value">:to_i</span>){ <span class="ruby-ivar">@entity</span>.<span class="ruby-identifier">to_i</span> }
<span class="ruby-identifier">members</span>.<span class="ruby-identifier">each</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">name</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">define_method</span>(<span class="ruby-identifier">name</span>){ <span class="ruby-ivar">@entity</span>[<span class="ruby-identifier">name</span>] }
<span class="ruby-identifier">define_method</span>(<span class="ruby-identifier">name</span> <span class="ruby-operator">+</span> <span class="ruby-string">"="</span>){<span class="ruby-operator">|</span><span class="ruby-identifier">val</span><span class="ruby-operator">|</span> <span class="ruby-ivar">@entity</span>[<span class="ruby-identifier">name</span>] = <span class="ruby-identifier">val</span> }
}
}
<span class="ruby-identifier">size</span> = <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">entity_class</span>.<span class="ruby-identifier">size</span>(<span class="ruby-identifier">types</span>)
<span class="ruby-identifier">new_class</span>.<span class="ruby-identifier">module_eval</span>(<span class="ruby-identifier"><<-EOS</span>, <span class="ruby-keyword">__FILE__</span>, <span class="ruby-keyword">__LINE__</span><span class="ruby-value">+1</span>)
<span class="ruby-value"> def new_class.size()
#{size}
end
def new_class.malloc()
addr = Fiddle.malloc(#{size})
new(addr)
end
</span><span class="ruby-identifier"> EOS</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">new_class</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>