fvwm-window-search 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dd55a9dff4bdaee0fcb2e3aab600d85f6c0d40b8a706ea1dd0d7d17e2c0a83c8
+  data.tar.gz: b47ae4bac4a1a0e68f629306de58e76f6d0111f48e1a9bb686fb63362179161b
+SHA512:
+  metadata.gz: 13ce630d60e59c33f1bd26c6b29f4dcca5134dabc8d4f0a6a54f812e9d5d50ebb4ca644031e126785cefdaad6cd95ce008a3ca7167deb04b103a0e9dfc43ed53
+  data.tar.gz: 00311f2288294e4556f3e38b297c33581a7f0ab0b8ced615daf07d31c88682d0555b164a8eb5be6d68729495a8460469ed244511d93d8f2cab0793abac7a8fbc

data/Makefile

@@ -0,0 +1,16 @@
+out := _out
+dmenu := $(out)/dmenu
+dmenu.commit := 9b38fda6feda68f95754d5b8932b1a69471df960
+
+$(out)/.dmenu.build: $(out)/.dmenu.$(dmenu.commit) dmenu.patch
+	patch -d $(dmenu) -p1 < dmenu.patch
+	make -C $(dmenu)
+	touch $@
+
+$(out)/.dmenu.$(dmenu.commit):
+	git clone https://git.suckless.org/dmenu $(dmenu)
+	git -C $(dmenu) checkout $(dmenu.commit) -q
+	touch $@
+
+# an empty target to satisfy rubygems
+install:

data/README.md

