Merge pull request #1955 from ivanov/vim-ipython

update to latest version of vim-ipython

The new features include a Ctrl-C implementation for local kernels,
autoupdates on idle and focus change for vim-ipython shell, the
possibility to limit completefunc to a local buffer only or disable it
altogether. Lots of other small bugfixes.

docs/examples/vim/README.rst

@@ -1,189 +1,253
 ###########
 vim-ipython
 ###########
 
 A two-way integration between Vim and IPython 0.11+
 
 * author: Paul Ivanov (http://pirsquared.org)
 * github: http://github.com/ivanov/vim-ipython
 * demos: http://pirsquared.org/vim-ipython/
 * blogpost: http://pirsquared.org/blog/2011/07/28/vim-ipython/
 
 Using this plugin, you can send lines or whole files for IPython to
 execute, and also get back object introspection and word completions in
 Vim, like what you get with: ``object?<enter>`` and ``object.<tab>`` in
 IPython.
 
 The big change from previous versions of ``ipy.vim`` is that it no longer
 requires the old brittle ``ipy_vimserver.py`` instantiation, and since
-it uses just vim and python, it is platform independent (i.e. should work
+it uses just vim and python, it is platform independent (i.e. works
 even on windows, unlike the previous \*nix only solution). The requirements
 are IPython 0.11+ with zeromq capabilities, vim compiled with +python.
 
 If you can launch ``ipython qtconsole`` or ``ipython kernel``, and
 ``:echo has('python')`` returns 1 in vim, you should be good to go.
 
 -----------------
 Quickstart Guide:
 -----------------
 Start ``ipython qtconsole`` [*]_ and copy the connection string.
 Source ``ipy.vim`` file, which provides new IPython command::
 
   :source ipy.vim
   (or copy it to ~/.vim/ftplugin/python to load automatically)
 
   :IPythonClipboard
   (or :IPythonXSelection if you're using X11 without having to copy)
 
 The :IPython command allows you to put the full connection string. For IPython
 0.11, it would look like this::
 
   :IPython --existing --shell=41882 --iopub=43286 --stdin=34987 --hb=36697
 
 and for IPython 0.12, like this::
 
   :IPython --existing kernel-85997.json
 
 The ``:IPythonClipboard`` command just uses the ``+`` register to get the
-connection string, whereas ``:IPythonXSelection`` uses the ``*`` register
+connection string, whereas ``:IPythonXSelection`` uses the ``*`` register.
+
+**NEW in IPython 0.12**!
+Since IPython 0.12, you can simply use::
+
+  :IPython
+
+without arguments to connect to the most recent IPython session (this is the
+same as passing just the ``--existing`` flag to ``ipython qtconsole`` and
+``ipython console``.
 
 .. [*] Though the demos above use ``qtconsole``, it is not required
     for this workflow, it's just that it was the easiest way to show how to
-    make use of the new functionality in 0.11 release. In the current git
-    trunk of IPython, you can use ``ipython kernel`` to create a kernel and
-    get the connection string to use for any frontend (including vim-ipython).
-    If you are still using 0.11, you can launch a regular kernel using
-    ``python -c "from IPython.zmq.ipkernel import main; main()"``
+    make use of the new functionality in 0.11 release. Since IPython 0.12, you
+    can use ``ipython kernel`` to create a kernel and get the connection
+    string to use for any frontend (including vim-ipython), or use ``ipython
+    console`` to create a kernel and immediately connect to it using a
+    terminal-based client. You can even connect to an active IPython Notebook
+    kernel - just watch for the connection string that gets printed when you
+    open the notebook, or use the ``%connect_info`` magic to get the
+    connection string.  If you are still using 0.11, you can launch a regular
+    kernel using ``python -c "from IPython.zmq.ipkernel import main; main()"``
 
 ------------------------
 Sending lines to IPython
 ------------------------
 Now type out a line and send it to IPython using ``<Ctrl-S>`` from Command mode::
 
   import os
 
 You should see a notification message confirming the line was sent, along
 with the input number for the line, like so ``In[1]: import os``.
 
 ``<Ctrl-S>`` also works from insert mode, but doesn't show notification,
 unless ``monitor_subchannel`` is set to ``True`` (see `vim-ipython 'shell'`_,
 below)
 
 It also works blockwise in Visual Mode. Select and send these lines using
 ``<Ctrl-S>``::
 
   import this,math # secret decoder ring
   a,b,c,d,e,f,g,h,i = range(1,10)
   code =(c,a,d,a,e,i,)
   msg = '...jrer nyy frag sebz Ivz.\nIvz+VClguba=%fyl '+this.s.split()[g]
   decode=lambda x:"\n"+"".join([this.d.get(c,c) for c in x])+"!"
   format=lambda x:'These lines:\n  '+'\n  '.join([l for l in x.splitlines()])
   secret_decoder = lambda a,b: format(a)+decode(msg)%str(b)[:-1]
   '%d'*len(code)%code == str(int(math.pi*1e5))
 
 Then, go to the qtconsole and run this line::
 
   print secret_decoder(_i,_)
 
 You can also send whole files to IPython's ``%run`` magic using ``<F5>``.
 
+**NEW in IPython 0.12**!
+If you're trying to do run code fragments that have leading whitespace, use
+``<Alt-S>`` instead - it will dedent a single line, and remove the leading
+whitespace of the first line from all lines in a visual mode selection.
+
 -------------------------------
 IPython's object? Functionality
 -------------------------------
 
-If you're using gvim, mouse-over a variable to see IPython's ? equivalent. If
-you're using vim from a terminal, or want to copy something from the
+If you're using gvim, mouse-over a variable to see IPython's ``?`` equivalent.
+If you're using vim from a terminal, or want to copy something from the
 docstring, type ``<leader>d``. ``<leader>`` is usually ``\`` (the backslash
 key).  This will open a quickpreview window, which can be closed by hitting
 ``q`` or ``<escape>``.
 
 --------------------------------------
 IPython's tab-completion Functionality
 --------------------------------------
 vim-ipython activates a 'completefunc' that queries IPython.
 A completefunc is activated using ``Ctrl-X Ctrl-U`` in Insert Mode (vim
 default). You can combine this functionality with SuperTab to get tab
 completion.
 
 -------------------
 vim-ipython 'shell'
 -------------------
-**NEW since IPython 0.11**!
 
 By monitoring km.sub_channel, we can recreate what messages were sent to
 IPython, and what IPython sends back in response.
 
 ``monitor_subchannel`` is a parameter that sets whether this 'shell' should
 updated on every sent command (default: True).
 
 If at any later time you wish to bring this shell up, including if you've set
 ``monitor_subchannel=False``, hit ``<leader>s``.
 
+**NEW since IPython 0.12**
+For local kernels (kernels running on the same machine as vim), `Ctrl-C` in
+the vim-ipython 'shell' sends an keyboard interrupt. (Note: this feature may
+not work on Windows, please report the issue to ).
+
 -------
 Options
 -------
 You can change these at the top of the ipy.vim::
 
   reselect = False            # reselect lines after sending from Visual mode
   show_execution_count = True # wait to get numbers for In[43]: feedback?
   monitor_subchannel = True   # update vim-ipython 'shell' on every send?
   run_flags= "-i"             # flags to for IPython's run magic when using <F5>
 
 **Disabling default mappings**
 In your own ``.vimrc``, if you don't like the mappings provided by default,
 you can define a variable ``let g:ipy_perform_mappings=0`` which will prevent
 vim-ipython from defining any of the default mappings.
 
+**NEW since IPython 0.12**
+**Making completefunc local to a buffer, or disabling it**
+By default, vim-ipython activates the custom completefunc globally.
+Sometimes, having a completefunc breaks other plugins' completions. Putting
+the line ``let g:ipy_completefunc = 'local'`` in one's vimrc will activate the
+IPython-based completion only for current buffer. Setting `g:ipy_completefunc`
+to anything other than `'local'` or `'global'` disables it altogether.
+
 ---------------
 Current issues:
 ---------------
 - For now, vim-ipython only connects to an ipython session in progress.
 - The ipdb integration is not yet re-implemented.
 - If you're running inside ``screen``, read about the ``<CTRL-S>`` issue `here
   <http://munkymorgy.blogspot.com/2008/07/screen-ctrl-s-bug.html>`_, and add
   this line to your ``.bashrc`` to fix it::
 
     stty stop undef # to unmap ctrl-s
 
 - In vim, if you're getting ``ImportError: No module named
   IPython.zmq.blockingkernelmanager`` but are able to import it in regular
   python, **either**
 
   1. your ``sys.path`` in vim differs from the ``sys.path`` in regular python.
      Try running these two lines, and comparing their output files::
 
       $ vim -c 'py import vim, sys; vim.current.buffer.append(sys.path)' -c ':wq vim_syspath'
       $ python -c "import sys; f=file('python_syspath','w'); f.write('\n'.join(sys.path)); f.close()"
 
   **or**
 
   2. your vim is compiled against a different python than you are launching. See
      if there's a difference between ::
 
       $ vim -c ':py import os; print os.__file__' -c ':q'
-      $ python -c ':py import os; print os.__file__'
+      $ python -c 'import os; print os.__file__'
 
 - For vim inside a terminal, using the arrow keys won't work inside a
   documentation buffer, because the mapping for ``<Esc>`` overlaps with
   ``^[OA`` and so on, and we use ``<Esc>`` as a quick way of closing the
   documentation preview window. If you want go without this quick close
   functionality and want to use the arrow keys instead, look for instructions
   starting with "Known issue: to enable the use of arrow keys..." in the
   ``get_doc_buffer`` function.
 
 - @fholgado's update to ``minibufexpl.vim`` that is up on GitHub will always
   put the cursor in the minibuf after sending a command when
   ``monitor_subchannel`` is set. This is a bug in minibufexpl.vim and the workaround
   is described in vim-ipython issue #7.
 
 ----------------------------
 Thanks and Bug Participation
 ----------------------------
-* @MinRK for guiding me through the IPython kernel manager protocol.
-* @nakamuray and @tcheneau for reporting and providing a fix for when vim is compiled without a gui (#1)
-* @unpingco for reporting Windows bugs (#3,#4)
+Here's a brief acknowledgment of the folks who have graciously pitched in. If
+you've been missed, don't hesitate to contact me, or better yet, submit a
+pull request with your attribution.
+
+* @minrk for guiding me through the IPython kernel manager protocol, and
+  support of connection_file-based IPython connection (#13)
+* @nakamuray and @tcheneau for reporting and providing a fix for when vim is
+  compiled without a gui (#1)
+* @unpingco for reporting Windows bugs (#3,#4), providing better multiline
+  dedenting (#15), and suggesting that a resized vim-ipython shell stays
+  resized (#16).
 * @simon-b for terminal vim arrow key issue (#5)
-* @jorgesca and @kwgoodman for shell (#6)
+* @jorgesca and @kwgoodman for shell update problems (#6)
+* @xowlinx and @vladimiroff for Ctrl-S issues in Konsole (#8)
 * @zeekay for easily allowing custom mappings (#9)
-* @minrk for support of connection_file-based IPython connection (#13)
-* @jorgesca for reporting the lack of profile handling capability (#14)
+* @jorgesca for reporting the lack of profile handling capability (#14),
+  only open updating 'shell' if it is open (#29)
+* @enzbang for removing mapping that's not currently functional (#17)
+* @ogrisel  for fixing documentation typo (#19)
+* @koepsell for gracefully exiting in case python is not available (#23)
+* @mrterry for activating completefunc only after a connection is made (#25),
+  Ctrl-C implementation in vim-ipython 'shell' (#28)
+* @nonameentername for completion on import statements (#26)
+* @dstahlke for setting syntax of doc window to ReST
+* @jtratner for docs with quotes (#30)
+* @pielgrzym for setting completefunc locally to a buffer (#32)
+
+Similar Projects
+----------------
+* `vim-slime`_ - Grab some text and "send" it to a GNU Screen / tmux session
+  (Jonathan Palardy)
+* `screen.vba`_ - Simulate a split shell, using GNU Screen / tmux, that you
+  can send commands to (Eric Van Dewoestine)
+* conque_ - terminal emulator which uses a Vim buffer to display the program
+  output (Nico Raffo)
+* `ipyqtmacvim`_ - plugin to send commands from MacVim to IPython Qt console
+  (Justin Kitzes)
+
+.. _vim-slime: https://github.com/jpalardy/vim-slime
+.. _screen.vba: https://github.com/ervandew/screen
+.. _conque: http://code.google.com/p/conque/
+.. _ipyqtmacvim: https://github.com/jkitzes/ipyqtmacvim/

docs/examples/vim/ipy.vim

@@ -1,521 +1,665
 " Vim integration with IPython 0.11+
 "
 " A two-way integration between Vim and IPython. 
 "
 " Using this plugin, you can send lines or whole files for IPython to execute,
 " and also get back object introspection and word completions in Vim, like
 " what you get with: object?<enter> object.<tab> in IPython
 "
 " -----------------
 " Quickstart Guide:
 " -----------------
 " Start ipython qtconsole and copy the connection string.
 " Source this file, which provides new IPython command
 "   :source ipy.vim  
 "   :IPythonClipboard   
 "   (or :IPythonXSelection if you're using X11 without having to copy)
 "
 " written by Paul Ivanov (http://pirsquared.org)
+"
+if !has('python')
+    " exit if python is not available.
+    finish
+endif
+
+" Allow custom mappings.
+if !exists('g:ipy_perform_mappings')
+    let g:ipy_perform_mappings = 1
+endif
+
+" Register IPython completefunc
+" 'global'   -- for all of vim (default).
+" 'local'    -- only for the current buffer.
+" otherwise  -- don't register it at all.
+"
+" you can later set it using ':set completefunc=CompleteIPython', which will
+" correspond to the 'global' behavior, or with ':setl ...' to get the 'local'
+" behavior
+if !exists('g:ipy_completefunc')
+    let g:ipy_completefunc = 'global'
+endif
+
 python << EOF
 reselect = False            # reselect lines after sending from Visual mode
 show_execution_count = True # wait to get numbers for In[43]: feedback?
 monitor_subchannel = True   # update vim-ipython 'shell' on every send?
 run_flags= "-i"             # flags to for IPython's run magic when using <F5>
+current_line = ''
 
 import vim
 import sys
 
 # get around unicode problems when interfacing with vim
 vim_encoding=vim.eval('&encoding') or 'utf-8'
 
 try:
     sys.stdout.flush
 except AttributeError:
     # IPython complains if stderr and stdout don't have flush
     # this is fixed in newer version of Vim
     class WithFlush(object):
         def __init__(self,noflush):
             self.write=noflush.write
             self.writelines=noflush.writelines
         def flush(self):pass
     sys.stdout = WithFlush(sys.stdout)
     sys.stderr = WithFlush(sys.stderr)
 
 
 
 ip = '127.0.0.1'
 try:
     km
 except NameError:
     km = None
+try:
+    pid
+except NameError:
+    pid = None
 
 def km_from_string(s=''):
     """create kernel manager from IPKernelApp string
     such as '--shell=47378 --iopub=39859 --stdin=36778 --hb=52668' for IPython 0.11
     or just 'kernel-12345.json' for IPython 0.12
     """
     from os.path import join as pjoin
     from IPython.zmq.blockingkernelmanager import BlockingKernelManager, Empty
     from IPython.config.loader import KeyValueConfigLoader
     from IPython.zmq.kernelapp import kernel_aliases
     global km,send,Empty
 
     s = s.replace('--existing', '')
     if 'connection_file' in BlockingKernelManager.class_trait_names():
         from IPython.lib.kernel import find_connection_file
         # 0.12 uses files instead of a collection of ports
         # include default IPython search path
         # filefind also allows for absolute paths, in which case the search
         # is ignored
         try:
             # XXX: the following approach will be brittle, depending on what
             # connection strings will end up looking like in the future, and
             # whether or not they are allowed to have spaces. I'll have to sync
             # up with the IPython team to address these issues -pi
             if '--profile' in s:
                 k,p = s.split('--profile')
                 k = k.lstrip().rstrip() # kernel part of the string
                 p = p.lstrip().rstrip() # profile part of the string
                 fullpath = find_connection_file(k,p)
             else:
                 fullpath = find_connection_file(s.lstrip().rstrip())
         except IOError,e:
             echo(":IPython " + s + " failed", "Info")
             echo("^-- failed '" + s + "' not found", "Error")
             return
         km = BlockingKernelManager(connection_file = fullpath)
         km.load_connection_file()
     else:
         if s == '':
             echo(":IPython 0.11 requires the full connection string")
             return
         loader = KeyValueConfigLoader(s.split(), aliases=kernel_aliases)
         cfg = loader.load_config()['KernelApp']
         try:
             km = BlockingKernelManager(
                 shell_address=(ip, cfg['shell_port']),
                 sub_address=(ip, cfg['iopub_port']),
                 stdin_address=(ip, cfg['stdin_port']),
                 hb_address=(ip, cfg['hb_port']))
         except KeyError,e:
             echo(":IPython " +s + " failed", "Info")
             echo("^-- failed --"+e.message.replace('_port','')+" not specified", "Error")
             return
     km.start_channels()
     send = km.shell_channel.execute
+
+    # now that we're connect to an ipython kernel, activate completion
+    # machinery, but do so only for the local buffer if the user added the
+    # following line the vimrc:
+    #   let g:ipy_completefunc = 'local'
+    vim.command("""
+        if g:ipy_completefunc == 'global'
+            set completefunc=CompleteIPython
+        elseif g:ipy_completefunc == 'local'
+            setl completefunc=CompleteIPython
+        endif
+        """)
+    # also activate GUI doc balloons if in gvim
+    vim.command("""
+        if has('balloon_eval')
+            set bexpr=IPythonBalloonExpr()
+            set ballooneval
+        endif
+        """)
+    set_pid()
     return km
 
 def echo(arg,style="Question"):
     try:
         vim.command("echohl %s" % style)
         vim.command("echom \"%s\"" % arg.replace('\"','\\\"'))
         vim.command("echohl None")
     except vim.error:
         print "-- %s" % arg
 
 def disconnect():
     "disconnect kernel manager"
     # XXX: make a prompt here if this km owns the kernel
     pass
 
 def get_doc(word):
     if km is None:
-        return ["Not connected to IPython, cannot query \"%s\"" %word]
+        return ["Not connected to IPython, cannot query: %s" % word]
     msg_id = km.shell_channel.object_info(word)
     doc = get_doc_msg(msg_id)
     # get around unicode problems when interfacing with vim
     return [d.encode(vim_encoding) for d in doc]
 
 import re
 # from http://serverfault.com/questions/71285/in-centos-4-4-how-can-i-strip-escape-sequences-from-a-text-file
 strip = re.compile('\x1B\[([0-9]{1,2}(;[0-9]{1,2})?)?[m|K]')
 def strip_color_escapes(s):
     return strip.sub('',s)
     
 def get_doc_msg(msg_id):
     n = 13 # longest field name (empirically)
     b=[]
     try:
         content = get_child_msg(msg_id)['content']
     except Empty:
         # timeout occurred
         return ["no reply from IPython kernel"]
 
     if not content['found']:
         return b
 
     for field in ['type_name','base_class','string_form','namespace',
             'file','length','definition','source','docstring']:
         c = content.get(field,None)
         if c:
             if field in ['definition']:
                 c = strip_color_escapes(c).rstrip()
             s = field.replace('_',' ').title()+':'
             s = s.ljust(n)
             if c.find('\n')==-1:
                 b.append(s+c)
             else:
                 b.append(s)
                 b.extend(c.splitlines())
     return b
 
 def get_doc_buffer(level=0):
     # empty string in case vim.eval return None
     word = vim.eval('expand("<cfile>")') or ''
     doc = get_doc(word)
     if len(doc) ==0:
-        echo(word+" not found","Error")
+        echo(repr(word)+" not found","Error")
         return
-    # close any currently open preview windows
-    vim.command('pcl')
     # documentation buffer name is same as the query made to ipython
     vim.command('new '+word)
-    vim.command('setlocal pvw modifiable noro')
+    vim.command('setlocal modifiable noro')
     # doc window quick quit keys: 'q' and 'escape'
     vim.command('map <buffer> q :q<CR>')
     # Known issue: to enable the use of arrow keys inside the terminal when
     # viewing the documentation, comment out the next line
     vim.command('map <buffer> <Esc> :q<CR>')
     # and uncomment this line (which will work if you have a timoutlen set)
     #vim.command('map <buffer> <Esc><Esc> :q<CR>')
     b = vim.current.buffer
     b[:] = None
     b[:] = doc
     vim.command('setlocal nomodified bufhidden=wipe')
     #vim.command('setlocal previewwindow nomodifiable nomodified ro')
     #vim.command('set previewheight=%d'%len(b))# go to previous window
     vim.command('resize %d'%len(b))
     #vim.command('pcl')
     #vim.command('pedit doc')
     #vim.command('normal ') # go to previous window
+    # use the ReST formatting that ships with stock vim
+    vim.command('setlocal syntax=rst')
+
+def vim_ipython_is_open():
+    """
+    Helper function to let us know if the vim-ipython shell is currently
+    visible
+    """
+    for w in vim.windows:
+        if w.buffer.name is not None and w.buffer.name.endswith("vim-ipython"):
+            return True
+    return False
 
-def update_subchannel_msgs(debug=False):
+def update_subchannel_msgs(debug=False, force=False):
+    """
+    Grab any pending messages and place them inside the vim-ipython shell.
+    This function will do nothing if the vim-ipython shell is not visible,
+    unless force=True argument is passed.
+    """
+    if km is None or (not vim_ipython_is_open() and not force):
+        return False
     msgs = km.sub_channel.get_msgs()
     if debug:
         #try:
         #    vim.command("b debug_msgs")
         #except vim.error:
         #    vim.command("new debug_msgs")
         #finally:
         db = vim.current.buffer
     else:
         db = []
     b = vim.current.buffer
     startedin_vimipython = vim.eval('@%')=='vim-ipython'
     if not startedin_vimipython:
         # switch to preview window
         vim.command(
             "try"
             "|silent! wincmd P"
             "|catch /^Vim\%((\a\+)\)\=:E441/"
             "|silent pedit +set\ ma vim-ipython"
             "|silent! wincmd P"
             "|endtry")
         # if the current window is called 'vim-ipython'
         if vim.eval('@%')=='vim-ipython':
             # set the preview window height to the current height
             vim.command("set pvh=" + vim.eval('winheight(0)'))
         else:
             # close preview window, it was something other than 'vim-ipython'
             vim.command("pcl")
             vim.command("silent pedit +set\ ma vim-ipython")
             vim.command("wincmd P") #switch to preview window
             # subchannel window quick quit key 'q'
             vim.command('map <buffer> q :q<CR>')
             vim.command("set bufhidden=hide buftype=nofile ft=python")
+            # make shift-enter and control-enter in insert mode behave same as in ipython notebook
+            # shift-enter send the current line, control-enter send the line
+            # but keeps it around for further editing.
+            vim.command("imap <buffer> <s-Enter> <esc>dd:python run_command('''<C-r>\"''')<CR>i")
+            # pkddA: paste, go up one line which is blank after run_command,
+            # delete it, and then back to insert mode
+            vim.command("imap <buffer> <c-Enter> <esc>dd:python run_command('''<C-r>\"''')<CR>pkddA")
+            # ctrl-C gets sent to the IPython process as a signal on POSIX
+            vim.command("map <buffer>  :IPythonInterrupt<cr>")
 
     #syntax highlighting for python prompt
     # QtConsole In[] is blue, but I prefer the oldschool green
     # since it makes the vim-ipython 'shell' look like the holidays!
     #vim.command("hi Blue ctermfg=Blue guifg=Blue")
     vim.command("hi Green ctermfg=Green guifg=Green")
     vim.command("hi Red ctermfg=Red guifg=Red")
     vim.command("syn keyword Green 'In\ []:'")
     vim.command("syn match Green /^In \[[0-9]*\]\:/")
     vim.command("syn match Red /^Out\[[0-9]*\]\:/")
     b = vim.current.buffer
+    update_occured = False
     for m in msgs:
         #db.append(str(m).splitlines())
         s = ''
         if 'msg_type' not in m['header']:
             # debug information
             #echo('skipping a message on sub_channel','WarningMsg')
             #echo(str(m))
             continue
         elif m['header']['msg_type'] == 'status':
             continue
         elif m['header']['msg_type'] == 'stream':
             s = strip_color_escapes(m['content']['data'])
         elif m['header']['msg_type'] == 'pyout':
             s = "Out[%d]: " % m['content']['execution_count']
             s += m['content']['data']['text/plain']
         elif m['header']['msg_type'] == 'pyin':
             # TODO: the next line allows us to resend a line to ipython if
             # %doctest_mode is on. In the future, IPython will send the
             # execution_count on subchannel, so this will need to be updated
             # once that happens
             if 'execution_count' in m['content']:
                 s = "\nIn [%d]: "% m['content']['execution_count']
             else:
                 s = "\nIn [00]: "
             s += m['content']['code'].strip()
         elif m['header']['msg_type'] == 'pyerr':
             c = m['content']
             s = "\n".join(map(strip_color_escapes,c['traceback']))
             s += c['ename'] + ":" + c['evalue']
         if s.find('\n') == -1:
             # somewhat ugly unicode workaround from
             # http://vim.1045645.n5.nabble.com/Limitations-of-vim-python-interface-with-respect-to-character-encodings-td1223881.html
             if isinstance(s,unicode):
                 s=s.encode(vim_encoding)
             b.append(s)
         else:
             try:
                 b.append(s.splitlines())
             except:
                 b.append([l.encode(vim_encoding) for l in s.splitlines()])
+        update_occured = True
     # make a newline so we can just start typing there
     if b[-1] != '':
         b.append([''])
     vim.command('normal G') # go to the end of the file
     if not startedin_vimipython:
         vim.command('normal p') # go back to where you were
+    return update_occured
 
 def get_child_msg(msg_id):
     # XXX: message handling should be split into its own process in the future
     while True:
         # get_msg will raise with Empty exception if no messages arrive in 1 second
         m= km.shell_channel.get_msg(timeout=1)
         if m['parent_header']['msg_id'] == msg_id:
             break
         else:
             #got a message, but not the one we were looking for
             echo('skipping a message on shell_channel','WarningMsg')
     return m
             
 def print_prompt(prompt,msg_id=None):
     """Print In[] or In[42] style messages"""
     global show_execution_count
     if show_execution_count and msg_id:
         # wait to get message back from kernel
         try:
             child = get_child_msg(msg_id)
             count = child['content']['execution_count']
             echo("In[%d]: %s" %(count,prompt))
         except Empty:
             echo("In[]: %s (no reply from IPython kernel)" % prompt)
     else:
         echo("In[]: %s" % prompt)
 
 def with_subchannel(f,*args):
     "conditionally monitor subchannel"
     def f_with_update(*args):
         try:
             f(*args)
             if monitor_subchannel:
                 update_subchannel_msgs()
         except AttributeError: #if km is None
             echo("not connected to IPython", 'Error')
     return f_with_update
 
 @with_subchannel
 def run_this_file():
     msg_id = send('run %s %s' % (run_flags, repr(vim.current.buffer.name),))
     print_prompt("In[]: run %s %s" % (run_flags, repr(vim.current.buffer.name)),msg_id)
 
 @with_subchannel
 def run_this_line():
     msg_id = send(vim.current.line)
     print_prompt(vim.current.line, msg_id)
 
 @with_subchannel
 def run_command(cmd):
     msg_id = send(cmd)
     print_prompt(cmd, msg_id)
-    if monitor_subchannel:
-        update_subchannel_msgs()
 
 @with_subchannel
 def run_these_lines():
     r = vim.current.range
     lines = "\n".join(vim.current.buffer[r.start:r.end+1])
     msg_id = send(lines)
     #alternative way of doing this in more recent versions of ipython
     #but %paste only works on the local machine
     #vim.command("\"*yy")
     #send("'%paste')")
     #reselect the previously highlighted block
     vim.command("normal gv")
     if not reselect:
         vim.command("normal ")
 
     #vim lines start with 1
     #print "lines %d-%d sent to ipython"% (r.start+1,r.end+1)
     prompt = "lines %d-%d "% (r.start+1,r.end+1)
     print_prompt(prompt,msg_id)
 
+
+def set_pid():
+    """
+    Explicitly ask the ipython kernel for its pid
+    """
+    global km, pid
+    lines = '\n'.join(['import os', '_pid = os.getpid()'])
+    msg_id = send(lines, silent=True, user_variables=['_pid'])
+
+    # wait to get message back from kernel
+    try:
+        child = get_child_msg(msg_id)
+    except Empty:
+        echo("no reply from IPython kernel")
+        return
+
+    pid = int(child['content']['user_variables']['_pid'])
+    return pid
+
+
+def interrupt_kernel_hack():
+    """
+    Sends the interrupt signal to the remote kernel.  This side steps the
+    (non-functional) ipython interrupt mechanisms.
+    Only works on posix.
+    """
+    global pid
+    import signal
+    import os
+    if pid is None:
+        # Avoid errors if we couldn't get pid originally,
+        # by trying to obtain it now
+        pid = set_pid()
+
+        if pid is None:
+            echo("cannot get kernel PID, Ctrl-C will not be supported")
+            return
+    echo("KeyboardInterrupt (sent to ipython: pid " +
+        "%i with signal %i)" % (pid, signal.SIGINT),"Operator")
+    try:
+        os.kill(pid, signal.SIGINT)
+    except OSError:
+        echo("unable to kill pid %d" % pid)
+        pid = None
+
 def dedent_run_this_line():
     vim.command("left")
     run_this_line()
     vim.command("silent undo")
 
 def dedent_run_these_lines():
     r = vim.current.range
     shiftwidth = vim.eval('&shiftwidth')
     count = int(vim.eval('indent(%d+1)/%s' % (r.start,shiftwidth)))
     vim.command("'<,'>" + "<"*count)
     run_these_lines()
     vim.command("silent undo")
     
 #def set_this_line():
 #    # not sure if there's a way to do this, since we have multiple clients
 #    send("get_ipython().shell.set_next_input(\'%s\')" % vim.current.line.replace("\'","\\\'"))
 #    #print "line \'%s\' set at ipython prompt"% vim.current.line
 #    echo("line \'%s\' set at ipython prompt"% vim.current.line,'Statement')
 
 
 def toggle_reselect():
     global reselect
     reselect=not reselect
     print "F9 will%sreselect lines after sending to ipython"% (reselect and " " or " not ")
 
 #def set_breakpoint():
 #    send("__IP.InteractiveTB.pdb.set_break('%s',%d)" % (vim.current.buffer.name,
 #                                                        vim.current.window.cursor[0]))
 #    print "set breakpoint in %s:%d"% (vim.current.buffer.name, 
 #                                      vim.current.window.cursor[0])
 #    
 #def clear_breakpoint():
 #    send("__IP.InteractiveTB.pdb.clear_break('%s',%d)" % (vim.current.buffer.name,
 #                                                          vim.current.window.cursor[0]))
 #    print "clearing breakpoint in %s:%d" % (vim.current.buffer.name,
 #                                            vim.current.window.cursor[0])
 #
 #def clear_all_breakpoints():
 #    send("__IP.InteractiveTB.pdb.clear_all_breaks()");
 #    print "clearing all breakpoints"
 #
 #def run_this_file_pdb():
 #    send(' __IP.InteractiveTB.pdb.run(\'execfile("%s")\')' % (vim.current.buffer.name,))
 #    #send('run -d %s' % (vim.current.buffer.name,))
 #    echo("In[]: run -d %s (using pdb)" % vim.current.buffer.name)
 
 EOF
 
 fun! <SID>toggle_send_on_save()
     if exists("s:ssos") && s:ssos == 0
         let s:ssos = 1
         au BufWritePost *.py :py run_this_file()
         echo "Autosend On"
     else
         let s:ssos = 0
         au! BufWritePost *.py
         echo "Autosend Off"
     endif
 endfun
 
-" Allow custom mappings
-if !exists('g:ipy_perform_mappings')
-    let g:ipy_perform_mappings = 1
-endif
+" Update the vim-ipython shell when the cursor is not moving.
+" You can change how quickly this happens after you stop moving the cursor by
+" setting 'updatetime' (in milliseconds). For example, to have this event
+" trigger after 1 second:
+"
+"       :set updatetime 1000
+"
+" NOTE: This will only be triggered once, after the first 'updatetime'
+" milliseconds, *not* every 'updatetime' milliseconds. see :help CursorHold
+" for more info.
+"
+" TODO: Make this easily configurable on the fly, so that an introspection
+" buffer we may have opened up doesn't get closed just because of an idle
+" event (i.e. user pressed \d and then left the buffer that popped up, but
+" expects it to stay there).
+au CursorHold *.*,vim-ipython :python if update_subchannel_msgs(): echo("vim-ipython shell updated (on idle)",'Operator')
+
+" XXX: broken - cursor hold update for insert mode moves the cursor one
+" character to the left of the last character (update_subchannel_msgs must be
+" doing this)
+"au CursorHoldI *.* :python if update_subchannel_msgs(): echo("vim-ipython shell updated (on idle)",'Operator')
+
+" Same as above, but on regaining window focus (mostly for GUIs)
+au FocusGained *.*,vim-ipython :python if update_subchannel_msgs(): echo("vim-ipython shell updated (on input focus)",'Operator')
+
+" Update vim-ipython buffer when we move the cursor there. A message is only
+" displayed if vim-ipython buffer has been updated.
+au BufEnter vim-ipython :python if update_subchannel_msgs(): echo("vim-ipython shell updated (on buffer enter)",'Operator')
+
 if g:ipy_perform_mappings != 0
     map <silent> <F5> :python run_this_file()<CR>
     map <silent> <S-F5> :python run_this_line()<CR>
     map <silent> <F9> :python run_these_lines()<CR>
     map <silent> <leader>d :py get_doc_buffer()<CR>
-    map <silent> <leader>s :py update_subchannel_msgs(); echo("vim-ipython shell updated",'Operator')<CR>
+    map <silent> <leader>s :py if update_subchannel_msgs(force=True): echo("vim-ipython shell updated",'Operator')<CR>
     map <silent> <S-F9> :python toggle_reselect()<CR>
     "map <silent> <C-F6> :python send('%pdb')<CR>
     "map <silent> <F6> :python set_breakpoint()<CR>
     "map <silent> <s-F6> :python clear_breakpoint()<CR>
     "map <silent> <F7> :python run_this_file_pdb()<CR>
     "map <silent> <s-F7> :python clear_all_breaks()<CR>
     imap <C-F5> <C-O><F5>
     imap <S-F5> <C-O><S-F5>
     imap <silent> <F5> <C-O><F5>
     map <C-F5> :call <SID>toggle_send_on_save()<CR>
     "" Example of how to quickly clear the current plot with a keystroke
-    map <silent> <F12> :python run_command("plt.clf()")<cr>
+    "map <silent> <F12> :python run_command("plt.clf()")<cr>
     "" Example of how to quickly close all figures with a keystroke
-    map <silent> <F11> :python run_command("plt.close('all')")<cr>
+    "map <silent> <F11> :python run_command("plt.close('all')")<cr>
 
     "pi custom
     map <silent> <C-Return> :python run_this_file()<CR>
     map <silent> <C-s> :python run_this_line()<CR>
     imap <silent> <C-s> <C-O>:python run_this_line()<CR>
     map <silent> <M-s> :python dedent_run_this_line()<CR>
     vmap <silent> <C-S> :python run_these_lines()<CR>
     vmap <silent> <M-s> :python dedent_run_these_lines()<CR>
     map <silent> <M-c> I#<ESC>
     vmap <silent> <M-c> I#<ESC>
     map <silent> <M-C> :s/^\([ \t]*\)#/\1/<CR>
     vmap <silent> <M-C> :s/^\([ \t]*\)#/\1/<CR>
 endif
 
 command! -nargs=* IPython :py km_from_string("<args>")
 command! -nargs=0 IPythonClipboard :py km_from_string(vim.eval('@+'))
 command! -nargs=0 IPythonXSelection :py km_from_string(vim.eval('@*'))
+command! -nargs=0 IPythonInterrupt :py interrupt_kernel_hack()
 
 function! IPythonBalloonExpr()
 python << endpython
 word = vim.eval('v:beval_text')
 reply = get_doc(word)
 vim.command("let l:doc = %s"% reply)
 endpython
 return l:doc
 endfunction
-if has('balloon_eval')
-    set bexpr=IPythonBalloonExpr()
-    set ballooneval
-endif
 
 fun! CompleteIPython(findstart, base)
 	  if a:findstart
 	    " locate the start of the word
 	    let line = getline('.')
 	    let start = col('.') - 1
 	    while start > 0 && line[start-1] =~ '\k\|\.' "keyword
 	      let start -= 1
 	    endwhile
         echo start
+        python << endpython
+current_line = vim.current.line
+endpython
 	    return start
 	  else
 	    " find months matching with "a:base"
 	    let res = []
         python << endpython
 base = vim.eval("a:base")
 findstart = vim.eval("a:findstart")
-msg_id = km.shell_channel.complete(base, vim.current.line, vim.eval("col('.')"))
+msg_id = km.shell_channel.complete(base, current_line, vim.eval("col('.')"))
 try:
     m = get_child_msg(msg_id)
     matches = m['content']['matches']
     matches.insert(0,base) # the "no completion" version
     # we need to be careful with unicode, because we can have unicode
     # completions for filenames (for the %run magic, for example). So the next
     # line will fail on those:
     #completions= [str(u) for u in matches]
     # because str() won't work for non-ascii characters
     # and we also have problems with unicode in vim, hence the following:
     completions = [s.encode(vim_encoding) for s in matches]
 except Empty:
     echo("no reply from IPython kernel")
     completions=['']
 ## Additionally, we have no good way of communicating lists to vim, so we have
 ## to turn in into one long string, which can be problematic if e.g. the
 ## completions contain quotes. The next line will not work if some filenames
 ## contain quotes - but if that's the case, the user's just asking for
 ## it, right?
 #completions = '["'+ '", "'.join(completions)+'"]'
 #vim.command("let completions = %s" % completions)
 ## An alternative for the above, which will insert matches one at a time, so
 ## if there's a problem with turning a match into a string, it'll just not
 ## include the problematic match, instead of not including anything. There's a
 ## bit more indirection here, but I think it's worth it
 for c in completions:
     vim.command('call add(res,"'+c+'")')
 endpython
         "call extend(res,completions)
 	    return res
 	  endif
 	endfun
-set completefunc=CompleteIPython