Class: Rabbit::Canvas

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
Enumerable, GetText
Defined in:
lib/rabbit/canvas.rb

Direct Known Subclasses

DependencyCanvas

Constant Summary collapse

INTERNAL_DPI = 
80.0

Constants included from GetText

GetText::DOMAIN

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from GetText

included

Constructor Details

#initialize(logger, renderer) ⇒ Canvas

Returns a new instance of Canvas.



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/rabbit/canvas.rb', line 134

def initialize(logger, renderer)
  @logger = logger
  @frame = NullFrame.new
  @theme_name = nil
  @saved_image_base_name = nil
  @saved_image_type = "png"
  @processing = false
  @quitted = false
  @parse_request_queue = []
  @apply_theme_request_queue = []
  @auto_redraw_timer = nil
  @output_html = false
  @rss_base_uri = nil
  @source_filename = nil
  @migemo_dictionary_search_path = []
  @migemo_dictionary_name = nil
  @limit_time = nil
  @use_gl = false
  @font_resolution_ratio = 1
  @max_n_comments = 100
  @allotted_time = nil
  @comment_theme = nil
  clear
  @renderer = renderer.new(self)
  @actions = Action.action_group(self)
end

Instance Attribute Details

#actions ⇒ Object (readonly)

Returns the value of attribute actions.



122
123
124
 
# File 'lib/rabbit/canvas.rb', line 122

def actions
  @actions
end

#allotted_time ⇒ Object 



618
619
620
621
622
 
# File 'lib/rabbit/canvas.rb', line 618

def allotted_time
  time = @allotted_time
  time ||= title_slide.allotted_time if title_slide
  Utils.ensure_time(time)
end

#comment_theme ⇒ Object

Returns the value of attribute comment_theme.



132
133
134
 
# File 'lib/rabbit/canvas.rb', line 132

def comment_theme
  @comment_theme
end

#comments ⇒ Object (readonly)

Returns the value of attribute comments.



122
123
124
 
# File 'lib/rabbit/canvas.rb', line 122

def comments
  @comments
end

#font_resolution_ratio ⇒ Object

Returns the value of attribute font_resolution_ratio.



131
132
133
 
# File 'lib/rabbit/canvas.rb', line 131

def font_resolution_ratio
  @font_resolution_ratio
end

#last_modified ⇒ Object (readonly)

Returns the value of attribute last_modified.



121
122
123
 
# File 'lib/rabbit/canvas.rb', line 121

def last_modified
  @last_modified
end

#logger ⇒ Object (readonly)

Returns the value of attribute logger.



121
122
123
 
# File 'lib/rabbit/canvas.rb', line 121

def logger
  @logger
end

#max_n_comments ⇒ Object

Returns the value of attribute max_n_comments.



132
133
134
 
# File 'lib/rabbit/canvas.rb', line 132

def max_n_comments
  @max_n_comments
end

#migemo_dictionary_name ⇒ Object

Returns the value of attribute migemo_dictionary_name.



130
131
132
 
# File 'lib/rabbit/canvas.rb', line 130

def migemo_dictionary_name
  @migemo_dictionary_name
end

#migemo_dictionary_search_path ⇒ Object

Returns the value of attribute migemo_dictionary_search_path.



130
131
132
 
# File 'lib/rabbit/canvas.rb', line 130

def migemo_dictionary_search_path
  @migemo_dictionary_search_path
end

#output_html ⇒ Object

Returns the value of attribute output_html.



128
129
130
 
# File 'lib/rabbit/canvas.rb', line 128

def output_html
  @output_html
end

#output_index_html ⇒ Object

Returns the value of attribute output_index_html.



128
129
130
 
# File 'lib/rabbit/canvas.rb', line 128

def output_index_html
  @output_index_html
end

#renderer ⇒ Object (readonly)

Returns the value of attribute renderer.



121
122
123
 
# File 'lib/rabbit/canvas.rb', line 121

def renderer
  @renderer
end

#rss_base_uri ⇒ Object

Returns the value of attribute rss_base_uri.



127
128
129
 
# File 'lib/rabbit/canvas.rb', line 127

def rss_base_uri
  @rss_base_uri
end

#saved_image_base_name ⇒ Object 



414
415
416
417
418
419
420
421
422
 
# File 'lib/rabbit/canvas.rb', line 414

def saved_image_base_name
  if @saved_image_base_name
    base_name = GLib.filename_to_utf8(@saved_image_base_name)
  else
    base_name = title.dup
  end
  base_name << "-index" if index_mode?
  base_name
end

#saved_image_type ⇒ Object

Returns the value of attribute saved_image_type.



