The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
PodParser-1.03
River stage zero No dependents
++
/ Pod::Parser

NAME

Pod::Parser - base class for creating POD filters and translators

SYNOPSIS

    use Pod::Parser;

    package MyParser;
    @ISA = qw(Pod::Parser);

    sub command { 
        my ($parser, $command, $paragraph, $attributes) = @_;
        ## 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);
        print $out_fh $expansion;
    }

    sub verbatim { 
        my ($parser, $paragraph) = @_;
        ## Format verbatim paragraph; sample actions might be:
        my $out_fh = $parser->output_handle();
        print $out_fh $paragraph;
    }

    sub textblock { 
        my ($parser, $paragraph) = @_;
        ## Translate/Format this block of text; sample actions might be:
        my $out_fh = $parser->output_handle();
        my $expansion = $parser->interpolate($paragraph);
        print $out_fh $expansion;
    }

    sub interior_sequence { 
        my ($parser, $seq_command, $seq_argument, $attributes) = @_;
        ## Expand an interior sequence; sample actions might be:
        return "*$seq_argument*"     if ($seq_command = 'B');
        return "`$seq_argument'"     if ($seq_command = 'C');
        return "_${seq_argument}_'"  if ($seq_command = 'I');
        ## ... other sequence commands and their resulting text
    }

    package main;

    ## 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($_); }

REQUIRES

perl5.003, Exporter, FileHandle, Carp

EXPORTS

Nothing.

DESCRIPTION

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.

QUICK OVERVIEW

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:

  • command()

  • verbatim()

  • textblock()

  • interior_sequence()

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 "PRIVATE METHODS AND DATA" 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.

RECOMMENDED SUBROUTINE/METHOD OVERRIDES

Pod::Parser provides several methods which most subclasses will probably want to override. These methods are as follows:

command()

            $parser->command($cmd,$text,$attrs);

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 the command name $cmd, and the remainder of the text paragraph $text, which appears immediately after the command name. The $attrs argument is a reference to a hash-table (associative array) which indicates some attributes or properties of the command. Currently supported attributed supported are:

-prefix

The command-prefix used (which should be the string "=").

-separator

The string of characters which separated the command from its corresponding text.

Note that this method is called for =pod 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).

verbatim()

            $parser->verbatim($text);

This method may be overridden by subclasses to take the appropriate action when a block of verbatim text is encountered. It is passed the text block $text as a parameter.

The base class implementation of this method simply prints the textblock (unmodified) to the output filehandle.

textblock()

            $parser->textblock($text);

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 text block $text as a parameter.

In order to process interior sequences, subclasses implementations of this method will probably want invoke the interpolate() method, passing it the text block $text as a parameter 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).

interior_sequence()

            $parser->interior_sequence($seq_cmd,$seq_arg,$attrs);

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 $seq_cmd and the corresponding text $seq_arg. 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 $attrs argument is a reference to a hash-table (associative array) which indicates some attributes or properties of the interior sequence. Currently supported attributes supported are:

-ldelim

The leftmost delimiter beginning the $seq_arg (should be "<").

-rdelim

The rightmost delimiter ending the $seq_arg (should be ">").

Subclass implementations of this method may wish to invoke the the sequence_commands() method to examine the set of interior sequence commands that are in the middle of being processed (there might be several such sequence commands if nested interior sequences appear in the input). See "sequence_commands()".

The base class implementation of the interior_sequence() method simply returns the raw text of the of the interior sequence (as it occurred in the input) to the caller.

OPTIONAL SUBROUTINE/METHOD OVERRIDES

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.

new()

            Pod::Parser->new();

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:

    my $parser1 = MyParser->new();
    my $parser2 = new MyParser();
    my $parser3 = $parser2->new();

where MyParser is some subclass of Pod::Parser.

Using the syntax MyParser::new() 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:

    my $parser1 = MyParser->new( MYDATA => $value1, MOREDATA => $value2 );
    my $parser2 = new MyParser( -myflag => 1 );

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).

initialize()

            $parser->initialize();

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 $self). If subclasses override this method then they must be sure to invoke $self->SUPER::initialize().

begin_pod()

            $parser->begin_pod();

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.

begin_input()

            $parser->begin_input();

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 =include 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().

end_input()

            $parser->end_input();

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 =include 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().

end_pod()

            $parser->end_pod();

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.

preprocess_line()

          $textline = $parser->preprocess_line($text);

This methods 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 $text is the input line and 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 process will be performed for this line. If desired, this method can call the parse_paragraph() method directly with any preprocessed text and return an empty string (to indicate that no further processing is needed).

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.

preprocess_paragraph()

            $textblock = $parser->preprocess_paragraph($text);

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 $text is the POD paragraph from the input file and 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 $text is ignored (not processed).

This method is invoked by parse_paragraph(). After it returns, parse_paragraph() examines the current cutting state (which is returned by $self->cutting()). If it evaluates to false then input text (including the given $text) 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 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.

