# A quite dimwitted pod2plaintext that need only know how to format whatever
# text comes out of Pod::BlackBox's _gen_errata

package Pod::Simple::Checker;

use utf8;
use Carp ();
use Pod::Simple::Methody ();
use Pod::Simple ();
our $VERSION = '2.02';
our @ISA = @('Pod::Simple::Methody');
BEGIN { *DEBUG = defined(&Pod::Simple::DEBUG)
          ?? \&Pod::Simple::DEBUG
          !! sub() {0}
      }

use Text::Wrap v98.112902 (); # was 2001.0131, but I don't think we need that
$Text::Wrap::wrap = 'overflow';
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

sub any_errata_seen {  # read-only accessor
  return @_[1]->{?'Errata_seen'};
}

sub new {
  my $self = shift;
  my $new = $self->SUPER::new(< @_);
  $new->{+'output_fh'} ||= $^STDOUT{IO};
  $new->nix_X_codes(1);
  $new->nbsp_for_S(1);
  $new->{+'Thispara'} = '';
  $new->{+'Indent'} = 0;
  $new->{+'Indentstring'} = '   ';
  $new->{+'Errata_seen'} = 0;
  return $new;
}

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

sub handle_text {  @_[0]->{?'Errata_seen'} and @_[0]->{+'Thispara'} .= @_[1] }

sub start_Para  {  @_[0]->{+'Thispara'} = '' }

sub start_head1 {
  if(@_[0]->{?'Errata_seen'}) {
    @_[0]->{+'Thispara'} = '';
  } else {
    if(@_[1]->{?'errata'}) { # start of errata!
      @_[0]->{+'Errata_seen'} = 1;
      @_[0]->{+'Thispara'} = @_[0]->{?'source_filename'} ??
        "@_[0]->{?'source_filename'} -- " !! ''
    }
  }
}
sub start_head2 {  @_[0]->{+'Thispara'} = '' }
sub start_head3 {  @_[0]->{+'Thispara'} = '' }
sub start_head4 {  @_[0]->{+'Thispara'} = '' }

sub start_Verbatim    { @_[0]->{+'Thispara'} = ''   }
sub start_item_bullet { @_[0]->{+'Thispara'} = '* ' }
sub start_item_number { @_[0]->{+'Thispara'} = "@_[1]->{?'number'}. "  }
sub start_item_text   { @_[0]->{+'Thispara'} = ''   }

sub start_over_bullet  { ++@_[0]->{+'Indent'} }
sub start_over_number  { ++@_[0]->{+'Indent'} }
sub start_over_text    { ++@_[0]->{+'Indent'} }
sub start_over_block   { ++@_[0]->{+'Indent'} }

sub   end_over_bullet  { --@_[0]->{+'Indent'} }
sub   end_over_number  { --@_[0]->{+'Indent'} }
sub   end_over_text    { --@_[0]->{+'Indent'} }
sub   end_over_block   { --@_[0]->{+'Indent'} }


# . . . . . Now the actual formatters:

sub end_head1       { @_[0]->emit_par(-4) }
sub end_head2       { @_[0]->emit_par(-3) }
sub end_head3       { @_[0]->emit_par(-2) }
sub end_head4       { @_[0]->emit_par(-1) }
sub end_Para        { @_[0]->emit_par( 0) }
sub end_item_bullet { @_[0]->emit_par( 0) }
sub end_item_number { @_[0]->emit_par( 0) }
sub end_item_text   { @_[0]->emit_par(-2) }

sub emit_par {
  return unless @_[0]->{?'Errata_seen'};
  my@($self, $tweak_indent) = @: splice(@_,0,2);
  my $indent = ' ' x ( 2 * $self->{?'Indent'} + ($tweak_indent||0) );
   # Yes, 'STRING' x NEGATIVE gives '', same as 'STRING' x 0

  $self->{+'Thispara'} =~ s/\x{AD}//g if Pod::Simple::ASCII;
  my $out = Text::Wrap::wrap($indent, $indent, ($self->{+'Thispara'} .= "\n"));
  $out =~ s/\x{A0}/ /g if Pod::Simple::ASCII;
  print $self->{?'output_fh'} ,$out,
    #"\n"
  ;
  $self->{+'Thispara'} = '';
  
  return;
}

# . . . . . . . . . . And then off by its lonesome:

sub end_Verbatim  {
  return unless @_[0]->{?'Errata_seen'};
  my $self = shift;
  if(Pod::Simple::ASCII) {
    $self->{+'Thispara'} =~ s/\x{A0}/ /g;
    $self->{+'Thispara'} =~ s/\x{AD}//g;
  }

  my $i = ' ' x ( 2 * $self->{?'Indent'} + 4);
  
  $self->{+'Thispara'} =~ s/^/$i/mg;
  
  print  $self->{?'output_fh'}    ,'', 
    $self->{?'Thispara'},
    "\n\n"
  ;
  $self->{+'Thispara'} = '';
  return;
}

#@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
1;

__END__

=head1 NAME

Pod::Simple::Checker -- check the Pod syntax of a document

=head1 SYNOPSIS

  perl -MPod::Simple::Checker -e \
   "exit Pod::Simple::Checker->filter(shift)->any_errata_seen" \
   thingy.pod

=head1 DESCRIPTION

This class is for checking the syntactic validity of Pod.
It works by basically acting like a simple-minded version of
L<Pod::Simple::Text> that formats only the "Pod Errors" section
(if Pod::Simple even generates one for the given document).

This is a subclass of L<Pod::Simple> and inherits all its methods.

=head1 SEE ALSO

L<Pod::Simple>, L<Pod::Simple::Text>, L<Pod::Checker>

=head1 COPYRIGHT AND DISCLAIMERS

Copyright (c) 2002 Sean M. Burke.  All rights reserved.

This library is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.

This program is distributed in the hope that it will be useful, but
without any warranty; without even the implied warranty of
merchantability or fitness for a particular purpose.

=head1 AUTHOR

Sean M. Burke C<sburke@cpan.org>

=cut