Tag windows-only function so it doesn't get picked up on *nix doc builds.

IPython/terminal/shortcuts.py

@@ -1,165 +1,167 b''
 import signal
 import sys
 
 from prompt_toolkit.enums import DEFAULT_BUFFER, SEARCH_BUFFER
 from prompt_toolkit.filters import (HasFocus, HasSelection, Condition,
     ViInsertMode, EmacsInsertMode, HasCompletions)
 from prompt_toolkit.filters.cli import ViMode
 from prompt_toolkit.keys import Keys
 from prompt_toolkit.key_binding.bindings.completion import display_completions_like_readline
 
+from IPython.utils.decorators import undoc
+
 @Condition
 def cursor_in_leading_ws(cli):
     before = cli.application.buffer.document.current_line_before_cursor
     return (not before) or before.isspace()
 
 def register_ipython_shortcuts(registry, shell):
     """Set up the prompt_toolkit keyboard shortcuts for IPython"""
     insert_mode = ViInsertMode() | EmacsInsertMode()
 
     # Ctrl+J == Enter, seemingly
     registry.add_binding(Keys.ControlJ,
                          filter=(HasFocus(DEFAULT_BUFFER)
                                  & ~HasSelection()
                                  & insert_mode
                         ))(newline_or_execute_outer(shell))
 
     registry.add_binding(Keys.ControlP,
                          filter=(ViInsertMode() & HasFocus(DEFAULT_BUFFER)
                         ))(previous_history_or_previous_completion)
 
     registry.add_binding(Keys.ControlN,
                          filter=(ViInsertMode() & HasFocus(DEFAULT_BUFFER)
                         ))(next_history_or_next_completion)
 
     registry.add_binding(Keys.ControlG,
                          filter=(HasFocus(DEFAULT_BUFFER) & HasCompletions()
                         ))(dismiss_completion)
 
     registry.add_binding(Keys.ControlC, filter=HasFocus(DEFAULT_BUFFER)
                         )(reset_buffer)
 
     registry.add_binding(Keys.ControlC, filter=HasFocus(SEARCH_BUFFER)
                         )(reset_search_buffer)
 
     supports_suspend = Condition(lambda cli: hasattr(signal, 'SIGTSTP'))
     registry.add_binding(Keys.ControlZ, filter=supports_suspend
                         )(suspend_to_bg)
 
     # Ctrl+I == Tab
     registry.add_binding(Keys.ControlI,
                          filter=(HasFocus(DEFAULT_BUFFER)
                                  & ~HasSelection()
                                  & insert_mode
                                  & cursor_in_leading_ws
                         ))(indent_buffer)
 
     if shell.display_completions == 'readlinelike':
         registry.add_binding(Keys.ControlI,
                              filter=(HasFocus(DEFAULT_BUFFER)
                                      & ~HasSelection()
                                      & insert_mode
                                      & ~cursor_in_leading_ws
                             ))(display_completions_like_readline)
 
     if sys.platform == 'win32':
         registry.add_binding(Keys.ControlV,
                              filter=(
                              HasFocus(
                              DEFAULT_BUFFER) & ~ViMode()
                             ))(win_paste)
 
 
 def newline_or_execute_outer(shell):
     def newline_or_execute(event):
         """When the user presses return, insert a newline or execute the code."""
         b = event.current_buffer
         d = b.document
 
         if b.complete_state:
             cc = b.complete_state.current_completion
             if cc:
                 b.apply_completion(cc)
             else:
                 b.cancel_completion()
             return
 
         if not (d.on_last_line or d.cursor_position_row >= d.line_count
             - d.empty_line_count_at_the_end()):
             b.newline()
             return
 
         status, indent = shell.input_splitter.check_complete(d.text + '\n')
 
         if (status != 'incomplete') and b.accept_action.is_returnable:
             b.accept_action.validate_and_handle(event.cli, b)
         else:
             b.insert_text('\n' + (' ' * (indent or 0)))
     return newline_or_execute
 
 
 def previous_history_or_previous_completion(event):
     """
     Control-P in vi edit mode on readline is history next, unlike default prompt toolkit.
 
     If completer is open this still select previous completion.
     """
     event.current_buffer.auto_up()
 
 
 def next_history_or_next_completion(event):
     """
     Control-N in vi edit mode on readline is history previous, unlike default prompt toolkit.
 
     If completer is open this still select next completion.
     """
     event.current_buffer.auto_down()
 
 
 def dismiss_completion(event):
     b = event.current_buffer
     if b.complete_state:
         b.cancel_completion()
 
 
 def reset_buffer(event):
     b = event.current_buffer
     if b.complete_state:
         b.cancel_completion()
     else:
         b.reset()
 
 
 def reset_search_buffer(event):
     if event.current_buffer.document.text:
         event.current_buffer.reset()
     else:
         event.cli.push_focus(DEFAULT_BUFFER)
 
 def suspend_to_bg(event):
     event.cli.suspend_to_background()
 
 def indent_buffer(event):
     event.current_buffer.insert_text(' ' * 4)
 
 
 
 
 if sys.platform == 'win32':
     from IPython.core.error import TryNext
     from IPython.lib.clipboard import (ClipboardEmpty,
                                        win32_clipboard_get,
                                        tkinter_clipboard_get)
 
-
+    @undoc
     def win_paste(event):
         try:
             text = win32_clipboard_get()
         except TryNext:
             try:
                 text = tkinter_clipboard_get()
             except (TryNext, ClipboardEmpty):
                 return
         except ClipboardEmpty:
             return
         event.current_buffer.insert_text(text.replace('\t', ' ' * 4))