davebenvenuti-prawn 0.11.1.pre

data/lib/prawn/document/internals.rb

@@ -0,0 +1,170 @@
+# encoding: utf-8
+#
+# internals.rb : Implements document internals for Prawn
+#
+# Copyright August 2008, Gregory Brown. All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
+module Prawn
+  class Document     
+    
+    # This module exposes a few low-level PDF features for those who want
+    # to extend Prawn's core functionality.  If you are not comfortable with
+    # low level PDF functionality as defined by Adobe's specification, chances
+    # are you won't need anything you find here.  
+    #
+    module Internals    
+      
+      # Creates a new Prawn::Reference and adds it to the Document's object
+      # list.  The +data+ argument is anything that Prawn::PdfObject() can convert. 
+      #
+      # Returns the identifier which points to the reference in the ObjectStore   
+      # 
+      def ref(data)
+        ref!(data).identifier
+      end                                               
+
+      # Like ref, but returns the actual reference instead of its identifier.
+      # 
+      # While you can use this to build up nested references within the object
+      # tree, it is recommended to persist only identifiers, and them provide
+      # helper methods to look up the actual references in the ObjectStore
+      # if needed.  If you take this approach, Prawn::Document::Snapshot
+      # will probably work with your extension
+      #
+      def ref!(data)
+        state.store.ref(data)
+      end
+
+      # At any stage in the object tree an object can be replaced with an
+      # indirect reference. To get access to the object safely, regardless
+      # of if it's hidden behind a Prawn::Reference, wrap it in deref().
+      #
+      def deref(obj)
+        obj.is_a?(Prawn::Core::Reference) ? obj.data : obj
+      end
+
+      # Appends a raw string to the current page content.
+      #                               
+      #  # Raw line drawing example:           
+      #  x1,y1,x2,y2 = 100,500,300,550
+      #  pdf.add_content("%.3f %.3f m" % [ x1, y1 ])  # move 
+      #  pdf.add_content("%.3f %.3f l" % [ x2, y2 ])  # draw path
+      #  pdf.add_content("S") # stroke                    
+      #
+      def add_content(str)
+        state.page.content << str << "\n"
+      end  
+
+      # The Name dictionary (PDF spec 3.6.3) for this document. It is
+      # lazily initialized, so that documents that do not need a name
+      # dictionary do not incur the additional overhead.
+      #
+      def names
+        state.store.root.data[:Names] ||= ref!(:Type => :Names)
+      end
+
+      # Returns true if the Names dictionary is in use for this document.
+      # 
+      def names?
+        state.store.root.data[:Names]
+      end
+
+      # Defines a block to be called just before the document is rendered.
+      #
+      def before_render(&block)
+        state.before_render_callbacks << block
+      end
+
+      # Defines a block to be called just before a new page is started.
+      #
+      def on_page_create(&block)
+         if block_given?
+            state.on_page_create_callback = block
+         else
+            state.on_page_create_callback = nil
+         end
+      end
+      
+      private      
+
+      # adds a new, empty content stream to each page. Used in templating so
+      # that imported content streams can be left pristine
+      #
+      def fresh_content_streams(options={})
+        (1..page_count).each do |i|
+          go_to_page i
+          state.page.new_content_stream
+          apply_margin_options(options)
+          use_graphic_settings
+          save_graphics_state
+        end
+      end
+
+      def finalize_all_page_contents
+        (1..page_count).each do |i|
+          go_to_page i
+          repeaters.each { |r| r.run(i) }
+          restore_graphics_state
+          state.page.finalize
+        end
+      end
+
+      # raise the PDF version of the file we're going to generate.
+      # A private method, designed for internal use when the user adds a feature
+      # to their document that requires a particular version.
+      #
+      def min_version(min)
+        state.version = min if min > state.version
+      end
+
+      # Write out the PDF Header, as per spec 3.4.1
+      #
+      def render_header(output)
+        state.before_render_actions(self)
+
+        # pdf version
+        output << "%PDF-#{state.version}\n"
+
+        # 4 binary chars, as recommended by the spec
+        output << "%\xFF\xFF\xFF\xFF\n"
+      end
+
+      # Write out the PDF Body, as per spec 3.4.2
+      #
+      def render_body(output)
+        state.render_body(output)
+      end
+
+      # Write out the PDF Cross Reference Table, as per spec 3.4.3
+      #
+      def render_xref(output)
+        @xref_offset = output.size
+        output << "xref\n"
+        output << "0 #{state.store.size + 1}\n"
+        output << "0000000000 65535 f \n"
+        state.store.each do |ref|
+          output.printf("%010d", ref.offset)
+          output << " 00000 n \n"
+        end
+      end
+
+      # Write out the PDF Trailer, as per spec 3.4.4
+      #
+      def render_trailer(output)
+        trailer_hash = {:Size => state.store.size + 1, 
+                        :Root => state.store.root,
+                        :Info => state.store.info}
+        trailer_hash.merge!(state.trailer) if state.trailer
+
+        output << "trailer\n"
+        output << Prawn::Core::PdfObject(trailer_hash) << "\n"
+        output << "startxref\n" 
+        output << @xref_offset << "\n"
+        output << "%%EOF" << "\n"
+      end
+                 
+    end
+  end
+end

