<?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>File: tclient.rb</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="fileHeader">
<h1>tclient.rb</h1>
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Path:</strong></td>
<td>tclient.rb
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Last Update:</strong></td>
<td>Sat Mar 18 09:16:52 -0400 2006</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
<div id="diagram">
<map id="map" name="map">
<area shape="rect" coords="79,101,151,149" href="../classes/Client.html" alt="Client
" />
<area shape="rect" coords="5,197,101,245" href="../classes/CursesClient.html" alt="CursesClient
" />
<area shape="rect" coords="125,197,227,245" href="../classes/ConsoleClient.html" alt="ConsoleClient
" />
<area shape="rect" coords="79,5,151,53" href="../classes/Publisher.html" alt="Publisher
" />
</map>
<img src="../dot/f_4.png" usemap="#map" border="0" alt="dot/f_4.png">
</div>
<div id="description">
<table>
<tr><td valign="top">file:</td><td>tclient.rb
</td></tr>
<tr><td valign="top">author:</td><td>Jon A. Lambert
</td></tr>
<tr><td valign="top">version:</td><td>2.8.0
</td></tr>
<tr><td valign="top">date:</td><td>01/19/2006
</td></tr>
</table>
<p>
This source code copyright (C) 2005, 2006 by Jon A. Lambert All rights
reserved.
</p>
<p>
Released under the terms of the TeensyMUD Public License See LICENSE file
for additional information.
</p>
</div>
<div id="requires-list">
<h3 class="section-bar">Required files</h3>
<div class="name-list">
pp
network/reactor
optparse
ostruct
curses
Win32API
</div>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000002">get_options</a>
<a href="#M000003">getkey</a>
<a href="#M000004">getkey</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">Version</td>
<td>=</td>
<td class="context-item-value">"0.2.0"</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">BANNER</td>
<td>=</td>
<td class="context-item-value"><<-EOH This is TeensyClient version #{Version} Copyright (C) 2005, 2006 by Jon A. Lambert Released under the terms of the TeensyMUD Public License EOH</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">Kbhit</td>
<td>=</td>
<td class="context-item-value">Win32API.new("msvcrt", "_kbhit", [], 'I')</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">Getch</td>
<td>=</td>
<td class="context-item-value">Win32API.new("msvcrt", "_getch", [], 'I')</td>
</tr>
</table>
</div>
</div>
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000002" class="method-detail">
<a name="M000002"></a>
<div class="method-heading">
<a href="#M000002" class="method-signature">
<span class="method-name">get_options</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000002-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000002-source">
<pre>
<span class="ruby-comment cmt"># File tclient.rb, line 257</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get_options</span>
<span class="ruby-comment cmt"># parse options</span>
<span class="ruby-keyword kw">begin</span>
<span class="ruby-comment cmt"># The myopts specified on the command line will be collected in *myopts*.</span>
<span class="ruby-comment cmt"># We set default values here.</span>
<span class="ruby-identifier">myopts</span> = <span class="ruby-constant">OpenStruct</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">myopts</span>.<span class="ruby-identifier">port</span> = <span class="ruby-value">4000</span>
<span class="ruby-identifier">myopts</span>.<span class="ruby-identifier">address</span> = <span class="ruby-value str">'localhost'</span>
<span class="ruby-identifier">myopts</span>.<span class="ruby-identifier">curses</span> = <span class="ruby-keyword kw">false</span>
<span class="ruby-identifier">myopts</span>.<span class="ruby-identifier">echo</span> = <span class="ruby-keyword kw">false</span>
<span class="ruby-identifier">myopts</span>.<span class="ruby-identifier">verbose</span> = <span class="ruby-keyword kw">false</span>
<span class="ruby-identifier">myopts</span>.<span class="ruby-identifier">trace</span> = <span class="ruby-keyword kw">false</span>
<span class="ruby-constant">RUBY_PLATFORM</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/win32/</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">myopts</span>.<span class="ruby-identifier">win32</span> = <span class="ruby-keyword kw">true</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">myopts</span>.<span class="ruby-identifier">win32</span> = <span class="ruby-keyword kw">false</span>
<span class="ruby-identifier">opts</span> = <span class="ruby-constant">OptionParser</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">opts</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">opts</span>.<span class="ruby-identifier">banner</span> = <span class="ruby-constant">BANNER</span>
<span class="ruby-identifier">opts</span>.<span class="ruby-identifier">separator</span> <span class="ruby-value str">""</span>
<span class="ruby-identifier">opts</span>.<span class="ruby-identifier">separator</span> <span class="ruby-node">"Usage: ruby #{$0} [options]"</span>
<span class="ruby-identifier">opts</span>.<span class="ruby-identifier">separator</span> <span class="ruby-value str">""</span>
<span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">"-p"</span>, <span class="ruby-value str">"--port PORT"</span>, <span class="ruby-constant">Integer</span>,
<span class="ruby-value str">"Select the port of the mud"</span>,
<span class="ruby-value str">" (defaults to 4000)"</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">myopts</span>.<span class="ruby-identifier">port</span><span class="ruby-operator">|</span>}
<span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">"-a"</span>, <span class="ruby-value str">"--address URL"</span>, <span class="ruby-constant">String</span>,
<span class="ruby-value str">"Select the address of the mud"</span>,
<span class="ruby-value str">" (defaults to \'localhost\')"</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">myopts</span>.<span class="ruby-identifier">address</span><span class="ruby-operator">|</span>}
<span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">"-e"</span>, <span class="ruby-value str">"--[no-]echo"</span>, <span class="ruby-value str">"Run in server echo mode"</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">myopts</span>.<span class="ruby-identifier">echo</span><span class="ruby-operator">|</span>}
<span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">"-t"</span>, <span class="ruby-value str">"--[no-]trace"</span>, <span class="ruby-value str">"Trace execution"</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">myopts</span>.<span class="ruby-identifier">trace</span><span class="ruby-operator">|</span>}
<span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">"-c"</span>, <span class="ruby-value str">"--[no-]curses"</span>, <span class="ruby-value str">"Run with curses support"</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">myopts</span>.<span class="ruby-identifier">curses</span><span class="ruby-operator">|</span>}
<span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">"-v"</span>, <span class="ruby-value str">"--[no-]verbose"</span>, <span class="ruby-value str">"Run verbosely"</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">myopts</span>.<span class="ruby-identifier">verbose</span><span class="ruby-operator">|</span>}
<span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on_tail</span>(<span class="ruby-value str">"-h"</span>, <span class="ruby-value str">"--help"</span>, <span class="ruby-value str">"Show this message"</span>) <span class="ruby-keyword kw">do</span>
<span class="ruby-identifier">$stdout</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">help</span>
<span class="ruby-identifier">exit</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on_tail</span>(<span class="ruby-value str">"--version"</span>, <span class="ruby-value str">"Show version"</span>) <span class="ruby-keyword kw">do</span>
<span class="ruby-identifier">$stdout</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">"TeensyClient #{Version}"</span>
<span class="ruby-identifier">exit</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-identifier">opts</span>.<span class="ruby-identifier">parse!</span>(<span class="ruby-constant">ARGV</span>)
<span class="ruby-keyword kw">return</span> <span class="ruby-identifier">myopts</span>
<span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">OptionParser</span><span class="ruby-operator">::</span><span class="ruby-constant">ParseError</span>
<span class="ruby-identifier">$stderr</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">"ERROR - #{$!}"</span>
<span class="ruby-identifier">$stderr</span>.<span class="ruby-identifier">puts</span> <span class="ruby-value str">"For help..."</span>
<span class="ruby-identifier">$stderr</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">" ruby #{$0} --help"</span>
<span class="ruby-identifier">exit</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000003" class="method-detail">
<a name="M000003"></a>
<div class="method-heading">
<a href="#M000003" class="method-signature">
<span class="method-name">getkey</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000003-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000003-source">
<pre>
<span class="ruby-comment cmt"># File tclient.rb, line 328</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">getkey</span>
<span class="ruby-identifier">sleep</span> <span class="ruby-value">0</span><span class="ruby-value">.01</span>
<span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span> <span class="ruby-keyword kw">if</span> <span class="ruby-constant">Kbhit</span>.<span class="ruby-identifier">call</span>.<span class="ruby-identifier">zero?</span>
<span class="ruby-identifier">c</span> = <span class="ruby-constant">Getch</span>.<span class="ruby-identifier">call</span>
<span class="ruby-identifier">c</span> = <span class="ruby-constant">Getch</span>.<span class="ruby-identifier">call</span> <span class="ruby-operator">+</span> <span class="ruby-value">256</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">c</span>.<span class="ruby-identifier">zero?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">c</span> <span class="ruby-operator">==</span> <span class="ruby-value">0x</span><span class="ruby-constant">E0</span>
<span class="ruby-identifier">c</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000004" class="method-detail">
<a name="M000004"></a>
<div class="method-heading">
<a href="#M000004" class="method-signature">
<span class="method-name">getkey</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000004-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000004-source">
<pre>
<span class="ruby-comment cmt"># File tclient.rb, line 336</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">getkey</span>
<span class="ruby-identifier">select</span>( [<span class="ruby-identifier">$stdin</span>], <span class="ruby-keyword kw">nil</span>, <span class="ruby-keyword kw">nil</span>, <span class="ruby-value">0</span><span class="ruby-value">.01</span> ) <span class="ruby-operator">?</span> <span class="ruby-identifier">c</span> = <span class="ruby-identifier">$stdin</span>.<span class="ruby-identifier">getc</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">c</span> = <span class="ruby-keyword kw">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>
