pdf-writer 1.0.0

data/lib/pdf/writer/object/pages.rb

@@ -0,0 +1,115 @@
+#--
+# PDF::Writer for Ruby.
+#   http://rubyforge.org/projects/ruby-pdf/
+#   Copyright 2003 - 2005 Austin Ziegler.
+#
+#   Licensed under a MIT-style licence. See LICENCE in the main distribution
+#   for full licensing information.
+#
+# $Id: pages.rb,v 1.2 2005/05/16 03:59:21 austin Exp $
+#++
+  # object which is a parent to the pages in the document
+class PDF::Writer::Object::Pages < PDF::Writer::Object
+  def initialize(parent)
+    super(parent)
+
+    @parent.catalog.pages = self
+
+    @pages      = []
+    @procset    = nil
+    @media_box  = nil
+    @fonts      = []
+    @xObjects   = []
+    @bleed_box  = nil
+    @trim_box   = nil
+  end
+
+  def size
+    @pages.size
+  end
+
+  def first_page
+    @pages[0]
+  end
+
+    # Add the page ID to the end of the page list.
+  def <<(p)
+    if p.kind_of?(PDF::Writer::Object::Page)
+      @pages << p
+    elsif p.kind_of?(PDF::Writer::Object::Font)
+      @fonts << p
+    elsif p.kind_of?(PDF::Writer::External)
+      @xObjects << p
+    else
+      raise ArgumentError, PDF::Message[:req_FPXO]
+    end
+  end
+
+    # Add a page to the page list. If p is just a Page, then it will be
+    # added to the page list. Otherwise, it will be treated as a Hash with
+    # keys :page, :pos, and :rpage. :page is the Page to be added to the
+    # list; :pos is :before or :after; :rpage is the Page to which the
+    # new Page will be added relative to.
+  def add(p)
+    if p.kind_of?(PDF::Writer::Object::Page)
+      @pages << p
+    elsif p.kind_of?(PDF::Writer::FontMetrics)
+      @fonts << p
+    elsif p.kind_of?(PDF::Writer::External)
+      @xObjects << p
+    elsif p.kind_of?(Hash)
+      # Find a match.
+      i = @pages.index(p[:rpage])
+      unless i.nil?
+        # There is a match; insert the page.
+        case p[:pos]
+        when :before
+          @pages[i, 0] = p[:page]
+        when :after
+          @pages[i + 1, 0] = p[:page]
+        else
+          raise ArgumentError, PDF::Message[:invalid_pos]
+        end
+      end
+    else
+      raise ArgumentError, PDF::Message[:req_FPXOH]
+    end
+  end
+
+  attr_accessor :procset
+    # Each of the following should be an array of 4 numbers, the x and y
+    # coordinates of the lower left and upper right bounds of the box.
+  attr_accessor :media_box
+  attr_accessor :bleed_box
+  attr_accessor :trim_box
+
+  def to_s
+    unless @pages.empty?
+      res = "\n#{@oid} 0 obj\n<< /Type /Pages\n/Kids ["
+      @pages.uniq! # uniqify the data...
+      @pages.each { |p| res << "#{p.oid} 0 R\n" }
+      res << "]\n/Count #{@pages.size}"
+      unless @fonts.empty? and @procset.nil?
+        res << "\n/Resources <<"
+        res << "\n/ProcSet #{@procset.oid} 0 R" unless @procset.nil?
+        unless @fonts.empty?
+          res << "\n/Font << "
+          @fonts.each { |f| res << "\n/F#{f.font_id} #{f.oid} 0 R" }
+          res << " >>"
+        end
+        unless @xObjects.empty?
+          res << "\n/XObject << "
+          @xObjects.each { |x| res << "\n/#{x.label} #{x.oid} 0 R" }
+          res << " >>"
+        end
+        res << "\n>>"
+        res << "\n/MediaBox [#{@media_box.join(' ')}]" unless @media_box.nil? or @media_box.empty?
+        res << "\n/BleedBox [#{@bleed_box.join(' ')}]" unless @bleed_box.nil? or @bleed_box.empty?
+        res << "\n/TrimBox [#{@trim_box.join(' ')}]" unless @trim_box.nil? or @trim_box.empty?
+      end
+      res << "\n >>\nendobj"
+    else
+      "\n#{@oid} 0 obj\n<< /Type /Pages\n/Count 0\n>>\nendobj"
+    end
+  end
+end

