Chip 2000 May

home *** CD-ROM | disk | FTP | other *** search

/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _3d02ca8500aae6e0a973cb2da9be409b < prev next >

Wrap

Text File | 2000-03-23 | 48KB | 914 lines

<HTML> <HEAD> <TITLE>Pod::Parser - base class for creating POD filters and translators</TITLE> <LINK REL="stylesheet" HREF="../../Active.css" TYPE="text/css"> <LINK REV="made" HREF="mailto:"> </HEAD> <BODY> <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%> <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc"> Pod::Parser - base class for creating POD filters and translators </TD></TR> </TABLE> <A NAME="__index__"></A>  <UL> <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI> <LI><A HREF="#synopsis">SYNOPSIS</A></LI> <LI><A HREF="#requires">REQUIRES</A></LI> <LI><A HREF="#exports">EXPORTS</A></LI> <LI><A HREF="#description">DESCRIPTION</A></LI> <LI><A HREF="#quick overview">QUICK OVERVIEW</A></LI> <LI><A HREF="#parsing options">PARSING OPTIONS</A></LI> <LI><A HREF="#recommended subroutine/method overrides">RECOMMENDED SUBROUTINE/METHOD OVERRIDES</A></LI> <LI><A HREF="#command()">command()</A></LI> <LI><A HREF="#verbatim()">verbatim()</A></LI> <LI><A HREF="#textblock()">textblock()</A></LI> <LI><A HREF="#interior_sequence()">interior_sequence()</A></LI> <LI><A HREF="#optional subroutine/method overrides">OPTIONAL SUBROUTINE/METHOD OVERRIDES</A></LI> <LI><A HREF="#new()">new()</A></LI> <LI><A HREF="#initialize()">initialize()</A></LI> <LI><A HREF="#begin_pod()">begin_pod()</A></LI> <LI><A HREF="#begin_input()">begin_input()</A></LI> <LI><A HREF="#end_input()">end_input()</A></LI> <LI><A HREF="#end_pod()">end_pod()</A></LI> <LI><A HREF="#preprocess_line()">preprocess_line()</A></LI> <LI><A HREF="#preprocess_paragraph()">preprocess_paragraph()</A></LI> <LI><A HREF="#methods for parsing and processing">METHODS FOR PARSING AND PROCESSING</A></LI> <LI><A HREF="#parse_text()">parse_text()</A></LI> <LI><A HREF="#interpolate()">interpolate()</A></LI> <LI><A HREF="#parse_paragraph()">parse_paragraph()</A></LI> <LI><A HREF="#parse_from_filehandle()">parse_from_filehandle()</A></LI> <LI><A HREF="#parse_from_file()">parse_from_file()</A></LI> <LI><A HREF="#accessor methods">ACCESSOR METHODS</A></LI> <LI><A HREF="#errorsub()">errorsub()</A></LI> <LI><A HREF="#cutting()">cutting()</A></LI> <LI><A HREF="#parseopts()">parseopts()</A></LI> <LI><A HREF="#output_file()">output_file()</A></LI> <LI><A HREF="#output_handle()">output_handle()</A></LI> <LI><A HREF="#input_file()">input_file()</A></LI> <LI><A HREF="#input_handle()">input_handle()</A></LI> <LI><A HREF="#input_streams()">input_streams()</A></LI> <LI><A HREF="#top_stream()">top_stream()</A></LI> <LI><A HREF="#private methods and data">PRIVATE METHODS AND DATA</A></LI> <LI><A HREF="#_push_input_stream()">_push_input_stream()</A></LI> <LI><A HREF="#_pop_input_stream()">_pop_input_stream()</A></LI> <LI><A HREF="#treebased parsing">TREE-BASED PARSING</A></LI> <LI><A HREF="#see also">SEE ALSO</A></LI> <LI><A HREF="#author">AUTHOR</A></LI> </UL>  <HR> <H1><A NAME="name">NAME</A></H1> Pod::Parser - base class for creating POD filters and translators <HR> <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1> <UL> <LI>Linux</LI> <LI>Solaris</LI> <LI>Windows</LI> </UL> <HR> <H1><A NAME="synopsis">SYNOPSIS</A></H1> <PRE> use Pod::Parser;</PRE> <PRE> package MyParser; @ISA = qw(Pod::Parser);</PRE> <PRE> sub command { my ($parser, $command, $paragraph, $line_num) = @_; ## Interpret the command and its text; sample actions might be: if ($command eq 'head1') { ... } elsif ($command eq 'head2') { ... } ## ... other commands and their actions my $out_fh = $parser->output_handle(); my $expansion = $parser->interpolate($paragraph, $line_num); print $out_fh $expansion; }</PRE> <PRE> sub verbatim { my ($parser, $paragraph, $line_num) = @_; ## Format verbatim paragraph; sample actions might be: my $out_fh = $parser->output_handle(); print $out_fh $paragraph; }</PRE> <PRE> sub textblock { my ($parser, $paragraph, $line_num) = @_; ## Translate/Format this block of text; sample actions might be: my $out_fh = $parser->output_handle(); my $expansion = $parser->interpolate($paragraph, $line_num); print $out_fh $expansion; }</PRE> <PRE> sub interior_sequence { my ($parser, $seq_command, $seq_argument) = @_; ## Expand an interior sequence; sample actions might be: return "*$seq_argument*" if ($seq_command eq 'B'); return "`$seq_argument'" if ($seq_command eq 'C'); return "_${seq_argument}_'" if ($seq_command eq 'I'); ## ... other sequence commands and their resulting text }</PRE> <PRE> package main;</PRE> <PRE> ## Create a parser object and have it parse file whose name was ## given on the command-line (use STDIN if no files were given). $parser = new MyParser(); $parser->parse_from_filehandle(\*STDIN) if (@ARGV == 0); for (@ARGV) { $parser->parse_from_file($_); }</PRE> <HR> <H1><A NAME="requires">REQUIRES</A></H1> perl5.005, Pod::InputObjects, Exporter, Symbol, Carp <HR> <H1><A NAME="exports">EXPORTS</A></H1> Nothing. <HR> <H1><A NAME="description">DESCRIPTION</A></H1> Pod::Parser is a base class for creating POD filters and translators. It handles most of the effort involved with parsing the POD sections from an input stream, leaving subclasses free to be concerned only with performing the actual translation of text. Pod::Parser parses PODs, and makes method calls to handle the various components of the POD. Subclasses of Pod::Parser override these methods to translate the POD into whatever output format they desire. <HR> <H1><A NAME="quick overview">QUICK OVERVIEW</A></H1> To create a POD filter for translating POD documentation into some other format, you create a subclass of Pod::Parser which typically overrides just the base class implementation for the following methods: <UL> <LI> command() <LI> verbatim() <LI> textblock() <LI> interior_sequence() </UL> You may also want to override the begin_input() and end_input() methods for your subclass (to perform any needed per-file and/or per-document initialization or cleanup). If you need to perform any preprocesssing of input before it is parsed you may want to override one or more of preprocess_line() and/or preprocess_paragraph(). Sometimes it may be necessary to make more than one pass over the input files. If this is the case you have several options. You can make the first pass using Pod::Parser and override your methods to store the intermediate results in memory somewhere for the end_pod() method to process. You could use Pod::Parser for several passes with an appropriate state variable to control the operation for each pass. If your input source can't be reset to start at the beginning, you can store it in some other structure as a string or an array and have that structure implement a getline() method (which is all that parse_from_filehandle() uses to read input). Feel free to add any member data fields you need to keep track of things like current font, indentation, horizontal or vertical position, or whatever else you like. Be sure to read <A HREF="#private methods and data">PRIVATE METHODS AND DATA</A> to avoid name collisions. For the most part, the Pod::Parser base class should be able to do most of the input parsing for you and leave you free to worry about how to intepret the commands and translate the result. Note that all we have described here in this quick overview is the simplest most straightforward use of Pod::Parser to do stream-based parsing. It is also possible to use the Pod::Parser::parse_text function to do more sophisticated tree-based parsing. See <A HREF="#treebased parsing">TREE-BASED PARSING</A>. <HR> <H1><A NAME="parsing options">PARSING OPTIONS</A></H1> A parse-option is simply a named option of Pod::Parser with a value that corresponds to a certain specified behavior. These various behaviors of Pod::Parser may be enabled/disabled by setting or or unsetting one or more parse-options using the parseopts() method. The set of currently accepted parse-options is as follows: <DL> <DT><A NAME="item_want_nonPODs">-want_nonPODs (default: unset)</A> <DD> Normally (by default) Pod::Parser will only provide access to the POD sections of the input. Input paragraphs that are not part of the POD-format documentation are not made available to the caller (not even using preprocess_paragraph()). Setting this option to a non-empty, non-zero value will allow preprocess_paragraph() to see non-POD sections of the input as well as POD sections. The cutting() method can be used to determine if the corresponding paragraph is a POD paragraph, or some other input paragraph. <DT><A NAME="item_process_cut_cmd">-process_cut_cmd (default: unset)</A> <DD> Normally (by default) Pod::Parser handles the <CODE>=cut</CODE> POD directive by itself and does not pass it on to the caller for processing. Setting this option to a non-empty, non-zero value will cause Pod::Parser to pass the <CODE>=cut</CODE> directive to the caller just like any other POD command (and hence it may be processed by the command() method). Pod::Parser will still interpret the <CODE>=cut</CODE> directive to mean that ``cutting mode'' has been (re)entered, but the caller will get a chance to capture the actual <CODE>=cut</CODE> paragraph itself for whatever purpose it desires. <DT><A NAME="item_warnings">-warnings (default: unset)</A> <DD> Normally (by default) Pod::Parser recognizes a bare minimum of pod syntax errors and warnings and issues diagnostic messages for errors, but not for warnings. (Use Pod::Checker to do more thorough checking of POD syntax.) Setting this option to a non-empty, non-zero value will cause Pod::Parser to issue diagnostics for the few warnings it recognizes as well as the errors. </DL> Please see <A HREF="#parseopts()">parseopts()</A> for a complete description of the interface for the setting and unsetting of parse-options. <HR> <H1><A NAME="recommended subroutine/method overrides">RECOMMENDED SUBROUTINE/METHOD OVERRIDES</A></H1> Pod::Parser provides several methods which most subclasses will probably want to override. These methods are as follows: <HR> <H1><A NAME="command()">command()</A></H1> <PRE> $parser->command($cmd,$text,$line_num,$pod_para);</PRE> This method should be overridden by subclasses to take the appropriate action when a POD command paragraph (denoted by a line beginning with ``='') is encountered. When such a POD directive is seen in the input, this method is called and is passed: <DL> <DT><A NAME="item_%24cmd"><CODE>$cmd</CODE></A> <DD> the name of the command for this POD paragraph <DT><A NAME="item_%24text"><CODE>$text</CODE></A> <DD> the paragraph text for the given POD paragraph command. <DT><A NAME="item_%24line_num"><CODE>$line_num</CODE></A> <DD> the line-number of the beginning of the paragraph <DT><A NAME="item_%24pod_para"><CODE>$pod_para</CODE></A> <DD> a reference to a <CODE>Pod::Paragraph</CODE> object which contains further information about the paragraph command (see <A HREF="../../lib/Pod/InputObjects.html">the Pod::InputObjects manpage</A> for details). </DL> Note that this method is called for <CODE>=pod</CODE> paragraphs. The base class implementation of this method simply treats the raw POD command as normal block of paragraph text (invoking the textblock() method with the command paragraph). <HR> <H1><A NAME="verbatim()">verbatim()</A></H1> <PRE> $parser->verbatim($text,$line_num,$pod_para);</PRE> This method may be overridden by subclasses to take the appropriate action when a block of verbatim text is encountered. It is passed the following parameters: <DL> <DT><CODE>$text</CODE> <DD> the block of text for the verbatim paragraph <DT><CODE>$line_num</CODE> <DD> the line-number of the beginning of the paragraph <DT><CODE>$pod_para</CODE> <DD> a reference to a <CODE>Pod::Paragraph</CODE> object which contains further information about the paragraph (see <A HREF="../../lib/Pod/InputObjects.html">the Pod::InputObjects manpage</A> for details). </DL> The base class implementation of this method simply prints the textblock (unmodified) to the output filehandle. <HR> <H1><A NAME="textblock()">textblock()</A></H1> <PRE> $parser->textblock($text,$line_num,$pod_para);</PRE> This method may be overridden by subclasses to take the appropriate action when a normal block of POD text is encountered (although the base class method will usually do what you want). It is passed the following parameters: <DL> <DT><CODE>$text</CODE> <DD> the block of text for the a POD paragraph <DT><CODE>$line_num</CODE> <DD> the line-number of the beginning of the paragraph <DT><CODE>$pod_para</CODE> <DD> a reference to a <CODE>Pod::Paragraph</CODE> object which contains further information about the paragraph (see <A HREF="../../lib/Pod/InputObjects.html">the Pod::InputObjects manpage</A> for details). </DL> In order to process interior sequences, subclasses implementations of this method will probably want to invoke either interpolate() or parse_text(), passing it the text block <A HREF="#item_%24text"><CODE>$text</CODE></A>, and the corresponding line number in <A HREF="#item_%24line_num"><CODE>$line_num</CODE></A>, and then perform any desired processing upon the returned result. The base class implementation of this method simply prints the text block as it occurred in the input stream). <HR> <H1><A NAME="interior_sequence()">interior_sequence()</A></H1> <PRE> $parser->interior_sequence($seq_cmd,$seq_arg,$pod_seq);</PRE> This method should be overridden by subclasses to take the appropriate action when an interior sequence is encountered. An interior sequence is an embedded command within a block of text which appears as a command name (usually a single uppercase character) followed immediately by a string of text which is enclosed in angle brackets. This method is passed the sequence command <CODE>$seq_cmd</CODE> and the corresponding text <CODE>$seq_arg</CODE>. It is invoked by the interpolate() method for each interior sequence that occurs in the string that it is passed. It should return the desired text string to be used in place of the interior sequence. The <CODE>$pod_seq</CODE> argument is a reference to a <CODE>Pod::InteriorSequence</CODE> object which contains further information about the interior sequence. Please see <A HREF="../../lib/Pod/InputObjects.html">the Pod::InputObjects manpage</A> for details if you need to access this additional information. Subclass implementations of this method may wish to invoke the nested() method of <CODE>$pod_seq</CODE> to see if it is nested inside some other interior-sequence (and if so, which kind). The base class implementation of the interior_sequence() method simply returns the raw text of the interior sequence (as it occurred in the input) to the caller. <HR> <H1><A NAME="optional subroutine/method overrides">OPTIONAL SUBROUTINE/METHOD OVERRIDES</A></H1> Pod::Parser provides several methods which subclasses may want to override to perform any special pre/post-processing. These methods do not have to be overridden, but it may be useful for subclasses to take advantage of them. <HR> <H1><A NAME="new()">new()</A></H1> <PRE> my $parser = Pod::Parser->new();</PRE> This is the constructor for Pod::Parser and its subclasses. You do not need to override this method! It is capable of constructing subclass objects as well as base class objects, provided you use any of the following constructor invocation styles: <PRE> my $parser1 = MyParser->new(); my $parser2 = new MyParser(); my $parser3 = $parser2->new();</PRE> where <CODE>MyParser</CODE> is some subclass of Pod::Parser. Using the syntax <CODE>MyParser::new()</CODE> to invoke the constructor is not recommended, but if you insist on being able to do this, then the subclass will need to override the new() constructor method. If you do override the constructor, you must be sure to invoke the initialize() method of the newly blessed object. Using any of the above invocations, the first argument to the constructor is always the corresponding package name (or object reference). No other arguments are required, but if desired, an associative array (or hash-table) my be passed to the new() constructor, as in: <PRE> my $parser1 = MyParser->new( MYDATA => $value1, MOREDATA => $value2 ); my $parser2 = new MyParser( -myflag => 1 );</PRE> All arguments passed to the new() constructor will be treated as key/value pairs in a hash-table. The newly constructed object will be initialized by copying the contents of the given hash-table (which may have been empty). The new() constructor for this class and all of its subclasses returns a blessed reference to the initialized object (hash-table). <HR> <H1><A NAME="initialize()">initialize()</A></H1> <PRE> $parser->initialize();</PRE> This method performs any necessary object initialization. It takes no arguments (other than the object instance of course, which is typically copied to a local variable named <CODE>$self</CODE>). If subclasses override this method then they must be sure to invoke <CODE>$self->SUPER::initialize()</CODE>. <HR> <H1><A NAME="begin_pod()">begin_pod()</A></H1> <PRE> $parser->begin_pod();</PRE> This method is invoked at the beginning of processing for each POD document that is encountered in the input. Subclasses should override this method to perform any per-document initialization. <HR> <H1><A NAME="begin_input()">begin_input()</A></H1> <PRE> $parser->begin_input();</PRE> This method is invoked by parse_from_filehandle() immediately before processing input from a filehandle. The base class implementation does nothing, however, subclasses may override it to perform any per-file initializations. Note that if multiple files are parsed for a single POD document (perhaps the result of some future <CODE>=include</CODE> directive) this method is invoked for every file that is parsed. If you wish to perform certain initializations once per document, then you should use begin_pod(). <HR> <H1><A NAME="end_input()">end_input()</A></H1> <PRE> $parser->end_input();</PRE> This method is invoked by parse_from_filehandle() immediately after processing input from a filehandle. The base class implementation does nothing, however, subclasses may override it to perform any per-file cleanup actions. Please note that if multiple files are parsed for a single POD document (perhaps the result of some kind of <CODE>=include</CODE> directive) this method is invoked for every file that is parsed. If you wish to perform certain cleanup actions once per document, then you should use end_pod(). <HR> <H1><A NAME="end_pod()">end_pod()</A></H1> <PRE> $parser->end_pod();</PRE> This method is invoked at the end of processing for each POD document that is encountered in the input. Subclasses should override this method to perform any per-document finalization. <HR> <H1><A NAME="preprocess_line()">preprocess_line()</A></H1> <PRE> $textline = $parser->preprocess_line($text, $line_num);</PRE> This method should be overridden by subclasses that wish to perform any kind of preprocessing for each line of input (before it has been determined whether or not it is part of a POD paragraph). The parameter <A HREF="#item_%24text"><CODE>$text</CODE></A> is the input line; and the parameter <A HREF="#item_%24line_num"><CODE>$line_num</CODE></A> is the line number of the corresponding text line. The value returned should correspond to the new text to use in its place. If the empty string or an undefined value is returned then no further processing will be performed for this line. Please note that the preprocess_line() method is invoked before the preprocess_paragraph() method. After all (possibly preprocessed) lines in a paragraph have been assembled together and it has been determined that the paragraph is part of the POD documentation from one of the selected sections, then preprocess_paragraph() is invoked. The base class implementation of this method returns the given text. <HR> <H1><A NAME="preprocess_paragraph()">preprocess_paragraph()</A></H1> <PRE> $textblock = $parser->preprocess_paragraph($text, $line_num);</PRE> This method should be overridden by subclasses that wish to perform any kind of preprocessing for each block (paragraph) of POD documentation that appears in the input stream. The parameter <A HREF="#item_%24text"><CODE>$text</CODE></A> is the POD paragraph from the input file; and the parameter <A HREF="#item_%24line_num"><CODE>$line_num</CODE></A> is the line number for the beginning of the corresponding paragraph. The value returned should correspond to the new text to use in its place If the empty string is returned or an undefined value is returned, then the given <A HREF="#item_%24text"><CODE>$text</CODE></A> is ignored (not processed). This method is invoked after gathering up all the lines in a paragraph and after determining the cutting state of the paragraph, but before trying to further parse or interpret them. After preprocess_paragraph() returns, the current cutting state (which is returned by <CODE>$self->cutting()</CODE>) is examined. If it evaluates to true then input text (including the given <A HREF="#item_%24text"><CODE>$text</CODE></A>) is cut (not processed) until the next POD directive is encountered. Please note that the preprocess_line() method is invoked before the preprocess_paragraph() method. After all (possibly preprocessed) lines in a paragraph have been assembled together and either it has been determined that the paragraph is part of the POD documentation from one of the selected sections or the <CODE>-want_nonPODs</CODE> option is true, then preprocess_paragraph() is invoked. The base class implementation of this method returns the given text. <HR> <H1><A NAME="methods for parsing and processing">METHODS FOR PARSING AND PROCESSING</A></H1> Pod::Parser provides several methods to process input text. These methods typically won't need to be overridden (and in some cases they can't be overridden), but subclasses may want to invoke them to exploit their functionality. <HR> <H1><A NAME="parse_text()">parse_text()</A></H1> <PRE> $ptree1 = $parser->parse_text($text, $line_num); $ptree2 = $parser->parse_text({%opts}, $text, $line_num); $ptree3 = $parser->parse_text(\%opts, $text, $line_num);</PRE> This method is useful if you need to perform your own interpolation of interior sequences and can't rely upon interpolate to expand them in simple bottom-up order order. The parameter <A HREF="#item_%24text"><CODE>$text</CODE></A> is a string or block of text to be parsed for interior sequences; and the parameter <A HREF="#item_%24line_num"><CODE>$line_num</CODE></A> is the line number curresponding to the beginning of <A HREF="#item_%24text"><CODE>$text</CODE></A>. parse_text() will parse the given text into a parse-tree of ``nodes.'' and interior-sequences. Each ``node'' in the parse tree is either a text-string, or a Pod::InteriorSequence. The result returned is a parse-tree of type Pod::ParseTree. Please see <A HREF="../../lib/Pod/InputObjects.html">the Pod::InputObjects manpage</A> for more information about Pod::InteriorSequence and Pod::ParseTree. If desired, an optional hash-ref may be specified as the first argument to customize certain aspects of the parse-tree that is created and returned. The set of recognized option keywords are: <DL> <DT><A NAME="item_%2Dexpand_seq_%3D%3E_code%2Dref%7Cmethod%2Dname">-expand_seq => code-ref|method-name</A> <DD> Normally, the parse-tree returned by parse_text() will contain an unexpanded <CODE>Pod::InteriorSequence</CODE> object for each interior-sequence encountered. Specifying -expand_seq tells parse_text() to ``expand'' every interior-sequence it sees by invoking the referenced function (or named method of the parser object) and using the return value as the expanded result. If a subroutine reference was given, it is invoked as: <PRE> &$code_ref( $parser, $sequence )</PRE> and if a method-name was given, it is invoked as: <PRE> $parser->method_name( $sequence )</PRE> where <CODE>$parser</CODE> is a reference to the parser object, and <CODE>$sequence</CODE> is a reference to the interior-sequence object. [NOTE: If the interior_sequence() method is specified, then it is invoked according to the interface specified in <A HREF="#interior_sequence()">interior_sequence()</A>]. <DT><A NAME="item_%2Dexpand_text_%3D%3E_code%2Dref%7Cmethod%2Dname">-expand_text => code-ref|method-name</A> <DD> Normally, the parse-tree returned by parse_text() will contain a text-string for each contiguous sequence of characters outside of an interior-sequence. Specifying -expand_text tells parse_text() to ``preprocess'' every such text-string it sees by invoking the referenced function (or named method of the parser object) and using the return value as the preprocessed (or ``expanded'') result. [Note that if the result is an interior-sequence, then it will not be expanded as specified by the -expand_seq option; Any such recursive expansion needs to be handled by the specified callback routine.] If a subroutine reference was given, it is invoked as: <PRE> &$code_ref( $parser, $text, $ptree_node )</PRE> and if a method-name was given, it is invoked as: <PRE> $parser->method_name( $text, $ptree_node )</PRE> where <CODE>$parser</CODE> is a reference to the parser object, <A HREF="#item_%24text"><CODE>$text</CODE></A> is the text-string encountered, and <CODE>$ptree_node</CODE> is a reference to the current node in the parse-tree (usually an interior-sequence object or else the top-level node of the parse-tree). <DT><A NAME="item_%2Dexpand_ptree_%3D%3E_code%2Dref%7Cmethod%2Dname">-expand_ptree => code-ref|method-name</A> <DD> Rather than returning a <CODE>Pod::ParseTree</CODE>, pass the parse-tree as an argument to the referenced subroutine (or named method of the parser object) and return the result instead of the parse-tree object. If a subroutine reference was given, it is invoked as: <PRE> &$code_ref( $parser, $ptree )</PRE> and if a method-name was given, it is invoked as: <PRE> $parser->method_name( $ptree )</PRE> where <CODE>$parser</CODE> is a reference to the parser object, and <CODE>$ptree</CODE> is a reference to the parse-tree object. </DL> <HR> <H1><A NAME="interpolate()">interpolate()</A></H1> <PRE> $textblock = $parser->interpolate($text, $line_num);</PRE> This method translates all text (including any embedded interior sequences) in the given text string <A HREF="#item_%24text"><CODE>$text</CODE></A> and returns the interpolated result. The parameter <A HREF="#item_%24line_num"><CODE>$line_num</CODE></A> is the line number corresponding to the beginning of <A HREF="#item_%24text"><CODE>$text</CODE></A>. interpolate() merely invokes a private method to recursively expand nested interior sequences in bottom-up order (innermost sequences are expanded first). If there is a need to expand nested sequences in some alternate order, use parse_text instead. <HR> <H1><A NAME="parse_from_filehandle()">parse_from_filehandle()</A></H1> <PRE> $parser->parse_from_filehandle($in_fh,$out_fh);</PRE> This method takes an input filehandle (which is assumed to already be opened for reading) and reads the entire input stream looking for blocks (paragraphs) of POD documentation to be processed. If no first argument is given the default input filehandle <CODE>STDIN</CODE> is used. The <CODE>$in_fh</CODE> parameter may be any object that provides a getline() method to retrieve a single line of input text (hence, an appropriate wrapper object could be used to parse PODs from a single string or an array of strings). Using <CODE>$in_fh->getline()</CODE>, input is read line-by-line and assembled into paragraphs or ``blocks'' (which are separated by lines containing nothing but whitespace). For each block of POD documentation encountered it will invoke a method to parse the given paragraph. If a second argument is given then it should correspond to a filehandle where output should be sent (otherwise the default output filehandle is <CODE>STDOUT</CODE> if no output filehandle is currently in use). NOTE: For performance reasons, this method caches the input stream at the top of the stack in a local variable. Any attempts by clients to change the stack contents during processing when in the midst executing of this method will not affect the input stream used by the current invocation of this method. This method does not usually need to be overridden by subclasses. <HR> <H1><A NAME="parse_from_file()">parse_from_file()</A></H1> <PRE> $parser->parse_from_file($filename,$outfile);</PRE> This method takes a filename and does the following: <UL> <LI> opens the input and output files for reading (creating the appropriate filehandles) <LI> invokes the parse_from_filehandle() method passing it the corresponding input and output filehandles. <LI> closes the input and output files. </UL> If the special input filename ``-'' or ``<&STDIN'' is given then the STDIN filehandle is used for input (and no open or close is performed). If no input filename is specified then ``-'' is implied. If a second argument is given then it should be the name of the desired output file. If the special output filename ``-'' or ``>&STDOUT'' is given then the STDOUT filehandle is used for output (and no open or close is performed). If the special output filename ``>&STDERR'' is given then the STDERR filehandle is used for output (and no open or close is performed). If no output filehandle is currently in use and no output filename is specified, then ``-'' is implied. This method does not usually need to be overridden by subclasses. <HR> <H1><A NAME="accessor methods">ACCESSOR METHODS</A></H1> Clients of Pod::Parser should use the following methods to access instance data fields: <HR> <H1><A NAME="errorsub()">errorsub()</A></H1> <PRE> $parser->errorsub("method_name"); $parser->errorsub(\&warn_user); $parser->errorsub(sub { print STDERR, @_ });</PRE> Specifies the method or subroutine to use when printing error messages about POD syntax. The supplied method/subroutine must return TRUE upon successful printing of the message. If <A HREF="../../lib/Pod/perlfunc.html#item_undef"><CODE>undef</CODE></A> is given, then the warn builtin is used to issue error messages (this is the default behavior). <PRE> my $errorsub = $parser->errorsub() my $errmsg = "This is an error message!\n" (ref $errorsub) and &{$errorsub}($errmsg) or (defined $errorsub) and $parser->$errorsub($errmsg) or warn($errmsg);</PRE> Returns a method name, or else a reference to the user-supplied subroutine used to print error messages. Returns <A HREF="../../lib/Pod/perlfunc.html#item_undef"><CODE>undef</CODE></A> if the warn builtin is used to issue error messages (this is the default behavior). <HR> <H1><A NAME="cutting()">cutting()</A></H1> <PRE> $boolean = $parser->cutting();</PRE> Returns the current <CODE>cutting</CODE> state: a boolean-valued scalar which evaluates to true if text from the input file is currently being ``cut'' (meaning it is not considered part of the POD document). <PRE> $parser->cutting($boolean);</PRE> Sets the current <CODE>cutting</CODE> state to the given value and returns the result. <HR> <H1><A NAME="parseopts()">parseopts()</A></H1> When invoked with no additional arguments, parseopts returns a hashtable of all the current parsing options. <PRE> ## See if we are parsing non-POD sections as well as POD ones my %opts = $parser->parseopts(); $opts{'-want_nonPODs}' and print "-want_nonPODs\n";</PRE> When invoked using a single string, parseopts treats the string as the name of a parse-option and returns its corresponding value if it exists (returns <A HREF="../../lib/Pod/perlfunc.html#item_undef"><CODE>undef</CODE></A> if it doesn't). <PRE> ## Did we ask to see '=cut' paragraphs? my $want_cut = $parser->parseopts('-process_cut_cmd'); $want_cut and print "-process_cut_cmd\n";</PRE> When invoked with multiple arguments, parseopts treats them as key/value pairs and the specified parse-option names are set to the given values. Any unspecified parse-options are unaffected. <PRE> ## Set them back to the default $parser->parseopts(-warnings => 0);</PRE> When passed a single hash-ref, parseopts uses that hash to completely reset the existing parse-options, all previous parse-option values are lost. <PRE> ## Reset all options to default $parser->parseopts( { } );</PRE> See <A HREF="#parsing options">PARSING OPTIONS</A> for more information on the name and meaning of each parse-option currently recognized. <HR> <H1><A NAME="output_file()">output_file()</A></H1> <PRE> $fname = $parser->output_file();</PRE> Returns the name of the output file being written. <HR> <H1><A NAME="output_handle()">output_handle()</A></H1> <PRE> $fhandle = $parser->output_handle();</PRE> Returns the output filehandle object. <HR> <H1><A NAME="input_file()">input_file()</A></H1> <PRE> $fname = $parser->input_file();</PRE> Returns the name of the input file being read. <HR> <H1><A NAME="input_handle()">input_handle()</A></H1> <PRE> $fhandle = $parser->input_handle();</PRE> Returns the current input filehandle object. <HR> <H1><A NAME="private methods and data">PRIVATE METHODS AND DATA</A></H1> Pod::Parser makes use of several internal methods and data fields which clients should not need to see or use. For the sake of avoiding name collisions for client data and methods, these methods and fields are briefly discussed here. Determined hackers may obtain further information about them by reading the Pod::Parser source code. Private data fields are stored in the hash-object whose reference is returned by the new() constructor for this class. The names of all private methods and data-fields used by Pod::Parser begin with a prefix of ``_'' and match the regular expression <CODE>/^_\w+$/</CODE>. <HR> <H1><A NAME="treebased parsing">TREE-BASED PARSING</A></H1> If straightforward stream-based parsing wont meet your needs (as is likely the case for tasks such as translating PODs into structured markup languages like HTML and XML) then you may need to take the tree-based approach. Rather than doing everything in one pass and calling the interpolate() method to expand sequences into text, it may be desirable to instead create a parse-tree using the parse_text() method to return a tree-like structure which may contain an ordered list list of children (each of which may be a text-string, or a similar tree-like structure). Pay special attention to <A HREF="#methods for parsing and processing">METHODS FOR PARSING AND PROCESSING</A> and to the objects described in <A HREF="../../lib/Pod/InputObjects.html">the Pod::InputObjects manpage</A>. The former describes the gory details and parameters for how to customize and extend the parsing behavior of Pod::Parser. Pod::InputObjects provides several objects that may all be used interchangeably as parse-trees. The most obvious one is the Pod::ParseTree object. It defines the basic interface and functionality that all things trying to be a POD parse-tree should do. A Pod::ParseTree is defined such that each ``node'' may be a text-string, or a reference to another parse-tree. Each Pod::Paragraph object and each Pod::InteriorSequence object also supports the basic parse-tree interface. The parse_text() method takes a given paragraph of text, and returns a parse-tree that contains one or more children, each of which may be a text-string, or an InteriorSequence object. There are also callback-options that may be passed to parse_text() to customize the way it expands or transforms interior-sequences, as well as the returned result. These callbacks can be used to create a parse-tree with custom-made objects (which may or may not support the parse-tree interface, depending on how you choose to do it). If you wish to turn an entire POD document into a parse-tree, that process is fairly straightforward. The parse_text() method is the key to doing this successfully. Every paragraph-callback (i.e. the polymorphic methods for command(), verbatim(), and textblock() paragraphs) takes a Pod::Paragraph object as an argument. Each paragraph object has a parse_tree() method that can be used to get or set a corresponding parse-tree. So for each of those paragraph-callback methods, simply call parse_text() with the options you desire, and then use the returned parse-tree to assign to the given paragraph object. That gives you a parse-tree for each paragraph - so now all you need is an ordered list of paragraphs. You can maintain that yourself as a data element in the object/hash. The most straightforward way would be simply to use an array-ref, with the desired set of custom ``options'' for each invocation of parse_text. Let's assume the desired option-set is given by the hash <CODE>%options</CODE>. Then we might do something like the following: <PRE> package MyPodParserTree;</PRE> <PRE> @ISA = qw( Pod::Parser );</PRE> <PRE> ...</PRE> <PRE> sub begin_pod { my $self = shift; $self->{'-paragraphs'} = []; ## initialize paragraph list }</PRE> <PRE> sub command { my ($parser, $command, $paragraph, $line_num, $pod_para) = @_; my $ptree = $parser->parse_text({%options}, $paragraph, ...); $pod_para->parse_tree( $ptree ); push @{ $self->{'-paragraphs'} }, $pod_para; }</PRE> <PRE> sub verbatim { my ($parser, $paragraph, $line_num, $pod_para) = @_; push @{ $self->{'-paragraphs'} }, $pod_para; }</PRE> <PRE> sub textblock { my ($parser, $paragraph, $line_num, $pod_para) = @_; my $ptree = $parser->parse_text({%options}, $paragraph, ...); $pod_para->parse_tree( $ptree ); push @{ $self->{'-paragraphs'} }, $pod_para; }</PRE> <PRE> ...</PRE> <PRE> package main; ... my $parser = new MyPodParserTree(...); $parser->parse_from_file(...); my $paragraphs_ref = $parser->{'-paragraphs'};</PRE> Of course, in this module-author's humble opinion, I'd be more inclined to use the existing Pod::ParseTree object than a simple array. That way everything in it, paragraphs and sequences, all respond to the same core interface for all parse-tree nodes. The result would look something like: <PRE> package MyPodParserTree2;</PRE> <PRE> ...</PRE> <PRE> sub begin_pod { my $self = shift; $self->{'-ptree'} = new Pod::ParseTree; ## initialize parse-tree }</PRE> <PRE> sub parse_tree { ## convenience method to get/set the parse-tree for the entire POD (@_ > 1) and $_[0]->{'-ptree'} = $_[1]; return $_[0]->{'-ptree'}; }</PRE> <PRE> sub command { my ($parser, $command, $paragraph, $line_num, $pod_para) = @_; my $ptree = $parser->parse_text({<<options>>}, $paragraph, ...); $pod_para->parse_tree( $ptree ); $parser->parse_tree()->append( $pod_para ); }</PRE> <PRE> sub verbatim { my ($parser, $paragraph, $line_num, $pod_para) = @_; $parser->parse_tree()->append( $pod_para ); }</PRE> <PRE> sub textblock { my ($parser, $paragraph, $line_num, $pod_para) = @_; my $ptree = $parser->parse_text({<<options>>}, $paragraph, ...); $pod_para->parse_tree( $ptree ); $parser->parse_tree()->append( $pod_para ); }</PRE> <PRE> ...</PRE> <PRE> package main; ... my $parser = new MyPodParserTree2(...); $parser->parse_from_file(...); my $ptree = $parser->parse_tree; ...</PRE> Now you have the entire POD document as one great big parse-tree. You can even use the -expand_seq option to parse_text to insert whole different kinds of objects. Just don't expect Pod::Parser to know what to do with them after that. That will need to be in your code. Or, alternatively, you can insert any object you like so long as it conforms to the Pod::ParseTree interface. One could use this to create subclasses of Pod::Paragraphs and Pod::InteriorSequences for specific commands (or to create your own custom node-types in the parse-tree) and add some kind of emit() method to each custom node/subclass object in the tree. Then all you'd need to do is recursively walk the tree in the desired order, processing the children (most likely from left to right) by formatting them if they are text-strings, or by calling their emit() method if they are objects/references. <HR> <H1><A NAME="see also">SEE ALSO</A></H1> <A HREF="../../lib/Pod/InputObjects.html">the Pod::InputObjects manpage</A>, <A HREF="../../lib/Pod/Select.html">the Pod::Select manpage</A> Pod::InputObjects defines POD input objects corresponding to command paragraphs, parse-trees, and interior-sequences. Pod::Select is a subclass of Pod::Parser which provides the ability to selectively include and/or exclude sections of a POD document from being translated based upon the current heading, subheading, subsubheading, etc. <HR> <H1><A NAME="author">AUTHOR</A></H1> Brad Appleton <<A HREF="mailto:bradapp@enteract.com">bradapp@enteract.com</A>> Based on code for Pod::Text written by Tom Christiansen <<A HREF="mailto:tchrist@mox.perl.com">tchrist@mox.perl.com</A>> <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%> <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc"> Pod::Parser - base class for creating POD filters and translators </TD></TR> </TABLE> </BODY> </HTML>