<?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::Print</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::Print</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>
Super-class for ‘printing’ directives, namely ~A (<a
href="Ascii.html">Ascii</a>) and ~S (<a
href="SExpression.html">SExpression</a>). These directives print, in some
sense, their argument in a Ruby friendly manner. This means that their
argument is either converted to a string using Object#to_s or
Object#inspect.
</p>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000474">execute</a>
<a href="#M000473">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-M000473" class="method-detail">
<a name="M000473"></a>
<div class="method-heading">
<a href="#M000473" class="method-signature">
<span class="method-name">new</span><span class="method-args">(params, modifiers, top, pos, inspect = false)</span>
</a>
</div>
<div class="method-description">
<p>
All parameters except <tt>inspect</tt> are simply passed on to
Directive#initialize. If <tt>inspect</tt> is true, string arguments are
inspected as well as all other objects.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000473-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000473-source">
<pre>
<span class="ruby-comment cmt"># File lib/carat/lisp-format.rb, line 584</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">params</span>, <span class="ruby-identifier">modifiers</span>, <span class="ruby-identifier">top</span>, <span class="ruby-identifier">pos</span>, <span class="ruby-identifier">inspect</span> = <span class="ruby-keyword kw">false</span>)
<span class="ruby-keyword kw">super</span> <span class="ruby-identifier">params</span>, <span class="ruby-identifier">modifiers</span>, <span class="ruby-identifier">top</span>, <span class="ruby-identifier">pos</span>
<span class="ruby-ivar">@inspect</span> = <span class="ruby-identifier">inspect</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000474" class="method-detail">
<a name="M000474"></a>
<div class="method-heading">
<a href="#M000474" class="method-signature">
<span class="method-name">execute</span><span class="method-args">(state)</span>
</a>
</div>
<div class="method-description">
<p>
<a href="../Output.html">Output</a> the given argument as it generally
prints in Ruby. The full form is:
</p>
<pre>
~mincol,colinc,minpad,padchar:@[AS]
</pre>
<p>
with the following interpretations
</p>
<dl>
<dt><tt>mincol</tt> (0)</dt><dd>minimum number of columns to output,
</dd>
<dt><tt>colinc</tt> (1)</dt><dd>number of columns to increase by, until <tt>mincol</tt> is reached,
</dd>
<dt><tt>minpad</tt> (0)</dt><dd>minimum amount of padding to add (added before <tt>mincol</tt> is checked),
</dd>
<dt><tt>padchar</tt> (?\s)</dt><dd>character to pad with,
</dd>
<dt>:</dt><dd><tt>nil</tt> is output as <tt>nil</tt> (In <a
href="../../../Lisp.html">Lisp</a>, this outputs <tt>nil</tt> as
<tt>()</tt>, which isn’t generally useful in Ruby. TODO: come up with
better use for this modifier),
</dd>
<dt>@</dt><dd>padding is done on the right.
</dd>
</dl>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000474-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000474-source">
<pre>
<span class="ruby-comment cmt"># File lib/carat/lisp-format.rb, line 608</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">execute</span>(<span class="ruby-identifier">state</span>)
<span class="ruby-identifier">padmethod</span> = <span class="ruby-identifier">at_mod?</span> <span class="ruby-value">? </span><span class="ruby-operator">:</span><span class="ruby-identifier">rjust</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">:ljust</span>
<span class="ruby-identifier">mincol</span> = <span class="ruby-identifier">param</span>(<span class="ruby-value">0</span>, <span class="ruby-identifier">state</span>, <span class="ruby-value">0</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">minpad</span> = <span class="ruby-identifier">param</span>(<span class="ruby-value">2</span>, <span class="ruby-identifier">state</span>, <span class="ruby-value">0</span>)
<span class="ruby-identifier">padchar</span> = <span class="ruby-identifier">param</span>(<span class="ruby-value">3</span>, <span class="ruby-identifier">state</span>, <span class="ruby-value">?\s</span>).<span class="ruby-identifier">chr</span>
<span class="ruby-identifier">arg</span> = <span class="ruby-identifier">state</span>.<span class="ruby-identifier">next_arg</span>
<span class="ruby-comment cmt"># XXX: this needs checking use .to_s here?</span>
<span class="ruby-identifier">str</span> = (<span class="ruby-identifier">arg</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">String</span> <span class="ruby-keyword kw">and</span> <span class="ruby-keyword kw">not</span> <span class="ruby-ivar">@inspect</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">arg</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">arg</span>.<span class="ruby-identifier">inspect</span>
<span class="ruby-identifier">str</span> = <span class="ruby-identifier">str</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">padmethod</span>, <span class="ruby-identifier">str</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">minpad</span>, <span class="ruby-identifier">padchar</span>)
<span class="ruby-identifier">k</span> = ((<span class="ruby-identifier">mincol</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">str</span>.<span class="ruby-identifier">length</span>) <span class="ruby-operator">/</span> <span class="ruby-identifier">colinc</span>.<span class="ruby-identifier">to_f</span>).<span class="ruby-identifier">ceil</span>
<span class="ruby-keyword kw">if</span> <span class="ruby-identifier">k</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
<span class="ruby-identifier">str</span> = <span class="ruby-identifier">str</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">padmethod</span>, <span class="ruby-identifier">str</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">colinc</span> <span class="ruby-operator">*</span> <span class="ruby-identifier">k</span>, <span class="ruby-identifier">padchar</span>)
<span class="ruby-keyword kw">end</span>
<span class="ruby-identifier">state</span>.<span class="ruby-identifier">output</span> <span class="ruby-identifier">str</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>