tuile 0.2.0 → 0.4.0

data/lib/tuile/mouse_event.rb

@@ -5,7 +5,7 @@ module Tuile
   #
   # @!attribute [r] button
   #   @return [Symbol, nil] one of `:left`, `:middle`, `:right`, `:scroll_up`,
-  #     `:scroll_down`; `nil` if not known.
+  #     `:scroll_down`, `:scroll_left`, `:scroll_right`; `nil` if not known.
   # @!attribute [r] x
   #   @return [Integer] x coordinate, 0-based.
   # @!attribute [r] y
@@ -14,17 +14,34 @@ module Tuile
     # @return [Point] the event's position.
     def point = Point.new(x, y)
 
-    # Checks whether given key is a mouse event key
+    # Checks whether given key is a mouse event key. Returns true on the X10
+    # `\e[M` prefix regardless of length — {.parse} is the place that
+    # validates the full 6-byte shape and raises on malformed input.
     # @param key [String] key read via {Keys.getkey}
     # @return [Boolean] true if it is a mouse event
     def self.mouse_event?(key)
-      key.start_with?("\e[M") && key.size >= 6
+      key.start_with?("\e[M")
     end
 
+    # Parses an X10 mouse report (`\e[M` + 3 bytes: button, x, y).
+    #
+    # Raises {Tuile::Error} when `key` starts with the mouse prefix but is
+    # not exactly 6 bytes long. Both shorter and longer inputs are bugs in
+    # the upstream key-reader: a shorter prefix means the tail was lost on
+    # the way in, and a longer one means we over-consumed into the next
+    # escape sequence. We refuse to silently truncate either case because
+    # the trailing `\e` of an over-read corrupts the *next* getkey, and the
+    # corruption then surfaces as garbled keystrokes in focused inputs
+    # rather than as a parser failure pointing at the actual cause.
     # @param key [String] key read via {Keys.getkey}
-    # @return [MouseEvent, nil]
+    # @return [MouseEvent, nil] `nil` if `key` is not a mouse event
+    # @raise [Tuile::Error] if `key` is a malformed mouse event
     def self.parse(key)
       return nil unless mouse_event?(key)
+      unless key.bytesize == 6
+        raise Tuile::Error,
+              "malformed mouse event: expected 6 bytes after \\e[M prefix, got #{key.bytesize}: #{key.inspect}"
+      end
 
       button = key[3].ord - 32
       # XTerm reports coordinates 1-based (column N is encoded as N + 32);
@@ -37,6 +54,8 @@ module Tuile
                when 1 then :middle
                when 64 then :scroll_up
                when 65 then :scroll_down
+               when 66 then :scroll_left
+               when 67 then :scroll_right
                end
       MouseEvent.new(button, x, y)
     end

data/lib/tuile/screen.rb

@@ -39,8 +39,17 @@ module Tuile
       # stack and status bar.
       @pane = ScreenPane.new
       @on_error = ->(e) { raise e }
+      # App-level keyboard shortcuts dispatched by {#handle_key} before keys
+      # reach the pane. See {#register_global_shortcut}.
+      @global_shortcuts = {}
     end
 
+    # Entry in the global shortcut registry: the block to run, whether it
+    # pre-empts open popups, and an optional preformatted status-bar hint.
+    # @api private
+    Shortcut = Data.define(:block, :over_popups, :hint)
+    private_constant :Shortcut
+
     # @return [ScreenPane] the structural root of the component tree.
     attr_reader :pane
 
@@ -148,15 +157,45 @@ module Tuile
         @pane.on_tree { it.active = active.include?(it) }
         @focused.on_focus
       end
-      # Popups own their own "q Close" prefix in #keyboard_hint; for the tiled
-      # case Screen tacks on the global "q quit" instead.
+      refresh_status_bar
+    end
+
+    # Rebuild the status-bar text from the current focus and global-shortcut
+    # registry. Called from {#focused=} and whenever the global registry
+    # changes. Popups own their own "q Close" prefix in `#keyboard_hint`;
+    # for the tiled case Screen tacks on the global "q quit" instead.
+    # Global-shortcut hints get spliced in too — see {#global_shortcut_hints}
+    # for the over_popups filter rule.
+    # @api private
+    # @return [void]
+    def refresh_status_bar
       top_popup = @pane.popups.last
