设为首页收藏本站

LinuxSir.cn，穿越时空的Linuxsir!

 找回密码
 注册
搜索
热搜: shell linux mysql
LinuxSir.cn，穿越时空的Linuxsir!»论坛 › 编程开发讨论区 —— LinuxSir.cn › Perl | PHP | Python 脚本程序开发 › Jump Or Exec
返回列表 发新帖
查看: 1220|回复: 2

Jump Or Exec

[复制链接]
pluskid
发表于 2007-1-26 10:20:42 | 显示全部楼层 |阅读模式
jump or exec 的概念是我在接触  Sawfish  的时候接知道的。通常对于一个任
务，你并不需要关心它是否已经在运行了，你需要它的时候只需要一个指令，如
果它已经在运行了，那么就把他带到前台来，否则就启动一个。而把这个指令绑
定到一个全局快捷键上，也就成了 jump or exec 了。

在  Sawfish  里面有好几个扩展可以方便地实现这个功能，我不知道在其它窗口
管理器里面怎么做，自己也没有用过 FVWM 之类的，而像 KDE 的 kwin 之类的
窗口管理器好像也没有相关的东西。

由于对 Konqueror 文件管理器特别喜爱，同时 Konqueror 又要在 KDE 下面使
用才舒服，在使用  Sawfish  代替 KDE 的 kwin 一段时间以后，我还是决定制作
在其它窗口管理器下可以使用的 jump or exec 功能，因为  Sawfish  搭配 KDE
使用还是有一些小问题的。

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  EWMH/NetWM compatible X Window Manager
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

无意中发现 wmctrl 这个程序，可以通过命令行的方式控制 EWMH/NetWM 兼容的
窗口管理器，其中就包括 kwin 和 Icewm 等。其实只要可以通过命令行控制的
话，用脚本来实现这个功能应该是很方便的，例如，这样一个脚本：


  2. #!/bin/sh

  4. wind=$1
  5. cmd=$2

  7. if ! wmctrl -a $wind
  8. then
  9.     $cmd &
  10. fi
复制代码


便可以实现这个功能，只是还没有快捷键，KDE 的控制中心里可以设置快捷键，
但是还有一个独立的程序叫做 xbindkeys 可以在任何窗口管理器下设置全局快捷
键，用于运行特定的程序。这样，我写了一个通用的  Python  脚本：


  2. #!/usr/bin/python

  4. ######################################################################
  5. ## file:   jump-or-exec.py
  6. ## author: pluskid <pluskid.zju@gmail.com>
  7. ## date:   2007-01-21
  8. ##
  9. ## description:
  10. ##   Jump or Exec utilities -- jump to perticular window or start a
  11. ##   new one if it doesn't exist.
  12. ##
  13. ##   There's `wmctrl' that can control a interact with an X Window
  14. ##   manager that is compatible with the EWMH/NetWM
  15. ##   specification. (Some examples of EWMH/NetWM compatible window
  16. ##   managers include recent versions of Enlightenment, Icewm, Kwin,
  17. ##   Sawfish and Xfce.)
  18. ##
  19. ##   There's another utility `xbindkeys' which can be used to customize
  20. ##   your own keyboard shortcut.
  21. ##
  22. ##   Combining the two tools, here comes the jump-or-exec utilities:
  23. ##   save this file as `jump-or-exec.py' and then:
  24. ##    $ chmod +x jump-or-exec.py
  25. ##    $ ln -s joe-browser jump-or-exec.py
  26. ##   then you can execute ./joe-browser to jump or exec the firefox web
  27. ##   browser. If it works, you can customize the progs variable to set
  28. ##   your own programs to execute and create those symlinks. Finally you
  29. ##   can bind a shortcut to each program with `xbindkeys'. This method
  30. ##   works under any window manager that is compatible with the EWMH/NetWM
  31. ##   specification.
  32. ##
  33. ######################################################################

  35. import os
  36. import sys

  38. progs = {
  39.     "joe-terminal" : ("urxvt.URxvt -x", "urxvt -e screen -xRRS terminal"),
  40.     "joe-emacs" : ("emacs@", "fe -f server-start"),
  41.     "joe-gnus" : ("gnus@", "fe --eval \'(setq frame-title-format "gnus@%b")\' -f gnus"),
  42.     "joe-fm" : ("konqueror.Konqueror -x", "kfmclient openProfile filemanagement"),
  43.     "joe-browser" : ("Gecko.Firefox-bin -x", "firefox"),
  44.     "joe-bbs" : ("qterm.Qterm -x", "qterm")
  45.     }

  47. if len(sys.argv) < 1:
  48.     print "Don't know what program to start. Please execute with one of:\n%s\n" % \
  49.           "\n".join(["\t"+prog_name for prog_name in progs.keys()])
  50.     sys.exit(-1)

  52. prog = os.path.basename(sys.argv[0])
  53. wind,cmdline = progs[prog]
  54. if os.system("wmctrl -a %s" % wind) != 0:
  55.     os.system("%s &" % cmdline)         # execute in background
