API2/Content.pm

filter: Statementstmt 74.6% 776 / 1040 Branchbran 58.2% 233 / 400 Conditioncond 35.0% 55 / 157 MC/DCmcdc 14.4% 14 / 97 Subroutinesub 87.6% 128 / 146 Podpod 78.2% 79 / 101 totaltotal 66.2% 1285 / 1941 SCAR 79.9
CC
268
Cov
67%
textlabel
306.0
_makecolor
264.6
textstate
110.0
CRAP 2938.2
« API2/Resource/Font/Postscript.pm ↑ Summary API2/Resource/CIDFont.pm »
1 package PDF::API2::Content;
2  
3 38 ▶use base 'PDF::API2::Basic::PDF::Dict';
Subroutine BEGIN: called CC=1 SCAR=0.0
4  
5 38 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
6 38 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
7  
8 38 our $VERSION = '2.044'; # VERSION
9  
10 38 ▶use Carp;
Subroutine BEGIN: called CC=1 SCAR=0.0
11 38 ▶use Compress::Zlib ();
Subroutine BEGIN: called CC=1 SCAR=0.0
12 38 ▶use Encode;
Subroutine BEGIN: called CC=1 SCAR=0.0
13 38 ▶use Math::Trig;
Subroutine BEGIN: called CC=1 SCAR=0.0
14 38 ▶use PDF::API2::Matrix;
Subroutine BEGIN: called CC=1 SCAR=0.0
15  
16 38 ▶use PDF::API2::Basic::PDF::Utils;
Subroutine BEGIN: called CC=1 SCAR=0.0
17 38 ▶use PDF::API2::Util;
Subroutine BEGIN: called CC=1 SCAR=0.0
18  
19 =head1 NAME
20  
21 PDF::API2::Content - Methods for adding graphics and text to a PDF
22  
23 =head1 SYNOPSIS
24  
25 # Start with a PDF page (new or opened)
26 my $pdf = PDF::API2->new();
27 my $page = $pdf->page();
28  
29 # Add a new content object
30 my $content = $page->graphics();
31 my $content = $page->text();
32  
33 # Then call the methods below to add graphics and text to the page.
34  
35 =cut
36  
37 sub new {
38 122 ▶ my $class = shift();
Subroutine new: called CC=1 SCAR=0.0
Pod documented
39 122 my $self = $class->SUPER::new();
40  
41 122 $self->{' stream'} = '';
42 122 $self->{' poststream'} = '';
43 122 $self->{' font'} = undef;
44 122 $self->{' fontset'} = 0;
45 122 $self->{' fontsize'} = 0;
46 122 $self->{' charspace'} = 0;
47 122 $self->{' hscale'} = 100;
48 122 $self->{' wordspace'} = 0;
49 122 $self->{' leading'} = 0;
50 122 $self->{' rise'} = 0;
51 122 $self->{' render'} = 0;
52 122 $self->{' matrix'} = [1, 0, 0, 1, 0, 0];
53 122 $self->{' textmatrix'} = [1, 0, 0, 1, 0, 0];
54 122 $self->{' textlinematrix'} = [0, 0];
55 122 $self->{' textlinestart'} = 0;
56 122 $self->{' fillcolor'} = [0];
57 122 $self->{' strokecolor'} = [0];
58 122 $self->{' translate'} = [0, 0];
59 122 $self->{' scale'} = [1, 1];
60 122 $self->{' skew'} = [0, 0];
61 122 $self->{' rotate'} = 0;
62 122 $self->{' apiistext'} = 0;
63  
64 122 return $self;
65 }
66  
67 sub outobjdeep {
68 114 ▶ my $self = shift();
Subroutine outobjdeep: called CC=3 SCAR=11.0
Pod documented
69 114 $self->textend();
70 114 ▶ if ($self->{'-docompress'} and $self->{'Filter'}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->{"-docompress"} and $self->{"Filter"}) 6 108 114
Condition66%2/3
$self->{"-docompress"} and $self->{"Filter"}
!ll&&!rl&&r
10806
MC/DC50%1/2
$self->{"-docompress"} and $self->{"Filter"}
$self->{"-docompress"} $self->{"Filter"}
Truth table66%2/3
A and B
A= $self->{"-docompress"}B= $self->{"Filter"}
ABresult
0X0
100
111
71 6 $self->{' stream'} = Compress::Zlib::compress($self->{' stream'});
72 6 $self->{' nofilt'} = 1;
73 6 delete $self->{'-docompress'};
74 }
75 114 return $self->SUPER::outobjdeep(@_);
76 }
77  
78 =head1 COORDINATE TRANSFORMATIONS
79  
80 The methods in this section change the coordinate system for the current content
81 object relative to the rest of the document.
82  
83 Changes to the coordinate system only affect subsequent paths or text.
84  
85 A call to any of the methods in this section resets the coordinate system before
86 applying its changes, unless the C<relative> option is set.
87  
88 =head2 translate
89  
90 $content = $content->translate($x, $y);
91  
92 Moves the origin along the x and y axes.
93  
94 =cut
95  
96 sub _translate {
97 12 ▶ my ($x, $y) = @_;
Subroutine _translate: called CC=1 SCAR=0.0
98 12 return (1, 0, 0, 1, $x, $y);
99 }
100  
101 sub translate {
102 2 ▶ my ($self, $x, $y) = @_;
Subroutine translate: called CC=1 SCAR=0.0
Pod documented
103 2 $self->transform(translate => [$x, $y]);
104 }
105  
106 =head2 rotate
107  
108 $content = $content->rotate($degrees);
109  
110 Rotates the coordinate system counter-clockwise.
111  
112 Use a negative argument to rotate clockwise.
113  
114 =cut
115  
116 sub _rotate {
117 9 ▶ my $a = deg2rad(shift());
Subroutine _rotate: called CC=1 SCAR=0.0
118 9 return (cos($a), sin($a), -sin($a), cos($a), 0, 0);
119 }
120  
121 sub rotate {
122 1 ▶ my ($self, $a) = @_;
Subroutine rotate: called CC=1 SCAR=0.0
Pod documented
123 1 $self->transform(rotate => $a);
124 }
125  
126 =head2 scale
127  
128 $content = $content->scale($x, $y);
129  
130 Scales (stretches) the coordinate systems along the x and y axes. A value of 1
131 for either C<$x> or C<$y> represents 100% scale (i.e. no change).
132  
133 =cut
134  
135 sub _scale {
136 9 ▶ my ($x, $y) = @_;
Subroutine _scale: called CC=1 SCAR=0.0
137 9 return ($x, 0, 0, $y, 0, 0);
138 }
139  
140 sub scale {
141 1 ▶ my ($self, $sx, $sy) = @_;
Subroutine scale: called CC=1 SCAR=0.0
Pod documented
142 1 $self->transform(scale => [$sx, $sy]);
143 }
144  
145 =head2 skew
146  
147 $content = $content->skew($a, $b);
148  
149 Skews the coordinate system by C<$a> degrees (counter-clockwise) from the x axis
150 and C<$b> degrees (clockwise) from the y axis.
151  
152 =cut
153  
154 sub _skew {
155 9 ▶ my $a = deg2rad(shift());
Subroutine _skew: called CC=1 SCAR=0.0
156 9 my $b = deg2rad(shift());
157 9 return (1, tan($a), tan($b), 1, 0, 0);
158 }
159  
160 sub skew {
161 1 ▶ my ($self, $a, $b) = @_;
Subroutine skew: called CC=1 SCAR=0.0
Pod documented
162 1 $self->transform(skew => [$a, $b]);
163 }
164  
165 =head2 transform
166  
167 $content = $content->transform(
168 translate => [$x, $y],
169 rotate => $degrees,
170 scale => [$x, $y],
171 skew => [$a, $b],
172 repeat => $boolean,
173 );
174  
175 Performs multiple coordinate transformations, in the order recommended by the
176 PDF specification (translate, rotate, scale, then skew). Omitted options will
177 be unchanged.
178  
179 If C<repeat> is true and if this is not the first call to a transformation
180 method, the previous transformation will be performed again, modified by any
181 other provided arguments.
182  
183 =cut
184  
185 sub _to_matrix {
186 39 ▶ my @array = @_;
Subroutine _to_matrix: called CC=1 SCAR=0.0
187 39 return PDF::API2::Matrix->new([$array[0], $array[1], 0],
188 [$array[2], $array[3], 0],
189 [$array[4], $array[5], 1]);
190 }
191  
192 sub _transform {
193 15 ▶ my %opts = @_;
Subroutine _transform: called CC=7 SCAR=20.1
194 15 my $m = PDF::API2::Matrix->new([1, 0, 0], [0, 1, 0], [0, 0, 1]);
195  
196 # Undocumented; only used by textpos()
197 15 ▶ if (defined $opts{'-matrix'}) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $opts{"-matrix"}) 0 15 15
198 0 $m = $m->multiply(_to_matrix(@{$opts{'-matrix'}}));
199 }
200  
201 # Note that the transformations are applied in reverse order. See PDF 1.7
202 # specification section 8.3.4: Transformation Matrices.
203 15 ▶ if (defined $opts{'skew'}) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $opts{"skew"}) 9 6 15
204 9 $m = $m->multiply(_to_matrix(_skew(@{$opts{'skew'}})));
205 }
206 15 ▶ if (defined $opts{'scale'}) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $opts{"scale"}) 9 6 15
207 9 $m = $m->multiply(_to_matrix(_scale(@{$opts{'scale'}})));
208 }
209 15 ▶ if (defined $opts{'rotate'}) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $opts{"rotate"}) 9 6 15
210 9 $m = $m->multiply(_to_matrix(_rotate($opts{'rotate'})));
211 }
212 15 ▶ if (defined $opts{'translate'}) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $opts{"translate"}) 12 3 15
213 12 $m = $m->multiply(_to_matrix(_translate(@{$opts{'translate'}})));
214 }
215  
216 # Undocumented; only used by textpos()
217 15 ▶ if ($opts{'-point'}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($opts{"-point"}) 0 15 15
218 my $mp = PDF::API2::Matrix->new([$opts{'-point'}->[0],
219 0 $opts{'-point'}->[1], 1]);
220 0 $mp = $mp->multiply($m);
221 0 return ($mp->[0][0], $mp->[0][1]);
222 }
223  
224 return (
225 15 $m->[0][0], $m->[0][1],
226 $m->[1][0], $m->[1][1],
227 $m->[2][0], $m->[2][1]
228 );
229 }
230  
231 # Transformations are described in the PDF 1.7 specification, section 8.3.3:
232 # Common Transformations.
233 sub transform {
234 16 ▶ my ($self, %options) = @_;
Subroutine transform: called CC=10 SCAR=23.1
Pod documented
235 16 ▶ return $self->transform_rel(%options) if $options{'repeat'};
Branch: 1 branch
BranchTrueFalseTotal
if $options{"repeat"} 0 16 16
236  
237 # Deprecated (renamed to 'repeat' to avoid confusion)
238 16 ▶ return $self->transform_rel(%options) if $options{'relative'};
Branch: 1 branch
BranchTrueFalseTotal
if $options{"relative"} 1 15 16
239  
240 # Deprecated options (remove hyphens)
241 15 foreach my $option (qw(translate rotate scale skew)) {
242 60 ▶ if (exists $options{'-' . $option}) {
Branch: 1 branch
BranchTrueFalseTotal
if (exists $options{'-' . $option}) 14 46 60
243 14 ▶ $options{$option} //= delete $options{'-' . $option};
Condition33%1/3
$options{$option} //= delete $options{'-' . $option}
l!l&&r!l&&!r
0140
MC/DC0%0/2
$options{$option} //= delete $options{'-' . $option}
$options{$option} delete $options{'-' . $option}
Truth table33%1/3
A //= B
A= $options{$option}B= delete $options{'-' . $option}
ABresult
1X1
011
000
244 }
245 }
246  
247 # Apply the transformations
248 15 $self->matrix(_transform(%options));
249  
250 # Store the transformations for lookup or future relative transformations
251 15 ▶ $self->{' translate'} = $options{'translate'} // [0, 0];
Condition100%2/2
$options{"translate"} // [0, 0]
l!l
123
MC/DC100%1/1
$options{"translate"} // [0, 0]
$options{"translate"}
Truth table100%2/2
A
A= $options{"translate"}
Aresult
11
00
252 15 ▶ $self->{' rotate'} = $options{'rotate'} // 0;
Condition100%2/2
$options{"rotate"} // 0
l!l
96
MC/DC100%1/1
$options{"rotate"} // 0
$options{"rotate"}
Truth table100%2/2
A
A= $options{"rotate"}
Aresult
11
00
253 15 ▶ $self->{' scale'} = $options{'scale'} // [1, 1];
Condition100%2/2
$options{"scale"} // [1, 1]
l!l
96
MC/DC100%1/1
$options{"scale"} // [1, 1]
$options{"scale"}
Truth table100%2/2
A
A= $options{"scale"}
Aresult
11
00
254 15 ▶ $self->{' skew'} = $options{'skew'} // [0, 0];
Condition100%2/2
$options{"skew"} // [0, 0]
l!l
96
MC/DC100%1/1
$options{"skew"} // [0, 0]
$options{"skew"}
Truth table100%2/2
A
A= $options{"skew"}
Aresult
11
00
255  
256 15 return $self;
257 }
258  
259 sub transform_rel {
260 2 ▶ my ($self, %options) = @_;
Subroutine transform_rel: called CC=8 SCAR=21.3
Pod documented
261  
262 # Deprecated options (remove hyphens)
263 2 foreach my $option (qw(translate rotate scale skew)) {
264 8 ▶ if (exists $options{'-' . $option}) {
Branch: 1 branch
BranchTrueFalseTotal
if (exists $options{'-' . $option}) 4 4 8
265 4 ▶ $options{$option} //= delete $options{'-' . $option};
Condition33%1/3
$options{$option} //= delete $options{'-' . $option}
l!l&&r!l&&!r
040
MC/DC0%0/2
$options{$option} //= delete $options{'-' . $option}
$options{$option} delete $options{'-' . $option}
Truth table33%1/3
A //= B
A= $options{$option}B= delete $options{'-' . $option}
ABresult
1X1
011
000
266 }
267 }
268  
269 2 ▶ my ($sa1, $sb1) = @{$options{'skew'} ? $options{'skew'} : [0, 0]};
Branch: 1 branch
BranchTrueFalseTotal
$options{'skew'} ? : 2 0 2
270 2 my ($sa0, $sb0) = @{$self->{' skew'}};
271  
272 2 ▶ my ($sx1, $sy1) = @{$options{'scale'} ? $options{'scale'} : [1, 1]};
Branch: 1 branch
BranchTrueFalseTotal
$options{'scale'} ? : 2 0 2
273 2 my ($sx0, $sy0) = @{$self->{' scale'}};
274  
275 2 ▶ my $r1 = $options{'rotate'} // 0;
Condition50%1/2
$options{"rotate"} // 0
l!l
20
MC/DC0%0/1
$options{"rotate"} // 0
$options{"rotate"}
Truth table50%1/2
A
A= $options{"rotate"}
Aresult
11
00
276 2 my $r0 = $self->{' rotate'};
277  
278 2 ▶ my ($tx1, $ty1) = @{$options{'translate'} ? $options{'translate'} : [0, 0]};
Branch: 1 branch
BranchTrueFalseTotal
$options{'translate'} ? : 2 0 2
279 2 my ($tx0, $ty0) = @{$self->{' translate'}};
280  
281 2 $self->transform(
282 skew => [$sa0 + $sa1, $sb0 + $sb1],
283 scale => [$sx0 * $sx1, $sy0 * $sy1],
284 rotate => $r0 + $r1,
285 translate => [$tx0 + $tx1, $ty0 + $ty1],
286 );
287  
288 2 return $self;
289 }
290  
291 =head2 matrix
292  
293 $graphics = $graphics->matrix($a, $b, $c, $d, $e, $f);
294  
295 ($a, $b, $c, $d, $e, $f) = $text->matrix($a, $b, $c, $d, $e, $f);
296  
297 Sets the current transformation matrix manually. Unless you have a particular
298 need to enter transformations manually, you should use the C<transform> method
299 instead.
300  
301 The return value differs based on whether the caller is a graphics content
302 object or a text content object.
303  
304 =cut
305  
306 sub _matrix_text {
307 3 ▶ my ($a, $b, $c, $d, $e, $f) = @_;
Subroutine _matrix_text: called CC=1 SCAR=0.0
308 3 return (floats($a, $b, $c, $d, $e, $f), 'Tm');
309 }
310  
311 sub _matrix_gfx {
312 23 ▶ my ($a, $b, $c, $d, $e, $f) = @_;
Subroutine _matrix_gfx: called CC=1 SCAR=0.0
313 23 return (floats($a, $b, $c, $d, $e, $f), 'cm');
314 }
315  
316 sub matrix {
317 26 ▶ my $self = shift();
Subroutine matrix: called CC=4 SCAR=13.9
Pod documented
318 26 ▶ if (scalar(@_)) {
Branch: 1 branch
BranchTrueFalseTotal
if (scalar @_) 26 0 26
319 26 my ($a, $b, $c, $d, $e, $f) = @_;
320 26 ▶ if ($self->_in_text_object()) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->_in_text_object) { } 3 23 26
321 3 $self->add(_matrix_text($a, $b, $c, $d, $e, $f));
322 3 $self->{' textmatrix'} = [$a, $b, $c, $d, $e, $f];
323 3 $self->{' textlinematrix'} = [0, 0];
324 }
325 else {
326 23 $self->add(_matrix_gfx($a, $b, $c, $d, $e, $f));
327 }
328 }
329  
330 26 ▶ if ($self->_in_text_object()) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->_in_text_object) { } 3 23 26
331 3 return @{$self->{' textmatrix'}};
332 }
333 else {
334 23 return $self;
335 }
336 }
337  
338 sub matrix_update {
339 70 ▶ my ($self, $tx, $ty) = @_;
Subroutine matrix_update: called CC=1 SCAR=0.0
Pod undocumented
340 70 $self->{' textlinematrix'}->[0] += $tx;
341 70 $self->{' textlinematrix'}->[1] += $ty;
342 70 return $self;
343 }
344  
345 =head1 GRAPHICS STATE
346  
347 =head2 save
348  
349 $content = $content->save();
350  
351 Saves the current graphics state on a stack.
352  
353 =cut
354  
355 sub _save {
356 11 ▶ return 'q';
Subroutine _save: called CC=1 SCAR=0.0
357 }
358  
359 sub save {
360 11 ▶ my $self = shift;
Subroutine save: called CC=2 SCAR=7.9
Pod documented
361 11 ▶ if ($self->_in_text_object()) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->_in_text_object) 0 11 11
362 0 carp 'Calling save from a text content object has no effect';
363 0 return;
364 }
365  
366 11 $self->add(_save());
367  
368 11 return $self;
369 }
370  
371 =head2 restore
372  
373 $content = $content->restore();
374  
375 Restores the most recently saved graphics state, removing it from the stack.
376  
377 =cut
378  
379 sub _restore {
380 11 ▶ return 'Q';
Subroutine _restore: called CC=1 SCAR=0.0
381 }
382  
383 sub restore {
384 11 ▶ my $self = shift;
Subroutine restore: called CC=2 SCAR=7.9
Pod documented
385 11 ▶ if ($self->_in_text_object()) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->_in_text_object) 0 11 11
386 0 carp 'Calling save from a text content object has no effect';
387 0 return;
388 }
389  
390 11 $self->add(_restore());
391  
392 11 return $self;
393 }
394  
395 =head2 line_width
396  
397 $content = $content->line_width($points);
398  
399 Sets the width of the stroke in points.
400  
401 =cut
402  
403 sub _linewidth {
404 88 ▶ my $linewidth = shift();
Subroutine _linewidth: called CC=1 SCAR=0.0
405 88 return ($linewidth, 'w');
406 }
407  
408 # Deprecated (renamed)
409 87 ▶sub linewidth { return line_width(@_) }
Subroutine linewidth: called CC=1 SCAR=0.0
Pod documented
410  
411 sub line_width {
412 88 ▶ my ($self, $line_width) = @_;
Subroutine line_width: called CC=1 SCAR=0.0
Pod documented
413  
414 88 $self->add(_linewidth($line_width));
415  
416 88 return $self;
417 }
418  
419 =head2 line_cap
420  
421 $content = $content->line_cap($style);
422  
423 Sets the shape that will be used at the ends of open subpaths (and dashes, if
424 any) when they are stroked.
425  
426 =over
427  
428 =item * "butt" or 0 = Butt Cap, default
429  
430 The stroke ends at the end of the path, with no projection.
431  
432 =item * "round" or 1 = Round Cap)
433  
434 An arc is drawn around the end of the path with a diameter equal to the line
435 width, and is filled in.
436  
437 =item * "square" or 2 = Projecting Square Cap
438  
439 The stroke continues past the end of the path for half the line width.
440  
441 =back
442  
443 =cut
444  
445 sub _linecap {
446 2 ▶ my $linecap = shift();
Subroutine _linecap: called CC=1 SCAR=0.0
447 2 return ($linecap, 'J');
448 }
449  
450 # Deprecated (renamed)
451 1 ▶sub linecap { return line_cap(@_) }
Subroutine linecap: called CC=1 SCAR=0.0
Pod documented
452  
453 sub line_cap {
454 2 ▶ my $self = shift();
Subroutine line_cap: called CC=10 SCAR=28.7
Pod documented
455  
456 2 ▶ if ($self->{' graphics'} and not @_) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->{" graphics"} and not @_) 0 2 2
Condition66%2/3
$self->{" graphics"} and not @_
!ll&&!rl&&r
110
MC/DC0%0/2
$self->{" graphics"} and not @_
$self->{" graphics"} not @_
Truth table66%2/3
A and not(B)
A= $self->{" graphics"}B= not @_
ABresult
0X0
100
111
457 0 croak "Missing argument to line_cap";
458 }
459  
460 2 ▶ my $style = shift() // 0;
Condition50%1/2
shift() // 0
l!l
20
MC/DC0%0/1
shift() // 0
shift()
Truth table50%1/2
A
A= shift()
Aresult
11
00
461 2 ▶ $style = 0 if $style eq 'butt';
Branch: 1 branch
BranchTrueFalseTotal
if $style eq "butt" 0 2 2
462 2 ▶ $style = 1 if $style eq 'round';
Branch: 1 branch
BranchTrueFalseTotal
if $style eq "round" 1 1 2
463 2 ▶ $style = 2 if $style eq 'square';
Branch: 1 branch
BranchTrueFalseTotal
if $style eq "square" 0 2 2
464  
465 2 ▶ unless ($style >= 0 and $style <= 2) {
Branch: 1 branch
BranchTrueFalseTotal
unless ($style >= 0 and $style <= 2) 0 2 2
Condition33%1/3
$style >= 0 and $style <= 2
!ll&&!rl&&r
002
MC/DC0%0/2
$style >= 0 and $style <= 2
$style >= 0 $style <= 2
Truth table33%1/3
A and B
A= $style >= 0B= $style <= 2
ABresult
0X0
100
111
466 0 ▶ if ($self->{' graphics'}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->{' graphics'}) { } 0 0 0
467 0 croak "Unknown line cap style \"$style\"";
468 }
469 else {
470 0 confess "Unknown line cap style \"$style\"";
471 }
472 }
473  
474 2 $self->add(_linecap($style));
475  
476 2 return $self;
477 }
478  
479 =head2 line_join
480  
481 $content = $content->line_join($style);
482  
483 Sets the style of join to be used at corners of a path.
484  
485 =over
486  
487 =item * "miter" or 0 = Miter Join, default
488  
489 The outer edges of the stroke extend until they meet, up to the limit specified
490 below. If the limit would be surpassed, a bevel join is used instead.
491  
492 =item * "round" or 1 = Round Join
493  
494 A circle with a diameter equal to the linewidth is drawn around the corner
495 point, producing a rounded corner.
496  
497 =item * "bevel" or 2 = Bevel Join
498  
499 A triangle is drawn to fill in the notch between the two strokes.
500  
501 =back
502  
503 =cut
504  
505 sub _linejoin {
506 2 ▶ my $linejoin = shift();
Subroutine _linejoin: called CC=1 SCAR=0.0
507 2 return ($linejoin, 'j');
508 }
509  
510 # Deprecated (renamed)
511 1 ▶sub linejoin { return line_join(@_) }
Subroutine linejoin: called CC=1 SCAR=0.0
Pod documented
512  
513 sub line_join {
514 2 ▶ my $self = shift();
Subroutine line_join: called CC=10 SCAR=28.7
Pod documented
515  
516 2 ▶ if ($self->{' graphics'} and not @_) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->{" graphics"} and not @_) 0 2 2
Condition66%2/3
$self->{" graphics"} and not @_
!ll&&!rl&&r
110
MC/DC0%0/2
$self->{" graphics"} and not @_
$self->{" graphics"} not @_
Truth table66%2/3
A and not(B)
A= $self->{" graphics"}B= not @_
ABresult
0X0
100
111
517 0 croak "Missing argument to line_join";
518 }
519  
520 2 ▶ my $style = shift() // 0;
Condition50%1/2
shift() // 0
l!l
20
MC/DC0%0/1
shift() // 0
shift()
Truth table50%1/2
A
A= shift()
Aresult
11
00
521 2 ▶ $style = 0 if $style eq 'miter';
Branch: 1 branch
BranchTrueFalseTotal
if $style eq "miter" 0 2 2
522 2 ▶ $style = 1 if $style eq 'round';
Branch: 1 branch
BranchTrueFalseTotal
if $style eq "round" 0 2 2
523 2 ▶ $style = 2 if $style eq 'bevel';
Branch: 1 branch
BranchTrueFalseTotal
if $style eq "bevel" 1 1 2
524  
525 2 ▶ unless ($style >= 0 and $style <= 2) {
Branch: 1 branch
BranchTrueFalseTotal
unless ($style >= 0 and $style <= 2) 0 2 2
Condition33%1/3
$style >= 0 and $style <= 2
!ll&&!rl&&r
002
MC/DC0%0/2
$style >= 0 and $style <= 2
$style >= 0 $style <= 2
Truth table33%1/3
A and B
A= $style >= 0B= $style <= 2
ABresult
0X0
100
111
526 0 ▶ if ($self->{' graphics'}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->{' graphics'}) { } 0 0 0
527 0 croak "Unknown line join style \"$style\"";
528 }
529 else {
530 0 confess "Unknown line join style \"$style\"";
531 }
532 }
533  
534 2 $self->add(_linejoin($style));
535  
536 2 return $self;
537 }
538  
539 =head2 miter_limit
540  
541 $content = $content->miter_limit($ratio);
542  
543 Sets the miter limit when the line join style is a miter join.
544  
545 The C<$ratio> is the maximum length of the miter (inner to outer corner) divided
546 by the line width. Any miter above this ratio will be converted to a bevel
547 join. The practical effect is that lines meeting at shallow angles are chopped
548 off instead of producing long pointed corners.
549  
550 There is no documented default miter limit.
551  
552 =cut
553  
554 sub _miterlimit {
555 3 ▶ my $limit = shift();
Subroutine _miterlimit: called CC=1 SCAR=0.0
556 3 return ($limit, 'M');
557 }
558  
559 # Deprecated; miterlimit was originally named incorrectly
560 1 ▶sub meterlimit { return miter_limit(@_) }
Subroutine meterlimit: called CC=1 SCAR=0.0
Pod documented
561  
562 # Deprecated (renamed)
563 1 ▶sub miterlimit { return miter_limit(@_) }
Subroutine miterlimit: called CC=1 SCAR=0.0
Pod documented
564  
565 sub miter_limit {
566 3 ▶ my ($self, $limit) = @_;
Subroutine miter_limit: called CC=1 SCAR=0.0
Pod documented
567  
568 3 $self->add(_miterlimit($limit));
569  
570 3 return $self;
571 }
572  
573 =head2 line_dash_pattern
574  
575 # Solid line
576 $content = $content->line_dash_pattern();
577  
578 # Equal length lines and gaps
579 $content = $content->line_dash_pattern($length);
580  
581 # Specified line and gap lengths
582 $content = $content->line_dash_pattern($line1, $gap1, $line2, $gap2, ...);
583  
584 # Offset the starting point
585 $content = $content->line_dash_pattern(
586 pattern => [$line1, $gap1, $line2, $gap2, ...],
587 offset => $points,
588 );
589  
590 Sets the line dash pattern.
591  
592 If called without any arguments, a solid line will be drawn.
593  
594 If called with one argument, the dashes and gaps will have equal lengths.
595  
596 If called with two or more arguments, the arguments represent alternating dash
597 and gap lengths.
598  
599 If called with a hash of arguments, a dash phase may be set, which specifies the
600 distance into the pattern at which to start the dash.
601  
602 =cut
603  
604 sub _linedash {
605 10 ▶ my @options = @_;
Subroutine _linedash: called CC=13 SCAR=46.2
606  
607 10 ▶ unless (@options) {
Branch: 1 branch
BranchTrueFalseTotal
unless (@options) 7 3 10
608 7 return ('[', ']', '0', 'd');
609 }
610  
611 3 ▶ if ($options[0] =~ /^\d/) {
Branch: 1 branch
BranchTrueFalseTotal
if ($options[0] =~ /^\d/) 3 0 3
612 3 return ('[', floats(@options), '] 0 d');
613 }
614  
615 0 my %options = @options;
616  
617 # Deprecated option names
618 0 ▶ if ($options{'-pattern'}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($options{"-pattern"}) 0 0 0
619 0 ▶ $options{'pattern'} //= delete $options{'-pattern'};
Condition0%0/3
$options{"pattern"} //= delete $options{"-pattern"}
l!l&&r!l&&!r
000
MC/DC0%0/2
$options{"pattern"} //= delete $options{"-pattern"}
$options{"pattern"} delete $options{"-pattern"}
Truth table0%0/3
A //= B
A= $options{"pattern"}B= delete $options{"-pattern"}
ABresult
1X1
011
000
620 }
621 0 ▶ if ($options{'-shift'}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($options{"-shift"}) 0 0 0
622 0 ▶ $options{'offset'} //= delete $options{'-shift'};
Condition0%0/3
$options{"offset"} //= delete $options{"-shift"}
l!l&&r!l&&!r
000
MC/DC0%0/2
$options{"offset"} //= delete $options{"-shift"}
$options{"offset"} delete $options{"-shift"}
Truth table0%0/3
A //= B
A= $options{"offset"}B= delete $options{"-shift"}
ABresult
1X1
011
000
623 }
624  
625 # Deprecated: the -full and -clear options will be removed in a future
626 # release
627 0 ▶ if (exists $options{'-full'} or exists $options{'-clear'}) {
Branch: 1 branch
BranchTrueFalseTotal
if (exists $options{"-full"} or exists $options{"-clear"}) 0 0 0
Condition0%0/3
exists $options{"-full"} or exists $options{"-clear"}
l!l&&r!l&&!r
000
MC/DC0%0/2
exists $options{"-full"} or exists $options{"-clear"}
exists $options{"-full"} exists $options{"-clear"}
Truth table0%0/3
A or B
A= exists $options{"-full"}B= exists $options{"-clear"}
ABresult
1X1
011
000
628 0 ▶ $options{'pattern'} //= [$options{'-full'} // 0, $options{'-clear'} // 0];
Condition0%0/6
$options{"pattern"} //= [$options{"-full"} // 0, $options{"-clear"} // 0]
l!l
00
$options{"-full"} // 0
l!l
00
$options{"-clear"} // 0
l!l
00
MC/DC0%0/1
$options{"pattern"} //= [$options{"-full"} // 0, $options{"-clear"} // 0]
$options{"pattern"}
MC/DC0%0/1
$options{"-full"} // 0
$options{"-full"}
MC/DC0%0/1
$options{"-clear"} // 0
$options{"-clear"}
Truth table0%0/2
A
A= $options{"pattern"}
Aresult
11
00
Truth table0%0/2
A
A= $options{"-full"}
Aresult
11
00
Truth table0%0/2
A
A= $options{"-clear"}
Aresult
11
00
629 }
630  
631 0 ▶ return ('[', floats(@{$options{'pattern'}}), ']',
Condition0%0/2
$options{'offset'} || 0
l!l
00
MC/DC0%0/1
$options{'offset'} || 0
$options{'offset'}
Truth table0%0/2
A
A= $options{'offset'}
Aresult
11
00
632 0 ($options{'offset'} || 0), 'd');
633 }
634  
635 # Deprecated (renamed)
636 7 ▶sub linedash { return line_dash_pattern(@_) }
Subroutine linedash: called CC=1 SCAR=0.0
Pod documented
637  
638 sub line_dash_pattern {
639 10 ▶ my ($self, @a) = @_;
Subroutine line_dash_pattern: called CC=1 SCAR=0.0
Pod documented
640  
641 10 $self->add(_linedash(@a));
642  
643 10 return $self;
644 }
645  
646 =head2 flatness_tolerance
647  
648 $content = $content->flatness_tolerance($tolerance);
649  
650 Sets the maximum distance in device pixels between the mathematically correct
651 path for a curve and an approximation constructed from straight line segments.
652  
653 C<$tolerance> is an integer between 0 and 100, where 0 represents the device's
654 default flatness tolerance.
655  
656 =cut
657  
658 sub _flatness {
659 2 ▶ my $flatness = shift();
Subroutine _flatness: called CC=1 SCAR=0.0
660 2 return ($flatness, 'i');
661 }
662  
663 # Deprecated (renamed)
664 1 ▶sub flatness { return flatness_tolerance(@_) }
Subroutine flatness: called CC=1 SCAR=0.0
Pod documented
665  
666 sub flatness_tolerance {
667 2 ▶ my ($self, $flatness) = @_;
Subroutine flatness_tolerance: called CC=1 SCAR=0.0
Pod documented
668  
669 2 $self->add(_flatness($flatness));
670  
671 2 return $self;
672 }
673  
674 =head2 egstate
675  
676 $content = $content->egstate($object);
677  
678 Adds a L<PDF::API2::Resource::ExtGState> object containing a set of graphics
679 state parameters.
680  
681 =cut
682  
683 sub egstate {
684 0 ▶ my ($self, $egstate) = @_;
Subroutine egstate: not called CC=1 SCAR=6.9
Pod documented
685 0 $self->add('/' . $egstate->name(), 'gs');
686 0 $self->resource('ExtGState', $egstate->name(), $egstate);
687 0 return $self;
688 }
689  
690 =head1 PATH CONSTRUCTION (DRAWING)
691  
692 Note that paths will not appear until a path painting method is called
693 (L</"stroke">, L</"fill">, or L</"paint">).
694  
695 =head2 move
696  
697 $content = $content->move($x, $y);
698  
699 Starts a new path at the specified coordinates.
700  
701 =cut
702  
703 sub _move {
704 0 ▶ my ($x, $y) =@_;
Subroutine _move: not called CC=1 SCAR=6.9
705 0 return (floats($x, $y), 'm');
706 }
707  
708 sub move {
709 107 ▶ my $self = shift();
Subroutine move: called CC=3 SCAR=11.1
Pod documented
710 107 my ($x, $y);
711 107 ▶ while (defined($x = shift())) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined($x = shift())) 107 107 214
712 107 $y = shift();
713 107 ▶ if ($self->_in_text_object()) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->_in_text_object) { } 0 107 107
714 0 $self->add_post(floats($x, $y), 'm');
715 }
716 else {
717 107 $self->add(floats($x, $y), 'm');
718 }
719 107 $self->{' x'} = $self->{' mx'} = $x;
720 107 $self->{' y'} = $self->{' my'} = $y;
721 }
722 107 return $self;
723 }
724  
725 =head2 line
726  
727 $content = $content->line($x, $y);
728  
729 Extends the path in a line from the current coordinates to the specified
730 coordinates.
731  
732 =cut
733  
734 sub _line {
735 0 ▶ my ($x, $y) = @_;
Subroutine _line: not called CC=1 SCAR=6.9
736 0 return (floats($x, $y), 'l');
737 }
738  
739 sub line {
740 95 ▶ my $self = shift();
Subroutine line: called CC=3 SCAR=11.1
Pod documented
741 95 my ($x, $y);
742 95 ▶ while (defined($x = shift())) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined($x = shift())) 96 95 191
743 96 $y = shift();
744 96 ▶ if ($self->_in_text_object()) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->_in_text_object) { } 0 96 96
745 0 $self->add_post(floats($x, $y), 'l');
746 }
747 else {
748 96 $self->add(floats($x, $y), 'l');
749 }
750 96 $self->{' x'} = $x;
751 96 $self->{' y'} = $y;
752 }
753 95 return $self;
754 }
755  
756 =head2 hline
757  
758 $content = $content->hline($x);
759  
760 Extends the path in a horizontal line from the current position to the specified
761 x coordinate.
762  
763 =cut
764  
765 sub hline {
766 2 ▶ my ($self, $x) = @_;
Subroutine hline: called CC=2 SCAR=7.2
Pod documented
767 2 $self->{' x'} = $x;
768 2 ▶ if ($self->_in_text_object()) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->_in_text_object) { } 0 2 2
769 0 $self->add_post(floats($x, $self->{' y'}), 'l');
770 }
771 else {
772 2 $self->add(floats($x, $self->{' y'}), 'l');
773 }
774 2 return $self;
775 }
776  
777 =head2 vline
778  
779 $content = $content->vline($x);
780  
781 Extends the path in a vertical line from the current position to the specified y
782 coordinate.
783  
784 =cut
785  
786 sub vline {
787 1 ▶ my ($self, $y) = @_;
Subroutine vline: called CC=2 SCAR=7.2
Pod documented
788 1 ▶ if ($self->_in_text_object()) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->_in_text_object) { } 0 1 1
789 0 $self->add_post(floats($self->{' x'}, $y), 'l');
790 }
791 else {
792 1 $self->add(floats($self->{' x'}, $y), 'l');
793 }
794 1 $self->{' y'} = $y;
795 1 return $self;
796 }
797  
798 =head2 polyline
799  
800 $content = $content->polyline($x1, $y1, $x2, $y2, ...);
801  
802 Extends the path from the current position in one or more straight lines.
803  
804 =cut
805  
806 sub polyline {
807 2 ▶ my $self = shift();
Subroutine polyline: called CC=3 SCAR=11.1
Pod documented
808 2 ▶ unless (@_ % 2 == 0) {
Branch: 1 branch
BranchTrueFalseTotal
unless (@_ % 2 == 0) 0 2 2
809 0 croak 'polyline requires pairs of coordinates';
810 }
811  
812 2 ▶ while (@_) {
Branch: 1 branch
BranchTrueFalseTotal
if (@_) 3 2 5
813 3 my $x = shift();
814 3 my $y = shift();
815 3 $self->line($x, $y);
816 }
817  
818 2 return $self;
819 }
820  
821 # Deprecated; replace with move and polyline. Deprecated because poly breaks
822 # the convention followed by every other path-drawing method (other than
823 # enclosed shapes) of extending the path from the current position.
824 sub poly {
825 2 ▶ my $self = shift();
Subroutine poly: called CC=1 SCAR=0.0
Pod documented
826 2 my $x = shift();
827 2 my $y = shift();
828 2 $self->move($x, $y);
829 2 $self->line(@_);
830 2 return $self;
831 }
832  
833 =head2 curve
834  
835 $content = $content->curve($cx1, $cy1, $cx2, $cy2, $x, $y);
836  
837 Extends the path in a curve from the current point to C<($x, $y)>, using the two
838 specified points to create a cubic Bezier curve.
839  
840 =cut
841  
842 sub curve {
843 78 ▶ my $self = shift();
Subroutine curve: called CC=3 SCAR=11.0
Pod documented
844 78 my ($x1, $y1, $x2, $y2, $x3, $y3);
845 78 ▶ while (defined($x1 = shift())) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined($x1 = shift())) 78 78 156
846 78 $y1 = shift();
847 78 $x2 = shift();
848 78 $y2 = shift();
849 78 $x3 = shift();
850 78 $y3 = shift();
851 78 ▶ if ($self->_in_text_object()) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->_in_text_object) { } 0 78 78
852 0 $self->add_post(floats($x1, $y1, $x2, $y2, $x3, $y3), 'c');
853 }
854 else {
855 78 $self->add(floats($x1, $y1, $x2, $y2, $x3, $y3), 'c');
856 }
857 78 $self->{' x'} = $x3;
858 78 $self->{' y'} = $y3;
859 }
860 78 return $self;
861 }
862  
863 =head2 spline
864  
865 $content = $content->spline($cx1, $cy1, $x, $y);
866  
867 Extends the path in a curve from the current point to C<($x, $y)>, using the two
868 specified points to create a spline.
869  
870 =cut
871  
872 sub spline {
873 1 ▶ my $self = shift();
Subroutine spline: called CC=2 SCAR=6.9
Pod documented
874  
875 1 ▶ while (scalar @_ >= 4) {
Branch: 1 branch
BranchTrueFalseTotal
if (scalar @_ >= 4) 1 1 2
876 1 my $cx = shift();
877 1 my $cy = shift();
878 1 my $x = shift();
879 1 my $y = shift();
880 1 my $c1x = (2 * $cx + $self->{' x'}) / 3;
881 1 my $c1y = (2 * $cy + $self->{' y'}) / 3;
882 1 my $c2x = (2 * $cx + $x) / 3;
883 1 my $c2y = (2 * $cy + $y) / 3;
884 1 $self->curve($c1x, $c1y, $c2x, $c2y, $x, $y);
885 }
886 }
887  
888 =head2 arc
889  
890 $content = $content->arc($x, $y, $major, $minor, $a, $b);
891  
892 Extends the path along an arc of an ellipse centered at C<[$x, $y]>. C<$major>
893 and C<$minor> represent the axes of the ellipse, and the arc moves from C<$a>
894 degrees to C<$b> degrees.
895  
896 =cut
897  
898 # Private
899 sub arctocurve {
900 144 ▶ my ($a, $b, $alpha, $beta) = @_;
Subroutine arctocurve: called CC=2 SCAR=6.9
Pod undocumented
901 144 ▶ if (abs($beta - $alpha) > 30) {
Branch: 1 branch
BranchTrueFalseTotal
if (abs $beta - $alpha > 30) { } 68 76 144
902 return (
903 68 arctocurve($a, $b, $alpha, ($beta + $alpha) / 2),
904 arctocurve($a, $b, ($beta + $alpha) / 2, $beta)
905 );
906 }
907 else {
908 76 $alpha = ($alpha * pi / 180);
909 76 $beta = ($beta * pi / 180);
910  
911 76 my $bcp = (4.0 / 3 * (1 - cos(($beta - $alpha) / 2)) / sin(($beta - $alpha) / 2));
912 76 my $sin_alpha = sin($alpha);
913 76 my $sin_beta = sin($beta);
914 76 my $cos_alpha = cos($alpha);
915 76 my $cos_beta = cos($beta);
916  
917 76 my $p0_x = $a * $cos_alpha;
918 76 my $p0_y = $b * $sin_alpha;
919 76 my $p1_x = $a * ($cos_alpha - $bcp * $sin_alpha);
920 76 my $p1_y = $b * ($sin_alpha + $bcp * $cos_alpha);
921 76 my $p2_x = $a * ($cos_beta + $bcp * $sin_beta);
922 76 my $p2_y = $b * ($sin_beta - $bcp * $cos_beta);
923 76 my $p3_x = $a * $cos_beta;
924 76 my $p3_y = $b * $sin_beta;
925  
926 76 return ($p0_x, $p0_y, $p1_x, $p1_y, $p2_x, $p2_y, $p3_x, $p3_y);
927 }
928 }
929  
930 sub arc {
931 4 ▶ my ($self, $x, $y, $a, $b, $alpha, $beta, $move) = @_;
Subroutine arc: called CC=3 SCAR=11.0
Pod documented
932 4 my @points = arctocurve($a, $b, $alpha, $beta);
933 4 my ($p0_x, $p0_y, $p1_x, $p1_y, $p2_x, $p2_y, $p3_x, $p3_y);
934  
935 4 $p0_x = $x + shift(@points);
936 4 $p0_y = $y + shift(@points);
937  
938 # Deprecated
939 4 ▶ $self->move($p0_x, $p0_y) if $move;
Branch: 1 branch
BranchTrueFalseTotal
if $move 3 1 4
940  
941 4 ▶ while (scalar @points) {
Branch: 1 branch
BranchTrueFalseTotal
if (scalar @points) 40 4 44
942 40 $p1_x = $x + shift(@points);
943 40 $p1_y = $y + shift(@points);
944 40 $p2_x = $x + shift(@points);
945 40 $p2_y = $y + shift(@points);
946 40 $p3_x = $x + shift(@points);
947 40 $p3_y = $y + shift(@points);
948 40 $self->curve($p1_x, $p1_y, $p2_x, $p2_y, $p3_x, $p3_y);
949 40 shift(@points);
950 40 shift(@points);
951 40 $self->{' x'} = $p3_x;
952 40 $self->{' y'} = $p3_y;
953 }
954 4 return $self;
955 }
956  
957 # Extends the path along an arc of a circle of the specified radius from
958 # C<[x1,y1]> to C<[x2,y2]>.
959 #
960 # Set C<$move> to a true value if this arc is the beginning of a new path
961 # instead of the continuation of an existing path.
962 #
963 # Set C<$outer> to a true value to draw the larger arc between the two points
964 # instead of the smaller one.
965 #
966 # Set C<$reverse> to a true value to draw the mirror image of the specified arc.
967 #
968 # C<$radius * 2> cannot be smaller than the distance from C<[x1,y1]> to
969 # C<[x2,y2]>.
970  
971 # Deprecated; recreate using arc (Bogen is German for arc)
972 sub bogen {
973 4 ▶ my ($self, $x1, $y1, $x2, $y2, $r, $move, $larc, $spf) = @_;
Subroutine bogen: called CC=15 SCAR=27.3
Pod undocumented
974 4 my ($p0_x, $p0_y, $p1_x, $p1_y, $p2_x, $p2_y, $p3_x, $p3_y);
975 4 my $x = $x2 - $x1;
976 4 my $y = $y2 - $y1;
977 4 my $z = sqrt($x ** 2 + $y ** 2);
978 4 my $alpha_rad = asin($y / $z);
979  
980 4 ▶ $alpha_rad += pi / 2 if $x < 0 and $y > 0;
Branch: 1 branch
BranchTrueFalseTotal
if $x < 0 and $y > 0 0 4 4
Condition33%1/3
$x < 0 and $y > 0
!ll&&!rl&&r
400
MC/DC0%0/2
$x < 0 and $y > 0
$x < 0 $y > 0
Truth table33%1/3
A and B
A= $x < 0B= $y > 0
ABresult
0X0
100
111
981 4 ▶ $alpha_rad -= pi / 2 if $x < 0 and $y < 0;
Branch: 1 branch
BranchTrueFalseTotal
if $x < 0 and $y < 0 0 4 4
Condition33%1/3
$x < 0 and $y < 0
!ll&&!rl&&r
400
MC/DC0%0/2
$x < 0 and $y < 0
$x < 0 $y < 0
Truth table33%1/3
A and B
A= $x < 0B= $y < 0
ABresult
0X0
100
111
982  
983 4 my $alpha = rad2deg($alpha_rad);
984 # use the complement angle for span
985 4 ▶ $alpha -= 180 if $spf and $spf > 0;
Branch: 1 branch
BranchTrueFalseTotal
if $spf and $spf > 0 1 3 4
Condition66%2/3
$spf and $spf > 0
!ll&&!rl&&r
301
MC/DC50%1/2
$spf and $spf > 0
$spf $spf > 0
Truth table66%2/3
A and B
A= $spfB= $spf > 0
ABresult
0X0
100
111
986  
987 4 my $d = 2 * $r;
988 4 my ($beta, $beta_rad, @points);
989  
990 4 $beta = rad2deg(2 * asin($z / $d));
991 4 ▶ $beta = 360 - $beta if $larc and $larc > 0;
Branch: 1 branch
BranchTrueFalseTotal
if $larc and $larc > 0 1 3 4
Condition66%2/3
$larc and $larc > 0
!ll&&!rl&&r
301
MC/DC50%1/2
$larc and $larc > 0
$larc $larc > 0
Truth table66%2/3
A and B
A= $larcB= $larc > 0
ABresult
0X0
100
111
992  
993 4 $beta_rad = deg2rad($beta);
994  
995 4 @points = arctocurve($r, $r, 90 + $alpha + $beta / 2, 90 + $alpha - $beta / 2);
996  
997 4 ▶ if ($spf and $spf > 0) {
Branch: 1 branch
BranchTrueFalseTotal
if ($spf and $spf > 0) 1 3 4
Condition66%2/3
$spf and $spf > 0
!ll&&!rl&&r
301
MC/DC50%1/2
$spf and $spf > 0
$spf $spf > 0
Truth table66%2/3
A and B
A= $spfB= $spf > 0
ABresult
0X0
100
111
998 1 my @pts = @points;
999 1 @points = ();
1000 1 ▶ while ($y = pop(@pts)) {
Branch: 1 branch
BranchTrueFalseTotal
if ($y = pop @pts) 15 1 16
1001 15 $x = pop(@pts);
1002 15 push(@points, $x, $y);
1003 }
1004 }
1005  
1006 4 $p0_x = shift(@points);
1007 4 $p0_y = shift(@points);
1008 4 $x = $x1 - $p0_x;
1009 4 $y = $y1 - $p0_y;
1010  
1011 4 ▶ $self->move($x1, $y1) if $move;
Branch: 1 branch
BranchTrueFalseTotal
if $move 1 3 4
1012  
1013 4 ▶ while (scalar @points) {
Branch: 1 branch
BranchTrueFalseTotal
if (scalar @points) 36 4 40
1014 36 $p1_x = $x + shift(@points);
1015 36 $p1_y = $y + shift(@points);
1016 36 $p2_x = $x + shift(@points);
1017 36 $p2_y = $y + shift(@points);
1018 # if we run out of data points, use the end point instead
1019 36 ▶ if (scalar @points == 0) {
Branch: 1 branch
BranchTrueFalseTotal
if (scalar @points == 0) { } 1 35 36
1020 1 $p3_x = $x2;
1021 1 $p3_y = $y2;
1022 }
1023 else {
1024 35 $p3_x = $x + shift(@points);
1025 35 $p3_y = $y + shift(@points);
1026 }
1027 36 $self->curve($p1_x, $p1_y, $p2_x, $p2_y, $p3_x, $p3_y);
1028 36 shift(@points);
1029 36 shift(@points);
1030 }
1031 4 return $self;
1032 }
1033  
1034 =head2 close
1035  
1036 $content = $content->close();
1037  
1038 Closes the current path by extending a line from the current position to the
1039 starting position.
1040  
1041 =cut
1042  
1043 sub close {
1044 13 ▶ my $self = shift();
Subroutine close: called CC=1 SCAR=0.0
Pod documented
1045 13 $self->add('h');
1046 13 $self->{' x'} = $self->{' mx'};
1047 13 $self->{' y'} = $self->{' my'};
1048 13 return $self;
1049 }
1050  
1051 =head2 end
1052  
1053 $content = $content->end();
1054  
1055 Ends the current path without filling or stroking.
1056  
1057 =cut
1058  
1059 # Deprecated (renamed)
1060 1 ▶sub endpath { return end(@_) }
Subroutine endpath: called CC=1 SCAR=0.0
Pod documented
1061  
1062 sub end {
1063 2 ▶ my $self = shift();
Subroutine end: called CC=1 SCAR=0.0
Pod documented
1064 2 $self->add('n');
1065 2 return $self;
1066 }
1067  
1068 =head1 SHAPE CONSTRUCTION (DRAWING)
1069  
1070 The following are convenience methods for drawing closed paths.
1071  
1072 Note that shapes will not appear until a path painting method is called
1073 (L</"stroke">, L</"fill">, or L</"paint">).
1074  
1075 =head2 rectangle
1076  
1077 $content = $content->rectangle($x1, $y1, $x2, $y2);
1078  
1079 Creates a new rectangle-shaped path, between the two points C<[$x1, $y1]>
1080 and C<[$x2, $y2]>.
1081  
1082 =cut
1083  
1084 sub rectangle {
1085 2 ▶ my ($self, $x1, $y1, $x2, $y2) = @_;
Subroutine rectangle: called CC=3 SCAR=11.4
Pod documented
1086  
1087 # Ensure that x1,y1 is lower-left and x2,y2 is upper-right
1088 2 ▶ if ($x2 < $x1) {
Branch: 1 branch
BranchTrueFalseTotal
if ($x2 < $x1) 1 1 2
1089 1 my $x = $x1;
1090 1 $x1 = $x2;
1091 1 $x2 = $x;
1092 }
1093 2 ▶ if ($y2 < $y1) {
Branch: 1 branch
BranchTrueFalseTotal
if ($y2 < $y1) 0 2 2
1094 0 my $y = $y1;
1095 0 $y1 = $y2;
1096 0 $y2 = $y;
1097 }
1098  
1099 2 $self->add(floats($x1, $y1, ($x2 - $x1), ($y2 - $y1)), 're');
1100 2 $self->{' x'} = $x1;
1101 2 $self->{' y'} = $y1;
1102  
1103 2 return $self;
1104 }
1105  
1106 # Deprecated; replace with individual calls to rectangle
1107 sub rect {
1108 5 ▶ my $self = shift();
Subroutine rect: called CC=2 SCAR=6.9
Pod documented
1109 5 my ($x, $y, $w, $h);
1110 5 ▶ while (defined($x = shift())) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined($x = shift())) 6 5 11
1111 6 $y = shift();
1112 6 $w = shift();
1113 6 $h = shift();
1114 6 $self->add(floats($x, $y, $w, $h), 're');
1115 }
1116 5 $self->{' x'} = $x;
1117 5 $self->{' y'} = $y;
1118 5 return $self;
1119 }
1120  
1121 # Deprecated; replace with rectangle, converting x2/y2 to w/h.
1122 sub rectxy {
1123 2 ▶ my ($self, $x, $y, $x2, $y2) = @_;
Subroutine rectxy: called CC=1 SCAR=0.0
Pod documented
1124 2 $self->rect($x, $y, ($x2 - $x), ($y2 - $y));
1125 2 return $self;
1126 }
1127  
1128 =head2 circle
1129  
1130 $content = $content->circle($x, $y, $radius);
1131  
1132 Creates a new circular path centered on C<[$x, $y]> with the specified radius.
1133  
1134 =cut
1135  
1136 sub circle {
1137 1 ▶ my ($self, $x, $y, $r) = @_;
Subroutine circle: called CC=1 SCAR=0.0
Pod documented
1138 1 $self->arc($x, $y, $r, $r, 0, 360, 1);
1139 1 $self->close();
1140 1 return $self;
1141 }
1142  
1143 =head2 ellipse
1144  
1145 $content = $content->ellipse($x, $y, $major, $minor);
1146  
1147 Creates a new elliptical path centered on C<[$x, $y]> with the specified major
1148 and minor axes.
1149  
1150 =cut
1151  
1152 sub ellipse {
1153 1 ▶ my ($self, $x, $y, $a, $b) = @_;
Subroutine ellipse: called CC=1 SCAR=0.0
Pod documented
1154 1 $self->arc($x, $y, $a, $b, 0, 360, 1);
1155 1 $self->close();
1156 1 return $self;
1157 }
1158  
1159 =head2 pie
1160  
1161 $content = $content->pie($x, $y, $major, $minor, $a, $b);
1162  
1163 Creates a new wedge-shaped path from an ellipse centered on C<[$x, $y]> with the
1164 specified major and minor axes, extending from C<$a> degrees to C<$b> degrees.
1165  
1166 =cut
1167  
1168 sub pie {
1169 0 ▶ my $self = shift();
Subroutine pie: not called CC=1 SCAR=6.9
Pod documented
1170 0 my ($x, $y, $a, $b, $alpha, $beta) = @_;
1171 0 my ($p0_x, $p0_y) = arctocurve($a, $b, $alpha, $beta);
1172 0 $self->move($x, $y);
1173 0 $self->line($p0_x + $x, $p0_y + $y);
1174 0 $self->arc($x, $y, $a, $b, $alpha, $beta);
1175 0 $self->close();
1176 }
1177  
1178 =head1 PATH PAINTING (DRAWING)
1179  
1180 =head2 stroke_color
1181  
1182 $content = $content->stroke_color($color, @arguments);
1183  
1184 Sets the stroke color, which is black by default.
1185  
1186 # Use a named color
1187 $content->stroke_color('blue');
1188  
1189 # Use an RGB color (start with '#')
1190 $content->stroke_color('#FF0000');
1191  
1192 # Use a CMYK color (start with '%')
1193 $content->stroke_color('%FF000000');
1194  
1195 # Use a spot color with 100% coverage.
1196 my $spot = $pdf->colorspace('spot', 'PANTONE Red 032 C', '#EF3340');
1197 $content->stroke_color($spot, 1.0);
1198  
1199 RGB and CMYK colors can have one-byte, two-byte, three-byte, or four-byte values
1200 for each color, depending on the level of precision needed. For instance, cyan
1201 can be given as C<%F000> or C<%FFFF000000000000>.
1202  
1203 =head2 fill_color
1204  
1205 $content = $content->fill_color($color, @arguments);
1206  
1207 Sets the fill color, which is black by default. Arguments are the same as in
1208 L</"stroke_color">.
1209  
1210 =cut
1211  
1212 # default colorspaces: rgb/hsv/named cmyk/hsl lab
1213 # ... only one text string
1214 #
1215 # pattern or shading space
1216 # ... only one object
1217 #
1218 # legacy greylevel
1219 # ... only one value
1220 sub _makecolor {
1221 26 ▶ my ($self, $sf, @clr) = @_;
Subroutine _makecolor: called CC=26 SCAR=55.8
1222  
1223 26 ▶ if ($clr[0] =~ /^[a-z\#\!]+/) {
Branch: 9 branches
BranchTrueFalseTotal
if ($clr[0] =~ /^[a-z\#\!]+/) { } 23 3 26
elsif ($clr[0] =~ /^[\%]+/) { } 2 1 3
elsif ($clr[0] =~ /^[\$\&]/) { } 0 1 1
elsif (scalar @clr == 1 and ref $clr[0]) { } 0 1 1
elsif (scalar @clr == 1) { } 0 1 1
elsif (scalar @clr > 1 and ref $clr[0]) { } 1 0 1
elsif (scalar @clr == 2) { } 0 0 0
elsif (scalar @clr == 3) { } 0 0 0
elsif (scalar @clr == 4) { } 0 0 0
1224 # colorname or #! specifier
1225 # with rgb target colorspace
1226 # namecolor returns always a RGB
1227 23 ▶ return namecolor($clr[0]), ($sf ? 'rg' : 'RG');
Branch: 1 branch
BranchTrueFalseTotal
$sf ? : 14 9 23
1228 }
1229 elsif ($clr[0] =~ /^[\%]+/) {
1230 # % specifier
1231 # with cmyk target colorspace
1232 2 ▶ return namecolor_cmyk($clr[0]), ($sf ? 'k' : 'K');
Branch: 1 branch
BranchTrueFalseTotal
$sf ? : 1 1 2
1233 }
1234 elsif ($clr[0] =~ /^[\$\&]/) {
1235 # &$ specifier
1236 # with L*a*b target colorspace
1237 0 ▶ if (!defined $self->resource('ColorSpace', 'LabS')) {
Branch: 1 branch
BranchTrueFalseTotal
unless (defined $self->resource("ColorSpace", "LabS")) 0 0 0
1238 0 my $dc = PDFDict();
1239 0 my $cs = PDFArray(PDFName('Lab'), $dc);
1240 0 $dc->{'WhitePoint'} = PDFArray(map { PDFNum($_) } qw(1 1 1));
1241 0 $dc->{'Range'} = PDFArray(map { PDFNum($_) } qw(-128 127 -128 127));
1242 0 $dc->{'Gamma'} = PDFArray(map { PDFNum($_) } qw(2.2 2.2 2.2));
1243 0 $self->resource('ColorSpace', 'LabS', $cs);
1244 }
1245 0 ▶ return '/LabS', ($sf ? 'cs' : 'CS'), namecolor_lab($clr[0]), ($sf ? 'sc' : 'SC');
Branch: 2 branches
BranchTrueFalseTotal
$sf ? : 0 0 0
$sf ? : 0 0 0
1246 }
1247 ▶ elsif (scalar @clr == 1 and ref($clr[0])) {
Condition33%1/3
scalar @clr == 1 and ref $clr[0]
!ll&&!rl&&r
100
MC/DC0%0/2
scalar @clr == 1 and ref $clr[0]
scalar @clr == 1 ref $clr[0]
Truth table33%1/3
A and B
A= scalar @clr == 1B= ref $clr[0]
ABresult
0X0
100
111
1248 # pattern or shading space
1249 0 ▶ return '/Pattern', ($sf ? 'cs' : 'CS'), '/' . ($clr[0]->name()), ($sf ? 'scn' : 'SCN');
Branch: 2 branches
BranchTrueFalseTotal
$sf ? : 0 0 0
$sf ? : 0 0 0
1250 }
1251 elsif (scalar @clr == 1) {
1252 # grey color spec.
1253 0 ▶ return $clr[0], $sf ? 'g' : 'G';
Branch: 1 branch
BranchTrueFalseTotal
$sf ? : 0 0 0
1254 }
1255 ▶ elsif (scalar @clr > 1 and ref($clr[0])) {
Condition33%1/3
scalar @clr > 1 and ref $clr[0]
!ll&&!rl&&r
001
MC/DC0%0/2
scalar @clr > 1 and ref $clr[0]
scalar @clr > 1 ref $clr[0]
Truth table33%1/3
A and B
A= scalar @clr > 1B= ref $clr[0]
ABresult
0X0
100
111
1256 # indexed colorspace plus color-index
1257 # or custom colorspace plus param
1258 1 my $cs = shift(@clr);
1259 1 ▶ return '/' . $cs->name(), ($sf ? 'cs' : 'CS'), $cs->param(@clr), ($sf ? 'sc' : 'SC');
Branch: 2 branches
BranchTrueFalseTotal
$sf ? : 0 1 1
$sf ? : 0 1 1
1260 }
1261 elsif (scalar @clr == 2) {
1262 # indexed colorspace plus color-index
1263 # or custom colorspace plus param
1264 0 ▶ return '/' . $clr[0]->name(), ($sf ? 'cs' : 'CS'), $clr[0]->param($clr[1]), ($sf ? 'sc' : 'SC');
Branch: 2 branches
BranchTrueFalseTotal
$sf ? : 0 0 0
$sf ? : 0 0 0
1265 }
1266 elsif (scalar @clr == 3) {
1267 # legacy rgb color-spec (0 <= x <= 1)
1268 0 ▶ return floats($clr[0], $clr[1], $clr[2]), ($sf ? 'rg' : 'RG');
Branch: 1 branch
BranchTrueFalseTotal
$sf ? : 0 0 0
1269 }
1270 elsif (scalar @clr == 4) {
1271 # legacy cmyk color-spec (0 <= x <= 1)
1272 0 ▶ return floats($clr[0], $clr[1], $clr[2], $clr[3]), ($sf ? 'k' : 'K');
Branch: 1 branch
BranchTrueFalseTotal
$sf ? : 0 0 0
1273 }
1274 else {
1275 0 die 'invalid color specification.';
1276 }
1277 }
1278  
1279 sub _fillcolor {
1280 15 ▶ my ($self, @clrs) = @_;
Subroutine _fillcolor: called CC=3 SCAR=13.3
1281 15 ▶ if (ref($clrs[0]) =~ m|^PDF::API2::Resource::ColorSpace|) {
Branch: 2 branches
BranchTrueFalseTotal
if (ref($clrs[0]) =~ /^PDF::API2::Resource::ColorSpace/) { } 0 15 15
elsif (ref($clrs[0]) =~ /^PDF::API2::Resource::Pattern/) { } 0 15 15
1282 0 $self->resource('ColorSpace', $clrs[0]->name(), $clrs[0]);
1283 }
1284 elsif (ref($clrs[0]) =~ m|^PDF::API2::Resource::Pattern|) {
1285 0 $self->resource('Pattern', $clrs[0]->name(), $clrs[0]);
1286 }
1287  
1288 15 return $self->_makecolor(1, @clrs);
1289 }
1290  
1291 # Deprecated
1292 13 ▶sub fillcolor { return fill_color(@_) }
Subroutine fillcolor: called CC=1 SCAR=0.0
Pod undocumented
1293  
1294 sub fill_color {
1295 15 ▶ my $self = shift();
Subroutine fill_color: called CC=2 SCAR=7.0
Pod documented
1296 15 ▶ if (@_) {
Branch: 1 branch
BranchTrueFalseTotal
if (@_) 15 0 15
1297 15 @{$self->{' fillcolor'}} = @_;
1298 15 $self->add($self->_fillcolor(@_));
1299 }
1300 15 return @{$self->{' fillcolor'}};
1301 }
1302  
1303 sub _strokecolor {
1304 11 ▶ my ($self, @clrs) = @_;
Subroutine _strokecolor: called CC=3 SCAR=11.3
1305 11 ▶ if (ref($clrs[0]) =~ m|^PDF::API2::Resource::ColorSpace|) {
Branch: 2 branches
BranchTrueFalseTotal
if (ref($clrs[0]) =~ /^PDF::API2::Resource::ColorSpace/) { } 1 10 11
elsif (ref($clrs[0]) =~ /^PDF::API2::Resource::Pattern/) { } 0 10 10
1306 1 $self->resource('ColorSpace', $clrs[0]->name(), $clrs[0]);
1307 }
1308 elsif (ref($clrs[0]) =~ m|^PDF::API2::Resource::Pattern|) {
1309 0 $self->resource('Pattern', $clrs[0]->name(), $clrs[0]);
1310 }
1311 11 return $self->_makecolor(0, @clrs);
1312 }
1313  
1314 # Deprecated
1315 8 ▶sub strokecolor { return stroke_color(@_) }
Subroutine strokecolor: called CC=1 SCAR=0.0
Pod undocumented
1316  
1317 sub stroke_color {
1318 11 ▶ my $self = shift();
Subroutine stroke_color: called CC=2 SCAR=7.0
Pod documented
1319 11 ▶ if (@_) {
Branch: 1 branch
BranchTrueFalseTotal
if (@_) 11 0 11
1320 11 @{$self->{' strokecolor'}} = @_;
1321 11 $self->add($self->_strokecolor(@_));
1322 }
1323 11 return @{$self->{' strokecolor'}};
1324 }
1325  
1326 =head2 stroke
1327  
1328 $content = $content->stroke();
1329  
1330 Strokes the current path.
1331  
1332 =cut
1333  
1334 sub _stroke {
1335 121 ▶ return 'S';
Subroutine _stroke: called CC=1 SCAR=0.0
1336 }
1337  
1338 sub stroke {
1339 121 ▶ my $self = shift();
Subroutine stroke: called CC=1 SCAR=0.0
Pod documented
1340 121 $self->add(_stroke());
1341 121 return $self;
1342 }
1343  
1344 =head2 fill
1345  
1346 $content = $content->fill(rule => $rule);
1347  
1348 Fills the current path.
1349  
1350 C<$rule> describes which areas are filled in when the path intersects with itself.
1351  
1352 =over
1353  
1354 =item * nonzero (default)
1355  
1356 Use the nonzero winding number rule. This tends to mean that the entire area
1357 enclosed by the path is filled in, with some exceptions depending on the
1358 direction of the path.
1359  
1360 =item * even-odd
1361  
1362 Use the even-odd rule. This tends to mean that the presence of fill alternates
1363 each time the path is intersected.
1364  
1365 =back
1366  
1367 See PDF specification 1.7 section 8.5.3.3, Filling, for more details.
1368  
1369 =cut
1370  
1371 sub fill {
1372 3 ▶ my $self = shift();
Subroutine fill: called CC=5 SCAR=16.2
Pod documented
1373  
1374 3 my $even_odd;
1375 3 ▶ if (@_ == 2) {
Branch: 1 branch
BranchTrueFalseTotal
if (@_ == 2) { } 1 2 3
1376 1 my %options = @_;
1377 1 ▶ if (($options{'rule'} // 'nonzero') eq 'even-odd') {
Branch: 1 branch
BranchTrueFalseTotal
if (($options{"rule"} // "nonzero") eq "even-odd") 1 0 1
Condition50%1/2
$options{"rule"} // "nonzero"
l!l
10
MC/DC0%0/1
$options{"rule"} // "nonzero"
$options{"rule"}
Truth table50%1/2
A
A= $options{"rule"}
Aresult
11
00
1378 1 $even_odd = 1;
1379 }
1380 }
1381 else {
1382 # Deprecated
1383 2 $even_odd = shift();
1384 }
1385  
1386 3 ▶ $self->add($even_odd ? 'f*' : 'f');
Branch: 1 branch
BranchTrueFalseTotal
$even_odd ? : 2 1 3
1387  
1388 3 return $self;
1389 }
1390  
1391 =head2 paint
1392  
1393 $content = $content->paint(rule => $rule);
1394  
1395 Fills and strokes the current path. C<$rule> is as described in L</"fill">.
1396  
1397 =cut
1398  
1399 # Deprecated (renamed)
1400 2 ▶sub fillstroke { return paint(@_) }
Subroutine fillstroke: called CC=1 SCAR=0.0
Pod documented
1401  
1402 sub paint {
1403 4 ▶ my $self = shift();
Subroutine paint: called CC=5 SCAR=16.2
Pod documented
1404  
1405 4 my $even_odd;
1406 4 ▶ if (@_ == 2) {
Branch: 1 branch
BranchTrueFalseTotal
if (@_ == 2) { } 1 3 4
1407 1 my %options = @_;
1408 1 ▶ if (($options{'rule'} // 'nonzero') eq 'even-odd') {
Branch: 1 branch
BranchTrueFalseTotal
if (($options{"rule"} // "nonzero") eq "even-odd") 1 0 1
Condition50%1/2
$options{"rule"} // "nonzero"
l!l
10
MC/DC0%0/1
$options{"rule"} // "nonzero"
$options{"rule"}
Truth table50%1/2
A
A= $options{"rule"}
Aresult
11
00
1409 1 $even_odd = 1;
1410 }
1411 }
1412 else {
1413 # Deprecated
1414 3 $even_odd = shift();
1415 }
1416  
1417 4 ▶ $self->add($even_odd ? 'B*' : 'B');
Branch: 1 branch
BranchTrueFalseTotal
$even_odd ? : 2 2 4
1418  
1419 4 return $self;
1420 }
1421  
1422 =head2 clip
1423  
1424 $content = $content->clip(rule => $rule);
1425  
1426 Modifies the current clipping path (initially the entire page) by intersecting
1427 it with the current path following the next path-painting command. C<$rule> is
1428 as described in L</"fill">.
1429  
1430 =cut
1431  
1432 sub clip {
1433 3 ▶ my $self = shift();
Subroutine clip: called CC=5 SCAR=16.2
Pod documented
1434  
1435 3 my $even_odd;
1436 3 ▶ if (@_ == 2) {
Branch: 1 branch
BranchTrueFalseTotal
if (@_ == 2) { } 1 2 3
1437 1 my %options = @_;
1438 1 ▶ if (($options{'rule'} // 'nonzero') eq 'even-odd') {
Branch: 1 branch
BranchTrueFalseTotal
if (($options{"rule"} // "nonzero") eq "even-odd") 1 0 1
Condition50%1/2
$options{"rule"} // "nonzero"
l!l
10
MC/DC0%0/1
$options{"rule"} // "nonzero"
$options{"rule"}
Truth table50%1/2
A
A= $options{"rule"}
Aresult
11
00
1439 1 $even_odd = 1;
1440 }
1441 }
1442 else {
1443 # Deprecated
1444 2 $even_odd = shift();
1445 }
1446  
1447 3 ▶ $self->add($even_odd ? 'W*' : 'W');
Branch: 1 branch
BranchTrueFalseTotal
$even_odd ? : 2 1 3
1448  
1449 3 return $self;
1450 }
1451  
1452 sub shade {
1453 0 ▶ my ($self, $shade, @cord) = @_;
Subroutine shade: not called CC=1 SCAR=6.9
Pod undocumented
1454  
1455 0 my @tm = (
1456 $cord[2] - $cord[0], 0,
1457 0 , $cord[3] - $cord[1],
1458 $cord[0] , $cord[1],
1459 );
1460  
1461 0 $self->save();
1462 0 $self->matrix(@tm);
1463 0 $self->add('/' . $shade->name(), 'sh');
1464 0 $self->resource('Shading', $shade->name(), $shade);
1465 0 $self->restore();
1466  
1467 0 return $self;
1468 }
1469  
1470 =head1 EXTERNAL OBJECTS
1471  
1472 =head2 object
1473  
1474 $content = $content->object($object, $x, $y, $scale_x, $scale_y);
1475  
1476 Places an image or other external object (a.k.a. XObject) on the page in the
1477 specified location.
1478  
1479 For images, C<$scale_x> and C<$scale_y> represent the width and height of the
1480 image on the page in points. If C<$scale_x> is omitted, it will default to 72
1481 pixels per inch. If C<$scale_y> is omitted, the image will be scaled
1482 proportionally based on the image dimensions.
1483  
1484 For other external objects, the scale is a multiplier, where 1 (the default)
1485 represents 100% (i.e. no change).
1486  
1487 If coordinate transformations have been made (see Coordinate Transformations
1488 above), the position and scale will be relative to the updated coordinates.
1489  
1490 If no coordinate transformations are needed, this method can be called directly
1491 from the L<PDF::API2::Page> object instead.
1492  
1493 =cut
1494  
1495 # Behavior based on argument count
1496 # 0: Place at 0, 0, 100%
1497 # 2: Place at X, Y, 100%
1498 # 3: Place at X, Y, scaled
1499 # 4: Place at X, Y, scale_w, scale_h
1500 sub object {
1501 0 ▶ my ($self, $object, $x, $y, $scale_x, $scale_y) = @_;
Subroutine object: not called CC=8 SCAR=42.8
Pod documented
1502 0 ▶ $x //= 0;
Condition0%0/2
$x //= 0
l!l
00
MC/DC0%0/1
$x //= 0
$x
Truth table0%0/2
A
A= $x
Aresult
11
00
1503 0 ▶ $y //= 0;
Condition0%0/2
$y //= 0
l!l
00
MC/DC0%0/1
$y //= 0
$y
Truth table0%0/2
A
A= $y
Aresult
11
00
1504 0 ▶ if ($object->isa('PDF::API2::Resource::XObject::Image')) {
Branch: 1 branch
BranchTrueFalseTotal
if ($object->isa('PDF::API2::Resource::XObject::Image')) { } 0 0 0
1505 0 ▶ $scale_x //= $object->width();
Condition0%0/3
$scale_x //= $object->width
l!l&&r!l&&!r
000
MC/DC0%0/2
$scale_x //= $object->width
$scale_x $object->width
Truth table0%0/3
A //= B
A= $scale_xB= $object->width
ABresult
1X1
011
000
1506 0 ▶ $scale_y //= $object->height() * $scale_x / $object->width();
Condition0%0/3
$scale_y //= $object->height * $scale_x / $object->width
l!l&&r!l&&!r
000
MC/DC0%0/2
$scale_y //= $object->height * $scale_x / $object->width
$scale_y $object->height * $scale_x / $object->width
Truth table0%0/3
A //= B
A= $scale_yB= $object->height * $scale_x / $object->width
ABresult
1X1
011
000
1507 }
1508 else {
1509 0 ▶ $scale_x //= 1;
Condition0%0/2
$scale_x //= 1
l!l
00
MC/DC0%0/1
$scale_x //= 1
$scale_x
Truth table0%0/2
A
A= $scale_x
Aresult
11
00
1510 0 ▶ $scale_y //= $scale_x;
Condition0%0/3
$scale_y //= $scale_x
l!l&&r!l&&!r
000
MC/DC0%0/2
$scale_y //= $scale_x
$scale_y $scale_x
Truth table0%0/3
A //= B
A= $scale_yB= $scale_x
ABresult
1X1
011
000
1511 }
1512  
1513 0 $self->save();
1514 0 $self->matrix($scale_x, 0, 0, $scale_y, $x, $y);
1515 0 $self->add('/' . $object->name(), 'Do');
1516 0 $self->restore();
1517  
1518 0 $self->resource('XObject', $object->name(), $object);
1519  
1520 0 return $self;
1521 }
1522  
1523 # Deprecated
1524 sub image {
1525 8 ▶ my $self = shift;
Subroutine image: called CC=5 SCAR=18.5
Pod documented
1526 8 my $img = shift;
1527 8 my ($x, $y, $w, $h) = @_;
1528 8 ▶ if (defined $img->{'Metadata'}) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $img->{"Metadata"}) 0 8 8
1529 0 $self->metaStart('PPAM:PlacedImage', $img->{'Metadata'});
1530 }
1531 8 $self->save();
1532 8 ▶ unless (defined $w) {
Branch: 2 branches
BranchTrueFalseTotal
if (defined $w) { } 8 0 8
(do { not defined $h }) 0 8 8
1533 0 $h = $img->height();
1534 0 $w = $img->width();
1535 }
1536 0 elsif (not defined $h) {
1537 0 $h = $img->height() * $w;
1538 0 $w = $img->width() * $w;
1539 }
1540 8 $self->matrix($w, 0, 0, $h, $x, $y);
1541 8 $self->add('/' . $img->name(), 'Do');
1542 8 $self->restore();
1543 8 $self->{' x'} = $x;
1544 8 $self->{' y'} = $y;
1545 8 $self->resource('XObject', $img->name(), $img);
1546 8 ▶ if (defined $img->{'Metadata'}) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $img->{"Metadata"}) 0 8 8
1547 0 $self->metaEnd();
1548 }
1549 8 return $self;
1550 }
1551  
1552 # Deprecated
1553 sub formimage {
1554 2 ▶ my ($self, $img, $x, $y, $s) = @_;
Subroutine formimage: called CC=2 SCAR=7.1
Pod documented
1555 2 $self->save();
1556 2 ▶ if (defined $s) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $s) { } 2 0 2
1557 2 $self->matrix($s, 0, 0, $s, $x, $y);
1558 }
1559 else {
1560 0 $self->matrix(1, 0, 0, 1, $x, $y);
1561 }
1562 2 $self->add('/' . $img->name(), 'Do');
1563 2 $self->restore();
1564 2 $self->resource('XObject', $img->name(), $img);
1565 2 return $self;
1566 }
1567  
1568 =head1 TEXT STATE
1569  
1570 All of the following parameters that take a size are applied before any scaling
1571 takes place, so you don't need to adjust values to counteract scaling.
1572  
1573 =head2 font
1574  
1575 $content = $content->font($font, $size);
1576  
1577 Sets the font and font size. C<$font> is an object created by calling
1578 L<PDF::API2/"font"> to add the font to the document.
1579  
1580 my $pdf = PDF::API2->new();
1581 my $page = $pdf->page();
1582 my $text = $page->text();
1583  
1584 my $font = $pdf->font('Helvetica');
1585 $text->font($font, 24);
1586 $text->position(72, 720);
1587 $text->text('Hello, World!');
1588  
1589 $pdf->save('sample.pdf');
1590  
1591 =cut
1592  
1593 sub _font {
1594 18 ▶ my ($font, $size) = @_;
Subroutine _font: called CC=2 SCAR=6.9
1595 18 ▶ if ($font->isvirtual()) {
Branch: 1 branch
BranchTrueFalseTotal
if ($font->isvirtual) { } 1 17 18
1596 1 return('/' . $font->fontlist->[0]->name() . ' ' . float($size) . ' Tf');
1597 }
1598 else {
1599 17 return('/' . $font->name() . ' ' . float($size) . ' Tf');
1600 }
1601 }
1602 sub font {
1603 19 ▶ my ($self, $font, $size) = @_;
Subroutine font: called CC=2 SCAR=6.9
Pod documented
1604 19 ▶ unless ($size) {
Branch: 1 branch
BranchTrueFalseTotal
unless ($size) 1 18 19
1605 1 croak q{A font size is required};
1606 }
1607 18 $self->fontset($font, $size);
1608 18 $self->add(_font($font, $size));
1609 18 $self->{' fontset'} = 1;
1610 18 return $self;
1611 }
1612  
1613 sub fontset {
1614 18 ▶ my ($self, $font, $size) = @_;
Subroutine fontset: called CC=3 SCAR=11.0
Pod undocumented
1615 18 $self->{' font'} = $font;
1616 18 $self->{' fontsize'} = $size;
1617 18 $self->{' fontset'} = 0;
1618  
1619 18 ▶ if ($font->isvirtual()) {
Branch: 1 branch
BranchTrueFalseTotal
if ($font->isvirtual) { } 1 17 18
1620 1 foreach my $f (@{$font->fontlist()}) {
1621 2 $self->resource('Font', $f->name(), $f);
1622 }
1623 }
1624 else {
1625 17 $self->resource('Font', $font->name(), $font);
1626 }
1627  
1628 18 return $self;
1629 }
1630  
1631 =head2 character_spacing
1632  
1633 $spacing = $content->character_spacing($spacing);
1634  
1635 Sets the spacing between characters. This is initially zero.
1636  
1637 =cut
1638  
1639 sub _charspace {
1640 3 ▶ my $spacing = shift();
Subroutine _charspace: called CC=1 SCAR=0.0
1641 3 return float($spacing, 6) . ' Tc';
1642 }
1643  
1644 # Deprecated (renamed)
1645 3 ▶sub charspace { return character_spacing(@_) }
Subroutine charspace: called CC=1 SCAR=0.0
Pod documented
1646  
1647 sub character_spacing {
1648 4 ▶ my ($self, $spacing) = @_;
Subroutine character_spacing: called CC=2 SCAR=6.9
Pod documented
1649 4 ▶ if (defined $spacing) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $spacing) 3 1 4
1650 3 $self->{' charspace'} = $spacing;
1651 3 $self->add(_charspace($spacing));
1652 }
1653 4 return $self->{' charspace'};
1654 }
1655  
1656 =head2 word_spacing
1657  
1658 $spacing = $content->word_spacing($spacing);
1659  
1660 Sets the spacing between words. This is initially zero (i.e. just the width of
1661 the space).
1662  
1663 Word spacing might only affect simple fonts and composite fonts where the space
1664 character is a single-byte code. This is a limitation of the PDF specification
1665 at least as of version 1.7 (see section 9.3.3). It's possible that a later
1666 version of the specification will support word spacing in fonts that use
1667 multi-byte codes.
1668  
1669 =cut
1670  
1671 sub _wordspace {
1672 15 ▶ my $spacing = shift();
Subroutine _wordspace: called CC=1 SCAR=0.0
1673 15 return float($spacing, 6) . ' Tw';
1674 }
1675  
1676 # Deprecated (renamed)
1677 24 ▶sub wordspace { return word_spacing(@_) }
Subroutine wordspace: called CC=1 SCAR=0.0
Pod documented
1678  
1679 sub word_spacing {
1680 25 ▶ my ($self, $spacing) = @_;
Subroutine word_spacing: called CC=2 SCAR=6.9
Pod documented
1681 25 ▶ if (defined $spacing) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $spacing) 15 10 25
1682 15 $self->{' wordspace'} = $spacing;
1683 15 $self->add(_wordspace($spacing));
1684 }
1685 25 return $self->{' wordspace'};
1686 }
1687  
1688 =head2 hscale
1689  
1690 $scale = $content->hscale($scale);
1691  
1692 Sets/gets the percentage of horizontal text scaling. Enter a scale greater than
1693 100 to stretch text, less than 100 to squeeze text, or 100 to disable any
1694 existing scaling.
1695  
1696 =cut
1697  
1698 sub _hscale {
1699 2 ▶ my $scale = shift();
Subroutine _hscale: called CC=1 SCAR=0.0
1700 2 return float($scale, 6) . ' Tz';
1701 }
1702  
1703 sub hscale {
1704 14 ▶ my ($self, $scale) = @_;
Subroutine hscale: called CC=2 SCAR=6.9
Pod documented
1705 14 ▶ if (defined $scale) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $scale) 2 12 14
1706 2 $self->{' hscale'} = $scale;
1707 2 $self->add(_hscale($scale));
1708 }
1709 14 return $self->{' hscale'};
1710 }
1711  
1712 # Deprecated: hscale was originally named incorrectly (as hspace)
1713 1 ▶sub hspace { return hscale(@_) }
Subroutine hspace: called CC=1 SCAR=0.0
Pod documented
1714 0 ▶sub _hspace { return _hscale(@_) }
Subroutine _hspace: not called CC=1 SCAR=6.9
1715  
1716 =head2 leading
1717  
1718 $leading = $content->leading($leading);
1719  
1720 Sets/gets the text leading, which is the distance between baselines. This is
1721 initially zero (i.e. the lines will be printed on top of each other).
1722  
1723 =cut
1724  
1725 # Deprecated: leading is the correct name for this operator
1726 0 ▶sub _lead { return _leading(@_) }
Subroutine _lead: not called CC=1 SCAR=6.9
1727 1 ▶sub lead { return leading(@_) }
Subroutine lead: called CC=1 SCAR=0.0
Pod documented
1728  
1729 sub _leading {
1730 11 ▶ my $leading = shift();
Subroutine _leading: called CC=1 SCAR=0.0
1731 11 return float($leading) . ' TL';
1732 }
1733 sub leading {
1734 46 ▶ my ($self, $leading) = @_;
Subroutine leading: called CC=2 SCAR=6.9
Pod documented
1735 46 ▶ if (defined ($leading)) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $leading) 11 35 46
1736 11 $self->{' leading'} = $leading;
1737 11 $self->add(_leading($leading));
1738 }
1739 46 return $self->{' leading'};
1740 }
1741  
1742 =head2 render
1743  
1744 $mode = $content->render($mode);
1745  
1746 Sets the text rendering mode.
1747  
1748 =over
1749  
1750 =item * 0 = Fill text
1751  
1752 =item * 1 = Stroke text (outline)
1753  
1754 =item * 2 = Fill, then stroke text
1755  
1756 =item * 3 = Neither fill nor stroke text (invisible)
1757  
1758 =item * 4 = Fill text and add to path for clipping
1759  
1760 =item * 5 = Stroke text and add to path for clipping
1761  
1762 =item * 6 = Fill, then stroke text and add to path for clipping
1763  
1764 =item * 7 = Add text to path for clipping
1765  
1766 =back
1767  
1768 =cut
1769  
1770 sub _render {
1771 1 ▶ my $mode = shift();
Subroutine _render: called CC=1 SCAR=0.0
1772 1 return intg($mode) . ' Tr';
1773 }
1774  
1775 sub render {
1776 1 ▶ my ($self, $mode) = @_;
Subroutine render: called CC=2 SCAR=7.0
Pod documented
1777 1 ▶ if (defined ($mode)) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $mode) 1 0 1
1778 1 $self->{' render'} = $mode;
1779 1 $self->add(_render($mode));
1780 }
1781 1 return $self->{' render'};
1782 }
1783  
1784 =head2 rise
1785  
1786 $distance = $content->rise($distance);
1787  
1788 Adjusts the baseline up or down from its current location. This is initially
1789 zero.
1790  
1791 Use this to create superscripts or subscripts (usually with an adjustment to the
1792 font size as well).
1793  
1794 =cut
1795  
1796 sub _rise {
1797 1 ▶ my $distance = shift();
Subroutine _rise: called CC=1 SCAR=0.0
1798 1 return float($distance) . ' Ts';
1799 }
1800  
1801 sub rise {
1802 1 ▶ my ($self, $distance) = @_;
Subroutine rise: called CC=2 SCAR=7.0
Pod documented
1803 1 ▶ if (defined ($distance)) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $distance) 1 0 1
1804 1 $self->{' rise'} = $distance;
1805 1 $self->add(_rise($distance));
1806 }
1807 1 return $self->{' rise'};
1808 }
1809  
1810 # Formerly documented; still used internally
1811 sub textstate {
1812 0 ▶ my $self = shift();
Subroutine textstate: not called CC=10 SCAR=47.0
Pod undocumented
1813 0 my %state;
1814 0 ▶ if (@_) {
Branch: 1 branch
BranchTrueFalseTotal
if (@_) { } 0 0 0
1815 0 %state = @_;
1816 0 foreach my $k (qw(charspace hscale wordspace leading rise render)) {
1817 0 ▶ next unless $state{$k};
Branch: 1 branch
BranchTrueFalseTotal
unless $state{$k} 0 0 0
1818 0 $self->can($k)->($self, $state{$k});
1819 }
1820 0 ▶ if ($state{'font'} and $state{'fontsize'}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($state{"font"} and $state{"fontsize"}) 0 0 0
Condition0%0/3
$state{"font"} and $state{"fontsize"}
!ll&&!rl&&r
000
MC/DC0%0/2
$state{"font"} and $state{"fontsize"}
$state{"font"} $state{"fontsize"}
Truth table0%0/3
A and B
A= $state{"font"}B= $state{"fontsize"}
ABresult
0X0
100
111
1821 0 $self->font($state{'font'}, $state{'fontsize'});
1822 }
1823 0 ▶ if ($state{'textmatrix'}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($state{"textmatrix"}) 0 0 0
1824 0 $self->matrix(@{$state{'textmatrix'}});
1825 0 @{$self->{' translate'}} = @{$state{'translate'}};
1826 0 $self->{' rotate'} = $state{'rotate'};
1827 0 @{$self->{' scale'}} = @{$state{'scale'}};
1828 0 @{$self->{' skew'}} = @{$state{'skew'}};
1829 }
1830 0 ▶ if ($state{'fillcolor'}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($state{"fillcolor"}) 0 0 0
1831 0 $self->fillcolor(@{$state{'fillcolor'}});
1832 }
1833 0 ▶ if ($state{'strokecolor'}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($state{"strokecolor"}) 0 0 0
1834 0 $self->strokecolor(@{$state{'strokecolor'}});
1835 }
1836 0 %state = ();
1837 }
1838 else {
1839 0 foreach my $k (qw(font fontsize charspace hscale wordspace leading rise render)) {
1840 0 $state{$k} = $self->{" $k"};
1841 }
1842 0 $state{'matrix'} = [@{$self->{' matrix'}}];
1843 0 $state{'textmatrix'} = [@{$self->{' textmatrix'}}];
1844 0 $state{'textlinematrix'} = [@{$self->{' textlinematrix'}}];
1845 0 $state{'rotate'} = $self->{' rotate'};
1846 0 $state{'scale'} = [@{$self->{' scale'}}];
1847 0 $state{'skew'} = [@{$self->{' skew'}}];
1848 0 $state{'translate'} = [@{$self->{' translate'}}];
1849 0 $state{'fillcolor'} = [@{$self->{' fillcolor'}}];
1850 0 $state{'strokecolor'} = [@{$self->{' strokecolor'}}];
1851 }
1852 0 return %state;
1853 }
1854  
1855 =head1 TEXT PLACEMENT
1856  
1857 =head2 position
1858  
1859 # Set
1860 $content = $content->position($x, $y);
1861  
1862 # Get
1863 ($x, $y) = $content->position();
1864  
1865 If called with arguments, moves to the start of the current line of text, offset
1866 by C<$x> and C<$y>.
1867  
1868 If called without arguments, returns the current position of the cursor (before
1869 the effects of any coordinate transformation methods).
1870  
1871 =cut
1872  
1873 sub position {
1874 59 ▶ my ($self, $x, $y) = @_;
Subroutine position: called CC=4 SCAR=14.0
Pod documented
1875  
1876 59 ▶ if (defined $x and not defined $y) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $x and not defined $y) 0 59 59
Condition66%2/3
defined $x and not defined $y
!ll&&!rl&&r
5810
MC/DC0%0/2
defined $x and not defined $y
defined $x not defined $y
Truth table66%2/3
A and not(B)
A= defined $xB= not defined $y
ABresult
0X0
100
111
1877 0 croak 'position requires either 0 or 2 arguments';
1878 }
1879  
1880 59 ▶ if (defined $x) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $x) 1 58 59
1881 1 $self->add(float($x), float($y), 'Td');
1882 1 $self->matrix_update($x, $y);
1883 1 $self->{' textlinematrix'}->[0] = $self->{' textlinestart'} + $x;
1884 1 $self->{' textlinestart'} = $self->{' textlinematrix'}->[0];
1885 1 return $self;
1886 }
1887  
1888 58 return @{$self->{' textlinematrix'}};
1889 }
1890  
1891 # Deprecated; replace with position
1892 sub distance {
1893 1 ▶ my ($self, $dx, $dy) = @_;
Subroutine distance: called CC=1 SCAR=0.0
Pod documented
1894 1 $self->add(float($dx), float($dy), 'Td');
1895 1 $self->matrix_update($dx, $dy);
1896 1 $self->{' textlinematrix'}->[0] = $self->{' textlinestart'} + $dx;
1897 1 $self->{' textlinestart'} = $self->{' textlinematrix'}->[0];
1898 }
1899  
1900 # Deprecated; use position (ignores leading) or crlf (uses leading) instead
1901 sub cr {
1902 3 ▶ my ($self, $offset) = @_;
Subroutine cr: called CC=2 SCAR=6.9
Pod documented
1903 3 ▶ if (defined $offset) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $offset) { } 2 1 3
1904 2 $self->add(0, float($offset), 'Td');
1905 2 $self->matrix_update(0, $offset);
1906 }
1907 else {
1908 1 $self->add('T*');
1909 1 $self->matrix_update(0, $self->leading() * -1);
1910 }
1911  
1912 3 $self->{' textlinematrix'}->[0] = $self->{' textlinestart'};
1913 }
1914  
1915 =head2 crlf
1916  
1917 $content = $content->crlf();
1918  
1919 Moves to the start of the next line, based on the L</"leading"> setting.
1920  
1921 If leading isn't set, a default distance of 120% of the font size will be used.
1922  
1923 =cut
1924  
1925 sub crlf {
1926 23 ▶ my $self = shift();
Subroutine crlf: called CC=3 SCAR=11.0
Pod documented
1927 23 my $leading = $self->leading();
1928 23 ▶ if ($leading or not $self->{' fontsize'}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($leading or not $self->{' fontsize'}) { } 22 1 23
Condition100%3/3
$leading or not $self->{" fontsize"}
l!l&&r!l&&!r
2111
MC/DC100%2/2
$leading or not $self->{" fontsize"}
$leading not $self->{" fontsize"}
Truth table100%3/3
A or not(B)
A= $leadingB= not $self->{" fontsize"}
ABresult
1X1
011
000
1929 22 $self->add('T*');
1930 }
1931 else {
1932 1 $leading = $self->{' fontsize'} * 1.2;
1933 1 $self->add(0, float($leading * -1), 'Td');
1934 }
1935  
1936 23 $self->matrix_update(0, $leading * -1);
1937 23 $self->{' textlinematrix'}->[0] = $self->{' textlinestart'};
1938 23 return $self;
1939 }
1940  
1941 # Deprecated; replace with crlf
1942 sub nl {
1943 1 ▶ my $self = shift();
Subroutine nl: called CC=1 SCAR=0.0
Pod documented
1944 1 $self->add('T*');
1945 1 $self->matrix_update(0, $self->leading() * -1);
1946 1 $self->{' textlinematrix'}->[0] = $self->{' textlinestart'};
1947 }
1948  
1949 sub _textpos {
1950 0 ▶ my ($self, @xy) = @_;
Subroutine _textpos: not called CC=2 SCAR=17.9
1951  
1952 0 my ($x, $y) = (0, 0);
1953 0 ▶ while (@xy) {
Branch: 1 branch
BranchTrueFalseTotal
if (@xy) 0 0 0
1954 0 $x += shift(@xy);
1955 0 $y += shift(@xy);
1956 }
1957 my (@m) = _transform(
1958 0 -matrix => $self->{' textmatrix'},
1959 -point => [$x, $y],
1960 );
1961  
1962 0 return ($m[0], $m[1]);
1963 }
1964  
1965 # Deprecated
1966 sub textpos {
1967 0 ▶ my $self = shift();
Subroutine textpos: not called CC=1 SCAR=6.9
Pod undocumented
1968 0 return $self->_textpos(@{$self->{' textlinematrix'}});
1969 }
1970  
1971 # Deprecated; replace with position (without arguments)
1972 sub textpos2 {
1973 0 ▶ my $self = shift();
Subroutine textpos2: not called CC=1 SCAR=6.9
Pod undocumented
1974 0 return $self->position();
1975 }
1976  
1977 =head2 text
1978  
1979 my $width = $content->text($text, %options);
1980  
1981 Places text on the page. Returns the width of the text in points.
1982  
1983 Options:
1984  
1985 =over
1986  
1987 =item * align
1988  
1989 One of C<left> (default), C<center>, or C<right>. Text will be placed such that
1990 it begins, is centered on, or ends at the current text position, respectively.
1991  
1992 In each case, the position will then be moved to the end of the text.
1993  
1994 =item * indent
1995  
1996 Indents the text by the number of points.
1997  
1998 If C<align> is set to anything other than C<left>, this setting will be ignored.
1999  
2000 =item * underline
2001  
2002 Underlines the text. The value may be one of the following:
2003  
2004 =over
2005  
2006 =item * auto
2007  
2008 Determines the underline distance from the text based on the font and font size.
2009  
2010 =item * $distance
2011  
2012 Manually set the underline distance in points. A positive distance moves the
2013 line downward.
2014  
2015 =item * [$distance, $thickness, ...]
2016  
2017 Manually set both the underline distance and line thickness, both in points.
2018  
2019 Repeat these arguments to include multiple underlines.
2020  
2021 =back
2022  
2023 =back
2024  
2025 =cut
2026  
2027 sub _text_underline {
2028 0 ▶ my ($self, $xy1, $xy2, $underline, $color) = @_;
Subroutine _text_underline: not called CC=10 SCAR=47.0
2029 0 ▶ $color ||= 'black';
Condition0%0/2
$color ||= "black"
l!l
00
MC/DC0%0/1
$color ||= "black"
$color
Truth table0%0/2
A
A= $color
Aresult
11
00
2030  
2031 0 my @underline;
2032 0 ▶ if (ref($underline) eq 'ARRAY') {
Branch: 1 branch
BranchTrueFalseTotal
if (ref $underline eq 'ARRAY') { } 0 0 0
2033 0 @underline = @$underline;
2034 }
2035 else {
2036 0 @underline = ($underline, 1);
2037 }
2038 0 ▶ push @underline, 1 if @underline % 2;
Branch: 1 branch
BranchTrueFalseTotal
if @underline % 2 0 0 0
2039  
2040 0 ▶ my $underlineposition = (-$self->{' font'}->underlineposition() * $self->{' fontsize'} / 1000 || 1);
Condition0%0/2
-$self->{' font'}->underlineposition * $self->{' fontsize'} / 1000 || 1
l!l
00
MC/DC0%0/1
-$self->{' font'}->underlineposition * $self->{' fontsize'} / 1000 || 1
-$self->{' font'}->underlineposition * $self->{' fontsize'} / 1000
Truth table0%0/2
A
A= -$self->{' font'}->underlineposition * $self->{' fontsize'} / 1000
Aresult
11
00
2041 0 ▶ my $underlinethickness = ($self->{' font'}->underlinethickness() * $self->{' fontsize'} / 1000 || 1);
Condition0%0/2
$self->{' font'}->underlinethickness * $self->{' fontsize'} / 1000 || 1
l!l
00
MC/DC0%0/1
$self->{' font'}->underlinethickness * $self->{' fontsize'} / 1000 || 1
$self->{' font'}->underlinethickness * $self->{' fontsize'} / 1000
Truth table0%0/2
A
A= $self->{' font'}->underlinethickness * $self->{' fontsize'} / 1000
Aresult
11
00
2042 0 my $pos = 1;
2043  
2044 0 ▶ while (@underline) {
Branch: 1 branch
BranchTrueFalseTotal
if (@underline) 0 0 0
2045 0 $self->add_post(_save());
2046  
2047 0 my $distance = shift(@underline);
2048 0 my $thickness = shift(@underline);
2049 0 my $scolor = $color;
2050 0 ▶ if (ref($thickness)) {
Branch: 1 branch
BranchTrueFalseTotal
if (ref $thickness) 0 0 0
2051 0 ($thickness, $scolor) = @$thickness;
2052 }
2053 0 ▶ if ($distance eq 'auto') {
Branch: 1 branch
BranchTrueFalseTotal
if ($distance eq "auto") 0 0 0
2054 0 $distance = $pos * $underlineposition;
2055 }
2056 0 ▶ if ($thickness eq 'auto') {
Branch: 1 branch
BranchTrueFalseTotal
if ($thickness eq "auto") 0 0 0
2057 0 $thickness = $underlinethickness;
2058 }
2059  
2060 0 my ($x1, $y1) = $self->_textpos(@$xy1, 0, -($distance + ($thickness / 2)));
2061 0 my ($x2, $y2) = $self->_textpos(@$xy2, 0, -($distance + ($thickness / 2)));
2062  
2063 0 $self->add_post($self->_strokecolor($scolor));
2064 0 $self->add_post(_linewidth($thickness));
2065 0 $self->add_post(_move($x1, $y1));
2066 0 $self->add_post(_line($x2, $y2));
2067 0 $self->add_post(_stroke());
2068  
2069 0 $self->add_post(_restore());
2070 0 $pos++;
2071 }
2072 }
2073  
2074 sub text {
2075 30 ▶ my ($self, $text, %opts) = @_;
Subroutine text: called CC=15 SCAR=29.6
Pod documented
2076 30 ▶ unless ($self->{' fontset'}) {
Branch: 1 branch
BranchTrueFalseTotal
unless ($self->{" fontset"}) 1 29 30
2077 1 ▶ unless (defined $self->{' font'} and $self->{' fontsize'}) {
Branch: 1 branch
BranchTrueFalseTotal
unless (defined $self->{" font"} and $self->{" fontsize"}) 1 0 1
Condition33%1/3
defined $self->{" font"} and $self->{" fontsize"}
!ll&&!rl&&r
100
MC/DC0%0/2
defined $self->{" font"} and $self->{" fontsize"}
defined $self->{" font"} $self->{" fontsize"}
Truth table33%1/3
A and B
A= defined $self->{" font"}B= $self->{" fontsize"}
ABresult
0X0
100
111
2078 1 croak q{Can't add text without first setting a font and font size};
2079 }
2080 0 $self->font($self->{' font'}, $self->{' fontsize'});
2081 0 $self->{' fontset'} = 1;
2082 }
2083  
2084 # Deprecated options (remove hyphens)
2085 29 ▶ if (exists $opts{'-indent'}) {
Branch: 1 branch
BranchTrueFalseTotal
if (exists $opts{"-indent"}) 10 19 29
2086 10 ▶ $opts{'indent'} //= delete $opts{'-indent'};
Condition33%1/3
$opts{"indent"} //= delete $opts{"-indent"}
l!l&&r!l&&!r
0100
MC/DC0%0/2
$opts{"indent"} //= delete $opts{"-indent"}
$opts{"indent"} delete $opts{"-indent"}
Truth table33%1/3
A //= B
A= $opts{"indent"}B= delete $opts{"-indent"}
ABresult
1X1
011
000
2087 }
2088 29 ▶ if (exists $opts{'-underline'}) {
Branch: 1 branch
BranchTrueFalseTotal
if (exists $opts{"-underline"}) 0 29 29
2089 0 ▶ $opts{'underline'} //= delete $opts{'-underline'};
Condition0%0/3
$opts{"underline"} //= delete $opts{"-underline"}
l!l&&r!l&&!r
000
MC/DC0%0/2
$opts{"underline"} //= delete $opts{"-underline"}
$opts{"underline"} delete $opts{"-underline"}
Truth table0%0/3
A //= B
A= $opts{"underline"}B= delete $opts{"-underline"}
ABresult
1X1
011
000
2090 }
2091  
2092 29 my $width = $self->text_width($text);
2093  
2094 29 ▶ if (defined $opts{'align'}) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $opts{"align"}) 12 17 29
2095 12 ▶ if ($opts{'align'} eq 'left') {
Branch: 3 branches
BranchTrueFalseTotal
if ($opts{'align'} eq 'left') { } 6 6 12
elsif ($opts{'align'} eq 'center') { } 3 3 6
elsif ($opts{'align'} eq 'right') { } 3 0 3
2096 # NOOP
2097 }
2098 elsif ($opts{'align'} eq 'center') {
2099 3 $opts{'indent'} = -($width / 2);
2100 }
2101 elsif ($opts{'align'} eq 'right') {
2102 3 $opts{'indent'} = -$width;
2103 }
2104 else {
2105 0 croak 'Invalid alignment: ' . $opts{'align'};
2106 }
2107 }
2108  
2109 29 ▶ if (defined $opts{'indent'}) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $opts{"indent"}) 12 17 29
2110 12 $self->matrix_update($opts{'indent'}, 0);
2111 }
2112  
2113 29 my $underline_start = [$self->position()];
2114  
2115 29 ▶ if (defined $opts{'indent'}) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $opts{'indent'}) { } 12 17 29
2116 12 my $indent = -$opts{'indent'};
2117 12 $indent *= (1000 / $self->{' fontsize'}) * (100 / $self->hscale());
2118 12 $self->add($self->{' font'}->text($text, $self->{' fontsize'}, $indent));
2119 }
2120 else {
2121 17 $self->add($self->{' font'}->text($text, $self->{' fontsize'}));
2122 }
2123  
2124 29 $self->matrix_update($width, 0);
2125  
2126 29 my $underline_end = [$self->position()];
2127  
2128 29 ▶ if (defined $opts{'underline'}) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $opts{"underline"}) 0 29 29
2129 $self->_text_underline($underline_start, $underline_end,
2130 $opts{'underline'},
2131 0 $opts{'-strokecolor'});
2132 }
2133  
2134 29 return $width;
2135 }
2136  
2137 # Deprecated; replace with text($line, align => 'center')
2138 sub text_center {
2139 6 ▶ my ($self, $text, @opts) = @_;
Subroutine text_center: called CC=1 SCAR=0.0
Pod documented
2140 6 my $width = $self->advancewidth($text);
2141 6 return $self->text($text, -indent => -($width / 2), @opts);
2142 }
2143  
2144 # Deprecated; replace with text($line, align => 'right')
2145 sub text_right {
2146 3 ▶ my ($self, $text, @opts) = @_;
Subroutine text_right: called CC=1 SCAR=0.0
Pod documented
2147 3 my $width = $self->advancewidth($text);
2148 3 return $self->text($text, -indent => -$width, @opts);
2149 }
2150  
2151 =head2 text_justified
2152  
2153 my $width = $content->text_justified($text, $width, %options);
2154  
2155 As C<text>, filling the specified width by adjusting the space between words.
2156  
2157 =cut
2158  
2159 sub text_justified {
2160 1 ▶ my ($self, $text, $width, %opts) = @_;
Subroutine text_justified: called CC=2 SCAR=7.0
Pod documented
2161 1 my $initial_width = $self->text_width($text);
2162 1 my $space_count = (split /\s/, $text) - 1;
2163 1 my $ws = $self->wordspace();
2164 1 ▶ $self->wordspace(($width - $initial_width) / $space_count) if $space_count;
Branch: 1 branch
BranchTrueFalseTotal
if $space_count 1 0 1
2165 1 $self->text($text, %opts);
2166 1 $self->wordspace($ws);
2167 1 return $width;
2168 }
2169  
2170 sub _text_fill_line {
2171 19 ▶ my ($self, $text, $width) = @_;
Subroutine _text_fill_line: called CC=5 SCAR=16.1
2172 19 my @words = split(/\x20/, $text);
2173 19 my @line = ();
2174 19 local $" = ' ';
2175 19 ▶ while (@words) {
Branch: 1 branch
BranchTrueFalseTotal
if (@words) 112 7 119
2176 112 push @line, (shift @words);
2177 112 ▶ last if $self->advancewidth("@line") > $width;
Branch: 1 branch
BranchTrueFalseTotal
if $self->advancewidth(join($", @line)) > $width 12 100 112
2178 }
2179 19 ▶ if ((scalar @line > 1) and ($self->advancewidth("@line") > $width)) {
Branch: 1 branch
BranchTrueFalseTotal
if (scalar @line > 1 and $self->advancewidth(join($", @line)) > $width) 12 7 19
Condition66%2/3
scalar @line > 1 and $self->advancewidth(join($", @line)) > $width
!ll&&!rl&&r
0712
MC/DC50%1/2
scalar @line > 1 and $self->advancewidth(join($", @line)) > $width
scalar @line > 1 $self->advancewidth(join($", @line)) > $width
Truth table66%2/3
A and B
A= scalar @line > 1B= $self->advancewidth(join($", @line)) > $width
ABresult
0X0
100
111
2180 12 unshift @words, pop @line;
2181 }
2182 19 my $ret = "@words";
2183 19 my $line = "@line";
2184 19 return $line, $ret;
2185 }
2186  
2187 sub text_fill_left {
2188 7 ▶ my ($self, $text, $width, %opts) = @_;
Subroutine text_fill_left: called CC=1 SCAR=0.0
Pod undocumented
2189 7 my ($line, $ret) = $self->_text_fill_line($text, $width);
2190 7 $width = $self->text($line, %opts);
2191 7 return $width, $ret;
2192 }
2193  
2194 sub text_fill_center {
2195 2 ▶ my ($self, $text, $width, %opts) = @_;
Subroutine text_fill_center: called CC=1 SCAR=0.0
Pod undocumented
2196 2 my ($line, $ret) = $self->_text_fill_line($text, $width);
2197 2 $width = $self->text_center($line, %opts);
2198 2 return $width, $ret;
2199 }
2200  
2201 sub text_fill_right {
2202 2 ▶ my ($self, $text, $width, %opts) = @_;
Subroutine text_fill_right: called CC=1 SCAR=0.0
Pod undocumented
2203 2 my ($line, $ret) = $self->_text_fill_line($text, $width);
2204 2 $width = $self->text_right($line, %opts);
2205 2 return $width, $ret;
2206 }
2207  
2208 sub text_fill_justified {
2209 8 ▶ my ($self, $text, $width, %opts) = @_;
Subroutine text_fill_justified: called CC=10 SCAR=23.1
Pod undocumented
2210 8 my ($line, $ret) = $self->_text_fill_line($text, $width);
2211 8 my $ws = $self->wordspace();
2212 8 my $w = $self->advancewidth($line);
2213 8 my $space_count = (split /\s/, $line) - 1;
2214  
2215 # Normal Line
2216 8 ▶ if ($ret) {
Branch: 1 branch
BranchTrueFalseTotal
if ($ret) 4 4 8
2217 4 ▶ $self->wordspace(($width - $w) / $space_count) if $space_count;
Branch: 1 branch
BranchTrueFalseTotal
if $space_count 4 0 4
2218 4 $width = $self->text($line, %opts, align => 'left');
2219 4 $self->wordspace($ws);
2220 4 return $width, $ret;
2221 }
2222  
2223 # Last Line
2224 4 ▶ if ($opts{'align-last'}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($opts{"align-last"}) 3 1 4
2225 3 ▶ unless ($opts{'align-last'} =~ /^(left|center|right|justified)$/) {
Branch: 1 branch
BranchTrueFalseTotal
unless ($opts{"align-last"} =~ /^(left|center|right|justified)$/) 0 3 3
2226 0 croak 'Invalid align-last (must be left, center, right, or justified)';
2227 }
2228 }
2229 4 ▶ my $align_last = $opts{'align-last'} // 'left';
Condition100%2/2
$opts{"align-last"} // "left"
l!l
31
MC/DC100%1/1
$opts{"align-last"} // "left"
$opts{"align-last"}
Truth table100%2/2
A
A= $opts{"align-last"}
Aresult
11
00
2230 4 ▶ if ($align_last eq 'left') {
Branch: 3 branches
BranchTrueFalseTotal
if ($align_last eq 'left') { } 1 3 4
elsif ($align_last eq 'center') { } 1 2 3
elsif ($align_last eq 'right') { } 1 1 2
2231 1 $width = $self->text($line, %opts, align => 'left');
2232 }
2233 elsif ($align_last eq 'center') {
2234 1 $width = $self->text($line, %opts, align => 'center');
2235 }
2236 elsif ($align_last eq 'right') {
2237 1 $width = $self->text($line, %opts, align => 'right');
2238 }
2239 else {
2240 1 ▶ $self->wordspace(($width - $w) / $space_count) if $space_count;
Branch: 1 branch
BranchTrueFalseTotal
if $space_count 1 0 1
2241 1 $width = $self->text($line, %opts, align => 'left');
2242 1 $self->wordspace($ws);
2243 }
2244 4 return $width, $ret;
2245 }
2246  
2247 =head2 paragraph
2248  
2249 # Scalar context
2250 $overflow_text = $content->paragraph($text, $width, $height, %options);
2251  
2252 # Array context
2253 ($overflow, $height) = $content->paragraph($text, $width, $height, %options);
2254  
2255 Fills the rectangle with as much of the provided text as will fit.
2256  
2257 In array context, returns the remaining text (if any) of the positioned text and
2258 the remaining (unused) height. In scalar context, returns the remaining text
2259 (if any).
2260  
2261 Line spacing follows L</"leading">, if set, or 120% of the font size by default.
2262  
2263 B<Options>
2264  
2265 =over
2266  
2267 =item * align
2268  
2269 Specifies the alignment for each line of text. May be set to C<left> (default),
2270 C<center>, C<right>, or C<justified>.
2271  
2272 =item * align-last
2273  
2274 Specifies the alignment for the last line of justified text. May be set to
2275 C<left> (default), C<center>, C<right>, or C<justified>.
2276  
2277 =item * underline
2278  
2279 As described in L</"text">.
2280  
2281 =back
2282  
2283 =cut
2284  
2285 sub paragraph {
2286 10 ▶ my ($self, $text, $width, $height, %opts) = @_;
Subroutine paragraph: called CC=22 SCAR=32.5
Pod documented
2287  
2288 # Deprecated options (remove hyphens)
2289 10 ▶ if (exists $opts{'-align'}) {
Branch: 1 branch
BranchTrueFalseTotal
if (exists $opts{"-align"}) 6 4 10
2290 6 ▶ $opts{'align'} //= delete $opts{'-align'};
Condition33%1/3
$opts{"align"} //= delete $opts{"-align"}
l!l&&r!l&&!r
060
MC/DC0%0/2
$opts{"align"} //= delete $opts{"-align"}
$opts{"align"} delete $opts{"-align"}
Truth table33%1/3
A //= B
A= $opts{"align"}B= delete $opts{"-align"}
ABresult
1X1
011
000
2291 }
2292 10 ▶ if (exists $opts{'-align-last'}) {
Branch: 1 branch
BranchTrueFalseTotal
if (exists $opts{"-align-last"}) 3 7 10
2293 3 ▶ $opts{'align-last'} //= delete $opts{'-align-last'};
Condition33%1/3
$opts{"align-last"} //= delete $opts{"-align-last"}
l!l&&r!l&&!r
030
MC/DC0%0/2
$opts{"align-last"} //= delete $opts{"-align-last"}
$opts{"align-last"} delete $opts{"-align-last"}
Truth table33%1/3
A //= B
A= $opts{"align-last"}B= delete $opts{"-align-last"}
ABresult
1X1
011
000
2294 }
2295 10 ▶ if (exists $opts{'-underline'}) {
Branch: 1 branch
BranchTrueFalseTotal
if (exists $opts{"-underline"}) 0 10 10
2296 0 ▶ $opts{'underline'} //= delete $opts{'-underline'};
Condition0%0/3
$opts{"underline"} //= delete $opts{"-underline"}
l!l&&r!l&&!r
000
MC/DC0%0/2
$opts{"underline"} //= delete $opts{"-underline"}
$opts{"underline"} delete $opts{"-underline"}
Truth table0%0/3
A //= B
A= $opts{"underline"}B= delete $opts{"-underline"}
ABresult
1X1
011
000
2297 }
2298  
2299 10 my $leading = $self->leading();
2300 10 ▶ unless ($leading) {
Branch: 1 branch
BranchTrueFalseTotal
unless ($leading) 0 10 10
2301 0 $leading = $self->{' fontsize'} * 1.2;
2302 }
2303  
2304 # If the text contains newlines, call paragraph on each line
2305 10 ▶ if ($text =~ /\n/) {
Branch: 1 branch
BranchTrueFalseTotal
if ($text =~ /\n/) 1 9 10
2306 1 my $overflow = '';
2307 1 foreach my $line (split /\n/, $text) {
2308 # If there's overflow, no more text can be placed.
2309 3 ▶ if (length($overflow)) {
Branch: 1 branch
BranchTrueFalseTotal
if (length $overflow) 0 3 3
2310 0 $overflow .= "\n" . $line;
2311 0 next;
2312 }
2313  
2314 # Place a blank line if there are consecutive newlines
2315 3 ▶ unless (length($line)) {
Branch: 1 branch
BranchTrueFalseTotal
unless (length $line) 1 2 3
2316 1 $self->crlf();
2317 1 $height -= $leading;
2318 1 next;
2319 }
2320  
2321 2 ($line, $height) = $self->paragraph($line, $width, $height, %opts);
2322 2 ▶ $overflow .= $line if length($line);
Branch: 1 branch
BranchTrueFalseTotal
if length $line 1 1 2
2323 }
2324  
2325 1 ▶ return ($overflow, $height) if wantarray();
Branch: 1 branch
BranchTrueFalseTotal
if wantarray 0 1 1
2326 1 return $overflow;
2327 }
2328  
2329 9 my $w;
2330 9 ▶ while (length($text) > 0) {
Branch: 1 branch
BranchTrueFalseTotal
if (length $text > 0) 21 7 28
2331 21 $height -= $leading;
2332 21 ▶ last if $height < 0;
Branch: 1 branch
BranchTrueFalseTotal
if $height < 0 2 19 21
2333  
2334 19 ▶ my $align = $opts{'align'} // 'left';
Condition100%2/2
$opts{"align"} // "left"
l!l
127
MC/DC100%1/1
$opts{"align"} // "left"
$opts{"align"}
Truth table100%2/2
A
A= $opts{"align"}
Aresult
11
00
2335 19 ▶ if ($align eq 'justified' or $align eq 'justify') {
Branch: 3 branches
BranchTrueFalseTotal
if ($align eq 'justified' or $align eq 'justify') { } 8 11 19
elsif ($align eq 'right') { } 2 9 11
elsif ($align eq 'center') { } 2 7 9
Condition66%2/3
$align eq "justified" or $align eq "justify"
l!l&&r!l&&!r
8011
MC/DC50%1/2
$align eq "justified" or $align eq "justify"
$align eq "justified" $align eq "justify"
Truth table66%2/3
A or B
A= $align eq "justified"B= $align eq "justify"
ABresult
1X1
011
000
2336 8 ($w, $text) = $self->text_fill_justified($text, $width, %opts);
2337 }
2338 elsif ($align eq 'right') {
2339 2 ($w, $text) = $self->text_fill_right($text, $width, %opts);
2340 }
2341 elsif ($align eq 'center') {
2342 2 ($w, $text) = $self->text_fill_center($text, $width, %opts);
2343 }
2344 else {
2345 7 ($w, $text) = $self->text_fill_left($text, $width, %opts);
2346 }
2347 19 $self->crlf();
2348 }
2349  
2350 9 ▶ return ($text, $height) if wantarray();
Branch: 1 branch
BranchTrueFalseTotal
if wantarray 2 7 9
2351 7 return $text;
2352 }
2353  
2354 # Deprecated former name
2355 0 ▶sub section { return paragraphs(@_) }
Subroutine section: not called CC=1 SCAR=6.9
Pod documented
2356  
2357 # Deprecated; merged into paragraph
2358 1 ▶sub paragraphs { return paragraph(@_) }
Subroutine paragraphs: called CC=1 SCAR=0.0
Pod documented
2359  
2360 sub textlabel {
2361 0 ▶ my ($self, $x, $y, $font, $size, $text, %opts, $wht) = @_;
Subroutine textlabel: not called CC=17 SCAR=57.2
Pod undocumented
2362 0 my %trans_opts = (-translate => [$x,$y]);
2363 0 my %text_state;
2364 0 ▶ $trans_opts{'-rotate'} = $opts{'-rotate'} if $opts{'-rotate'};
Branch: 1 branch
BranchTrueFalseTotal
if $opts{"-rotate"} 0 0 0
2365  
2366 0 my $wastext = $self->_in_text_object();
2367 0 ▶ if ($wastext) {
Branch: 1 branch
BranchTrueFalseTotal
if ($wastext) 0 0 0
2368 0 %text_state = $self->textstate();
2369 0 $self->textend();
2370 }
2371 0 $self->save();
2372 0 $self->textstart();
2373  
2374 0 $self->transform(%trans_opts);
2375  
2376 0 ▶ if ($opts{'-color'}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($opts{"-color"}) 0 0 0
2377 0 ▶ my $color = ref($opts{'-color'}) ? @{$opts{'-color'}} : $opts{'-color'};
Branch: 1 branch
BranchTrueFalseTotal
ref $opts{'-color'} ? : 0 0 0
2378 0 $self->fillcolor($color);
2379 }
2380 0 ▶ if ($opts{'-strokecolor'}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($opts{"-strokecolor"}) 0 0 0
2381 my $color = (ref($opts{'-strokecolor'})
2382 0 ? @{$opts{'-strokecolor'}}
2383 0 ▶ : $opts{'-strokecolor'});
Branch: 1 branch
BranchTrueFalseTotal
ref $opts{'-strokecolor'} ? : 0 0 0
2384 0 $self->strokecolor($color);
2385 }
2386  
2387 0 $self->font($font, $size);
2388  
2389 0 ▶ $self->charspace($opts{'-charspace'}) if $opts{'-charspace'};
Branch: 1 branch
BranchTrueFalseTotal
if $opts{"-charspace"} 0 0 0
2390 0 ▶ $self->hscale($opts{'-hscale'}) if $opts{'-hscale'};
Branch: 1 branch
BranchTrueFalseTotal
if $opts{"-hscale"} 0 0 0
2391 0 ▶ $self->wordspace($opts{'-wordspace'}) if $opts{'-wordspace'};
Branch: 1 branch
BranchTrueFalseTotal
if $opts{"-wordspace"} 0 0 0
2392 0 ▶ $self->render($opts{'-render'}) if $opts{'-render'};
Branch: 1 branch
BranchTrueFalseTotal
if $opts{"-render"} 0 0 0
2393  
2394 0 ▶ my $align = $opts{'-align'} // 'left';
Condition0%0/2
$opts{"-align"} // "left"
l!l
00
MC/DC0%0/1
$opts{"-align"} // "left"
$opts{"-align"}
Truth table0%0/2
A
A= $opts{"-align"}
Aresult
11
00
2395 0 ▶ if ($opts{'-right'} or $align =~ /^r/i) {
Branch: 2 branches
BranchTrueFalseTotal
if ($opts{'-right'} or $align =~ /^r/i) { } 0 0 0
elsif ($opts{'-center'} or $align =~ /^c/i) { } 0 0 0
Condition0%0/3
$opts{"-right"} or $align =~ /^r/i
l!l&&r!l&&!r
000
MC/DC0%0/2
$opts{"-right"} or $align =~ /^r/i
$opts{"-right"} $align =~ /^r/i
Truth table0%0/3
A or B
A= $opts{"-right"}B= $align =~ /^r/i
ABresult
1X1
011
000
2396 0 $wht = $self->text_right($text, %opts);
2397 }
2398 ▶ elsif ($opts{'-center'} or $align =~ /^c/i) {
Condition0%0/3
$opts{"-center"} or $align =~ /^c/i
l!l&&r!l&&!r
000
MC/DC0%0/2
$opts{"-center"} or $align =~ /^c/i
$opts{"-center"} $align =~ /^c/i
Truth table0%0/3
A or B
A= $opts{"-center"}B= $align =~ /^c/i
ABresult
1X1
011
000
2399 0 $wht = $self->text_center($text, %opts);
2400 }
2401 else {
2402 0 $wht = $self->text($text, %opts);
2403 }
2404  
2405 0 $self->textend();
2406 0 $self->restore();
2407  
2408 0 ▶ if ($wastext) {
Branch: 1 branch
BranchTrueFalseTotal
if ($wastext) 0 0 0
2409 0 $self->textstart();
2410 0 $self->textstate(%text_state);
2411 }
2412 0 return $wht;
2413 }
2414  
2415 =head2 text_width
2416  
2417 my $width = $content->text_width($line, %overrides);
2418  
2419 Returns the width of a line of text based on the current text state attributes.
2420 These can optionally be overridden:
2421  
2422 my $width = $content->text_width($line,
2423 font => $font,
2424 size => $size,
2425 character_spacing => $spacing,
2426 word_spacing => $spacing,
2427 hscale => $scale,
2428 );
2429  
2430 =cut
2431  
2432 # Deprecated (renamed)
2433 153 ▶sub advancewidth { return text_width(@_) }
Subroutine advancewidth: called CC=1 SCAR=0.0
Pod documented
2434  
2435 sub text_width {
2436 183 ▶ my ($self, $text, %opts) = @_;
Subroutine text_width: called CC=8 SCAR=22.8
Pod documented
2437 183 ▶ return 0 unless defined($text) and length($text);
Branch: 1 branch
BranchTrueFalseTotal
unless defined $text and length $text 0 183 183
Condition33%1/3
defined $text and length $text
!ll&&!rl&&r
00183
MC/DC0%0/2
defined $text and length $text
defined $text length $text
Truth table33%1/3
A and B
A= defined $textB= length $text
ABresult
0X0
100
111
2438  
2439 # Convert new names to old names
2440 183 ▶ if (exists $opts{'size'}) {
Branch: 1 branch
BranchTrueFalseTotal
if (exists $opts{"size"}) 0 183 183
2441 0 $opts{'fontsize'} = delete $opts{'size'};
2442 }
2443 183 ▶ if (exists $opts{'character_spacing'}) {
Branch: 1 branch
BranchTrueFalseTotal
if (exists $opts{"character_spacing"}) 0 183 183
2444 0 $opts{'charspace'} = delete $opts{'character_spacing'};
2445 }
2446 183 ▶ if (exists $opts{'word_spacing'}) {
Branch: 1 branch
BranchTrueFalseTotal
if (exists $opts{"word_spacing"}) 0 183 183
2447 0 $opts{'charspace'} = delete $opts{'word_spacing'};
2448 }
2449  
2450 183 foreach my $k (qw(font fontsize wordspace charspace hscale)) {
2451 915 ▶ $opts{$k} = $self->{" $k"} unless defined $opts{$k};
Branch: 1 branch
BranchTrueFalseTotal
unless defined $opts{$k} 913 2 915
2452 }
2453  
2454 # Width of glyphs
2455 183 my $width = $opts{'font'}->width($text) * $opts{'fontsize'};
2456  
2457 # Width of space characters
2458 183 my $space_count = $text =~ y/\x20/\x20/;
2459 183 $width += $opts{'wordspace'} * $space_count;
2460  
2461 # Width of space between characters
2462 183 my $char_count = length($text);
2463 183 $width += $opts{'charspace'} * ($char_count - 1);
2464  
2465 # Horizontal scale multiplier
2466 183 $width *= $opts{'hscale'} / 100;
2467  
2468 183 return $width;
2469 }
2470  
2471 sub metaStart {
2472 0 ▶ my ($self, $tag, $obj) = @_;
Subroutine metaStart: not called CC=2 SCAR=17.9
Pod undocumented
2473 0 $self->add("/$tag");
2474 0 ▶ if (defined $obj) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $obj) { } 0 0 0
2475 0 my $dict = PDFDict();
2476 0 $dict->{'Metadata'} = $obj;
2477 0 $self->resource('Properties', $obj->name(), $dict);
2478 0 $self->add('/' . $obj->name());
2479 0 $self->add('BDC');
2480 }
2481 else {
2482 0 $self->add('BMC');
2483 }
2484 0 return $self;
2485 }
2486  
2487 sub metaEnd {
2488 0 ▶ my $self = shift();
Subroutine metaEnd: not called CC=1 SCAR=6.9
Pod undocumented
2489 0 $self->add('EMC');
2490 0 return $self;
2491 }
2492  
2493 sub add_post {
2494 0 ▶ my $self = shift();
Subroutine add_post: not called CC=3 SCAR=24.8
Pod undocumented
2495 0 ▶ if (@_) {
Branch: 1 branch
BranchTrueFalseTotal
if (@_) 0 0 0
2496 0 ▶ unless ($self->{' poststream'} =~ /\s$/) {
Branch: 1 branch
BranchTrueFalseTotal
unless ($self->{" poststream"} =~ /\s$/) 0 0 0
2497 0 $self->{' poststream'} .= ' ';
2498 }
2499 0 $self->{' poststream'} .= join(' ', @_) . ' ';
2500 }
2501 0 return $self;
2502 }
2503  
2504 sub add {
2505 778 ▶ my $self = shift();
Subroutine add: called CC=3 SCAR=11.0
Pod documented
2506 778 ▶ if (@_) {
Branch: 1 branch
BranchTrueFalseTotal
if (@_) 778 0 778
2507 778 ▶ unless ($self->{' stream'} =~ /\s$/) {
Branch: 1 branch
BranchTrueFalseTotal
unless ($self->{" stream"} =~ /\s$/) 129 649 778
2508 129 $self->{' stream'} .= ' ';
2509 }
2510 778 $self->{' stream'} .= encode('iso-8859-1', join(' ', @_) . ' ');
2511 }
2512 778 return $self;
2513 }
2514  
2515 # Shortcut method for determining if we're inside a text object
2516 # (i.e. between BT and ET). See textstart and textend.
2517 sub _in_text_object {
2518 500 ▶ my $self = shift();
Subroutine _in_text_object: called CC=1 SCAR=0.0
2519 500 return $self->{' apiistext'};
2520 }
2521  
2522 sub compressFlate {
2523 28 ▶ my $self = shift();
Subroutine compressFlate: called CC=1 SCAR=0.0
Pod undocumented
2524 28 $self->{'Filter'} = PDFArray(PDFName('FlateDecode'));
2525 28 $self->{'-docompress'} = 1;
2526 28 return $self;
2527 }
2528  
2529 sub textstart {
2530 19 ▶ my $self = shift();
Subroutine textstart: called CC=2 SCAR=6.9
Pod undocumented
2531 19 ▶ unless ($self->_in_text_object()) {
Branch: 1 branch
BranchTrueFalseTotal
unless ($self->_in_text_object) 19 0 19
2532 19 $self->add(' BT ');
2533 19 $self->{' apiistext'} = 1;
2534 19 $self->{' font'} = undef;
2535 19 $self->{' fontset'} = 0;
2536 19 $self->{' fontsize'} = 0;
2537 19 $self->{' charspace'} = 0;
2538 19 $self->{' hscale'} = 100;
2539 19 $self->{' wordspace'} = 0;
2540 19 $self->{' leading'} = 0;
2541 19 $self->{' rise'} = 0;
2542 19 $self->{' render'} = 0;
2543 19 $self->{' textlinestart'} = 0;
2544 19 @{$self->{' matrix'}} = (1, 0, 0, 1, 0, 0);
2545 19 @{$self->{' textmatrix'}} = (1, 0, 0, 1, 0, 0);
2546 19 @{$self->{' textlinematrix'}} = (0, 0);
2547 19 @{$self->{' fillcolor'}} = 0;
2548 19 @{$self->{' strokecolor'}} = 0;
2549 19 @{$self->{' translate'}} = (0, 0);
2550 19 @{$self->{' scale'}} = (1, 1);
2551 19 @{$self->{' skew'}} = (0, 0);
2552 19 $self->{' rotate'} = 0;
2553 }
2554 19 return $self;
2555 }
2556  
2557 sub textend {
2558 123 ▶ my $self = shift();
Subroutine textend: called CC=2 SCAR=6.9
Pod undocumented
2559 123 ▶ if ($self->_in_text_object()) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->_in_text_object) 15 108 123
2560 15 $self->add(' ET ', $self->{' poststream'});
2561 15 $self->{' apiistext'} = 0;
2562 15 $self->{' poststream'} = '';
2563 }
2564 123 return $self;
2565 }
2566  
2567 sub resource {
2568 31 ▶ my ($self, $type, $key, $obj, $force) = @_;
Subroutine resource: called CC=9 SCAR=25.6
Pod undocumented
2569 31 ▶ if ($self->{' apipage'}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->{' apipage'}) { } 29 2 31
2570 # we are a content stream on a page.
2571 29 return $self->{' apipage'}->resource($type, $key, $obj, $force);
2572 }
2573 else {
2574 # we are a self-contained content stream.
2575 2 ▶ $self->{'Resources'} //= PDFDict();
Condition33%1/3
$self->{"Resources"} //= PDFDict()
l!l&&r!l&&!r
200
MC/DC0%0/2
$self->{"Resources"} //= PDFDict()
$self->{"Resources"} PDFDict()
Truth table33%1/3
A //= B
A= $self->{"Resources"}B= PDFDict()
ABresult
1X1
011
000
2576  
2577 2 my $dict = $self->{'Resources'};
2578 2 ▶ $dict->realise() if ref($dict) =~ /Objind$/;
Branch: 1 branch
BranchTrueFalseTotal
if ref($dict) =~ /Objind$/ 0 2 2
2579  
2580 2 ▶ $dict->{$type} ||= PDFDict();
Condition33%1/3
$dict->{$type} ||= PDFDict()
l!l&&r!l&&!r
020
MC/DC0%0/2
$dict->{$type} ||= PDFDict()
$dict->{$type} PDFDict()
Truth table33%1/3
A ||= B
A= $dict->{$type}B= PDFDict()
ABresult
1X1
011
000
2581 2 ▶ $dict->{$type}->realise() if ref($dict->{$type}) =~ /Objind$/;
Branch: 1 branch
BranchTrueFalseTotal
if ref($dict->{$type}) =~ /Objind$/ 0 2 2
2582 2 ▶ unless (defined $obj) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $obj) { } 2 0 2
2583 0 return $dict->{$type}->{$key};
2584 }
2585 else {
2586 2 ▶ if ($force) {
Branch: 1 branch
BranchTrueFalseTotal
if ($force) { } 0 2 2
2587 0 $dict->{$type}->{$key} = $obj;
2588 }
2589 else {
2590 2 ▶ $dict->{$type}->{$key} //= $obj;
Condition33%1/3
$dict->{$type}{$key} //= $obj
l!l&&r!l&&!r
020
MC/DC0%0/2
$dict->{$type}{$key} //= $obj
$dict->{$type}{$key} $obj
Truth table33%1/3
A //= B
A= $dict->{$type}{$key}B= $obj
ABresult
1X1
011
000
2591 }
2592 2 return $dict;
2593 }
2594 }
2595 }
2596  
2597 =head1 MIGRATION
2598  
2599 See L<PDF::API2/"MIGRATION"> for an overview.
2600  
2601 =over
2602  
2603 =item transform(%hyphen_prefixed_options);
2604  
2605 Remove hyphens from option names (C<-translate> becomes C<translate>, etc.).
2606  
2607 =item transform_rel
2608  
2609 Replace with L</"transform">, setting option C<repeat> to true. Remove
2610 hyphens from the names of other options.
2611  
2612 =item linewidth
2613  
2614 Replace with L</"line_width">.
2615  
2616 =item linecap
2617  
2618 Replace with L</"line_cap">.
2619  
2620 =item linejoin
2621  
2622 Replace with L</"line_join">.
2623  
2624 =item meterlimit
2625  
2626 =item miterlimit
2627  
2628 Replace with L</"miter_limit">.
2629  
2630 =item linedash
2631  
2632 Replace with L</"line_dash_pattern">. Remove hyphens from option names. Rename
2633 C<-shift> to C<offset>.
2634  
2635 =item flatness
2636  
2637 Replace with L</"flatness_tolerance">.
2638  
2639 =item poly
2640  
2641 Replace with L</"move"> (first two arguments) and L</"polyline"> (remaining
2642 arguments).
2643  
2644 =item endpath
2645  
2646 Replace with L</"end">.
2647  
2648 =item rect
2649  
2650 Replace with L</"rectangle">, converting the C<$w> (third) and C<$h> (fourth)
2651 arguments to the X and Y values of the upper-right corner:
2652  
2653 # Old
2654 $content->rect($x, $y, $w, $h);
2655  
2656 # New
2657 $content->rectangle($x, $y, $x + $w, $y + $h);
2658  
2659 =item rectxy
2660  
2661 Replace with L</"rectangle">.
2662  
2663 =item fill(1)
2664  
2665 Replace with C<$content-E<gt>fill(rule =E<gt> 'even-odd')>.
2666  
2667 =item fillstroke
2668  
2669 Replace with L</"paint">.
2670  
2671 =item clip(1)
2672  
2673 Replace with C<$content-E<gt>clip(rule =E<gt> 'even-odd')>.
2674  
2675 =item image
2676  
2677 =item formimage
2678  
2679 Replace with L</"object">.
2680  
2681 =item charspace
2682  
2683 Replace with L</"character_spacing">.
2684  
2685 =item wordspace
2686  
2687 Replace with L</"word_spacing">.
2688  
2689 =item hspace
2690  
2691 Replace with L</"hscale">.
2692  
2693 =item lead
2694  
2695 Replace with L</"leading">.
2696  
2697 =item distance
2698  
2699 Replace with L</"position">.
2700  
2701 =item cr
2702  
2703 Replace with either L</"position"> (if called with arguments) or L</"crlf"> (if
2704 called without arguments).
2705  
2706 =item nl
2707  
2708 Replace with L</"crlf">.
2709  
2710 =item text(%hyphen_prefixed_options)
2711  
2712 Remove initial hyphens from option names.
2713  
2714 =item text_center
2715  
2716 Replace with L</"text">, setting C<align> to C<center>.
2717  
2718 =item text_right
2719  
2720 Replace with L</"text">, setting C<align> to C<right>.
2721  
2722 =item paragraph(%hyphen_prefixed_options)
2723  
2724 Remove initial hyphens from option names. C<-align-last> becomes C<align-last>.
2725  
2726 =item section
2727  
2728 =item paragraphs
2729  
2730 Replace with L</"paragraph">.
2731  
2732 =item advancewidth
2733  
2734 Replace with L</"text_width">.
2735  
2736 =back
2737  
2738 =cut
2739  
2740 38 1;
« API2/Resource/Font/Postscript.pm ↑ Summary API2/Resource/CIDFont.pm »