StringPreParserclass | input.t[631]

Base class for command input string preparsers.

Preparsers must be registered in order to run. During preinitialization, we will automatically register any existing preparser objects; preparsers that are created dynamically during execution must be registered explicitly, which can be accomplished by inheriting the default constructor from this class.

`class StringPreParser : PreinitObject`

Superclass Tree (in declaration order)

`StringPreParser`
`PreinitObject`
`ModuleExecObject`
`object`

Subclass Tree

(none)

Global Objects

`commentPreParser decimalPreParser evalPreParser pleasePreParser pronounUsePreParser queryPreParser seekPreParser somethingPreParser usePreParser`

Summary of Properties

`isActive regList regListSorted runOrder`

Inherited from `PreinitObject` :
`execBeforeMe reverseGlobalSymbols`

Inherited from `ModuleExecObject` :
`execAfterMe hasInitialized_ isDoingExec_ isExecuted_`

Summary of Methods

`construct doParsing execute registerPreParser runAll`

``

Inherited from `ModuleExecObject` :
`_execute classExec`

Properties

`isActive` | `input.t[735]`

Flag, is this PreParser active?

`regList` | `input.t[729]`

class property containing the list of registered parsers

`regListSorted` | `input.t[732]`

class property - the registration list has been sorted

`runOrder` | `input.t[637]`

My execution order number. When multiple preparsers are registered, we'll run the preparsers in ascending order of this value (i.e., smallest runOrder goes first).

Methods

`construct ( )` | `input.t[663]`

construction - when we dynamically create a preparser, register it by default

`doParsing (str, which)` | `input.t[653]`

Do our parsing. Each instance should override this method to define the parsing that it does.

'str' is the string to parse, and 'which' is the rmcXxx enum giving the type of command we're working with.

This method returns a string or nil. If the method returns a string, the caller will forget the original string and work from here on out with the new version returned; this allows the method to rewrite the original input as desired. If the method returns nil, it means that the string has been fully handled and that further parsing of the same string is not desired.

`execute ( )`OVERRIDDEN | `input.t[670]`

run pre-initialization

`registerPreParser (pp)` | `input.t[677]`

register a preparser

`runAll (str, which)` | `input.t[694]`

Class method - Run all preparsers. Returns the result of successively calling each preparser on the given string.

Adv3Lite Library Reference Manual
Generated on 12/09/2014 from adv3Lite version 1.4