Class: Origami::XRef

Inherits:
Object
  • Object
show all
Defined in:
lib/origami/xreftable.rb

Overview

Class representing a Cross-reference information.

Defined Under Namespace

Classes: InvalidXRefSectionError, InvalidXRefSubsectionError, Section, Subsection

Constant Summary collapse

FREE = 
"f"
USED = 
"n"
FIRSTFREE = 
65535
@@regexp = 
/(?<offset>\d{10}) (?<gen>\d{5}) (?<state>n|f)(\r\n| \r| \n)/

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(offset, generation, state) ⇒ XRef

Creates a new XRef.

offset

The file offset of the referenced Object.

generation

The generation number of the referenced Object.

state

The state of the referenced Object (FREE or USED).



77
78
79
 
# File 'lib/origami/xreftable.rb', line 77

def initialize(offset, generation, state)
    @offset, @generation, @state = offset, generation, state
end

Instance Attribute Details

#generation ⇒ Object

Returns the value of attribute generation.



69
70
71
 
# File 'lib/origami/xreftable.rb', line 69

def generation
  @generation
end

#offset ⇒ Object

Returns the value of attribute offset.



69
70
71
 
# File 'lib/origami/xreftable.rb', line 69

def offset
  @offset
end

#state ⇒ Object

Returns the value of attribute state.



69
70
71
 
# File 'lib/origami/xreftable.rb', line 69

def state
  @state
end

Class Method Details

.parse(stream) ⇒ Object

:nodoc:



81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/origami/xreftable.rb', line 81

def self.parse(stream) #:nodoc:
    if stream.scan(@@regexp).nil?
        raise InvalidXRefError, "Invalid XRef format"
    end

    offset = stream['offset'].to_i
    generation = stream['gen'].to_i
    state = stream['state']

    XRef.new(offset, generation, state)
end

Instance Method Details

#free? ⇒ Boolean

Returns true if the associated object is freed.

Returns:



103
104
105
 
# File 'lib/origami/xreftable.rb', line 103

def free?
    @state == FREE
end

#to_s ⇒ Object

Outputs self into PDF code.



110
111
112
113
114
115
 
# File 'lib/origami/xreftable.rb', line 110

def to_s
    off = @offset.to_s.rjust(10, '0')
    gen = @generation.to_s.rjust(5, '0')

    "#{off} #{gen} #{@state}" + EOL
end

#to_xrefstm_data(type_w, field1_w, field2_w) ⇒ Object 



117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/origami/xreftable.rb', line 117

def to_xrefstm_data(type_w, field1_w, field2_w)
    type_w <<= 3
    field1_w <<= 3
    field2_w <<= 3

    type = ((@state == FREE) ? "\000" : "\001").unpack("B#{type_w}")[0]

    offset = @offset.to_s(2).rjust(field1_w, '0')
    generation = @generation.to_s(2).rjust(field2_w, '0')

    [ type , offset, generation ].pack("B#{type_w}B#{field1_w}B#{field2_w}")
end

#used? ⇒ Boolean

Returns true if the associated object is used.

Returns:



96
97
98
 
# File 'lib/origami/xreftable.rb', line 96

def used?
    @state == USED
end