Python code coverage for Lib/idlelib/ParenMatch.py

#	count	content
1	n/a	"""ParenMatch -- An IDLE extension for parenthesis matching.
2	n/a
3	n/a	When you hit a right paren, the cursor should move briefly to the left
4	n/a	paren. Paren here is used generically; the matching applies to
5	n/a	parentheses, square brackets, and curly braces.
6	n/a	"""
7	n/a
8	n/a	from idlelib.HyperParser import HyperParser
9	n/a	from idlelib.configHandler import idleConf
10	n/a
11	n/a	_openers = {')':'(',']':'[','}':'{'}
12	n/a	CHECK_DELAY = 100 # miliseconds
13	n/a
14	n/a	class ParenMatch:
15	n/a	"""Highlight matching parentheses
16	n/a
17	n/a	There are three supported style of paren matching, based loosely
18	n/a	on the Emacs options. The style is select based on the
19	n/a	HILITE_STYLE attribute; it can be changed used the set_style
20	n/a	method.
21	n/a
22	n/a	The supported styles are:
23	n/a
24	n/a	default -- When a right paren is typed, highlight the matching
25	n/a	left paren for 1/2 sec.
26	n/a
27	n/a	expression -- When a right paren is typed, highlight the entire
28	n/a	expression from the left paren to the right paren.
29	n/a
30	n/a	TODO:
31	n/a	- extend IDLE with configuration dialog to change options
32	n/a	- implement rest of Emacs highlight styles (see below)
33	n/a	- print mismatch warning in IDLE status window
34	n/a
35	n/a	Note: In Emacs, there are several styles of highlight where the
36	n/a	matching paren is highlighted whenever the cursor is immediately
37	n/a	to the right of a right paren. I don't know how to do that in Tk,
38	n/a	so I haven't bothered.
39	n/a	"""
40	n/a	menudefs = [
41	n/a	('edit', [
42	n/a	("Show surrounding parens", "<<flash-paren>>"),
43	n/a	])
44	n/a	]
45	n/a	STYLE = idleConf.GetOption('extensions','ParenMatch','style',
46	n/a	default='expression')
47	n/a	FLASH_DELAY = idleConf.GetOption('extensions','ParenMatch','flash-delay',
48	n/a	type='int',default=500)
49	n/a	HILITE_CONFIG = idleConf.GetHighlight(idleConf.CurrentTheme(),'hilite')
50	n/a	BELL = idleConf.GetOption('extensions','ParenMatch','bell',
51	n/a	type='bool',default=1)
52	n/a
53	n/a	RESTORE_VIRTUAL_EVENT_NAME = "<<parenmatch-check-restore>>"
54	n/a	# We want the restore event be called before the usual return and
55	n/a	# backspace events.
56	n/a	RESTORE_SEQUENCES = ("<KeyPress>", "<ButtonPress>",
57	n/a	"<Key-Return>", "<Key-BackSpace>")
58	n/a
59	n/a	def __init__(self, editwin):
60	n/a	self.editwin = editwin
61	n/a	self.text = editwin.text
62	n/a	# Bind the check-restore event to the function restore_event,
63	n/a	# so that we can then use activate_restore (which calls event_add)
64	n/a	# and deactivate_restore (which calls event_delete).
65	n/a	editwin.text.bind(self.RESTORE_VIRTUAL_EVENT_NAME,
66	n/a	self.restore_event)
67	n/a	self.counter = 0
68	n/a	self.is_restore_active = 0
69	n/a	self.set_style(self.STYLE)
70	n/a
71	n/a	def activate_restore(self):
72	n/a	if not self.is_restore_active:
73	n/a	for seq in self.RESTORE_SEQUENCES:
74	n/a	self.text.event_add(self.RESTORE_VIRTUAL_EVENT_NAME, seq)
75	n/a	self.is_restore_active = True
76	n/a
77	n/a	def deactivate_restore(self):
78	n/a	if self.is_restore_active:
79	n/a	for seq in self.RESTORE_SEQUENCES:
80	n/a	self.text.event_delete(self.RESTORE_VIRTUAL_EVENT_NAME, seq)
81	n/a	self.is_restore_active = False
82	n/a
83	n/a	def set_style(self, style):
84	n/a	self.STYLE = style
85	n/a	if style == "default":
86	n/a	self.create_tag = self.create_tag_default
87	n/a	self.set_timeout = self.set_timeout_last
88	n/a	elif style == "expression":
89	n/a	self.create_tag = self.create_tag_expression
90	n/a	self.set_timeout = self.set_timeout_none
91	n/a
92	n/a	def flash_paren_event(self, event):
93	n/a	indices = HyperParser(self.editwin, "insert").get_surrounding_brackets()
94	n/a	if indices is None:
95	n/a	self.warn_mismatched()
96	n/a	return
97	n/a	self.activate_restore()
98	n/a	self.create_tag(indices)
99	n/a	self.set_timeout_last()
100	n/a
101	n/a	def paren_closed_event(self, event):
102	n/a	# If it was a shortcut and not really a closing paren, quit.
103	n/a	closer = self.text.get("insert-1c")
104	n/a	if closer not in _openers:
105	n/a	return
106	n/a	hp = HyperParser(self.editwin, "insert-1c")
107	n/a	if not hp.is_in_code():
108	n/a	return
109	n/a	indices = hp.get_surrounding_brackets(_openers[closer], True)
110	n/a	if indices is None:
111	n/a	self.warn_mismatched()
112	n/a	return
113	n/a	self.activate_restore()
114	n/a	self.create_tag(indices)
115	n/a	self.set_timeout()
116	n/a
117	n/a	def restore_event(self, event=None):
118	n/a	self.text.tag_delete("paren")
119	n/a	self.deactivate_restore()
120	n/a	self.counter += 1 # disable the last timer, if there is one.
121	n/a
122	n/a	def handle_restore_timer(self, timer_count):
123	n/a	if timer_count == self.counter:
124	n/a	self.restore_event()
125	n/a
126	n/a	def warn_mismatched(self):
127	n/a	if self.BELL:
128	n/a	self.text.bell()
129	n/a
130	n/a	# any one of the create_tag_XXX methods can be used depending on
131	n/a	# the style
132	n/a
133	n/a	def create_tag_default(self, indices):
134	n/a	"""Highlight the single paren that matches"""
135	n/a	self.text.tag_add("paren", indices[0])
136	n/a	self.text.tag_config("paren", self.HILITE_CONFIG)
137	n/a
138	n/a	def create_tag_expression(self, indices):
139	n/a	"""Highlight the entire expression"""
140	n/a	if self.text.get(indices[1]) in (')', ']', '}'):
141	n/a	rightindex = indices[1]+"+1c"
142	n/a	else:
143	n/a	rightindex = indices[1]
144	n/a	self.text.tag_add("paren", indices[0], rightindex)
145	n/a	self.text.tag_config("paren", self.HILITE_CONFIG)
146	n/a
147	n/a	# any one of the set_timeout_XXX methods can be used depending on
148	n/a	# the style
149	n/a
150	n/a	def set_timeout_none(self):
151	n/a	"""Highlight will remain until user input turns it off
152	n/a	or the insert has moved"""
153	n/a	# After CHECK_DELAY, call a function which disables the "paren" tag
154	n/a	# if the event is for the most recent timer and the insert has changed,
155	n/a	# or schedules another call for itself.
156	n/a	self.counter += 1
157	n/a	def callme(callme, self=self, c=self.counter,
158	n/a	index=self.text.index("insert")):
159	n/a	if index != self.text.index("insert"):
160	n/a	self.handle_restore_timer(c)
161	n/a	else:
162	n/a	self.editwin.text_frame.after(CHECK_DELAY, callme, callme)
163	n/a	self.editwin.text_frame.after(CHECK_DELAY, callme, callme)
164	n/a
165	n/a	def set_timeout_last(self):
166	n/a	"""The last highlight created will be removed after .5 sec"""
167	n/a	# associate a counter with an event; only disable the "paren"
168	n/a	# tag if the event is for the most recent timer.
169	n/a	self.counter += 1
170	n/a	self.editwin.text_frame.after(self.FLASH_DELAY,
171	n/a	lambda self=self, c=self.counter: \
172	n/a	self.handle_restore_timer(c))