| 1 | package PDF::API2; | ||||||||||||||||||||||||||||||||||||||||||||
| 2 | |||||||||||||||||||||||||||||||||||||||||||||
| 3 | 38 | ▶ | use strict; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||||||||||||||||||
| 4 | 38 | ▶ | no warnings qw[ deprecated recursion uninitialized ]; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||||||||||||||||||
| 5 | |||||||||||||||||||||||||||||||||||||||||||||
| 6 | 38 | our $VERSION = '2.044'; # VERSION | |||||||||||||||||||||||||||||||||||||||||||
| 7 | |||||||||||||||||||||||||||||||||||||||||||||
| 8 | 38 | ▶ | use Carp; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||||||||||||||||||
| 9 | 38 | ▶ | use Encode qw(:all); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||||||||||||||||||
| 10 | 38 | ▶ | use English; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||||||||||||||||||
| 11 | 38 | ▶ | use FileHandle; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||||||||||||||||||
| 12 | |||||||||||||||||||||||||||||||||||||||||||||
| 13 | 38 | ▶ | use PDF::API2::Basic::PDF::Utils; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||||||||||||||||||
| 14 | 38 | ▶ | use PDF::API2::Util; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||||||||||||||||||
| 15 | |||||||||||||||||||||||||||||||||||||||||||||
| 16 | 38 | ▶ | use PDF::API2::Basic::PDF::File; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||||||||||||||||||
| 17 | 38 | ▶ | use PDF::API2::Basic::PDF::Pages; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||||||||||||||||||
| 18 | 38 | ▶ | use PDF::API2::Page; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||||||||||||||||||
| 19 | |||||||||||||||||||||||||||||||||||||||||||||
| 20 | 38 | ▶ | use PDF::API2::Resource::XObject::Form::Hybrid; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||||||||||||||||||
| 21 | |||||||||||||||||||||||||||||||||||||||||||||
| 22 | 38 | ▶ | use PDF::API2::Resource::ExtGState; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||||||||||||||||||
| 23 | 38 | ▶ | use PDF::API2::Resource::Pattern; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||||||||||||||||||
| 24 | 38 | ▶ | use PDF::API2::Resource::Shading; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||||||||||||||||||
| 25 | |||||||||||||||||||||||||||||||||||||||||||||
| 26 | 38 | ▶ | use PDF::API2::NamedDestination; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||||||||||||||||||
| 27 | |||||||||||||||||||||||||||||||||||||||||||||
| 28 | 38 | ▶ | use List::Util qw(max); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||||||||||||||||||
| 29 | 38 | ▶ | use Scalar::Util qw(weaken); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||||||||||||||||||
| 30 | |||||||||||||||||||||||||||||||||||||||||||||
| 31 | 38 | my @font_path = __PACKAGE__->set_font_path('/usr/share/fonts', | |||||||||||||||||||||||||||||||||||||||||||
| 32 | '/usr/local/share/fonts', | ||||||||||||||||||||||||||||||||||||||||||||
| 33 | 'c:/windows/fonts'); | ||||||||||||||||||||||||||||||||||||||||||||
| 34 | |||||||||||||||||||||||||||||||||||||||||||||
| 35 | =head1 NAME | ||||||||||||||||||||||||||||||||||||||||||||
| 36 | |||||||||||||||||||||||||||||||||||||||||||||
| 37 | PDF::API2 - Create, modify, and examine PDF files | ||||||||||||||||||||||||||||||||||||||||||||
| 38 | |||||||||||||||||||||||||||||||||||||||||||||
| 39 | =head1 SYNOPSIS | ||||||||||||||||||||||||||||||||||||||||||||
| 40 | |||||||||||||||||||||||||||||||||||||||||||||
| 41 | use PDF::API2; | ||||||||||||||||||||||||||||||||||||||||||||
| 42 | |||||||||||||||||||||||||||||||||||||||||||||
| 43 | # Create a blank PDF file | ||||||||||||||||||||||||||||||||||||||||||||
| 44 | $pdf = PDF::API2->new(); | ||||||||||||||||||||||||||||||||||||||||||||
| 45 | |||||||||||||||||||||||||||||||||||||||||||||
| 46 | # Open an existing PDF file | ||||||||||||||||||||||||||||||||||||||||||||
| 47 | $pdf = PDF::API2->open('some.pdf'); | ||||||||||||||||||||||||||||||||||||||||||||
| 48 | |||||||||||||||||||||||||||||||||||||||||||||
| 49 | # Add a blank page | ||||||||||||||||||||||||||||||||||||||||||||
| 50 | $page = $pdf->page(); | ||||||||||||||||||||||||||||||||||||||||||||
| 51 | |||||||||||||||||||||||||||||||||||||||||||||
| 52 | # Retrieve an existing page | ||||||||||||||||||||||||||||||||||||||||||||
| 53 | $page = $pdf->open_page($page_number); | ||||||||||||||||||||||||||||||||||||||||||||
| 54 | |||||||||||||||||||||||||||||||||||||||||||||
| 55 | # Set the page size | ||||||||||||||||||||||||||||||||||||||||||||
| 56 | $page->size('Letter'); | ||||||||||||||||||||||||||||||||||||||||||||
| 57 | |||||||||||||||||||||||||||||||||||||||||||||
| 58 | # Add a built-in font to the PDF | ||||||||||||||||||||||||||||||||||||||||||||
| 59 | $font = $pdf->font('Helvetica-Bold'); | ||||||||||||||||||||||||||||||||||||||||||||
| 60 | |||||||||||||||||||||||||||||||||||||||||||||
| 61 | # Add an external TrueType font to the PDF | ||||||||||||||||||||||||||||||||||||||||||||
| 62 | $font = $pdf->font('/path/to/font.ttf'); | ||||||||||||||||||||||||||||||||||||||||||||
| 63 | |||||||||||||||||||||||||||||||||||||||||||||
| 64 | # Add some text to the page | ||||||||||||||||||||||||||||||||||||||||||||
| 65 | $text = $page->text(); | ||||||||||||||||||||||||||||||||||||||||||||
| 66 | $text->font($font, 20); | ||||||||||||||||||||||||||||||||||||||||||||
| 67 | $text->position(200, 700); | ||||||||||||||||||||||||||||||||||||||||||||
| 68 | $text->text('Hello World!'); | ||||||||||||||||||||||||||||||||||||||||||||
| 69 | |||||||||||||||||||||||||||||||||||||||||||||
| 70 | # Save the PDF | ||||||||||||||||||||||||||||||||||||||||||||
| 71 | $pdf->save('/path/to/new.pdf'); | ||||||||||||||||||||||||||||||||||||||||||||
| 72 | |||||||||||||||||||||||||||||||||||||||||||||
| 73 | =head1 INPUT/OUTPUT METHODS | ||||||||||||||||||||||||||||||||||||||||||||
| 74 | |||||||||||||||||||||||||||||||||||||||||||||
| 75 | =head2 new | ||||||||||||||||||||||||||||||||||||||||||||
| 76 | |||||||||||||||||||||||||||||||||||||||||||||
| 77 | my $pdf = PDF::API2->new(%options); | ||||||||||||||||||||||||||||||||||||||||||||
| 78 | |||||||||||||||||||||||||||||||||||||||||||||
| 79 | Create a new PDF. | ||||||||||||||||||||||||||||||||||||||||||||
| 80 | |||||||||||||||||||||||||||||||||||||||||||||
| 81 | The following options are available: | ||||||||||||||||||||||||||||||||||||||||||||
| 82 | |||||||||||||||||||||||||||||||||||||||||||||
| 83 | =over | ||||||||||||||||||||||||||||||||||||||||||||
| 84 | |||||||||||||||||||||||||||||||||||||||||||||
| 85 | =item * file | ||||||||||||||||||||||||||||||||||||||||||||
| 86 | |||||||||||||||||||||||||||||||||||||||||||||
| 87 | If you will be saving the PDF to disk and already know the filename, you can | ||||||||||||||||||||||||||||||||||||||||||||
| 88 | include it here to open the file for writing immediately. C<file> may also be | ||||||||||||||||||||||||||||||||||||||||||||
| 89 | a filehandle. | ||||||||||||||||||||||||||||||||||||||||||||
| 90 | |||||||||||||||||||||||||||||||||||||||||||||
| 91 | =item * compress | ||||||||||||||||||||||||||||||||||||||||||||
| 92 | |||||||||||||||||||||||||||||||||||||||||||||
| 93 | By default, most of the PDF will be compressed to save space. To turn this off | ||||||||||||||||||||||||||||||||||||||||||||
| 94 | (generally only useful for testing or debugging), set C<compress> to 0. | ||||||||||||||||||||||||||||||||||||||||||||
| 95 | |||||||||||||||||||||||||||||||||||||||||||||
| 96 | =back | ||||||||||||||||||||||||||||||||||||||||||||
| 97 | |||||||||||||||||||||||||||||||||||||||||||||
| 98 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 99 | |||||||||||||||||||||||||||||||||||||||||||||
| 100 | sub new { | ||||||||||||||||||||||||||||||||||||||||||||
| 101 | 164 | ▶ | my ($class, %options) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
new: called CC=11 SCAR=26.0
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 102 | |||||||||||||||||||||||||||||||||||||||||||||
| 103 | 164 | my $self = {}; | |||||||||||||||||||||||||||||||||||||||||||
| 104 | 164 | bless $self, $class; | |||||||||||||||||||||||||||||||||||||||||||
| 105 | 164 | $self->{'pdf'} = PDF::API2::Basic::PDF::File->new(); | |||||||||||||||||||||||||||||||||||||||||||
| 106 | |||||||||||||||||||||||||||||||||||||||||||||
| 107 | 164 | $self->{'pdf'}->{' version'} = '1.4'; | |||||||||||||||||||||||||||||||||||||||||||
| 108 | 164 | $self->{'pages'} = PDF::API2::Basic::PDF::Pages->new($self->{'pdf'}); | |||||||||||||||||||||||||||||||||||||||||||
| 109 | 164 | $self->{'pages'}->proc_set(qw(PDF Text ImageB ImageC ImageI)); | |||||||||||||||||||||||||||||||||||||||||||
| 110 | 164 | ▶ | $self->{'pages'}->{'Resources'} ||= PDFDict(); | ||||||||||||||||||||||||||||||||||||||||||
|
Condition33%1/3
$self->{"pages"}{"Resources"} ||= PDFDict()
MC/DC0%0/2
$self->{"pages"}{"Resources"} ||= PDFDict()
$self->{"pages"}{"Resources"}
PDFDict()
Truth table33%1/3
A ||= B
A= $self->{"pages"}{"Resources"}B= PDFDict()
| |||||||||||||||||||||||||||||||||||||||||||||
| 111 | 164 | ▶ | $self->{'pdf'}->new_obj($self->{'pages'}->{'Resources'}) unless $self->{'pages'}->{'Resources'}->is_obj($self->{'pdf'}); | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 112 | 164 | $self->{'catalog'} = $self->{'pdf'}->{'Root'}; | |||||||||||||||||||||||||||||||||||||||||||
| 113 | 164 | weaken $self->{'catalog'}; | |||||||||||||||||||||||||||||||||||||||||||
| 114 | 164 | $self->{'fonts'} = {}; | |||||||||||||||||||||||||||||||||||||||||||
| 115 | 164 | $self->{'pagestack'} = []; | |||||||||||||||||||||||||||||||||||||||||||
| 116 | |||||||||||||||||||||||||||||||||||||||||||||
| 117 | # -compress is deprecated (remove the hyphen) | ||||||||||||||||||||||||||||||||||||||||||||
| 118 | 164 | ▶ | if (exists $options{'-compress'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 119 | 27 | ▶ | $options{'compress'} //= delete $options{'-compress'}; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition33%1/3
$options{"compress"} //= delete $options{"-compress"}
MC/DC0%0/2
$options{"compress"} //= delete $options{"-compress"}
$options{"compress"}
delete $options{"-compress"}
Truth table33%1/3
A //= B
A= $options{"compress"}B= delete $options{"-compress"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 120 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 121 | |||||||||||||||||||||||||||||||||||||||||||||
| 122 | 164 | ▶ | if (exists $options{'compress'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 123 | 114 | ▶ | $self->{'forcecompress'} = $options{'compress'} ? 1 : 0; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 124 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 125 | else { | ||||||||||||||||||||||||||||||||||||||||||||
| 126 | 50 | $self->{'forcecompress'} = 1; | |||||||||||||||||||||||||||||||||||||||||||
| 127 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 128 | 164 | $self->preferences(%options); | |||||||||||||||||||||||||||||||||||||||||||
| 129 | |||||||||||||||||||||||||||||||||||||||||||||
| 130 | # -file is deprecated (remove the hyphen) | ||||||||||||||||||||||||||||||||||||||||||||
| 131 | 164 | ▶ | $options{'file'} //= $options{'-file'} if $options{'-file'}; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
Condition0%0/3
$options{"file"} //= $options{"-file"}
MC/DC0%0/2
$options{"file"} //= $options{"-file"}
$options{"file"}
$options{"-file"}
Truth table0%0/3
A //= B
A= $options{"file"}B= $options{"-file"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 132 | |||||||||||||||||||||||||||||||||||||||||||||
| 133 | 164 | ▶ | if ($options{'file'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 134 | 0 | $self->{'pdf'}->create_file($options{'file'}); | |||||||||||||||||||||||||||||||||||||||||||
| 135 | 0 | $self->{'partial_save'} = 1; | |||||||||||||||||||||||||||||||||||||||||||
| 136 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 137 | |||||||||||||||||||||||||||||||||||||||||||||
| 138 | # Deprecated; used by info and infoMetaAttributes but not their replacements | ||||||||||||||||||||||||||||||||||||||||||||
| 139 | 164 | $self->{'infoMeta'} = [qw(Author CreationDate ModDate Creator Producer Title | |||||||||||||||||||||||||||||||||||||||||||
| 140 | Subject Keywords)]; | ||||||||||||||||||||||||||||||||||||||||||||
| 141 | |||||||||||||||||||||||||||||||||||||||||||||
| 142 | 164 | ▶ | my $version = eval { $PDF::API2::VERSION } || 'Development Version'; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition50%1/2
eval {
do {
$PDF::API2::VERSION
}
} || 'Development Version'
MC/DC0%0/1
eval {
do {
$PDF::API2::VERSION
}
} || 'Development Version'
eval {
do {
$PDF::API2::VERSION
}
}
Truth table50%1/2
A
A= eval {
do {
$PDF::API2::VERSION
}
}
| |||||||||||||||||||||||||||||||||||||||||||||
| 143 | 164 | $self->producer("PDF::API2 $version ($OSNAME)"); | |||||||||||||||||||||||||||||||||||||||||||
| 144 | |||||||||||||||||||||||||||||||||||||||||||||
| 145 | 164 | return $self; | |||||||||||||||||||||||||||||||||||||||||||
| 146 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 147 | |||||||||||||||||||||||||||||||||||||||||||||
| 148 | =head2 open | ||||||||||||||||||||||||||||||||||||||||||||
| 149 | |||||||||||||||||||||||||||||||||||||||||||||
| 150 | my $pdf = PDF::API2->open('/path/to/file.pdf', %options); | ||||||||||||||||||||||||||||||||||||||||||||
| 151 | |||||||||||||||||||||||||||||||||||||||||||||
| 152 | Open an existing PDF file. | ||||||||||||||||||||||||||||||||||||||||||||
| 153 | |||||||||||||||||||||||||||||||||||||||||||||
| 154 | The following option is available: | ||||||||||||||||||||||||||||||||||||||||||||
| 155 | |||||||||||||||||||||||||||||||||||||||||||||
| 156 | =over | ||||||||||||||||||||||||||||||||||||||||||||
| 157 | |||||||||||||||||||||||||||||||||||||||||||||
| 158 | =item * compress | ||||||||||||||||||||||||||||||||||||||||||||
| 159 | |||||||||||||||||||||||||||||||||||||||||||||
| 160 | By default, most of the PDF will be compressed to save space. To turn this off | ||||||||||||||||||||||||||||||||||||||||||||
| 161 | (generally only useful for testing or debugging), set C<compress> to 0. | ||||||||||||||||||||||||||||||||||||||||||||
| 162 | |||||||||||||||||||||||||||||||||||||||||||||
| 163 | =back | ||||||||||||||||||||||||||||||||||||||||||||
| 164 | |||||||||||||||||||||||||||||||||||||||||||||
| 165 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 166 | |||||||||||||||||||||||||||||||||||||||||||||
| 167 | sub open { | ||||||||||||||||||||||||||||||||||||||||||||
| 168 | 8 | ▶ | my ($class, $file, %options) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
open: called CC=5 SCAR=16.3
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 169 | 8 | ▶ | croak "File '$file' does not exist" unless -f $file; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 170 | 8 | ▶ | croak "File '$file' is not readable" unless -r $file; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 171 | |||||||||||||||||||||||||||||||||||||||||||||
| 172 | 8 | my $self = {}; | |||||||||||||||||||||||||||||||||||||||||||
| 173 | 8 | bless $self, $class; | |||||||||||||||||||||||||||||||||||||||||||
| 174 | 8 | foreach my $parameter (keys %options) { | |||||||||||||||||||||||||||||||||||||||||||
| 175 | 2 | $self->default($parameter, $options{$parameter}); | |||||||||||||||||||||||||||||||||||||||||||
| 176 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 177 | |||||||||||||||||||||||||||||||||||||||||||||
| 178 | 8 | my $is_writable = -w $file; | |||||||||||||||||||||||||||||||||||||||||||
| 179 | 8 | $self->{'pdf'} = PDF::API2::Basic::PDF::File->open($file, $is_writable); | |||||||||||||||||||||||||||||||||||||||||||
| 180 | 8 | _open_common($self, %options); | |||||||||||||||||||||||||||||||||||||||||||
| 181 | 8 | $self->{'pdf'}->{' fname'} = $file; | |||||||||||||||||||||||||||||||||||||||||||
| 182 | 8 | ▶ | $self->{'opened_readonly'} = 1 unless $is_writable; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 183 | |||||||||||||||||||||||||||||||||||||||||||||
| 184 | 8 | return $self; | |||||||||||||||||||||||||||||||||||||||||||
| 185 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 186 | |||||||||||||||||||||||||||||||||||||||||||||
| 187 | sub _open_common { | ||||||||||||||||||||||||||||||||||||||||||||
| 188 | 16 | ▶ | my ($self, %options) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
_open_common: called CC=7 SCAR=19.6
| |||||||||||||||||||||||||||||||||||||||||||||
| 189 | |||||||||||||||||||||||||||||||||||||||||||||
| 190 | 16 | $self->{'pdf'}->{'Root'}->realise(); | |||||||||||||||||||||||||||||||||||||||||||
| 191 | 16 | ▶ | $self->{'pdf'}->{' version'} ||= '1.3'; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition50%1/2
$self->{"pdf"}{" version"} ||= "1.3"
MC/DC0%0/1
$self->{"pdf"}{" version"} ||= "1.3"
$self->{"pdf"}{" version"}
Truth table50%1/2
A
A= $self->{"pdf"}{" version"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 192 | |||||||||||||||||||||||||||||||||||||||||||||
| 193 | 16 | $self->{'pages'} = $self->{'pdf'}->{'Root'}->{'Pages'}->realise(); | |||||||||||||||||||||||||||||||||||||||||||
| 194 | 16 | weaken $self->{'pages'}; | |||||||||||||||||||||||||||||||||||||||||||
| 195 | 16 | my @pages = proc_pages($self->{'pdf'}, $self->{'pages'}); | |||||||||||||||||||||||||||||||||||||||||||
| 196 | 16 | $self->{'pagestack'} = [sort { $a->{' pnum'} <=> $b->{' pnum'} } @pages]; | |||||||||||||||||||||||||||||||||||||||||||
| 197 | 16 | weaken $self->{'pagestack'}->[$_] for (0 .. scalar @{$self->{'pagestack'}}); | |||||||||||||||||||||||||||||||||||||||||||
| 198 | |||||||||||||||||||||||||||||||||||||||||||||
| 199 | 16 | $self->{'catalog'} = $self->{'pdf'}->{'Root'}; | |||||||||||||||||||||||||||||||||||||||||||
| 200 | 16 | weaken $self->{'catalog'}; | |||||||||||||||||||||||||||||||||||||||||||
| 201 | |||||||||||||||||||||||||||||||||||||||||||||
| 202 | 16 | $self->{'opened'} = 1; | |||||||||||||||||||||||||||||||||||||||||||
| 203 | |||||||||||||||||||||||||||||||||||||||||||||
| 204 | # -compress is deprecated (remove the hyphen) | ||||||||||||||||||||||||||||||||||||||||||||
| 205 | 16 | ▶ | if (exists $options{'-compress'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 206 | 2 | ▶ | $options{'compress'} //= delete $options{'-compress'}; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition33%1/3
$options{"compress"} //= delete $options{"-compress"}
MC/DC0%0/2
$options{"compress"} //= delete $options{"-compress"}
$options{"compress"}
delete $options{"-compress"}
Truth table33%1/3
A //= B
A= $options{"compress"}B= delete $options{"-compress"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 207 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 208 | |||||||||||||||||||||||||||||||||||||||||||||
| 209 | 16 | ▶ | if (exists $options{'compress'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 210 | 2 | ▶ | $self->{'forcecompress'} = $options{'compress'} ? 1 : 0; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 211 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 212 | else { | ||||||||||||||||||||||||||||||||||||||||||||
| 213 | 14 | $self->{'forcecompress'} = 1; | |||||||||||||||||||||||||||||||||||||||||||
| 214 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 215 | 16 | $self->{'fonts'} = {}; | |||||||||||||||||||||||||||||||||||||||||||
| 216 | 16 | $self->{'infoMeta'} = [qw(Author CreationDate ModDate Creator Producer Title Subject Keywords)]; | |||||||||||||||||||||||||||||||||||||||||||
| 217 | 16 | return $self; | |||||||||||||||||||||||||||||||||||||||||||
| 218 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 219 | |||||||||||||||||||||||||||||||||||||||||||||
| 220 | =head2 save | ||||||||||||||||||||||||||||||||||||||||||||
| 221 | |||||||||||||||||||||||||||||||||||||||||||||
| 222 | $pdf->save('/path/to/file.pdf'); | ||||||||||||||||||||||||||||||||||||||||||||
| 223 | |||||||||||||||||||||||||||||||||||||||||||||
| 224 | Write the PDF to disk and close the file. A filename is optional if one was | ||||||||||||||||||||||||||||||||||||||||||||
| 225 | specified while opening or creating the PDF. | ||||||||||||||||||||||||||||||||||||||||||||
| 226 | |||||||||||||||||||||||||||||||||||||||||||||
| 227 | As a side effect, the document structure is removed from memory when the file is | ||||||||||||||||||||||||||||||||||||||||||||
| 228 | saved, so it will no longer be usable. | ||||||||||||||||||||||||||||||||||||||||||||
| 229 | |||||||||||||||||||||||||||||||||||||||||||||
| 230 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 231 | |||||||||||||||||||||||||||||||||||||||||||||
| 232 | # Deprecated (renamed) | ||||||||||||||||||||||||||||||||||||||||||||
| 233 | 0 | ▶ | sub saveas { return save(@_) } ## no critic | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
saveas: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 234 | |||||||||||||||||||||||||||||||||||||||||||||
| 235 | sub save { | ||||||||||||||||||||||||||||||||||||||||||||
| 236 | 1 | ▶ | my ($self, $file) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
save: called CC=10 SCAR=35.1
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 237 | |||||||||||||||||||||||||||||||||||||||||||||
| 238 | 1 | ▶ | if ($self->{'partial_save'} and not $file) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 2 branches
Condition33%1/3
$self->{"partial_save"} and not $file
MC/DC0%0/2
$self->{"partial_save"} and not $file
$self->{"partial_save"}
not $file
Truth table33%1/3
A and not(B)
A= $self->{"partial_save"}B= not $file
| |||||||||||||||||||||||||||||||||||||||||||||
| 239 | 0 | $self->{'pdf'}->close_file(); | |||||||||||||||||||||||||||||||||||||||||||
| 240 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 241 | elsif ($self->{'opened_scalar'}) { | ||||||||||||||||||||||||||||||||||||||||||||
| 242 | 0 | ▶ | croak 'A filename argument is required' unless $file; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 243 | 0 | $self->{'pdf'}->append_file(); | |||||||||||||||||||||||||||||||||||||||||||
| 244 | 0 | my $fh; | |||||||||||||||||||||||||||||||||||||||||||
| 245 | 0 | ▶ | CORE::open($fh, '>', $file) or die "Unable to open $file for writing: $!"; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 246 | 0 | binmode($fh, ':raw'); | |||||||||||||||||||||||||||||||||||||||||||
| 247 | 0 | print $fh ${$self->{'content_ref'}}; | |||||||||||||||||||||||||||||||||||||||||||
| 248 | 0 | CORE::close($fh); | |||||||||||||||||||||||||||||||||||||||||||
| 249 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 250 | else { | ||||||||||||||||||||||||||||||||||||||||||||
| 251 | 1 | ▶ | croak 'A filename argument is required' unless $file; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 252 | 1 | ▶ | unless ($self->{'pdf'}->{' fname'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 2 branches
| |||||||||||||||||||||||||||||||||||||||||||||
| 253 | 0 | $self->{'pdf'}->out_file($file); | |||||||||||||||||||||||||||||||||||||||||||
| 254 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 255 | elsif ($self->{'pdf'}->{' fname'} eq $file) { | ||||||||||||||||||||||||||||||||||||||||||||
| 256 | 1 | ▶ | croak "File is read-only" if $self->{'opened_readonly'}; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 257 | 1 | $self->{'pdf'}->close_file(); | |||||||||||||||||||||||||||||||||||||||||||
| 258 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 259 | else { | ||||||||||||||||||||||||||||||||||||||||||||
| 260 | 0 | $self->{'pdf'}->clone_file($file); | |||||||||||||||||||||||||||||||||||||||||||
| 261 | 0 | $self->{'pdf'}->close_file(); | |||||||||||||||||||||||||||||||||||||||||||
| 262 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 263 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 264 | |||||||||||||||||||||||||||||||||||||||||||||
| 265 | # This can be eliminated once we're confident that circular references are | ||||||||||||||||||||||||||||||||||||||||||||
| 266 | # no longer an issue. See t/circular-references.t. | ||||||||||||||||||||||||||||||||||||||||||||
| 267 | 1 | $self->close(); | |||||||||||||||||||||||||||||||||||||||||||
| 268 | |||||||||||||||||||||||||||||||||||||||||||||
| 269 | 1 | return; | |||||||||||||||||||||||||||||||||||||||||||
| 270 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 271 | |||||||||||||||||||||||||||||||||||||||||||||
| 272 | # Deprecated (use save instead) | ||||||||||||||||||||||||||||||||||||||||||||
| 273 | # | ||||||||||||||||||||||||||||||||||||||||||||
| 274 | # This method allows for objects to be written to disk in advance of finally | ||||||||||||||||||||||||||||||||||||||||||||
| 275 | # saving and closing the file. Otherwise, it's no different than just calling | ||||||||||||||||||||||||||||||||||||||||||||
| 276 | # save when all changes have been made. There's no memory advantage since | ||||||||||||||||||||||||||||||||||||||||||||
| 277 | # ship_out doesn't remove objects from memory. | ||||||||||||||||||||||||||||||||||||||||||||
| 278 | sub finishobjects { | ||||||||||||||||||||||||||||||||||||||||||||
| 279 | 0 | ▶ | my ($self, @objs) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
finishobjects: not called CC=2 SCAR=17.9
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 280 | |||||||||||||||||||||||||||||||||||||||||||||
| 281 | 0 | ▶ | if ($self->{'partial_save'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 282 | 0 | $self->{'pdf'}->ship_out(@objs); | |||||||||||||||||||||||||||||||||||||||||||
| 283 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 284 | |||||||||||||||||||||||||||||||||||||||||||||
| 285 | 0 | return; | |||||||||||||||||||||||||||||||||||||||||||
| 286 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 287 | |||||||||||||||||||||||||||||||||||||||||||||
| 288 | # Deprecated (use save instead) | ||||||||||||||||||||||||||||||||||||||||||||
| 289 | sub update { | ||||||||||||||||||||||||||||||||||||||||||||
| 290 | 0 | ▶ | my $self = shift(); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
update: not called CC=2 SCAR=17.9
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 291 | 0 | ▶ | croak "File is read-only" if $self->{'opened_readonly'}; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 292 | 0 | $self->{'pdf'}->close_file(); | |||||||||||||||||||||||||||||||||||||||||||
| 293 | 0 | return; | |||||||||||||||||||||||||||||||||||||||||||
| 294 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 295 | |||||||||||||||||||||||||||||||||||||||||||||
| 296 | =head2 close | ||||||||||||||||||||||||||||||||||||||||||||
| 297 | |||||||||||||||||||||||||||||||||||||||||||||
| 298 | $pdf->close(); | ||||||||||||||||||||||||||||||||||||||||||||
| 299 | |||||||||||||||||||||||||||||||||||||||||||||
| 300 | Close an open file (if relevant) and remove the object structure from memory. | ||||||||||||||||||||||||||||||||||||||||||||
| 301 | |||||||||||||||||||||||||||||||||||||||||||||
| 302 | PDF::API2 contains circular references, so this call is necessary in | ||||||||||||||||||||||||||||||||||||||||||||
| 303 | long-running processes to keep from running out of memory. | ||||||||||||||||||||||||||||||||||||||||||||
| 304 | |||||||||||||||||||||||||||||||||||||||||||||
| 305 | This will be called automatically when you save or stringify a PDF. | ||||||||||||||||||||||||||||||||||||||||||||
| 306 | You should only need to call it explicitly if you are reading PDF | ||||||||||||||||||||||||||||||||||||||||||||
| 307 | files and not writing them. | ||||||||||||||||||||||||||||||||||||||||||||
| 308 | |||||||||||||||||||||||||||||||||||||||||||||
| 309 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 310 | |||||||||||||||||||||||||||||||||||||||||||||
| 311 | # Deprecated (renamed) | ||||||||||||||||||||||||||||||||||||||||||||
| 312 | 165 | ▶ | sub release { return $_[0]->close() } | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
release: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 313 | 0 | ▶ | sub end { return $_[0]->close() } | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
end: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 314 | |||||||||||||||||||||||||||||||||||||||||||||
| 315 | sub close { | ||||||||||||||||||||||||||||||||||||||||||||
| 316 | 313 | ▶ | my $self = shift(); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
close: called CC=3 SCAR=11.0
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 317 | 313 | ▶ | $self->{'pdf'}->release() if defined $self->{'pdf'}; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 318 | |||||||||||||||||||||||||||||||||||||||||||||
| 319 | 313 | foreach my $key (keys %$self) { | |||||||||||||||||||||||||||||||||||||||||||
| 320 | 1054 | $self->{$key} = undef; | |||||||||||||||||||||||||||||||||||||||||||
| 321 | 1054 | delete $self->{$key}; | |||||||||||||||||||||||||||||||||||||||||||
| 322 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 323 | |||||||||||||||||||||||||||||||||||||||||||||
| 324 | 313 | return; | |||||||||||||||||||||||||||||||||||||||||||
| 325 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 326 | |||||||||||||||||||||||||||||||||||||||||||||
| 327 | =head2 from_string | ||||||||||||||||||||||||||||||||||||||||||||
| 328 | |||||||||||||||||||||||||||||||||||||||||||||
| 329 | my $pdf = PDF::API2->from_string($pdf_string, %options); | ||||||||||||||||||||||||||||||||||||||||||||
| 330 | |||||||||||||||||||||||||||||||||||||||||||||
| 331 | Read a PDF document contained in a string. | ||||||||||||||||||||||||||||||||||||||||||||
| 332 | |||||||||||||||||||||||||||||||||||||||||||||
| 333 | The following option is available: | ||||||||||||||||||||||||||||||||||||||||||||
| 334 | |||||||||||||||||||||||||||||||||||||||||||||
| 335 | =over | ||||||||||||||||||||||||||||||||||||||||||||
| 336 | |||||||||||||||||||||||||||||||||||||||||||||
| 337 | =item * compress | ||||||||||||||||||||||||||||||||||||||||||||
| 338 | |||||||||||||||||||||||||||||||||||||||||||||
| 339 | By default, most of the PDF will be compressed to save space. To turn this off | ||||||||||||||||||||||||||||||||||||||||||||
| 340 | (generally only useful for testing or debugging), set C<compress> to 0. | ||||||||||||||||||||||||||||||||||||||||||||
| 341 | |||||||||||||||||||||||||||||||||||||||||||||
| 342 | =back | ||||||||||||||||||||||||||||||||||||||||||||
| 343 | |||||||||||||||||||||||||||||||||||||||||||||
| 344 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 345 | |||||||||||||||||||||||||||||||||||||||||||||
| 346 | # Deprecated (renamed) | ||||||||||||||||||||||||||||||||||||||||||||
| 347 | 1 | ▶ | sub openScalar { return from_string(@_); } ## no critic | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
openScalar: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 348 | 0 | ▶ | sub open_scalar { return from_string(@_); } ## no critic | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
open_scalar: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 349 | |||||||||||||||||||||||||||||||||||||||||||||
| 350 | sub from_string { | ||||||||||||||||||||||||||||||||||||||||||||
| 351 | 8 | ▶ | my ($class, $content, %options) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
from_string: called CC=3 SCAR=11.1
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 352 | |||||||||||||||||||||||||||||||||||||||||||||
| 353 | 8 | my $self = {}; | |||||||||||||||||||||||||||||||||||||||||||
| 354 | 8 | bless $self, $class; | |||||||||||||||||||||||||||||||||||||||||||
| 355 | 8 | foreach my $parameter (keys %options) { | |||||||||||||||||||||||||||||||||||||||||||
| 356 | 0 | $self->default($parameter, $options{$parameter}); | |||||||||||||||||||||||||||||||||||||||||||
| 357 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 358 | |||||||||||||||||||||||||||||||||||||||||||||
| 359 | 8 | $self->{'content_ref'} = \$content; | |||||||||||||||||||||||||||||||||||||||||||
| 360 | 8 | my $fh; | |||||||||||||||||||||||||||||||||||||||||||
| 361 | 8 | ▶ | CORE::open($fh, '+<', \$content) or die "Can't begin scalar IO"; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 362 | |||||||||||||||||||||||||||||||||||||||||||||
| 363 | 8 | $self->{'pdf'} = PDF::API2::Basic::PDF::File->open($fh, 1); | |||||||||||||||||||||||||||||||||||||||||||
| 364 | 8 | _open_common($self, %options); | |||||||||||||||||||||||||||||||||||||||||||
| 365 | 8 | $self->{'opened_scalar'} = 1; | |||||||||||||||||||||||||||||||||||||||||||
| 366 | |||||||||||||||||||||||||||||||||||||||||||||
| 367 | 8 | return $self; | |||||||||||||||||||||||||||||||||||||||||||
| 368 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 369 | |||||||||||||||||||||||||||||||||||||||||||||
| 370 | =head2 to_string | ||||||||||||||||||||||||||||||||||||||||||||
| 371 | |||||||||||||||||||||||||||||||||||||||||||||
| 372 | my $string = $pdf->to_string(); | ||||||||||||||||||||||||||||||||||||||||||||
| 373 | |||||||||||||||||||||||||||||||||||||||||||||
| 374 | Return the PDF document as a string. | ||||||||||||||||||||||||||||||||||||||||||||
| 375 | |||||||||||||||||||||||||||||||||||||||||||||
| 376 | As a side effect, the document structure is removed from memory when the string | ||||||||||||||||||||||||||||||||||||||||||||
| 377 | is created, so it will no longer be usable. | ||||||||||||||||||||||||||||||||||||||||||||
| 378 | |||||||||||||||||||||||||||||||||||||||||||||
| 379 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 380 | |||||||||||||||||||||||||||||||||||||||||||||
| 381 | # Maintainer's note: The object is being destroyed because it contains | ||||||||||||||||||||||||||||||||||||||||||||
| 382 | # (contained?) circular references that would otherwise result in memory not | ||||||||||||||||||||||||||||||||||||||||||||
| 383 | # being freed if the object merely goes out of scope. If possible, the circular | ||||||||||||||||||||||||||||||||||||||||||||
| 384 | # references should be eliminated so that to_string doesn't need to be | ||||||||||||||||||||||||||||||||||||||||||||
| 385 | # destructive. See t/circular-references.t. | ||||||||||||||||||||||||||||||||||||||||||||
| 386 | # | ||||||||||||||||||||||||||||||||||||||||||||
| 387 | # I've opted not to just require a separate call to close() because it would | ||||||||||||||||||||||||||||||||||||||||||||
| 388 | # likely introduce memory leaks in many existing programs that use this module. | ||||||||||||||||||||||||||||||||||||||||||||
| 389 | |||||||||||||||||||||||||||||||||||||||||||||
| 390 | # Deprecated (renamed) | ||||||||||||||||||||||||||||||||||||||||||||
| 391 | 0 | ▶ | sub stringify { return to_string(@_) } ## no critic | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
stringify: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 392 | |||||||||||||||||||||||||||||||||||||||||||||
| 393 | sub to_string { | ||||||||||||||||||||||||||||||||||||||||||||
| 394 | 147 | ▶ | my $self = shift(); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
to_string: called CC=5 SCAR=16.1
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 395 | |||||||||||||||||||||||||||||||||||||||||||||
| 396 | 147 | my $string = ''; | |||||||||||||||||||||||||||||||||||||||||||
| 397 | 147 | ▶ | if ($self->{'opened_scalar'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 2 branches
| |||||||||||||||||||||||||||||||||||||||||||||
| 398 | 3 | $self->{'pdf'}->append_file(); | |||||||||||||||||||||||||||||||||||||||||||
| 399 | 3 | $string = ${$self->{'content_ref'}}; | |||||||||||||||||||||||||||||||||||||||||||
| 400 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 401 | elsif ($self->{'opened'}) { | ||||||||||||||||||||||||||||||||||||||||||||
| 402 | 4 | my $fh = FileHandle->new(); | |||||||||||||||||||||||||||||||||||||||||||
| 403 | 4 | ▶ | CORE::open($fh, '>', \$string) || die "Can't begin scalar IO"; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 404 | 4 | $self->{'pdf'}->clone_file($fh); | |||||||||||||||||||||||||||||||||||||||||||
| 405 | 4 | $self->{'pdf'}->close_file(); | |||||||||||||||||||||||||||||||||||||||||||
| 406 | 4 | $fh->close(); | |||||||||||||||||||||||||||||||||||||||||||
| 407 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 408 | else { | ||||||||||||||||||||||||||||||||||||||||||||
| 409 | 140 | my $fh = FileHandle->new(); | |||||||||||||||||||||||||||||||||||||||||||
| 410 | 140 | ▶ | CORE::open($fh, '>', \$string) || die "Can't begin scalar IO"; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 411 | 140 | $self->{'pdf'}->out_file($fh); | |||||||||||||||||||||||||||||||||||||||||||
| 412 | 140 | $fh->close(); | |||||||||||||||||||||||||||||||||||||||||||
| 413 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 414 | |||||||||||||||||||||||||||||||||||||||||||||
| 415 | # This can be eliminated once we're confident that circular references are | ||||||||||||||||||||||||||||||||||||||||||||
| 416 | # no longer an issue. See t/circular-references.t. | ||||||||||||||||||||||||||||||||||||||||||||
| 417 | 147 | $self->close(); | |||||||||||||||||||||||||||||||||||||||||||
| 418 | |||||||||||||||||||||||||||||||||||||||||||||
| 419 | 147 | return $string; | |||||||||||||||||||||||||||||||||||||||||||
| 420 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 421 | |||||||||||||||||||||||||||||||||||||||||||||
| 422 | =head1 METADATA METHODS | ||||||||||||||||||||||||||||||||||||||||||||
| 423 | |||||||||||||||||||||||||||||||||||||||||||||
| 424 | =head2 title | ||||||||||||||||||||||||||||||||||||||||||||
| 425 | |||||||||||||||||||||||||||||||||||||||||||||
| 426 | $title = $pdf->title(); | ||||||||||||||||||||||||||||||||||||||||||||
| 427 | $pdf = $pdf->title($title); | ||||||||||||||||||||||||||||||||||||||||||||
| 428 | |||||||||||||||||||||||||||||||||||||||||||||
| 429 | Get/set/clear the document's title. | ||||||||||||||||||||||||||||||||||||||||||||
| 430 | |||||||||||||||||||||||||||||||||||||||||||||
| 431 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 432 | |||||||||||||||||||||||||||||||||||||||||||||
| 433 | sub title { | ||||||||||||||||||||||||||||||||||||||||||||
| 434 | 0 | ▶ | my $self = shift(); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
title: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 435 | 0 | return $self->info_metadata('Title', @_); | |||||||||||||||||||||||||||||||||||||||||||
| 436 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 437 | |||||||||||||||||||||||||||||||||||||||||||||
| 438 | =head2 author | ||||||||||||||||||||||||||||||||||||||||||||
| 439 | |||||||||||||||||||||||||||||||||||||||||||||
| 440 | $author = $pdf->author(); | ||||||||||||||||||||||||||||||||||||||||||||
| 441 | $pdf = $pdf->author($author); | ||||||||||||||||||||||||||||||||||||||||||||
| 442 | |||||||||||||||||||||||||||||||||||||||||||||
| 443 | Get/set/clear the name of the person who created the document. | ||||||||||||||||||||||||||||||||||||||||||||
| 444 | |||||||||||||||||||||||||||||||||||||||||||||
| 445 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 446 | |||||||||||||||||||||||||||||||||||||||||||||
| 447 | sub author { | ||||||||||||||||||||||||||||||||||||||||||||
| 448 | 0 | ▶ | my $self = shift(); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
author: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 449 | 0 | return $self->info_metadata('Author', @_); | |||||||||||||||||||||||||||||||||||||||||||
| 450 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 451 | |||||||||||||||||||||||||||||||||||||||||||||
| 452 | =head2 subject | ||||||||||||||||||||||||||||||||||||||||||||
| 453 | |||||||||||||||||||||||||||||||||||||||||||||
| 454 | $subject = $pdf->subject(); | ||||||||||||||||||||||||||||||||||||||||||||
| 455 | $pdf = $pdf->subject($subject); | ||||||||||||||||||||||||||||||||||||||||||||
| 456 | |||||||||||||||||||||||||||||||||||||||||||||
| 457 | Get/set/clear the subject of the document. | ||||||||||||||||||||||||||||||||||||||||||||
| 458 | |||||||||||||||||||||||||||||||||||||||||||||
| 459 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 460 | |||||||||||||||||||||||||||||||||||||||||||||
| 461 | sub subject { | ||||||||||||||||||||||||||||||||||||||||||||
| 462 | 0 | ▶ | my $self = shift(); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
subject: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 463 | 0 | return $self->info_metadata('Subject', @_); | |||||||||||||||||||||||||||||||||||||||||||
| 464 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 465 | |||||||||||||||||||||||||||||||||||||||||||||
| 466 | =head2 keywords | ||||||||||||||||||||||||||||||||||||||||||||
| 467 | |||||||||||||||||||||||||||||||||||||||||||||
| 468 | $keywords = $pdf->keywords(); | ||||||||||||||||||||||||||||||||||||||||||||
| 469 | $pdf = $pdf->keywords($keywords); | ||||||||||||||||||||||||||||||||||||||||||||
| 470 | |||||||||||||||||||||||||||||||||||||||||||||
| 471 | Get/set/clear a space-separated string of keywords associated with the document. | ||||||||||||||||||||||||||||||||||||||||||||
| 472 | |||||||||||||||||||||||||||||||||||||||||||||
| 473 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 474 | |||||||||||||||||||||||||||||||||||||||||||||
| 475 | sub keywords { | ||||||||||||||||||||||||||||||||||||||||||||
| 476 | 0 | ▶ | my $self = shift(); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
keywords: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 477 | 0 | return $self->info_metadata('Keywords', @_); | |||||||||||||||||||||||||||||||||||||||||||
| 478 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 479 | |||||||||||||||||||||||||||||||||||||||||||||
| 480 | =head2 creator | ||||||||||||||||||||||||||||||||||||||||||||
| 481 | |||||||||||||||||||||||||||||||||||||||||||||
| 482 | $creator = $pdf->creator(); | ||||||||||||||||||||||||||||||||||||||||||||
| 483 | $pdf = $pdf->creator($creator); | ||||||||||||||||||||||||||||||||||||||||||||
| 484 | |||||||||||||||||||||||||||||||||||||||||||||
| 485 | Get/set/clear the name of the product that created the document prior to its | ||||||||||||||||||||||||||||||||||||||||||||
| 486 | conversion to PDF. | ||||||||||||||||||||||||||||||||||||||||||||
| 487 | |||||||||||||||||||||||||||||||||||||||||||||
| 488 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 489 | |||||||||||||||||||||||||||||||||||||||||||||
| 490 | sub creator { | ||||||||||||||||||||||||||||||||||||||||||||
| 491 | 0 | ▶ | my $self = shift(); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
creator: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 492 | 0 | return $self->info_metadata('Creator', @_); | |||||||||||||||||||||||||||||||||||||||||||
| 493 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 494 | |||||||||||||||||||||||||||||||||||||||||||||
| 495 | =head2 producer | ||||||||||||||||||||||||||||||||||||||||||||
| 496 | |||||||||||||||||||||||||||||||||||||||||||||
| 497 | $producer = $pdf->producer(); | ||||||||||||||||||||||||||||||||||||||||||||
| 498 | $pdf = $pdf->producer($producer); | ||||||||||||||||||||||||||||||||||||||||||||
| 499 | |||||||||||||||||||||||||||||||||||||||||||||
| 500 | Get/set/clear the name of the product that converted the original document to | ||||||||||||||||||||||||||||||||||||||||||||
| 501 | PDF. | ||||||||||||||||||||||||||||||||||||||||||||
| 502 | |||||||||||||||||||||||||||||||||||||||||||||
| 503 | PDF::API2 fills in this field when creating a PDF. | ||||||||||||||||||||||||||||||||||||||||||||
| 504 | |||||||||||||||||||||||||||||||||||||||||||||
| 505 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 506 | |||||||||||||||||||||||||||||||||||||||||||||
| 507 | sub producer { | ||||||||||||||||||||||||||||||||||||||||||||
| 508 | 169 | ▶ | my $self = shift(); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
producer: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 509 | 169 | return $self->info_metadata('Producer', @_); | |||||||||||||||||||||||||||||||||||||||||||
| 510 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 511 | |||||||||||||||||||||||||||||||||||||||||||||
| 512 | =head2 created | ||||||||||||||||||||||||||||||||||||||||||||
| 513 | |||||||||||||||||||||||||||||||||||||||||||||
| 514 | $date = $pdf->created(); | ||||||||||||||||||||||||||||||||||||||||||||
| 515 | $pdf = $pdf->created($date); | ||||||||||||||||||||||||||||||||||||||||||||
| 516 | |||||||||||||||||||||||||||||||||||||||||||||
| 517 | Get/set/clear the document's creation date. | ||||||||||||||||||||||||||||||||||||||||||||
| 518 | |||||||||||||||||||||||||||||||||||||||||||||
| 519 | The date format is C<D:YYYYMMDDHHmmSSOHH'mm>, where C<D:> is a static prefix | ||||||||||||||||||||||||||||||||||||||||||||
| 520 | identifying the string as a PDF date. The date may be truncated at any point | ||||||||||||||||||||||||||||||||||||||||||||
| 521 | after the year. C<O> is one of C<+>, C<->, or C<Z>, with the following C<HH'mm> | ||||||||||||||||||||||||||||||||||||||||||||
| 522 | representing an offset from UTC. | ||||||||||||||||||||||||||||||||||||||||||||
| 523 | |||||||||||||||||||||||||||||||||||||||||||||
| 524 | When setting the date, C<D:> will be prepended automatically if omitted. | ||||||||||||||||||||||||||||||||||||||||||||
| 525 | |||||||||||||||||||||||||||||||||||||||||||||
| 526 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 527 | |||||||||||||||||||||||||||||||||||||||||||||
| 528 | sub created { | ||||||||||||||||||||||||||||||||||||||||||||
| 529 | 1 | ▶ | my $self = shift(); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
created: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 530 | 1 | return $self->info_metadata('CreationDate', @_); | |||||||||||||||||||||||||||||||||||||||||||
| 531 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 532 | |||||||||||||||||||||||||||||||||||||||||||||
| 533 | =head2 modified | ||||||||||||||||||||||||||||||||||||||||||||
| 534 | |||||||||||||||||||||||||||||||||||||||||||||
| 535 | $date = $pdf->modified(); | ||||||||||||||||||||||||||||||||||||||||||||
| 536 | $pdf = $pdf->modified($date); | ||||||||||||||||||||||||||||||||||||||||||||
| 537 | |||||||||||||||||||||||||||||||||||||||||||||
| 538 | Get/set/clear the document's modification date. The date format is as described | ||||||||||||||||||||||||||||||||||||||||||||
| 539 | in C<created> above. | ||||||||||||||||||||||||||||||||||||||||||||
| 540 | |||||||||||||||||||||||||||||||||||||||||||||
| 541 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 542 | |||||||||||||||||||||||||||||||||||||||||||||
| 543 | sub modified { | ||||||||||||||||||||||||||||||||||||||||||||
| 544 | 0 | ▶ | my $self = shift(); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
modified: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 545 | 0 | return $self->info_metadata('ModDate', @_); | |||||||||||||||||||||||||||||||||||||||||||
| 546 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 547 | |||||||||||||||||||||||||||||||||||||||||||||
| 548 | sub _is_date { | ||||||||||||||||||||||||||||||||||||||||||||
| 549 | 1 | ▶ | my $value = shift(); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
_is_date: called CC=21 SCAR=40.2
| |||||||||||||||||||||||||||||||||||||||||||||
| 550 | |||||||||||||||||||||||||||||||||||||||||||||
| 551 | # PDF 1.7 section 7.9.4 describes the required date format. Other than the | ||||||||||||||||||||||||||||||||||||||||||||
| 552 | # D: prefix and the year, all components are optional but must be present if | ||||||||||||||||||||||||||||||||||||||||||||
| 553 | # a later component is present. No provision is made in the specification | ||||||||||||||||||||||||||||||||||||||||||||
| 554 | # for leap seconds, etc. | ||||||||||||||||||||||||||||||||||||||||||||
| 555 | 1 | ▶ | return unless $value =~ /^D:([0-9]{4}) # D:YYYY (required) | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 556 | (?:([01][0-9]) # Month (01-12) | ||||||||||||||||||||||||||||||||||||||||||||
| 557 | (?:([0123][0-9]) # Day (01-31) | ||||||||||||||||||||||||||||||||||||||||||||
| 558 | (?:([012][0-9]) # Hour (00-23) | ||||||||||||||||||||||||||||||||||||||||||||
| 559 | (?:([012345][0-9]) # Minute (00-59) | ||||||||||||||||||||||||||||||||||||||||||||
| 560 | (?:([012345][0-9]) # Second (00-59) | ||||||||||||||||||||||||||||||||||||||||||||
| 561 | (?:([Z+-]) # UT Offset Direction | ||||||||||||||||||||||||||||||||||||||||||||
| 562 | (?:([012][0-9]) # UT Offset Hours | ||||||||||||||||||||||||||||||||||||||||||||
| 563 | (?:\'([012345][0-9]) # UT Offset Minutes | ||||||||||||||||||||||||||||||||||||||||||||
| 564 | )?)?)?)?)?)?)?)?$/x; | ||||||||||||||||||||||||||||||||||||||||||||
| 565 | 1 | my ($year, $month, $day, $hour, $minute, $second, $od, $oh, $om) | |||||||||||||||||||||||||||||||||||||||||||
| 566 | = ($1, $2, $3, $4, $5, $6, $7, $8, $9); | ||||||||||||||||||||||||||||||||||||||||||||
| 567 | |||||||||||||||||||||||||||||||||||||||||||||
| 568 | # Do some basic validation to catch accidental date formatting issues. | ||||||||||||||||||||||||||||||||||||||||||||
| 569 | # Complete date validation is out of scope. | ||||||||||||||||||||||||||||||||||||||||||||
| 570 | 1 | ▶ | if (defined $month) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 571 | 1 | ▶ | return unless $month >= 1 and $month <= 12; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
Condition33%1/3
$month >= 1 and $month <= 12
MC/DC0%0/2
$month >= 1 and $month <= 12
$month >= 1
$month <= 12
Truth table33%1/3
A and B
A= $month >= 1B= $month <= 12
| |||||||||||||||||||||||||||||||||||||||||||||
| 572 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 573 | 1 | ▶ | if (defined $day) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 574 | 1 | ▶ | return unless $day >= 1 and $day <= 31; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
Condition33%1/3
$day >= 1 and $day <= 31
MC/DC0%0/2
$day >= 1 and $day <= 31
$day >= 1
$day <= 31
Truth table33%1/3
A and B
A= $day >= 1B= $day <= 31
| |||||||||||||||||||||||||||||||||||||||||||||
| 575 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 576 | 1 | ▶ | if (defined $hour) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 577 | 1 | ▶ | return unless $hour <= 23; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 578 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 579 | 1 | ▶ | if (defined $minute) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 580 | 1 | ▶ | return unless $minute <= 59; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 581 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 582 | 1 | ▶ | if (defined $second) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 583 | 1 | ▶ | return unless $second <= 59; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 584 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 585 | 1 | ▶ | if (defined $od) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 586 | 1 | ▶ | return if $od eq 'Z' and defined($oh); | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
Condition33%1/3
$od eq "Z" and defined $oh
MC/DC0%0/2
$od eq "Z" and defined $oh
$od eq "Z"
defined $oh
Truth table33%1/3
A and B
A= $od eq "Z"B= defined $oh
| |||||||||||||||||||||||||||||||||||||||||||||
| 587 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 588 | 1 | ▶ | if (defined $oh) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 589 | 0 | ▶ | return unless $oh <= 23; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 590 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 591 | 1 | ▶ | if (defined $om) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 592 | 0 | ▶ | return unless $om <= 59; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 593 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 594 | |||||||||||||||||||||||||||||||||||||||||||||
| 595 | 1 | return 1; | |||||||||||||||||||||||||||||||||||||||||||
| 596 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 597 | |||||||||||||||||||||||||||||||||||||||||||||
| 598 | =head2 info_metadata | ||||||||||||||||||||||||||||||||||||||||||||
| 599 | |||||||||||||||||||||||||||||||||||||||||||||
| 600 | # Get all keys and values | ||||||||||||||||||||||||||||||||||||||||||||
| 601 | %info = $pdf->info_metadata(); | ||||||||||||||||||||||||||||||||||||||||||||
| 602 | |||||||||||||||||||||||||||||||||||||||||||||
| 603 | # Get the value of one key | ||||||||||||||||||||||||||||||||||||||||||||
| 604 | $value = $pdf->info_metadata($key); | ||||||||||||||||||||||||||||||||||||||||||||
| 605 | |||||||||||||||||||||||||||||||||||||||||||||
| 606 | # Set the value of one key | ||||||||||||||||||||||||||||||||||||||||||||
| 607 | $pdf = $pdf->info_metadata($key, $value); | ||||||||||||||||||||||||||||||||||||||||||||
| 608 | |||||||||||||||||||||||||||||||||||||||||||||
| 609 | Get/set/clear a key in the document's information dictionary. The standard keys | ||||||||||||||||||||||||||||||||||||||||||||
| 610 | (title, author, etc.) have their own accessors, so this is primarily intended | ||||||||||||||||||||||||||||||||||||||||||||
| 611 | for interacting with custom metadata. | ||||||||||||||||||||||||||||||||||||||||||||
| 612 | |||||||||||||||||||||||||||||||||||||||||||||
| 613 | Pass C<undef> as the value in order to remove the key from the dictionary. | ||||||||||||||||||||||||||||||||||||||||||||
| 614 | |||||||||||||||||||||||||||||||||||||||||||||
| 615 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 616 | |||||||||||||||||||||||||||||||||||||||||||||
| 617 | sub info_metadata { | ||||||||||||||||||||||||||||||||||||||||||||
| 618 | 170 | ▶ | my $self = shift(); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
info_metadata: called CC=19 SCAR=35.5
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 619 | 170 | my $field = shift(); | |||||||||||||||||||||||||||||||||||||||||||
| 620 | |||||||||||||||||||||||||||||||||||||||||||||
| 621 | # Return a hash of the Info table if called without arguments | ||||||||||||||||||||||||||||||||||||||||||||
| 622 | 170 | ▶ | unless (defined $field) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 623 | 0 | ▶ | return unless exists $self->{'pdf'}->{'Info'}; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 624 | 0 | $self->{'pdf'}->{'Info'}->realise(); | |||||||||||||||||||||||||||||||||||||||||||
| 625 | 0 | my %info; | |||||||||||||||||||||||||||||||||||||||||||
| 626 | 0 | foreach my $key (keys %{$self->{'pdf'}->{'Info'}}) { | |||||||||||||||||||||||||||||||||||||||||||
| 627 | 0 | ▶ | next if $key =~ /^ /; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 628 | 0 | ▶ | next unless defined $self->{'pdf'}->{'Info'}->{$key}; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 629 | 0 | $info{$key} = $self->{'pdf'}->{'Info'}->{$key}->val(); | |||||||||||||||||||||||||||||||||||||||||||
| 630 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 631 | 0 | return %info; | |||||||||||||||||||||||||||||||||||||||||||
| 632 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 633 | |||||||||||||||||||||||||||||||||||||||||||||
| 634 | # Set | ||||||||||||||||||||||||||||||||||||||||||||
| 635 | 170 | ▶ | if (@_) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 636 | 167 | my $value = shift(); | |||||||||||||||||||||||||||||||||||||||||||
| 637 | 167 | ▶ | $value = undef if defined($value) and not length($value); | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
Condition66%2/3
defined $value and not length $value
MC/DC0%0/2
defined $value and not length $value
defined $value
not length $value
Truth table66%2/3
A and not(B)
A= defined $valueB= not length $value
| |||||||||||||||||||||||||||||||||||||||||||||
| 638 | |||||||||||||||||||||||||||||||||||||||||||||
| 639 | 167 | ▶ | if ($field eq 'CreationDate' or $field eq 'ModDate') { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
Condition66%2/3
$field eq "CreationDate" or $field eq "ModDate"
MC/DC50%1/2
$field eq "CreationDate" or $field eq "ModDate"
$field eq "CreationDate"
$field eq "ModDate"
Truth table66%2/3
A or B
A= $field eq "CreationDate"B= $field eq "ModDate"
| |||||||||||||||||||||||||||||||||||||||||||||
| 640 | 1 | ▶ | if (defined ($value)) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 641 | 1 | ▶ | $value = 'D:' . $value unless $value =~ /^D:/; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 642 | 1 | ▶ | croak "Invalid date string: $value" unless _is_date($value); | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 643 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 644 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 645 | |||||||||||||||||||||||||||||||||||||||||||||
| 646 | 167 | ▶ | unless (exists $self->{'pdf'}->{'Info'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 647 | 164 | ▶ | return $self unless defined $value; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 648 | 164 | $self->{'pdf'}->{'Info'} = PDFDict(); | |||||||||||||||||||||||||||||||||||||||||||
| 649 | 164 | $self->{'pdf'}->new_obj($self->{'pdf'}->{'Info'}); | |||||||||||||||||||||||||||||||||||||||||||
| 650 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 651 | else { | ||||||||||||||||||||||||||||||||||||||||||||
| 652 | 3 | $self->{'pdf'}->{'Info'}->realise(); | |||||||||||||||||||||||||||||||||||||||||||
| 653 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 654 | |||||||||||||||||||||||||||||||||||||||||||||
| 655 | 167 | ▶ | if (defined $value) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 656 | 166 | $self->{'pdf'}->{'Info'}->{$field} = PDFStr($value); | |||||||||||||||||||||||||||||||||||||||||||
| 657 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 658 | else { | ||||||||||||||||||||||||||||||||||||||||||||
| 659 | 1 | delete $self->{'pdf'}->{'Info'}->{$field}; | |||||||||||||||||||||||||||||||||||||||||||
| 660 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 661 | |||||||||||||||||||||||||||||||||||||||||||||
| 662 | 167 | return $self; | |||||||||||||||||||||||||||||||||||||||||||
| 663 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 664 | |||||||||||||||||||||||||||||||||||||||||||||
| 665 | # Get | ||||||||||||||||||||||||||||||||||||||||||||
| 666 | 3 | ▶ | return unless $self->{'pdf'}->{'Info'}; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 667 | 3 | $self->{'pdf'}->{'Info'}->realise(); | |||||||||||||||||||||||||||||||||||||||||||
| 668 | 3 | ▶ | return unless $self->{'pdf'}->{'Info'}->{$field}; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 669 | 2 | return $self->{'pdf'}->{'Info'}->{$field}->val(); | |||||||||||||||||||||||||||||||||||||||||||
| 670 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 671 | |||||||||||||||||||||||||||||||||||||||||||||
| 672 | # Deprecated; replace with individual accessors or info_metadata | ||||||||||||||||||||||||||||||||||||||||||||
| 673 | sub info { | ||||||||||||||||||||||||||||||||||||||||||||
| 674 | 3 | ▶ | my ($self, %opt) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
info: called CC=11 SCAR=25.9
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 675 | |||||||||||||||||||||||||||||||||||||||||||||
| 676 | 3 | ▶ | if (not defined($self->{'pdf'}->{'Info'})) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 677 | 0 | $self->{'pdf'}->{'Info'} = PDFDict(); | |||||||||||||||||||||||||||||||||||||||||||
| 678 | 0 | $self->{'pdf'}->new_obj($self->{'pdf'}->{'Info'}); | |||||||||||||||||||||||||||||||||||||||||||
| 679 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 680 | else { | ||||||||||||||||||||||||||||||||||||||||||||
| 681 | 3 | $self->{'pdf'}->{'Info'}->realise(); | |||||||||||||||||||||||||||||||||||||||||||
| 682 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 683 | |||||||||||||||||||||||||||||||||||||||||||||
| 684 | # Maintenance Note: Since we're not shifting at the beginning of | ||||||||||||||||||||||||||||||||||||||||||||
| 685 | # this sub, this "if" will always be true | ||||||||||||||||||||||||||||||||||||||||||||
| 686 | 3 | ▶ | if (scalar @_) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 687 | 3 | foreach my $k (@{$self->{'infoMeta'}}) { | |||||||||||||||||||||||||||||||||||||||||||
| 688 | 24 | ▶ | next unless defined $opt{$k}; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 689 | 1 | ▶ | $self->{'pdf'}->{'Info'}->{$k} = PDFStr($opt{$k} || 'NONE'); | ||||||||||||||||||||||||||||||||||||||||||
|
Condition50%1/2
$opt{$k} || 'NONE'
MC/DC0%0/1
$opt{$k} || 'NONE'
$opt{$k}
Truth table50%1/2
A
A= $opt{$k}
| |||||||||||||||||||||||||||||||||||||||||||||
| 690 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 691 | 3 | $self->{'pdf'}->out_obj($self->{'pdf'}->{'Info'}); | |||||||||||||||||||||||||||||||||||||||||||
| 692 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 693 | |||||||||||||||||||||||||||||||||||||||||||||
| 694 | 3 | ▶ | if (defined $self->{'pdf'}->{'Info'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 695 | 3 | %opt = (); | |||||||||||||||||||||||||||||||||||||||||||
| 696 | 3 | foreach my $k (@{$self->{'infoMeta'}}) { | |||||||||||||||||||||||||||||||||||||||||||
| 697 | 24 | ▶ | next unless defined $self->{'pdf'}->{'Info'}->{$k}; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 698 | 3 | $opt{$k} = $self->{'pdf'}->{'Info'}->{$k}->val(); | |||||||||||||||||||||||||||||||||||||||||||
| 699 | 3 | ▶ | if ( (unpack('n', $opt{$k}) == 0xfffe) | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
Condition33%1/3
unpack("n", $opt{$k}) == 65534 or unpack("n", $opt{$k}) == 65279
MC/DC0%0/2
unpack("n", $opt{$k}) == 65534 or unpack("n", $opt{$k}) == 65279
unpack("n", $opt{$k}) == 65534
unpack("n", $opt{$k}) == 65279
Truth table33%1/3
A or B
A= unpack("n", $opt{$k}) == 65534B= unpack("n", $opt{$k}) == 65279
| |||||||||||||||||||||||||||||||||||||||||||||
| 700 | or (unpack('n', $opt{$k}) == 0xfeff)) | ||||||||||||||||||||||||||||||||||||||||||||
| 701 | { | ||||||||||||||||||||||||||||||||||||||||||||
| 702 | 0 | $opt{$k} = decode('UTF-16', $self->{'pdf'}->{'Info'}->{$k}->val()); | |||||||||||||||||||||||||||||||||||||||||||
| 703 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 704 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 705 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 706 | |||||||||||||||||||||||||||||||||||||||||||||
| 707 | 3 | return %opt; | |||||||||||||||||||||||||||||||||||||||||||
| 708 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 709 | |||||||||||||||||||||||||||||||||||||||||||||
| 710 | # Deprecated; replace with info_metadata | ||||||||||||||||||||||||||||||||||||||||||||
| 711 | sub infoMetaAttributes { | ||||||||||||||||||||||||||||||||||||||||||||
| 712 | 0 | ▶ | my ($self, @attr) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
infoMetaAttributes: not called CC=2 SCAR=17.9
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 713 | |||||||||||||||||||||||||||||||||||||||||||||
| 714 | 0 | ▶ | if (scalar @attr) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 715 | 0 | my %at = map { $_ => 1 } @{$self->{'infoMeta'}}, @attr; | |||||||||||||||||||||||||||||||||||||||||||
| 716 | 0 | @{$self->{'infoMeta'}} = keys %at; | |||||||||||||||||||||||||||||||||||||||||||
| 717 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 718 | |||||||||||||||||||||||||||||||||||||||||||||
| 719 | 0 | return @{$self->{'infoMeta'}}; | |||||||||||||||||||||||||||||||||||||||||||
| 720 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 721 | |||||||||||||||||||||||||||||||||||||||||||||
| 722 | =head2 xml_metadata | ||||||||||||||||||||||||||||||||||||||||||||
| 723 | |||||||||||||||||||||||||||||||||||||||||||||
| 724 | $xml = $pdf->xml_metadata(); | ||||||||||||||||||||||||||||||||||||||||||||
| 725 | $pdf = $pdf->xml_metadata($xml); | ||||||||||||||||||||||||||||||||||||||||||||
| 726 | |||||||||||||||||||||||||||||||||||||||||||||
| 727 | Get/set the document's XML metadata stream. | ||||||||||||||||||||||||||||||||||||||||||||
| 728 | |||||||||||||||||||||||||||||||||||||||||||||
| 729 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 730 | |||||||||||||||||||||||||||||||||||||||||||||
| 731 | # Deprecated (renamed, changed set return value for consistency) | ||||||||||||||||||||||||||||||||||||||||||||
| 732 | sub xmpMetadata { | ||||||||||||||||||||||||||||||||||||||||||||
| 733 | 0 | ▶ | my $self = shift(); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
xmpMetadata: not called CC=2 SCAR=17.9
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 734 | 0 | ▶ | if (@_) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 735 | 0 | my $value = shift(); | |||||||||||||||||||||||||||||||||||||||||||
| 736 | 0 | $self->xml_metadata($value); | |||||||||||||||||||||||||||||||||||||||||||
| 737 | 0 | return $value; | |||||||||||||||||||||||||||||||||||||||||||
| 738 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 739 | |||||||||||||||||||||||||||||||||||||||||||||
| 740 | 0 | return $self->xml_metadata(); | |||||||||||||||||||||||||||||||||||||||||||
| 741 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 742 | |||||||||||||||||||||||||||||||||||||||||||||
| 743 | sub xml_metadata { | ||||||||||||||||||||||||||||||||||||||||||||
| 744 | 0 | ▶ | my ($self, $value) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
xml_metadata: not called CC=3 SCAR=24.8
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 745 | |||||||||||||||||||||||||||||||||||||||||||||
| 746 | 0 | ▶ | if (not defined($self->{'catalog'}->{'Metadata'})) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 747 | 0 | $self->{'catalog'}->{'Metadata'} = PDFDict(); | |||||||||||||||||||||||||||||||||||||||||||
| 748 | 0 | $self->{'catalog'}->{'Metadata'}->{'Type'} = PDFName('Metadata'); | |||||||||||||||||||||||||||||||||||||||||||
| 749 | 0 | $self->{'catalog'}->{'Metadata'}->{'Subtype'} = PDFName('XML'); | |||||||||||||||||||||||||||||||||||||||||||
| 750 | 0 | $self->{'pdf'}->new_obj($self->{'catalog'}->{'Metadata'}); | |||||||||||||||||||||||||||||||||||||||||||
| 751 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 752 | else { | ||||||||||||||||||||||||||||||||||||||||||||
| 753 | 0 | $self->{'catalog'}->{'Metadata'}->realise(); | |||||||||||||||||||||||||||||||||||||||||||
| 754 | 0 | $self->{'catalog'}->{'Metadata'}->{' stream'} = unfilter($self->{'catalog'}->{'Metadata'}->{'Filter'}, $self->{'catalog'}->{'Metadata'}->{' stream'}); | |||||||||||||||||||||||||||||||||||||||||||
| 755 | 0 | delete $self->{'catalog'}->{'Metadata'}->{' nofilt'}; | |||||||||||||||||||||||||||||||||||||||||||
| 756 | 0 | delete $self->{'catalog'}->{'Metadata'}->{'Filter'}; | |||||||||||||||||||||||||||||||||||||||||||
| 757 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 758 | |||||||||||||||||||||||||||||||||||||||||||||
| 759 | 0 | my $md = $self->{'catalog'}->{'Metadata'}; | |||||||||||||||||||||||||||||||||||||||||||
| 760 | |||||||||||||||||||||||||||||||||||||||||||||
| 761 | 0 | ▶ | if (defined $value) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 762 | 0 | $md->{' stream'} = $value; | |||||||||||||||||||||||||||||||||||||||||||
| 763 | 0 | delete $md->{'Filter'}; | |||||||||||||||||||||||||||||||||||||||||||
| 764 | 0 | delete $md->{' nofilt'}; | |||||||||||||||||||||||||||||||||||||||||||
| 765 | 0 | $self->{'pdf'}->out_obj($md); | |||||||||||||||||||||||||||||||||||||||||||
| 766 | 0 | $self->{'pdf'}->out_obj($self->{'catalog'}); | |||||||||||||||||||||||||||||||||||||||||||
| 767 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 768 | |||||||||||||||||||||||||||||||||||||||||||||
| 769 | 0 | return $md->{' stream'}; | |||||||||||||||||||||||||||||||||||||||||||
| 770 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 771 | |||||||||||||||||||||||||||||||||||||||||||||
| 772 | =head2 version | ||||||||||||||||||||||||||||||||||||||||||||
| 773 | |||||||||||||||||||||||||||||||||||||||||||||
| 774 | $version = $pdf->version($new_version); | ||||||||||||||||||||||||||||||||||||||||||||
| 775 | |||||||||||||||||||||||||||||||||||||||||||||
| 776 | Get/set the PDF version (e.g. 1.4). | ||||||||||||||||||||||||||||||||||||||||||||
| 777 | |||||||||||||||||||||||||||||||||||||||||||||
| 778 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 779 | |||||||||||||||||||||||||||||||||||||||||||||
| 780 | sub version { | ||||||||||||||||||||||||||||||||||||||||||||
| 781 | 5 | ▶ | my $self = shift(); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
version: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 782 | 5 | return $self->{'pdf'}->version(@_); | |||||||||||||||||||||||||||||||||||||||||||
| 783 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 784 | |||||||||||||||||||||||||||||||||||||||||||||
| 785 | =head2 is_encrypted | ||||||||||||||||||||||||||||||||||||||||||||
| 786 | |||||||||||||||||||||||||||||||||||||||||||||
| 787 | $boolean = $pdf->is_encrypted(); | ||||||||||||||||||||||||||||||||||||||||||||
| 788 | |||||||||||||||||||||||||||||||||||||||||||||
| 789 | Returns true if the opened PDF is encrypted. | ||||||||||||||||||||||||||||||||||||||||||||
| 790 | |||||||||||||||||||||||||||||||||||||||||||||
| 791 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 792 | |||||||||||||||||||||||||||||||||||||||||||||
| 793 | # Deprecated (renamed) | ||||||||||||||||||||||||||||||||||||||||||||
| 794 | 0 | ▶ | sub isEncrypted { return is_encrypted(@_) } | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
isEncrypted: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 795 | |||||||||||||||||||||||||||||||||||||||||||||
| 796 | sub is_encrypted { | ||||||||||||||||||||||||||||||||||||||||||||
| 797 | 0 | ▶ | my $self = shift(); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
is_encrypted: not called CC=2 SCAR=17.9
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 798 | 0 | ▶ | return defined($self->{'pdf'}->{'Encrypt'}) ? 1 : 0; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 799 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 800 | |||||||||||||||||||||||||||||||||||||||||||||
| 801 | =head1 INTERACTIVE FEATURE METHODS | ||||||||||||||||||||||||||||||||||||||||||||
| 802 | |||||||||||||||||||||||||||||||||||||||||||||
| 803 | =head2 outline | ||||||||||||||||||||||||||||||||||||||||||||
| 804 | |||||||||||||||||||||||||||||||||||||||||||||
| 805 | $outline = $pdf->outlines(); | ||||||||||||||||||||||||||||||||||||||||||||
| 806 | |||||||||||||||||||||||||||||||||||||||||||||
| 807 | Creates (if needed) and returns the document's outline tree, which is also known | ||||||||||||||||||||||||||||||||||||||||||||
| 808 | as its bookmarks or the table of contents, depending on the PDF reader. | ||||||||||||||||||||||||||||||||||||||||||||
| 809 | |||||||||||||||||||||||||||||||||||||||||||||
| 810 | To examine or modify the outline tree, see L<PDF::API2::Outline>. | ||||||||||||||||||||||||||||||||||||||||||||
| 811 | |||||||||||||||||||||||||||||||||||||||||||||
| 812 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 813 | |||||||||||||||||||||||||||||||||||||||||||||
| 814 | # Deprecated (renamed) | ||||||||||||||||||||||||||||||||||||||||||||
| 815 | 4 | ▶ | sub outlines { return outline(@_) } | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
outlines: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 816 | |||||||||||||||||||||||||||||||||||||||||||||
| 817 | sub outline { | ||||||||||||||||||||||||||||||||||||||||||||
| 818 | 4 | ▶ | my $self = shift(); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
outline: called CC=3 SCAR=11.0
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 819 | |||||||||||||||||||||||||||||||||||||||||||||
| 820 | 4 | require PDF::API2::Outlines; | |||||||||||||||||||||||||||||||||||||||||||
| 821 | 4 | my $obj = $self->{'pdf'}->{'Root'}->{'Outlines'}; | |||||||||||||||||||||||||||||||||||||||||||
| 822 | 4 | ▶ | if ($obj) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 823 | 1 | $obj->realise(); | |||||||||||||||||||||||||||||||||||||||||||
| 824 | 1 | bless $obj, 'PDF::API2::Outlines'; | |||||||||||||||||||||||||||||||||||||||||||
| 825 | 1 | $obj->{' api'} = $self; | |||||||||||||||||||||||||||||||||||||||||||
| 826 | 1 | weaken $obj->{' api'}; | |||||||||||||||||||||||||||||||||||||||||||
| 827 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 828 | else { | ||||||||||||||||||||||||||||||||||||||||||||
| 829 | 3 | $obj = PDF::API2::Outlines->new($self); | |||||||||||||||||||||||||||||||||||||||||||
| 830 | |||||||||||||||||||||||||||||||||||||||||||||
| 831 | 3 | $self->{'pdf'}->{'Root'}->{'Outlines'} = $obj; | |||||||||||||||||||||||||||||||||||||||||||
| 832 | 3 | ▶ | $self->{'pdf'}->new_obj($obj) unless $obj->is_obj($self->{'pdf'}); | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 833 | 3 | $self->{'pdf'}->out_obj($obj); | |||||||||||||||||||||||||||||||||||||||||||
| 834 | 3 | $self->{'pdf'}->out_obj($self->{'pdf'}->{'Root'}); | |||||||||||||||||||||||||||||||||||||||||||
| 835 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 836 | |||||||||||||||||||||||||||||||||||||||||||||
| 837 | 4 | return $obj; | |||||||||||||||||||||||||||||||||||||||||||
| 838 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 839 | |||||||||||||||||||||||||||||||||||||||||||||
| 840 | =head2 open_action | ||||||||||||||||||||||||||||||||||||||||||||
| 841 | |||||||||||||||||||||||||||||||||||||||||||||
| 842 | $pdf = $pdf->open_action($page, $location, @args); | ||||||||||||||||||||||||||||||||||||||||||||
| 843 | |||||||||||||||||||||||||||||||||||||||||||||
| 844 | Set the destination in the PDF that should be displayed when the document is | ||||||||||||||||||||||||||||||||||||||||||||
| 845 | opened. | ||||||||||||||||||||||||||||||||||||||||||||
| 846 | |||||||||||||||||||||||||||||||||||||||||||||
| 847 | C<$page> may be either a page number or a page object. The other parameters are | ||||||||||||||||||||||||||||||||||||||||||||
| 848 | as described in L<PDF::API2::NamedDestination>. | ||||||||||||||||||||||||||||||||||||||||||||
| 849 | |||||||||||||||||||||||||||||||||||||||||||||
| 850 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 851 | |||||||||||||||||||||||||||||||||||||||||||||
| 852 | sub open_action { | ||||||||||||||||||||||||||||||||||||||||||||
| 853 | 2 | ▶ | my ($self, $page, @args) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
open_action: called CC=2 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 854 | |||||||||||||||||||||||||||||||||||||||||||||
| 855 | # $page can be either a page number or a page object | ||||||||||||||||||||||||||||||||||||||||||||
| 856 | 2 | ▶ | $page = PDFNum($page) unless ref($page); | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 857 | |||||||||||||||||||||||||||||||||||||||||||||
| 858 | 2 | require PDF::API2::NamedDestination; | |||||||||||||||||||||||||||||||||||||||||||
| 859 | 2 | my $array = PDF::API2::NamedDestination::_destination($page, @args); | |||||||||||||||||||||||||||||||||||||||||||
| 860 | 2 | $self->{'catalog'}->{'OpenAction'} = $array; | |||||||||||||||||||||||||||||||||||||||||||
| 861 | 2 | $self->{'pdf'}->out_obj($self->{'catalog'}); | |||||||||||||||||||||||||||||||||||||||||||
| 862 | 2 | return $self; | |||||||||||||||||||||||||||||||||||||||||||
| 863 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 864 | |||||||||||||||||||||||||||||||||||||||||||||
| 865 | =head2 page_layout | ||||||||||||||||||||||||||||||||||||||||||||
| 866 | |||||||||||||||||||||||||||||||||||||||||||||
| 867 | $layout = $pdf->page_layout(); | ||||||||||||||||||||||||||||||||||||||||||||
| 868 | $pdf = $pdf->page_layout($layout); | ||||||||||||||||||||||||||||||||||||||||||||
| 869 | |||||||||||||||||||||||||||||||||||||||||||||
| 870 | Get/set the page layout that should be used when the PDF is opened. | ||||||||||||||||||||||||||||||||||||||||||||
| 871 | |||||||||||||||||||||||||||||||||||||||||||||
| 872 | C<$layout> is one of the following: | ||||||||||||||||||||||||||||||||||||||||||||
| 873 | |||||||||||||||||||||||||||||||||||||||||||||
| 874 | =over | ||||||||||||||||||||||||||||||||||||||||||||
| 875 | |||||||||||||||||||||||||||||||||||||||||||||
| 876 | =item * single_page (or undef) | ||||||||||||||||||||||||||||||||||||||||||||
| 877 | |||||||||||||||||||||||||||||||||||||||||||||
| 878 | Display one page at a time. | ||||||||||||||||||||||||||||||||||||||||||||
| 879 | |||||||||||||||||||||||||||||||||||||||||||||
| 880 | =item * one_column | ||||||||||||||||||||||||||||||||||||||||||||
| 881 | |||||||||||||||||||||||||||||||||||||||||||||
| 882 | Display the pages in one column (a.k.a. continuous). | ||||||||||||||||||||||||||||||||||||||||||||
| 883 | |||||||||||||||||||||||||||||||||||||||||||||
| 884 | =item * two_column_left | ||||||||||||||||||||||||||||||||||||||||||||
| 885 | |||||||||||||||||||||||||||||||||||||||||||||
| 886 | Display the pages in two columns, with odd-numbered pages on the left. | ||||||||||||||||||||||||||||||||||||||||||||
| 887 | |||||||||||||||||||||||||||||||||||||||||||||
| 888 | =item * two_column_right | ||||||||||||||||||||||||||||||||||||||||||||
| 889 | |||||||||||||||||||||||||||||||||||||||||||||
| 890 | Display the pages in two columns, with odd-numbered pages on the right. | ||||||||||||||||||||||||||||||||||||||||||||
| 891 | |||||||||||||||||||||||||||||||||||||||||||||
| 892 | =item * two_page_left | ||||||||||||||||||||||||||||||||||||||||||||
| 893 | |||||||||||||||||||||||||||||||||||||||||||||
| 894 | Display two pages at a time, with odd-numbered pages on the left. | ||||||||||||||||||||||||||||||||||||||||||||
| 895 | |||||||||||||||||||||||||||||||||||||||||||||
| 896 | =item * two_page_right | ||||||||||||||||||||||||||||||||||||||||||||
| 897 | |||||||||||||||||||||||||||||||||||||||||||||
| 898 | Display two pages at a time, with odd-numbered pages on the right. | ||||||||||||||||||||||||||||||||||||||||||||
| 899 | |||||||||||||||||||||||||||||||||||||||||||||
| 900 | =back | ||||||||||||||||||||||||||||||||||||||||||||
| 901 | |||||||||||||||||||||||||||||||||||||||||||||
| 902 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 903 | |||||||||||||||||||||||||||||||||||||||||||||
| 904 | sub page_layout { | ||||||||||||||||||||||||||||||||||||||||||||
| 905 | 169 | ▶ | my $self = shift(); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
page_layout: called CC=17 SCAR=49.7
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 906 | |||||||||||||||||||||||||||||||||||||||||||||
| 907 | 169 | ▶ | unless (@_) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 908 | 0 | ▶ | return 'single_page' unless $self->{'catalog'}->{'PageLayout'}; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 909 | 0 | my $layout = $self->{'catalog'}->{'PageLayout'}->val(); | |||||||||||||||||||||||||||||||||||||||||||
| 910 | 0 | ▶ | return 'single_page' if $layout eq 'SinglePage'; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 911 | 0 | ▶ | return 'one_column' if $layout eq 'OneColumn'; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 912 | 0 | ▶ | return 'two_column_left' if $layout eq 'TwoColumnLeft'; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 913 | 0 | ▶ | return 'two_column_right' if $layout eq 'TwoColumnRight'; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 914 | 0 | ▶ | return 'two_page_left' if $layout eq 'TwoPageLeft'; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 915 | 0 | ▶ | return 'two_page_right' if $layout eq 'TwoPageRight'; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 916 | 0 | warn "Unknown page layout: $layout"; | |||||||||||||||||||||||||||||||||||||||||||
| 917 | 0 | return $layout; | |||||||||||||||||||||||||||||||||||||||||||
| 918 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 919 | |||||||||||||||||||||||||||||||||||||||||||||
| 920 | 169 | ▶ | my $name = shift() // 'single_page'; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition50%1/2
shift() // "single_page"
MC/DC0%0/1
shift() // "single_page"
shift()
Truth table50%1/2
A
A= shift()
| |||||||||||||||||||||||||||||||||||||||||||||
| 921 | 169 | ▶ | my $layout = ($name eq 'single_page' ? 'SinglePage' : | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 6 branches
| |||||||||||||||||||||||||||||||||||||||||||||
| 922 | $name eq 'one_column' ? 'OneColumn' : | ||||||||||||||||||||||||||||||||||||||||||||
| 923 | $name eq 'two_column_left' ? 'TwoColumnLeft' : | ||||||||||||||||||||||||||||||||||||||||||||
| 924 | $name eq 'two_column_right' ? 'TwoColumnRight' : | ||||||||||||||||||||||||||||||||||||||||||||
| 925 | $name eq 'two_page_left' ? 'TwoPageLeft' : | ||||||||||||||||||||||||||||||||||||||||||||
| 926 | $name eq 'two_page_right' ? 'TwoPageRight' : ''); | ||||||||||||||||||||||||||||||||||||||||||||
| 927 | |||||||||||||||||||||||||||||||||||||||||||||
| 928 | 169 | ▶ | croak "Invalid page layout: $name" unless $layout; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 929 | 169 | $self->{'catalog'}->{'PageLayout'} = PDFName($layout); | |||||||||||||||||||||||||||||||||||||||||||
| 930 | 169 | $self->{'pdf'}->out_obj($self->{'catalog'}); | |||||||||||||||||||||||||||||||||||||||||||
| 931 | 169 | return $self; | |||||||||||||||||||||||||||||||||||||||||||
| 932 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 933 | |||||||||||||||||||||||||||||||||||||||||||||
| 934 | =head2 page_mode | ||||||||||||||||||||||||||||||||||||||||||||
| 935 | |||||||||||||||||||||||||||||||||||||||||||||
| 936 | # Get | ||||||||||||||||||||||||||||||||||||||||||||
| 937 | $mode = $pdf->page_mode(); | ||||||||||||||||||||||||||||||||||||||||||||
| 938 | |||||||||||||||||||||||||||||||||||||||||||||
| 939 | # Set | ||||||||||||||||||||||||||||||||||||||||||||
| 940 | $pdf = $pdf->page_mode($mode); | ||||||||||||||||||||||||||||||||||||||||||||
| 941 | |||||||||||||||||||||||||||||||||||||||||||||
| 942 | Get/set the page mode, which describes how the PDF should be displayed when | ||||||||||||||||||||||||||||||||||||||||||||
| 943 | opened. | ||||||||||||||||||||||||||||||||||||||||||||
| 944 | |||||||||||||||||||||||||||||||||||||||||||||
| 945 | C<$mode> is one of the following: | ||||||||||||||||||||||||||||||||||||||||||||
| 946 | |||||||||||||||||||||||||||||||||||||||||||||
| 947 | =over | ||||||||||||||||||||||||||||||||||||||||||||
| 948 | |||||||||||||||||||||||||||||||||||||||||||||
| 949 | =item * none (or undef) | ||||||||||||||||||||||||||||||||||||||||||||
| 950 | |||||||||||||||||||||||||||||||||||||||||||||
| 951 | Neither outlines nor thumbnails should be displayed. | ||||||||||||||||||||||||||||||||||||||||||||
| 952 | |||||||||||||||||||||||||||||||||||||||||||||
| 953 | =item * outlines | ||||||||||||||||||||||||||||||||||||||||||||
| 954 | |||||||||||||||||||||||||||||||||||||||||||||
| 955 | Show the document outline. | ||||||||||||||||||||||||||||||||||||||||||||
| 956 | |||||||||||||||||||||||||||||||||||||||||||||
| 957 | =item * thumbnails | ||||||||||||||||||||||||||||||||||||||||||||
| 958 | |||||||||||||||||||||||||||||||||||||||||||||
| 959 | Show the page thumbnails. | ||||||||||||||||||||||||||||||||||||||||||||
| 960 | |||||||||||||||||||||||||||||||||||||||||||||
| 961 | =item * full_screen | ||||||||||||||||||||||||||||||||||||||||||||
| 962 | |||||||||||||||||||||||||||||||||||||||||||||
| 963 | Open in full-screen mode, with no menu bar, window controls, or any other window | ||||||||||||||||||||||||||||||||||||||||||||
| 964 | visible. | ||||||||||||||||||||||||||||||||||||||||||||
| 965 | |||||||||||||||||||||||||||||||||||||||||||||
| 966 | =item * optional_content | ||||||||||||||||||||||||||||||||||||||||||||
| 967 | |||||||||||||||||||||||||||||||||||||||||||||
| 968 | Show the optional content group panel. | ||||||||||||||||||||||||||||||||||||||||||||
| 969 | |||||||||||||||||||||||||||||||||||||||||||||
| 970 | =item * attachments | ||||||||||||||||||||||||||||||||||||||||||||
| 971 | |||||||||||||||||||||||||||||||||||||||||||||
| 972 | Show the attachments panel. | ||||||||||||||||||||||||||||||||||||||||||||
| 973 | |||||||||||||||||||||||||||||||||||||||||||||
| 974 | =back | ||||||||||||||||||||||||||||||||||||||||||||
| 975 | |||||||||||||||||||||||||||||||||||||||||||||
| 976 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 977 | |||||||||||||||||||||||||||||||||||||||||||||
| 978 | sub page_mode { | ||||||||||||||||||||||||||||||||||||||||||||
| 979 | 169 | ▶ | my $self = shift(); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
page_mode: called CC=17 SCAR=49.7
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 980 | |||||||||||||||||||||||||||||||||||||||||||||
| 981 | 169 | ▶ | unless (@_) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 982 | 0 | ▶ | return 'none' unless $self->{'catalog'}->{'PageMode'}; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 983 | 0 | my $mode = $self->{'catalog'}->{'PageMode'}->val(); | |||||||||||||||||||||||||||||||||||||||||||
| 984 | 0 | ▶ | return 'none' if $mode eq 'UseNone'; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 985 | 0 | ▶ | return 'outlines' if $mode eq 'UseOutlines'; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 986 | 0 | ▶ | return 'thumbnails' if $mode eq 'UseThumbs'; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 987 | 0 | ▶ | return 'full_screen' if $mode eq 'FullScreen'; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 988 | 0 | ▶ | return 'optional_content' if $mode eq 'UseOC'; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 989 | 0 | ▶ | return 'attachments' if $mode eq 'UseAttachments'; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 990 | 0 | warn "Unknown page mode: $mode"; | |||||||||||||||||||||||||||||||||||||||||||
| 991 | 0 | return $mode; | |||||||||||||||||||||||||||||||||||||||||||
| 992 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 993 | |||||||||||||||||||||||||||||||||||||||||||||
| 994 | 169 | ▶ | my $name = shift() // 'none'; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition50%1/2
shift() // "none"
MC/DC0%0/1
shift() // "none"
shift()
Truth table50%1/2
A
A= shift()
| |||||||||||||||||||||||||||||||||||||||||||||
| 995 | 169 | ▶ | my $mode = ($name eq 'none' ? 'UseNone' : | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 6 branches
| |||||||||||||||||||||||||||||||||||||||||||||
| 996 | $name eq 'outlines' ? 'UseOutlines' : | ||||||||||||||||||||||||||||||||||||||||||||
| 997 | $name eq 'thumbnails' ? 'UseThumbs' : | ||||||||||||||||||||||||||||||||||||||||||||
| 998 | $name eq 'full_screen' ? 'FullScreen' : | ||||||||||||||||||||||||||||||||||||||||||||
| 999 | $name eq 'optional_content' ? 'UseOC' : | ||||||||||||||||||||||||||||||||||||||||||||
| 1000 | $name eq 'attachments' ? 'UseAttachments' : ''); | ||||||||||||||||||||||||||||||||||||||||||||
| 1001 | |||||||||||||||||||||||||||||||||||||||||||||
| 1002 | 169 | ▶ | croak "Invalid page mode: $name" unless $mode; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1003 | 169 | $self->{'catalog'}->{'PageMode'} = PDFName($mode); | |||||||||||||||||||||||||||||||||||||||||||
| 1004 | 169 | $self->{'pdf'}->out_obj($self->{'catalog'}); | |||||||||||||||||||||||||||||||||||||||||||
| 1005 | 169 | return $self; | |||||||||||||||||||||||||||||||||||||||||||
| 1006 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1007 | |||||||||||||||||||||||||||||||||||||||||||||
| 1008 | =head2 viewer_preferences | ||||||||||||||||||||||||||||||||||||||||||||
| 1009 | |||||||||||||||||||||||||||||||||||||||||||||
| 1010 | # Get | ||||||||||||||||||||||||||||||||||||||||||||
| 1011 | %preferences = $pdf->viewer_preferences(); | ||||||||||||||||||||||||||||||||||||||||||||
| 1012 | |||||||||||||||||||||||||||||||||||||||||||||
| 1013 | # Set | ||||||||||||||||||||||||||||||||||||||||||||
| 1014 | $pdf = $pdf->viewer_preferences(%preferences); | ||||||||||||||||||||||||||||||||||||||||||||
| 1015 | |||||||||||||||||||||||||||||||||||||||||||||
| 1016 | Get or set PDF viewer preferences, as described in | ||||||||||||||||||||||||||||||||||||||||||||
| 1017 | L<PDF::API2::ViewerPreferences>. | ||||||||||||||||||||||||||||||||||||||||||||
| 1018 | |||||||||||||||||||||||||||||||||||||||||||||
| 1019 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 1020 | |||||||||||||||||||||||||||||||||||||||||||||
| 1021 | sub viewer_preferences { | ||||||||||||||||||||||||||||||||||||||||||||
| 1022 | 172 | ▶ | my $self = shift(); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
viewer_preferences: called CC=2 SCAR=7.2
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 1023 | 172 | require PDF::API2::ViewerPreferences; | |||||||||||||||||||||||||||||||||||||||||||
| 1024 | 172 | my $prefs = PDF::API2::ViewerPreferences->new($self); | |||||||||||||||||||||||||||||||||||||||||||
| 1025 | 172 | ▶ | unless (@_) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1026 | 0 | return $prefs->get_preferences(); | |||||||||||||||||||||||||||||||||||||||||||
| 1027 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1028 | 172 | return $prefs->set_preferences(@_); | |||||||||||||||||||||||||||||||||||||||||||
| 1029 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1030 | |||||||||||||||||||||||||||||||||||||||||||||
| 1031 | # Deprecated; the various preferences have been split out into their own methods | ||||||||||||||||||||||||||||||||||||||||||||
| 1032 | sub preferences { | ||||||||||||||||||||||||||||||||||||||||||||
| 1033 | 169 | ▶ | my ($self, %options) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
preferences: called CC=31 SCAR=51.2
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 1034 | |||||||||||||||||||||||||||||||||||||||||||||
| 1035 | # Page Mode Options | ||||||||||||||||||||||||||||||||||||||||||||
| 1036 | 169 | ▶ | if ($options{'-fullscreen'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 3 branches
| |||||||||||||||||||||||||||||||||||||||||||||
| 1037 | 0 | $self->page_mode('full_screen'); | |||||||||||||||||||||||||||||||||||||||||||
| 1038 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1039 | elsif ($options{'-thumbs'}) { | ||||||||||||||||||||||||||||||||||||||||||||
| 1040 | 0 | $self->page_mode('thumbnails'); | |||||||||||||||||||||||||||||||||||||||||||
| 1041 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1042 | elsif ($options{'-outlines'}) { | ||||||||||||||||||||||||||||||||||||||||||||
| 1043 | 0 | $self->page_mode('outlines'); | |||||||||||||||||||||||||||||||||||||||||||
| 1044 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1045 | else { | ||||||||||||||||||||||||||||||||||||||||||||
| 1046 | 169 | $self->page_mode('none'); | |||||||||||||||||||||||||||||||||||||||||||
| 1047 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1048 | |||||||||||||||||||||||||||||||||||||||||||||
| 1049 | # Page Layout Options | ||||||||||||||||||||||||||||||||||||||||||||
| 1050 | 169 | ▶ | if ($options{'-singlepage'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 4 branches
| |||||||||||||||||||||||||||||||||||||||||||||
| 1051 | 0 | $self->page_layout('single_page'); | |||||||||||||||||||||||||||||||||||||||||||
| 1052 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1053 | elsif ($options{'-onecolumn'}) { | ||||||||||||||||||||||||||||||||||||||||||||
| 1054 | 0 | $self->page_layout('one_column'); | |||||||||||||||||||||||||||||||||||||||||||
| 1055 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1056 | elsif ($options{'-twocolumnleft'}) { | ||||||||||||||||||||||||||||||||||||||||||||
| 1057 | 0 | $self->page_layout('two_column_left'); | |||||||||||||||||||||||||||||||||||||||||||
| 1058 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1059 | elsif ($options{'-twocolumnright'}) { | ||||||||||||||||||||||||||||||||||||||||||||
| 1060 | 0 | $self->page_layout('two_column_right'); | |||||||||||||||||||||||||||||||||||||||||||
| 1061 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1062 | else { | ||||||||||||||||||||||||||||||||||||||||||||
| 1063 | 169 | $self->page_layout('single_page'); | |||||||||||||||||||||||||||||||||||||||||||
| 1064 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1065 | |||||||||||||||||||||||||||||||||||||||||||||
| 1066 | # Viewer Preferences | ||||||||||||||||||||||||||||||||||||||||||||
| 1067 | 169 | ▶ | if ($options{'-hidetoolbar'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1068 | 0 | $self->viewer_preferences(hide_toolbar => 1); | |||||||||||||||||||||||||||||||||||||||||||
| 1069 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1070 | 169 | ▶ | if ($options{'-hidemenubar'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1071 | 0 | $self->viewer_preferences(hide_menubar => 1); | |||||||||||||||||||||||||||||||||||||||||||
| 1072 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1073 | 169 | ▶ | if ($options{'-hidewindowui'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1074 | 0 | $self->viewer_preferences(hide_window_ui => 1); | |||||||||||||||||||||||||||||||||||||||||||
| 1075 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1076 | 169 | ▶ | if ($options{'-fitwindow'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1077 | 0 | $self->viewer_preferences(fit_window => 1); | |||||||||||||||||||||||||||||||||||||||||||
| 1078 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1079 | 169 | ▶ | if ($options{'-centerwindow'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1080 | 0 | $self->viewer_preferences(center_window => 1); | |||||||||||||||||||||||||||||||||||||||||||
| 1081 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1082 | 169 | ▶ | if ($options{'-displaytitle'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1083 | 0 | $self->viewer_preferences(display_doc_title => 1); | |||||||||||||||||||||||||||||||||||||||||||
| 1084 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1085 | 169 | ▶ | if ($options{'-righttoleft'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1086 | 0 | $self->viewer_preferences(direction => 'r2l'); | |||||||||||||||||||||||||||||||||||||||||||
| 1087 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1088 | |||||||||||||||||||||||||||||||||||||||||||||
| 1089 | 169 | ▶ | if ($options{'-afterfullscreenthumbs'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 2 branches
| |||||||||||||||||||||||||||||||||||||||||||||
| 1090 | 0 | $self->viewer_preferences(non_full_screen_page_mode => 'thumbnails'); | |||||||||||||||||||||||||||||||||||||||||||
| 1091 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1092 | elsif ($options{'-afterfullscreenoutlines'}) { | ||||||||||||||||||||||||||||||||||||||||||||
| 1093 | 0 | $self->viewer_preferences(non_full_screen_page_mode => 'outlines'); | |||||||||||||||||||||||||||||||||||||||||||
| 1094 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1095 | else { | ||||||||||||||||||||||||||||||||||||||||||||
| 1096 | 169 | $self->viewer_preferences(non_full_screen_page_mode => 'none'); | |||||||||||||||||||||||||||||||||||||||||||
| 1097 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1098 | |||||||||||||||||||||||||||||||||||||||||||||
| 1099 | 169 | ▶ | if ($options{'-printscalingnone'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1100 | 0 | $self->viewer_preferences(print_scaling => 'none'); | |||||||||||||||||||||||||||||||||||||||||||
| 1101 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1102 | |||||||||||||||||||||||||||||||||||||||||||||
| 1103 | 169 | ▶ | if ($options{'-simplex'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 3 branches
| |||||||||||||||||||||||||||||||||||||||||||||
| 1104 | 1 | $self->viewer_preferences(duplex => 'simplex'); | |||||||||||||||||||||||||||||||||||||||||||
| 1105 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1106 | elsif ($options{'-duplexfliplongedge'}) { | ||||||||||||||||||||||||||||||||||||||||||||
| 1107 | 1 | $self->viewer_preferences(duplex => 'duplex_long'); | |||||||||||||||||||||||||||||||||||||||||||
| 1108 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1109 | elsif ($options{'-duplexflipshortedge'}) { | ||||||||||||||||||||||||||||||||||||||||||||
| 1110 | 1 | $self->viewer_preferences(duplex => 'duplex_short'); | |||||||||||||||||||||||||||||||||||||||||||
| 1111 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1112 | |||||||||||||||||||||||||||||||||||||||||||||
| 1113 | # Open Action | ||||||||||||||||||||||||||||||||||||||||||||
| 1114 | 169 | ▶ | if ($options{'-firstpage'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1115 | 2 | my ($page, %args) = @{$options{'-firstpage'}}; | |||||||||||||||||||||||||||||||||||||||||||
| 1116 | 2 | ▶ | $args{'-fit'} = 1 unless keys %args; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1117 | |||||||||||||||||||||||||||||||||||||||||||||
| 1118 | 2 | ▶ | if (defined $args{'-fit'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 8 branches
| |||||||||||||||||||||||||||||||||||||||||||||
| 1119 | 2 | $self->open_action($page, 'fit'); | |||||||||||||||||||||||||||||||||||||||||||
| 1120 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1121 | elsif (defined $args{'-fith'}) { | ||||||||||||||||||||||||||||||||||||||||||||
| 1122 | 0 | $self->open_action($page, 'fith', $args{'-fith'}); | |||||||||||||||||||||||||||||||||||||||||||
| 1123 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1124 | elsif (defined $args{'-fitb'}) { | ||||||||||||||||||||||||||||||||||||||||||||
| 1125 | 0 | $self->open_action($page, 'fitb'); | |||||||||||||||||||||||||||||||||||||||||||
| 1126 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1127 | elsif (defined $args{'-fitbh'}) { | ||||||||||||||||||||||||||||||||||||||||||||
| 1128 | 0 | $self->open_action($page, 'fitbh', $args{'-fitbh'}); | |||||||||||||||||||||||||||||||||||||||||||
| 1129 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1130 | elsif (defined $args{'-fitv'}) { | ||||||||||||||||||||||||||||||||||||||||||||
| 1131 | 0 | $self->open_action($page, 'fitv', $args{'-fitv'}); | |||||||||||||||||||||||||||||||||||||||||||
| 1132 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1133 | elsif (defined $args{'-fitbv'}) { | ||||||||||||||||||||||||||||||||||||||||||||
| 1134 | 0 | $self->open_action($page, 'fitbv', $args{'-fitbv'}); | |||||||||||||||||||||||||||||||||||||||||||
| 1135 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1136 | elsif (defined $args{'-fitr'}) { | ||||||||||||||||||||||||||||||||||||||||||||
| 1137 | 0 | $self->open_action($page, 'fitr', @{$args{'-fitr'}}); | |||||||||||||||||||||||||||||||||||||||||||
| 1138 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1139 | elsif (defined $args{'-xyz'}) { | ||||||||||||||||||||||||||||||||||||||||||||
| 1140 | 0 | $self->open_action($page, 'xyz', @{$args{'-xyz'}}); | |||||||||||||||||||||||||||||||||||||||||||
| 1141 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1142 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1143 | 169 | $self->{'pdf'}->out_obj($self->{'catalog'}); | |||||||||||||||||||||||||||||||||||||||||||
| 1144 | |||||||||||||||||||||||||||||||||||||||||||||
| 1145 | 169 | return $self; | |||||||||||||||||||||||||||||||||||||||||||
| 1146 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1147 | |||||||||||||||||||||||||||||||||||||||||||||
| 1148 | sub proc_pages { | ||||||||||||||||||||||||||||||||||||||||||||
| 1149 | 16 | ▶ | my ($pdf, $object) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
proc_pages: called CC=6 SCAR=18.4
Pod
undocumented
| |||||||||||||||||||||||||||||||||||||||||||||
| 1150 | |||||||||||||||||||||||||||||||||||||||||||||
| 1151 | 16 | ▶ | if (defined $object->{'Resources'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1152 | 16 | eval { | |||||||||||||||||||||||||||||||||||||||||||
| 1153 | 16 | $object->{'Resources'}->realise(); | |||||||||||||||||||||||||||||||||||||||||||
| 1154 | }; | ||||||||||||||||||||||||||||||||||||||||||||
| 1155 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1156 | |||||||||||||||||||||||||||||||||||||||||||||
| 1157 | 16 | my @pages; | |||||||||||||||||||||||||||||||||||||||||||
| 1158 | 16 | ▶ | $pdf->{' apipagecount'} ||= 0; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition50%1/2
$pdf->{" apipagecount"} ||= 0
MC/DC0%0/1
$pdf->{" apipagecount"} ||= 0
$pdf->{" apipagecount"}
Truth table50%1/2
A
A= $pdf->{" apipagecount"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 1159 | 16 | foreach my $page ($object->{'Kids'}->elements()) { | |||||||||||||||||||||||||||||||||||||||||||
| 1160 | 18 | $page->realise(); | |||||||||||||||||||||||||||||||||||||||||||
| 1161 | 18 | ▶ | if ($page->{'Type'}->val() eq 'Pages') { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1162 | 0 | push @pages, proc_pages($pdf, $page); | |||||||||||||||||||||||||||||||||||||||||||
| 1163 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1164 | else { | ||||||||||||||||||||||||||||||||||||||||||||
| 1165 | 18 | $pdf->{' apipagecount'}++; | |||||||||||||||||||||||||||||||||||||||||||
| 1166 | 18 | $page->{' pnum'} = $pdf->{' apipagecount'}; | |||||||||||||||||||||||||||||||||||||||||||
| 1167 | 18 | ▶ | if (defined $page->{'Resources'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1168 | 18 | eval { | |||||||||||||||||||||||||||||||||||||||||||
| 1169 | 18 | $page->{'Resources'}->realise(); | |||||||||||||||||||||||||||||||||||||||||||
| 1170 | }; | ||||||||||||||||||||||||||||||||||||||||||||
| 1171 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1172 | 18 | push @pages, $page; | |||||||||||||||||||||||||||||||||||||||||||
| 1173 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1174 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1175 | |||||||||||||||||||||||||||||||||||||||||||||
| 1176 | 16 | return @pages; | |||||||||||||||||||||||||||||||||||||||||||
| 1177 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1178 | |||||||||||||||||||||||||||||||||||||||||||||
| 1179 | =head1 PAGE METHODS | ||||||||||||||||||||||||||||||||||||||||||||
| 1180 | |||||||||||||||||||||||||||||||||||||||||||||
| 1181 | =head2 page | ||||||||||||||||||||||||||||||||||||||||||||
| 1182 | |||||||||||||||||||||||||||||||||||||||||||||
| 1183 | # Add a page to the end of the document | ||||||||||||||||||||||||||||||||||||||||||||
| 1184 | $page = $pdf->page(); | ||||||||||||||||||||||||||||||||||||||||||||
| 1185 | |||||||||||||||||||||||||||||||||||||||||||||
| 1186 | # Insert a page before the specified page number | ||||||||||||||||||||||||||||||||||||||||||||
| 1187 | $page = $pdf->page($page_number); | ||||||||||||||||||||||||||||||||||||||||||||
| 1188 | |||||||||||||||||||||||||||||||||||||||||||||
| 1189 | Returns a new page object. By default, the page is added to the end | ||||||||||||||||||||||||||||||||||||||||||||
| 1190 | of the document. If you include an existing page number, the new page | ||||||||||||||||||||||||||||||||||||||||||||
| 1191 | will be inserted in that position, pushing existing pages back. | ||||||||||||||||||||||||||||||||||||||||||||
| 1192 | |||||||||||||||||||||||||||||||||||||||||||||
| 1193 | If C<$page_number> is -1, the new page is inserted as the second-last page; if | ||||||||||||||||||||||||||||||||||||||||||||
| 1194 | C<$page_number> is 0, the new page is inserted as the last page. | ||||||||||||||||||||||||||||||||||||||||||||
| 1195 | |||||||||||||||||||||||||||||||||||||||||||||
| 1196 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 1197 | |||||||||||||||||||||||||||||||||||||||||||||
| 1198 | sub page { | ||||||||||||||||||||||||||||||||||||||||||||
| 1199 | 142 | ▶ | my $self = shift(); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
page: called CC=5 SCAR=16.2
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 1200 | 142 | ▶ | my $index = shift() || 0; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition100%2/2
shift() || 0
MC/DC100%1/1
shift() || 0
shift()
Truth table100%2/2
A
A= shift()
| |||||||||||||||||||||||||||||||||||||||||||||
| 1201 | 142 | my $page; | |||||||||||||||||||||||||||||||||||||||||||
| 1202 | 142 | ▶ | if ($index == 0) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1203 | 140 | $page = PDF::API2::Page->new($self->{'pdf'}, $self->{'pages'}); | |||||||||||||||||||||||||||||||||||||||||||
| 1204 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1205 | else { | ||||||||||||||||||||||||||||||||||||||||||||
| 1206 | 2 | $page = PDF::API2::Page->new($self->{'pdf'}, $self->{'pages'}, $index - 1); | |||||||||||||||||||||||||||||||||||||||||||
| 1207 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1208 | 142 | $page->{' apipdf'} = $self->{'pdf'}; | |||||||||||||||||||||||||||||||||||||||||||
| 1209 | 142 | $page->{' api'} = $self; | |||||||||||||||||||||||||||||||||||||||||||
| 1210 | 142 | weaken $page->{' apipdf'}; | |||||||||||||||||||||||||||||||||||||||||||
| 1211 | 142 | weaken $page->{' api'}; | |||||||||||||||||||||||||||||||||||||||||||
| 1212 | 142 | $self->{'pdf'}->out_obj($page); | |||||||||||||||||||||||||||||||||||||||||||
| 1213 | 142 | $self->{'pdf'}->out_obj($self->{'pages'}); | |||||||||||||||||||||||||||||||||||||||||||
| 1214 | 142 | ▶ | if ($index == 0) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 2 branches
| |||||||||||||||||||||||||||||||||||||||||||||
| 1215 | 140 | push @{$self->{'pagestack'}}, $page; | |||||||||||||||||||||||||||||||||||||||||||
| 1216 | 140 | weaken $self->{'pagestack'}->[-1]; | |||||||||||||||||||||||||||||||||||||||||||
| 1217 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1218 | elsif ($index < 0) { | ||||||||||||||||||||||||||||||||||||||||||||
| 1219 | 0 | splice @{$self->{'pagestack'}}, $index, 0, $page; | |||||||||||||||||||||||||||||||||||||||||||
| 1220 | 0 | weaken $self->{'pagestack'}->[$index]; | |||||||||||||||||||||||||||||||||||||||||||
| 1221 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1222 | else { | ||||||||||||||||||||||||||||||||||||||||||||
| 1223 | 2 | splice @{$self->{'pagestack'}}, $index - 1, 0, $page; | |||||||||||||||||||||||||||||||||||||||||||
| 1224 | 2 | weaken $self->{'pagestack'}->[$index - 1]; | |||||||||||||||||||||||||||||||||||||||||||
| 1225 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1226 | # $page->{'Resources'} = $self->{'pages'}->{'Resources'}; | ||||||||||||||||||||||||||||||||||||||||||||
| 1227 | 142 | return $page; | |||||||||||||||||||||||||||||||||||||||||||
| 1228 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1229 | |||||||||||||||||||||||||||||||||||||||||||||
| 1230 | =head2 open_page | ||||||||||||||||||||||||||||||||||||||||||||
| 1231 | |||||||||||||||||||||||||||||||||||||||||||||
| 1232 | $page = $pdf->open_page($page_number); | ||||||||||||||||||||||||||||||||||||||||||||
| 1233 | |||||||||||||||||||||||||||||||||||||||||||||
| 1234 | Returns the L<PDF::API2::Page> object of page C<$page_number>, if it exists. | ||||||||||||||||||||||||||||||||||||||||||||
| 1235 | |||||||||||||||||||||||||||||||||||||||||||||
| 1236 | If $page_number is 0 or -1, it will return the last page in the document. | ||||||||||||||||||||||||||||||||||||||||||||
| 1237 | |||||||||||||||||||||||||||||||||||||||||||||
| 1238 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 1239 | |||||||||||||||||||||||||||||||||||||||||||||
| 1240 | # Deprecated (renamed) | ||||||||||||||||||||||||||||||||||||||||||||
| 1241 | 1 | ▶ | sub openpage { return open_page(@_); } ## no critic | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
openpage: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 1242 | |||||||||||||||||||||||||||||||||||||||||||||
| 1243 | sub open_page { | ||||||||||||||||||||||||||||||||||||||||||||
| 1244 | 6 | ▶ | my $self = shift(); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
open_page: called CC=25 SCAR=46.6
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 1245 | 6 | ▶ | my $index = shift() || 0; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition50%1/2
shift() || 0
MC/DC0%0/1
shift() || 0
shift()
Truth table50%1/2
A
A= shift()
| |||||||||||||||||||||||||||||||||||||||||||||
| 1246 | 6 | my ($page, $rotate, $media, $trans); | |||||||||||||||||||||||||||||||||||||||||||
| 1247 | |||||||||||||||||||||||||||||||||||||||||||||
| 1248 | 6 | ▶ | if ($index == 0) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 2 branches
| |||||||||||||||||||||||||||||||||||||||||||||
| 1249 | 0 | $page = $self->{'pagestack'}->[-1]; | |||||||||||||||||||||||||||||||||||||||||||
| 1250 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1251 | elsif ($index < 0) { | ||||||||||||||||||||||||||||||||||||||||||||
| 1252 | 0 | $page = $self->{'pagestack'}->[$index]; | |||||||||||||||||||||||||||||||||||||||||||
| 1253 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1254 | else { | ||||||||||||||||||||||||||||||||||||||||||||
| 1255 | 6 | $page = $self->{'pagestack'}->[$index - 1]; | |||||||||||||||||||||||||||||||||||||||||||
| 1256 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1257 | 6 | ▶ | return unless ref($page); | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1258 | |||||||||||||||||||||||||||||||||||||||||||||
| 1259 | 6 | ▶ | if (ref($page) ne 'PDF::API2::Page') { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1260 | 5 | bless $page, 'PDF::API2::Page'; | |||||||||||||||||||||||||||||||||||||||||||
| 1261 | 5 | $page->{' apipdf'} = $self->{'pdf'}; | |||||||||||||||||||||||||||||||||||||||||||
| 1262 | 5 | $page->{' api'} = $self; | |||||||||||||||||||||||||||||||||||||||||||
| 1263 | 5 | weaken $page->{' apipdf'}; | |||||||||||||||||||||||||||||||||||||||||||
| 1264 | 5 | weaken $page->{' api'}; | |||||||||||||||||||||||||||||||||||||||||||
| 1265 | 5 | $self->{'pdf'}->out_obj($page); | |||||||||||||||||||||||||||||||||||||||||||
| 1266 | 5 | ▶ | if (($rotate = $page->find_prop('Rotate')) and not $page->{' opened'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
Condition33%1/3
$rotate = $page->find_prop("Rotate") and not $page->{" opened"}
MC/DC0%0/2
$rotate = $page->find_prop("Rotate") and not $page->{" opened"}
$rotate = $page->find_prop("Rotate")
not $page->{" opened"}
Truth table33%1/3
A and not(B)
A= $rotate = $page->find_prop("Rotate")B= not $page->{" opened"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 1267 | 0 | $rotate = ($rotate->val() + 360) % 360; | |||||||||||||||||||||||||||||||||||||||||||
| 1268 | |||||||||||||||||||||||||||||||||||||||||||||
| 1269 | 0 | ▶ | if ($rotate != 0 and not $self->default('nounrotate')) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
Condition0%0/3
$rotate != 0 and not $self->default("nounrotate")
MC/DC0%0/2
$rotate != 0 and not $self->default("nounrotate")
$rotate != 0
not $self->default("nounrotate")
Truth table0%0/3
A and not(B)
A= $rotate != 0B= not $self->default("nounrotate")
| |||||||||||||||||||||||||||||||||||||||||||||
| 1270 | 0 | $page->{'Rotate'} = PDFNum(0); | |||||||||||||||||||||||||||||||||||||||||||
| 1271 | 0 | foreach my $mediatype (qw(MediaBox CropBox BleedBox TrimBox ArtBox)) { | |||||||||||||||||||||||||||||||||||||||||||
| 1272 | 0 | ▶ | if ($media = $page->find_prop($mediatype)) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1273 | 0 | $media = [ map { $_->val() } $media->elements() ]; | |||||||||||||||||||||||||||||||||||||||||||
| 1274 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1275 | else { | ||||||||||||||||||||||||||||||||||||||||||||
| 1276 | 0 | $media = [0, 0, 612, 792]; | |||||||||||||||||||||||||||||||||||||||||||
| 1277 | 0 | ▶ | next if $mediatype ne 'MediaBox'; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1278 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1279 | 0 | ▶ | if ($rotate == 90) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 3 branches
| |||||||||||||||||||||||||||||||||||||||||||||
| 1280 | 0 | ▶ | $trans = "0 -1 1 0 0 $media->[2] cm" if $mediatype eq 'MediaBox'; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1281 | 0 | $media = [$media->[1], $media->[0], $media->[3], $media->[2]]; | |||||||||||||||||||||||||||||||||||||||||||
| 1282 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1283 | elsif ($rotate == 180) { | ||||||||||||||||||||||||||||||||||||||||||||
| 1284 | 0 | ▶ | $trans = "-1 0 0 -1 $media->[2] $media->[3] cm" if $mediatype eq 'MediaBox'; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1285 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1286 | elsif ($rotate == 270) { | ||||||||||||||||||||||||||||||||||||||||||||
| 1287 | 0 | ▶ | $trans = "0 1 -1 0 $media->[3] 0 cm" if $mediatype eq 'MediaBox'; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1288 | 0 | $media = [$media->[1], $media->[0], $media->[3], $media->[2]]; | |||||||||||||||||||||||||||||||||||||||||||
| 1289 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1290 | 0 | $page->{$mediatype} = PDFArray(map { PDFNum($_) } @$media); | |||||||||||||||||||||||||||||||||||||||||||
| 1291 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1292 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1293 | else { | ||||||||||||||||||||||||||||||||||||||||||||
| 1294 | 0 | $trans = ''; | |||||||||||||||||||||||||||||||||||||||||||
| 1295 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1296 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1297 | else { | ||||||||||||||||||||||||||||||||||||||||||||
| 1298 | 5 | $trans = ''; | |||||||||||||||||||||||||||||||||||||||||||
| 1299 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1300 | |||||||||||||||||||||||||||||||||||||||||||||
| 1301 | 5 | ▶ | if (defined $page->{'Contents'} and not $page->{' opened'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
Condition66%2/3
defined $page->{"Contents"} and not $page->{" opened"}
MC/DC50%1/2
defined $page->{"Contents"} and not $page->{" opened"}
defined $page->{"Contents"}
not $page->{" opened"}
Truth table66%2/3
A and not(B)
A= defined $page->{"Contents"}B= not $page->{" opened"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 1302 | 3 | $page->fixcontents(); | |||||||||||||||||||||||||||||||||||||||||||
| 1303 | 3 | my $uncontent = delete $page->{'Contents'}; | |||||||||||||||||||||||||||||||||||||||||||
| 1304 | 3 | my $content = $page->gfx(); | |||||||||||||||||||||||||||||||||||||||||||
| 1305 | 3 | $content->add(" $trans "); | |||||||||||||||||||||||||||||||||||||||||||
| 1306 | |||||||||||||||||||||||||||||||||||||||||||||
| 1307 | 3 | ▶ | if ($self->default('pageencaps')) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1308 | 0 | $content->{' stream'} .= ' q '; | |||||||||||||||||||||||||||||||||||||||||||
| 1309 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1310 | 3 | foreach my $k ($uncontent->elements()) { | |||||||||||||||||||||||||||||||||||||||||||
| 1311 | 3 | $k->realise(); | |||||||||||||||||||||||||||||||||||||||||||
| 1312 | 3 | $content->{' stream'} .= ' ' . unfilter($k->{'Filter'}, $k->{' stream'}) . ' '; | |||||||||||||||||||||||||||||||||||||||||||
| 1313 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1314 | 3 | ▶ | if ($self->default('pageencaps')) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1315 | 0 | $content->{' stream'} .= ' Q '; | |||||||||||||||||||||||||||||||||||||||||||
| 1316 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1317 | |||||||||||||||||||||||||||||||||||||||||||||
| 1318 | # if we like compress we will do it now to do quicker saves | ||||||||||||||||||||||||||||||||||||||||||||
| 1319 | 3 | ▶ | if ($self->{'forcecompress'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1320 | 3 | $content->{' stream'} = dofilter($content->{'Filter'}, $content->{' stream'}); | |||||||||||||||||||||||||||||||||||||||||||
| 1321 | 3 | $content->{' nofilt'} = 1; | |||||||||||||||||||||||||||||||||||||||||||
| 1322 | 3 | delete $content->{'-docompress'}; | |||||||||||||||||||||||||||||||||||||||||||
| 1323 | 3 | $content->{'Length'} = PDFNum(length($content->{' stream'})); | |||||||||||||||||||||||||||||||||||||||||||
| 1324 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1325 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1326 | 5 | $page->{' opened'} = 1; | |||||||||||||||||||||||||||||||||||||||||||
| 1327 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1328 | |||||||||||||||||||||||||||||||||||||||||||||
| 1329 | 6 | $self->{'pdf'}->out_obj($page); | |||||||||||||||||||||||||||||||||||||||||||
| 1330 | 6 | $self->{'pdf'}->out_obj($self->{'pages'}); | |||||||||||||||||||||||||||||||||||||||||||
| 1331 | 6 | $page->{' apipdf'} = $self->{'pdf'}; | |||||||||||||||||||||||||||||||||||||||||||
| 1332 | 6 | $page->{' api'} = $self; | |||||||||||||||||||||||||||||||||||||||||||
| 1333 | 6 | weaken $page->{' apipdf'}; | |||||||||||||||||||||||||||||||||||||||||||
| 1334 | 6 | weaken $page->{' api'}; | |||||||||||||||||||||||||||||||||||||||||||
| 1335 | 6 | return $page; | |||||||||||||||||||||||||||||||||||||||||||
| 1336 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1337 | |||||||||||||||||||||||||||||||||||||||||||||
| 1338 | =head2 import_page | ||||||||||||||||||||||||||||||||||||||||||||
| 1339 | |||||||||||||||||||||||||||||||||||||||||||||
| 1340 | $page = $pdf->import_page($source_pdf, $source_page_num, $target_page_num); | ||||||||||||||||||||||||||||||||||||||||||||
| 1341 | |||||||||||||||||||||||||||||||||||||||||||||
| 1342 | Imports a page from C<$source_pdf> and adds it to the specified position in | ||||||||||||||||||||||||||||||||||||||||||||
| 1343 | C<$pdf>. | ||||||||||||||||||||||||||||||||||||||||||||
| 1344 | |||||||||||||||||||||||||||||||||||||||||||||
| 1345 | If C<$source_page_num> or C<$target_page_num> is 0, -1, or unspecified, the last | ||||||||||||||||||||||||||||||||||||||||||||
| 1346 | page in the document is used. | ||||||||||||||||||||||||||||||||||||||||||||
| 1347 | |||||||||||||||||||||||||||||||||||||||||||||
| 1348 | B<Note:> If you pass a page object instead of a page number for | ||||||||||||||||||||||||||||||||||||||||||||
| 1349 | C<$target_page_num>, the contents of the page will be merged into the existing | ||||||||||||||||||||||||||||||||||||||||||||
| 1350 | page. | ||||||||||||||||||||||||||||||||||||||||||||
| 1351 | |||||||||||||||||||||||||||||||||||||||||||||
| 1352 | B<Example:> | ||||||||||||||||||||||||||||||||||||||||||||
| 1353 | |||||||||||||||||||||||||||||||||||||||||||||
| 1354 | my $pdf = PDF::API2->new(); | ||||||||||||||||||||||||||||||||||||||||||||
| 1355 | my $source = PDF::API2->open('source.pdf'); | ||||||||||||||||||||||||||||||||||||||||||||
| 1356 | |||||||||||||||||||||||||||||||||||||||||||||
| 1357 | # Add page 2 from the source PDF as page 1 of the new PDF | ||||||||||||||||||||||||||||||||||||||||||||
| 1358 | my $page = $pdf->import_page($source, 2); | ||||||||||||||||||||||||||||||||||||||||||||
| 1359 | |||||||||||||||||||||||||||||||||||||||||||||
| 1360 | $pdf->save('sample.pdf'); | ||||||||||||||||||||||||||||||||||||||||||||
| 1361 | |||||||||||||||||||||||||||||||||||||||||||||
| 1362 | B<Note:> You can only import a page from an existing PDF file. | ||||||||||||||||||||||||||||||||||||||||||||
| 1363 | |||||||||||||||||||||||||||||||||||||||||||||
| 1364 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 1365 | |||||||||||||||||||||||||||||||||||||||||||||
| 1366 | # Deprecated (renamed) | ||||||||||||||||||||||||||||||||||||||||||||
| 1367 | 1 | ▶ | sub importpage { return import_page(@_); } ## no critic | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
importpage: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 1368 | |||||||||||||||||||||||||||||||||||||||||||||
| 1369 | sub import_page { | ||||||||||||||||||||||||||||||||||||||||||||
| 1370 | 1 | ▶ | my ($self, $s_pdf, $s_idx, $t_idx) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
import_page: called CC=24 SCAR=51.2
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 1371 | 1 | ▶ | $s_idx ||= 0; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition50%1/2
$s_idx ||= 0
MC/DC0%0/1
$s_idx ||= 0
$s_idx
Truth table50%1/2
A
A= $s_idx
| |||||||||||||||||||||||||||||||||||||||||||||
| 1372 | 1 | ▶ | $t_idx ||= 0; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition50%1/2
$t_idx ||= 0
MC/DC0%0/1
$t_idx ||= 0
$t_idx
Truth table50%1/2
A
A= $t_idx
| |||||||||||||||||||||||||||||||||||||||||||||
| 1373 | 1 | my ($s_page, $t_page); | |||||||||||||||||||||||||||||||||||||||||||
| 1374 | |||||||||||||||||||||||||||||||||||||||||||||
| 1375 | 1 | ▶ | unless (ref($s_pdf) and $s_pdf->isa('PDF::API2')) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
Condition33%1/3
ref $s_pdf and $s_pdf->isa("PDF::API2")
MC/DC0%0/2
ref $s_pdf and $s_pdf->isa("PDF::API2")
ref $s_pdf
$s_pdf->isa("PDF::API2")
Truth table33%1/3
A and B
A= ref $s_pdfB= $s_pdf->isa("PDF::API2")
| |||||||||||||||||||||||||||||||||||||||||||||
| 1376 | 0 | die "Invalid usage: first argument must be PDF::API2 instance, not: " . ref($s_pdf); | |||||||||||||||||||||||||||||||||||||||||||
| 1377 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1378 | |||||||||||||||||||||||||||||||||||||||||||||
| 1379 | 1 | ▶ | if (ref($s_idx) eq 'PDF::API2::Page') { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1380 | 0 | $s_page = $s_idx; | |||||||||||||||||||||||||||||||||||||||||||
| 1381 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1382 | else { | ||||||||||||||||||||||||||||||||||||||||||||
| 1383 | 1 | $s_page = $s_pdf->open_page($s_idx); | |||||||||||||||||||||||||||||||||||||||||||
| 1384 | 1 | ▶ | die "Unable to open page '$s_idx' in source PDF" unless defined $s_page; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1385 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1386 | |||||||||||||||||||||||||||||||||||||||||||||
| 1387 | 1 | ▶ | if (ref($t_idx) eq 'PDF::API2::Page') { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1388 | 0 | $t_page = $t_idx; | |||||||||||||||||||||||||||||||||||||||||||
| 1389 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1390 | else { | ||||||||||||||||||||||||||||||||||||||||||||
| 1391 | 1 | ▶ | if ($self->pages() < $t_idx) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1392 | 0 | $t_page = $self->page(); | |||||||||||||||||||||||||||||||||||||||||||
| 1393 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1394 | else { | ||||||||||||||||||||||||||||||||||||||||||||
| 1395 | 1 | $t_page = $self->page($t_idx); | |||||||||||||||||||||||||||||||||||||||||||
| 1396 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1397 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1398 | |||||||||||||||||||||||||||||||||||||||||||||
| 1399 | 1 | ▶ | $self->{'apiimportcache'} = $self->{'apiimportcache'} || {}; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition50%1/2
$self->{'apiimportcache'} || {}
MC/DC0%0/1
$self->{'apiimportcache'} || {}
$self->{'apiimportcache'}
Truth table50%1/2
A
A= $self->{'apiimportcache'}
| |||||||||||||||||||||||||||||||||||||||||||||
| 1400 | 1 | ▶ | $self->{'apiimportcache'}->{$s_pdf} = $self->{'apiimportcache'}->{$s_pdf} || {}; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition50%1/2
$self->{'apiimportcache'}{$s_pdf} || {}
MC/DC0%0/1
$self->{'apiimportcache'}{$s_pdf} || {}
$self->{'apiimportcache'}{$s_pdf}
Truth table50%1/2
A
A= $self->{'apiimportcache'}{$s_pdf}
| |||||||||||||||||||||||||||||||||||||||||||||
| 1401 | |||||||||||||||||||||||||||||||||||||||||||||
| 1402 | # we now import into a form to keep | ||||||||||||||||||||||||||||||||||||||||||||
| 1403 | # all that nasty resources from polluting | ||||||||||||||||||||||||||||||||||||||||||||
| 1404 | # our very own resource naming space. | ||||||||||||||||||||||||||||||||||||||||||||
| 1405 | 1 | my $xo = $self->importPageIntoForm($s_pdf, $s_page); | |||||||||||||||||||||||||||||||||||||||||||
| 1406 | |||||||||||||||||||||||||||||||||||||||||||||
| 1407 | # copy all page dimensions | ||||||||||||||||||||||||||||||||||||||||||||
| 1408 | 1 | foreach my $k (qw(MediaBox ArtBox TrimBox BleedBox CropBox)) { | |||||||||||||||||||||||||||||||||||||||||||
| 1409 | 5 | my $prop = $s_page->find_prop($k); | |||||||||||||||||||||||||||||||||||||||||||
| 1410 | 5 | ▶ | next unless defined $prop; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1411 | |||||||||||||||||||||||||||||||||||||||||||||
| 1412 | 0 | my $box = walk_obj({}, $s_pdf->{'pdf'}, $self->{'pdf'}, $prop); | |||||||||||||||||||||||||||||||||||||||||||
| 1413 | 0 | my $method = lc $k; | |||||||||||||||||||||||||||||||||||||||||||
| 1414 | |||||||||||||||||||||||||||||||||||||||||||||
| 1415 | 0 | $t_page->$method(map { $_->val() } $box->elements()); | |||||||||||||||||||||||||||||||||||||||||||
| 1416 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1417 | |||||||||||||||||||||||||||||||||||||||||||||
| 1418 | 1 | $t_page->gfx->formimage($xo, 0, 0, 1); | |||||||||||||||||||||||||||||||||||||||||||
| 1419 | |||||||||||||||||||||||||||||||||||||||||||||
| 1420 | # copy annotations and/or form elements as well | ||||||||||||||||||||||||||||||||||||||||||||
| 1421 | 1 | ▶ | if (exists $s_page->{'Annots'} and $s_page->{'Annots'} and $self->{'copyannots'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
Condition33%2/6
exists $s_page->{"Annots"} and $s_page->{"Annots"} and $self->{"copyannots"}
exists $s_page->{"Annots"} and $s_page->{"Annots"}
MC/DC0%0/3
exists $s_page->{"Annots"} and $s_page->{"Annots"} and $self->{"copyannots"}
exists $s_page->{"Annots"}
$s_page->{"Annots"}
$self->{"copyannots"}
Truth table25%1/4
A and B and C
A= exists $s_page->{"Annots"}B= $s_page->{"Annots"}C= $self->{"copyannots"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 1422 | # first set up the AcroForm, if required | ||||||||||||||||||||||||||||||||||||||||||||
| 1423 | 0 | my $AcroForm; | |||||||||||||||||||||||||||||||||||||||||||
| 1424 | 0 | ▶ | if (my $a = $s_pdf->{'pdf'}->{'Root'}->realise->{'AcroForm'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1425 | 0 | $a->realise(); | |||||||||||||||||||||||||||||||||||||||||||
| 1426 | |||||||||||||||||||||||||||||||||||||||||||||
| 1427 | 0 | $AcroForm = walk_obj({}, $s_pdf->{'pdf'}, $self->{'pdf'}, $a, qw(NeedAppearances SigFlags CO DR DA Q)); | |||||||||||||||||||||||||||||||||||||||||||
| 1428 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1429 | 0 | my @Fields = (); | |||||||||||||||||||||||||||||||||||||||||||
| 1430 | 0 | my @Annots = (); | |||||||||||||||||||||||||||||||||||||||||||
| 1431 | 0 | foreach my $a ($s_page->{'Annots'}->elements()) { | |||||||||||||||||||||||||||||||||||||||||||
| 1432 | 0 | $a->realise(); | |||||||||||||||||||||||||||||||||||||||||||
| 1433 | 0 | my $t_a = PDFDict(); | |||||||||||||||||||||||||||||||||||||||||||
| 1434 | 0 | $self->{'pdf'}->new_obj($t_a); | |||||||||||||||||||||||||||||||||||||||||||
| 1435 | # these objects are likely to be both annotations and Acroform fields | ||||||||||||||||||||||||||||||||||||||||||||
| 1436 | # key names are copied from PDF Reference 1.4 (Tables) | ||||||||||||||||||||||||||||||||||||||||||||
| 1437 | 0 | my @k = ( | |||||||||||||||||||||||||||||||||||||||||||
| 1438 | qw( Type Subtype Contents P Rect NM M F BS Border AP AS C CA T Popup A AA StructParent Rotate | ||||||||||||||||||||||||||||||||||||||||||||
| 1439 | ), # Annotations - Common (8.10) | ||||||||||||||||||||||||||||||||||||||||||||
| 1440 | qw( Subtype Contents Open Name ), # Text Annotations (8.15) | ||||||||||||||||||||||||||||||||||||||||||||
| 1441 | qw( Subtype Contents Dest H PA ), # Link Annotations (8.16) | ||||||||||||||||||||||||||||||||||||||||||||
| 1442 | qw( Subtype Contents DA Q ), # Free Text Annotations (8.17) | ||||||||||||||||||||||||||||||||||||||||||||
| 1443 | qw( Subtype Contents L BS LE IC ) , # Line Annotations (8.18) | ||||||||||||||||||||||||||||||||||||||||||||
| 1444 | qw( Subtype Contents BS IC ), # Square and Circle Annotations (8.20) | ||||||||||||||||||||||||||||||||||||||||||||
| 1445 | qw( Subtype Contents QuadPoints ), # Markup Annotations (8.21) | ||||||||||||||||||||||||||||||||||||||||||||
| 1446 | qw( Subtype Contents Name ), # Rubber Stamp Annotations (8.22) | ||||||||||||||||||||||||||||||||||||||||||||
| 1447 | qw( Subtype Contents InkList BS ), # Ink Annotations (8.23) | ||||||||||||||||||||||||||||||||||||||||||||
| 1448 | qw( Subtype Contents Parent Open ), # Popup Annotations (8.24) | ||||||||||||||||||||||||||||||||||||||||||||
| 1449 | qw( Subtype FS Contents Name ), # File Attachment Annotations (8.25) | ||||||||||||||||||||||||||||||||||||||||||||
| 1450 | qw( Subtype Sound Contents Name ), # Sound Annotations (8.26) | ||||||||||||||||||||||||||||||||||||||||||||
| 1451 | qw( Subtype Movie Contents A ), # Movie Annotations (8.27) | ||||||||||||||||||||||||||||||||||||||||||||
| 1452 | qw( Subtype Contents H MK ), # Widget Annotations (8.28) | ||||||||||||||||||||||||||||||||||||||||||||
| 1453 | # Printers Mark Annotations (none) | ||||||||||||||||||||||||||||||||||||||||||||
| 1454 | # Trap Network Annotations (none) | ||||||||||||||||||||||||||||||||||||||||||||
| 1455 | ); | ||||||||||||||||||||||||||||||||||||||||||||
| 1456 | |||||||||||||||||||||||||||||||||||||||||||||
| 1457 | 0 | ▶ | push @k, ( | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1458 | qw( Subtype FT Parent Kids T TU TM Ff V DV AA | ||||||||||||||||||||||||||||||||||||||||||||
| 1459 | ), # Fields - Common (8.49) | ||||||||||||||||||||||||||||||||||||||||||||
| 1460 | qw( DR DA Q ), # Fields containing variable text (8.51) | ||||||||||||||||||||||||||||||||||||||||||||
| 1461 | qw( Opt ), # Checkbox field (8.54) | ||||||||||||||||||||||||||||||||||||||||||||
| 1462 | qw( Opt ), # Radio field (8.55) | ||||||||||||||||||||||||||||||||||||||||||||
| 1463 | qw( MaxLen ), # Text field (8.57) | ||||||||||||||||||||||||||||||||||||||||||||
| 1464 | qw( Opt TI I ), # Choice field (8.59) | ||||||||||||||||||||||||||||||||||||||||||||
| 1465 | ) if $AcroForm; | ||||||||||||||||||||||||||||||||||||||||||||
| 1466 | |||||||||||||||||||||||||||||||||||||||||||||
| 1467 | # sorting out dups | ||||||||||||||||||||||||||||||||||||||||||||
| 1468 | 0 | my %ky = map { $_ => 1 } @k; | |||||||||||||||||||||||||||||||||||||||||||
| 1469 | # we do P separately, as it points to the page the Annotation is on | ||||||||||||||||||||||||||||||||||||||||||||
| 1470 | 0 | delete $ky{'P'}; | |||||||||||||||||||||||||||||||||||||||||||
| 1471 | # copy everything else | ||||||||||||||||||||||||||||||||||||||||||||
| 1472 | 0 | foreach my $k (keys %ky) { | |||||||||||||||||||||||||||||||||||||||||||
| 1473 | 0 | ▶ | next unless defined $a->{$k}; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1474 | 0 | $a->{$k}->realise(); | |||||||||||||||||||||||||||||||||||||||||||
| 1475 | 0 | $t_a->{$k} = walk_obj({}, $s_pdf->{'pdf'}, $self->{'pdf'}, $a->{$k}); | |||||||||||||||||||||||||||||||||||||||||||
| 1476 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1477 | 0 | $t_a->{'P'} = $t_page; | |||||||||||||||||||||||||||||||||||||||||||
| 1478 | 0 | push @Annots, $t_a; | |||||||||||||||||||||||||||||||||||||||||||
| 1479 | 0 | ▶ | push @Fields, $t_a if ($AcroForm and $t_a->{'Subtype'}->val() eq 'Widget'); | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
Condition0%0/3
$AcroForm and $t_a->{"Subtype"}->val eq "Widget"
MC/DC0%0/2
$AcroForm and $t_a->{"Subtype"}->val eq "Widget"
$AcroForm
$t_a->{"Subtype"}->val eq "Widget"
Truth table0%0/3
A and B
A= $AcroFormB= $t_a->{"Subtype"}->val eq "Widget"
| |||||||||||||||||||||||||||||||||||||||||||||
| 1480 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1481 | 0 | $t_page->{'Annots'} = PDFArray(@Annots); | |||||||||||||||||||||||||||||||||||||||||||
| 1482 | 0 | ▶ | $AcroForm->{'Fields'} = PDFArray(@Fields) if $AcroForm; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1483 | 0 | $self->{'pdf'}->{'Root'}->{'AcroForm'} = $AcroForm; | |||||||||||||||||||||||||||||||||||||||||||
| 1484 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1485 | 1 | $t_page->{' imported'} = 1; | |||||||||||||||||||||||||||||||||||||||||||
| 1486 | |||||||||||||||||||||||||||||||||||||||||||||
| 1487 | 1 | $self->{'pdf'}->out_obj($t_page); | |||||||||||||||||||||||||||||||||||||||||||
| 1488 | 1 | $self->{'pdf'}->out_obj($self->{'pages'}); | |||||||||||||||||||||||||||||||||||||||||||
| 1489 | |||||||||||||||||||||||||||||||||||||||||||||
| 1490 | 1 | return $t_page; | |||||||||||||||||||||||||||||||||||||||||||
| 1491 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1492 | |||||||||||||||||||||||||||||||||||||||||||||
| 1493 | =head2 embed_page | ||||||||||||||||||||||||||||||||||||||||||||
| 1494 | |||||||||||||||||||||||||||||||||||||||||||||
| 1495 | $xobject = $pdf->embed_page($source_pdf, $source_page_number); | ||||||||||||||||||||||||||||||||||||||||||||
| 1496 | |||||||||||||||||||||||||||||||||||||||||||||
| 1497 | Returns a Form XObject created by extracting the specified page from a | ||||||||||||||||||||||||||||||||||||||||||||
| 1498 | C<$source_pdf>. | ||||||||||||||||||||||||||||||||||||||||||||
| 1499 | |||||||||||||||||||||||||||||||||||||||||||||
| 1500 | This is useful if you want to transpose the imported page somewhat differently | ||||||||||||||||||||||||||||||||||||||||||||
| 1501 | onto a page (e.g. two-up, four-up, etc.). | ||||||||||||||||||||||||||||||||||||||||||||
| 1502 | |||||||||||||||||||||||||||||||||||||||||||||
| 1503 | If $source_page_number is 0 or -1, it will return the last page in the document. | ||||||||||||||||||||||||||||||||||||||||||||
| 1504 | |||||||||||||||||||||||||||||||||||||||||||||
| 1505 | B<Example:> | ||||||||||||||||||||||||||||||||||||||||||||
| 1506 | |||||||||||||||||||||||||||||||||||||||||||||
| 1507 | my $pdf = PDF::API2->new(); | ||||||||||||||||||||||||||||||||||||||||||||
| 1508 | my $source = PDF::API2->open('source.pdf'); | ||||||||||||||||||||||||||||||||||||||||||||
| 1509 | my $page = $pdf->page(); | ||||||||||||||||||||||||||||||||||||||||||||
| 1510 | |||||||||||||||||||||||||||||||||||||||||||||
| 1511 | # Import Page 2 from the source PDF | ||||||||||||||||||||||||||||||||||||||||||||
| 1512 | my $object = $pdf->embed_page($source, 2); | ||||||||||||||||||||||||||||||||||||||||||||
| 1513 | |||||||||||||||||||||||||||||||||||||||||||||
| 1514 | # Add it to the new PDF's first page at 1/2 scale | ||||||||||||||||||||||||||||||||||||||||||||
| 1515 | my ($x, $y) = (0, 0); | ||||||||||||||||||||||||||||||||||||||||||||
| 1516 | $page->object($object, $x, $y, 0.5); | ||||||||||||||||||||||||||||||||||||||||||||
| 1517 | |||||||||||||||||||||||||||||||||||||||||||||
| 1518 | $pdf->save('sample.pdf'); | ||||||||||||||||||||||||||||||||||||||||||||
| 1519 | |||||||||||||||||||||||||||||||||||||||||||||
| 1520 | B<Note:> You can only import a page from an existing PDF file. | ||||||||||||||||||||||||||||||||||||||||||||
| 1521 | |||||||||||||||||||||||||||||||||||||||||||||
| 1522 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 1523 | |||||||||||||||||||||||||||||||||||||||||||||
| 1524 | # Deprecated (renamed) | ||||||||||||||||||||||||||||||||||||||||||||
| 1525 | 4 | ▶ | sub importPageIntoForm { return embed_page(@_) } | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
importPageIntoForm: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 1526 | |||||||||||||||||||||||||||||||||||||||||||||
| 1527 | sub embed_page { | ||||||||||||||||||||||||||||||||||||||||||||
| 1528 | 4 | ▶ | my ($self, $s_pdf, $s_idx) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
embed_page: called CC=22 SCAR=32.0
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 1529 | 4 | ▶ | $s_idx ||= 0; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition50%1/2
$s_idx ||= 0
MC/DC0%0/1
$s_idx ||= 0
$s_idx
Truth table50%1/2
A
A= $s_idx
| |||||||||||||||||||||||||||||||||||||||||||||
| 1530 | |||||||||||||||||||||||||||||||||||||||||||||
| 1531 | 4 | ▶ | unless (ref($s_pdf) and $s_pdf->isa('PDF::API2')) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
Condition33%1/3
ref $s_pdf and $s_pdf->isa("PDF::API2")
MC/DC0%0/2
ref $s_pdf and $s_pdf->isa("PDF::API2")
ref $s_pdf
$s_pdf->isa("PDF::API2")
Truth table33%1/3
A and B
A= ref $s_pdfB= $s_pdf->isa("PDF::API2")
| |||||||||||||||||||||||||||||||||||||||||||||
| 1532 | 0 | die "Invalid usage: first argument must be PDF::API2 instance, not: " . ref($s_pdf); | |||||||||||||||||||||||||||||||||||||||||||
| 1533 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1534 | |||||||||||||||||||||||||||||||||||||||||||||
| 1535 | 4 | my ($s_page, $xo); | |||||||||||||||||||||||||||||||||||||||||||
| 1536 | |||||||||||||||||||||||||||||||||||||||||||||
| 1537 | 4 | $xo = $self->xo_form(); | |||||||||||||||||||||||||||||||||||||||||||
| 1538 | |||||||||||||||||||||||||||||||||||||||||||||
| 1539 | 4 | ▶ | if (ref($s_idx) eq 'PDF::API2::Page') { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1540 | 1 | $s_page = $s_idx; | |||||||||||||||||||||||||||||||||||||||||||
| 1541 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1542 | else { | ||||||||||||||||||||||||||||||||||||||||||||
| 1543 | 3 | $s_page = $s_pdf->open_page($s_idx); | |||||||||||||||||||||||||||||||||||||||||||
| 1544 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1545 | |||||||||||||||||||||||||||||||||||||||||||||
| 1546 | 4 | ▶ | $self->{'apiimportcache'} ||= {}; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition100%2/2
$self->{"apiimportcache"} ||= {}
MC/DC100%1/1
$self->{"apiimportcache"} ||= {}
$self->{"apiimportcache"}
Truth table100%2/2
A
A= $self->{"apiimportcache"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 1547 | 4 | ▶ | $self->{'apiimportcache'}->{$s_pdf} ||= {}; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition100%2/2
$self->{"apiimportcache"}{$s_pdf} ||= {}
MC/DC100%1/1
$self->{"apiimportcache"}{$s_pdf} ||= {}
$self->{"apiimportcache"}{$s_pdf}
Truth table100%2/2
A
A= $self->{"apiimportcache"}{$s_pdf}
| |||||||||||||||||||||||||||||||||||||||||||||
| 1548 | |||||||||||||||||||||||||||||||||||||||||||||
| 1549 | # This should never get past MediaBox, since it's a required object. | ||||||||||||||||||||||||||||||||||||||||||||
| 1550 | 4 | foreach my $k (qw(MediaBox ArtBox TrimBox BleedBox CropBox)) { | |||||||||||||||||||||||||||||||||||||||||||
| 1551 | # next unless defined $s_page->{$k}; | ||||||||||||||||||||||||||||||||||||||||||||
| 1552 | # my $box = walk_obj($self->{'apiimportcache'}->{$s_pdf}, $s_pdf->{'pdf'}, $self->{'pdf'}, $s_page->{$k}); | ||||||||||||||||||||||||||||||||||||||||||||
| 1553 | 12 | ▶ | next unless defined $s_page->find_prop($k); | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1554 | 2 | my $box = walk_obj($self->{'apiimportcache'}->{$s_pdf}, $s_pdf->{'pdf'}, $self->{'pdf'}, $s_page->find_prop($k)); | |||||||||||||||||||||||||||||||||||||||||||
| 1555 | 2 | $xo->bbox(map { $_->val() } $box->elements()); | |||||||||||||||||||||||||||||||||||||||||||
| 1556 | 2 | last; | |||||||||||||||||||||||||||||||||||||||||||
| 1557 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1558 | 4 | ▶ | $xo->bbox(0, 0, 612, 792) unless defined $xo->{'BBox'}; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1559 | |||||||||||||||||||||||||||||||||||||||||||||
| 1560 | 4 | foreach my $k (qw(Resources)) { | |||||||||||||||||||||||||||||||||||||||||||
| 1561 | 4 | $s_page->{$k} = $s_page->find_prop($k); | |||||||||||||||||||||||||||||||||||||||||||
| 1562 | 4 | ▶ | next unless defined $s_page->{$k}; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1563 | 4 | ▶ | $s_page->{$k}->realise() if ref($s_page->{$k}) =~ /Objind$/; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1564 | |||||||||||||||||||||||||||||||||||||||||||||
| 1565 | 4 | foreach my $sk (qw(XObject ExtGState Font ProcSet Properties ColorSpace Pattern Shading)) { | |||||||||||||||||||||||||||||||||||||||||||
| 1566 | 32 | ▶ | next unless defined $s_page->{$k}->{$sk}; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1567 | 5 | ▶ | $s_page->{$k}->{$sk}->realise() if ref($s_page->{$k}->{$sk}) =~ /Objind$/; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1568 | 5 | foreach my $ssk (keys %{$s_page->{$k}->{$sk}}) { | |||||||||||||||||||||||||||||||||||||||||||
| 1569 | 10 | ▶ | next if $ssk =~ /^ /; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1570 | 1 | $xo->resource($sk, $ssk, walk_obj($self->{'apiimportcache'}->{$s_pdf}, $s_pdf->{'pdf'}, $self->{'pdf'}, $s_page->{$k}->{$sk}->{$ssk})); | |||||||||||||||||||||||||||||||||||||||||||
| 1571 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1572 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1573 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1574 | |||||||||||||||||||||||||||||||||||||||||||||
| 1575 | # create a whole content stream | ||||||||||||||||||||||||||||||||||||||||||||
| 1576 | ## technically it is possible to submit an unfinished | ||||||||||||||||||||||||||||||||||||||||||||
| 1577 | ## (eg. newly created) source-page, but that's nonsense, | ||||||||||||||||||||||||||||||||||||||||||||
| 1578 | ## so we expect a page fixed by open_page and die otherwise | ||||||||||||||||||||||||||||||||||||||||||||
| 1579 | 4 | ▶ | unless ($s_page->{' opened'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1580 | 0 | croak join(' ', | |||||||||||||||||||||||||||||||||||||||||||
| 1581 | "Pages may only be imported from a complete PDF.", | ||||||||||||||||||||||||||||||||||||||||||||
| 1582 | "Save and reopen the source PDF object first"); | ||||||||||||||||||||||||||||||||||||||||||||
| 1583 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1584 | |||||||||||||||||||||||||||||||||||||||||||||
| 1585 | 4 | ▶ | if (defined $s_page->{'Contents'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1586 | 3 | $s_page->fixcontents(); | |||||||||||||||||||||||||||||||||||||||||||
| 1587 | |||||||||||||||||||||||||||||||||||||||||||||
| 1588 | 3 | $xo->{' stream'} = ''; | |||||||||||||||||||||||||||||||||||||||||||
| 1589 | # open_page pages only contain one stream | ||||||||||||||||||||||||||||||||||||||||||||
| 1590 | 3 | my ($k) = $s_page->{'Contents'}->elements(); | |||||||||||||||||||||||||||||||||||||||||||
| 1591 | 3 | $k->realise(); | |||||||||||||||||||||||||||||||||||||||||||
| 1592 | 3 | ▶ | if ($k->{' nofilt'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1593 | # we have a finished stream here so we unfilter | ||||||||||||||||||||||||||||||||||||||||||||
| 1594 | 3 | $xo->add('q', unfilter($k->{'Filter'}, $k->{' stream'}), 'Q'); | |||||||||||||||||||||||||||||||||||||||||||
| 1595 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1596 | else { | ||||||||||||||||||||||||||||||||||||||||||||
| 1597 | # stream is an unfinished/unfiltered content | ||||||||||||||||||||||||||||||||||||||||||||
| 1598 | # so we just copy it and add the required "qQ" | ||||||||||||||||||||||||||||||||||||||||||||
| 1599 | 0 | $xo->add('q', $k->{' stream'}, 'Q'); | |||||||||||||||||||||||||||||||||||||||||||
| 1600 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1601 | 3 | ▶ | $xo->compressFlate() if $self->{'forcecompress'}; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1602 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1603 | |||||||||||||||||||||||||||||||||||||||||||||
| 1604 | 4 | return $xo; | |||||||||||||||||||||||||||||||||||||||||||
| 1605 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1606 | |||||||||||||||||||||||||||||||||||||||||||||
| 1607 | # Used by embed_page and import_page | ||||||||||||||||||||||||||||||||||||||||||||
| 1608 | sub walk_obj { | ||||||||||||||||||||||||||||||||||||||||||||
| 1609 | 16 | ▶ | my ($object_cache, $source_pdf, $target_pdf, $source_object, @keys) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
walk_obj: called CC=14 SCAR=28.4
Pod
undocumented
| |||||||||||||||||||||||||||||||||||||||||||||
| 1610 | |||||||||||||||||||||||||||||||||||||||||||||
| 1611 | 16 | ▶ | if (ref($source_object) =~ /Objind$/) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1612 | 1 | $source_object->realise(); | |||||||||||||||||||||||||||||||||||||||||||
| 1613 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1614 | |||||||||||||||||||||||||||||||||||||||||||||
| 1615 | 16 | ▶ | return $object_cache->{scalar $source_object} if defined $object_cache->{scalar $source_object}; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1616 | # die "infinite loop while copying objects" if $source_object->{' copied'}; | ||||||||||||||||||||||||||||||||||||||||||||
| 1617 | |||||||||||||||||||||||||||||||||||||||||||||
| 1618 | 16 | my $target_object = $source_object->copy($source_pdf); ## thanks to: yaheath // Fri, 17 Sep 2004 | |||||||||||||||||||||||||||||||||||||||||||
| 1619 | |||||||||||||||||||||||||||||||||||||||||||||
| 1620 | # $source_object->{' copied'} = 1; | ||||||||||||||||||||||||||||||||||||||||||||
| 1621 | 16 | ▶ | $target_pdf->new_obj($target_object) if $source_object->is_obj($source_pdf); | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1622 | |||||||||||||||||||||||||||||||||||||||||||||
| 1623 | 16 | $object_cache->{scalar $source_object} = $target_object; | |||||||||||||||||||||||||||||||||||||||||||
| 1624 | |||||||||||||||||||||||||||||||||||||||||||||
| 1625 | 16 | ▶ | if (ref($source_object) =~ /Array$/) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 2 branches
| |||||||||||||||||||||||||||||||||||||||||||||
| 1626 | 2 | $target_object->{' val'} = []; | |||||||||||||||||||||||||||||||||||||||||||
| 1627 | 2 | foreach my $k ($source_object->elements()) { | |||||||||||||||||||||||||||||||||||||||||||
| 1628 | 8 | ▶ | $k->realise() if ref($k) =~ /Objind$/; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1629 | 8 | $target_object->add_elements(walk_obj($object_cache, $source_pdf, $target_pdf, $k)); | |||||||||||||||||||||||||||||||||||||||||||
| 1630 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1631 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1632 | elsif (ref($source_object) =~ /Dict$/) { | ||||||||||||||||||||||||||||||||||||||||||||
| 1633 | 1 | ▶ | @keys = keys(%$target_object) unless scalar @keys; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1634 | 1 | foreach my $k (@keys) { | |||||||||||||||||||||||||||||||||||||||||||
| 1635 | 6 | ▶ | next if $k =~ /^ /; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1636 | 5 | ▶ | next unless defined $source_object->{$k}; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1637 | 5 | $target_object->{$k} = walk_obj($object_cache, $source_pdf, $target_pdf, $source_object->{$k}); | |||||||||||||||||||||||||||||||||||||||||||
| 1638 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1639 | 1 | ▶ | if ($source_object->{' stream'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1640 | 0 | ▶ | if ($target_object->{'Filter'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1641 | 0 | $target_object->{' nofilt'} = 1; | |||||||||||||||||||||||||||||||||||||||||||
| 1642 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1643 | else { | ||||||||||||||||||||||||||||||||||||||||||||
| 1644 | 0 | delete $target_object->{' nofilt'}; | |||||||||||||||||||||||||||||||||||||||||||
| 1645 | 0 | $target_object->{'Filter'} = PDFArray(PDFName('FlateDecode')); | |||||||||||||||||||||||||||||||||||||||||||
| 1646 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1647 | 0 | $target_object->{' stream'} = $source_object->{' stream'}; | |||||||||||||||||||||||||||||||||||||||||||
| 1648 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1649 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1650 | 16 | delete $target_object->{' streamloc'}; | |||||||||||||||||||||||||||||||||||||||||||
| 1651 | 16 | delete $target_object->{' streamsrc'}; | |||||||||||||||||||||||||||||||||||||||||||
| 1652 | |||||||||||||||||||||||||||||||||||||||||||||
| 1653 | 16 | return $target_object; | |||||||||||||||||||||||||||||||||||||||||||
| 1654 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1655 | |||||||||||||||||||||||||||||||||||||||||||||
| 1656 | =head2 page_count | ||||||||||||||||||||||||||||||||||||||||||||
| 1657 | |||||||||||||||||||||||||||||||||||||||||||||
| 1658 | $integer = $pdf->page_count(); | ||||||||||||||||||||||||||||||||||||||||||||
| 1659 | |||||||||||||||||||||||||||||||||||||||||||||
| 1660 | Return the number of pages in the document. | ||||||||||||||||||||||||||||||||||||||||||||
| 1661 | |||||||||||||||||||||||||||||||||||||||||||||
| 1662 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 1663 | |||||||||||||||||||||||||||||||||||||||||||||
| 1664 | # Deprecated (renamed) | ||||||||||||||||||||||||||||||||||||||||||||
| 1665 | 3 | ▶ | sub pages { return page_count(@_) } | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
pages: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 1666 | |||||||||||||||||||||||||||||||||||||||||||||
| 1667 | sub page_count { | ||||||||||||||||||||||||||||||||||||||||||||
| 1668 | 3 | ▶ | my $self = shift(); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
page_count: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 1669 | 3 | return scalar @{$self->{'pagestack'}}; | |||||||||||||||||||||||||||||||||||||||||||
| 1670 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1671 | |||||||||||||||||||||||||||||||||||||||||||||
| 1672 | =head2 page_labels | ||||||||||||||||||||||||||||||||||||||||||||
| 1673 | |||||||||||||||||||||||||||||||||||||||||||||
| 1674 | $pdf = $pdf->page_labels($page_number, %options); | ||||||||||||||||||||||||||||||||||||||||||||
| 1675 | |||||||||||||||||||||||||||||||||||||||||||||
| 1676 | Describes how pages should be numbered beginning at the specified page number. | ||||||||||||||||||||||||||||||||||||||||||||
| 1677 | |||||||||||||||||||||||||||||||||||||||||||||
| 1678 | # Generate a 30-page PDF | ||||||||||||||||||||||||||||||||||||||||||||
| 1679 | my $pdf = PDF::API2->new(); | ||||||||||||||||||||||||||||||||||||||||||||
| 1680 | $pdf->page() for 1..30; | ||||||||||||||||||||||||||||||||||||||||||||
| 1681 | |||||||||||||||||||||||||||||||||||||||||||||
| 1682 | # Number pages i to v, 1 to 20, and A-1 to A-5, respectively | ||||||||||||||||||||||||||||||||||||||||||||
| 1683 | $pdf->page_labels(1, style => 'roman'); | ||||||||||||||||||||||||||||||||||||||||||||
| 1684 | $pdf->page_labels(6, style => 'decimal'); | ||||||||||||||||||||||||||||||||||||||||||||
| 1685 | $pdf->page_labels(26, style => 'decimal', prefix => 'A-'); | ||||||||||||||||||||||||||||||||||||||||||||
| 1686 | |||||||||||||||||||||||||||||||||||||||||||||
| 1687 | $pdf->save('sample.pdf'); | ||||||||||||||||||||||||||||||||||||||||||||
| 1688 | |||||||||||||||||||||||||||||||||||||||||||||
| 1689 | The following options are available: | ||||||||||||||||||||||||||||||||||||||||||||
| 1690 | |||||||||||||||||||||||||||||||||||||||||||||
| 1691 | =over | ||||||||||||||||||||||||||||||||||||||||||||
| 1692 | |||||||||||||||||||||||||||||||||||||||||||||
| 1693 | =item * style | ||||||||||||||||||||||||||||||||||||||||||||
| 1694 | |||||||||||||||||||||||||||||||||||||||||||||
| 1695 | One of C<decimal> (standard decimal arabic numerals), C<Roman> (uppercase roman | ||||||||||||||||||||||||||||||||||||||||||||
| 1696 | numerals), C<roman> (lowercase roman numerals), C<Alpha> (uppercase letters), | ||||||||||||||||||||||||||||||||||||||||||||
| 1697 | or C<alpha> (lowercase letters). | ||||||||||||||||||||||||||||||||||||||||||||
| 1698 | |||||||||||||||||||||||||||||||||||||||||||||
| 1699 | There is no default numbering style. If omitted, the page label will be just | ||||||||||||||||||||||||||||||||||||||||||||
| 1700 | the prefix (if set) or an empty string. | ||||||||||||||||||||||||||||||||||||||||||||
| 1701 | |||||||||||||||||||||||||||||||||||||||||||||
| 1702 | =item * prefix | ||||||||||||||||||||||||||||||||||||||||||||
| 1703 | |||||||||||||||||||||||||||||||||||||||||||||
| 1704 | The label prefix for pages in this range. | ||||||||||||||||||||||||||||||||||||||||||||
| 1705 | |||||||||||||||||||||||||||||||||||||||||||||
| 1706 | =item * start | ||||||||||||||||||||||||||||||||||||||||||||
| 1707 | |||||||||||||||||||||||||||||||||||||||||||||
| 1708 | An integer (default: 1) representing the first value to be used in this page | ||||||||||||||||||||||||||||||||||||||||||||
| 1709 | range. | ||||||||||||||||||||||||||||||||||||||||||||
| 1710 | |||||||||||||||||||||||||||||||||||||||||||||
| 1711 | =back | ||||||||||||||||||||||||||||||||||||||||||||
| 1712 | |||||||||||||||||||||||||||||||||||||||||||||
| 1713 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 1714 | |||||||||||||||||||||||||||||||||||||||||||||
| 1715 | # Deprecated; replace with page_labels, updating arguments as shown | ||||||||||||||||||||||||||||||||||||||||||||
| 1716 | sub pageLabel { | ||||||||||||||||||||||||||||||||||||||||||||
| 1717 | 8 | ▶ | my $self = shift(); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
pageLabel: called CC=8 SCAR=20.8
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 1718 | 8 | ▶ | while (@_) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1719 | 8 | my $page_index = shift(); | |||||||||||||||||||||||||||||||||||||||||||
| 1720 | |||||||||||||||||||||||||||||||||||||||||||||
| 1721 | # Pass options as a hash rather than a hashref | ||||||||||||||||||||||||||||||||||||||||||||
| 1722 | 8 | ▶ | my %options = %{shift() // {}}; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition50%1/2
shift() // {}
MC/DC0%0/1
shift() // {}
shift()
Truth table50%1/2
A
A= shift()
| |||||||||||||||||||||||||||||||||||||||||||||
| 1723 | |||||||||||||||||||||||||||||||||||||||||||||
| 1724 | # Remove leading hyphens from option names | ||||||||||||||||||||||||||||||||||||||||||||
| 1725 | 8 | ▶ | if (exists $options{'-prefix'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1726 | 1 | $options{'prefix'} = delete $options{'-prefix'}; | |||||||||||||||||||||||||||||||||||||||||||
| 1727 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1728 | 8 | ▶ | if (exists $options{'-start'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1729 | 1 | $options{'start'} = delete $options{'-start'}; | |||||||||||||||||||||||||||||||||||||||||||
| 1730 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1731 | 8 | ▶ | if (exists $options{'-style'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1732 | 6 | $options{'style'} = delete $options{'-style'}; | |||||||||||||||||||||||||||||||||||||||||||
| 1733 | 6 | ▶ | unless ($options{'style'} =~ /^(?:[Rr]oman|[Aa]lpha|decimal)$/) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1734 | 1 | carp "Invalid -style for page labels; defaulting to decimal"; | |||||||||||||||||||||||||||||||||||||||||||
| 1735 | 1 | $options{'style'} = 'decimal'; | |||||||||||||||||||||||||||||||||||||||||||
| 1736 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1737 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1738 | |||||||||||||||||||||||||||||||||||||||||||||
| 1739 | # page_labels doesn't have a default numbering style, to be consistent | ||||||||||||||||||||||||||||||||||||||||||||
| 1740 | # with the spec. | ||||||||||||||||||||||||||||||||||||||||||||
| 1741 | 8 | ▶ | $options{'style'} //= 'D'; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition100%2/2
$options{"style"} //= "D"
MC/DC100%1/1
$options{"style"} //= "D"
$options{"style"}
Truth table100%2/2
A
A= $options{"style"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 1742 | |||||||||||||||||||||||||||||||||||||||||||||
| 1743 | # Set one set of page labels at a time (support for multiple sets of | ||||||||||||||||||||||||||||||||||||||||||||
| 1744 | # page labels by pageLabel was undocumented). Switch from 0-based to | ||||||||||||||||||||||||||||||||||||||||||||
| 1745 | # 1-based numbering. | ||||||||||||||||||||||||||||||||||||||||||||
| 1746 | 8 | $self->page_labels($page_index + 1, %options); | |||||||||||||||||||||||||||||||||||||||||||
| 1747 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1748 | |||||||||||||||||||||||||||||||||||||||||||||
| 1749 | # Return nothing (page_labels returns $self, matching other setters) | ||||||||||||||||||||||||||||||||||||||||||||
| 1750 | 8 | return; | |||||||||||||||||||||||||||||||||||||||||||
| 1751 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1752 | |||||||||||||||||||||||||||||||||||||||||||||
| 1753 | sub page_labels { | ||||||||||||||||||||||||||||||||||||||||||||
| 1754 | 8 | ▶ | my ($self, $page_number, %options) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
page_labels: called CC=11 SCAR=26.0
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 1755 | |||||||||||||||||||||||||||||||||||||||||||||
| 1756 | # $page_number is 1-based in order to be consistent with other PDF::API2 | ||||||||||||||||||||||||||||||||||||||||||||
| 1757 | # methods, but the page label numbering is 0-based. | ||||||||||||||||||||||||||||||||||||||||||||
| 1758 | 8 | my $page_index = $page_number - 1; | |||||||||||||||||||||||||||||||||||||||||||
| 1759 | |||||||||||||||||||||||||||||||||||||||||||||
| 1760 | 8 | ▶ | $self->{'catalog'}->{'PageLabels'} //= PDFDict(); | ||||||||||||||||||||||||||||||||||||||||||
|
Condition33%1/3
$self->{"catalog"}{"PageLabels"} //= PDFDict()
MC/DC0%0/2
$self->{"catalog"}{"PageLabels"} //= PDFDict()
$self->{"catalog"}{"PageLabels"}
PDFDict()
Truth table33%1/3
A //= B
A= $self->{"catalog"}{"PageLabels"}B= PDFDict()
| |||||||||||||||||||||||||||||||||||||||||||||
| 1761 | 8 | ▶ | $self->{'catalog'}->{'PageLabels'}->{'Nums'} //= PDFArray(); | ||||||||||||||||||||||||||||||||||||||||||
|
Condition33%1/3
$self->{"catalog"}{"PageLabels"}{"Nums"} //= PDFArray()
MC/DC0%0/2
$self->{"catalog"}{"PageLabels"}{"Nums"} //= PDFArray()
$self->{"catalog"}{"PageLabels"}{"Nums"}
PDFArray()
Truth table33%1/3
A //= B
A= $self->{"catalog"}{"PageLabels"}{"Nums"}B= PDFArray()
| |||||||||||||||||||||||||||||||||||||||||||||
| 1762 | |||||||||||||||||||||||||||||||||||||||||||||
| 1763 | 8 | my $nums = $self->{'catalog'}->{'PageLabels'}->{'Nums'}; | |||||||||||||||||||||||||||||||||||||||||||
| 1764 | 8 | $nums->add_elements(PDFNum($page_index)); | |||||||||||||||||||||||||||||||||||||||||||
| 1765 | |||||||||||||||||||||||||||||||||||||||||||||
| 1766 | 8 | my $d = PDFDict(); | |||||||||||||||||||||||||||||||||||||||||||
| 1767 | 8 | ▶ | if (exists $options{'style'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1768 | 8 | ▶ | unless ($options{'style'} and $options{'style'} =~ /^([rad])/i) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
Condition33%1/3
$options{"style"} and $options{"style"} =~ /^([rad])/i
MC/DC0%0/2
$options{"style"} and $options{"style"} =~ /^([rad])/i
$options{"style"}
$options{"style"} =~ /^([rad])/i
Truth table33%1/3
A and B
A= $options{"style"}B= $options{"style"} =~ /^([rad])/i
| |||||||||||||||||||||||||||||||||||||||||||||
| 1769 | 0 | croak 'Invalid page numbering style'; | |||||||||||||||||||||||||||||||||||||||||||
| 1770 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1771 | 8 | ▶ | $d->{'S'} = PDFName($1 eq 'd' ? 'D' : $1); | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1772 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1773 | |||||||||||||||||||||||||||||||||||||||||||||
| 1774 | 8 | ▶ | if (exists $options{'prefix'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1775 | 1 | ▶ | $d->{'P'} = PDFStr($options{'prefix'} // ''); | ||||||||||||||||||||||||||||||||||||||||||
|
Condition50%1/2
$options{"prefix"} // ""
MC/DC0%0/1
$options{"prefix"} // ""
$options{"prefix"}
Truth table50%1/2
A
A= $options{"prefix"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 1776 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1777 | |||||||||||||||||||||||||||||||||||||||||||||
| 1778 | 8 | ▶ | if (exists $options{'start'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1779 | 1 | ▶ | $d->{'St'} = PDFNum($options{'start'} // ''); | ||||||||||||||||||||||||||||||||||||||||||
|
Condition50%1/2
$options{"start"} // ""
MC/DC0%0/1
$options{"start"} // ""
$options{"start"}
Truth table50%1/2
A
A= $options{"start"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 1780 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1781 | |||||||||||||||||||||||||||||||||||||||||||||
| 1782 | 8 | $nums->add_elements($d); | |||||||||||||||||||||||||||||||||||||||||||
| 1783 | |||||||||||||||||||||||||||||||||||||||||||||
| 1784 | 8 | return $self; | |||||||||||||||||||||||||||||||||||||||||||
| 1785 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1786 | |||||||||||||||||||||||||||||||||||||||||||||
| 1787 | =head2 default_page_size | ||||||||||||||||||||||||||||||||||||||||||||
| 1788 | |||||||||||||||||||||||||||||||||||||||||||||
| 1789 | # Set | ||||||||||||||||||||||||||||||||||||||||||||
| 1790 | $pdf->default_page_size($size); | ||||||||||||||||||||||||||||||||||||||||||||
| 1791 | |||||||||||||||||||||||||||||||||||||||||||||
| 1792 | # Get | ||||||||||||||||||||||||||||||||||||||||||||
| 1793 | @rectangle = $pdf->default_page_size() | ||||||||||||||||||||||||||||||||||||||||||||
| 1794 | |||||||||||||||||||||||||||||||||||||||||||||
| 1795 | Set the default physical size for pages in the PDF. If called without | ||||||||||||||||||||||||||||||||||||||||||||
| 1796 | arguments, return the coordinates of the rectangle describing the default | ||||||||||||||||||||||||||||||||||||||||||||
| 1797 | physical page size. | ||||||||||||||||||||||||||||||||||||||||||||
| 1798 | |||||||||||||||||||||||||||||||||||||||||||||
| 1799 | See L<PDF::API2::Page/"Page Sizes"> for possible values. | ||||||||||||||||||||||||||||||||||||||||||||
| 1800 | |||||||||||||||||||||||||||||||||||||||||||||
| 1801 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 1802 | |||||||||||||||||||||||||||||||||||||||||||||
| 1803 | sub default_page_size { | ||||||||||||||||||||||||||||||||||||||||||||
| 1804 | 1 | ▶ | my $self = shift(); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
default_page_size: called CC=2 SCAR=9.2
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 1805 | |||||||||||||||||||||||||||||||||||||||||||||
| 1806 | # Set | ||||||||||||||||||||||||||||||||||||||||||||
| 1807 | 1 | ▶ | if (@_) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1808 | 1 | return $self->default_page_boundaries(media => @_); | |||||||||||||||||||||||||||||||||||||||||||
| 1809 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1810 | |||||||||||||||||||||||||||||||||||||||||||||
| 1811 | # Get | ||||||||||||||||||||||||||||||||||||||||||||
| 1812 | 0 | my $boundaries = $self->default_page_boundaries(); | |||||||||||||||||||||||||||||||||||||||||||
| 1813 | 0 | return @{$boundaries->{'media'}}; | |||||||||||||||||||||||||||||||||||||||||||
| 1814 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1815 | |||||||||||||||||||||||||||||||||||||||||||||
| 1816 | =head2 default_page_boundaries | ||||||||||||||||||||||||||||||||||||||||||||
| 1817 | |||||||||||||||||||||||||||||||||||||||||||||
| 1818 | # Set | ||||||||||||||||||||||||||||||||||||||||||||
| 1819 | $pdf->default_page_boundaries(%boundaries); | ||||||||||||||||||||||||||||||||||||||||||||
| 1820 | |||||||||||||||||||||||||||||||||||||||||||||
| 1821 | # Get | ||||||||||||||||||||||||||||||||||||||||||||
| 1822 | %boundaries = $pdf->default_page_boundaries(); | ||||||||||||||||||||||||||||||||||||||||||||
| 1823 | |||||||||||||||||||||||||||||||||||||||||||||
| 1824 | Set default prepress page boundaries for pages in the PDF. If called without | ||||||||||||||||||||||||||||||||||||||||||||
| 1825 | arguments, returns the coordinates of the rectangles describing each of the | ||||||||||||||||||||||||||||||||||||||||||||
| 1826 | supported page boundaries. | ||||||||||||||||||||||||||||||||||||||||||||
| 1827 | |||||||||||||||||||||||||||||||||||||||||||||
| 1828 | See the equivalent C<page_boundaries> method in L<PDF::API2::Page> for details. | ||||||||||||||||||||||||||||||||||||||||||||
| 1829 | |||||||||||||||||||||||||||||||||||||||||||||
| 1830 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 1831 | |||||||||||||||||||||||||||||||||||||||||||||
| 1832 | # Called by PDF::API2::Page::boundaries via the default_page_* methods below | ||||||||||||||||||||||||||||||||||||||||||||
| 1833 | sub _bounding_box { | ||||||||||||||||||||||||||||||||||||||||||||
| 1834 | 17 | ▶ | my $self = shift(); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
_bounding_box: called CC=5 SCAR=16.8
| |||||||||||||||||||||||||||||||||||||||||||||
| 1835 | 17 | my $type = shift(); | |||||||||||||||||||||||||||||||||||||||||||
| 1836 | |||||||||||||||||||||||||||||||||||||||||||||
| 1837 | # Get | ||||||||||||||||||||||||||||||||||||||||||||
| 1838 | 17 | ▶ | unless (scalar @_) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1839 | 6 | ▶ | unless ($self->{'pages'}->{$type}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1840 | 1 | ▶ | return if $type eq 'MediaBox'; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1841 | |||||||||||||||||||||||||||||||||||||||||||||
| 1842 | # Use defaults per PDF 1.7 section 14.11.2 Page Boundaries | ||||||||||||||||||||||||||||||||||||||||||||
| 1843 | 0 | ▶ | return $self->_bounding_box('MediaBox') if $type eq 'CropBox'; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1844 | 0 | return $self->_bounding_box('CropBox'); | |||||||||||||||||||||||||||||||||||||||||||
| 1845 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1846 | 5 | return map { $_->val() } $self->{'pages'}->{$type}->elements(); | |||||||||||||||||||||||||||||||||||||||||||
| 1847 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1848 | |||||||||||||||||||||||||||||||||||||||||||||
| 1849 | # Set | ||||||||||||||||||||||||||||||||||||||||||||
| 1850 | 11 | $self->{'pages'}->{$type} = PDFArray(map { PDFNum(float($_)) } @_); | |||||||||||||||||||||||||||||||||||||||||||
| 1851 | 11 | return $self; | |||||||||||||||||||||||||||||||||||||||||||
| 1852 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1853 | |||||||||||||||||||||||||||||||||||||||||||||
| 1854 | sub default_page_boundaries { | ||||||||||||||||||||||||||||||||||||||||||||
| 1855 | 3 | ▶ | return PDF::API2::Page::boundaries(@_); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
default_page_boundaries: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 1856 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1857 | |||||||||||||||||||||||||||||||||||||||||||||
| 1858 | # Deprecated; use default_page_size or default_page_boundaries | ||||||||||||||||||||||||||||||||||||||||||||
| 1859 | sub mediabox { | ||||||||||||||||||||||||||||||||||||||||||||
| 1860 | 5 | ▶ | my $self = shift(); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
mediabox: called CC=2 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 1861 | 5 | ▶ | return $self->_bounding_box('MediaBox') unless @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1862 | 3 | return $self->_bounding_box('MediaBox', page_size(@_)); | |||||||||||||||||||||||||||||||||||||||||||
| 1863 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1864 | |||||||||||||||||||||||||||||||||||||||||||||
| 1865 | # Deprecated; use default_page_boundaries | ||||||||||||||||||||||||||||||||||||||||||||
| 1866 | sub cropbox { | ||||||||||||||||||||||||||||||||||||||||||||
| 1867 | 1 | ▶ | my $self = shift(); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
cropbox: called CC=2 SCAR=7.1
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 1868 | 1 | ▶ | return $self->_bounding_box('CropBox') unless @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1869 | 1 | return $self->_bounding_box('CropBox', page_size(@_)); | |||||||||||||||||||||||||||||||||||||||||||
| 1870 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1871 | |||||||||||||||||||||||||||||||||||||||||||||
| 1872 | # Deprecated; use default_page_boundaries | ||||||||||||||||||||||||||||||||||||||||||||
| 1873 | sub bleedbox { | ||||||||||||||||||||||||||||||||||||||||||||
| 1874 | 1 | ▶ | my $self = shift(); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
bleedbox: called CC=2 SCAR=7.1
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 1875 | 1 | ▶ | return $self->_bounding_box('BleedBox') unless @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1876 | 1 | return $self->_bounding_box('BleedBox', page_size(@_)); | |||||||||||||||||||||||||||||||||||||||||||
| 1877 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1878 | |||||||||||||||||||||||||||||||||||||||||||||
| 1879 | # Deprecated; use default_page_boundaries | ||||||||||||||||||||||||||||||||||||||||||||
| 1880 | sub trimbox { | ||||||||||||||||||||||||||||||||||||||||||||
| 1881 | 1 | ▶ | my $self = shift(); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
trimbox: called CC=2 SCAR=7.1
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 1882 | 1 | ▶ | return $self->_bounding_box('TrimBox') unless @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1883 | 1 | return $self->_bounding_box('TrimBox', page_size(@_)); | |||||||||||||||||||||||||||||||||||||||||||
| 1884 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1885 | |||||||||||||||||||||||||||||||||||||||||||||
| 1886 | # Deprecated; use default_page_boundaries | ||||||||||||||||||||||||||||||||||||||||||||
| 1887 | sub artbox { | ||||||||||||||||||||||||||||||||||||||||||||
| 1888 | 1 | ▶ | my $self = shift(); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
artbox: called CC=2 SCAR=7.1
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 1889 | 1 | ▶ | return $self->_bounding_box('ArtBox') unless @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1890 | 1 | return $self->_bounding_box('ArtBox', page_size(@_)); | |||||||||||||||||||||||||||||||||||||||||||
| 1891 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1892 | |||||||||||||||||||||||||||||||||||||||||||||
| 1893 | =head1 FONT METHODS | ||||||||||||||||||||||||||||||||||||||||||||
| 1894 | |||||||||||||||||||||||||||||||||||||||||||||
| 1895 | =head2 font | ||||||||||||||||||||||||||||||||||||||||||||
| 1896 | |||||||||||||||||||||||||||||||||||||||||||||
| 1897 | my $font = $pdf->font($name, %options) | ||||||||||||||||||||||||||||||||||||||||||||
| 1898 | |||||||||||||||||||||||||||||||||||||||||||||
| 1899 | Add a font to the PDF. Returns the font object, to be used by | ||||||||||||||||||||||||||||||||||||||||||||
| 1900 | L<PDF::API2::Content>. | ||||||||||||||||||||||||||||||||||||||||||||
| 1901 | |||||||||||||||||||||||||||||||||||||||||||||
| 1902 | The font C<$name> is either the name of one of the L<standard 14 | ||||||||||||||||||||||||||||||||||||||||||||
| 1903 | fonts|PDF::API2::Resource::Font::CoreFont/"STANDARD FONTS"> (e.g. Helvetica) or | ||||||||||||||||||||||||||||||||||||||||||||
| 1904 | the path to a font file. | ||||||||||||||||||||||||||||||||||||||||||||
| 1905 | |||||||||||||||||||||||||||||||||||||||||||||
| 1906 | my $pdf = PDF::API2->new(); | ||||||||||||||||||||||||||||||||||||||||||||
| 1907 | my $font1 = $pdf->font('Helvetica-Bold'); | ||||||||||||||||||||||||||||||||||||||||||||
| 1908 | my $font2 = $pdf->font('/path/to/ComicSans.ttf'); | ||||||||||||||||||||||||||||||||||||||||||||
| 1909 | my $page = $pdf->page(); | ||||||||||||||||||||||||||||||||||||||||||||
| 1910 | my $content = $page->text(); | ||||||||||||||||||||||||||||||||||||||||||||
| 1911 | |||||||||||||||||||||||||||||||||||||||||||||
| 1912 | $content->position(1 * 72, 9 * 72); | ||||||||||||||||||||||||||||||||||||||||||||
| 1913 | $content->font($font1, 24); | ||||||||||||||||||||||||||||||||||||||||||||
| 1914 | $content->text('Hello, World!'); | ||||||||||||||||||||||||||||||||||||||||||||
| 1915 | |||||||||||||||||||||||||||||||||||||||||||||
| 1916 | $content->position(0, -36); | ||||||||||||||||||||||||||||||||||||||||||||
| 1917 | $content->font($font2, 12); | ||||||||||||||||||||||||||||||||||||||||||||
| 1918 | $content->text('This is some sample text.'); | ||||||||||||||||||||||||||||||||||||||||||||
| 1919 | |||||||||||||||||||||||||||||||||||||||||||||
| 1920 | $pdf->save('sample.pdf'); | ||||||||||||||||||||||||||||||||||||||||||||
| 1921 | |||||||||||||||||||||||||||||||||||||||||||||
| 1922 | The path can be omitted if the font file is in the current directory or one of | ||||||||||||||||||||||||||||||||||||||||||||
| 1923 | the directories returned by C<font_path>. | ||||||||||||||||||||||||||||||||||||||||||||
| 1924 | |||||||||||||||||||||||||||||||||||||||||||||
| 1925 | TrueType (ttf/otf), Adobe PostScript Type 1 (pfa/pfb), and Adobe Glyph Bitmap | ||||||||||||||||||||||||||||||||||||||||||||
| 1926 | Distribution Format (bdf) fonts are supported. | ||||||||||||||||||||||||||||||||||||||||||||
| 1927 | |||||||||||||||||||||||||||||||||||||||||||||
| 1928 | The following C<%options> are available: | ||||||||||||||||||||||||||||||||||||||||||||
| 1929 | |||||||||||||||||||||||||||||||||||||||||||||
| 1930 | =over | ||||||||||||||||||||||||||||||||||||||||||||
| 1931 | |||||||||||||||||||||||||||||||||||||||||||||
| 1932 | =item * format | ||||||||||||||||||||||||||||||||||||||||||||
| 1933 | |||||||||||||||||||||||||||||||||||||||||||||
| 1934 | The font format is normally detected automatically based on the file's | ||||||||||||||||||||||||||||||||||||||||||||
| 1935 | extension. If you're using a font with an atypical extension, you can set | ||||||||||||||||||||||||||||||||||||||||||||
| 1936 | C<format> to one of C<truetype> (TrueType or OpenType), C<type1> (PostScript | ||||||||||||||||||||||||||||||||||||||||||||
| 1937 | Type 1), or C<bitmap> (Adobe Bitmap). | ||||||||||||||||||||||||||||||||||||||||||||
| 1938 | |||||||||||||||||||||||||||||||||||||||||||||
| 1939 | =item * kerning | ||||||||||||||||||||||||||||||||||||||||||||
| 1940 | |||||||||||||||||||||||||||||||||||||||||||||
| 1941 | Kerning (automatic adjustment of space between pairs of characters) is enabled | ||||||||||||||||||||||||||||||||||||||||||||
| 1942 | by default if the font includes this information. Set this option to false to | ||||||||||||||||||||||||||||||||||||||||||||
| 1943 | disable. | ||||||||||||||||||||||||||||||||||||||||||||
| 1944 | |||||||||||||||||||||||||||||||||||||||||||||
| 1945 | =item * afm_file (PostScript Type 1 fonts only) | ||||||||||||||||||||||||||||||||||||||||||||
| 1946 | |||||||||||||||||||||||||||||||||||||||||||||
| 1947 | Specifies the location of the font metrics file. | ||||||||||||||||||||||||||||||||||||||||||||
| 1948 | |||||||||||||||||||||||||||||||||||||||||||||
| 1949 | =item * pfm_file (PostScript Type 1 fonts only) | ||||||||||||||||||||||||||||||||||||||||||||
| 1950 | |||||||||||||||||||||||||||||||||||||||||||||
| 1951 | Specifies the location of the printer font metrics file. This option overrides | ||||||||||||||||||||||||||||||||||||||||||||
| 1952 | the -encode option. | ||||||||||||||||||||||||||||||||||||||||||||
| 1953 | |||||||||||||||||||||||||||||||||||||||||||||
| 1954 | =item * embed (TrueType fonts only) | ||||||||||||||||||||||||||||||||||||||||||||
| 1955 | |||||||||||||||||||||||||||||||||||||||||||||
| 1956 | Fonts are embedded in the PDF by default, which is required to ensure that they | ||||||||||||||||||||||||||||||||||||||||||||
| 1957 | can be viewed properly on a device that doesn't have the font installed. Set | ||||||||||||||||||||||||||||||||||||||||||||
| 1958 | this option to false to prevent the font from being embedded. | ||||||||||||||||||||||||||||||||||||||||||||
| 1959 | |||||||||||||||||||||||||||||||||||||||||||||
| 1960 | =back | ||||||||||||||||||||||||||||||||||||||||||||
| 1961 | |||||||||||||||||||||||||||||||||||||||||||||
| 1962 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 1963 | |||||||||||||||||||||||||||||||||||||||||||||
| 1964 | sub font { | ||||||||||||||||||||||||||||||||||||||||||||
| 1965 | 1 | ▶ | my ($self, $name, %options) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
font: called CC=15 SCAR=50.5
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 1966 | |||||||||||||||||||||||||||||||||||||||||||||
| 1967 | 1 | ▶ | if (exists $options{'kerning'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1968 | 0 | $options{'-dokern'} = delete $options{'kerning'}; | |||||||||||||||||||||||||||||||||||||||||||
| 1969 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1970 | |||||||||||||||||||||||||||||||||||||||||||||
| 1971 | 1 | require PDF::API2::Resource::Font::CoreFont; | |||||||||||||||||||||||||||||||||||||||||||
| 1972 | 1 | ▶ | if (PDF::API2::Resource::Font::CoreFont->is_standard($name)) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1973 | 1 | return $self->corefont($name, %options); | |||||||||||||||||||||||||||||||||||||||||||
| 1974 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1975 | |||||||||||||||||||||||||||||||||||||||||||||
| 1976 | 0 | my $format = $options{'format'}; | |||||||||||||||||||||||||||||||||||||||||||
| 1977 | 0 | ▶ | $format //= ($name =~ /\.[ot]tf$/i ? 'truetype' : | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 3 branches
Condition0%0/3
$format //= $name =~ /\.[ot]tf$/i ? "truetype" : ($name =~ /\.pf[ab]$/i ? "type1" : ($name =~ /\.bdf$/i ? "bitmap" : ""))
MC/DC0%0/2
$format //= $name =~ /\.[ot]tf$/i ? "truetype" : ($name =~ /\.pf[ab]$/i ? "type1" : ($name =~ /\.bdf$/i ? "bitmap" : ""))
$format
$name =~ /\.[ot]tf$/i ? "truetype" : ($name =~ /\.pf[ab]$/i ? "type1" : ($name =~ /\.bdf$/i ? "bitmap" : ""))
Truth table0%0/3
A //= B
A= $formatB= $name =~ /\.[ot]tf$/i ? "truetype" : ($name =~ /\.pf[ab]$/i ? "type1" : ($name =~ /\.bdf$/i ? "bitmap" : ""))
| |||||||||||||||||||||||||||||||||||||||||||||
| 1978 | $name =~ /\.pf[ab]$/i ? 'type1' : | ||||||||||||||||||||||||||||||||||||||||||||
| 1979 | $name =~ /\.bdf$/i ? 'bitmap' : ''); | ||||||||||||||||||||||||||||||||||||||||||||
| 1980 | |||||||||||||||||||||||||||||||||||||||||||||
| 1981 | 0 | ▶ | if ($format eq 'truetype') { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 5 branches
| |||||||||||||||||||||||||||||||||||||||||||||
| 1982 | 0 | ▶ | $options{'embed'} //= 1; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition0%0/2
$options{"embed"} //= 1
MC/DC0%0/1
$options{"embed"} //= 1
$options{"embed"}
Truth table0%0/2
A
A= $options{"embed"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 1983 | 0 | return $self->ttfont($name, %options); | |||||||||||||||||||||||||||||||||||||||||||
| 1984 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1985 | elsif ($format eq 'type1') { | ||||||||||||||||||||||||||||||||||||||||||||
| 1986 | 0 | ▶ | if (exists $options{'afm_file'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1987 | 0 | $options{'-afmfile'} = delete $options{'afm_file'}; | |||||||||||||||||||||||||||||||||||||||||||
| 1988 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1989 | 0 | ▶ | if (exists $options{'pfm_file'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 1990 | 0 | $options{'-pfmfile'} = delete $options{'pfm_file'}; | |||||||||||||||||||||||||||||||||||||||||||
| 1991 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1992 | 0 | return $self->psfont($name, %options); | |||||||||||||||||||||||||||||||||||||||||||
| 1993 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1994 | elsif ($format eq 'bitmap') { | ||||||||||||||||||||||||||||||||||||||||||||
| 1995 | 0 | return $self->bdfont($name, %options); | |||||||||||||||||||||||||||||||||||||||||||
| 1996 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 1997 | elsif ($format) { | ||||||||||||||||||||||||||||||||||||||||||||
| 1998 | 0 | croak "Unrecognized font format: $format"; | |||||||||||||||||||||||||||||||||||||||||||
| 1999 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2000 | elsif ($name =~ /(\..*)$/) { | ||||||||||||||||||||||||||||||||||||||||||||
| 2001 | 0 | croak "Unrecognized font file extension: $1"; | |||||||||||||||||||||||||||||||||||||||||||
| 2002 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2003 | else { | ||||||||||||||||||||||||||||||||||||||||||||
| 2004 | 0 | croak "Unrecognized font: $name"; | |||||||||||||||||||||||||||||||||||||||||||
| 2005 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2006 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2007 | |||||||||||||||||||||||||||||||||||||||||||||
| 2008 | =head2 synthetic_font | ||||||||||||||||||||||||||||||||||||||||||||
| 2009 | |||||||||||||||||||||||||||||||||||||||||||||
| 2010 | $font = $pdf->synthetic_font($base_font, %options) | ||||||||||||||||||||||||||||||||||||||||||||
| 2011 | |||||||||||||||||||||||||||||||||||||||||||||
| 2012 | Create and return a new synthetic font object. See | ||||||||||||||||||||||||||||||||||||||||||||
| 2013 | L<PDF::API2::Resource::Font::SynFont> for details. | ||||||||||||||||||||||||||||||||||||||||||||
| 2014 | |||||||||||||||||||||||||||||||||||||||||||||
| 2015 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 2016 | |||||||||||||||||||||||||||||||||||||||||||||
| 2017 | # Deprecated (renamed) | ||||||||||||||||||||||||||||||||||||||||||||
| 2018 | 0 | ▶ | sub synfont { return synthetic_font(@_) } | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
synfont: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 2019 | |||||||||||||||||||||||||||||||||||||||||||||
| 2020 | sub synthetic_font { | ||||||||||||||||||||||||||||||||||||||||||||
| 2021 | 0 | ▶ | my ($self, $font, %opts) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
synthetic_font: not called CC=3 SCAR=24.8
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 2022 | |||||||||||||||||||||||||||||||||||||||||||||
| 2023 | # PDF::API2 doesn't set BaseEncoding for TrueType fonts, so text | ||||||||||||||||||||||||||||||||||||||||||||
| 2024 | # isn't searchable unless a ToUnicode CMap is included. Include | ||||||||||||||||||||||||||||||||||||||||||||
| 2025 | # the ToUnicode CMap by default, but allow it to be disabled (for | ||||||||||||||||||||||||||||||||||||||||||||
| 2026 | # performance and file size reasons) by setting -unicodemap to 0. | ||||||||||||||||||||||||||||||||||||||||||||
| 2027 | 0 | ▶ | $opts{-unicodemap} = 1 unless exists $opts{-unicodemap}; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 2028 | |||||||||||||||||||||||||||||||||||||||||||||
| 2029 | 0 | require PDF::API2::Resource::Font::SynFont; | |||||||||||||||||||||||||||||||||||||||||||
| 2030 | 0 | my $obj = PDF::API2::Resource::Font::SynFont->new($self->{'pdf'}, $font, %opts); | |||||||||||||||||||||||||||||||||||||||||||
| 2031 | |||||||||||||||||||||||||||||||||||||||||||||
| 2032 | 0 | $self->{'pdf'}->out_obj($self->{'pages'}); | |||||||||||||||||||||||||||||||||||||||||||
| 2033 | 0 | ▶ | $obj->tounicodemap() if $opts{-unicodemap}; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 2034 | |||||||||||||||||||||||||||||||||||||||||||||
| 2035 | 0 | return $obj; | |||||||||||||||||||||||||||||||||||||||||||
| 2036 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2037 | |||||||||||||||||||||||||||||||||||||||||||||
| 2038 | =head2 font_path | ||||||||||||||||||||||||||||||||||||||||||||
| 2039 | |||||||||||||||||||||||||||||||||||||||||||||
| 2040 | @directories = PDF::API2->font_path() | ||||||||||||||||||||||||||||||||||||||||||||
| 2041 | |||||||||||||||||||||||||||||||||||||||||||||
| 2042 | Return the list of directories that will be searched (in order) in addition to | ||||||||||||||||||||||||||||||||||||||||||||
| 2043 | the current directory when you add a font to a PDF without including the full | ||||||||||||||||||||||||||||||||||||||||||||
| 2044 | path to the font file. | ||||||||||||||||||||||||||||||||||||||||||||
| 2045 | |||||||||||||||||||||||||||||||||||||||||||||
| 2046 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 2047 | |||||||||||||||||||||||||||||||||||||||||||||
| 2048 | sub font_path { | ||||||||||||||||||||||||||||||||||||||||||||
| 2049 | 0 | ▶ | return @font_path; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
font_path: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 2050 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2051 | |||||||||||||||||||||||||||||||||||||||||||||
| 2052 | =head2 add_to_font_path | ||||||||||||||||||||||||||||||||||||||||||||
| 2053 | |||||||||||||||||||||||||||||||||||||||||||||
| 2054 | @directories = PDF::API2->add_to_font_path('/my/fonts', '/path/to/fonts'); | ||||||||||||||||||||||||||||||||||||||||||||
| 2055 | |||||||||||||||||||||||||||||||||||||||||||||
| 2056 | Add one or more directories to the list of paths to be searched for font files. | ||||||||||||||||||||||||||||||||||||||||||||
| 2057 | |||||||||||||||||||||||||||||||||||||||||||||
| 2058 | Returns the font search path. | ||||||||||||||||||||||||||||||||||||||||||||
| 2059 | |||||||||||||||||||||||||||||||||||||||||||||
| 2060 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 2061 | |||||||||||||||||||||||||||||||||||||||||||||
| 2062 | # Deprecated (renamed) | ||||||||||||||||||||||||||||||||||||||||||||
| 2063 | 0 | ▶ | sub addFontDirs { return add_to_font_path(@_) } | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
addFontDirs: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 2064 | |||||||||||||||||||||||||||||||||||||||||||||
| 2065 | sub add_to_font_path { | ||||||||||||||||||||||||||||||||||||||||||||
| 2066 | # Allow this method to be called using either :: or -> notation. | ||||||||||||||||||||||||||||||||||||||||||||
| 2067 | 0 | ▶ | shift() if ref($_[0]); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
add_to_font_path: not called CC=3 SCAR=24.8
Pod
documented
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 2068 | 0 | ▶ | shift() if $_[0] eq __PACKAGE__; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 2069 | |||||||||||||||||||||||||||||||||||||||||||||
| 2070 | 0 | push @font_path, @_; | |||||||||||||||||||||||||||||||||||||||||||
| 2071 | 0 | return @font_path; | |||||||||||||||||||||||||||||||||||||||||||
| 2072 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2073 | |||||||||||||||||||||||||||||||||||||||||||||
| 2074 | =head2 set_font_path | ||||||||||||||||||||||||||||||||||||||||||||
| 2075 | |||||||||||||||||||||||||||||||||||||||||||||
| 2076 | @directories = PDF::API2->set_font_path('/my/fonts', '/path/to/fonts'); | ||||||||||||||||||||||||||||||||||||||||||||
| 2077 | |||||||||||||||||||||||||||||||||||||||||||||
| 2078 | Replace the existing font search path. This should only be necessary if you | ||||||||||||||||||||||||||||||||||||||||||||
| 2079 | need to remove a directory from the path for some reason, or if you need to | ||||||||||||||||||||||||||||||||||||||||||||
| 2080 | reorder the list. | ||||||||||||||||||||||||||||||||||||||||||||
| 2081 | |||||||||||||||||||||||||||||||||||||||||||||
| 2082 | Returns the font search path. | ||||||||||||||||||||||||||||||||||||||||||||
| 2083 | |||||||||||||||||||||||||||||||||||||||||||||
| 2084 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 2085 | |||||||||||||||||||||||||||||||||||||||||||||
| 2086 | sub set_font_path { | ||||||||||||||||||||||||||||||||||||||||||||
| 2087 | # Allow this method to be called using either :: or -> notation. | ||||||||||||||||||||||||||||||||||||||||||||
| 2088 | 38 | ▶ | shift() if ref($_[0]); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
set_font_path: called CC=3 SCAR=11.3
Pod
documented
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 2089 | 38 | ▶ | shift() if $_[0] eq __PACKAGE__; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 2090 | |||||||||||||||||||||||||||||||||||||||||||||
| 2091 | 38 | @font_path = ((map { "$_/PDF/API2/fonts" } @INC), @_); | |||||||||||||||||||||||||||||||||||||||||||
| 2092 | |||||||||||||||||||||||||||||||||||||||||||||
| 2093 | 38 | return @font_path; | |||||||||||||||||||||||||||||||||||||||||||
| 2094 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2095 | |||||||||||||||||||||||||||||||||||||||||||||
| 2096 | sub _find_font { | ||||||||||||||||||||||||||||||||||||||||||||
| 2097 | 0 | ▶ | my $font = shift(); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
_find_font: not called CC=4 SCAR=30.0
| |||||||||||||||||||||||||||||||||||||||||||||
| 2098 | |||||||||||||||||||||||||||||||||||||||||||||
| 2099 | # Check the current directory | ||||||||||||||||||||||||||||||||||||||||||||
| 2100 | 0 | ▶ | return $font if -f $font; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 2101 | |||||||||||||||||||||||||||||||||||||||||||||
| 2102 | # Check the font search path | ||||||||||||||||||||||||||||||||||||||||||||
| 2103 | 0 | foreach my $directory (@font_path) { | |||||||||||||||||||||||||||||||||||||||||||
| 2104 | 0 | ▶ | return "$directory/$font" if -f "$directory/$font"; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 2105 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2106 | |||||||||||||||||||||||||||||||||||||||||||||
| 2107 | 0 | return; | |||||||||||||||||||||||||||||||||||||||||||
| 2108 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2109 | |||||||||||||||||||||||||||||||||||||||||||||
| 2110 | sub corefont { | ||||||||||||||||||||||||||||||||||||||||||||
| 2111 | 53 | ▶ | my ($self, $name, %opts) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
corefont: called CC=2 SCAR=7.0
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 2112 | 53 | require PDF::API2::Resource::Font::CoreFont; | |||||||||||||||||||||||||||||||||||||||||||
| 2113 | 53 | my $obj = PDF::API2::Resource::Font::CoreFont->new($self->{'pdf'}, $name, %opts); | |||||||||||||||||||||||||||||||||||||||||||
| 2114 | 53 | $self->{'pdf'}->out_obj($self->{'pages'}); | |||||||||||||||||||||||||||||||||||||||||||
| 2115 | 53 | ▶ | $obj->tounicodemap() if $opts{-unicodemap}; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 2116 | 53 | return $obj; | |||||||||||||||||||||||||||||||||||||||||||
| 2117 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2118 | |||||||||||||||||||||||||||||||||||||||||||||
| 2119 | sub psfont { | ||||||||||||||||||||||||||||||||||||||||||||
| 2120 | 0 | ▶ | my ($self, $psf, %opts) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
psfont: not called CC=5 SCAR=34.0
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 2121 | |||||||||||||||||||||||||||||||||||||||||||||
| 2122 | 0 | foreach my $o (qw(-afmfile -pfmfile)) { | |||||||||||||||||||||||||||||||||||||||||||
| 2123 | 0 | ▶ | next unless defined $opts{$o}; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 2124 | 0 | $opts{$o} = _find_font($opts{$o}); | |||||||||||||||||||||||||||||||||||||||||||
| 2125 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2126 | 0 | ▶ | $psf = _find_font($psf) or croak "Unable to find font \"$psf\""; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 2127 | 0 | require PDF::API2::Resource::Font::Postscript; | |||||||||||||||||||||||||||||||||||||||||||
| 2128 | 0 | my $obj = PDF::API2::Resource::Font::Postscript->new($self->{'pdf'}, $psf, %opts); | |||||||||||||||||||||||||||||||||||||||||||
| 2129 | |||||||||||||||||||||||||||||||||||||||||||||
| 2130 | 0 | $self->{'pdf'}->out_obj($self->{'pages'}); | |||||||||||||||||||||||||||||||||||||||||||
| 2131 | 0 | ▶ | $obj->tounicodemap() if $opts{-unicodemap}; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 2132 | |||||||||||||||||||||||||||||||||||||||||||||
| 2133 | 0 | return $obj; | |||||||||||||||||||||||||||||||||||||||||||
| 2134 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2135 | |||||||||||||||||||||||||||||||||||||||||||||
| 2136 | sub ttfont { | ||||||||||||||||||||||||||||||||||||||||||||
| 2137 | 0 | ▶ | my ($self, $name, %opts) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
ttfont: not called CC=7 SCAR=40.3
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 2138 | |||||||||||||||||||||||||||||||||||||||||||||
| 2139 | # PDF::API2 doesn't set BaseEncoding for TrueType fonts, so text | ||||||||||||||||||||||||||||||||||||||||||||
| 2140 | # isn't searchable unless a ToUnicode CMap is included. Include | ||||||||||||||||||||||||||||||||||||||||||||
| 2141 | # the ToUnicode CMap by default, but allow it to be disabled (for | ||||||||||||||||||||||||||||||||||||||||||||
| 2142 | # performance and file size reasons) by setting -unicodemap to 0. | ||||||||||||||||||||||||||||||||||||||||||||
| 2143 | 0 | ▶ | $opts{-unicodemap} = 1 unless exists $opts{-unicodemap}; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 2144 | |||||||||||||||||||||||||||||||||||||||||||||
| 2145 | # -noembed is deprecated (replace with embed => 0) | ||||||||||||||||||||||||||||||||||||||||||||
| 2146 | 0 | ▶ | if ($opts{'-noembed'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 2147 | 0 | ▶ | $opts{'embed'} //= 1; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition0%0/2
$opts{"embed"} //= 1
MC/DC0%0/1
$opts{"embed"} //= 1
$opts{"embed"}
Truth table0%0/2
A
A= $opts{"embed"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 2148 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2149 | 0 | ▶ | $opts{'embed'} //= 1; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition0%0/2
$opts{"embed"} //= 1
MC/DC0%0/1
$opts{"embed"} //= 1
$opts{"embed"}
Truth table0%0/2
A
A= $opts{"embed"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 2150 | |||||||||||||||||||||||||||||||||||||||||||||
| 2151 | 0 | ▶ | my $file = _find_font($name) or croak "Unable to find font \"$name\""; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 2152 | 0 | require PDF::API2::Resource::CIDFont::TrueType; | |||||||||||||||||||||||||||||||||||||||||||
| 2153 | 0 | my $obj = PDF::API2::Resource::CIDFont::TrueType->new($self->{'pdf'}, $file, %opts); | |||||||||||||||||||||||||||||||||||||||||||
| 2154 | |||||||||||||||||||||||||||||||||||||||||||||
| 2155 | 0 | $self->{'pdf'}->out_obj($self->{'pages'}); | |||||||||||||||||||||||||||||||||||||||||||
| 2156 | 0 | ▶ | $obj->tounicodemap() if $opts{-unicodemap}; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 2157 | |||||||||||||||||||||||||||||||||||||||||||||
| 2158 | 0 | return $obj; | |||||||||||||||||||||||||||||||||||||||||||
| 2159 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2160 | |||||||||||||||||||||||||||||||||||||||||||||
| 2161 | sub bdfont { | ||||||||||||||||||||||||||||||||||||||||||||
| 2162 | 0 | ▶ | my ($self, @opts) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
bdfont: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 2163 | |||||||||||||||||||||||||||||||||||||||||||||
| 2164 | 0 | require PDF::API2::Resource::Font::BdFont; | |||||||||||||||||||||||||||||||||||||||||||
| 2165 | 0 | my $obj = PDF::API2::Resource::Font::BdFont->new($self->{'pdf'}, @opts); | |||||||||||||||||||||||||||||||||||||||||||
| 2166 | |||||||||||||||||||||||||||||||||||||||||||||
| 2167 | 0 | $self->{'pdf'}->out_obj($self->{'pages'}); | |||||||||||||||||||||||||||||||||||||||||||
| 2168 | # $obj->tounicodemap(); # does not support Unicode | ||||||||||||||||||||||||||||||||||||||||||||
| 2169 | |||||||||||||||||||||||||||||||||||||||||||||
| 2170 | 0 | return $obj; | |||||||||||||||||||||||||||||||||||||||||||
| 2171 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2172 | |||||||||||||||||||||||||||||||||||||||||||||
| 2173 | # Deprecated. Use Unicode-supporting TrueType fonts instead. | ||||||||||||||||||||||||||||||||||||||||||||
| 2174 | # See PDF::API2::Resource::CIDFont::CJKFont for details. | ||||||||||||||||||||||||||||||||||||||||||||
| 2175 | sub cjkfont { | ||||||||||||||||||||||||||||||||||||||||||||
| 2176 | 1 | ▶ | my ($self, $name, %opts) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
cjkfont: called CC=2 SCAR=7.0
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 2177 | |||||||||||||||||||||||||||||||||||||||||||||
| 2178 | 1 | require PDF::API2::Resource::CIDFont::CJKFont; | |||||||||||||||||||||||||||||||||||||||||||
| 2179 | 1 | my $obj = PDF::API2::Resource::CIDFont::CJKFont->new($self->{'pdf'}, $name, %opts); | |||||||||||||||||||||||||||||||||||||||||||
| 2180 | |||||||||||||||||||||||||||||||||||||||||||||
| 2181 | 1 | $self->{'pdf'}->out_obj($self->{'pages'}); | |||||||||||||||||||||||||||||||||||||||||||
| 2182 | 1 | ▶ | $obj->tounicodemap() if $opts{-unicodemap}; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 2183 | |||||||||||||||||||||||||||||||||||||||||||||
| 2184 | 1 | return $obj; | |||||||||||||||||||||||||||||||||||||||||||
| 2185 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2186 | |||||||||||||||||||||||||||||||||||||||||||||
| 2187 | # Deprecated. Use Unicode-supporting TrueType fonts instead. | ||||||||||||||||||||||||||||||||||||||||||||
| 2188 | sub unifont { | ||||||||||||||||||||||||||||||||||||||||||||
| 2189 | 1 | ▶ | my ($self, @opts) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
unifont: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 2190 | |||||||||||||||||||||||||||||||||||||||||||||
| 2191 | 1 | require PDF::API2::Resource::UniFont; | |||||||||||||||||||||||||||||||||||||||||||
| 2192 | 1 | my $obj = PDF::API2::Resource::UniFont->new($self->{'pdf'}, @opts); | |||||||||||||||||||||||||||||||||||||||||||
| 2193 | |||||||||||||||||||||||||||||||||||||||||||||
| 2194 | 1 | return $obj; | |||||||||||||||||||||||||||||||||||||||||||
| 2195 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2196 | |||||||||||||||||||||||||||||||||||||||||||||
| 2197 | =head1 GRAPHICS METHODS | ||||||||||||||||||||||||||||||||||||||||||||
| 2198 | |||||||||||||||||||||||||||||||||||||||||||||
| 2199 | =head2 image | ||||||||||||||||||||||||||||||||||||||||||||
| 2200 | |||||||||||||||||||||||||||||||||||||||||||||
| 2201 | $object = $pdf->image($file, %options); | ||||||||||||||||||||||||||||||||||||||||||||
| 2202 | |||||||||||||||||||||||||||||||||||||||||||||
| 2203 | Import a supported image type and return an object that can be placed as part of | ||||||||||||||||||||||||||||||||||||||||||||
| 2204 | a page's content: | ||||||||||||||||||||||||||||||||||||||||||||
| 2205 | |||||||||||||||||||||||||||||||||||||||||||||
| 2206 | my $pdf = PDF::API2->new(); | ||||||||||||||||||||||||||||||||||||||||||||
| 2207 | my $page = $pdf->page(); | ||||||||||||||||||||||||||||||||||||||||||||
| 2208 | |||||||||||||||||||||||||||||||||||||||||||||
| 2209 | my $image = $pdf->image('/path/to/image.jpg'); | ||||||||||||||||||||||||||||||||||||||||||||
| 2210 | $page->object($image, 100, 100); | ||||||||||||||||||||||||||||||||||||||||||||
| 2211 | |||||||||||||||||||||||||||||||||||||||||||||
| 2212 | $pdf->save('sample.pdf'); | ||||||||||||||||||||||||||||||||||||||||||||
| 2213 | |||||||||||||||||||||||||||||||||||||||||||||
| 2214 | C<$file> may be either a file name, a filehandle, or a L<GD::Image> object. | ||||||||||||||||||||||||||||||||||||||||||||
| 2215 | |||||||||||||||||||||||||||||||||||||||||||||
| 2216 | See L<PDF::API2::Content/"place"> for details about placing images on a page | ||||||||||||||||||||||||||||||||||||||||||||
| 2217 | once they're imported. | ||||||||||||||||||||||||||||||||||||||||||||
| 2218 | |||||||||||||||||||||||||||||||||||||||||||||
| 2219 | The image format is normally detected automatically based on the file's | ||||||||||||||||||||||||||||||||||||||||||||
| 2220 | extension. If passed a filehandle, image formats GIF, JPEG, and PNG will be | ||||||||||||||||||||||||||||||||||||||||||||
| 2221 | detected based on the file's header. | ||||||||||||||||||||||||||||||||||||||||||||
| 2222 | |||||||||||||||||||||||||||||||||||||||||||||
| 2223 | If the file has an atypical extension or the filehandle is for a different kind | ||||||||||||||||||||||||||||||||||||||||||||
| 2224 | of image, you can set the C<format> option to one of the supported types: | ||||||||||||||||||||||||||||||||||||||||||||
| 2225 | C<gif>, C<jpeg>, C<png>, C<pnm>, or C<tiff>. | ||||||||||||||||||||||||||||||||||||||||||||
| 2226 | |||||||||||||||||||||||||||||||||||||||||||||
| 2227 | Note: PNG images that include an alpha (transparency) channel go through a | ||||||||||||||||||||||||||||||||||||||||||||
| 2228 | relatively slow process of splitting the image into separate RGB and alpha | ||||||||||||||||||||||||||||||||||||||||||||
| 2229 | components as is required by images in PDFs. If you're having performance | ||||||||||||||||||||||||||||||||||||||||||||
| 2230 | issues, install PDF::API2::XS or Image::PNG::Libpng to speed this process up by | ||||||||||||||||||||||||||||||||||||||||||||
| 2231 | an order of magnitude; either module will be used automatically if available. | ||||||||||||||||||||||||||||||||||||||||||||
| 2232 | |||||||||||||||||||||||||||||||||||||||||||||
| 2233 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 2234 | |||||||||||||||||||||||||||||||||||||||||||||
| 2235 | sub image { | ||||||||||||||||||||||||||||||||||||||||||||
| 2236 | 3 | ▶ | my ($self, $file, %options) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
image: called CC=20 SCAR=49.3
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 2237 | |||||||||||||||||||||||||||||||||||||||||||||
| 2238 | 3 | ▶ | my $format = lc($options{'format'} // ''); | ||||||||||||||||||||||||||||||||||||||||||
|
Condition50%1/2
$options{"format"} // ""
MC/DC0%0/1
$options{"format"} // ""
$options{"format"}
Truth table50%1/2
A
A= $options{"format"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 2239 | |||||||||||||||||||||||||||||||||||||||||||||
| 2240 | 3 | ▶ | if (ref($file) eq 'GD::Image') { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 2 branches
| |||||||||||||||||||||||||||||||||||||||||||||
| 2241 | 0 | return image_gd($file, %options); | |||||||||||||||||||||||||||||||||||||||||||
| 2242 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2243 | elsif (ref($file)) { | ||||||||||||||||||||||||||||||||||||||||||||
| 2244 | 3 | ▶ | $format ||= _detect_image_format($file); | ||||||||||||||||||||||||||||||||||||||||||
|
Condition33%1/3
$format ||= _detect_image_format($file)
MC/DC0%0/2
$format ||= _detect_image_format($file)
$format
_detect_image_format($file)
Truth table33%1/3
A ||= B
A= $formatB= _detect_image_format($file)
| |||||||||||||||||||||||||||||||||||||||||||||
| 2245 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2246 | 3 | ▶ | unless (ref($file)) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 2247 | 0 | ▶ | $format ||= ($file =~ /\.jpe?g$/i ? 'jpeg' : | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 5 branches
Condition0%0/3
$format ||= $file =~ /\.jpe?g$/i ? "jpeg" : ($file =~ /\.png$/i ? "png" : ($file =~ /\.gif$/i ? "gif" : ($file =~ /\.tiff?$/i ? "tiff" : ($file =~ /\.p[bgp]m$/i ? "pnm" : ""))))
MC/DC0%0/2
$format ||= $file =~ /\.jpe?g$/i ? "jpeg" : ($file =~ /\.png$/i ? "png" : ($file =~ /\.gif$/i ? "gif" : ($file =~ /\.tiff?$/i ? "tiff" : ($file =~ /\.p[bgp]m$/i ? "pnm" : ""))))
$format
$file =~ /\.jpe?g$/i ? "jpeg" : ($file =~ /\.png$/i ? "png" : ($file =~ /\.gif$/i ? "gif" : ($file =~ /\.tiff?$/i ? "tiff" : ($file =~ /\.p[bgp]m$/i ? "pnm" : ""))))
Truth table0%0/3
A ||= B
A= $formatB= $file =~ /\.jpe?g$/i ? "jpeg" : ($file =~ /\.png$/i ? "png" : ($file =~ /\.gif$/i ? "gif" : ($file =~ /\.tiff?$/i ? "tiff" : ($file =~ /\.p[bgp]m$/i ? "pnm" : ""))))
| |||||||||||||||||||||||||||||||||||||||||||||
| 2248 | $file =~ /\.png$/i ? 'png' : | ||||||||||||||||||||||||||||||||||||||||||||
| 2249 | $file =~ /\.gif$/i ? 'gif' : | ||||||||||||||||||||||||||||||||||||||||||||
| 2250 | $file =~ /\.tiff?$/i ? 'tiff' : | ||||||||||||||||||||||||||||||||||||||||||||
| 2251 | $file =~ /\.p[bgp]m$/i ? 'pnm' : ''); | ||||||||||||||||||||||||||||||||||||||||||||
| 2252 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2253 | |||||||||||||||||||||||||||||||||||||||||||||
| 2254 | 3 | ▶ | if ($format eq 'jpeg') { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 8 branches
| |||||||||||||||||||||||||||||||||||||||||||||
| 2255 | 1 | return $self->image_jpeg($file, %options); | |||||||||||||||||||||||||||||||||||||||||||
| 2256 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2257 | elsif ($format eq 'png') { | ||||||||||||||||||||||||||||||||||||||||||||
| 2258 | 1 | return $self->image_png($file, %options); | |||||||||||||||||||||||||||||||||||||||||||
| 2259 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2260 | elsif ($format eq 'gif') { | ||||||||||||||||||||||||||||||||||||||||||||
| 2261 | 1 | return $self->image_gif($file, %options); | |||||||||||||||||||||||||||||||||||||||||||
| 2262 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2263 | elsif ($format eq 'tiff') { | ||||||||||||||||||||||||||||||||||||||||||||
| 2264 | 0 | return $self->image_tiff($file, %options); | |||||||||||||||||||||||||||||||||||||||||||
| 2265 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2266 | elsif ($format eq 'pnm') { | ||||||||||||||||||||||||||||||||||||||||||||
| 2267 | 0 | return $self->image_pnm($file, %options); | |||||||||||||||||||||||||||||||||||||||||||
| 2268 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2269 | elsif ($format) { | ||||||||||||||||||||||||||||||||||||||||||||
| 2270 | 0 | croak "Unrecognized image format: $format"; | |||||||||||||||||||||||||||||||||||||||||||
| 2271 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2272 | elsif (ref($file)) { | ||||||||||||||||||||||||||||||||||||||||||||
| 2273 | 0 | croak "Unspecified image format"; | |||||||||||||||||||||||||||||||||||||||||||
| 2274 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2275 | elsif ($file =~ /(\..*)$/) { | ||||||||||||||||||||||||||||||||||||||||||||
| 2276 | 0 | croak "Unrecognized image extension: $1"; | |||||||||||||||||||||||||||||||||||||||||||
| 2277 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2278 | else { | ||||||||||||||||||||||||||||||||||||||||||||
| 2279 | 0 | croak "Unrecognized image: $file"; | |||||||||||||||||||||||||||||||||||||||||||
| 2280 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2281 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2282 | |||||||||||||||||||||||||||||||||||||||||||||
| 2283 | sub _detect_image_format { | ||||||||||||||||||||||||||||||||||||||||||||
| 2284 | 3 | ▶ | my $fh = shift(); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
_detect_image_format: called CC=6 SCAR=18.6
| |||||||||||||||||||||||||||||||||||||||||||||
| 2285 | 3 | $fh->seek(0, 0); | |||||||||||||||||||||||||||||||||||||||||||
| 2286 | 3 | binmode $fh, ':raw'; | |||||||||||||||||||||||||||||||||||||||||||
| 2287 | |||||||||||||||||||||||||||||||||||||||||||||
| 2288 | 3 | my $test; | |||||||||||||||||||||||||||||||||||||||||||
| 2289 | 3 | my $bytes_read = $fh->read($test, 8); | |||||||||||||||||||||||||||||||||||||||||||
| 2290 | 3 | $fh->seek(0, 0); | |||||||||||||||||||||||||||||||||||||||||||
| 2291 | 3 | ▶ | return unless $bytes_read and $bytes_read == 8; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
Condition33%1/3
$bytes_read and $bytes_read == 8
MC/DC0%0/2
$bytes_read and $bytes_read == 8
$bytes_read
$bytes_read == 8
Truth table33%1/3
A and B
A= $bytes_readB= $bytes_read == 8
| |||||||||||||||||||||||||||||||||||||||||||||
| 2292 | |||||||||||||||||||||||||||||||||||||||||||||
| 2293 | 3 | ▶ | return 'gif' if $test =~ /^GIF\d\d[a-z]/; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 2294 | 2 | ▶ | return 'jpeg' if $test =~ /^\xFF\xD8\xFF/; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 2295 | 1 | ▶ | return 'png' if $test =~ /^\x89PNG\x0D\x0A\x1A\x0A/; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 2296 | 0 | return; | |||||||||||||||||||||||||||||||||||||||||||
| 2297 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2298 | |||||||||||||||||||||||||||||||||||||||||||||
| 2299 | sub image_jpeg { | ||||||||||||||||||||||||||||||||||||||||||||
| 2300 | 3 | ▶ | my ($self, $file, %opts) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
image_jpeg: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 2301 | |||||||||||||||||||||||||||||||||||||||||||||
| 2302 | 3 | require PDF::API2::Resource::XObject::Image::JPEG; | |||||||||||||||||||||||||||||||||||||||||||
| 2303 | 3 | my $obj = PDF::API2::Resource::XObject::Image::JPEG->new($self->{'pdf'}, $file); | |||||||||||||||||||||||||||||||||||||||||||
| 2304 | |||||||||||||||||||||||||||||||||||||||||||||
| 2305 | 2 | $self->{'pdf'}->out_obj($self->{'pages'}); | |||||||||||||||||||||||||||||||||||||||||||
| 2306 | |||||||||||||||||||||||||||||||||||||||||||||
| 2307 | 2 | return $obj; | |||||||||||||||||||||||||||||||||||||||||||
| 2308 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2309 | |||||||||||||||||||||||||||||||||||||||||||||
| 2310 | sub image_tiff { | ||||||||||||||||||||||||||||||||||||||||||||
| 2311 | 4 | ▶ | my ($self, $file, %opts) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
image_tiff: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 2312 | |||||||||||||||||||||||||||||||||||||||||||||
| 2313 | 4 | require PDF::API2::Resource::XObject::Image::TIFF; | |||||||||||||||||||||||||||||||||||||||||||
| 2314 | 4 | my $obj = PDF::API2::Resource::XObject::Image::TIFF->new($self->{'pdf'}, $file); | |||||||||||||||||||||||||||||||||||||||||||
| 2315 | |||||||||||||||||||||||||||||||||||||||||||||
| 2316 | 3 | $self->{'pdf'}->out_obj($self->{'pages'}); | |||||||||||||||||||||||||||||||||||||||||||
| 2317 | |||||||||||||||||||||||||||||||||||||||||||||
| 2318 | 3 | return $obj; | |||||||||||||||||||||||||||||||||||||||||||
| 2319 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2320 | |||||||||||||||||||||||||||||||||||||||||||||
| 2321 | sub image_pnm { | ||||||||||||||||||||||||||||||||||||||||||||
| 2322 | 3 | ▶ | my ($self, $file, %opts) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
image_pnm: called CC=2 SCAR=7.1
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 2323 | |||||||||||||||||||||||||||||||||||||||||||||
| 2324 | 3 | ▶ | $opts{'-compress'} //= $self->{'forcecompress'}; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition33%1/3
$opts{"-compress"} //= $self->{"forcecompress"}
MC/DC0%0/2
$opts{"-compress"} //= $self->{"forcecompress"}
$opts{"-compress"}
$self->{"forcecompress"}
Truth table33%1/3
A //= B
A= $opts{"-compress"}B= $self->{"forcecompress"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 2325 | |||||||||||||||||||||||||||||||||||||||||||||
| 2326 | 3 | require PDF::API2::Resource::XObject::Image::PNM; | |||||||||||||||||||||||||||||||||||||||||||
| 2327 | 3 | my $obj = PDF::API2::Resource::XObject::Image::PNM->new($self->{'pdf'}, $file, %opts); | |||||||||||||||||||||||||||||||||||||||||||
| 2328 | |||||||||||||||||||||||||||||||||||||||||||||
| 2329 | 2 | $self->{'pdf'}->out_obj($self->{'pages'}); | |||||||||||||||||||||||||||||||||||||||||||
| 2330 | |||||||||||||||||||||||||||||||||||||||||||||
| 2331 | 2 | return $obj; | |||||||||||||||||||||||||||||||||||||||||||
| 2332 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2333 | |||||||||||||||||||||||||||||||||||||||||||||
| 2334 | sub image_png { | ||||||||||||||||||||||||||||||||||||||||||||
| 2335 | 5 | ▶ | my ($self, $file, %opts) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
image_png: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 2336 | |||||||||||||||||||||||||||||||||||||||||||||
| 2337 | 5 | require PDF::API2::Resource::XObject::Image::PNG; | |||||||||||||||||||||||||||||||||||||||||||
| 2338 | 5 | my $obj = PDF::API2::Resource::XObject::Image::PNG->new($self->{'pdf'}, $file); | |||||||||||||||||||||||||||||||||||||||||||
| 2339 | |||||||||||||||||||||||||||||||||||||||||||||
| 2340 | 4 | $self->{'pdf'}->out_obj($self->{'pages'}); | |||||||||||||||||||||||||||||||||||||||||||
| 2341 | |||||||||||||||||||||||||||||||||||||||||||||
| 2342 | 4 | return $obj; | |||||||||||||||||||||||||||||||||||||||||||
| 2343 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2344 | |||||||||||||||||||||||||||||||||||||||||||||
| 2345 | sub image_gif { | ||||||||||||||||||||||||||||||||||||||||||||
| 2346 | 3 | ▶ | my ($self, $file, %opts) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
image_gif: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 2347 | |||||||||||||||||||||||||||||||||||||||||||||
| 2348 | 3 | require PDF::API2::Resource::XObject::Image::GIF; | |||||||||||||||||||||||||||||||||||||||||||
| 2349 | 3 | my $obj = PDF::API2::Resource::XObject::Image::GIF->new($self->{'pdf'}, $file); | |||||||||||||||||||||||||||||||||||||||||||
| 2350 | |||||||||||||||||||||||||||||||||||||||||||||
| 2351 | 2 | $self->{'pdf'}->out_obj($self->{'pages'}); | |||||||||||||||||||||||||||||||||||||||||||
| 2352 | |||||||||||||||||||||||||||||||||||||||||||||
| 2353 | 2 | return $obj; | |||||||||||||||||||||||||||||||||||||||||||
| 2354 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2355 | |||||||||||||||||||||||||||||||||||||||||||||
| 2356 | sub image_gd { | ||||||||||||||||||||||||||||||||||||||||||||
| 2357 | 0 | ▶ | my ($self, $gd, %opts) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
image_gd: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 2358 | |||||||||||||||||||||||||||||||||||||||||||||
| 2359 | 0 | require PDF::API2::Resource::XObject::Image::GD; | |||||||||||||||||||||||||||||||||||||||||||
| 2360 | 0 | my $obj = PDF::API2::Resource::XObject::Image::GD->new($self->{'pdf'}, $gd, undef, %opts); | |||||||||||||||||||||||||||||||||||||||||||
| 2361 | |||||||||||||||||||||||||||||||||||||||||||||
| 2362 | 0 | $self->{'pdf'}->out_obj($self->{'pages'}); | |||||||||||||||||||||||||||||||||||||||||||
| 2363 | |||||||||||||||||||||||||||||||||||||||||||||
| 2364 | 0 | return $obj; | |||||||||||||||||||||||||||||||||||||||||||
| 2365 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2366 | |||||||||||||||||||||||||||||||||||||||||||||
| 2367 | =head2 barcode | ||||||||||||||||||||||||||||||||||||||||||||
| 2368 | |||||||||||||||||||||||||||||||||||||||||||||
| 2369 | $object = $pdf->barcode($format, $code, %options); | ||||||||||||||||||||||||||||||||||||||||||||
| 2370 | |||||||||||||||||||||||||||||||||||||||||||||
| 2371 | Generate and return a barcode that can be placed as part of a page's content: | ||||||||||||||||||||||||||||||||||||||||||||
| 2372 | |||||||||||||||||||||||||||||||||||||||||||||
| 2373 | my $pdf = PDF::API2->new(); | ||||||||||||||||||||||||||||||||||||||||||||
| 2374 | my $page = $pdf->page(); | ||||||||||||||||||||||||||||||||||||||||||||
| 2375 | |||||||||||||||||||||||||||||||||||||||||||||
| 2376 | my $barcode = $pdf->barcode('ean13', '0123456789012'); | ||||||||||||||||||||||||||||||||||||||||||||
| 2377 | $page->object($barcode, 100, 100); | ||||||||||||||||||||||||||||||||||||||||||||
| 2378 | |||||||||||||||||||||||||||||||||||||||||||||
| 2379 | my $qr_code = $pdf->barcode('qr', 'http://www.example.com'); | ||||||||||||||||||||||||||||||||||||||||||||
| 2380 | $page->object($qr_code, 100, 300, 144 / $qr_code->width()) | ||||||||||||||||||||||||||||||||||||||||||||
| 2381 | |||||||||||||||||||||||||||||||||||||||||||||
| 2382 | $pdf->save('sample.pdf'); | ||||||||||||||||||||||||||||||||||||||||||||
| 2383 | |||||||||||||||||||||||||||||||||||||||||||||
| 2384 | C<$format> can be one of C<codabar>, C<code128>, C<code39> (a.k.a. 3 of 9), | ||||||||||||||||||||||||||||||||||||||||||||
| 2385 | C<ean128>, C<ean13>, C<itf> (a.k.a. interleaved 2 of 5), or C<qr>. | ||||||||||||||||||||||||||||||||||||||||||||
| 2386 | |||||||||||||||||||||||||||||||||||||||||||||
| 2387 | C<$code> is the value to be encoded. Start and stop characters are only | ||||||||||||||||||||||||||||||||||||||||||||
| 2388 | required when they're not static (e.g. for Codabar). | ||||||||||||||||||||||||||||||||||||||||||||
| 2389 | |||||||||||||||||||||||||||||||||||||||||||||
| 2390 | The following options are available: | ||||||||||||||||||||||||||||||||||||||||||||
| 2391 | |||||||||||||||||||||||||||||||||||||||||||||
| 2392 | =over | ||||||||||||||||||||||||||||||||||||||||||||
| 2393 | |||||||||||||||||||||||||||||||||||||||||||||
| 2394 | =item * bar_width | ||||||||||||||||||||||||||||||||||||||||||||
| 2395 | |||||||||||||||||||||||||||||||||||||||||||||
| 2396 | The width of the smallest bar or space in points (72 points = 1 inch). | ||||||||||||||||||||||||||||||||||||||||||||
| 2397 | |||||||||||||||||||||||||||||||||||||||||||||
| 2398 | If you're following a specification that gives bar width in mils (thousandths of | ||||||||||||||||||||||||||||||||||||||||||||
| 2399 | an inch), use this conversion: C<$points = $mils / 1000 * 72>. | ||||||||||||||||||||||||||||||||||||||||||||
| 2400 | |||||||||||||||||||||||||||||||||||||||||||||
| 2401 | =item * bar_height | ||||||||||||||||||||||||||||||||||||||||||||
| 2402 | |||||||||||||||||||||||||||||||||||||||||||||
| 2403 | The base height of the barcode in points. | ||||||||||||||||||||||||||||||||||||||||||||
| 2404 | |||||||||||||||||||||||||||||||||||||||||||||
| 2405 | =item * bar_extend | ||||||||||||||||||||||||||||||||||||||||||||
| 2406 | |||||||||||||||||||||||||||||||||||||||||||||
| 2407 | If present, bars for non-printing characters (e.g. start and stop characters) | ||||||||||||||||||||||||||||||||||||||||||||
| 2408 | will be extended downward by this many points, and printing characters will be | ||||||||||||||||||||||||||||||||||||||||||||
| 2409 | shown below their respective bars. | ||||||||||||||||||||||||||||||||||||||||||||
| 2410 | |||||||||||||||||||||||||||||||||||||||||||||
| 2411 | This is enabled by default for EAN-13 barcodes. | ||||||||||||||||||||||||||||||||||||||||||||
| 2412 | |||||||||||||||||||||||||||||||||||||||||||||
| 2413 | =item * caption | ||||||||||||||||||||||||||||||||||||||||||||
| 2414 | |||||||||||||||||||||||||||||||||||||||||||||
| 2415 | If present, this value will be printed, centered, beneath the barcode, and | ||||||||||||||||||||||||||||||||||||||||||||
| 2416 | should be a human-readable representation of the barcode. | ||||||||||||||||||||||||||||||||||||||||||||
| 2417 | |||||||||||||||||||||||||||||||||||||||||||||
| 2418 | =item * font | ||||||||||||||||||||||||||||||||||||||||||||
| 2419 | |||||||||||||||||||||||||||||||||||||||||||||
| 2420 | A font object (created by L</"font">) that will be used to print the caption, or | ||||||||||||||||||||||||||||||||||||||||||||
| 2421 | the printable characters when C<bar_extend> is set. | ||||||||||||||||||||||||||||||||||||||||||||
| 2422 | |||||||||||||||||||||||||||||||||||||||||||||
| 2423 | Helvetica will be used by default. | ||||||||||||||||||||||||||||||||||||||||||||
| 2424 | |||||||||||||||||||||||||||||||||||||||||||||
| 2425 | =item * font_size | ||||||||||||||||||||||||||||||||||||||||||||
| 2426 | |||||||||||||||||||||||||||||||||||||||||||||
| 2427 | The size of the font used for printing the caption or printable characters. | ||||||||||||||||||||||||||||||||||||||||||||
| 2428 | |||||||||||||||||||||||||||||||||||||||||||||
| 2429 | The default will be calculated based on the barcode size, if C<bar_extend> is | ||||||||||||||||||||||||||||||||||||||||||||
| 2430 | set, or 10 otherwise. | ||||||||||||||||||||||||||||||||||||||||||||
| 2431 | |||||||||||||||||||||||||||||||||||||||||||||
| 2432 | =item * quiet_zone | ||||||||||||||||||||||||||||||||||||||||||||
| 2433 | |||||||||||||||||||||||||||||||||||||||||||||
| 2434 | A margin, in points, that will be place before the left and bottom edges of the | ||||||||||||||||||||||||||||||||||||||||||||
| 2435 | barcode (including the caption, if present). This is used to help barcode | ||||||||||||||||||||||||||||||||||||||||||||
| 2436 | scanners tell where the barcode begins and ends. | ||||||||||||||||||||||||||||||||||||||||||||
| 2437 | |||||||||||||||||||||||||||||||||||||||||||||
| 2438 | The default is the width of one encoded character. | ||||||||||||||||||||||||||||||||||||||||||||
| 2439 | |||||||||||||||||||||||||||||||||||||||||||||
| 2440 | =item * bar_overflow | ||||||||||||||||||||||||||||||||||||||||||||
| 2441 | |||||||||||||||||||||||||||||||||||||||||||||
| 2442 | Shrinks the horizontal width of bars by this amount in points to account for ink | ||||||||||||||||||||||||||||||||||||||||||||
| 2443 | spread when printing. | ||||||||||||||||||||||||||||||||||||||||||||
| 2444 | |||||||||||||||||||||||||||||||||||||||||||||
| 2445 | The default is 0.01 points. | ||||||||||||||||||||||||||||||||||||||||||||
| 2446 | |||||||||||||||||||||||||||||||||||||||||||||
| 2447 | =item * color | ||||||||||||||||||||||||||||||||||||||||||||
| 2448 | |||||||||||||||||||||||||||||||||||||||||||||
| 2449 | Draw bars using this color, which may be any value accepted by | ||||||||||||||||||||||||||||||||||||||||||||
| 2450 | L<PDF::API2::Content/"fillcolor">. | ||||||||||||||||||||||||||||||||||||||||||||
| 2451 | |||||||||||||||||||||||||||||||||||||||||||||
| 2452 | The default is black. | ||||||||||||||||||||||||||||||||||||||||||||
| 2453 | |||||||||||||||||||||||||||||||||||||||||||||
| 2454 | =back | ||||||||||||||||||||||||||||||||||||||||||||
| 2455 | |||||||||||||||||||||||||||||||||||||||||||||
| 2456 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 2457 | |||||||||||||||||||||||||||||||||||||||||||||
| 2458 | sub barcode { | ||||||||||||||||||||||||||||||||||||||||||||
| 2459 | 0 | ▶ | my ($self, $format, $value, %options) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
barcode: not called CC=50 SCAR=78.4
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 2460 | 0 | ▶ | croak "Missing barcode format" unless defined $format; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 2461 | 0 | ▶ | croak "Missing barcode value" unless defined $value; | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 2462 | |||||||||||||||||||||||||||||||||||||||||||||
| 2463 | # Set defaults to approximately the minimums for each barcode format. | ||||||||||||||||||||||||||||||||||||||||||||
| 2464 | 0 | ▶ | if ($format eq 'codabar') { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 5 branches
| |||||||||||||||||||||||||||||||||||||||||||||
| 2465 | 0 | ▶ | $options{'bar_width'} //= 1.8; # 0.025" | ||||||||||||||||||||||||||||||||||||||||||
|
Condition0%0/2
$options{"bar_width"} //= "1.8"
MC/DC0%0/1
$options{"bar_width"} //= "1.8"
$options{"bar_width"}
Truth table0%0/2
A
A= $options{"bar_width"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 2466 | 0 | ▶ | $options{'bar_extend'} //= 0; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition0%0/2
$options{"bar_extend"} //= 0
MC/DC0%0/1
$options{"bar_extend"} //= 0
$options{"bar_extend"}
Truth table0%0/2
A
A= $options{"bar_extend"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 2467 | 0 | ▶ | $options{'quiet_zone'} //= 10 * $options{'bar_width'}; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition0%0/3
$options{"quiet_zone"} //= 10 * $options{"bar_width"}
MC/DC0%0/2
$options{"quiet_zone"} //= 10 * $options{"bar_width"}
$options{"quiet_zone"}
10 * $options{"bar_width"}
Truth table0%0/3
A //= B
A= $options{"quiet_zone"}B= 10 * $options{"bar_width"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 2468 | 0 | ▶ | if ($options{'bar_extend'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 2469 | 0 | ▶ | $options{'font_size'} //= 9 * $options{'bar_width'}; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition0%0/3
$options{"font_size"} //= 9 * $options{"bar_width"}
MC/DC0%0/2
$options{"font_size"} //= 9 * $options{"bar_width"}
$options{"font_size"}
9 * $options{"bar_width"}
Truth table0%0/3
A //= B
A= $options{"font_size"}B= 9 * $options{"bar_width"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 2470 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2471 | |||||||||||||||||||||||||||||||||||||||||||||
| 2472 | # Minimum height is the larger of 0.25" or 15% of barcode length. | ||||||||||||||||||||||||||||||||||||||||||||
| 2473 | 0 | my $length = (10 * length($value) + 2) * $options{'bar_width'}; | |||||||||||||||||||||||||||||||||||||||||||
| 2474 | 0 | ▶ | $options{'bar_height'} //= max(18, $length * 0.15); | ||||||||||||||||||||||||||||||||||||||||||
|
Condition0%0/3
$options{"bar_height"} //= &max(18, $length * "0.15")
MC/DC0%0/2
$options{"bar_height"} //= &max(18, $length * "0.15")
$options{"bar_height"}
&max(18, $length * "0.15")
Truth table0%0/3
A //= B
A= $options{"bar_height"}B= &max(18, $length * "0.15")
| |||||||||||||||||||||||||||||||||||||||||||||
| 2475 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2476 | ▶ | elsif ($format eq 'code128' or $format eq 'ean128' or $format eq 'code39') { | |||||||||||||||||||||||||||||||||||||||||||
|
Condition0%0/6
$format eq "code128" or $format eq "ean128" or $format eq "code39"
$format eq "code128" or $format eq "ean128"
MC/DC0%0/3
$format eq "code128" or $format eq "ean128" or $format eq "code39"
$format eq "code128"
$format eq "ean128"
$format eq "code39"
Truth table0%0/4
A or B or C
A= $format eq "code128"B= $format eq "ean128"C= $format eq "code39"
| |||||||||||||||||||||||||||||||||||||||||||||
| 2477 | 0 | ▶ | $options{'bar_width'} //= 1; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition0%0/2
$options{"bar_width"} //= 1
MC/DC0%0/1
$options{"bar_width"} //= 1
$options{"bar_width"}
Truth table0%0/2
A
A= $options{"bar_width"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 2478 | 0 | ▶ | $options{'bar_extend'} //= 0; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition0%0/2
$options{"bar_extend"} //= 0
MC/DC0%0/1
$options{"bar_extend"} //= 0
$options{"bar_extend"}
Truth table0%0/2
A
A= $options{"bar_extend"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 2479 | 0 | ▶ | $options{'quiet_zone'} //= 11 * $options{'bar_width'}; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition0%0/3
$options{"quiet_zone"} //= 11 * $options{"bar_width"}
MC/DC0%0/2
$options{"quiet_zone"} //= 11 * $options{"bar_width"}
$options{"quiet_zone"}
11 * $options{"bar_width"}
Truth table0%0/3
A //= B
A= $options{"quiet_zone"}B= 11 * $options{"bar_width"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 2480 | 0 | ▶ | if ($options{'bar_extend'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 2481 | 0 | ▶ | $options{'font_size'} //= 10 * $options{'bar_width'}; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition0%0/3
$options{"font_size"} //= 10 * $options{"bar_width"}
MC/DC0%0/2
$options{"font_size"} //= 10 * $options{"bar_width"}
$options{"font_size"}
10 * $options{"bar_width"}
Truth table0%0/3
A //= B
A= $options{"font_size"}B= 10 * $options{"bar_width"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 2482 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2483 | |||||||||||||||||||||||||||||||||||||||||||||
| 2484 | # Minimum height is the larger of 0.5" or 15% of barcode length. | ||||||||||||||||||||||||||||||||||||||||||||
| 2485 | 0 | my $length = 11 * (length($value) + 1) * $options{'bar_width'}; | |||||||||||||||||||||||||||||||||||||||||||
| 2486 | 0 | ▶ | $options{'bar_height'} //= max(36, $length * 0.15); | ||||||||||||||||||||||||||||||||||||||||||
|
Condition0%0/3
$options{"bar_height"} //= &max(36, $length * "0.15")
MC/DC0%0/2
$options{"bar_height"} //= &max(36, $length * "0.15")
$options{"bar_height"}
&max(36, $length * "0.15")
Truth table0%0/3
A //= B
A= $options{"bar_height"}B= &max(36, $length * "0.15")
| |||||||||||||||||||||||||||||||||||||||||||||
| 2487 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2488 | elsif ($format eq 'itf') { | ||||||||||||||||||||||||||||||||||||||||||||
| 2489 | 0 | ▶ | $options{'bar_width'} //= 1; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition0%0/2
$options{"bar_width"} //= 1
MC/DC0%0/1
$options{"bar_width"} //= 1
$options{"bar_width"}
Truth table0%0/2
A
A= $options{"bar_width"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 2490 | 0 | ▶ | $options{'bar_height'} //= 40; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition0%0/2
$options{"bar_height"} //= 40
MC/DC0%0/1
$options{"bar_height"} //= 40
$options{"bar_height"}
Truth table0%0/2
A
A= $options{"bar_height"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 2491 | 0 | ▶ | $options{'bar_extend'} //= 0; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition0%0/2
$options{"bar_extend"} //= 0
MC/DC0%0/1
$options{"bar_extend"} //= 0
$options{"bar_extend"}
Truth table0%0/2
A
A= $options{"bar_extend"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 2492 | 0 | ▶ | $options{'quiet_zone'} //= 10 * $options{'bar_width'}; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition0%0/3
$options{"quiet_zone"} //= 10 * $options{"bar_width"}
MC/DC0%0/2
$options{"quiet_zone"} //= 10 * $options{"bar_width"}
$options{"quiet_zone"}
10 * $options{"bar_width"}
Truth table0%0/3
A //= B
A= $options{"quiet_zone"}B= 10 * $options{"bar_width"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 2493 | 0 | ▶ | if ($options{'bar_extend'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 2494 | 0 | ▶ | $options{'font_size'} //= 9 * $options{'bar_width'}; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition0%0/3
$options{"font_size"} //= 9 * $options{"bar_width"}
MC/DC0%0/2
$options{"font_size"} //= 9 * $options{"bar_width"}
$options{"font_size"}
9 * $options{"bar_width"}
Truth table0%0/3
A //= B
A= $options{"font_size"}B= 9 * $options{"bar_width"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 2495 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2496 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2497 | elsif ($format eq 'ean13') { | ||||||||||||||||||||||||||||||||||||||||||||
| 2498 | 0 | ▶ | $options{'bar_width'} //= 1; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition0%0/2
$options{"bar_width"} //= 1
MC/DC0%0/1
$options{"bar_width"} //= 1
$options{"bar_width"}
Truth table0%0/2
A
A= $options{"bar_width"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 2499 | 0 | ▶ | $options{'bar_height'} //= 64.8; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition0%0/2
$options{"bar_height"} //= "64.8"
MC/DC0%0/1
$options{"bar_height"} //= "64.8"
$options{"bar_height"}
Truth table0%0/2
A
A= $options{"bar_height"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 2500 | 0 | ▶ | $options{'quiet_zone'} //= 11 * $options{'bar_width'}; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition0%0/3
$options{"quiet_zone"} //= 11 * $options{"bar_width"}
MC/DC0%0/2
$options{"quiet_zone"} //= 11 * $options{"bar_width"}
$options{"quiet_zone"}
11 * $options{"bar_width"}
Truth table0%0/3
A //= B
A= $options{"quiet_zone"}B= 11 * $options{"bar_width"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 2501 | 0 | ▶ | unless ($options{'caption'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 2502 | 0 | ▶ | $options{'bar_extend'} //= 5 * $options{'bar_width'}; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition0%0/3
$options{"bar_extend"} //= 5 * $options{"bar_width"}
MC/DC0%0/2
$options{"bar_extend"} //= 5 * $options{"bar_width"}
$options{"bar_extend"}
5 * $options{"bar_width"}
Truth table0%0/3
A //= B
A= $options{"bar_extend"}B= 5 * $options{"bar_width"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 2503 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2504 | 0 | ▶ | if ($options{'bar_extend'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 2505 | 0 | ▶ | $options{'font_size'} //= 10 * $options{'bar_width'}; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition0%0/3
$options{"font_size"} //= 10 * $options{"bar_width"}
MC/DC0%0/2
$options{"font_size"} //= 10 * $options{"bar_width"}
$options{"font_size"}
10 * $options{"bar_width"}
Truth table0%0/3
A //= B
A= $options{"font_size"}B= 10 * $options{"bar_width"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 2506 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2507 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2508 | elsif ($format eq 'qr') { | ||||||||||||||||||||||||||||||||||||||||||||
| 2509 | 0 | ▶ | $options{'bar_width'} //= 1; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition0%0/2
$options{"bar_width"} //= 1
MC/DC0%0/1
$options{"bar_width"} //= 1
$options{"bar_width"}
Truth table0%0/2
A
A= $options{"bar_width"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 2510 | 0 | ▶ | $options{'bar_height'} //= $options{'bar_width'}; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition0%0/3
$options{"bar_height"} //= $options{"bar_width"}
MC/DC0%0/2
$options{"bar_height"} //= $options{"bar_width"}
$options{"bar_height"}
$options{"bar_width"}
Truth table0%0/3
A //= B
A= $options{"bar_height"}B= $options{"bar_width"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 2511 | 0 | ▶ | $options{'quiet_zone'} //= 4 * $options{'bar_width'}; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition0%0/3
$options{"quiet_zone"} //= 4 * $options{"bar_width"}
MC/DC0%0/2
$options{"quiet_zone"} //= 4 * $options{"bar_width"}
$options{"quiet_zone"}
4 * $options{"bar_width"}
Truth table0%0/3
A //= B
A= $options{"quiet_zone"}B= 4 * $options{"bar_width"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 2512 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2513 | else { | ||||||||||||||||||||||||||||||||||||||||||||
| 2514 | 0 | croak "Unrecognized barcode format: $format"; | |||||||||||||||||||||||||||||||||||||||||||
| 2515 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2516 | |||||||||||||||||||||||||||||||||||||||||||||
| 2517 | 0 | ▶ | if (exists $options{'caption'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 2518 | 0 | ▶ | $options{'font_size'} //= 10; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition0%0/2
$options{"font_size"} //= 10
MC/DC0%0/1
$options{"font_size"} //= 10
$options{"font_size"}
Truth table0%0/2
A
A= $options{"font_size"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 2519 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2520 | 0 | ▶ | if ($options{'bar_extend'} or $options{'font_size'}) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
Condition0%0/3
$options{"bar_extend"} or $options{"font_size"}
MC/DC0%0/2
$options{"bar_extend"} or $options{"font_size"}
$options{"bar_extend"}
$options{"font_size"}
Truth table0%0/3
A or B
A= $options{"bar_extend"}B= $options{"font_size"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 2521 | 0 | ▶ | $options{'font'} //= $self->font('Helvetica'); | ||||||||||||||||||||||||||||||||||||||||||
|
Condition0%0/3
$options{"font"} //= $self->font("Helvetica")
MC/DC0%0/2
$options{"font"} //= $self->font("Helvetica")
$options{"font"}
$self->font("Helvetica")
Truth table0%0/3
A //= B
A= $options{"font"}B= $self->font("Helvetica")
| |||||||||||||||||||||||||||||||||||||||||||||
| 2522 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2523 | |||||||||||||||||||||||||||||||||||||||||||||
| 2524 | # Convert from new arguments to old arguments | ||||||||||||||||||||||||||||||||||||||||||||
| 2525 | 0 | $options{'-color'} = delete $options{'color'}; | |||||||||||||||||||||||||||||||||||||||||||
| 2526 | 0 | $options{'-fnsz'} = delete $options{'font_size'}; | |||||||||||||||||||||||||||||||||||||||||||
| 2527 | 0 | $options{'-font'} = delete $options{'font'}; | |||||||||||||||||||||||||||||||||||||||||||
| 2528 | 0 | $options{'-lmzn'} = delete $options{'bar_extend'}; | |||||||||||||||||||||||||||||||||||||||||||
| 2529 | 0 | $options{'-mils'} = (delete $options{'bar_width'}) * 1000 / 72; | |||||||||||||||||||||||||||||||||||||||||||
| 2530 | 0 | $options{'-ofwt'} = delete $options{'bar_overflow'}; | |||||||||||||||||||||||||||||||||||||||||||
| 2531 | 0 | $options{'-quzn'} = delete $options{'quiet_zone'}; | |||||||||||||||||||||||||||||||||||||||||||
| 2532 | 0 | $options{'-zone'} = delete $options{'bar_height'}; | |||||||||||||||||||||||||||||||||||||||||||
| 2533 | |||||||||||||||||||||||||||||||||||||||||||||
| 2534 | 0 | ▶ | if ($format eq 'codabar') { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 7 branches
| |||||||||||||||||||||||||||||||||||||||||||||
| 2535 | 0 | return $self->xo_codabar(%options, -code => $value); | |||||||||||||||||||||||||||||||||||||||||||
| 2536 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2537 | elsif ($format eq 'code128') { | ||||||||||||||||||||||||||||||||||||||||||||
| 2538 | 0 | return $self->xo_code128(%options, -code => $value); | |||||||||||||||||||||||||||||||||||||||||||
| 2539 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2540 | elsif ($format eq 'code39') { | ||||||||||||||||||||||||||||||||||||||||||||
| 2541 | 0 | return $self->xo_3of9(%options, -code => $value); | |||||||||||||||||||||||||||||||||||||||||||
| 2542 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2543 | elsif ($format eq 'ean128') { | ||||||||||||||||||||||||||||||||||||||||||||
| 2544 | 0 | return $self->xo_code128(%options, -code => $value, -ean => 1); | |||||||||||||||||||||||||||||||||||||||||||
| 2545 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2546 | elsif ($format eq 'ean13') { | ||||||||||||||||||||||||||||||||||||||||||||
| 2547 | 0 | return $self->xo_ean13(%options, -code => $value); | |||||||||||||||||||||||||||||||||||||||||||
| 2548 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2549 | elsif ($format eq 'itf') { | ||||||||||||||||||||||||||||||||||||||||||||
| 2550 | 0 | return $self->xo_2of5int(%options, -code => $value); | |||||||||||||||||||||||||||||||||||||||||||
| 2551 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2552 | elsif ($format eq 'qr') { | ||||||||||||||||||||||||||||||||||||||||||||
| 2553 | 0 | my $qr_class = 'PDF::API2::Resource::XObject::Form::BarCode::qrcode'; | |||||||||||||||||||||||||||||||||||||||||||
| 2554 | 0 | eval "require $qr_class"; | |||||||||||||||||||||||||||||||||||||||||||
| 2555 | 0 | my $obj = $qr_class->new($self->{'pdf'}, %options, code => $value); | |||||||||||||||||||||||||||||||||||||||||||
| 2556 | # $self->{'pdf'}->out_obj($self->{'pages'}); | ||||||||||||||||||||||||||||||||||||||||||||
| 2557 | 0 | return $obj; | |||||||||||||||||||||||||||||||||||||||||||
| 2558 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2559 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2560 | |||||||||||||||||||||||||||||||||||||||||||||
| 2561 | sub xo_code128 { | ||||||||||||||||||||||||||||||||||||||||||||
| 2562 | 1 | ▶ | my ($self, @opts) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
xo_code128: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 2563 | |||||||||||||||||||||||||||||||||||||||||||||
| 2564 | 1 | require PDF::API2::Resource::XObject::Form::BarCode::code128; | |||||||||||||||||||||||||||||||||||||||||||
| 2565 | 1 | my $obj = PDF::API2::Resource::XObject::Form::BarCode::code128->new($self->{'pdf'}, @opts); | |||||||||||||||||||||||||||||||||||||||||||
| 2566 | |||||||||||||||||||||||||||||||||||||||||||||
| 2567 | 1 | $self->{'pdf'}->out_obj($self->{'pages'}); | |||||||||||||||||||||||||||||||||||||||||||
| 2568 | |||||||||||||||||||||||||||||||||||||||||||||
| 2569 | 1 | return $obj; | |||||||||||||||||||||||||||||||||||||||||||
| 2570 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2571 | |||||||||||||||||||||||||||||||||||||||||||||
| 2572 | sub xo_codabar { | ||||||||||||||||||||||||||||||||||||||||||||
| 2573 | 1 | ▶ | my ($self, @opts) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
xo_codabar: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 2574 | |||||||||||||||||||||||||||||||||||||||||||||
| 2575 | 1 | require PDF::API2::Resource::XObject::Form::BarCode::codabar; | |||||||||||||||||||||||||||||||||||||||||||
| 2576 | 1 | my $obj = PDF::API2::Resource::XObject::Form::BarCode::codabar->new($self->{'pdf'}, @opts); | |||||||||||||||||||||||||||||||||||||||||||
| 2577 | |||||||||||||||||||||||||||||||||||||||||||||
| 2578 | 1 | $self->{'pdf'}->out_obj($self->{'pages'}); | |||||||||||||||||||||||||||||||||||||||||||
| 2579 | |||||||||||||||||||||||||||||||||||||||||||||
| 2580 | 1 | return $obj; | |||||||||||||||||||||||||||||||||||||||||||
| 2581 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2582 | |||||||||||||||||||||||||||||||||||||||||||||
| 2583 | sub xo_2of5int { | ||||||||||||||||||||||||||||||||||||||||||||
| 2584 | 1 | ▶ | my ($self, @opts) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
xo_2of5int: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 2585 | |||||||||||||||||||||||||||||||||||||||||||||
| 2586 | 1 | require PDF::API2::Resource::XObject::Form::BarCode::int2of5; | |||||||||||||||||||||||||||||||||||||||||||
| 2587 | 1 | my $obj = PDF::API2::Resource::XObject::Form::BarCode::int2of5->new($self->{'pdf'}, @opts); | |||||||||||||||||||||||||||||||||||||||||||
| 2588 | |||||||||||||||||||||||||||||||||||||||||||||
| 2589 | 1 | $self->{'pdf'}->out_obj($self->{'pages'}); | |||||||||||||||||||||||||||||||||||||||||||
| 2590 | |||||||||||||||||||||||||||||||||||||||||||||
| 2591 | 1 | return $obj; | |||||||||||||||||||||||||||||||||||||||||||
| 2592 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2593 | |||||||||||||||||||||||||||||||||||||||||||||
| 2594 | sub xo_3of9 { | ||||||||||||||||||||||||||||||||||||||||||||
| 2595 | 2 | ▶ | my ($self, @opts) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
xo_3of9: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 2596 | |||||||||||||||||||||||||||||||||||||||||||||
| 2597 | 2 | require PDF::API2::Resource::XObject::Form::BarCode::code3of9; | |||||||||||||||||||||||||||||||||||||||||||
| 2598 | 2 | my $obj = PDF::API2::Resource::XObject::Form::BarCode::code3of9->new($self->{'pdf'}, @opts); | |||||||||||||||||||||||||||||||||||||||||||
| 2599 | |||||||||||||||||||||||||||||||||||||||||||||
| 2600 | 2 | $self->{'pdf'}->out_obj($self->{'pages'}); | |||||||||||||||||||||||||||||||||||||||||||
| 2601 | |||||||||||||||||||||||||||||||||||||||||||||
| 2602 | 2 | return $obj; | |||||||||||||||||||||||||||||||||||||||||||
| 2603 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2604 | |||||||||||||||||||||||||||||||||||||||||||||
| 2605 | sub xo_ean13 { | ||||||||||||||||||||||||||||||||||||||||||||
| 2606 | 1 | ▶ | my ($self, @opts) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
xo_ean13: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 2607 | |||||||||||||||||||||||||||||||||||||||||||||
| 2608 | 1 | require PDF::API2::Resource::XObject::Form::BarCode::ean13; | |||||||||||||||||||||||||||||||||||||||||||
| 2609 | 1 | my $obj = PDF::API2::Resource::XObject::Form::BarCode::ean13->new($self->{'pdf'}, @opts); | |||||||||||||||||||||||||||||||||||||||||||
| 2610 | |||||||||||||||||||||||||||||||||||||||||||||
| 2611 | 1 | $self->{'pdf'}->out_obj($self->{'pages'}); | |||||||||||||||||||||||||||||||||||||||||||
| 2612 | |||||||||||||||||||||||||||||||||||||||||||||
| 2613 | 1 | return $obj; | |||||||||||||||||||||||||||||||||||||||||||
| 2614 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2615 | |||||||||||||||||||||||||||||||||||||||||||||
| 2616 | =head2 colorspace | ||||||||||||||||||||||||||||||||||||||||||||
| 2617 | |||||||||||||||||||||||||||||||||||||||||||||
| 2618 | $colorspace = $pdf->colorspace($type, @arguments); | ||||||||||||||||||||||||||||||||||||||||||||
| 2619 | |||||||||||||||||||||||||||||||||||||||||||||
| 2620 | Colorspaces can be added to a PDF to either specifically control the output | ||||||||||||||||||||||||||||||||||||||||||||
| 2621 | color on a particular device (spot colors, device colors) or to save space by | ||||||||||||||||||||||||||||||||||||||||||||
| 2622 | limiting the available colors to a defined color palette (web-safe palette, ACT | ||||||||||||||||||||||||||||||||||||||||||||
| 2623 | file). | ||||||||||||||||||||||||||||||||||||||||||||
| 2624 | |||||||||||||||||||||||||||||||||||||||||||||
| 2625 | Once added to the PDF, they can be used in place of regular hex codes or named | ||||||||||||||||||||||||||||||||||||||||||||
| 2626 | colors: | ||||||||||||||||||||||||||||||||||||||||||||
| 2627 | |||||||||||||||||||||||||||||||||||||||||||||
| 2628 | my $pdf = PDF::API2->new(); | ||||||||||||||||||||||||||||||||||||||||||||
| 2629 | my $page = $pdf->page(); | ||||||||||||||||||||||||||||||||||||||||||||
| 2630 | my $content = $page->graphics(); | ||||||||||||||||||||||||||||||||||||||||||||
| 2631 | |||||||||||||||||||||||||||||||||||||||||||||
| 2632 | # Add colorspaces for a spot color and the web-safe color palette | ||||||||||||||||||||||||||||||||||||||||||||
| 2633 | my $spot = $pdf->colorspace('spot', 'PANTONE Red 032 C', '#EF3340'); | ||||||||||||||||||||||||||||||||||||||||||||
| 2634 | my $web = $pdf->colorspace('web'); | ||||||||||||||||||||||||||||||||||||||||||||
| 2635 | |||||||||||||||||||||||||||||||||||||||||||||
| 2636 | # Fill using the spot color with 100% coverage | ||||||||||||||||||||||||||||||||||||||||||||
| 2637 | $content->fill_color($spot, 1.0); | ||||||||||||||||||||||||||||||||||||||||||||
| 2638 | |||||||||||||||||||||||||||||||||||||||||||||
| 2639 | # Stroke using the first color of the web-safe palette | ||||||||||||||||||||||||||||||||||||||||||||
| 2640 | $content->stroke_color($web, 0); | ||||||||||||||||||||||||||||||||||||||||||||
| 2641 | |||||||||||||||||||||||||||||||||||||||||||||
| 2642 | # Add a rectangle to the page | ||||||||||||||||||||||||||||||||||||||||||||
| 2643 | $content->rectangle(100, 100, 200, 200); | ||||||||||||||||||||||||||||||||||||||||||||
| 2644 | $content->paint(); | ||||||||||||||||||||||||||||||||||||||||||||
| 2645 | |||||||||||||||||||||||||||||||||||||||||||||
| 2646 | $pdf->save('sample.pdf'); | ||||||||||||||||||||||||||||||||||||||||||||
| 2647 | |||||||||||||||||||||||||||||||||||||||||||||
| 2648 | The following types of colorspaces are supported | ||||||||||||||||||||||||||||||||||||||||||||
| 2649 | |||||||||||||||||||||||||||||||||||||||||||||
| 2650 | =over | ||||||||||||||||||||||||||||||||||||||||||||
| 2651 | |||||||||||||||||||||||||||||||||||||||||||||
| 2652 | =item * spot | ||||||||||||||||||||||||||||||||||||||||||||
| 2653 | |||||||||||||||||||||||||||||||||||||||||||||
| 2654 | my $spot = $pdf->colorspace('spot', $tint, $alt_color); | ||||||||||||||||||||||||||||||||||||||||||||
| 2655 | |||||||||||||||||||||||||||||||||||||||||||||
| 2656 | Spot colors are used to instruct a device (usually a printer) to use or emulate | ||||||||||||||||||||||||||||||||||||||||||||
| 2657 | a particular ink color (C<$tint>) for parts of the document. An C<$alt_color> | ||||||||||||||||||||||||||||||||||||||||||||
| 2658 | is provided for devices (e.g. PDF viewers) that don't know how to produce the | ||||||||||||||||||||||||||||||||||||||||||||
| 2659 | named color. It can either be an approximation of the color in RGB, CMYK, or | ||||||||||||||||||||||||||||||||||||||||||||
| 2660 | HSV formats, or a wildly different color (e.g. 100% magenta, C<%0F00>) to make | ||||||||||||||||||||||||||||||||||||||||||||
| 2661 | it clear if the spot color isn't being used as expected. | ||||||||||||||||||||||||||||||||||||||||||||
| 2662 | |||||||||||||||||||||||||||||||||||||||||||||
| 2663 | =item * web | ||||||||||||||||||||||||||||||||||||||||||||
| 2664 | |||||||||||||||||||||||||||||||||||||||||||||
| 2665 | my $web = $pdf->colorspace('web'); | ||||||||||||||||||||||||||||||||||||||||||||
| 2666 | |||||||||||||||||||||||||||||||||||||||||||||
| 2667 | The web-safe color palette is a historical collection of colors that was used | ||||||||||||||||||||||||||||||||||||||||||||
| 2668 | when many display devices only supported 256 colors. | ||||||||||||||||||||||||||||||||||||||||||||
| 2669 | |||||||||||||||||||||||||||||||||||||||||||||
| 2670 | =item * act | ||||||||||||||||||||||||||||||||||||||||||||
| 2671 | |||||||||||||||||||||||||||||||||||||||||||||
| 2672 | my $act = $pdf->colorspace('act', $filename); | ||||||||||||||||||||||||||||||||||||||||||||
| 2673 | |||||||||||||||||||||||||||||||||||||||||||||
| 2674 | An Adobe Color Table (ACT) file provides a custom palette of colors that can be | ||||||||||||||||||||||||||||||||||||||||||||
| 2675 | referenced by PDF graphics and text drawing commands. | ||||||||||||||||||||||||||||||||||||||||||||
| 2676 | |||||||||||||||||||||||||||||||||||||||||||||
| 2677 | =item * device | ||||||||||||||||||||||||||||||||||||||||||||
| 2678 | |||||||||||||||||||||||||||||||||||||||||||||
| 2679 | my $devicen = $pdf->colorspace('device', @colorspaces); | ||||||||||||||||||||||||||||||||||||||||||||
| 2680 | |||||||||||||||||||||||||||||||||||||||||||||
| 2681 | A device-specific colorspace allows for precise color output on a given device | ||||||||||||||||||||||||||||||||||||||||||||
| 2682 | (typically a printing press), bypassing the normal color interpretation | ||||||||||||||||||||||||||||||||||||||||||||
| 2683 | performed by raster image processors (RIPs). | ||||||||||||||||||||||||||||||||||||||||||||
| 2684 | |||||||||||||||||||||||||||||||||||||||||||||
| 2685 | Device colorspaces are also needed if you want to blend spot colors: | ||||||||||||||||||||||||||||||||||||||||||||
| 2686 | |||||||||||||||||||||||||||||||||||||||||||||
| 2687 | my $pdf = PDF::API2->new(); | ||||||||||||||||||||||||||||||||||||||||||||
| 2688 | my $page = $pdf->page(); | ||||||||||||||||||||||||||||||||||||||||||||
| 2689 | my $content = $page->graphics(); | ||||||||||||||||||||||||||||||||||||||||||||
| 2690 | |||||||||||||||||||||||||||||||||||||||||||||
| 2691 | # Create a two-color device colorspace | ||||||||||||||||||||||||||||||||||||||||||||
| 2692 | my $yellow = $pdf->colorspace('spot', 'Yellow', '%00F0'); | ||||||||||||||||||||||||||||||||||||||||||||
| 2693 | my $spot = $pdf->colorspace('spot', 'PANTONE Red 032 C', '#EF3340'); | ||||||||||||||||||||||||||||||||||||||||||||
| 2694 | my $device = $pdf->colorspace('device', $yellow, $spot); | ||||||||||||||||||||||||||||||||||||||||||||
| 2695 | |||||||||||||||||||||||||||||||||||||||||||||
| 2696 | # Fill using a blend of 25% yellow and 75% spot color | ||||||||||||||||||||||||||||||||||||||||||||
| 2697 | $content->fill_color($device, 0.25, 0.75); | ||||||||||||||||||||||||||||||||||||||||||||
| 2698 | |||||||||||||||||||||||||||||||||||||||||||||
| 2699 | # Stroke using 100% spot color | ||||||||||||||||||||||||||||||||||||||||||||
| 2700 | $content->stroke_color($device, 0, 1); | ||||||||||||||||||||||||||||||||||||||||||||
| 2701 | |||||||||||||||||||||||||||||||||||||||||||||
| 2702 | # Add a rectangle to the page | ||||||||||||||||||||||||||||||||||||||||||||
| 2703 | $content->rectangle(100, 100, 200, 200); | ||||||||||||||||||||||||||||||||||||||||||||
| 2704 | $content->paint(); | ||||||||||||||||||||||||||||||||||||||||||||
| 2705 | |||||||||||||||||||||||||||||||||||||||||||||
| 2706 | $pdf->save('sample.pdf'); | ||||||||||||||||||||||||||||||||||||||||||||
| 2707 | |||||||||||||||||||||||||||||||||||||||||||||
| 2708 | =back | ||||||||||||||||||||||||||||||||||||||||||||
| 2709 | |||||||||||||||||||||||||||||||||||||||||||||
| 2710 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 2711 | |||||||||||||||||||||||||||||||||||||||||||||
| 2712 | sub colorspace { | ||||||||||||||||||||||||||||||||||||||||||||
| 2713 | 0 | ▶ | my $self = shift(); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
colorspace: not called CC=6 SCAR=37.4
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 2714 | 0 | my $type = shift(); | |||||||||||||||||||||||||||||||||||||||||||
| 2715 | |||||||||||||||||||||||||||||||||||||||||||||
| 2716 | 0 | ▶ | if ($type eq 'act') { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 5 branches
| |||||||||||||||||||||||||||||||||||||||||||||
| 2717 | 0 | my $file = shift(); | |||||||||||||||||||||||||||||||||||||||||||
| 2718 | 0 | return $self->colorspace_act($file); | |||||||||||||||||||||||||||||||||||||||||||
| 2719 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2720 | elsif ($type eq 'web') { | ||||||||||||||||||||||||||||||||||||||||||||
| 2721 | 0 | return $self->colorspace_web(); | |||||||||||||||||||||||||||||||||||||||||||
| 2722 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2723 | elsif ($type eq 'hue') { | ||||||||||||||||||||||||||||||||||||||||||||
| 2724 | # This type is undocumented until either a reference can be found for | ||||||||||||||||||||||||||||||||||||||||||||
| 2725 | # this being a standard palette like the web color palette, or POD is | ||||||||||||||||||||||||||||||||||||||||||||
| 2726 | # added to the Hue colorspace class that describes how to use it. | ||||||||||||||||||||||||||||||||||||||||||||
| 2727 | 0 | return $self->colorspace_hue(); | |||||||||||||||||||||||||||||||||||||||||||
| 2728 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2729 | elsif ($type eq 'spot') { | ||||||||||||||||||||||||||||||||||||||||||||
| 2730 | 0 | my $name = shift(); | |||||||||||||||||||||||||||||||||||||||||||
| 2731 | 0 | my $alt_color = shift(); | |||||||||||||||||||||||||||||||||||||||||||
| 2732 | 0 | return $self->colorspace_separation($name, $alt_color); | |||||||||||||||||||||||||||||||||||||||||||
| 2733 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2734 | elsif ($type eq 'device') { | ||||||||||||||||||||||||||||||||||||||||||||
| 2735 | 0 | my @colors = @_; | |||||||||||||||||||||||||||||||||||||||||||
| 2736 | 0 | return $self->colorspace_devicen(\@colors); | |||||||||||||||||||||||||||||||||||||||||||
| 2737 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2738 | else { | ||||||||||||||||||||||||||||||||||||||||||||
| 2739 | 0 | croak "Unrecognized or unsupported colorspace: $type"; | |||||||||||||||||||||||||||||||||||||||||||
| 2740 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2741 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2742 | |||||||||||||||||||||||||||||||||||||||||||||
| 2743 | sub colorspace_act { | ||||||||||||||||||||||||||||||||||||||||||||
| 2744 | 0 | ▶ | my ($self, $file) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
colorspace_act: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 2745 | |||||||||||||||||||||||||||||||||||||||||||||
| 2746 | 0 | require PDF::API2::Resource::ColorSpace::Indexed::ACTFile; | |||||||||||||||||||||||||||||||||||||||||||
| 2747 | 0 | return PDF::API2::Resource::ColorSpace::Indexed::ACTFile->new($self->{'pdf'}, | |||||||||||||||||||||||||||||||||||||||||||
| 2748 | $file); | ||||||||||||||||||||||||||||||||||||||||||||
| 2749 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2750 | |||||||||||||||||||||||||||||||||||||||||||||
| 2751 | sub colorspace_web { | ||||||||||||||||||||||||||||||||||||||||||||
| 2752 | 1 | ▶ | my $self = shift(); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
colorspace_web: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 2753 | |||||||||||||||||||||||||||||||||||||||||||||
| 2754 | 1 | require PDF::API2::Resource::ColorSpace::Indexed::WebColor; | |||||||||||||||||||||||||||||||||||||||||||
| 2755 | 1 | return PDF::API2::Resource::ColorSpace::Indexed::WebColor->new($self->{'pdf'}); | |||||||||||||||||||||||||||||||||||||||||||
| 2756 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2757 | |||||||||||||||||||||||||||||||||||||||||||||
| 2758 | sub colorspace_hue { | ||||||||||||||||||||||||||||||||||||||||||||
| 2759 | 0 | ▶ | my $self = shift(); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
colorspace_hue: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 2760 | |||||||||||||||||||||||||||||||||||||||||||||
| 2761 | 0 | require PDF::API2::Resource::ColorSpace::Indexed::Hue; | |||||||||||||||||||||||||||||||||||||||||||
| 2762 | 0 | return PDF::API2::Resource::ColorSpace::Indexed::Hue->new($self->{'pdf'}); | |||||||||||||||||||||||||||||||||||||||||||
| 2763 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2764 | |||||||||||||||||||||||||||||||||||||||||||||
| 2765 | sub colorspace_separation { | ||||||||||||||||||||||||||||||||||||||||||||
| 2766 | 0 | ▶ | my ($self, $name, @clr) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
colorspace_separation: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 2767 | |||||||||||||||||||||||||||||||||||||||||||||
| 2768 | 0 | require PDF::API2::Resource::ColorSpace::Separation; | |||||||||||||||||||||||||||||||||||||||||||
| 2769 | 0 | return PDF::API2::Resource::ColorSpace::Separation->new($self->{'pdf'}, | |||||||||||||||||||||||||||||||||||||||||||
| 2770 | pdfkey(), | ||||||||||||||||||||||||||||||||||||||||||||
| 2771 | $name, | ||||||||||||||||||||||||||||||||||||||||||||
| 2772 | @clr); | ||||||||||||||||||||||||||||||||||||||||||||
| 2773 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2774 | |||||||||||||||||||||||||||||||||||||||||||||
| 2775 | sub colorspace_devicen { | ||||||||||||||||||||||||||||||||||||||||||||
| 2776 | 0 | ▶ | my ($self, $clrs) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
colorspace_devicen: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 2777 | |||||||||||||||||||||||||||||||||||||||||||||
| 2778 | 0 | require PDF::API2::Resource::ColorSpace::DeviceN; | |||||||||||||||||||||||||||||||||||||||||||
| 2779 | 0 | return PDF::API2::Resource::ColorSpace::DeviceN->new($self->{'pdf'}, | |||||||||||||||||||||||||||||||||||||||||||
| 2780 | pdfkey(), | ||||||||||||||||||||||||||||||||||||||||||||
| 2781 | $clrs); | ||||||||||||||||||||||||||||||||||||||||||||
| 2782 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2783 | |||||||||||||||||||||||||||||||||||||||||||||
| 2784 | =head2 egstate | ||||||||||||||||||||||||||||||||||||||||||||
| 2785 | |||||||||||||||||||||||||||||||||||||||||||||
| 2786 | $resource = $pdf->egstate(); | ||||||||||||||||||||||||||||||||||||||||||||
| 2787 | |||||||||||||||||||||||||||||||||||||||||||||
| 2788 | Creates and returns a new extended graphics state object, described in | ||||||||||||||||||||||||||||||||||||||||||||
| 2789 | L<PDF::API2::ExtGState>. | ||||||||||||||||||||||||||||||||||||||||||||
| 2790 | |||||||||||||||||||||||||||||||||||||||||||||
| 2791 | =cut | ||||||||||||||||||||||||||||||||||||||||||||
| 2792 | |||||||||||||||||||||||||||||||||||||||||||||
| 2793 | sub egstate { | ||||||||||||||||||||||||||||||||||||||||||||
| 2794 | 3 | ▶ | my $self = shift(); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
egstate: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 2795 | |||||||||||||||||||||||||||||||||||||||||||||
| 2796 | 3 | my $obj = PDF::API2::Resource::ExtGState->new($self->{'pdf'}, pdfkey()); | |||||||||||||||||||||||||||||||||||||||||||
| 2797 | |||||||||||||||||||||||||||||||||||||||||||||
| 2798 | 3 | $self->{'pdf'}->out_obj($self->{'pages'}); | |||||||||||||||||||||||||||||||||||||||||||
| 2799 | |||||||||||||||||||||||||||||||||||||||||||||
| 2800 | 3 | return $obj; | |||||||||||||||||||||||||||||||||||||||||||
| 2801 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2802 | |||||||||||||||||||||||||||||||||||||||||||||
| 2803 | sub default { | ||||||||||||||||||||||||||||||||||||||||||||
| 2804 | 8 | ▶ | my ($self, $parameter, $value) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
default: called CC=2 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||||||||||||||||||
| 2805 | |||||||||||||||||||||||||||||||||||||||||||||
| 2806 | # Parameter names may consist of lowercase letters, numbers, and underscores | ||||||||||||||||||||||||||||||||||||||||||||
| 2807 | 8 | $parameter = lc $parameter; | |||||||||||||||||||||||||||||||||||||||||||
| 2808 | 8 | $parameter =~ s/[^a-z\d_]//g; | |||||||||||||||||||||||||||||||||||||||||||
| 2809 | |||||||||||||||||||||||||||||||||||||||||||||
| 2810 | 8 | my $previous_value = $self->{$parameter}; | |||||||||||||||||||||||||||||||||||||||||||
| 2811 | 8 | ▶ | if (defined $value) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 2812 | 2 | $self->{$parameter} = $value; | |||||||||||||||||||||||||||||||||||||||||||
| 2813 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2814 | 8 | return $previous_value; | |||||||||||||||||||||||||||||||||||||||||||
| 2815 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2816 | |||||||||||||||||||||||||||||||||||||||||||||
| 2817 | sub xo_form { | ||||||||||||||||||||||||||||||||||||||||||||
| 2818 | 4 | ▶ | my $self = shift(); | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
xo_form: called CC=1 SCAR=0.0
Pod
undocumented
| |||||||||||||||||||||||||||||||||||||||||||||
| 2819 | |||||||||||||||||||||||||||||||||||||||||||||
| 2820 | 4 | my $obj = PDF::API2::Resource::XObject::Form::Hybrid->new($self->{'pdf'}); | |||||||||||||||||||||||||||||||||||||||||||
| 2821 | |||||||||||||||||||||||||||||||||||||||||||||
| 2822 | 4 | $self->{'pdf'}->out_obj($self->{'pages'}); | |||||||||||||||||||||||||||||||||||||||||||
| 2823 | |||||||||||||||||||||||||||||||||||||||||||||
| 2824 | 4 | return $obj; | |||||||||||||||||||||||||||||||||||||||||||
| 2825 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2826 | |||||||||||||||||||||||||||||||||||||||||||||
| 2827 | sub pattern { | ||||||||||||||||||||||||||||||||||||||||||||
| 2828 | 0 | ▶ | my ($self, %opts) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
pattern: not called CC=1 SCAR=6.9
Pod
undocumented
| |||||||||||||||||||||||||||||||||||||||||||||
| 2829 | |||||||||||||||||||||||||||||||||||||||||||||
| 2830 | 0 | my $obj = PDF::API2::Resource::Pattern->new($self->{'pdf'}, undef, %opts); | |||||||||||||||||||||||||||||||||||||||||||
| 2831 | |||||||||||||||||||||||||||||||||||||||||||||
| 2832 | 0 | $self->{'pdf'}->out_obj($self->{'pages'}); | |||||||||||||||||||||||||||||||||||||||||||
| 2833 | |||||||||||||||||||||||||||||||||||||||||||||
| 2834 | 0 | return $obj; | |||||||||||||||||||||||||||||||||||||||||||
| 2835 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2836 | |||||||||||||||||||||||||||||||||||||||||||||
| 2837 | sub shading { | ||||||||||||||||||||||||||||||||||||||||||||
| 2838 | 0 | ▶ | my ($self, %opts) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
shading: not called CC=1 SCAR=6.9
Pod
undocumented
| |||||||||||||||||||||||||||||||||||||||||||||
| 2839 | |||||||||||||||||||||||||||||||||||||||||||||
| 2840 | 0 | my $obj = PDF::API2::Resource::Shading->new($self->{'pdf'}, undef, %opts); | |||||||||||||||||||||||||||||||||||||||||||
| 2841 | |||||||||||||||||||||||||||||||||||||||||||||
| 2842 | 0 | $self->{'pdf'}->out_obj($self->{'pages'}); | |||||||||||||||||||||||||||||||||||||||||||
| 2843 | |||||||||||||||||||||||||||||||||||||||||||||
| 2844 | 0 | return $obj; | |||||||||||||||||||||||||||||||||||||||||||
| 2845 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2846 | |||||||||||||||||||||||||||||||||||||||||||||
| 2847 | sub named_destination { | ||||||||||||||||||||||||||||||||||||||||||||
| 2848 | 0 | ▶ | my ($self, $cat, $name, $obj) = @_; | ||||||||||||||||||||||||||||||||||||||||||
|
Subroutine
named_destination: not called CC=8 SCAR=42.8
Pod
undocumented
| |||||||||||||||||||||||||||||||||||||||||||||
| 2849 | 0 | my $root = $self->{'catalog'}; | |||||||||||||||||||||||||||||||||||||||||||
| 2850 | |||||||||||||||||||||||||||||||||||||||||||||
| 2851 | 0 | ▶ | $root->{'Names'} ||= PDFDict(); | ||||||||||||||||||||||||||||||||||||||||||
|
Condition0%0/3
$root->{"Names"} ||= PDFDict()
MC/DC0%0/2
$root->{"Names"} ||= PDFDict()
$root->{"Names"}
PDFDict()
Truth table0%0/3
A ||= B
A= $root->{"Names"}B= PDFDict()
| |||||||||||||||||||||||||||||||||||||||||||||
| 2852 | 0 | ▶ | $root->{'Names'}->{$cat} ||= PDFDict(); | ||||||||||||||||||||||||||||||||||||||||||
|
Condition0%0/3
$root->{"Names"}{$cat} ||= PDFDict()
MC/DC0%0/2
$root->{"Names"}{$cat} ||= PDFDict()
$root->{"Names"}{$cat}
PDFDict()
Truth table0%0/3
A ||= B
A= $root->{"Names"}{$cat}B= PDFDict()
| |||||||||||||||||||||||||||||||||||||||||||||
| 2853 | 0 | ▶ | $root->{'Names'}->{$cat}->{'-vals'} ||= {}; | ||||||||||||||||||||||||||||||||||||||||||
|
Condition0%0/2
$root->{"Names"}{$cat}{"-vals"} ||= {}
MC/DC0%0/1
$root->{"Names"}{$cat}{"-vals"} ||= {}
$root->{"Names"}{$cat}{"-vals"}
Truth table0%0/2
A
A= $root->{"Names"}{$cat}{"-vals"}
| |||||||||||||||||||||||||||||||||||||||||||||
| 2854 | 0 | ▶ | $root->{'Names'}->{$cat}->{'Limits'} ||= PDFArray(); | ||||||||||||||||||||||||||||||||||||||||||
|
Condition0%0/3
$root->{"Names"}{$cat}{"Limits"} ||= PDFArray()
MC/DC0%0/2
$root->{"Names"}{$cat}{"Limits"} ||= PDFArray()
$root->{"Names"}{$cat}{"Limits"}
PDFArray()
Truth table0%0/3
A ||= B
A= $root->{"Names"}{$cat}{"Limits"}B= PDFArray()
| |||||||||||||||||||||||||||||||||||||||||||||
| 2855 | 0 | ▶ | $root->{'Names'}->{$cat}->{'Names'} ||= PDFArray(); | ||||||||||||||||||||||||||||||||||||||||||
|
Condition0%0/3
$root->{"Names"}{$cat}{"Names"} ||= PDFArray()
MC/DC0%0/2
$root->{"Names"}{$cat}{"Names"} ||= PDFArray()
$root->{"Names"}{$cat}{"Names"}
PDFArray()
Truth table0%0/3
A ||= B
A= $root->{"Names"}{$cat}{"Names"}B= PDFArray()
| |||||||||||||||||||||||||||||||||||||||||||||
| 2856 | |||||||||||||||||||||||||||||||||||||||||||||
| 2857 | 0 | ▶ | unless (defined $obj) { | ||||||||||||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||||||||||||
| 2858 | 0 | $obj = PDF::API2::NamedDestination->new($self->{'pdf'}); | |||||||||||||||||||||||||||||||||||||||||||
| 2859 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2860 | 0 | $root->{'Names'}->{$cat}->{'-vals'}->{$name} = $obj; | |||||||||||||||||||||||||||||||||||||||||||
| 2861 | |||||||||||||||||||||||||||||||||||||||||||||
| 2862 | 0 | my @names = sort {$a cmp $b} keys %{$root->{'Names'}->{$cat}->{'-vals'}}; | |||||||||||||||||||||||||||||||||||||||||||
| 2863 | |||||||||||||||||||||||||||||||||||||||||||||
| 2864 | 0 | $root->{'Names'}->{$cat}->{'Limits'}->{' val'}->[0] = PDFStr($names[0]); | |||||||||||||||||||||||||||||||||||||||||||
| 2865 | 0 | $root->{'Names'}->{$cat}->{'Limits'}->{' val'}->[1] = PDFStr($names[-1]); | |||||||||||||||||||||||||||||||||||||||||||
| 2866 | |||||||||||||||||||||||||||||||||||||||||||||
| 2867 | 0 | @{$root->{'Names'}->{$cat}->{'Names'}->{' val'}} = (); | |||||||||||||||||||||||||||||||||||||||||||
| 2868 | |||||||||||||||||||||||||||||||||||||||||||||
| 2869 | 0 | foreach my $k (@names) { | |||||||||||||||||||||||||||||||||||||||||||
| 2870 | 0 | push @{$root->{'Names'}->{$cat}->{'Names'}->{' val'}}, ( | |||||||||||||||||||||||||||||||||||||||||||
| 2871 | PDFStr($k), | ||||||||||||||||||||||||||||||||||||||||||||
| 2872 | 0 | $root->{'Names'}->{$cat}->{'-vals'}->{$k} | |||||||||||||||||||||||||||||||||||||||||||
| 2873 | ); | ||||||||||||||||||||||||||||||||||||||||||||
| 2874 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2875 | |||||||||||||||||||||||||||||||||||||||||||||
| 2876 | 0 | return $obj; | |||||||||||||||||||||||||||||||||||||||||||
| 2877 | } | ||||||||||||||||||||||||||||||||||||||||||||
| 2878 | |||||||||||||||||||||||||||||||||||||||||||||
| 2879 | 38 | 1; | |||||||||||||||||||||||||||||||||||||||||||
| 2880 | |||||||||||||||||||||||||||||||||||||||||||||
| 2881 | __END__ | ||||||||||||||||||||||||||||||||||||||||||||