NAME 
PGE::Match - implementation of PGE match objects
DESCRIPTION
This file implements match objects returned by the Parrot Grammar Engine.
Functions
newfrom(PMC mob [, int from [, string grammar]])- Creates a new Match object,
based on
mob. Ifgrammaris specified then the newly created object is an instance of that class, otherwise ifisa mob, 'PGE::Match'then the new object is the same class asmob, otherwise the new object is a 'PGE::Match' object. The optionalfromparameter says how to initialize the$.fromattribute of the new object if it can't start from the current position ofmob.
Methods
new(PMC src, [ PMC adverbs :slurpy :named ])- Creates a new Match object based on
src. If thegrammaradverb is specified, then the new Match object is of the given grammar class, otherwise ifsrcis an instance ofMatch(or a subclass) then that class is used to create the object, otherwise it uses the class of the invocant. - The
pos,p,continue, orcadverbs specify where the match object should begin. If no starting position is given, the current position ofsrcis used if it has one, otherwise the start position is at offset zero. Thefromadverb can be used to initialize the Match's$.fromattribute to a value other than the starting position. - The
rwadverb causes the invocant to be modified and returned instead of creating a new Match object. - The
newmethod returns several values to the caller: the initialized match object, the target the object is matching against, a reference to its $.from attribute, a reference to its $.pos attribute, the value ofpos/p/continue/cused to initialize the object, and whether or not a continue flag is set or implied. next()- Tell a Match object to continue the previous match from where it left off.
from([int pos])- Returns or sets the offset in the target string of the first item this object matched.
to([int pos])- Returns or sets the offset at the end of this match.
text()- Returns the portion of the target string matched by this object.
get_scalar()- Returns the scalar value of this match -- the "result object" if there is one, otherwise the substring matched by this match object.
result_object([pmc obj])- Returns or sets the "result object" for the match object.
find_key([ key1, key2, ... ])- Find the first of
key1,key2, etc. in the current Match object, and return it. Returns '' if none of the specified keys are found. If no keys are specified, then simply return the first key found. _failcut(int cutvalue)- Immediately "fail" this Match object,
removing any captured entities and coroutine continuation.
Set the position of the match object to
cutvalue. __get_bool()- Returns 1 if this object successfully matched the target string, 0 otherwise.
__get_integer()- Returns the integer value of this match.
__get_number()- Returns the numeric value of this match.
__get_string()- Returns the portion of the target string matched by this object.
__get_string_keyed_int(int key)- Returns the portion of the target string matched by
key, in string context. If the Match object contains an array of matches, a space seperated list of matches is returned. __get_pmc_keyed_int(int key)- Returns the subpattern capture associated with
key. This returns either a single Match object or an array of match objects depending on the rule. get_hash()- Returns the hash component of the match object.
get_array()- Returns the array component of the match object.
AUTHOR
Patrick Michaud (pmichaud@pobox.com) is the author and maintainer. Patches and suggestions should be sent to the Perl 6 compiler list (perl6-compiler@perl.org).
