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

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

# 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/>. 

 

"""Completion item delegate for CompletionView. 

 

We use this to be able to highlight parts of the text. 

""" 

 

import re 

import html 

 

from PyQt5.QtWidgets import QStyle, QStyleOptionViewItem, QStyledItemDelegate 

from PyQt5.QtCore import QRectF, QSize, Qt 

from PyQt5.QtGui import (QIcon, QPalette, QTextDocument, QTextOption, 

QAbstractTextDocumentLayout) 

 

from qutebrowser.config import config 

from qutebrowser.utils import qtutils, jinja 

 

 

_cached_stylesheet = None 

 

 

class CompletionItemDelegate(QStyledItemDelegate): 

 

"""Delegate used by CompletionView to draw individual items. 

 

Mainly a cleaned up port of Qt's way to draw a TreeView item, except it 

uses a QTextDocument to draw the text and add marking. 

 

Original implementation: 

qt/src/gui/styles/qcommonstyle.cpp:drawControl:2153 

 

Attributes: 

_opt: The QStyleOptionViewItem which is used. 

_style: The style to be used. 

_painter: The QPainter to be used. 

_doc: The QTextDocument to be used. 

""" 

 

# FIXME this is horribly slow when resizing. 

# We should probably cache something in _get_textdoc or so, but as soon as 

# we implement eliding that cache probably isn't worth much anymore... 

# https://github.com/qutebrowser/qutebrowser/issues/121 

 

def __init__(self, parent=None): 

self._painter = None 

self._opt = None 

self._doc = None 

self._style = None 

super().__init__(parent) 

 

def _draw_background(self): 

"""Draw the background of an ItemViewItem.""" 

self._style.drawPrimitive(self._style.PE_PanelItemViewItem, self._opt, 

self._painter, self._opt.widget) 

 

def _draw_icon(self): 

"""Draw the icon of an ItemViewItem.""" 

icon_rect = self._style.subElementRect( 

self._style.SE_ItemViewItemDecoration, self._opt, self._opt.widget) 

if not icon_rect.isValid(): 

# The rect seems to be wrong in all kind of ways if no icon should 

# be displayed. 

return 

 

mode = QIcon.Normal 

if not self._opt.state & QStyle.State_Enabled: 

mode = QIcon.Disabled 

elif self._opt.state & QStyle.State_Selected: 

mode = QIcon.Selected 

state = QIcon.On if self._opt.state & QStyle.State_Open else QIcon.Off 

self._opt.icon.paint(self._painter, icon_rect, 

self._opt.decorationAlignment, mode, state) 

 

def _draw_text(self, index): 

"""Draw the text of an ItemViewItem. 

 

This is the main part where we differ from the original implementation 

in Qt: We use a QTextDocument to draw text. 

 

Args: 

index: The QModelIndex of the item to draw. 

""" 

if not self._opt.text: 

return 

 

text_rect_ = self._style.subElementRect( 

self._style.SE_ItemViewItemText, self._opt, self._opt.widget) 

qtutils.ensure_valid(text_rect_) 

margin = self._style.pixelMetric(QStyle.PM_FocusFrameHMargin, 

self._opt, self._opt.widget) + 1 

# remove width padding 

text_rect = text_rect_.adjusted(margin, 0, -margin, 0) 

qtutils.ensure_valid(text_rect) 

# move text upwards a bit 

if index.parent().isValid(): 

text_rect.adjust(0, -1, 0, -1) 

else: 

text_rect.adjust(0, -2, 0, -2) 

self._painter.save() 

state = self._opt.state 

if state & QStyle.State_Enabled and state & QStyle.State_Active: 

cg = QPalette.Normal 

elif state & QStyle.State_Enabled: 

cg = QPalette.Inactive 

else: 

cg = QPalette.Disabled 

 

if state & QStyle.State_Selected: 

self._painter.setPen(self._opt.palette.color( 

cg, QPalette.HighlightedText)) 

# This is a dirty fix for the text jumping by one pixel for 

# whatever reason. 

text_rect.adjust(0, -1, 0, 0) 

else: 

self._painter.setPen(self._opt.palette.color(cg, QPalette.Text)) 

 

if state & QStyle.State_Editing: 

self._painter.setPen(self._opt.palette.color(cg, QPalette.Text)) 

self._painter.drawRect(text_rect_.adjusted(0, 0, -1, -1)) 

 

self._painter.translate(text_rect.left(), text_rect.top()) 

self._get_textdoc(index) 

self._draw_textdoc(text_rect, index.column()) 

self._painter.restore() 

 

def _draw_textdoc(self, rect, col): 

"""Draw the QTextDocument of an item. 

 

Args: 

rect: The QRect to clip the drawing to. 

""" 

# We can't use drawContents because then the color would be ignored. 

clip = QRectF(0, 0, rect.width(), rect.height()) 

self._painter.save() 

 

if self._opt.state & QStyle.State_Selected: 

color = config.val.colors.completion.item.selected.fg 

elif not self._opt.state & QStyle.State_Enabled: 

color = config.val.colors.completion.category.fg 

else: 

colors = config.val.colors.completion.fg 

# if multiple colors are set, use different colors per column 

