.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Text::Query::Parse 3"
.TH Text::Query::Parse 3 "1999-06-19" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Text::Query::Parse \- Base class for query parsers
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    package Text::Query::ParseThisSyntax;
.Ve
.PP
.Vb 1
\&    use Text::Query::Parse;
.Ve
.PP
.Vb 1
\&    use vars qw(@ISA);
.Ve
.PP
.Vb 1
\&    @ISA = qw(Text::Query::Parse);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module provides a virtual base class for query parsers.
.PP
It defines the \f(CW\*(C`prepare\*(C'\fR method that is called by the \f(CW\*(C`Text::Query\*(C'\fR
object to compile the query string.
.SH "MEMBERS"
.IX Header "MEMBERS"
.IP "\fB\-build\fR Pointer to a Text::Query::Build object." 4
.IX Item "-build Pointer to a Text::Query::Build object."
.PD 0
.IP "\fBscope\fR Scope stack. Defines the context in which the query must be solved." 4
.IX Item "scope Scope stack. Defines the context in which the query must be solved."
.ie n .IP "\fBtoken\fR The current token. Destroyed by ""prepare""." 4
.el .IP "\fBtoken\fR The current token. Destroyed by \f(CWprepare\fR." 4
.IX Item "token The current token. Destroyed by prepare."
.ie n .IP "\fBtokens\fR A reference to the list of all the tokens. Filled by parse_tokens. Destroyed by ""prepare""." 4
.el .IP "\fBtokens\fR A reference to the list of all the tokens. Filled by parse_tokens. Destroyed by \f(CWprepare\fR." 4
.IX Item "tokens A reference to the list of all the tokens. Filled by parse_tokens. Destroyed by prepare."
.ie n .IP "\fBparseopts\fR A reference to a hash table containing all the parameters given to the ""prepare"" function." 4
.el .IP "\fBparseopts\fR A reference to a hash table containing all the parameters given to the \f(CWprepare\fR function." 4
.IX Item "parseopts A reference to a hash table containing all the parameters given to the prepare function."
.IP "\fB\-verbose\fR Integer indicating the desired verbose level." 4
.IX Item "-verbose Integer indicating the desired verbose level."
.PD
.SH "METHODS"
.IX Header "METHODS"
.IP "prepare (\s-1QSTRING\s0 [\s-1OPTIONS\s0])" 4
.IX Item "prepare (QSTRING [OPTIONS])"
Compiles the query expression in \f(CW\*(C`QSTRING\*(C'\fR to internal form and sets any 
options. First calls \f(CW\*(C`build_init\*(C'\fR to reset the builder and destroy the
\&\f(CW\*(C`token\*(C'\fR and \f(CW\*(C`tokens\*(C'\fR members. Then calls \f(CW\*(C`parse_tokens\*(C'\fR to fill 
the \f(CW\*(C`tokens\*(C'\fR member. Then calls \f(CW\*(C`expression\*(C'\fR to use the tokens from 
\&\f(CW\*(C`tokens\*(C'\fR. The \f(CW\*(C`expression\*(C'\fR is expected to call the \f(CW\*(C`build_*\*(C'\fR functions
to build the compiled expression. At last calls \f(CW\*(C`build_final_expression\*(C'\fR
with the result of \f(CW\*(C`expression\*(C'\fR.
.Sp
A derived parser must redefine this function to define default values for
specific options.
.IP "expression ()" 4
.IX Item "expression ()"
Must be redefined by derived package. Returns the internal form of the
question built from \f(CW\*(C`build_*\*(C'\fR functions using the \f(CW\*(C`tokens\*(C'\fR.
.IP "parse_tokens (\s-1QSTRING\s0)" 4
.IX Item "parse_tokens (QSTRING)"
Must be redefined by derived package. Parses the \f(CW\*(C`QSTRING\*(C'\fR scalar
and fills the \f(CW\*(C`tokens\*(C'\fR member with lexical units.
.IP "build_*" 4
.IX Item "build_*"
Shortcuts to the corresponding function of the Text::Query::Build object
found in the \f(CW\*(C`\-build\*(C'\fR member.
.SH "OPTIONS"
.IX Header "OPTIONS"
These are the options of the \f(CW\*(C`prepare\*(C'\fR method and the constructor.
.IP "\-quotes defaults to \e'\e""" 4
.IX Item "-quotes defaults to '"""
Defines the quote characters.
.IP "\-case defaults to 0" 4
.IX Item "-case defaults to 0"
If true, do case-sensitive match.
.IP "\-litspace defaults to 0" 4
.IX Item "-litspace defaults to 0"
If true, match spaces (except between operators) in 
\&\f(CW\*(C`QSTRING\*(C'\fR literally.  If false, match spaces as \f(CW\*(C`\es+\*(C'\fR.
.IP "\-regexp defaults to 0" 4
.IX Item "-regexp defaults to 0"
If true, treat patterns in \f(CW\*(C`QSTRING\*(C'\fR as regular expressions 
rather than literal text.
.IP "\-whole defaults to 0" 4
.IX Item "-whole defaults to 0"
If true, match whole words only, not substrings of words.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIText::Query\fR\|(3)
.SH "AUTHORS"
.IX Header "AUTHORS"
Eric Bohlman (ebohlman@netcom.com)
.PP
Loic Dachary (loic@senga.org)