view release on metacpan or  search on metacpan

lib/App/sdview/Output/Pod.pm  view on Meta::CPAN

use warnings;

use Object::Pad 0.807;

package App::sdview::Output::Pod 0.20;
class App::sdview::Output::Pod :strict(params);

apply App::sdview::Output;

use constant format => "Pod";

=head1 NAME

C<App::sdview::Output::Pod> - generate Pod output from L<App::sdview>

=head1 SYNOPSIS

   $ sdview README.md -o Pod > README.pod

=head1 DESCRIPTION

This output module adds to L<App::sdview> the ability to output text in Pod
formatting. Given a Pod file as input, the output should be relatively
similar, up to minor details like whitespacing. Given input in some other
format, it will do a reasonable job attempting to represent most of the
structure and formatting.

As an extension it will output underline formatting using the C<UE<lt>...E<gt>>
code, which is recognised by L<App::sdview::Parser::Pod>.

=cut

field $_printed_pod;

method output_head1 ( $para ) { $self->_output_head( "=head1", $para ); }
method output_head2 ( $para ) { $self->_output_head( "=head2", $para ); }
method output_head3 ( $para ) { $self->_output_head( "=head3", $para ); }
method output_head4 ( $para ) { $self->_output_head( "=head4", $para ); }

method _output_head ( $leader, $para )
{
   $self->maybe_blank;

   $self->say( $leader, " ", $self->_convert_str( $para->text ) );
   $_printed_pod = 1;
}

method output_plain ( $para )
{
   $self->say( "=pod" ), $_printed_pod = 1 unless $_printed_pod;
   $self->maybe_blank;

   $self->say( $self->_convert_str( $para->text ) );
}

method output_verbatim ( $para )
{
   $self->say( "=pod" ), $_printed_pod = 1 unless $_printed_pod;
   $self->maybe_blank;

   $self->say( "    ", $_ ) for split m/\n/, $para->text;
}

method output_list_bullet ( $para ) { $self->_output_list( $para ); }
method output_list_number ( $para ) { $self->_output_list( $para ); }
method output_list_text   ( $para ) { $self->_output_list( $para ); }

method _output_list ( $para )
{
   $self->maybe_blank;

   $self->say( "=over ", $para->indent );
   $self->say;

   my @items = $para->items;
   foreach my $idx ( 0 .. $#items ) {
      my $item = $items[$idx];

      if( $item->type ne "item" ) {
         # Non-item has no leader
      }
      elsif( $para->listtype eq "bullet" ) {
         $self->say( "=item *" );
         $self->say;
      }
      elsif( $para->listtype eq "number" ) {
         $self->say( sprintf "=item %d.", $idx + 1 );
         $self->say;
      }
      elsif( $para->listtype eq "text" ) {
         $self->say( sprintf "=item %s", $self->_convert_str( $item->term ) );
         $self->say;
      }

      $self->say( $self->_convert_str( $item->text ) );
      $self->say;
   }

   $self->say( "=back" );
}

field $table_style :param :reader;

method output_table ( $para )
{
   $self->maybe_blank;

   my $method = $self->can( "output_table_$table_style" ) or return;
   $self->$method( $para );
}

method output_table_md ( $para )
{
   $self->say( "=begin table md" );
   $self->say;

   my $first = 1;
   foreach my $row ( $para->rows ) {
      my @cells = @$row;
      $self->say( join " | ", map { $self->_convert_str( $_->text ) } @cells );