Merge lp:~blackdaemon/enso/win32-selection-fixes into lp:~communityenso/enso/community-enso

[blackdaemon]

Handling of copy/cut/paste for Vim and gVim
Handling of copy/paste for console windows

[lp:~blackdaemon/enso/win32-selection-fixes]

148. By blackdaemon on 2010-07-30

Small fixes

Unmerged revisions

148. By blackdaemon on 2010-07-30

Small fixes

147. By blackdaemon on 2010-06-17

Handling Vim and gVim copy&paste

146. By blackdaemon on 2010-06-17

Handle copy&paste for console windows using "Alt-space e y" and "Alt-space e p"

145. By blackdaemon on 2010-06-17

Ignore pylint errors for pywintypes.error

144. By blackdaemon on 2010-06-17

Added getWindowProcessName()

143. By blackdaemon on 2010-06-17

Added handling of some special keys ([, ])
Fixed sending of extended keys (Ins, Del, Home, [, ], etc)
Added typeShiftKey
Added possibility to send key as string or virtual-code

=== modified file 'enso/platform/win32/selection/FileSelection.py'
--- enso/platform/win32/selection/FileSelection.py	2008-04-27 11:12:38 +0000
+++ enso/platform/win32/selection/FileSelection.py	2010-07-30 13:46:41 +0000
@@ -44,8 +44,10 @@
 # Imports
 # ----------------------------------------------------------------------------
 
+import os
 import win32con
 import win32clipboard
+import win32gui
 import pywintypes
 import logging
 
@@ -144,9 +146,8 @@
                 value = win32clipboard.GetClipboardData(
                     win32con.CF_HDROP
                     )
-            except pywintypes.error, e:
-                logging.warn( "Error getting CF_HDROP from clipboard: %s" \
-                                 % ( str(e) ) )
+            except pywintypes.error, e: #IGNORE:E1101
+                logging.warn( "Error getting CF_HDROP from clipboard: %s", str(e) )
                 value = None
         else:
             logging.info( "Clipboard type CF_HDROP not in clipboard." )
@@ -167,13 +168,17 @@
     subclass which is appropriate to the currently active application.
     """
     
-    windowClass = ContextUtils.getForegroundClassNameUnicode()
-
-    if windowClass == u"ConsoleWindowClass":
-        fsContext = NullFileSelectionContext()
-    elif windowClass == u"Emacs":
-        fsContext = NullFileSelectionContext()
-    else:
-        fsContext = DefaultFileSelectionContext()
+    hwnd = win32gui.GetForegroundWindow()
+    className = ContextUtils.getWindowClassName(hwnd)
+    processName = ContextUtils.getWindowProcessName(hwnd)
+
+    fsContext = DefaultFileSelectionContext()
+
+    if className == u"Emacs":
+        fsContext = NullFileSelectionContext()
+    elif className == u"ConsoleWindowClass":
+        fsContext = NullFileSelectionContext()
+    elif className == u"Vim" and os.path.basename(processName).lower() == "gvim.exe":
+        fsContext = NullFileSelectionContext()
 
     return fsContext

=== modified file 'enso/platform/win32/selection/TextSelection.py'
--- enso/platform/win32/selection/TextSelection.py	2009-02-20 00:39:06 +0000
+++ enso/platform/win32/selection/TextSelection.py	2010-07-30 13:46:41 +0000
@@ -42,6 +42,8 @@
 # Imports
 # ----------------------------------------------------------------------------
 
+import os
+import win32gui
 import win32clipboard
 import win32con
 import logging
@@ -103,6 +105,7 @@
         newDict[ "text" ] = newPlainText
     if len( newHtml ) > 0:
         newDict[ "html" ] = newHtml
+    return newDict
 
 def _textDictToAscii( textDict ):
     text = textDict.get( "text", u"" )
@@ -407,7 +410,7 @@
 class NonReplacingTextSelection( DefaultTextSelection ):
     """
     In some applications, notably MoonEdit and Emacs, a paste
-    does not replace selected tet: it inserts
+    does not replace selected text: it inserts
     at the cursor.  This is the selection context to use for
     those applications.
     """
@@ -473,20 +476,6 @@
     these functions are no-ops.
     """
 
