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.



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

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.



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

def actions
  @actions
end

#allotted_time ⇒ Object 



660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
 
# File 'lib/rabbit/canvas.rb', line 660

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_theme ⇒ Object

Returns the value of attribute comment_theme.



157
158
159
 
# File 'lib/rabbit/canvas.rb', line 157

def comment_theme
  @comment_theme
end

#comments ⇒ Object (readonly)

Returns the value of attribute comments.



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

def comments
  @comments
end

#font_resolution_ratio ⇒ Object

Returns the value of attribute font_resolution_ratio.



156
157
158
 
# File 'lib/rabbit/canvas.rb', line 156

def font_resolution_ratio
  @font_resolution_ratio
end

#last_modified ⇒ Object (readonly)

Returns the value of attribute last_modified.



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

def last_modified
  @last_modified
end

#logger ⇒ Object (readonly)

Returns the value of attribute logger.



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

def logger
  @logger
end

#max_n_comments ⇒ Object

Returns the value of attribute max_n_comments.



157
158
159
 
# File 'lib/rabbit/canvas.rb', line 157

def max_n_comments
  @max_n_comments
end

#migemo_dictionary_name ⇒ Object

Returns the value of attribute migemo_dictionary_name.



155
156
157
 
# File 'lib/rabbit/canvas.rb', line 155

def migemo_dictionary_name
  @migemo_dictionary_name
end

#migemo_dictionary_search_path ⇒ Object

Returns the value of attribute migemo_dictionary_search_path.



155
156
157
 
# File 'lib/rabbit/canvas.rb', line 155

def migemo_dictionary_search_path
  @migemo_dictionary_search_path
end

#output_html ⇒ Object

Returns the value of attribute output_html.



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

def output_html
  @output_html
end

#output_index_html ⇒ Object

Returns the value of attribute output_index_html.



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

def output_index_html
  @output_index_html
end

#renderer ⇒ Object (readonly)

Returns the value of attribute renderer.



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

def renderer
  @renderer
end

#rss_base_uri ⇒ Object

Returns the value of attribute rss_base_uri.



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

def rss_base_uri
  @rss_base_uri
end

#saved_image_base_name ⇒ Object 



451
452
453
454
455
456
457
458
459
 
# File 'lib/rabbit/canvas.rb', line 451

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_type ⇒ Object

Returns the value of attribute saved_image_type.



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

def saved_image_type
  @saved_image_type
end

#source_filename ⇒ Object

Returns the value of attribute source_filename.



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

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.



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

def use_gl=(value)
  @use_gl = value
end

Instance Method Details

#<<(slide) ⇒ Object 



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

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

#action(name) ⇒ Object 



641
642
643
644
645
646
647
648
649
 
# File 'lib/rabbit/canvas.rb', line 641

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 



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

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

#append_comment(comment) ⇒ Object 



614
615
616
617
618
619
620
621
622
623
624
625
 
# File 'lib/rabbit/canvas.rb', line 614

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 



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

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

#apply_timer ⇒ Object 



689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
 
# File 'lib/rabbit/canvas.rb', line 689

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) 


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

def applying?
  not @apply_theme_request_queue.empty?
end

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



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

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 



573
574
575
576
577
 
# File 'lib/rabbit/canvas.rb', line 573

def cache_all_slides
  process do
    @renderer.cache_all_slides
  end
end

#change_current_index(new_index) ⇒ Object 



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/rabbit/canvas.rb', line 297

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 



289
290
291
292
293
294
295
 
# File 'lib/rabbit/canvas.rb', line 289

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

#current_slide ⇒ Object 



279
280
281
282
283
284
285
286
287
 
# File 'lib/rabbit/canvas.rb', line 279

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 



608
609
610
611
612
 
# File 'lib/rabbit/canvas.rb', line 608

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

#detach ⇒ Object 



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

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

#each(&block) ⇒ Object 



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

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

#find_slide(pattern) ⇒ Object 



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

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

#first_slide? ⇒ Boolean

Returns:

  • (Boolean) 


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

def first_slide?
  current_index.zero?
end

#font_resolution ⇒ Object 



705
706
707
 
# File 'lib/rabbit/canvas.rb', line 705

def font_resolution
  INTERNAL_DPI * @font_resolution_ratio
end

#front(public_level = nil) ⇒ Object 



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

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

#full_path(path) ⇒ Object 



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

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

#fullscreened ⇒ Object 



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

def fullscreened
  @renderer.post_fullscreen
end

#have_next? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#have_next_slide? ⇒ Boolean

Returns:

  • (Boolean) 


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

def have_next_slide?
  slide_size - 1 > current_index
end

#have_previous? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#have_previous_slide? ⇒ Boolean

Returns:

  • (Boolean) 


553
554
555
 
# File 'lib/rabbit/canvas.rb', line 553

def have_previous_slide?
  0 < current_index
end

#iconified ⇒ Object 



439
440
441
 
# File 'lib/rabbit/canvas.rb', line 439

