Class: Origami::ContentStream

Inherits:
Stream
  • Object
show all
Defined in:
lib/origami/page.rb,
lib/origami/graphics/xobject.rb

Overview

A class representing a Stream containing the contents of a Page.

Constant Summary collapse

DEFAULT_SIZE = 
12
DEFAULT_FONT = 
:F1
DEFAULT_LEADING = 
20
DEFAULT_STROKE_COLOR = 
Graphics::Color::GrayScale.new(0.0)
DEFAULT_FILL_COLOR = 
Graphics::Color::GrayScale.new(1.0)
DEFAULT_LINECAP = 
Graphics::LineCapStyle::BUTT_CAP
DEFAULT_LINEJOIN = 
Graphics::LineJoinStyle::MITER_JOIN
DEFAULT_DASHPATTERN = 
Graphics::DashPattern.new([], 0)
DEFAULT_LINEWIDTH = 
1.0

Constants inherited from Stream

Stream::DEFINED_FILTERS, Stream::TOKENS

Constants included from StandardObject

StandardObject::DEFAULT_ATTRIBUTES

Constants included from Object

Object::TOKENS

Instance Attribute Summary collapse

Attributes inherited from Stream

#dictionary

Attributes included from Object

#file_offset, #generation, #no, #objstm_offset, #parent

Instance Method Summary collapse

Methods inherited from Stream

#[], #[]=, #cast_to, #data, #data=, #decode!, #each_filter, #each_key, #each_pair, #encode!, #encoded_data, #encoded_data=, #filters, #key?, #keys, parse, #post_build, #set_predictor, #to_obfuscated_str, #to_s, #value

Methods included from TypeGuessing

#guess_type

Methods included from FieldAccessor

#method_missing, #respond_to_missing?

Methods included from StandardObject

included, #version_required

Methods included from Object

#cast_to, #copy, #document, #export, included, #indirect?, #indirect_parent, #logicalize, #logicalize!, #native_type, #numbered?, parse, #post_build, #reference, #set_document, #set_indirect, skip_until_next_obj, #solve, #to_o, #to_s, #type, typeof, #version_required, #xrefs

Constructor Details

#initialize(data = "", dictionary = {}) ⇒ ContentStream

Returns a new instance of ContentStream.



40
41
42
43
44
45
 
# File 'lib/origami/graphics/xobject.rb', line 40

def initialize(data = "", dictionary = {})
    super

    @instructions = nil
    @canvas = Graphics::DummyCanvas.new
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Origami::FieldAccessor

Instance Attribute Details

#canvas ⇒ Object

Returns the value of attribute canvas.



38
39
40
 
# File 'lib/origami/graphics/xobject.rb', line 38

def canvas
  @canvas
end

Instance Method Details

#draw_image(name, attr = {}) ⇒ Object 



75
76
77
78
79
80
81
82
83
84
 
# File 'lib/origami/graphics/xobject.rb', line 75

def draw_image(name, attr = {})
    load!

    x, y = attr[:x], attr[:y]

    @instructions << PDF::Instruction.new('q')
    @instructions << PDF::Instruction.new('cm', (attr[:w] || 300), 0, 0, (attr[:h] || 300), x, y)
    @instructions << PDF::Instruction.new('Do', name)
    @instructions << PDF::Instruction.new('Q')
end

#draw_line(from, to, attr = {}) ⇒ Object

Draw a straight line from the point at coord from, to the point at coord to.



89
90
91
 
# File 'lib/origami/graphics/xobject.rb', line 89

def draw_line(from, to, attr = {})
    draw_polygon([from, to], attr)
end

#draw_polygon(coords = [], attr = {}) ⇒ Object

Draw a polygon from a array of coordinates.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/origami/graphics/xobject.rb', line 96

