Class: PDF::Reader::Page

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/pdf/reader/page.rb

Overview

high level representation of a single PDF page. Ties together the various low level classes in PDF::Reader and provides access to the various components of the page (text, images, fonts, etc) in convenient formats.

If you require access to the raw PDF objects for this page, you can access the Page dictionary via the page_object accessor. You will need to use the objects accessor to help walk the page dictionary in any useful way.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(objects, pagenum, options = {}) ⇒ Page

creates a new page wrapper.

  • objects - an ObjectHash instance that wraps a PDF file

  • pagenum - an int specifying the page number to expose. 1 indexed.



44
45
46
47
48
49
50
51
52
 
# File 'lib/pdf/reader/page.rb', line 44

def initialize(objects, pagenum, options = {})
  @objects, @pagenum = objects, pagenum
  @page_object = objects.deref_hash(objects.page_references[pagenum - 1]) || {}
  @cache       = options[:cache] || {}

  if @page_object.empty?
    raise InvalidPageError, "Invalid page: #{pagenum}"
  end
end

Instance Attribute Details

#cache ⇒ Object (readonly)

a Hash-like object for storing cached data. Generally this is scoped to the current document and is used to avoid repeating expensive operations



28
29
30
 
# File 'lib/pdf/reader/page.rb', line 28

def cache
  @cache
end

#objects ⇒ Object (readonly)

lowlevel hash-like access to all objects in the underlying PDF



20
21
22
 
# File 'lib/pdf/reader/page.rb', line 20

def objects
  @objects
end

#page_object ⇒ Object (readonly)

the raw PDF object that defines this page



23
24
25
 
# File 'lib/pdf/reader/page.rb', line 23

def page_object
  @page_object
end

Instance Method Details

#attributes ⇒ Object

Returns the attributes that accompany this page, including attributes inherited from parents.



69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/pdf/reader/page.rb', line 69

def attributes
  @attributes ||= {}.tap { |hash|
    page_with_ancestors.reverse.each do |obj|
      hash.merge!(@objects.deref_hash(obj) || {})
    end
  }
  # This shouldn't be necesary, but some non compliant PDFs leave MediaBox
  # out. Assuming 8.5" x 11" is what Acobat does, so we do it too.
  @attributes[:MediaBox] ||= [0,0,612,792]
  @attributes
end

#boxes ⇒ Object

returns the “boxes” that define the page object. values are defaulted according to section 7.7.3.3 of the PDF Spec 1.7

DEPRECATED. Recommend using Page#rectangles instead



191
192
193
194
 
# File 'lib/pdf/reader/page.rb', line 191

def boxes
  # In ruby 2.4+ we could use Hash#transform_values
  Hash[rectangles.map{ |k,rect| [k,rect.to_a] } ]
end

#height ⇒ Object 



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

def height
  rect = Rectangle.new(*attributes[:MediaBox])
  rect.apply_rotation(rotate) if rotate > 0
  rect.height
end

#inspect ⇒ Object

return a friendly string representation of this page



62
63
64
 
# File 'lib/pdf/reader/page.rb', line 62

def inspect
  "<PDF::Reader::Page page: #{@pagenum}>"
end

#number ⇒ Object

return the number of this page within the full document



56
57
58
 
# File 'lib/pdf/reader/page.rb', line 56

def number
  @pagenum
end

#orientation ⇒ Object

Convenience method to identify the page’s orientation.



102
103
104
105
106
107
108
 
# File 'lib/pdf/reader/page.rb', line 102

def orientation
  if height > width
    "portrait"
  else
    "landscape"
  end
end

#origin ⇒ Object 



93
94
95
96
97
98
 
# File 'lib/pdf/reader/page.rb', line 93

def origin
  rect = Rectangle.new(*attributes[:MediaBox])
  rect.apply_rotation(rotate) if rotate > 0

  rect.bottom_left
end

#raw_content ⇒ Object

returns the raw content stream for this page. This is plumbing, nothing to see here unless you’re a PDF nerd like me.



165
166
167
168
169
170
171
172
 
# File 'lib/pdf/reader/page.rb', line 165

def raw_content
  contents = objects.deref_stream_or_array(@page_object[:Contents])
  [contents].flatten.compact.map { |obj|
    objects.deref_stream(obj)
  }.compact.map { |obj|
    obj.unfiltered_data
  }.join(" ")
