rabbit 3.0.4 → 4.0.0

data/lib/rabbit/canvas.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2004-2024  Sutou Kouhei <kou@cozmixng.org>
+# Copyright (C) 2004-2025  Sutou Kouhei <kou@cozmixng.org>
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -15,17 +15,19 @@
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 require "forwardable"
-require "rabbit/gtk"
-
-require "rabbit/rabbit"
-require "rabbit/filename"
-require "rabbit/frame"
-require "rabbit/element"
-require "rabbit/parser"
-require "rabbit/theme/manager"
-require "rabbit/front"
-require "rabbit/action"
-require "rabbit/html/generator"
+
+require_relative "gtk"
+
+require_relative "actions"
+require_relative "element"
+require_relative "filename"
+require_relative "frame"
+require_relative "front"
+require_relative "html/generator"
+require_relative "key-handler"
+require_relative "parser"
+require_relative "rabbit"
+require_relative "theme/manager"
 
 module Rabbit
   class Canvas
@@ -118,14 +120,16 @@ module Rabbit
     def_delegators(:@renderer, :graffiti_line_width, :graffiti_line_width=)
 
     def_delegators(:@renderer, :toggle_info_window)
-    def_delegators(:@renderer, :toggle_spotlight, :toggle_magnifier)
+    def_delegators(:@renderer, :info_window_showing?)
+    def_delegators(:@renderer, :toggle_spotlight)
+    def_delegators(:@renderer, :spotlighting?)
+    def_delegators(:@renderer, :toggle_magnifier)
+    def_delegators(:@renderer, :magnifying?)
 
     def_delegators(:@renderer, :add_gesture_action)
 
     def_delegators(:@renderer, :post_init_gui)
 
-    def_delegators(:@renderer, :connect_key, :disconnect_key)
-
     def_delegators(:@renderer, :expand_hole, :narrow_hole)
 
     def_delegators(:@renderer, :search_slide, :stop_slide_search, :searching?)
@@ -134,7 +138,7 @@ module Rabbit
 
     def_delegators(:@source, :source=, :reset, :base)
 
-    attr_reader :logger, :renderer, :last_modified
+    attr_reader :renderer, :last_modified
     attr_reader :comments, :actions
 
     attr_writer :saved_image_base_name
@@ -147,8 +151,7 @@ module Rabbit
     attr_accessor :font_resolution_ratio
     attr_accessor :max_n_comments, :comment_theme
 
-    def initialize(logger, renderer)
-      @logger = logger
+    def initialize(renderer_class)
       @frame = NullFrame.new
       @theme_name = nil
       @saved_image_base_name = nil
@@ -169,9 +172,17 @@ module Rabbit
       @max_n_comments = 100
       @allotted_time = nil
       @comment_theme = nil
+      @index_mode = false
+      @key_handler = nil
       clear
-      @renderer = renderer.new(self)
-      @actions = Action.action_group(self)
+      @renderer = renderer_class.new(self)
+      @actions = Actions.new(self)
+    end
+
+    def logger
+      message = "Rabbit::Canvas#logger is deprecated. Use Rabbit.logger instead."
+      Rabbit.logger.warn(message)
+      Rabbit.logger
     end
 
     def quitted?
@@ -201,11 +212,15 @@ module Rabbit
 
     def attach_to(frame, window, container=nil, &block)
       @frame = frame if frame
-      @renderer.attach_to(window, container, &block) if window
+      if window
+        @key_handler = KeyHandler.new(self, window)
+        @renderer.attach_to(window, container, &block)
+      end
     end
 
     def detach
       @frame = NullFrame.new
+      @key_handler&.detach
       @renderer.detach
     end
 
@@ -263,10 +278,17 @@ module Rabbit
       indexes
     end
 
-    def slide_size
+    def n_slides
       slides.size
     end
 
+    def slide_size
+      warn("#{self.class.name}\##{__method__} is deprecated. " +
+           "Use \#n_slides instead.",
+           category: :deprecated)
+      n_slides
+    end
+
     def current_slide
       slide = slides[current_index]
       if slide