METHODS FOR PARSING AND PROCESSING

Pod::Parser provides several methods to process input text. These methods typically won't need to be overridden, but subclasses may want to invoke them to exploit their functionality.

interpolate()

            $textblock = $parser->interpolate($text,$end_re);

This method translates all text (including any embedded interior sequences) in the given text string $text and returns the interpolated result. If a second argument is given, then it is must be a regular expression which, when matched in the text, indicates when to quit interpolating the string.

interpolate() merely invokes a private method to recursively expand nested interior sequences in bottom-up order (innermost sequences are expanded first). Unless there is a need to expand nested sequences in some alternate order, this method should probably not be overridden by subclasses.

parse_paragraph()

            $parser->parse_paragraph($text);

This method takes the text of a POD paragraph to be processed and invokes the appropriate method (one of command(), verbatim(), or textblock()).

This method does not usually need to be overridden by subclasses.

parse_from_filehandle()

            $parser->parse_from_filehandle($in_fh,$out_fh);

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 STDIN is used.

The $in_fh 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 $in_fh->getline(), 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 call the parse_paragraph() method.

If a second argument is given then it should correspond to a filehandle where output should be sent (otherwise the default output filehandle is STDOUT 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.

parse_from_file()

            $parser->parse_from_file($filename,$outfile);

This method takes a filename and does the following:

  • opens the input and output files for reading (creating the appropriate filehandles)

  • invokes the parse_from_filehandle() method passing it the corresponding input and output filehandles.

  • closes the input and output files.

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.

ACCESSOR METHODS

Clients of Pod::Parser should use the following methods to access instance data fields:

cutting()

            $boolean = $parser->cutting();

Returns the current cutting 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).

            $parser->cutting($boolean);

Sets the current cutting state to the given value and returns the result.

output_file()

            $fname = $parser->output_file();

Returns the name of the output file being written.

output_handle()

            $fhandle = $parser->output_handle();

Returns the output filehandle object.

input_file()

            $fname = $parser->input_file();

Returns the name of the input file being read.

input_handle()

            $fhandle = $parser->input_handle();

Returns the current input filehandle object.

total_lines()

            $numlines = $parser->total_lines();

The total number of input lines read thus far. This includes all lines, regardless of whether or not they were part of the POD documentation.

total_paragraphs()

            $numpara = $parser->total_paragraphs();

The total number of input paragraphs read thus far. This includes all paragraphs, regardless of whether or not they were part of the POD documentation.

input_streams()

            $listref = $parser->input_streams();

Returns a reference to an array which corresponds to the stack of all the input streams that are currently in the middle of being parsed.

While parsing an input stream, it is possible to invoke parse_from_file() or parse_from_filehandle() to parse a new input stream and then return to parsing the previous input stream. Each input stream to be parsed is pushed onto the end of this input stack before any of its input is read. The input stream that is currently being parsed is always at the end (or top) of the input stack. When an input stream has been exhausted, it is popped off the end of the input stack.

Each element on this input stack is a reference to a hash-table whose elements are indexed by the following keys:

-name

The name of the corresponding input file.

-handle

The corresponding input filehandle.

-lines

The number of input lines read from the corresponding input stream.

-paragraphs

The number of paragraphs read from the corresponding input stream (which includes input paragraphs that are not part of the POD documentation).

-was_cutting

The value of the cutting state (that the cutting() method would have returned) immediately before any input was read from this input stream. After all input from this stream has been read, the cutting state is restored to this value.

This method might be invoked when printing diagnostic messages, for example, to obtain the name and line number of the all input files that are currently being processed.

top_stream()

            $hashref = $parser->top_stream();

Returns a reference to the hash-table that represents the element that is currently at the top (end) of the input stream stack (see "input_streams()"). The return value will be the undef if the input stack is empty.

This method might be used when printing diagnostic messages, for example, to obtain the name and line number of the current input file.

sequence_commands()

            $listref = $parser->sequence_commands();

Returns a reference to an array that corresponds to the list of interior sequence commands that are currently in the middle of being processed. The array will have multiple elements only when in the middle of processing nested interior sequences.

The current interior sequence command (the one currently being processes) should always be at the top of this stack. Each element on this stack is a reference to a hash-table whose elements are indexed by the following keys:

-name

The command-name of the corresponding interior sequence.

PRIVATE METHODS AND DATA

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. Determned 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 /^_\w+$/.

SEE ALSO

See Pod::Select and Pod::Callbacks.

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.

Pod::Callbacks is a subclass of Pod::Parser which gives its users the ability the employ callback functions instead of, or in addition to, overriding methods of the base class.

Pod::Select and Pod::Callbacks do not override any methods nor do they define any new methods with the same name. Because of this, they may both be used (in combination) as a base class of the same subclass in order to combine their functionality without causing any namespace clashes due to multiple inheritance.

AUTHOR

Brad Appleton <bradapp@enteract.mot.con>

Based on code for Pod::Text written by Tom Christiansen <tchrist@mox.perl.com>