Changeset 1471

Timestamp:

07/08/08 12:20:56 (2 months ago)

Author:

rob

Message:

Fixed #480: added DescribeKey? action
* modified keystroke processing to send an action to a callback rather than processing the action
* updated the keystroke definition to use the built-in keystrokes from wx itself rather than a hard-coded list here in the source
* changed some default key bindings to C-h for Help

Location:

trunk/peppy

Files:

• lib/wxemacskeybindings.py (modified) (9 diffs)
• mainmenu.py (modified) (4 diffs)
• plugins/keyboard.py (modified) (1 diff)

trunk/peppy/lib/wxemacskeybindings.py

@@ -21 +21 @@
 import wx
 
-wxkeynames = (
-    "BACK", "TAB", "RETURN", "ESCAPE", "SPACE", "DELETE", "START",
-    "LBUTTON", "RBUTTON", "CANCEL", "MBUTTON", "CLEAR", "PAUSE",
-    "CAPITAL", "PRIOR", "NEXT", "END", "HOME", "LEFT", "UP", "RIGHT",
-    "DOWN", "SELECT", "PRINT", "EXECUTE", "SNAPSHOT", "INSERT", "HELP",
-    "NUMPAD0", "NUMPAD1", "NUMPAD2", "NUMPAD3", "NUMPAD4", "NUMPAD5",
-    "NUMPAD6", "NUMPAD7", "NUMPAD8", "NUMPAD9", "MULTIPLY", "ADD",
-    "SEPARATOR", "SUBTRACT", "DECIMAL", "DIVIDE", "F1", "F2", "F3", "F4",
-    "F5", "F6", "F7", "F8", "F9", "F10", "F11", "F12", "F13", "F14",
-    "F15", "F16", "F17", "F18", "F19", "F20", "F21", "F22", "F23", "F24",
-    "NUMLOCK", "SCROLL", "PAGEUP", "PAGEDOWN", "NUMPAD_SPACE",
-    "NUMPAD_TAB", "NUMPAD_ENTER", "NUMPAD_F1", "NUMPAD_F2", "NUMPAD_F3",
-    "NUMPAD_F4", "NUMPAD_HOME", "NUMPAD_LEFT", "NUMPAD_UP",
-    "NUMPAD_RIGHT", "NUMPAD_DOWN", "NUMPAD_PRIOR", "NUMPAD_PAGEUP",
-    "NUMPAD_NEXT", "NUMPAD_PAGEDOWN", "NUMPAD_END", "NUMPAD_BEGIN",
-    "NUMPAD_INSERT", "NUMPAD_DELETE", "NUMPAD_EQUAL", "NUMPAD_MULTIPLY",
-    "NUMPAD_ADD", "NUMPAD_SEPARATOR", "NUMPAD_SUBTRACT", "NUMPAD_DECIMAL",
-    "NUMPAD_DIVIDE",
-    )
+# The list of all the wx keynames (without the WXK_ prefix) is needed by both
+# KeyMap and KeyProcessor objects
+wxkeynames = [i[4:] for i in dir(wx) if i.startswith('WXK_')]
+
 
 class DuplicateKeyError(Exception):
@@ -333 +318 @@
     """
     debug = False
-    
+
+    # Mapping of wx keystroke numbers to keystroke names
+    wxkeys = {}
+    for i in wxkeynames:
+        wxkeys[getattr(wx, "WXK_"+i)] = i
+    for i in ("SHIFT", "ALT", "COMMAND", "CONTROL", "MENU"):
+        if wx.Platform == '__WXGTK__':
+            # unix doesn't create a keystroke when a modifier key
+            # is also modified by another modifier key, so we
+            # create entries here so that decode() doesn't have to
+            # have platform-specific code
+            wxkeys[getattr(wx, "WXK_"+i)] = i[0:1]+'-'
+        else:
+            wxkeys[getattr(wx, "WXK_"+i)] = ''
+
     def __init__(self,status=None):
         self.keymaps=[]
@@ -367 +366 @@
         self.universalArgument="C-U"
         self.processingArgument=0
+        
+        # If reportNext is not None, instead of being processed the next action
+        # is reported to a caller by using reportNext as a callback.
+        self.reportNext = None
 
         self.hasshown=False
         self.reset()
-
-        # Mapping of wx keystroke numbers to keystroke names
-        self.wxkeys={}
-        # set up the wxkeys{} dict
-        self.wxkeymap()
-
-    def wxkeymap(self):
-        for i in wxkeynames:
-            self.wxkeys[getattr(wx, "WXK_"+i)] = i
-        for i in ("SHIFT", "ALT", "COMMAND", "MENU"):
-            if wx.Platform == '__WXGTK__':
-                # unix doesn't create a keystroke when a modifier key
-                # is also modified by another modifier key, so we
-                # create entries here so that decode() doesn't have to
-                # have platform-specific code
-                self.wxkeys[getattr(wx, "WXK_"+i)] = i[0:1]+'-'
-            else:
-                self.wxkeys[getattr(wx, "WXK_"+i)] = ''
 
     def findStickyMeta(self):
@@ -486 +471 @@
                 keyname = chr(keycode)
             else:
-                keyname = "(%s)unknown" % keycode
+                keyname = "unknown-%s" % keycode
         if self.debug: print("modifiers: raw=%d processed='%s' keyname=%s keycode=%s key=%s" % (emods, modifiers, keyname, keycode, modifiers+keyname))
         return modifiers + keyname
@@ -514 +499 @@
         """
         if self.status:
+            if self.reportNext:
+                text = "Describe Key: %s" % text
             self.status.SetStatusText(text)
             self.hasshown=True
@@ -608 +595 @@
             self.args+=key + ' '
             self.processingArgument+=1
+    
+    def setReportNext(self, callback):
+        self.reportNext = callback
+        self.show('')
 
     def process(self, evt):
@@ -635 +626 @@
                 skip, unknown, function = self.add(key)
             self.reset()
-            self.show("Quit")
-            if function:
-                function(evt, printable=False)
+            if self.reportNext:
+                self.reportNext(function)
+                self.reportNext = None
+            else:
+                self.show("Quit")
+                if function:
+                    function(evt, printable=False)
         elif self.metaNext:
             # OK, the meta sticky key is down, but it's not a quit
@@ -679 +674 @@
                     printable = not self.modifier
                     self.reset()
-                    if save is not None:
-                        function(evt,save, printable=printable)
+                    if self.reportNext:
+                        self.reportNext(function)
+                        self.reportNext = None
                     else:
-                        function(evt, printable=printable)
+                        if save is not None:
+                            function(evt,save, printable=printable)
+                        else:
+                            function(evt, printable=printable)
                 elif unknown:
                     # This is an unknown keystroke combo
                     sf = "%s not defined."%(self.sofar)
                     self.reset()
+                    if self.reportNext:
+                        self.reportNext(None)
+                        self.reportNext = None
                     self.show(sf)
                 elif skip:
@@ -693 +695 @@
                     # to get processed elsewhere.
                     self.reset()
-                    evt.Skip()
+                    if self.reportNext:
+                        self.reportNext(None)
+                        self.reportNext = None
+                    else:
+                        evt.Skip()
                 else:
                     self.show(self.args+self.sofar)

trunk/peppy/mainmenu.py

@@ -799 +799 @@
     tooltip = "Describe an action by name"
     default_menu = ("&Help", -200)
+    key_bindings = {'emacs': "C-h a", }
 
     def __init__(self, *args, **kwargs):
@@ -825 +826 @@
 
 
+class DescribeKey(SelectAction):
+    """Look up the action from the keystroke"""
+    name = "&Describe Key"
+    alias = "describe-key"
+    default_menu = ("&Help", 201)
+    key_bindings = {'emacs': "C-h k", }
+
+    def action(self, index=-1, multiplier=1):
+        self.frame.keys.setReportNext(self.displayAction)
+
+    def displayAction(self, action):
+        if action:
+            dprint("looking up docs for %s" % action)
+            Publisher().sendMessage('peppy.log.info', action.getHelp())
+            self.frame.SetStatusText("Keystroke found.")
+        else:
+            self.frame.SetStatusText("Unbound keystroke.")
+
+
 class CancelMinibuffer(SelectAction):
     alias = "cancel-minibuffer"
@@ -841 +861 @@
     tooltip = "Show help for the currently active minibuffer"
     default_menu = ("&Help", 210)
-    key_bindings = {'emacs': "M-S-/ m", }
+    key_bindings = {'emacs': "C-h m", }
     
     def isEnabled(self):
@@ -903 +923 @@
                 NewWindow, DeleteWindow, WindowList,
                 
-                ExecuteActionByName, DescribeAction, HelpMinibuffer,
+                ExecuteActionByName, DescribeAction, DescribeKey, HelpMinibuffer,
                 
                 CancelMinibuffer,

trunk/peppy/plugins/keyboard.py

@@ -25 +25 @@
     alias = "describe-keys"
     default_menu = ("&Help", 210)
-    key_bindings = {'emacs': "M-/ B", }
+    key_bindings = {'emacs': "C-h b", }
 
     def action(self, index=-1, multiplier=1):