.\" 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 "Zoidberg::StringParser 3"
.TH Zoidberg::StringParser 3 "2008-01-12" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Zoidberg::StringParser \- Simple string parser
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 7
\&        my $base_gram = {
\&            esc => '\e\e',
\&            quotes => {
\&                q{"} => q{"},
\&                q{'} => q{'},
\&            },
\&        };
.Ve
.PP
.Vb 1
\&        my $parser = Zoidberg::StringParser->new($base_gram);
.Ve
.PP
.Vb 3
\&        my @blocks = $parser->split(
\&            qr/\e|/, 
\&            qq{ls -al | cat > "somefile with a pipe | in it"} );
.Ve
.PP
.Vb 3
\&        # @blocks now is: 
\&        # ('ls -al ', ' cat > "somefile with a pipe | in it"');
\&        # So it worked like split, but it respected quotes
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module is a simple syntax parser. It originaly was designed 
to work like the built-in \f(CW\*(C`split\*(C'\fR function, but to respect quotes.
The current version is a little more advanced: it uses user defined 
grammars to deal with delimiters, an escape char, quotes and braces.
.PP
Yes, I know of the existence of Text::Balanced, but I wanted to do this the hard way :)
.PP
\&\fIAll grammars and collections of grammars should be considered \s-1PRIVATE\s0 when used by a Z::SP object.\fR
.SH "EXPORT"
.IX Header "EXPORT"
None by default.
.SH "GRAMMARS"
.IX Header "GRAMMARS"
\&\s-1TODO\s0
.IP "esc" 4
.IX Item "esc"
\&\s-1FIXME\s0
.Sh "Collection"
.IX Subsection "Collection"
The collection hash is simply a hash of grammars with the grammar names as keys.
When a collection is given all methods can use a grammar name instead of a grammar.
.Sh "Base grammar"
.IX Subsection "Base grammar"
This can be seen as the default grammar, to use it leave the grammar undefined when calling 
a method. If this base grammar is defined \fIand\fR you specify a grammar at a method call, 
the specified grammar will overload the base grammar.
.SH "METHODS"
.IX Header "METHODS"
.ie n .IP """new(\e%base_grammar, \e%collection, \e%settings)""" 4
.el .IP "\f(CWnew(\e%base_grammar, \e%collection, \e%settings)\fR" 4
.IX Item "new(%base_grammar, %collection, %settings)"
Simple constructor. See \*(L"Collection\*(R", 
\&\*(L"Base grammar\*(R" and  \*(L"settings\*(R" for explanation of the arguments.
.ie n .IP """split($grammar, $input, $int)""" 4
.el .IP "\f(CWsplit($grammar, $input, $int)\fR" 4
.IX Item "split($grammar, $input, $int)"
Splits \f(CW$input\fR as specified by \f(CW$grammar\fR,
.Sp
\&\f(CW$input\fR can be either a string or a reference to an array of strings.
Such a array reference is used as provided, so it should be possible to use
for example tied arrays here.
.Sp
\&\f(CW$int\fR is an optional arguments specifying the maximum number of parts the input
should be splitted in. Remaining strings are joined and returned as the last part.
If you use a grammar with named tokens these are not counted as a part of the string.
.Sp
Blocks will by default be passed as scalar refs (unless the grammar's meta function altered them)
and tokens as scalars. To be a little compatible with \f(CW\*(C`CORE::split\*(C'\fR all items (blocks and tokens)
are passed as plain scalars if \f(CW$grammar\fR is or was a Regexp reference.
( This behaviour can be faked by giving your grammr a value called 'was_regexp'. )
This behaviour is turned off by the \*(L"no_split_intel\*(R" setting.
.Sh "settings"
.IX Subsection "settings"
The \f(CW%settings\fR hash contains options that control the  general behaviour of the parser.
Supported settings are:
.IP "allow_broken" 4
.IX Item "allow_broken"
If this value is set the parser will not throw an exception if for example 
an unmatched quote occurs
.IP "no_esc_rm" 4
.IX Item "no_esc_rm"
Boolean that tells the parser not to remove the escape char when an escaped token
is encountered. Double escapes won't be replaced either. Usefull when a string needs 
to go through a chain of parsers.
.IP "no_split_intel" 4
.IX Item "no_split_intel"
Boolean, disables \*(L"intelligent\*(R" behaviour of \f(CW\*(C`split()\*(C'\fR when set.
.SH "AUTHOR"
.IX Header "AUTHOR"
Jaap Karssenberg || Pardus [Larus] <pardus@cpan.org>
.PP
Copyright (c) 2003 Jaap G Karssenberg. All rights reserved.
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
.PP
Contains some code derived from Tie\-Hash\-Stack\-0.09 by Michael K. Neylon.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Zoidberg, Text::Balanced