-    def getSelection( self ):
-        """
-        Always blank.
-        """
-        return {}
-
-    def replaceSelection( self, textDict ):
-        """
-        Text in the command prompt window is immutable, so
-        the replacement behavior is impossible to achieve.
-        Return False to indicate failure.
-        """
-        return False
-
     def simulatePasteKeystroke( self ):
         # Alt-space pops up the window menu (the thing you get
         # by clicking in the upper-left corner).  Then typing
@@ -495,7 +484,11 @@
         ContextUtils.typeSequence( "e p" )
 
     def simulateCopyKeystroke( self ):
-        pass
+        # Alt-space pops up the window menu (the thing you get
+        # by clicking in the upper-left corner).  Then typing
+        # e and then y selects edit->copy.
+        ContextUtils.typeAltKey( " " )
+        ContextUtils.typeSequence( "e y" )
     
     def simulateCutKeystroke( self ):
         pass
@@ -509,6 +502,28 @@
         return self._pasteText( textDict )
 
     
+class VimTextSelection( DefaultTextSelection ):
+    """
+    Returned if the currently active application is a Windows Vim/gVim.
+    """
+
+    def simulatePasteKeystroke( self ):
+        # Shift-Insert should work by default in Windows version of Vim/gVim
+        ContextUtils.typeShiftKey(win32con.VK_INSERT)
+
+    def simulateCopyKeystroke( self ):
+        # Ctrl-Insert should work by default in Windows version of Vim/gVim
+        # But yanking the selection will also clear it. So the sequence is:
+        #   copy text to clipboard: Ctrl-Insert
+        #   get to normal mode 2x: Ctrl-[ Ctrl-[
+        #   return to last selection: gv
+        ContextUtils.typeSequence('CD INS [ [ CU g v')
+
+    def simulateCutKeystroke( self ):
+        # Ctrl-Del should work by default in Windows version of Vim/gVim
+        ContextUtils.typeCommandKey(win32con.VK_DELETE)
+
+
 # ----------------------------------------------------------------------------
 # Public Function
 # ----------------------------------------------------------------------------