def draw_polygon(coords = [], attr = {})
    load!

    stroke_color  = attr.fetch(:stroke_color, DEFAULT_STROKE_COLOR)
    fill_color    = attr.fetch(:fill_color, DEFAULT_FILL_COLOR)
    line_cap      = attr.fetch(:line_cap, DEFAULT_LINECAP)
    line_join     = attr.fetch(:line_join, DEFAULT_LINEJOIN)
    line_width    = attr.fetch(:line_width, DEFAULT_LINEWIDTH)
    dash_pattern  = attr.fetch(:dash, DEFAULT_DASHPATTERN)

    stroke        = attr[:stroke].nil? ? true : attr[:stroke]
    fill          = attr[:fill].nil? ? false : attr[:fill]

    stroke = true if fill == false and stroke == false

    set_fill_color(fill_color) if fill
    set_stroke_color(stroke_color) if stroke
    set_line_width(line_width)
    set_line_cap(line_cap)
    set_line_join(line_join)
    set_dash_pattern(dash_pattern)

    if @canvas.gs.text_state.is_in_text_object?
        @instructions << PDF::Instruction.new('ET').render(@canvas)
    end

    unless coords.size < 1
        x,y = coords.slice!(0)
        @instructions << PDF::Instruction.new('m',x,y).render(@canvas)

        coords.each do |px,py|
            @instructions << PDF::Instruction.new('l',px,py).render(@canvas)
        end

        @instructions << (i =
            if stroke and not fill
                PDF::Instruction.new('s')
            elsif fill and not stroke
                PDF::Instruction.new('f')
            elsif fill and stroke
                PDF::Instruction.new('b')
            end
        )

        i.render(@canvas)
    end

    self
end

#draw_rectangle(x, y, width, height, attr = {}) ⇒ Object

Draw a rectangle at position (x,y) with defined width and height.



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/origami/graphics/xobject.rb', line 149

def draw_rectangle(x, y, width, height, attr = {})
    load!

    stroke_color  = attr.fetch(:stroke_color, DEFAULT_STROKE_COLOR)
    fill_color    = attr.fetch(:fill_color, DEFAULT_FILL_COLOR)
    line_cap      = attr.fetch(:line_cap, DEFAULT_LINECAP)
    line_join     = attr.fetch(:line_join, DEFAULT_LINEJOIN)
    line_width    = attr.fetch(:line_width, DEFAULT_LINEWIDTH)
    dash_pattern  = attr.fetch(:dash, DEFAULT_DASHPATTERN)

    stroke        = attr[:stroke].nil? ? true : attr[:stroke]
    fill          = attr[:fill].nil? ? false : attr[:fill]

    stroke = true if fill == false and stroke == false

    set_fill_color(fill_color) if fill
    set_stroke_color(stroke_color) if stroke
    set_line_width(line_width)
    set_line_cap(line_cap)
    set_line_join(line_join)
    set_dash_pattern(dash_pattern)

    if @canvas.gs.text_state.is_in_text_object?
        @instructions << PDF::Instruction.new('ET').render(@canvas)
    end

    @instructions << PDF::Instruction.new('re', x,y,width,height).render(@canvas)

    @instructions << (i =
        if stroke and not fill
            PDF::Instruction.new('S')
        elsif fill and not stroke
            PDF::Instruction.new('f')
        elsif fill and stroke
            PDF::Instruction.new('B')
        end
    )

    i.render(@canvas)

    self
end

#instructions ⇒ Object 



69
70
71
72
73
 
# File 'lib/origami/graphics/xobject.rb', line 69

def instructions
    load!

    @instructions
end

#paint_shading(shade) ⇒ Object 



236
237
238
239
240
241
242
 
# File 'lib/origami/graphics/xobject.rb', line 236

def paint_shading(shade)
    load!

    @instructions << PDF::Instruction.new('sh', shade).render(@canvas)

    self
end

#pre_build ⇒ Object

:nodoc:



57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/origami/graphics/xobject.rb', line 57

def pre_build #:nodoc:
    unless @instructions.nil?
        if @canvas.gs.text_state.is_in_text_object?
            @instructions << PDF::Instruction.new('ET').render(@canvas)
        end

        @data = @instructions.join
    end

    super
end

#render(engine) ⇒ Object 



47
48
49
50
51
52
53
54
55
 
# File 'lib/origami/graphics/xobject.rb', line 47

def render(engine)
    load!

    @instructions.each do |instruction|
        instruction.render(engine)
    end

    nil
end

#set_dash_pattern(pattern) ⇒ Object 



382
383
384
385
386
387
388
389
390
 
# File 'lib/origami/graphics/xobject.rb', line 382

def set_dash_pattern(pattern)
    load!

    unless @canvas.gs.dash_pattern.eql? pattern
        @instructions << PDF::Instruction.new('d', pattern.array, pattern.phase).render(@canvas)
    end

    self
end

#set_fill_color(color) ⇒ Object 



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/origami/graphics/xobject.rb', line 322

