fvwm-window-search 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2819e711c1b51e6a619fbbf5839481b9a8019fc2c6db40265bda3756c65cad51
-  data.tar.gz: 8a58cab8dfc2e504e83d9b71a430a52bb95a63144fc5c499db02172078c57cb6
+  metadata.gz: 6334e45909512868782e41da16d60c26114f43230f0579b1e2e60918fadca628
+  data.tar.gz: 16e792a204f7ed859752781dc537a9e106200ac2c722dd8a581510d90d51d164
 SHA512:
-  metadata.gz: 9d0ab3a08c7bf6993e74c6c8aa07cfbbc1d34dfbc0a31bc6e61f190d6db4fbe0201305967522bf7507470df21e8183e49032b78faa9ea8e77b5f71fe0603d0d5
-  data.tar.gz: 58b49f87d0b92f176b6cf4c80ae0d11fc81f471ed096ac64e50bb74c64c5e52cc929ee437c240c298212ee58cf4af4633d965ebe6ebfc15e27f7f2943bf4c48d
+  metadata.gz: ca486c7cac4a994953c0855877b687a44283c106b6e21cc2cba56ea4a95248ddec2b4a9fa3b0b4df1d82f1d8743a33d949566371c68e54c5c96d4646db4af531
+  data.tar.gz: 3b6f993cdc08f38fb695fb99ca9f2e50c09150bd3cb65d7423b9d99aa97917e71115863b5b46cf1372d34cf8f5dd40b623fd98df9456f8c8b5cb17006e1167c1

data/README.md

@@ -12,21 +12,21 @@ Incremental window search & immediate switch to the selected window
 
 ## Reqs
 
-* Ruby 2.4+
+* Ruby 2.1+
 * `dnf install jansson-devel`
 
 ## Compilation
 
-Type `make`. This clones the dmenu repo, patches & builds it. It does
-not contravene w/ a system-installed dmenu.
+Type `make`. This clones the dmenu repo, patches & builds it. It
+doesn't interfere w/ a system-installed dmenu.
 
 ## Usage
 
 ~~~
 $ ./fvwm-window-search -h
 Usage: fvwm-window-search [options]
-    -c path                          an alternative path to conf.yaml
-    -r                               focus a window only if Return is pressed
+    -c path                      an alternative path to conf.yaml
+    -r                           switch to a window only when <Return> is pressed
 ~~~
 
 To customise dmenu or filtering, create a yaml file
@@ -50,10 +50,20 @@ CLO.
 
 [dmenu(1)]: https://manpages.debian.org/unstable/suckless-tools/dmenu.1.en.html
 
-`filter-out` key tells what windows should be filtered out. Each value
-in a subkey is an array of regexes. See the defaults in
+`filter-out` key tells what windows should be ignored. Each value in a
+subkey is an array of regexes. See the defaults at the top of
 `fvwm-window-search` file.
 
+## Start-up time
+
+As a task switcher, the program must not only run fast, but also
+*start* fast. I managed to get it under 70ms on my laptop, when you
+run `./fvwm-window-search` directly from the repo.
+
+This is not the case with rubygems! The latter generates a stub script
+that invokes `./fvwm-window-search` file. This indirection may add
+~140ms of additional delay.
+
 ## Bugs
 
 * Tested only w/ Fvwm3.

data/fvwm-window-search

@@ -1,19 +1,18 @@
-#!/usr/bin/env ruby
+#!/usr/bin/env -S ruby --disable-gems
 
-require_relative './lib'
-include FvwmWindowSearch
 require 'yaml'
