Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

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

# vim: ft=python fileencoding=utf-8 sts=4 sw=4 et: 

 

# Copyright 2014-2018 Florian Bruhin (The Compiler) <mail@qutebrowser.org> 

# 

# This file is part of qutebrowser. 

# 

# qutebrowser is free software: you can redistribute it and/or modify 

# it under the terms of the GNU General Public License as published by 

# the Free Software Foundation, either version 3 of the License, or 

# (at your option) any later version. 

# 

# qutebrowser is distributed in the hope that it will be useful, 

# but WITHOUT ANY WARRANTY; without even the implied warranty of 

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

# GNU General Public License for more details. 

# 

# You should have received a copy of the GNU General Public License 

# along with qutebrowser. If not, see <http://www.gnu.org/licenses/>. 

 

"""The commandline in the statusbar.""" 

 

from PyQt5.QtCore import pyqtSignal, pyqtSlot, Qt, QSize 

from PyQt5.QtWidgets import QSizePolicy 

 

from qutebrowser.keyinput import modeman, modeparsers 

from qutebrowser.commands import cmdexc, cmdutils 

from qutebrowser.misc import cmdhistory, editor 

from qutebrowser.misc import miscwidgets as misc 

from qutebrowser.utils import usertypes, log, objreg, message, utils 

from qutebrowser.config import config 

 

 

class Command(misc.MinimalLineEditMixin, misc.CommandLineEdit): 

 

"""The commandline part of the statusbar. 

 

Attributes: 

_win_id: The window ID this widget is associated with. 

 

Signals: 

got_cmd: Emitted when a command is triggered by the user. 

arg: The command string and also potentially the count. 

clear_completion_selection: Emitted before the completion widget is 

hidden. 

hide_completion: Emitted when the completion widget should be hidden. 

update_completion: Emitted when the completion should be shown/updated. 

show_cmd: Emitted when command input should be shown. 

hide_cmd: Emitted when command input can be hidden. 

""" 

 

got_cmd = pyqtSignal([str], [str, int]) 

clear_completion_selection = pyqtSignal() 

hide_completion = pyqtSignal() 

update_completion = pyqtSignal() 

show_cmd = pyqtSignal() 

hide_cmd = pyqtSignal() 

 

def __init__(self, *, win_id, private, parent=None): 

misc.CommandLineEdit.__init__(self, parent=parent) 

misc.MinimalLineEditMixin.__init__(self) 

self._win_id = win_id 

if not private: 

command_history = objreg.get('command-history') 

self.history.history = command_history.data 

self.history.changed.connect(command_history.changed) 

self.setSizePolicy(QSizePolicy.MinimumExpanding, QSizePolicy.Ignored) 

self.cursorPositionChanged.connect(self.update_completion) 

self.textChanged.connect(self.update_completion) 

self.textChanged.connect(self.updateGeometry) 

self.textChanged.connect(self._incremental_search) 

 

def prefix(self): 

"""Get the currently entered command prefix.""" 

text = self.text() 

if not text: 

return '' 

elif text[0] in modeparsers.STARTCHARS: 

return text[0] 

else: 

return '' 

 

def set_cmd_text(self, text): 

"""Preset the statusbar to some text. 

 

Args: 

text: The text to set as string. 

""" 

self.setText(text) 

log.modes.debug("Setting command text, focusing {!r}".format(self)) 

modeman.enter(self._win_id, usertypes.KeyMode.command, 'cmd focus') 

self.setFocus() 

self.show_cmd.emit() 

 

@cmdutils.register(instance='status-command', name='set-cmd-text', 

scope='window', maxsplit=0) 

@cmdutils.argument('count', count=True) 

def set_cmd_text_command(self, text, count=None, space=False, append=False, 

run_on_count=False): 

"""Preset the statusbar to some text. 

 

// 

 

Wrapper for set_cmd_text to check the arguments and allow multiple 

strings which will get joined. 

 

Args: 

text: The commandline to set. 

count: The count if given. 

space: If given, a space is added to the end. 

append: If given, the text is appended to the current text. 

run_on_count: If given with a count, the command is run with the 

given count rather than setting the command text. 

""" 

if space: 

text += ' ' 

if append: 

if not self.text(): 

raise cmdexc.CommandError("No current text!") 

text = self.text() + text 

 

if not text or text[0] not in modeparsers.STARTCHARS: 

