Skip to content

Commit

Permalink
Implemented Window Switcher Management
Browse files Browse the repository at this point in the history
  • Loading branch information
LexiconCode committed Mar 1, 2021
1 parent caaeb0f commit de5e030
Show file tree
Hide file tree
Showing 2 changed files with 193 additions and 6 deletions.
55 changes: 49 additions & 6 deletions castervoice/rules/core/navigation_rules/window_mgmt_rule.py
Original file line number Diff line number Diff line change
@@ -1,20 +1,58 @@
from dragonfly import MappingRule, Function, Repeat, ShortIntegerRef
from dragonfly import MappingRule, Function, Repeat, DictListRef, Repetition, get_engine, ShortIntegerRef

from castervoice.lib import utilities
from castervoice.lib import virtual_desktops
from castervoice.lib.actions import Key
from castervoice.lib.ctrl.mgr.rule_details import RuleDetails
from castervoice.lib.merge.state.short import R

try: # Try first loading from caster user directory
from navigation_rules.window_mgmt_rule_support import refresh_open_windows_dictlist, debug_window_switching, switch_window, open_windows_dictlist, timerinstance
except ImportError:
from castervoice.rules.core.navigation_rules.window_mgmt_rule_support import refresh_open_windows_dictlist, debug_window_switching, switch_window, open_windows_dictlist, timerinstance


"""
Window Switch Manager to swap windows by saying words in their title.
Uses a timer to periodically load the list of open windows into a DictList,
so they can be referenced by the "switch window" command.
Commands:
"window switch <windows>" -> switch to the window with the given word in its
title. If multiple windows have that word in
their title, then you can say more words in the
window's title to disambiguate which one you
mean. If you don't, the caster messaging window will be
foregrounded instead with info on which windows
are ambiguously being matched by your keywords.
"window switch refresh" -> manually reload the list of windows. Useful while
developing if you don't want to use the timer. Command disabled
"window switch show" -> output information about which keywords can
be used on their own to switch windows and which
require multiple words.
"""