+      globals = global_shortcut_hints(popup_open: !top_popup.nil?)
       @pane.status_bar.text = if top_popup.nil?
-                                "q #{Rainbow("quit").cadetblue}  #{active_window&.keyboard_hint}".strip
+                                ["q #{Rainbow("quit").cadetblue}", *globals,
+                                 active_window&.keyboard_hint].compact.reject(&:empty?).join("  ")
                               else
-                                top_popup.keyboard_hint
+                                [*globals, top_popup.keyboard_hint].reject(&:empty?).join("  ")
                               end
     end
+    private :refresh_status_bar
+
+    # Status-bar hints from currently-registered global shortcuts.
+    # When a popup is open, only `over_popups: true` shortcuts contribute —
+    # the rest don't fire in that context, so showing them would be a lie.
+    # Insertion order is preserved (Hash iteration order).
+    # @api private
+    # @param popup_open [Boolean]
+    # @return [Array<String>]
+    def global_shortcut_hints(popup_open:)
+      @global_shortcuts.each_value.filter_map do |s|
+        next if s.hint.nil? || s.hint.empty?
+        next if popup_open && !s.over_popups
+
+        s.hint
+      end
+    end
+    private :global_shortcut_hints
 
     # Internal — use {Component::Popup#open} instead. Adds the popup to
     # {#pane}, centers and focuses it.
@@ -172,16 +211,24 @@ module Tuile
 
     # Runs event loop – waits for keys and sends them to active window. The
     # function exits when the 'ESC' or 'q' key is pressed.
+    #
+    # @param capture_mouse [Boolean] when true (default), enables xterm mouse
+    #   tracking so clicks and scroll wheel arrive as {MouseEvent}s and feed
+    #   {Component#handle_mouse}. When false, no tracking escape sequence is
+    #   written: the terminal keeps its native click handling, which is what
+    #   you want if the app benefits more from select-to-copy than from
+    #   click-to-focus. Components' `handle_mouse` is simply never invoked
+    #   from the loop in that mode (the terminal stops sending the bytes).
     # @return [void]
-    def run_event_loop
+    def run_event_loop(capture_mouse: true)
       @pretend_ui_lock = false
       $stdin.echo = false
-      print MouseEvent.start_tracking
+      print MouseEvent.start_tracking if capture_mouse
       $stdin.raw do
         event_loop
       end
     ensure
-      print MouseEvent.stop_tracking
+      print MouseEvent.stop_tracking if capture_mouse
       print TTY::Cursor.show
       $stdin.echo = true
     end
@@ -197,6 +244,80 @@ module Tuile
     # @return [Boolean] true if focus moved.
     def focus_previous = cycle_focus(forward: false)
 