raise cmdexc.CommandError( 

"Invalid command text '{}'.".format(text)) 

if run_on_count and count is not None: 

self.got_cmd[str, int].emit(text, count) 

else: 

self.set_cmd_text(text) 

 

@cmdutils.register(instance='status-command', 

modes=[usertypes.KeyMode.command], scope='window') 

def command_history_prev(self): 

"""Go back in the commandline history.""" 

try: 

if not self.history.is_browsing(): 

item = self.history.start(self.text().strip()) 

else: 

item = self.history.previtem() 

except (cmdhistory.HistoryEmptyError, 

cmdhistory.HistoryEndReachedError): 

return 

if item: 

self.set_cmd_text(item) 

 

@cmdutils.register(instance='status-command', 

modes=[usertypes.KeyMode.command], scope='window') 

def command_history_next(self): 

"""Go forward in the commandline history.""" 

if not self.history.is_browsing(): 

return 

try: 

item = self.history.nextitem() 

except cmdhistory.HistoryEndReachedError: 

return 

if item: 

self.set_cmd_text(item) 

 

@cmdutils.register(instance='status-command', 

modes=[usertypes.KeyMode.command], scope='window') 

def command_accept(self, rapid=False): 

"""Execute the command currently in the commandline. 

 

Args: 

rapid: Run the command without closing or clearing the command bar. 

""" 

prefixes = { 

':': '', 

'/': 'search -- ', 

'?': 'search -r -- ', 

} 

text = self.text() 

self.history.append(text) 

if not rapid: 

modeman.leave(self._win_id, usertypes.KeyMode.command, 

'cmd accept') 

self.got_cmd[str].emit(prefixes[text[0]] + text[1:]) 

 

@cmdutils.register(instance='status-command', scope='window') 

def edit_command(self, run=False): 

"""Open an editor to modify the current command. 

 

Args: 

run: Run the command if the editor exits successfully. 

""" 

ed = editor.ExternalEditor(parent=self) 

 

def callback(text): 

"""Set the commandline to the edited text.""" 

if not text or text[0] not in modeparsers.STARTCHARS: 

message.error('command must start with one of {}' 

.format(modeparsers.STARTCHARS)) 

return 

self.set_cmd_text(text) 

if run: 

self.command_accept() 

 

ed.file_updated.connect(callback) 

ed.edit(self.text()) 

 

@pyqtSlot(usertypes.KeyMode) 

def on_mode_left(self, mode): 

"""Clear up when command mode was left. 

 

- Clear the statusbar text if it's explicitly unfocused. 

- Clear completion selection 

- Hide completion 

 

Args: 

mode: The mode which was left. 

""" 

if mode == usertypes.KeyMode.command: 

self.setText('') 

self.history.stop() 

self.hide_cmd.emit() 

self.clear_completion_selection.emit() 

self.hide_completion.emit() 

 

def setText(self, text): 

"""Extend setText to set prefix and make sure the prompt is ok.""" 

if not text: 

pass 

elif text[0] in modeparsers.STARTCHARS: 

super().set_prompt(text[0]) 

else: 

raise utils.Unreachable("setText got called with invalid text " 

"'{}'!".format(text)) 

super().setText(text) 

 

def keyPressEvent(self, e): 

"""Override keyPressEvent to ignore Return key presses. 

 

If this widget is focused, we are in passthrough key mode, and 

Enter/Shift+Enter/etc. will cause QLineEdit to think it's finished 

without command_accept to be called. 

""" 

text = self.text() 

if text in modeparsers.STARTCHARS and e.key() == Qt.Key_Backspace: 

e.accept() 

modeman.leave(self._win_id, usertypes.KeyMode.command, 

'prefix deleted') 

return 

if e.key() == Qt.Key_Return: 

e.ignore() 

return 

else: 

super().keyPressEvent(e) 

 

def sizeHint(self): 

"""Dynamically calculate the needed size.""" 

height = super().sizeHint().height() 

text = self.text() 

if not text: 

text = 'x' 

width = self.fontMetrics().width(text) 

return QSize(width, height) 

 

@pyqtSlot(str) 

def _incremental_search(self, text): 

if not config.val.search.incremental: 

return 

 

search_prefixes = { 

'/': 'search -- ', 

'?': 'search -r -- ', 

} 

 

if self.prefix() in ['/', '?']: 

self.got_cmd[str].emit(search_prefixes[text[0]] + text[1:])