File Coverage

blib/lib/PDFLib/PPS.pm

Criterion	Covered	Total	%
statement	7	9	77.7
branch			n/a
condition			n/a
subroutine	3	3	100.0
pod			n/a
total	10	12	83.3

package PDFLib::PPS;

use strict;
use base 'PDFLib';
use pdflib_pl 7.0;
use PDFLib::ZapfChars;

use constant { ERROR => -1 };

our $VERSION = '0.04';

if ($ARGV[0]) {
  my $pdf = PDFLib::PPS->new(BlockContainer => $ARGV[0]);
  $pdf->print_block_info;
  exit;
}

sub new {
  my $class = shift;
  my $pdf = $class->SUPER::new(@_);
  return $pdf;
}

sub flowhandle {
  my ($pdf, $field_name, $handle) = @_;
  if (defined $handle) {
    $pdf->{FlowHandles}{$field_name} = $handle;
  }
  return defined $pdf->{FlowHandles}{$field_name}
    ? $pdf->{FlowHandles}{$field_name} : -1;
}


sub zapfchar {
  my ($pdf, $name) = @_;
  return sprintf('%c', $PDFLib::ZapfChars{$name});
}

sub search_path {
  my ($pdf, $search_path) = @_;
  if (defined $search_path) {
    $pdf->{SearchPath} = $search_path;
  }
  $pdf->{SearchPath};
}

sub block_data {
  my $pdf = shift;
  if ($_[0]) {
    $pdf->{BlockData} = ref $_[0] ? $_[0] : \@_;
  }
  return $pdf->{BlockData};
}

sub block_datum {
  my ($pdf, $block_name, $value) = @_;
  if (defined $value) {
    $pdf->{BlockData}->{$block_name} = $value;
  }
  return $pdf->{BlockData}->{$block_name};
}

sub block_container {		# this is the "template" filename
  my ($pdf, $block_container) = @_;
  if (defined $block_container) {
    $pdf->{BlockContainer} = $block_container;
  }
  $pdf->{BlockContainer};
}

sub container {			# i.e., the block container object
  my ($pdf, $container) = @_;
  if (defined $container) {
    $pdf->{container} = $container;
  }
  return $pdf->{container};
}

sub current_page {
  my ($pdf, $page) = @_;
  if (defined $page) {
    $pdf->{page} = $page;
  }
  return $pdf->{page};
}

sub parse_datum {
  my ($pdf, $datum) = @_;
  return $datum unless ref $datum eq 'HASH';

  my $text = $datum->{text};
  my $override_encoding = exists $datum->{encoding} ? "Yes" : undef;
  my $options = join " " =>
    map { sprintf "%s=%s", $_, $datum->{$_} } grep { not /text/ } keys %$datum;

  return ($text, $options, $override_encoding);
}

sub fill_in {
  my ($pdf, $verbose) = @_;

  my $container = $pdf->open_pdi_document;
  defined $container ? $pdf->container($container) : return undef;

  for my $page_no (1 .. $pdf->number_of_pages) {
    print STDERR "[PPS] processing page number $page_no\n" if $verbose;

    # open the template page.
    my $page = $pdf->open_pdi_page($page_no);
    defined $page ? $pdf->current_page($page) : return undef;

    # create a new document page.
    $pdf->begin_page_ext;

    for my $block_name (sort $pdf->block_names) {
      my $encoding = $pdf->encoding_for_block($block_name);

      my ($text, $font_spec, $override_encoding) =
	$pdf->parse_datum($pdf->block_datum($block_name));
      $encoding = $override_encoding ? $font_spec : "$encoding $font_spec";

      if ($pdf->is_textflow($block_name)) {
	$encoding .= sprintf " textflowhandle=%s textflow=true $font_spec ",
	  $pdf->flowhandle($block_name);
	print STDERR "$block_name encoding: ($font_spec) $encoding\n"
	  if $verbose;
      }

      my $fill =
	PDF_fill_textblock($pdf->_pdf, $pdf->current_page,
			   $block_name, $text, "$encoding");
      if ($fill == ERROR) { return undef }

      if ($pdf->is_textflow($block_name)) {
	$pdf->flowhandle($block_name, $fill);
      }

      print STDERR
	"[page $page_no]\tfilled in $block_name with $text ($encoding)\n"
	if $verbose;
    }

    $pdf->end_page_ext;
    $pdf->close_pdi_page;
  }

  $pdf->close_pdi_document;
  return "OK";
}

