pdf-writer 1.0.0

data/lib/pdf/writer/object.rb

@@ -0,0 +1,23 @@
+#--
+# 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: object.rb,v 1.3 2005/05/25 11:19:50 austin Exp $
+#++
+class PDF::Writer::Object
+  def initialize(parent)
+    @parent = parent
+    @oid    = @parent.__send__(:generate_id)
+    @parent.objects << self
+  end
+      
+  attr_reader :oid
+end
+
+class PDF::Writer::External < PDF::Writer::Object; end
+
+class PDF::Writer::Complex < PDF::Writer::Object; end

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

@@ -0,0 +1,40 @@
+#--
+# 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: action.rb,v 1.5 2005/05/24 22:19:42 austin Exp $
+#++
+  # An action object, used to link to URLS initially
+class PDF::Writer::Object::Action < PDF::Writer::Object
+  def initialize(parent, label, type = "URI")
+    super(parent)
+
+    @type   = type
+    @label  = label
+    raise TypeError if @label.nil?
+  end
+
+  attr_accessor :type
+  attr_accessor :label
+
+  def to_s
+    @parent.arc4.prepare(self) if @parent.encrypted?
+    res = "\n#{@oid} 0 obj\n<< /Type /Action"
+    if @type == :ilink
+      res << "\n/S /GoTo\n/D #{@parent.destinations[@label].oid} 0 R"
+    elsif @type == 'URI'
+      res << "\n/S /URI\n/URI ("
+      if @parent.encrypted?
+        res << PDF::Writer.escape(@parent.arc4.encrypt(@label))
+      else
+        res << PDF::Writer.escape(@label)
+      end
+      res << ")\n"
+    end
+    res << ">>\nendobj"
+  end
+end

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

@@ -0,0 +1,42 @@
+#--
+# 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: annotation.rb,v 1.2 2005/05/16 03:59:21 austin Exp $
+#++
+  # An annotation object, this will add an annotation to the current page.
+  # initially will support just link annotations.
+class PDF::Writer::Object::Annotation < PDF::Writer::Object
+  TYPES = [:link, :ilink]
+
+  def initialize(parent, type, rect, label)
+    super(parent)
+
+    @type = type
+    @rect = rect
+
+    case @type
+    when :link
+      @action = PDF::Writer::Object::Action.new(parent, label)
+    when :ilink
+      @action = PDF::Writer::Object::Action.new(parent, label, type)
+    end
+    parent.current_page.add_annotation(self)
+  end
+
+  attr_accessor :type
+  attr_accessor :action
+  attr_accessor :rect
+
+  def to_s
+    res = "\n#{@oid} 0 obj\n<< /Type /Annot"
+    res << "\n/Subtype /Link" if TYPES.include?(@type)
+    res << "\n/A #{@action.oid} 0 R\n/Border [0 0 0]\n/H /I\n/Rect ["
+    @rect.each { |v| res << "%.4f " % v }
+    res << "]\n>>\nendobj"
+  end
+end

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

@@ -0,0 +1,39 @@
+#--
+# 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: catalog.rb,v 1.2 2005/05/16 03:59:21 austin Exp $
+#++
+  # Define the document catalog, the overall controller for the document
+class PDF::Writer::Object::Catalog < PDF::Writer::Object
+  def initialize(parent)
+    super(parent)
+
+    @outlines           = nil
+    @pages              = nil
+    @open_here          = nil
+    @viewer_preferences  = nil
+    @page_mode          = nil
+  end
+
+  attr_accessor :outlines
+  attr_accessor :pages
+  attr_accessor :open_here
+  attr_accessor :viewer_preferences
+  attr_accessor :page_mode
+
+  def to_s
+    res = "\n#{@oid} 0 obj\n<< /Type /Catalog"
+    res << "\n/Outlines #{@outlines.oid} 0 R" unless @outlines.nil?
+    res << "\n/Pages #{@pages.oid} 0 R" unless @pages.nil?
+    res << "\n/ViewerPreferences #{@viewer_preferences.oid} 0 R" if @viewer_preferences and @parent.version >= '1.2'
+    res << "\n/OpenAction #{@open_here.oid} 0 R" unless @open_here.nil?
+    res << "\n/PageMode /#{@page_mode}" unless @page_mode.nil?
+    res << "\n/Version /#{@parent.version}" if @parent.version >= '1.4'
+    res << ">>\nendobj"
+  end
+end

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