@@ -294,7 +316,7 @@ module Rabbit
         index = @current_index
         @current_index = new_index
       end
-      if 0 <= current_index and current_index < slide_size
+      if 0 <= current_index and current_index < n_slides
         yield
       end
     ensure
@@ -368,7 +390,7 @@ module Rabbit
         if block_given?
           yield($!)
         else
-          logger.warn($!.message)
+          Rabbit.logger.warn($!.message)
         end
       ensure
         @parse_request_queue.delete_if {|x| x == id}
@@ -431,11 +453,21 @@ module Rabbit
       @renderer.post_iconify
     end
 
+    def connect_key(keyval, modifier, flags, &block)
+      @key_handler.connect_key(keyval, modifier, flags, &block) if @key_handler
+    end
+
+    def disconnect_key(keyval, modifier)
+      @key_handler.disconnect_key(keyval, modifier) if @key_handler
+    end
+
     def pre_terminal
       @renderer.pre_terminal
+      @key_handler.pre_terminal if @key_handler
     end
 
     def post_terminal
+      @key_handler.post_terminal if @key_handler
       @renderer.post_terminal
     end
 
@@ -450,7 +482,7 @@ module Rabbit
     end
 
     def move_to_if_can(index)
-      if index and 0 <= index and index < slide_size
+      if index and 0 <= index and index < n_slides
         move_to(index)
       end
       current_index
@@ -461,7 +493,7 @@ module Rabbit
       if slide and !slide.last?
         old_index = slide.drawing_index
         slide.move_to_next
-        Action.update_status(self)
+        @actions.update_status
         @renderer.post_move_in_slide(old_index, slide.drawing_index)
       else
         move_to_next_slide_if_can
@@ -477,7 +509,7 @@ module Rabbit
       if slide and !slide.first?
         old_index = slide.drawing_index
         slide.move_to_previous
-        Action.update_status(self)
+        @actions.update_status
         @renderer.post_move_in_slide(old_index, slide.drawing_index)
       else
         move_to_previous_slide_if_can
@@ -493,7 +525,7 @@ module Rabbit
     end
 
     def move_to_last
-      move_to(slide_size - 1)
+      move_to(n_slides - 1)
     end
 
     def index_mode?
@@ -538,7 +570,7 @@ module Rabbit
     end
 
     def last_slide?
-      slide_size.zero? or current_index == (slide_size - 1)
+      n_slides.zero? or current_index == (n_slides - 1)
     end
 
     def have_previous_slide?
@@ -552,7 +584,7 @@ module Rabbit
     end
 
     def have_next_slide?
-      slide_size - 1 > current_index
+      n_slides - 1 > current_index
     end
 
     def have_next?
@@ -609,7 +641,7 @@ module Rabbit
         begin
           callback.call(comment)
         rescue
-          logger.error($!)
+          Rabbit.logger.error($!)
         end
       end
       true
@@ -619,10 +651,10 @@ module Rabbit
       @slides.find{|x| x.is_a?(Element::TitleSlide)}
     end
 
-    def activate(name, &block)
+    def activate(name, argument=nil)
       act = action(name)
-      if act and act.sensitive?
-        act.activate(&block)
+      if act and act.enabled?
+        act.activate(argument)
         true
       else
         false
@@ -630,11 +662,11 @@ module Rabbit
     end
 
     def action(name)
-      act = @actions.get_action(name)
+      act = @actions[name]
       if act
         act
       else
-        logger.warn(_("Unknown action: %s") % name)
+        Rabbit.logger.warn(_("Unknown action: %s") % name)
         false
       end
     end
@@ -707,7 +739,7 @@ module Rabbit
         success = false
         index_mode = @index_mode
         begin
-          Action.update_status(self)
+          @actions.update_status
           clear_theme
           clear_index_slides
           manager = Theme::Manager.new(self) do
@@ -722,7 +754,7 @@ module Rabbit
         rescue ApplyFinish
         ensure
           @apply_theme_request_queue.delete_if {|x| x == id}