+    # Registers an app-level keyboard shortcut. When `key` arrives, the block
+    # is invoked on the event-loop thread (so it may freely mutate UI) before
+    # the key reaches any component. Re-registering the same key replaces the
+    # previous binding; use {#unregister_global_shortcut} to remove one.
+    #
+    # Only unprintable keys are accepted — control characters (Ctrl+letter,
+    # ESC, BACKSPACE, ENTER, …) and multi-character escape sequences (arrows,
+    # F-keys, …). Printable keys raise {ArgumentError}: they'd hijack typing
+    # into a {Component::TextField} and should be expressed as
+    # {Component#key_shortcut} instead, which the dispatcher suppresses while
+    # a text widget owns the hardware cursor. TAB and SHIFT_TAB are also
+    # rejected because {#handle_key} intercepts them for focus navigation
+    # before the global registry is consulted, so a binding on them would
+    # silently never fire.
+    #
+    # Pass `hint:` to surface the shortcut in the status bar. It's a
+    # preformatted string the caller fully owns (so colors and the key label
+    # style stay consistent with whatever the host app uses elsewhere). The
+    # framework splices it in like any other status hint: in the tiled case,
+    # right after `q quit` and before the active window's own hint; while a
+    # popup is open, only hints from `over_popups: true` shortcuts are
+    # shown, and they're prepended before the popup's `q Close`.
+    #
+    # Example — open a log popup with Ctrl+L from anywhere, even while a
+    # popup is already on screen:
+    #
+    #   screen.register_global_shortcut(Keys::CTRL_L,
+    #                                   over_popups: true,
+    #                                   hint: "^L #{Rainbow("log").cadetblue}") do
+    #     log_popup.open
+    #   end
+    #
+    # @param key [String] unprintable key (e.g. {Keys::CTRL_L}, {Keys::ESC},
+    #   {Keys::PAGE_UP}).
+    # @param over_popups [Boolean] when true, fires even while a modal popup
+    #   is open (pre-empting the popup's own key handling). When false
+    #   (default), the shortcut is suppressed while any popup is open and
+    #   the popup gets the key instead.
+    # @param hint [String, nil] preformatted status-bar hint (e.g.
+    #   `"^L #{Rainbow("log").cadetblue}"`). When nil (default) the shortcut
+    #   is silent in the status bar.
+    # @yield invoked with no arguments when `key` is pressed.
+    # @return [void]
+    def register_global_shortcut(key, over_popups: false, hint: nil, &block)
+      raise ArgumentError, "block required" if block.nil?
+      raise ArgumentError, "key must be a String, got #{key.inspect}" unless key.is_a?(String)
+      raise ArgumentError, "key cannot be empty" if key.empty?
+      if Keys.printable?(key)
+        raise ArgumentError,
+              "global shortcut key must be unprintable; got #{key.inspect}. " \
+              "Use Component#key_shortcut for printable keys (it's suppressed " \
+              "while a text widget owns the cursor, so it won't hijack typing)."
+      end
+      if [Keys::TAB, Keys::SHIFT_TAB].include?(key)
+        raise ArgumentError,
+              "#{key == Keys::TAB ? "TAB" : "SHIFT_TAB"} is reserved for focus navigation"
+      end
+      unless hint.nil? || hint.is_a?(String)
+        raise ArgumentError, "hint must be a String or nil, got #{hint.inspect}"
+      end
+
+      @global_shortcuts[key] = Shortcut.new(block: block, over_popups: over_popups, hint: hint)
+      refresh_status_bar
+    end
+
+    # Removes a shortcut previously installed by {#register_global_shortcut}.
+    # No-op if `key` was not registered.
+    # @param key [String]
+    # @return [void]
+    def unregister_global_shortcut(key)
+      @global_shortcuts.delete(key)
+      refresh_status_bar
+    end
+
     # @return [Component, nil] current active tiled component.
     def active_window
       check_locked
@@ -289,6 +410,14 @@ module Tuile
       @frame_buffer = +""
       begin
         until @invalidated.empty?
+          # Defensive filter: a component can become detached between enqueue
+          # and drain (popup close, sibling removed mid-event-handling, focus
+          # repair). Detached components have no place on the screen and must
+          # never paint, even though Component#invalidate already gates them
+          # out — this catches the case where attachment changed since.
+          @invalidated.delete_if { |c| !c.attached? }
+          break if @invalidated.empty?
+
           did_paint = true
           popups = @pane.popups
 
@@ -417,10 +546,17 @@ module Tuile
     # A key has been pressed on the keyboard. Handle it, or forward to active
     # window.
     #
-    # Tab / Shift+Tab are reserved navigation keys: intercepted here before
-    # the pane sees them, so a focused {Component::TextField} (which would
-    # otherwise swallow printable keys via the standard cursor-owner
-    # suppression) doesn't trap them.
+    # Dispatch order:
+    #   1. Tab / Shift+Tab — reserved focus navigation, intercepted before
+    #      anything else so a focused {Component::TextField} (which would
+    #      otherwise swallow printable keys via cursor-owner suppression)
+    #      doesn't trap them.
+    #   2. App-level shortcuts from {#register_global_shortcut}. An entry
+    #      registered with `over_popups: true` always fires; one with the
+    #      default `over_popups: false` fires only when no popup is open
+    #      (otherwise the popup receives the key normally).
+    #   3. {ScreenPane#handle_key}, which routes to the topmost popup or
+    #      tiled content.
     # @param key [String]
     # @return [Boolean] true if the key was handled by some window.
     def handle_key(key)
@@ -432,7 +568,13 @@ module Tuile
         focus_previous
         true
       else
-        @pane.handle_key(key)
+        shortcut = @global_shortcuts[key]
+        if !shortcut.nil? && (shortcut.over_popups || @pane.popups.empty?)
+          shortcut.block.call
+          true
+        else
+          @pane.handle_key(key)
+        end
       end
     end