data/lib/pdf/writer/object/procset.rb

@@ -0,0 +1,46 @@
+#--
+# PDF::Writer for Ruby.
+#   http://rubyforge.org/projects/ruby-pdf/
+#   Copyright 2003 - 2005 Austin Ziegler.
+#
+#   Licensed under a MIT-style licence. See LICENCE in the main distribution
+#   for full licensing information.
+#
+# $Id: procset.rb,v 1.2 2005/05/16 03:59:21 austin Exp $
+#++
+  # The document Procedure Set. Not necessary in PDF 1.4 or later, but
+  # producing applications are recommended to provide the /ProcSet /Resource
+  # in any case for older viewers. Viewing applications are *not*
+  # recommended to rely on this information being correct.
+  #
+  # These procedure sets are used only when the content stream is printed to
+  # a PostScript output device; the names identify PostScript procedure sets
+  # that must be sent to the device to interpret the PDF operators in the
+  # content stream. Each element of this array must be one of the following
+  # predefined names: 'PDF', 'Text', 'ImageB', 'ImageC', and 'ImageI'. See
+  # also Appendix H note 102.
+class PDF::Writer::Object::Procset < PDF::Writer::Object
+  def initialize(parent)
+    super
+
+    @info = ["PDF", "Text"]
+    @parent.pages.procset = self
+    @parent.procset = self
+  end
+
+  # This is to add new items to the procset list, despite the fact that
+  # this is considered obselete, the items are required for printing to
+  # some PostsCript printers.
+  #
+  # +p+ may be 'ImageB', 'ImageC', or 'ImageI'.
+  def <<(p)
+    @info << p
+  end
+
+  def to_s
+    info = @info.uniq
+    res = "\n#{@oid} 0 obj\n["
+    @info.each { |k| res << "/#{k} " }
+    res << "]\nendobj"
+  end
+end

data/lib/pdf/writer/object/viewerpreferences.rb