-          Action.update_status(self)
+          @actions.update_status
         end
         activate("ToggleIndexMode") if success and index_mode
       end
@@ -730,16 +762,16 @@ module Rabbit
 
     def process
       if @processing
-        @logger.info(_("Processing..."))
+        Rabbit.logger.info(_("Processing..."))
         return
       end
       begin
         @processing = true
-        Action.update_status(self)
+        @actions.update_status
         yield
       ensure
         @processing = false
-        Action.update_status(self)
+        @actions.update_status
       end
     end
 
@@ -806,7 +838,7 @@ module Rabbit
     def move_to(index)
       old_index = current_index
       set_current_index(index)
-      Action.update_status(self)
+      @actions.update_status
       @renderer.post_move(old_index, current_index)
     end
   end

data/lib/rabbit/command/rabbit-slide.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2012-2021  Sutou Kouhei <kou@cozmixng.org>
+# Copyright (C) 2012-2025  Sutou Kouhei <kou@cozmixng.org>
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -16,11 +16,11 @@
 
 require "yaml"
 
-require "rabbit/author-configuration"
-require "rabbit/console"
-require "rabbit/path-manipulatable"
-require "rabbit/slide-configuration"
-require "rabbit/source-generator"
+require_relative "../author-configuration"
+require_relative "../console"
+require_relative "../path-manipulatable"
+require_relative "../slide-configuration"
+require_relative "../source-generator"
 
 module Rabbit
   module Command
@@ -63,7 +63,6 @@ module Rabbit
       def initialize
         @use_gui = true
         @data = Data.new
-        @logger = nil
       end
 
       def run(arguments)
@@ -76,7 +75,7 @@ module Rabbit
         validate
         unless @validation_errors.empty?
           messages = (@validation_errors + [_("See --help for example")])
-          @logger.error(messages.join("\n"))
+          Rabbit.logger.error(messages.join("\n"))
           return false
         end
 
@@ -95,10 +94,9 @@ module Rabbit
 
       def setup_options(parser, options)
         @options = options
-        @logger = @options.default_logger
-        @data.author_conf = AuthorConfiguration.new(@logger)
+        @data.author_conf = AuthorConfiguration.new
         @data.author_conf.load