@@ -0,0 +1,68 @@
+#--
+# 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: contents.rb,v 1.2 2005/05/16 03:59:21 austin Exp $
+#++
+  # The contents objects hold all of the content which appears on pages
+class PDF::Writer::Object::Contents < PDF::Writer::Object
+  def initialize(parent, page = nil)
+    super(parent)
+
+    @data = ""
+    @info = {}
+    @raw = false
+    @on_page = nil
+
+    if page.kind_of?(PDF::Writer::Object::Page)
+      @on_page = page
+    elsif page == :raw
+      @raw = true
+    end
+  end
+
+  attr_reader :on_page
+
+  def size
+    @data.size
+  end
+
+  def each
+    @contents.each { |c| yield c }
+  end
+
+  def <<(v)
+    raise TypeError unless v.kind_of?(PDF::Writer::Object) or v.kind_of?(String)
+    @data << v
+  end
+
+  def add(a)
+    a.each { |k, v| @info[k] = v }
+  end
+
+  def to_s
+    tmp = @data.dup
+    res = "\n#{@oid} 0 obj\n"
+    if @raw
+      res << tmp
+    else
+      res << "<<"
+      if PDF::Writer::Compression and @parent.compressed?
+        res << " /Filter /FlateDecode"
+        tmp = Zlib::Deflate.deflate(tmp)
+      end
+      if (@parent.encrypted?)
+        @parent.arc4.prepare(self)
+        tmp = @parent.arc4.encrypt(tmp)
+      end
+      @info.each { |k, v| res << "\n/#{k} #{v}" }
+      res << "\n/Length #{tmp.size} >>\nstream\n#{tmp}\nendstream"
+    end
+    res << "\nendobj\n"
+    res
+  end
+end

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

@@ -0,0 +1,40 @@
+#--
+# 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: destination.rb,v 1.2 2005/05/16 03:59:21 austin Exp $
+#++
+  # Destination object, used to specify the location for the user to jump
+  # to; presently, only on opening.
+class PDF::Writer::Object::Destination < PDF::Writer::Object
+  def initialize(parent, page, type, *params)
+    super(parent)
+
+    case type
+    when "FitR"
+      raise TypeError if params.size < 4
+      @string = "/#{type} #{params[0..3].join(' ')}"
+    when "XYZ"
+      params = (params + [ "null" ] * 4).first(4)
+      @string = "/#{type} #{params[0..2].join(' ')}"
+    when "FitH", "FitV", "FitBH", "FitBV"
+      raise TypeError if params.empty?
+      @string = "/#{type} #{params[0]}"
+    when "Fit", "FitB"
+      @string = "/#{type}"
+    end
+
+    @page = page
+  end
+
+  attr_accessor :string
+  attr_accessor :page
+
+  def to_s
+    "\n#{@oid} 0 obj\n[#{@page.oid} 0 R #{@string}]\nendobj\n"
+  end
+end

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

@@ -0,0 +1,53 @@
+#--
+# 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: encryption.rb,v 1.2 2005/05/16 03:59:21 austin Exp $
+#++
+  # Encryption object
+class PDF::Writer::Object::Encryption < PDF::Writer::Object
+  PAD = [ 0x28, 0xBF, 0x4E, 0x5E, 0x4E, 0x75, 0x8A, 0x41,
+          0x64, 0x00, 0x4E, 0x56, 0xFF, 0xFA, 0x01, 0x08,
+          0x2E, 0x2E, 0x00, 0xB6, 0xD0, 0x68, 0x3E, 0x80,
+          0x2F, 0x0C, 0xA9, 0xFE, 0x64, 0x53, 0x69, 0x7A ].pack("C*")
+
+  def initialize(parent, options)
+    super(parent)
+
+    @parent.encrypt_obj = self
+
+      # Figure out the additional parameters required.
+    @owner  = "#{options[:owner_pass]}#{PAD}"[0...32]
+    @user   = "#{options[:user_pass]}#{PAD}"[0...32]
+    @perms  = options[:permissions]
+
+    @parent.arc4.prepare(Digest::MD5.hexdigest(@owner)[0...5])
+
+      # Get the 'O' value.
+    @owner_info = ARC4.encrypt(@user)
+      # Get the 'U' value.
+    ukey = @user.dup
+    ukey << @owner_info
+    ukey << [ @perms, 0xFF, 0xFF, 0xFF ].pack("C*")
+    ukey << @parent.file_identifier
+    @parent.encryption_key = Digest::MD5.hexdigest(ukey)[0...5]
+
+    @parent.arc4.prepare(@parent.encryption_key)
+
+    @user_info = @parent.arc4.encrypt(PAD)
+  end
+
+  def to_s
+    res = "\n#{@oid} 0 obj\n<<\n/Filter /Standard\n"
+    res << "/V 1\n/R 2\n"
+    res << "/O (#{PDF::Writer.escape(@owner_info)})\n"
+    res << "/U (#{PDF::Writer.escape(@user_info)})\n"
+    res << "/P #{(((@perms ^ 255) + 1) * -1)}\n"
+    res << ">>\nendobj\n"
+    res
+  end
+end

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

