Wrap.pm
上传用户:qdrechuli
上传日期:2022-08-01
资源大小:917k
文件大小:11k
源码类别:

视频捕捉/采集

开发平台:

Visual C++

  1. # $Id: Wrap.pm,v 1.16 2000/09/18 08:39:47 mgjv Exp $
  2. package GD::Text::Wrap;
  3. $GD::Text::Wrap::VERSION = '$Revision: 1.16 $' =~ /s([d.]+)/;
  4. =head1 NAME
  5. GD::Text::Wrap - Wrap strings in boxes
  6. =head1 SYNOPSIS
  7.   use GD;
  8.   use GD::Text::Wrap;
  9.   my $gd = GD::Image->new(800,600);
  10.   # allocate colours, do other things.
  11.   
  12.   my $text = <<EOSTR;
  13.   Lorem ipsum dolor sit amet, consectetuer adipiscing elit, 
  14.   sed diam nonummy nibh euismod tincidunt ut laoreet dolore 
  15.   magna aliquam erat volutpat.
  16.   EOSTR
  17.   
  18.   my $wrapbox = GDTextWrap->new( $gd,
  19.       line_space  => 4,
  20.       color       => $black,
  21.       text        => $text,
  22.   );
  23.   $wrapbox->set_font(gdMediumBoldFont);
  24.   $wrapbox->set_font('cetus.ttf', 12);
  25.   $wrapbox->set(align => 'left', width => 120);
  26.   $wrapbox->draw(10,140);
  27.   $gd->rectangle($wrap_box->get_bounds(10,140), $color);
  28. =head1 DESCRIPTION
  29. GD::Text::Wrap provides an object that draws a formatted paragraph of
  30. text in a box on a GD::Image canvas, using either a builtin GD font
  31. or a TrueType font.
  32. =head1 METHODS
  33. This class doesn't inherit from GD::Text directly, but delegates most of
  34. its work to it (in fact to a GD::Text::Align object. That means that
  35. most of the GD::Text::Align methods are available for this class,
  36. specifically C<set_font> and C<font_path>. Other methods and methods
  37. with a different interface are described here:
  38. =cut
  39. use strict;
  40. # XXX add version number to GD
  41. use GD;
  42. use GD::Text::Align;
  43. use Carp;
  44. my %attribs = (
  45. width => undef,
  46. height => undef,
  47.     line_space  => 2,
  48.     para_space  => 0,
  49.     align       => 'justified',
  50. text => undef,
  51. preserve_nl => 0,
  52. );
  53. =head2 GD::Text::Wrap->new( $gd_object, attribute => value, ... )
  54. Create a new object. The first argument to new has to be a valid
  55. GD::Image object. The other arguments will be passed to the set() method
  56. for initialisation of the attributes.
  57. =cut
  58. sub new
  59. {
  60.     my $proto = shift;
  61.     my $class = ref($proto) || $proto;
  62.     my $gd    = shift;
  63.     ref($gd) and $gd->isa('GD::Image') 
  64.         or croak "Not a GD::Image object";
  65.     my $self  = { gd => $gd };
  66.     bless $self => $class;
  67.     $self->_init();
  68.     $self->set(@_);
  69.     return $self
  70. }
  71. sub _init
  72. {
  73.     my $self = shift;
  74. $self->{render} = GD::Text::Align->new($self->{gd}, text => 'Foo');
  75. croak "Cannot allocate GD::Text::Align object" unless $self->{render};
  76. # XXX 5.004_04 doesn't like foreach as a modifier
  77. #$self->set($_, $attribs{$_}) foreach (keys %attribs);
  78. foreach (keys %attribs) { $self->set($_, $attribs{$_}) };
  79. # XXX SET DEFAULTS
  80.     $self->set(
  81. colour => $self->{gd}->colorsTotal - 1,
  82. width  => ($self->{gd}->getBounds())[0] - 1,
  83. );
  84. }
  85. =head2 $wrapbox->set( attribute => value, ... )
  86. set the value for an attribute. Valid attributes are:
  87. =over 4
  88. =item width
  89. The width of the box to draw the text in. If unspecified, they will
  90. default to the width of the GD::Image object.
  91. =item line_space
  92. The number of pixels between lines. Defaults to 2.
  93. =item para_space, paragraph_space
  94. The number of extra pixels between paragraphs, above line_space.
  95. Defaults to 0.
  96. =item color, colour
  97. Synonyms. The colour to use when drawing the font. Will be initialised
  98. to the last colour in the GD object's palette.
  99. =item align, alignment
  100. Synonyms. One of 'justified' (the default), 'left', 'right' or 'center'.
  101. =item text
  102. The text to draw. This is the only attribute that you absolutely have to
  103. set.
  104. =item preserve_nl
  105. If set to a true value, newlines in the text will cause a line break.
  106. Note that lines will still be justified. If only one word appears on
  107. the line, it could get ugly.
  108. Defaults to 0.
  109. =back
  110. As with the methods, attributes unknown to this class get delegated to
  111. the GD::Text::Align class. 
  112. =cut
  113. sub _attrib_name
  114. {
  115. my $attrib = shift;
  116. $attrib = 'colour'      if $attrib eq 'color';
  117. $attrib = 'align'       if $attrib =~ /^align/;
  118. $attrib = 'para_space'  if $attrib eq 'paragraph_space';
  119. $attrib;
  120. }
  121. sub set
  122. {
  123.     my $self = shift;
  124.     my %args = @_;
  125.     while (my ($attrib, $val) =  each %args)
  126. {
  127. # This spelling problem keeps bugging me.
  128. SWITCH: for (_attrib_name($attrib))
  129. {
  130. exists $attribs{$_} and 
  131. $self->{$_} = $val, last SWITCH;
  132. # If we don't have this attribute, maybe the GD::Text::Align
  133. # object can use it (for colour mainly at the moment)
  134. $self->{render}->set($_ => $val) and last SWITCH;
  135. carp "No attribute $attrib";
  136. }
  137. }
  138. }
  139. =head2 $wrapbox->get( attribute );
  140. Get the current value of an attribute. All attributes mentioned under
  141. the C<set()> method can be retrieved
  142. =cut
  143. sub get 
  144. my $self = shift;
  145. my $attrib = shift;
  146. $self->{_attrib_name($attrib)} 
  147. }
  148. =head2 $wrapbox->get_bounds()
  149. Returns the bounding box of the box that will be drawn with the current
  150. attribute settings as a list. The values returned are the coordinates of
  151. the upper left and lower right corner.
  152. ($left, $top, $right, $bottom) = $wrapbox->get_bounds();
  153. Returns an empty list on error.
  154. NOTE: The return list of this method may change in a future
  155. implementation that allows angled boxes.
  156. =cut
  157. my $dry_run = 0;
  158. sub get_bounds
  159. {
  160.     my $self = shift;
  161. $dry_run = 1;
  162.     return $self->draw(@_);
  163. }
  164. #
  165. # Vertical movement and state
  166. #
  167. sub _move_to_top
  168. {
  169. my $self = shift;
  170. $self->{_y_pos} = $self->{top} + $self->{render}->get('char_up');
  171. }
  172. sub _at_top
  173. {
  174. my $self = shift;
  175. $self->{_y_pos} == $self->{top} + $self->{render}->get('char_up');
  176. }
  177. sub _set_bottom
  178. {
  179. my $self = shift;
  180. $self->{bottom} = $self->{_y_pos} + $self->{render}->get('char_down');
  181. }
  182. sub _crlf
  183. {
  184. my $self = shift;
  185. $self->{_y_pos} += $self->{render}->get('height') + 
  186.                    $self->{line_space}
  187. }
  188. sub _new_paragraph
  189. {
  190. my $self = shift;
  191. $self->_crlf;
  192. $self->{_y_pos} += $self->{para_space};
  193. }
  194. sub _undo_new_paragraph
  195. {
  196. my $self = shift;
  197. $self->{_y_pos} -= $self->{render}->get('height') + 
  198.                    $self->{line_space} +
  199.    $self->{para_space};
  200. }
  201. =head2 $wrapbox->draw(x, y)
  202. Draw the box, with (x,y) as the top right corner. 
  203. Returns the same values as the C<getbounds()> method.
  204. NOTE: The return list of this method may change in a future
  205. implementation that allows angled boxes.
  206. =cut
  207. sub draw
  208. {
  209.     my $self  = shift;
  210. $self->{left}  = shift or return;
  211. $self->{top}  = shift or return;
  212. $self->{angle}  = shift || 0; #unused
  213. return unless $self->{text};
  214. $self->{right} = $self->{left} + $self->{width};
  215. $self->_move_to_top;
  216. # FIXME We need a better paragraph separation RE
  217. foreach my $paragraph (split 'nn+', $self->{text})
  218. #foreach my $paragraph ($self->{text})
  219. {
  220. $self->_draw_paragraph($paragraph);
  221. $self->_new_paragraph;
  222. }
  223. $self->_undo_new_paragraph; # FIXME Yuck
  224. # Reset dry_run
  225. $dry_run = 0;
  226. $self->_set_bottom;
  227.     return (
  228.         $self->{left}, $self->{top},
  229.         $self->{right}, $self->{bottom}
  230.     )
  231. }
  232. sub _draw_paragraph
  233. {
  234. my $self = shift;
  235. my $text = shift;
  236. my @line = ();
  237. foreach my $word (split /(s+)/, $text)
  238. {
  239. # Number of newlines
  240. my $nnl = $self->{preserve_nl} ? $word =~ y/n// : 0;
  241. # Length of the whole line with this new word
  242. my $len = $nnl ? 0 : $self->{render}->width(join(' ', @line, $word));
  243. # If this is a separator without newlines, continue with next
  244. next if !$nnl && $word =~ /^s+$/;
  245. if (($len > $self->{right} - $self->{left} || $nnl) && @line)
  246. {
  247. $self->_draw_line(@line) unless $dry_run;
  248. @line = ();
  249. $self->_crlf;
  250. # XXX 5.004 compatibility
  251. #$self->_crlf for (2..$nnl);
  252. for (2..$nnl) { $self->_crlf }
  253. }
  254. # Store the new word, unless it's just newlines
  255. push @line, $word unless $nnl;
  256. }
  257. # Take care of the last line
  258. $self->_draw_last_line(@line) unless $dry_run;
  259. }
  260. sub _draw_line
  261. {
  262. my $self = shift;
  263. $self->__draw_line(0, @_);
  264. }
  265. sub _draw_last_line
  266. {
  267. my $self = shift;
  268. $self->__draw_line(1, @_);
  269. }
  270. sub __draw_line
  271. {
  272. my $self = shift;
  273. # We need the following for justification only
  274. my $last = shift;
  275.     for ($self->{align})
  276.     {
  277. /^just/i and !$last and do
  278. {
  279. $self->_draw_justified_line(@_);
  280. last;
  281. };
  282.         /^right/i   and do 
  283. {
  284. $self->{render}->set_text(join(' ', @_));
  285. $self->{render}->set_halign('right');
  286. $self->{render}->draw($self->{right}, $self->{_y_pos});
  287. last;
  288. };
  289.         /^center/i  and do
  290. {
  291. $self->{render}->set_text(join(' ', @_));
  292. $self->{render}->set_halign('left');
  293. my $x = ($self->{right} + $self->{left} - 
  294. $self->{render}->get('width')) / 2;
  295. $self->{render}->draw($x, $self->{_y_pos});
  296. last;
  297. };
  298.         # default action, left justification
  299. $self->{render}->set_text(join(' ', @_));
  300. $self->{render}->set_halign('left');
  301. $self->{render}->draw($self->{left}, $self->{_y_pos});
  302.     }
  303. }
  304. sub _draw_justified_line
  305. {
  306. my $self = shift;
  307. my $y = $self->{_y_pos};
  308. my $x = $self->{left};
  309. $self->{render}->set_halign('left');
  310. my @lengths = ();
  311. my $length = 0;
  312. # first, calculate the lengths of the individual words
  313. foreach my $word (@_)
  314. {
  315. $self->{render}->set_text($word);
  316. my $len = $self->{render}->get('width');
  317. push @lengths, $len;
  318. $length += $len;
  319. }
  320. # Calculate the average space between words
  321. my $space = ($self->{right} - $self->{left} - $length)/($#_ || 1);
  322. # Draw all the words, except the last one
  323. for (my $i = 0; $i < $#_; $i++)
  324. {
  325. $self->{render}->set_text($_[$i]);
  326. $self->{render}->draw($x, $y);
  327. $x += $lengths[$i] + $space;
  328. }
  329. # Draw the last word
  330. # XXX This will make a single word that's too long stick out the
  331. # right side of the box. is that what we want?
  332. $self->{render}->set_halign('right');
  333. $self->{render}->set_text($_[-1]);
  334. $self->{render}->draw($self->{right}, $y);
  335. }
  336. #
  337. # Delegate all the other methods to the GD::Text::Align method
  338. use vars qw($AUTOLOAD);
  339. sub AUTOLOAD
  340. {
  341. my $self = shift;
  342. my ($method) = $AUTOLOAD =~ /.*::(.*)$/;
  343. $self->{render}->$method(@_) if ($method ne 'DESTROY');
  344. }
  345. =head1 NOTES
  346. As with all Modules for Perl: Please stick to using the interface. If
  347. you try to fiddle too much with knowledge of the internals of this
  348. module, you may get burned. I may change them at any time.
  349. You can only use TrueType fonts with version of GD > 1.20, and then
  350. only if compiled with support for this. If you attempt to do it
  351. anyway, you will get errors.
  352. Even though this module lives in the GD::Text namespace, it is not a
  353. GD::Text. It does however delegate a lot of its functionality to a
  354. contained object that is one (GD::Text::Align).
  355. =head1 BUGS
  356. None that I know of, but that doesn't mean much. There may be some
  357. problems with exotic fonts, or locales and character encodings that I am
  358. not used to.
  359. =head1 TODO
  360. Angled boxes.
  361. At the moment, the only bit of the box that is allowed to be unspecified
  362. and in fact must be unspecified, is the bottom. If there is enough need
  363. for it, I might implement more flexibility, in that that you need to
  364. only specify three of the four sides of the box, and the fourth will
  365. be calculated.
  366. Automatic resizing of a TrueType font to fit inside a box when four
  367. sides are specified, or maybe some other nifty things.
  368. More flexibility in the interface. Especially draw needs some thought.
  369. More and better error handling.
  370. Warnings for lines that are too long and stick out of the box.
  371. Warning for emptyish lines?
  372. =head1 COPYRIGHT
  373. copyright 1999
  374. Martien Verbruggen (mgjv@comdyn.com.au)
  375. =head1 SEE ALSO
  376. L<GD>, L<GD::Text>, L<GD::Text::Align>
  377. =cut
  378. 1;