-
Notifications
You must be signed in to change notification settings - Fork 65
/
PythonConsole.cpp
384 lines (332 loc) · 10.5 KB
/
PythonConsole.cpp
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
#include "stdafx.h"
#include "WcharMbcsConverter.h"
#include "PythonConsole.h"
#include "ConsoleDialog.h"
#include "PythonHandler.h"
#include "ProcessExecute.h"
#include "PluginInterface.h"
#include "ScintillaWrapper.h"
#include "PythonScript/NppPythonScript.h"
#include "scintilla.h"
#include "GILManager.h"
// Sad, but we need to know if we're in an event handler when running an external command
// Not sure how I can extrapolate this info and not tie PythonConsole and NotepadPlusWrapper together.
#include "NotepadPlusWrapper.h"
namespace NppPythonScript
{
PythonConsole::PythonConsole(HWND hNotepad) :
mp_scintillaWrapper(new ScintillaWrapper(NULL, hNotepad)),
mp_consoleDlg(new ConsoleDialog()),
mp_mainThreadState(NULL),
m_statementRunning(CreateEvent(NULL, FALSE, TRUE, NULL)),
m_hNotepad(hNotepad),
m_consumerStarted(false),
m_runStatementExecuted(false),
m_nppData(new NppData)
{
}
/*
//lint -e1554 Direct pointer copy of member 'name' within copy constructor: 'PythonConsole::PythonConsole(const PythonConsole &)')
// We indeed copy pointers, and it's okay. These are not allocated within the
// scope of this class but rather passed in and copied anyway.
PythonConsole::PythonConsole(const PythonConsole& other) :
PyProducerConsumer<std::string>(other),
ConsoleInterface(other),
mp_scintillaWrapper(other.mp_scintillaWrapper ? new ScintillaWrapper(*other.mp_scintillaWrapper) : NULL),
mp_consoleDlg(other.mp_consoleDlg ? new ConsoleDialog(*other.mp_consoleDlg) : NULL),
m_console(other.m_console),
m_pushFunc(other.m_pushFunc),
m_sys(other.m_sys),
mp_mainThreadState(other.mp_mainThreadState),
m_statementRunning(CreateEvent(NULL, FALSE, TRUE, NULL)),
m_hNotepad(other.m_hNotepad),
m_consumerStarted(other.m_consumerStarted),
m_nppData(other.m_nppData ? new NppData(*other.m_nppData) : NULL)
{
}
//lint +e1554
*/
PythonConsole::~PythonConsole()
{
try
{
delete mp_consoleDlg;
delete m_nppData;
}
catch (...)
{
// I don't know what to do with that, but a destructor should never throw, so...
}
if (m_statementRunning)
{
CloseHandle(m_statementRunning);
m_statementRunning = NULL;
}
// To please Lint, let's NULL these handles and pointers
mp_mainThreadState = NULL;
m_hNotepad = NULL;
}
void PythonConsole::init(HINSTANCE hInst, NppData& nppData)
{
assert(mp_consoleDlg);
assert(m_nppData);
assert(mp_scintillaWrapper);
if (mp_consoleDlg && m_nppData && mp_scintillaWrapper)
{
mp_consoleDlg->initDialog(hInst, nppData, this);
*m_nppData = nppData;
mp_scintillaWrapper->setHandle(mp_consoleDlg->getScintillaHwnd());
}
}
void PythonConsole::initPython(PythonHandler *pythonHandler)
{
try
{
mp_mainThreadState = pythonHandler->getMainThreadState();
GILLock gilLock;
boost::python::object main_module(boost::python::handle<>(boost::python::borrowed(PyImport_AddModule("__main__"))));
boost::python::object main_namespace = main_module.attr("__dict__");
// import code
boost::python::object code = boost::python::import("code");
main_namespace["code"] = code;
// import __main__
main_namespace["__main__"] = main_namespace;
// get ref to code.InteractiveConsole().push()
m_console = eval("code.InteractiveConsole(__main__)", main_namespace, main_namespace);
m_pushFunc = m_console.attr("push");
m_sys = main_namespace["sys"];
}
catch(...)
{
PyErr_Print();
}
}
void PythonConsole::pythonShowDialog()
{
assert(mp_consoleDlg);
GILRelease release;
if (mp_consoleDlg)
{
// Post the message to ourselves (on the right thread) to create the window
if (!mp_consoleDlg->isCreated())
{
CommunicationInfo commInfo;
commInfo.internalMsg = PYSCR_SHOWCONSOLE;
commInfo.srcModuleName = _T("PythonScript.dll");
TCHAR pluginName[] = _T("PythonScript.dll");
::SendMessage(m_hNotepad, NPPM_MSGTOPLUGIN, reinterpret_cast<WPARAM>(pluginName), reinterpret_cast<LPARAM>(&commInfo));
}
else
{
mp_consoleDlg->doDialog();
}
}
}
void PythonConsole::showDialog()
{
assert(mp_consoleDlg);
if (mp_consoleDlg)
{
GILRelease release;
mp_consoleDlg->doDialog();
}
}
void PythonConsole::hideDialog()
{
assert(mp_consoleDlg);
if (mp_consoleDlg)
{
GILRelease release;
mp_consoleDlg->hide();
}
}
void PythonConsole::message(const char *msg)
{
assert(mp_consoleDlg);
if (mp_consoleDlg)
{
GILRelease release;
mp_consoleDlg->writeCmdText(strlen(msg), msg);
}
}
void PythonConsole::clear()
{
assert(mp_consoleDlg);
if (mp_consoleDlg)
{
GILRelease release;
mp_consoleDlg->clearText();
}
}
/** To call this function, you MUST have the GIL
* (it runs the __str__ attribute of the object)
* If you don't, or aren't sure, you can call message() instead, which takes a const char*
*/
void PythonConsole::writeText(boost::python::object text)
{
assert(mp_consoleDlg);
if (mp_consoleDlg)
{
if (PyUnicode_Check(text.ptr()))
{
std::string textToWrite((const char *)boost::python::extract<const char *>(text.attr("__str__")()));
GILRelease release;
if (m_runStatementExecuted)
{
mp_consoleDlg->writeColoredText(textToWrite.size(), textToWrite.c_str());
}
else
{
mp_consoleDlg->writeText(textToWrite.size(), textToWrite.c_str());
}
}
else
{
std::string textToWrite((const char *)boost::python::extract<const char *>(text.attr("__str__")()), _len(text));
GILRelease release;
if (m_runStatementExecuted)
{
mp_consoleDlg->writeColoredText(textToWrite.size(), textToWrite.c_str());
}
else
{
mp_consoleDlg->writeText(textToWrite.size(), textToWrite.c_str());
}
}
}
}
void PythonConsole::writeError(boost::python::object text)
{
assert(mp_consoleDlg);
if (mp_consoleDlg)
{
if (PyUnicode_Check(text.ptr()))
{
std::string textToWrite((const char *)boost::python::extract<const char *>(text.attr("__str__")()));
GILRelease release;
mp_consoleDlg->writeError(textToWrite.size(), textToWrite.c_str());
}
else
{
std::string textToWrite((const char *)boost::python::extract<const char *>(text.attr("__str__")()));
GILRelease release;
mp_consoleDlg->writeError(textToWrite.size(),textToWrite.c_str());
}
}
}
void PythonConsole::stopStatement()
{
DWORD threadID;
CreateThread(NULL, 0, (LPTHREAD_START_ROUTINE)PythonConsole::stopStatementWorker, this, 0, &threadID);
}
DWORD PythonConsole::runCommand(boost::python::str text, boost::python::object pyStdout, boost::python::object pyStderr)
{
ProcessExecute process;
std::shared_ptr<TCHAR> cmdLine = WcharMbcsConverter::char2tchar(boost::python::extract<const char *>(text));
return process.execute(cmdLine.get(), pyStdout, pyStderr, boost::python::object());
}
void PythonConsole::runStatement(const char *statement)
{
assert(mp_consoleDlg);
if (mp_consoleDlg)
{
m_runStatementExecuted = true;
mp_consoleDlg->runEnabled(false);
}
// Console statements executed whilst a script is in progress MUST run on a separate
// thread. Otherwise, we wait for the GIL, no problem, except that that blocks the UI thread
// so if the script happens to be sending a message to scintilla (likely), then
// it will deadlock.
// PyProducerConsumer used here to keep one thread running the actual statements
if (!m_consumerStarted)
{
m_consumerStarted = true;
startConsumer();
}
produce(std::shared_ptr<std::string>(new std::string(statement)));
}
void PythonConsole::queueComplete()
{
assert(mp_consoleDlg);
if (mp_consoleDlg)
{
mp_consoleDlg->runEnabled(true);
m_runStatementExecuted = false;
}
}
void PythonConsole::consume(std::shared_ptr<std::string> statement)
{
bool continuePrompt = false;
{
GILLock gilLock;
try
{
boost::python::object oldStdout = m_sys.attr("stdout");
m_sys.attr("stdout") = boost::python::ptr(this);
boost::python::object result = m_pushFunc(boost::python::str(statement->c_str()));
//Py_DECREF(unicodeCommand);
m_sys.attr("stdout") = oldStdout;
continuePrompt = boost::python::extract<bool>(result);
}
catch(...)
{
PyErr_Print();
}
}
assert(mp_consoleDlg);
if (mp_consoleDlg)
{
mp_consoleDlg->setPrompt(continuePrompt ? mp_consoleDlg->getContinuePrompt() : mp_consoleDlg->getStandardPrompt());
mp_consoleDlg->giveInputFocus();
}
}
void PythonConsole::stopStatementWorker(PythonConsole *console)
{
GILLock gilLock;
PyThreadState_SetAsyncExc((long)console->getConsumerThreadID(), PyExc_KeyboardInterrupt);
}
void export_console()
{
//lint -e1793 While calling Symbol: Initializing the implicit object parameter Type (a non-const reference) with a non-lvalue
// The class and enum declarations are used as designed, but they mess up Lint.
boost::python::class_<PythonConsole, boost::shared_ptr<PythonConsole>, boost::noncopyable >("Console", boost::python::no_init)
.def("write", &PythonConsole::writeText, "Writes text to the console. Uses the __str__ function of the object passed.")
.def("clear", &PythonConsole::clear, "Clears the console window")
.def("writeError", &PythonConsole::writeError, "Writes text in the console in a red colour")
.def("show", &PythonConsole::pythonShowDialog, "Shows the console")
.def("hide", &PythonConsole::hideDialog, "Hides the console")
.def("run", &PythonConsole::runCommand, "Runs a command on the console")
.def("run", &PythonConsole::runCommandNoStderr, "Runs a command on the console")
.def("run", &PythonConsole::runCommandNoStdout, "Runs a command on the console")
.add_static_property("encoding", &PythonConsole::getEncoding)
.add_property("editor", &PythonConsole::getScintillaWrapper);
//lint +e1793
}
void PythonConsole::openFile(const char *filename, idx_t lineNo)
{
std::shared_ptr<TCHAR> tFilename = WcharMbcsConverter::char2tchar(filename);
if (!SendMessage(m_hNotepad, NPPM_SWITCHTOFILE, 0, reinterpret_cast<LPARAM>(tFilename.get())))
{
SendMessage(m_hNotepad, NPPM_DOOPEN, 0, reinterpret_cast<LPARAM>(tFilename.get()));
}
if (lineNo != IDX_MAX)
{
int currentView;
SendMessage(m_hNotepad, NPPM_GETCURRENTSCINTILLA, 0, reinterpret_cast<LPARAM>(¤tView));
assert(m_nppData);
if (m_nppData)
{
SendMessage(currentView ? m_nppData->_scintillaSecondHandle : m_nppData->_scintillaMainHandle, SCI_GOTOLINE, lineNo, 0);
}
}
}
HWND PythonConsole::getScintillaHwnd()
{
assert(mp_consoleDlg);
if (mp_consoleDlg)
{
return mp_consoleDlg->getScintillaHwnd();
}
return NULL;
}
}