127
128
129
 
# File 'lib/rabbit/canvas.rb', line 127

def saved_image_type
  @saved_image_type
end

#source_filename ⇒ Object

Returns the value of attribute source_filename.



129
130
131
 
# File 'lib/rabbit/canvas.rb', line 129

def source_filename
  @source_filename
end

#use_gl=(value) ⇒ Object (writeonly)

Sets the attribute use_gl

Parameters:

  • value —

    the value to set the attribute use_gl to.



125
126
127
 
# File 'lib/rabbit/canvas.rb', line 125

def use_gl=(value)
  @use_gl = value
end

Instance Method Details

#<<(slide) ⇒ Object 



300
301
302
303
 
# File 'lib/rabbit/canvas.rb', line 300

def <<(slide)
  slide.index = slides.size
  slides << slide
end

#action(name) ⇒ Object 



599
600
601
602
603
604
605
606
607
 
# File 'lib/rabbit/canvas.rb', line 599

def action(name)
  act = @actions.get_action(name)
  if act
    act
  else
    logger.warn(_("Unknown action: %s") % name)
    false
  end
end

#activate(name, &block) ⇒ Object 



589
590
591
592
593
594
595
596
597
 
# File 'lib/rabbit/canvas.rb', line 589

def activate(name, &block)
  act = action(name)
  if act and act.sensitive?
    act.activate(&block)
    true
  else
    false
  end
end

#append_comment(comment) ⇒ Object 



572
573
574
575
576
577
578
579
580
581
582
583
 
# File 'lib/rabbit/canvas.rb', line 572

def append_comment(comment)
  @comments << comment
  @comments.shift if @comments.size > @max_n_comments
  @on_comment_callbacks.each do |name, callback|
    begin
      callback.call(comment)
    rescue
      logger.error($!)
    end
  end
  true
end

#apply_theme(name = nil, &block) ⇒ Object 



305
306
307
 
# File 'lib/rabbit/canvas.rb', line 305

def apply_theme(name=nil, &block)
  _apply_theme(name, Object.new.__id__, &block)
end

#applying? ⇒ Boolean

Returns:

  • (Boolean) 


169
170
171
 
# File 'lib/rabbit/canvas.rb', line 169

def applying?
  not @apply_theme_request_queue.empty?
end

#attach_to(frame, window, container = nil, &block) ⇒ Object 



186
187
188
189
 
# File 'lib/rabbit/canvas.rb', line 186

def attach_to(frame, window, container=nil, &block)
  @frame = frame if frame
  @renderer.attach_to(window, container, &block) if window
end

#cache_all_slides ⇒ Object 



532
533
534
535
536
 
# File 'lib/rabbit/canvas.rb', line 532

def cache_all_slides
  process do
    @renderer.cache_all_slides
  end
end

#change_current_index(new_index) ⇒ Object 



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/rabbit/canvas.rb', line 272

def change_current_index(new_index)
  mode = @index_mode
  if mode
    index = @index_current_index
    @index_current_index = new_index
  else
    index = @current_index
    @current_index = new_index
  end
  if 0 <= current_index and current_index < slide_size
    yield
  end
ensure
  if mode
    @index_current_index = index
  else
    @current_index = index
  end
end

#current_index ⇒ Object 



264
265
266
267
268
269
270
 
# File 'lib/rabbit/canvas.rb', line 264

def current_index
  if @index_mode
    @index_current_index
  else
    @current_index
  end
end

#current_slide ⇒ Object 



254
255
256
257
258
259
260
261
262
 
# File 'lib/rabbit/canvas.rb', line 254

def current_slide
  slide = slides[current_index]
  if slide
    slide
  else
    move_to_first
    slides.first
  end
end

#delete_on_comment_proc_by_name(name) ⇒ Object 



566
567
568
569
570
 
# File 'lib/rabbit/canvas.rb', line 566

def delete_on_comment_proc_by_name(name)
  @on_comment_callbacks.reject! do |callback_name, callback|
    callback_name == name
  end
end

#detach ⇒ Object 



191
192
193
194
 
# File 'lib/rabbit/canvas.rb', line 191

def detach
  @frame = NullFrame.new
  @renderer.detach
end

#each(&block) ⇒ Object 



296
297
298
 
# File 'lib/rabbit/canvas.rb', line 296

def each(&block)
  slides.each(&block)
end

#find_slide(pattern) ⇒ Object 



231
232
233
 
# File 'lib/rabbit/canvas.rb', line 231

def find_slide(pattern)
  slides.find {|slide| slide.match?(pattern)}
end

#first_slide? ⇒ Boolean

Returns:

  • (Boolean) 