data/lib/prawn/document/page_geometry.rb

@@ -0,0 +1,136 @@
+# encoding: utf-8
+
+# page_geometry.rb : Describes PDF page geometries
+#
+# Copyright April 2008, Gregory Brown.  All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
+module Prawn
+  class Document
+    
+    # Dimensions pulled from PDF::Writer, rubyforge.org/projects/ruby-pdf
+    # 
+    # All of these dimensions are in PDF Points, see Prawn::Measurements for
+    # conversion utilities.
+    # 
+    # Additionally, if the size you are after is not listed below, you can always
+    # specify your size by passing an array of width and height to Prawn::Document.new
+    # like:
+    # 
+    #  Prawn::Document.new(:page_size => [1000, 20000])
+    #
+    # The sizes below can be used by passing the appropriate string to :size:
+    # 
+    #  Prawn::Document.new(:page_size => '2A0')
+    # 
+    # ===Inbuilt Sizes:
+    # 
+    # 
+    # 4A0:: => 4767.87 x 6740.79
+    # 2A0:: => 3370.39 x 4767.87
+    # A0:: => 2383.94 x 3370.39
+    # A1:: => 1683.78 x 2383.94
+    # A2:: => 1190.55 x 1683.78
+    # A3:: => 841.89 x 1190.55
+    # A4:: => 595.28 x 841.89
+    # A5:: => 419.53 x 595.28
+    # A6:: => 297.64 x 419.53
+    # A7:: => 209.76 x 297.64
+    # A8:: => 147.40 x 209.76
+    # A9:: => 104.88 x 147.40
+    # A10:: => 73.70 x 104.88
+    # B0:: => 2834.65 x 4008.19
+    # B1:: => 2004.09 x 2834.65
+    # B2:: => 1417.32 x 2004.09
+    # B3:: => 1000.63 x 1417.32
+    # B4:: => 708.66 x 1000.63
+    # B5:: => 498.90 x 708.66
+    # B6:: => 354.33 x 498.90
+    # B7:: => 249.45 x 354.33
+    # B8:: => 175.75 x 249.45
+    # B9:: => 124.72 x 175.75
+    # B10:: => 87.87 x 124.72
+    # C0:: => 2599.37 x 3676.54
+    # C1:: => 1836.85 x 2599.37
+    # C2:: => 1298.27 x 1836.85
+    # C3:: => 918.43 x 1298.27
+    # C4:: => 649.13 x 918.43
+    # C5:: => 459.21 x 649.13
+    # C6:: => 323.15 x 459.21
+    # C7:: => 229.61 x 323.15
+    # C8:: => 161.57 x 229.61
+    # C9:: => 113.39 x 161.57
+    # C10:: => 79.37 x 113.39
+    # RA0:: => 2437.80 x 3458.27
+    # RA1:: => 1729.13 x 2437.80
+    # RA2:: => 1218.90 x 1729.13
+    # RA3:: => 864.57 x 1218.90
+    # RA4:: => 609.45 x 864.57
+    # SRA0:: => 2551.18 x 3628.35
+    # SRA1:: => 1814.17 x 2551.18
+    # SRA2:: => 1275.59 x 1814.17
+    # SRA3:: => 907.09 x 1275.59
+    # SRA4:: => 637.80 x 907.09
+    # EXECUTIVE:: => 521.86 x 756.00
+    # FOLIO:: => 612.00 x 936.00
+    # LEGAL:: => 612.00 x 1008.00
+    # LETTER:: => 612.00 x 792.00
+    # TABLOID:: => 792.00 x 1224.00 
+    #
+    module PageGeometry
+
+      SIZES = { "4A0" => [4767.87, 6740.79],
+                "2A0" => [3370.39, 4767.87],
+                 "A0" => [2383.94, 3370.39],
+                 "A1" => [1683.78, 2383.94],
+                 "A2" => [1190.55, 1683.78],
+                 "A3" => [841.89, 1190.55],
+                 "A4" => [595.28, 841.89],
+                 "A5" => [419.53, 595.28],
+                 "A6" => [297.64, 419.53],
+                 "A7" => [209.76, 297.64],
+                 "A8" => [147.40, 209.76],
+                 "A9" => [104.88, 147.40],
+                "A10" => [73.70, 104.88],
+                 "B0" => [2834.65, 4008.19],
+                 "B1" => [2004.09, 2834.65],
+                 "B2" => [1417.32, 2004.09],
+                 "B3" => [1000.63, 1417.32],
+                 "B4" => [708.66, 1000.63],
+                 "B5" => [498.90, 708.66],
+                 "B6" => [354.33, 498.90],
+                 "B7" => [249.45, 354.33],
+                 "B8" => [175.75, 249.45],
+                 "B9" => [124.72, 175.75],
+                "B10" => [87.87, 124.72],
+                 "C0" => [2599.37, 3676.54],
+                 "C1" => [1836.85, 2599.37],
+                 "C2" => [1298.27, 1836.85],
+                 "C3" => [918.43, 1298.27],
+                 "C4" => [649.13, 918.43],
+                 "C5" => [459.21, 649.13],
+                 "C6" => [323.15, 459.21],
+                 "C7" => [229.61, 323.15],
+                 "C8" => [161.57, 229.61],
+                 "C9" => [113.39, 161.57],
+                "C10" => [79.37, 113.39],
+                "RA0" => [2437.80, 3458.27],
+                "RA1" => [1729.13, 2437.80],
+                "RA2" => [1218.90, 1729.13],
+                "RA3" => [864.57, 1218.90],
+                "RA4" => [609.45, 864.57],
+               "SRA0" => [2551.18, 3628.35],
+               "SRA1" => [1814.17, 2551.18],
+               "SRA2" => [1275.59, 1814.17],
+               "SRA3" => [907.09, 1275.59],
+               "SRA4" => [637.80, 907.09],
+          "EXECUTIVE" => [521.86, 756.00],
+              "FOLIO" => [612.00, 936.00],
+              "LEGAL" => [612.00, 1008.00],
+             "LETTER" => [612.00, 792.00],
+            "TABLOID" => [792.00, 1224.00] }
+
+   end
+  end
+end