复制代码


并且做一系列的链接 ( joe-fm、joe-gnus 等 ) 到这个脚本文件，它根据自己
被调用的名字来启动对应的程序，于是我就在 xbindkeys 里面执行这些软链接：


  2. ###########################
  3. # xbindkeys configuration #
  4. ###########################
  5. # My jump-or-exec utilities
  6. "/home/kid/bin/joe-terminal"
  7. Mod4 + t

  9. "/home/kid/bin/joe-browser"
  10. Mod4 + f

  12. "/home/kid/bin/joe-emacs"
  13. Mod4 + e

  15. "/home/kid/bin/joe-gnus"
  16. Mod4 + g

  18. "/home/kid/bin/joe-bbs"
  19. Mod4 + q

  21. "/home/kid/bin/joe-fm"
  22. Mod4 + c

  24. ##################################
  25. # End of xbindkeys configuration #
  26. ##################################
复制代码


这样就能实现 jump-or-exec 的功能了。但是效果不如  Sawfish  里面内置的
jump-or-exec 好，因为每次都是启动一个脚本，有一些微微的延迟，而且有时
候切换过去之后没有获得焦点。于是我决定做一个像 xbindkeys 一样的后台进
程，自己处理快捷键捕获、窗口切换已经运行程序，而不是用几个命令组合起来。


=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  独立的 Python 版 jump-or-exec
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

正好  Python  有 Xlib 的库，可是后来发现它的文档其实非常不全，很多东西都
没有提到，上它的网站也看到提到这个问题，并且还在征集维护者。不过我对
Xlib 和  Python  都还不熟悉，只好看一些源代码来摸索如何做。其中主要查看
了 xbindkeys 和 pypanel 两个程序的源代码，大概搞清楚了几个重要的地方如
何实现。

=======================================================
    截获全局快捷键
=======================================================

X 被设计于可以在网络上运行，为了不被大量的事件传输阻塞，通常 X 在你明
确要求某些事件之后才会将事件发送给你。我通过注册 root 窗口的
KeyPress 事件来收取全局快捷键的信息：


  2. root.change_attributes(event_mask=(X.KeyPressMask|X.KeyReleaseMask))
复制代码


但是并不是所有的按键都会被截获，还必须告诉 X 你对哪些快捷键感兴趣：


  2. root.grab_key(keycode, modifier, False, X.GrabModeAsync, X.GrabModeAsync)
复制代码


这样就可以截获带 modifier 修饰的 keycode 按键了。通常在按下快捷键的时
候不会关心 CapsLock 、 NumLock 等键的状态，但是在 X 里面这是有区别的，
于是需要把他们分别按下、同时按下以及没有按下的情况都进行捕获。而这几个
Lock 键的值又是可以经过映射的，所以需要动态获取，具体可以参见下面所附
的源代码。


=======================================================
    列出所有任务
=======================================================

因为要查找是否有已经存在的窗口，所以需要列出所有的正在运行的任务的窗
口，通过查看 pypanel 的源代码，我发现这段代码可以列出这些窗口：


  2. tasks = root.get_full_property(disp.intern_atom("_NET_CLIENT_LIST"),Xatom.WINDOW).value
  3. for task in tasks:
  4.     wind = disp.create_resource_object("window", task)
  5.     name = wind.get_wm_name()
复制代码



=======================================================
    将一个窗口切换到前台
=======================================================

如果找到对应的窗口，就把它切换到前台，这段代码可以完成这个工作：


  2. wind.configure(stack_mode=X.Above)
  3. wind.set_input_focus(X.RevertToNone, X.CurrentTime)
复制代码


