1 #############################################################################
2 # Pod/Checker.pm -- check pod documents for syntax errors
4 # Copyright (C) 1994-2000 by Bradford Appleton. 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 #############################################################################
12 use vars qw($VERSION);
13 $VERSION = 1.2; ## Current version of this package
14 require 5.005; ## requires this Perl version or later
16 use Pod::ParseUtils; ## for hyperlinks and lists
20 Pod::Checker, podchecker() - check pod documents for syntax errors
26 $syntax_okay = podchecker($filepath, $outputpath, %options);
28 my $checker = new Pod::Checker %options;
29 $checker->parse_from_file($filepath, \*STDERR);
31 =head1 OPTIONS/ARGUMENTS
33 C<$filepath> is the input POD to read and C<$outputpath> is
34 where to write POD syntax error messages. Either argument may be a scalar
35 indicating a file-path, or else a reference to an open filehandle.
36 If unspecified, the input-file it defaults to C<\*STDIN>, and
37 the output-file defaults to C<\*STDERR>.
41 This function can take a hash of options:
45 =item B<-warnings> =E<gt> I<val>
47 Turn warnings on/off. I<val> is usually 1 for on, but higher values
48 trigger additional warnings. See L<"Warnings">.
54 B<podchecker> will perform syntax checking of Perl5 POD format documentation.
56 I<NOTE THAT THIS MODULE IS CURRENTLY IN THE BETA STAGE!>
58 It is hoped that curious/ambitious user will help flesh out and add the
59 additional features they wish to see in B<Pod::Checker> and B<podchecker>
60 and verify that the checks are consistent with L<perlpod>.
62 The following checks are currently preformed:
68 Unknown '=xxxx' commands, unknown 'XE<lt>...E<gt>' interior-sequences,
69 and unterminated interior sequences.
73 Check for proper balancing of C<=begin> and C<=end>. The contents of such
74 a block are generally ignored, i.e. no syntax checks are performed.
78 Check for proper nesting and balancing of C<=over>, C<=item> and C<=back>.
82 Check for same nested interior-sequences (e.g.
83 C<LE<lt>...LE<lt>...E<gt>...E<gt>>).
87 Check for malformed or nonexisting entities C<EE<lt>...E<gt>>.
91 Check for correct syntax of hyperlinks C<LE<lt>...E<gt>>. See L<perlpod>
96 Check for unresolved document-internal links. This check may also reveal
97 misspelled links that seem to be internal links but should be links
110 A heading (C<=head1> or C<=head2>) without any text? That ain't no
113 =item * =over on line I<N> without closing =back
115 The C<=over> command does not have a corresponding C<=back> before the
116 next heading (C<=head1> or C<=head2>) or the end of the file.
118 =item * =item without previous =over
120 =item * =back without previous =over
122 An C<=item> or C<=back> command has been found outside a
123 C<=over>/C<=back> block.
125 =item * No argument for =begin
127 A C<=begin> command was found that is not followed by the formatter
130 =item * =end without =begin
132 A standalone C<=end> command was found.
134 =item * Nested =begin's
136 There were at least two consecutive C<=begin> commands without
137 the corresponding C<=end>. Only one C<=begin> may be active at
140 =item * =for without formatter specification
142 There is no specification of the formatter after the C<=for> command.
144 =item * unresolved internal link I<NAME>
146 The given link to I<NAME> does not have a matching node in the current
147 POD. This also happend when a single word node name is not enclosed in
150 =item * Unknown command "I<CMD>"
152 An invalid POD command has been found. Valid are C<=head1>, C<=head2>,
153 C<=head3>, C<=head4>, C<=over>, C<=item>, C<=back>, C<=begin>, C<=end>,
154 C<=for>, C<=pod>, C<=cut>
156 =item * Unknown interior-sequence "I<SEQ>"
158 An invalid markup command has been encountered. Valid are:
159 C<BE<lt>E<gt>>, C<CE<lt>E<gt>>, C<EE<lt>E<gt>>, C<FE<lt>E<gt>>,
160 C<IE<lt>E<gt>>, C<LE<lt>E<gt>>, C<SE<lt>E<gt>>, C<XE<lt>E<gt>>,
163 =item * nested commands I<CMD>E<lt>...I<CMD>E<lt>...E<gt>...E<gt>
165 Two nested identical markup commands have been found. Generally this
168 =item * garbled entity I<STRING>
170 The I<STRING> found cannot be interpreted as a character entity.
172 =item * Entity number out of range
174 An entity specified by number (dec, hex, oct) is out of range (1-255).
176 =item * malformed link LE<lt>E<gt>
178 The link found cannot be parsed because it does not conform to the
179 syntax described in L<perlpod>.
181 =item * nonempty ZE<lt>E<gt>
183 The C<ZE<lt>E<gt>> sequence is supposed to be empty.
185 =item * empty XE<lt>E<gt>
187 The index entry specified contains nothing but whitespace.
189 =item * Spurious text after =pod / =cut
191 The commands C<=pod> and C<=cut> do not take any arguments.
193 =item * Spurious character(s) after =back
195 The C<=back> command does not take any arguments.
201 These may not necessarily cause trouble, but indicate mediocre style.
205 =item * multiple occurence of link target I<name>
207 The POD file has some C<=item> and/or C<=head> commands that have
208 the same text. Potential hyperlinks to such a text cannot be unique then.
210 =item * line containing nothing but whitespace in paragraph
212 There is some whitespace on a seemingly empty line. POD is very sensitive
213 to such things, so this is flagged. B<vi> users switch on the B<list>
214 option to avoid this problem.
218 =item * file does not start with =head
220 The file starts with a different POD directive than head.
221 This is most probably something you do not want.
225 =item * previous =item has no contents
227 There is a list C<=item> right above the flagged line that has no
228 text contents. You probably want to delete empty items.
230 =item * preceding non-item paragraph(s)
232 A list introduced by C<=over> starts with a text or verbatim paragraph,
233 but continues with C<=item>s. Move the non-item paragraph out of the
234 C<=over>/C<=back> block.
236 =item * =item type mismatch (I<one> vs. I<two>)
238 A list started with e.g. a bulletted C<=item> and continued with a
239 numbered one. This is obviously inconsistent. For most translators the
240 type of the I<first> C<=item> determines the type of the list.
242 =item * I<N> unescaped C<E<lt>E<gt>> in paragraph
244 Angle brackets not written as C<E<lt>ltE<gt>> and C<E<lt>gtE<gt>>
245 can potentially cause errors as they could be misinterpreted as
246 markup commands. This is only printed when the -warnings level is
249 =item * Unknown entity
251 A character entity was found that does not belong to the standard
252 ISO set or the POD specials C<verbar> and C<sol>.
254 =item * No items in =over
256 The list opened with C<=over> does not contain any items.
258 =item * No argument for =item
260 C<=item> without any parameters is deprecated. It should either be followed
261 by C<*> to indicate an unordered list, by a number (optionally followed
262 by a dot) to indicate an ordered (numbered) list or simple text for a
265 =item * empty section in previous paragraph
267 The previous section (introduced by a C<=head> command) does not contain
268 any text. This usually indicates that something is missing. Note: A
269 C<=head1> followed immediately by C<=head2> does not trigger this warning.
271 =item * Verbatim paragraph in NAME section
273 The NAME section (C<=head1 NAME>) should consist of a single paragraph
274 with the script/module name, followed by a dash `-' and a very short
275 description of what the thing is good for.
281 There are some warnings wrt. malformed hyperlinks.
285 =item * ignoring leading/trailing whitespace in link
287 There is whitespace at the beginning or the end of the contents of
290 =item * (section) in '$page' deprecated
292 There is a section detected in the page name of LE<lt>...E<gt>, e.g.
293 C<LE<gt>passwd(2)E<gt>>. POD hyperlinks may point to POD documents only.
294 Please write C<CE<lt>passwd(2)E<gt>> instead. Some formatters are able
295 to expand this to appropriate code. For links to (builtin) functions,
296 please say C<LE<lt>perlfunc/mkdirE<gt>>, without ().
298 =item * alternative text/node '%s' contains non-escaped | or /
300 The characters C<|> and C</> are special in the LE<lt>...E<gt> context.
301 Although the hyperlink parser does its best to determine which "/" is
302 text and which is a delimiter in case of doubt, one ought to escape
303 these literal characters like this:
312 B<podchecker> returns the number of POD syntax errors found or -1 if
313 there were no POD commands at all found in the file.
321 While checking, this module collects document properties, e.g. the nodes
322 for hyperlinks (C<=headX>, C<=item>) and index entries (C<XE<lt>E<gt>>).
323 POD translators can use this feature to syntax-check and get the nodes in
324 a first pass before actually starting to convert. This is expensive in terms
325 of execution time, but allows for very robust conversions.
329 #############################################################################
337 use vars qw(@ISA @EXPORT);
338 @ISA = qw(Pod::Parser);
339 @EXPORT = qw(&podchecker);
341 use vars qw(%VALID_COMMANDS %VALID_SEQUENCES);
343 my %VALID_COMMANDS = (
358 my %VALID_SEQUENCES = (
370 # stolen from HTML::Entities
372 # Some normal chars that have special meaning in SGML context
373 amp => '&', # ampersand
374 'gt' => '>', # greater than
375 'lt' => '<', # less than
376 quot => '"', # double quote
378 # PUBLIC ISO 8879-1986//ENTITIES Added Latin 1//EN//HTML
379 AElig => 'Æ', # capital AE diphthong (ligature)
380 Aacute => 'Á', # capital A, acute accent
381 Acirc => 'Â', # capital A, circumflex accent
382 Agrave => 'À', # capital A, grave accent
383 Aring => 'Å', # capital A, ring
384 Atilde => 'Ã', # capital A, tilde
385 Auml => 'Ä', # capital A, dieresis or umlaut mark
386 Ccedil => 'Ç', # capital C, cedilla
387 ETH => 'Ð', # capital Eth, Icelandic
388 Eacute => 'É', # capital E, acute accent
389 Ecirc => 'Ê', # capital E, circumflex accent
390 Egrave => 'È', # capital E, grave accent
391 Euml => 'Ë', # capital E, dieresis or umlaut mark
392 Iacute => 'Í', # capital I, acute accent
393 Icirc => 'Î', # capital I, circumflex accent
394 Igrave => 'Ì', # capital I, grave accent
395 Iuml => 'Ï', # capital I, dieresis or umlaut mark
396 Ntilde => 'Ñ', # capital N, tilde
397 Oacute => 'Ó', # capital O, acute accent
398 Ocirc => 'Ô', # capital O, circumflex accent
399 Ograve => 'Ò', # capital O, grave accent
400 Oslash => 'Ø', # capital O, slash
401 Otilde => 'Õ', # capital O, tilde
402 Ouml => 'Ö', # capital O, dieresis or umlaut mark
403 THORN => 'Þ', # capital THORN, Icelandic
404 Uacute => 'Ú', # capital U, acute accent
405 Ucirc => 'Û', # capital U, circumflex accent
406 Ugrave => 'Ù', # capital U, grave accent
407 Uuml => 'Ü', # capital U, dieresis or umlaut mark
408 Yacute => 'Ý', # capital Y, acute accent
409 aacute => 'á', # small a, acute accent
410 acirc => 'â', # small a, circumflex accent
411 aelig => 'æ', # small ae diphthong (ligature)
412 agrave => 'à', # small a, grave accent
413 aring => 'å', # small a, ring
414 atilde => 'ã', # small a, tilde
415 auml => 'ä', # small a, dieresis or umlaut mark
416 ccedil => 'ç', # small c, cedilla
417 eacute => 'é', # small e, acute accent
418 ecirc => 'ê', # small e, circumflex accent
419 egrave => 'è', # small e, grave accent
420 eth => 'ð', # small eth, Icelandic
421 euml => 'ë', # small e, dieresis or umlaut mark
422 iacute => 'í', # small i, acute accent
423 icirc => 'î', # small i, circumflex accent
424 igrave => 'ì', # small i, grave accent
425 iuml => 'ï', # small i, dieresis or umlaut mark
426 ntilde => 'ñ', # small n, tilde
427 oacute => 'ó', # small o, acute accent
428 ocirc => 'ô', # small o, circumflex accent
429 ograve => 'ò', # small o, grave accent
430 oslash => 'ø', # small o, slash
431 otilde => 'õ', # small o, tilde
432 ouml => 'ö', # small o, dieresis or umlaut mark
433 szlig => 'ß', # small sharp s, German (sz ligature)
434 thorn => 'þ', # small thorn, Icelandic
435 uacute => 'ú', # small u, acute accent
436 ucirc => 'û', # small u, circumflex accent
437 ugrave => 'ù', # small u, grave accent
438 uuml => 'ü', # small u, dieresis or umlaut mark
439 yacute => 'ý', # small y, acute accent
440 yuml => 'ÿ', # small y, dieresis or umlaut mark
442 # Some extra Latin 1 chars that are listed in the HTML3.2 draft (21-May-96)
443 copy => '©', # copyright sign
444 reg => '®', # registered sign
445 nbsp => "\240", # non breaking space
447 # Additional ISO-8859/1 entities listed in rfc1866 (section 14)
458 'not' => '¬', # not is a keyword in perl
477 'times' => '×', # times is a keyword in perl
480 # some POD special entities
485 ##---------------------------------------------------------------------------
487 ##---------------------------------
488 ## Function definitions begin here
489 ##---------------------------------
491 sub podchecker( $ ; $ % ) {
492 my ($infile, $outfile, %options) = @_;
497 $outfile ||= \*STDERR;
499 ## Now create a pod checker
500 my $checker = new Pod::Checker(%options);
502 ## Now check the pod document for errors
503 $checker->parse_from_file($infile, $outfile);
505 ## Return the number of errors found
506 return $checker->num_errors();
509 ##---------------------------------------------------------------------------
511 ##-------------------------------
512 ## Method definitions begin here
513 ##-------------------------------
515 ##################################
519 =item C<Pod::Checker-E<gt>new( %options )>
521 Return a reference to a new Pod::Checker object that inherits from
522 Pod::Parser and is used for calling the required methods later. The
523 following options are recognized:
525 C<-warnings =E<gt> num>
526 Print warnings if C<num> is true. The higher the value of C<num>,
527 the more warnings are printed. Currently there are only levels 1 and 2.
530 If C<num> is true, do not print any errors/warnings. This is useful
531 when Pod::Checker is used to munge POD code into plain text from within
538 ## my $class = ref($this) || $this;
540 ## my $self = {%params};
541 ## bless $self, $class;
542 ## $self->initialize();
548 ## Initialize number of errors, and setup an error function to
549 ## increment this number and then print to the designated output.
550 $self->{_NUM_ERRORS} = 0;
551 $self->{-quiet} ||= 0;
552 # set the error handling subroutine
553 $self->errorsub($self->{-quiet} ? sub { 1; } : 'poderror');
554 $self->{_commands} = 0; # total number of POD commands encountered
555 $self->{_list_stack} = []; # stack for nested lists
556 $self->{_have_begin} = ''; # stores =begin
557 $self->{_links} = []; # stack for internal hyperlinks
558 $self->{_nodes} = []; # stack for =head/=item nodes
559 $self->{_index} = []; # text in X<>
561 $self->{-warnings} = 1 unless(defined $self->{-warnings});
562 $self->{_current_head1} = ''; # the current =head1 block
563 $self->parseopts(-process_cut_cmd => 1, -warnings => $self->{-warnings});
566 ##################################
568 =item C<$checker-E<gt>poderror( @args )>
570 =item C<$checker-E<gt>poderror( {%opts}, @args )>
572 Internal method for printing errors and warnings. If no options are
573 given, simply prints "@_". The following options are recognized and used
578 A message to print prior to C<@args>.
582 The line number the error occurred in.
586 The file (name) the error occurred in.
590 The error level, should be 'WARNING' or 'ERROR'.
594 # Invoked as $self->poderror( @args ), or $self->poderror( {%opts}, @args )
597 my %opts = (ref $_[0]) ? %{shift()} : ();
600 chomp( my $msg = ($opts{-msg} || "")."@_" );
601 my $line = (exists $opts{-line}) ? " at line $opts{-line}" : "";
602 my $file = (exists $opts{-file}) ? " in file $opts{-file}" : "";
603 unless (exists $opts{-severity}) {
604 ## See if can find severity in message prefix
605 $opts{-severity} = $1 if ( $msg =~ s/^\**\s*([A-Z]{3,}):\s+// );
607 my $severity = (exists $opts{-severity}) ? "*** $opts{-severity}: " : "";
609 ## Increment error count and print message "
610 ++($self->{_NUM_ERRORS})
611 if(!%opts || ($opts{-severity} && $opts{-severity} eq 'ERROR'));
612 my $out_fh = $self->output_handle() || \*STDERR;
613 print $out_fh ($severity, $msg, $line, $file, "\n")
614 if($self->{-warnings} || !%opts || $opts{-severity} ne 'WARNING');
617 ##################################
619 =item C<$checker-E<gt>num_errors()>
621 Set (if argument specified) and retrieve the number of errors found.
626 return (@_ > 1) ? ($_[0]->{_NUM_ERRORS} = $_[1]) : $_[0]->{_NUM_ERRORS};
629 ##################################
631 =item C<$checker-E<gt>name()>
633 Set (if argument specified) and retrieve the canonical name of POD as
634 found in the C<=head1 NAME> section.
639 return (@_ > 1 && $_[1]) ?
640 ($_[0]->{-name} = $_[1]) : $_[0]->{-name};
643 ##################################
645 =item C<$checker-E<gt>node()>
647 Add (if argument specified) and retrieve the nodes (as defined by C<=headX>
648 and C<=item>) of the current POD. The nodes are returned in the order of
649 their occurence. They consist of plain text, each piece of whitespace is
650 collapsed to a single blank.
655 my ($self,$text) = @_;
657 $text =~ s/\s+$//s; # strip trailing whitespace
658 $text =~ s/\s+/ /gs; # collapse whitespace
659 # add node, order important!
660 push(@{$self->{_nodes}}, $text);
661 # keep also a uniqueness counter
662 $self->{_unique_nodes}->{$text}++ if($text !~ /^\s*$/s);
668 ##################################
670 =item C<$checker-E<gt>idx()>
672 Add (if argument specified) and retrieve the index entries (as defined by
673 C<XE<lt>E<gt>>) of the current POD. They consist of plain text, each piece
674 of whitespace is collapsed to a single blank.
678 # set/return index entries of current POD
680 my ($self,$text) = @_;
682 $text =~ s/\s+$//s; # strip trailing whitespace
683 $text =~ s/\s+/ /gs; # collapse whitespace
684 # add node, order important!
685 push(@{$self->{_index}}, $text);
686 # keep also a uniqueness counter
687 $self->{_unique_nodes}->{$text}++ if($text !~ /^\s*$/s);
693 ##################################
695 =item C<$checker-E<gt>hyperlink()>
697 Add (if argument specified) and retrieve the hyperlinks (as defined by
698 C<LE<lt>E<gt>>) of the current POD. They consist of an 2-item array: line
699 number and C<Pod::Hyperlink> object.
705 # set/return hyperlinks of the current POD
709 push(@{$self->{_links}}, $_[0]);
715 ## overrides for Pod::Parser
718 ## Do some final checks and
719 ## print the number of errors found
721 my $infile = $self->input_file();
722 my $out_fh = $self->output_handle();
724 if(@{$self->{_list_stack}}) {
725 # _TODO_ display, but don't count them for now
727 while(($list = $self->_close_list('EOF',$infile)) &&
728 $list->indent() ne 'auto') {
729 $self->poderror({ -line => 'EOF', -file => $infile,
730 -severity => 'ERROR', -msg => "=over on line " .
731 $list->start() . " without closing =back" }); #"
735 # check validity of document internal hyperlinks
736 # first build the node names from the paragraph text
738 foreach($self->node()) {
741 # we have more than one word. Use the first as a node, too.
742 # This is used heavily in perlfunc.pod
743 $nodes{$1} ||= 2; # derived node
746 foreach($self->idx()) {
747 $nodes{$_} = 3; # index node
749 foreach($self->hyperlink()) {
750 my ($line,$link) = @$_;
751 # _TODO_ what if there is a link to the page itself by the name,
752 # e.g. in Tk::Pod : L<Tk::Pod/"DESCRIPTION">
753 if($link->node() && !$link->page() && $link->type() ne 'hyperlink') {
754 my $node = $self->_check_ptree($self->parse_text($link->node(),
755 $line), $line, $infile, 'L');
756 if($node && !$nodes{$node}) {
757 $self->poderror({ -line => $line || '', -file => $infile,
758 -severity => 'ERROR',
759 -msg => "unresolved internal link '$node'"});
764 # check the internal nodes for uniqueness. This pertains to
765 # =headX, =item and X<...>
766 foreach(grep($self->{_unique_nodes}->{$_} > 1,
767 keys %{$self->{_unique_nodes}})) {
768 $self->poderror({ -line => '-', -file => $infile,
769 -severity => 'WARNING',
770 -msg => "multiple occurence of link target '$_'"});
773 ## Print the number of errors found
774 my $num_errors = $self->num_errors();
775 if ($num_errors > 0) {
776 printf $out_fh ("$infile has $num_errors pod syntax %s.\n",
777 ($num_errors == 1) ? "error" : "errors");
779 elsif($self->{_commands} == 0) {
780 print $out_fh "$infile does not contain any pod commands.\n";
781 $self->num_errors(-1);
784 print $out_fh "$infile pod syntax OK.\n";
788 # check a POD command directive
790 my ($self, $cmd, $paragraph, $line_num, $pod_para) = @_;
791 my ($file, $line) = $pod_para->file_line;
792 ## Check the command syntax
793 my $arg; # this will hold the command argument
794 if (! $VALID_COMMANDS{$cmd}) {
795 $self->poderror({ -line => $line, -file => $file, -severity => 'ERROR',
796 -msg => "Unknown command '$cmd'" });
798 else { # found a valid command
799 $self->{_commands}++; # delete this line if below is enabled again
801 ##### following check disabled due to strong request
802 #if(!$self->{_commands}++ && $cmd !~ /^head/) {
803 # $self->poderror({ -line => $line, -file => $file,
804 # -severity => 'WARNING',
805 # -msg => "file does not start with =head" });
808 # check syntax of particular command
811 $arg = $self->interpolate_and_check($paragraph, $line,$file);
812 my $indent = 4; # default
813 if($arg && $arg =~ /^\s*(\d+)\s*$/) {
817 $self->_open_list($indent,$line,$file);
819 elsif($cmd eq 'item') {
821 unless(@{$self->{_list_stack}}) {
822 $self->poderror({ -line => $line, -file => $file,
823 -severity => 'ERROR',
824 -msg => "=item without previous =over" });
825 # auto-open in case we encounter many more
826 $self->_open_list('auto',$line,$file);
828 my $list = $self->{_list_stack}->[0];
829 # check whether the previous item had some contents
830 if(defined $self->{_list_item_contents} &&
831 $self->{_list_item_contents} == 0) {
832 $self->poderror({ -line => $line, -file => $file,
833 -severity => 'WARNING',
834 -msg => "previous =item has no contents" });
836 if($list->{_has_par}) {
837 $self->poderror({ -line => $line, -file => $file,
838 -severity => 'WARNING',
839 -msg => "preceding non-item paragraph(s)" });
840 delete $list->{_has_par};
843 $arg = $self->interpolate_and_check($paragraph, $line, $file);
844 if($arg && $arg =~ /(\S+)/) {
845 $arg =~ s/[\s\n]+$//;
847 if($arg =~ /^[*]\s*(\S*.*)/) {
849 $self->{_list_item_contents} = $1 ? 1 : 0;
852 elsif($arg =~ /^\d+\.?\s*(\S*)/) {
854 $self->{_list_item_contents} = $1 ? 1 : 0;
858 $type = 'definition';
859 $self->{_list_item_contents} = 1;
861 my $first = $list->type();
862 if($first && $first ne $type) {
863 $self->poderror({ -line => $line, -file => $file,
864 -severity => 'WARNING',
865 -msg => "=item type mismatch ('$first' vs. '$type')"});
872 $self->poderror({ -line => $line, -file => $file,
873 -severity => 'WARNING',
874 -msg => "No argument for =item" });
876 $self->{_list_item_contents} = 0;
883 elsif($cmd eq 'back') {
884 # check if we have an open list
885 unless(@{$self->{_list_stack}}) {
886 $self->poderror({ -line => $line, -file => $file,
887 -severity => 'ERROR',
888 -msg => "=back without previous =over" });
891 # check for spurious characters
892 $arg = $self->interpolate_and_check($paragraph, $line,$file);
893 if($arg && $arg =~ /\S/) {
894 $self->poderror({ -line => $line, -file => $file,
895 -severity => 'ERROR',
896 -msg => "Spurious character(s) after =back" });
899 my $list = $self->_close_list($line,$file);
900 # check for empty lists
901 if(!$list->item() && $self->{-warnings}) {
902 $self->poderror({ -line => $line, -file => $file,
903 -severity => 'WARNING',
904 -msg => "No items in =over (at line " .
905 $list->start() . ") / =back list"}); #"
909 elsif($cmd =~ /^head(\d+)/) {
910 # check whether the previous =head section had some contents
911 if(defined $self->{_commands_in_head} &&
912 $self->{_commands_in_head} == 0 &&
913 defined $self->{_last_head} &&
914 $self->{_last_head} >= $1) {
915 $self->poderror({ -line => $line, -file => $file,
916 -severity => 'WARNING',
917 -msg => "empty section in previous paragraph"});
919 $self->{_commands_in_head} = -1;
920 $self->{_last_head} = $1;
921 # check if there is an open list
922 if(@{$self->{_list_stack}}) {
924 while(($list = $self->_close_list($line,$file)) &&
925 $list->indent() ne 'auto') {
926 $self->poderror({ -line => $line, -file => $file,
927 -severity => 'ERROR',
928 -msg => "=over on line ". $list->start() .
929 " without closing =back (at $cmd)" });
933 $arg = $self->interpolate_and_check($paragraph, $line,$file);
934 $arg =~ s/[\s\n]+$//s;
936 unless(length($arg)) {
937 $self->poderror({ -line => $line, -file => $file,
938 -severity => 'ERROR',
939 -msg => "empty =$cmd"});
941 if($cmd eq 'head1') {
942 $self->{_current_head1} = $arg;
944 $self->{_current_head1} = '';
947 elsif($cmd eq 'begin') {
948 if($self->{_have_begin}) {
949 # already have a begin
950 $self->poderror({ -line => $line, -file => $file,
951 -severity => 'ERROR',
952 -msg => "Nested =begin's (first at line " .
953 $self->{_have_begin} . ")"});
957 $arg = $self->interpolate_and_check($paragraph, $line,$file);
958 unless($arg && $arg =~ /(\S+)/) {
959 $self->poderror({ -line => $line, -file => $file,
960 -severity => 'ERROR',
961 -msg => "No argument for =begin"});
963 # remember the =begin
964 $self->{_have_begin} = "$line:$1";
967 elsif($cmd eq 'end') {
968 if($self->{_have_begin}) {
969 # close the existing =begin
970 $self->{_have_begin} = '';
971 # check for spurious characters
972 $arg = $self->interpolate_and_check($paragraph, $line,$file);
973 # the closing argument is optional
974 #if($arg && $arg =~ /\S/) {
975 # $self->poderror({ -line => $line, -file => $file,
976 # -severity => 'WARNING',
977 # -msg => "Spurious character(s) after =end" });
981 # don't have a matching =begin
982 $self->poderror({ -line => $line, -file => $file,
983 -severity => 'ERROR',
984 -msg => "=end without =begin" });
987 elsif($cmd eq 'for') {
988 unless($paragraph =~ /\s*(\S+)\s*/) {
989 $self->poderror({ -line => $line, -file => $file,
990 -severity => 'ERROR',
991 -msg => "=for without formatter specification" });
993 $arg = ''; # do not expand paragraph below
995 elsif($cmd =~ /^(pod|cut)$/) {
997 $arg = $self->interpolate_and_check($paragraph, $line,$file);
998 if($arg && $arg =~ /(\S+)/) {
999 $self->poderror({ -line => $line, -file => $file,
1000 -severity => 'ERROR',
1001 -msg => "Spurious text after =$cmd"});
1004 $self->{_commands_in_head}++;
1005 ## Check the interior sequences in the command-text
1006 $self->interpolate_and_check($paragraph, $line,$file)
1007 unless(defined $arg);
1013 my ($self,$indent,$line,$file) = @_;
1014 my $list = Pod::List->new(
1018 unshift(@{$self->{_list_stack}}, $list);
1019 undef $self->{_list_item_contents};
1025 my ($self,$line,$file) = @_;
1026 my $list = shift(@{$self->{_list_stack}});
1027 if(defined $self->{_list_item_contents} &&
1028 $self->{_list_item_contents} == 0) {
1029 $self->poderror({ -line => $line, -file => $file,
1030 -severity => 'WARNING',
1031 -msg => "previous =item has no contents" });
1033 undef $self->{_list_item_contents};
1037 # process a block of some text
1038 sub interpolate_and_check {
1039 my ($self, $paragraph, $line, $file) = @_;
1040 ## Check the interior sequences in the command-text
1041 # and return the text
1042 $self->_check_ptree(
1043 $self->parse_text($paragraph,$line), $line, $file, '');
1047 my ($self,$ptree,$line,$file,$nestlist) = @_;
1050 # process each node in the parse tree
1052 # regular text chunk
1055 # count the unescaped angle brackets
1056 # complain only when warning level is greater than 1
1058 if($count = $i =~ tr/<>/<>/) {
1059 $self->poderror({ -line => $line, -file => $file,
1060 -severity => 'WARNING',
1061 -msg => "$count unescaped <> in paragraph" })
1062 if($self->{-warnings} && $self->{-warnings}>1);
1067 # have an interior sequence
1068 my $cmd = $_->cmd_name();
1069 my $contents = $_->parse_tree();
1070 ($file,$line) = $_->file_line();
1071 # check for valid tag
1072 if (! $VALID_SEQUENCES{$cmd}) {
1073 $self->poderror({ -line => $line, -file => $file,
1074 -severity => 'ERROR',
1075 -msg => qq(Unknown interior-sequence '$cmd')});
1077 $text .= $self->_check_ptree($contents, $line, $file, "$nestlist$cmd");
1080 if($nestlist =~ /$cmd/) {
1081 $self->poderror({ -line => $line, -file => $file,
1082 -severity => 'ERROR',
1083 -msg => "nested commands $cmd<...$cmd<...>...>"});
1084 # _TODO_ should we add the contents anyway?
1085 # expand it anyway, see below
1089 if(@$contents > 1 || ref $$contents[0] || $$contents[0] !~ /^\w+$/) {
1090 $self->poderror({ -line => $line, -file => $file,
1091 -severity => 'ERROR',
1092 -msg => "garbled entity " . $_->raw_text()});
1095 my $ent = $$contents[0];
1097 if($ent =~ /^0x[0-9a-f]+$/i) {
1101 elsif($ent =~ /^0\d+$/) {
1105 elsif($ent =~ /^\d+$/) {
1110 if($val>0 && $val<256) {
1114 $self->poderror({ -line => $line, -file => $file,
1115 -severity => 'ERROR',
1116 -msg => "Entity number out of range " . $_->raw_text()});
1119 elsif($ENTITIES{$ent}) {
1121 $text .= $ENTITIES{$ent};
1124 $self->poderror({ -line => $line, -file => $file,
1125 -severity => 'WARNING',
1126 -msg => "Unknown entity " . $_->raw_text()});
1130 elsif($cmd eq 'L') {
1131 # try to parse the hyperlink
1132 my $link = Pod::Hyperlink->new($contents->raw_text());
1133 unless(defined $link) {
1134 $self->poderror({ -line => $line, -file => $file,
1135 -severity => 'ERROR',
1136 -msg => "malformed link " . $_->raw_text() ." : $@"});
1139 $link->line($line); # remember line
1140 if($self->{-warnings}) {
1141 foreach my $w ($link->warning()) {
1142 $self->poderror({ -line => $line, -file => $file,
1143 -severity => 'WARNING',
1147 # check the link text
1148 $text .= $self->_check_ptree($self->parse_text($link->text(),
1149 $line), $line, $file, "$nestlist$cmd");
1151 $self->hyperlink([$line,$link]);
1153 elsif($cmd =~ /[BCFIS]/) {
1155 $text .= $self->_check_ptree($contents, $line, $file, "$nestlist$cmd");
1157 elsif($cmd eq 'Z') {
1158 if(length($contents->raw_text())) {
1159 $self->poderror({ -line => $line, -file => $file,
1160 -severity => 'ERROR',
1161 -msg => "Nonempty Z<>"});
1164 elsif($cmd eq 'X') {
1165 my $idx = $self->_check_ptree($contents, $line, $file, "$nestlist$cmd");
1166 if($idx =~ /^\s*$/s) {
1167 $self->poderror({ -line => $line, -file => $file,
1168 -severity => 'ERROR',
1169 -msg => "Empty X<>"});
1172 # remember this node
1178 die "internal error";
1184 # process a block of verbatim text
1186 ## Nothing particular to check
1187 my ($self, $paragraph, $line_num, $pod_para) = @_;
1189 $self->_preproc_par($paragraph);
1191 if($self->{_current_head1} eq 'NAME') {
1192 my ($file, $line) = $pod_para->file_line;
1193 $self->poderror({ -line => $line, -file => $file,
1194 -severity => 'WARNING',
1195 -msg => 'Verbatim paragraph in NAME section' });
1199 # process a block of regular text
1201 my ($self, $paragraph, $line_num, $pod_para) = @_;
1202 my ($file, $line) = $pod_para->file_line;
1204 $self->_preproc_par($paragraph);
1206 # skip this paragraph if in a =begin block
1207 unless($self->{_have_begin}) {
1208 my $block = $self->interpolate_and_check($paragraph, $line,$file);
1209 if($self->{_current_head1} eq 'NAME') {
1210 if($block =~ /^\s*(\S+?)\s*[,-]/) {
1211 # this is the canonical name
1212 $self->{-name} = $1 unless(defined $self->{-name});
1221 $_[0] =~ s/[\s\n]+$//;
1223 $self->{_commands_in_head}++;
1224 $self->{_list_item_contents}++ if(defined $self->{_list_item_contents});
1225 if(@{$self->{_list_stack}} && !$self->{_list_stack}->[0]->item()) {
1226 $self->{_list_stack}->[0]->{_has_par} = 1;
1237 Brad Appleton E<lt>bradapp@enteract.comE<gt> (initial version),
1238 Marek Rouchal E<lt>marek@saftsack.fs.uni-bayreuth.deE<gt>
1240 Based on code for B<Pod::Text::pod2text()> written by
1241 Tom Christiansen E<lt>tchrist@mox.perl.comE<gt>