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 =
96.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.



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
# File 'lib/rabbit/canvas.rb', line 155

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

#actionsObject (readonly)

Returns the value of attribute actions.



143
144
145
# File 'lib/rabbit/canvas.rb', line 143

def actions
  @actions
end

#allotted_timeObject



648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
# File 'lib/rabbit/canvas.rb', line 648

def allotted_time
  time = @allotted_time
  if time.nil? and title_slide
    time = title_slide.allotted_time
    if time.nil?
      start_time = title_slide.start_time
      end_time = title_slide.end_time
      if start_time and end_time
        start_time = Time.parse(start_time)
        end_time = Time.parse(end_time)
        time = end_time - start_time
      end
    end
  end
  Utils.ensure_time(time)
end

#comment_themeObject

Returns the value of attribute comment_theme.



153
154
155
# File 'lib/rabbit/canvas.rb', line 153

def comment_theme
  @comment_theme
end

#commentsObject (readonly)

Returns the value of attribute comments.



143
144
145
# File 'lib/rabbit/canvas.rb', line 143

def comments
  @comments
end

#font_resolution_ratioObject

Returns the value of attribute font_resolution_ratio.



152
153
154
# File 'lib/rabbit/canvas.rb', line 152

def font_resolution_ratio
  @font_resolution_ratio
end

#last_modifiedObject (readonly)

Returns the value of attribute last_modified.



142
143
144
# File 'lib/rabbit/canvas.rb', line 142

def last_modified
  @last_modified
end

#loggerObject (readonly)

Returns the value of attribute logger.



142
143
144
# File 'lib/rabbit/canvas.rb', line 142

def logger
  @logger
end

#max_n_commentsObject

Returns the value of attribute max_n_comments.



153
154
155
# File 'lib/rabbit/canvas.rb', line 153

def max_n_comments
  @max_n_comments
end

#migemo_dictionary_nameObject

Returns the value of attribute migemo_dictionary_name.



151
152
153
# File 'lib/rabbit/canvas.rb', line 151

def migemo_dictionary_name
  @migemo_dictionary_name
end

#migemo_dictionary_search_pathObject

Returns the value of attribute migemo_dictionary_search_path.



151
152
153
# File 'lib/rabbit/canvas.rb', line 151

def migemo_dictionary_search_path
  @migemo_dictionary_search_path
end

#output_htmlObject

Returns the value of attribute output_html.



149
150
151
# File 'lib/rabbit/canvas.rb', line 149

def output_html
  @output_html
end

#output_index_htmlObject

Returns the value of attribute output_index_html.



149
150
151
# File 'lib/rabbit/canvas.rb', line 149

def output_index_html
  @output_index_html
end

#rendererObject (readonly)

Returns the value of attribute renderer.



142
143
144
# File 'lib/rabbit/canvas.rb', line 142

def renderer
  @renderer
end

#rss_base_uriObject

Returns the value of attribute rss_base_uri.



148
149
150
# File 'lib/rabbit/canvas.rb', line 148

def rss_base_uri
  @rss_base_uri
end

#saved_image_base_nameObject



439
440
441
442
443
444
445
446
447
# File 'lib/rabbit/canvas.rb', line 439

def saved_image_base_name
  if @saved_image_base_name
    base_name = @saved_image_base_name.encode("UTF-8")
  else
    base_name = Filename.sanitize(title)
  end
  base_name << "-index" if index_mode?
  base_name
end

#saved_image_typeObject

Returns the value of attribute saved_image_type.



148
149
150
# File 'lib/rabbit/canvas.rb', line 148

def saved_image_type
  @saved_image_type
end

#source_filenameObject

Returns the value of attribute source_filename.



150
151
152
# File 'lib/rabbit/canvas.rb', line 150

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.



146
147
148
# File 'lib/rabbit/canvas.rb', line 146

def use_gl=(value)
  @use_gl = value
end

Instance Method Details

#<<(slide) ⇒ Object



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

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

#action(name) ⇒ Object



629
630
631
632
633
634
635
636
637
# File 'lib/rabbit/canvas.rb', line 629

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



619
620
621
622
623
624
625
626
627
# File 'lib/rabbit/canvas.rb', line 619

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

#append_comment(comment) ⇒ Object



