##// END OF EJS Templates
command should not be aliased to control by default
MinRK -
Show More
@@ -1,1848 +1,1848 b''
1 1 """ An abstract base class for console-type widgets.
2 2 """
3 3 #-----------------------------------------------------------------------------
4 4 # Imports
5 5 #-----------------------------------------------------------------------------
6 6
7 7 # Standard library imports
8 8 from os.path import commonprefix
9 9 import re
10 10 import os
11 11 import sys
12 12 from textwrap import dedent
13 13
14 14 # System library imports
15 15 from PyQt4 import QtCore, QtGui
16 16
17 17 # Local imports
18 18 from IPython.config.configurable import Configurable
19 19 from IPython.frontend.qt.util import MetaQObjectHasTraits, get_font
20 20 from IPython.utils.traitlets import Bool, Enum, Int
21 21 from ansi_code_processor import QtAnsiCodeProcessor
22 22 from completion_widget import CompletionWidget
23 23
24 24 #-----------------------------------------------------------------------------
25 25 # Classes
26 26 #-----------------------------------------------------------------------------
27 27
28 28 class ConsoleWidget(Configurable, QtGui.QWidget):
29 29 """ An abstract base class for console-type widgets. This class has
30 30 functionality for:
31 31
32 32 * Maintaining a prompt and editing region
33 33 * Providing the traditional Unix-style console keyboard shortcuts
34 34 * Performing tab completion
35 35 * Paging text
36 36 * Handling ANSI escape codes
37 37
38 38 ConsoleWidget also provides a number of utility methods that will be
39 39 convenient to implementors of a console-style widget.
40 40 """
41 41 __metaclass__ = MetaQObjectHasTraits
42 42
43 43 #------ Configuration ------------------------------------------------------
44 44
45 45 # Whether to process ANSI escape codes.
46 46 ansi_codes = Bool(True, config=True)
47 47
48 48 # The maximum number of lines of text before truncation. Specifying a
49 49 # non-positive number disables text truncation (not recommended).
50 50 buffer_size = Int(500, config=True)
51 51
52 52 # Whether to use a list widget or plain text output for tab completion.
53 53 gui_completion = Bool(False, config=True)
54 54
55 55 # The type of underlying text widget to use. Valid values are 'plain', which
56 56 # specifies a QPlainTextEdit, and 'rich', which specifies a QTextEdit.
57 57 # NOTE: this value can only be specified during initialization.
58 58 kind = Enum(['plain', 'rich'], default_value='plain', config=True)
59 59
60 60 # The type of paging to use. Valid values are:
61 61 # 'inside' : The widget pages like a traditional terminal.
62 62 # 'hsplit' : When paging is requested, the widget is split
63 63 # horizontally. The top pane contains the console, and the
64 64 # bottom pane contains the paged text.
65 65 # 'vsplit' : Similar to 'hsplit', except that a vertical splitter used.
66 66 # 'custom' : No action is taken by the widget beyond emitting a
67 67 # 'custom_page_requested(str)' signal.
68 68 # 'none' : The text is written directly to the console.
69 69 # NOTE: this value can only be specified during initialization.
70 70 paging = Enum(['inside', 'hsplit', 'vsplit', 'custom', 'none'],
71 71 default_value='inside', config=True)
72 72
73 73 # Whether to override ShortcutEvents for the keybindings defined by this
74 74 # widget (Ctrl+n, Ctrl+a, etc). Enable this if you want this widget to take
75 75 # priority (when it has focus) over, e.g., window-level menu shortcuts.
76 76 override_shortcuts = Bool(False)
77 77
78 78 #------ Signals ------------------------------------------------------------
79 79
80 80 # Signals that indicate ConsoleWidget state.
81 81 copy_available = QtCore.pyqtSignal(bool)
82 82 redo_available = QtCore.pyqtSignal(bool)
83 83 undo_available = QtCore.pyqtSignal(bool)
84 84
85 85 # Signal emitted when paging is needed and the paging style has been
86 86 # specified as 'custom'.
87 87 custom_page_requested = QtCore.pyqtSignal(object)
88 88
89 89 # Signal emitted when the font is changed.
90 90 font_changed = QtCore.pyqtSignal(QtGui.QFont)
91 91
92 92 #------ Protected class variables ------------------------------------------
93 93
94 94 _ctrl_down_remap = { QtCore.Qt.Key_B : QtCore.Qt.Key_Left,
95 95 QtCore.Qt.Key_F : QtCore.Qt.Key_Right,
96 96 QtCore.Qt.Key_A : QtCore.Qt.Key_Home,
97 97 QtCore.Qt.Key_E : QtCore.Qt.Key_End,
98 98 QtCore.Qt.Key_P : QtCore.Qt.Key_Up,
99 99 QtCore.Qt.Key_N : QtCore.Qt.Key_Down,
100 100 QtCore.Qt.Key_D : QtCore.Qt.Key_Delete, }
101 101
102 102 _shortcuts = set(_ctrl_down_remap.keys() +
103 103 [ QtCore.Qt.Key_C, QtCore.Qt.Key_G, QtCore.Qt.Key_O,
104 104 QtCore.Qt.Key_V ])
105 105
106 106 #---------------------------------------------------------------------------
107 107 # 'QObject' interface
108 108 #---------------------------------------------------------------------------
109 109
110 110 def __init__(self, parent=None, **kw):
111 111 """ Create a ConsoleWidget.
112 112
113 113 Parameters:
114 114 -----------
115 115 parent : QWidget, optional [default None]
116 116 The parent for this widget.
117 117 """
118 118 QtGui.QWidget.__init__(self, parent)
119 119 Configurable.__init__(self, **kw)
120 120
121 121 # Create the layout and underlying text widget.
122 122 layout = QtGui.QStackedLayout(self)
123 123 layout.setContentsMargins(0, 0, 0, 0)
124 124 self._control = self._create_control()
125 125 self._page_control = None
126 126 self._splitter = None
127 127 if self.paging in ('hsplit', 'vsplit'):
128 128 self._splitter = QtGui.QSplitter()
129 129 if self.paging == 'hsplit':
130 130 self._splitter.setOrientation(QtCore.Qt.Horizontal)
131 131 else:
132 132 self._splitter.setOrientation(QtCore.Qt.Vertical)
133 133 self._splitter.addWidget(self._control)
134 134 layout.addWidget(self._splitter)
135 135 else:
136 136 layout.addWidget(self._control)
137 137
138 138 # Create the paging widget, if necessary.
139 139 if self.paging in ('inside', 'hsplit', 'vsplit'):
140 140 self._page_control = self._create_page_control()
141 141 if self._splitter:
142 142 self._page_control.hide()
143 143 self._splitter.addWidget(self._page_control)
144 144 else:
145 145 layout.addWidget(self._page_control)
146 146
147 147 # Initialize protected variables. Some variables contain useful state
148 148 # information for subclasses; they should be considered read-only.
149 149 self._ansi_processor = QtAnsiCodeProcessor()
150 150 self._completion_widget = CompletionWidget(self._control)
151 151 self._continuation_prompt = '> '
152 152 self._continuation_prompt_html = None
153 153 self._executing = False
154 154 self._filter_drag = False
155 155 self._filter_resize = False
156 156 self._prompt = ''
157 157 self._prompt_html = None
158 158 self._prompt_pos = 0
159 159 self._prompt_sep = ''
160 160 self._reading = False
161 161 self._reading_callback = None
162 162 self._tab_width = 8
163 163 self._text_completing_pos = 0
164 164 self._filename = os.path.join(os.curdir, 'ipython.html')
165 165
166 166 # Set a monospaced font.
167 167 self.reset_font()
168 168
169 169 # Configure actions.
170 170 action = QtGui.QAction('Print', None)
171 171 action.setEnabled(True)
172 172 action.setShortcut(QtGui.QKeySequence.Print)
173 173 action.triggered.connect(self.print_)
174 174 self.addAction(action)
175 175 self._print_action = action
176 176
177 177 action = QtGui.QAction('Save as HTML/XML', None)
178 178 action.setEnabled(self.can_export())
179 179 action.setShortcut(QtGui.QKeySequence.Save)
180 180 action.triggered.connect(self.export)
181 181 self.addAction(action)
182 182 self._export_action = action
183 183
184 184 action = QtGui.QAction('Select All', None)
185 185 action.setEnabled(True)
186 186 action.setShortcut(QtGui.QKeySequence.SelectAll)
187 187 action.triggered.connect(self.select_all)
188 188 self.addAction(action)
189 189 self._select_all_action = action
190 190
191 191
192 192 def eventFilter(self, obj, event):
193 193 """ Reimplemented to ensure a console-like behavior in the underlying
194 194 text widgets.
195 195 """
196 196 etype = event.type()
197 197 if etype == QtCore.QEvent.KeyPress:
198 198
199 199 # Re-map keys for all filtered widgets.
200 200 key = event.key()
201 201 if self._control_key_down(event.modifiers()) and \
202 202 key in self._ctrl_down_remap:
203 203 new_event = QtGui.QKeyEvent(QtCore.QEvent.KeyPress,
204 204 self._ctrl_down_remap[key],
205 205 QtCore.Qt.NoModifier)
206 206 QtGui.qApp.sendEvent(obj, new_event)
207 207 return True
208 208
209 209 elif obj == self._control:
210 210 return self._event_filter_console_keypress(event)
211 211
212 212 elif obj == self._page_control:
213 213 return self._event_filter_page_keypress(event)
214 214
215 215 # Make middle-click paste safe.
216 216 elif etype == QtCore.QEvent.MouseButtonRelease and \
217 217 event.button() == QtCore.Qt.MidButton and \
218 218 obj == self._control.viewport():
219 219 cursor = self._control.cursorForPosition(event.pos())
220 220 self._control.setTextCursor(cursor)
221 221 self.paste(QtGui.QClipboard.Selection)
222 222 return True
223 223
224 224 # Manually adjust the scrollbars *after* a resize event is dispatched.
225 225 elif etype == QtCore.QEvent.Resize and not self._filter_resize:
226 226 self._filter_resize = True
227 227 QtGui.qApp.sendEvent(obj, event)
228 228 self._adjust_scrollbars()
229 229 self._filter_resize = False
230 230 return True
231 231
232 232 # Override shortcuts for all filtered widgets.
233 233 elif etype == QtCore.QEvent.ShortcutOverride and \
234 234 self.override_shortcuts and \
235 235 self._control_key_down(event.modifiers()) and \
236 236 event.key() in self._shortcuts:
237 237 event.accept()
238 238
239 239 # Ensure that drags are safe. The problem is that the drag starting
240 240 # logic, which determines whether the drag is a Copy or Move, is locked
241 241 # down in QTextControl. If the widget is editable, which it must be if
242 242 # we're not executing, the drag will be a Move. The following hack
243 243 # prevents QTextControl from deleting the text by clearing the selection
244 244 # when a drag leave event originating from this widget is dispatched.
245 245 # The fact that we have to clear the user's selection is unfortunate,
246 246 # but the alternative--trying to prevent Qt from using its hardwired
247 247 # drag logic and writing our own--is worse.
248 248 elif etype == QtCore.QEvent.DragEnter and \
249 249 obj == self._control.viewport() and \
250 250 event.source() == self._control.viewport():
251 251 self._filter_drag = True
252 252 elif etype == QtCore.QEvent.DragLeave and \
253 253 obj == self._control.viewport() and \
254 254 self._filter_drag:
255 255 cursor = self._control.textCursor()
256 256 cursor.clearSelection()
257 257 self._control.setTextCursor(cursor)
258 258 self._filter_drag = False
259 259
260 260 # Ensure that drops are safe.
261 261 elif etype == QtCore.QEvent.Drop and obj == self._control.viewport():
262 262 cursor = self._control.cursorForPosition(event.pos())
263 263 if self._in_buffer(cursor.position()):
264 264 text = unicode(event.mimeData().text())
265 265 self._insert_plain_text_into_buffer(cursor, text)
266 266
267 267 # Qt is expecting to get something here--drag and drop occurs in its
268 268 # own event loop. Send a DragLeave event to end it.
269 269 QtGui.qApp.sendEvent(obj, QtGui.QDragLeaveEvent())
270 270 return True
271 271
272 272 return super(ConsoleWidget, self).eventFilter(obj, event)
273 273
274 274 #---------------------------------------------------------------------------
275 275 # 'QWidget' interface
276 276 #---------------------------------------------------------------------------
277 277
278 278 def sizeHint(self):
279 279 """ Reimplemented to suggest a size that is 80 characters wide and
280 280 25 lines high.
281 281 """
282 282 font_metrics = QtGui.QFontMetrics(self.font)
283 283 margin = (self._control.frameWidth() +
284 284 self._control.document().documentMargin()) * 2
285 285 style = self.style()
286 286 splitwidth = style.pixelMetric(QtGui.QStyle.PM_SplitterWidth)
287 287
288 288 # Note 1: Despite my best efforts to take the various margins into
289 289 # account, the width is still coming out a bit too small, so we include
290 290 # a fudge factor of one character here.
291 291 # Note 2: QFontMetrics.maxWidth is not used here or anywhere else due
292 292 # to a Qt bug on certain Mac OS systems where it returns 0.
293 293 width = font_metrics.width(' ') * 81 + margin
294 294 width += style.pixelMetric(QtGui.QStyle.PM_ScrollBarExtent)
295 295 if self.paging == 'hsplit':
296 296 width = width * 2 + splitwidth
297 297
298 298 height = font_metrics.height() * 25 + margin
299 299 if self.paging == 'vsplit':
300 300 height = height * 2 + splitwidth
301 301
302 302 return QtCore.QSize(width, height)
303 303
304 304 #---------------------------------------------------------------------------
305 305 # 'ConsoleWidget' public interface
306 306 #---------------------------------------------------------------------------
307 307
308 308 def can_copy(self):
309 309 """ Returns whether text can be copied to the clipboard.
310 310 """
311 311 return self._control.textCursor().hasSelection()
312 312
313 313 def can_cut(self):
314 314 """ Returns whether text can be cut to the clipboard.
315 315 """
316 316 cursor = self._control.textCursor()
317 317 return (cursor.hasSelection() and
318 318 self._in_buffer(cursor.anchor()) and
319 319 self._in_buffer(cursor.position()))
320 320
321 321 def can_paste(self):
322 322 """ Returns whether text can be pasted from the clipboard.
323 323 """
324 324 if self._control.textInteractionFlags() & QtCore.Qt.TextEditable:
325 325 return not QtGui.QApplication.clipboard().text().isEmpty()
326 326 return False
327 327
328 328 def can_export(self):
329 329 """Returns whether we can export. Currently only rich widgets
330 330 can export html.
331 331 """
332 332 return self.kind == "rich"
333 333
334 334 def clear(self, keep_input=True):
335 335 """ Clear the console.
336 336
337 337 Parameters:
338 338 -----------
339 339 keep_input : bool, optional (default True)
340 340 If set, restores the old input buffer if a new prompt is written.
341 341 """
342 342 if self._executing:
343 343 self._control.clear()
344 344 else:
345 345 if keep_input:
346 346 input_buffer = self.input_buffer
347 347 self._control.clear()
348 348 self._show_prompt()
349 349 if keep_input:
350 350 self.input_buffer = input_buffer
351 351
352 352 def copy(self):
353 353 """ Copy the currently selected text to the clipboard.
354 354 """
355 355 self._control.copy()
356 356
357 357 def cut(self):
358 358 """ Copy the currently selected text to the clipboard and delete it
359 359 if it's inside the input buffer.
360 360 """
361 361 self.copy()
362 362 if self.can_cut():
363 363 self._control.textCursor().removeSelectedText()
364 364
365 365 def execute(self, source=None, hidden=False, interactive=False):
366 366 """ Executes source or the input buffer, possibly prompting for more
367 367 input.
368 368
369 369 Parameters:
370 370 -----------
371 371 source : str, optional
372 372
373 373 The source to execute. If not specified, the input buffer will be
374 374 used. If specified and 'hidden' is False, the input buffer will be
375 375 replaced with the source before execution.
376 376
377 377 hidden : bool, optional (default False)
378 378
379 379 If set, no output will be shown and the prompt will not be modified.
380 380 In other words, it will be completely invisible to the user that
381 381 an execution has occurred.
382 382
383 383 interactive : bool, optional (default False)
384 384
385 385 Whether the console is to treat the source as having been manually
386 386 entered by the user. The effect of this parameter depends on the
387 387 subclass implementation.
388 388
389 389 Raises:
390 390 -------
391 391 RuntimeError
392 392 If incomplete input is given and 'hidden' is True. In this case,
393 393 it is not possible to prompt for more input.
394 394
395 395 Returns:
396 396 --------
397 397 A boolean indicating whether the source was executed.
398 398 """
399 399 # WARNING: The order in which things happen here is very particular, in
400 400 # large part because our syntax highlighting is fragile. If you change
401 401 # something, test carefully!
402 402
403 403 # Decide what to execute.
404 404 if source is None:
405 405 source = self.input_buffer
406 406 if not hidden:
407 407 # A newline is appended later, but it should be considered part
408 408 # of the input buffer.
409 409 source += '\n'
410 410 elif not hidden:
411 411 self.input_buffer = source
412 412
413 413 # Execute the source or show a continuation prompt if it is incomplete.
414 414 complete = self._is_complete(source, interactive)
415 415 if hidden:
416 416 if complete:
417 417 self._execute(source, hidden)
418 418 else:
419 419 error = 'Incomplete noninteractive input: "%s"'
420 420 raise RuntimeError(error % source)
421 421 else:
422 422 if complete:
423 423 self._append_plain_text('\n')
424 424 self._executing_input_buffer = self.input_buffer
425 425 self._executing = True
426 426 self._prompt_finished()
427 427
428 428 # The maximum block count is only in effect during execution.
429 429 # This ensures that _prompt_pos does not become invalid due to
430 430 # text truncation.
431 431 self._control.document().setMaximumBlockCount(self.buffer_size)
432 432
433 433 # Setting a positive maximum block count will automatically
434 434 # disable the undo/redo history, but just to be safe:
435 435 self._control.setUndoRedoEnabled(False)
436 436
437 437 # Perform actual execution.
438 438 self._execute(source, hidden)
439 439
440 440 else:
441 441 # Do this inside an edit block so continuation prompts are
442 442 # removed seamlessly via undo/redo.
443 443 cursor = self._get_end_cursor()
444 444 cursor.beginEditBlock()
445 445 cursor.insertText('\n')
446 446 self._insert_continuation_prompt(cursor)
447 447 cursor.endEditBlock()
448 448
449 449 # Do not do this inside the edit block. It works as expected
450 450 # when using a QPlainTextEdit control, but does not have an
451 451 # effect when using a QTextEdit. I believe this is a Qt bug.
452 452 self._control.moveCursor(QtGui.QTextCursor.End)
453 453
454 454 return complete
455 455
456 456 def _get_input_buffer(self):
457 457 """ The text that the user has entered entered at the current prompt.
458 458 """
459 459 # If we're executing, the input buffer may not even exist anymore due to
460 460 # the limit imposed by 'buffer_size'. Therefore, we store it.
461 461 if self._executing:
462 462 return self._executing_input_buffer
463 463
464 464 cursor = self._get_end_cursor()
465 465 cursor.setPosition(self._prompt_pos, QtGui.QTextCursor.KeepAnchor)
466 466 input_buffer = unicode(cursor.selection().toPlainText())
467 467
468 468 # Strip out continuation prompts.
469 469 return input_buffer.replace('\n' + self._continuation_prompt, '\n')
470 470
471 471 def _set_input_buffer(self, string):
472 472 """ Replaces the text in the input buffer with 'string'.
473 473 """
474 474 # For now, it is an error to modify the input buffer during execution.
475 475 if self._executing:
476 476 raise RuntimeError("Cannot change input buffer during execution.")
477 477
478 478 # Remove old text.
479 479 cursor = self._get_end_cursor()
480 480 cursor.beginEditBlock()
481 481 cursor.setPosition(self._prompt_pos, QtGui.QTextCursor.KeepAnchor)
482 482 cursor.removeSelectedText()
483 483
484 484 # Insert new text with continuation prompts.
485 485 self._insert_plain_text_into_buffer(self._get_prompt_cursor(), string)
486 486 cursor.endEditBlock()
487 487 self._control.moveCursor(QtGui.QTextCursor.End)
488 488
489 489 input_buffer = property(_get_input_buffer, _set_input_buffer)
490 490
491 491 def _get_font(self):
492 492 """ The base font being used by the ConsoleWidget.
493 493 """
494 494 return self._control.document().defaultFont()
495 495
496 496 def _set_font(self, font):
497 497 """ Sets the base font for the ConsoleWidget to the specified QFont.
498 498 """
499 499 font_metrics = QtGui.QFontMetrics(font)
500 500 self._control.setTabStopWidth(self.tab_width * font_metrics.width(' '))
501 501
502 502 self._completion_widget.setFont(font)
503 503 self._control.document().setDefaultFont(font)
504 504 if self._page_control:
505 505 self._page_control.document().setDefaultFont(font)
506 506
507 507 self.font_changed.emit(font)
508 508
509 509 font = property(_get_font, _set_font)
510 510
511 511 def paste(self, mode=QtGui.QClipboard.Clipboard):
512 512 """ Paste the contents of the clipboard into the input region.
513 513
514 514 Parameters:
515 515 -----------
516 516 mode : QClipboard::Mode, optional [default QClipboard::Clipboard]
517 517
518 518 Controls which part of the system clipboard is used. This can be
519 519 used to access the selection clipboard in X11 and the Find buffer
520 520 in Mac OS. By default, the regular clipboard is used.
521 521 """
522 522 if self._control.textInteractionFlags() & QtCore.Qt.TextEditable:
523 523 # Make sure the paste is safe.
524 524 self._keep_cursor_in_buffer()
525 525 cursor = self._control.textCursor()
526 526
527 527 # Remove any trailing newline, which confuses the GUI and forces the
528 528 # user to backspace.
529 529 text = unicode(QtGui.QApplication.clipboard().text(mode)).rstrip()
530 530 self._insert_plain_text_into_buffer(cursor, dedent(text))
531 531
532 532 def print_(self, printer = None):
533 533 """ Print the contents of the ConsoleWidget to the specified QPrinter.
534 534 """
535 535 if (not printer):
536 536 printer = QtGui.QPrinter()
537 537 if(QtGui.QPrintDialog(printer).exec_() != QtGui.QDialog.Accepted):
538 538 return
539 539 self._control.print_(printer)
540 540
541 541 def export(self, parent = None):
542 542 """Export HTML/XML in various modes from one Dialog."""
543 543 parent = parent or None # sometimes parent is False
544 544 dialog = QtGui.QFileDialog(parent, 'Save Console as...')
545 545 dialog.setAcceptMode(QtGui.QFileDialog.AcceptSave)
546 546 filters = [
547 547 'HTML with inline PNGs (*.html *.htm)',
548 548 'HTML with external PNGs (*.html *.htm)',
549 549 'XHTML with inline SVGs (*.xhtml *.xml)'
550 550 ]
551 551 dialog.setNameFilters(filters)
552 552 if self._filename:
553 553 dialog.selectFile(self._filename)
554 554 root,ext = os.path.splitext(self._filename)
555 555 if ext.lower() in ('.xml', '.xhtml'):
556 556 dialog.selectNameFilter(filters[-1])
557 557 if dialog.exec_():
558 558 filename = str(dialog.selectedFiles()[0])
559 559 self._filename = filename
560 560 choice = str(dialog.selectedNameFilter())
561 561
562 562 if choice.startswith('XHTML'):
563 563 exporter = self.export_xhtml
564 564 else:
565 565 exporter = lambda filename: self.export_html(filename, 'inline' in choice)
566 566
567 567 try:
568 568 return exporter(filename)
569 569 except Exception, e:
570 570 title = self.window().windowTitle()
571 571 msg = "Error while saving to: %s\n"%filename+str(e)
572 572 reply = QtGui.QMessageBox.warning(self, title, msg,
573 573 QtGui.QMessageBox.Ok, QtGui.QMessageBox.Ok)
574 574 return None
575 575
576 576 def export_html(self, filename, inline=False):
577 577 """ Export the contents of the ConsoleWidget as HTML.
578 578
579 579 Parameters:
580 580 -----------
581 581 filename : str
582 582 The file to be saved.
583 583 inline : bool, optional [default True]
584 584 If True, include images as inline PNGs. Otherwise,
585 585 include them as links to external PNG files, mimicking
586 586 web browsers' "Web Page, Complete" behavior.
587 587 """
588 588 if(inline):
589 589 path = None
590 590 else:
591 591 root,ext = os.path.splitext(filename)
592 592 path = root+"_files"
593 593 if os.path.isfile(path):
594 594 raise OSError("%s exists, but is not a directory."%path)
595 595
596 596 f = open(filename, 'w')
597 597 try:
598 598 # N.B. this is overly restrictive, but Qt's output is
599 599 # predictable...
600 600 img_re = re.compile(r'<img src="(?P<name>[\d]+)" />')
601 601 html = self.fix_html_encoding(
602 602 str(self._control.toHtml().toUtf8()))
603 603 f.write(img_re.sub(
604 604 lambda x: self.image_tag(x, path = path, format = "png"),
605 605 html))
606 606 except Exception, e:
607 607 f.close()
608 608 raise e
609 609 else:
610 610 f.close()
611 611 return filename
612 612
613 613
614 614 def export_xhtml(self, filename):
615 615 """ Export the contents of the ConsoleWidget as XHTML with inline SVGs.
616 616 """
617 617 f = open(filename, 'w')
618 618 try:
619 619 # N.B. this is overly restrictive, but Qt's output is
620 620 # predictable...
621 621 img_re = re.compile(r'<img src="(?P<name>[\d]+)" />')
622 622 html = str(self._control.toHtml().toUtf8())
623 623 # Hack to make xhtml header -- note that we are not doing
624 624 # any check for valid xml
625 625 offset = html.find("<html>")
626 626 assert(offset > -1)
627 627 html = ('<html xmlns="http://www.w3.org/1999/xhtml">\n'+
628 628 html[offset+6:])
629 629 # And now declare UTF-8 encoding
630 630 html = self.fix_html_encoding(html)
631 631 f.write(img_re.sub(
632 632 lambda x: self.image_tag(x, path = None, format = "svg"),
633 633 html))
634 634 except Exception, e:
635 635 f.close()
636 636 raise e
637 637 else:
638 638 f.close()
639 639 return filename
640 640
641 641 def fix_html_encoding(self, html):
642 642 """ Return html string, with a UTF-8 declaration added to <HEAD>.
643 643
644 644 Assumes that html is Qt generated and has already been UTF-8 encoded
645 645 and coerced to a python string. If the expected head element is
646 646 not found, the given object is returned unmodified.
647 647
648 648 This patching is needed for proper rendering of some characters
649 649 (e.g., indented commands) when viewing exported HTML on a local
650 650 system (i.e., without seeing an encoding declaration in an HTTP
651 651 header).
652 652
653 653 C.f. http://www.w3.org/International/O-charset for details.
654 654 """
655 655 offset = html.find("<head>")
656 656 if(offset > -1):
657 657 html = (html[:offset+6]+
658 658 '\n<meta http-equiv="Content-Type" '+
659 659 'content="text/html; charset=utf-8" />\n'+
660 660 html[offset+6:])
661 661
662 662 return html
663 663
664 664 def image_tag(self, match, path = None, format = "png"):
665 665 """ Return (X)HTML mark-up for the image-tag given by match.
666 666
667 667 Parameters
668 668 ----------
669 669 match : re.SRE_Match
670 670 A match to an HTML image tag as exported by Qt, with
671 671 match.group("Name") containing the matched image ID.
672 672
673 673 path : string|None, optional [default None]
674 674 If not None, specifies a path to which supporting files
675 675 may be written (e.g., for linked images).
676 676 If None, all images are to be included inline.
677 677
678 678 format : "png"|"svg", optional [default "png"]
679 679 Format for returned or referenced images.
680 680
681 681 Subclasses supporting image display should override this
682 682 method.
683 683 """
684 684
685 685 # Default case -- not enough information to generate tag
686 686 return ""
687 687
688 688 def prompt_to_top(self):
689 689 """ Moves the prompt to the top of the viewport.
690 690 """
691 691 if not self._executing:
692 692 prompt_cursor = self._get_prompt_cursor()
693 693 if self._get_cursor().blockNumber() < prompt_cursor.blockNumber():
694 694 self._set_cursor(prompt_cursor)
695 695 self._set_top_cursor(prompt_cursor)
696 696
697 697 def redo(self):
698 698 """ Redo the last operation. If there is no operation to redo, nothing
699 699 happens.
700 700 """
701 701 self._control.redo()
702 702
703 703 def reset_font(self):
704 704 """ Sets the font to the default fixed-width font for this platform.
705 705 """
706 706 if sys.platform == 'win32':
707 707 # Consolas ships with Vista/Win7, fallback to Courier if needed
708 708 family, fallback = 'Consolas', 'Courier'
709 709 elif sys.platform == 'darwin':
710 710 # OSX always has Monaco, no need for a fallback
711 711 family, fallback = 'Monaco', None
712 712 else:
713 713 # FIXME: remove Consolas as a default on Linux once our font
714 714 # selections are configurable by the user.
715 715 family, fallback = 'Consolas', 'Monospace'
716 716 font = get_font(family, fallback)
717 717 font.setPointSize(QtGui.qApp.font().pointSize())
718 718 font.setStyleHint(QtGui.QFont.TypeWriter)
719 719 self._set_font(font)
720 720
721 721 def change_font_size(self, delta):
722 722 """Change the font size by the specified amount (in points).
723 723 """
724 724 font = self.font
725 725 font.setPointSize(font.pointSize() + delta)
726 726 self._set_font(font)
727 727
728 728 def select_all(self):
729 729 """ Selects all the text in the buffer.
730 730 """
731 731 self._control.selectAll()
732 732
733 733 def _get_tab_width(self):
734 734 """ The width (in terms of space characters) for tab characters.
735 735 """
736 736 return self._tab_width
737 737
738 738 def _set_tab_width(self, tab_width):
739 739 """ Sets the width (in terms of space characters) for tab characters.
740 740 """
741 741 font_metrics = QtGui.QFontMetrics(self.font)
742 742 self._control.setTabStopWidth(tab_width * font_metrics.width(' '))
743 743
744 744 self._tab_width = tab_width
745 745
746 746 tab_width = property(_get_tab_width, _set_tab_width)
747 747
748 748 def undo(self):
749 749 """ Undo the last operation. If there is no operation to undo, nothing
750 750 happens.
751 751 """
752 752 self._control.undo()
753 753
754 754 #---------------------------------------------------------------------------
755 755 # 'ConsoleWidget' abstract interface
756 756 #---------------------------------------------------------------------------
757 757
758 758 def _is_complete(self, source, interactive):
759 759 """ Returns whether 'source' can be executed. When triggered by an
760 760 Enter/Return key press, 'interactive' is True; otherwise, it is
761 761 False.
762 762 """
763 763 raise NotImplementedError
764 764
765 765 def _execute(self, source, hidden):
766 766 """ Execute 'source'. If 'hidden', do not show any output.
767 767 """
768 768 raise NotImplementedError
769 769
770 770 def _prompt_started_hook(self):
771 771 """ Called immediately after a new prompt is displayed.
772 772 """
773 773 pass
774 774
775 775 def _prompt_finished_hook(self):
776 776 """ Called immediately after a prompt is finished, i.e. when some input
777 777 will be processed and a new prompt displayed.
778 778 """
779 779 pass
780 780
781 781 def _up_pressed(self):
782 782 """ Called when the up key is pressed. Returns whether to continue
783 783 processing the event.
784 784 """
785 785 return True
786 786
787 787 def _down_pressed(self):
788 788 """ Called when the down key is pressed. Returns whether to continue
789 789 processing the event.
790 790 """
791 791 return True
792 792
793 793 def _tab_pressed(self):
794 794 """ Called when the tab key is pressed. Returns whether to continue
795 795 processing the event.
796 796 """
797 797 return False
798 798
799 799 #--------------------------------------------------------------------------
800 800 # 'ConsoleWidget' protected interface
801 801 #--------------------------------------------------------------------------
802 802
803 803 def _append_html(self, html):
804 804 """ Appends html at the end of the console buffer.
805 805 """
806 806 cursor = self._get_end_cursor()
807 807 self._insert_html(cursor, html)
808 808
809 809 def _append_html_fetching_plain_text(self, html):
810 810 """ Appends 'html', then returns the plain text version of it.
811 811 """
812 812 cursor = self._get_end_cursor()
813 813 return self._insert_html_fetching_plain_text(cursor, html)
814 814
815 815 def _append_plain_text(self, text):
816 816 """ Appends plain text at the end of the console buffer, processing
817 817 ANSI codes if enabled.
818 818 """
819 819 cursor = self._get_end_cursor()
820 820 self._insert_plain_text(cursor, text)
821 821
822 822 def _append_plain_text_keeping_prompt(self, text):
823 823 """ Writes 'text' after the current prompt, then restores the old prompt
824 824 with its old input buffer.
825 825 """
826 826 input_buffer = self.input_buffer
827 827 self._append_plain_text('\n')
828 828 self._prompt_finished()
829 829
830 830 self._append_plain_text(text)
831 831 self._show_prompt()
832 832 self.input_buffer = input_buffer
833 833
834 834 def _cancel_text_completion(self):
835 835 """ If text completion is progress, cancel it.
836 836 """
837 837 if self._text_completing_pos:
838 838 self._clear_temporary_buffer()
839 839 self._text_completing_pos = 0
840 840
841 841 def _clear_temporary_buffer(self):
842 842 """ Clears the "temporary text" buffer, i.e. all the text following
843 843 the prompt region.
844 844 """
845 845 # Select and remove all text below the input buffer.
846 846 cursor = self._get_prompt_cursor()
847 847 prompt = self._continuation_prompt.lstrip()
848 848 while cursor.movePosition(QtGui.QTextCursor.NextBlock):
849 849 temp_cursor = QtGui.QTextCursor(cursor)
850 850 temp_cursor.select(QtGui.QTextCursor.BlockUnderCursor)
851 851 text = unicode(temp_cursor.selection().toPlainText()).lstrip()
852 852 if not text.startswith(prompt):
853 853 break
854 854 else:
855 855 # We've reached the end of the input buffer and no text follows.
856 856 return
857 857 cursor.movePosition(QtGui.QTextCursor.Left) # Grab the newline.
858 858 cursor.movePosition(QtGui.QTextCursor.End,
859 859 QtGui.QTextCursor.KeepAnchor)
860 860 cursor.removeSelectedText()
861 861
862 862 # After doing this, we have no choice but to clear the undo/redo
863 863 # history. Otherwise, the text is not "temporary" at all, because it
864 864 # can be recalled with undo/redo. Unfortunately, Qt does not expose
865 865 # fine-grained control to the undo/redo system.
866 866 if self._control.isUndoRedoEnabled():
867 867 self._control.setUndoRedoEnabled(False)
868 868 self._control.setUndoRedoEnabled(True)
869 869
870 870 def _complete_with_items(self, cursor, items):
871 871 """ Performs completion with 'items' at the specified cursor location.
872 872 """
873 873 self._cancel_text_completion()
874 874
875 875 if len(items) == 1:
876 876 cursor.setPosition(self._control.textCursor().position(),
877 877 QtGui.QTextCursor.KeepAnchor)
878 878 cursor.insertText(items[0])
879 879
880 880 elif len(items) > 1:
881 881 current_pos = self._control.textCursor().position()
882 882 prefix = commonprefix(items)
883 883 if prefix:
884 884 cursor.setPosition(current_pos, QtGui.QTextCursor.KeepAnchor)
885 885 cursor.insertText(prefix)
886 886 current_pos = cursor.position()
887 887
888 888 if self.gui_completion:
889 889 cursor.movePosition(QtGui.QTextCursor.Left, n=len(prefix))
890 890 self._completion_widget.show_items(cursor, items)
891 891 else:
892 892 cursor.beginEditBlock()
893 893 self._append_plain_text('\n')
894 894 self._page(self._format_as_columns(items))
895 895 cursor.endEditBlock()
896 896
897 897 cursor.setPosition(current_pos)
898 898 self._control.moveCursor(QtGui.QTextCursor.End)
899 899 self._control.setTextCursor(cursor)
900 900 self._text_completing_pos = current_pos
901 901
902 902 def _context_menu_make(self, pos):
903 903 """ Creates a context menu for the given QPoint (in widget coordinates).
904 904 """
905 905 menu = QtGui.QMenu(self)
906 906
907 907 cut_action = menu.addAction('Cut', self.cut)
908 908 cut_action.setEnabled(self.can_cut())
909 909 cut_action.setShortcut(QtGui.QKeySequence.Cut)
910 910
911 911 copy_action = menu.addAction('Copy', self.copy)
912 912 copy_action.setEnabled(self.can_copy())
913 913 copy_action.setShortcut(QtGui.QKeySequence.Copy)
914 914
915 915 paste_action = menu.addAction('Paste', self.paste)
916 916 paste_action.setEnabled(self.can_paste())
917 917 paste_action.setShortcut(QtGui.QKeySequence.Paste)
918 918
919 919 menu.addSeparator()
920 920 menu.addAction(self._select_all_action)
921 921
922 922 menu.addSeparator()
923 923 menu.addAction(self._export_action)
924 924 menu.addAction(self._print_action)
925 925
926 926 return menu
927 927
928 def _control_key_down(self, modifiers, include_command=True):
928 def _control_key_down(self, modifiers, include_command=False):
929 929 """ Given a KeyboardModifiers flags object, return whether the Control
930 930 key is down.
931 931
932 932 Parameters:
933 933 -----------
934 934 include_command : bool, optional (default True)
935 935 Whether to treat the Command key as a (mutually exclusive) synonym
936 936 for Control when in Mac OS.
937 937 """
938 938 # Note that on Mac OS, ControlModifier corresponds to the Command key
939 939 # while MetaModifier corresponds to the Control key.
940 940 if sys.platform == 'darwin':
941 941 down = include_command and (modifiers & QtCore.Qt.ControlModifier)
942 942 return bool(down) ^ bool(modifiers & QtCore.Qt.MetaModifier)
943 943 else:
944 944 return bool(modifiers & QtCore.Qt.ControlModifier)
945 945
946 946 def _create_control(self):
947 947 """ Creates and connects the underlying text widget.
948 948 """
949 949 # Create the underlying control.
950 950 if self.kind == 'plain':
951 951 control = QtGui.QPlainTextEdit()
952 952 elif self.kind == 'rich':
953 953 control = QtGui.QTextEdit()
954 954 control.setAcceptRichText(False)
955 955
956 956 # Install event filters. The filter on the viewport is needed for
957 957 # mouse events and drag events.
958 958 control.installEventFilter(self)
959 959 control.viewport().installEventFilter(self)
960 960
961 961 # Connect signals.
962 962 control.cursorPositionChanged.connect(self._cursor_position_changed)
963 963 control.customContextMenuRequested.connect(
964 964 self._custom_context_menu_requested)
965 965 control.copyAvailable.connect(self.copy_available)
966 966 control.redoAvailable.connect(self.redo_available)
967 967 control.undoAvailable.connect(self.undo_available)
968 968
969 969 # Hijack the document size change signal to prevent Qt from adjusting
970 970 # the viewport's scrollbar. We are relying on an implementation detail
971 971 # of Q(Plain)TextEdit here, which is potentially dangerous, but without
972 972 # this functionality we cannot create a nice terminal interface.
973 973 layout = control.document().documentLayout()
974 974 layout.documentSizeChanged.disconnect()
975 975 layout.documentSizeChanged.connect(self._adjust_scrollbars)
976 976
977 977 # Configure the control.
978 978 control.setContextMenuPolicy(QtCore.Qt.CustomContextMenu)
979 979 control.setReadOnly(True)
980 980 control.setUndoRedoEnabled(False)
981 981 control.setVerticalScrollBarPolicy(QtCore.Qt.ScrollBarAlwaysOn)
982 982 return control
983 983
984 984 def _create_page_control(self):
985 985 """ Creates and connects the underlying paging widget.
986 986 """
987 987 if self.kind == 'plain':
988 988 control = QtGui.QPlainTextEdit()
989 989 elif self.kind == 'rich':
990 990 control = QtGui.QTextEdit()
991 991 control.installEventFilter(self)
992 992 control.setReadOnly(True)
993 993 control.setUndoRedoEnabled(False)
994 994 control.setVerticalScrollBarPolicy(QtCore.Qt.ScrollBarAlwaysOn)
995 995 return control
996 996
997 997 def _event_filter_console_keypress(self, event):
998 998 """ Filter key events for the underlying text widget to create a
999 999 console-like interface.
1000 1000 """
1001 1001 intercepted = False
1002 1002 cursor = self._control.textCursor()
1003 1003 position = cursor.position()
1004 1004 key = event.key()
1005 1005 ctrl_down = self._control_key_down(event.modifiers())
1006 1006 alt_down = event.modifiers() & QtCore.Qt.AltModifier
1007 1007 shift_down = event.modifiers() & QtCore.Qt.ShiftModifier
1008 1008
1009 1009 #------ Special sequences ----------------------------------------------
1010 1010
1011 1011 if event.matches(QtGui.QKeySequence.Copy):
1012 1012 self.copy()
1013 1013 intercepted = True
1014 1014
1015 1015 elif event.matches(QtGui.QKeySequence.Cut):
1016 1016 self.cut()
1017 1017 intercepted = True
1018 1018
1019 1019 elif event.matches(QtGui.QKeySequence.Paste):
1020 1020 self.paste()
1021 1021 intercepted = True
1022 1022
1023 1023 #------ Special modifier logic -----------------------------------------
1024 1024
1025 1025 elif key in (QtCore.Qt.Key_Return, QtCore.Qt.Key_Enter):
1026 1026 intercepted = True
1027 1027
1028 1028 # Special handling when tab completing in text mode.
1029 1029 self._cancel_text_completion()
1030 1030
1031 1031 if self._in_buffer(position):
1032 1032 if self._reading:
1033 1033 self._append_plain_text('\n')
1034 1034 self._reading = False
1035 1035 if self._reading_callback:
1036 1036 self._reading_callback()
1037 1037
1038 1038 # If the input buffer is a single line or there is only
1039 1039 # whitespace after the cursor, execute. Otherwise, split the
1040 1040 # line with a continuation prompt.
1041 1041 elif not self._executing:
1042 1042 cursor.movePosition(QtGui.QTextCursor.End,
1043 1043 QtGui.QTextCursor.KeepAnchor)
1044 1044 at_end = cursor.selectedText().trimmed().isEmpty()
1045 1045 single_line = (self._get_end_cursor().blockNumber() ==
1046 1046 self._get_prompt_cursor().blockNumber())
1047 1047 if (at_end or shift_down or single_line) and not ctrl_down:
1048 1048 self.execute(interactive = not shift_down)
1049 1049 else:
1050 1050 # Do this inside an edit block for clean undo/redo.
1051 1051 cursor.beginEditBlock()
1052 1052 cursor.setPosition(position)
1053 1053 cursor.insertText('\n')
1054 1054 self._insert_continuation_prompt(cursor)
1055 1055 cursor.endEditBlock()
1056 1056
1057 1057 # Ensure that the whole input buffer is visible.
1058 1058 # FIXME: This will not be usable if the input buffer is
1059 1059 # taller than the console widget.
1060 1060 self._control.moveCursor(QtGui.QTextCursor.End)
1061 1061 self._control.setTextCursor(cursor)
1062 1062
1063 1063 #------ Control/Cmd modifier -------------------------------------------
1064 1064
1065 1065 elif ctrl_down:
1066 1066 if key == QtCore.Qt.Key_G:
1067 1067 self._keyboard_quit()
1068 1068 intercepted = True
1069 1069
1070 1070 elif key == QtCore.Qt.Key_K:
1071 1071 if self._in_buffer(position):
1072 1072 cursor.movePosition(QtGui.QTextCursor.EndOfLine,
1073 1073 QtGui.QTextCursor.KeepAnchor)
1074 1074 if not cursor.hasSelection():
1075 1075 # Line deletion (remove continuation prompt)
1076 1076 cursor.movePosition(QtGui.QTextCursor.NextBlock,
1077 1077 QtGui.QTextCursor.KeepAnchor)
1078 1078 cursor.movePosition(QtGui.QTextCursor.Right,
1079 1079 QtGui.QTextCursor.KeepAnchor,
1080 1080 len(self._continuation_prompt))
1081 1081 cursor.removeSelectedText()
1082 1082 intercepted = True
1083 1083
1084 1084 elif key == QtCore.Qt.Key_L:
1085 1085 self.prompt_to_top()
1086 1086 intercepted = True
1087 1087
1088 1088 elif key == QtCore.Qt.Key_O:
1089 1089 if self._page_control and self._page_control.isVisible():
1090 1090 self._page_control.setFocus()
1091 1091 intercepted = True
1092 1092
1093 1093 elif key == QtCore.Qt.Key_Y:
1094 1094 self.paste()
1095 1095 intercepted = True
1096 1096
1097 1097 elif key in (QtCore.Qt.Key_Backspace, QtCore.Qt.Key_Delete):
1098 1098 intercepted = True
1099 1099
1100 1100 elif key == QtCore.Qt.Key_Plus:
1101 1101 self.change_font_size(1)
1102 1102 intercepted = True
1103 1103
1104 1104 elif key == QtCore.Qt.Key_Minus:
1105 1105 self.change_font_size(-1)
1106 1106 intercepted = True
1107 1107
1108 1108 #------ Alt modifier ---------------------------------------------------
1109 1109
1110 1110 elif alt_down:
1111 1111 if key == QtCore.Qt.Key_B:
1112 1112 self._set_cursor(self._get_word_start_cursor(position))
1113 1113 intercepted = True
1114 1114
1115 1115 elif key == QtCore.Qt.Key_F:
1116 1116 self._set_cursor(self._get_word_end_cursor(position))
1117 1117 intercepted = True
1118 1118
1119 1119 elif key == QtCore.Qt.Key_Backspace:
1120 1120 cursor = self._get_word_start_cursor(position)
1121 1121 cursor.setPosition(position, QtGui.QTextCursor.KeepAnchor)
1122 1122 cursor.removeSelectedText()
1123 1123 intercepted = True
1124 1124
1125 1125 elif key == QtCore.Qt.Key_D:
1126 1126 cursor = self._get_word_end_cursor(position)
1127 1127 cursor.setPosition(position, QtGui.QTextCursor.KeepAnchor)
1128 1128 cursor.removeSelectedText()
1129 1129 intercepted = True
1130 1130
1131 1131 elif key == QtCore.Qt.Key_Delete:
1132 1132 intercepted = True
1133 1133
1134 1134 elif key == QtCore.Qt.Key_Greater:
1135 1135 self._control.moveCursor(QtGui.QTextCursor.End)
1136 1136 intercepted = True
1137 1137
1138 1138 elif key == QtCore.Qt.Key_Less:
1139 1139 self._control.setTextCursor(self._get_prompt_cursor())
1140 1140 intercepted = True
1141 1141
1142 1142 #------ No modifiers ---------------------------------------------------
1143 1143
1144 1144 else:
1145 1145 if shift_down:
1146 1146 anchormode=QtGui.QTextCursor.KeepAnchor
1147 1147 else:
1148 1148 anchormode=QtGui.QTextCursor.MoveAnchor
1149 1149
1150 1150 if key == QtCore.Qt.Key_Escape:
1151 1151 self._keyboard_quit()
1152 1152 intercepted = True
1153 1153
1154 1154 elif key == QtCore.Qt.Key_Up:
1155 1155 if self._reading or not self._up_pressed():
1156 1156 intercepted = True
1157 1157 else:
1158 1158 prompt_line = self._get_prompt_cursor().blockNumber()
1159 1159 intercepted = cursor.blockNumber() <= prompt_line
1160 1160
1161 1161 elif key == QtCore.Qt.Key_Down:
1162 1162 if self._reading or not self._down_pressed():
1163 1163 intercepted = True
1164 1164 else:
1165 1165 end_line = self._get_end_cursor().blockNumber()
1166 1166 intercepted = cursor.blockNumber() == end_line
1167 1167
1168 1168 elif key == QtCore.Qt.Key_Tab:
1169 1169 if not self._reading:
1170 1170 intercepted = not self._tab_pressed()
1171 1171
1172 1172 elif key == QtCore.Qt.Key_Left:
1173 1173
1174 1174 # Move to the previous line
1175 1175 line, col = cursor.blockNumber(), cursor.columnNumber()
1176 1176 if line > self._get_prompt_cursor().blockNumber() and \
1177 1177 col == len(self._continuation_prompt):
1178 1178 self._control.moveCursor(QtGui.QTextCursor.PreviousBlock,
1179 1179 mode=anchormode)
1180 1180 self._control.moveCursor(QtGui.QTextCursor.EndOfBlock,
1181 1181 mode=anchormode)
1182 1182 intercepted = True
1183 1183
1184 1184 # Regular left movement
1185 1185 else:
1186 1186 intercepted = not self._in_buffer(position - 1)
1187 1187
1188 1188 elif key == QtCore.Qt.Key_Right:
1189 1189 original_block_number = cursor.blockNumber()
1190 1190 cursor.movePosition(QtGui.QTextCursor.Right,
1191 1191 mode=anchormode)
1192 1192 if cursor.blockNumber() != original_block_number:
1193 1193 cursor.movePosition(QtGui.QTextCursor.Right,
1194 1194 n=len(self._continuation_prompt),
1195 1195 mode=anchormode)
1196 1196 self._set_cursor(cursor)
1197 1197 intercepted = True
1198 1198
1199 1199 elif key == QtCore.Qt.Key_Home:
1200 1200 start_line = cursor.blockNumber()
1201 1201 if start_line == self._get_prompt_cursor().blockNumber():
1202 1202 start_pos = self._prompt_pos
1203 1203 else:
1204 1204 cursor.movePosition(QtGui.QTextCursor.StartOfBlock,
1205 1205 QtGui.QTextCursor.KeepAnchor)
1206 1206 start_pos = cursor.position()
1207 1207 start_pos += len(self._continuation_prompt)
1208 1208 cursor.setPosition(position)
1209 1209 if shift_down and self._in_buffer(position):
1210 1210 cursor.setPosition(start_pos, QtGui.QTextCursor.KeepAnchor)
1211 1211 else:
1212 1212 cursor.setPosition(start_pos)
1213 1213 self._set_cursor(cursor)
1214 1214 intercepted = True
1215 1215
1216 1216 elif key == QtCore.Qt.Key_Backspace:
1217 1217
1218 1218 # Line deletion (remove continuation prompt)
1219 1219 line, col = cursor.blockNumber(), cursor.columnNumber()
1220 1220 if not self._reading and \
1221 1221 col == len(self._continuation_prompt) and \
1222 1222 line > self._get_prompt_cursor().blockNumber():
1223 1223 cursor.beginEditBlock()
1224 1224 cursor.movePosition(QtGui.QTextCursor.StartOfBlock,
1225 1225 QtGui.QTextCursor.KeepAnchor)
1226 1226 cursor.removeSelectedText()
1227 1227 cursor.deletePreviousChar()
1228 1228 cursor.endEditBlock()
1229 1229 intercepted = True
1230 1230
1231 1231 # Regular backwards deletion
1232 1232 else:
1233 1233 anchor = cursor.anchor()
1234 1234 if anchor == position:
1235 1235 intercepted = not self._in_buffer(position - 1)
1236 1236 else:
1237 1237 intercepted = not self._in_buffer(min(anchor, position))
1238 1238
1239 1239 elif key == QtCore.Qt.Key_Delete:
1240 1240
1241 1241 # Line deletion (remove continuation prompt)
1242 1242 if not self._reading and self._in_buffer(position) and \
1243 1243 cursor.atBlockEnd() and not cursor.hasSelection():
1244 1244 cursor.movePosition(QtGui.QTextCursor.NextBlock,
1245 1245 QtGui.QTextCursor.KeepAnchor)
1246 1246 cursor.movePosition(QtGui.QTextCursor.Right,
1247 1247 QtGui.QTextCursor.KeepAnchor,
1248 1248 len(self._continuation_prompt))
1249 1249 cursor.removeSelectedText()
1250 1250 intercepted = True
1251 1251
1252 1252 # Regular forwards deletion:
1253 1253 else:
1254 1254 anchor = cursor.anchor()
1255 1255 intercepted = (not self._in_buffer(anchor) or
1256 1256 not self._in_buffer(position))
1257 1257
1258 1258 # Don't move the cursor if control is down to allow copy-paste using
1259 1259 # the keyboard in any part of the buffer.
1260 1260 if not ctrl_down:
1261 1261 self._keep_cursor_in_buffer()
1262 1262
1263 1263 return intercepted
1264 1264
1265 1265 def _event_filter_page_keypress(self, event):
1266 1266 """ Filter key events for the paging widget to create console-like
1267 1267 interface.
1268 1268 """
1269 1269 key = event.key()
1270 1270 ctrl_down = self._control_key_down(event.modifiers())
1271 1271 alt_down = event.modifiers() & QtCore.Qt.AltModifier
1272 1272
1273 1273 if ctrl_down:
1274 1274 if key == QtCore.Qt.Key_O:
1275 1275 self._control.setFocus()
1276 1276 intercept = True
1277 1277
1278 1278 elif alt_down:
1279 1279 if key == QtCore.Qt.Key_Greater:
1280 1280 self._page_control.moveCursor(QtGui.QTextCursor.End)
1281 1281 intercepted = True
1282 1282
1283 1283 elif key == QtCore.Qt.Key_Less:
1284 1284 self._page_control.moveCursor(QtGui.QTextCursor.Start)
1285 1285 intercepted = True
1286 1286
1287 1287 elif key in (QtCore.Qt.Key_Q, QtCore.Qt.Key_Escape):
1288 1288 if self._splitter:
1289 1289 self._page_control.hide()
1290 1290 else:
1291 1291 self.layout().setCurrentWidget(self._control)
1292 1292 return True
1293 1293
1294 1294 elif key in (QtCore.Qt.Key_Enter, QtCore.Qt.Key_Return):
1295 1295 new_event = QtGui.QKeyEvent(QtCore.QEvent.KeyPress,
1296 1296 QtCore.Qt.Key_PageDown,
1297 1297 QtCore.Qt.NoModifier)
1298 1298 QtGui.qApp.sendEvent(self._page_control, new_event)
1299 1299 return True
1300 1300
1301 1301 elif key == QtCore.Qt.Key_Backspace:
1302 1302 new_event = QtGui.QKeyEvent(QtCore.QEvent.KeyPress,
1303 1303 QtCore.Qt.Key_PageUp,
1304 1304 QtCore.Qt.NoModifier)
1305 1305 QtGui.qApp.sendEvent(self._page_control, new_event)
1306 1306 return True
1307 1307
1308 1308 return False
1309 1309
1310 1310 def _format_as_columns(self, items, separator=' '):
1311 1311 """ Transform a list of strings into a single string with columns.
1312 1312
1313 1313 Parameters
1314 1314 ----------
1315 1315 items : sequence of strings
1316 1316 The strings to process.
1317 1317
1318 1318 separator : str, optional [default is two spaces]
1319 1319 The string that separates columns.
1320 1320
1321 1321 Returns
1322 1322 -------
1323 1323 The formatted string.
1324 1324 """
1325 1325 # Note: this code is adapted from columnize 0.3.2.
1326 1326 # See http://code.google.com/p/pycolumnize/
1327 1327
1328 1328 # Calculate the number of characters available.
1329 1329 width = self._control.viewport().width()
1330 1330 char_width = QtGui.QFontMetrics(self.font).width(' ')
1331 1331 displaywidth = max(10, (width / char_width) - 1)
1332 1332
1333 1333 # Some degenerate cases.
1334 1334 size = len(items)
1335 1335 if size == 0:
1336 1336 return '\n'
1337 1337 elif size == 1:
1338 1338 return '%s\n' % items[0]
1339 1339
1340 1340 # Try every row count from 1 upwards
1341 1341 array_index = lambda nrows, row, col: nrows*col + row
1342 1342 for nrows in range(1, size):
1343 1343 ncols = (size + nrows - 1) // nrows
1344 1344 colwidths = []
1345 1345 totwidth = -len(separator)
1346 1346 for col in range(ncols):
1347 1347 # Get max column width for this column
1348 1348 colwidth = 0
1349 1349 for row in range(nrows):
1350 1350 i = array_index(nrows, row, col)
1351 1351 if i >= size: break
1352 1352 x = items[i]
1353 1353 colwidth = max(colwidth, len(x))
1354 1354 colwidths.append(colwidth)
1355 1355 totwidth += colwidth + len(separator)
1356 1356 if totwidth > displaywidth:
1357 1357 break
1358 1358 if totwidth <= displaywidth:
1359 1359 break
1360 1360
1361 1361 # The smallest number of rows computed and the max widths for each
1362 1362 # column has been obtained. Now we just have to format each of the rows.
1363 1363 string = ''
1364 1364 for row in range(nrows):
1365 1365 texts = []
1366 1366 for col in range(ncols):
1367 1367 i = row + nrows*col
1368 1368 if i >= size:
1369 1369 texts.append('')
1370 1370 else:
1371 1371 texts.append(items[i])
1372 1372 while texts and not texts[-1]:
1373 1373 del texts[-1]
1374 1374 for col in range(len(texts)):
1375 1375 texts[col] = texts[col].ljust(colwidths[col])
1376 1376 string += '%s\n' % separator.join(texts)
1377 1377 return string
1378 1378
1379 1379 def _get_block_plain_text(self, block):
1380 1380 """ Given a QTextBlock, return its unformatted text.
1381 1381 """
1382 1382 cursor = QtGui.QTextCursor(block)
1383 1383 cursor.movePosition(QtGui.QTextCursor.StartOfBlock)
1384 1384 cursor.movePosition(QtGui.QTextCursor.EndOfBlock,
1385 1385 QtGui.QTextCursor.KeepAnchor)
1386 1386 return unicode(cursor.selection().toPlainText())
1387 1387
1388 1388 def _get_cursor(self):
1389 1389 """ Convenience method that returns a cursor for the current position.
1390 1390 """
1391 1391 return self._control.textCursor()
1392 1392
1393 1393 def _get_end_cursor(self):
1394 1394 """ Convenience method that returns a cursor for the last character.
1395 1395 """
1396 1396 cursor = self._control.textCursor()
1397 1397 cursor.movePosition(QtGui.QTextCursor.End)
1398 1398 return cursor
1399 1399
1400 1400 def _get_input_buffer_cursor_column(self):
1401 1401 """ Returns the column of the cursor in the input buffer, excluding the
1402 1402 contribution by the prompt, or -1 if there is no such column.
1403 1403 """
1404 1404 prompt = self._get_input_buffer_cursor_prompt()
1405 1405 if prompt is None:
1406 1406 return -1
1407 1407 else:
1408 1408 cursor = self._control.textCursor()
1409 1409 return cursor.columnNumber() - len(prompt)
1410 1410
1411 1411 def _get_input_buffer_cursor_line(self):
1412 1412 """ Returns the text of the line of the input buffer that contains the
1413 1413 cursor, or None if there is no such line.
1414 1414 """
1415 1415 prompt = self._get_input_buffer_cursor_prompt()
1416 1416 if prompt is None:
1417 1417 return None
1418 1418 else:
1419 1419 cursor = self._control.textCursor()
1420 1420 text = self._get_block_plain_text(cursor.block())
1421 1421 return text[len(prompt):]
1422 1422
1423 1423 def _get_input_buffer_cursor_prompt(self):
1424 1424 """ Returns the (plain text) prompt for line of the input buffer that
1425 1425 contains the cursor, or None if there is no such line.
1426 1426 """
1427 1427 if self._executing:
1428 1428 return None
1429 1429 cursor = self._control.textCursor()
1430 1430 if cursor.position() >= self._prompt_pos:
1431 1431 if cursor.blockNumber() == self._get_prompt_cursor().blockNumber():
1432 1432 return self._prompt
1433 1433 else:
1434 1434 return self._continuation_prompt
1435 1435 else:
1436 1436 return None
1437 1437
1438 1438 def _get_prompt_cursor(self):
1439 1439 """ Convenience method that returns a cursor for the prompt position.
1440 1440 """
1441 1441 cursor = self._control.textCursor()
1442 1442 cursor.setPosition(self._prompt_pos)
1443 1443 return cursor
1444 1444
1445 1445 def _get_selection_cursor(self, start, end):
1446 1446 """ Convenience method that returns a cursor with text selected between
1447 1447 the positions 'start' and 'end'.
1448 1448 """
1449 1449 cursor = self._control.textCursor()
1450 1450 cursor.setPosition(start)
1451 1451 cursor.setPosition(end, QtGui.QTextCursor.KeepAnchor)
1452 1452 return cursor
1453 1453
1454 1454 def _get_word_start_cursor(self, position):
1455 1455 """ Find the start of the word to the left the given position. If a
1456 1456 sequence of non-word characters precedes the first word, skip over
1457 1457 them. (This emulates the behavior of bash, emacs, etc.)
1458 1458 """
1459 1459 document = self._control.document()
1460 1460 position -= 1
1461 1461 while position >= self._prompt_pos and \
1462 1462 not document.characterAt(position).isLetterOrNumber():
1463 1463 position -= 1
1464 1464 while position >= self._prompt_pos and \
1465 1465 document.characterAt(position).isLetterOrNumber():
1466 1466 position -= 1
1467 1467 cursor = self._control.textCursor()
1468 1468 cursor.setPosition(position + 1)
1469 1469 return cursor
1470 1470
1471 1471 def _get_word_end_cursor(self, position):
1472 1472 """ Find the end of the word to the right the given position. If a
1473 1473 sequence of non-word characters precedes the first word, skip over
1474 1474 them. (This emulates the behavior of bash, emacs, etc.)
1475 1475 """
1476 1476 document = self._control.document()
1477 1477 end = self._get_end_cursor().position()
1478 1478 while position < end and \
1479 1479 not document.characterAt(position).isLetterOrNumber():
1480 1480 position += 1
1481 1481 while position < end and \
1482 1482 document.characterAt(position).isLetterOrNumber():
1483 1483 position += 1
1484 1484 cursor = self._control.textCursor()
1485 1485 cursor.setPosition(position)
1486 1486 return cursor
1487 1487
1488 1488 def _insert_continuation_prompt(self, cursor):
1489 1489 """ Inserts new continuation prompt using the specified cursor.
1490 1490 """
1491 1491 if self._continuation_prompt_html is None:
1492 1492 self._insert_plain_text(cursor, self._continuation_prompt)
1493 1493 else:
1494 1494 self._continuation_prompt = self._insert_html_fetching_plain_text(
1495 1495 cursor, self._continuation_prompt_html)
1496 1496
1497 1497 def _insert_html(self, cursor, html):
1498 1498 """ Inserts HTML using the specified cursor in such a way that future
1499 1499 formatting is unaffected.
1500 1500 """
1501 1501 cursor.beginEditBlock()
1502 1502 cursor.insertHtml(html)
1503 1503
1504 1504 # After inserting HTML, the text document "remembers" it's in "html
1505 1505 # mode", which means that subsequent calls adding plain text will result
1506 1506 # in unwanted formatting, lost tab characters, etc. The following code
1507 1507 # hacks around this behavior, which I consider to be a bug in Qt, by
1508 1508 # (crudely) resetting the document's style state.
1509 1509 cursor.movePosition(QtGui.QTextCursor.Left,
1510 1510 QtGui.QTextCursor.KeepAnchor)
1511 1511 if cursor.selection().toPlainText() == ' ':
1512 1512 cursor.removeSelectedText()
1513 1513 else:
1514 1514 cursor.movePosition(QtGui.QTextCursor.Right)
1515 1515 cursor.insertText(' ', QtGui.QTextCharFormat())
1516 1516 cursor.endEditBlock()
1517 1517
1518 1518 def _insert_html_fetching_plain_text(self, cursor, html):
1519 1519 """ Inserts HTML using the specified cursor, then returns its plain text
1520 1520 version.
1521 1521 """
1522 1522 cursor.beginEditBlock()
1523 1523 cursor.removeSelectedText()
1524 1524
1525 1525 start = cursor.position()
1526 1526 self._insert_html(cursor, html)
1527 1527 end = cursor.position()
1528 1528 cursor.setPosition(start, QtGui.QTextCursor.KeepAnchor)
1529 1529 text = unicode(cursor.selection().toPlainText())
1530 1530
1531 1531 cursor.setPosition(end)
1532 1532 cursor.endEditBlock()
1533 1533 return text
1534 1534
1535 1535 def _insert_plain_text(self, cursor, text):
1536 1536 """ Inserts plain text using the specified cursor, processing ANSI codes
1537 1537 if enabled.
1538 1538 """
1539 1539 cursor.beginEditBlock()
1540 1540 if self.ansi_codes:
1541 1541 for substring in self._ansi_processor.split_string(text):
1542 1542 for act in self._ansi_processor.actions:
1543 1543
1544 1544 # Unlike real terminal emulators, we don't distinguish
1545 1545 # between the screen and the scrollback buffer. A screen
1546 1546 # erase request clears everything.
1547 1547 if act.action == 'erase' and act.area == 'screen':
1548 1548 cursor.select(QtGui.QTextCursor.Document)
1549 1549 cursor.removeSelectedText()
1550 1550
1551 1551 # Simulate a form feed by scrolling just past the last line.
1552 1552 elif act.action == 'scroll' and act.unit == 'page':
1553 1553 cursor.insertText('\n')
1554 1554 cursor.endEditBlock()
1555 1555 self._set_top_cursor(cursor)
1556 1556 cursor.joinPreviousEditBlock()
1557 1557 cursor.deletePreviousChar()
1558 1558
1559 1559 format = self._ansi_processor.get_format()
1560 1560 cursor.insertText(substring, format)
1561 1561 else:
1562 1562 cursor.insertText(text)
1563 1563 cursor.endEditBlock()
1564 1564
1565 1565 def _insert_plain_text_into_buffer(self, cursor, text):
1566 1566 """ Inserts text into the input buffer using the specified cursor (which
1567 1567 must be in the input buffer), ensuring that continuation prompts are
1568 1568 inserted as necessary.
1569 1569 """
1570 1570 lines = unicode(text).splitlines(True)
1571 1571 if lines:
1572 1572 cursor.beginEditBlock()
1573 1573 cursor.insertText(lines[0])
1574 1574 for line in lines[1:]:
1575 1575 if self._continuation_prompt_html is None:
1576 1576 cursor.insertText(self._continuation_prompt)
1577 1577 else:
1578 1578 self._continuation_prompt = \
1579 1579 self._insert_html_fetching_plain_text(
1580 1580 cursor, self._continuation_prompt_html)
1581 1581 cursor.insertText(line)
1582 1582 cursor.endEditBlock()
1583 1583
1584 1584 def _in_buffer(self, position=None):
1585 1585 """ Returns whether the current cursor (or, if specified, a position) is
1586 1586 inside the editing region.
1587 1587 """
1588 1588 cursor = self._control.textCursor()
1589 1589 if position is None:
1590 1590 position = cursor.position()
1591 1591 else:
1592 1592 cursor.setPosition(position)
1593 1593 line = cursor.blockNumber()
1594 1594 prompt_line = self._get_prompt_cursor().blockNumber()
1595 1595 if line == prompt_line:
1596 1596 return position >= self._prompt_pos
1597 1597 elif line > prompt_line:
1598 1598 cursor.movePosition(QtGui.QTextCursor.StartOfBlock)
1599 1599 prompt_pos = cursor.position() + len(self._continuation_prompt)
1600 1600 return position >= prompt_pos
1601 1601 return False
1602 1602
1603 1603 def _keep_cursor_in_buffer(self):
1604 1604 """ Ensures that the cursor is inside the editing region. Returns
1605 1605 whether the cursor was moved.
1606 1606 """
1607 1607 moved = not self._in_buffer()
1608 1608 if moved:
1609 1609 cursor = self._control.textCursor()
1610 1610 cursor.movePosition(QtGui.QTextCursor.End)
1611 1611 self._control.setTextCursor(cursor)
1612 1612 return moved
1613 1613
1614 1614 def _keyboard_quit(self):
1615 1615 """ Cancels the current editing task ala Ctrl-G in Emacs.
1616 1616 """
1617 1617 if self._text_completing_pos:
1618 1618 self._cancel_text_completion()
1619 1619 else:
1620 1620 self.input_buffer = ''
1621 1621
1622 1622 def _page(self, text, html=False):
1623 1623 """ Displays text using the pager if it exceeds the height of the
1624 1624 viewport.
1625 1625
1626 1626 Parameters:
1627 1627 -----------
1628 1628 html : bool, optional (default False)
1629 1629 If set, the text will be interpreted as HTML instead of plain text.
1630 1630 """
1631 1631 line_height = QtGui.QFontMetrics(self.font).height()
1632 1632 minlines = self._control.viewport().height() / line_height
1633 1633 if self.paging != 'none' and \
1634 1634 re.match("(?:[^\n]*\n){%i}" % minlines, text):
1635 1635 if self.paging == 'custom':
1636 1636 self.custom_page_requested.emit(text)
1637 1637 else:
1638 1638 self._page_control.clear()
1639 1639 cursor = self._page_control.textCursor()
1640 1640 if html:
1641 1641 self._insert_html(cursor, text)
1642 1642 else:
1643 1643 self._insert_plain_text(cursor, text)
1644 1644 self._page_control.moveCursor(QtGui.QTextCursor.Start)
1645 1645
1646 1646 self._page_control.viewport().resize(self._control.size())
1647 1647 if self._splitter:
1648 1648 self._page_control.show()
1649 1649 self._page_control.setFocus()
1650 1650 else:
1651 1651 self.layout().setCurrentWidget(self._page_control)
1652 1652 elif html:
1653 1653 self._append_plain_html(text)
1654 1654 else:
1655 1655 self._append_plain_text(text)
1656 1656
1657 1657 def _prompt_finished(self):
1658 1658 """ Called immediately after a prompt is finished, i.e. when some input
1659 1659 will be processed and a new prompt displayed.
1660 1660 """
1661 1661 # Flush all state from the input splitter so the next round of
1662 1662 # reading input starts with a clean buffer.
1663 1663 self._input_splitter.reset()
1664 1664
1665 1665 self._control.setReadOnly(True)
1666 1666 self._prompt_finished_hook()
1667 1667
1668 1668 def _prompt_started(self):
1669 1669 """ Called immediately after a new prompt is displayed.
1670 1670 """
1671 1671 # Temporarily disable the maximum block count to permit undo/redo and
1672 1672 # to ensure that the prompt position does not change due to truncation.
1673 1673 self._control.document().setMaximumBlockCount(0)
1674 1674 self._control.setUndoRedoEnabled(True)
1675 1675
1676 1676 self._control.setReadOnly(False)
1677 1677 self._control.moveCursor(QtGui.QTextCursor.End)
1678 1678 self._executing = False
1679 1679 self._prompt_started_hook()
1680 1680
1681 1681 def _readline(self, prompt='', callback=None):
1682 1682 """ Reads one line of input from the user.
1683 1683
1684 1684 Parameters
1685 1685 ----------
1686 1686 prompt : str, optional
1687 1687 The prompt to print before reading the line.
1688 1688
1689 1689 callback : callable, optional
1690 1690 A callback to execute with the read line. If not specified, input is
1691 1691 read *synchronously* and this method does not return until it has
1692 1692 been read.
1693 1693
1694 1694 Returns
1695 1695 -------
1696 1696 If a callback is specified, returns nothing. Otherwise, returns the
1697 1697 input string with the trailing newline stripped.
1698 1698 """
1699 1699 if self._reading:
1700 1700 raise RuntimeError('Cannot read a line. Widget is already reading.')
1701 1701
1702 1702 if not callback and not self.isVisible():
1703 1703 # If the user cannot see the widget, this function cannot return.
1704 1704 raise RuntimeError('Cannot synchronously read a line if the widget '
1705 1705 'is not visible!')
1706 1706
1707 1707 self._reading = True
1708 1708 self._show_prompt(prompt, newline=False)
1709 1709
1710 1710 if callback is None:
1711 1711 self._reading_callback = None
1712 1712 while self._reading:
1713 1713 QtCore.QCoreApplication.processEvents()
1714 1714 return self.input_buffer.rstrip('\n')
1715 1715
1716 1716 else:
1717 1717 self._reading_callback = lambda: \
1718 1718 callback(self.input_buffer.rstrip('\n'))
1719 1719
1720 1720 def _set_continuation_prompt(self, prompt, html=False):
1721 1721 """ Sets the continuation prompt.
1722 1722
1723 1723 Parameters
1724 1724 ----------
1725 1725 prompt : str
1726 1726 The prompt to show when more input is needed.
1727 1727
1728 1728 html : bool, optional (default False)
1729 1729 If set, the prompt will be inserted as formatted HTML. Otherwise,
1730 1730 the prompt will be treated as plain text, though ANSI color codes
1731 1731 will be handled.
1732 1732 """
1733 1733 if html:
1734 1734 self._continuation_prompt_html = prompt
1735 1735 else:
1736 1736 self._continuation_prompt = prompt
1737 1737 self._continuation_prompt_html = None
1738 1738
1739 1739 def _set_cursor(self, cursor):
1740 1740 """ Convenience method to set the current cursor.
1741 1741 """
1742 1742 self._control.setTextCursor(cursor)
1743 1743
1744 1744 def _set_top_cursor(self, cursor):
1745 1745 """ Scrolls the viewport so that the specified cursor is at the top.
1746 1746 """
1747 1747 scrollbar = self._control.verticalScrollBar()
1748 1748 scrollbar.setValue(scrollbar.maximum())
1749 1749 original_cursor = self._control.textCursor()
1750 1750 self._control.setTextCursor(cursor)
1751 1751 self._control.ensureCursorVisible()
1752 1752 self._control.setTextCursor(original_cursor)
1753 1753
1754 1754 def _show_prompt(self, prompt=None, html=False, newline=True):
1755 1755 """ Writes a new prompt at the end of the buffer.
1756 1756
1757 1757 Parameters
1758 1758 ----------
1759 1759 prompt : str, optional
1760 1760 The prompt to show. If not specified, the previous prompt is used.
1761 1761
1762 1762 html : bool, optional (default False)
1763 1763 Only relevant when a prompt is specified. If set, the prompt will
1764 1764 be inserted as formatted HTML. Otherwise, the prompt will be treated
1765 1765 as plain text, though ANSI color codes will be handled.
1766 1766
1767 1767 newline : bool, optional (default True)
1768 1768 If set, a new line will be written before showing the prompt if
1769 1769 there is not already a newline at the end of the buffer.
1770 1770 """
1771 1771 # Insert a preliminary newline, if necessary.
1772 1772 if newline:
1773 1773 cursor = self._get_end_cursor()
1774 1774 if cursor.position() > 0:
1775 1775 cursor.movePosition(QtGui.QTextCursor.Left,
1776 1776 QtGui.QTextCursor.KeepAnchor)
1777 1777 if unicode(cursor.selection().toPlainText()) != '\n':
1778 1778 self._append_plain_text('\n')
1779 1779
1780 1780 # Write the prompt.
1781 1781 self._append_plain_text(self._prompt_sep)
1782 1782 if prompt is None:
1783 1783 if self._prompt_html is None:
1784 1784 self._append_plain_text(self._prompt)
1785 1785 else:
1786 1786 self._append_html(self._prompt_html)
1787 1787 else:
1788 1788 if html:
1789 1789 self._prompt = self._append_html_fetching_plain_text(prompt)
1790 1790 self._prompt_html = prompt
1791 1791 else:
1792 1792 self._append_plain_text(prompt)
1793 1793 self._prompt = prompt
1794 1794 self._prompt_html = None
1795 1795
1796 1796 self._prompt_pos = self._get_end_cursor().position()
1797 1797 self._prompt_started()
1798 1798
1799 1799 #------ Signal handlers ----------------------------------------------------
1800 1800
1801 1801 def _adjust_scrollbars(self):
1802 1802 """ Expands the vertical scrollbar beyond the range set by Qt.
1803 1803 """
1804 1804 # This code is adapted from _q_adjustScrollbars in qplaintextedit.cpp
1805 1805 # and qtextedit.cpp.
1806 1806 document = self._control.document()
1807 1807 scrollbar = self._control.verticalScrollBar()
1808 1808 viewport_height = self._control.viewport().height()
1809 1809 if isinstance(self._control, QtGui.QPlainTextEdit):
1810 1810 maximum = max(0, document.lineCount() - 1)
1811 1811 step = viewport_height / self._control.fontMetrics().lineSpacing()
1812 1812 else:
1813 1813 # QTextEdit does not do line-based layout and blocks will not in
1814 1814 # general have the same height. Therefore it does not make sense to
1815 1815 # attempt to scroll in line height increments.
1816 1816 maximum = document.size().height()
1817 1817 step = viewport_height
1818 1818 diff = maximum - scrollbar.maximum()
1819 1819 scrollbar.setRange(0, maximum)
1820 1820 scrollbar.setPageStep(step)
1821 1821 # Compensate for undesirable scrolling that occurs automatically due to
1822 1822 # maximumBlockCount() text truncation.
1823 1823 if diff < 0 and document.blockCount() == document.maximumBlockCount():
1824 1824 scrollbar.setValue(scrollbar.value() + diff)
1825 1825
1826 1826 def _cursor_position_changed(self):
1827 1827 """ Clears the temporary buffer based on the cursor position.
1828 1828 """
1829 1829 if self._text_completing_pos:
1830 1830 document = self._control.document()
1831 1831 if self._text_completing_pos < document.characterCount():
1832 1832 cursor = self._control.textCursor()
1833 1833 pos = cursor.position()
1834 1834 text_cursor = self._control.textCursor()
1835 1835 text_cursor.setPosition(self._text_completing_pos)
1836 1836 if pos < self._text_completing_pos or \
1837 1837 cursor.blockNumber() > text_cursor.blockNumber():
1838 1838 self._clear_temporary_buffer()
1839 1839 self._text_completing_pos = 0
1840 1840 else:
1841 1841 self._clear_temporary_buffer()
1842 1842 self._text_completing_pos = 0
1843 1843
1844 1844 def _custom_context_menu_requested(self, pos):
1845 1845 """ Shows a context menu at the given QPoint (in widget coordinates).
1846 1846 """
1847 1847 menu = self._context_menu_make(pos)
1848 1848 menu.exec_(self._control.mapToGlobal(pos))
General Comments 0
You need to be logged in to leave comments. Login now