@@ -0,0 +1,64 @@
+# fvwm-window-search
+
+Incremental window search & immediate switch to the selected window
+*during the search*. Uses a patched version of dmenu as a GUI.
+
+    $ gem install fvwm-window-search
+
+![demo](https://thumbs.gfycat.com/GenerousRingedFlicker-small.gif)
+
+* Should work w/ most stackings X11 window managers.
+* Filtering by window name/resource/classe.
+
+## Reqs
+
+* Ruby 2.4+
+* `xwininfo` & `xdotool` (`xorg-x11-utils` & `xdotool` Fedora pkgs)
+
+## Compilation
+
+Type `make`. This clones the dmenu repo, patches & builds it. It does
+not contravene 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
+~~~
+
+To customise dmenu or filtering, create a yaml file
+`$XDG_CONFIG_HOME/fvwm-window-search/conf.yaml`, e.g.:
+
+~~~
+---
+dmenu:
+  fn: Monospace-12
+  b: false
+  selhook-return-key-focus-only: true
+filter:
+    name: ['System Monitor']
+    resource: []
+    class: []
+~~~
+
+Subkeys in `dmenu` are the usual CLOs for
+[dmenu(1)][]. `selhook-return-key-focus-only` is an equivalent of `-r`
+CLO.
+
+[dmenu(1)]: https://manpages.debian.org/unstable/suckless-tools/dmenu.1.en.html
+
+`filter` key tells what windows should be filtered out. Each value in
+a subkey is an array of regexes. See the defaults in
+`fvwm-window-search` file.
+
+## Bugs
+
+* Tested only w/ Fvwm3.
+* No distinction between normal & iconified windows.
+
+## License
+
+MIT.

data/dmenu.patch

@@ -0,0 +1,129 @@
+diff --git a/Makefile b/Makefile
+index a03a95c..ee5cffb 100644
+--- a/Makefile
++++ b/Makefile
+@@ -17,8 +17,8 @@ options:
+ .c.o:
+ 	$(CC) -c $(CFLAGS) $<
+ 
+-config.h:
+-	cp config.def.h $@
++config.h: config.def.h
++	cp $< $@
+ 
+ $(OBJ): arg.h config.h config.mk drw.h
+ 
+diff --git a/config.def.h b/config.def.h
+index 1edb647..1920110 100644
+--- a/config.def.h
++++ b/config.def.h
+@@ -21,3 +21,7 @@ static unsigned int lines      = 0;
+  * for example: " /?\"&[]"
+  */
+ static const char worddelimiters[] = " ";
++
++/* -selhook option; run a command on every selection */
++static const char *selection_hook = NULL;
++static int selection_hook_return_key_focus_only = 0;
+diff --git a/dmenu.c b/dmenu.c
+index 65f25ce..274668a 100644
+--- a/dmenu.c
++++ b/dmenu.c
+@@ -304,6 +304,62 @@ movewordedge(int dir)
+ 	}
+ }
+ 
++/*
++ * Replacing all instances of ' with '\'' then enclosing the whole
++ * string in single quotes (') is the safe way.
++ * */
++static char *
++shellquote(const char *src)
++{
++  char *quoted, *q;
++  const char *p;
++
++  if (!src) return NULL;
++  p = src;
++
++  if (!(quoted = malloc(strlen(src)*4+3))) die("malloc failed");
++  q = quoted;
++
++  *q++ = '\'';
++  while (*p) {
++    if (*p == '\'') {
++      *q++ = '\'';
++      *q++ = '\\';
++      *q++ = '\'';
++      *q++ = '\'';
++    } else {
++      *q++ = *p;
++    }
++
++    p++;
++  }
++  *q++ = '\'';
++  *q = '\0';
++
++  return quoted;
++}
++
++void
++selhook(const char *user_command, const struct item *item)
++{
++  char *cmd, *quoted_item_text;
++  size_t cmd_size;
++
++  if ( !(user_command && item)) return;
++  quoted_item_text = shellquote(item->text);
++  /* printf("QUOTED: >%s<\n", quoted_item_text); */
++
++  cmd_size = strlen(user_command) + strlen(quoted_item_text) + 1;
++  if ( !(cmd = malloc(cmd_size))) die("malloc failed");
++  snprintf(cmd, cmd_size, user_command, quoted_item_text);
++
++  /* printf("SELECTED HOOK: %s\n", cmd); */
++  system(cmd);
++
++  free(quoted_item_text);
++  free(cmd);
++}
++
+ static void
+ keypress(XKeyEvent *ev)
+ {
+@@ -464,6 +520,7 @@ insert:
+ 		break;
+ 	case XK_Return:
+ 	case XK_KP_Enter:
++		selhook(selection_hook, sel);
+ 		puts((sel && !(ev->state & ShiftMask)) ? sel->text : text);
+ 		if (!(ev->state & ControlMask)) {
+ 			cleanup();
+@@ -572,6 +629,8 @@ run(void)
+ 			break;
+ 		case KeyPress:
+ 			keypress(&ev.xkey);
++			if (!selection_hook_return_key_focus_only)
++				selhook(selection_hook, sel);
+ 			break;
+ 		case SelectionNotify:
+ 			if (ev.xselection.property == utf8)
+@@ -712,6 +771,8 @@ main(int argc, char *argv[])
+ 		else if (!strcmp(argv[i], "-i")) { /* case-insensitive item matching */
+ 			fstrncmp = strncasecmp;
+ 			fstrstr = cistrstr;
++		} else if (!strcmp(argv[i], "-selhook-return-key-focus-only")) {
++			selection_hook_return_key_focus_only = 1;
+ 		} else if (i + 1 == argc)
+ 			usage();
+ 		/* these options take one argument */
+@@ -733,6 +794,8 @@ main(int argc, char *argv[])
+ 			colors[SchemeSel][ColFg] = argv[++i];
+ 		else if (!strcmp(argv[i], "-w"))   /* embedding window id */
+ 			embed = argv[++i];
++		else if (!strcmp(argv[i], "-selhook")) /* a command to run */
++			selection_hook = argv[++i];
+ 		else
+ 			usage();
+ 

data/extconf.rb

@@ -0,0 +1 @@
+# a dummy file that forces rubygems to run our Makefile during 'gem install'

data/focus.sh

@@ -0,0 +1,22 @@
+#!/bin/sh
+
+id=`echo "$1" | awk -F'|' '{print $NF} END { exit $NF == "" ? 1 : 0}'` || {
+    echo "usage: `basename "$0"` 'name | class | id'"
+    exit 1
+}
+
+# tries to put a mouse pointer as shown on the picture below (▲ is the
+# pointer):
+#
+# +-------------+
+# |    Title    |
+# +-------------+
+# |      ▲      |
+# |             |
+# |             |
+# +-------------+
+
+eval "`xdotool getwindowgeometry --shell "$id"`"
+x=$((WIDTH/2))
+
+xdotool windowactivate "$id" mousemove --window "$id" "$x" 0

data/fvwm-window-search

@@ -0,0 +1,81 @@
+#!/usr/bin/env ruby
+
+require_relative './lib'
+include FvwmWindowSearch
+require 'yaml'
+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,
+      "fn" => "Monospace-10",
+      "l" => 8,
+      "b" => true,
+      "i" => true,
+    },
+    "filter" => {
+      "name" => [],
+      "resource" => [],
+      "class" => ['^Fvwm', '!^FvwmIdent$']
+    }
+  }
+
+  cl = options_load_cl
+  env = deep_merge(default, options_load_file(cl) || {})
+  deep_merge env, cl
+end
+
+def options_load_cl
+  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
+      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
+    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
+end
+
+def menu params, text
+  cmd = [File.join(__dir__, "_out/dmenu/dmenu")]
+  params = params.map do |k,v|
+    k = "-"+k
+    if !!v == v
+      v ? k : nil
+    else
+      [k,v]
+    end
+  end.reject(&:nil?).flatten.map(&:to_s)
+  IO.popen(cmd + params, 'w') { |ios| ios.puts text }
+end
+
+def main
+  ['xwininfo', 'xdotool'].each do |util|
+    errx 1, "no #{util} in PATH" unless which util
+  end
+
+  opt = options
+  begin
+    winlist = windows_filter opt["filter"], windows
+  rescue RegexpError
+    errx 1, "filter: #{$!}"
+  end
+  winlist = winlist.map do |w|
+    "#{w.name} | #{w.class} | #{w.id}"
+  end.join "\n"
+
+  menu opt["dmenu"], winlist
+end
+
+main