class WindowManagementRule(MappingRule):
mapping = {
'maximize win':
'window maximize':
R(Function(utilities.maximize_window)),
'minimize win':
'window minimize':
R(Function(utilities.minimize_window)),

# Workspace management
'window restore':
R(Function(utilities.restore_window)),
# Window Switcher Management
"window switch <windows>":
R(Function(switch_window), rdescript=""), # Block printing out rdescript
# Manualy refreshes open windows if `timerinstance.set()` not used
# "window switch refresh":
# R(Function(lambda: refresh_open_windows_dictlist())),
"window switch show":
R(Function(debug_window_switching)),
# Virtual Workspace Management
"show work [spaces]":
R(Key("w-tab")),
"(create | new) work [space]":
Expand All @@ -27,7 +65,6 @@ class WindowManagementRule(MappingRule):
R(Key("wc-right"))*Repeat(extra="n"),
"(previous | prior) work [space] [<n>]":
R(Key("wc-left"))*Repeat(extra="n"),

"go work [space] <n>":
R(Function(virtual_desktops.go_to_desktop_number)),
"send work [space] <n>":
Expand All @@ -38,9 +75,15 @@ class WindowManagementRule(MappingRule):

extras = [
ShortIntegerRef("n", 1, 20, default=1),
Repetition(name="windows", min=1, max=5,
child=DictListRef("window_by_keyword", open_windows_dictlist))
]


# Window switch update sopen_windows_dictlist every 2 second
timerinstance.set()


def get_rule():
details = RuleDetails(name="window management rule")
return WindowManagementRule, details
144 changes: 144 additions & 0 deletions castervoice/rules/core/navigation_rules/window_mgmt_rule_support.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,144 @@
# All credit goes to caspark
# This is adapted from caspark's grammar at https://gist.github.com/caspark/9c2c5e2853a14b6e28e9aa4f121164a6

from __future__ import print_function

import re
import time
import six

from dragonfly import Window, DictList, get_engine, get_current_engine
from castervoice.lib import utilities
from castervoice.lib.util import recognition_history

_history = recognition_history.get_and_register_history(1)

open_windows_dictlist = DictList("open_windows")

WORD_SPLITTER = re.compile('[^a-zA-Z0-9]+')


def lower_if_not_abbreviation(s):
if len(s) <= 4 and s.upper() == s:
return s
else:
return s.lower()


def find_window(window_matcher_func, timeout_ms=3000):
"""
Returns a Window matching the given matcher function, or raises an error otherwise
"""
steps = int(timeout_ms / 100)
for i in range(steps):
for win in Window.get_all_windows():
if window_matcher_func(win):
return win
time.sleep(0.1)
raise ValueError(
"no matching window found within {} ms".format(timeout_ms))


def refresh_open_windows_dictlist():
"""
Refreshes `open_windows_dictlist`
"""
window_options = {}
for window in (x for x in Window.get_all_windows() if
x.is_valid and
x.is_enabled and
x.is_visible and
not x.executable.startswith("C:\\Windows") and
x.classname != "DgnResultsBoxWindow"):
for word in {lower_if_not_abbreviation(word)
for word
in WORD_SPLITTER.split(window.title)
if len(word)}:
if word in window_options:
window_options[word] += [window]
else:
window_options[word] = [window]

window_options = {k: v for k,
v in six.iteritems(window_options) if v is not None}
open_windows_dictlist.set(window_options)


def debug_window_switching():
"""
Prints out contents of `open_windows_dictlist`
"""
options = open_windows_dictlist.copy()
print("*** Windows known:\n",
"\n".join(sorted({w.title for list_of_windows in six.itervalues(options) for w in list_of_windows})))

print("*** Single word switching options:\n", "\n".join(
"{}: '{}'".format(
k.ljust(20), "', '".join(window.title for window in options[k])
) for k in sorted(six.iterkeys(options)) if len(options[k]) == 1))
print("*** Ambiguous switching options:\n", "\n".join(
"{}: '{}'".format(
k.ljust(20), "', '".join(window.title for window in options[k])
) for k in sorted(six.iterkeys(options)) if len(options[k]) > 1))


def switch_window(windows):
"""
Matches keywords to window titles stored in `open_windows_dictlist`
"""
matched_window_handles = {w.handle: w for w in windows[0]}
for window_options in windows[1:]:
matched_window_handles = {
w.handle: w for w in window_options if w.handle in matched_window_handles}
if six.PY2:
matched_windows = matched_window_handles.values()
else:
matched_windows = list(matched_window_handles.values())
if len(matched_windows) == 1:
window = matched_windows[0]
print("Window Management: Switching to", window.title)
window.set_foreground()
else:
try:
# Brings caster messaging window to the forefront
messaging_title = utilities.get_caster_messaging_window()
messaging_window = find_window(
lambda w: messaging_title in w.title, timeout_ms=100)
if messaging_window.is_minimized:
messaging_window.restore()
else:
messaging_window.set_foreground()
except ValueError:
# window didn't exist, it'll be created when we write some output
pass
if len(matched_windows) >= 2: # Keywords match more than one window title
print("Ambiguous window switch command:\n", "\n".join(
"'{}' from {} (handle: {})".format(w.title, w.executable, w.handle) for w in matched_windows))
else:
# At this point the series of keywords do not match any single window title.
# Uses recognition history to inform what keywords were said in <windows> repetition element
spec_n_word = 2 # `window switch`
# Edge case: if the spec `window switch <windows>` word length changes.
# The `spec_n_word` integer equals `n` number of words in spec excluding <windows>
words = list(map(str, _history[0]))
del words[:spec_n_word]
print("Window Management: No matching window title containing keywords: `{}`".format(
' '.join(map(str, words))))


class Timer:
"""
Dragonfly timer runs every 2 seconds updating open_windows_dictlist
"""
timer = None

def __init__(self):
pass

def set(self):
if self.timer is None:
self.timer = get_engine().create_timer(refresh_open_windows_dictlist, 2)
self.timer.start()


timerinstance = Timer()

0 comments on commit de5e030

Please sign in to comment.