pdf-reader 0.5

data/lib/pdf/reader/content.rb

@@ -0,0 +1,289 @@
+################################################################################
+#
+# 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'
+
+class PDF::Reader
+  ################################################################################
+  # Walks the PDF file and calls the appropriate callback methods when something of interest is
+  # found. 
+  #
+  # The callback methods should exist on the receiver object passed into the constructor. Whenever
+  # some content is found that will trigger a callback, the receiver is checked to see if the callback 
+  # is defined.
+  #
+  # If it is defined it will be called. If not, processing will continue.
+  #
+  # = Available Callbacks
+  # The following callbacks are available and should be methods defined on your receiver class. Only 
+  # implement the ones you need - the rest will be ignored.
+  #
+  # Some callbacks will include parameters which will be passed in as an array. For callbacks that supply no
+  # paramters, or where you don't need them, the *params argument can be left off. Some example callback 
+  # method definitions are:
+  #
+  #   def begin_document
+  #   def end_page
+  #   def show_text(string, *params)
+  #   def fill_stroke(*params)
+  #
+  # You should be able to infer the basic command the callback is reporting based on the name. For
+  # further experimentation, define the callback with just a *params parameter, then print out the 
+  # contents of the array using something like:
+  #
+  #   puts params.inspect
+  #
+  # == Text Callbacks
+  # - end_text_object
+  # - move_to_start_of_next_line
+  # - set_character_spacing
+  # - move_text_position
+  # - move_text_position_and_set_leading
+  # - set_text_font_and_size
+  # - show_text
+  # - show_text_with_positioning
+  # - set_text_leading
+  # - set_text_matrix_and_text_line_matrix
+  # - set_text_rendering_mode
+  # - set_text_rise
+  # - set_word_spacing
+  # - set_horizontal_text_scaling
+  # - move_to_next_line_and_show_text
+  # - set_spacing_next_line_show_text
+  #
+  # == Graphics Callbacks
+  # - close_fill_stroke
+  # - fill_stroke
+  # - close_fill_stroke_with_even_odd
+  # - fill_stroke_with_even_odd
+  # - begin_marked_content_with_pl
+  # - begin_inline_image
+  # - begin_marked_content
+  # - begin_text_object
+  # - append_curved_segment
+  # - concatenate_matrix
+  # - set_stroke_color_space
+  # - set_nonstroke_color_space
+  # - set_line_dash
+  # - set_glyph_width
+  # - set_glyph_width_and_bounding_box
+  # - invoke_xobject
+  # - define_marked_content_with_pl
+  # - end_inline_image
+  # - end_marked_content
+  # - fill_path_with_nonzero
+  # - fill_path_with_nonzero
+  # - fill_path_with_even_odd
+  # - set_gray_for_stroking
+  # - set_gray_for_nonstroking
+  # - set_graphics_state_parameters
+  # - close_subpath
+  # - set_flatness_tolerance
+  # - begin_inline_image_data
+  # - set_line_join_style
+  # - set_line_cap_style
+  # - set_cmyk_color_for_stroking,
+  # - set_cmyk_color_for_nonstroking
+  # - append_line
+  # - begin_new_subpath
+  # - set_miter_limit
+  # - define_marked_content_point
+  # - end_path
+  # - save_graphics_state
+  # - restore_graphics_state
+  # - append_rectangle
+  # - set_rgb_color_for_stroking
+  # - set_rgb_color_for_nonstroking
+  # - set_color_rendering_intent
+  # - close_and_stroke_path
+  # - stroke_path
+  # - set_color_for_stroking
+  # - set_color_for_nonstroking
+  # - set_color_for_stroking_and_special
+  # - set_color_for_nonstroking_and_special
+  # - paint_area_with_shading_pattern
+  # - append_curved_segment_initial_point_replicated
+  # - set_line_width
+  # - set_clipping_path_with_nonzero
+  # - set_clipping_path_with_even_odd
+  # - append_curved_segment_final_point_replicated
+  #
+  # == Misc Callbacks
+  # - begin_compatibility_section
+  # - end_compatibility_section,
+  # - begin_document
+  # - end_document
+  # - begin_page_container
+  # - end_page_container
+  # - begin_page
+  # - end_page
+  class Content
+    OPERATORS = {
+      'b'   => :close_fill_stroke,
+      'B'   => :fill_stroke,
+      'b*'  => :close_fill_stroke_with_even_odd,
+      'B*'  => :fill_stroke_with_even_odd,
+      'BDC' => :begin_marked_content_with_pl,
+      'BI'  => :begin_inline_image,
+      'BMC' => :begin_marked_content,
+      'BT'  => :begin_text_object,
+      'BX'  => :begin_compatibility_section,
+      'c'   => :append_curved_segment,
+      'cm'  => :concatenate_matrix,
+      'CS'  => :set_stroke_color_space,
+      'cs'  => :set_nonstroke_color_space,
+      'd'   => :set_line_dash,
+      'd0'  => :set_glyph_width,
+      'd1'  => :set_glyph_width_and_bounding_box,
+      'Do'  => :invoke_xobject,
+      'DP'  => :define_marked_content_with_pl,
+      'EI'  => :end_inline_image,
+      'EMC' => :end_marked_content,
+      'ET'  => :end_text_object,
+      'EX'  => :end_compatibility_section,
+      'f'   => :fill_path_with_nonzero,
+      'F'   => :fill_path_with_nonzero,
+      'f*'  => :fill_path_with_even_odd,
+      'G'   => :set_gray_for_stroking,
+      'g'   => :set_gray_for_nonstroking,
+      'gs'  => :set_graphics_state_parameters,
+      'h'   => :close_subpath,
+      'i'   => :set_flatness_tolerance,
+      'ID'  => :begin_inline_image_data,
+      'j'   => :set_line_join_style,
+      'J'   => :set_line_cap_style,
+      'K'   => :set_cmyk_color_for_stroking,
+      'k'   => :set_cmyk_color_for_nonstroking,
+      'l'   => :append_line,
+      'm'   => :begin_new_subpath,
+      'M'   => :set_miter_limit,
+      'MP'  => :define_marked_content_point,
+      'n'   => :end_path,
+      'q'   => :save_graphics_state,
+      'Q'   => :restore_graphics_state,
+      're'  => :append_rectangle,
+      'RG'  => :set_rgb_color_for_stroking,
+      'rg'  => :set_rgb_color_for_nonstroking,
+      'ri'  => :set_color_rendering_intent,
+      's'   => :close_and_stroke_path,
+      'S'   => :stroke_path,
+      'SC'  => :set_color_for_stroking,
+      'sc'  => :set_color_for_nonstroking,
+      'SCN' => :set_color_for_stroking_and_special,
+      'scn' => :set_color_for_nonstroking_and_special,
+      'sh'  => :paint_area_with_shading_pattern,
+      'T*'  => :move_to_start_of_next_line,
+      'Tc'  => :set_character_spacing,
+      'Td'  => :move_text_position,
+      'TD'  => :move_text_position_and_set_leading,
+      'Tf'  => :set_text_font_and_size,
+      'Tj'  => :show_text,
+      'TJ'  => :show_text_with_positioning,
+      'TL'  => :set_text_leading,
+      'Tm'  => :set_text_matrix_and_text_line_matrix,
+      'Tr'  => :set_text_rendering_mode,
+      'Ts'  => :set_text_rise,
+      'Tw'  => :set_word_spacing,
+      'Tz'  => :set_horizontal_text_scaling,
+      'v'   => :append_curved_segment_initial_point_replicated,
+      'w'   => :set_line_width,
+      'W'   => :set_clipping_path_with_nonzero,
+      'W*'  => :set_clipping_path_with_even_odd,
+      'y'   => :append_curved_segment_final_point_replicated,
+      '\''  => :move_to_next_line_and_show_text,
+      '"'   => :set_spacing_next_line_show_text,
+    }
+    ################################################################################
+    # Create a new PDF::Reader::Content object to process the contents of PDF file
+    # - receiver - an object containing the required callback methods
+    # - xref     - a PDF::Reader::Xref object that contains references to all the objects in a PDF file
+    def initialize (receiver, xref)
+      @receiver = receiver
+      @xref     = xref
+    end
+    ################################################################################
+    # Begin processing the document
+    def document (root)
+      callback(:begin_document, [root])
+      walk_pages(@xref.object(root['Pages']))
+      callback(:end_document)
+    end
+    ################################################################################
+    # Walk over all pages in the PDF file, calling the appropriate callbacks for each page and all 
+    # its content
+    def walk_pages (page)
+      if page['Type'] == "Pages"
+        callback(:begin_page_container, [page])
+        page['Kids'].each {|child| walk_pages(@xref.object(child))}
+        callback(:end_page_container)
+      elsif page['Type'] == "Page"
+        callback(:begin_page, [page])
+        @page = page
+        @params = []
+
+        page['Contents'].to_a.each do |cstream|
+          content_stream(@xref.object(cstream))
+        end if page.has_key?('Contents') and page['Contents']
+
+        callback(:end_page)
+      end
+    end
+    ################################################################################
+    # Reads a PDF content stream and calls all the appropriate callback methods for the operators
+    # it contains
+    def content_stream (instructions)
+      @buffer = Buffer.new(StringIO.new(instructions))
+      @parser = Parser.new(@buffer, @xref)
+      @params = [] if @params.nil?
+
+      until @buffer.eof?
+        loop do
+          token = @parser.parse_token(OPERATORS)
+
+          if token.kind_of?(Token) and OPERATORS.has_key?(token) 
+            resolve_resources
+            callback(OPERATORS[token], @params)
+            @params.clear
+            break
+          end
+
+          @params << token
+        end
+      end
+    rescue EOFError => e
+    end
+    ################################################################################
+    def resolve_resources
+      # FIXME TODO
+    end
+    ################################################################################
+    # calls the name callback method on the receiver class with params as the arguments
+    def callback (name, params=[])
+      @receiver.send(name, *params) if @receiver.respond_to?(name)
+    end
+    ################################################################################
+  end
+  ################################################################################
+end
+################################################################################

