RubyGems - redsnow - Versions diffs - 0.3.1 → 0.3.2 - Mend

redsnow 0.3.1 → 0.3.2

Files changed (583) hide show

@@ -0,0 +1,135 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Module: RedSnow::Binding
+    &mdash; Documentation by YARD 0.8.7.4
+</title>
+  <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '../';
+  framesUrl = "../frames.html#!RedSnow/Binding.html";
+</script>
+  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+    <a href="../_index.html">Index (B)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../RedSnow.html" title="RedSnow (module)">RedSnow</a></span></span>
+     &raquo;
+    <span class="title">Binding</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+      Class List
+    </a>
+    <a class="full_list_link" id="method_list_link"
+        href="../method_list.html">
+      Method List
+    </a>
+    <a class="full_list_link" id="file_list_link"
+        href="../file_list.html">
+      File List
+    </a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Module: RedSnow::Binding
+</h1>
+<dl class="box">
+      <dt class="r1">Extended by:</dt>
+      <dd class="r1">FFI::Library</dd>
+    <dt class="r2">Included in:</dt>
+    <dd class="r2"><span class='object_link'><a href="../RedSnow.html" title="RedSnow (module)">RedSnow</a></span></dd>
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/redsnow/binding.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+<p>C-binding with Snow Crash Library using <a
+href="https://github.com/ffi/ffi">FFI</a></p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+      <li><a href="https://github.com/apiaryio/snowcrash/blob/master/src/csnowcrash.cc" target="_parent" title="https://github.com/apiaryio/snowcrash/blob/master/src/csnowcrash.cc">https://github.com/apiaryio/snowcrash/blob/master/src/csnowcrash.cc</a></li>
+      <li><a href="https://github.com/apiaryio/snowcrash/blob/master/src/CBlueprint.cc" target="_parent" title="https://github.com/apiaryio/snowcrash/blob/master/src/CBlueprint.cc">https://github.com/apiaryio/snowcrash/blob/master/src/CBlueprint.cc</a></li>
+  </ul>
+</div>
+</div>
+    <div id="footer">
+  Generated on Wed Jul 23 10:49:32 2014 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.4 (ruby-2.1.1).
+</div>
+  </body>
+</html>

data/doc/RedSnow/Blueprint.html ADDED

