################################################################################
#
# Copyright (C) 2006 Peter J Jones (pjones@pmade.com)
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
# 
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
# 
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
#
################################################################################

require 'stringio'

module PDF
  ################################################################################
  # The Reader class serves as an entry point for parsing a PDF file. There are three
  # ways to kick off processing - which one you pick will be based on personal preference
  # and the situation.
  #
  # For all examples, assume the receiver variable contains an object that will respond
  # to various callbacks. Refer to the README and PDF::Reader::Content for more information
  # on receivers.
  #
  # = Parsing a file
  #   
  #   PDF::Reader.file("somefile.pdf", receiver)
  #
  # = Parsing a String
  # 
  # This is useful for processing a PDF that is already in memory
  #
  #   PDF::Reader.string("somefile.pdf", receiver)
  #
  # = Parsing an IO object
  # 
  # This can be a useful alternative to the first 2 options in some situations
  #
  #   pdf = PDF::Reader.new
  #   pdf.parse(File.new("somefile.pdf"), receiver)
  class Reader
    ################################################################################
    # Parse the file with the given name, sending events to the given receiver.
    def self.file (name, receiver)
      File.open(name,"rb") do |f|
        new.parse(f, receiver)
      end
    end
    ################################################################################
    # Parse the given string, sending events to the given receiver.
    def self.string (str, receiver)
      StringIO.open(str) do |s|
        new.parse(s, receiver)
      end
    end
    ################################################################################
  end
  ################################################################################
end
################################################################################
require 'pdf/reader/explore'
require 'pdf/reader/buffer'
require 'pdf/reader/content'
require 'pdf/reader/error'
require 'pdf/reader/filter'
require 'pdf/reader/name'
require 'pdf/reader/parser'
require 'pdf/reader/reference'
require 'pdf/reader/register_receiver'
require 'pdf/reader/text_receiver'
require 'pdf/reader/token'
require 'pdf/reader/xref'


class PDF::Reader
  ################################################################################
  # Initialize a new PDF::Reader
  def initialize
  end
  ################################################################################
  # Given an IO object that contains PDF data, parse it.
  def parse (io, receiver)
    @buffer   = Buffer.new(io)
    @xref     = XRef.new(@buffer)
    @parser   = Parser.new(@buffer, @xref)
    @content  = (receiver == Explore ? Explore : Content).new(receiver, @xref)

    trailer = @xref.load
    @content.document(@xref.object(trailer['Root'])) || self
  end
  ################################################################################
end
################################################################################