piglop-prawn 0.10.2.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (276) hide show
  1. data/COPYING +340 -0
  2. data/HACKING +49 -0
  3. data/LICENSE +56 -0
  4. data/README +140 -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/resources_as_indirect_object.pdf +83 -0
  62. data/data/pdfs/two_hexagons.pdf +90 -0
  63. data/data/pdfs/version_1_6.pdf +61 -0
  64. data/data/shift_jis_text.txt +1 -0
  65. data/examples/bounding_box/bounding_boxes.rb +43 -0
  66. data/examples/bounding_box/indentation.rb +34 -0
  67. data/examples/bounding_box/russian_boxes.rb +36 -0
  68. data/examples/bounding_box/stretched_nesting.rb +67 -0
  69. data/examples/example_helper.rb +4 -0
  70. data/examples/general/background.rb +23 -0
  71. data/examples/general/canvas.rb +15 -0
  72. data/examples/general/context_sensitive_headers.rb +37 -0
  73. data/examples/general/float.rb +11 -0
  74. data/examples/general/margin.rb +36 -0
  75. data/examples/general/measurement_units.rb +51 -0
  76. data/examples/general/metadata-info.rb +16 -0
  77. data/examples/general/multi_page_layout.rb +18 -0
  78. data/examples/general/outlines.rb +50 -0
  79. data/examples/general/page_geometry.rb +31 -0
  80. data/examples/general/page_numbering.rb +15 -0
  81. data/examples/general/repeaters.rb +47 -0
  82. data/examples/general/stamp.rb +41 -0
  83. data/examples/general/templates.rb +13 -0
  84. data/examples/graphics/basic_images.rb +23 -0
  85. data/examples/graphics/cmyk.rb +12 -0
  86. data/examples/graphics/curves.rb +11 -0
  87. data/examples/graphics/hexagon.rb +13 -0
  88. data/examples/graphics/image_fit.rb +15 -0
  89. data/examples/graphics/image_flow.rb +37 -0
  90. data/examples/graphics/image_position.rb +17 -0
  91. data/examples/graphics/line.rb +32 -0
  92. data/examples/graphics/png_types.rb +22 -0
  93. data/examples/graphics/polygons.rb +16 -0
  94. data/examples/graphics/remote_images.rb +12 -0
  95. data/examples/graphics/rounded_polygons.rb +19 -0
  96. data/examples/graphics/rounded_rectangle.rb +20 -0
  97. data/examples/graphics/ruport_style_helpers.rb +19 -0
  98. data/examples/graphics/stroke_bounds.rb +20 -0
  99. data/examples/graphics/stroke_cap_and_join.rb +45 -0
  100. data/examples/graphics/stroke_dash.rb +42 -0
  101. data/examples/graphics/transformations.rb +52 -0
  102. data/examples/graphics/transparency.rb +26 -0
  103. data/examples/m17n/chinese_text_wrapping.rb +17 -0
  104. data/examples/m17n/euro.rb +15 -0
  105. data/examples/m17n/sjis.rb +28 -0
  106. data/examples/m17n/utf8.rb +13 -0
  107. data/examples/m17n/win_ansi_charset.rb +54 -0
  108. data/examples/security/hello_foo.rb +8 -0
  109. data/examples/table/bill.rb +53 -0
  110. data/examples/table/cell.rb +12 -0
  111. data/examples/table/checkerboard.rb +22 -0
  112. data/examples/table/header.rb +14 -0
  113. data/examples/table/inline_format_table.rb +12 -0
  114. data/examples/table/multi_page_table.rb +9 -0
  115. data/examples/table/simple_table.rb +24 -0
  116. data/examples/table/subtable.rb +12 -0
  117. data/examples/table/widths.rb +20 -0
  118. data/examples/text/alignment.rb +18 -0
  119. data/examples/text/dfont.rb +48 -0
  120. data/examples/text/family_based_styling.rb +24 -0
  121. data/examples/text/font_calculations.rb +91 -0
  122. data/examples/text/font_size.rb +33 -0
  123. data/examples/text/hyphenation.rb +45 -0
  124. data/examples/text/indent_paragraphs.rb +18 -0
  125. data/examples/text/inline_format.rb +72 -0
  126. data/examples/text/kerning.rb +30 -0
  127. data/examples/text/rotated.rb +98 -0
  128. data/examples/text/shaped_text_box.rb +31 -0
  129. data/examples/text/simple_text.rb +17 -0
  130. data/examples/text/simple_text_ttf.rb +17 -0
  131. data/examples/text/text_box.rb +88 -0
  132. data/examples/text/text_box_returning_excess.rb +51 -0
  133. data/examples/text/text_flow.rb +67 -0
  134. data/lib/prawn/compatibility.rb +51 -0
  135. data/lib/prawn/core/annotations.rb +61 -0
  136. data/lib/prawn/core/byte_string.rb +9 -0
  137. data/lib/prawn/core/destinations.rb +90 -0
  138. data/lib/prawn/core/document_state.rb +84 -0
  139. data/lib/prawn/core/literal_string.rb +16 -0
  140. data/lib/prawn/core/name_tree.rb +165 -0
  141. data/lib/prawn/core/object_store.rb +219 -0
  142. data/lib/prawn/core/page.rb +179 -0
  143. data/lib/prawn/core/pdf_object.rb +83 -0
  144. data/lib/prawn/core/reference.rb +112 -0
  145. data/lib/prawn/core/text/formatted/arranger.rb +260 -0
  146. data/lib/prawn/core/text/formatted/line_wrap.rb +127 -0
  147. data/lib/prawn/core/text/formatted/wrap.rb +113 -0
  148. data/lib/prawn/core/text/line_wrap.rb +198 -0
  149. data/lib/prawn/core/text/wrap.rb +80 -0
  150. data/lib/prawn/core/text.rb +115 -0
  151. data/lib/prawn/core.rb +89 -0
  152. data/lib/prawn/document/bounding_box.rb +425 -0
  153. data/lib/prawn/document/graphics_state.rb +48 -0
  154. data/lib/prawn/document/internals.rb +176 -0
  155. data/lib/prawn/document/page_geometry.rb +136 -0
  156. data/lib/prawn/document/snapshot.rb +87 -0
  157. data/lib/prawn/document.rb +573 -0
  158. data/lib/prawn/encoding.rb +121 -0
  159. data/lib/prawn/errors.rb +94 -0
  160. data/lib/prawn/font/afm.rb +225 -0
  161. data/lib/prawn/font/dfont.rb +42 -0
  162. data/lib/prawn/font/ttf.rb +350 -0
  163. data/lib/prawn/font.rb +342 -0
  164. data/lib/prawn/graphics/cap_style.rb +38 -0
  165. data/lib/prawn/graphics/color.rb +205 -0
  166. data/lib/prawn/graphics/dash.rb +71 -0
  167. data/lib/prawn/graphics/join_style.rb +38 -0
  168. data/lib/prawn/graphics/transformation.rb +156 -0
  169. data/lib/prawn/graphics/transparency.rb +99 -0
  170. data/lib/prawn/graphics.rb +321 -0
  171. data/lib/prawn/images/jpg.rb +46 -0
  172. data/lib/prawn/images/png.rb +226 -0
  173. data/lib/prawn/images.rb +348 -0
  174. data/lib/prawn/measurement_extensions.rb +46 -0
  175. data/lib/prawn/measurements.rb +71 -0
  176. data/lib/prawn/outline.rb +278 -0
  177. data/lib/prawn/repeater.rb +129 -0
  178. data/lib/prawn/security/arcfour.rb +51 -0
  179. data/lib/prawn/security.rb +262 -0
  180. data/lib/prawn/stamp.rb +126 -0
  181. data/lib/prawn/table/accessors.rb +180 -0
  182. data/lib/prawn/table/cell/in_table.rb +27 -0
  183. data/lib/prawn/table/cell/subtable.rb +65 -0
  184. data/lib/prawn/table/cell/text.rb +128 -0
  185. data/lib/prawn/table/cell.rb +330 -0
  186. data/lib/prawn/table.rb +421 -0
  187. data/lib/prawn/text/box.rb +380 -0
  188. data/lib/prawn/text/formatted/box.rb +215 -0
  189. data/lib/prawn/text/formatted/fragment.rb +127 -0
  190. data/lib/prawn/text/formatted/parser.rb +202 -0
  191. data/lib/prawn/text/formatted.rb +4 -0
  192. data/lib/prawn/text.rb +442 -0
  193. data/lib/prawn.rb +25 -0
  194. data/spec/annotations_spec.rb +90 -0
  195. data/spec/bounding_box_spec.rb +190 -0
  196. data/spec/cell_spec.rb +337 -0
  197. data/spec/destinations_spec.rb +15 -0
  198. data/spec/document_spec.rb +461 -0
  199. data/spec/font_spec.rb +314 -0
  200. data/spec/formatted_text_arranger_spec.rb +400 -0
  201. data/spec/formatted_text_box_spec.rb +659 -0
  202. data/spec/formatted_text_fragment_spec.rb +211 -0
  203. data/spec/graphics_spec.rb +446 -0
  204. data/spec/images_spec.rb +96 -0
  205. data/spec/inline_formatted_text_parser_spec.rb +446 -0
  206. data/spec/jpg_spec.rb +25 -0
  207. data/spec/line_wrap_spec.rb +341 -0
  208. data/spec/measurement_units_spec.rb +23 -0
  209. data/spec/name_tree_spec.rb +112 -0
  210. data/spec/object_store_spec.rb +160 -0
  211. data/spec/outline_spec.rb +229 -0
  212. data/spec/pdf_object_spec.rb +127 -0
  213. data/spec/png_spec.rb +237 -0
  214. data/spec/reference_spec.rb +82 -0
  215. data/spec/repeater_spec.rb +96 -0
  216. data/spec/security_spec.rb +120 -0
  217. data/spec/snapshot_spec.rb +138 -0
  218. data/spec/spec_helper.rb +26 -0
  219. data/spec/stamp_spec.rb +108 -0
  220. data/spec/stroke_styles_spec.rb +163 -0
  221. data/spec/table_spec.rb +583 -0
  222. data/spec/template_spec.rb +158 -0
  223. data/spec/text_at_spec.rb +119 -0
  224. data/spec/text_box_spec.rb +675 -0
  225. data/spec/text_spacing_spec.rb +57 -0
  226. data/spec/text_spec.rb +328 -0
  227. data/spec/text_with_inline_formatting_spec.rb +193 -0
  228. data/spec/transparency_spec.rb +75 -0
  229. data/vendor/pdf-inspector/README +18 -0
  230. data/vendor/pdf-inspector/lib/pdf/inspector/extgstate.rb +18 -0
  231. data/vendor/pdf-inspector/lib/pdf/inspector/graphics.rb +131 -0
  232. data/vendor/pdf-inspector/lib/pdf/inspector/page.rb +25 -0
  233. data/vendor/pdf-inspector/lib/pdf/inspector/text.rb +46 -0
  234. data/vendor/pdf-inspector/lib/pdf/inspector/xobject.rb +19 -0
  235. data/vendor/pdf-inspector/lib/pdf/inspector.rb +26 -0
  236. data/vendor/ttfunk/data/fonts/DejaVuSans.ttf +0 -0
  237. data/vendor/ttfunk/data/fonts/comicsans.ttf +0 -0
  238. data/vendor/ttfunk/example.rb +45 -0
  239. data/vendor/ttfunk/lib/ttfunk/directory.rb +17 -0
  240. data/vendor/ttfunk/lib/ttfunk/encoding/mac_roman.rb +88 -0
  241. data/vendor/ttfunk/lib/ttfunk/encoding/windows_1252.rb +69 -0
  242. data/vendor/ttfunk/lib/ttfunk/reader.rb +44 -0
  243. data/vendor/ttfunk/lib/ttfunk/resource_file.rb +78 -0
  244. data/vendor/ttfunk/lib/ttfunk/subset/base.rb +141 -0
  245. data/vendor/ttfunk/lib/ttfunk/subset/mac_roman.rb +50 -0
  246. data/vendor/ttfunk/lib/ttfunk/subset/unicode.rb +48 -0
  247. data/vendor/ttfunk/lib/ttfunk/subset/unicode_8bit.rb +63 -0
  248. data/vendor/ttfunk/lib/ttfunk/subset/windows_1252.rb +55 -0
  249. data/vendor/ttfunk/lib/ttfunk/subset.rb +18 -0
  250. data/vendor/ttfunk/lib/ttfunk/subset_collection.rb +72 -0
  251. data/vendor/ttfunk/lib/ttfunk/table/cmap/format00.rb +54 -0
  252. data/vendor/ttfunk/lib/ttfunk/table/cmap/format04.rb +126 -0
  253. data/vendor/ttfunk/lib/ttfunk/table/cmap/subtable.rb +79 -0
  254. data/vendor/ttfunk/lib/ttfunk/table/cmap.rb +34 -0
  255. data/vendor/ttfunk/lib/ttfunk/table/glyf/compound.rb +81 -0
  256. data/vendor/ttfunk/lib/ttfunk/table/glyf/simple.rb +37 -0
  257. data/vendor/ttfunk/lib/ttfunk/table/glyf.rb +64 -0
  258. data/vendor/ttfunk/lib/ttfunk/table/head.rb +44 -0
  259. data/vendor/ttfunk/lib/ttfunk/table/hhea.rb +41 -0
  260. data/vendor/ttfunk/lib/ttfunk/table/hmtx.rb +47 -0
  261. data/vendor/ttfunk/lib/ttfunk/table/kern/format0.rb +62 -0
  262. data/vendor/ttfunk/lib/ttfunk/table/kern.rb +79 -0
  263. data/vendor/ttfunk/lib/ttfunk/table/loca.rb +43 -0
  264. data/vendor/ttfunk/lib/ttfunk/table/maxp.rb +40 -0
  265. data/vendor/ttfunk/lib/ttfunk/table/name.rb +125 -0
  266. data/vendor/ttfunk/lib/ttfunk/table/os2.rb +78 -0
  267. data/vendor/ttfunk/lib/ttfunk/table/post/format10.rb +43 -0
  268. data/vendor/ttfunk/lib/ttfunk/table/post/format20.rb +35 -0
  269. data/vendor/ttfunk/lib/ttfunk/table/post/format25.rb +23 -0
  270. data/vendor/ttfunk/lib/ttfunk/table/post/format30.rb +17 -0
  271. data/vendor/ttfunk/lib/ttfunk/table/post/format40.rb +17 -0
  272. data/vendor/ttfunk/lib/ttfunk/table/post.rb +91 -0
  273. data/vendor/ttfunk/lib/ttfunk/table/simple.rb +14 -0
  274. data/vendor/ttfunk/lib/ttfunk/table.rb +46 -0
  275. data/vendor/ttfunk/lib/ttfunk.rb +102 -0
  276. metadata +364 -0