@@ -0,0 +1,76 @@
+#--
+# 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: font.rb,v 1.3 2005/05/25 11:19:50 austin Exp $
+#++
+  # An object to hold the font description
+class PDF::Writer::Object::Font < PDF::Writer::Object
+  Details = %w{FirstChar LastChar Widths FontDescriptor SubType}
+
+  def initialize(parent, name, encoding = 'WinAnsiEncoding', subtype = 'Type1')
+    super(parent)
+
+    @name     = name
+    @subtype  = subtype
+    @encoding = encoding
+
+    @font_id  = @parent.__send__(:generate_font_id)
+
+    if encoding.kind_of?(PDF::Writer::Object::FontEncoding)
+      @encoding = nil
+      @encodingDictionary = encoding
+    elsif encoding == 'none' or encoding.nil?
+      @encoding = nil
+    end
+
+    @parent.pages << self
+
+    @encodingDictionary = nil
+    @firstchar          = nil
+    @lastchar           = nil
+    @widths             = nil
+    @fontdescriptor     = nil
+  end
+
+  attr_reader :font_id
+  attr_accessor :subtype
+    # Valid values: WinAnsiEncoding, MacRomanEncoding, MacExpertEncoding,
+    # none, +nil+
+  attr_accessor :encoding
+  attr_reader :encodingDictionary
+  def encodingDictionary=(ed)
+    @encodingDictionary = ed
+  end
+
+  def basefont
+    @name
+  end
+
+  def basefont=(b)
+    @name = basefont
+  end
+
+  Details.each do |d|
+    attr_accessor d.downcase.intern
+  end
+
+  def to_s
+    res = "\n#{@oid} 0 obj\n<< /Type /Font\n/Subtype /#{@subtype}\n"
+    res << "/Name /F#{@font_id}\n/BaseFont /#{@name}\n"
+    if @encodingDictionary.nil?
+      res << "/Encoding /#{@encoding}\n"
+    else
+      res << "/Encoding #{@encodingDictionary.oid} 0 R\n"
+    end
+    res << "/FirstChar #{@firstchar}\n" unless @firstchar.nil?
+    res << "/LastChar #{@lastchar}\n" unless @lastchar.nil?
+    res << "/Widths #{@widths} 0 R\n" unless @widths.nil?
+    res << "/FontDescriptor #{@fontdescriptor} 0 R\n" unless @fontdescriptor.nil?
+    res << ">>\nendobj"
+  end
+end

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

@@ -0,0 +1,34 @@
+#--
+# 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: fontdescriptor.rb,v 1.2 2005/05/16 03:59:21 austin Exp $
+#++
+  # A font descriptor, needed for including additional fonts. +options+ is a
+  # Hash with one of the following keys: Ascent, CapHeight, Descent, Flags,
+  # ItalicAngle, StemV, AvgWidth, Leading, MaxWidth, MissingWidth, StemH,
+  # XHeight, CharSet, FontFile, FontFile2, FontFile3, FontBBox, or FontName.
+class PDF::Writer::Object::FontDescriptor < PDF::Writer::Object
+  def initialize(parent, options = nil)
+    super(parent)
+
+    @options = options
+  end
+
+  attr_accessor :options
+
+  def to_s
+    res = "\n#{@oid} 0 obj\n<< /Type /FontDescriptor\n"
+    @options.each do |k, v|
+      res << "/#{k} #{v}\n" if %w{Ascent CapHeight Descent Flags ItalicAngle StemV AvgWidth Leading MaxWidth MissingWidth StemH XHeight CharSet}.include?(k)
+      res << "/#{k} #{v} 0 R\n" if %w{FontFile FontFile2 FontFile3}.include?(k)
+      res << "/#{k} [#{v.join(' ')}]\n" if k == "FontBBox"
+      res << "/#{k} /#{v}\n" if k == "FontName"
+    end
+    res << "\n>>\nendobj"
+  end
+end

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

@@ -0,0 +1,39 @@
+#--
+# 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: fontencoding.rb,v 1.2 2005/05/16 03:59:21 austin Exp $
+#++
+  # The font encoding
+class PDF::Writer::Object::FontEncoding < PDF::Writer::Object
+  def initialize(parent, encoding, differences)
+    super(parent)
+
+    @differences  = differences
+    @encoding     = encoding
+  end
+
+  attr_accessor :differences
+  attr_accessor :encoding
+
+  def to_s
+    res = "\n#{@oid} 0 obj\n<< /Type /Encoding\n"
+    enc = @encoding || 'WinAnsiEncoding'
+    res << "/BaseEncoding /#{enc}\n" unless enc == 'none'
+    res << "/Differences \n["
+    n = -100
+    differences.each do |k, v|
+      if k != (n + 1)
+        res << "\n#{k} /#{v}" # Cannot make use of consecutive numbering
+      else
+        res << " /#{v}"
+      end
+      n = k
+    end
+    res << "\n]\n>>\nendobj"
+  end
+end