sub block_info {
  my $pdf = shift;

  my $container = $pdf->open_pdi_document;
  defined $container ? $pdf->container($container) : return undef;

  my %info = ();
  for my $page_no (1 .. $pdf->number_of_pages) {

    # open the template page.
    my $page = $pdf->open_pdi_page($page_no);
    defined $page ? $pdf->current_page($page) : return undef;

    for my $block_name ($pdf->block_names) {
      my $font = $pdf->font_for_block($block_name);
      push @{ $info{$page_no} } => [$block_name, $font];
    }

    $pdf->close_pdi_page;
  }
  return wantarray ? %info : \%info;
}

sub print_block_info {
  my $pdf = shift;
  my %info = $pdf->block_info;
  for my $page (sort keys %info) {
    print "Page $page ", '-' x 70, "\n";
    for my $block (@{ $info{$page} }) {
      my ($name, $font) = @$block;
      my $spacer = " " x (40 - length $name);
      print "\t$name $spacer $font\n";
    }
  }
}

sub end_page_ext {
  my $pdf = shift;
  PDF_end_page_ext($pdf->_pdf, "");
}

sub begin_page_ext {
  my $pdf = shift;
  PDF_begin_page_ext($pdf->_pdf, 20, 20, "");
  PDF_fit_pdi_page($pdf->_pdf, $pdf->current_page, 0, 0, "adjustpage");
}

sub encoding_for_block {
  my ($pdf, $block_name) = @_;
  my $font = $pdf->font_for_block($block_name);
  if ($font eq 'ZapfDingbats') {
    return "encoding=builtin";
  }
  else {
    return "encoding=host";
  }
}

sub get_pdi_parameter {
  my ($pdf, $path) = @_;
  return PDF_get_pdi_parameter($pdf->_pdf, $path,
			       $pdf->container, $pdf->current_page, 0);
}

sub is_textflow {
  my ($pdf, $block_name) = @_;
  return lc $pdf->field_type($block_name) eq 'textflow' ? 1 : undef;
}

sub field_type {
  my ($pdf, $block_name) = @_;
  return
    $pdf->get_pdi_parameter("vdp/Blocks/$block_name/Custom/PDFlib:field:type");
}

sub font_for_block {
  my ($pdf, $block_name) = @_;
  return $pdf->get_pdi_parameter("vdp/Blocks/$block_name/fontname");
}

sub block_names {
  my $pdf = shift;
  my $count = $pdf->block_count;
  return map { $pdf->get_pdi_parameter("vdp/Blocks[$_]/Name") }
    (0 .. ($pdf->block_count - 1));
}



sub block_count {
  my $pdf = shift;
  return PDF_get_pdi_value($pdf->_pdf, 'vdp/blockcount',
			   $pdf->container, $pdf->current_page, 0);
}

sub number_of_pages {
  my $pdf = shift;
  return PDF_get_pdi_value($pdf->_pdf, '/Root/Pages/Count',
			   $pdf->container, -1, 0);
}

sub open_pdi_document {
  my ($pdf) = @_;
  $pdf->set_parameter(SearchPath => $pdf->search_path);
  $pdf->set_parameter(pdiwarning => 'true');
  my $container = PDF_open_pdi_document($pdf->_pdf, $pdf->block_container, "");
  if ($container == ERROR) {
    warn ("Error opening PDI document: ", PDF_get_errmsg($pdf->_pdf));
    return undef;
  }
  return $container;
}

sub close_pdi_document {
  my $pdf = shift;
  PDF_close_pdi($pdf->_pdf, $pdf->container);
}

sub open_pdi_page {
  my ($pdf, $page_no) = @_;
  my $page = PDF_open_pdi_page($pdf->_pdf, $pdf->container, $page_no, "");
  if ($page == ERROR) {
    warn ("Error opening PDI page: ", PDF_get_errmsg($pdf->_pdf));
    return undef;
  }
  return $page;
}

sub close_pdi_page {
  my $pdf = shift;
  PDF_close_pdi_page($pdf->_pdf, $pdf->current_page);
}


1;


__END__