@@ -0,0 +1,136 @@
1
+ # encoding: utf-8
2
+
3
+ # page_geometry.rb : Describes PDF page geometries
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
+ class Document
11
+
12
+ # Dimensions pulled from PDF::Writer, rubyforge.org/projects/ruby-pdf
13
+ #
14
+ # All of these dimensions are in PDF Points, see Prawn::Measurements for
15
+ # conversion utilities.
16
+ #
17
+ # Additionally, if the size you are after is not listed below, you can always
18
+ # specify your size by passing an array of width and height to Prawn::Document.new
19
+ # like:
20
+ #
21
+ # Prawn::Document.new(:page_size => [1000, 20000])
22
+ #
23
+ # The sizes below can be used by passing the appropriate string to :size:
24
+ #
25
+ # Prawn::Document.new(:page_size => '2A0')
26
+ #
27
+ # ===Inbuilt Sizes:
28
+ #
29
+ #
30
+ # 4A0:: => 4767.87 x 6740.79
31
+ # 2A0:: => 3370.39 x 4767.87
32
+ # A0:: => 2383.94 x 3370.39
33
+ # A1:: => 1683.78 x 2383.94
34
+ # A2:: => 1190.55 x 1683.78
35
+ # A3:: => 841.89 x 1190.55
36
+ # A4:: => 595.28 x 841.89
37
+ # A5:: => 419.53 x 595.28
38
+ # A6:: => 297.64 x 419.53
39
+ # A7:: => 209.76 x 297.64
40
+ # A8:: => 147.40 x 209.76
41
+ # A9:: => 104.88 x 147.40
42
+ # A10:: => 73.70 x 104.88
43
+ # B0:: => 2834.65 x 4008.19
44
+ # B1:: => 2004.09 x 2834.65
45
+ # B2:: => 1417.32 x 2004.09
46
+ # B3:: => 1000.63 x 1417.32
47
+ # B4:: => 708.66 x 1000.63
48
+ # B5:: => 498.90 x 708.66
49
+ # B6:: => 354.33 x 498.90
50
+ # B7:: => 249.45 x 354.33
51
+ # B8:: => 175.75 x 249.45
52
+ # B9:: => 124.72 x 175.75
53
+ # B10:: => 87.87 x 124.72
54
+ # C0:: => 2599.37 x 3676.54
55
+ # C1:: => 1836.85 x 2599.37
56
+ # C2:: => 1298.27 x 1836.85
57
+ # C3:: => 918.43 x 1298.27
58
+ # C4:: => 649.13 x 918.43
59
+ # C5:: => 459.21 x 649.13
60
+ # C6:: => 323.15 x 459.21
61
+ # C7:: => 229.61 x 323.15
62
+ # C8:: => 161.57 x 229.61
63
+ # C9:: => 113.39 x 161.57
64
+ # C10:: => 79.37 x 113.39
65
+ # RA0:: => 2437.80 x 3458.27
66
+ # RA1:: => 1729.13 x 2437.80
67
+ # RA2:: => 1218.90 x 1729.13
68
+ # RA3:: => 864.57 x 1218.90
69
+ # RA4:: => 609.45 x 864.57
70
+ # SRA0:: => 2551.18 x 3628.35
71
+ # SRA1:: => 1814.17 x 2551.18
72
+ # SRA2:: => 1275.59 x 1814.17
73
+ # SRA3:: => 907.09 x 1275.59
74
+ # SRA4:: => 637.80 x 907.09
75
+ # EXECUTIVE:: => 521.86 x 756.00
76
+ # FOLIO:: => 612.00 x 936.00
77
+ # LEGAL:: => 612.00 x 1008.00
78
+ # LETTER:: => 612.00 x 792.00
79
+ # TABLOID:: => 792.00 x 1224.00
80
+ #
81
+ module PageGeometry
82
+
83
+ SIZES = { "4A0" => [4767.87, 6740.79],
84
+ "2A0" => [3370.39, 4767.87],
85
+ "A0" => [2383.94, 3370.39],
86
+ "A1" => [1683.78, 2383.94],
87
+ "A2" => [1190.55, 1683.78],
88
+ "A3" => [841.89, 1190.55],
89
+ "A4" => [595.28, 841.89],
90
+ "A5" => [419.53, 595.28],
91
+ "A6" => [297.64, 419.53],
92
+ "A7" => [209.76, 297.64],
93
+ "A8" => [147.40, 209.76],
94
+ "A9" => [104.88, 147.40],
95
+ "A10" => [73.70, 104.88],
96
+ "B0" => [2834.65, 4008.19],
97
+ "B1" => [2004.09, 2834.65],
98
+ "B2" => [1417.32, 2004.09],
99
+ "B3" => [1000.63, 1417.32],
100
+ "B4" => [708.66, 1000.63],
101
+ "B5" => [498.90, 708.66],
102
+ "B6" => [354.33, 498.90],
103
+ "B7" => [249.45, 354.33],
104
+ "B8" => [175.75, 249.45],
105
+ "B9" => [124.72, 175.75],
106
+ "B10" => [87.87, 124.72],
107
+ "C0" => [2599.37, 3676.54],
108
+ "C1" => [1836.85, 2599.37],
109
+ "C2" => [1298.27, 1836.85],
110
+ "C3" => [918.43, 1298.27],
111
+ "C4" => [649.13, 918.43],
112
+ "C5" => [459.21, 649.13],
113
+ "C6" => [323.15, 459.21],
114
+ "C7" => [229.61, 323.15],
115
+ "C8" => [161.57, 229.61],
116
+ "C9" => [113.39, 161.57],
117
+ "C10" => [79.37, 113.39],
118
+ "RA0" => [2437.80, 3458.27],
119
+ "RA1" => [1729.13, 2437.80],
120
+ "RA2" => [1218.90, 1729.13],
121
+ "RA3" => [864.57, 1218.90],
122
+ "RA4" => [609.45, 864.57],
123
+ "SRA0" => [2551.18, 3628.35],
124
+ "SRA1" => [1814.17, 2551.18],
125
+ "SRA2" => [1275.59, 1814.17],
126
+ "SRA3" => [907.09, 1275.59],
127
+ "SRA4" => [637.80, 907.09],
128
+ "EXECUTIVE" => [521.86, 756.00],
129
+ "FOLIO" => [612.00, 936.00],
130
+ "LEGAL" => [612.00, 1008.00],
131
+ "LETTER" => [612.00, 792.00],
132
+ "TABLOID" => [792.00, 1224.00] }
133
+
134
+ end
135
+ end
136
+ end
@@ -0,0 +1,87 @@
1
+ # encoding: utf-8
2
+
3
+ # snapshot.rb : Implements transactional rendering for Prawn
4
+ #
5
+ # Copyright August 2009, Brad Ediger. All Rights Reserved.
6
+ #
7
+ # This is free software. Please see the LICENSE and COPYING files for details.
8
+
9
+ require 'delegate'
10
+
11
+ module Prawn
12
+ class Document
13
+ module Snapshot
14
+
15
+ RollbackTransaction = Class.new(StandardError)
16
+
17
+ # Call this within a +transaction+ block to roll back the transaction and
18
+ # prevent any of its data from being rendered. You must reset the
19
+ # y-position yourself if you have performed any drawing operations that
20
+ # modify it.
21
+ #
22
+ def rollback
23
+ raise RollbackTransaction
24
+ end
25
+
26
+ # Run a block of drawing operations, to be completed atomically. If
27
+ # +rollback+ is called or a RollbackTransaction exception is raised
28
+ # inside the block, all actions taken inside the block will be rolled
29
+ # back (with the exception of y-position, which you must restore
30
+ # yourself).
31
+ #
32
+ # Returns true on success, or false if the transaction was rolled back.
33
+ #
34
+ def transaction
35
+ snap = take_snapshot
36
+ yield
37
+ true
38
+ rescue RollbackTransaction
39
+ restore_snapshot(snap)
40
+ false
41
+ end
42
+
43
+ private
44
+
45
+ # Takes a current snapshot of the document's state, sufficient to
46
+ # reconstruct it after it was amended.
47
+ #
48
+ def take_snapshot
49
+ # current_page holds a ref to the Pages dictionary which grows
50
+ # monotonically as data is added to the document, so we share that
51
+ # between the old and new copies.
52
+ {:page_content => state.page.content.deep_copy,
53
+ :current_page => state.page.dictionary.deep_copy(share=[:Parent]),
54
+ :page_number => page_number,
55
+ :page_kids => state.store.pages.data[:Kids].map{|kid| kid.identifier},
56
+ :dests => names? &&
57
+ Marshal.load(Marshal.dump(names.data[:Dests]))}
58
+ end
59
+
60
+ # Rolls the page state back to the state of the given snapshot.
61
+ #
62
+ def restore_snapshot(shot)
63
+ page = state.page
64
+ # Because these objects are referenced by identifier from the Pages
65
+ # dictionary, we can't just restore them over the current refs in
66
+ # page_content and current_page. We have to restore them over the old
67
+ # ones.
68
+ page.content = shot[:page_content].identifier
69
+ page.content.replace shot[:page_content]
70
+
71
+ page.dictionary = shot[:current_page].identifier
72
+ page.dictionary.replace shot[:current_page]
73
+ page.dictionary.data[:Contents] = page.content
74
+
75
+ self.page_number = shot[:page_number]
76
+
77
+ state.store.pages.data[:Kids] = shot[:page_kids].map{|id| state.store[id]}
78
+ state.store.pages.data[:Count] = shot[:page_kids].size
79
+
80
+ if shot[:dests]
81
+ names.data[:Dests] = shot[:dests]
82
+ end
83
+ end
84
+
85
+ end
86
+ end
87
+ end