@@ -521,16 +536,24 @@
     If no text is selected, this must return a TextSelection object with
     no text in it -- NOT a None.
     """
+    hwnd = win32gui.GetForegroundWindow()
+    className = ContextUtils.getWindowClassName(hwnd)
 
-    className = ContextUtils.getForegroundClassNameUnicode()
+    tsContext = DefaultTextSelection()
 
     if className == u"Emacs":
         tsContext = EmacsTextSelection()
     elif className == u"MoonEdit":
         tsContext = NonReplacingTextSelection()
     elif className == u"ConsoleWindowClass":
-        tsContext = CommandPromptTextSelection()
-    else:
-        tsContext = DefaultTextSelection()
+        processName = ContextUtils.getWindowProcessName(hwnd)
+        if os.path.basename(processName).lower() == "vim.exe":
+            tsContext = VimTextSelection()
+        else:
+            tsContext = CommandPromptTextSelection()
+    elif className == u"Vim":
+        processName = ContextUtils.getWindowProcessName(hwnd)
+        if os.path.basename(processName).lower() == "gvim.exe":
+            tsContext = VimTextSelection()
 
     return tsContext

=== modified file 'enso/platform/win32/selection/_ContextUtils.py'
--- enso/platform/win32/selection/_ContextUtils.py	2008-04-27 11:12:38 +0000
+++ enso/platform/win32/selection/_ContextUtils.py	2010-07-30 13:46:41 +0000
@@ -1,6 +1,6 @@
 # Copyright (c) 2008, Humanized, Inc.
 # All rights reserved.
-# 
+#
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
 #
@@ -14,7 +14,7 @@
 #    3. Neither the name of Enso nor the names of its contributors may
 #       be used to endorse or promote products derived from this
 #       software without specific prior written permission.
-# 
+#
 # THIS SOFTWARE IS PROVIDED BY Humanized, Inc. ``AS IS'' AND ANY
 # EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
@@ -37,10 +37,12 @@
 # Imports
 # ----------------------------------------------------------------------------
 
+import os
 import win32api
 import win32con
 import win32gui
 import win32clipboard
+import win32process
 import ctypes
 import pywintypes
 import time
@@ -95,6 +97,55 @@
 #    key is being depressed."
 KEYEVENTF_KEYDOWN = 0
 KEYEVENTF_KEYUP = win32con.KEYEVENTF_KEYUP
+KEYEVENTF_EXTENDEDKEY = win32con.KEYEVENTF_EXTENDEDKEY
+
+VK_LBRACKET = 0xDB
+VK_RBRACKET = 0xDD
+
+KEY_MAPPING = { "F1" : win32con.VK_F1,
+                "F2" : win32con.VK_F2,
+                "F3" : win32con.VK_F3,
+                "F4" : win32con.VK_F4,
+                "F5" : win32con.VK_F5,
+                "F6" : win32con.VK_F6,
+                "F7" : win32con.VK_F7,
+                "F8" : win32con.VK_F8,
+                "F9" : win32con.VK_F9,
+                "F10": win32con.VK_F10,
+                "F11": win32con.VK_F11,
+                "F12": win32con.VK_F12,
+                "CD" : win32con.VK_LCONTROL,
+                "CU" : win32con.VK_LCONTROL,
+                "SD" : win32con.VK_LSHIFT,
+                "SU" : win32con.VK_LSHIFT,
+                "AD" : win32con.VK_MENU,
+                "AU" : win32con.VK_MENU,
+                "ID" : win32con.VK_LWIN,
+                "IU" : win32con.VK_LWIN,
+                "LA": win32con.VK_LEFT,
+                "RA": win32con.VK_RIGHT,
+                "ESC": win32con.VK_ESCAPE,
+                "INS": win32con.VK_INSERT,
+                "DEL": win32con.VK_DELETE,
+                "[": VK_LBRACKET,
+                "]": VK_RBRACKET,
+                "LBRACKET": VK_LBRACKET,
+                "RBRACKET": VK_RBRACKET
+              }
+
+# List of keys that need to have the win32con.KEYEVENTF_EXTENDEDKEY flag set
+KEYS_EXTENDED = [
+    win32con.VK_UP,
+    win32con.VK_DOWN,
+    win32con.VK_LEFT,
+    win32con.VK_RIGHT,
+    win32con.VK_HOME,
+    win32con.VK_END,
+    win32con.VK_PRIOR, # PgUp
+    win32con.VK_NEXT,  # PgDn
+    win32con.VK_INSERT,
+    win32con.VK_DELETE
+]
 
 # ----------------------------------------------------------------------------
 # Private Module Variables
@@ -125,10 +176,14 @@
     # win32all does not provide access to MapVirtualKey, so we have to use
     # ctypes to access the DLL directly, and have to append "A" to the name
     # since the function is implemented in Unicode and ANSI versions.
-    
+
     # This gives a hardware scancode for the virtual key.
     scanCode = ctypes.windll.user32.MapVirtualKeyA( vkCode, 0 )
 
+    # Some keys needs the 'extended-key' attribute
+    if vkCode in KEYS_EXTENDED:
+        eventType |= KEYEVENTF_EXTENDEDKEY
+
     # This creates the keyboard event (this function is the one called
     # by keyboard driver interupt handlers, so it's as low-level as it gets)
     win32api.keybd_event( vkCode, scanCode, eventType, 0 )
@@ -157,7 +212,7 @@
         try:
             win32clipboard.OpenClipboard( 0 )
             success = True
-        except pywintypes.error:
+        except pywintypes.error: #IGNORE:E1101
             if totalTime < CLIPBOARD_OPEN_WAIT_AMOUNT:
                 sleepForMs( CLIPBOARD_OPEN_WAIT_INTERVAL )
                 totalTime += CLIPBOARD_OPEN_WAIT_INTERVAL
@@ -186,10 +241,10 @@
 
     # Postconditions:
     assert( _hasTheClipboardOpen() )
-    
+
     try:
         win32clipboard.CloseClipboard()
-    except pywintypes.error:
+    except pywintypes.error: #IGNORE:E1101
         logging.warn( "Attempted to close clipboard when not open." )
     global _contextUtilsHasTheClipboardOpen
     _contextUtilsHasTheClipboardOpen = False
@@ -205,7 +260,7 @@
     function, then closes it when the wrapped function is done,
     whether or not the wrapped function throws an exception.
     """
-    
+
     def wrapperFunc( *args, **kwargs ):
         # If safeOpenClipboard() raises an exception, this function will do
         # nothing but allow it to be raised. (We shouldn't attempt to close