-        @data.slide_conf = SlideConfiguration.new(@logger)
+        @data.slide_conf = SlideConfiguration.new
         @data.slide_conf.author = @data.author_conf
 
         format = _("Usage: %s COMMAND [OPTIONS]\n" \
@@ -439,7 +437,7 @@ module Rabbit
       end
 
       def show_gui
-        require "rabbit/gtk"
+        require_relative "../gtk"
 
         mappers = build_gui_mappers
 
@@ -506,7 +504,7 @@ module Rabbit
       end
 
       def merge_config_yaml
-        existing_slide_conf = SlideConfiguration.new(@logger)
+        existing_slide_conf = SlideConfiguration.new
         existing_slide_conf.load
         existing_slide_conf.merge!(@data.slide_conf.to_hash)
         @data.slide_conf = existing_slide_conf

data/lib/rabbit/command/rabbit-theme.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2012  Kouhei Sutou <kou@cozmixng.org>
+# Copyright (C) 2012-2025  Sutou Kouhei <kou@cozmixng.org>
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -16,11 +16,11 @@
 
 require "yaml"
 
-require "rabbit/console"
-require "rabbit/author-configuration"
-require "rabbit/theme-configuration"
-require "rabbit/path-manipulatable"
-require "rabbit/source-generator"
+require_relative "../console"
+require_relative "../author-configuration"
+require_relative "../theme-configuration"
+require_relative "../path-manipulatable"
+require_relative "../source-generator"
 
 module Rabbit
   module Command
@@ -37,16 +37,15 @@ module Rabbit
       def initialize
         @theme_conf = nil
         @author_conf = nil
-        @logger = nil
       end
 
       def run(arguments)
-        @options, @logger = parse_command_line_arguments(arguments)
+        @options = parse_command_line_arguments(arguments)
 
         validate
         unless @validation_errors.empty?
           messages = (@validation_errors + [_("See --help for example")])
-          @logger.error(messages.join("\n"))
+          Rabbit.logger.error(messages.join("\n"))
           return false
         end
 
@@ -58,10 +57,9 @@ module Rabbit
       private
       def parse_command_line_arguments(arguments)
         Rabbit::Console.parse!(ARGV) do |parser, options|
-          @logger = options.default_logger
-          @author_conf = AuthorConfiguration.new(@logger)
+          @author_conf = AuthorConfiguration.new
           @author_conf.load
-          @theme_conf = ThemeConfiguration.new(@logger)
+          @theme_conf = ThemeConfiguration.new
           @theme_conf.author = @author_conf
 
           format = _("Usage: %s new [options]\n" \

data/lib/rabbit/command/rabbit.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2004-2024  Sutou Kouhei <kou@cozmixng.org>
+# Copyright (C) 2004-2025  Sutou Kouhei <kou@cozmixng.org>
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -16,8 +16,8 @@
 
 require "English"
 
-require "rabbit/gettext"
-require "rabbit/slide-configuration"
+require_relative "../rabbit"
+require_relative "../slide-configuration"
 
 module Rabbit
   module Command
@@ -30,27 +30,24 @@ module Rabbit
         end
       end
 
-      def initialize
-        @logger = nil
-      end
-
       def run(arguments)
         GC.disable
         require "rbconfig"
 
-        require "rabbit/console"
-        require "rabbit/source"
-        require "rabbit/renderer"
-        require "rabbit/front"
+        require_relative "../console"
+        require_relative "../front"
+        require_relative "../renderer"
+        require_relative "../source"
 
-        @options, @logger = parse_command_line_arguments(arguments)
+        @options = parse_command_line_arguments(arguments)
 
-        require "rabbit/canvas"
+        require_relative "../canvas"
         GC.enable
 
         application = ::Rabbit.application
         succeeded = false
         application.signal_connect("command-line") do |_, command_line|
+          GLib.application_name = "Rabbit"
           application.activate
           succeeded ? 0 : 1
         end
@@ -61,7 +58,7 @@ module Rabbit
               __send__("do_#{@options.action}")
             end
           rescue
-            @logger.error($!)
+            ::Rabbit.logger.error($!)
           end
         end
         exit_code = application.run
@@ -74,8 +71,6 @@ module Rabbit
       private
       def parse_command_line_arguments(arguments)
         Console.parse!(arguments) do |parser, options|
-          @logger = options.logger
-
           rest_arguments_from_options_file = []
           options.before_hooks << lambda do |_, _, _|
             rest_arguments_from_options_file = options.rest.dup
@@ -608,8 +603,8 @@ module Rabbit
         source = options.rest[0]
         if /\.gem\z/i =~ source
           gem_name = $PREMATCH
-          require "rabbit/gem-finder"
-          finder = GemFinder.new(@logger)
+          require_relative "../gem-finder"
+          finder = GemFinder.new
           spec = finder.find(gem_name, "#{SlideConfiguration::GEM_NAME_PREFIX}-")
           source = spec.gem_dir if spec
         end
@@ -622,7 +617,7 @@ module Rabbit
       end
 
       def make_canvas(renderer)
-        canvas = Canvas.new(@logger, renderer)
+        canvas = Canvas.new(renderer)
         canvas.comment_theme = @options.comment_theme
         canvas.allotted_time = @options.allotted_time
         canvas
@@ -673,8 +668,7 @@ module Rabbit
         if @options.source_type == Source::ARGF
           rest_arguments = [ARGF]
         end
-        source = @options.source_type.new(@options.encoding, @logger,
-                                          *rest_arguments)
+        source = @options.source_type.new(@options.encoding, *rest_arguments)
         source.base = @options.base if @options.base
         source
       end
@@ -746,16 +740,16 @@ module Rabbit
         require "drb/drb"
         begin
           DRb.start_service(@options.druby_uri, front)
-          @logger.info(DRb.uri) if @options.output_druby_uri
+          ::Rabbit.logger.info(DRb.uri) if @options.output_druby_uri
         rescue SocketError
-          @logger.error($!)
+          ::Rabbit.logger.error($!)
         rescue Errno::EADDRINUSE
-          @logger.error(_("dRuby URI <%s> is in use.") % @options.druby_uri)
+          ::Rabbit.logger.error(_("dRuby URI <%s> is in use.") % @options.druby_uri)
         end
       end
 
       def setup_soap(front)
-        require "rabbit/soap/server"
+        require_relative "../soap/server"
         thread = nil
 
         begin
@@ -763,20 +757,20 @@ module Rabbit
             :BindAddress => @options.soap_host,
             :Port => @options.soap_port,
             :AddressFamily => Socket::AF_INET,
-            :Logger => @logger,
+            :Logger => ::Rabbit.logger,
           }
           server = Rabbit::SOAP::Server.new(front, config)
           prev = trap(:INT) {server.shutdown; trap(:INT, prev)}
           thread = Thread.new {server.start}
         rescue Errno::EADDRINUSE
-          @logger.error(_("port <%s> for SOAP is in use.") % @options.soap_port)
+          ::Rabbit.logger.error(_("port <%s> for SOAP is in use.") % @options.soap_port)
         end
 
         thread
       end
 
       def setup_xmlrpc(front)
-        require "rabbit/xmlrpc/server"
+        require_relative "../xmlrpc/server"
         thread = nil
 
         begin
@@ -784,13 +778,13 @@ module Rabbit
             :BindAddress => @options.xmlrpc_host,
             :Port => @options.xmlrpc_port,
             :AddressFamily => Socket::AF_INET,
-            :Logger => @logger,
+            :Logger => ::Rabbit.logger,
           }
           server = Rabbit::XMLRPC::Server.new(front, config)
           prev = trap(:INT) {server.shutdown; trap(:INT, prev)}
           thread = Thread.new {server.start}
         rescue Errno::EADDRINUSE