@@ -0,0 +1,657 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Class: RedSnow::Blueprint
+    &mdash; Documentation by YARD 0.8.7.4
+</title>
+  <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '../';
+  framesUrl = "../frames.html#!RedSnow/Blueprint.html";
+</script>
+  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+    <a href="../_index.html">Index (B)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../RedSnow.html" title="RedSnow (module)">RedSnow</a></span></span>
+     &raquo;
+    <span class="title">Blueprint</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+      Class List
+    </a>
+    <a class="full_list_link" id="method_list_link"
+        href="../method_list.html">
+      Method List
+    </a>
+    <a class="full_list_link" id="file_list_link"
+        href="../file_list.html">
+      File List
+    </a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Class: RedSnow::Blueprint
+</h1>
+<dl class="box">
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName"><span class='object_link'><a href="NamedBlueprintNode.html" title="RedSnow::NamedBlueprintNode (class)">NamedBlueprintNode</a></span></span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next"><span class='object_link'><a href="BlueprintNode.html" title="RedSnow::BlueprintNode (class)">BlueprintNode</a></span></li>
+            <li class="next"><span class='object_link'><a href="NamedBlueprintNode.html" title="RedSnow::NamedBlueprintNode (class)">NamedBlueprintNode</a></span></li>
+            <li class="next">RedSnow::Blueprint</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      </dd>
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/redsnow/blueprint.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+<p>Top-level Blueprint AST node  represents &#39;blueprint section&#39;</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+  <h2>Constant Summary</h2>
+    <dl class="constants">
+        <dt id="VERSION_KEY-constant" class="">VERSION_KEY =
+          <div class="docstring">
+  <div class="discussion">
+<p>Version key</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+        </dt>
+        <dd><pre class="code"><span class='symbol'>:_version</span></pre></dd>
+        <dt id="SUPPORTED_VERSIONS-constant" class="">SUPPORTED_VERSIONS =
+          <div class="docstring">
+  <div class="discussion">
+<p>Supported version of Api Blueprint</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+        </dt>
+        <dd><pre class="code"><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>2.0</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span></pre></dd>
+    </dl>
+  <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
+  <ul class="summary">
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#description-instance_method" title="#description (instance method)">- (String) <strong>description</strong> </a>
+  </span>
+    <span class="note title not_defined_here">
+      inherited
+      from <span class='object_link'><a href="NamedBlueprintNode.html#description-instance_method" title="RedSnow::NamedBlueprintNode#description (method)">NamedBlueprintNode</a></span>
+    </span>
+    <span class="summary_desc"><div class='inline'>
+<p>description of the node.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#metadata-instance_method" title="#metadata (instance method)">- (Metadata) <strong>metadata</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>tool-specific metadata collection or nil.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#name-instance_method" title="#name (instance method)">- (String) <strong>name</strong> </a>
+  </span>
+    <span class="note title not_defined_here">
+      inherited
+      from <span class='object_link'><a href="NamedBlueprintNode.html#name-instance_method" title="RedSnow::NamedBlueprintNode#name (method)">NamedBlueprintNode</a></span>
+    </span>
+    <span class="summary_desc"><div class='inline'>
+<p>name of the node.</p>
+</div></span>
+</li>
+      <li class="public ">
+  <span class="summary_signature">
+      <a href="#resource_groups-instance_method" title="#resource_groups (instance method)">- (Array&lt;ResourceGroup&gt;) <strong>resource_groups</strong> </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>array of blueprint resource groups.</p>
+</div></span>
+</li>
+  </ul>
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (Blueprint) <strong>initialize</strong>(handle) </a>
+  </span>
+    <span class="note title constructor">constructor</span>
+    <span class="summary_desc"><div class='inline'>
+<p>A new instance of Blueprint.</p>
+</div></span>
+</li>
+    </ul>
+  <div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+    <div class="method_details first">
+  <h3 class="signature first" id="initialize-instance_method">
+    - (<tt><span class='object_link'><a href="" title="RedSnow::Blueprint (class)">Blueprint</a></span></tt>) <strong>initialize</strong>(handle)
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns a new instance of Blueprint</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>handle</span>
+        <span class='type'>(<tt>FFI:Pointer</tt>)</span>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+343
+344
+345
+346
+347
+348
+349
+350
+351
+352
+353
+354
+355
+356
+357
+358
+359
+360
+361
+362
+363</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/redsnow/blueprint.rb', line 343</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_handle'>handle</span><span class='rparen'>)</span>
+  <span class='comment'># BP name, desc
+</span>  <span class='ivar'>@name</span> <span class='op'>=</span> <span class='const'>RedSnow</span><span class='op'>::</span><span class='const'>Binding</span><span class='period'>.</span><span class='id identifier rubyid_sc_blueprint_name'>sc_blueprint_name</span><span class='lparen'>(</span><span class='id identifier rubyid_handle'>handle</span><span class='rparen'>)</span>
+  <span class='ivar'>@description</span> <span class='op'>=</span> <span class='const'>RedSnow</span><span class='op'>::</span><span class='const'>Binding</span><span class='period'>.</span><span class='id identifier rubyid_sc_blueprint_description'>sc_blueprint_description</span><span class='lparen'>(</span><span class='id identifier rubyid_handle'>handle</span><span class='rparen'>)</span>
+  <span class='comment'># BP metadata
+</span>  <span class='id identifier rubyid_sc_metadata_collection_handle'>sc_metadata_collection_handle</span> <span class='op'>=</span> <span class='const'>RedSnow</span><span class='op'>::</span><span class='const'>Binding</span><span class='period'>.</span><span class='id identifier rubyid_sc_metadata_collection_handle'>sc_metadata_collection_handle</span><span class='lparen'>(</span><span class='id identifier rubyid_handle'>handle</span><span class='rparen'>)</span>
+  <span class='ivar'>@metadata</span> <span class='op'>=</span> <span class='const'>Metadata</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_sc_metadata_collection_handle'>sc_metadata_collection_handle</span><span class='rparen'>)</span>
+  <span class='comment'># BP Resource Groups
+</span>  <span class='id identifier rubyid_sc_resource_groups_collection_handle'>sc_resource_groups_collection_handle</span> <span class='op'>=</span> <span class='const'>RedSnow</span><span class='op'>::</span><span class='const'>Binding</span><span class='period'>.</span><span class='id identifier rubyid_sc_resource_groups_collection_handle'>sc_resource_groups_collection_handle</span><span class='lparen'>(</span><span class='id identifier rubyid_handle'>handle</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_sc_resource_groups_collection_size'>sc_resource_groups_collection_size</span> <span class='op'>=</span> <span class='const'>RedSnow</span><span class='op'>::</span><span class='const'>Binding</span><span class='period'>.</span><span class='id identifier rubyid_sc_resource_groups_collection_size'>sc_resource_groups_collection_size</span><span class='lparen'>(</span><span class='id identifier rubyid_sc_resource_groups_collection_handle'>sc_resource_groups_collection_handle</span><span class='rparen'>)</span>
+  <span class='ivar'>@resource_groups</span> <span class='op'>=</span> <span class='const'>Array</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
+  <span class='kw'>if</span> <span class='id identifier rubyid_sc_resource_groups_collection_size'>sc_resource_groups_collection_size</span> <span class='op'>&gt;</span> <span class='int'>0</span>
+    <span class='id identifier rubyid_group_size'>group_size</span> <span class='op'>=</span> <span class='id identifier rubyid_sc_resource_groups_collection_size'>sc_resource_groups_collection_size</span> <span class='op'>-</span> <span class='int'>1</span>
+    <span class='kw'>for</span> <span class='id identifier rubyid_index'>index</span> <span class='kw'>in</span> <span class='int'>0</span><span class='op'>..</span><span class='id identifier rubyid_group_size'>group_size</span> <span class='kw'>do</span>
+      <span class='id identifier rubyid_sc_resource_groups_handle'>sc_resource_groups_handle</span> <span class='op'>=</span> <span class='const'>RedSnow</span><span class='op'>::</span><span class='const'>Binding</span><span class='period'>.</span><span class='id identifier rubyid_sc_resource_groups_handle'>sc_resource_groups_handle</span><span class='lparen'>(</span><span class='id identifier rubyid_sc_resource_groups_collection_handle'>sc_resource_groups_collection_handle</span><span class='comma'>,</span> <span class='id identifier rubyid_index'>index</span><span class='rparen'>)</span>
+      <span class='ivar'>@resource_groups</span> <span class='op'>&lt;&lt;</span> <span class='const'>ResourceGroup</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_sc_resource_groups_handle'>sc_resource_groups_handle</span><span class='rparen'>)</span>
+    <span class='kw'>end</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+</div>
+  <div id="instance_attr_details" class="attr_details">
+    <h2>Instance Attribute Details</h2>
+      <span id="description=-instance_method"></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="description-instance_method">
+    - (<tt>String</tt>) <strong>description</strong>
+    <span class="not_defined_here">
+      Originally defined in class
+        <span class='object_link'><a href="NamedBlueprintNode.html#description-instance_method" title="RedSnow::NamedBlueprintNode#description (method)">NamedBlueprintNode</a></span>
+    </span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>description of the node</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>the current value of description</p>
+</div>
+    </li>
+</ul>
+</div>
+</div>
+      <span id="metadata=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="metadata-instance_method">
+    - (<tt><span class='object_link'><a href="Metadata.html" title="RedSnow::Metadata (class)">Metadata</a></span></tt>) <strong>metadata</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>tool-specific metadata collection or nil</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt><span class='object_link'><a href="Metadata.html" title="RedSnow::Metadata (class)">Metadata</a></span></tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>the current value of metadata</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+334
+335
+336</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/redsnow/blueprint.rb', line 334</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_metadata'>metadata</span>
+  <span class='ivar'>@metadata</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <span id="name=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="name-instance_method">
+    - (<tt>String</tt>) <strong>name</strong>
+    <span class="not_defined_here">
+      Originally defined in class
+        <span class='object_link'><a href="NamedBlueprintNode.html#name-instance_method" title="RedSnow::NamedBlueprintNode#name (method)">NamedBlueprintNode</a></span>
+    </span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>name of the node</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>the current value of name</p>
+</div>
+    </li>
+</ul>
+</div>
+</div>
+      <span id="resource_groups=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="resource_groups-instance_method">
+    - (<tt>Array&lt;<span class='object_link'><a href="ResourceGroup.html" title="RedSnow::ResourceGroup (class)">ResourceGroup</a></span>&gt;</tt>) <strong>resource_groups</strong>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>array of blueprint resource groups</p>
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Array&lt;<span class='object_link'><a href="ResourceGroup.html" title="RedSnow::ResourceGroup (class)">ResourceGroup</a></span>&gt;</tt>)</span>
+        &mdash;
+        <div class='inline'>
+<p>the current value of resource_groups</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+334
+335
+336</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/redsnow/blueprint.rb', line 334</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_resource_groups'>resource_groups</span>
+  <span class='ivar'>@resource_groups</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Wed Jul 23 10:49:33 2014 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.4 (ruby-2.1.1).
+</div>
+  </body>
+</html>