color = colors[col % len(colors)] 

self._painter.setPen(color) 

 

ctx = QAbstractTextDocumentLayout.PaintContext() 

ctx.palette.setColor(QPalette.Text, self._painter.pen().color()) 

if clip.isValid(): 

self._painter.setClipRect(clip) 

ctx.clip = clip 

self._doc.documentLayout().draw(self._painter, ctx) 

self._painter.restore() 

 

def _get_textdoc(self, index): 

"""Create the QTextDocument of an item. 

 

Args: 

index: The QModelIndex of the item to draw. 

""" 

# FIXME we probably should do eliding here. See 

# qcommonstyle.cpp:viewItemDrawText 

# https://github.com/qutebrowser/qutebrowser/issues/118 

text_option = QTextOption() 

if self._opt.features & QStyleOptionViewItem.WrapText: 

text_option.setWrapMode(QTextOption.WordWrap) 

else: 

text_option.setWrapMode(QTextOption.ManualWrap) 

text_option.setTextDirection(self._opt.direction) 

text_option.setAlignment(QStyle.visualAlignment( 

self._opt.direction, self._opt.displayAlignment)) 

 

if self._doc is not None: 

self._doc.deleteLater() 

self._doc = QTextDocument(self) 

self._doc.setDefaultFont(self._opt.font) 

self._doc.setDefaultTextOption(text_option) 

self._doc.setDocumentMargin(2) 

 

assert _cached_stylesheet is not None 

self._doc.setDefaultStyleSheet(_cached_stylesheet) 

 

if index.parent().isValid(): 

view = self.parent() 

pattern = view.pattern 

columns_to_filter = index.model().columns_to_filter(index) 

if index.column() in columns_to_filter and pattern: 

repl = r'<span class="highlight">\g<0></span>' 

pat = html.escape(re.escape(pattern)).replace(r'\ ', r'|') 

txt = html.escape(self._opt.text) 

text = re.sub(pat, repl, txt, flags=re.IGNORECASE) 

self._doc.setHtml(text) 

else: 

self._doc.setPlainText(self._opt.text) 

else: 

self._doc.setHtml( 

'<span style="font: {};">{}</span>'.format( 

html.escape(config.val.fonts.completion.category), 

html.escape(self._opt.text))) 

 

def _draw_focus_rect(self): 

"""Draw the focus rectangle of an ItemViewItem.""" 

state = self._opt.state 

if not state & QStyle.State_HasFocus: 

return 

o = self._opt 

o.rect = self._style.subElementRect( 

self._style.SE_ItemViewItemFocusRect, self._opt, self._opt.widget) 

o.state |= QStyle.State_KeyboardFocusChange | QStyle.State_Item 

qtutils.ensure_valid(o.rect) 

if state & QStyle.State_Enabled: 

cg = QPalette.Normal 

else: 

cg = QPalette.Disabled 

if state & QStyle.State_Selected: 

role = QPalette.Highlight 

else: 

role = QPalette.Window 

o.backgroundColor = self._opt.palette.color(cg, role) 

self._style.drawPrimitive(QStyle.PE_FrameFocusRect, o, self._painter, 

self._opt.widget) 

 

def sizeHint(self, option, index): 

"""Override sizeHint of QStyledItemDelegate. 

 

Return the cell size based on the QTextDocument size, but might not 

work correctly yet. 

 

Args: 

option: const QStyleOptionViewItem & option 

index: const QModelIndex & index 

 

Return: 

A QSize with the recommended size. 

""" 

value = index.data(Qt.SizeHintRole) 

if value is not None: 

return value 

self._opt = QStyleOptionViewItem(option) 

self.initStyleOption(self._opt, index) 

self._style = self._opt.widget.style() 

self._get_textdoc(index) 

docsize = self._doc.size().toSize() 

size = self._style.sizeFromContents(QStyle.CT_ItemViewItem, self._opt, 

docsize, self._opt.widget) 

qtutils.ensure_valid(size) 

return size + QSize(10, 3) 

 

def paint(self, painter, option, index): 

"""Override the QStyledItemDelegate paint function. 

 

Args: 

painter: QPainter * painter 

option: const QStyleOptionViewItem & option 

index: const QModelIndex & index 

""" 

self._painter = painter 

self._painter.save() 

self._opt = QStyleOptionViewItem(option) 

self.initStyleOption(self._opt, index) 

self._style = self._opt.widget.style() 

 

self._draw_background() 

self._draw_icon() 

self._draw_text(index) 

self._draw_focus_rect() 

 

self._painter.restore() 

 

 

@config.change_filter('colors.completion.match.fg', function=True) 

def _update_stylesheet(): 

"""Update the cached stylesheet.""" 

stylesheet = """ 

.highlight { 

color: {{ conf.colors.completion.match.fg }}; 

} 

""" 

with jinja.environment.no_autoescape(): 

template = jinja.environment.from_string(stylesheet) 

 

global _cached_stylesheet 

_cached_stylesheet = template.render(conf=config.val) 

 

 

def init(): 

"""Initialize the cached stylesheet.""" 

_update_stylesheet() 

config.instance.changed.connect(_update_stylesheet)