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.40; ## 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 occurrence 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.
277 =item * =headI<n> without preceding higher level
279 For example if there is a C<=head2> in the POD file prior to a
286 There are some warnings wrt. malformed hyperlinks.
290 =item * ignoring leading/trailing whitespace in link
292 There is whitespace at the beginning or the end of the contents of
295 =item * (section) in '$page' deprecated
297 There is a section detected in the page name of LE<lt>...E<gt>, e.g.
298 C<LE<lt>passwd(2)E<gt>>. POD hyperlinks may point to POD documents only.
299 Please write C<CE<lt>passwd(2)E<gt>> instead. Some formatters are able
300 to expand this to appropriate code. For links to (builtin) functions,
301 please say C<LE<lt>perlfunc/mkdirE<gt>>, without ().
303 =item * alternative text/node '%s' contains non-escaped | or /
305 The characters C<|> and C</> are special in the LE<lt>...E<gt> context.
306 Although the hyperlink parser does its best to determine which "/" is
307 text and which is a delimiter in case of doubt, one ought to escape
308 these literal characters like this:
317 B<podchecker> returns the number of POD syntax errors found or -1 if
318 there were no POD commands at all found in the file.
326 While checking, this module collects document properties, e.g. the nodes
327 for hyperlinks (C<=headX>, C<=item>) and index entries (C<XE<lt>E<gt>>).
328 POD translators can use this feature to syntax-check and get the nodes in
329 a first pass before actually starting to convert. This is expensive in terms
330 of execution time, but allows for very robust conversions.
334 #############################################################################
342 use vars qw(@ISA @EXPORT);
343 @ISA = qw(Pod::Parser);
344 @EXPORT = qw(&podchecker);
346 use vars qw(%VALID_COMMANDS %VALID_SEQUENCES);
348 my %VALID_COMMANDS = (
363 my %VALID_SEQUENCES = (
375 # stolen from HTML::Entities
377 # Some normal chars that have special meaning in SGML context
378 amp => '&', # ampersand
379 'gt' => '>', # greater than
380 'lt' => '<', # less than
381 quot => '"', # double quote
383 # PUBLIC ISO 8879-1986//ENTITIES Added Latin 1//EN//HTML
384 AElig => 'Æ', # capital AE diphthong (ligature)
385 Aacute => 'Á', # capital A, acute accent
386 Acirc => 'Â', # capital A, circumflex accent
387 Agrave => 'À', # capital A, grave accent
388 Aring => 'Å', # capital A, ring
389 Atilde => 'Ã', # capital A, tilde
390 Auml => 'Ä', # capital A, dieresis or umlaut mark
391 Ccedil => 'Ç', # capital C, cedilla
392 ETH => 'Ð', # capital Eth, Icelandic
393 Eacute => 'É', # capital E, acute accent
394 Ecirc => 'Ê', # capital E, circumflex accent
395 Egrave => 'È', # capital E, grave accent
396 Euml => 'Ë', # capital E, dieresis or umlaut mark
397 Iacute => 'Í', # capital I, acute accent
398 Icirc => 'Î', # capital I, circumflex accent
399 Igrave => 'Ì', # capital I, grave accent
400 Iuml => 'Ï', # capital I, dieresis or umlaut mark
401 Ntilde => 'Ñ', # capital N, tilde
402 Oacute => 'Ó', # capital O, acute accent
403 Ocirc => 'Ô', # capital O, circumflex accent
404 Ograve => 'Ò', # capital O, grave accent
405 Oslash => 'Ø', # capital O, slash
406 Otilde => 'Õ', # capital O, tilde
407 Ouml => 'Ö', # capital O, dieresis or umlaut mark
408 THORN => 'Þ', # capital THORN, Icelandic
409 Uacute => 'Ú', # capital U, acute accent
410 Ucirc => 'Û', # capital U, circumflex accent
411 Ugrave => 'Ù', # capital U, grave accent
412 Uuml => 'Ü', # capital U, dieresis or umlaut mark
413 Yacute => 'Ý', # capital Y, acute accent
414 aacute => 'á', # small a, acute accent
415 acirc => 'â', # small a, circumflex accent
416 aelig => 'æ', # small ae diphthong (ligature)
417 agrave => 'à', # small a, grave accent
418 aring => 'å', # small a, ring
419 atilde => 'ã', # small a, tilde
420 auml => 'ä', # small a, dieresis or umlaut mark
421 ccedil => 'ç', # small c, cedilla
422 eacute => 'é', # small e, acute accent
423 ecirc => 'ê', # small e, circumflex accent
424 egrave => 'è', # small e, grave accent
425 eth => 'ð', # small eth, Icelandic
426 euml => 'ë', # small e, dieresis or umlaut mark
427 iacute => 'í', # small i, acute accent
428 icirc => 'î', # small i, circumflex accent
429 igrave => 'ì', # small i, grave accent
430 iuml => 'ï', # small i, dieresis or umlaut mark
431 ntilde => 'ñ', # small n, tilde
432 oacute => 'ó', # small o, acute accent
433 ocirc => 'ô', # small o, circumflex accent
434 ograve => 'ò', # small o, grave accent
435 oslash => 'ø', # small o, slash
436 otilde => 'õ', # small o, tilde
437 ouml => 'ö', # small o, dieresis or umlaut mark
438 szlig => 'ß', # small sharp s, German (sz ligature)
439 thorn => 'þ', # small thorn, Icelandic
440 uacute => 'ú', # small u, acute accent
441 ucirc => 'û', # small u, circumflex accent
442 ugrave => 'ù', # small u, grave accent
443 uuml => 'ü', # small u, dieresis or umlaut mark
444 yacute => 'ý', # small y, acute accent
445 yuml => 'ÿ', # small y, dieresis or umlaut mark
447 # Some extra Latin 1 chars that are listed in the HTML3.2 draft (21-May-96)
448 copy => '©', # copyright sign
449 reg => '®', # registered sign
450 nbsp => "\240", # non breaking space
452 # Additional ISO-8859/1 entities listed in rfc1866 (section 14)
463 'not' => '¬', # not is a keyword in perl
482 'times' => '×', # times is a keyword in perl
485 # some POD special entities
490 ##---------------------------------------------------------------------------
492 ##---------------------------------
493 ## Function definitions begin here
494 ##---------------------------------
496 sub podchecker( $ ; $ % ) {
497 my ($infile, $outfile, %options) = @_;
502 $outfile ||= \*STDERR;
504 ## Now create a pod checker
505 my $checker = new Pod::Checker(%options);
507 ## Now check the pod document for errors
508 $checker->parse_from_file($infile, $outfile);
510 ## Return the number of errors found
511 return $checker->num_errors();
514 ##---------------------------------------------------------------------------
516 ##-------------------------------
517 ## Method definitions begin here
518 ##-------------------------------
520 ##################################
524 =item C<Pod::Checker-E<gt>new( %options )>
526 Return a reference to a new Pod::Checker object that inherits from
527 Pod::Parser and is used for calling the required methods later. The
528 following options are recognized:
530 C<-warnings =E<gt> num>
531 Print warnings if C<num> is true. The higher the value of C<num>,
532 the more warnings are printed. Currently there are only levels 1 and 2.
535 If C<num> is true, do not print any errors/warnings. This is useful
536 when Pod::Checker is used to munge POD code into plain text from within
543 ## my $class = ref($this) || $this;
545 ## my $self = {%params};
546 ## bless $self, $class;
547 ## $self->initialize();
553 ## Initialize number of errors, and setup an error function to
554 ## increment this number and then print to the designated output.
555 $self->{_NUM_ERRORS} = 0;
556 $self->{_NUM_WARNINGS} = 0;
557 $self->{-quiet} ||= 0;
558 # set the error handling subroutine
559 $self->errorsub($self->{-quiet} ? sub { 1; } : 'poderror');
560 $self->{_commands} = 0; # total number of POD commands encountered
561 $self->{_list_stack} = []; # stack for nested lists
562 $self->{_have_begin} = ''; # stores =begin
563 $self->{_links} = []; # stack for internal hyperlinks
564 $self->{_nodes} = []; # stack for =head/=item nodes
565 $self->{_index} = []; # text in X<>
567 $self->{-warnings} = 1 unless(defined $self->{-warnings});
568 $self->{_current_head1} = ''; # the current =head1 block
569 $self->parseopts(-process_cut_cmd => 1, -warnings => $self->{-warnings});
572 ##################################
574 =item C<$checker-E<gt>poderror( @args )>
576 =item C<$checker-E<gt>poderror( {%opts}, @args )>
578 Internal method for printing errors and warnings. If no options are
579 given, simply prints "@_". The following options are recognized and used
584 A message to print prior to C<@args>.
588 The line number the error occurred in.
592 The file (name) the error occurred in.
596 The error level, should be 'WARNING' or 'ERROR'.
600 # Invoked as $self->poderror( @args ), or $self->poderror( {%opts}, @args )
603 my %opts = (ref $_[0]) ? %{shift()} : ();
606 chomp( my $msg = ($opts{-msg} || "")."@_" );
607 my $line = (exists $opts{-line}) ? " at line $opts{-line}" : "";
608 my $file = (exists $opts{-file}) ? " in file $opts{-file}" : "";
609 unless (exists $opts{-severity}) {
610 ## See if can find severity in message prefix
611 $opts{-severity} = $1 if ( $msg =~ s/^\**\s*([A-Z]{3,}):\s+// );
613 my $severity = (exists $opts{-severity}) ? "*** $opts{-severity}: " : "";
615 ## Increment error count and print message "
616 ++($self->{_NUM_ERRORS})
617 if(!%opts || ($opts{-severity} && $opts{-severity} eq 'ERROR'));
618 ++($self->{_NUM_WARNINGS})
619 if(!%opts || ($opts{-severity} && $opts{-severity} eq 'WARNING'));
620 my $out_fh = $self->output_handle() || \*STDERR;
621 print $out_fh ($severity, $msg, $line, $file, "\n")
622 if($self->{-warnings} || !%opts || $opts{-severity} ne 'WARNING');
625 ##################################
627 =item C<$checker-E<gt>num_errors()>
629 Set (if argument specified) and retrieve the number of errors found.
634 return (@_ > 1) ? ($_[0]->{_NUM_ERRORS} = $_[1]) : $_[0]->{_NUM_ERRORS};
637 ##################################
639 =item C<$checker-E<gt>num_warnings()>
641 Set (if argument specified) and retrieve the number of warnings found.
646 return (@_ > 1) ? ($_[0]->{_NUM_WARNINGS} = $_[1]) : $_[0]->{_NUM_WARNINGS};
649 ##################################
651 =item C<$checker-E<gt>name()>
653 Set (if argument specified) and retrieve the canonical name of POD as
654 found in the C<=head1 NAME> section.
659 return (@_ > 1 && $_[1]) ?
660 ($_[0]->{-name} = $_[1]) : $_[0]->{-name};
663 ##################################
665 =item C<$checker-E<gt>node()>
667 Add (if argument specified) and retrieve the nodes (as defined by C<=headX>
668 and C<=item>) of the current POD. The nodes are returned in the order of
669 their occurrence. They consist of plain text, each piece of whitespace is
670 collapsed to a single blank.
675 my ($self,$text) = @_;
677 $text =~ s/\s+$//s; # strip trailing whitespace
678 $text =~ s/\s+/ /gs; # collapse whitespace
679 # add node, order important!
680 push(@{$self->{_nodes}}, $text);
681 # keep also a uniqueness counter
682 $self->{_unique_nodes}->{$text}++ if($text !~ /^\s*$/s);
688 ##################################
690 =item C<$checker-E<gt>idx()>
692 Add (if argument specified) and retrieve the index entries (as defined by
693 C<XE<lt>E<gt>>) of the current POD. They consist of plain text, each piece
694 of whitespace is collapsed to a single blank.
698 # set/return index entries of current POD
700 my ($self,$text) = @_;
702 $text =~ s/\s+$//s; # strip trailing whitespace
703 $text =~ s/\s+/ /gs; # collapse whitespace
704 # add node, order important!
705 push(@{$self->{_index}}, $text);
706 # keep also a uniqueness counter
707 $self->{_unique_nodes}->{$text}++ if($text !~ /^\s*$/s);
713 ##################################
715 =item C<$checker-E<gt>hyperlink()>
717 Add (if argument specified) and retrieve the hyperlinks (as defined by
718 C<LE<lt>E<gt>>) of the current POD. They consist of a 2-item array: line
719 number and C<Pod::Hyperlink> object.
725 # set/return hyperlinks of the current POD
729 push(@{$self->{_links}}, $_[0]);
735 ## overrides for Pod::Parser
738 ## Do some final checks and
739 ## print the number of errors found
741 my $infile = $self->input_file();
742 my $out_fh = $self->output_handle();
744 if(@{$self->{_list_stack}}) {
745 # _TODO_ display, but don't count them for now
747 while(($list = $self->_close_list('EOF',$infile)) &&
748 $list->indent() ne 'auto') {
749 $self->poderror({ -line => 'EOF', -file => $infile,
750 -severity => 'ERROR', -msg => "=over on line " .
751 $list->start() . " without closing =back" }); #"
755 # check validity of document internal hyperlinks
756 # first build the node names from the paragraph text
758 foreach($self->node()) {
761 # we have more than one word. Use the first as a node, too.
762 # This is used heavily in perlfunc.pod
763 $nodes{$1} ||= 2; # derived node
766 foreach($self->idx()) {
767 $nodes{$_} = 3; # index node
769 foreach($self->hyperlink()) {
770 my ($line,$link) = @$_;
771 # _TODO_ what if there is a link to the page itself by the name,
772 # e.g. in Tk::Pod : L<Tk::Pod/"DESCRIPTION">
773 if($link->node() && !$link->page() && $link->type() ne 'hyperlink') {
774 my $node = $self->_check_ptree($self->parse_text($link->node(),
775 $line), $line, $infile, 'L');
776 if($node && !$nodes{$node}) {
777 $self->poderror({ -line => $line || '', -file => $infile,
778 -severity => 'ERROR',
779 -msg => "unresolved internal link '$node'"});
784 # check the internal nodes for uniqueness. This pertains to
785 # =headX, =item and X<...>
786 foreach(grep($self->{_unique_nodes}->{$_} > 1,
787 keys %{$self->{_unique_nodes}})) {
788 $self->poderror({ -line => '-', -file => $infile,
789 -severity => 'WARNING',
790 -msg => "multiple occurrence of link target '$_'"});
793 ## Print the number of errors found
794 my $num_errors = $self->num_errors();
795 if ($num_errors > 0) {
796 printf $out_fh ("$infile has $num_errors pod syntax %s.\n",
797 ($num_errors == 1) ? "error" : "errors");
799 elsif($self->{_commands} == 0) {
800 print $out_fh "$infile does not contain any pod commands.\n";
801 $self->num_errors(-1);
804 print $out_fh "$infile pod syntax OK.\n";
808 # check a POD command directive
810 my ($self, $cmd, $paragraph, $line_num, $pod_para) = @_;
811 my ($file, $line) = $pod_para->file_line;
812 ## Check the command syntax
813 my $arg; # this will hold the command argument
814 if (! $VALID_COMMANDS{$cmd}) {
815 $self->poderror({ -line => $line, -file => $file, -severity => 'ERROR',
816 -msg => "Unknown command '$cmd'" });
818 else { # found a valid command
819 $self->{_commands}++; # delete this line if below is enabled again
821 ##### following check disabled due to strong request
822 #if(!$self->{_commands}++ && $cmd !~ /^head/) {
823 # $self->poderror({ -line => $line, -file => $file,
824 # -severity => 'WARNING',
825 # -msg => "file does not start with =head" });
828 # check syntax of particular command
831 $arg = $self->interpolate_and_check($paragraph, $line,$file);
832 my $indent = 4; # default
833 if($arg && $arg =~ /^\s*(\d+)\s*$/) {
837 $self->_open_list($indent,$line,$file);
839 elsif($cmd eq 'item') {
841 unless(@{$self->{_list_stack}}) {
842 $self->poderror({ -line => $line, -file => $file,
843 -severity => 'ERROR',
844 -msg => "=item without previous =over" });
845 # auto-open in case we encounter many more
846 $self->_open_list('auto',$line,$file);
848 my $list = $self->{_list_stack}->[0];
849 # check whether the previous item had some contents
850 if(defined $self->{_list_item_contents} &&
851 $self->{_list_item_contents} == 0) {
852 $self->poderror({ -line => $line, -file => $file,
853 -severity => 'WARNING',
854 -msg => "previous =item has no contents" });
856 if($list->{_has_par}) {
857 $self->poderror({ -line => $line, -file => $file,
858 -severity => 'WARNING',
859 -msg => "preceding non-item paragraph(s)" });
860 delete $list->{_has_par};
863 $arg = $self->interpolate_and_check($paragraph, $line, $file);
864 if($arg && $arg =~ /(\S+)/) {
865 $arg =~ s/[\s\n]+$//;
867 if($arg =~ /^[*]\s*(\S*.*)/) {
869 $self->{_list_item_contents} = $1 ? 1 : 0;
872 elsif($arg =~ /^\d+\.?\s*(\S*)/) {
874 $self->{_list_item_contents} = $1 ? 1 : 0;
878 $type = 'definition';
879 $self->{_list_item_contents} = 1;
881 my $first = $list->type();
882 if($first && $first ne $type) {
883 $self->poderror({ -line => $line, -file => $file,
884 -severity => 'WARNING',
885 -msg => "=item type mismatch ('$first' vs. '$type')"});
892 $self->poderror({ -line => $line, -file => $file,
893 -severity => 'WARNING',
894 -msg => "No argument for =item" });
896 $self->{_list_item_contents} = 0;
903 elsif($cmd eq 'back') {
904 # check if we have an open list
905 unless(@{$self->{_list_stack}}) {
906 $self->poderror({ -line => $line, -file => $file,
907 -severity => 'ERROR',
908 -msg => "=back without previous =over" });
911 # check for spurious characters
912 $arg = $self->interpolate_and_check($paragraph, $line,$file);
913 if($arg && $arg =~ /\S/) {
914 $self->poderror({ -line => $line, -file => $file,
915 -severity => 'ERROR',
916 -msg => "Spurious character(s) after =back" });
919 my $list = $self->_close_list($line,$file);
920 # check for empty lists
921 if(!$list->item() && $self->{-warnings}) {
922 $self->poderror({ -line => $line, -file => $file,
923 -severity => 'WARNING',
924 -msg => "No items in =over (at line " .
925 $list->start() . ") / =back list"}); #"
929 elsif($cmd =~ /^head(\d+)/) {
931 $self->{"_have_head_$hnum"}++; # count head types
932 if($hnum > 1 && !$self->{"_have_head_".($hnum -1)}) {
933 $self->poderror({ -line => $line, -file => $file,
934 -severity => 'WARNING',
935 -msg => "=head$hnum without preceding higher level"});
937 # check whether the previous =head section had some contents
938 if(defined $self->{_commands_in_head} &&
939 $self->{_commands_in_head} == 0 &&
940 defined $self->{_last_head} &&
941 $self->{_last_head} >= $hnum) {
942 $self->poderror({ -line => $line, -file => $file,
943 -severity => 'WARNING',
944 -msg => "empty section in previous paragraph"});
946 $self->{_commands_in_head} = -1;
947 $self->{_last_head} = $hnum;
948 # check if there is an open list
949 if(@{$self->{_list_stack}}) {
951 while(($list = $self->_close_list($line,$file)) &&
952 $list->indent() ne 'auto') {
953 $self->poderror({ -line => $line, -file => $file,
954 -severity => 'ERROR',
955 -msg => "=over on line ". $list->start() .
956 " without closing =back (at $cmd)" });
960 $arg = $self->interpolate_and_check($paragraph, $line,$file);
961 $arg =~ s/[\s\n]+$//s;
963 unless(length($arg)) {
964 $self->poderror({ -line => $line, -file => $file,
965 -severity => 'ERROR',
966 -msg => "empty =$cmd"});
968 if($cmd eq 'head1') {
969 $self->{_current_head1} = $arg;
971 $self->{_current_head1} = '';
974 elsif($cmd eq 'begin') {
975 if($self->{_have_begin}) {
976 # already have a begin
977 $self->poderror({ -line => $line, -file => $file,
978 -severity => 'ERROR',
979 -msg => "Nested =begin's (first at line " .
980 $self->{_have_begin} . ")"});
984 $arg = $self->interpolate_and_check($paragraph, $line,$file);
985 unless($arg && $arg =~ /(\S+)/) {
986 $self->poderror({ -line => $line, -file => $file,
987 -severity => 'ERROR',
988 -msg => "No argument for =begin"});
990 # remember the =begin
991 $self->{_have_begin} = "$line:$1";
994 elsif($cmd eq 'end') {
995 if($self->{_have_begin}) {
996 # close the existing =begin
997 $self->{_have_begin} = '';
998 # check for spurious characters
999 $arg = $self->interpolate_and_check($paragraph, $line,$file);
1000 # the closing argument is optional
1001 #if($arg && $arg =~ /\S/) {
1002 # $self->poderror({ -line => $line, -file => $file,
1003 # -severity => 'WARNING',
1004 # -msg => "Spurious character(s) after =end" });
1008 # don't have a matching =begin
1009 $self->poderror({ -line => $line, -file => $file,
1010 -severity => 'ERROR',
1011 -msg => "=end without =begin" });
1014 elsif($cmd eq 'for') {
1015 unless($paragraph =~ /\s*(\S+)\s*/) {
1016 $self->poderror({ -line => $line, -file => $file,
1017 -severity => 'ERROR',
1018 -msg => "=for without formatter specification" });
1020 $arg = ''; # do not expand paragraph below
1022 elsif($cmd =~ /^(pod|cut)$/) {
1023 # check for argument
1024 $arg = $self->interpolate_and_check($paragraph, $line,$file);
1025 if($arg && $arg =~ /(\S+)/) {
1026 $self->poderror({ -line => $line, -file => $file,
1027 -severity => 'ERROR',
1028 -msg => "Spurious text after =$cmd"});
1031 $self->{_commands_in_head}++;
1032 ## Check the interior sequences in the command-text
1033 $self->interpolate_and_check($paragraph, $line,$file)
1034 unless(defined $arg);
1040 my ($self,$indent,$line,$file) = @_;
1041 my $list = Pod::List->new(
1045 unshift(@{$self->{_list_stack}}, $list);
1046 undef $self->{_list_item_contents};
1052 my ($self,$line,$file) = @_;
1053 my $list = shift(@{$self->{_list_stack}});
1054 if(defined $self->{_list_item_contents} &&
1055 $self->{_list_item_contents} == 0) {
1056 $self->poderror({ -line => $line, -file => $file,
1057 -severity => 'WARNING',
1058 -msg => "previous =item has no contents" });
1060 undef $self->{_list_item_contents};
1064 # process a block of some text
1065 sub interpolate_and_check {
1066 my ($self, $paragraph, $line, $file) = @_;
1067 ## Check the interior sequences in the command-text
1068 # and return the text
1069 $self->_check_ptree(
1070 $self->parse_text($paragraph,$line), $line, $file, '');
1074 my ($self,$ptree,$line,$file,$nestlist) = @_;
1077 # process each node in the parse tree
1079 # regular text chunk
1082 # count the unescaped angle brackets
1083 # complain only when warning level is greater than 1
1085 if($count = $i =~ tr/<>/<>/) {
1086 $self->poderror({ -line => $line, -file => $file,
1087 -severity => 'WARNING',
1088 -msg => "$count unescaped <> in paragraph" })
1089 if($self->{-warnings} && $self->{-warnings}>1);
1094 # have an interior sequence
1095 my $cmd = $_->cmd_name();
1096 my $contents = $_->parse_tree();
1097 ($file,$line) = $_->file_line();
1098 # check for valid tag
1099 if (! $VALID_SEQUENCES{$cmd}) {
1100 $self->poderror({ -line => $line, -file => $file,
1101 -severity => 'ERROR',
1102 -msg => qq(Unknown interior-sequence '$cmd')});
1104 $text .= $self->_check_ptree($contents, $line, $file, "$nestlist$cmd");
1107 if($nestlist =~ /$cmd/) {
1108 $self->poderror({ -line => $line, -file => $file,
1109 -severity => 'ERROR',
1110 -msg => "nested commands $cmd<...$cmd<...>...>"});
1111 # _TODO_ should we add the contents anyway?
1112 # expand it anyway, see below
1116 if(@$contents > 1 || ref $$contents[0] || $$contents[0] !~ /^\w+$/) {
1117 $self->poderror({ -line => $line, -file => $file,
1118 -severity => 'ERROR',
1119 -msg => "garbled entity " . $_->raw_text()});
1122 my $ent = $$contents[0];
1124 if($ent =~ /^0x[0-9a-f]+$/i) {
1128 elsif($ent =~ /^0\d+$/) {
1132 elsif($ent =~ /^\d+$/) {
1137 if($val>0 && $val<256) {
1141 $self->poderror({ -line => $line, -file => $file,
1142 -severity => 'ERROR',
1143 -msg => "Entity number out of range " . $_->raw_text()});
1146 elsif($ENTITIES{$ent}) {
1148 $text .= $ENTITIES{$ent};
1151 $self->poderror({ -line => $line, -file => $file,
1152 -severity => 'WARNING',
1153 -msg => "Unknown entity " . $_->raw_text()});
1157 elsif($cmd eq 'L') {
1158 # try to parse the hyperlink
1159 my $link = Pod::Hyperlink->new($contents->raw_text());
1160 unless(defined $link) {
1161 $self->poderror({ -line => $line, -file => $file,
1162 -severity => 'ERROR',
1163 -msg => "malformed link " . $_->raw_text() ." : $@"});
1166 $link->line($line); # remember line
1167 if($self->{-warnings}) {
1168 foreach my $w ($link->warning()) {
1169 $self->poderror({ -line => $line, -file => $file,
1170 -severity => 'WARNING',
1174 # check the link text
1175 $text .= $self->_check_ptree($self->parse_text($link->text(),
1176 $line), $line, $file, "$nestlist$cmd");
1178 $self->hyperlink([$line,$link]);
1180 elsif($cmd =~ /[BCFIS]/) {
1182 $text .= $self->_check_ptree($contents, $line, $file, "$nestlist$cmd");
1184 elsif($cmd eq 'Z') {
1185 if(length($contents->raw_text())) {
1186 $self->poderror({ -line => $line, -file => $file,
1187 -severity => 'ERROR',
1188 -msg => "Nonempty Z<>"});
1191 elsif($cmd eq 'X') {
1192 my $idx = $self->_check_ptree($contents, $line, $file, "$nestlist$cmd");
1193 if($idx =~ /^\s*$/s) {
1194 $self->poderror({ -line => $line, -file => $file,
1195 -severity => 'ERROR',
1196 -msg => "Empty X<>"});
1199 # remember this node
1205 die "internal error";
1211 # process a block of verbatim text
1213 ## Nothing particular to check
1214 my ($self, $paragraph, $line_num, $pod_para) = @_;
1216 $self->_preproc_par($paragraph);
1218 if($self->{_current_head1} eq 'NAME') {
1219 my ($file, $line) = $pod_para->file_line;
1220 $self->poderror({ -line => $line, -file => $file,
1221 -severity => 'WARNING',
1222 -msg => 'Verbatim paragraph in NAME section' });
1226 # process a block of regular text
1228 my ($self, $paragraph, $line_num, $pod_para) = @_;
1229 my ($file, $line) = $pod_para->file_line;
1231 $self->_preproc_par($paragraph);
1233 # skip this paragraph if in a =begin block
1234 unless($self->{_have_begin}) {
1235 my $block = $self->interpolate_and_check($paragraph, $line,$file);
1236 if($self->{_current_head1} eq 'NAME') {
1237 if($block =~ /^\s*(\S+?)\s*[,-]/) {
1238 # this is the canonical name
1239 $self->{-name} = $1 unless(defined $self->{-name});
1248 $_[0] =~ s/[\s\n]+$//;
1250 $self->{_commands_in_head}++;
1251 $self->{_list_item_contents}++ if(defined $self->{_list_item_contents});
1252 if(@{$self->{_list_stack}} && !$self->{_list_stack}->[0]->item()) {
1253 $self->{_list_stack}->[0]->{_has_par} = 1;
1264 Brad Appleton E<lt>bradapp@enteract.comE<gt> (initial version),
1265 Marek Rouchal E<lt>marek@saftsack.fs.uni-bayreuth.deE<gt>
1267 Based on code for B<Pod::Text::pod2text()> written by
1268 Tom Christiansen E<lt>tchrist@mox.perl.comE<gt>