602
603
604
605
606
607
608
609
610
611
612
613
# File 'lib/rabbit/canvas.rb', line 602

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



326
327
328
# File 'lib/rabbit/canvas.rb', line 326

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

#apply_timerObject



677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
# File 'lib/rabbit/canvas.rb', line 677

def apply_timer
  return unless title_slide

  start_time = title_slide.start_time
  end_time = title_slide.end_time
  return if start_time.nil?
  return if end_time.nil?

  start_time = Time.parse(start_time)
  end_time = Time.parse(end_time)
  return unless (start_time..end_time).cover?(Time.now)

  @allotted_time = end_time - start_time
  @limit_time = end_time
end

#applying?Boolean

Returns:

  • (Boolean)


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

def applying?
  not @apply_theme_request_queue.empty?
end

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



207
208
209
210
# File 'lib/rabbit/canvas.rb', line 207

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

#cache_all_slidesObject



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

def cache_all_slides
  process do
    @renderer.cache_all_slides
  end
end

#change_current_index(new_index) ⇒ Object



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
# File 'lib/rabbit/canvas.rb', line 293

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_indexObject



285
286
287
288
289
290
291
# File 'lib/rabbit/canvas.rb', line 285

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

#current_slideObject



275
276
277
278
279
280
281
282
283
# File 'lib/rabbit/canvas.rb', line 275

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



596
597
598
599
600
# File 'lib/rabbit/canvas.rb', line 596

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

#detachObject



212
213
214
215
# File 'lib/rabbit/canvas.rb', line 212

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

#each(&block) ⇒ Object



317
318
319
# File 'lib/rabbit/canvas.rb', line 317

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

#find_slide(pattern) ⇒ Object



252
253
254
# File 'lib/rabbit/canvas.rb', line 252

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

#first_slide?Boolean

Returns:

  • (Boolean)


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

def first_slide?
  current_index.zero?
end

#font_resolutionObject



693
694
695
# File 'lib/rabbit/canvas.rb', line 693

def font_resolution
  INTERNAL_DPI * @font_resolution_ratio
end

#front(public_level = nil) ⇒ Object



203
204
205
# File 'lib/rabbit/canvas.rb', line 203

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

#full_path(path) ⇒ Object



393
394
395
# File 'lib/rabbit/canvas.rb', line 393

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

#fullscreenedObject



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

def fullscreened
  @renderer.post_fullscreen
end

#have_next?Boolean

Returns:

  • (Boolean)


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

def have_next?
  return true if have_next_slide?
  return !current_slide.last? if current_slide
  false
end

#have_next_slide?Boolean

Returns:

  • (Boolean)


551
552
553
# File 'lib/rabbit/canvas.rb', line 551

def have_next_slide?
  slide_size - 1 > current_index
end

#have_previous?Boolean

Returns:

  • (Boolean)


545
546
547
548
549
# File 'lib/rabbit/canvas.rb', line 545

def have_previous?
  return true if have_previous_slide?
  return !current_slide.first? if current_slide
  false
end

#have_previous_slide?Boolean

Returns:

  • (Boolean)


541
542
543
# File 'lib/rabbit/canvas.rb', line 541

def have_previous_slide?
  0 < current_index
end

#iconifiedObject



435
436
437
# File 'lib/rabbit/canvas.rb', line 435

def iconified
  @renderer.post_iconify
end

#index_mode?Boolean

Returns:

  • (Boolean)


496
497
498
# File 'lib/rabbit/canvas.rb', line 496

def index_mode?
  @index_mode
end

#last_slide?Boolean

Returns:

  • (Boolean)


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

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

#merge_theme(name) ⇒ Object



334
335
336
337
338
339
340
# File 'lib/rabbit/canvas.rb', line 334

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

#move_to_firstObject



488
489
490
# File 'lib/rabbit/canvas.rb', line 488

def move_to_first
  move_to_if_can(0)
end

#move_to_if_can(index) ⇒ Object



449
450
451
452
453
454
# File 'lib/rabbit/canvas.rb', line 449

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

#move_to_lastObject



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

def move_to_last
  move_to(slide_size - 1)
end

#move_to_next_if_canObject



456
457
458
459
460
461
462
463
464
465
466
# File 'lib/rabbit/canvas.rb', line 456

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_canObject



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