data/lib/pdf/reader/error.rb

@@ -0,0 +1,53 @@
+################################################################################
+#
+# 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.
+#
+
+
+class PDF::Reader
+  ################################################################################
+  # An internal PDF::Reader class that helps to verify various parts of the PDF file
+  # are valid
+  class Error
+    ################################################################################
+    def self.str_assert (lvalue, rvalue, chars=nil)
+      raise MalformedPDFError, "PDF malformed, expected string but found #{lvalue.class} instead" if chars and !lvalue.kind_of?(String)
+      lvalue = lvalue[0,chars] if chars
+      raise MalformedPDFError, "PDF malformed, expected '#{rvalue}' but found #{lvalue} instead"  if lvalue != rvalue
+    end
+    ################################################################################
+    def self.str_assert_not (lvalue, rvalue, chars=nil)
+      raise MalformedPDFError, "PDF malformed, expected string but found #{lvalue.class} instead" if chars and !lvalue.kind_of?(String)
+      lvalue = lvalue[0,chars] if chars
+      raise MalformedPDFError, "PDF malformed, expected '#{rvalue}' but found #{lvalue} instead"  if lvalue == rvalue
+    end
+    ################################################################################
+    def self.assert_equal (lvalue, rvalue)
+      raise MalformedPDFError, "PDF malformed, expected #{rvalue} but found #{lvalue} instead" if lvalue != rvalue
+    end
+    ################################################################################
+  end
+  ################################################################################
+  class MalformedPDFError < RuntimeError; end
+  class UnsupportedFeatureError < RuntimeError; end
+end
+################################################################################

