<?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::FFFP</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::FFFP</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 ~F (Fixed-format floating-point) directive. This outputs
floating point values with various kinds of padding and such.
</p>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000476">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-M000476" class="method-detail">
<a name="M000476"></a>
<div class="method-heading">
<a href="#M000476" class="method-signature">
<span class="method-name">execute</span><span class="method-args">(state)</span>
</a>
</div>
<div class="method-description">
<p>
Outputs the given argument using a floating-point representation. The full
form is
</p>
<pre>
~w,d,k,overflowchar,padchar@F
</pre>
<p>
with the following interpretations
</p>
<dl>
<dt><tt>w</tt> (<tt>nil</tt>)</dt><dd>if non-<tt>nil</tt>, the output will be exactly <tt>w</tt> characters long,
</dd>
<dt><tt>d</tt> (<tt>nil</tt>)</dt><dd>if non-<tt>nil</tt>, this is the number of digits output after the decimal
point (<tt>.</tt>),
</dd>
<dt><tt>k</tt> (0)</dt><dd>scaling factor - the number is first scaled using this value,
</dd>
<dt><tt>overflowchar</tt> (<tt>nil</tt>)</dt><dd>if non-<tt>nil</tt>, this character is used when this directive would
produce output longer than that specified with the <tt>w</tt> directive,
</dd>
<dt><tt>padchar</tt> (?\s)</dt><dd>character to pad with if <tt>w</tt> is non-nil and output isn’t wide
enough yet,
</dd>
<dt>@</dt><dd>numbers are always output with sign prepended.
</dd>
</dl>
<p>
An <a href="../ArgumentError.html">ArgumentError</a> is raised if the
argument is not a number or a string that can be converted to a number.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000476-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000476-source">
<pre>
<span class="ruby-comment cmt"># File lib/carat/lisp-format.rb, line 996</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">execute</span>(<span class="ruby-identifier">state</span>)
<span class="ruby-identifier">width</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-identifier">digits</span> = <span class="ruby-identifier">param</span>(<span class="ruby-value">1</span>, <span class="ruby-identifier">state</span>, <span class="ruby-keyword kw">nil</span>)
<span class="ruby-identifier">scale</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">overflowchar</span> = <span class="ruby-identifier">param</span>(<span class="ruby-value">3</span>, <span class="ruby-identifier">state</span>, <span class="ruby-keyword kw">nil</span>)
<span class="ruby-identifier">padchar</span> = <span class="ruby-identifier">param</span>(<span class="ruby-value">4</span>, <span class="ruby-identifier">state</span>, <span class="ruby-value">?\s</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_f</span>
<span class="ruby-identifier">num</span> = <span class="ruby-identifier">arg</span>.<span class="ruby-identifier">to_f</span> <span class="ruby-operator">*</span> (<span class="ruby-value">10</span> <span class="ruby-operator">**</span> <span class="ruby-identifier">scale</span>)
<span class="ruby-identifier">str</span> = (<span class="ruby-identifier">at_mod?</span> <span class="ruby-keyword kw">and</span> <span class="ruby-identifier">num</span> <span class="ruby-operator">>=</span> <span class="ruby-value">0</span>) <span class="ruby-operator">?</span> <span class="ruby-value str">'+'</span> <span class="ruby-operator">:</span> <span class="ruby-value str">''</span>
<span class="ruby-identifier">str</span> = <span class="ruby-identifier">sign</span> <span class="ruby-operator">+</span> (<span class="ruby-identifier">digits</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-value">? </span><span class="ruby-identifier">num</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">sprintf</span>(<span class="ruby-node">"%.#{digits}f"</span>,<span class="ruby-identifier">num</span>))
<span class="ruby-identifier">str</span> = <span class="ruby-identifier">sign</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">sprintf</span>(<span class="ruby-node">"%.#{$1}f"</span>, <span class="ruby-identifier">num</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">str</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/e-([0-9]+)$/</span>
<span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">width</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-keyword kw">if</span> <span class="ruby-keyword kw">not</span> <span class="ruby-identifier">digits</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-keyword kw">and</span> <span class="ruby-identifier">width</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">digits</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>
<span class="ruby-identifier">str</span>.<span class="ruby-identifier">sub!</span>(<span class="ruby-regexp re">/^([+-]?)0\./</span>, <span class="ruby-value str">'\1.'</span>)
<span class="ruby-keyword kw">end</span>
<span class="ruby-identifier">str</span> = <span class="ruby-identifier">str</span>.<span class="ruby-identifier">rjust</span>(<span class="ruby-identifier">width</span>, <span class="ruby-identifier">padchar</span>.<span class="ruby-identifier">chr</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">str</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator"><</span> <span class="ruby-identifier">width</span>
<span class="ruby-keyword kw">if</span> <span class="ruby-identifier">str</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">></span> <span class="ruby-identifier">width</span> <span class="ruby-keyword kw">and</span> <span class="ruby-identifier">digits</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-identifier">prec</span> = <span class="ruby-identifier">width</span> <span class="ruby-operator">-</span> (<span class="ruby-identifier">str</span>.<span class="ruby-identifier">index</span>(<span class="ruby-regexp re">/\./</span>) <span class="ruby-operator">+</span> <span class="ruby-value">1</span>)
<span class="ruby-identifier">str</span> = <span class="ruby-identifier">sign</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">sprintf</span>(<span class="ruby-node">"%#.#{prec}f"</span>, <span class="ruby-identifier">num</span>)
<span class="ruby-keyword kw">end</span>
<span class="ruby-identifier">str</span>.<span class="ruby-identifier">sub!</span>(<span class="ruby-regexp re">/\.$/</span>, <span class="ruby-value str">''</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">str</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">></span> <span class="ruby-identifier">width</span> <span class="ruby-keyword kw">and</span> <span class="ruby-identifier">digits</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-keyword kw">if</span> <span class="ruby-identifier">str</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">></span> <span class="ruby-identifier">width</span> <span class="ruby-keyword kw">and</span> <span class="ruby-keyword kw">not</span> <span class="ruby-identifier">overflowchar</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-identifier">str</span> = <span class="ruby-identifier">overflowchar</span>.<span class="ruby-identifier">chr</span> <span class="ruby-operator">*</span> <span class="ruby-identifier">width</span>
<span class="ruby-keyword kw">end</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">elsif</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">state</span>.<span class="ruby-identifier">push_back_arg</span>
<span class="ruby-identifier">parameters</span> = <span class="ruby-ivar">@params</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">nil?</span> <span class="ruby-value">? </span>[] <span class="ruby-operator">:</span> [<span class="ruby-ivar">@params</span>[<span class="ruby-value">0</span>]]
<span class="ruby-constant">Factory</span>.<span class="ruby-identifier">build</span>(<span class="ruby-identifier">parameters</span>, [], <span class="ruby-value">?D</span>, <span class="ruby-keyword kw">nil</span>, <span class="ruby-ivar">@pos</span>).<span class="ruby-identifier">execute</span>(<span class="ruby-identifier">state</span>)
<span class="ruby-keyword kw">else</span>
<span class="ruby-identifier">arg_error</span> <span class="ruby-value str">'argument is not a number or a number string'</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>