File Coverage

blib/lib/PDF/Make/Canvas.pm

Criterion	Covered	Total	%
statement	21	21	100.0
branch			n/a
condition			n/a
subroutine	7	7	100.0
pod			n/a
total	28	28	100.0

package PDF::Make::Canvas;

use strict;
use warnings;

our $VERSION = '0.03';

# Load the XS code from PDF::Make
use PDF::Make ();

# XS bindings provide all PDF content stream operators:
#
# Graphics State Operators:
#   q()               - save graphics state
#   Q()               - restore graphics state
#   cm(a,b,c,d,e,f)   - concatenate matrix
#   w(width)          - set line width
#   J(cap)            - set line cap style
#   j(join)           - set line join style
#   M(miter)          - set miter limit
#   d([array], phase) - set dash pattern
#   ri(intent)        - set rendering intent
#   i(flatness)       - set flatness tolerance
#   gs(name)          - set graphics state dict
#
# Path Construction:
#   m(x,y)            - move to
#   l(x,y)            - line to
#   c(x1,y1,x2,y2,x3,y3) - cubic Bézier curve
#   v(x2,y2,x3,y3)    - cubic Bézier (first control = current)
#   y(x1,y1,x3,y3)    - cubic Bézier (second control = endpoint)
#   re(x,y,w,h)       - rectangle
#   h()               - close subpath
#
# Path Painting:
#   S()               - stroke
#   s()               - close and stroke
#   f()               - fill (non-zero)
#   f_star()          - fill (even-odd)
#   B()               - fill and stroke (non-zero)
#   B_star()          - fill and stroke (even-odd)
#   b()               - close, fill, and stroke (non-zero)
#   b_star()          - close, fill, and stroke (even-odd)
#   n()               - end path (no-op)
#
# Clipping:
#   W()               - clip (non-zero)
#   W_star()          - clip (even-odd)
#
# Color:
#   CS(name)          - set stroke color space
#   cs(name)          - set fill color space
#   G(gray)           - set stroke gray
#   g(gray)           - set fill gray
#   RG(r,g,b)         - set stroke RGB
#   rg(r,g,b)         - set fill RGB
#   K(c,m,y,k)        - set stroke CMYK
#   k(c,m,y,k)        - set fill CMYK
#
# Text:
#   BT()              - begin text object
#   ET()              - end text object
#   Tc(space)         - set character spacing
#   Tw(space)         - set word spacing
#   Tz(scale)         - set horizontal scaling
#   TL(leading)       - set leading
#   Tf(font,size)     - set font
#   Tr(render)        - set render mode
#   Ts(rise)          - set rise
#   Td(tx,ty)         - move text position
#   TD(tx,ty)         - move text position, set leading
#   Tm(a,b,c,d,e,f)   - set text matrix
#   T_star()          - move to next line
#   Tj(text)          - show text
#   TJ(array)         - show text with positioning
#   quote(text)       - move to next line and show text
#   dquote(aw,ac,text) - set spacing, move, show
#
# XObject:
#   Do(name)          - invoke XObject
#
# Inline Image:
#   BI()              - begin inline image
#   ID($data)         - image data
#   EI()              - end inline image
#
# Marked Content:
#   BMC(tag)          - begin marked content
#   BDC(tag,props)    - begin marked content with properties
#   EMC()             - end marked content
#   MP(tag)           - marked content point
#   DP(tag,props)     - marked content point with properties
#
# Utility:
#   new()             - create new canvas
#   to_bytes()        - get content stream bytes
#   len()             - get current length
#   clear()           - reset the canvas
#   DESTROY()         - cleanup

# Line cap styles
use constant {
    CAP_BUTT   => 0,
    CAP_ROUND  => 1,
    CAP_SQUARE => 2,
};

# Line join styles
use constant {
    JOIN_MITER => 0,
    JOIN_ROUND => 1,
    JOIN_BEVEL => 2,
};

# Text rendering modes
use constant {
    RENDER_FILL           => 0,
    RENDER_STROKE         => 1,
    RENDER_FILL_STROKE    => 2,
    RENDER_INVISIBLE      => 3,
    RENDER_FILL_CLIP      => 4,
    RENDER_STROKE_CLIP    => 5,
    RENDER_FILL_STROKE_CLIP => 6,
    RENDER_CLIP           => 7,
};

use Exporter 'import';
our @EXPORT_OK = qw(
    CAP_BUTT CAP_ROUND CAP_SQUARE
    JOIN_MITER JOIN_ROUND JOIN_BEVEL
    RENDER_FILL RENDER_STROKE RENDER_FILL_STROKE RENDER_INVISIBLE
    RENDER_FILL_CLIP RENDER_STROKE_CLIP RENDER_FILL_STROKE_CLIP RENDER_CLIP
);
our %EXPORT_TAGS = (
    caps => [qw(CAP_BUTT CAP_ROUND CAP_SQUARE)],
    joins => [qw(JOIN_MITER JOIN_ROUND JOIN_BEVEL)],
    render => [qw(
        RENDER_FILL RENDER_STROKE RENDER_FILL_STROKE RENDER_INVISIBLE
        RENDER_FILL_CLIP RENDER_STROKE_CLIP RENDER_FILL_STROKE_CLIP RENDER_CLIP
    )],
    all => \@EXPORT_OK,
);

1;

__END__