Lines Matching full:parser
34 then possibly even read L<perlpodspec> (some of which is for parser-writers,
41 =item C<< $parser = I<SomeClass>->new(); >>
43 This returns a new parser object, where I<C<SomeClass>> is a subclass
46 =item C<< $parser->output_fh( *OUT ); >>
48 This sets the filehandle that C<$parser>'s output will be written to.
54 $parser->output_fh(*TXTOUT);
56 ...before you call one of the C<< $parser->parse_I<whatever> >> methods.
58 =item C<< $parser->output_string( \$somestring ); >>
60 This sets the string that C<$parser>'s output will be sent to,
64 =item C<< $parser->parse_file( I<$some_filename> ); >>
66 =item C<< $parser->parse_file( *INPUT_FH ); >>
69 and processes it with that C<$parser> object, according to however
70 C<$parser>'s class works, and according to whatever parser options you
71 have set up for this C<$parser> object.
73 =item C<< $parser->parse_string_document( I<$all_content> ); >>
79 =item C<< $parser->parse_lines( I<...@lines...>, undef ); >>
87 per C<$parser> object; but C<parse_lines> can be called as many times per
88 C<$parser> object as you want, as long as the last call (and only
92 =item C<< $parser->content_seen >>
104 This is a shortcut method for creating a new parser object, setting the
121 read the attribute's value with C<< $value = $parser->I<attribute> >>
123 C<< $parser->I<attribute>(I<newvalue>) >>. For each accessor, I typically
130 =item C<< $parser->parse_characters( I<SOMEVALUE> ) >>
132 The Pod parser normally expects to read octets and to convert those octets
135 character stream. This tells the parser to ignore any C<=encoding> command
138 =item C<< $parser->no_whining( I<SOMEVALUE> ) >>
141 parser's complaints about irregularities in the Pod coding. By default,
149 =item C<< $parser->no_errata_section( I<SOMEVALUE> ) >>
151 If you set this attribute to a true value, you will stop the parser from
157 =item C<< $parser->complain_stderr( I<SOMEVALUE> ) >>
166 =item C<< $parser->source_filename >>
168 This returns the filename that this parser object was set to read from.
171 =item C<< $parser->doc_has_started >>
173 This returns true if C<$parser> has read from a source, and has seen
177 =item C<< $parser->source_dead >>
179 This returns true if C<$parser> has read from a source, and come to the
182 =item C<< $parser->strip_verbatim_indent( I<SOMEVALUE> ) >>
195 $parser->strip_verbatim_indent(' ');
199 $parser->strip_verbatim_indent("\t");
226 =item C<< $parser->expand_verbatim_tabs( I<n> ) >>
247 =item C<< $parser->abandon_output_fh() >>X<abandon_output_fh>
249 Cancel output to the file handle. Any POD read by the C<$parser> is not
252 =item C<< $parser->abandon_output_string() >>X<abandon_output_string>
254 Cancel output to the output string. Any POD read by the C<$parser> is not
257 =item C<< $parser->accept_code( @codes ) >>X<accept_code>
261 =item C<< $parser->accept_codes( @codes ) >>X<accept_codes>
263 Allows C<$parser> to accept a list of L<perlpod/Formatting Codes>. This can be
266 =item C<< $parser->accept_directive_as_data( @directives ) >>X<accept_directive_as_data>
268 Allows C<$parser> to accept a list of directives for data paragraphs. A
273 =item C<< $parser->accept_directive_as_processed( @directives ) >>X<accept_directive_as_processed>
275 Allows C<$parser> to accept a list of directives for processed paragraphs. A
280 =item C<< $parser->accept_directive_as_verbatim( @directives ) >>X<accept_directive_as_verbatim>
282 Allows C<$parser> to accept a list of directives for L<perlpod/Verbatim
286 =item C<< $parser->accept_target( @targets ) >>X<accept_target>
290 =item C<< $parser->accept_target_as_text( @targets ) >>X<accept_target_as_text>
294 =item C<< $parser->accept_targets( @targets ) >>X<accept_targets>
298 =item C<< $parser->accept_targets_as_text( @targets ) >>X<accept_targets_as_text>
303 =item C<< $parser->any_errata_seen() >>X<any_errata_seen>
309 die "too many errors\n" if $parser->any_errata_seen();
311 =item C<< $parser->errata_seen() >>X<errata_seen>
317 if ( $parser->any_errata_seen() ) {
318 $logger->log( $parser->errata_seen() );
321 =item C<< $parser->detected_encoding() >>X<detected_encoding>
326 =item C<< $parser->encoding() >>X<encoding>
331 =item C<< $parser->parse_from_file( $source, $to ) >>X<parse_from_file>
334 Pod::Parser/parse_from_file >>.
336 =item C<< $parser->scream( @error_messages ) >>X<scream>
340 =item C<< $parser->unaccept_code( @codes ) >>X<unaccept_code>
344 =item C<< $parser->unaccept_codes( @codes ) >>X<unaccept_codes>
348 =item C<< $parser->unaccept_directive( @directives ) >>X<unaccept_directive>
352 =item C<< $parser->unaccept_directives( @directives ) >>X<unaccept_directives>
356 =item C<< $parser->unaccept_target( @targets ) >>X<unaccept_target>
360 =item C<< $parser->unaccept_targets( @targets ) >>X<unaccept_targets>
364 =item C<< $parser->version_report() >>X<version_report>
368 =item C<< $parser->whine( @error_messages ) >>X<whine>
370 Log an error unless C<< $parser->no_whining( TRUE ); >>.
376 The Pod::Simple parser expects to read B<octets>. The parser will decode the
380 If the POD source does not include an C<=encoding> declaration, the parser will
386 If you set the C<parse_characters> option to a true value the parser will