1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
# (C) Copyright 2005-2023 Enthought, Inc., Austin, TX
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in LICENSE.txt and may be redistributed only under
# the conditions described in the aforementioned license. The license
# is also available online at http://www.enthought.com/licenses/BSD.txt
#
# Thanks for using Enthought open source!
from pyface.qt import QtGui
from .console_widget import ConsoleWidget
class HistoryConsoleWidget(ConsoleWidget):
""" A ConsoleWidget that keeps a history of the commands that have been
executed and provides a readline-esque interface to this history.
"""
# ---------------------------------------------------------------------------
# 'object' interface
# ---------------------------------------------------------------------------
def __init__(self, *args, **kw):
super().__init__(*args, **kw)
# HistoryConsoleWidget protected variables.
self._history = []
self._history_index = 0
self._history_prefix = ""
# ---------------------------------------------------------------------------
# 'ConsoleWidget' public interface
# ---------------------------------------------------------------------------
def execute(self, source=None, hidden=False, interactive=False):
""" Reimplemented to the store history.
"""
if not hidden:
history = self.input_buffer if source is None else source
executed = super().execute(source, hidden, interactive)
if executed and not hidden:
# Save the command unless it was an empty string or was identical
# to the previous command.
history = history.rstrip()
if history and (not self._history or self._history[-1] != history):
self._history.append(history)
# Move the history index to the most recent item.
self._history_index = len(self._history)
return executed
# ---------------------------------------------------------------------------
# 'ConsoleWidget' abstract interface
# ---------------------------------------------------------------------------
def _up_pressed(self):
""" Called when the up key is pressed. Returns whether to continue
processing the event.
"""
prompt_cursor = self._get_prompt_cursor()
if self._get_cursor().blockNumber() == prompt_cursor.blockNumber():
# Set a search prefix based on the cursor position.
col = self._get_input_buffer_cursor_column()
input_buffer = self.input_buffer
if self._history_index == len(self._history) or (
self._history_prefix and col != len(self._history_prefix)
):
self._history_index = len(self._history)
self._history_prefix = input_buffer[:col]
# Perform the search.
self.history_previous(self._history_prefix)
# Go to the first line of the prompt for seemless history scrolling.
# Emulate readline: keep the cursor position fixed for a prefix
# search.
cursor = self._get_prompt_cursor()
if self._history_prefix:
cursor.movePosition(
QtGui.QTextCursor.MoveOperation.Right, n=len(self._history_prefix)
)
else:
cursor.movePosition(QtGui.QTextCursor.MoveOperation.EndOfLine)
self._set_cursor(cursor)
return False
return True
def _down_pressed(self):
""" Called when the down key is pressed. Returns whether to continue
processing the event.
"""
end_cursor = self._get_end_cursor()
if self._get_cursor().blockNumber() == end_cursor.blockNumber():
# Perform the search.
self.history_next(self._history_prefix)
# Emulate readline: keep the cursor position fixed for a prefix
# search. (We don't need to move the cursor to the end of the buffer
# in the other case because this happens automatically when the
# input buffer is set.)
if self._history_prefix:
cursor = self._get_prompt_cursor()
cursor.movePosition(
QtGui.QTextCursor.MoveOperation.Right, n=len(self._history_prefix)
)
self._set_cursor(cursor)
return False
return True
# ---------------------------------------------------------------------------
# 'HistoryConsoleWidget' public interface
# ---------------------------------------------------------------------------
def history_previous(self, prefix=""):
""" If possible, set the input buffer to a previous item in the history.
Parameters:
-----------
prefix : str, optional
If specified, search for an item with this prefix.
"""
index = self._history_index
while index > 0:
index -= 1
history = self._history[index]
if history.startswith(prefix):
break
else:
history = None
if history is not None:
self._history_index = index
self.input_buffer = history
def history_next(self, prefix=""):
""" Set the input buffer to a subsequent item in the history, or to the
original search prefix if there is no such item.
Parameters:
-----------
prefix : str, optional
If specified, search for an item with this prefix.
"""
while self._history_index < len(self._history) - 1:
self._history_index += 1
history = self._history[self._history_index]
if history.startswith(prefix):
break
else:
self._history_index = len(self._history)
history = prefix
self.input_buffer = history
# ---------------------------------------------------------------------------
# 'HistoryConsoleWidget' protected interface
# ---------------------------------------------------------------------------
def _set_history(self, history, history_index=None):
""" Replace the current history with a sequence of history items.
"""
if history_index is None:
history_index = len(history)
self._history = list(history)
self._history_index = history_index
|
