forked from Moataz-Elibiary/PyQTerminal
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Terminal.py
559 lines (497 loc) · 25.1 KB
/
Terminal.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
from PyQt5.QtGui import QTextCursor, QFont, QTextCharFormat, QFontMetrics, QColor
#from PyQt5.QtWidgets import *
from PyQt5.QtWidgets import QTextEdit
from PyQt5.QtCore import QTimer, Qt, QCoreApplication, pyqtSignal
from .Background import Connection
from .ControlSequence import *
from re import match, sub, findall, finditer
class QTerminal(QTextEdit):
TIMEOUT = 60 # Timeout after 60 [s]
MAX_OUTPUT = 1000 # Maximum output is 1000 lines
MAX_HISTORY = 100 # Maximum history is 100 lines
SCREEN_HEIGHT = 24
SCREEN_WIDTH = 80
FONT_NAME = "Lucida Console"
FONT_SIZE = 10
FG_COLOR = QColor(100, 100, 100)
BG_COLOR = QColor(255, 255, 255)
SELECT_FG_COLOR = QColor(255, 255, 255)
SELECT_BG_COLOR = QColor(40, 90, 240)
def __init__(self, master=None, session=None, connection=None):
super(QTerminal, self).__init__(master)
self.master = master
# Define the connection
self._session = session
self._connection = Connection() if connection is None else connection
if self._session:
self._connection.set_session(self._session)
self._connection.start_connection()
# Define timer
self._timeout = self.TIMEOUT * 1000 # _timeout in [ms]
self.timer = QTimer(self)
self.timer.setSingleShot(True)
# Update the GUI
self._application_cursor_mode = False
self._application_keypad_mode = False
self.font = QFont(self.FONT_NAME, self.FONT_SIZE)
self.setFont(self.font)
self.document().setMaximumBlockCount(self.MAX_OUTPUT)
self.setCurrentCharFormat(self.default_text_format()) # Reset the text format
self.set_title('Terminal')
self._selection_cursor = self.textCursor()
self._select_cursor_format = self.currentCharFormat()
self._deselect_cursor_format = self.currentCharFormat()
self._select_cursor_format.setBackground(self.SELECT_BG_COLOR)
self._select_cursor_format.setForeground(self.SELECT_FG_COLOR)
self._deselect_cursor_format.setBackground(self.BG_COLOR)
self._deselect_cursor_format.setForeground(self.FG_COLOR)
# noinspection PyArgumentList
self._app = QCoreApplication.instance()
self._clipboard = self._app.clipboard()
# Update cursor and cursor position
self.setCursorWidth(QFontMetrics(self.font).width('M'))
self.setCursor(Qt.IBeamCursor)
# Update signals connections
self._connect_signals()
def __del__(self):
self._connection.close_session()
def _connect_signals(self):
# Connect pyqt signals
self.selectionChanged.connect(self.on_selection_changed)
self._connection.add_text['QString'].connect(self.add_received_text)
self._connection.clear_all.connect(self.clear)
self._connection.reset_timer.connect(lambda: self.timer.start(self._timeout))
self._connection.stop_timer.connect(self.timer.stop)
self.timer.timeout.connect(self._connection.timeout)
def closeEvent(self, *args, **kwargs):
self._connection.close_session()
return QTextEdit.closeEvent(self, *args, **kwargs)
def resizeEvent(self, event):
frame_format = self.document().rootFrame().frameFormat()
frame_format.setBottomMargin(self.viewport().height() - QFontMetrics(
self.document().defaultFont()).height() - 2)
self.document().rootFrame().setFrameFormat(frame_format)
return QTextEdit.resizeEvent(self, event)
def focusInEvent(self, event):
if self._connection:
self._connection.set_reading_interval(
Connection.DATA_READ_INT) # Reset the data reading interval
return QTextEdit.focusInEvent(self, event)
def focusOutEvent(self, event):
if self._connection:
# increase the data reading interval, as to reduce the application load
self._connection.set_reading_interval(Connection.DATA_READ_INT * 20)
return QTextEdit.focusOutEvent(self, event)
def mousePressEvent(self, event):
if event.button() == Qt.MiddleButton:
self.paste()
return
elif event.button() == Qt.LeftButton:
self._clear_cursor_selection()
self._selection_cursor.setPosition(
self.cursorForPosition(event.pos()).position(), QTextCursor.MoveAnchor)
return
elif event.button() == Qt.RightButton:
return
return QTextEdit.mousePressEvent(self, event)
def mouseReleaseEvent(self, event):
return
def mouseDoubleClickEvent(self, event):
if event.button() == Qt.LeftButton:
self._clear_cursor_selection()
self._selection_cursor.movePosition(
self.cursorForPosition(event.pos()).StartOfWord, QTextCursor.MoveAnchor)
self._selection_cursor.movePosition(QTextCursor.EndOfWord, QTextCursor.KeepAnchor)
self._selection_cursor.setCharFormat(self._select_cursor_format)
if self._selection_cursor.hasSelection:
self._clipboard.setText(self._selection_cursor.selectedText())
return
def mouseMoveEvent(self, event):
if event.buttons() == Qt.LeftButton:
self._selection_cursor.setCharFormat(self._deselect_cursor_format)
self._selection_cursor.setPosition(
self.cursorForPosition(event.pos()).position(), QTextCursor.KeepAnchor)
self._selection_cursor.setCharFormat(self._select_cursor_format)
if self._selection_cursor.hasSelection:
self._clipboard.setText(self._selection_cursor.selectedText())
return QTextEdit.mouseMoveEvent(self, event)
def _clear_cursor_selection(self):
if self._selection_cursor.hasSelection():
self._selection_cursor.setCharFormat(self._deselect_cursor_format)
self._selection_cursor.clearSelection()
def keyPressEvent(self, event):
if event.modifiers() == Qt.NoModifier:
if event.key() == Qt.Key_Up: # Move cursor up
text = (SS3 if self._application_cursor_mode else CSI) + 'A'
elif event.key() == Qt.Key_Down: # Move cursor down
text = (SS3 if self._application_cursor_mode else CSI) + 'B'
elif event.key() == Qt.Key_Right: # Move cursor right
text = (SS3 if self._application_cursor_mode else CSI) + 'C'
elif event.key() == Qt.Key_Left: # Move cursor left
text = (SS3 if self._application_cursor_mode else CSI) + 'D'
elif event.key() == Qt.Key_Return: # Move cursor to end of line then send command
cursor = self.textCursor()
cursor.movePosition(QTextCursor.EndOfLine, QTextCursor.MoveAnchor)
cursor.setCharFormat(self.currentCharFormat())
self.setTextCursor(cursor)
text = event.text()
elif event.key(
) == Qt.Key_Escape: # Read data in buffer - Send "End Of Transmission" (same as CRTL + D)
# text = EOT
text = event.text()
else:
text = event.text()
self.send_text(text)
return
elif event.modifiers() == Qt.ControlModifier:
if event.key() == Qt.Key_A: # Select All
self._clear_cursor_selection()
self._selection_cursor.movePosition(QTextCursor.Start, QTextCursor.MoveAnchor)
self._selection_cursor.movePosition(QTextCursor.End, QTextCursor.KeepAnchor)
self._selection_cursor.setCharFormat(self._select_cursor_format)
if self._selection_cursor.hasSelection:
self._clipboard.setText(self._selection_cursor.selectedText())
elif event.key() == Qt.Key_B: # Break Terminal - sent "Start Of Text"
self.send_text(SOH)
elif event.key() == Qt.Key_C: # Break Terminal - sent "End of Text"
self.send_text(ETX)
elif event.key() == Qt.Key_D: # Close Connection - sent "End of Transmission"
self.send_text(EOT)
elif event.key() == Qt.Key_E: # Sent "Enquiry"
self.send_text(ENQ)
elif event.key() == Qt.Key_F: # Sent " Acknowledge"
self.send_text(ACK)
elif event.key() == Qt.Key_G: # Sent "Bell"
self.send_text(BEL)
elif event.key() == Qt.Key_Z: # Suspend Terminal - Send "Substitute"
self.send_text(SUB)
return
elif event.modifiers() == Qt.ShiftModifier:
if event.text():
self.send_text(event.text())
return
# if event.key() == Qt.Key_Home:
# if event.modifiers() == Qt.ShiftModifier:
# self.set_cursor_pos(self._readonly_end_pos, QTextCursor.KeepAnchor)
# return
# elif event.modifiers() == Qt.NoModifier:
# self.set_cursor_pos(self._readonly_end_pos, QTextCursor.MoveAnchor)
# return
return QTextEdit.keyPressEvent(self, event)
def send_text(self, cmd=''):
if self._connection.is_connected():
self._connection.send(str(cmd))
elif cmd == '\r':
self.clear()
self._connection.start_connection()
def on_selection_changed(self):
if self.textCursor().selectedText():
self.copy()
def print_data(self, data):
if BEL in data or BS in data:
self._print_per_char(data)
else:
self._print_bulk(data)
def _print_bulk(self, data):
partitioned = str(data).partition("\n")
cursor = self.textCursor()
for part_i, text in enumerate(partitioned):
# The first line might need to overwrite some characters.
if part_i == 0:
cursor.movePosition(QTextCursor.Right, QTextCursor.KeepAnchor, n=len(text))
cursor.setCharFormat(self.currentCharFormat())
cursor.insertText(text)
self.setTextCursor(cursor)
def _print_per_char(self, data):
for char_i in data:
# Decode ASCII character
if char_i == BEL: # Beep
self._app.beep()
elif char_i == BS: # Backspace
if not self._application_cursor_mode:
cursor = self.textCursor()
cursor.movePosition(QTextCursor.Left, QTextCursor.MoveAnchor)
cursor.setCharFormat(self.currentCharFormat())
self.setTextCursor(cursor)
elif str(char_i): # Normal characters
# Replace the existing character
cursor = self.textCursor()
cursor.movePosition(QTextCursor.Right, QTextCursor.KeepAnchor)
cursor.setCharFormat(self.currentCharFormat())
cursor.insertText(str(char_i))
self.setTextCursor(cursor)
def add_received_text(self, data):
if ESC in data:
# Slice the data with Escape
new_data_list = [ESC + d for d in data.split(ESC)]
new_data_list[0] = new_data_list[0][1:]
for data_slice in new_data_list:
self.print_data(self.decode_data(data_slice))
else:
self.print_data(self.decode_data(data))
# Close connection on exit
if match('.*\n?logout\n+', data):
self.close()
def insertFromMimeData(self, mime_data):
self.send_text(self._clipboard.text())
return
def set_title(self, title):
self.setWindowTitle(title.strip() if title.strip() else 'Terminal')
def decode_data(self, data):
def moving_cursor(d, pattern):
"""
This function is used to moves the cursor by COUNT rows/column depending on the received data.
The default count is 1.
"""
if pattern:
if pattern.group()[-1] == 'A': # Move Cursor Up
action = QTextCursor.Up
elif pattern.group()[-1] == 'B': # Move Cursor Down
action = QTextCursor.Down
elif pattern.group()[-1] == 'C': # Move Cursor Right
action = QTextCursor.Right
elif pattern.group()[-1] == 'D': # Move Cursor Left
action = QTextCursor.Left
elif pattern.group()[-1] == 'E': # Move Cursor Next Block
action = QTextCursor.NextBlock
elif pattern.group()[-1] == 'F': # Move Cursor Previous Block
action = QTextCursor.PreviousBlock
else:
action = None
if action:
count = pattern.group()[2:-1]
if count:
try:
cursor.movePosition(action, QTextCursor.MoveAnchor, int(count))
except ValueError:
print("Receiving non-integer value for escape sequence.")
else: # same as value = 1
cursor.movePosition(action, QTextCursor.MoveAnchor)
return sub("%s\d*[ABCDEF]" % rCSI, '', d)
return d
def moving_cursor_to_pos(d, pattern):
"""
This function is used to scroll the text depending on the received data.
Sets the cursor position where subsequent text will begin.
If no row/column parameters are provided ( i.e. <ESC>[H ), the cursor will
move to the home position, at the upper left of the screen.
"""
if pattern:
row_col = pattern.group()[2:-1]
if row_col:
try:
row = int(row_col.split(';')[0])
col = int(row_col.split(';')[1])
cursor.movePosition(QTextCursor.Up, QTextCursor.MoveAnchor, row)
cursor.movePosition(QTextCursor.PreviousCharacter, QTextCursor.MoveAnchor,
col)
except ValueError:
print("Receiving non-integer value for escape sequence.")
else:
# self.verticalScrollBar().setValue(self.verticalScrollBar().maximum())
cursor.movePosition(QTextCursor.Start, QTextCursor.MoveAnchor)
return sub("%s(\d+;\d+)?H" % rCSI, '', d)
return d
cursor = self.textCursor()
text_format = self.currentCharFormat()
# Decode escape characters
if ESC in data:
if data.startswith(CSI): # CSI Codes ( ESC + [ )
""" Moving Cursor Patterns """
data = moving_cursor(data, match("%s\d*[ABCDEF]" % rCSI,
data)) # pattern = <ESC>[{value} A|B|C|D|E|F
# Move Cursor Position [row;column] (default = [1,1])
data = moving_cursor_to_pos(data, match("%s(\d+;\d+)?H" % rCSI,
data)) # pattern = <ESC>[{value};{value}H
""" Changing cursor mode """
# Set cursor key to application mode
matched_pattern = match("%s\?1h" % rCSI, data) # pattern = <ESC>[?1h
if matched_pattern:
print(matched_pattern.group())
data = sub("%s\?1h" % rCSI, '', data)
self._application_cursor_mode = True
# Set cursor key to normal mode (cursor mode)
matched_pattern = match("%s\?1l" % rCSI, data) # pattern = <ESC>[?1l
if matched_pattern:
data = sub("%s\?1l" % rCSI, '', data)
self._application_cursor_mode = False
""" Erase Patterns """
# Text Erase in Display
matched_pattern = match("%s\d*J" % rCSI, data) # pattern = <ESC>[{value}J
if matched_pattern:
data = sub("%s\d*J" % rCSI, '', data)
matched_code = matched_pattern.group()[2:-1]
if matched_code:
if matched_code == 0:
# EL0 = CSI + '0J' ==> Erase Below (from cursor down)
cursor.movePosition(QTextCursor.End, QTextCursor.KeepAnchor)
elif matched_code == 1:
# EL1 = CSI + '1J' ==> Erase Above (from cursor up)
cursor.movePosition(QTextCursor.Start, QTextCursor.KeepAnchor)
elif matched_code == 2:
# EL2 = CSI + '2J' ==> Erase All
cursor.movePosition(QTextCursor.End, QTextCursor.MoveAnchor)
cursor.movePosition(QTextCursor.Start, QTextCursor.KeepAnchor)
else:
# unsupported number
print("Unsupported escape sequence.")
else:
# EL = CSI + 'J' ==> Erase Below (from cursor down)
cursor.movePosition(QTextCursor.End, QTextCursor.KeepAnchor)
if cursor.hasSelection():
cursor.removeSelectedText()
# Text Erase in Line (EL)
matched_pattern = match("%s\d?K" % rCSI, data) # pattern = <ESC>[{value}K
if matched_pattern:
data = sub("%s\d?K" % rCSI, '', data)
matched_code = matched_pattern.group()[2:-1]
if matched_code:
if matched_code == 0:
# EL0 = CSI + '0K' ==> Clear from cursor to end of line (from cursor right)
cursor.movePosition(QTextCursor.EndOfLine, QTextCursor.KeepAnchor)
elif matched_code == 1:
# EL1 = CSI + '1K' ==> Clear from cursor to start of line (from cursor left)
cursor.movePosition(QTextCursor.StartOfLine, QTextCursor.KeepAnchor)
elif matched_code == 2:
# EL2 = CSI + '2K' ==> Clear entire line
cursor.movePosition(QTextCursor.EndOfLine, QTextCursor.MoveAnchor)
cursor.movePosition(QTextCursor.StartOfLine, QTextCursor.KeepAnchor)
else:
# Cursor already in position, or unsupported number
pass
else:
# EL = CSI + 'K' ==> Clear from cursor to end of line (from cursor right)
cursor.movePosition(QTextCursor.EndOfLine, QTextCursor.KeepAnchor)
if cursor.hasSelection():
cursor.removeSelectedText()
# Text Graphical Format
matched_pattern = match("%s(\d+;?)+m" % rCSI,
data) # pattern = <ESC>[{value};{value}m
if matched_pattern:
data = data[len(matched_pattern.group()):]
matched_code = finditer('\d+', matched_pattern.group())
if matched_code:
for code in matched_code:
text_format = self.update_text_format(int(code.group()), text_format)
elif data.startswith(OSC): # OSC Codes ( ESC + ] )
# Update Terminal Title
matched_pattern = match("%s\d+;.*(%s|%s)" % (rOSC, BEL, rST),
data) # pattern = <ESC>]{value};{string} + ST|BEL
if matched_pattern:
data = data[len(matched_pattern.group()):]
matched_code = str(findall('\d+', matched_pattern.group())[0])
if matched_code in '02': # Ignore all other codes
self.set_title(matched_pattern.group()[4:-1])
else:
""" Changing keypad mode """
# Set keypad to application mode
matched_pattern = match("\x1B=", data) # pattern = <ESC>=
if matched_pattern:
data = sub("\x1B=", '', data)
self._application_keypad_mode = True
# Set keypad to normal numeric mode
matched_pattern = match("\x1b>", data) # pattern = <ESC>>
if matched_pattern:
data = sub("\x1b>", '', data)
self._application_keypad_mode = False
cursor.setCharFormat(text_format)
self.setTextCursor(cursor)
return sub(ESC, '', data)
def update_text_format(self, code, text_format):
# Set Default Text Graphical Format
default_format = self.default_text_format()
# Text attributes
if code == 0: # Default
text_format = default_format
elif code == 1: # Bold
text_format.setFontWeight(QFont.Bold)
elif code == 2: # Low Intensity
text_format.setFontWeight(QFont.Light)
elif code == 3: # Italic
text_format.setFontItalic(True)
elif code == 4: # Underline
text_format.setUnderlineStyle(QTextCharFormat.SingleUnderline)
text_format.setFontUnderline(True)
elif code == 5: # Blink, Appears as Bold
text_format.setFontWeight(QFont.Bold)
elif code == 6: # Blink, Appears as Very Bold
text_format.setFontWeight(QFont.Black)
elif code == 7: # Reverse/Inverse
foreground_color = text_format.foreground()
text_format.setForeground(text_format.background())
text_format.setBackground(foreground_color)
elif code == 8: # Hidden/Invisible (for password)
text_format.setForeground(text_format.background())
elif code == 9: # Crossed-out
text_format.setFontStrikeOut(True)
elif code == 21: # Bold OFF
text_format.setFontWeight(QFont.Normal)
elif code == 22: # Faint OFF
text_format.setFontWeight(QFont.Normal)
elif code == 23: # Italic OFF
text_format.setFontItalic(False)
elif code == 24: # Underline OFF
text_format.setUnderlineStyle(QTextCharFormat.NoUnderline)
text_format.setFontUnderline(False)
elif code == 25: # Steady (Not Blinking/Bold)
text_format.setFontWeight(QFont.Normal)
elif code == 27: # Positive (non-inverted)
foreground_color = text_format.foreground()
text_format.setForeground(text_format.background())
text_format.setBackground(foreground_color)
elif code == 28: # Visible (not hidden)
text_format.setForeground(default_format.foreground())
text_format.setBackground(default_format.background())
elif code == 29: # Crossed-out OFF
text_format.setFontStrikeOut(False)
# Foreground colors
elif code == 30: # Foreground Black
text_format.setForeground(Qt.black)
elif code == 31: # Foreground Red
text_format.setForeground(Qt.red)
elif code == 32: # Foreground Green
text_format.setForeground(Qt.green)
elif code == 33: # Foreground Yellow
text_format.setForeground(Qt.yellow)
elif code == 34: # Foreground Blue
text_format.setForeground(Qt.blue)
elif code == 35: # Foreground Magenta
text_format.setForeground(Qt.magenta)
elif code == 36: # Foreground Cyan
text_format.setForeground(Qt.cyan)
elif code == 37: # Foreground White
text_format.setForeground(Qt.white)
elif code == 39: # Foreground Default
text_format.setForeground(default_format.foreground())
# Background colors
elif code == 40: # Background Black
text_format.setBackground(Qt.black)
elif code == 41: # Background Red
text_format.setBackground(Qt.red)
elif code == 42: # Background Green
text_format.setBackground(Qt.green)
elif code == 43: # Background Yellow
text_format.setBackground(Qt.yellow)
elif code == 44: # Background Blue
text_format.setBackground(Qt.blue)
elif code == 45: # Background Magenta
text_format.setBackground(Qt.magenta)
elif code == 46: # Background Cyan
text_format.setBackground(Qt.cyan)
elif code == 47: # Background White
text_format.setBackground(Qt.white)
elif code == 49: # Background Default
text_format.setBackground(default_format.background())
else:
pass
return text_format
def default_text_format(self):
text_format = self.currentCharFormat()
text_format.setFontWeight(QFont.Normal)
text_format.setFontItalic(False)
text_format.setUnderlineStyle(QTextCharFormat.NoUnderline)
text_format.setFontUnderline(False)
text_format.setFontStrikeOut(False)
text_format.setForeground(self.FG_COLOR)
text_format.setBackground(self.BG_COLOR)
return text_format