def iconified
  @renderer.post_iconify
end

#index_mode? ⇒ Boolean

Returns:

  • (Boolean) 


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

def index_mode?
  @index_mode
end

#last_slide? ⇒ Boolean

Returns:

  • (Boolean) 


549
550
551
 
# File 'lib/rabbit/canvas.rb', line 549

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

#merge_theme(name) ⇒ Object 



338
339
340
341
342
343
344
 
# File 'lib/rabbit/canvas.rb', line 338

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 



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

def move_to_first
  move_to_if_can(0)
end

#move_to_if_can(index) ⇒ Object 



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

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 



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

def move_to_last
  move_to(slide_size - 1)
end

#move_to_next_if_can ⇒ Object 



468
469
470
471
472
473
474
475
476
477
478
 
# File 'lib/rabbit/canvas.rb', line 468

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 



480
481
482
 
# File 'lib/rabbit/canvas.rb', line 480

def move_to_next_slide_if_can
  move_to_if_can(current_index + 1)
end

#move_to_previous_if_can ⇒ Object 



484
485
486
487
488
489
490
491
492
493
494
 
# File 'lib/rabbit/canvas.rb', line 484

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 



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

def move_to_previous_slide_if_can
  move_to_if_can(current_index - 1)
end

#need_reload_source? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#next_slide ⇒ Object 



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

def next_slide
  slides[current_index + 1]
end

#on_comment(name, &callback) ⇒ Object 



604
605
606
 
# File 'lib/rabbit/canvas.rb', line 604

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

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



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
382
383
384
385
 
# File 'lib/rabbit/canvas.rb', line 350

def parse(source=nil, progress=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, progress: progress)
      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
        progress.call if progress
      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) 


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

def parsing?
  not @parse_request_queue.empty?
end

#post_terminal ⇒ Object 



447
448
449
 
# File 'lib/rabbit/canvas.rb', line 447

def post_terminal
  @renderer.post_terminal
end

#pre_terminal ⇒ Object 



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

def pre_terminal
  @renderer.pre_terminal
end

#print(&block) ⇒ Object 



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

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

#processing? ⇒ Boolean

Returns:

  • (Boolean) 


579
580
581
 
# File 'lib/rabbit/canvas.rb', line 579

def processing?
  @processing
end

#quit ⇒ Object 



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

def quit
  @quitted = true
  @frame.quit
end

#quitted? ⇒ Boolean

Returns:

  • (Boolean) 


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

def quitted?
  @quitted
end

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



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

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

#reload_theme(&block) ⇒ Object 



346
347
348
 
# File 'lib/rabbit/canvas.rb', line 346

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

#reset_timer ⇒ Object 



685
686
687
 
# File 'lib/rabbit/canvas.rb', line 685

def reset_timer
  @limit_time = nil
end

#rest_time ⇒ Object 



681
682
683
 
# File 'lib/rabbit/canvas.rb', line 681

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

#save_as_image ⇒ Object 



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

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 



260
261
262
263
264
265
 
# File 'lib/rabbit/canvas.rb', line 260

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

#slide_indexes(pattern) ⇒ Object 



267
268
269
270
271
272
273
 
# File 'lib/rabbit/canvas.rb', line 267

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

#slide_size ⇒ Object 



275
276
277
 
# File 'lib/rabbit/canvas.rb', line 275

def slide_size
  slides.size
end

#slide_text(index = current_index) ⇒ Object 



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

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 



230
231
232
233
234
235
236
237
238
239
 
# File 'lib/rabbit/canvas.rb', line 230

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 



248
249
250
251
252
253
254
 
# File 'lib/rabbit/canvas.rb', line 248

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

#source ⇒ Object 



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

def source
  @source.read
end

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

Yields:



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

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 



583
584
585
586
587
588
589
590
591
592
593
594
595
 
# File 'lib/rabbit/canvas.rb', line 583

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 



677
678
679
 
# File 'lib/rabbit/canvas.rb', line 677

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

#stop_auto_redraw_timer ⇒ Object 



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

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

#theme_name ⇒ Object 



334
335
336
 
# File 'lib/rabbit/canvas.rb', line 334

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

#title ⇒ Object 



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

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

#title_slide ⇒ Object 



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

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

#tmp_dir_name ⇒ Object 



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

def tmp_dir_name
  @source and @source.tmp_dir_name
end

#to_pixbuf(i) ⇒ Object 



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

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

#toggle_index_mode ⇒ Object 



512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
 
# File 'lib/rabbit/canvas.rb', line 512

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 



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

def unfullscreened
  @renderer.post_unfullscreen
end

#update_index_slides ⇒ Object 



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

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

#use_gl? ⇒ Boolean

Returns:

  • (Boolean) 


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

def use_gl?
  @use_gl
end

#with_index_mode(new_value) ⇒ Object 



651
652
653
654
655
656
657
658
 
# File 'lib/rabbit/canvas.rb', line 651

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