+require 'json'
 require 'optparse'
 
 def options
   default = {
-    "dmenu" => {               # each key is a corresponding CL option
-      "selhook" => File.join(__dir__, "focus.sh %s"),
-      "selhook-return-key-focus-only" => false,
+    "dmenu" => { # each key corresponds to a dmenu CL option, except for selhook*
       "fn" => "Monospace-10",
       "l" => 8,
       "b" => true,
       "i" => true,
+      "selhook" => File.join(__dir__, "focus.sh %s"),
+      "selhook-return-key-focus-only" => false, # FIXME: rename
     },
     "filter-out" => {
       "name" => [],
@@ -22,34 +21,38 @@ def options
     }
   }
 
-  cl = options_load_cl
-  env = deep_merge(default, options_load_file(cl) || {})
-  deep_merge env, cl
+  args = options_command_line
+  file = options_config_file(args) || {}
+  deep_merge default, deep_merge(file, args)
 end
 
-def options_load_cl
+def options_command_line
   opt = { "dmenu" => {} }
   OptionParser.new do |o|
     o.on("-c path", "an alternative path to conf.yaml") { |v| opt["conf"] = v }
-    o.on("-r", "focus a window only if Return is pressed") do
+    o.on("-r", "switch to a window only when <Return> is pressed") do
       opt["dmenu"]["selhook-return-key-focus-only"] = true
     end
   end.parse!
   opt
 end
 
-def options_load_file opt       # return nil if config wasn't found
-  conf = opt["conf"] || -> do
+def options_config_file opt
+  file = opt["conf"] || -> do
     xdg_config_home = ENV['XDG_CONFIG_HOME'] || File.expand_path('~/.config')
     File.join xdg_config_home, 'fvwm-window-search', 'conf.yaml'
   end.call
-  r = File.read conf rescue nil
-  YAML.load r, conf rescue errx 1, "invalid config: #{$!}" if r
+  r = File.read file rescue nil
+  YAML.safe_load(r, filename: file) rescue abort "invalid config: #{$!}" if r
 end
 
-def menu params, text
-  cmd = [File.join(__dir__, "_out/dmenu/dmenu")]
-  params = params.map do |k,v|
+def deep_merge first, second
+  merger = proc {|_,v1,v2| Hash === v1 && Hash === v2 ? v1.merge(v2, &merger) : v2 }
+  first.merge(second, &merger)
+end
+
+def dmenu_cmd params
+  [File.join(__dir__, "_out/dmenu/dmenu")] + params.map do |k,v|
     k = "-"+k
     if !!v == v
       v ? k : nil
@@ -57,22 +60,48 @@ def menu params, text
       [k,v]
     end
   end.reject(&:nil?).flatten.map(&:to_s)
-  IO.popen(cmd + params, 'w') { |ios| ios.puts text }
+end
+
+def desired patterns, window
+  match = -> (type, value) {
+    include = patterns[type].select {|v| v[0] != '!'}
+    exclude = patterns[type].select {|v| v[0] == '!'}.map {|v| v[1..-1]}
+
+    exclude.each do |pattern|
+      return true if value.match pattern
+    end
+    include.each do |pattern|
+      return false if value.match pattern
+    end
+    true
+  }
+
+  match.call("class", window['class']) &&
+    match.call("resource", window['resource']) &&
+    match.call("name", window['name'])
 end
 
 def main
   opt = options
-  begin
-    winlist = windows_filter_out opt["filter-out"], windows
-  rescue RegexpError
-    errx 1, "filter-out: #{$!}"
-  end
-  winlist = winlist.map do |w|
+  pp opt if $DEBUG
+  dmenu = IO.popen(dmenu_cmd(opt['dmenu']), 'r+')
+
+  IO.popen(File.join(__dir__, '_out/winlist')).each_line do |line|
+    begin
+      w = JSON.parse line
+    rescue
+      dmenu.puts $!.to_s.gsub(/\n+/m, ' ') # let a user see an error
+      next
+    end
+
+    next unless desired opt['filter-out'], w
+
     desk = w['desk'] == -1 ? '*' : w['desk']
-    [desk, w['class'], w['name'], w['host'], '0x'+w['id'].to_s(16)].join ' | '
-  end.join "\n"
+    dmenu.puts [desk, w['class'], w['name'], w['host'], '0x'+w['id'].to_s(16)].join ' | '
+  end
 
-  menu opt["dmenu"], winlist
+  dmenu.close
 end
 
-main
+# not __FILE__ == $0, for $0 points to a generated stub after `gem install ...`
+main unless defined? Minitest

data/lib.c

@@ -17,7 +17,7 @@ long desktop(Display *dpy, Window wid) {
   if (!prop(dpy, wid, XA_CARDINAL, "_NET_WM_DESKTOP", &prop_val, &prop_size))
     return -2;
 
-  long r = -1;
+  long r = -1; // means a window is in a 'sticky' mode
   if (prop_val) r = ((long*)prop_val)[0];
   free(prop_val);
   return r;

data/winlist.c

@@ -1,3 +1,10 @@
+/*
+  produces line-delimited JSON of currently managed windows by an X
+  window manager:
+
+  {"desk":0,"host":"hm76","name":"xterm","resource":"xterm","class":"XTerm","id":67108878}
+*/
+
 #include <stdlib.h>
 #include <err.h>
 #include <stdio.h>
@@ -16,7 +23,7 @@ typedef struct {
   ulong size;
 } WinList;
 
-// result should be freed
+// result (WinList.ids) should be freed
 WinList winlist(Display *dpy) {
   WinList list;
   u_char *result;
@@ -50,7 +57,7 @@ typedef struct {
   char *class_name;
 } ResClass;
 
-// result should be freed
+// result (ResClass.*) should be freed
 ResClass wm_class(Display *dpy, Window wid) {
   ResClass r = {.resource = NULL};
 
@@ -92,7 +99,6 @@ int main() {
   Display *dpy = XOpenDisplay(getenv("DISPLAY"));
   if (!dpy) errx(1, "failed to open display %s", getenv("DISPLAY"));
 
-  json_t *r = json_array();
   WinList list = winlist(dpy);
   for (ulong idx = 0; idx < list.size; idx++) {
     ulong wid = list.ids[idx];
@@ -108,7 +114,11 @@ int main() {
     json_object_set_new(line, "resource", json_string(rc.resource));
     json_object_set_new(line, "class", json_string(rc.class_name));
     json_object_set_new(line, "id", json_integer(wid));
-    json_array_append_new(r, line);
+
+    char *dump = json_dumps(line, JSON_COMPACT);
+    printf("%s\n", dump);
+    free(dump);
+    json_decref(line);
 
     free(host);
     free(name);
@@ -116,9 +126,4 @@ int main() {
     free(rc.class_name);
   }
   XFree(list.ids);
-
-  char *dump = json_dumps(r, JSON_COMPACT);
-  printf("%s\n", dump);
-  free(dump);
-  json_decref(r);
 }

metadata

@@ -1,20 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: fvwm-window-search
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Alexander Gromnitsky
 autorequire:
 bindir: "."
 cert_chain: []
-date: 2021-04-04 00:00:00.000000000 Z
+date: 2021-04-05 00:00:00.000000000 Z
 dependencies: []
 description: |
   A window switcher: search for windows interactively using a patched
   dmenu utility (comes with the gem). This was originally made for Fvwm,
   but it's been fully rewritten to work out-of-the-box with any stacking
-  window manager. Requires jansson-devel C library installed.
+  window manager. Requires a preinstalled jansson-devel C library.
 
   It differs from rofi & co in that it activates (brings up) windows
   _during_ the search.
@@ -33,7 +33,6 @@ files:
 - focus.c
 - focus.sh
 - lib.c
-- lib.rb
 - winlist.c
 homepage: https://github.com/gromnitsky/fvwm-window-search
 licenses:
@@ -47,14 +46,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: 'A window switcher: an interactive incremental windows search & selection

data/lib.rb

@@ -1,37 +0,0 @@
-require "json"
-
-module FvwmWindowSearch
-  def windows
-    cmd = File.join(__dir__, '_out/winlist')
-    JSON.parse `#{cmd}`
-  end
-
-  def windows_filter_out patterns, winlist
-    desired = -> (type, value) {
-      include = patterns[type].select {|v| v[0] != '!'}
-      exclude = patterns[type].select {|v| v[0] == '!'}.map {|v| v[1..-1]}
-
-      exclude.each do |pattern|
-        return true if value.match pattern
-      end
-      include.each do |pattern|
-        return false if value.match pattern
-      end
-      true
-    }
-
-    winlist.select { |w| desired.call "class", w['class'] }
-      .select { |w| desired.call "resource", w['resource'] }
-      .select { |w| desired.call "name", w['name'] }
-  end
-
-  def deep_merge first, second
-    merger = proc { |_, v1, v2| Hash === v1 && Hash === v2 ? v1.merge(v2, &merger) : v2 }
-    first.merge(second, &merger)
-  end
-
-  def errx exit_code, msg
-    $stderr.puts "#{File.basename $0} error: #{msg}"
-    exit exit_code
-  end
-end