data/lib/prawn/document/snapshot.rb

@@ -0,0 +1,87 @@
+# encoding: utf-8
+
+# snapshot.rb : Implements transactional rendering for Prawn
+#
+# Copyright August 2009, Brad Ediger.  All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
+require 'delegate'
+
+module Prawn
+  class Document
+    module Snapshot
+
+      RollbackTransaction = Class.new(StandardError)
+
+      # Call this within a +transaction+ block to roll back the transaction and
+      # prevent any of its data from being rendered. You must reset the
+      # y-position yourself if you have performed any drawing operations that
+      # modify it.
+      #
+      def rollback
+        raise RollbackTransaction
+      end
+
+      # Run a block of drawing operations, to be completed atomically. If
+      # +rollback+ is called or a RollbackTransaction exception is raised
+      # inside the block, all actions taken inside the block will be rolled
+      # back (with the exception of y-position, which you must restore
+      # yourself). 
+      #
+      # Returns true on success, or false if the transaction was rolled back.
+      #
+      def transaction
+        snap = take_snapshot
+        yield
+        true
+      rescue RollbackTransaction
+        restore_snapshot(snap)
+        false
+      end
+
+      private
+      
+      # Takes a current snapshot of the document's state, sufficient to
+      # reconstruct it after it was amended.
+      #
+      def take_snapshot
+        # current_page holds a ref to the Pages dictionary which grows
+        # monotonically as data is added to the document, so we share that
+        # between the old and new copies.
+        {:page_content    => state.page.content.deep_copy,
+         :current_page    => state.page.dictionary.deep_copy(share=[:Parent]),
+         :page_number     => page_number,
+         :page_kids       => state.store.pages.data[:Kids].map{|kid| kid.identifier},
+         :dests           => names? && 
+                             Marshal.load(Marshal.dump(names.data[:Dests]))}
+      end
+
+      # Rolls the page state back to the state of the given snapshot.
+      #
+      def restore_snapshot(shot)
+        page = state.page
+        # Because these objects are referenced by identifier from the Pages
+        # dictionary, we can't just restore them over the current refs in
+        # page_content and current_page. We have to restore them over the old
+        # ones.
+        page.content = shot[:page_content].identifier
+        page.content.replace shot[:page_content]
+
+        page.dictionary = shot[:current_page].identifier
+        page.dictionary.replace shot[:current_page]
+        page.dictionary.data[:Contents] = page.content
+
+        self.page_number = shot[:page_number]
+
+        state.store.pages.data[:Kids] = shot[:page_kids].map{|id| state.store[id]}
+        state.store.pages.data[:Count] = shot[:page_kids].size
+
+        if shot[:dests]
+          names.data[:Dests] = shot[:dests] 
+        end
+      end
+
+    end
+  end
+end