@@ -0,0 +1,74 @@
+#--
+# PDF::Writer for Ruby.
+#   http://rubyforge.org/projects/ruby-pdf/
+#   Copyright 2003 - 2005 Austin Ziegler.
+#
+#   Licensed under a MIT-style licence. See LICENCE in the main distribution
+#   for full licensing information.
+#
+# $Id: viewerpreferences.rb,v 1.2 2005/05/16 03:59:21 austin Exp $
+#++
+  # Set the viewer preferences. 
+  # 
+  # HideToolbar::   boolean (Optional) A flag specifying whether to hide the
+  #                 viewer application? tool bars when the document is
+  #                 active. Default value: false.
+  # HideMenubar::   boolean (Optional) A flag specifying whether to hide the
+  #                 viewer application? menu bar when the document is
+  #                 active. Default value: false.
+  # HideWindowUI::  boolean (Optional) A flag specifying whether to hide
+  #                 user interface elements in the document? window (such as
+  #                 scroll bars and navigation controls), leaving only the
+  #                 document? contents displayed. Default value: false.
+  # FitWindow::     boolean (Optional) A flag specifying whether to resize
+  #                 the document? window to fit the size of the first
+  #                 displayed page. Default value: false.
+  # CenterWindow::  boolean (Optional) A flag specifying whether to position
+  #                 the document? window in the center of the screen.
+  #                 Default value: false.
+  # NonFullScreenPageMode:: name (Optional) The document? page mode,
+  #                         specifying how to display the document on
+  #                         exiting full-screen mode. This entry is
+  #                         meaningful only if the value of the PageMode
+  #                         entry in the catalog dictionary is FullScreen;
+  #                         it is ignored otherwise. Default value: UseNone.
+  # Direction::             name (Optional; PDF 1.3) The predominant reading
+  #                         order for text: L2R Left to right R2L Right to
+  #                         left (including vertical writing systems such as
+  #                         Chinese, Japanese, and Korean) This entry has no
+  #                         direct effect on the document? contents or page
+  #                         numbering, but can be used to determine the
+  #                         relative positioning of pages when displayed
+  #                         side by side or printed n-up. Default value:
+  #                         L2R.
+  #
+  # NonFullScreenPageMode Names
+  # UseNone:: Neither document outline nor thumbnail images visible
+  # UseOutlines:: Document outline visible
+  # UseThumbs:: Thumbnail images visible
+  #
+  # Note that boolean values are represented by the values 'true' and
+  # 'false'. Also note that I have not done much testing on changing these
+  # values and am not sure how responsive the various viewers and browsers
+  # are to them (and setting the direction would be fairly meaningless as
+  # none of these character sets are avaliable yet.
+class PDF::Writer::Object::ViewerPreferences < PDF::Writer::Object
+  Preferences = %w{HideToolbar HideMenubar HideWindowUI FitWindow CenterWindow NonFullScreenPageMode Direction}
+
+  def initialize(parent)
+    super(parent)
+  end
+
+  Preferences.each do |s|
+    attr_accessor s.downcase.intern
+  end
+
+  def to_s
+    res = "\n#{@id} 0 obj\n<< "
+    Preferences.each do |s|
+      v = __send__("#{s.downcase}".intern)
+      res << "\n/#{s} /#{v}" unless v.nil?
+    end
+    res << "\n>>\n"
+  end
+end

data/lib/pdf/writer/ohash.rb

@@ -0,0 +1,58 @@
+#--
+# PDF::Writer for Ruby.
+#   http://rubyforge.org/projects/ruby-pdf/
+#   Copyright 2003 - 2005 Austin Ziegler.
+#
+#   Licensed under a MIT-style licence. See LICENCE in the main distribution
+#   for full licensing information.
+#
+# $Id: ohash.rb,v 1.2 2005/05/16 03:59:21 austin Exp $
+#++
+  # Based on [ruby-talk:20551]. Updated to (hopefully) be 1.8 friendly.
+class PDF::Writer::OHash < Hash
+  alias_method :store, :[]=
+  alias_method :each_pair, :each
+
+  def initialize(*args)
+    @keys = []
+    super
+  end
+
+  def []=(key, val)
+    @keys << key unless has_key?(key)
+    super
+  end
+
+  def delete(key)
+    @keys.delete(key) if has_key?(key)
+    super
+  end
+
+  def each
+    @keys.each { |k| yield k, self[k] }
+  end
+
+  def each_key
+    @keys.each { |k| yield k }
+  end
+
+  def each_value
+    @keys.each { |k| yield self[k] }
+  end
+
+  def first
+    self[@keys[0]]
+  end
+
+  def last
+    self[@keys[-1]]
+  end
+
+  def first?(item)
+    self[@keys[0]] == item
+  end
+
+  def last?(item)
+    self[@keys[-1]] == item
+  end
+end

data/lib/pdf/writer/oreader.rb

@@ -0,0 +1,25 @@
+#--
+# PDF::Writer for Ruby.
+#   http://rubyforge.org/projects/ruby-pdf/
+#   Copyright 2003 - 2005 Austin Ziegler.
+#
+#   Licensed under a MIT-style licence. See LICENCE in the main distribution
+#   for full licensing information.
+#
+# $Id: oreader.rb,v 1.2 2005/05/16 03:59:21 austin Exp $
+#++
+module PDF::Writer::OffsetReader
+  def read_o(length = 1, offset = nil)
+    @offset ||= 0
+    @offset = offset if offset
+    ret = self[@offset, length]
+    @offset += length
+    ret
+  end
+  def offset
+    @offset
+  end
+  def offset=(o)
+    @offset = o || 0
+  end
+end

