prawn-core 0.5.0.1

data/lib/prawn/images/jpg.rb

@@ -0,0 +1,45 @@
+# encoding: ASCII-8BIT
+
+# jpg.rb : Extracts the data from a JPG that is needed for embedding
+#
+# Copyright April 2008, James Healy.  All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
+require 'stringio'
+
+module Prawn
+  module Images
+    # A convenience class that wraps the logic for extracting the parts
+    # of a PNG image that we need to embed them in a PDF
+    class JPG 
+      attr_reader :width, :height, :bits, :channels
+      attr_accessor :scaled_width, :scaled_height
+      
+      JPEG_SOF_BLOCKS = %W(\xc0 \xc1 \xc2 \xc3 \xc5 \xc6 \xc7 \xc9 \xca \xcb \xcd \xce \xcf)
+      JPEG_APP_BLOCKS = %W(\xe0 \xe1 \xe2 \xe3 \xe4 \xe5 \xe6 \xe7 \xe8 \xe9 \xea \xeb \xec \xed \xee \xef)
+
+      # Process a new JPG image
+      #
+      # <tt>:data</tt>:: A string containing a full PNG file
+      #
+      def initialize(data)
+        data = StringIO.new(data.dup)
+
+        c_marker = "\xff" # Section marker.
+        data.read(2)   # Skip the first two bytes of JPEG identifier.
+        loop do
+          marker, code, length = data.read(4).unpack('aan')
+          raise "JPEG marker not found!" if marker != c_marker
+
+          if JPEG_SOF_BLOCKS.include?(code)
+            @bits, @height, @width, @channels = data.read(6).unpack("CnnC")
+            break
+          end
+
+          buffer = data.read(length - 2)
+        end
+      end
+    end
+  end
+end

data/lib/prawn/images/png.rb

