Class: PDF::Reader::XRef

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/pdf/reader/xref.rb

Overview

An internal PDF::Reader class that represents the XRef table in a PDF file as a hash-like object.

An Xref table is a map of object identifiers and byte offsets. Any time a particular object needs to be found, the Xref table is used to find where it is stored in the file.

Hash keys are object ids, values are either:

  • a byte offset where the object starts (regular PDF objects)

  • a PDF::Reader::Reference instance that points to a stream that contains the desired object (PDF objects embedded in an object stream)

The class behaves much like a standard Ruby hash, including the use of the Enumerable mixin. The key difference is no []= method - the hash is read only.

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (XRef) initialize(io)

create a new Xref table based on the contents of the supplied io object

io - must be an IO object, generally either a file or a StringIO



56
57
58
59
60
61
# File 'lib/pdf/reader/xref.rb', line 56

def initialize (io)
  @io = io
  @junk_offset = calc_junk_offset(io) || 0
  @xref = {}
  @trailer = load_offsets
end

Instance Attribute Details

- (Object) trailer (readonly)

Returns the value of attribute trailer



49
50
51
# File 'lib/pdf/reader/xref.rb', line 49

def trailer
  @trailer
end

Instance Method Details

- (Object) [](ref)

returns the byte offset for the specified PDF object.

ref - a PDF::Reader::Reference object containing an object ID and revision number



73
74
75
76
77
# File 'lib/pdf/reader/xref.rb', line 73

def [](ref)
  @xref[ref.id][ref.gen]
rescue
  raise InvalidObjectError, "Object #{ref.id}, Generation #{ref.gen} is invalid"
end

- (Object) each(&block)

iterate over each object in the xref table



80
81
82
83
84
85
86
# File 'lib/pdf/reader/xref.rb', line 80

def each(&block)
  ids = @xref.keys.sort
  ids.each do |id|
    gen = @xref[id].keys.sort[-1]
    yield PDF::Reader::Reference.new(id, gen)
  end
end

- (Object) size

return the number of objects in this file. Objects with multiple generations are only counter once.



66
67
68
# File 'lib/pdf/reader/xref.rb', line 66

def size
  @xref.size
end