508
509
510
 
# File 'lib/rabbit/canvas.rb', line 508

def first_slide?
  current_index.zero?
end

#font_resolution ⇒ Object 



636
637
638
 
# File 'lib/rabbit/canvas.rb', line 636

def font_resolution
  INTERNAL_DPI * @font_resolution_ratio
end

#front(public_level = nil) ⇒ Object 



182
183
184
 
# File 'lib/rabbit/canvas.rb', line 182

def front(public_level=nil)
  Front.new(self, public_level)
end

#full_path(path) ⇒ Object 



368
369
370
 
# File 'lib/rabbit/canvas.rb', line 368

def full_path(path)
  @source and @source.full_path(path)
end

#fullscreened ⇒ Object 



402
403
404
 
# File 'lib/rabbit/canvas.rb', line 402

def fullscreened
  @renderer.post_fullscreen
end

#have_next? ⇒ Boolean

Returns:

  • (Boolean) 


528
529
530
 
# File 'lib/rabbit/canvas.rb', line 528

def have_next?
  have_next_slide? or (current_slide and !current_slide.last?)
end

#have_next_slide? ⇒ Boolean

Returns:

  • (Boolean) 


524
525
526
 
# File 'lib/rabbit/canvas.rb', line 524

def have_next_slide?
  slide_size - 1 > current_index
end

#have_previous? ⇒ Boolean

Returns:

  • (Boolean) 


520
521
522
 
# File 'lib/rabbit/canvas.rb', line 520

def have_previous?
  have_previous_slide? or (current_slide and !current_slide.first?)
end

#have_previous_slide? ⇒ Boolean

Returns:

  • (Boolean) 


516
517
518
 
# File 'lib/rabbit/canvas.rb', line 516

def have_previous_slide?
  0 < current_index
end

#iconified ⇒ Object 



410
411
412
 
# File 'lib/rabbit/canvas.rb', line 410

def iconified
  @renderer.post_iconify
end

#index_mode? ⇒ Boolean

Returns:

  • (Boolean) 


471
472
473
 
# File 'lib/rabbit/canvas.rb', line 471

def index_mode?
  @index_mode
end

#last_slide? ⇒ Boolean

Returns:

  • (Boolean) 


512
513
514
 
# File 'lib/rabbit/canvas.rb', line 512

def last_slide?
  slide_size.zero? or current_index == (slide_size - 1)
end

#merge_theme(name) ⇒ Object 



313
314
315
316
317
318
319
 
# File 'lib/rabbit/canvas.rb', line 313

def merge_theme(name)
  unless @slides.empty?
    manager = Theme::Manager.new(self)
    manager.apply(name)
    @renderer.post_apply_theme
  end
end

#move_to_first ⇒ Object 



463
464
465
 
# File 'lib/rabbit/canvas.rb', line 463

def move_to_first
  move_to_if_can(0)
end

#move_to_if_can(index) ⇒ Object 



424
425
426
427
428
429
 
# File 'lib/rabbit/canvas.rb', line 424

def move_to_if_can(index)
  if index and 0 <= index and index < slide_size
    move_to(index)
  end
  current_index
end

#move_to_last ⇒ Object 



467
468
469
 
# File 'lib/rabbit/canvas.rb', line 467

def move_to_last
  move_to(slide_size - 1)
end

#move_to_next_if_can ⇒ Object 



431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/rabbit/canvas.rb', line 431

def move_to_next_if_can
  slide = current_slide
  if slide and !slide.last?
    old_index = slide.drawing_index
    slide.move_to_next
    Action.update_status(self)
    @renderer.post_move_in_slide(old_index, slide.drawing_index)
  else
    move_to_next_slide_if_can
  end
end

#move_to_next_slide_if_can ⇒ Object 



443
444
445
 
# File 'lib/rabbit/canvas.rb', line 443

def move_to_next_slide_if_can
  move_to_if_can(current_index + 1)
end

#move_to_previous_if_can ⇒ Object 



447
448
449
450
451
452
453
454
455
456
457
 
# File 'lib/rabbit/canvas.rb', line 447

def move_to_previous_if_can
  slide = current_slide
  if slide and !slide.first?
    old_index = slide.drawing_index
    slide.move_to_previous
    Action.update_status(self)
    @renderer.post_move_in_slide(old_index, slide.drawing_index)
  else
    move_to_previous_slide_if_can
  end
end

#move_to_previous_slide_if_can ⇒ Object 



459
460
461
 
# File 'lib/rabbit/canvas.rb', line 459

def move_to_previous_slide_if_can
  move_to_if_can(current_index - 1)
end

#need_reload_source? ⇒ Boolean

