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 = 0.2; ## 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:
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} ||= '';
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};
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};
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};
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};
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};
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}};
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};
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.
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} = [];
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.
282 # syntax check the link and extract destination
283 my ($alttext,$page,$node,$type) = ('','','','');
285 $self->{_warnings} = [];
287 # collapse newlines with whitespace
288 if(s/\s*\n+\s*/ /g) {
289 $self->warning("collapsing newlines to blanks");
291 # strip leading/trailing whitespace
293 $self->warning("ignoring leading whitespace in link");
296 $self->warning("ignoring trailing whitespace in link");
299 _invalid_link("empty link");
303 ## Check for different possibilities. This is tedious and error-prone
304 # we match all possibilities (alttext, page, section/item)
305 #warn "DEBUG: link=$_\n";
308 # problem: a lot of people use (), or (1) or the like to indicate
309 # man page sections. But this collides with L<func()> that is supposed
310 # to point to an internal funtion...
311 # I would like the following better, here and below:
312 #if(m!^(\w+(?:::\w+)*)$!) {
313 my $page_rx = '[\w.]+(?:::[\w.]+)*';
314 if(m!^($page_rx)$!o) {
318 # alttext, page and "section"
319 elsif(m!^(.+?)\s*[|]\s*($page_rx)\s*/\s*"(.+)"$!o) {
320 ($alttext, $page, $node) = ($1, $2, $3);
324 elsif(m!^(.+?)\s*[|]\s*($page_rx)$!o) {
325 ($alttext, $page) = ($1, $2);
328 # alttext and "section"
329 elsif(m!^(.+?)\s*[|]\s*(?:/\s*|)"(.+)"$!) {
330 ($alttext, $node) = ($1,$2);
334 elsif(m!^($page_rx)\s*/\s*"(.+)"$!o) {
335 ($page, $node) = ($1, $2);
339 elsif(m!^($page_rx)\s*/\s*(.+)$!o) {
340 ($page, $node) = ($1, $2);
344 elsif(m!^/?"(.+)"$!) {
349 elsif(m!^\s*/(.+)$!) {
353 # non-standard: Hyperlink
354 elsif(m!^((?:http|ftp|mailto|news):.+)$!i) {
358 # alttext, page and item
359 elsif(m!^(.+?)\s*[|]\s*($page_rx)\s*/\s*(.+)$!o) {
360 ($alttext, $page, $node) = ($1, $2, $3);
364 elsif(m!^(.+?)\s*[|]\s*/(.+)$!) {
365 ($alttext, $node) = ($1,$2);
367 # nonstandard: alttext and hyperlink
368 elsif(m!^(.+?)\s*[|]\s*((?:http|ftp|mailto|news):.+)$!) {
369 ($alttext, $node) = ($1,$2);
372 # must be an item or a "malformed" section (without "")
377 # collapse whitespace in nodes
380 #if($page =~ /[(]\w*[)]$/) {
381 # $self->warning("section in '$page' deprecated");
383 if($node =~ m:[|/]:) {
384 $self->warning("node '$node' contains non-escaped | or /");
386 if($alttext =~ m:[|/]:) {
387 $self->warning("alternative text '$node' contains non-escaped | or /");
389 $self->{-page} = $page;
390 $self->{-node} = $node;
391 $self->{-alttext} = $alttext;
392 #warn "DEBUG: page=$page section=$section item=$item alttext=$alttext\n";
393 $self->{-type} = $type;
394 $self->_construct_text();
398 sub _construct_text {
400 my $alttext = $self->alttext();
401 my $type = $self->type();
402 my $section = $self->node();
403 my $page = $self->page();
405 $page =~ s/([(]\w*[)])$// && ($page_ext = $1);
407 $self->{_text} = $alttext;
409 elsif($type eq 'hyperlink') {
410 $self->{_text} = $section;
413 $self->{_text} = (!$section ? '' :
414 $type eq 'item' ? "the $section entry" :
415 "the section on $section" ) .
416 ($page ? ($section ? ' in ':'') . "the $page$page_ext manpage" :
417 ' elsewhere in this document');
419 # for being marked up later
420 # use the non-standard markers P<> and Q<>, so that the resulting
421 # text can be parsed by the translators. It's their job to put
422 # the correct hypertext around the linktext
424 $self->{_markup} = "Q<$alttext>";
426 elsif($type eq 'hyperlink') {
427 $self->{_markup} = "Q<$section>";
430 $self->{_markup} = (!$section ? '' :
431 $type eq 'item' ? "the Q<$section> entry" :
432 "the section on Q<$section>" ) .
433 ($page ? ($section ? ' in ':'') . "the P<$page>$page_ext manpage" :
434 ' elsewhere in this document');
438 =item markup($string)
440 Set/retrieve the textual value of the link. This string contains special
441 markers C<PE<lt>E<gt>> and C<QE<lt>E<gt>> that should be expanded by the
442 translator's interior sequence expansion engine to the
443 formatter-specific code to highlight/activate the hyperlink. The details
444 have to be implemented in the translator.
448 #' retrieve/set markuped text
450 return (@_ > 1) ? ($_[0]->{_markup} = $_[1]) : $_[0]->{_markup};
455 This method returns the textual representation of the hyperlink as above,
456 but without markers (read only). Depending on the link type this is one of
457 the following alternatives (the + and * denote the portions of the text
461 the *$|* entry in the +perlvar+ manpage
462 the section on *OPTIONS* in the +perldoc+ manpage
463 the section on *DESCRIPTION* elsewhere in this document
467 # The complete link's text
474 After parsing, this method returns any warnings encountered during the
479 # Set/retrieve warnings
483 push(@{$self->{_warnings}}, @_);
486 return @{$self->{_warnings}};
491 Just simple slots for storing information about the line and the file
492 the link was encountered in. Has to be filled in manually.
496 # The line in the file the link appears
498 return (@_ > 1) ? ($_[0]->{-line} = $_[1]) : $_[0]->{-line};
501 # The POD file name the link appears in
503 return (@_ > 1) ? ($_[0]->{-file} = $_[1]) : $_[0]->{-file};
508 This method sets or returns the POD page this link points to.
512 # The POD page the link appears on
515 $_[0]->{-page} = $_[1];
516 $_[0]->_construct_text();
523 As above, but the destination node text of the link.
527 # The link destination
530 $_[0]->{-node} = $_[1];
531 $_[0]->_construct_text();
538 Sets or returns an alternative text specified in the link.
542 # Potential alternative text
545 $_[0]->{-alttext} = $_[1];
546 $_[0]->_construct_text();
553 The node type, either C<section> or C<item>. As an unofficial type,
554 there is also C<hyperlink>, derived from e.g. C<LE<lt>http://perl.comE<gt>>
558 # The type: item or headn
560 return (@_ > 1) ? ($_[0]->{-type} = $_[1]) : $_[0]->{-type};
565 Returns the link as contents of C<LE<lt>E<gt>>. Reciprocal to B<parse()>.
574 my $link = $self->page() || '';
576 my $node = $self->node();
577 $text =~ s/\|/E<verbar>/g;
578 $text =~ s:/:E<sol>:g;
579 if($self->type() eq 'section') {
580 $link .= ($link ? '/' : '') . '"' . $node . '"';
582 elsif($self->type() eq 'hyperlink') {
583 $link = $self->node();
586 $link .= '/' . $node;
589 if($self->alttext()) {
590 my $text = $self->alttext();
591 $text =~ s/\|/E<verbar>/g;
592 $text =~ s:/:E<sol>:g;
593 $link = "$text|$link";
601 #eval { die "$msg\n" };
603 $@ = $msg; # this seems to work, too!
607 #-----------------------------------------------------------------------------
610 # class to hold POD page details
611 #-----------------------------------------------------------------------------
617 B<Pod::Cache> holds information about a set of POD documents,
618 especially the nodes for hyperlinks.
619 The following methods are available:
625 Create a new cache object. This object can hold an arbitrary number of
626 POD documents of class Pod::Cache::Item.
632 my $class = ref($this) || $this;
640 Add a new item to the cache. Without arguments, this method returns a
641 list of all cache elements.
646 my ($self,%param) = @_;
648 my $item = Pod::Cache::Item->new(%param);
657 =item find_page($name)
659 Look for a POD document named C<$name> in the cache. Returns the
660 reference to the corresponding Pod::Cache::Item object or undef if
668 my ($self,$page) = @_;
670 if($_->page() eq $page) {
677 package Pod::Cache::Item;
679 =head2 Pod::Cache::Item
681 B<Pod::Cache::Item> holds information about individual POD documents,
682 that can be grouped in a Pod::Cache object.
683 It is intended to hold information about the hyperlink nodes of POD
685 The following methods are available:
697 my $class = ref($this) || $this;
699 my $self = {%params};
707 $self->{-nodes} = [] unless(defined $self->{-nodes});
712 Set/retrieve the POD document name (e.g. "Pod::Parser").
718 return (@_ > 1) ? ($_[0]->{-page} = $_[1]) : $_[0]->{-page};
723 Set/retrieve the POD short description as found in the C<=head1 NAME>
728 # The POD description, taken out of NAME if present
730 return (@_ > 1) ? ($_[0]->{-description} = $_[1]) : $_[0]->{-description};
735 Set/retrieve the POD file storage path.
741 return (@_ > 1) ? ($_[0]->{-path} = $_[1]) : $_[0]->{-path};
746 Set/retrieve the POD file name.
752 return (@_ > 1) ? ($_[0]->{-file} = $_[1]) : $_[0]->{-file};
757 Add a node (or a list of nodes) to the document's node list. Note that
758 the order is kept, i.e. start with the first node and end with the last.
759 If no argument is given, the current list of nodes is returned in the
760 same order the nodes have been added.
761 A node can be any scalar, but usually is a pair of node string and
762 unique id for the C<find_node> method to work correctly.
768 my ($self,@nodes) = @_;
770 push(@{$self->{-nodes}}, @nodes);
774 return @{$self->{-nodes}};
778 =item find_node($name)
780 Look for a node or index entry named C<$name> in the object.
781 Returns the unique id of the node (i.e. the second element of the array
782 stored in the node arry) or undef if not found.
789 my ($self,$node) = @_;
791 push(@search, @{$self->{-nodes}}) if($self->{-nodes});
792 push(@search, @{$self->{-idx}}) if($self->{-idx});
794 if($_->[0] eq $node) {
803 Add an index entry (or a list of them) to the document's index list. Note that
804 the order is kept, i.e. start with the first node and end with the last.
805 If no argument is given, the current list of index entries is returned in the
806 same order the entries have been added.
807 An index entry can be any scalar, but usually is a pair of string and
812 # The POD index entries
814 my ($self,@idx) = @_;
816 push(@{$self->{-idx}}, @idx);
820 return @{$self->{-idx}};
826 Marek Rouchal E<lt>marek@saftsack.fs.uni-bayreuth.deE<gt>, borrowing
827 a lot of things from L<pod2man> and L<pod2roff> as well as other POD
828 processing tools by Tom Christiansen, Brad Appleton and Russ Allbery.
832 L<pod2man>, L<pod2roff>, L<Pod::Parser>, L<Pod::Checker>,