nurettin-prawn 1.0.0.rc1

data/lib/prawn/core/page.rb

@@ -0,0 +1,212 @@
+# encoding: utf-8
+
+# prawn/core/page.rb : Implements low-level representation of a PDF page
+#
+# Copyright February 2010, Gregory Brown.  All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+#
+
+require 'prawn/document/graphics_state'
+
+module Prawn
+  module Core
+    class Page #:nodoc:
+
+      include Prawn::Core::Page::GraphicsState
+
+      attr_accessor :document, :content, :dictionary, :margins, :stack
+
+      def initialize(document, options={})
+        @document = document
+        @margins  = options[:margins] || { :left    => 36,
+                                           :right   => 36,
+                                           :top     => 36,
+                                           :bottom  => 36  }
+        @stack = Prawn::GraphicStateStack.new(options[:graphic_state])
+        if options[:object_id]
+          init_from_object(options)
+        else
+          init_new_page(options)
+        end
+      end
+
+      def layout
+        return @layout if @layout
+
+        mb = dictionary.data[:MediaBox]
+        if mb[3] > mb[2]
+          :portrait
+        else
+          :landscape
+        end
+      end
+
+      def size
+        @size || dimensions[2,2]
+      end
+
+      def in_stamp_stream?
+        !!@stamp_stream
+      end
+
+      def stamp_stream(dictionary)
+        @stamp_stream     = ""
+        @stamp_dictionary = dictionary
+        graphic_stack_size = stack.stack.size
+
+        document.save_graphics_state
+        document.send(:freeze_stamp_graphics)
+        yield if block_given?
+
+        until graphic_stack_size == stack.stack.size
+          document.restore_graphics_state
+        end
+
+        @stamp_dictionary << @stamp_stream
+
+        @stamp_stream      = nil
+        @stamp_dictionary  = nil
+      end
+
+      def content
+        @stamp_stream || document.state.store[@content]
+      end
+
+      # As per the PDF spec, each page can have multiple content streams. This will
+      # add a fresh, empty content stream this the page, mainly for use in loading
+      # template files.
+      #
+      def new_content_stream
+        return if in_stamp_stream?
+
+        unless dictionary.data[:Contents].is_a?(Array)
+          dictionary.data[:Contents] = [content]
+        end
+        @content    = document.ref({})
+        dictionary.data[:Contents] << document.state.store[@content]
+        document.open_graphics_state
+      end
+
+      def dictionary
+        @stamp_dictionary || document.state.store[@dictionary]
+      end
+
+      def resources
+        if dictionary.data[:Resources]
+          document.deref(dictionary.data[:Resources])
+        else
+          dictionary.data[:Resources] = {}
+        end
+      end
+
+      def fonts
+        if resources[:Font]
+          document.deref(resources[:Font])
+        else
+          resources[:Font] = {}
+        end
+      end
+
+      def xobjects
+        if resources[:XObject]
+          document.deref(resources[:XObject])
+        else
+          resources[:XObject] = {}
+        end
+      end
+
+      def ext_gstates
+        if resources[:ExtGState]
+          document.deref(resources[:ExtGState])
+        else
+          resources[:ExtGState] = {}
+        end
+      end
+
+      def finalize
+        if dictionary.data[:Contents].is_a?(Array)
+          dictionary.data[:Contents].each do |stream|
+            stream.compress_stream if document.compression_enabled?
+          end
+        else
+          content.compress_stream if document.compression_enabled?
+        end
+      end
+
+      def imported_page?
+        @imported_page
+      end
+
+      def dimensions
+        return inherited_dictionary_value(:MediaBox) if imported_page?
+
+        coords = Prawn::Document::PageGeometry::SIZES[size] || size
+        [0,0] + case(layout)
+        when :portrait
+          coords
+        when :landscape
+          coords.reverse
+        else
+          raise Prawn::Errors::InvalidPageLayout,
+            "Layout must be either :portrait or :landscape"
+        end
+      end
+
+      private
+
+      def init_from_object(options)
+        @dictionary = options[:object_id].to_i
+        dictionary.data[:Parent] = document.state.store.pages if options[:page_template]
+
+        unless dictionary.data[:Contents].is_a?(Array) # content only on leafs
+          @content    = dictionary.data[:Contents].identifier
+        end
+
+        @stamp_stream      = nil
+        @stamp_dictionary  = nil
+        @imported_page     = true
+      end
+
+      def init_new_page(options)
+        @size     = options[:size]    ||  "LETTER"
+        @layout   = options[:layout]  || :portrait
+
+        @content    = document.ref({})
+        content << "q" << "\n"
+        @dictionary = document.ref(:Type        => :Page,
+                                   :Parent      => document.state.store.pages,
+                                   :MediaBox    => dimensions,
+                                   :Contents    => content)
+
+        resources[:ProcSet] = [:PDF, :Text, :ImageB, :ImageC, :ImageI]
+
+        @stamp_stream      = nil
+        @stamp_dictionary  = nil
+      end
+
+      # some entries in the Page dict can be inherited from parent Pages dicts.
+      #
+      # Starting with the current page dict, this method will walk up the
+      # inheritance chain return the first value that is found for key
+      #
+      #     inherited_dictionary_value(:MediaBox)
+      #     => [ 0, 0, 595, 842 ]
+      #
+      def inherited_dictionary_value(key, local_dict = nil)
+        local_dict ||= dictionary.data
+
+        if local_dict.has_key?(key)
+          local_dict[key]
+        elsif local_dict.has_key?(:Parent)
+          inherited_dictionary_value(key, local_dict[:Parent].data)
+        else
+          nil
+        end
+      end
+
+    end
+
+  end
+end
+

