-
-
Notifications
You must be signed in to change notification settings - Fork 286
/
prompt.py
631 lines (532 loc) · 22.1 KB
/
prompt.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
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
"""
@package gui_core.prompt
@brief wxGUI command prompt
Classes:
- prompt::GPrompt
- prompt::GPromptSTC
(C) 2009-2014 by the GRASS Development Team
This program is free software under the GNU General Public License
(>=v2). Read the file COPYING that comes with GRASS for details.
@author Martin Landa <landa.martin gmail.com>
@author Michael Barton <michael.barton@asu.edu>
@author Vaclav Petras <wenzeslaus gmail.com> (copy&paste customization)
"""
import os
import difflib
import codecs
import sys
import wx
import wx.stc
from grass.script import core as grass
from grass.script import task as gtask
from grass.pydispatch.signal import Signal
from core import globalvar
from core import utils
from core.gcmd import EncodeString, DecodeString
class GPrompt(object):
"""Abstract class for interactive wxGUI prompt
Signal promptRunCmd - emitted to run command from prompt
- attribute 'cmd'
See subclass GPromptPopUp and GPromptSTC.
"""
def __init__(self, parent, menuModel):
self.parent = parent # GConsole
self.panel = self.parent.GetPanel()
self.promptRunCmd = Signal('GPrompt.promptRunCmd')
# probably only subclasses need this
self._menuModel = menuModel
self.mapList = self._getListOfMaps()
self.mapsetList = utils.ListOfMapsets()
# auto complete items
self.autoCompList = list()
self.autoCompFilter = None
# command description (gtask.grassTask)
self.cmdDesc = None
self.cmdbuffer = self._readHistory()
self.cmdindex = len(self.cmdbuffer)
# list of traced commands
self.commands = list()
def _readHistory(self):
"""Get list of commands from history file"""
hist = list()
env = grass.gisenv()
try:
fileHistory = codecs.open(
os.path.join(
env['GISDBASE'],
env['LOCATION_NAME'],
env['MAPSET'],
'.bash_history'),
encoding='utf-8',
mode='r',
errors='replace')
except IOError:
return hist
try:
for line in fileHistory.readlines():
hist.append(line.replace('\n', ''))
finally:
fileHistory.close()
return hist
def _getListOfMaps(self):
"""Get list of maps"""
result = dict()
result['raster'] = grass.list_strings('raster')
result['vector'] = grass.list_strings('vector')
return result
def _runCmd(self, cmdString):
"""Run command
:param str cmdString: command to run
"""
if not cmdString:
return
# parse command into list
try:
cmd = utils.split(str(cmdString))
except UnicodeError:
cmd = utils.split(EncodeString((cmdString)))
cmd = list(map(DecodeString, cmd))
self.promptRunCmd.emit(cmd=cmd)
self.OnCmdErase(None)
self.ShowStatusText('')
def GetCommands(self):
"""Get list of launched commands"""
return self.commands
def ClearCommands(self):
"""Clear list of commands"""
del self.commands[:]
class GPromptSTC(GPrompt, wx.stc.StyledTextCtrl):
"""Styled wxGUI prompt with autocomplete and calltips"""
def __init__(self, parent, menuModel, margin=False):
GPrompt.__init__(self, parent=parent, menuModel=menuModel)
wx.stc.StyledTextCtrl.__init__(self, self.panel, id=wx.ID_ANY)
#
# styles
#
self.SetWrapMode(True)
self.SetUndoCollection(True)
#
# create command and map lists for autocompletion
#
self.AutoCompSetIgnoreCase(False)
#
# line margins
#
# TODO print number only from cmdlog
self.SetMarginWidth(1, 0)
self.SetMarginWidth(2, 0)
if margin:
self.SetMarginType(0, wx.stc.STC_MARGIN_NUMBER)
self.SetMarginWidth(0, 30)
else:
self.SetMarginWidth(0, 0)
#
# miscellaneous
#
self.SetViewWhiteSpace(False)
self.SetUseTabs(False)
self.UsePopUp(True)
self.SetSelBackground(True, "#FFFF00")
self.SetUseHorizontalScrollBar(True)
#
# bindings
#
self.Bind(wx.EVT_WINDOW_DESTROY, self.OnDestroy)
self.Bind(wx.EVT_CHAR, self.OnChar)
self.Bind(wx.EVT_KEY_DOWN, self.OnKeyPressed)
self.Bind(wx.stc.EVT_STC_AUTOCOMP_SELECTION, self.OnItemSelected)
self.Bind(wx.EVT_LIST_ITEM_SELECTED, self.OnItemChanged)
if sys.platform != 'darwin': # unstable on Mac with wxPython 3
self.Bind(wx.EVT_KILL_FOCUS, self.OnKillFocus)
# signal which requests showing of a notification
self.showNotification = Signal('GPromptSTC.showNotification')
# signal to notify selected command
self.commandSelected = Signal('GPromptSTC.commandSelected')
def OnTextSelectionChanged(self, event):
"""Copy selected text to clipboard and skip event.
The same function is in GStc class (goutput.py).
"""
wx.CallAfter(self.Copy)
event.Skip()
def OnItemChanged(self, event):
"""Change text in statusbar
if the item selection in the auto-completion list is changed"""
# list of commands
if self.toComplete['entity'] == 'command':
item = self.toComplete['cmd'].rpartition(
'.')[0] + '.' + self.autoCompList[event.GetIndex()]
try:
nodes = self._menuModel.SearchNodes(key='command', value=item)
desc = ''
if nodes:
self.commandSelected.emit(command=item)
desc = nodes[0].data['description']
except KeyError:
desc = ''
self.ShowStatusText(desc)
# list of flags
elif self.toComplete['entity'] == 'flags':
desc = self.cmdDesc.get_flag(
self.autoCompList[
event.GetIndex()])['description']
self.ShowStatusText(desc)
# list of parameters
elif self.toComplete['entity'] == 'params':
item = self.cmdDesc.get_param(self.autoCompList[event.GetIndex()])
desc = item['name'] + '=' + item['type']
if not item['required']:
desc = '[' + desc + ']'
desc += ': ' + item['description']
self.ShowStatusText(desc)
# list of flags and commands
elif self.toComplete['entity'] == 'params+flags':
if self.autoCompList[event.GetIndex()][0] == '-':
desc = self.cmdDesc.get_flag(
self.autoCompList[
event.GetIndex()].strip('-'))['description']
else:
item = self.cmdDesc.get_param(
self.autoCompList[event.GetIndex()])
desc = item['name'] + '=' + item['type']
if not item['required']:
desc = '[' + desc + ']'
desc += ': ' + item['description']
self.ShowStatusText(desc)
else:
self.ShowStatusText('')
def OnItemSelected(self, event):
"""Item selected from the list"""
lastWord = self.GetWordLeft()
# to insert selection correctly if selected word partly matches written
# text
match = difflib.SequenceMatcher(None, event.GetText(), lastWord)
matchTuple = match.find_longest_match(
0, len(event.GetText()), 0, len(lastWord))
compl = event.GetText()[matchTuple[2]:]
text = self.GetTextLeft() + compl
# add space or '=' at the end
end = '='
for char in ('.', '-', '='):
if text.split(' ')[-1].find(char) >= 0:
end = ' '
compl += end
text += end
self.AddText(compl)
pos = len(text)
self.SetCurrentPos(pos)
cmd = text.strip().split(' ')[0]
if not self.cmdDesc or cmd != self.cmdDesc.get_name():
try:
self.cmdDesc = gtask.parse_interface(cmd)
except IOError:
self.cmdDesc = None
def OnKillFocus(self, event):
"""Hides autocomplete"""
# hide autocomplete
if self.AutoCompActive():
self.AutoCompCancel()
event.Skip()
def SetTextAndFocus(self, text):
pos = len(text)
self.commandSelected.emit(command=text)
self.SetText(text)
self.SetSelectionStart(pos)
self.SetCurrentPos(pos)
self.SetFocus()
def UpdateCmdHistory(self, cmd):
"""Update command history
:param cmd: command given as a string
"""
# add command to history
self.cmdbuffer.append(cmd)
# update also traced commands
self.commands.append(cmd)
# keep command history to a managable size
if len(self.cmdbuffer) > 200:
del self.cmdbuffer[0]
self.cmdindex = len(self.cmdbuffer)
def EntityToComplete(self):
"""Determines which part of command (flags, parameters) should
be completed at current cursor position"""
entry = self.GetTextLeft()
toComplete = dict(cmd=None, entity=None)
try:
cmd = entry.split()[0].strip()
except IndexError:
return toComplete
try:
splitted = utils.split(str(entry))
except ValueError: # No closing quotation error
return toComplete
if len(splitted) > 0 and cmd in globalvar.grassCmd:
toComplete['cmd'] = cmd
if entry[-1] == ' ':
words = entry.split(' ')
if any(word.startswith('-') for word in words):
toComplete['entity'] = 'params'
else:
toComplete['entity'] = 'params+flags'
else:
# get word left from current position
word = self.GetWordLeft(withDelimiter=True)
if word[0] == '=' and word[-1] == '@':
toComplete['entity'] = 'mapsets'
elif word[0] == '=':
# get name of parameter
paramName = self.GetWordLeft(
withDelimiter=False, ignoredDelimiter='=').strip('=')
if paramName:
try:
param = self.cmdDesc.get_param(paramName)
except (ValueError, AttributeError):
return toComplete
else:
return toComplete
if param['values']:
toComplete['entity'] = 'param values'
elif param['prompt'] == 'raster' and param['element'] == 'cell':
toComplete['entity'] = 'raster map'
elif param['prompt'] == 'vector' and param['element'] == 'vector':
toComplete['entity'] = 'vector map'
elif word[0] == '-':
toComplete['entity'] = 'flags'
elif word[0] == ' ':
toComplete['entity'] = 'params'
else:
toComplete['entity'] = 'command'
toComplete['cmd'] = cmd
return toComplete
def GetWordLeft(self, withDelimiter=False, ignoredDelimiter=None):
"""Get word left from current cursor position. The beginning
of the word is given by space or chars: .,-=
:param withDelimiter: returns the word with the initial delimeter
:param ignoredDelimiter: finds the word ignoring certain delimeter
"""
textLeft = self.GetTextLeft()
parts = list()
if ignoredDelimiter is None:
ignoredDelimiter = ''
for char in set(' .,-=') - set(ignoredDelimiter):
if not withDelimiter:
delimiter = ''
else:
delimiter = char
parts.append(delimiter + textLeft.rpartition(char)[2])
return min(parts, key=lambda x: len(x))
def ShowList(self):
"""Show sorted auto-completion list if it is not empty"""
if len(self.autoCompList) > 0:
self.autoCompList.sort()
self.AutoCompShow(
lenEntered=0, itemList=' '.join(
self.autoCompList))
def OnKeyPressed(self, event):
"""Key pressed capture special treatment for tabulator to show help"""
pos = self.GetCurrentPos()
if event.GetKeyCode() == wx.WXK_TAB:
# show GRASS command calltips (to hide press 'ESC')
entry = self.GetTextLeft()
try:
cmd = entry.split()[0].strip()
except IndexError:
cmd = ''
if cmd not in globalvar.grassCmd:
return
info = gtask.command_info(cmd)
self.CallTipSetBackground("#f4f4d1")
self.CallTipSetForeground("BLACK")
self.CallTipShow(pos, info['usage'] + '\n\n' + info['description'])
elif event.GetKeyCode() in (wx.WXK_RETURN, wx.WXK_NUMPAD_ENTER) and \
not self.AutoCompActive():
# run command on line when <return> is pressed
self._runCmd(self.GetCurLine()[0].strip())
elif event.GetKeyCode() in [wx.WXK_UP, wx.WXK_DOWN] and \
not self.AutoCompActive():
# Command history using up and down
if len(self.cmdbuffer) < 1:
return
self.DocumentEnd()
# move through command history list index values
if event.GetKeyCode() == wx.WXK_UP:
self.cmdindex = self.cmdindex - 1
if event.GetKeyCode() == wx.WXK_DOWN:
self.cmdindex = self.cmdindex + 1
if self.cmdindex < 0:
self.cmdindex = 0
if self.cmdindex > len(self.cmdbuffer) - 1:
self.cmdindex = len(self.cmdbuffer) - 1
try:
# without strip causes problem on windows
txt = self.cmdbuffer[self.cmdindex].strip()
except KeyError:
txt = ''
# clear current line and insert command history
self.DelLineLeft()
self.DelLineRight()
pos = self.GetCurrentPos()
self.InsertText(pos, txt)
self.LineEnd()
self.ShowStatusText('')
else:
event.Skip()
def OnChar(self, event):
"""Key char capture for autocompletion, calltips, and command history
.. todo::
event.ControlDown() for manual autocomplete
"""
# keycodes used: "." = 46, "=" = 61, "-" = 45
pos = self.GetCurrentPos()
# complete command after pressing '.'
if event.GetKeyCode() == 46:
self.autoCompList = list()
entry = self.GetTextLeft()
self.InsertText(pos, '.')
self.CharRight()
self.toComplete = self.EntityToComplete()
try:
if self.toComplete['entity'] == 'command':
for command in globalvar.grassCmd:
try:
if command.find(self.toComplete['cmd']) == 0:
dotNumber = list(
self.toComplete['cmd']).count('.')
self.autoCompList.append(
command.split('.', dotNumber)[-1])
except UnicodeDecodeError as e: # TODO: fix it
sys.stderr.write(
DecodeString(command) + ": " + unicode(e))
except (KeyError, TypeError):
return
self.ShowList()
# complete flags after pressing '-'
elif (event.GetKeyCode() == 45) \
or event.GetKeyCode() == wx.WXK_NUMPAD_SUBTRACT \
or event.GetKeyCode() == wx.WXK_SUBTRACT:
self.autoCompList = list()
entry = self.GetTextLeft()
self.InsertText(pos, '-')
self.CharRight()
self.toComplete = self.EntityToComplete()
if self.toComplete['entity'] == 'flags' and self.cmdDesc:
if self.GetTextLeft()[-2:] == ' -': # complete e.g. --quite
for flag in self.cmdDesc.get_options()['flags']:
if len(flag['name']) == 1:
self.autoCompList.append(flag['name'])
else:
for flag in self.cmdDesc.get_options()['flags']:
if len(flag['name']) > 1:
self.autoCompList.append(flag['name'])
self.ShowList()
# complete map or values after parameter
elif event.GetKeyCode() == 61:
self.autoCompList = list()
self.InsertText(pos, '=')
self.CharRight()
self.toComplete = self.EntityToComplete()
if self.toComplete['entity'] == 'raster map':
self.autoCompList = self.mapList['raster']
elif self.toComplete['entity'] == 'vector map':
self.autoCompList = self.mapList['vector']
elif self.toComplete['entity'] == 'param values':
param = self.GetWordLeft(
withDelimiter=False,
ignoredDelimiter='=').strip(' =')
self.autoCompList = self.cmdDesc.get_param(param)['values']
self.ShowList()
# complete mapset ('@')
elif event.GetKeyCode() == 64:
self.autoCompList = list()
self.InsertText(pos, '@')
self.CharRight()
self.toComplete = self.EntityToComplete()
if self.toComplete['entity'] == 'mapsets':
self.autoCompList = self.mapsetList
self.ShowList()
# complete after pressing CTRL + Space
elif event.GetKeyCode() == wx.WXK_SPACE and event.ControlDown():
self.autoCompList = list()
self.toComplete = self.EntityToComplete()
# complete command
if self.toComplete['entity'] == 'command':
for command in globalvar.grassCmd:
if command.find(self.toComplete['cmd']) == 0:
dotNumber = list(self.toComplete['cmd']).count('.')
self.autoCompList.append(
command.split('.', dotNumber)[-1])
# complete flags in such situations (| is cursor):
# r.colors -| ...w, q, l
# r.colors -w| ...w, q, l
elif self.toComplete['entity'] == 'flags' and self.cmdDesc:
for flag in self.cmdDesc.get_options()['flags']:
if len(flag['name']) == 1:
self.autoCompList.append(flag['name'])
# complete parameters in such situations (| is cursor):
# r.colors -w | ...color, map, rast, rules
# r.colors col| ...color
elif self.toComplete['entity'] == 'params' and self.cmdDesc:
for param in self.cmdDesc.get_options()['params']:
if param['name'].find(
self.GetWordLeft(withDelimiter=False)) == 0:
self.autoCompList.append(param['name'])
# complete flags or parameters in such situations (| is cursor):
# r.colors | ...-w, -q, -l, color, map, rast, rules
# r.colors color=grey | ...-w, -q, -l, color, map, rast, rules
elif self.toComplete['entity'] == 'params+flags' and self.cmdDesc:
self.autoCompList = list()
for param in self.cmdDesc.get_options()['params']:
self.autoCompList.append(param['name'])
for flag in self.cmdDesc.get_options()['flags']:
if len(flag['name']) == 1:
self.autoCompList.append('-' + flag['name'])
else:
self.autoCompList.append('--' + flag['name'])
self.ShowList()
# complete map or values after parameter
# r.buffer input=| ...list of raster maps
# r.buffer units=| ... feet, kilometers, ...
elif self.toComplete['entity'] == 'raster map':
self.autoCompList = list()
self.autoCompList = self.mapList['raster']
elif self.toComplete['entity'] == 'vector map':
self.autoCompList = list()
self.autoCompList = self.mapList['vector']
elif self.toComplete['entity'] == 'param values':
self.autoCompList = list()
param = self.GetWordLeft(
withDelimiter=False,
ignoredDelimiter='=').strip(' =')
self.autoCompList = self.cmdDesc.get_param(param)['values']
self.ShowList()
elif event.GetKeyCode() == wx.WXK_SPACE:
items = self.GetTextLeft().split()
if len(items) == 1:
cmd = items[0].strip()
if cmd in globalvar.grassCmd and \
(not self.cmdDesc or cmd != self.cmdDesc.get_name()):
try:
self.cmdDesc = gtask.parse_interface(cmd)
except IOError:
self.cmdDesc = None
event.Skip()
else:
event.Skip()
def ShowStatusText(self, text):
"""Requests showing of notification, e.g. showing in a statusbar."""
self.showNotification.emit(message=text)
def GetTextLeft(self):
"""Returns all text left of the caret"""
pos = self.GetCurrentPos()
self.HomeExtend()
entry = self.GetSelectedText()
self.SetCurrentPos(pos)
return entry
def OnDestroy(self, event):
"""The clipboard contents can be preserved after
the app has exited"""
if wx.TheClipboard.IsOpened():
wx.TheClipboard.Flush()
event.Skip()
def OnCmdErase(self, event):
"""Erase command prompt"""
self.Home()
self.DelLineRight()