@@ -231,7 +286,7 @@
     the CF_CLIPBOARD_VIEWER_IGNORE format so that clipboard viewers
     will ignore this alteration of the clipboard.
     """
-    
+
     win32clipboard.EmptyClipboard()
     setClipboardDataViewerIgnore()
 
@@ -264,7 +319,7 @@
     """
     LONGTERM TODO: This is kept around for debugging but can be deleted from
     production code.
-    
+
     Given a format code (of the kind returned from the windows clipboard
     functions), returns a string describing the meaning of that
     format code.
@@ -333,8 +388,18 @@
     """
 
     _keyboardEvent( win32con.VK_CONTROL, KEYEVENTF_KEYDOWN )
-    _keyboardEvent( ord(key.upper()), KEYEVENTF_KEYDOWN )
-    _keyboardEvent( ord(key.upper()), KEYEVENTF_KEYUP )
+
+    if isinstance(key, basestring):
+        if key in KEY_MAPPING:
+            key_code = KEY_MAPPING[key]
+        else:
+            key_code = ord(key.upper())
+    else:
+        key_code = key
+
+    _keyboardEvent( key_code, KEYEVENTF_KEYDOWN )
+    _keyboardEvent( key_code, KEYEVENTF_KEYUP )
+
     _keyboardEvent( win32con.VK_CONTROL, KEYEVENTF_KEYUP )
     logging.info( "I am in typeCommandKey and I just typed " + key )
 
@@ -344,18 +409,50 @@
     Given a character literal, simulates holding the Alt key down
     and typing that character.
     """
-    
+
     _keyboardEvent( win32con.VK_MENU, KEYEVENTF_KEYDOWN )
-    _keyboardEvent( ord(key.upper()), KEYEVENTF_KEYDOWN )
-    _keyboardEvent( ord(key.upper()), KEYEVENTF_KEYUP )
+
+    if isinstance(key, basestring):
+        if key in KEY_MAPPING:
+            key_code = KEY_MAPPING[key]
+        else:
+            key_code = ord(key.upper())
+    else:
+        key_code = key
+
+    _keyboardEvent( key_code, KEYEVENTF_KEYDOWN )
+    _keyboardEvent( key_code, KEYEVENTF_KEYUP )
+
     _keyboardEvent( win32con.VK_MENU, KEYEVENTF_KEYUP )
 
 
+def typeShiftKey( key ):
+    """
+    Given a character literal, simulates holding the Shift key down
+    and typing that character.
+    """
+
+    _keyboardEvent( win32con.VK_LSHIFT, KEYEVENTF_KEYDOWN )
+
+    if isinstance(key, basestring):
+        if key in KEY_MAPPING:
+            key_code = KEY_MAPPING[key]
+        else:
+            key_code = ord(key.upper())
+    else:
+        key_code = key
+
+    _keyboardEvent( key_code, KEYEVENTF_KEYDOWN )
+    _keyboardEvent( key_code, KEYEVENTF_KEYUP )
+
+    _keyboardEvent( win32con.VK_LSHIFT, KEYEVENTF_KEYUP )
+
+
 def tapKey( keyCode ):
     """
     Given a virtual key code, simulates tapping that key.
     """
-    
+
     _keyboardEvent( keyCode, KEYEVENTF_KEYDOWN )
     _keyboardEvent( keyCode, KEYEVENTF_KEYUP )
 
@@ -384,43 +481,10 @@
     # keydown, keyup, keypress, and pauses.
 
     keys = keys.split( " " )
-    mapping = { "F1" : win32con.VK_F1, 
-                "F2" : win32con.VK_F2, 
-                "F3" : win32con.VK_F3, 
-                "F4" : win32con.VK_F4, 
-                "F5" : win32con.VK_F5, 
-                "F6" : win32con.VK_F6, 
-                "F7" : win32con.VK_F7, 
-                "F8" : win32con.VK_F8, 
-                "F9" : win32con.VK_F9, 
-                "F10": win32con.VK_F10, 
-                "F11": win32con.VK_F11, 
-                "F12": win32con.VK_F12,
-                "CD" : win32con.VK_LCONTROL,
-                "CU" : win32con.VK_LCONTROL,
-                "SD" : win32con.VK_LSHIFT, 
-                "SU" : win32con.VK_LSHIFT,
-                "AD" : win32con.VK_MENU,
-                "AU" : win32con.VK_MENU,
-                "ID" : win32con.VK_LWIN,
-                "IU" : win32con.VK_LWIN,
-                "LA": win32con.VK_LEFT,
-                "RA": win32con.VK_RIGHT,
-                "ESC": win32con.VK_ESCAPE,
-                "INS": win32con.VK_INSERT,
-                "DEL": win32con.VK_DELETE
-              }
 
     for key in keys:
         key = key.upper()