@@ -0,0 +1,217 @@
+# encoding: ASCII-8BIT
+
+# png.rb : Extracts the data from a PNG that is needed for embedding
+#
+# Based on some similar code in PDF::Writer by Austin Ziegler
+#
+# Copyright April 2008, James Healy.  All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
+require 'stringio'
+
+module Prawn
+  module Images
+    # A convenience class that wraps the logic for extracting the parts
+    # of a PNG image that we need to embed them in a PDF
+    class PNG
+      attr_reader :palette, :img_data, :transparency
+      attr_reader :width, :height, :bits
+      attr_reader :color_type, :compression_method, :filter_method
+      attr_reader :interlace_method, :alpha_channel
+      attr_accessor :scaled_width, :scaled_height
+
+      # Process a new PNG image
+      #
+      # <tt>data</tt>:: A string containing a full PNG file
+      #
+      def initialize(data)
+        data = StringIO.new(data.dup)
+
+        data.read(8)  # Skip the default header
+
+        @palette  = ""
+        @img_data = ""
+        @transparency = {}
+
+        loop do
+          chunk_size  = data.read(4).unpack("N")[0]
+          section     = data.read(4)
+          case section
+          when 'IHDR'
+            # we can grab other interesting values from here (like width,
+            # height, etc)
+            values = data.read(chunk_size).unpack("NNCCCCC")
+
+            @width              = values[0]
+            @height             = values[1]
+            @bits               = values[2]
+            @color_type         = values[3]
+            @compression_method = values[4]
+            @filter_method      = values[5]
+            @interlace_method   = values[6]
+          when 'PLTE'
+            @palette << data.read(chunk_size)
+          when 'IDAT'
+            @img_data << data.read(chunk_size)
+          when 'tRNS'
+            # This chunk can only occur once and it must occur after the
+            # PLTE chunk and before the IDAT chunk
+            @transparency = {}
+            case @color_type
+            when 3
+              # Indexed colour, RGB. Each byte in this chunk is an alpha for
+              # the palette index in the PLTE ("palette") chunk up until the
+              # last non-opaque entry. Set up an array, stretching over all
+              # palette entries which will be 0 (opaque) or 1 (transparent).
+              @transparency[:indexed]  = data.read(chunk_size).unpack("C*")
+              short = 255 - @transparency[:indexed].size
+              @transparency[:indexed] += ([255] * short) if short > 0
+            when 0
+              # Greyscale. Corresponding to entries in the PLTE chunk.
+              # Grey is two bytes, range 0 .. (2 ^ bit-depth) - 1
+              grayval = data.read(chunk_size).unpack("n").first
+              @transparency[:grayscale] = grayval
+            when 2
+              # True colour with proper alpha channel.
+              @transparency[:rgb] = data.read(chunk_size).unpack("nnn")
+            end
+          when 'IEND'
+            # we've got everything we need, exit the loop
+            break
+          else
+            # unknown (or un-important) section, skip over it
+            data.seek(data.pos + chunk_size)
+          end
+
+          data.read(4)  # Skip the CRC
+        end
+      end
+
+      # number of color components to each pixel
+      #
+      def colors
+        case self.color_type
+        when 0, 3, 4
+          return 1
+        when 2, 6
+          return 3
+        end
+      end
+
+      # number of bits used per pixel
+      #
+      def pixel_bitlength
+        if alpha_channel?
+          self.bits * (self.colors + 1)
+        else
+          self.bits * self.colors
+        end
+      end
+
+      # split the alpha channel data from the raw image data in images
+      # where it's required.
+      #
+      def split_alpha_channel!
+        unfilter_image_data if alpha_channel?
+      end
+
+      private
+
+      def alpha_channel?
+        @color_type == 4 || @color_type == 6
+      end
+
+      def unfilter_image_data
+        data = Zlib::Inflate.inflate(@img_data).unpack 'C*'
+        @img_data = ""
+        @alpha_channel = ""
+
+        pixel_bytes     = pixel_bitlength / 8
+        scanline_length = pixel_bytes * self.width + 1
+        row = 0
+        pixels = []
+        paeth, pa, pb, pc = nil
+        until data.empty? do
+          row_data = data.slice! 0, scanline_length
+          filter = row_data.shift
+          case filter
+          when 0 # None
+          when 1 # Sub
+            row_data.each_with_index do |byte, index|
+              left = index < pixel_bytes ? 0 : row_data[index - pixel_bytes]
+              row_data[index] = (byte + left) % 256
+              #p [byte, left, row_data[index]]
+            end
+          when 2 # Up
+            row_data.each_with_index do |byte, index|
+              col = index / pixel_bytes
+              upper = row == 0 ? 0 : pixels[row-1][col][index % pixel_bytes]
+              row_data[index] = (upper + byte) % 256
+            end
+          when 3  # Average
+            row_data.each_with_index do |byte, index|
+              col = index / pixel_bytes
+              upper = row == 0 ? 0 : pixels[row-1][col][index % pixel_bytes]
+              left = index < pixel_bytes ? 0 : row_data[index - pixel_bytes]
+
+              row_data[index] = (byte + ((left + upper)/2).floor) % 256
+            end
+          when 4 # Paeth
+            left = upper = upper_left = nil
+            row_data.each_with_index do |byte, index|
+              col = index / pixel_bytes
+
+              left = index < pixel_bytes ? 0 : row_data[index - pixel_bytes]
+              if row.zero?
+                upper = upper_left = 0
+              else
+                upper = pixels[row-1][col][index % pixel_bytes]
+                upper_left = col.zero? ? 0 :
+                  pixels[row-1][col-1][index % pixel_bytes]
+              end
+
+              p = left + upper - upper_left
+              pa = (p - left).abs
+              pb = (p - upper).abs
+              pc = (p - upper_left).abs
+
+              paeth = if pa <= pb && pa <= pc
+                left
+              elsif pb <= pc
+                upper
+              else
+                upper_left
+              end
+
+              row_data[index] = (byte + paeth) % 256
+            end
+          else
+            raise ArgumentError, "Invalid filter algorithm #{filter}"
+          end
+
+          s = []
+          row_data.each_slice pixel_bytes do |slice|
+            s << slice
+          end
+          pixels << s
+          row += 1
+        end
+
+        # convert the pixel data to seperate strings for colours and alpha
+        color_byte_size = self.colors * self.bits / 8
+        alpha_byte_size = self.bits / 8
+        pixels.each do |row|
+          row.each do |pixel|
+            @img_data << pixel[0, color_byte_size].pack("C*")
+            @alpha_channel << pixel[color_byte_size, alpha_byte_size].pack("C*")
+          end
+        end
+
+        # compress the data
+        @img_data = Zlib::Deflate.deflate(@img_data)
+        @alpha_channel = Zlib::Deflate.deflate(@alpha_channel)
+      end
+    end
+  end
+end

data/lib/prawn/literal_string.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+module Prawn
+  # This is used to differentiate strings that must be encoded as
+  # a *literal* string, versus those that can be encoded in
+  # the PDF hexadecimal format.
+  #
+  # Some features of the PDF format appear to require that literal
+  # strings be used. One such feature is the /Dest key of a link
+  # annotation; if a hex encoded string is used there, the links
+  # do not work (as tested in Mac OS X Preview, and Adobe Acrobat
+  # Reader).
+  class LiteralString < String #:nodoc:
+  end
+end

data/lib/prawn/measurement_extensions.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+# measurement_extensions.rb: Core extensions for Prawn::Measurements
+#
+# Copyright December 2008, Florian Witteler.  All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
+require 'prawn/measurements'
+
+class Numeric
+  include Prawn::Measurements        
+  # prawns' basic unit is PostScript-Point        
+  # 72 points per inch
+
+  def mm
+    return mm2pt(self)
+  end
+
+  def cm
+    return cm2pt(self)
+  end
+
+  def dm
+    return dm2pt(self)
+  end
+
+  def m
+    return m2pt(self)
+  end
+
+  def in
+    return in2pt(self)
+  end
+
+  def yd
+    return yd2pt(self)
+  end
+
+  def ft
+    return ft2pt(self)
+  end
+  
+  def pt
+    return self
+  end
+end        

data/lib/prawn/measurements.rb

