pqPythonEventSource.cxx 11.5 KB
Newer Older
Clinton Stimpson's avatar
 
Clinton Stimpson committed
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
/*=========================================================================

   Program: ParaView
   Module:    pqPythonEventSource.cxx

   Copyright (c) 2005,2006 Sandia Corporation, Kitware Inc.
   All rights reserved.

   ParaView is a free software; you can redistribute it and/or modify it
   under the terms of the ParaView license version 1.1. 

   See License_v1.1.txt for the full ParaView license.
   A copy of this license can be obtained by contacting
   Kitware Inc.
   28 Corporate Drive
   Clifton Park, NY 12065
   USA

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

=========================================================================*/

// python header first
Clinton Stimpson's avatar
   
Clinton Stimpson committed
34
35
// TODO:  Fix this so we don't depend on VTK
#include "vtkPython.h"
Clinton Stimpson's avatar
   
Clinton Stimpson committed
36
37
38
#ifndef PyMODINIT_FUNC
#define PyMODINIT_FUNC extern "C" void
#endif // PyMODINIT_FUNC
Clinton Stimpson's avatar
 
Clinton Stimpson committed
39
40
41
42

// self include
#include "pqPythonEventSource.h"

43
44
45
// system includes
#include <signal.h>

Clinton Stimpson's avatar
 
Clinton Stimpson committed
46
47
48
49
50
51
52
// Qt include
#include <QVariant>
#include <QFile>
#include <QtDebug>
#include <QMutex>
#include <QCoreApplication>
#include <QEvent>
53
54
55
#include <QStringList>
#include <QThread>
#include <QApplication>
Clinton Stimpson's avatar
 
Clinton Stimpson committed
56
57
58

// Qt testing includes
#include "pqObjectNaming.h"
Clinton Stimpson's avatar
Clinton Stimpson committed
59
#include "pqWidgetEventPlayer.h"
Clinton Stimpson's avatar
   
Clinton Stimpson committed
60
#include "pqEventDispatcher.h"
Clinton Stimpson's avatar
 
Clinton Stimpson committed
61
62
63
64
65
66


// TODO not have a global instance pointer?
static pqPythonEventSource* Instance = NULL;
static QString PropertyObject;
static QString PropertyResult;
67
static QString PropertyValue;
68
static QStringList ObjectList;
Clinton Stimpson's avatar
 
Clinton Stimpson committed
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88


static PyObject*
QtTesting_playCommand(PyObject* /*self*/, PyObject* args)
{
  // void QtTesting.playCommand('object', 'command', 'arguments')
  //   an exception is thrown in this fails
  
  const char* object = 0;
  const char* command = 0;
  const char* arguments = 0;

  if(!PyArg_ParseTuple(args, const_cast<char*>("sss"), &object, &command, &arguments))
    {
    PyErr_SetString(PyExc_TypeError, "bad arguments to playCommand()");
    return NULL;
    }

  if(Instance)
    {
Clinton Stimpson's avatar
   
Clinton Stimpson committed
89
90
91
92
93
    if(!Instance->postNextEvent(object, command, arguments))
      {
      PyErr_SetString(PyExc_AssertionError, "error processing event");
      return NULL;
      }
Clinton Stimpson's avatar
 
Clinton Stimpson committed
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
    }
  else
    {
    PyErr_SetString(PyExc_AssertionError, "pqPythonEventSource not defined");
    return NULL;
    }

  return Py_BuildValue(const_cast<char*>(""));
}

