<?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::Tabulate</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::Tabulate</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 ~T (<a href="Tabulate.html">Tabulate</a>) directive. This tabulates to a given position in the output using white-space. </p> </div> </div> <div id="method-list"> <h3 class="section-bar">Methods</h3> <div class="name-list"> <a href="#M000486">execute</a> </div> </div> </div> <!-- if includes --> <div id="section"> <!-- if method_list --> <div id="methods"> <h3 class="section-bar">Public Instance methods</h3> <div id="method-M000486" class="method-detail"> <a name="M000486"></a> <div class="method-heading"> <a href="#M000486" class="method-signature"> <span class="method-name">execute</span><span class="method-args">(state)</span> </a> </div> <div class="method-description"> <p> The output is spaced over to a given position, depending on where it already is and parameters given to this directive. </p> <pre> ~colnum,colinc:@T </pre> <p> with the following interpretations </p> <dl> <dt><tt>colnum</tt> (1)</dt><dd>column to move to, </dd> <dt><tt>colinc</tt> (1)</dt><dd>number of columns to space over by if already at or beyond <tt>colnum</tt>, </dd> <dt>@</dt><dd>performs relative tabulation. <tt>colnum</tt> is treated as the column to begin from (spacing over to it if necessary), and then moves over to a column that is the smallest multiple of <tt>colinc</tt>. </dd> </dl> <p> If output is already at or beyond <tt>colnum</tt>, then output is spaced over to column <em>colnum + k * colinc</em>, for the smallest <em>k</em> possible. An example of the @ modifiers effect is for the instance of the ~T directive ~3,8@T, which moves over three columns, and then to the first eight-sized tab-stop. </p> <p><a class="source-toggle" href="#" onclick="toggleCode('M000486-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000486-source"> <pre> <span class="ruby-comment cmt"># File lib/carat/lisp-format.rb, line 1368</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">execute</span>(<span class="ruby-identifier">state</span>) <span class="ruby-identifier">colnum</span> = <span class="ruby-identifier">param</span>(<span class="ruby-value">0</span>, <span class="ruby-identifier">state</span>, <span class="ruby-value">1</span>) <span class="ruby-identifier">colinc</span> = <span class="ruby-identifier">param</span>(<span class="ruby-value">1</span>, <span class="ruby-identifier">state</span>, <span class="ruby-value">1</span>) <span class="ruby-identifier">padchar</span> = <span class="ruby-value">?\s</span>.<span class="ruby-identifier">chr</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">at_mod?</span> <span class="ruby-identifier">state</span>.<span class="ruby-identifier">output</span>(<span class="ruby-identifier">padchar</span> <span class="ruby-operator">*</span> <span class="ruby-identifier">colnum</span>) <span class="ruby-identifier">state</span>.<span class="ruby-identifier">output</span>(<span class="ruby-identifier">padchar</span> <span class="ruby-operator">*</span> (<span class="ruby-identifier">colinc</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">state</span>.<span class="ruby-identifier">col</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">colinc</span>)) <span class="ruby-keyword kw">else</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">state</span>.<span class="ruby-identifier">col</span> <span class="ruby-operator"><</span> <span class="ruby-identifier">colnum</span> <span class="ruby-identifier">state</span>.<span class="ruby-identifier">output</span>(<span class="ruby-identifier">padchar</span> <span class="ruby-operator">*</span> (<span class="ruby-identifier">colnum</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">state</span>.<span class="ruby-identifier">col</span>)) <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">colinc</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span> <span class="ruby-identifier">k</span> = <span class="ruby-value">1</span> <span class="ruby-operator">+</span> (<span class="ruby-identifier">state</span>.<span class="ruby-identifier">col</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">colnum</span>) <span class="ruby-operator">/</span> <span class="ruby-identifier">colinc</span> <span class="ruby-identifier">state</span>.<span class="ruby-identifier">output</span>(<span class="ruby-identifier">padchar</span> <span class="ruby-operator">*</span> ((<span class="ruby-identifier">colnum</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">k</span> <span class="ruby-operator">*</span> <span class="ruby-identifier">colinc</span>) <span class="ruby-operator">-</span> <span class="ruby-identifier">state</span>.<span class="ruby-identifier">col</span>)) <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">end</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>