data/lib/prawn/core/pdf_object.rb

@@ -0,0 +1,125 @@
+# encoding: utf-8
+#
+# pdf_object.rb : Handles Ruby to PDF object serialization
+#
+# Copyright April 2008, Gregory Brown.  All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
+# Top level Module
+#
+module Prawn 
+  module Core #:nodoc:
+                                             
+    module_function
+
+    if "".respond_to?(:encode)
+      # Ruby 1.9+
+      def utf8_to_utf16(str)
+        utf16 = "\xFE\xFF".force_encoding("UTF-16BE") + str.encode("UTF-16BE")
+      end
+
+      # encodes any string into a hex representation. The result is a string
+      # with only 0-9 and a-f characters. That result is valid ASCII so tag
+      # it as such to account for behaviour of different ruby VMs
+      def string_to_hex(str)
+        str.unpack("H*").first.force_encoding("ascii")
+      end
+    else
+      # Ruby 1.8
+      def utf8_to_utf16(str)
+        utf16 = "\xFE\xFF"
+
+        str.codepoints do |cp|
+          if cp < 0x10000 # Basic Multilingual Plane
+            utf16 << [cp].pack("n")
+          else
+            # pull out high/low 10 bits
+            hi, lo = (cp - 0x10000).divmod(2**10)
+            # encode a surrogate pair
+            utf16 << [0xD800 + hi, 0xDC00 + lo].pack("n*")
+          end
+        end
+
+        utf16
+      end
+
+      def string_to_hex(str)
+        str.unpack("H*").first
+      end
+    end
+      
+    # Serializes Ruby objects to their PDF equivalents.  Most primitive objects
+    # will work as expected, but please note that Name objects are represented 
+    # by Ruby Symbol objects and Dictionary objects are represented by Ruby hashes
+    # (keyed by symbols)   
+    #
+    #  Examples:
+    #
+    #     PdfObject(true)      #=> "true"
+    #     PdfObject(false)     #=> "false" 
+    #     PdfObject(1.2124)    #=> "1.2124"
+    #     PdfObject("foo bar") #=> "(foo bar)"  
+    #     PdfObject(:Symbol)   #=> "/Symbol"
+    #     PdfObject(["foo",:bar, [1,2]]) #=> "[foo /bar [1 2]]"
+    # 
+    def PdfObject(obj, in_content_stream = false)
+      case(obj)        
+      when NilClass   then "null" 
+      when TrueClass  then "true"
+      when FalseClass then "false"
+      when Numeric
+        if (str = String(obj)) =~ /e/i
+          # scientific notation is not supported in PDF
+          sprintf("%.16f", obj).gsub(/\.?0+\z/, "")
+        else
+          str
+        end
+      when Array
+        "[" << obj.map { |e| PdfObject(e, in_content_stream) }.join(' ') << "]"
+      when Prawn::Core::LiteralString
+        obj = obj.gsub(/[\\\n\r\t\b\f\(\)]/n) { |m| "\\#{m}" }
+        "(#{obj})"
+      when Time
+        obj = obj.strftime("D:%Y%m%d%H%M%S%z").chop.chop + "'00'"
+        obj = obj.gsub(/[\\\n\r\t\b\f\(\)]/n) { |m| "\\#{m}" }
+        "(#{obj})"
+      when Prawn::Core::ByteString
+        "<" << obj.unpack("H*").first << ">"
+      when String
+        obj = utf8_to_utf16(obj) unless in_content_stream
+        "<" << string_to_hex(obj) << ">"
+       when Symbol                                                         
+         "/" + obj.to_s.unpack("C*").map { |n|
+          if n < 33 || n > 126 || [35,40,41,47,60,62].include?(n)
+            "#" + n.to_s(16).upcase
+          else
+            [n].pack("C*")
+          end
+         }.join
+      when Hash           
+        output = "<< "
+        obj.each do |k,v|  
+          unless String === k || Symbol === k
+            raise Prawn::Errors::FailedObjectConversion, 
+              "A PDF Dictionary must be keyed by names"
+          end                          
+          output << PdfObject(k.to_sym, in_content_stream) << " " << 
+                    PdfObject(v, in_content_stream) << "\n"
+        end  
+        output << ">>"  
+      when Prawn::Core::Reference
+        obj.to_s      
+      when Prawn::Core::NameTree::Node
+        PdfObject(obj.to_hash)
+      when Prawn::Core::NameTree::Value
+        PdfObject(obj.name) + " " + PdfObject(obj.value)
+      when Prawn::OutlineRoot, Prawn::OutlineItem
+        PdfObject(obj.to_hash)
+      else
+        raise Prawn::Errors::FailedObjectConversion, 
+          "This object cannot be serialized to PDF (#{obj.inspect})"
+      end     
+    end   
+  end
+end