static PyObject*
QtTesting_getProperty(PyObject* /*self*/, PyObject* args)
{
  // string QtTesting.getProperty('object', 'property')
  //    returns the string value of the property
  
  const char* object = 0;
  const char* property = 0;

  if(!PyArg_ParseTuple(args, const_cast<char*>("ss"), &object, &property))
    {
    return NULL;
    }

118
119
120
121
122
123
124
125
  PropertyObject = object;
  PropertyResult = property;

  if(Instance && QThread::currentThread() != QApplication::instance()->thread())
    {
    QMutex mut;
    mut.lock();
    QMetaObject::invokeMethod(Instance, "threadGetProperty", Qt::QueuedConnection);
Clinton Stimpson's avatar
   
Clinton Stimpson committed
126
127
128
129
130
    if(!Instance->waitForGUI(mut))
      {
      PyErr_SetString(PyExc_ValueError, "error getting property");
      return NULL;
      }
131
132
133
134
135
136
    }
  else if(QThread::currentThread() == QApplication::instance()->thread())
    {
    PropertyResult = pqPythonEventSource::getProperty(PropertyObject, PropertyResult);
    }
  else
Clinton Stimpson's avatar
 
Clinton Stimpson committed
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
    {
    PyErr_SetString(PyExc_AssertionError, "pqPythonEventSource not defined");
    return NULL;
    }

  if(PropertyObject == QString::null)
    {
    PyErr_SetString(PyExc_ValueError, "object not found");
    return NULL;
    }

  return Py_BuildValue(const_cast<char*>("s"), 
             PropertyResult.toAscii().data());
}

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
static PyObject*
QtTesting_setProperty(PyObject* /*self*/, PyObject* args)
{
  // string QtTesting.setProperty('object', 'property', 'value')
  //    returns the string value of the property
  
  const char* object = 0;
  const char* property = 0;
  const char* value = 0;

  if(!PyArg_ParseTuple(args, const_cast<char*>("ss"), &object, 
                                                      &property, &value))
    {
    return NULL;
    }

  PropertyObject = object;
  PropertyResult = property;
  PropertyValue = value;

  if(Instance && QThread::currentThread() != QApplication::instance()->thread())
    {
    QMutex mut;
    mut.lock();
    QMetaObject::invokeMethod(Instance, "threadSetProperty", Qt::QueuedConnection);
Clinton Stimpson's avatar
   
Clinton Stimpson committed
177
178
179
180
181
    if(!Instance->waitForGUI(mut))
      {
      PyErr_SetString(PyExc_ValueError, "error setting property");
      return NULL;
      }
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
    }
  else if(QThread::currentThread() == QApplication::instance()->thread())
    {
    pqPythonEventSource::setProperty(PropertyObject, 
                                     PropertyResult,
                                     PropertyValue);
    }
  else
    {
    PyErr_SetString(PyExc_AssertionError, "pqPythonEventSource not defined");
    return NULL;
    }

  if(PropertyObject == QString::null)
    {
    PyErr_SetString(PyExc_ValueError, "object not found");
    return NULL;
    }

  if(PropertyResult == QString::null)
    {
    PyErr_SetString(PyExc_ValueError, "property not found");
    return NULL;
    }

  return Py_BuildValue(const_cast<char*>("s"), "");
}

Clinton Stimpson's avatar
   
Clinton Stimpson committed
210
211
212
213
214
215
216
217
218
219
220
221
static PyObject*
QtTesting_wait(PyObject* /*self*/, PyObject* args)
{
  // void QtTesting.wait(msec)
  
  int ms = 0;

  if(!PyArg_ParseTuple(args, const_cast<char*>("i"), &ms))
    {
    PyErr_SetString(PyExc_TypeError, "bad arguments to wait(msec)");
    return NULL;
    }
Clinton Stimpson's avatar
Clinton Stimpson committed
222

Clinton Stimpson's avatar
   
Clinton Stimpson committed
223
  pqEventDispatcher::processEventsAndWait(ms);
Clinton Stimpson's avatar
   
Clinton Stimpson committed
224
225
226
227
228
229
230
231
232
233
234
235
236

  return Py_BuildValue(const_cast<char*>(""));
}

static PyObject*
QtTesting_getQtVersion(PyObject* /*self*/, PyObject* /*args*/)
{
  // string QtTesting.getQtVersion()
  //    returns the Qt version as a string
  
  return Py_BuildValue(const_cast<char*>("s"), qVersion());
}

237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258