def set_fill_color(color)
    load!

    @instructions << ( i =
        if (color.respond_to? :r and color.respond_to? :g and color.respond_to? :b) or (color.is_a?(::Array) and color.size == 3)
            r = (color.respond_to?(:r) ? color.r : color[0]).to_f / 255
            g = (color.respond_to?(:g) ? color.g : color[1]).to_f / 255
            b = (color.respond_to?(:b) ? color.b : color[2]).to_f / 255
            PDF::Instruction.new('rg', r, g, b) if @canvas.gs.nonstroking_color != [r,g,b]

        elsif (color.respond_to? :c and color.respond_to? :m and color.respond_to? :y and color.respond_to? :k) or (color.is_a?(::Array) and color.size == 4)
            c = (color.respond_to?(:c) ? color.c : color[0]).to_f
            m = (color.respond_to?(:m) ? color.m : color[1]).to_f
            y = (color.respond_to?(:y) ? color.y : color[2]).to_f
            k = (color.respond_to?(:k) ? color.k : color[3]).to_f
            PDF::Instruction.new('k', c, m, y, k) if @canvas.gs.nonstroking_color != [c,m,y,k]

        elsif color.respond_to?(:g) or (0.0..1.0).include?(color)
            g = color.respond_to?(:g) ? color.g : color
            PDF::Instruction.new('g', g) if @canvas.gs.nonstroking_color != [ g ]

        else
            raise TypeError, "Invalid color : #{color}"
        end
    )

    i.render(@canvas) if i
    self
end

#set_line_cap(cap) ⇒ Object 



402
403
404
405
406
407
408
409
410
 
# File 'lib/origami/graphics/xobject.rb', line 402

def set_line_cap(cap)
    load!

    if @canvas.gs.line_cap != cap
        @instructions << PDF::Instruction.new('J', cap).render(@canvas)
    end

    self
end

#set_line_join(join) ⇒ Object 



412
413
414
415
416
417
418
419
420
 
# File 'lib/origami/graphics/xobject.rb', line 412

def set_line_join(join)
    load!

    if @canvas.gs.line_join != join
        @instructions << PDF::Instruction.new('j', join).render(@canvas)
    end

    self
end

#set_line_width(width) ⇒ Object 



392
393
394
395
396
397
398
399
400
 
# File 'lib/origami/graphics/xobject.rb', line 392

def set_line_width(width)
    load!

    if @canvas.gs.line_width != width
        @instructions << PDF::Instruction.new('w', width).render(@canvas)
    end

    self
end

#set_stroke_color(color) ⇒ Object 



352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/origami/graphics/xobject.rb', line 352

def set_stroke_color(color)
    load!

    @instructions << ( i =
        if (color.respond_to? :r and color.respond_to? :g and color.respond_to? :b) or (color.is_a?(::Array) and color.size == 3)
            r = (color.respond_to?(:r) ? color.r : color[0]).to_f / 255
            g = (color.respond_to?(:g) ? color.g : color[1]).to_f / 255
            b = (color.respond_to?(:b) ? color.b : color[2]).to_f / 255
            PDF::Instruction.new('RG', r, g, b) if @canvas.gs.stroking_color != [r,g,b]

        elsif (color.respond_to? :c and color.respond_to? :m and color.respond_to? :y and color.respond_to? :k) or (color.is_a?(::Array) and color.size == 4)
            c = (color.respond_to?(:c) ? color.c : color[0]).to_f
            m = (color.respond_to?(:m) ? color.m : color[1]).to_f
            y = (color.respond_to?(:y) ? color.y : color[2]).to_f
            k = (color.respond_to?(:k) ? color.k : color[3]).to_f
            PDF::Instruction.new('K', c, m, y, k) if @canvas.gs.stroking_color != [c,m,y,k]

        elsif color.respond_to?(:g) or (0.0..1.0).include?(color)
            g = color.respond_to?(:g) ? color.g : color
            PDF::Instruction.new('G', g) if @canvas.gs.stroking_color != [ g ]

        else
            raise TypeError, "Invalid color : #{color}"
        end
    )

    i.render(@canvas) if i
    self
end

#set_text_char_spacing(char_spacing) ⇒ Object 



312
313
314
315
316
317
318
319
320
 
# File 'lib/origami/graphics/xobject.rb', line 312

def set_text_char_spacing(char_spacing)
    load!

    if char_spacing != @canvas.gs.text_state.char_spacing
        @instructions << PDF::Instruction.new('Tc', char_spacing).render(@canvas)
    end

    self
end

#set_text_font(fontname, size) ⇒ Object 



244
245
246
247
248
249
250
251
252
 