def move_to_next_slide_if_can
  move_to_if_can(current_index + 1)
end

#move_to_previous_if_canObject



472
473
474
475
476
477
478
479
480
481
482
# File 'lib/rabbit/canvas.rb', line 472

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_canObject



484
485
486
# File 'lib/rabbit/canvas.rb', line 484

def move_to_previous_slide_if_can
  move_to_if_can(current_index - 1)
end

#need_reload_source?Boolean

Returns:

  • (Boolean)


389
390
391
# File 'lib/rabbit/canvas.rb', line 389

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

#next_slideObject



313
314
315
# File 'lib/rabbit/canvas.rb', line 313

def next_slide
  slides[current_index + 1]
end

#on_comment(name, &callback) ⇒ Object



592
593
594
# File 'lib/rabbit/canvas.rb', line 592

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

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



346
347
348
349
350
351
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
381
# File 'lib/rabbit/canvas.rb', line 346

def parse(source=nil, callback=nil, &block)
  id = Object.new.__id__
  @parse_request_queue.push(id)
  @source = source || @source
  begin
    index = current_index
    current_allotted_time = allotted_time
    keep_index do
      @renderer.pre_parse
      clear
      Parser.parse(self, @source)
      new_allotted_time = allotted_time
      reset_timer if new_allotted_time != current_allotted_time
      apply_timer
      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)


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

def parsing?
  not @parse_request_queue.empty?
end


421
422
423
424
425
# File 'lib/rabbit/canvas.rb', line 421

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

#processing?Boolean

Returns:

  • (Boolean)


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

def processing?
  @processing
end

#quitObject



198
199
200
201
# File 'lib/rabbit/canvas.rb', line 198

def quit
  @quitted = true
  @frame.quit
end

#quitted?Boolean

Returns:

  • (Boolean)


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

def quitted?
  @quitted
end

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



383
384
385
386
387
# File 'lib/rabbit/canvas.rb', line 383

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

#reload_theme(&block) ⇒ Object



342
343
344
# File 'lib/rabbit/canvas.rb', line 342

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

#reset_timerObject



673
674
675
# File 'lib/rabbit/canvas.rb', line 673

def reset_timer
  @limit_time = nil
end

#rest_timeObject



669
670
671
# File 'lib/rabbit/canvas.rb', line 669

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

#save_as_imageObject



407
408
409
410
411
412
413
414
415
416
417
418
419
# File 'lib/rabbit/canvas.rb', line 407

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



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

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

#slide_indexes(pattern) ⇒ Object



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

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

#slide_sizeObject



271
272
273
# File 'lib/rabbit/canvas.rb', line 271

def slide_size
  slides.size
end

#slide_text(index = current_index) ⇒ Object



237
238
239
240
241
242
# File 'lib/rabbit/canvas.rb', line 237

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



226
227
228
229
230
231
232
233
234
235
# File 'lib/rabbit/canvas.rb', line 226

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

#slidesObject



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

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

#sourceObject



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

def source
  @source.read
end

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

Yields:



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

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



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

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

#start_timer(limit) ⇒ Object



665
666
667
# File 'lib/rabbit/canvas.rb', line 665

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

#stop_auto_redraw_timerObject



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

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

#theme_nameObject



330
331
332
# File 'lib/rabbit/canvas.rb', line 330

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

#titleObject



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

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

#title_slideObject



615
616
617
# File 'lib/rabbit/canvas.rb', line 615

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

#tmp_dir_nameObject



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

def tmp_dir_name
  @source and @source.tmp_dir_name
end

#to_pixbuf(i) ⇒ Object



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

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

#toggle_index_modeObject



500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
# File 'lib/rabbit/canvas.rb', line 500

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

#unfullscreenedObject



431
432
433
# File 'lib/rabbit/canvas.rb', line 431

def unfullscreened
  @renderer.post_unfullscreen
end

#update_index_slidesObject



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

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

#use_gl?Boolean

Returns:

  • (Boolean)


194
195
196
# File 'lib/rabbit/canvas.rb', line 194

def use_gl?
  @use_gl
end

#with_index_mode(new_value) ⇒ Object



639
640
641
642
643
644
645
646
# File 'lib/rabbit/canvas.rb', line 639

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