data/lib.rb

@@ -0,0 +1,105 @@
+module FvwmWindowSearch; end
+
+class FvwmWindowSearch::Window
+  def initialize xwininfo_line
+    @line = xwininfo_line.match(/^([x0-9a-f]+)\s+(["\(].+["\)]):\s+\((.*)\)\s+([x0-9+-]+)\s+([0-9+-]+)$/)
+    raise "invalid xwininfo line" unless @line
+    @dim = parse
+  end
+
+  def parse
+    dim = {}
+    if @line[4]
+      m4 = @line[4].match(/^([0-9]+)x([0-9]+)\+([0-9-]+)\+([0-9-]+)$/)
+      if m4
+        dim[:w] = m4[1].to_i
+        dim[:h] = m4[2].to_i
+        dim[:x_rel] = m4[3].to_i
+        dim[:y_rel] = m4[4].to_i
+      end
+    end
+
+    if @line[5]
+      m5 = @line[5].match(/^\+([0-9-]+)\+([0-9-]+)$/)
+      if m5
+        dim[:x] = m5[1].to_i
+        dim[:y] = m5[2].to_i
+      end
+    end
+
+    dim
+  end
+
+  def id; @line[1]; end
+
+  def name;
+    return unless @line[2]
+    @line[2] == '(has no name)' ? nil : @line[2][1..-2]
+  end
+
+  def resource; @line[3]&.split(' ')&.dig(0)&.slice(1..-2); end
+  def class;    @line[3]&.split(' ')&.dig(1)&.slice(1..-2); end
+  def width; @dim[:w]; end
+  def height; @dim[:h]; end
+  def x; @dim[:x]; end # an absolute upper-left X
+  def y; @dim[:y]; end # an absolute upper-left Y
+  def x_rel; @dim[:x_rel]; end
+  def y_rel; @dim[:y_rel]; end
+
+  def useful?
+    return false unless @line
+    return false if width == 0 || height == 0
+    return false if (x == x_rel) && (y == y_rel)
+    return false if x_rel > 0 || y_rel > 0
+    return false unless self.class
+    true
+  end
+
+  def inspect
+    "#<Window> id=#{id}, name=#{name}, resource=#{resource}, class=#{self.class}"
+  end
+end
+
+module FvwmWindowSearch
+  def windows
+  `xwininfo -root -tree`.split("\n")
+    .select {|v| v.match(/^\s*0x.+/)}
+    .map(&:strip)
+    .map {|v| Window.new(v)}
+    .select(&:useful?)
+  end
+
+  def windows_filter 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
+
+  def which cmd
+    ENV['PATH'].split(File::PATH_SEPARATOR).map {|v| File.join v, cmd }
+      .find {|v| File.executable?(v) && !File.directory?(v) }
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: fvwm-window-search
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+platform: ruby
+authors:
+- Alexander Gromnitsky
+autorequire: 
+bindir: "."
+cert_chain: []
+date: 2020-07-21 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 xdotool & xwininfo installed.
+
+  It differs from rofi & co in that it activates (brings up) windows
+  _during_ the search.
+email: alexander.gromnitsky@gmail.com
+executables:
+- fvwm-window-search
+extensions:
+- extconf.rb
+extra_rdoc_files: []
+files:
+- "./fvwm-window-search"
+- Makefile
+- README.md
+- dmenu.patch
+- extconf.rb
+- focus.sh
+- lib.rb
+homepage: https://github.com/gromnitsky/fvwm-window-search
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: 'A window switcher: an interactive incremental windows search & selection
+  for X Window'
+test_files: []