data/lib/pdf/writer/state.rb

@@ -0,0 +1,48 @@
+#--
+# PDF::Writer for Ruby.
+#   http://rubyforge.org/projects/ruby-pdf/
+#   Copyright 2003 - 2005 Austin Ziegler.
+#
+#   Licensed under a MIT-style licence. See LICENCE in the main distribution
+#   for full licensing information.
+#
+# $Id: state.rb,v 1.2 2005/05/16 03:59:21 austin Exp $
+#++
+class PDF::Writer
+  class State
+    attr_accessor :fill_color
+    attr_accessor :stroke_color
+    attr_accessor :text_render_style
+    attr_accessor :stroke_style
+
+    def initialize(vals = {})
+      @fill_color         = vals[:fill_color]
+      @stroke_color       = vals[:stroke_color]
+      @text_render_style  = vals[:text_render_style]
+      @stroke_style       = vals[:stroke_style]
+
+      yield self if block_given?
+    end
+
+    def blank?
+      @fill_color.nil? and @stroke_color.nil? and @stroke_style.nil?
+    end
+  end
+
+  class StateStack < ::Array
+    alias_method :__push__, :push
+#   alias_method :__pop__, :pop
+
+    def push(obj)
+      return self if obj.nil?
+      raise TypeError unless obj.kind_of?(PDF::Writer::State)
+      return self if obj.blank?
+      __push__(obj)
+    end
+
+#   def pop
+#     ret = __pop__
+#     ret
+#   end
+  end
+end

data/lib/pdf/writer/strokestyle.rb