@@ -0,0 +1,71 @@
+# encoding: utf-8
+# measurements.rb: Conversions from other measurements to PDF points
+#
+# Copyright December 2008, Florian Witteler.  All Rights Reserved.
+#
+module Prawn  
+  module Measurements
+  
+    # ============================================================================
+    #metric conversions
+    def cm2mm(cm)
+      return cm*10
+    end
+  
+    def dm2mm(dm)
+      return dm*100  
+    end
+  
+    def m2mm(m)
+      return m*1000
+    end
+  
+    # ============================================================================
+    # imperial conversions    
+    # from http://en.wikipedia.org/wiki/Imperial_units
+  
+    def ft2in(ft)
+      return ft * 12
+    end  
+
+    def yd2in(yd)
+      return yd*36
+    end
+
+  
+    # ============================================================================
+    # PostscriptPoint-converisons
+  
+    def in2pt(inch)
+      return inch * 72    
+    end
+  
+    def ft2pt(ft)
+      return in2pt(ft2in(ft))
+    end
+  
+    def yd2pt(yd)
+      return in2pt(yd2in(yd))
+    end
+  
+    def mm2pt(mm)
+        return mm*(72 / 25.4)
+    end
+  
+    def cm2pt(cm)
+      return mm2pt(cm2mm(cm))
+    end
+  
+    def dm2pt(dm)
+      return mm2pt(dm2mm(dm))
+    end
+  
+    def m2pt(m)
+      return mm2pt(m2mm(m))
+    end
+  
+    def pt2mm(pt)    
+      return pt * 1 / mm2pt(1)# (25.4 / 72)
+    end
+  end
+end

data/lib/prawn/name_tree.rb

@@ -0,0 +1,165 @@
+# encoding: utf-8
+
+# name_tree.rb : Implements NameTree for PDF
+#
+# Copyright November 2008, Jamis Buck. All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+#
+require 'prawn/literal_string'
+require 'prawn/reference'
+
+module Prawn
+  module NameTree #:nodoc:
+    class Node #:nodoc:
+      attr_reader :children
+      attr_reader :limit
+      attr_reader :document
+      attr_accessor :parent
+      attr_accessor :ref
+
+      def initialize(document, limit, parent=nil)
+        @document = document
+        @children = []
+        @limit = limit
+        @parent = parent
+        @ref = nil
+      end
+
+      def empty?
+        children.empty?
+      end
+
+      def size
+        leaf? ? children.size : children.inject(0) { |sum, child| sum + child.size }
+      end
+
+      def leaf?
+        children.empty? || children.first.is_a?(Value)
+      end
+
+      def add(name, value)
+        self << Value.new(name, value)
+      end
+
+      def to_hash
+        hash = {}
+
+        hash[:Limits] = [least, greatest] if parent
+        if leaf?
+          hash[:Names] = children if leaf?
+        else
+          hash[:Kids] = children.map { |child| child.ref }
+        end
+
+        return hash
+      end
+
+      def least
+        if leaf?
+          children.first.name
+        else
+          children.first.least
+        end
+      end
+
+      def greatest
+        if leaf?
+          children.last.name
+        else
+          children.last.greatest
+        end
+      end
+
+      def <<(value)
+        if children.empty?
+          children << value
+        elsif leaf?
+          children.insert(insertion_point(value), value)
+          split! if children.length > limit
+        else
+          fit = children.detect { |child| child >= value }
+          fit << value
+        end
+
+        value
+      end
+
+      def >=(value)
+        children.empty? || children.last >= value
+      end
+
+      def split!
+        if parent
+          parent.split(self)
+        else
+          left, right = new_node(self), new_node(self)
+          split_children(self, left, right)
+          children.replace([left, right])
+        end
+      end
+
+      protected
+
+        def split(node)
+          new_child = new_node(self)
+          split_children(node, node, new_child)
+          index = children.index(node)
+          children.insert(index+1, new_child)
+          split! if children.length > limit
+        end
+
+      private
+
+        def new_node(parent=nil)
+          node = Node.new(document, limit, parent)
+          node.ref = document.ref(node)
+          return node
+        end
+
+        def split_children(node, left, right)
+          half = (node.limit+1)/2
+
+          left_children, right_children = node.children[0...half], node.children[half..-1]
+
+          left.children.replace(left_children)
+          right.children.replace(right_children)
+
+          unless node.leaf?
+            left_children.each { |child| child.parent = left }
+            right_children.each { |child| child.parent = right }
+          end
+        end
+
+        def insertion_point(value)
+          children.each_with_index do |child, index|
+            return index if child >= value
+          end
+          return children.length
+        end
+    end
+
+    class Value #:nodoc:
+      include Comparable
+
+      attr_reader :name
+      attr_reader :value
+
+      def initialize(name, value)
+        @name, @value = Prawn::LiteralString.new(name), value
+      end
+
+      def <=>(leaf)
+        name <=> leaf.name
+      end
+
+      def inspect
+        "#<Value: #{name.inspect} : #{value.inspect}>"
+      end
+
+      def to_s
+        "#{name} : #{value}"
+      end
+    end
+  end
+end