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,121 @@
1
+ # encoding: utf-8
2
+ #
3
+ # Copyright September 2008, Gregory Brown, James Healy All Rights Reserved.
4
+ #
5
+ # This is free software. Please see the LICENSE and COPYING files for details.
6
+ #
7
+ module Prawn
8
+ module Encoding
9
+ # Map between unicode and WinAnsiEnoding
10
+ #
11
+ class WinAnsi #:nodoc:
12
+ CHARACTERS = %w[
13
+ .notdef .notdef .notdef .notdef
14
+ .notdef .notdef .notdef .notdef
15
+ .notdef .notdef .notdef .notdef
16
+ .notdef .notdef .notdef .notdef
17
+ .notdef .notdef .notdef .notdef
18
+ .notdef .notdef .notdef .notdef
19
+ .notdef .notdef .notdef .notdef
20
+ .notdef .notdef .notdef .notdef
21
+
22
+ space exclam quotedbl numbersign
23
+ dollar percent ampersand quotesingle
24
+ parenleft parenright asterisk plus
25
+ comma hyphen period slash
26
+ zero one two three
27
+ four five six seven
28
+ eight nine colon semicolon
29
+ less equal greater question
30
+
31
+ at A B C
32
+ D E F G
33
+ H I J K
34
+ L M N O
35
+ P Q R S
36
+ T U V W
37
+ X Y Z bracketleft
38
+ backslash bracketright asciicircum underscore
39
+
40
+ grave a b c
41
+ d e f g
42
+ h i j k
43
+ l m n o
44
+ p q r s
45
+ t u v w
46
+ x y z braceleft
47
+ bar braceright asciitilde .notdef
48
+
49
+ Euro .notdef quotesinglbase florin
50
+ quotedblbase ellipsis dagger daggerdbl
51
+ circumflex perthousand Scaron guilsinglleft
52
+ OE .notdef Zcaron .notdef
53
+ .notdef quoteleft quoteright quotedblleft
54
+ quotedblright bullet endash emdash
55
+ tilde trademark scaron guilsinglright
56
+ oe .notdef zcaron ydieresis
57
+
58
+ space exclamdown cent sterling
59
+ currency yen brokenbar section
60
+ dieresis copyright ordfeminine guillemotleft
61
+ logicalnot hyphen registered macron
62
+ degree plusminus twosuperior threesuperior
63
+ acute mu paragraph periodcentered
64
+ cedilla onesuperior ordmasculine guillemotright
65
+ onequarter onehalf threequarters questiondown
66
+
67
+ Agrave Aacute Acircumflex Atilde
68
+ Adieresis Aring AE Ccedilla
69
+ Egrave Eacute Ecircumflex Edieresis
70
+ Igrave Iacute Icircumflex Idieresis
71
+ Eth Ntilde Ograve Oacute
72
+ Ocircumflex Otilde Odieresis multiply
73
+ Oslash Ugrave Uacute Ucircumflex
74
+ Udieresis Yacute Thorn germandbls
75
+
76
+ agrave aacute acircumflex atilde
77
+ adieresis aring ae ccedilla
78
+ egrave eacute ecircumflex edieresis
79
+ igrave iacute icircumflex idieresis
80
+ eth ntilde ograve oacute
81
+ ocircumflex otilde odieresis divide
82
+ oslash ugrave uacute ucircumflex
83
+ udieresis yacute thorn ydieresis
84
+ ]
85
+
86
+ def initialize
87
+ @mapping_file = "#{Prawn::BASEDIR}/data/encodings/win_ansi.txt"
88
+ load_mapping if self.class.mapping.empty?
89
+ end
90
+
91
+ # Converts a Unicode codepoint into a valid WinAnsi single byte character.
92
+ #
93
+ # If there is no WinAnsi equivlant for a character, a _ will be substituted.
94
+ #
95
+ def [](codepoint)
96
+ # unicode codepoints < 255 map directly to the single byte value in WinAnsi
97
+ return codepoint if codepoint <= 255
98
+
99
+ # There are a handful of codepoints > 255 that have equivilants in WinAnsi.
100
+ # Replace anything else with an underscore
101
+ self.class.mapping[codepoint] || 95
102
+ end
103
+
104
+ def self.mapping
105
+ @mapping ||= {}
106
+ end
107
+
108
+ private
109
+
110
+ def load_mapping
111
+ RUBY_VERSION >= "1.9" ? mode = "r:BINARY" : mode = "r"
112
+ File.open(@mapping_file, mode) do |f|
113
+ f.each do |l|
114
+ m, single_byte, unicode = *l.match(/([0-9A-Za-z]+);([0-9A-F]{4})/)
115
+ self.class.mapping["0x#{unicode}".hex] = "0x#{single_byte}".hex if single_byte
116
+ end
117
+ end
118
+ end
119
+ end
120
+ end
121
+ end
@@ -0,0 +1,86 @@
1
+ # encoding: utf-8
2
+ #
3
+ # errors.rb : Implements custom error classes for Prawn
4
+ #
5
+ # Copyright April 2008, Gregory Brown. All Rights Reserved.
6
+ #
7
+ # This is free software. Please see the LICENSE and COPYING files for details.
8
+ #
9
+ module Prawn
10
+ module Errors
11
+
12
+ # This error is raised when Prawn::PdfObject() encounters a Ruby object it
13
+ # cannot convert to PDF
14
+ #
15
+ FailedObjectConversion = Class.new(StandardError)
16
+
17
+ # This error is raised when Document#page_layout is set to anything
18
+ # other than :portrait or :landscape
19
+ #
20
+ InvalidPageLayout = Class.new(StandardError)
21
+
22
+ # This error is raised when a method requiring a current page is called
23
+ # without being on a page.
24
+ #
25
+ NotOnPage = Class.new(StandardError)
26
+
27
+ # This error is raised when Prawn cannot find a specified font
28
+ #
29
+ UnknownFont = Class.new(StandardError)
30
+
31
+ # Raised when Prawn is asked to draw something into a too-small box
32
+ #
33
+ CannotFit = Class.new(StandardError)
34
+
35
+ # Raised if group() is called with a block that is too big to be
36
+ # rendered in the current context.
37
+ #
38
+ CannotGroup = Class.new(StandardError)
39
+
40
+ # This error is raised when Prawn is being used on a M17N aware VM,
41
+ # and the user attempts to add text that isn't compatible with UTF-8
42
+ # to their document
43
+ #
44
+ IncompatibleStringEncoding = Class.new(StandardError)
45
+
46
+ # This error is raised when Prawn encounters an unknown key in functions
47
+ # that accept an options hash. This usually means there is a typo in your
48
+ # code or that the option you are trying to use has a different name than
49
+ # what you have specified.
50
+ #
51
+ UnknownOption = Class.new(StandardError)
52
+
53
+ # this error is raised when a user attempts to embed an image of an unsupported
54
+ # type. This can either a completely unsupported format, or a dialect of a
55
+ # supported format (ie. some types of PNG)
56
+ UnsupportedImageType = Class.new(StandardError)
57
+
58
+ # This error is raised when a named element has alredy been
59
+ # created. For example, in the stamp module, stamps must have
60
+ # unique names within a document
61
+ NameTaken = Class.new(StandardError)
62
+
63
+ # This error is raised when a name is not a valid format
64
+ InvalidName = Class.new(StandardError)
65
+
66
+ # This error is raised when an object is attempted to be
67
+ # referenced by name, but no such name is associated with an object
68
+ UndefinedObjectName = Class.new(StandardError)
69
+
70
+ # This error is raised when a required option has not been set
71
+ RequiredOption = Class.new(StandardError)
72
+
73
+ # This error is raised when a requested outline item with a given title does not exist
74
+ UnknownOutlineTitle = Class.new(StandardError)
75
+
76
+ # This error is raised when a block is required, but not provided
77
+ BlockRequired = Class.new(StandardError)
78
+
79
+ # This error is rased when a graphics method is called with improper arguments
80
+ InvalidGraphicsPath = Class.new(StandardError)
81
+
82
+ # This error is raised when Prawn fails to load a template file
83
+ #
84
+ TemplateError = Class.new(StandardError)
85
+ end
86
+ end
@@ -0,0 +1,368 @@
1
+ # encoding: utf-8
2
+ #
3
+ # font.rb : The Prawn font class
4
+ #
5
+ # Copyright May 2008, Gregory Brown / James Healy. All Rights Reserved.
6
+ #
7
+ # This is free software. Please see the LICENSE and COPYING files for details.
8
+ #
9
+ require "prawn/font/afm"
10
+ require "prawn/font/ttf"
11
+ require "prawn/font/dfont"
12
+
13
+ module Prawn
14
+
15
+ class Document
16
+ # Without arguments, this returns the currently selected font. Otherwise,
17
+ # it sets the current font. When a block is used, the font is applied
18
+ # transactionally and is rolled back when the block exits.
19
+ #
20
+ # Prawn::Document.generate("font.pdf") do
21
+ # text "Default font is Helvetica"
22
+ #
23
+ # font "Times-Roman"
24
+ # text "Now using Times-Roman"
25
+ #
26
+ # font("Chalkboard.ttf") do
27
+ # text "Using TTF font from file Chalkboard.ttf"
28
+ # font "Courier", :style => :bold
29
+ # text "You see this in bold Courier"
30
+ # end
31
+ #
32
+ # text "Times-Roman, again"
33
+ # end
34
+ #
35
+ # The :name parameter must be a string. It can be one of the 14 built-in
36
+ # fonts supported by PDF, or the location of a TTF file. The Font::AFM::BUILT_INS
37
+ # array specifies the valid built in font values.
38
+ #
39
+ # If a ttf font is specified, the glyphs necessary to render your document
40
+ # will be embedded in the rendered PDF. This should be your preferred option
41
+ # in most cases. It will increase the size of the resulting file, but also
42
+ # make it more portable.
43
+ #
44
+ # The options parameter is an optional hash providing size and style. To use
45
+ # the :style option you need to map those font styles to their respective font files.
46
+ # See font_families for more information.
47
+ #
48
+ def font(name=nil, options={})
49
+ return((defined?(@font) && @font) || font("Helvetica")) if name.nil?
50
+
51
+ if state.pages.empty? && !state.page.in_stamp_stream?
52
+ raise Prawn::Errors::NotOnPage
53
+ end
54
+
55
+ new_font = find_font(name, options)
56
+
57
+ if block_given?
58
+ save_font do
59
+ set_font(new_font, options[:size])
60
+ yield
61
+ end
62
+ else
63
+ set_font(new_font, options[:size])
64
+ end
65
+
66
+ @font
67
+ end
68
+
69
+ # When called with no argument, returns the current font size.
70
+ # When called with a single argument but no block, sets the current font
71
+ # size. When a block is used, the font size is applied transactionally and
72
+ # is rolled back when the block exits. You may still change the font size
73
+ # within a transactional block for individual text segments, or nested calls
74
+ # to font_size.
75
+ #
76
+ # Prawn::Document.generate("font_size.pdf") do
77
+ # font_size 16
78
+ # text "At size 16"
79
+ #
80
+ # font_size(10) do
81
+ # text "At size 10"
82
+ # text "At size 6", :size => 6
83
+ # text "At size 10"
84
+ # end
85
+ #
86
+ # text "At size 16"
87
+ # end
88
+ #
89
+ # When called without an argument, this method returns the current font
90
+ # size.
91
+ #
92
+ def font_size(points=nil)
93
+ return @font_size unless points
94
+ size_before_yield = @font_size
95
+ @font_size = points
96
+ block_given? ? yield : return
97
+ @font_size = size_before_yield
98
+ end
99
+
100
+ # Sets the font directly, given an actual Font object
101
+ # and size.
102
+ #
103
+ def set_font(font, size=nil) # :nodoc:
104
+ @font = font
105
+ @font_size = size if size
106
+ end
107
+
108
+ # Saves the current font, and then yields. When the block
109
+ # finishes, the original font is restored.
110
+ #
111
+ def save_font
112
+ @font ||= find_font("Helvetica")
113
+ original_font = @font
114
+ original_size = @font_size
115
+
116
+ yield
117
+ ensure
118
+ set_font(original_font, original_size) if original_font
119
+ end
120
+
121
+ # Looks up the given font using the given criteria. Once a font has been
122
+ # found by that matches the criteria, it will be cached to subsequent lookups
123
+ # for that font will return the same object.
124
+ #--
125
+ # Challenges involved: the name alone is not sufficient to uniquely identify
126
+ # a font (think dfont suitcases that can hold multiple different fonts in a
127
+ # single file). Thus, the :name key is included in the cache key.
128
+ #
129
+ # It is further complicated, however, since fonts in some formats (like the
130
+ # dfont suitcases) can be identified either by numeric index, OR by their
131
+ # name within the suitcase, and both should hash to the same font object
132
+ # (to avoid the font being embedded multiple times). This is not yet implemented,
133
+ # which means if someone selects a font both by name, and by index, the
134
+ # font will be embedded twice. Since we do font subsetting, this double
135
+ # embedding won't be catastrophic, just annoying.
136
+ # ++
137
+ def find_font(name, options={}) #:nodoc:
138
+ if font_families.key?(name)
139
+ family, name = name, font_families[name][options[:style] || :normal]
140
+ if name.is_a?(Hash)
141
+ options = options.merge(name)
142
+ name = options[:file]
143
+ end
144
+ end
145
+ key = "#{name}:#{options[:font] || 0}"
146
+ font_registry[key] ||= Font.load(self, name, options.merge(:family => family))
147
+ end
148
+
149
+ # Hash of Font objects keyed by names
150
+ #
151
+ def font_registry #:nodoc:
152
+ @font_registry ||= {}
153
+ end
154
+
155
+ # Hash that maps font family names to their styled individual font names.
156
+ #
157
+ # To add support for another font family, append to this hash, e.g:
158
+ #
159
+ # pdf.font_families.update(
160
+ # "MyTrueTypeFamily" => { :bold => "foo-bold.ttf",
161
+ # :italic => "foo-italic.ttf",
162
+ # :bold_italic => "foo-bold-italic.ttf",
163
+ # :normal => "foo.ttf" })
164
+ #
165
+ # This will then allow you to use the fonts like so:
166
+ #
167
+ # pdf.font("MyTrueTypeFamily", :style => :bold)
168
+ # pdf.text "Some bold text"
169
+ # pdf.font("MyTrueTypeFamily")
170
+ # pdf.text "Some normal text"
171
+ #
172
+ # This assumes that you have appropriate TTF fonts for each style you
173
+ # wish to support.
174
+ #
175
+ # By default the styles :bold, :italic, :bold_italic, and :normal are
176
+ # defined for fonts "Courier", "Times-Roman" and "Helvetica".
177
+ #
178
+ # You probably want to provide those four styles, but are free to define
179
+ # custom ones, like :thin, and use them in font calls.
180
+ #
181
+ def font_families
182
+ @font_families ||= Hash.new { |h,k| h[k] = {} }.merge!(
183
+ { "Courier" => { :bold => "Courier-Bold",
184
+ :italic => "Courier-Oblique",
185
+ :bold_italic => "Courier-BoldOblique",
186
+ :normal => "Courier" },
187
+
188
+ "Times-Roman" => { :bold => "Times-Bold",
189
+ :italic => "Times-Italic",
190
+ :bold_italic => "Times-BoldItalic",
191
+ :normal => "Times-Roman" },
192
+
193
+ "Helvetica" => { :bold => "Helvetica-Bold",
194
+ :italic => "Helvetica-Oblique",
195
+ :bold_italic => "Helvetica-BoldOblique",
196
+ :normal => "Helvetica" }
197
+ })
198
+ end
199
+
200
+ # Returns the width of the given string using the given font. If :size is not
201
+ # specified as one of the options, the string is measured using the current
202
+ # font size. You can also pass :kerning as an option to indicate whether
203
+ # kerning should be used when measuring the width (defaults to +false+).
204
+ #
205
+ # Note that the string _must_ be encoded properly for the font being used.
206
+ # For AFM fonts, this is WinAnsi. For TTF, make sure the font is encoded as
207
+ # UTF-8. You can use the Font#normalize_encoding method to make sure strings
208
+ # are in an encoding appropriate for the current font.
209
+ #--
210
+ # For the record, this method used to be a method of Font (and still delegates
211
+ # to width computations on Font). However, having the primary interface for
212
+ # calculating string widths exist on Font made it tricky to write extensions
213
+ # for Prawn in which widths are computed differently (e.g., taking formatting
214
+ # tags into account, or the like).
215
+ #
216
+ # By putting width_of here, on Document itself, extensions may easily override
217
+ # it and redefine the width calculation behavior.
218
+ #++
219
+ def width_of(string, options={})
220
+ font.compute_width_of(string, options) + character_spacing * string.length
221
+ end
222
+ end
223
+
224
+ # Provides font information and helper functions.
225
+ #
226
+ class Font
227
+
228
+ # The current font name
229
+ attr_reader :name
230
+
231
+ # The current font family
232
+ attr_reader :family
233
+
234
+ # The options hash used to initialize the font
235
+ attr_reader :options
236
+
237
+ # Shortcut interface for constructing a font object. Filenames of the form
238
+ # *.ttf will call Font::TTF.new, *.dfont Font::DFont.new, and anything else
239
+ # will be passed through to Font::AFM.new()
240
+ #
241
+ def self.load(document,name,options={})
242
+ case name
243
+ when /\.ttf$/ then TTF.new(document, name, options)
244
+ when /\.dfont$/ then DFont.new(document, name, options)
245
+ when /\.afm$/ then AFM.new(document, name, options)
246
+ else AFM.new(document, name, options)
247
+ end
248
+ end
249
+
250
+ def initialize(document,name,options={}) #:nodoc:
251
+ @document = document
252
+ @name = name
253
+ @options = options
254
+
255
+ @family = options[:family]
256
+
257
+ @identifier = generate_unique_id
258
+
259
+ @references = {}
260
+ end
261
+
262
+ # The size of the font ascender in PDF points
263
+ #
264
+ def ascender
265
+ @ascender / 1000.0 * size
266
+ end
267
+
268
+ # The size of the font descender in PDF points
269
+ #
270
+ def descender
271
+ -@descender / 1000.0 * size
272
+ end
273
+
274
+ # The size of the recommended gap between lines of text in PDF points
275
+ #
276
+ def line_gap
277
+ @line_gap / 1000.0 * size
278
+ end
279
+
280
+ def identifier_for(subset)
281
+ "#{@identifier}.#{subset}".to_sym
282
+ end
283
+
284
+ def inspect
285
+ "#{self.class.name}< #{name}: #{size} >"
286
+ end
287
+
288
+ # Normalizes the encoding of the string to an encoding supported by the
289
+ # font. The string is expected to be UTF-8 going in. It will be re-encoded
290
+ # and the new string will be returned. For an in-place (destructive)
291
+ # version, see normalize_encoding!.
292
+ def normalize_encoding(string)
293
+ raise NotImplementedError, "subclasses of Prawn::Font must implement #normalize_encoding"
294
+ end
295
+
296
+ # Destructive version of normalize_encoding; normalizes the encoding of a
297
+ # string in place.
298
+ #
299
+ def normalize_encoding!(str)
300
+ str.replace(normalize_encoding(str))
301
+ end
302
+
303
+ # Gets height of current font in PDF points at the given font size
304
+ #
305
+ def height_at(size)
306
+ @normalized_height ||= (@ascender - @descender + @line_gap) / 1000.0
307
+ @normalized_height * size
308
+ end
309
+
310
+ # Gets height of current font in PDF points at current font size
311
+ #
312
+ def height
313
+ height_at(size)
314
+ end
315
+
316
+ # Registers the given subset of the current font with the current PDF
317
+ # page. This is safe to call multiple times for a given font and subset,
318
+ # as it will only add the font the first time it is called.
319
+ #
320
+ def add_to_current_page(subset)
321
+ @references[subset] ||= register(subset)
322
+ @document.state.page.fonts.merge!(identifier_for(subset) => @references[subset])
323
+ end
324
+
325
+ def identifier_for(subset) #:nodoc:
326
+ "#{@identifier}.#{subset}"
327
+ end
328
+
329
+ def inspect #:nodoc:
330
+ "#{self.class.name}< #{name}: #{size} >"
331
+ end
332
+
333
+ private
334
+
335
+ # generate a font identifier that hasn't been used on the curretn page yet
336
+ #
337
+ def generate_unique_id
338
+ offset, id = 0, nil
339
+
340
+ while id.nil? || page_contains_font_id?(id)
341
+ offset += 1
342
+ id = :"F#{@document.font_registry.size + offset}"
343
+ end
344
+
345
+ id
346
+ end
347
+
348
+ # Returns true if the provided font identifier already exists in the document.
349
+ # This is used when adding new fonts to a document to ensure we don't step
350
+ # on fonts imported from a template.
351
+ #
352
+ # page_contains_font_id?("F1")
353
+ # => true
354
+ #
355
+ def page_contains_font_id?(id)
356
+ id = id.to_s
357
+ @document.state.page.fonts.keys.any? { |exist_id|
358
+ exist_id.to_s[0,id.size] == id
359
+ }
360
+ end
361
+
362
+ def size
363
+ @document.font_size
364
+ end
365
+
366
+ end
367
+
368
+ end