echoes 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c05df4a1ad800e1b7e982aa2577a2bd6c64bfe15ec4c630aff8a561b53992072
-  data.tar.gz: dc78e9e8813c237375818a76e87b3a756cf9431e0dfb78da331cb5e8b309ca5a
+  metadata.gz: 840cfd55fa04459db94048feb0ace4ac1fcd24afe1be90782f90ad10ee849c3f
+  data.tar.gz: 93f77b0d7360472791d898ceef10049a72019ef3facacbe73280648f740eb929
 SHA512:
-  metadata.gz: 8fd75f4eff8db332e59669df7359c0a0a904d9b879da99dcd33aa4dfb053a28869f80e556b9f783c6e362b8b34397ffab264d59a0aeda9c76244ad639d187dfa
-  data.tar.gz: 53a1aa9d6ee94264a31fb68c9f94ff5289415540e48461031a9b91cf52b31f8706bd9fce89dee880b2d1546c94b25605c4955545fefa0475b5aeb4c2908b8920
+  metadata.gz: 68c56c9b24cf3bd2456cea2b559bff0d7e4a25df9562561c6d29b79b0a9f54b171074f5dcc6cbf0731336037821ddd641f95295f1bfc81ae158e080089be2210
+  data.tar.gz: 9f86318197b4796b239013d626fdbf0e2214a5fa343c215c56518fdd77f25bce3c04995929840b496dbb1d8fa61bd3c769db4eb794ea45a7d47fa6808c97b1ca

data/lib/echoes/client.rb

@@ -62,6 +62,20 @@ module Echoes
       nil
     end
 
+    # Ask Echoes to write the current pane to `path`. Format is
+    # picked from the file extension: `.png` produces a rasterized
+    # PNG; anything else (including `.pdf`) produces a vector PDF
+    # via [NSView dataWithPDFInsideRect:] — typically much smaller
+    # than the PNG equivalent for terminal content. The path should
+    # be absolute. There's no reply on the wire; the caller polls
+    # the filesystem. Other terminals ignore the OSC, so the call
+    # is a no-op outside Echoes (no file gets written).
+    def capture(path, io: $stdout)
+      io.write("#{OSC};capture;#{path}#{BEL}")
+      io.flush if io.respond_to?(:flush)
+      nil
+    end
+
     # Drop any pane background override (bg-color/bg-gradient) AND
     # all bg-fill overlays. Safe to call when nothing is set.
     def bg_clear(io: $stdout)
@@ -70,15 +84,18 @@ module Echoes
       nil
     end
 
-    # Emit text via OSC 66 (multicell), with optional cell-scale,
-    # sub-cell fraction, vertical/horizontal alignment, and font
-    # family. `family:` is an Echoes-specific extension other
-    # terminals ignore. On unknown families, Echoes falls back to the
-    # monospaced system font.
+    # Emit scaled / aligned multicell text. Routes through OSC 66
+    # (the kitty-compatible spec, portable across terminals) when
+    # only standard knobs are used, and through OSC 7772 ;multicell
+    # (Echoes-private) when an extension param like `family:` is
+    # set. On unknown families, Echoes falls back to the monospaced
+    # system font; non-Echoes terminals ignore the whole OSC 7772
+    # frame, so the text just doesn't render — same trade as any
+    # private OSC.
     #
     # Examples:
-    #   Echoes::Client.styled_text("Title",   scale: 3, family: "Helvetica Neue")
-    #   Echoes::Client.styled_text("• item",  scale: 1, family: "Menlo")
+    #   Echoes::Client.styled_text("Title",  scale: 3)                          # OSC 66, portable
+    #   Echoes::Client.styled_text("Title",  scale: 3, family: "Helvetica Neue") # OSC 7772, Echoes-only
     def styled_text(text, scale: 1, width: nil, frac_n: nil, frac_d: nil,
                     valign: nil, halign: nil, family: nil, io: $stdout)
       meta = +"s=#{scale}"