data/lib/prawn/document/span.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+# span.rb : Implements text columns
+#
+# Copyright September 2008, Gregory Brown. All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
+module Prawn
+  class Document
+    # A span is a special purpose bounding box that allows a column of 
+    # elements to be positioned relative to the margin_box.  
+    #
+    # Arguments:
+    # +width+:: The width of the column in PDF points
+    #
+    # Options:
+    # <tt>:position</tt>:: One of :left, :center, :right or an x offset
+    #
+    # This method is typically used for flowing a column of text from one 
+    # page to the next.
+    #
+    #  span(350, :position => :center) do
+    #    text "Here's some centered text in a 350 point column. " * 100
+    #  end
+    #  
+    def span(width, options={})
+      Prawn.verify_options [:position], options
+      original_position = self.y      
+     
+      # FIXME: Any way to move this upstream?
+      left_boundary = case(options[:position] || :left)
+      when :left
+        margin_box.absolute_left
+      when :center
+        margin_box.absolute_left + margin_box.width / 2.0 - width /2.0
+      when :right
+        margin_box.absolute_right - width
+      when Numeric
+        margin_box.absolute_left + options[:position]
+      else
+        raise ArgumentError, "Invalid option for :position"
+      end
+      
+      # we need to bust out of whatever nested bounding boxes we're in.
+      canvas do
+        bounding_box([left_boundary, 
+                      margin_box.absolute_top], :width => width) do
+          self.y = original_position
+          yield
+        end
+      end          
+    end
+  end
+end