Returns:

  • (Boolean) 


364
365
366
 
# File 'lib/rabbit/canvas.rb', line 364

def need_reload_source?
  !@processing and @source and @source.modified?
end

#next_slide ⇒ Object 



292
293
294
 
# File 'lib/rabbit/canvas.rb', line 292

def next_slide
  slides[current_index + 1]
end

#on_comment(name, &callback) ⇒ Object 



562
563
564
 
# File 'lib/rabbit/canvas.rb', line 562

def on_comment(name, &callback)
  @on_comment_callbacks << [name, callback]
end

#parse(source = nil, callback = nil, &block) ⇒ Object 



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
351
352
353
354
355
356
 
# File 'lib/rabbit/canvas.rb', line 325

def parse(source=nil, callback=nil, &block)
  id = Object.new.__id__
  @parse_request_queue.push(id)
  @source = source || @source
  begin
    index = current_index
    keep_index do
      @renderer.pre_parse
      clear
      Parser.parse(self, @source)
      set_current_index(index)
      reload_theme do
        if @parse_request_queue.last != id
          raise ParseFinish
        end
        callback.call if callback
      end
      @renderer.post_parse
      index = current_index
    end
    set_current_index(index)
  rescue ParseFinish
  rescue ParseError, UnsupportedFormatError
    if block_given?
      yield($!)
    else
      logger.warn($!.message)
    end
  ensure
    @parse_request_queue.delete_if {|x| x == id}
  end
end

#parsing? ⇒ Boolean

Returns:

  • (Boolean) 


165
166
167
 
# File 'lib/rabbit/canvas.rb', line 165

def parsing?
  not @parse_request_queue.empty?
end

#print(&block) ⇒ Object 



396
397
398
399
400
 
# File 'lib/rabbit/canvas.rb', line 396

def print(&block)
  process do
    @renderer.print(&block)
  end
end

#processing? ⇒ Boolean

Returns:

  • (Boolean) 


538
539
540
 
# File 'lib/rabbit/canvas.rb', line 538

def processing?
  @processing
end

#quit ⇒ Object 



177
178
179
180
 
# File 'lib/rabbit/canvas.rb', line 177

def quit
  @quitted = true
  @frame.quit
end

#quitted? ⇒ Boolean

Returns:

  • (Boolean) 


161
162
163
 
# File 'lib/rabbit/canvas.rb', line 161

def quitted?
  @quitted
end

#reload_source(callback = nil, &block) ⇒ Object 



358
359
360
361
362
 
# File 'lib/rabbit/canvas.rb', line 358

def reload_source(callback=nil, &block)
  if need_reload_source?
    parse(nil, callback, &block)
  end
end

#reload_theme(&block) ⇒ Object 



321
322
323
 
# File 'lib/rabbit/canvas.rb', line 321

def reload_theme(&block)
  apply_theme(@theme_name, &block)
end

#reset_timer ⇒ Object 



632
633
634
 
# File 'lib/rabbit/canvas.rb', line 632

def reset_timer
  @limit_time = nil
end

#rest_time ⇒ Object 



628
629
630
 
# File 'lib/rabbit/canvas.rb', line 628

def rest_time
  @limit_time ? @limit_time - Time.now : nil
end

#save_as_image ⇒ Object 



382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/rabbit/canvas.rb', line 382

def save_as_image
  process do
    generator = HTML::Generator.new(self,
                                    saved_image_base_name,
                                    @saved_image_type,
                                    @output_html,
                                    @output_index_html,
                                    @rss_base_uri)
    generator.pdf_filename = filename if /\.pdf\z/i =~ filename.to_s
    generator.source_filename = @source_filename
    generator.save
  end
end

#slide_index(pattern) ⇒ Object 



235
236
237
238
239
240
 
# File 'lib/rabbit/canvas.rb', line 235

def slide_index(pattern)
  slides.each_with_index do |slide, i|
    return i if slide.match?(pattern)
  end
  nil
end

#slide_indexes(pattern) ⇒ Object 



242
243
244
245
246
247
248
 
# File 'lib/rabbit/canvas.rb', line 242

def slide_indexes(pattern)
  indexes = []
  slides.each_with_index do |slide, i|
    indexes << i if slide.match?(pattern)
  end
  indexes
end

#slide_size ⇒ Object 



250
251
252
 
# File 'lib/rabbit/canvas.rb', line 250

def slide_size
  slides.size
end

#slide_text(index = current_index) ⇒ Object 



216
217
218
219
220
221
 
# File 'lib/rabbit/canvas.rb', line 216

