doc/classes/SDL4R/Parser.html in sdl4r-0.9.4 vs doc/classes/SDL4R/Parser.html in sdl4r-0.9.5
- old
+ new
@@ -1,14 +1,11 @@
-<?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">
-
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
- <title>Class: SDL4R::Parser</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+ <title>Class: SDL4R::Parser [RDoc: Simple Declarative Language for Ruby]</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<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[
@@ -23,77 +20,109 @@
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>" )
-
+ 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">SDL4R::Parser</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
+
+
<a href="../../files/lib/sdl4r/parser_rb.html">
+
lib/sdl4r/parser.rb
+
</a>
+
+
<br />
+
+
<a href="../../files/lib/sdl4r/parser/reader_rb.html">
+
lib/sdl4r/parser/reader.rb
+
</a>
+
+
<br />
+
+
<a href="../../files/lib/sdl4r/parser/tokenizer_rb.html">
+
lib/sdl4r/parser/tokenizer.rb
+
</a>
+
+
<br />
+
+
<a href="../../files/lib/sdl4r/parser/token_rb.html">
+
lib/sdl4r/parser/token.rb
+
</a>
+
+
<br />
+
+
<a href="../../files/lib/sdl4r/parser/time_span_with_zone_rb.html">
+
lib/sdl4r/parser/time_span_with_zone.rb
+
</a>
+
+
<br />
+
</td>
</tr>
+
<tr class="top-aligned-row">
<td><strong>Parent:</strong></td>
<td>
+
Object
+
</td>
</tr>
+
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
-
-
<div id="contextContent">
<div id="description">
<p>
The SDL parser.
@@ -106,11 +135,11 @@
$KCODE = 'u'
require 'jcode'
</pre>
<p>
This will give you correct input and output and correct UTF-8
-"general" sorting. Alternatively you can use the following
+“general” sorting. Alternatively you can use the following
options when launching the Ruby interpreter:
</p>
<pre>
/path/to/ruby -Ku -rjcode
</pre>
@@ -119,156 +148,186 @@
Daniel Leuck, Philippe Vosges
</p>
</div>
-
</div>
+
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
- <a href="#M000010">new</a>
- <a href="#M000012">new_date_time</a>
- <a href="#M000011">parse</a>
+
+ <a href="#M000080">new</a>
+
+ <a href="#M000082">new_date_time</a>
+
+ <a href="#M000081">parse</a>
+
</div>
</div>
</div>
-
<!-- if includes -->
<div id="section">
-
<div id="constants-list">
<h3 class="section-bar">Constants</h3>
<div class="name-list">
<table summary="Constants">
+
<tr class="top-aligned-row context-row">
<td class="context-item-name">UNKNOWN_POSITION</td>
<td>=</td>
<td class="context-item-value">-2</td>
- <td width="3em"> </td>
+
+ <td> </td>
<td class="context-item-desc">
Passed to parse_error() in order to specify an error that occured on no
specific position (column).
</td>
+
</tr>
+
</table>
</div>
</div>
-
-
<!-- if method_list -->
+
<div id="methods">
+
<h3 class="section-bar">Public Class methods</h3>
- <div id="method-M000010" class="method-detail">
- <a name="M000010"></a>
+ <div id="method-M000080" class="method-detail">
+ <a name="M000080"></a>
+
<div class="method-heading">
- <a href="#M000010" class="method-signature">
+
+ <a href="#M000080" class="method-signature">
+
<span class="method-name">new</span><span class="method-args">(io)</span>
+
</a>
+
</div>
-
+
<div class="method-description">
+
<p>
Creates an SDL parser on the specified <tt>IO</tt>.
</p>
<pre>
IO.open("path/to/sdl_file") { |io|
parser = SDL4R::Parser.new(io)
tags = parser.parse()
}
</pre>
+
<p><a class="source-toggle" href="#"
- onclick="toggleCode('M000010-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000010-source">
+ onclick="toggleCode('M000080-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000080-source">
<pre>
-<span class="ruby-comment cmt"># File lib/sdl4r/parser.rb, line 56</span>
+<span class="ruby-comment cmt"># File lib/sdl4r/parser.rb, line 59</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">io</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-value str">"io == nil"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">io</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-ivar">@tokenizer</span> = <span class="ruby-constant">Tokenizer</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">io</span>)
<span class="ruby-keyword kw">end</span>
</pre>
</div>
+
</div>
</div>
+
<h3 class="section-bar">Public Instance methods</h3>
- <div id="method-M000012" class="method-detail">
- <a name="M000012"></a>
+ <div id="method-M000082" class="method-detail">
+ <a name="M000082"></a>
+
<div class="method-heading">
- <a href="#M000012" class="method-signature">
+
+ <a href="#M000082" class="method-signature">
+
<span class="method-name">new_date_time</span><span class="method-args">(year, month, day, hour, min, sec, time_zone_offset)</span>
+
</a>
+
</div>
-
+
<div class="method-description">
+
<p>
Creates and returns the object representing a datetime (DateTime in the
default implementation). Can be overriden.
</p>
<pre>
def new_date_time(year, month, day, hour, min, sec, time_zone_offset)
Time.utc(year, month, day, hour, min, sec)
end
</pre>
+
<p><a class="source-toggle" href="#"
- onclick="toggleCode('M000012-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000012-source">
+ onclick="toggleCode('M000082-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000082-source">
<pre>
-<span class="ruby-comment cmt"># File lib/sdl4r/parser.rb, line 102</span>
+<span class="ruby-comment cmt"># File lib/sdl4r/parser.rb, line 105</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">new_date_time</span>(<span class="ruby-identifier">year</span>, <span class="ruby-identifier">month</span>, <span class="ruby-identifier">day</span>, <span class="ruby-identifier">hour</span>, <span class="ruby-identifier">min</span>, <span class="ruby-identifier">sec</span>, <span class="ruby-identifier">time_zone_offset</span>)
<span class="ruby-constant">SDL4R</span><span class="ruby-operator">::</span><span class="ruby-identifier">new_date_time</span>(<span class="ruby-identifier">year</span>, <span class="ruby-identifier">month</span>, <span class="ruby-identifier">day</span>, <span class="ruby-identifier">hour</span>, <span class="ruby-identifier">min</span>, <span class="ruby-identifier">sec</span>, <span class="ruby-identifier">time_zone_offset</span>)
<span class="ruby-keyword kw">end</span>
</pre>
</div>
+
</div>
</div>
- <div id="method-M000011" class="method-detail">
- <a name="M000011"></a>
+ <div id="method-M000081" class="method-detail">
+ <a name="M000081"></a>
+
<div class="method-heading">
- <a href="#M000011" class="method-signature">
+
+ <a href="#M000081" class="method-signature">
+
<span class="method-name">parse</span><span class="method-args">()</span>
+
</a>
+
</div>
-
+
<div class="method-description">
+
<p>
-Parses the underlying <tt>IO</tt> and returns an <tt>Array</tt> of <tt><a
-href="Tag.html">Tag</a></tt>.
+Parses the underlying <tt>IO</tt> and returns an <tt>Array</tt> of
+<tt>Tag</tt>.
</p>
<h2>Errors</h2>
<dl>
<dt>IOError</dt><dd>If a problem is encountered with the IO
</dd>
<dt><a href="SdlParseError.html">SdlParseError</a></dt><dd>If the document is malformed
</dd>
</dl>
+
<p><a class="source-toggle" href="#"
- onclick="toggleCode('M000011-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000011-source">
+ onclick="toggleCode('M000081-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000081-source">
<pre>
-<span class="ruby-comment cmt"># File lib/sdl4r/parser.rb, line 67</span>
+<span class="ruby-comment cmt"># File lib/sdl4r/parser.rb, line 70</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">parse</span>
<span class="ruby-identifier">tags</span> = []
<span class="ruby-keyword kw">while</span> <span class="ruby-identifier">tokens</span> = <span class="ruby-ivar">@tokenizer</span>.<span class="ruby-identifier">read_line_tokens</span>()
<span class="ruby-keyword kw">if</span> <span class="ruby-identifier">tokens</span>.<span class="ruby-identifier">last</span>.<span class="ruby-identifier">type</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">:START_BLOCK</span>
@@ -294,21 +353,24 @@
<span class="ruby-keyword kw">return</span> <span class="ruby-identifier">tags</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
+
</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>
\ No newline at end of file
+</html>