-
-
Notifications
You must be signed in to change notification settings - Fork 626
/
cursorManager.py
440 lines (376 loc) · 18.4 KB
/
cursorManager.py
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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
#cursorManager.py
#A part of NonVisual Desktop Access (NVDA)
#Copyright (C) 2006-2017 NV Access Limited, Joseph Lee, Derek Riemer
#This file is covered by the GNU General Public License.
#See the file COPYING for more details.
"""
Implementation of cursor managers.
A cursor manager provides caret navigation and selection commands for a virtual text range.
"""
import wx
import baseObject
import gui
import sayAllHandler
import review
from scriptHandler import willSayAllResume
import textInfos
import api
import speech
import config
import braille
import controlTypes
from inputCore import SCRCAT_BROWSEMODE
import ui
from textInfos import DocumentWithPageTurns
class FindDialog(wx.Dialog):
"""A dialog used to specify text to find in a cursor manager.
"""
def __init__(self, parent, cursorManager, text, caseSensitivity):
# Translators: Title of a dialog to find text.
super(FindDialog, self).__init__(parent, wx.ID_ANY, _("Find"))
# Have a copy of the active cursor manager, as this is needed later for finding text.
self.activeCursorManager = cursorManager
mainSizer = wx.BoxSizer(wx.VERTICAL)
findSizer = wx.BoxSizer(wx.HORIZONTAL)
# Translators: Dialog text for NvDA's find command.
textToFind = wx.StaticText(self, wx.ID_ANY, label=_("Type the text you wish to find"))
findSizer.Add(textToFind)
self.findTextField = wx.TextCtrl(self, wx.ID_ANY)
self.findTextField.SetValue(text)
findSizer.Add(self.findTextField)
mainSizer.Add(findSizer,border=20,flag=wx.LEFT|wx.RIGHT|wx.TOP)
# Translators: An option in find dialog to perform case-sensitive search.
self.caseSensitiveCheckBox=wx.CheckBox(self,wx.NewId(),label=_("Case &sensitive"))
self.caseSensitiveCheckBox.SetValue(caseSensitivity)
mainSizer.Add(self.caseSensitiveCheckBox,border=10,flag=wx.BOTTOM)
mainSizer.AddSizer(self.CreateButtonSizer(wx.OK|wx.CANCEL), flag=wx.ALIGN_RIGHT)
self.Bind(wx.EVT_BUTTON,self.onOk,id=wx.ID_OK)
self.Bind(wx.EVT_BUTTON,self.onCancel,id=wx.ID_CANCEL)
mainSizer.Fit(self)
self.SetSizer(mainSizer)
self.Center(wx.BOTH | wx.CENTER_ON_SCREEN)
self.findTextField.SetFocus()
def onOk(self, evt):
text = self.findTextField.GetValue()
caseSensitive = self.caseSensitiveCheckBox.GetValue()
wx.CallLater(100, self.activeCursorManager.doFindText, text, caseSensitive=caseSensitive)
self.Destroy()
def onCancel(self, evt):
self.Destroy()
class CursorManager(baseObject.ScriptableObject):
"""
A mix-in providing caret navigation and selection commands for the object's virtual text range.
This is required where a text range is not linked to a physical control and thus does not provide commands to move the cursor, select and copy text, etc.
This base cursor manager requires that the text range being used stores its own caret and selection information.
This is a mix-in class; i.e. it should be inherited alongside another L{baseObject.ScriptableObject}.
The class into which it is inherited must provide a C{makeTextInfo(position)} method.
@ivar selection: The current caret/selection range.
@type selection: L{textInfos.TextInfo}
"""
# Translators: the script category for browse mode
scriptCategory=SCRCAT_BROWSEMODE
_lastFindText=""
_lastCaseSensitivity=False
def __init__(self, *args, **kwargs):
super(CursorManager, self).__init__(*args, **kwargs)
self.initCursorManager()
def initOverlayClass(self):
"""Performs automatic initialisation if this is being used as an overlay class."""
self.initCursorManager()
def initCursorManager(self):
"""Initialise this cursor manager.
This must be called before the cursor manager functionality can be used.
It is normally called by L{__init__} or L{initOverlayClass}.
"""
self._lastSelectionMovedStart=False
def _get_selection(self):
return self.makeTextInfo(textInfos.POSITION_SELECTION)
def _set_selection(self, info):
info.updateSelection()
review.handleCaretMove(info)
braille.handler.handleCaretMove(self)
def _caretMovementScriptHelper(self,gesture,unit,direction=None,posConstant=textInfos.POSITION_SELECTION,posUnit=None,posUnitEnd=False,extraDetail=False,handleSymbols=False):
oldInfo=self.makeTextInfo(posConstant)
info=oldInfo.copy()
info.collapse(end=not self._lastSelectionMovedStart)
if not self._lastSelectionMovedStart and not oldInfo.isCollapsed:
info.move(textInfos.UNIT_CHARACTER,-1)
if posUnit is not None:
info.expand(posUnit)
info.collapse(end=posUnitEnd)
if posUnitEnd:
info.move(textInfos.UNIT_CHARACTER,-1)
if direction is not None:
info.expand(unit)
info.collapse(end=posUnitEnd)
if info.move(unit,direction)==0 and isinstance(self,DocumentWithPageTurns):
try:
self.turnPage(previous=direction<0)
except RuntimeError:
pass
else:
info=self.makeTextInfo(textInfos.POSITION_FIRST if direction>0 else textInfos.POSITION_LAST)
self.selection=info
info.expand(unit)
if not willSayAllResume(gesture): speech.speakTextInfo(info,unit=unit,reason=controlTypes.REASON_CARET)
if not oldInfo.isCollapsed:
speech.speakSelectionChange(oldInfo,self.selection)
def doFindText(self,text,reverse=False,caseSensitive=False):
if not text:
return
info=self.makeTextInfo(textInfos.POSITION_CARET)
res=info.find(text,reverse=reverse,caseSensitive=caseSensitive)
if res:
self.selection=info
speech.cancelSpeech()
info.move(textInfos.UNIT_LINE,1,endPoint="end")
speech.speakTextInfo(info,reason=controlTypes.REASON_CARET)
else:
wx.CallAfter(gui.messageBox,_('text "%s" not found')%text,_("Find Error"),wx.OK|wx.ICON_ERROR)
CursorManager._lastFindText=text
CursorManager._lastCaseSensitivity=caseSensitive
def script_find(self,gesture):
d = FindDialog(gui.mainFrame, self, self._lastFindText, self._lastCaseSensitivity)
gui.mainFrame.prePopup()
d.Show()
gui.mainFrame.postPopup()
# Translators: Input help message for NVDA's find command.
script_find.__doc__ = _("find a text string from the current cursor position")
def script_findNext(self,gesture):
if not self._lastFindText:
self.script_find(gesture)
return
self.doFindText(self._lastFindText, caseSensitive = self._lastCaseSensitivity)
# Translators: Input help message for find next command.
script_findNext.__doc__ = _("find the next occurrence of the previously entered text string from the current cursor's position")
def script_findPrevious(self,gesture):
if not self._lastFindText:
self.script_find(gesture)
return
self.doFindText(self._lastFindText,reverse=True, caseSensitive = self._lastCaseSensitivity)
# Translators: Input help message for find previous command.
script_findPrevious.__doc__ = _("find the previous occurrence of the previously entered text string from the current cursor's position")
def script_moveByPage_back(self,gesture):
self._caretMovementScriptHelper(gesture,textInfos.UNIT_LINE,-config.conf["virtualBuffers"]["linesPerPage"],extraDetail=False)
script_moveByPage_back.resumeSayAllMode=sayAllHandler.CURSOR_CARET
def script_moveByPage_forward(self,gesture):
self._caretMovementScriptHelper(gesture,textInfos.UNIT_LINE,config.conf["virtualBuffers"]["linesPerPage"],extraDetail=False)
script_moveByPage_forward.resumeSayAllMode=sayAllHandler.CURSOR_CARET
def script_moveByCharacter_back(self,gesture):
self._caretMovementScriptHelper(gesture,textInfos.UNIT_CHARACTER,-1,extraDetail=True,handleSymbols=True)
def script_moveByCharacter_forward(self,gesture):
self._caretMovementScriptHelper(gesture,textInfos.UNIT_CHARACTER,1,extraDetail=True,handleSymbols=True)
def script_moveByWord_back(self,gesture):
self._caretMovementScriptHelper(gesture,textInfos.UNIT_WORD,-1,extraDetail=True,handleSymbols=True)
def script_moveByWord_forward(self,gesture):
self._caretMovementScriptHelper(gesture,textInfos.UNIT_WORD,1,extraDetail=True,handleSymbols=True)
def script_moveByLine_back(self,gesture):
self._caretMovementScriptHelper(gesture,textInfos.UNIT_LINE,-1)
script_moveByLine_back.resumeSayAllMode=sayAllHandler.CURSOR_CARET
def script_moveByLine_forward(self,gesture):
self._caretMovementScriptHelper(gesture,textInfos.UNIT_LINE,1)
script_moveByLine_forward.resumeSayAllMode=sayAllHandler.CURSOR_CARET
def script_moveBySentence_back(self,gesture):
self._caretMovementScriptHelper(gesture,textInfos.UNIT_SENTENCE,-1)
script_moveBySentence_back.resumeSayAllMode=sayAllHandler.CURSOR_CARET
def script_moveBySentence_forward(self,gesture):
self._caretMovementScriptHelper(gesture,textInfos.UNIT_SENTENCE,1)
script_moveBySentence_forward.resumeSayAllMode=sayAllHandler.CURSOR_CARET
def script_moveByParagraph_back(self,gesture):
self._caretMovementScriptHelper(gesture,textInfos.UNIT_PARAGRAPH,-1)
script_moveByParagraph_back.resumeSayAllMode=sayAllHandler.CURSOR_CARET
def script_moveByParagraph_forward(self,gesture):
self._caretMovementScriptHelper(gesture,textInfos.UNIT_PARAGRAPH,1)
script_moveByParagraph_forward.resumeSayAllMode=sayAllHandler.CURSOR_CARET
def script_startOfLine(self,gesture):
self._caretMovementScriptHelper(gesture,textInfos.UNIT_CHARACTER,posUnit=textInfos.UNIT_LINE,extraDetail=True,handleSymbols=True)
def script_endOfLine(self,gesture):
self._caretMovementScriptHelper(gesture,textInfos.UNIT_CHARACTER,posUnit=textInfos.UNIT_LINE,posUnitEnd=True,extraDetail=True,handleSymbols=True)
def script_topOfDocument(self,gesture):
self._caretMovementScriptHelper(gesture,textInfos.UNIT_LINE,posConstant=textInfos.POSITION_FIRST)
def script_bottomOfDocument(self,gesture):
self._caretMovementScriptHelper(gesture,textInfos.UNIT_LINE,posConstant=textInfos.POSITION_LAST)
def _selectionMovementScriptHelper(self,unit=None,direction=None,toPosition=None):
oldInfo=self.makeTextInfo(textInfos.POSITION_SELECTION)
# toPosition and unit might both be provided.
# In this case, we move to the position before moving by the unit.
if toPosition:
newInfo=self.makeTextInfo(toPosition)
if oldInfo.isCollapsed:
self._lastSelectionMovedStart = newInfo.compareEndPoints(oldInfo, "startToStart") < 0
elif unit:
# position was not provided, so start from the old selection.
newInfo = oldInfo.copy()
if unit:
if oldInfo.isCollapsed:
# Starting a new selection, so set the selection direction
# based on the direction of this movement.
self._lastSelectionMovedStart = direction < 0
# Find the requested unit starting from the active end of the selection.
# We can't just move the desired endpoint because this might cause
# the end to move before the start in some cases
# and some implementations don't support this.
# For example, you might shift+rightArrow to select a character in the middle of a word
# and then press shift+control+leftArrow to move to the previous word.
newInfo.collapse(end=not self._lastSelectionMovedStart)
newInfo.move(unit, direction, endPoint="start" if direction < 0 else "end")
# Collapse this so we don't have to worry about which endpoint we used here.
newInfo.collapse(end=direction > 0)
# If we're selecting all, we're moving both endpoints.
# Otherwise, newInfo is the collapsed new active endpoint
# and we need to set the anchor endpoint.
movingSingleEndpoint = toPosition != textInfos.POSITION_ALL
if movingSingleEndpoint and self._lastSelectionMovedStart:
if newInfo.compareEndPoints(oldInfo, "startToEnd") > 0:
# We were selecting backwards, but now we're selecting forwards.
# For example:
# 1. Caret at 1
# 2. Shift+leftArrow: selection (0, 1)
# 3. Shift+control+rightArrow: next word at 3, so selection (1, 3)
newInfo.setEndPoint(oldInfo, "startToEnd")
self._lastSelectionMovedStart = False
else:
# We're selecting backwards.
# For example:
# 1. Caret at 1; selection (1, 1)
# 2. Shift+leftArrow: selection (0, 1)
newInfo.setEndPoint(oldInfo, "endToEnd")
elif movingSingleEndpoint:
if newInfo.compareEndPoints(oldInfo, "startToStart") < 0:
# We were selecting forwards, but now we're selecting backwards.
# For example:
# 1. Caret at 1
# 2. Shift+rightArrow: selection (1, 2)
# 3. Shift+control+leftArrow: previous word at 0, so selection (0, 1)
newInfo.setEndPoint(oldInfo, "endToStart")
self._lastSelectionMovedStart = True
else:
# We're selecting forwards.
# For example:
# 1. Caret at 1; selection (1, 1)
# 2. Shift+rightArrow: selection (1, 2)
newInfo.setEndPoint(oldInfo, "startToStart")
self.selection = newInfo
speech.speakSelectionChange(oldInfo,newInfo)
def script_selectCharacter_forward(self,gesture):
self._selectionMovementScriptHelper(unit=textInfos.UNIT_CHARACTER,direction=1)
def script_selectCharacter_back(self,gesture):
self._selectionMovementScriptHelper(unit=textInfos.UNIT_CHARACTER,direction=-1)
def script_selectWord_forward(self,gesture):
self._selectionMovementScriptHelper(unit=textInfos.UNIT_WORD,direction=1)
def script_selectWord_back(self,gesture):
self._selectionMovementScriptHelper(unit=textInfos.UNIT_WORD,direction=-1)
def script_selectLine_forward(self,gesture):
self._selectionMovementScriptHelper(unit=textInfos.UNIT_LINE,direction=1)
def script_selectLine_back(self,gesture):
self._selectionMovementScriptHelper(unit=textInfos.UNIT_LINE,direction=-1)
def script_selectPage_forward(self,gesture):
self._selectionMovementScriptHelper(unit=textInfos.UNIT_LINE,direction=config.conf["virtualBuffers"]["linesPerPage"])
def script_selectPage_back(self,gesture):
self._selectionMovementScriptHelper(unit=textInfos.UNIT_LINE,direction=-config.conf["virtualBuffers"]["linesPerPage"])
def script_selectParagraph_forward(self, gesture):
self._selectionMovementScriptHelper(unit=textInfos.UNIT_PARAGRAPH, direction=1)
def script_selectParagraph_back(self, gesture):
self._selectionMovementScriptHelper(unit=textInfos.UNIT_PARAGRAPH, direction=-1)
def script_selectToBeginningOfLine(self,gesture):
# Make sure the active endpoint of the selection is after the start of the line.
sel=self.makeTextInfo(textInfos.POSITION_SELECTION)
line=sel.copy()
line.collapse()
line.expand(textInfos.UNIT_LINE)
compOp="startToStart" if self._lastSelectionMovedStart else "endToStart"
if sel.compareEndPoints(line,compOp)>0:
self._selectionMovementScriptHelper(unit=textInfos.UNIT_LINE,direction=-1)
def script_selectToEndOfLine(self,gesture):
curInfo=self.makeTextInfo(textInfos.POSITION_SELECTION)
curInfo.collapse()
tempInfo=curInfo.copy()
curInfo.expand(textInfos.UNIT_CHARACTER)
tempInfo.expand(textInfos.UNIT_LINE)
if curInfo.compareEndPoints(tempInfo,"endToEnd")<0:
self._selectionMovementScriptHelper(unit=textInfos.UNIT_LINE,direction=1)
def script_selectToTopOfDocument(self,gesture):
self._selectionMovementScriptHelper(toPosition=textInfos.POSITION_FIRST)
def script_selectToBottomOfDocument(self,gesture):
self._selectionMovementScriptHelper(toPosition=textInfos.POSITION_LAST,unit=textInfos.UNIT_CHARACTER,direction=1)
def script_selectAll(self,gesture):
self._selectionMovementScriptHelper(toPosition=textInfos.POSITION_ALL)
def script_copyToClipboard(self,gesture):
info=self.makeTextInfo(textInfos.POSITION_SELECTION)
if info.isCollapsed:
# Translators: Reported when there is no text selected (for copying).
ui.message(_("No selection"))
return
if info.copyToClipboard():
# Translators: Message presented when text has been copied to clipboard.
ui.message(_("Copied to clipboard"))
def reportSelectionChange(self, oldTextInfo):
newInfo=self.makeTextInfo(textInfos.POSITION_SELECTION)
speech.speakSelectionChange(oldTextInfo,newInfo)
braille.handler.handleCaretMove(self)
__gestures = {
"kb:pageUp": "moveByPage_back",
"kb:pageDown": "moveByPage_forward",
"kb:upArrow": "moveByLine_back",
"kb:downArrow": "moveByLine_forward",
"kb:leftArrow": "moveByCharacter_back",
"kb:rightArrow": "moveByCharacter_forward",
"kb:control+leftArrow": "moveByWord_back",
"kb:control+rightArrow": "moveByWord_forward",
"kb:control+upArrow": "moveByParagraph_back",
"kb:control+downArrow": "moveByParagraph_forward",
"kb:home": "startOfLine",
"kb:end": "endOfLine",
"kb:control+home": "topOfDocument",
"kb:control+end": "bottomOfDocument",
"kb:shift+rightArrow": "selectCharacter_forward",
"kb:shift+leftArrow": "selectCharacter_back",
"kb:shift+control+rightArrow": "selectWord_forward",
"kb:shift+control+leftArrow": "selectWord_back",
"kb:shift+downArrow": "selectLine_forward",
"kb:shift+upArrow": "selectLine_back",
"kb:shift+pageDown": "selectPage_forward",
"kb:shift+pageUp": "selectPage_back",
"kb:shift+control+downArrow": "selectParagraph_forward",
"kb:shift+control+upArrow": "selectParagraph_back",
"kb:shift+end": "selectToEndOfLine",
"kb:shift+home": "selectToBeginningOfLine",
"kb:shift+control+end": "selectToBottomOfDocument",
"kb:shift+control+home": "selectToTopOfDocument",
"kb:control+a": "selectAll",
"kb:control+c": "copyToClipboard",
"kb:NVDA+Control+f": "find",
"kb:NVDA+f3": "findNext",
"kb:NVDA+shift+f3": "findPrevious",
"kb:alt+upArrow":"moveBySentence_back",
"kb:alt+downArrow":"moveBySentence_forward",
}
class _ReviewCursorManagerTextInfo(textInfos.TextInfo):
"""For use with L{ReviewCursorManager}.
Overrides L{updateCaret} and L{updateSelection} to use the selection property on the underlying object.
"""
def updateCaret(self):
info=self.copy()
info.collapse()
self.obj._selection = info
def updateSelection(self):
self.obj._selection = self.copy()
class ReviewCursorManager(CursorManager):
"""
A cursor manager used for review.
This cursor manager maintains its own caret and selection information.
Thus, the underlying text range need not support updating the caret or selection.
"""
def initCursorManager(self):
super(ReviewCursorManager, self).initCursorManager()
realTI = self.TextInfo
self.TextInfo = type("ReviewCursorManager_%s" % realTI.__name__, (_ReviewCursorManagerTextInfo, realTI), {})
self._selection = self.makeTextInfo(textInfos.POSITION_FIRST)
def makeTextInfo(self, position):
if position == textInfos.POSITION_SELECTION:
return self._selection.copy()
elif position == textInfos.POSITION_CARET:
sel = self._selection.copy()
sel.collapse()
return sel
return super(ReviewCursorManager, self).makeTextInfo(position)