但是当窗口是最小化的时候并不能正常工作，而是要特殊处理，先用 map 函数
让窗口显示出来。但是由于 X 是异步的， map 并不是立即有效果，而设置输入
焦点又必须是在窗口显示出来的时候才有用，于是通常在 map 后面的设置焦点
的调用都没有任何效果，导致虽然窗口切换到前面了，但是还是没有输入焦点。
我试了一下 pypanel 发现它确实也是有这个问题的。不过这也并不是不能解决，我
只要登记这个窗口的显示事件，在窗口显示出来的时候再设置焦点就可以了。

为了避免同时有多个窗口要设置焦点的情况，我设置了一个标识，用于标识下一
个需要设置焦点的窗口，我想一个窗口应该有唯一标识符，但是  Python  的
Xlib 文档好像东西实在太少了，于是我就用窗口的类名称来标识吧，反正这个
也不需要太精确。

如果窗口没有最小化，那么直接升到前台，并设置焦点，如果是最小化了，那么
就订阅这个窗口的显示事件，并设置下一个等待设置焦点的窗口为它。在事件循
环里面捕捉到窗口显示的事件并且标识对应的时候，再设置焦点，同时退订该窗
口的显示事件。具体可以参考下面给出的源代码。


=======================================================
    构造快捷键值
=======================================================

修饰键不多，可以建立一个对应关系表，比如 "Control" 对应到
ControlMask ，多个修饰键的时候按位或一下就可以了。而键值可以使用 Xlib
里面的 string_to_keysym 转换为 keysym 然后由 keysym_to_keycode 转换为
可以用于截获快捷键的 keycode 。其中 CapsLock 、 NumLock 和
ScrollLock 这三个键是要自己计算一下的。


=======================================================
    提示窗口
=======================================================

如果要达到  Sawfish  里面那种效果，在没有找到窗口，启动一个新程序的时候，显
示一个气泡提示窗口，说正在启动某某程序，而避免让用户以为是没有反应了，
那么需要手工画一个窗口，这好像又好涉及到字体等一系列的问题，而且要这个
窗口在几秒钟之后自动消失的话，还要用定时器吧，在 google 了一下没有发现
Xlib 的定时器相关的特别有用的资料之后，我决定放弃这个功能了。或者留到
以后来实现吧。


=======================================================
    代码
=======================================================

