1 #############################################################################
2 # Pod/ParseUtils.pm -- helpers for POD parsing and conversion
4 # Copyright (C) 1999-2000 by Marek Rouchal. All rights reserved.
5 # This file is part of "PodParser". PodParser is free software;
6 # you can redistribute it and/or modify it under the same terms
8 #############################################################################
10 package Pod::ParseUtils;
12 use vars qw($VERSION);
13 $VERSION = 1.30; ## Current version of this package
14 require 5.005; ## requires this Perl version or later
18 Pod::ParseUtils - helpers for POD parsing and conversion
24 my $list = new Pod::List;
25 my $link = Pod::Hyperlink->new('Pod::Parser');
29 B<Pod::ParseUtils> contains a few object-oriented helper packages for
30 POD parsing and processing (i.e. in POD formatters and translators).
34 #-----------------------------------------------------------------------------
37 # class to hold POD list info (=over, =item, =back)
38 #-----------------------------------------------------------------------------
46 B<Pod::List> can be used to hold information about POD lists
47 (written as =over ... =item ... =back) for further processing.
48 The following methods are available:
52 =item Pod::List-E<gt>new()
54 Create a new list object. Properties may be specified through a hash
57 my $list = Pod::List->new({ -start => $., -indent => 4 });
59 See the individual methods/properties for details.
65 my $class = ref($this) || $this;
75 $self->{-file} ||= 'unknown';
76 $self->{-start} ||= 'unknown';
77 $self->{-indent} ||= 4; # perlpod: "should be the default"
79 $self->{-type} ||= '';
82 =item $list-E<gt>file()
84 Without argument, retrieves the file name the list is in. This must
85 have been set before by either specifying B<-file> in the B<new()>
86 method or by calling the B<file()> method with a scalar argument.
90 # The POD file name the list appears in
92 return (@_ > 1) ? ($_[0]->{-file} = $_[1]) : $_[0]->{-file};
95 =item $list-E<gt>start()
97 Without argument, retrieves the line number where the list started.
98 This must have been set before by either specifying B<-start> in the
99 B<new()> method or by calling the B<start()> method with a scalar
104 # The line in the file the node appears
106 return (@_ > 1) ? ($_[0]->{-start} = $_[1]) : $_[0]->{-start};
109 =item $list-E<gt>indent()
111 Without argument, retrieves the indent level of the list as specified
112 in C<=over n>. This must have been set before by either specifying
113 B<-indent> in the B<new()> method or by calling the B<indent()> method
114 with a scalar argument.
120 return (@_ > 1) ? ($_[0]->{-indent} = $_[1]) : $_[0]->{-indent};
123 =item $list-E<gt>type()
125 Without argument, retrieves the list type, which can be an arbitrary value,
126 e.g. C<OL>, C<UL>, ... when thinking the HTML way.
127 This must have been set before by either specifying
128 B<-type> in the B<new()> method or by calling the B<type()> method
129 with a scalar argument.
133 # The type of the list (UL, OL, ...)
135 return (@_ > 1) ? ($_[0]->{-type} = $_[1]) : $_[0]->{-type};
138 =item $list-E<gt>rx()
140 Without argument, retrieves a regular expression for simplifying the
141 individual item strings once the list type has been determined. Usage:
142 E.g. when converting to HTML, one might strip the leading number in
143 an ordered list as C<E<lt>OLE<gt>> already prints numbers itself.
144 This must have been set before by either specifying
145 B<-rx> in the B<new()> method or by calling the B<rx()> method
146 with a scalar argument.
150 # The regular expression to simplify the items
152 return (@_ > 1) ? ($_[0]->{-rx} = $_[1]) : $_[0]->{-rx};
155 =item $list-E<gt>item()
157 Without argument, retrieves the array of the items in this list.
158 The items may be represented by any scalar.
159 If an argument has been given, it is pushed on the list of items.
163 # The individual =items of this list
165 my ($self,$item) = @_;
167 push(@{$self->{_items}}, $item);
171 return @{$self->{_items}};
175 =item $list-E<gt>parent()
177 Without argument, retrieves information about the parent holding this
178 list, which is represented as an arbitrary scalar.
179 This must have been set before by either specifying
180 B<-parent> in the B<new()> method or by calling the B<parent()> method
181 with a scalar argument.
185 # possibility for parsers/translators to store information about the
186 # lists's parent object
188 return (@_ > 1) ? ($_[0]->{-parent} = $_[1]) : $_[0]->{-parent};
191 =item $list-E<gt>tag()
193 Without argument, retrieves information about the list tag, which can be
195 This must have been set before by either specifying
196 B<-tag> in the B<new()> method or by calling the B<tag()> method
197 with a scalar argument.
203 # possibility for parsers/translators to store information about the
206 return (@_ > 1) ? ($_[0]->{-tag} = $_[1]) : $_[0]->{-tag};
209 #-----------------------------------------------------------------------------
212 # class to manipulate POD hyperlinks (L<>)
213 #-----------------------------------------------------------------------------
215 package Pod::Hyperlink;
217 =head2 Pod::Hyperlink
219 B<Pod::Hyperlink> is a class for manipulation of POD hyperlinks. Usage:
221 my $link = Pod::Hyperlink->new('alternative text|page/"section in page"');
223 The B<Pod::Hyperlink> class is mainly designed to parse the contents of the
224 C<LE<lt>...E<gt>> sequence, providing a simple interface for accessing the
225 different parts of a POD hyperlink for further processing. It can also be
226 used to construct hyperlinks.
230 =item Pod::Hyperlink-E<gt>new()
232 The B<new()> method can either be passed a set of key/value pairs or a single
233 scalar value, namely the contents of a C<LE<lt>...E<gt>> sequence. An object
234 of the class C<Pod::Hyperlink> is returned. The value C<undef> indicates a
235 failure, the error message is stored in C<$@>.
243 my $class = ref($this) || $this;
249 # called with a list of parameters
251 $self->_construct_text();
254 # called with L<> contents
255 return undef unless($self->parse($_[0]));
263 $self->{-line} ||= 'undef';
264 $self->{-file} ||= 'undef';
265 $self->{-page} ||= '';
266 $self->{-node} ||= '';
267 $self->{-alttext} ||= '';
268 $self->{-type} ||= 'undef';
269 $self->{_warnings} = [];
272 =item $link-E<gt>parse($string)
274 This method can be used to (re)parse a (new) hyperlink, i.e. the contents
275 of a C<LE<lt>...E<gt>> sequence. The result is stored in the current object.
276 Warnings are stored in the B<warnings> property.
277 E.g. sections like C<LE<lt>open(2)E<gt>> are deprecated, as they do not point
278 to Perl documents. C<LE<lt>DBI::foo(3p)E<gt>> is wrong as well, the manpage
279 section can simply be dropped.
286 # syntax check the link and extract destination
287 my ($alttext,$page,$node,$type,$quoted) = (undef,'','','',0);
289 $self->{_warnings} = [];
291 # collapse newlines with whitespace
294 # strip leading/trailing whitespace
296 $self->warning("ignoring leading whitespace in link");
299 $self->warning("ignoring trailing whitespace in link");
302 _invalid_link("empty link");
306 ## Check for different possibilities. This is tedious and error-prone
307 # we match all possibilities (alttext, page, section/item)
308 #warn "DEBUG: link=$_\n";
311 # problem: a lot of people use (), or (1) or the like to indicate
312 # man page sections. But this collides with L<func()> that is supposed
313 # to point to an internal funtion...
314 my $page_rx = '[\w.-]+(?:::[\w.-]+)*(?:[(](?:\d\w*|)[)]|)';
316 if(m!^($page_rx)$!o) {
320 # alttext, page and "section"
321 elsif(m!^(.*?)\s*[|]\s*($page_rx)\s*/\s*"(.+)"$!o) {
322 ($alttext, $page, $node) = ($1, $2, $3);
324 $quoted = 1; #... therefore | and / are allowed
327 elsif(m!^(.*?)\s*[|]\s*($page_rx)$!o) {
328 ($alttext, $page) = ($1, $2);
331 # alttext and "section"
332 elsif(m!^(.*?)\s*[|]\s*(?:/\s*|)"(.+)"$!) {
333 ($alttext, $node) = ($1,$2);
338 elsif(m!^($page_rx)\s*/\s*"(.+)"$!o) {
339 ($page, $node) = ($1, $2);
344 elsif(m!^($page_rx)\s*/\s*(.+)$!o) {
345 ($page, $node) = ($1, $2);
349 elsif(m!^/?"(.+)"$!) {
355 elsif(m!^\s*/(.+)$!) {
359 # non-standard: Hyperlink
360 elsif(m!^((?:http|ftp|mailto|news):.+)$!i) {
364 # alttext, page and item
365 elsif(m!^(.*?)\s*[|]\s*($page_rx)\s*/\s*(.+)$!o) {
366 ($alttext, $page, $node) = ($1, $2, $3);
370 elsif(m!^(.*?)\s*[|]\s*/(.+)$!) {
371 ($alttext, $node) = ($1,$2);
373 # nonstandard: alttext and hyperlink
374 elsif(m!^(.*?)\s*[|]\s*((?:http|ftp|mailto|news):.+)$!) {
375 ($alttext, $node) = ($1,$2);
378 # must be an item or a "malformed" section (without "")
383 # collapse whitespace in nodes
386 # empty alternative text expands to node name
387 if(defined $alttext) {
388 if(!length($alttext)) {
389 $alttext = $node | $page;
396 if($page =~ /[(]\w*[)]$/) {
397 $self->warning("(section) in '$page' deprecated");
399 if(!$quoted && $node =~ m:[|/]: && $type ne 'hyperlink') {
400 $self->warning("node '$node' contains non-escaped | or /");
402 if($alttext =~ m:[|/]:) {
403 $self->warning("alternative text '$node' contains non-escaped | or /");
405 $self->{-page} = $page;
406 $self->{-node} = $node;
407 $self->{-alttext} = $alttext;
408 #warn "DEBUG: page=$page section=$section item=$item alttext=$alttext\n";
409 $self->{-type} = $type;
410 $self->_construct_text();
414 sub _construct_text {
416 my $alttext = $self->alttext();
417 my $type = $self->type();
418 my $section = $self->node();
419 my $page = $self->page();
421 $page =~ s/([(]\w*[)])$// && ($page_ext = $1);
423 $self->{_text} = $alttext;
425 elsif($type eq 'hyperlink') {
426 $self->{_text} = $section;
429 $self->{_text} = ($section || '') .
430 (($page && $section) ? ' in ' : '') .
433 # for being marked up later
434 # use the non-standard markers P<> and Q<>, so that the resulting
435 # text can be parsed by the translators. It's their job to put
436 # the correct hypertext around the linktext
438 $self->{_markup} = "Q<$alttext>";
440 elsif($type eq 'hyperlink') {
441 $self->{_markup} = "Q<$section>";
444 $self->{_markup} = (!$section ? '' : "Q<$section>") .
445 ($page ? ($section ? ' in ':'') . "P<$page>$page_ext" : '');
449 =item $link-E<gt>markup($string)
451 Set/retrieve the textual value of the link. This string contains special
452 markers C<PE<lt>E<gt>> and C<QE<lt>E<gt>> that should be expanded by the
453 translator's interior sequence expansion engine to the
454 formatter-specific code to highlight/activate the hyperlink. The details
455 have to be implemented in the translator.
459 #' retrieve/set markuped text
461 return (@_ > 1) ? ($_[0]->{_markup} = $_[1]) : $_[0]->{_markup};
464 =item $link-E<gt>text()
466 This method returns the textual representation of the hyperlink as above,
467 but without markers (read only). Depending on the link type this is one of
468 the following alternatives (the + and * denote the portions of the text
472 *$|* in +perlvar+ L<perlvar/$|>
473 *OPTIONS* in +perldoc+ L<perldoc/"OPTIONS">
474 *DESCRIPTION* L<"DESCRIPTION">
478 # The complete link's text
483 =item $link-E<gt>warning()
485 After parsing, this method returns any warnings encountered during the
490 # Set/retrieve warnings
494 push(@{$self->{_warnings}}, @_);
497 return @{$self->{_warnings}};
500 =item $link-E<gt>file()
502 =item $link-E<gt>line()
504 Just simple slots for storing information about the line and the file
505 the link was encountered in. Has to be filled in manually.
509 # The line in the file the link appears
511 return (@_ > 1) ? ($_[0]->{-line} = $_[1]) : $_[0]->{-line};
514 # The POD file name the link appears in
516 return (@_ > 1) ? ($_[0]->{-file} = $_[1]) : $_[0]->{-file};
519 =item $link-E<gt>page()
521 This method sets or returns the POD page this link points to.
525 # The POD page the link appears on
528 $_[0]->{-page} = $_[1];
529 $_[0]->_construct_text();
534 =item $link-E<gt>node()
536 As above, but the destination node text of the link.
540 # The link destination
543 $_[0]->{-node} = $_[1];
544 $_[0]->_construct_text();
549 =item $link-E<gt>alttext()
551 Sets or returns an alternative text specified in the link.
555 # Potential alternative text
558 $_[0]->{-alttext} = $_[1];
559 $_[0]->_construct_text();
564 =item $link-E<gt>type()
566 The node type, either C<section> or C<item>. As an unofficial type,
567 there is also C<hyperlink>, derived from e.g. C<LE<lt>http://perl.comE<gt>>
571 # The type: item or headn
573 return (@_ > 1) ? ($_[0]->{-type} = $_[1]) : $_[0]->{-type};
576 =item $link-E<gt>link()
578 Returns the link as contents of C<LE<lt>E<gt>>. Reciprocal to B<parse()>.
587 my $link = $self->page() || '';
589 my $node = $self->node();
590 $text =~ s/\|/E<verbar>/g;
591 $text =~ s:/:E<sol>:g;
592 if($self->type() eq 'section') {
593 $link .= ($link ? '/' : '') . '"' . $node . '"';
595 elsif($self->type() eq 'hyperlink') {
596 $link = $self->node();
599 $link .= '/' . $node;
602 if($self->alttext()) {
603 my $text = $self->alttext();
604 $text =~ s/\|/E<verbar>/g;
605 $text =~ s:/:E<sol>:g;
606 $link = "$text|$link";
614 #eval { die "$msg\n" };
616 $@ = $msg; # this seems to work, too!
620 #-----------------------------------------------------------------------------
623 # class to hold POD page details
624 #-----------------------------------------------------------------------------
630 B<Pod::Cache> holds information about a set of POD documents,
631 especially the nodes for hyperlinks.
632 The following methods are available:
636 =item Pod::Cache-E<gt>new()
638 Create a new cache object. This object can hold an arbitrary number of
639 POD documents of class Pod::Cache::Item.
645 my $class = ref($this) || $this;
651 =item $cache-E<gt>item()
653 Add a new item to the cache. Without arguments, this method returns a
654 list of all cache elements.
659 my ($self,%param) = @_;
661 my $item = Pod::Cache::Item->new(%param);
670 =item $cache-E<gt>find_page($name)
672 Look for a POD document named C<$name> in the cache. Returns the
673 reference to the corresponding Pod::Cache::Item object or undef if
681 my ($self,$page) = @_;
683 if($_->page() eq $page) {
690 package Pod::Cache::Item;
692 =head2 Pod::Cache::Item
694 B<Pod::Cache::Item> holds information about individual POD documents,
695 that can be grouped in a Pod::Cache object.
696 It is intended to hold information about the hyperlink nodes of POD
698 The following methods are available:
702 =item Pod::Cache::Item-E<gt>new()
710 my $class = ref($this) || $this;
712 my $self = {%params};
720 $self->{-nodes} = [] unless(defined $self->{-nodes});
723 =item $cacheitem-E<gt>page()
725 Set/retrieve the POD document name (e.g. "Pod::Parser").
731 return (@_ > 1) ? ($_[0]->{-page} = $_[1]) : $_[0]->{-page};
734 =item $cacheitem-E<gt>description()
736 Set/retrieve the POD short description as found in the C<=head1 NAME>
741 # The POD description, taken out of NAME if present
743 return (@_ > 1) ? ($_[0]->{-description} = $_[1]) : $_[0]->{-description};
746 =item $cacheitem-E<gt>path()
748 Set/retrieve the POD file storage path.
754 return (@_ > 1) ? ($_[0]->{-path} = $_[1]) : $_[0]->{-path};
757 =item $cacheitem-E<gt>file()
759 Set/retrieve the POD file name.
765 return (@_ > 1) ? ($_[0]->{-file} = $_[1]) : $_[0]->{-file};
768 =item $cacheitem-E<gt>nodes()
770 Add a node (or a list of nodes) to the document's node list. Note that
771 the order is kept, i.e. start with the first node and end with the last.
772 If no argument is given, the current list of nodes is returned in the
773 same order the nodes have been added.
774 A node can be any scalar, but usually is a pair of node string and
775 unique id for the C<find_node> method to work correctly.
781 my ($self,@nodes) = @_;
783 push(@{$self->{-nodes}}, @nodes);
787 return @{$self->{-nodes}};
791 =item $cacheitem-E<gt>find_node($name)
793 Look for a node or index entry named C<$name> in the object.
794 Returns the unique id of the node (i.e. the second element of the array
795 stored in the node arry) or undef if not found.
800 my ($self,$node) = @_;
802 push(@search, @{$self->{-nodes}}) if($self->{-nodes});
803 push(@search, @{$self->{-idx}}) if($self->{-idx});
805 if($_->[0] eq $node) {
812 =item $cacheitem-E<gt>idx()
814 Add an index entry (or a list of them) to the document's index list. Note that
815 the order is kept, i.e. start with the first node and end with the last.
816 If no argument is given, the current list of index entries is returned in the
817 same order the entries have been added.
818 An index entry can be any scalar, but usually is a pair of string and
825 # The POD index entries
827 my ($self,@idx) = @_;
829 push(@{$self->{-idx}}, @idx);
833 return @{$self->{-idx}};
839 Please report bugs using L<http://rt.cpan.org>.
841 Marek Rouchal E<lt>marekr@cpan.orgE<gt>, borrowing
842 a lot of things from L<pod2man> and L<pod2roff> as well as other POD
843 processing tools by Tom Christiansen, Brad Appleton and Russ Allbery.
847 L<pod2man>, L<pod2roff>, L<Pod::Parser>, L<Pod::Checker>,