Skip to content

Fixed issue where completion display function was overwritten when a … #376

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kmvanbrunt merged 2 commits into from
Apr 28, 2018
Merged

Fixed issue where completion display function was overwritten when a … #376

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5868fee
Fixed issue where completion display function was overwritten when a …
kmvanbrunt Apr 28, 2018
4447a8b
Properly copying a list
kmvanbrunt Apr 28, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 36 additions & 34 deletions cmd2/cmd2.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,6 @@
import ctypes
from .rl_utils import readline_lib

# Save address that rl_basic_quote_characters is pointing to since we need to override and restore it
rl_basic_quote_characters = ctypes.c_char_p.in_dll(readline_lib, "rl_basic_quote_characters")
orig_rl_basic_quote_characters_addr = ctypes.cast(rl_basic_quote_characters, ctypes.c_void_p).value

# Newer versions of pyperclip are released as a single file, but older versions had a more complicated structure
try:
from pyperclip.exceptions import PyperclipException
Expand Down Expand Up @@ -595,11 +591,22 @@ def complete_submenu(_self, text, line, begidx, endidx):
try:
# copy over any shared attributes
self._copy_in_shared_attrs(_self)

# Reset the submenu's tab completion parameters
submenu.allow_appended_space = True
submenu.allow_closing_quote = True
submenu.display_matches = []

return _complete_from_cmd(submenu, text, line, begidx, endidx)
finally:
# copy back original attributes
self._copy_out_shared_attrs(_self, original_attributes)

# Pass the submenu's tab completion parameters back up to the menu that called complete()
_self.allow_appended_space = submenu.allow_appended_space
_self.allow_closing_quote = submenu.allow_closing_quote
_self.display_matches = copy.copy(submenu.display_matches)

original_do_help = cmd_obj.do_help
original_complete_help = cmd_obj.complete_help

Expand Down Expand Up @@ -987,6 +994,11 @@ def set_completion_defaults(self):
self.allow_closing_quote = True
self.display_matches = []

if rl_type == RlType.GNU:
readline.set_completion_display_matches_hook(self._display_matches_gnu_readline)
elif rl_type == RlType.PYREADLINE:
readline.rl.mode._display_completions = self._display_matches_pyreadline

def tokens_for_completion(self, line, begidx, endidx):
"""
Used by tab completion functions to get all tokens through the one being completed
Expand Down Expand Up @@ -2357,38 +2369,33 @@ def _cmdloop(self):
"""
# An almost perfect copy from Cmd; however, the pseudo_raw_input portion
# has been split out so that it can be called separately
if self.use_rawinput and self.completekey:
if self.use_rawinput and self.completekey and rl_type != RlType.NONE:

# Set up readline for our tab completion needs
if rl_type == RlType.GNU:
readline.set_completion_display_matches_hook(self._display_matches_gnu_readline)

# Set GNU readline's rl_basic_quote_characters to NULL so it won't automatically add a closing quote
# We don't need to worry about setting rl_completion_suppress_quote since we never declared
# rl_completer_quote_characters.
rl_basic_quote_characters.value = None
basic_quote_characters = ctypes.c_char_p.in_dll(readline_lib, "rl_basic_quote_characters")
old_basic_quote_characters = ctypes.cast(basic_quote_characters, ctypes.c_void_p).value
basic_quote_characters.value = None

elif rl_type == RlType.PYREADLINE:
readline.rl.mode._display_completions = self._display_matches_pyreadline
old_completer = readline.get_completer()
old_delims = readline.get_completer_delims()
readline.set_completer(self.complete)

try:
self.old_completer = readline.get_completer()
self.old_delims = readline.get_completer_delims()
readline.set_completer(self.complete)
# Break words on whitespace and quotes when tab completing
completer_delims = " \t\n" + ''.join(constants.QUOTES)

# Break words on whitespace and quotes when tab completing
completer_delims = " \t\n" + ''.join(constants.QUOTES)
if self.allow_redirection:
# If redirection is allowed, then break words on those characters too
completer_delims += ''.join(constants.REDIRECTION_CHARS)

if self.allow_redirection:
# If redirection is allowed, then break words on those characters too
completer_delims += ''.join(constants.REDIRECTION_CHARS)
readline.set_completer_delims(completer_delims)

readline.set_completer_delims(completer_delims)
# Enable tab completion
readline.parse_and_bind(self.completekey + ": complete")

# Enable tab completion
readline.parse_and_bind(self.completekey + ": complete")
except NameError:
pass
stop = None
try:
while not stop:
Expand All @@ -2412,19 +2419,15 @@ def _cmdloop(self):
# Run the command along with all associated pre and post hooks
stop = self.onecmd_plus_hooks(line)
finally:
if self.use_rawinput and self.completekey:
if self.use_rawinput and self.completekey and rl_type != RlType.NONE:

# Restore what we changed in readline
try:
readline.set_completer(self.old_completer)
readline.set_completer_delims(self.old_delims)
except NameError:
pass
readline.set_completer(old_completer)
readline.set_completer_delims(old_delims)

if rl_type == RlType.GNU:
readline.set_completion_display_matches_hook(None)
rl_basic_quote_characters.value = orig_rl_basic_quote_characters_addr

basic_quote_characters.value = old_basic_quote_characters
elif rl_type == RlType.PYREADLINE:
readline.rl.mode._display_completions = orig_pyreadline_display

Expand Down Expand Up @@ -2770,7 +2773,7 @@ def show(self, args, parameter):
set_parser = ACArgumentParser(formatter_class=argparse.RawTextHelpFormatter)
set_parser.add_argument('-a', '--all', action='store_true', help='display read-only settings as well')
set_parser.add_argument('-l', '--long', action='store_true', help='describe function of parameter')
set_parser.add_argument('settable', nargs=(0,2), help='[param_name] [value]')
set_parser.add_argument('settable', nargs=(0, 2), help='[param_name] [value]')

@with_argparser(set_parser)
def do_set(self, args):
Expand Down Expand Up @@ -2851,7 +2854,6 @@ def complete_shell(self, text, line, begidx, endidx):
index_dict = {1: self.shell_cmd_complete}
return self.index_based_complete(text, line, begidx, endidx, index_dict, self.path_complete)


# noinspection PyBroadException
def do_py(self, arg):
"""
Expand Down