data/lib/prawn/core/reference.rb

@@ -0,0 +1,119 @@
+# encoding: utf-8
+
+# reference.rb : Implementation of PDF indirect objects
+#
+# Copyright April 2008, Gregory Brown.  All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
+require 'zlib'
+
+module Prawn  
+  module Core
+  
+    class Reference #:nodoc:
+
+      attr_accessor :gen, :data, :offset, :stream, :live, :identifier
+      
+      def initialize(id, data)
+        @identifier = id 
+        @gen        = 0       
+        @data       = data     
+        @compressed = false
+        @stream     = nil
+      end            
+      
+      def object 
+        output = "#{@identifier} #{gen} obj\n" <<
+                 Prawn::Core::PdfObject(data) << "\n"
+        if @stream
+          output << "stream\n" << @stream << "\nendstream\n" 
+        end
+        output << "endobj\n"
+      end  
+      
+      def <<(data)
+        raise 'Cannot add data to a stream that is compressed' if @compressed
+        (@stream ||= "") << data
+        @data[:Length] = @stream.length
+        @stream
+      end  
+      
+      def to_s            
+        "#{@identifier} #{gen} R"
+      end
+
+      def compress_stream
+        @stream = Zlib::Deflate.deflate(@stream)
+        @data[:Filter] = :FlateDecode
+        @data[:Length] = @stream.length
+        @compressed = true
+      end
+
+      def compressed?
+        @compressed
+      end
+
+      # Creates a deep copy of this ref. If +share+ is provided, shares the
+      # given dictionary entries between the old ref and the new.
+      #
+      def deep_copy(share=[])
+        r = dup
+
+        case r.data
+        when Hash
+          # Copy each entry not in +share+.
+          (r.data.keys - share).each do |k|
+            r.data[k] = Marshal.load(Marshal.dump(r.data[k]))
+          end
+        when Prawn::Core::NameTree::Node
+          r.data = r.data.deep_copy
+        else
+          r.data = Marshal.load(Marshal.dump(r.data))
+        end
+
+        r.stream = Marshal.load(Marshal.dump(r.stream))
+        r
+      end
+      
+      # Replaces the data and stream with that of other_ref. Preserves compressed
+      # status.
+      def replace(other_ref)
+        @data       = other_ref.data
+        @stream     = other_ref.stream
+        @compressed = other_ref.compressed?
+      end
+
+      # Marks this and all referenced objects live, recursively.
+      def mark_live
+        return if @live
+        @live = true
+        referenced_objects.each { |o| o.mark_live }
+      end
+
+      private
+
+      # All objects referenced by this one. Used for GC.
+      def referenced_objects(obj=@data)
+        case obj
+        when self.class
+          []
+        when Hash
+          obj.values.map{|v| [v] + referenced_objects(v) }
+        when Array
+          obj.map{|v| [v] + referenced_objects(v) }
+        when OutlineRoot, OutlineItem
+          referenced_objects(obj.to_hash)
+        else []
+        end.flatten.grep(self.class)
+      end
+
+    end         
+
+    module_function
+    
+    def Reference(*args, &block) #:nodoc:
+      Reference.new(*args, &block)
+    end     
+  end
+end