davebenvenuti-prawn 0.11.1.pre

Sign up to get free protection for your applications and to get access to all the features.
Files changed (291) hide show
  1. data/COPYING +340 -0
  2. data/HACKING +50 -0
  3. data/LICENSE +56 -0
  4. data/README +141 -0
  5. data/Rakefile +52 -0
  6. data/data/encodings/win_ansi.txt +29 -0
  7. data/data/fonts/Action Man.dfont +0 -0
  8. data/data/fonts/Activa.ttf +0 -0
  9. data/data/fonts/Chalkboard.ttf +0 -0
  10. data/data/fonts/Courier-Bold.afm +342 -0
  11. data/data/fonts/Courier-BoldOblique.afm +342 -0
  12. data/data/fonts/Courier-Oblique.afm +342 -0
  13. data/data/fonts/Courier.afm +342 -0
  14. data/data/fonts/DejaVuSans.ttf +0 -0
  15. data/data/fonts/Dustismo_Roman.ttf +0 -0
  16. data/data/fonts/Helvetica-Bold.afm +2827 -0
  17. data/data/fonts/Helvetica-BoldOblique.afm +2827 -0
  18. data/data/fonts/Helvetica-Oblique.afm +3051 -0
  19. data/data/fonts/Helvetica.afm +3051 -0
  20. data/data/fonts/MustRead.html +19 -0
  21. data/data/fonts/Symbol.afm +213 -0
  22. data/data/fonts/Times-Bold.afm +2588 -0
  23. data/data/fonts/Times-BoldItalic.afm +2384 -0
  24. data/data/fonts/Times-Italic.afm +2667 -0
  25. data/data/fonts/Times-Roman.afm +2419 -0
  26. data/data/fonts/ZapfDingbats.afm +225 -0
  27. data/data/fonts/comicsans.ttf +0 -0
  28. data/data/fonts/gkai00mp.ttf +0 -0
  29. data/data/images/16bit.alpha +0 -0
  30. data/data/images/16bit.dat +0 -0
  31. data/data/images/16bit.png +0 -0
  32. data/data/images/arrow.png +0 -0
  33. data/data/images/arrow2.png +0 -0
  34. data/data/images/barcode_issue.png +0 -0
  35. data/data/images/dice.alpha +0 -0
  36. data/data/images/dice.dat +0 -0
  37. data/data/images/dice.png +0 -0
  38. data/data/images/dice_interlaced.png +0 -0
  39. data/data/images/fractal.jpg +0 -0
  40. data/data/images/letterhead.jpg +0 -0
  41. data/data/images/page_white_text.alpha +0 -0
  42. data/data/images/page_white_text.dat +0 -0
  43. data/data/images/page_white_text.png +0 -0
  44. data/data/images/pigs.jpg +0 -0
  45. data/data/images/rails.dat +0 -0
  46. data/data/images/rails.png +0 -0
  47. data/data/images/ruport.png +0 -0
  48. data/data/images/ruport_data.dat +0 -0
  49. data/data/images/ruport_transparent.png +0 -0
  50. data/data/images/ruport_type0.png +0 -0
  51. data/data/images/stef.jpg +0 -0
  52. data/data/images/tru256.bmp +0 -0
  53. data/data/images/web-links.dat +1 -0
  54. data/data/images/web-links.png +0 -0
  55. data/data/pdfs/complex_template.pdf +0 -0
  56. data/data/pdfs/contains_ttf_font.pdf +0 -0
  57. data/data/pdfs/encrypted.pdf +0 -0
  58. data/data/pdfs/hexagon.pdf +61 -0
  59. data/data/pdfs/indirect_reference.pdf +86 -0
  60. data/data/pdfs/nested_pages.pdf +118 -0
  61. data/data/pdfs/page_without_mediabox.pdf +193 -0
  62. data/data/pdfs/resources_as_indirect_object.pdf +83 -0
  63. data/data/pdfs/two_hexagons.pdf +90 -0
  64. data/data/pdfs/version_1_6.pdf +61 -0
  65. data/data/shift_jis_text.txt +1 -0
  66. data/examples/bounding_box/bounding_boxes.rb +44 -0
  67. data/examples/bounding_box/indentation.rb +35 -0
  68. data/examples/bounding_box/russian_boxes.rb +37 -0
  69. data/examples/bounding_box/stretched_nesting.rb +68 -0
  70. data/examples/example_helper.rb +8 -0
  71. data/examples/general/background.rb +24 -0
  72. data/examples/general/canvas.rb +16 -0
  73. data/examples/general/context_sensitive_headers.rb +38 -0
  74. data/examples/general/float.rb +12 -0
  75. data/examples/general/margin.rb +37 -0
  76. data/examples/general/measurement_units.rb +52 -0
  77. data/examples/general/metadata-info.rb +17 -0
  78. data/examples/general/multi_page_layout.rb +19 -0
  79. data/examples/general/outlines.rb +67 -0
  80. data/examples/general/page_geometry.rb +32 -0
  81. data/examples/general/page_numbering.rb +16 -0
  82. data/examples/general/repeaters.rb +48 -0
  83. data/examples/general/stamp.rb +42 -0
  84. data/examples/general/templates.rb +14 -0
  85. data/examples/graphics/basic_images.rb +24 -0
  86. data/examples/graphics/cmyk.rb +13 -0
  87. data/examples/graphics/curves.rb +12 -0
  88. data/examples/graphics/hexagon.rb +14 -0
  89. data/examples/graphics/image_fit.rb +16 -0
  90. data/examples/graphics/image_flow.rb +38 -0
  91. data/examples/graphics/image_position.rb +18 -0
  92. data/examples/graphics/line.rb +33 -0
  93. data/examples/graphics/png_types.rb +23 -0
  94. data/examples/graphics/polygons.rb +17 -0
  95. data/examples/graphics/remote_images.rb +13 -0
  96. data/examples/graphics/rounded_polygons.rb +20 -0
  97. data/examples/graphics/rounded_rectangle.rb +21 -0
  98. data/examples/graphics/ruport_style_helpers.rb +20 -0
  99. data/examples/graphics/stroke_bounds.rb +21 -0
  100. data/examples/graphics/stroke_cap_and_join.rb +46 -0
  101. data/examples/graphics/stroke_dash.rb +43 -0
  102. data/examples/graphics/transformations.rb +53 -0
  103. data/examples/graphics/transparency.rb +27 -0
  104. data/examples/grid/bounding_boxes.rb +22 -0
  105. data/examples/grid/column_gutter_grid.rb +21 -0
  106. data/examples/grid/multi_boxes.rb +52 -0
  107. data/examples/grid/show_grid.rb +14 -0
  108. data/examples/grid/simple_grid.rb +21 -0
  109. data/examples/m17n/chinese_text_wrapping.rb +18 -0
  110. data/examples/m17n/euro.rb +16 -0
  111. data/examples/m17n/sjis.rb +29 -0
  112. data/examples/m17n/utf8.rb +14 -0
  113. data/examples/m17n/win_ansi_charset.rb +55 -0
  114. data/examples/security/hello_foo.rb +9 -0
  115. data/examples/table/bill.rb +54 -0
  116. data/examples/table/cell.rb +13 -0
  117. data/examples/table/checkerboard.rb +23 -0
  118. data/examples/table/header.rb +15 -0
  119. data/examples/table/inline_format_table.rb +13 -0
  120. data/examples/table/multi_page_table.rb +10 -0
  121. data/examples/table/simple_table.rb +25 -0
  122. data/examples/table/subtable.rb +13 -0
  123. data/examples/table/widths.rb +21 -0
  124. data/examples/text/alignment.rb +19 -0
  125. data/examples/text/character_spacing.rb +13 -0
  126. data/examples/text/dfont.rb +49 -0
  127. data/examples/text/family_based_styling.rb +25 -0
  128. data/examples/text/font_calculations.rb +92 -0
  129. data/examples/text/font_size.rb +34 -0
  130. data/examples/text/hyphenation.rb +46 -0
  131. data/examples/text/indent_paragraphs.rb +23 -0
  132. data/examples/text/inline_format.rb +104 -0
  133. data/examples/text/kerning.rb +31 -0
  134. data/examples/text/rotated.rb +99 -0
  135. data/examples/text/shaped_text_box.rb +32 -0
  136. data/examples/text/simple_text.rb +18 -0
  137. data/examples/text/simple_text_ttf.rb +18 -0
  138. data/examples/text/span.rb +30 -0
  139. data/examples/text/text_box.rb +89 -0
  140. data/examples/text/text_box_returning_excess.rb +52 -0
  141. data/examples/text/text_flow.rb +68 -0
  142. data/lib/prawn.rb +26 -0
  143. data/lib/prawn/compatibility.rb +51 -0
  144. data/lib/prawn/core.rb +85 -0
  145. data/lib/prawn/core/annotations.rb +61 -0
  146. data/lib/prawn/core/byte_string.rb +9 -0
  147. data/lib/prawn/core/destinations.rb +90 -0
  148. data/lib/prawn/core/document_state.rb +78 -0
  149. data/lib/prawn/core/literal_string.rb +16 -0
  150. data/lib/prawn/core/name_tree.rb +165 -0
  151. data/lib/prawn/core/object_store.rb +236 -0
  152. data/lib/prawn/core/page.rb +199 -0
  153. data/lib/prawn/core/pdf_object.rb +108 -0
  154. data/lib/prawn/core/reference.rb +112 -0
  155. data/lib/prawn/core/text.rb +140 -0
  156. data/lib/prawn/core/text/formatted/arranger.rb +266 -0
  157. data/lib/prawn/core/text/formatted/line_wrap.rb +127 -0
  158. data/lib/prawn/core/text/formatted/wrap.rb +112 -0
  159. data/lib/prawn/core/text/line_wrap.rb +211 -0
  160. data/lib/prawn/core/text/wrap.rb +82 -0
  161. data/lib/prawn/document.rb +575 -0
  162. data/lib/prawn/document/bounding_box.rb +428 -0
  163. data/lib/prawn/document/graphics_state.rb +48 -0
  164. data/lib/prawn/document/internals.rb +170 -0
  165. data/lib/prawn/document/page_geometry.rb +136 -0
  166. data/lib/prawn/document/snapshot.rb +87 -0
  167. data/lib/prawn/document/span.rb +55 -0
  168. data/lib/prawn/encoding.rb +121 -0
  169. data/lib/prawn/errors.rb +86 -0
  170. data/lib/prawn/font.rb +368 -0
  171. data/lib/prawn/font/afm.rb +225 -0
  172. data/lib/prawn/font/dfont.rb +42 -0
  173. data/lib/prawn/font/ttf.rb +350 -0
  174. data/lib/prawn/graphics.rb +325 -0
  175. data/lib/prawn/graphics/cap_style.rb +38 -0
  176. data/lib/prawn/graphics/color.rb +205 -0
  177. data/lib/prawn/graphics/dash.rb +71 -0
  178. data/lib/prawn/graphics/join_style.rb +38 -0
  179. data/lib/prawn/graphics/transformation.rb +156 -0
  180. data/lib/prawn/graphics/transparency.rb +99 -0
  181. data/lib/prawn/images.rb +217 -0
  182. data/lib/prawn/images/jpg.rb +85 -0
  183. data/lib/prawn/images/png.rb +356 -0
  184. data/lib/prawn/layout.rb +20 -0
  185. data/lib/prawn/layout/grid.rb +259 -0
  186. data/lib/prawn/measurement_extensions.rb +46 -0
  187. data/lib/prawn/measurements.rb +71 -0
  188. data/lib/prawn/outline.rb +326 -0
  189. data/lib/prawn/repeater.rb +129 -0
  190. data/lib/prawn/security.rb +262 -0
  191. data/lib/prawn/security/arcfour.rb +51 -0
  192. data/lib/prawn/stamp.rb +126 -0
  193. data/lib/prawn/table.rb +451 -0
  194. data/lib/prawn/table/cell.rb +395 -0
  195. data/lib/prawn/table/cell/in_table.rb +27 -0
  196. data/lib/prawn/table/cell/subtable.rb +65 -0
  197. data/lib/prawn/table/cell/text.rb +135 -0
  198. data/lib/prawn/table/cells.rb +206 -0
  199. data/lib/prawn/text.rb +449 -0
  200. data/lib/prawn/text/box.rb +397 -0
  201. data/lib/prawn/text/formatted.rb +4 -0
  202. data/lib/prawn/text/formatted/box.rb +222 -0
  203. data/lib/prawn/text/formatted/fragment.rb +181 -0
  204. data/lib/prawn/text/formatted/parser.rb +213 -0
  205. data/prawn.gemspec +28 -0
  206. data/spec/annotations_spec.rb +90 -0
  207. data/spec/bounding_box_spec.rb +190 -0
  208. data/spec/cell_spec.rb +430 -0
  209. data/spec/destinations_spec.rb +15 -0
  210. data/spec/document_spec.rb +476 -0
  211. data/spec/extensions/mocha.rb +32 -0
  212. data/spec/font_spec.rb +324 -0
  213. data/spec/formatted_text_arranger_spec.rb +426 -0
  214. data/spec/formatted_text_box_spec.rb +756 -0
  215. data/spec/formatted_text_fragment_spec.rb +211 -0
  216. data/spec/graphics_spec.rb +446 -0
  217. data/spec/grid_spec.rb +85 -0
  218. data/spec/images_spec.rb +119 -0
  219. data/spec/inline_formatted_text_parser_spec.rb +502 -0
  220. data/spec/jpg_spec.rb +25 -0
  221. data/spec/line_wrap_spec.rb +341 -0
  222. data/spec/measurement_units_spec.rb +23 -0
  223. data/spec/name_tree_spec.rb +112 -0
  224. data/spec/object_store_spec.rb +160 -0
  225. data/spec/outline_spec.rb +404 -0
  226. data/spec/pdf_object_spec.rb +170 -0
  227. data/spec/png_spec.rb +237 -0
  228. data/spec/reference_spec.rb +82 -0
  229. data/spec/repeater_spec.rb +96 -0
  230. data/spec/security_spec.rb +120 -0
  231. data/spec/snapshot_spec.rb +154 -0
  232. data/spec/span_spec.rb +49 -0
  233. data/spec/spec_helper.rb +34 -0
  234. data/spec/stamp_spec.rb +108 -0
  235. data/spec/stroke_styles_spec.rb +163 -0
  236. data/spec/table_spec.rb +687 -0
  237. data/spec/template_spec.rb +165 -0
  238. data/spec/text_at_spec.rb +125 -0
  239. data/spec/text_box_spec.rb +777 -0
  240. data/spec/text_spacing_spec.rb +75 -0
  241. data/spec/text_spec.rb +349 -0
  242. data/spec/text_with_inline_formatting_spec.rb +193 -0
  243. data/spec/transparency_spec.rb +89 -0
  244. data/vendor/pdf-inspector/README +18 -0
  245. data/vendor/pdf-inspector/lib/pdf/inspector.rb +26 -0
  246. data/vendor/pdf-inspector/lib/pdf/inspector/extgstate.rb +18 -0
  247. data/vendor/pdf-inspector/lib/pdf/inspector/graphics.rb +131 -0
  248. data/vendor/pdf-inspector/lib/pdf/inspector/page.rb +25 -0
  249. data/vendor/pdf-inspector/lib/pdf/inspector/text.rb +46 -0
  250. data/vendor/pdf-inspector/lib/pdf/inspector/xobject.rb +19 -0
  251. data/vendor/ttfunk/data/fonts/DejaVuSans.ttf +0 -0
  252. data/vendor/ttfunk/data/fonts/comicsans.ttf +0 -0
  253. data/vendor/ttfunk/example.rb +45 -0
  254. data/vendor/ttfunk/lib/ttfunk.rb +102 -0
  255. data/vendor/ttfunk/lib/ttfunk/directory.rb +17 -0
  256. data/vendor/ttfunk/lib/ttfunk/encoding/mac_roman.rb +88 -0
  257. data/vendor/ttfunk/lib/ttfunk/encoding/windows_1252.rb +69 -0
  258. data/vendor/ttfunk/lib/ttfunk/reader.rb +44 -0
  259. data/vendor/ttfunk/lib/ttfunk/resource_file.rb +78 -0
  260. data/vendor/ttfunk/lib/ttfunk/subset.rb +18 -0
  261. data/vendor/ttfunk/lib/ttfunk/subset/base.rb +141 -0
  262. data/vendor/ttfunk/lib/ttfunk/subset/mac_roman.rb +50 -0
  263. data/vendor/ttfunk/lib/ttfunk/subset/unicode.rb +48 -0
  264. data/vendor/ttfunk/lib/ttfunk/subset/unicode_8bit.rb +63 -0
  265. data/vendor/ttfunk/lib/ttfunk/subset/windows_1252.rb +55 -0
  266. data/vendor/ttfunk/lib/ttfunk/subset_collection.rb +72 -0
  267. data/vendor/ttfunk/lib/ttfunk/table.rb +46 -0
  268. data/vendor/ttfunk/lib/ttfunk/table/cmap.rb +34 -0
  269. data/vendor/ttfunk/lib/ttfunk/table/cmap/format00.rb +54 -0
  270. data/vendor/ttfunk/lib/ttfunk/table/cmap/format04.rb +126 -0
  271. data/vendor/ttfunk/lib/ttfunk/table/cmap/subtable.rb +79 -0
  272. data/vendor/ttfunk/lib/ttfunk/table/glyf.rb +64 -0
  273. data/vendor/ttfunk/lib/ttfunk/table/glyf/compound.rb +81 -0
  274. data/vendor/ttfunk/lib/ttfunk/table/glyf/simple.rb +37 -0
  275. data/vendor/ttfunk/lib/ttfunk/table/head.rb +44 -0
  276. data/vendor/ttfunk/lib/ttfunk/table/hhea.rb +41 -0
  277. data/vendor/ttfunk/lib/ttfunk/table/hmtx.rb +47 -0
  278. data/vendor/ttfunk/lib/ttfunk/table/kern.rb +79 -0
  279. data/vendor/ttfunk/lib/ttfunk/table/kern/format0.rb +62 -0
  280. data/vendor/ttfunk/lib/ttfunk/table/loca.rb +43 -0
  281. data/vendor/ttfunk/lib/ttfunk/table/maxp.rb +40 -0
  282. data/vendor/ttfunk/lib/ttfunk/table/name.rb +125 -0
  283. data/vendor/ttfunk/lib/ttfunk/table/os2.rb +78 -0
  284. data/vendor/ttfunk/lib/ttfunk/table/post.rb +91 -0
  285. data/vendor/ttfunk/lib/ttfunk/table/post/format10.rb +43 -0
  286. data/vendor/ttfunk/lib/ttfunk/table/post/format20.rb +35 -0
  287. data/vendor/ttfunk/lib/ttfunk/table/post/format25.rb +23 -0
  288. data/vendor/ttfunk/lib/ttfunk/table/post/format30.rb +17 -0
  289. data/vendor/ttfunk/lib/ttfunk/table/post/format40.rb +17 -0
  290. data/vendor/ttfunk/lib/ttfunk/table/simple.rb +14 -0
  291. metadata +379 -0
