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
|
"""
Interface for an output.
"""
from __future__ import unicode_literals
from abc import ABCMeta, abstractmethod
from six import with_metaclass
from prompt_toolkit.layout.screen import Size
__all__ = (
'Output',
)
class Output(with_metaclass(ABCMeta, object)):
"""
Base class defining the output interface for a
:class:`~prompt_toolkit.renderer.Renderer`.
Actual implementations are
:class:`~prompt_toolkit.terminal.vt100_output.Vt100_Output` and
:class:`~prompt_toolkit.terminal.win32_output.Win32Output`.
"""
@abstractmethod
def fileno(self):
" Return the file descriptor to which we can write for the output. "
@abstractmethod
def encoding(self):
"""
Return the encoding for this output, e.g. 'utf-8'.
(This is used mainly to know which characters are supported by the
output the data, so that the UI can provide alternatives, when
required.)
"""
@abstractmethod
def write(self, data):
" Write text (Terminal escape sequences will be removed/escaped.) "
@abstractmethod
def write_raw(self, data):
" Write text. "
@abstractmethod
def set_title(self, title):
" Set terminal title. "
@abstractmethod
def clear_title(self):
" Clear title again. (or restore previous title.) "
@abstractmethod
def flush(self):
" Write to output stream and flush. "
@abstractmethod
def erase_screen(self):
"""
Erases the screen with the background colour and moves the cursor to
home.
"""
@abstractmethod
def enter_alternate_screen(self):
" Go to the alternate screen buffer. (For full screen applications). "
@abstractmethod
def quit_alternate_screen(self):
" Leave the alternate screen buffer. "
@abstractmethod
def enable_mouse_support(self):
" Enable mouse. "
@abstractmethod
def disable_mouse_support(self):
" Disable mouse. "
@abstractmethod
def erase_end_of_line(self):
"""
Erases from the current cursor position to the end of the current line.
"""
@abstractmethod
def erase_down(self):
"""
Erases the screen from the current line down to the bottom of the
screen.
"""
@abstractmethod
def reset_attributes(self):
" Reset color and styling attributes. "
@abstractmethod
def set_attributes(self, attrs):
" Set new color and styling attributes. "
@abstractmethod
def disable_autowrap(self):
" Disable auto line wrapping. "
@abstractmethod
def enable_autowrap(self):
" Enable auto line wrapping. "
@abstractmethod
def cursor_goto(self, row=0, column=0):
" Move cursor position. "
@abstractmethod
def cursor_up(self, amount):
" Move cursor `amount` place up. "
@abstractmethod
def cursor_down(self, amount):
" Move cursor `amount` place down. "
@abstractmethod
def cursor_forward(self, amount):
" Move cursor `amount` place forward. "
@abstractmethod
def cursor_backward(self, amount):
" Move cursor `amount` place backward. "
@abstractmethod
def hide_cursor(self):
" Hide cursor. "
@abstractmethod
def show_cursor(self):
" Show cursor. "
def ask_for_cpr(self):
"""
Asks for a cursor position report (CPR).
(VT100 only.)
"""
def bell(self):
" Sound bell. "
def enable_bracketed_paste(self):
" For vt100 only. "
def disable_bracketed_paste(self):
" For vt100 only. "
class DummyOutput(Output):
"""
For testing. An output class that doesn't render anything.
"""
def fileno(self):
" There is no sensible default for fileno(). "
raise NotImplementedError
def encoding(self):
return 'utf-8'
def write(self, data): pass
def write_raw(self, data): pass
def set_title(self, title): pass
def clear_title(self): pass
def flush(self): pass
def erase_screen(self): pass
def enter_alternate_screen(self): pass
def quit_alternate_screen(self): pass
def enable_mouse_support(self): pass
def disable_mouse_support(self): pass
def erase_end_of_line(self): pass
def erase_down(self): pass
def reset_attributes(self): pass
def set_attributes(self, attrs): pass
def disable_autowrap(self): pass
def enable_autowrap(self): pass
def cursor_goto(self, row=0, column=0): pass
def cursor_up(self, amount): pass
def cursor_down(self, amount): pass
def cursor_forward(self, amount): pass
def cursor_backward(self, amount): pass
def hide_cursor(self): pass
def show_cursor(self): pass
def ask_for_cpr(self): pass
def bell(self): pass
def enable_bracketed_paste(self): pass
def disable_bracketed_paste(self): pass
def get_size(self):
return Size(rows=40, columns=80)
|