static PyObject*
QtTesting_getChildren(PyObject* /*self*/, PyObject* args)
{
  // string QtTesting.getChildren('object')
  //    returns the a list of strings with object names
  
  const char* object = 0;

  if(!PyArg_ParseTuple(args, const_cast<char*>("s"), &object))
    {
    return NULL;
    }

  PropertyObject = object;
  ObjectList.clear();

  if(Instance && QThread::currentThread() != QApplication::instance()->thread())
    {
    QMutex mut;
    mut.lock();
    QMetaObject::invokeMethod(Instance, "threadGetChildren", Qt::QueuedConnection);
Clinton Stimpson's avatar
   
Clinton Stimpson committed
259
260
261
262
263
    if(!Instance->waitForGUI(mut))
      {
      PyErr_SetString(PyExc_ValueError, "error getting children");
      return NULL;
      }
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
    }
  else if(QThread::currentThread() == QApplication::instance()->thread())
    {
    ObjectList = pqPythonEventSource::getChildren(PropertyObject);
    }
  else
    {
    PyErr_SetString(PyExc_AssertionError, "pqPythonEventSource not defined");
    return NULL;
    }

  if(PropertyObject == QString::null)
    {
    PyErr_SetString(PyExc_ValueError, "object not found");
    return NULL;
    }

  QString objs = ObjectList.join(", ");
  QString ret = QString("[%1]").arg(objs);

  return Py_BuildValue(const_cast<char*>("s"), 
             ret.toAscii().data());
}


Clinton Stimpson's avatar
 
Clinton Stimpson committed
289
290
291
292
293
294
295
296
297
298
299
300
301
static PyMethodDef QtTestingMethods[] = {
  {
    const_cast<char*>("playCommand"), 
    QtTesting_playCommand,
    METH_VARARGS,
    const_cast<char*>("Play a test command.")
  },
  {
    const_cast<char*>("getProperty"),
    QtTesting_getProperty,
    METH_VARARGS,
    const_cast<char*>("Get a property of an object.")
  },
302
303
304
305
306
307
308
  {
    const_cast<char*>("setProperty"),
    QtTesting_setProperty,
    METH_VARARGS,
    const_cast<char*>("Set a property of an object.")
  },

Clinton Stimpson's avatar
   
Clinton Stimpson committed
309
310
311
312
313
314
315
316
317
318
319
320
321
  {
    const_cast<char*>("getQtVersion"),
    QtTesting_getQtVersion,
    METH_VARARGS,
    const_cast<char*>("Get the version of Qt being used.")
  },
  {
    const_cast<char*>("wait"),
    QtTesting_wait,
    METH_VARARGS,
    const_cast<char*>("Have the python script wait for a specfied number"
                      " of msecs, while the Qt app is alive.")
  },
322
323
324
325
326
327
  {
    const_cast<char*>("getChildren"),
    QtTesting_getChildren,
    METH_VARARGS,
    const_cast<char*>("Return a list of child objects.")
  },
Clinton Stimpson's avatar
 
Clinton Stimpson committed
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345

  {NULL, NULL, 0, NULL} // Sentinal
};

PyMODINIT_FUNC
initQtTesting(void)
{
  Py_InitModule(const_cast<char*>("QtTesting"), QtTestingMethods);
}


class pqPythonEventSource::pqInternal
{
public:
  QString FileName;
  PyThreadState* MainThreadState;
};

Clinton Stimpson's avatar
   
Clinton Stimpson committed
346
347
pqPythonEventSource::pqPythonEventSource(QObject* p)
  : pqThreadedEventSource(p)
Clinton Stimpson's avatar
 
Clinton Stimpson committed
348
349
{
  this->Internal = new pqInternal;
350
351
352
353
354
  int initPy = Py_IsInitialized();
  if(!initPy)
    {
    // initialize python
    Py_Initialize();
355
#ifdef SIGINT
356
    signal(SIGINT, SIG_DFL);
357
#endif
358
    }
359
360
361
362
  PyEval_InitThreads();

  // add QtTesting to python's inittab, so it is
  // available to all interpreters
Clinton Stimpson's avatar
Clinton Stimpson committed
363
  PyImport_AppendInittab(const_cast<char*>("QtTesting"), initQtTesting);
Clinton Stimpson's avatar
 
Clinton Stimpson committed
364
365
366
367
368
369
370
371
372
373
374
375
376
377
}