-        
-        # Any one-character code means tap and release that literal key.
-        if len(key) == 1:
-            key_code = ord( key )
-            _keyboardEvent( key_code, KEYEVENTF_KEYDOWN )
-            _keyboardEvent( key_code, KEYEVENTF_KEYUP )
-            continue
-        
+
         # "W##"  means wait
         if key[0] == "W":
             time.sleep( float(key[1:]) )
@@ -430,26 +494,30 @@
         # keybd_event function, and therefore don't use our keyboard
         # event wrapper.
         if key in ["SD", "AD", "ID", "CD"]:
-            win32api.keybd_event( mapping[key], 0, KEYEVENTF_KEYDOWN, 0 )
+            win32api.keybd_event( KEY_MAPPING[key], 0, KEYEVENTF_KEYDOWN, 0 )
             continue
         if key in ["SU", "AU", "IU", "CU"]:
-            win32api.keybd_event( mapping[key], 0, KEYEVENTF_KEYUP, 0 )
+            win32api.keybd_event( KEY_MAPPING[key], 0, KEYEVENTF_KEYUP, 0 )
             continue
 
-        # Any other multi-character code means look up the code
-        # in the table above, and tap the key.
-        key_code = mapping[key]
+        # Any one-character code means tap and release that literal key.
+        if key in KEY_MAPPING:
+            key_code = KEY_MAPPING[key]
+        else:
+            key_code = ord(key.upper())
         _keyboardEvent( key_code, KEYEVENTF_KEYDOWN )
         _keyboardEvent( key_code, KEYEVENTF_KEYUP )
 
 
-def getForegroundClassNameUnicode():
+def getForegroundClassNameUnicode(hwnd = None):
     """
-    Returns a unicode string containing the class name of the frontmost
+    Returns a unicode string containing the class name of the specified
     application window.
+    If hwnd parameter is None, frontmost window will be queried.
     """
 
-    hwnd = win32gui.GetForegroundWindow()
+    if hwnd is None:
+        hwnd = win32gui.GetForegroundWindow()
 
     # Maximum number of chars we'll accept for the class name; the
     # rest will be truncated if it's longer than this.
@@ -466,6 +534,38 @@
     return classNameBuf.value
 
 
+def getWindowClassName(hwnd = None):
+    """
+    Returns a unicode string containing the class name of the specified
+    application window.
+    If hwnd parameter is None, frontmost window will be queried.
+    """
+    return getForegroundClassNameUnicode(hwnd)
+
+
+def getWindowProcessName(hwnd = None):
+    """
+    Returns a unicode string containing the process name of the specified
+    application window (executable path).
+    If hwnd parameter is None, frontmost window will be queried.
+    """
+    if hwnd is None:
+        hwnd = win32gui.GetForegroundWindow()
+    # Get PID so we can get process name
+    _, process_id = win32process.GetWindowThreadProcessId(hwnd)
+    # Get process name
+    phandle = win32api.OpenProcess(
+        win32con.PROCESS_QUERY_INFORMATION | win32con.PROCESS_VM_READ,
+        False,
+        process_id)
+    if phandle:
+        pexe = win32process.GetModuleFileNameEx(phandle, 0)
+        pexe = os.path.normcase(os.path.normpath(pexe))
+        return pexe
+    else:
+        return None
+
+
 # ----------------------------------------------------------------------------
 # Exception
 # ----------------------------------------------------------------------------
@@ -475,5 +575,5 @@
     Exception raised if the clipboard was unable to be opened after
     multiple attempts.
     """
-    
+
     pass

=== modified file 'enso/platform/win32/selection/__init__.py'
--- enso/platform/win32/selection/__init__.py	2008-04-27 11:12:38 +0000
+++ enso/platform/win32/selection/__init__.py	2010-07-30 13:46:41 +0000
@@ -70,7 +70,7 @@
     textSelContext = TextSelection.get()
     
     # Trying to "set" a file selection doesn't do anything.
-    textSelContext.replaceSelection( sel_dict )
+    return textSelContext.replaceSelection( sel_dict )
 
 
 # ----------------------------------------------------------------------------