pod::inputobjects.3

视频监控网络部分的协议ddns,的模块的实现代码,请大家大胆指正.

.el .Sh "\f(CW$pod_para\fP\->\fB\fP\f(BIcmd_separator()\fP\fB\fP"
.IX Subsection "$pod_para->cmd_separator()"
.Vb 1
\&        my $separator = $pod_para\->cmd_separator();
.Ve
.PP
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).
.ie n .Sh "$pod_para\fP\->\fB\fP\f(BIparse_tree()\fP\fB"
.el .Sh "\f(CW$pod_para\fP\->\fB\fP\f(BIparse_tree()\fP\fB\fP"
.IX Subsection "$pod_para->parse_tree()"
.Vb 3
\&        my $ptree = $pod_parser\->parse_text( $pod_para\->text() );
\&        $pod_para\->parse_tree( $ptree );
\&        $ptree = $pod_para\->parse_tree();
.Ve
.PP
This method will get/set the corresponding parse-tree of the paragraph's text.
.ie n .Sh "$pod_para\fP\->\fB\fP\f(BIfile_line()\fP\fB"
.el .Sh "\f(CW$pod_para\fP\->\fB\fP\f(BIfile_line()\fP\fB\fP"
.IX Subsection "$pod_para->file_line()"
.Vb 2
\&        my ($filename, $line_number) = $pod_para\->file_line();
\&        my $position = $pod_para\->file_line();
.Ve
.PP
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.
.SH "\fBPod::InteriorSequence\fP"
.IX Header "Pod::InteriorSequence"
An object representing a \s-1POD\s0 interior sequence command.
It has the following methods/attributes:
.Sh "Pod::InteriorSequence\->\fB\fP\f(BInew()\fP\fB\fP"
.IX Subsection "Pod::InteriorSequence->new()"
.Vb 8
\&        my $pod_seq1 = Pod::InteriorSequence\->new(\-name => $cmd
\&                                                  \-ldelim => $delimiter);
\&        my $pod_seq2 = new Pod::InteriorSequence(\-name => $cmd,
\&                                                 \-ldelim => $delimiter);
\&        my $pod_seq3 = new Pod::InteriorSequence(\-name => $cmd,
\&                                                 \-ldelim => $delimiter,
\&                                                 \-file => $filename,
\&                                                 \-line => $line_number);
\&
\&        my $pod_seq4 = new Pod::InteriorSequence(\-name => $cmd, $ptree);
\&        my $pod_seq5 = new Pod::InteriorSequence($cmd, $ptree);
.Ve
.PP
This is a class method that constructs a \f(CW\*(C`Pod::InteriorSequence\*(C'\fR object
and returns a reference to the new interior sequence object. It should
be given two keyword arguments.  The \f(CW\*(C`\-ldelim\*(C'\fR keyword indicates the
corresponding left-delimiter of the interior sequence (e.g. '<').
The \f(CW\*(C`\-name\*(C'\fR keyword indicates the name of the corresponding interior
sequence command, such as \f(CW\*(C`I\*(C'\fR or \f(CW\*(C`B\*(C'\fR or \f(CW\*(C`C\*(C'\fR. The \f(CW\*(C`\-file\*(C'\fR and
\&\f(CW\*(C`\-line\*(C'\fR keywords indicate the filename and line number corresponding
to the beginning of the interior sequence. If the \f(CW$ptree\fR argument is
given, it must be the last argument, and it must be either string, or
else an array-ref suitable for passing to \fBPod::ParseTree::new\fR (or
it may be a reference to a Pod::ParseTree object).
.ie n .Sh "$pod_seq\fP\->\fB\fP\f(BIcmd_name()\fP\fB"
.el .Sh "\f(CW$pod_seq\fP\->\fB\fP\f(BIcmd_name()\fP\fB\fP"
.IX Subsection "$pod_seq->cmd_name()"
.Vb 1
\&        my $seq_cmd = $pod_seq\->cmd_name();
.Ve
.PP
The name of the interior sequence command.
.ie n .Sh "$pod_seq\fP\->\fB\fP\f(BIprepend()\fP\fB"
.el .Sh "\f(CW$pod_seq\fP\->\fB\fP\f(BIprepend()\fP\fB\fP"
.IX Subsection "$pod_seq->prepend()"
.Vb 2
\&        $pod_seq\->prepend($text);
\&        $pod_seq1\->prepend($pod_seq2);
.Ve
.PP
Prepends the given string or parse-tree or sequence object to the parse-tree
of this interior sequence.
.ie n .Sh "$pod_seq\fP\->\fB\fP\f(BIappend()\fP\fB"
.el .Sh "\f(CW$pod_seq\fP\->\fB\fP\f(BIappend()\fP\fB\fP"
.IX Subsection "$pod_seq->append()"
.Vb 2
\&        $pod_seq\->append($text);
\&        $pod_seq1\->append($pod_seq2);
.Ve
.PP
Appends the given string or parse-tree or sequence object to the parse-tree
of this interior sequence.
.ie n .Sh "$pod_seq\fP\->\fB\fP\f(BInested()\fP\fB"
.el .Sh "\f(CW$pod_seq\fP\->\fB\fP\f(BInested()\fP\fB\fP"
.IX Subsection "$pod_seq->nested()"
.Vb 1
\&        $outer_seq = $pod_seq\->nested || print "not nested";
.Ve
.PP
If this interior sequence is nested inside of another interior
sequence, then the outer/parent sequence that contains it is
returned. Otherwise \f(CW\*(C`undef\*(C'\fR is returned.
.ie n .Sh "$pod_seq\fP\->\fB\fP\f(BIraw_text()\fP\fB"
.el .Sh "\f(CW$pod_seq\fP\->\fB\fP\f(BIraw_text()\fP\fB\fP"
.IX Subsection "$pod_seq->raw_text()"
.Vb 1
\&        my $seq_raw_text = $pod_seq\->raw_text();
.Ve
.PP
This method will return the \fIraw\fR text of the \s-1POD\s0 interior sequence,
exactly as it appeared in the input.
.ie n .Sh "$pod_seq\fP\->\fB\fP\f(BIleft_delimiter()\fP\fB"
.el .Sh "\f(CW$pod_seq\fP\->\fB\fP\f(BIleft_delimiter()\fP\fB\fP"
.IX Subsection "$pod_seq->left_delimiter()"
.Vb 1
\&        my $ldelim = $pod_seq\->left_delimiter();
.Ve
.PP
The leftmost delimiter beginning the argument text to the interior
sequence (should be \*(L"<\*(R").
.ie n .Sh "$pod_seq\fP\->\fB\fP\f(BIright_delimiter()\fP\fB"
.el .Sh "\f(CW$pod_seq\fP\->\fB\fP\f(BIright_delimiter()\fP\fB\fP"
.IX Subsection "$pod_seq->right_delimiter()"
The rightmost delimiter beginning the argument text to the interior
sequence (should be \*(L">\*(R").
.ie n .Sh "$pod_seq\fP\->\fB\fP\f(BIparse_tree()\fP\fB"
.el .Sh "\f(CW$pod_seq\fP\->\fB\fP\f(BIparse_tree()\fP\fB\fP"
.IX Subsection "$pod_seq->parse_tree()"
.Vb 3
\&        my $ptree = $pod_parser\->parse_text($paragraph_text);
\&        $pod_seq\->parse_tree( $ptree );
\&        $ptree = $pod_seq\->parse_tree();
.Ve
.PP
This method will get/set the corresponding parse-tree of the interior
sequence's text.
.ie n .Sh "$pod_seq\fP\->\fB\fP\f(BIfile_line()\fP\fB"
.el .Sh "\f(CW$pod_seq\fP\->\fB\fP\f(BIfile_line()\fP\fB\fP"
.IX Subsection "$pod_seq->file_line()"
.Vb 2
\&        my ($filename, $line_number) = $pod_seq\->file_line();
\&        my $position = $pod_seq\->file_line();
.Ve
.PP
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.
.Sh "Pod::InteriorSequence::\fB\s-1\fP\f(BIDESTROY\s0()\fP\fB\fP"
.IX Subsection "Pod::InteriorSequence::DESTROY()"
This method performs any necessary cleanup for the interior-sequence.
If you override this method then it is \fBimperative\fR that you invoke
the parent method from within your own method, otherwise
\&\fIinterior-sequence storage will not be reclaimed upon destruction!\fR
.SH "\fBPod::ParseTree\fP"
.IX Header "Pod::ParseTree"
This object corresponds to a tree of parsed \s-1POD\s0 text. As \s-1POD\s0 text is
scanned from left to right, it is parsed into an ordered list of
text-strings and \fBPod::InteriorSequence\fR objects (in order of
appearance). A \fBPod::ParseTree\fR 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).
.Sh "Pod::ParseTree\->\fB\fP\f(BInew()\fP\fB\fP"
.IX Subsection "Pod::ParseTree->new()"
.Vb 4
\&        my $ptree1 = Pod::ParseTree\->new;
\&        my $ptree2 = new Pod::ParseTree;
\&        my $ptree4 = Pod::ParseTree\->new($array_ref);
\&        my $ptree3 = new Pod::ParseTree($array_ref);
.Ve
.PP
This is a class method that constructs a \f(CW\*(C`Pod::Parse_tree\*(C'\fR 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.
.ie n .Sh "$ptree\fP\->\fB\fP\f(BItop()\fP\fB"
.el .Sh "\f(CW$ptree\fP\->\fB\fP\f(BItop()\fP\fB\fP"
.IX Subsection "$ptree->top()"
.Vb 3
\&        my $top_node = $ptree\->top();
\&        $ptree\->top( $top_node );
\&        $ptree\->top( @children );
.Ve
.PP
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 \fBPod::ParseTree\fR. 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.
.ie n .Sh "$ptree\fP\->\fB\fP\f(BIchildren()\fP\fB"
.el .Sh "\f(CW$ptree\fP\->\fB\fP\f(BIchildren()\fP\fB\fP"
.IX Subsection "$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 \fBPod::InteriorSequence\fR.
Otherwise, if arguments are given, they are treated as the new list of
children for the top node.
.ie n .Sh "$ptree\fP\->\fB\fP\f(BIprepend()\fP\fB"
.el .Sh "\f(CW$ptree\fP\->\fB\fP\f(BIprepend()\fP\fB\fP"
.IX Subsection "$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 \fIbefore\fR
the current one.
.ie n .Sh "$ptree\fP\->\fB\fP\f(BIappend()\fP\fB"
.el .Sh "\f(CW$ptree\fP\->\fB\fP\f(BIappend()\fP\fB\fP"
.IX Subsection "$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 \fIafter\fR
the current one.
.ie n .Sh "$ptree\fP\->\fB\fP\f(BIraw_text()\fP\fB"
.el .Sh "\f(CW$ptree\fP\->\fB\fP\f(BIraw_text()\fP\fB\fP"
.IX Subsection "$ptree->raw_text()"
.Vb 1
\&        my $ptree_raw_text = $ptree\->raw_text();
.Ve
.PP
This method will return the \fIraw\fR text of the \s-1POD\s0 parse-tree
exactly as it appeared in the input.
.Sh "Pod::ParseTree::\fB\s-1\fP\f(BIDESTROY\s0()\fP\fB\fP"
.IX Subsection "Pod::ParseTree::DESTROY()"
This method performs any necessary cleanup for the parse-tree.
If you override this method then it is \fBimperative\fR
that you invoke the parent method from within your own method,
otherwise \fIparse-tree storage will not be reclaimed upon destruction!\fR
.SH "SEE ALSO"
.IX Header "SEE ALSO"
See Pod::Parser, Pod::Select
.SH "AUTHOR"
.IX Header "AUTHOR"
Please report bugs using <http://rt.cpan.org>.
.PP
Brad Appleton <[e-mail]>
.SH "POD ERRORS"
.IX Header "POD ERRORS"
Hey! \fBThe above document had some coding errors, which are explained below:\fR
.IP "Around line 41:" 4
.IX Item "Around line 41:"
You can't have =items (as at line 54) unless the first thing after the =over is an =item