最后写出来的代码就是这样子了。为了避免再解析配置文件而添加更多的代码，
配置就直接在代码里面了，但是配置仍然是很直观的：


  2. #!/usr/bin/python

  4. ######################################################################
  5. ## file:   jump-or-exec.py
  6. ## author: pluskid <pluskid.zju@gmail.com>
  7. ## date:   2007-01-25
  8. ######################################################################

  10. import re
  11. import subprocess
  12. from Xlib import X, display, Xatom, XK, Xutil, protocol

  14. class JumpOrExec:
  15.     modifiers =  {
  16.         'Control':X.ControlMask,
  17.         'Shift':X.ShiftMask,
  18.         'Mod1':X.Mod1Mask,
  19.         'Alt':X.Mod1Mask,
  20.         'Mod2':X.Mod2Mask,
  21.         'Mod3':X.Mod3Mask,
  22.         'Mod4':X.Mod4Mask,
  23.         'Mod5':X.Mod5Mask
  24.         }
  25.     def __init__(self):
  26.         self.display = display.Display()
  27.         self.root = self.display.screen().root
  28.         (self.capslock_mask, self.numlock_mask, self.scrolllock_mask) = \
  29.             self.get_lock_masks()
  30.         self.jobs = {}
  31.     def get_lock_masks(self):
  32.         """Get the value of capslock_mask, numlock_mask and scrolllock_mask."""
  33.         mask_table = [X.ShiftMask, X.LockMask, X.ControlMask,
  34.                       X.Mod1Mask, X.Mod2Mask, X.Mod3Mask,
  35.                       X.Mod4Mask, X.Mod5Mask]
  36.         nlock = self.display.keysym_to_keycode(XK.XK_Num_Lock)
  37.         slock = self.display.keysym_to_keycode(XK.XK_Scroll_Lock)
  38.         modmap = self.display.get_modifier_mapping()
  39.         slock_mask = 0
  40.         nlock_mask = 0
  41.         for i in range(len(modmap)):
  42.             for key in modmap[i]:
  43.                 if key != 0 and key == nlock:
  44.                     nlock_mask = mask_table[i]
  45.                 elif key != 0 and key == slock:
  46.                     slock_mask = mask_table[i]
  47.         return (X.LockMask, nlock_mask, slock_mask)
  48.     def install_job(self, key_string, job):
  49.         """
  50.         Install the job with key_string.

  52.         key_string's format is just like that used by `xbindkeys'. But
  53.         the syntax is more restrictly here. Keys should be seperated
  54.         EXACTLY by ' + ', thus 'Control + +' is valid while 'Control++'
  55.         is invalid.

  57.         job is an instance of the Job class.

  59.         If the key is detected, first we will ask the job object to
  60.         find an existing window (See the document for the class Job
  61.         for more information), if found, we will raise it, otherwise
  62.         we will tell the job to start a new process.
  63.         """
  64.         (key_code, modifier) = self.decode_key(key_string)
  65.         self.jobs[(key_code, modifier)] = job
  66.         self.grab_key(key_code, modifier)
  67.     def decode_key(self, key_string):
  68.         """Decode key_string into (key_code, modifier)"""
  69.         modifier = 0
  70.         the_key = None
  71.         for key in key_string.split(' + '):
  72.             mod = self.modifiers.get(key)
  73.             if mod:
  74.                 modifier |= mod
  75.             else:
  76.                 the_key = self.display.keysym_to_keycode(XK.string_to_keysym(key))
  77.         return (the_key, self.escape_lock_mask(modifier))
  78.     def escape_lock_mask(self, modifier):
  79.         """
  80.         Mask off numlock_mask, capslock_mask and scrolllock_mask. Otherwise
  81.         you may find your key doesn't work only because the capslock(or anything)
  82.         is open. That's not what we needed, so we mask it off.
  83.         """
  84.         return modifier & ~(self.scrolllock_mask | \
  85.                                self.capslock_mask | \
  86.                                self.numlock_mask)
  87.     def grab_key(self, key_code, modifier):
  88.         """
  89.         Grab key press event of key_code+modifier.
  90.         This will enable the X to send us a KeyPress event when the
  91.         key is pressed.
  92.         """
  93.         self.do_grab_key(key_code, modifier)
  94.         if self.numlock_mask:
  95.             self.do_grab_key(key_code, modifier|self.numlock_mask)
  96.         if self.capslock_mask:
  97.             self.do_grab_key(key_code, modifier|self.capslock_mask)
  98.         if self.scrolllock_mask:
  99.             self.do_grab_key(key_code, modifier|self.scrolllock_mask)
  100.         if self.numlock_mask and self.capslock_mask:
  101.             self.do_grab_key(key_code, modifier|self.capslock_mask \
  102.                                  |self.numlock_mask)
  103.         if self.numlock_mask and self.scrolllock_mask:
  104.             self.do_grab_key(key_code, modifier|self.scrolllock_mask \
  105.                                  |self.numlock_mask)
  106.         if self.scrolllock_mask and self.capslock_mask:
  107.             self.do_grab_key(key_code, modifier|self.capslock_mask \
  108.                                  |self.scrolllock_mask)
  109.         if self.numlock_mask and \
  110.                 self.capslock_mask and self.scrolllock_mask:
  111.             self.do_grab_key(key_code, modifier|self.capslock_mask \
  112.                                  | self.numlock_mask | self.scrolllock_mask)
  113.     def do_grab_key(self, key_code, modifier):
  114.         """Helper function of grab_key."""
  115.         self.root.grab_key(key_code, modifier, False, X.GrabModeAsync, X.GrabModeAsync)
  116.     def event_loop(self):
  117.         """Start an infinity loop and handle the incoming events."""
  118.         self.root.change_attributes(event_mask=X.KeyPressMask)
  119.         while 1:
  120.             event = self.display.next_event()
  121.             if event.type == X.KeyPress:
  122.                 self.handle_key_press(event)
  123.             elif event.type == X.VisibilityNotify:
  124.                 self.handle_visibility_notify(event)
  125.     def handle_key_press(self, event):
  126.         """Key pressed means we will Jump or Exec now."""
  127.         key_code = event.detail
  128.         modifier = self.escape_lock_mask(event.state)
  129.         job = self.jobs.get((key_code, modifier))
  130.         if job:
  131.             wind = job.search_existing(self.display, self.root)
  132.             if wind:
  133.                 self.raise_window(wind)
  134.             else:
  135.                 job.start_new()
  136.     def raise_window(self, wind):
  137.         """
  138.         Raise the window.

  140.         If it is not in iconic state, we just raise it and
  141.         give it input focus. But if it is in iconic state,
  142.         we have to invoke map to show it first. And since
  143.         map doesn't show the window immediately, we can not
  144.         set the focus immediately (setting the focus to a
  145.         window not viewable have no effect). What we can do
  146.         is to record the window(class name) and start
  147.         listening the visibility notify event of this window,
  148.         when the event arrive and the window(class name)
  149.         matches, we set focus to it and remove the listener.
  150.         """
  151.         if wind.get_wm_state()['state'] == Xutil.IconicState:
  152.             wind.map()
  153.             # install a event listener
  154.             wind.change_attributes(event_mask=X.VisibilityChangeMask)
  155.             self.to_be_focus = ("%s.%s" % wind.get_wm_class())
  156.         else:
  157.             self.raise_and_focus_window(wind)
  158.     def raise_and_focus_window(self, wind):
  159.         wind.configure(stack_mode=X.Above)
  160.         wind.set_input_focus(X.RevertToNone, X.CurrentTime)

  162.     def handle_visibility_notify(self, event):
  163.         """
  164.         Visibility notify normally can only received from the window
  165.         we will give focus. But to avoid accidently received event
  166.         from other window(e.g. the user switchs to one another window
  167.         very very very quickly), we compare the window class name
  168.         before giving it focus.
  169.         """
  170.         wind = event.window
  171.         if ("%s.%s" % wind.get_wm_class()) == self.to_be_focus:
  172.             self.raise_and_focus_window(wind)
  173.             self.to_be_focus = None
  174.             # uninstall the listener
  175.             wind.change_attributes(event_mask=0)

  177. class Job:
  178.     """
  179.     A Job is consist of a Matcher and a Command. A Matcher is
  180.     an object of the class Matcher, which is used to match against
  181.     the window name and window class name to search for existing
  182.     window. A Command is just a string, which is invoked to start
  183.     a new process if no existing window is found.
  184.     """
  185.     def __init__(self, matcher, command):
  186.         self.matcher = matcher
  187.         self.command = command
  188.     def search_existing(self, disp, root):
  189.         tasks = root.get_full_property(
  190.             disp.intern_atom("_NET_CLIENT_LIST"), Xatom.WINDOW).value
  191.         for task in tasks:
  192.             wind = disp.create_resource_object("window", task)
  193.             if self.matcher.match(wind):
  194.                 return wind
  195.         return None
  196.     def start_new(self):
  197.         subprocess.Popen(self.command, shell=True)

  199. class Matcher:
  200.     """
  201.     Matcher is used to match against window. The window name and window
  202.     class name is to be matched use the regexp given.
  203.     """
  204.     def __init__(self, wm_name = None, wm_class = None):
  205.         self.wm_name = re.compile(wm_name or ".*")
  206.         self.wm_class = re.compile(wm_class or ".*")
  207.     def match(self, window):
  208.         return self.wm_name.search(window.get_wm_name()) and \
  209.             self.wm_class.search("%s.%s" % window.get_wm_class())

  211. if __name__ == "__main__":
  212.     jobs = [
  213.     ("Mod4 + t", Job(Matcher(wm_class="urxvt.URxvt"), "urxvt -e screen -xRRS terminal")),
  214.     ("Mod4 + f", Job(Matcher(wm_class="Gecko.Firefox-bin"), "firefox")),
  215.     ("Mod4 + e", Job(Matcher(wm_name="emacs@.*"), "/home/kid/bin/emacs -f server-start")),
  216.     ("Mod4 + g", Job(Matcher(wm_name="gnus@.*"),
  217.                      "/home/kid/bin/gnus --eval \'(setq frame-title-format "gnus@%b")\' -f gnus")),
  218.     ("Mod4 + q", Job(Matcher(wm_class="qterm.Qterm"), "qterm")),
  219.     ("Mod4 + c", Job(Matcher(wm_class="konqueror.Konqueror"), "kfmclient openProfile filemanagement"))
  220.     ]
  221.     joe = JumpOrExec()
  222.     for job in jobs:
  223.         joe.install_job(job[0], job[1])
  224.     joe.event_loop()
复制代码
回复

使用道具 举报

DoDo
发表于 2007-1-26 11:03:49 | 显示全部楼层
好文，收获颇丰，感谢楼主的辛勤劳动！
回复 支持 反对

使用道具 举报

danran
发表于 2007-2-3 15:36:35 | 显示全部楼层
不错，不错。

试试去。。。
回复 支持 反对

使用道具 举报

返回列表 发新帖
高级模式
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 | 注册

本版积分规则

快速回复 返回顶部 返回列表