@@ -87,8 +104,12 @@ module Echoes
       meta << ":d=#{frac_d}"  if frac_d
       meta << ":v=#{valign}"  if valign
       meta << ":h=#{halign}"  if halign
-      meta << ":f=#{family}"  if family
-      io.write("\e]66;#{meta};#{text}\a")
+      if family
+        meta << ":f=#{family}"
+        io.write("\e]7772;multicell;#{meta};#{text}\a")
+      else
+        io.write("\e]66;#{meta};#{text}\a")
+      end
       io.flush if io.respond_to?(:flush)
       nil
     end

data/lib/echoes/configuration.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative 'profile'
+
 module Echoes
   class Configuration
     def initialize
@@ -21,6 +23,36 @@ module Echoes
       @pane_divider_color = [0.4, 0.4, 0.4]
       @active_pane_border_color = [0.3, 0.5, 0.8]
       @copy_mode_cursor_color = [0.8, 0.7, 0.2]
+      register_default_profiles
+    end
+
+    # Two opinionated-but-recognizable profiles ship with Echoes so
+    # the View → Profile submenu has alternatives the moment the
+    # user opens it, without forcing them to write any DSL. Users
+    # can declare more (or override these) in their config file —
+    # `profile "Solarized Dark" do …` redeclaring an existing name
+    # replaces the entry.
+    def register_default_profiles
+      profile "Solarized Dark" do
+        foreground "#93a1a1"
+        background "#002b36"
+        cursor_color "#93a1a1"
+        selection_color "#586e75"
+        color_palette %w[
+          #073642 #dc322f #859900 #b58900 #268bd2 #d33682 #2aa198 #eee8d5
+          #002b36 #cb4b16 #586e75 #657b83 #839496 #6c71c4 #93a1a1 #fdf6e3
+        ]
+      end
+      profile "Solarized Light" do
+        foreground "#586e75"
+        background "#fdf6e3"
+        cursor_color "#586e75"
+        selection_color "#93a1a1"
+        color_palette %w[
+          #073642 #dc322f #859900 #b58900 #268bd2 #d33682 #2aa198 #eee8d5
+          #002b36 #cb4b16 #586e75 #657b83 #839496 #6c71c4 #93a1a1 #fdf6e3
+        ]
+      end
     end
 
     def font_family(val = nil)
@@ -99,6 +131,105 @@ module Echoes
       end
     end
 