# File 'lib/origami/graphics/xobject.rb', line 244

def set_text_font(fontname, size)
    load!

    if fontname != @canvas.gs.text_state.font or size != @canvas.gs.text_state.font_size
        @instructions << PDF::Instruction.new('Tf', fontname, size).render(@canvas)
    end

    self
end

#set_text_leading(leading) ⇒ Object 



262
263
264
265
266
267
268
269
270
 
# File 'lib/origami/graphics/xobject.rb', line 262

def set_text_leading(leading)
    load!

    if leading != @canvas.gs.text_state.leading
        @instructions << PDF::Instruction.new('TL', leading).render(@canvas)
    end

    self
end

#set_text_pos(tx, ty) ⇒ Object 



254
255
256
257
258
259
260
 
# File 'lib/origami/graphics/xobject.rb', line 254

def set_text_pos(tx,ty)
    load!

    @instructions << PDF::Instruction.new('Td', tx, ty).render(@canvas)

    self
end

#set_text_rendering(rendering) ⇒ Object 



272
273
274
275
276
277
278
279
280
 
# File 'lib/origami/graphics/xobject.rb', line 272

def set_text_rendering(rendering)
    load!

    if rendering != @canvas.gs.text_state.rendering_mode
        @instructions << PDF::Instruction.new('Tr', rendering).render(@canvas)
    end

    self
end

#set_text_rise(rise) ⇒ Object 



282
283
284
285
286
287
288
289
290
 
# File 'lib/origami/graphics/xobject.rb', line 282

def set_text_rise(rise)
    load!

    if rise != @canvas.gs.text_state.text_rise
        @instructions << PDF::Instruction.new('Ts', rise).render(@canvas)
    end

    self
end

#set_text_scale(scaling) ⇒ Object 



292
293
294
295
296
297
298
299
300
 
# File 'lib/origami/graphics/xobject.rb', line 292

def set_text_scale(scaling)
    load!

    if scaling != @canvas.gs.text_state.scaling
        @instructions << PDF::Instruction.new('Tz', scaling).render(@canvas)
    end

    self
end

#set_text_word_spacing(word_spacing) ⇒ Object 



302
303
304
305
306
307
308
309
310
 
# File 'lib/origami/graphics/xobject.rb', line 302

def set_text_word_spacing(word_spacing)
    load!

    if word_spacing != @canvas.gs.text_state.word_spacing
        @instructions << PDF::Instruction.new('Tw', word_spacing).render(@canvas)
    end

    self
end

#write(text, attr = {}) ⇒ Object

Adds text to the content stream with custom formatting attributes.

text

Text to write.

attr

Formatting attributes.



197
198
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
233
234
 
# File 'lib/origami/graphics/xobject.rb', line 197

def write(text, attr = {})
    load!

    x, y      = attr[:x], attr[:y]
    font      = attr.fetch(:font, DEFAULT_FONT)
    size      = attr.fetch(:size, DEFAULT_SIZE)
    leading   = attr.fetch(:leading, DEFAULT_LEADING)
    color     = attr.fetch(:color, attr.fetch(:fill_color, DEFAULT_STROKE_COLOR))
    stroke_color = attr.fetch(:stroke_color, DEFAULT_STROKE_COLOR)
    line_width    = attr.fetch(:line_width, DEFAULT_LINEWIDTH)
    word_spacing  = attr.fetch(:word_spacing, @canvas.gs.text_state.word_spacing)
    char_spacing  = attr.fetch(:char_spacing, @canvas.gs.text_state.char_spacing)
    scale     = attr.fetch(:scale, @canvas.gs.text_state.scaling)
    rise      = attr.fetch(:rise, @canvas.gs.text_state.text_rise)
    rendering = attr.fetch(:rendering, @canvas.gs.text_state.rendering_mode)

    @instructions << PDF::Instruction.new('ET').render(@canvas) if (x or y) and @canvas.gs.text_state.is_in_text_object?

    unless @canvas.gs.text_state.is_in_text_object?
        @instructions << PDF::Instruction.new('BT').render(@canvas)
    end

    set_text_font(font, size)
    set_text_pos(x, y) if x or y
    set_text_leading(leading)
    set_text_rendering(rendering)
    set_text_rise(rise)
    set_text_scale(scale)
    set_text_word_spacing(word_spacing)
    set_text_char_spacing(char_spacing)
    set_fill_color(color)
    set_stroke_color(stroke_color)
    set_line_width(line_width)

    write_text_block(text)

    self
end