]> git.imager.perl.org - imager.git/blob - T1/T1.pm
45a1cd55f68e82b3114a8d369707065447565422
[imager.git] / T1 / T1.pm
1 package Imager::Font::T1;
2 use strict;
3 use Imager::Color;
4 use vars qw(@ISA $VERSION);
5 @ISA = qw(Imager::Font);
6 use Scalar::Util ();
7
8 BEGIN {
9   $VERSION = "1.020";
10
11   require XSLoader;
12   XSLoader::load('Imager::Font::T1', $VERSION);
13 }
14
15
16 *_first = \&Imager::Font::_first;
17
18 my $t1aa = 2;
19
20 sub new {
21   my $class = shift;
22   my %hsh=(color=>Imager::Color->new(255,0,0,255),
23            size=>15,
24            @_);
25
26   unless ($hsh{file}) {
27     $Imager::ERRSTR = "No font file specified";
28     return;
29   }
30   unless (-e $hsh{file}) {
31     $Imager::ERRSTR = "Font file $hsh{file} not found";
32     return;
33   }
34   unless ($Imager::formats{t1}) {
35     $Imager::ERRSTR = "Type 1 fonts not supported in this build";
36     return;
37   }
38   # we want to avoid T1Lib's file search mechanism
39   unless ($hsh{file} =~ m!^/!
40           || $hsh{file} =~ m!^\.\/?/!
41           || $^O =~ /^(MSWin32|cygwin)$/ && $hsh{file} =~ /^[a-z]:/i) {
42     $hsh{file} = './' . $hsh{file};
43   }
44
45   if($hsh{afm}) {
46           unless (-e $hsh{afm}) {
47             $Imager::ERRSTR = "Afm file $hsh{afm} not found";
48             return;
49           }
50           unless ($hsh{afm} =~ m!^/!
51                   || $hsh{afm} =~ m!^\./!
52                   || $^O =~ /^(MSWin32|cygwin)$/ && $hsh{file} =~ /^[a-z]:/i) {
53             $hsh{file} = './' . $hsh{file};
54           }
55   } else {
56           $hsh{afm} = 0;
57   }
58
59   my $font = Imager::Font::T1xs->new($hsh{file},$hsh{afm});
60   unless ($font) { # the low-level code may miss some error handling
61     Imager->_set_error(Imager->_error_as_msg);
62     return;
63   }
64   return bless {
65                 t1font    => $font,
66                 aa    => $hsh{aa} || 0,
67                 file  => $hsh{file},
68                 type  => 't1',
69                 size  => $hsh{size},
70                 color => $hsh{color},
71                 t1aa  => $t1aa,
72                }, $class;
73 }
74
75 sub _draw {
76   my $self = shift;
77
78   $self->_valid
79     or return;
80
81   my %input = @_;
82   my $flags = '';
83   $flags .= 'u' if $input{underline};
84   $flags .= 's' if $input{strikethrough};
85   $flags .= 'o' if $input{overline};
86   my $aa = $input{aa} ? $self->{t1aa} : 0;
87   if (exists $input{channel}) {
88     $self->{t1font}->cp($input{image}{IMG}, $input{'x'}, $input{'y'},
89                     $input{channel}, $input{size},
90                     $input{string}, $input{align},
91                     $input{utf8}, $flags, $aa)
92       or return;
93   } else {
94     $self->{t1font}->text($input{image}{IMG}, $input{'x'}, $input{'y'}, 
95                       $input{color}, $input{size}, 
96                       $input{string}, $input{align}, $input{utf8}, $flags, $aa)
97       or return;
98   }
99
100   return $self;
101 }
102
103 sub _bounding_box {
104   my $self = shift;
105
106   $self->_valid
107     or return;
108
109   my %input = @_;
110   my $flags = '';
111   $flags .= 'u' if $input{underline};
112   $flags .= 's' if $input{strikethrough};
113   $flags .= 'o' if $input{overline};
114   return $self->{t1font}->bbox($input{size}, $input{string},
115                                $input{utf8}, $flags);
116 }
117
118 # check if the font has the characters in the given string
119 sub has_chars {
120   my ($self, %hsh) = @_;
121
122   $self->_valid
123     or return;
124
125   unless (defined $hsh{string}) {
126     $Imager::ERRSTR = "No string supplied to \$font->has_chars()";
127     return;
128   }
129   return $self->{t1font}->has_chars($hsh{string}, 
130                                     _first($hsh{'utf8'}, $self->{utf8}, 0));
131 }
132
133 sub utf8 {
134   1;
135 }
136
137 sub face_name {
138   my ($self) = @_;
139
140   $self->_valid
141     or return;
142
143   return $self->{t1font}->face_name();
144 }
145
146 sub glyph_names {
147   my ($self, %input) = @_;
148
149   $self->_valid
150     or return;
151
152   my $string = $input{string};
153   defined $string
154     or return Imager->_set_error("no string parameter passed to glyph_names");
155   my $utf8 = _first($input{utf8} || 0);
156
157   return $self->{t1font}->glyph_names($string, $utf8);
158 }
159
160 sub set_aa_level {
161   my ($self, $new_t1aa) = @_;
162
163   if (!defined $new_t1aa ||
164       ($new_t1aa != 1 && $new_t1aa != 2)) {
165     Imager->_set_error("set_aa_level: parameter must be 1 or 2");
166     return;
167   }
168
169   if (ref $self) {
170     $self->_valid
171       or return;
172
173     $self->{t1aa} = $new_t1aa;
174   }
175   else {
176     $t1aa = $new_t1aa;
177   }
178
179   return 1;
180 }
181
182 sub _valid {
183   my $self = shift;
184
185   unless ($self->{t1font} && Scalar::Util::blessed($self->{t1font})) {
186     Imager->_set_error("font object was created in another thread");
187     return;
188   }
189
190   return 1;
191 }
192
193 1;
194
195 __END__
196
197 =head1 NAME
198
199   Imager::Font::Type1 - low-level functions for Type1 fonts
200
201 =head1 DESCRIPTION
202
203 Imager::Font creates a Imager::Font::Type1 object when asked to create
204 a font object based on a C<.pfb> file.
205
206 See Imager::Font to see how to use this type.
207
208 This class provides low-level functions that require the caller to
209 perform data validation
210
211 By default Imager no longer creates the F<t1lib.log> log file.  You
212 can re-enable that by calling Imager::init() with the C<t1log> option:
213
214   Imager::init(t1log=>1);
215
216 This must be called before creating any fonts.
217
218 Currently specific to Imager::Font::Type1, you can use the following
219 flags when drawing text or calculating a bounding box:
220
221 =for stopwords overline strikethrough
222
223 =over
224
225 =item *
226
227 C<underline> - Draw the text with an underline.
228
229 =item *
230
231 C<overline> - Draw the text with an overline.
232
233 =item *
234
235 C<strikethrough> - Draw the text with a strikethrough.
236
237 =back
238
239 Obviously, if you're calculating the bounding box the size of the line
240 is included in the box, and the line isn't drawn :)
241
242 =head2 Anti-aliasing
243
244 T1Lib supports multiple levels of anti-aliasing, by default, if you
245 request anti-aliased output, Imager::Font::T1 will use the maximum
246 level.
247
248 You can override this with the set_t1_aa() method:
249
250 =over
251
252 =item set_aa_level()
253
254 Usage:
255
256   $font->set_aa_level(1);
257   Imager::Font::T1->set_aa_level(2);
258
259 Sets the T1Lib anti-aliasing level either for the specified font, or
260 for new font objects.
261
262 The only parameter must be 1 or 2.
263
264 Returns true on success.
265
266 =back
267
268 =head1 AUTHOR
269
270 Addi, Tony
271
272 =cut