def slide_text(index=current_index)
  return "" if slides.empty?
  slide = slides[index]
  return "" if slide.nil?
  slide.text.strip
end

#slide_title(index = current_index) ⇒ Object 



205
206
207
208
209
210
211
212
213
214
 
# File 'lib/rabbit/canvas.rb', line 205

def slide_title(index=current_index)
  return "" if slides.empty?
  slide = slides[index]
  return title if slide.nil?
  if slide.is_a?(Element::TitleSlide)
    slide.title
  else
    "#{title}: #{slide.title}"
  end
end

#slides ⇒ Object 



223
224
225
226
227
228
229
 
# File 'lib/rabbit/canvas.rb', line 223

def slides
  if @index_mode
    @index_slides
  else
    @slides
  end
end

#source ⇒ Object 



504
505
506
 
# File 'lib/rabbit/canvas.rb', line 504

def source
  @source.read
end

#source_force_modified(force_modified) {|@source| ... } ⇒ Object

Yields:



497
498
499
500
501
502
 
# File 'lib/rabbit/canvas.rb', line 497

def source_force_modified(force_modified)
  prev = @source.force_modified
  @source.force_modified = force_modified
  yield @source
  @source.force_modified = prev
end

#start_auto_redraw_timer(interval) ⇒ Object 



542
543
544
545
546
547
548
549
550
551
552
553
 
# File 'lib/rabbit/canvas.rb', line 542

def start_auto_redraw_timer(interval)
  stop_auto_redraw_timer
  timer = GLib::Timeout.add(interval * 1000) do
    if quitted?
      false
    else
      activate("Redraw")
      true
    end
  end
  @auto_redraw_timer = timer
end

#start_timer(limit) ⇒ Object 



624
625
626
 
# File 'lib/rabbit/canvas.rb', line 624

def start_timer(limit)
  @limit_time = Time.now + limit
end

#stop_auto_redraw_timer ⇒ Object 



555
556
557
558
559
560
 
# File 'lib/rabbit/canvas.rb', line 555

def stop_auto_redraw_timer
  if @auto_redraw_timer
    GLib::Source.remove(@auto_redraw_timer)
    @auto_redraw_timer = nil
  end
end

#theme_name ⇒ Object 



309
310
311
 
# File 'lib/rabbit/canvas.rb', line 309

def theme_name
  @theme_name || default_theme || "default"
end

#title ⇒ Object 



196
197
198
199
200
201
202
203
 
# File 'lib/rabbit/canvas.rb', line 196

def title
  ts = title_slide
  if ts
    ts.title
  else
    "Rabbit"
  end
end

#title_slide ⇒ Object 



585
586
587
 
# File 'lib/rabbit/canvas.rb', line 585

def title_slide
  @slides.find{|x| x.is_a?(Element::TitleSlide)}
end

#tmp_dir_name ⇒ Object 



372
373
374
 
# File 'lib/rabbit/canvas.rb', line 372

def tmp_dir_name
  @source and @source.tmp_dir_name
end

#to_pixbuf(i) ⇒ Object 



376
377
378
379
380
 
# File 'lib/rabbit/canvas.rb', line 376

def to_pixbuf(i)
  move_to_if_can(i)
  current_slide.flush
  @renderer.to_pixbuf(current_slide)
end

#toggle_index_mode ⇒ Object 



475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
 
# File 'lib/rabbit/canvas.rb', line 475

def toggle_index_mode
  @renderer.pre_toggle_index_mode
  process do
    if @index_mode
      @index_mode = false
      @renderer.index_mode_off
    else
      update_index_slides
      @index_mode = true
      @renderer.index_mode_on
    end
    modified
  end
  @renderer.post_toggle_index_mode
end

#unfullscreened ⇒ Object 



406
407
408
 
# File 'lib/rabbit/canvas.rb', line 406

def unfullscreened
  @renderer.post_unfullscreen
end

#update_index_slides ⇒ Object 



491
492
493
494
495
 
# File 'lib/rabbit/canvas.rb', line 491

def update_index_slides
  if @index_slides.empty?
    @index_slides = Element::IndexSlide.make_index_slides(self)
  end
end

#use_gl? ⇒ Boolean

Returns:

  • (Boolean) 


173
174
175
 
# File 'lib/rabbit/canvas.rb', line 173

def use_gl?
  @use_gl
end

#with_index_mode(new_value) ⇒ Object 



609
610
611
612
613
614
615
616
 
# File 'lib/rabbit/canvas.rb', line 609

def with_index_mode(new_value)
  current_index_mode = @index_mode
  @index_mode = new_value
  update_index_slides if @index_mode
  yield
ensure
  @index_mode = current_index_mode
end