Python code coverage for Lib/idlelib/AutoCompleteWindow.py

#	count	content
1	n/a	"""
2	n/a	An auto-completion window for IDLE, used by the AutoComplete extension
3	n/a	"""
4	n/a	from tkinter import *
5	n/a	from idlelib.MultiCall import MC_SHIFT
6	n/a	from idlelib.AutoComplete import COMPLETE_FILES, COMPLETE_ATTRIBUTES
7	n/a
8	n/a	HIDE_VIRTUAL_EVENT_NAME = "<<autocompletewindow-hide>>"
9	n/a	HIDE_SEQUENCES = ("<FocusOut>", "<ButtonPress>")
10	n/a	KEYPRESS_VIRTUAL_EVENT_NAME = "<<autocompletewindow-keypress>>"
11	n/a	# We need to bind event beyond <Key> so that the function will be called
12	n/a	# before the default specific IDLE function
13	n/a	KEYPRESS_SEQUENCES = ("<Key>", "<Key-BackSpace>", "<Key-Return>", "<Key-Tab>",
14	n/a	"<Key-Up>", "<Key-Down>", "<Key-Home>", "<Key-End>",
15	n/a	"<Key-Prior>", "<Key-Next>")
16	n/a	KEYRELEASE_VIRTUAL_EVENT_NAME = "<<autocompletewindow-keyrelease>>"
17	n/a	KEYRELEASE_SEQUENCE = "<KeyRelease>"
18	n/a	LISTUPDATE_SEQUENCE = "<B1-ButtonRelease>"
19	n/a	WINCONFIG_SEQUENCE = "<Configure>"
20	n/a	DOUBLECLICK_SEQUENCE = "<B1-Double-ButtonRelease>"
21	n/a
22	n/a	class AutoCompleteWindow:
23	n/a
24	n/a	def __init__(self, widget):
25	n/a	# The widget (Text) on which we place the AutoCompleteWindow
26	n/a	self.widget = widget
27	n/a	# The widgets we create
28	n/a	self.autocompletewindow = self.listbox = self.scrollbar = None
29	n/a	# The default foreground and background of a selection. Saved because
30	n/a	# they are changed to the regular colors of list items when the
31	n/a	# completion start is not a prefix of the selected completion
32	n/a	self.origselforeground = self.origselbackground = None
33	n/a	# The list of completions
34	n/a	self.completions = None
35	n/a	# A list with more completions, or None
36	n/a	self.morecompletions = None
37	n/a	# The completion mode. Either AutoComplete.COMPLETE_ATTRIBUTES or
38	n/a	# AutoComplete.COMPLETE_FILES
39	n/a	self.mode = None
40	n/a	# The current completion start, on the text box (a string)
41	n/a	self.start = None
42	n/a	# The index of the start of the completion
43	n/a	self.startindex = None
44	n/a	# The last typed start, used so that when the selection changes,
45	n/a	# the new start will be as close as possible to the last typed one.
46	n/a	self.lasttypedstart = None
47	n/a	# Do we have an indication that the user wants the completion window
48	n/a	# (for example, he clicked the list)
49	n/a	self.userwantswindow = None
50	n/a	# event ids
51	n/a	self.hideid = self.keypressid = self.listupdateid = self.winconfigid \
52	n/a	= self.keyreleaseid = self.doubleclickid = None
53	n/a	# Flag set if last keypress was a tab
54	n/a	self.lastkey_was_tab = False
55	n/a
56	n/a	def _change_start(self, newstart):
57	n/a	min_len = min(len(self.start), len(newstart))
58	n/a	i = 0
59	n/a	while i < min_len and self.start[i] == newstart[i]:
60	n/a	i += 1
61	n/a	if i < len(self.start):
62	n/a	self.widget.delete("%s+%dc" % (self.startindex, i),
63	n/a	"%s+%dc" % (self.startindex, len(self.start)))
64	n/a	if i < len(newstart):
65	n/a	self.widget.insert("%s+%dc" % (self.startindex, i),
66	n/a	newstart[i:])
67	n/a	self.start = newstart
68	n/a
69	n/a	def _binary_search(self, s):
70	n/a	"""Find the first index in self.completions where completions[i] is
71	n/a	greater or equal to s, or the last index if there is no such
72	n/a	one."""
73	n/a	i = 0; j = len(self.completions)
74	n/a	while j > i:
75	n/a	m = (i + j) // 2
76	n/a	if self.completions[m] >= s:
77	n/a	j = m
78	n/a	else:
79	n/a	i = m + 1
80	n/a	return min(i, len(self.completions)-1)
81	n/a
82	n/a	def _complete_string(self, s):
83	n/a	"""Assuming that s is the prefix of a string in self.completions,
84	n/a	return the longest string which is a prefix of all the strings which
85	n/a	s is a prefix of them. If s is not a prefix of a string, return s."""
86	n/a	first = self._binary_search(s)
87	n/a	if self.completions[first][:len(s)] != s:
88	n/a	# There is not even one completion which s is a prefix of.
89	n/a	return s
90	n/a	# Find the end of the range of completions where s is a prefix of.
91	n/a	i = first + 1
92	n/a	j = len(self.completions)
93	n/a	while j > i:
94	n/a	m = (i + j) // 2
95	n/a	if self.completions[m][:len(s)] != s:
96	n/a	j = m
97	n/a	else:
98	n/a	i = m + 1
99	n/a	last = i-1
100	n/a
101	n/a	if first == last: # only one possible completion
102	n/a	return self.completions[first]
103	n/a
104	n/a	# We should return the maximum prefix of first and last
105	n/a	first_comp = self.completions[first]
106	n/a	last_comp = self.completions[last]
107	n/a	min_len = min(len(first_comp), len(last_comp))
108	n/a	i = len(s)
109	n/a	while i < min_len and first_comp[i] == last_comp[i]:
110	n/a	i += 1
111	n/a	return first_comp[:i]
112	n/a
113	n/a	def _selection_changed(self):
114	n/a	"""Should be called when the selection of the Listbox has changed.
115	n/a	Updates the Listbox display and calls _change_start."""
116	n/a	cursel = int(self.listbox.curselection()[0])
117	n/a
118	n/a	self.listbox.see(cursel)
119	n/a
120	n/a	lts = self.lasttypedstart
121	n/a	selstart = self.completions[cursel]
122	n/a	if self._binary_search(lts) == cursel:
123	n/a	newstart = lts
124	n/a	else:
125	n/a	min_len = min(len(lts), len(selstart))
126	n/a	i = 0
127	n/a	while i < min_len and lts[i] == selstart[i]:
128	n/a	i += 1
129	n/a	newstart = selstart[:i]
130	n/a	self._change_start(newstart)
131	n/a
132	n/a	if self.completions[cursel][:len(self.start)] == self.start:
133	n/a	# start is a prefix of the selected completion
134	n/a	self.listbox.configure(selectbackground=self.origselbackground,
135	n/a	selectforeground=self.origselforeground)
136	n/a	else:
137	n/a	self.listbox.configure(selectbackground=self.listbox.cget("bg"),
138	n/a	selectforeground=self.listbox.cget("fg"))
139	n/a	# If there are more completions, show them, and call me again.
140	n/a	if self.morecompletions:
141	n/a	self.completions = self.morecompletions
142	n/a	self.morecompletions = None
143	n/a	self.listbox.delete(0, END)
144	n/a	for item in self.completions:
145	n/a	self.listbox.insert(END, item)
146	n/a	self.listbox.select_set(self._binary_search(self.start))
147	n/a	self._selection_changed()
148	n/a
149	n/a	def show_window(self, comp_lists, index, complete, mode, userWantsWin):
150	n/a	"""Show the autocomplete list, bind events.
151	n/a	If complete is True, complete the text, and if there is exactly one
152	n/a	matching completion, don't open a list."""
153	n/a	# Handle the start we already have
154	n/a	self.completions, self.morecompletions = comp_lists
155	n/a	self.mode = mode
156	n/a	self.startindex = self.widget.index(index)
157	n/a	self.start = self.widget.get(self.startindex, "insert")
158	n/a	if complete:
159	n/a	completed = self._complete_string(self.start)
160	n/a	self._change_start(completed)
161	n/a	i = self._binary_search(completed)
162	n/a	if self.completions[i] == completed and \
163	n/a	(i == len(self.completions)-1 or
164	n/a	self.completions[i+1][:len(completed)] != completed):
165	n/a	# There is exactly one matching completion
166	n/a	return
167	n/a	self.userwantswindow = userWantsWin
168	n/a	self.lasttypedstart = self.start
169	n/a
170	n/a	# Put widgets in place
171	n/a	self.autocompletewindow = acw = Toplevel(self.widget)
172	n/a	# Put it in a position so that it is not seen.
173	n/a	acw.wm_geometry("+10000+10000")
174	n/a	# Make it float
175	n/a	acw.wm_overrideredirect(1)
176	n/a	try:
177	n/a	# This command is only needed and available on Tk >= 8.4.0 for OSX
178	n/a	# Without it, call tips intrude on the typing process by grabbing
179	n/a	# the focus.
180	n/a	acw.tk.call("::tk::unsupported::MacWindowStyle", "style", acw._w,
181	n/a	"help", "noActivates")
182	n/a	except TclError:
183	n/a	pass
184	n/a	self.scrollbar = scrollbar = Scrollbar(acw, orient=VERTICAL)
185	n/a	self.listbox = listbox = Listbox(acw, yscrollcommand=scrollbar.set,
186	n/a	exportselection=False, bg="white")
187	n/a	for item in self.completions:
188	n/a	listbox.insert(END, item)
189	n/a	self.origselforeground = listbox.cget("selectforeground")
190	n/a	self.origselbackground = listbox.cget("selectbackground")
191	n/a	scrollbar.config(command=listbox.yview)
192	n/a	scrollbar.pack(side=RIGHT, fill=Y)
193	n/a	listbox.pack(side=LEFT, fill=BOTH, expand=True)
194	n/a
195	n/a	# Initialize the listbox selection
196	n/a	self.listbox.select_set(self._binary_search(self.start))
197	n/a	self._selection_changed()
198	n/a
199	n/a	# bind events
200	n/a	self.hideid = self.widget.bind(HIDE_VIRTUAL_EVENT_NAME,
201	n/a	self.hide_event)
202	n/a	for seq in HIDE_SEQUENCES:
203	n/a	self.widget.event_add(HIDE_VIRTUAL_EVENT_NAME, seq)
204	n/a	self.keypressid = self.widget.bind(KEYPRESS_VIRTUAL_EVENT_NAME,
205	n/a	self.keypress_event)
206	n/a	for seq in KEYPRESS_SEQUENCES:
207	n/a	self.widget.event_add(KEYPRESS_VIRTUAL_EVENT_NAME, seq)
208	n/a	self.keyreleaseid = self.widget.bind(KEYRELEASE_VIRTUAL_EVENT_NAME,
209	n/a	self.keyrelease_event)
210	n/a	self.widget.event_add(KEYRELEASE_VIRTUAL_EVENT_NAME,KEYRELEASE_SEQUENCE)
211	n/a	self.listupdateid = listbox.bind(LISTUPDATE_SEQUENCE,
212	n/a	self.listselect_event)
213	n/a	self.winconfigid = acw.bind(WINCONFIG_SEQUENCE, self.winconfig_event)
214	n/a	self.doubleclickid = listbox.bind(DOUBLECLICK_SEQUENCE,
215	n/a	self.doubleclick_event)
216	n/a
217	n/a	def winconfig_event(self, event):
218	n/a	if not self.is_active():
219	n/a	return
220	n/a	# Position the completion list window
221	n/a	text = self.widget
222	n/a	text.see(self.startindex)
223	n/a	x, y, cx, cy = text.bbox(self.startindex)
224	n/a	acw = self.autocompletewindow
225	n/a	acw_width, acw_height = acw.winfo_width(), acw.winfo_height()
226	n/a	text_width, text_height = text.winfo_width(), text.winfo_height()
227	n/a	new_x = text.winfo_rootx() + min(x, max(0, text_width - acw_width))
228	n/a	new_y = text.winfo_rooty() + y
229	n/a	if (text_height - (y + cy) >= acw_height # enough height below
230	n/a	or y < acw_height): # not enough height above
231	n/a	# place acw below current line
232	n/a	new_y += cy
233	n/a	else:
234	n/a	# place acw above current line
235	n/a	new_y -= acw_height
236	n/a	acw.wm_geometry("+%d+%d" % (new_x, new_y))
237	n/a
238	n/a	def hide_event(self, event):
239	n/a	if not self.is_active():
240	n/a	return
241	n/a	self.hide_window()
242	n/a
243	n/a	def listselect_event(self, event):
244	n/a	if not self.is_active():
245	n/a	return
246	n/a	self.userwantswindow = True
247	n/a	cursel = int(self.listbox.curselection()[0])
248	n/a	self._change_start(self.completions[cursel])
249	n/a
250	n/a	def doubleclick_event(self, event):
251	n/a	# Put the selected completion in the text, and close the list
252	n/a	cursel = int(self.listbox.curselection()[0])
253	n/a	self._change_start(self.completions[cursel])
254	n/a	self.hide_window()
255	n/a
256	n/a	def keypress_event(self, event):
257	n/a	if not self.is_active():
258	n/a	return
259	n/a	keysym = event.keysym
260	n/a	if hasattr(event, "mc_state"):
261	n/a	state = event.mc_state
262	n/a	else:
263	n/a	state = 0
264	n/a	if keysym != "Tab":
265	n/a	self.lastkey_was_tab = False
266	n/a	if (len(keysym) == 1 or keysym in ("underscore", "BackSpace")
267	n/a	or (self.mode == COMPLETE_FILES and keysym in
268	n/a	("period", "minus"))) \
269	n/a	and not (state & ~MC_SHIFT):
270	n/a	# Normal editing of text
271	n/a	if len(keysym) == 1:
272	n/a	self._change_start(self.start + keysym)
273	n/a	elif keysym == "underscore":
274	n/a	self._change_start(self.start + '_')
275	n/a	elif keysym == "period":
276	n/a	self._change_start(self.start + '.')
277	n/a	elif keysym == "minus":
278	n/a	self._change_start(self.start + '-')
279	n/a	else:
280	n/a	# keysym == "BackSpace"
281	n/a	if len(self.start) == 0:
282	n/a	self.hide_window()
283	n/a	return
284	n/a	self._change_start(self.start[:-1])
285	n/a	self.lasttypedstart = self.start
286	n/a	self.listbox.select_clear(0, int(self.listbox.curselection()[0]))
287	n/a	self.listbox.select_set(self._binary_search(self.start))
288	n/a	self._selection_changed()
289	n/a	return "break"
290	n/a
291	n/a	elif keysym == "Return":
292	n/a	self.hide_window()
293	n/a	return
294	n/a
295	n/a	elif (self.mode == COMPLETE_ATTRIBUTES and keysym in
296	n/a	("period", "space", "parenleft", "parenright", "bracketleft",
297	n/a	"bracketright")) or \
298	n/a	(self.mode == COMPLETE_FILES and keysym in
299	n/a	("slash", "backslash", "quotedbl", "apostrophe")) \
300	n/a	and not (state & ~MC_SHIFT):
301	n/a	# If start is a prefix of the selection, but is not '' when
302	n/a	# completing file names, put the whole
303	n/a	# selected completion. Anyway, close the list.
304	n/a	cursel = int(self.listbox.curselection()[0])
305	n/a	if self.completions[cursel][:len(self.start)] == self.start \
306	n/a	and (self.mode == COMPLETE_ATTRIBUTES or self.start):
307	n/a	self._change_start(self.completions[cursel])
308	n/a	self.hide_window()
309	n/a	return
310	n/a
311	n/a	elif keysym in ("Home", "End", "Prior", "Next", "Up", "Down") and \
312	n/a	not state:
313	n/a	# Move the selection in the listbox
314	n/a	self.userwantswindow = True
315	n/a	cursel = int(self.listbox.curselection()[0])
316	n/a	if keysym == "Home":
317	n/a	newsel = 0
318	n/a	elif keysym == "End":
319	n/a	newsel = len(self.completions)-1
320	n/a	elif keysym in ("Prior", "Next"):
321	n/a	jump = self.listbox.nearest(self.listbox.winfo_height()) - \
322	n/a	self.listbox.nearest(0)
323	n/a	if keysym == "Prior":
324	n/a	newsel = max(0, cursel-jump)
325	n/a	else:
326	n/a	assert keysym == "Next"
327	n/a	newsel = min(len(self.completions)-1, cursel+jump)
328	n/a	elif keysym == "Up":
329	n/a	newsel = max(0, cursel-1)
330	n/a	else:
331	n/a	assert keysym == "Down"
332	n/a	newsel = min(len(self.completions)-1, cursel+1)
333	n/a	self.listbox.select_clear(cursel)
334	n/a	self.listbox.select_set(newsel)
335	n/a	self._selection_changed()
336	n/a	self._change_start(self.completions[newsel])
337	n/a	return "break"
338	n/a
339	n/a	elif (keysym == "Tab" and not state):
340	n/a	if self.lastkey_was_tab:
341	n/a	# two tabs in a row; insert current selection and close acw
342	n/a	cursel = int(self.listbox.curselection()[0])
343	n/a	self._change_start(self.completions[cursel])
344	n/a	self.hide_window()
345	n/a	return "break"
346	n/a	else:
347	n/a	# first tab; let AutoComplete handle the completion
348	n/a	self.userwantswindow = True
349	n/a	self.lastkey_was_tab = True
350	n/a	return
351	n/a
352	n/a	elif any(s in keysym for s in ("Shift", "Control", "Alt",
353	n/a	"Meta", "Command", "Option")):
354	n/a	# A modifier key, so ignore
355	n/a	return
356	n/a
357	n/a	elif event.char and event.char >= ' ':
358	n/a	# Regular character with a non-length-1 keycode
359	n/a	self._change_start(self.start + event.char)
360	n/a	self.lasttypedstart = self.start
361	n/a	self.listbox.select_clear(0, int(self.listbox.curselection()[0]))
362	n/a	self.listbox.select_set(self._binary_search(self.start))
363	n/a	self._selection_changed()
364	n/a	return "break"
365	n/a
366	n/a	else:
367	n/a	# Unknown event, close the window and let it through.
368	n/a	self.hide_window()
369	n/a	return
370	n/a
371	n/a	def keyrelease_event(self, event):
372	n/a	if not self.is_active():
373	n/a	return
374	n/a	if self.widget.index("insert") != \
375	n/a	self.widget.index("%s+%dc" % (self.startindex, len(self.start))):
376	n/a	# If we didn't catch an event which moved the insert, close window
377	n/a	self.hide_window()
378	n/a
379	n/a	def is_active(self):
380	n/a	return self.autocompletewindow is not None
381	n/a
382	n/a	def complete(self):
383	n/a	self._change_start(self._complete_string(self.start))
384	n/a	# The selection doesn't change.
385	n/a
386	n/a	def hide_window(self):
387	n/a	if not self.is_active():
388	n/a	return
389	n/a
390	n/a	# unbind events
391	n/a	for seq in HIDE_SEQUENCES:
392	n/a	self.widget.event_delete(HIDE_VIRTUAL_EVENT_NAME, seq)
393	n/a	self.widget.unbind(HIDE_VIRTUAL_EVENT_NAME, self.hideid)
394	n/a	self.hideid = None
395	n/a	for seq in KEYPRESS_SEQUENCES:
396	n/a	self.widget.event_delete(KEYPRESS_VIRTUAL_EVENT_NAME, seq)
397	n/a	self.widget.unbind(KEYPRESS_VIRTUAL_EVENT_NAME, self.keypressid)
398	n/a	self.keypressid = None
399	n/a	self.widget.event_delete(KEYRELEASE_VIRTUAL_EVENT_NAME,
400	n/a	KEYRELEASE_SEQUENCE)
401	n/a	self.widget.unbind(KEYRELEASE_VIRTUAL_EVENT_NAME, self.keyreleaseid)
402	n/a	self.keyreleaseid = None
403	n/a	self.listbox.unbind(LISTUPDATE_SEQUENCE, self.listupdateid)
404	n/a	self.listupdateid = None
405	n/a	self.autocompletewindow.unbind(WINCONFIG_SEQUENCE, self.winconfigid)
406	n/a	self.winconfigid = None
407	n/a
408	n/a	# destroy widgets
409	n/a	self.scrollbar.destroy()
410	n/a	self.scrollbar = None
411	n/a	self.listbox.destroy()
412	n/a	self.listbox = None
413	n/a	self.autocompletewindow.destroy()
414	n/a	self.autocompletewindow = None