+    # Define a named profile (color theme). Anything not set inside
+    # the block falls back to the top-level config attrs, so a profile
+    # is a partial override.
+    #
+    #   profile "Light" do
+    #     foreground "#1a1a1a"
+    #     background "#ffffff"
+    #   end
+    def profile(name, &block)
+      p = Profile.new(name)
+      p.instance_eval(&block) if block
+      profiles[p.name] = p
+      p
+    end
+
+    def profiles
+      @profiles ||= {}
+    end
+
+    # Profiles plus the synthesized "Default" — the menu / GUI uses
+    # this so the View → Profile submenu always has at least a
+    # discoverable "Default" entry even when the user hasn't
+    # declared any profiles.
+    def all_profiles
+      base = {'Default' => synthesized_profile}
+      base.merge(profiles)
+    end
+
+    # Rebind a menu shortcut. The first arg is a shortcut string
+    # like "Cmd+Shift+S" (Cmd / Shift / Ctrl / Option modifiers,
+    # case-insensitive); pass an empty string to disable the
+    # shortcut entirely. The second is the action symbol — one
+    # of the symbols Echoes documents (:new_window, :split_right,
+    # :toggle_find, etc.).
+    #
+    #   keybind "Cmd+Shift+T", :new_tab
+    #   keybind "",            :toggle_pointer     # disable
+    def keybind(shortcut, action)
+      keybinds[action.to_sym] = parse_shortcut(shortcut.to_s)
+    end
+
+    def keybinds
+      @keybinds ||= {}
+    end
+
+    # Returns {key:, modifiers:} or nil if no override is set.
+    def keybind_for(action)
+      keybinds[action.to_sym]
+    end
+
+    # Matches the NSEvent modifier flag bits — kept in sync with
+    # `ObjC::NSEventModifierFlag*` in objc.rb. Defined here so
+    # Configuration can resolve shortcut strings without depending
+    # on the AppKit-loading objc.rb at config-load time.
+    SHORTCUT_MODIFIERS = {
+      'shift'   => 1 << 17,
+      'control' => 1 << 18,
+      'ctrl'    => 1 << 18,
+      'option'  => 1 << 19,
+      'opt'     => 1 << 19,
+      'alt'     => 1 << 19,
+      'cmd'     => 1 << 20,
+      'command' => 1 << 20,
+      'super'   => 1 << 20,
+    }.freeze
+
+    def parse_shortcut(str)
+      return {key: '', modifiers: 0} if str.nil? || str.empty?
+      parts = str.split('+').map(&:strip)
+      key = parts.pop.to_s.downcase
+      modifiers = parts.sum { |p| SHORTCUT_MODIFIERS[p.downcase] || 0 }
+      {key: key, modifiers: modifiers}
+    end
+
+    # Pick / look up the active profile by name. With no arg, returns
+    # whatever the user named via `default_profile "Foo"`, falling
+    # back to the synthesized "Default" so legacy configs (just
+    # foreground/background/etc.) keep working unchanged.
+    def default_profile(name = nil)
+      if name
+        @default_profile_name = name.to_s
+      else
+        profiles[@default_profile_name] || synthesized_profile
+      end
+    end
+
+    # Build a "Default" Profile from the flat config attrs every
+    # time it's asked for — never memoized, because the user's
+    # config might mutate the flat attrs after our first call.
+    def synthesized_profile
+      p = Profile.new('Default')
+      p.instance_variable_set(:@foreground,      @foreground)
+      p.instance_variable_set(:@background,      @background)
+      p.instance_variable_set(:@cursor_color,    @cursor_color)
+      p.instance_variable_set(:@selection_color, @selection_color)
+      p.instance_variable_set(:@color_palette,   @color_palette)
+      p
+    end
+
     private
 
     def parse_color(args)

data/lib/echoes/embedded_shell.rb

@@ -40,6 +40,11 @@ module Echoes
     def initialize(no_rc: false)
       ENV['GIT_PAGER'] ||= 'cat'
       ENV['PAGER']     ||= 'cat'
+      # Default $TERM so terminfo-aware tools (tput, less, vim, …)
+      # have a profile to look up. CI runners launch the rake task
+      # without TERM set; programs that read it bail with
+      # "No value for $TERM and no -T specified".
+      ENV['TERM']      ||= Echoes.config.term
 
       helper_env = {'ECHOES_HELPER_NO_RC' => no_rc ? '1' : nil}
       @master, slave = PTY.open
@@ -119,9 +124,9 @@ module Echoes
     # through the pty asynchronously and `command_done` will set
     # @running back to false. The line is added to history (rubish-side)
     # by the helper before execution.
-    def submit_line(line, rows: 24, cols: 80)
+    def submit_line(line, rows: 24, cols: 80, px_width: 0, px_height: 0)
       return if running?
-      @master.winsize = [rows, cols] rescue nil
+      @master.winsize = [rows, cols, px_width.to_i, px_height.to_i] rescue nil
       @running = true
       rpc_async('execute', line: line)
     end
@@ -194,8 +199,8 @@ module Echoes
     # Updates the pty master's winsize. The kernel propagates to the
     # slave (which is the helper's ctty) and emits SIGWINCH to the
     # foreground process group, so vim/less/etc. repaint.
-    def resize(rows:, cols:)
-      @master.winsize = [rows, cols]
+    def resize(rows:, cols:, px_width: 0, px_height: 0)
+      @master.winsize = [rows, cols, px_width.to_i, px_height.to_i]
     rescue IOError, Errno::EIO
     end