@@ -0,0 +1,138 @@
+#--
+# PDF::Writer for Ruby.
+#   http://rubyforge.org/projects/ruby-pdf/
+#   Copyright 2003 - 2005 Austin Ziegler.
+#
+#   Licensed under a MIT-style licence. See LICENCE in the main distribution
+#   for full licensing information.
+#
+# $Id: strokestyle.rb,v 1.5 2005/06/02 21:20:35 austin Exp $
+#++
+  # A class that represents a style with which lines will be drawn. 
+class PDF::Writer::StrokeStyle
+  LINE_CAPS   = { :butt => 0, :round => 1, :square => 2 }
+  LINE_JOINS  = { :miter => 0, :round => 1, :bevel => 2 }
+  SOLID_LINE  = { :pattern => [], :phase => 0 }
+
+  def initialize(width = 1, options = {})
+    @width        = width
+    @cap          = options[:cap]
+    @join         = options[:join]
+    @dash         = options[:dash]
+    @miter_limit  = options[:miter_limit]
+
+    yield self if block_given?
+  end
+
+  DEFAULT = self.new(1, :cap => :butt, :join => :miter, :dash => SOLID_LINE)
+
+    # The thickness of the line in PDF units.
+  attr_accessor :width
+    # The type of cap to put on the line.
+    #
+    # <tt>:butt</tt>::    The stroke is squared off at the endpoint of the
+    #                     path. There is no projection beyond the end of the
+    #                     path.
+    # <tt>:round</tt>::   A semicircular arc with a diameter equal to the
+    #                     line width is drawn around the endpoint and filled
+    #                     in.
+    # <tt>:square</tt>::  The stroke continues beyond the endpoint of the
+    #                     path for a distance equal to half the line width
+    #                     and is squared off.
+    # +nil+::             Keeps the current line cap.
+  attr_accessor :cap
+  def cap=(c) #:nodoc:
+    if c.nil? or LINE_CAPS.include?(c)
+      @cap = c
+    else
+      raise ArgumentError, "Line cap styles must be nil (none), butt, round, or square."
+    end
+  end
+    # How two lines join together.
+    #
+    # <tt>:miter</tt>::   The outer edges of the strokes for the two
+    #                     segments are extended until they meet at an angle,
+    #                     as in a picture frame. If the segments meet at too
+    #                     sharp an angle (as defined by the #miter_limit), a
+    #                     bevel join is used instead.
+    # <tt>:round</tt>::   An arc of a circle with a diameter equal to the
+    #                     line width is drawn around the point where the two
+    #                     segments meet, connecting the outer edges of the
+    #                     strokes for the two segments. This pie-slice
+    #                     shaped figure is filled in, producing a rounded
+    #                     corner.
+    # <tt>:bevel</tt>::   The two segments are finished with butt caps and
+    #                     the the resulting notch beyond the ends of the
+    #                     segments is filled with a triangle, forming a
+    #                     flattened edge on the join.
+    # +nil+::             Keeps the current line join.
+  attr_accessor :join
+  def join=(j) #:nodoc:
+    if j.nil? or LINE_JOINS.include?(j)
+      @join = j
+    else
+      raise ArgumentError, "Line join styles must be nil (none), miter, round, or bevel."
+    end
+  end
+    # When two line segments meet and <tt>:miter</tt> joins have been
+    # specified, the miter may extend far beyond the thickness of the line
+    # stroking the path. #miter_limit imposes a maximum ratio miter length
+    # to line width at which point the join will be converted from a miter
+    # to a bevel. Adobe points out that the ratio is directly related to the
+    # angle between the segments in user space. With [p] representing the
+    # angle at which the segments meet:
+    #
+    #     miter_length / line_width == 1 / (sin ([p] / 2))
+    #
+    # A miter limit of 1.414 converts miters to bevels for [p] less than 90
+    # degrees, a limit of 2.0 converts them for [p] less than 60 degrees,
+    # and a limit of 10.0 converts them for [p] less than approximately 11.5
+    # degrees. 
+  attr_accessor :miter_limit
+    # Controls the pattern of dashes and gaps used to stroke paths. This
+    # value must either be +nil+, or a hash with the following values:
+    #
+    # <tt>:pattern</tt>:: An array of numbers specifying the lengths (in PDF
+    #                     userspace units) of alternating dashes and gaps.
+    #                     The array is processed cyclically, so that a
+    #                     <tt>:pattern</tt> of [3] represents three units
+    #                     on, three units off, and a <tt>:pattern</tt> of
+    #                     [2, 1] represents two units on, one unit off.
+    #
+    #       # - represents on, _ represents off
+    #     ---___---___---   # pattern [3]
+    #     --_--_--_--_--_   # pattern [2, 1]
+    #
+    # <tt>:phase</tt>::   The offset in the <tt>:pattern</tt> where the
+    #                     drawing of the stroke begins. Using a
+    #                     <tt>:phase</tt> of 1, the <tt>:pattern</tt> [3]
+    #                     will start offset by one phase, for two units on,
+    #                     three units off, three units on.
+    #
+    #     --___---___---_   # pattern [3], phase 1
+    #     -_--_--_--_--_-   # pattern [2, 1], phase 1
+    #
+    # The constant SOLID_LINE may be used to restore line drawing to a solid
+    # line; this corresponds to an empty pattern with zero phase ([] 0).
+    #
+    # Dashed lines wrap around curves and corners just as solid stroked
+    # lines do, with normal cap and join handling with no consideration of
+    # the dash pattern. A path with several subpaths treats each subpath
+    # independently; the complete dash pattern is restarted at the beginning
+    # of each subpath.
+  attr_accessor :dash
+
+  def render(debug = false)
+    s = ""
+    s << "#{width} w" if @width > 0
+    s << " #{LINE_CAPS[@cap]} J" if @cap
+    s << " #{LINE_JOINS[@join]} j" if @join
+    s << " #{@miter_limit} M" if @miter_limit
+    if @dash
+      s << " ["
+      @dash[:pattern].each { |len| s << " #{len}" }
+      s << " ] #{@dash[:phase] or 0} d"
+    end
+    s
+  end
+end