pdf-labels 1.0.0

data/vendor/pdf/writer/object/page.rb

@@ -0,0 +1,195 @@
+#--
+# 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: page.rb,v 1.3 2005/06/02 21:20:35 austin Exp $
+#++
+  # A page object, it also creates a contents object to hold its contents
+class PDF::Writer::Object::Page < PDF::Writer::Object
+    # Create a page. The optional +relative+ is a Hash with keys :pos =>
+    # :before|:after and :rpage, the page to which this new page will be
+    # added relative.
+  def initialize(parent, relative = nil)
+    super(parent)
+
+    @parent.current_page = self
+    @owner = @parent.instance_variable_get('@current_node')
+    @page_number = @parent.pages.size
+    @contents = []
+
+    if relative.nil?
+      @parent.pages << self
+    else
+      relative[:page] = self
+      @parent.pages.add(relative)
+    end
+
+      # make a contents object to go with this page
+    @contents << PDF::Writer::Object::Contents.new(@parent, self)
+    @parent.instance_variable_set('@current_contents', @contents[-1])
+    match = (@parent.pages.size % 2 == 0 ? :even_pages : :odd_pages)
+      # Cheat here. I don't want to add an unnecessary attribute.
+    @parent.instance_variable_get('@add_loose_objects').each do |obj, target|
+      @contents << obj if target == :all_pages or match == target
+    end
+
+    @annotations = []
+
+    @media_box  = nil
+    @crop_box   = nil
+    @bleed_box  = nil
+    @trim_box   = nil
+    @art_box    = nil
+  end
+
+  attr_accessor :contents
+  attr_reader :page_number
+
+  def add_annotation(a)
+    @annotations << a
+  end
+
+  def to_s
+    res = "\n#{@oid} 0 obj\n<< /Type /Page\n/Parent #{@owner.oid} 0 R"
+    unless @annotations.empty?
+      res << "\n/Annots ["
+      @annotations.each { |e| res << " #{e.oid} 0 R"}
+      res << "]"
+    end
+
+    if @contents.size == 1
+      res << "\n/Contents #{@contents[0].oid} 0 R"
+    else
+      res << "\n/Contents [\n"
+      @contents.each { |c| res << "#{c.oid} 0 R\n" }
+      res << "]"
+    end
+
+      # MediaBox::  rectangle (Required; inheritable). A rectangle (see
+      #             Section 3.8.4, �Rectangles�), expressed in default user
+      #             space units, defining the boundaries of the physical
+      #             medium on which the page is intended to be displayed or
+      #             printed (see Section 10.10.1, �Page Boundaries�). 
+    res << "\n/MediaBox [#{@media_box.join(' ')}]" unless @media_box.nil? or @media_box.empty?
+      # CropBox::   rectangle (Optional; inheritable) A rectangle, expressed
+      #             in default user space units, defining the visible region
+      #             of default user space. When the page is displayed or
+      #             printed, its contents are to be clipped (cropped) to
+      #             this rectangle and then imposed on the output medium in
+      #             some implementation-defined manner (see Section 10.10.1,
+      #             �Page Boundaries�). Default value: the value of MediaBox. 
+    res << "\n/CropBox [#{@crop_box.join(' ')}]" unless @crop_box.nil? or @crop_box.empty?
+      # BleedBox::  rectangle (Optional; PDF 1.3) A rectangle, expressed in
+      #             default user space units, defining the region to which
+      #             the contents of the page should be clipped when output
+      #             in a production environment (see Section 10.10.1, �Page
+      #             Boundaries�). Default value: the value of CropBox. 
+    res << "\n/BleedBox [#{@bleed_box.join(' ')}]" unless @bleed_box.nil? or @bleed_box.empty?
+      # TrimBox::   rectangle (Optional; PDF 1.3) A rectangle, expressed in
+      #             default user space units, defining the intended
+      #             dimensions of the finished page after trimming (see
+      #             Section 10.10.1, �Page Boundaries�). Default value: the
+      #             value of CropBox. 
+    res << "\n/TrimBox [#{@trim_box.join(' ')}]" unless @trim_box.nil? or @trim_box.empty?
+      # ArtBox::    rectangle (Optional; PDF 1.3) A rectangle, expressed in
+      #             default user space units, defining the extent of the
+      #             page�s meaningful content (including potential white
+      #             space) as intended by the page�s creator (see Section
+      #             10.10.1, �Page Boundaries�). Default value: the value of
+      #             CropBox. 
+    res << "\n/ArtBox [#{@art_box.join(' ')}]" unless @art_box.nil? or @art_box.empty?
+
+    res << "\n>>\nendobj"
+  end
+end
+
+  # BoxColorInfo::  dictionary (Optional; PDF 1.4) A box color information
+  #                 dictionary specifying the colors and other visual
+  #                 characteristics to be used in displaying guidelines on
+  #                 the screen for the various page boundaries (see �Display
+  #                 of Page Boundaries� on page 893). If this entry is
+  #                 absent, the application should use its own current
+  #                 default settings. 
+  #
+  # Rotate::        integer (Optional; inheritable) The number of degrees by
+  #                 which the page should be rotated clockwise when
+  #                 displayed or printed. The value must be a multiple of
+  #                 90. Default value: 0. 
+  # Group::         dictionary (Optional; PDF 1.4) A group attributes
+  #                 dictionary specifying the attributes of the page�s page
+  #                 group for use in the transparent imaging model (see
+  #                 Sections 7.3.6, �Page Group,� and 7.5.5, �Transparency
+  #                 Group XObjects�). 
+  # Thumb::         stream (Optional) A stream object defining the page�s
+  #                 thumbnail image (see Section 8.2.3, �Thumbnail Images�). 
+  # B::             array (Optional; PDF 1.1; recommended if the page
+  #                 contains article beads) An array of indirect references
+  #                 to article beads appearing on the page (see Section
+  #                 8.3.2, �Articles�; see also implementation note 37 in
+  #                 Appendix H). The beads are listed in the array in
+  #                 natural reading order. 
+  # Dur::           number (Optional; PDF 1.1) The page�s display duration
+  #                 (also called its advance timing): the maximum length of
+  #                 time, in seconds, that the page is displayed during
+  #                 presentations before the viewer application
+  #                 automatically advances to the next page (see Section
+  #                 8.3.3, �Presentations�). By default, the viewer does not
+  #                 advance automatically. 
+  # Trans::         dictionary (Optional; PDF 1.1) A transition dictionary
+  #                 describing the transition effect to be used when
+  #                 displaying the page during presentations (see Section
+  #                 8.3.3, �Presentations�). 
+  # Annots::        array (Optional) An array of annotation dictionaries
+  #                 representing annotations associated with the page (see
+  #                 Section 8.4, �Annotations�). 
+  # AA::            dictionary (Optional; PDF 1.2) An additional-actions
+  #                 dictionary defining actions to be performed when the
+  #                 page is opened or closed (see Section 8.5.2, �Trigger
+  #                 Events�; see also implementation note 38 in Appendix H). 
+  # Metadata::      stream (Optional; PDF 1.4) A metadata stream containing
+  #                 metadata for the page (see Section 10.2.2, �Metadata
+  #                 Streams�). 
+  # PieceInfo::     dictionary (Optional; PDF 1.3) A page-piece dictionary
+  #                 associated with the page (see Section 10.4, �Page-Piece
+  #                 Dictionaries�). 
+  # StructParents:: integer (Required if the page contains structural
+  #                 content items; PDF 1.3) The integer key of the page�s
+  #                 entry in the structural parent tree (see �Finding
+  #                 Structure Elements from Content Items� on page 797). 
+  # ID::            string (Optional; PDF 1.3; indirect reference preferred)
+  #                 The digital identifier of the page�s parent Web Capture
+  #                 content set (see Section 10.9.5, �Object Attributes
+  #                 Related to Web Capture�). 
+  # PZ::            number (Optional; PDF 1.3) The page�s preferred zoom
+  #                 (magnification) factor: the factor by which it should be
+  #                 scaled to achieve the natural display magnification (see
+  #                 Section 10.9.5, �Object Attributes Related to Web
+  #                 Capture�). 
+  # SeparationInfo::  dictionary (Optional; PDF 1.3) A separation dictionary
+  #                   containing information needed to generate color
+  #                   separations for the page (see Section 10.10.3,
+  #                   �Separation Dictionaries�). 
+  # Tabs::          name (Optional; PDF 1.5) A name specifying the tab order
+  #                 to be used for annotations on the page. The possible
+  #                 values are R (row order), C (column order), and S
+  #                 (structure order). See Section 8.4, �Annotations,� for
+  #                 details.
+  # TemplateInstantiated::  name (Required if this page was created from a
+  #                         named page object; PDF 1.5) The name of the
+  #                         originating page object (see Section 8.6.5,
+  #                         �Named Pages�). 
+  # PresSteps::     dictionary (Optional; PDF 1.5) A navigation node
+  #                 dictionary representing the first node on the page (see
+  #                 �Sub-page Navigation� on page 566).
+  # UserUnit::      number (Optional; PDF 1.6) A positive number giving the
+  #                 size of default user space units, in multiples of 1/72
+  #                 inch. The range of supported values is
+  #                 implementation-dependent; see implementation note 171 in
+  #                 Appendix H. Default value: 1.0 (user unit is 1/72 inch).
+  # VP::            dictionary (Optional; PDF 1.6) An array of viewport
+  #                 dictionaries (see Table 8.105) specifying rectangular
+  #                 regions of the page.

data/vendor/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/vendor/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/vendor/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/vendor/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