name: TextReaderModule
class: autohit.call.modules.TextReaderModule
Text reader module. It'll supply lines or tokens out of a text source. The source can be a String or a Universe object. If you start a new session over an old one, it will throw a fault. You must call done() first..
method |
"startstring" |
parameters: |
"string" (REQUIRED): The string that will be read. |
returns: |
nothing |
description: |
Start a read on a target string. |
method |
"startuni" |
parameters: |
"objname" (REQUIRED): The universe object that will be read. |
returns: |
nothing |
description: |
Start a read on a universe object. |
method |
"line" |
parameters: |
none |
returns: |
Full line of text or an empty string. |
description: |
Get the next full line. If currently reading tokens in a line, it will
give the whole contents of the current line. If there is nothing left to
read, it will return an empty string. You must use hasmore() to detect the
end of a read. |
method |
"token" |
parameters: |
none |
returns: |
The next token or an empty string. |
description: |
Get the next whitespace delimited token. It'll eat as many empty lines as neccessary to find the next token. If there is nothing left to read, it will return an empty string. You must use hasmore() to detect the end of a read. |
method |
"hasmore" |
parameters: |
none |
returns: |
"true" or "false" |
description: |
Returns "true" if there are any more tokens to read, otherwise "false." |
method |
"done" |
parameters: |
none |
returns: |
nothing |
description: |
Close read. It is a VERY GOOD IDEA to do this for any session! |
AUTOHIT 2003
MODULES DOCUMENTATION
Copyright Erich P Gatejen (c) 1989,1997,2003,2004
See license for details.