end

#rectangles ⇒ Object

returns the “boxes” that define the page object. values are defaulted according to section 7.7.3.3 of the PDF Spec 1.7



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/pdf/reader/page.rb', line 199

def rectangles
  # attributes[:MediaBox] can never be nil, but I have no easy way to tell sorbet that atm
  mediabox = objects.deref_array_of_numbers(attributes[:MediaBox]) || []
  cropbox = objects.deref_array_of_numbers(attributes[:CropBox]) || mediabox
  bleedbox = objects.deref_array_of_numbers(attributes[:BleedBox]) || cropbox
  trimbox = objects.deref_array_of_numbers(attributes[:TrimBox]) || cropbox
  artbox = objects.deref_array_of_numbers(attributes[:ArtBox]) || cropbox

  begin
    mediarect = Rectangle.from_array(mediabox)
    croprect = Rectangle.from_array(cropbox)
    bleedrect = Rectangle.from_array(bleedbox)
    trimrect = Rectangle.from_array(trimbox)
    artrect = Rectangle.from_array(artbox)
  rescue ArgumentError => e
    raise MalformedPDFError, e.message
  end

  if rotate > 0
    mediarect.apply_rotation(rotate)
    croprect.apply_rotation(rotate)
    bleedrect.apply_rotation(rotate)
    trimrect.apply_rotation(rotate)
    artrect.apply_rotation(rotate)
  end

  {
    MediaBox: mediarect,
    CropBox: croprect,
    BleedBox: bleedrect,
    TrimBox: trimrect,
    ArtBox: artrect,
  }
end

#rotate ⇒ Object

returns the angle to rotate the page clockwise. Always 0, 90, 180 or 270



176
177
178
179
180
181
182
183
184
 
# File 'lib/pdf/reader/page.rb', line 176

def rotate
  value = attributes[:Rotate].to_i
  case value
  when 0, 90, 180, 270
    value
  else
    0
  end
end

#runs(opts = {}) ⇒ Object 



125
126
127
128
129
 
# File 'lib/pdf/reader/page.rb', line 125

def runs(opts = {})
  receiver = PageTextReceiver.new
  walk(receiver)
  receiver.runs(opts)
end

#text(opts = {}) ⇒ Object Also known as: to_s

returns the plain text content of this page encoded as UTF-8. Any characters that can’t be translated will be returned as a ▯



113
114
115
116
117
118
119
120
121
122
 
# File 'lib/pdf/reader/page.rb', line 113

def text(opts = {})
  receiver = PageTextReceiver.new
  walk(receiver)
  runs = receiver.runs(opts)

  # rectangles[:MediaBox] can never be nil, but I have no easy way to tell sorbet that atm
  mediabox = rectangles[:MediaBox] || Rectangle.new(0, 0, 0, 0)

  PageLayout.new(runs, mediabox).to_s
end

#walk(*receivers) ⇒ Object

processes the raw content stream for this page in sequential order and passes callbacks to the receiver objects.

This is mostly low level and you can probably ignore it unless you need access to something like the raw encoded text. For an example of how this can be used as a basis for higher level functionality, see the text() method

If someone was motivated enough, this method is intended to provide all the data required to faithfully render the entire page. If you find some required data isn’t available it’s a bug - let me know.

Many operators that generate callbacks will reference resources stored in the page header - think images, fonts, etc. To facilitate these operators, the first available callback is page=. If your receiver accepts that callback it will be passed the current PDF::Reader::Page object. Use the Page#resources method to grab any required resources.

It may help to think of each page as a self contained program made up of a set of instructions and associated resources. Calling walk() executes the program in the correct order and calls out to your implementation.



154
155
156
157
158
159
160
 
# File 'lib/pdf/reader/page.rb', line 154

def walk(*receivers)
  receivers = receivers.map { |receiver|
    ValidatingReceiver.new(receiver)
  }
  callback(receivers, :page=, [self])
  content_stream(receivers, raw_content)
end

#width ⇒ Object 



87
88
89
90
91
 
# File 'lib/pdf/reader/page.rb', line 87

def width
  rect = Rectangle.new(*attributes[:MediaBox])
  rect.apply_rotation(rotate) if rotate > 0
  rect.width
end