<?xml version="1.0" encoding="iso-8859-1"?> <!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> <title>Class: Lisp::Format::Directives::BeginConditional</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> <meta http-equiv="Content-Script-Type" content="text/javascript" /> <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" /> <script type="text/javascript"> // <![CDATA[ function popupCode( url ) { window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400") } function toggleCode( id ) { if ( document.getElementById ) elem = document.getElementById( id ); else if ( document.all ) elem = eval( "document.all." + id ); else return false; elemStyle = elem.style; if ( elemStyle.display != "block" ) { elemStyle.display = "block" } else { elemStyle.display = "none" } return true; } // Make codeblocks hidden by default document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" ) // ]]> </script> </head> <body> <div id="classHeader"> <table class="header-table"> <tr class="top-aligned-row"> <td><strong>Class</strong></td> <td class="class-name-in-header">Lisp::Format::Directives::BeginConditional</td> </tr> <tr class="top-aligned-row"> <td><strong>In:</strong></td> <td> <a href="../../../../files/lib/carat/lisp-format_rb.html"> lib/carat/lisp-format.rb </a> <br /> </td> </tr> <tr class="top-aligned-row"> <td><strong>Parent:</strong></td> <td> <a href="Directive.html"> Directive </a> </td> </tr> </table> </div> <!-- banner header --> <div id="bodyContent"> <div id="contextContent"> <div id="description"> <p> Represents the ~[ (Begin conditional expression) directive. This is useful to choose among a set of directives depending on arguments and numbers. </p> </div> </div> <div id="method-list"> <h3 class="section-bar">Methods</h3> <div class="name-list"> <a href="#M000491">connect</a> <a href="#M000490">execute</a> <a href="#M000489">new</a> </div> </div> </div> <!-- if includes --> <div id="section"> <!-- if method_list --> <div id="methods"> <h3 class="section-bar">Public Class methods</h3> <div id="method-M000489" class="method-detail"> <a name="M000489"></a> <div class="method-heading"> <a href="#M000489" class="method-signature"> <span class="method-name">new</span><span class="method-args">(*args)</span> </a> </div> <div class="method-description"> <p> Set up some variables and basically pass on to super. </p> <p><a class="source-toggle" href="#" onclick="toggleCode('M000489-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000489-source"> <pre> <span class="ruby-comment cmt"># File lib/carat/lisp-format.rb, line 1491</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>) <span class="ruby-keyword kw">super</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>) <span class="ruby-keyword kw">if</span> (<span class="ruby-identifier">colon_mod?</span> <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">at_mod?</span>) <span class="ruby-keyword kw">and</span> <span class="ruby-ivar">@params</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span> <span class="ruby-identifier">param_error</span> <span class="ruby-value">0</span>, <span class="ruby-value str">'no parameters allowed together with'</span> <span class="ruby-operator">+</span> <span class="ruby-value str">': and/or @ modifiers'</span> <span class="ruby-keyword kw">end</span> <span class="ruby-ivar">@clauses</span> = [] <span class="ruby-ivar">@default</span> = <span class="ruby-value">-1</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <h3 class="section-bar">Public Instance methods</h3> <div id="method-M000491" class="method-detail"> <a name="M000491"></a> <div class="method-heading"> <a href="#M000491" class="method-signature"> <span class="method-name">connect</span><span class="method-args">(directives)</span> </a> </div> <div class="method-description"> <p> Connect a set of directives to this conditional directive. A <a href="../SyntaxError.html">SyntaxError</a> is raised if multiple clauses have been marked as ‘default’, or if too many clauses have been specified for a given set of modifiers. </p> <p><a class="source-toggle" href="#" onclick="toggleCode('M000491-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000491-source"> <pre> <span class="ruby-comment cmt"># File lib/carat/lisp-format.rb, line 1553</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">connect</span>(<span class="ruby-identifier">directives</span>) <span class="ruby-ivar">@clauses</span> = [] <span class="ruby-identifier">clause</span> = [] <span class="ruby-identifier">directives</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">d</span><span class="ruby-operator">|</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">d</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">ClauseSeparator</span> <span class="ruby-ivar">@clauses</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">clause</span> <span class="ruby-identifier">clause</span> = [] <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">d</span>.<span class="ruby-identifier">colon_mod?</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@default</span> <span class="ruby-operator">==</span> <span class="ruby-value">-1</span> <span class="ruby-ivar">@default</span> = <span class="ruby-ivar">@clauses</span>.<span class="ruby-identifier">size</span> <span class="ruby-keyword kw">else</span> <span class="ruby-identifier">raise</span> <span class="ruby-constant">SyntaxError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">d</span>.<span class="ruby-identifier">pos</span>), <span class="ruby-value str">'default clause has already been set'</span> <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">d</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">EndConditional</span> <span class="ruby-ivar">@clauses</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">clause</span> <span class="ruby-keyword kw">break</span> <span class="ruby-keyword kw">else</span> <span class="ruby-identifier">clause</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">d</span> <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">end</span> <span class="ruby-identifier">must</span> = <span class="ruby-value str">'two'</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">colon_mod?</span> <span class="ruby-keyword kw">and</span> <span class="ruby-ivar">@clauses</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">!=</span> <span class="ruby-value">2</span> <span class="ruby-identifier">must</span> = <span class="ruby-value str">'one'</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">at_mod?</span> <span class="ruby-keyword kw">and</span> <span class="ruby-ivar">@clauses</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">!=</span> <span class="ruby-value">1</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">must</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-identifier">raise</span> <span class="ruby-constant">SyntaxError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@pos</span>), <span class="ruby-node">"must specify exactly #{must} clauses"</span> <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000490" class="method-detail"> <a name="M000490"></a> <div class="method-heading"> <a href="#M000490" class="method-signature"> <span class="method-name">execute</span><span class="method-args">(state)</span> </a> </div> <div class="method-description"> <p> Process one of the given clauses, depending on the numeric value of the given argument, or a specified parameter. The full form is </p> <pre> ~n[clause0~;clause1~:;clause2~] </pre> <p> or </p> <pre> ~:[clause0~;clause1~] </pre> <p> or </p> <pre> ~@[clause0~] </pre> <p> with the following interpretations </p> <dl> <dt><tt>n</tt> (nil)</dt><dd>if given, this value will be used to choose a clause instead of reading an arguments value. This is only useful if <tt>n</tt> is in fact the arguments left parameter (<tt>#</tt>). An error is raised if this argument does not respond_to? :to_int, </dd> <dt>:</dt><dd>instead of choosing a clause by number, the argument is tested as a boolean value, and if false, then first clause is executed, else the second one is, </dd> <dt>@</dt><dd>instead of choosing a clause by number, the argument is tested as a boolean value, and if true, the single clause is executed. </dd> </dl> <p><a class="source-toggle" href="#" onclick="toggleCode('M000490-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000490-source"> <pre> <span class="ruby-comment cmt"># File lib/carat/lisp-format.rb, line 1521</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">execute</span>(<span class="ruby-identifier">state</span>) <span class="ruby-identifier">test</span> = <span class="ruby-identifier">state</span>.<span class="ruby-identifier">next_arg</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">colon_mod?</span> <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">at_mod?</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">colon_mod?</span> <span class="ruby-identifier">c</span> = <span class="ruby-identifier">test</span> <span class="ruby-value">? </span><span class="ruby-value">1</span> <span class="ruby-operator">:</span> <span class="ruby-value">0</span> <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">at_mod?</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">test</span> <span class="ruby-identifier">state</span>.<span class="ruby-identifier">push_back_arg</span> <span class="ruby-identifier">c</span> = <span class="ruby-value">0</span> <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">else</span> <span class="ruby-identifier">n</span> = <span class="ruby-identifier">param</span>(<span class="ruby-value">0</span>, <span class="ruby-identifier">state</span>, <span class="ruby-keyword kw">nil</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">n</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-identifier">arg</span> = <span class="ruby-identifier">state</span>.<span class="ruby-identifier">next_arg</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">arg</span>.<span class="ruby-identifier">respond_to?</span> <span class="ruby-identifier">:to_int</span> <span class="ruby-identifier">n</span> = <span class="ruby-identifier">arg</span>.<span class="ruby-identifier">to_int</span> <span class="ruby-keyword kw">else</span> <span class="ruby-identifier">arg_error</span> <span class="ruby-value str">'argument is not an integral value'</span> <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">n</span> <span class="ruby-operator"><</span> <span class="ruby-ivar">@clauses</span>.<span class="ruby-identifier">size</span> <span class="ruby-identifier">c</span> = <span class="ruby-identifier">n</span> <span class="ruby-keyword kw">elsif</span> <span class="ruby-ivar">@default</span> <span class="ruby-operator">!=</span> <span class="ruby-value">-1</span> <span class="ruby-identifier">c</span> = <span class="ruby-ivar">@default</span> <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">end</span> <span class="ruby-constant">Format</span>.<span class="ruby-identifier">execute_directives</span>(<span class="ruby-identifier">state</span>, <span class="ruby-ivar">@clauses</span>[<span class="ruby-identifier">c</span>]) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">c</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> </div> </div> <div id="validator-badges"> <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p> </div> </body> </html>