.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.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.  \*(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-
.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" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Text::Query::Build 3"
.TH Text::Query::Build 3 "2020-07-07" "perl v5.32.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Text::Query::Build \- Base class for query builders
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    package Text::Query::BuildMy;
\&
\&    use Text::Query::Build;
\&    
\&    use vars qw(@ISA);
\&
\&    @ISA = qw(Text::Query::Build);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module provides a virtual base class for query builders.
.PP
Query builders are called by the parser logic. A given set of functions is
provided by the builder to match a Boolean logic.
All the methods return a scalar corresponding to the code that performs 
the specified options.
.PP
Parameters Q1 and Q2 are the same type of scalar as the return values.
.SH "METHODS"
.IX Header "METHODS"
.IP "\fBmatchstring()\fR" 4
.IX Item "matchstring()"
Return a string that represent the last built expression. Two identical expressions
should generate the same string. This is for testing purpose.
.SH "CODE-GENERATION METHODS"
.IX Header "CODE-GENERATION METHODS"
.IP "\fBbuild_init()\fR" 4
.IX Item "build_init()"
Called before building the expression. A chance to initialize object data.
.IP "build_final_expression(Q1)" 4
.IX Item "build_final_expression(Q1)"
Does any final processing to generate code to match a top-level expression.  
The return value is \s-1NOT\s0 necessarily of a type that can be passed to 
the other code-generation methods.
.IP "build_expression(Q1,Q2)" 4
.IX Item "build_expression(Q1,Q2)"
Generate code to match \f(CW\*(C`Q1\*(C'\fR \s-1OR\s0 \f(CW\*(C`Q2\*(C'\fR
.IP "build_expression_finish(Q1)" 4
.IX Item "build_expression_finish(Q1)"
Generate any code needed to enclose an expression.
.IP "build_conj(Q1,Q2,F)" 4
.IX Item "build_conj(Q1,Q2,F)"
Generate code needed to match \f(CW\*(C`Q1\*(C'\fR \s-1AND\s0 \f(CW\*(C`Q2\*(C'\fR.  F will be true if this is the first 
time this method is called in a sequence of several conjunctions.
.IP "build_near(Q1,Q2)" 4
.IX Item "build_near(Q1,Q2)"
Generate code needed to match \f(CW\*(C`Q1\*(C'\fR \s-1NEAR\s0 \f(CW\*(C`Q2\*(C'\fR.
.IP "build_concat(Q1,Q2)" 4
.IX Item "build_concat(Q1,Q2)"
Generate code needed to match \f(CW\*(C`Q1\*(C'\fR immediately followed by \f(CW\*(C`Q2\*(C'\fR.
.IP "build_negation(Q1)" 4
.IX Item "build_negation(Q1)"
Generate code needed to match \s-1NOT\s0 \f(CW\*(C`Q1\*(C'\fR.
.IP "build_literal(Q1)" 4
.IX Item "build_literal(Q1)"
Generate code to match \f(CW\*(C`Q1\*(C'\fR as a literal.
.IP "build_scope_start($scope)" 4
.IX Item "build_scope_start($scope)"
Generate code to enter in the \f(CW$scope\fR query context.
.IP "build_scope_end($scope,Q1)" 4
.IX Item "build_scope_end($scope,Q1)"
Generate code needed to match \f(CW\*(C`Q1\*(C'\fR in the \f(CW$scope\fR context.
.IP "build_mandatory(Q1)" 4
.IX Item "build_mandatory(Q1)"
Generate code to match \f(CW\*(C`Q1\*(C'\fR (think + in AltaVista syntax).
.IP "build_forbiden(Q1)" 4
.IX Item "build_forbiden(Q1)"
Generate code to match \s-1NOT\s0 \f(CW\*(C`Q1\*(C'\fR (think \- in AltaVista syntax).
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBText::Query\fR\|(3)
.SH "AUTHORS"
.IX Header "AUTHORS"
Eric Bohlman (ebohlman@netcom.com)
.PP
Loic Dachary (loic@senga.org)