pqPythonEventSource::~pqPythonEventSource()
{
  delete this->Internal;
}

void pqPythonEventSource::setContent(const QString& path)
{
  // start the python thread
  this->Internal->FileName = path;
  this->start();
}
  
378
QString pqPythonEventSource::getProperty(QString& object, const QString& prop)
Clinton Stimpson's avatar
 
Clinton Stimpson committed
379
{
Clinton Stimpson's avatar
   
Clinton Stimpson committed
380
381
  // ensure other tasks have been completed
  QCoreApplication::processEvents();
382
  QVariant ret;
Clinton Stimpson's avatar
   
Clinton Stimpson committed
383

384
  QObject* qobject = pqObjectNaming::GetObject(object);
385
386
  if(!qobject)
    {
387
    object = QString::null;
388
389
    }
  else
Clinton Stimpson's avatar
 
Clinton Stimpson committed
390
    {
391
    ret = qobject->property(prop.toAscii().data()).toString();
Clinton Stimpson's avatar
 
Clinton Stimpson committed
392
    }
393
394
395
396
397

  return ret.toString();

}

398

399
400
401
void pqPythonEventSource::threadGetProperty()
{
  PropertyResult = this->getProperty(PropertyObject, PropertyResult);
Clinton Stimpson's avatar
   
Clinton Stimpson committed
402
  this->guiAcknowledge();
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

void pqPythonEventSource::setProperty(QString& object, QString& prop, 
                                      const QString& value)
{
  // ensure other tasks have been completed
  QCoreApplication::processEvents();
  QVariant ret;

  QObject* qobject = pqObjectNaming::GetObject(object);
  if(!qobject)
    {
    object = QString::null;
    }
  else
    {
    if(!qobject->setProperty(prop.toAscii().data(), value))
      {
      prop = QString::null;
      }
    }
}

void pqPythonEventSource::threadSetProperty()
{
  this->setProperty(PropertyObject, PropertyResult, PropertyValue);
Clinton Stimpson's avatar
   
Clinton Stimpson committed
430
  this->guiAcknowledge();
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
QStringList pqPythonEventSource::getChildren(QString& object)
{
  // ensure other tasks have been completed
  QCoreApplication::processEvents();
  QStringList ret;

  QObject* qobject = pqObjectNaming::GetObject(object);
  if(!qobject)
    {
    object = QString::null;
    }
  else
    {
    const QObjectList& children = qobject->children();
    foreach(QObject* child, children)
      {
      ret.append(pqObjectNaming::GetName(*child));
      }
    }
  return ret;
}


void pqPythonEventSource::threadGetChildren()
{
  ObjectList = this->getChildren(PropertyObject);
Clinton Stimpson's avatar
   
Clinton Stimpson committed
460
  this->guiAcknowledge();
Clinton Stimpson's avatar
 
Clinton Stimpson committed
461
462
463
464
}

void pqPythonEventSource::run()
{
465
466
467
468
469
470
  QFile file(this->Internal->FileName);
  if(!file.open(QFile::ReadOnly | QFile::Text))
    {
    printf("Unable to open python script\n");
    return;
    } 
Clinton Stimpson's avatar
   
Clinton Stimpson committed
471

472
  PyThreadState* threadState = Py_NewInterpreter();
Clinton Stimpson's avatar
 
Clinton Stimpson committed
473
474
475
476
  
  Instance = this;

  // finally run the script
477
478
  QByteArray wholeFile = file.readAll();
  int result = PyRun_SimpleString(wholeFile.data()) == 0 ? 0 : 1;
Clinton Stimpson's avatar
 
Clinton Stimpson committed
479
  
480
  Py_EndInterpreter(threadState);
Clinton Stimpson's avatar
 
Clinton Stimpson committed
481
  
Clinton Stimpson's avatar
   
Clinton Stimpson committed
482
  this->done(result);
Clinton Stimpson's avatar
 
Clinton Stimpson committed
483
484
}