-          @logger.error(_("port <%s> for XML-RPC is in use.") % @options.xmlrpc_port)
+          ::Rabbit.logger.error(_("port <%s> for XML-RPC is in use.") % @options.xmlrpc_port)
         end
 
         thread
@@ -809,7 +803,7 @@ module Rabbit
         canvas.quit
         true
       rescue ::Rabbit::NoPrintSupportError
-        @logger.error($!.message)
+        ::Rabbit.logger.error($!.message)
         false
       end
 
@@ -831,19 +825,13 @@ module Rabbit
       end
 
       def do_display
-        display_init_options = {}
-        if @options.use_gl
-          display_init_options[:preferred_class_name] = "ClutterEmbed"
-        end
-        Renderer::Display.init(display_init_options)
-
         source = make_source
-        if ENV["RABBIT_RENDERER"] == "screen"
-          canvas = make_canvas(Renderer::Screen)
+        if Gtk::Version::MAJOR >= 4
+          canvas = make_canvas(Renderer::Scene)
         else
-          canvas = make_canvas(Renderer::Display)
+          canvas = make_canvas(Renderer::Display::DrawingArea)
         end
-        frame = Frame.new(@logger, canvas)
+        frame = Frame.new(canvas)
         frame.geometry = @options.geometry
         setup_base_size(canvas)
         setup_paper_size(canvas)
@@ -856,7 +844,7 @@ module Rabbit
         if @options.show_native_window_id
           native_surface = frame.window.surface
           if native_surface.respond_to?(:xid)
-            @logger.info(_("Window ID: %d") % native_surface.xid)
+            ::Rabbit.logger.info(_("Window ID: %d") % native_surface.xid)
           end
         end
         apply_theme_if_need(frame)
@@ -885,7 +873,7 @@ module Rabbit
         end
 
         if exception
-          @logger.info(exception.message)
+          ::Rabbit.logger.info(exception.message)
           false
         else
           true