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
|
# (C) Copyright 2005-2023 Enthought, Inc., Austin, TX
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in LICENSE.txt and may be redistributed only under
# the conditions described in the aforementioned license. The license
# is also available online at http://www.enthought.com/licenses/BSD.txt
#
# Thanks for using Enthought open source!
""" Enthought pyface package component
"""
import warnings
import wx.stc
from traits.api import Bool, Event, provides, Str
from pyface.i_python_editor import IPythonEditor, MPythonEditor
from pyface.key_pressed_event import KeyPressedEvent
from pyface.wx.python_stc import PythonSTC, faces
from .layout_widget import LayoutWidget
@provides(IPythonEditor)
class PythonEditor(MPythonEditor, LayoutWidget):
""" The toolkit specific implementation of a PythonEditor. See the
IPythonEditor interface for the API documentation.
"""
# 'IPythonEditor' interface --------------------------------------------
dirty = Bool(False)
path = Str()
show_line_numbers = Bool(True)
# Events ----
changed = Event()
key_pressed = Event(KeyPressedEvent)
# ------------------------------------------------------------------------
# 'object' interface.
# ------------------------------------------------------------------------
def __init__(self, parent=None, **traits):
""" Creates a new pager. """
create = traits.pop("create", None)
# Base class constructor.
super().__init__(parent=parent, **traits)
if create:
# Create the widget's toolkit-specific control.
self.create()
warnings.warn(
"automatic widget creation is deprecated and will be removed "
"in a future Pyface version, code should not pass the create "
"parameter and should instead call create() explicitly",
DeprecationWarning,
stacklevel=2,
)
elif create is not None:
warnings.warn(
"setting create=False is no longer required",
DeprecationWarning,
stacklevel=2,
)
# ------------------------------------------------------------------------
# 'PythonEditor' interface.
# ------------------------------------------------------------------------
def load(self, path=None):
""" Loads the contents of the editor. """
if path is None:
path = self.path
# We will have no path for a new script.
if len(path) > 0:
f = open(self.path, "r")
text = f.read()
f.close()
else:
text = ""
self.control.SetText(text)
self.dirty = False
def save(self, path=None):
""" Saves the contents of the editor. """
if path is None:
path = self.path
f = open(path, "w")
f.write(self.control.GetText())
f.close()
self.dirty = False
def set_style(self, n, fore, back):
self.control.StyleSetForeground(n, fore)
self.control.StyleSetBackground(n, back)
self.control.StyleSetFaceName(n, "courier new")
self.control.StyleSetSize(n, faces["size"])
def select_line(self, lineno):
""" Selects the specified line. """
start = self.control.PositionFromLine(lineno)
end = self.control.GetLineEndPosition(lineno)
self.control.SetSelection(start, end)
return
# ------------------------------------------------------------------------
# Trait handlers.
# ------------------------------------------------------------------------
def _path_changed(self):
""" Handle a change to path. """
self._changed_path()
return
# ------------------------------------------------------------------------
# Private interface.
# ------------------------------------------------------------------------
def _create_control(self, parent):
""" Creates the toolkit-specific control for the widget. """
# Base-class constructor.
self.control = stc = PythonSTC(parent, -1)
# No folding!
stc.SetProperty("fold", "0")
# Mark the maximum line size.
stc.SetEdgeMode(wx.stc.STC_EDGE_LINE)
stc.SetEdgeColumn(79)
# Display line numbers in the margin.
if self.show_line_numbers:
stc.SetMarginType(1, wx.stc.STC_MARGIN_NUMBER)
stc.SetMarginWidth(1, 45)
self.set_style(wx.stc.STC_STYLE_LINENUMBER, "#000000", "#c0c0c0")
else:
stc.SetMarginWidth(1, 4)
self.set_style(wx.stc.STC_STYLE_LINENUMBER, "#ffffff", "#ffffff")
# Create 'tabs' out of spaces!
stc.SetUseTabs(False)
# One 'tab' is 4 spaces.
stc.SetIndent(4)
# Line ending mode.
stc.SetEOLMode(wx.stc.STC_EOL_LF) # Unix
# self.SetEOLMode(wx.stc.STC_EOL_CR) # Apple Mac
# self.SetEOLMode(wx.stc.STC_EOL_CRLF) # Windows
# ------------------------------------------------------------------------
# Global styles for all languages.
# ------------------------------------------------------------------------
self.set_style(wx.stc.STC_STYLE_DEFAULT, "#000000", "#ffffff")
self.set_style(wx.stc.STC_STYLE_CONTROLCHAR, "#000000", "#ffffff")
self.set_style(wx.stc.STC_STYLE_BRACELIGHT, "#000000", "#ffffff")
self.set_style(wx.stc.STC_STYLE_BRACEBAD, "#000000", "#ffffff")
# ------------------------------------------------------------------------
# Python styles.
# ------------------------------------------------------------------------
# White space
self.set_style(wx.stc.STC_P_DEFAULT, "#000000", "#ffffff")
# Comment
self.set_style(wx.stc.STC_P_COMMENTLINE, "#007f00", "#ffffff")
# Number
self.set_style(wx.stc.STC_P_NUMBER, "#007f7f", "#ffffff")
# String
self.set_style(wx.stc.STC_P_STRING, "#7f007f", "#ffffff")
# Single quoted string
self.set_style(wx.stc.STC_P_CHARACTER, "#7f007f", "#ffffff")
# Keyword
self.set_style(wx.stc.STC_P_WORD, "#00007f", "#ffffff")
# Triple quotes
self.set_style(wx.stc.STC_P_TRIPLE, "#7f0000", "#ffffff")
# Triple double quotes
self.set_style(wx.stc.STC_P_TRIPLEDOUBLE, "#ff0000", "#ffffff")
# Class name definition
self.set_style(wx.stc.STC_P_CLASSNAME, "#0000ff", "#ffffff")
# Function or method name definition
self.set_style(wx.stc.STC_P_DEFNAME, "#007f7f", "#ffffff")
# Operators
self.set_style(wx.stc.STC_P_OPERATOR, "#000000", "#ffffff")
# Identifiers
self.set_style(wx.stc.STC_P_IDENTIFIER, "#000000", "#ffffff")
# Comment-blocks
self.set_style(wx.stc.STC_P_COMMENTBLOCK, "#007f00", "#ffffff")
# End of line where string is not closed
self.set_style(wx.stc.STC_P_STRINGEOL, "#000000", "#ffffff")
# ------------------------------------------------------------------------
# Events.
# ------------------------------------------------------------------------
# By default, the will fire EVT_STC_CHANGE evented for all mask values
# (STC_MODEVENTMASKALL). This generates too many events.
stc.SetModEventMask(
wx.stc.STC_MOD_INSERTTEXT
| wx.stc.STC_MOD_DELETETEXT
| wx.stc.STC_PERFORMED_UNDO
| wx.stc.STC_PERFORMED_REDO
)
# Listen for changes to the file.
stc.Bind(wx.stc.EVT_STC_CHANGE, self._on_stc_changed)
# Listen for key press events.
stc.Bind(wx.EVT_CHAR, self._on_char)
# Load the editor's contents.
self.load()
return stc
def destroy(self):
""" Destroy the toolkit control. """
if self.control is not None:
self.control.Unbind(wx.stc.EVT_STC_CHANGE)
self.control.Unbind(wx.EVT_CHAR)
super().destroy()
# wx event handlers ----------------------------------------------------
def _on_stc_changed(self, event):
""" Called whenever a change is made to the text of the document. """
self.dirty = True
self.changed = True
# Give other event handlers a chance.
event.Skip()
def _on_char(self, event):
""" Called whenever a change is made to the text of the document. """
self.key_pressed = KeyPressedEvent(
alt_down=event.altDown,
control_down=event.controlDown,
shift_down=event.shiftDown,
key_code=event.KeyCode,
event=event,
)
# Give other event handlers a chance.
event.Skip()
return
|