@@ -0,0 +1,397 @@
1
+ # encoding: utf-8
2
+
3
+ # text/rectangle.rb : Implements text boxes
4
+ #
5
+ # Copyright November 2009, Daniel Nelson. All Rights Reserved.
6
+ #
7
+ # This is free software. Please see the LICENSE and COPYING files for details.
8
+ #
9
+
10
+ module Prawn
11
+ module Text
12
+
13
+ # Draws the requested text into a box. When the text overflows
14
+ # the rectangle, you can display ellipses, shrink to fit, or
15
+ # truncate the text. Text boxes are independent of the document
16
+ # y position.
17
+ #
18
+ # == Encoding
19
+ #
20
+ # Note that strings passed to this function should be encoded as UTF-8.
21
+ # If you get unexpected characters appearing in your rendered document,
22
+ # check this.
23
+ #
24
+ # If the current font is a built-in one, although the string must be
25
+ # encoded as UTF-8, only characters that are available in WinAnsi
26
+ # are allowed.
27
+ #
28
+ # If an empty box is rendered to your PDF instead of the character you
29
+ # wanted it usually means the current font doesn't include that character.
30
+ #
31
+ # == Options (default values marked in [])
32
+ #
33
+ # <tt>:kerning</tt>:: <tt>boolean</tt>. Whether or not to use kerning (if it
34
+ # is available with the current font)
35
+ # [value of document.default_kerning?]
36
+ # <tt>:size</tt>:: <tt>number</tt>. The font size to use. [current font
37
+ # size]
38
+ # <tt>:character_spacing</tt>:: <tt>number</tt>. The amount of space to add
39
+ # to or remove from the default character
40
+ # spacing. [0]
41
+ # <tt>:style</tt>:: The style to use. The requested style must be part of
42
+ # the current font familly. [current style]
43
+ #
44
+ # <tt>:at</tt>::
45
+ # <tt>[x, y]</tt>. The upper left corner of the box
46
+ # [@document.bounds.left, @document.bounds.top]
47
+ # <tt>:width</tt>::
48
+ # <tt>number</tt>. The width of the box [@document.bounds.right - @at[0]]
49
+ # <tt>:height</tt>::
50
+ # <tt>number</tt>. The height of the box [default_height()]
51
+ # <tt>:align</tt>::
52
+ # <tt>:left</tt>, <tt>:center</tt>, <tt>:right</tt>, or
53
+ # <tt>:justify</tt> Alignment within the bounding box [:left]
54
+ # <tt>:valign</tt>::
55
+ # <tt>:top</tt>, <tt>:center</tt>, or <tt>:bottom</tt>. Vertical
56
+ # alignment within the bounding box [:top]
57
+ #
58
+ # <tt>:rotate</tt>::
59
+ # <tt>number</tt>. The angle to rotate the text
60
+ # <tt>:rotate_around</tt>::
61
+ # <tt>:center</tt>, <tt>:upper_left</tt>, <tt>:upper_right</tt>,
62
+ # <tt>:lower_right</tt>, or <tt>:lower_left</tt>. The point around which
63
+ # to rotate the text [:upper_left]
64
+ # <tt>:leading</tt>::
65
+ # <tt>number</tt>. Additional space between lines [0]
66
+ # <tt>:single_line</tt>::
67
+ # <tt>boolean</tt>. If true, then only the first line will be drawn [false]
68
+ # <tt>:skip_encoding</tt>::
69
+ # <tt>boolean</tt> [false]
70
+ # <tt>:overflow</tt>::
71
+ # <tt>:truncate</tt>, <tt>:shrink_to_fit</tt>, <tt>:expand</tt>, or
72
+ # <tt>:ellipses</tt>. This controls the behavior when the amount of text
73
+ # exceeds the available space. <tt>:ellipses</tt> [:truncate]
74
+ # <tt>:min_font_size</tt>::
75
+ # <tt>number</tt>. The minimum font size to use when :overflow is set to
76
+ # :shrink_to_fit (that is the font size will not be reduced to less than
77
+ # this value, even if it means that some text will be cut off). [5]
78
+ #
79
+ # == Returns
80
+ #
81
+ # Returns any text that did not print under the current settings.
82
+ #
83
+ # NOTE: if an AFM font is used, then the returned text is encoded in
84
+ # WinAnsi. Subsequent calls to text_box that pass this returned text back
85
+ # into text box must include a :skip_encoding => true option. This is
86
+ # unnecessary when using TTF fonts because those operate on UTF-8 encoding.
87
+ #
88
+ # == Exceptions
89
+ #
90
+ # Raises <tt>Prawn::Errrors::CannotFit</tt> if not wide enough to print
91
+ # any text
92
+ #
93
+ def text_box(string, options={})
94
+ Text::Box.new(string, options.merge(:document => self)).render
95
+ end
96
+
97
+ # Generally, one would use the Prawn::Text#text_box convenience
98
+ # method. However, using Text::Box.new in conjunction with
99
+ # #render(:dry_run=> true) enables one to do look-ahead calculations prior
100
+ # to placing text on the page, or to determine how much vertical space was
101
+ # consumed by the printed text
102
+ #
103
+ class Box
104
+ include Prawn::Core::Text::Wrap
105
+
106
+ def valid_options
107
+ Prawn::Core::Text::VALID_OPTIONS + [:at, :height, :width,
108
+ :align, :valign,
109
+ :rotate, :rotate_around,
110
+ :overflow, :min_font_size,
111
+ :leading, :character_spacing,
112
+ :single_line,
113
+ :skip_encoding,
114
+ :document]
115
+ end
116
+
117
+ # The text that was successfully printed (or, if <tt>dry_run</tt> was
118
+ # used, the test that would have been successfully printed)
119
+ attr_reader :text
120
+ # The upper left corner of the text box
121
+ attr_reader :at
122
+ # The line height of the last line printed
123
+ attr_reader :line_height
124
+ # The height of the ascender of the last line printed
125
+ attr_reader :ascender
126
+ # The height of the descender of the last line printed
127
+ attr_reader :descender
128
+ # The leading used during printing
129
+ attr_reader :leading
130
+
131
+
132
+ # Extend Prawn::Text::Box
133
+ #
134
+ # Example (see Prawn::Text::Core::Wrap for what is required
135
+ # of the wrap method if you want to override the default
136
+ # wrapping algorithm):
137
+ #
138
+ # module MyWrap
139
+ #
140
+ # def wrap
141
+ # @text = nil
142
+ # @line_height = @document.font.height
143
+ # @descender = @document.font.descender
144
+ # @ascender = @document.font.ascender
145
+ # @baseline_y = -@ascender
146
+ # draw_line("all your base are belong to us")
147
+ # ""
148
+ # end
149
+ #
150
+ # end
151
+ #
152
+ # Prawn::Text::Box.extensions << MyWrap
153
+ #
154
+ # box = Prawn::Text::Box.new('hello world')
155
+ # box.render('why can't I print anything other than' +
156
+ # '"all your base are belong to us"?')
157
+ #
158
+ #
159
+ def self.extensions
160
+ @extensions ||= []
161
+ end
162
+
163
+ def self.inherited(base) #:nodoc:
164
+ extensions.each { |e| base.extensions << e }
165
+ end
166
+
167
+ # See Prawn::Text#text_box for valid options
168
+ #
169
+ def initialize(text, options={})
170
+ @inked = false
171
+ Prawn.verify_options(valid_options, options)
172
+ options = options.dup
173
+
174
+ self.class.extensions.reverse_each { |e| extend e }
175
+
176
+ @overflow = options[:overflow] || :truncate
177
+
178
+ self.original_text = text
179
+ @text = nil
180
+
181
+ @document = options[:document]
182
+ @at = options[:at] ||
183
+ [@document.bounds.left, @document.bounds.top]
184
+ @width = options[:width] ||
185
+ @document.bounds.right - @at[0]
186
+ @height = options[:height] || default_height
187
+ @align = options[:align] || :left
188
+ @vertical_align = options[:valign] || :top
189
+ @leading = options[:leading] || @document.default_leading?
190
+ @character_spacing = options[:character_spacing] ||
191
+ @document.character_spacing
192
+ @rotate = options[:rotate] || 0
193
+ @rotate_around = options[:rotate_around] || :upper_left
194
+ @single_line = options[:single_line]
195
+ @skip_encoding = options[:skip_encoding] || @document.skip_encoding
196
+
197
+ if @overflow == :expand
198
+ # if set to expand, then we simply set the bottom
199
+ # as the bottom of the document bounds, since that
200
+ # is the maximum we should expand to
201
+ @height = default_height
202
+ @overflow = :truncate
203
+ end
204
+ @min_font_size = options[:min_font_size] || 5
205
+ if options[:kerning].nil? then
206
+ options[:kerning] = @document.default_kerning?
207
+ end
208
+ @options = { :kerning => options[:kerning],
209
+ :size => options[:size],
210
+ :style => options[:style] }
211
+
212
+ super(text, options)
213
+ end
214
+
215
+ # Render text to the document based on the settings defined in initialize.
216
+ #
217
+ # In order to facilitate look-ahead calculations, <tt>render</tt> accepts
218
+ # a <tt>:dry_run => true</tt> option. If provided, then everything is
219
+ # executed as if rendering, with the exception that nothing is drawn on
220
+ # the page. Useful for look-ahead computations of height, unprinted text,
221
+ # etc.
222
+ #
223
+ # Returns any text that did not print under the current settings
224
+ #
225
+ def render(flags={})
226
+ unprinted_text = ''
227
+ @document.save_font do
228
+ @document.character_spacing(@character_spacing) do
229
+ process_options
230
+
231
+ if @skip_encoding
232
+ text = original_text
233
+ else
234
+ text = normalize_encoding
235
+ end
236
+
237
+ @document.font_size(@font_size) do
238
+ shrink_to_fit(text) if @overflow == :shrink_to_fit
239
+ process_vertical_alignment(text)
240
+ @inked = true unless flags[:dry_run]
241
+ if @rotate != 0 && @inked
242
+ unprinted_text = render_rotated(text)
243
+ else
244
+ unprinted_text = wrap(text)
245
+ end
246
+ @inked = false
247
+ end
248
+ end
249
+ end
250
+
251
+ unprinted_text
252
+ end
253
+
254
+ # The height actually used during the previous <tt>render</tt>
255
+ #
256
+ def height
257
+ return 0 if @baseline_y.nil? || @descender.nil?
258
+ # baseline is already pushed down one line below the current
259
+ # line, so we need to subtract line line_height and leading,
260
+ # but we need to add in the descender since baseline is
261
+ # above the descender
262
+ @baseline_y.abs - @ascender - @leading
263
+ end
264
+
265
+ # The width available at this point in the box
266
+ #
267
+ def available_width
268
+ @width
269
+ end
270
+
271
+ def draw_line(line_to_print, line_width=0, word_spacing=0, include_ellipses=false) #:nodoc:
272
+ insert_ellipses(line_to_print) if include_ellipses
273
+
274
+ case(@align)
275
+ when :left, :justify
276
+ x = @at[0]
277
+ when :center
278
+ x = @at[0] + @width * 0.5 - line_width * 0.5
279
+ when :right
280
+ x = @at[0] + @width - line_width
281
+ end
282
+
283
+ y = @at[1] + @baseline_y
284
+
285
+ if @inked
286
+ @document.word_spacing(word_spacing) {
287
+ @document.character_spacing(@character_spacing) {
288
+ @document.draw_text!(line_to_print, :at => [x, y],
289
+ :kerning => @kerning)
290
+ }
291
+ }
292
+ end
293
+
294
+ line_to_print
295
+ end
296
+
297
+ private
298
+
299
+ # Returns the default height to be used if none is provided or if the
300
+ # overflow option is set to :expand. If we are in a stretchy bounding
301
+ # box, assume we can stretch to the bottom of the innermost non-stretchy
302
+ # box.
303
+ #
304
+ def default_height
305
+ # Find the "frame", the innermost non-stretchy bbox.
306
+ frame = @document.bounds
307
+ frame = frame.parent while frame.stretchy? && frame.parent
308
+
309
+ @at[1] + @document.bounds.absolute_bottom - frame.absolute_bottom
310
+ end
311
+
312
+ def normalize_encoding
313
+ @document.font.normalize_encoding(@original_string)
314
+ end
315
+
316
+ def original_text
317
+ @original_string
318
+ end
319
+
320
+ def original_text=(string)
321
+ @original_string = string.dup
322
+ end
323
+
324
+ def process_vertical_alignment(text)
325
+ return if @vertical_align == :top
326
+ wrap(text)
327
+ case @vertical_align
328
+ when :center
329
+ @at[1] = @at[1] - (@height - height) * 0.5
330
+ when :bottom
331
+ @at[1] = @at[1] - (@height - height)
332
+ end
333
+ @height = height
334
+ end
335
+
336
+ # Decrease the font size until the text fits or the min font
337
+ # size is reached
338
+ def shrink_to_fit(text)
339
+ while (unprinted_text = wrap(text)).length > 0 &&
340
+ @font_size > @min_font_size
341
+ @font_size -= 0.5
342
+ @document.font_size = @font_size
343
+ end
344
+ end
345
+
346
+ def process_options
347
+ # must be performed within a save_font bock because
348
+ # document.process_text_options sets the font
349
+ @document.process_text_options(@options)
350
+ @font_size = @options[:size]
351
+ @kerning = @options[:kerning]
352
+ end
353
+
354
+ def render_rotated(text)
355
+ unprinted_text = ''
356
+
357
+ case @rotate_around
358
+ when :center
359
+ x = @at[0] + @width * 0.5
360
+ y = @at[1] - @height * 0.5
361
+ when :upper_right
362
+ x = @at[0] + @width
363
+ y = @at[1]
364
+ when :lower_right
365
+ x = @at[0] + @width
366
+ y = @at[1] - @height
367
+ when :lower_left
368
+ x = @at[0]
369
+ y = @at[1] - @height
370
+ else
371
+ x = @at[0]
372
+ y = @at[1]
373
+ end
374
+
375
+ @document.rotate(@rotate, :origin => [x, y]) do
376
+ unprinted_text = wrap(text)
377
+ end
378
+ unprinted_text
379
+ end
380
+
381
+ def last_line?
382
+ @baseline_y.abs + @descender > @height - @line_height
383
+ end
384
+
385
+ def insert_ellipses(line_to_print)
386
+ if @document.width_of(line_to_print + "...",
387
+ :kerning => @kerning) < available_width
388
+ line_to_print.insert(-1, "...")
389
+ else
390
+ line_to_print[-3..-1] = "..." if line_to_print.length > 3
391
+ end
392
+ end
393
+
394
+ end
395
+
396
+ end
397
+ end
@@ -0,0 +1,4 @@
1
+ require "prawn/core/text/formatted/wrap"
2
+ require "prawn/text/formatted/box"
3
+ require "prawn/text/formatted/parser"
4
+ require "prawn/text/formatted/fragment"
@@ -0,0 +1,222 @@
1
+ # encoding: utf-8
2
+
3
+ # text/formatted/rectangle.rb : Implements text boxes with formatted text
4
+ #
5
+ # Copyright February 2010, Daniel Nelson. All Rights Reserved.
6
+ #
7
+ # This is free software. Please see the LICENSE and COPYING files for details.
8
+ #
9
+
10
+ module Prawn
11
+ module Text
12
+ module Formatted
13
+
14
+ # Draws the requested formatted text into a box. When the text overflows
15
+ # the rectangle shrink to fit or truncate the text. Text boxes are
16
+ # independent of the document y position.
17
+ #
18
+ # == Formatted Text Array
19
+ #
20
+ # Formatted text is comprised of an array of hashes, where each hash
21
+ # defines text and format information. As of the time of writing, the
22
+ # following hash options are supported:
23
+ #
24
+ # <tt>:text</tt>::
25
+ # the text to format according to the other hash options
26
+ # <tt>:styles</tt>::
27
+ # an array of styles to apply to this text. Available styles include
28
+ # :bold, :italic, :underline, :strikethrough, :subscript, and
29
+ # :superscript
30
+ # <tt>:size</tt>::
31
+ # a number denoting the font size to apply to this text
32
+ # <tt>:character_spacing</tt>::
33
+ # a number denoting how much to increase or decrease the default
34
+ # spacing between characters
35
+ # <tt>:font</tt>::
36
+ # the name of a font. The name must be an AFM font with the desired
37
+ # faces or must be a font that is already registered using
38
+ # Prawn::Document#font_families
39
+ # <tt>:color</tt>::
40
+ # anything compatible with Prawn::Graphics::Color#fill_color and
41
+ # Prawn::Graphics::Color#stroke_color
42
+ # <tt>:link</tt>::
43
+ # a URL to which to create a link. A clickable link will be created
44
+ # to that URL. Note that you must explicitly underline and color using
45
+ # the appropriate tags if you which to draw attention to the link
46
+ # <tt>:anchor</tt>::
47
+ # a destination that has already been or will be registered using
48
+ # Prawn::Core::Destinations#add_dest. A clickable link will be
49
+ # created to that destination. Note that you must explicitly underline
50
+ # and color using the appropriate tags if you which to draw attention
51
+ # to the link
52
+ # <tt>:callback</tt>::
53
+ # an object (or array of such objects) with two methods:
54
+ # #render_behind and #render_in_front, which are called immediately
55
+ # prior to and immediately after rendring the text fragment and which
56
+ # are passed the fragment as an argument
57
+ #
58
+ # == Example
59
+ #
60
+ # formatted_text_box([{ :text => "hello" },
61
+ # { :text => "world",
62
+ # :size => 24,
63
+ # :styles => [:bold, :italic] }])
64
+ #
65
+ # == Options
66
+ #
67
+ # Accepts the same options as Text::Box with the below exceptions
68
+ #
69
+ # <tt>:overflow</tt>::
70
+ # does not accept :ellipses
71
+ #
72
+ # == Returns
73
+ #
74
+ # Returns a formatted text array representing any text that did not print
75
+ # under the current settings.
76
+ #
77
+ # == Exceptions
78
+ #
79
+ # Raises "Bad font family" if no font family is defined for the current font
80
+ #
81
+ # Raises <tt>Prawn::Errrors::CannotFit</tt> if not wide enough to print
82
+ # any text
83
+ #
84
+ # Raises <tt>NotImplementedError</tt> if <tt>:ellipses</tt> <tt>overflow</tt>
85
+ # option included
86
+ #
87
+ def formatted_text_box(array, options)
88
+ Text::Formatted::Box.new(array, options.merge(:document => self)).render
89
+ end
90
+
91
+ # Generally, one would use the Prawn::Text::Formatted#formatted_text_box
92
+ # convenience method. However, using Text::Formatted::Box.new in
93
+ # conjunction with #render(:dry_run => true) enables one to do look-ahead
94
+ # calculations prior to placing text on the page, or to determine how much
95
+ # vertical space was consumed by the printed text
96
+ #
97
+ class Box < Prawn::Text::Box
98
+ include Prawn::Core::Text::Formatted::Wrap
99
+
100
+ def initialize(array, options={})
101
+ super(array, options)
102
+ if @overflow == :ellipses
103
+ raise NotImplementedError, "ellipses overflow unavailable with" +
104
+ "formatted box"
105
+ end
106
+ end
107
+
108
+ # The height actually used during the previous <tt>render</tt>
109
+ #
110
+ def height
111
+ return 0 if @baseline_y.nil? || @descender.nil?
112
+ @baseline_y.abs + @line_height - @ascender
113
+ end
114
+
115
+ # <tt>fragment</tt> is a Prawn::Text::Formatted::Fragment object
116
+ #
117
+ def draw_fragment(fragment, accumulated_width=0, line_width=0, word_spacing=0) #:nodoc:
118
+ case(@align)
119
+ when :left, :justify
120
+ x = @at[0]
121
+ when :center
122
+ x = @at[0] + @width * 0.5 - line_width * 0.5
123
+ when :right
124
+ x = @at[0] + @width - line_width
125
+ end
126
+
127
+ x += accumulated_width
128
+
129
+ y = @at[1] + @baseline_y
130
+
131
+ y += fragment.y_offset
132
+
133
+ fragment.left = x
134
+ fragment.baseline = y
135
+
136
+ draw_fragment_underlays(fragment)
137
+
138
+ if @inked
139
+ @document.word_spacing(word_spacing) {
140
+ @document.draw_text!(fragment.text, :at => [x, y],
141
+ :kerning => @kerning)
142
+ }
143
+ draw_fragment_overlays(fragment)
144
+ end
145
+ end
146
+
147
+ private
148
+
149
+ def original_text
150
+ @original_array.collect { |hash| hash.dup }
151
+ end
152
+
153
+ def original_text=(array)
154
+ @original_array = array
155
+ end
156
+
157
+ def normalize_encoding
158
+ array = original_text
159
+ array.each do |hash|
160
+ hash[:text] = @document.font.normalize_encoding(hash[:text])
161
+ end
162
+ array
163
+ end
164
+
165
+ def move_baseline_down
166
+ if @baseline_y == 0
167
+ @baseline_y = -@ascender
168
+ else
169
+ @baseline_y -= (@line_height + @leading)
170
+ end
171
+ end
172
+
173
+ def draw_fragment_underlays(fragment)
174
+ fragment.callback_objects.each do |obj|
175
+ obj.render_behind(fragment) if obj.respond_to?(:render_behind)
176
+ end
177
+ end
178
+
179
+ def draw_fragment_overlays(fragment)
180
+ draw_fragment_overlay_styles(fragment)
181
+ draw_fragment_overlay_link(fragment)
182
+ draw_fragment_overlay_anchor(fragment)
183
+ fragment.callback_objects.each do |obj|
184
+ obj.render_in_front(fragment) if obj.respond_to?(:render_in_front)
185
+ end
186
+ end
187
+
188
+ def draw_fragment_overlay_link(fragment)
189
+ return unless fragment.link
190
+ box = fragment.absolute_bounding_box
191
+ @document.link_annotation(box,
192
+ :Border => [0, 0, 0],
193
+ :A => { :Type => :Action,
194
+ :S => :URI,
195
+ :URI => fragment.link })
196
+ end
197
+
198
+ def draw_fragment_overlay_anchor(fragment)
199
+ return unless fragment.anchor
200
+ box = fragment.absolute_bounding_box
201
+ @document.link_annotation(box,
202
+ :Border => [0, 0, 0],
203
+ :Dest => fragment.anchor)
204
+ end
205
+
206
+ def draw_fragment_overlay_styles(fragment)
207
+ underline = fragment.styles.include?(:underline)
208
+ if underline
209
+ @document.stroke_line(fragment.underline_points)
210
+ end
211
+
212
+ strikethrough = fragment.styles.include?(:strikethrough)
213
+ if strikethrough
214
+ @document.stroke_line(fragment.strikethrough_points)
215
+ end
216
+ end
217
+
218
+ end
219
+
220
+ end
221
+ end
222
+ end