Manual

Reference

Modules

  • A • B • C • D • E
  • F • G • H • I • L
  • M • N • O • P • S
  • T • U • X

Tools

Pod::InputObjects

Perl 5 version 8.8 documentation
Go to top • Download PDF
Show page index • Show recent pages
Recently read

Pod::InputObjects

NAME

Pod::InputObjects - objects representing POD input paragraphs, commands, etc.

SYNOPSIS

  1.     use Pod::InputObjects;

REQUIRES

perl5.004, Carp

EXPORTS

Nothing.

DESCRIPTION

This module defines some basic input objects used by Pod::Parser when reading and parsing POD text from an input source. The following objects are defined:

  • package Pod::InputSource

    An object corresponding to a source of POD input text. It is mostly a wrapper around a filehandle or C-type object (or anything that implements the C method) which keeps track of some additional information relevant to the parsing of PODs.

An object corresponding to a paragraph of POD input text. It may be a plain paragraph, a verbatim paragraph, or a command paragraph (see L).

An object corresponding to an interior sequence command from the POD input text (see L).

An object corresponding to a tree of parsed POD text. Each "node" in a parse-tree (or I) is either a text-string or a reference to a B object. The nodes appear in the parse-tree in the order in which they were parsed from left-to-right.

Each of these input objects are described in further detail in the sections which follow.

Pod::InputSource

This object corresponds to an input source or stream of POD documentation. When parsing PODs, it is necessary to associate and store certain context information with each input source. All of this information is kept together with the stream itself in one of these C objects. Each such object is merely a wrapper around an C object of some kind (or at least something that implements the C method). They have the following methods/attributes:

new()

  1.         my $pod_input1 = Pod::InputSource->new(-handle => $filehandle);
  2.         my $pod_input2 = new Pod::InputSource(-handle => $filehandle,
  3.                                               -name   => $name);
  4.         my $pod_input3 = new Pod::InputSource(-handle => \*STDIN);
  5.         my $pod_input4 = Pod::InputSource->new(-handle => \*STDIN,
  6.                                                -name => "(STDIN)");

This is a class method that constructs a C object and returns a reference to the new input source object. It takes one or more keyword arguments in the form of a hash. The keyword C<-handle> is required and designates the corresponding input handle. The keyword C<-name> is optional and specifies the name associated with the input handle (typically a file name).

name()

  1.         my $filename = $pod_input->name();
  2.         $pod_input->name($new_filename_to_use);

This method gets/sets the name of the input source (usually a filename). If no argument is given, it returns a string containing the name of the input source; otherwise it sets the name of the input source to the contents of the given argument.

handle()

  1.         my $handle = $pod_input->handle();

Returns a reference to the handle object from which input is read (the one used to contructed this input source object).

was_cutting()

  1.         print "Yes.\n" if ($pod_input->was_cutting());

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

Pod::Paragraph

An object representing a paragraph of POD input text. It has the following methods/attributes:

Pod::Paragraph->new()

  1.         my $pod_para1 = Pod::Paragraph->new(-text => $text);
  2.         my $pod_para2 = Pod::Paragraph->new(-name => $cmd,
  3.                                             -text => $text);
  4.         my $pod_para3 = new Pod::Paragraph(-text => $text);
  5.         my $pod_para4 = new Pod::Paragraph(-name => $cmd,
  6.                                            -text => $text);
  7.         my $pod_para5 = Pod::Paragraph->new(-name => $cmd,
  8.                                             -text => $text,
  9.                                             -file => $filename,
  10.                                             -line => $line_number);

This is a class method that constructs a C object and returns a reference to the new paragraph object. It may be given one or two keyword arguments. The C<-text> keyword indicates the corresponding text of the POD paragraph. The C<-name> keyword indicates the name of the corresponding POD command, such as C or C (it should I contain the C<=> prefix); this is needed only if the POD paragraph corresponds to a command paragraph. The C<-file> and C<-line> keywords indicate the filename and line number corresponding to the beginning of the paragraph

$pod_para->cmd_name()

  1.         my $para_cmd = $pod_para->cmd_name();

If this paragraph is a command paragraph, then this method will return the name of the command (I any leading C<=> prefix).

$pod_para->text()

  1.         my $para_text = $pod_para->text();

This method will return the corresponding text of the paragraph.

$pod_para->raw_text()

  1.         my $raw_pod_para = $pod_para->raw_text();

This method will return the I text of the POD paragraph, exactly as it appeared in the input.

$pod_para->cmd_prefix()

  1.         my $prefix = $pod_para->cmd_prefix();

If this paragraph is a command paragraph, then this method will return the prefix used to denote the command (which should be the string "=" or "==").

$pod_para->cmd_separator()

  1.         my $separator = $pod_para->cmd_separator();

If this paragraph is a command paragraph, then this method will return the text used to separate the command name from the rest of the paragraph (if any).

$pod_para->parse_tree()

  1.         my $ptree = $pod_parser->parse_text( $pod_para->text() );
  2.         $pod_para->parse_tree( $ptree );
  3.         $ptree = $pod_para->parse_tree();

This method will get/set the corresponding parse-tree of the paragraph's text.

$pod_para->file_line()

  1.         my ($filename, $line_number) = $pod_para->file_line();
  2.         my $position = $pod_para->file_line();

Returns the current filename and line number for the paragraph object. If called in a list context, it returns a list of two elements: first the filename, then the line number. If called in a scalar context, it returns a string containing the filename, followed by a colon (':'), followed by the line number.

Pod::InteriorSequence

An object representing a POD interior sequence command. It has the following methods/attributes:

Pod::InteriorSequence->new()

  1.         my $pod_seq1 = Pod::InteriorSequence->new(-name => $cmd
  2.                                                   -ldelim => $delimiter);
  3.         my $pod_seq2 = new Pod::InteriorSequence(-name => $cmd,
  4.                                                  -ldelim => $delimiter);
  5.         my $pod_seq3 = new Pod::InteriorSequence(-name => $cmd,
  6.                                                  -ldelim => $delimiter,
  7.                                                  -file => $filename,
  8.                                                  -line => $line_number);
  10.         my $pod_seq4 = new Pod::InteriorSequence(-name => $cmd, $ptree);
  11.         my $pod_seq5 = new Pod::InteriorSequence($cmd, $ptree);

This is a class method that constructs a C object and returns a reference to the new interior sequence object. It should be given two keyword arguments. The C<-ldelim> keyword indicates the corresponding left-delimiter of the interior sequence (e.g. 'E'). The C<-name> keyword indicates the name of the corresponding interior sequence command, such as C or C or C. The C<-file> and C<-line> keywords indicate the filename and line number corresponding to the beginning of the interior sequence. If the C<$ptree> argument is given, it must be the last argument, and it must be either string, or else an array-ref suitable for passing to B (or it may be a reference to a Pod::ParseTree object).

$pod_seq->cmd_name()

  1.         my $seq_cmd = $pod_seq->cmd_name();

The name of the interior sequence command.

$pod_seq->prepend()

  1.         $pod_seq->prepend($text);
  2.         $pod_seq1->prepend($pod_seq2);

Prepends the given string or parse-tree or sequence object to the parse-tree of this interior sequence.

$pod_seq->append()

  1.         $pod_seq->append($text);
  2.         $pod_seq1->append($pod_seq2);

Appends the given string or parse-tree or sequence object to the parse-tree of this interior sequence.

$pod_seq->nested()

  1.         $outer_seq = $pod_seq->nested || print "not nested";

If this interior sequence is nested inside of another interior sequence, then the outer/parent sequence that contains it is returned. Otherwise C is returned.

$pod_seq->raw_text()

  1.         my $seq_raw_text = $pod_seq->raw_text();

This method will return the I text of the POD interior sequence, exactly as it appeared in the input.

$pod_seq->left_delimiter()

  1.         my $ldelim = $pod_seq->left_delimiter();

The leftmost delimiter beginning the argument text to the interior sequence (should be "<").

$pod_seq->right_delimiter()

The rightmost delimiter beginning the argument text to the interior sequence (should be ">").

$pod_seq->parse_tree()

  1.         my $ptree = $pod_parser->parse_text($paragraph_text);
  2.         $pod_seq->parse_tree( $ptree );
  3.         $ptree = $pod_seq->parse_tree();

This method will get/set the corresponding parse-tree of the interior sequence's text.

$pod_seq->file_line()

  1.         my ($filename, $line_number) = $pod_seq->file_line();
  2.         my $position = $pod_seq->file_line();

Returns the current filename and line number for the interior sequence object. If called in a list context, it returns a list of two elements: first the filename, then the line number. If called in a scalar context, it returns a string containing the filename, followed by a colon (':'), followed by the line number.

Pod::InteriorSequence::DESTROY()

This method performs any necessary cleanup for the interior-sequence. If you override this method then it is B that you invoke the parent method from within your own method, otherwise I

Pod::ParseTree

This object corresponds to a tree of parsed POD text. As POD text is scanned from left to right, it is parsed into an ordered list of text-strings and B objects (in order of appearance). A B object corresponds to this list of strings and sequences. Each interior sequence in the parse-tree may itself contain a parse-tree (since interior sequences may be nested).

Pod::ParseTree->new()

  1.         my $ptree1 = Pod::ParseTree->new;
  2.         my $ptree2 = new Pod::ParseTree;
  3.         my $ptree4 = Pod::ParseTree->new($array_ref);
  4.         my $ptree3 = new Pod::ParseTree($array_ref);

This is a class method that constructs a C object and returns a reference to the new parse-tree. If a single-argument is given, it must be a reference to an array, and is used to initialize the root (top) of the parse tree.

$ptree->top()

  1.         my $top_node = $ptree->top();
  2.         $ptree->top( $top_node );
  3.         $ptree->top( @children );

This method gets/sets the top node of the parse-tree. If no arguments are given, it returns the topmost node in the tree (the root), which is also a B. If it is given a single argument that is a reference, then the reference is assumed to a parse-tree and becomes the new top node. Otherwise, if arguments are given, they are treated as the new list of children for the top node.

$ptree->children()

This method gets/sets the children of the top node in the parse-tree. If no arguments are given, it returns the list (array) of children (each of which should be either a string or a B. Otherwise, if arguments are given, they are treated as the new list of children for the top node.

$ptree->prepend()

This method prepends the given text or parse-tree to the current parse-tree. If the first item on the parse-tree is text and the argument is also text, then the text is prepended to the first item (not added as a separate string). Otherwise the argument is added as a new string or parse-tree I the current one.

$ptree->append()

This method appends the given text or parse-tree to the current parse-tree. If the last item on the parse-tree is text and the argument is also text, then the text is appended to the last item (not added as a separate string). Otherwise the argument is added as a new string or parse-tree I the current one.

$ptree->raw_text()

  1.         my $ptree_raw_text = $ptree->raw_text();

This method will return the I text of the POD parse-tree exactly as it appeared in the input.

Pod::ParseTree::DESTROY()

This method performs any necessary cleanup for the parse-tree. If you override this method then it is B that you invoke the parent method from within your own method, otherwise I

SEE ALSO

See L, L

AUTHOR

Please report bugs using L.

Brad Appleton Ebradapp@enteract.comE

Page index