data/lib/pdf/reader/explore.rb

@@ -0,0 +1,116 @@
+################################################################################
+#
+# 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 'pathname'
+
+
+class PDF::Reader
+  ################################################################################
+  class Explore
+    ################################################################################
+    def self.file (name)
+      PDF::Reader.new.parse(File.open(name), self)
+    end
+    ################################################################################
+    def initialize (receiver, xref)
+      @xref = xref
+      @pwd  = '/'
+    end
+    ################################################################################
+    def document (root)
+      @root = root
+      self
+    end
+    ################################################################################
+    def output_parent (obj)
+      case obj
+      when Hash
+        obj.each do |k,v| 
+          print "#{k}"; output_child(v); print "\n"
+          Explore::const_set(k, k) if !Explore.const_defined?(k)
+        end
+      when Array
+        obj.each_with_index {|o, i| print "#{i}: "; output_child(o); print "\n"}
+      else
+        output_child(obj)
+        print "\n"
+      end
+    end
+    ################################################################################
+    def output_child (obj)
+      print ": #{obj.class}"
+
+      case obj
+      when Float
+        print ": #{obj}"
+      when String
+        print ": #{obj[0, 20].sub(/\n/, ' ')}"
+      end
+    end
+    ################################################################################
+    def cd (path)
+      path = path.to_s
+
+      if path[0,1] == "/"
+        @pwd = path
+      else
+        @pwd = Pathname.new(@pwd + '/' + path).cleanpath.to_s
+      end
+    end
+    ################################################################################
+    def pwd
+      @pwd
+    end
+    ################################################################################
+    def ls (entry = nil)
+      parts = @pwd.split('/')
+      obj   = @root
+
+      parts.shift if parts[0] == ""
+      parts.push(entry) if entry
+
+      parts.each do |p|
+        case obj
+        when Hash
+          unless obj.has_key?(p)
+            puts "invalid path at #{p}"
+            return
+          end
+          obj = obj[p]
+
+        when Array
+          obj = obj[p.to_i]
+        end
+
+        obj = @xref.object(obj) if obj.kind_of?(Reference)
+      end
+
+      output_parent(obj)
+      "#{@pwd}: #{obj.class}"
+    end
+    ################################################################################
+  end
+  ################################################################################
+end
+################################################################################