pqEventDispatcher.cxx 11.4 KB
Newer Older
1 2 3 4 5
/*=========================================================================

   Program: ParaView
   Module:    pqEventDispatcher.cxx

6
   Copyright (c) 2005-2008 Sandia Corporation, Kitware Inc.
7 8 9
   All rights reserved.

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

12
   See License_v1.2.txt for the full ParaView license.
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
   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.

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

33 34
#include "pqEventDispatcher.h"

35 36 37 38 39
#include "pqEventPlayer.h"
#include "pqEventSource.h"

#include <QAbstractEventDispatcher>
#include <QtDebug>
40
#include <QApplication>
41
#include <QEventLoop>
42
#include <QThread>
43 44
#include <QDialog>
#include <QMainWindow>
45 46 47
#include <QList>
#include <QPointer>
#include <QTimer>
48

49 50
#include <iostream>
using namespace std;
51

52
//-----------------------------------------------------------------------------
53 54 55
namespace
{
  static QList<QPointer<QTimer> > RegisteredTimers;
56
  
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71
  void processTimers()
    {
    foreach (QTimer* timer, RegisteredTimers)
      {
      if (timer && timer->isActive())
        {
        QTimerEvent event(timer->timerId());
        qApp->notify(timer, &event);
        }
      }
    }

  static int EventPlaybackDelay = QT_TESTING_EVENT_PLAYBACK_DELAY;
};

72
bool pqEventDispatcher::DeferMenuTimeouts = false;
73
bool pqEventDispatcher::DeferEventsIfBlocked = false;
74

75 76 77
//-----------------------------------------------------------------------------
pqEventDispatcher::pqEventDispatcher(QObject* parentObject) :
  Superclass(parentObject)
78
{
79 80
  this->ActiveSource = NULL;
  this->ActivePlayer = NULL;
81 82 83 84

  this->PlayingBlockingEvent = false;

  this->PlayBackStatus = true;
85
  this->PlayBackFinished = false;
86 87 88
  this->PlayBackPaused = false;
  this->PlayBackOneStep = false;
  this->PlayBackStoped = false;
89

90 91 92
#ifdef __APPLE__
  this->BlockTimer.setInterval(1000);
#else
93
  this->BlockTimer.setInterval(100);
94
#endif
95 96 97
  this->BlockTimer.setSingleShot(true);
  QObject::connect(&this->BlockTimer, SIGNAL(timeout()),
                   this, SLOT(playEventOnBlocking()));
98 99
}

100
//-----------------------------------------------------------------------------
101 102 103 104
pqEventDispatcher::~pqEventDispatcher()
{
}

105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126

//-----------------------------------------------------------------------------
void pqEventDispatcher::setEventPlaybackDelay(int milliseconds)
{
  EventPlaybackDelay = (milliseconds <= 0)? 0 : milliseconds;
}

//-----------------------------------------------------------------------------
int pqEventDispatcher::eventPlaybackDelay()
{
  return EventPlaybackDelay;
}

//-----------------------------------------------------------------------------
void pqEventDispatcher::registerTimer(QTimer* timer)
{
  if (timer)
    {
    RegisteredTimers.push_back(timer);
    }
}

127
//-----------------------------------------------------------------------------
128
void pqEventDispatcher::deferEventsIfBlocked(bool enable)
129
{
130
  pqEventDispatcher::DeferEventsIfBlocked = enable;
131 132
}

133

134 135 136
//-----------------------------------------------------------------------------
void pqEventDispatcher::aboutToBlock()
{
137
  // if (!pqEventDispatcher::DeferMenuTimeouts)
138 139 140
    {
    if (!this->BlockTimer.isActive())
      {
141
      // cout << "aboutToBlock" << endl;
142 143 144 145 146 147 148 149 150
      // Request a delayed playback for an event.
      this->BlockTimer.start();
      }
    }
}

//-----------------------------------------------------------------------------
void pqEventDispatcher::awake()
{
151 152 153 154 155
  //if (!pqEventDispatcher::DeferMenuTimeouts)
  //  {
  //  // cout << "awake" << endl;
  //  // this->BlockTimer.stop();
  //  }
156 157
}

158 159 160
//-----------------------------------------------------------------------------
void pqEventDispatcher::setTimeStep(int value)
{
161
  EventPlaybackDelay = value;
162 163 164
}

//-----------------------------------------------------------------------------
165
void pqEventDispatcher::run(bool value)
166
{
167 168 169 170 171 172 173 174 175
  this->PlayBackPaused = !value;
  if (value)
    {
    emit this->restarted();
    }
  else
    {
    emit this->paused();
    }
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
}

//-----------------------------------------------------------------------------
void pqEventDispatcher::stop()
{
  this->PlayBackPaused = false;
  this->PlayBackFinished = true;
}

//-----------------------------------------------------------------------------
bool pqEventDispatcher::isPaused() const
{
  return this->PlayBackPaused;
}

//-----------------------------------------------------------------------------
bool pqEventDispatcher::status() const
{
  return this->PlayBackStatus;
}

//-----------------------------------------------------------------------------
void pqEventDispatcher::oneStep()
{
  this->PlayBackOneStep = true;
}

203
//-----------------------------------------------------------------------------
204
bool pqEventDispatcher::playEvents(pqEventSource& source, pqEventPlayer& player)
205
{
206
  if (this->ActiveSource || this->ActivePlayer)
207 208
    {
    qCritical() << "Event dispatcher is already playing";
209
    return false;
210 211
    }

212 213 214
  this->ActiveSource = &source;
  this->ActivePlayer = &player;

215
  QApplication::setEffectEnabled(Qt::UI_General, false);
216

217 218 219 220 221
  QObject::connect(QAbstractEventDispatcher::instance(), SIGNAL(aboutToBlock()),
                   this, SLOT(aboutToBlock()));
  QObject::connect(QAbstractEventDispatcher::instance(), SIGNAL(awake()),
                   this, SLOT(awake()));

222 223 224 225 226 227 228 229 230 231 232
  // This is how the playback logic works:
  // * In here, we continuously keep on playing one event after another until
  //   we are done processing all the events.
  // * If a modal dialog pops up, then this->aboutToBlock() gets called. To me
  //   accurate, aboutToBlock() is called everytime the sub-event loop is entered
  //   and more modal dialogs that loop is entered after processing of each event
  //   (not merely when the dialog pops up).
  // * In this->aboutToBlock() we start a timer which on timeout processes just 1 event.
  // * After executing that event, if the dialog still is up, them aboutToBlock() will
  //   be called again and the cycle continues. If not, the control returns to this main
  //   playback loop, and it continues.
233 234
  this->PlayBackStatus = true; // success.
  this->PlayBackFinished = false;
235 236
  while (!this->PlayBackFinished)
    {
237 238
    if(!this->PlayBackPaused)
      {
239
    //cerr << "=== playEvent(1) ===" << endl;
240 241
    this->playEvent();
    }
242 243 244 245 246 247 248 249 250 251 252 253
    else
      {
      if (this->PlayBackOneStep)
        {
        this->PlayBackOneStep = false;
        this->playEvent();
        }
      else
        {
        this->processEventsAndWait(100);
        }
      }
254
    }
255 256
  this->ActiveSource = NULL;
  this->ActivePlayer = NULL;
257 258 259 260 261 262

  QObject::disconnect(QAbstractEventDispatcher::instance(), SIGNAL(aboutToBlock()),
                   this, SLOT(aboutToBlock()));
  QObject::disconnect(QAbstractEventDispatcher::instance(), SIGNAL(awake()),
                   this, SLOT(awake()));

263
  return this->PlayBackStatus;
264
}
265

266
//-----------------------------------------------------------------------------
267
void pqEventDispatcher::playEventOnBlocking()
268
{
269 270 271 272 273 274
//  if(this->PlayingBlockingEvent)
//    {
//    qDebug() << "Event blocking already playing ....";
//    return;
//    }

275
  if (pqEventDispatcher::DeferMenuTimeouts || pqEventDispatcher::DeferEventsIfBlocked)
276
    {
277
    //cerr << "=== playEventOnBlocking ===" << endl;
278 279 280 281
    this->BlockTimer.start();
    return;
    }

282 283
  //cout << "---blocked event: " << endl;
  // if needed for debugging, I can print blocking annotation here.
284
  //cerr << "=== playEvent(2) ===" << endl;
285
  this->playEvent(1);
286

287 288 289 290
  //if (!this->BlockTimer.isActive())
  //  {
  //  this->BlockTimer.start();
  //  }
291
  this->PlayingBlockingEvent = false;
292
}
293

294
//-----------------------------------------------------------------------------
295
void pqEventDispatcher::playEvent(int indent)
296 297
{
  this->BlockTimer.stop();
298
  if (this->PlayBackFinished)
299
    {
300
    return;
301
    }
302

303
  if (!this->ActiveSource)
304
    {
305 306 307
    this->PlayBackFinished = true;
    this->PlayBackStatus = false; // failure.
    qCritical("Internal error: playEvent called without a valid event source.");
308 309 310
    return;
    }

311 312 313
  QString object;
  QString command;
  QString arguments;
314
  
315 316
  int result = this->ActiveSource->getNextEvent(object, command, arguments);
  if (result == pqEventSource::DONE)
317
    {
318
    this->PlayBackFinished = true;
319 320
    return;
    }
321 322
  else if(result == pqEventSource::FAILURE)
    {
323 324
    this->PlayBackFinished = true;
    this->PlayBackStatus = false; // failure.
325 326
    return;
    }
327
    
328 329 330 331
  static unsigned long counter=0;
  unsigned long local_counter = counter++;
  QString pretty_name = object.mid(object.lastIndexOf('/'));
  bool print_debug = getenv("PV_DEBUG_TEST") != NULL;
332
#if defined(WIN32) || defined(__APPLE__) // temporary debugging on both platforms.
333 334
  print_debug = true;
#endif
335 336
  if (print_debug)
    {
337 338
    cout <<  QTime::currentTime().toString("hh:mm:ss").toStdString().c_str()
         << " : "
339 340 341 342 343
         << QString().fill(' ', 4*indent).toStdString().c_str()
         << local_counter << ": Test (" << indent << "): "
         << pretty_name.toStdString().c_str() << ": "
         << command.toStdString().c_str() << " : "
         << arguments.toStdString().c_str() << endl;
344 345
    }

346
  bool error = false;
347
  this->ActivePlayer->playEvent(object, command, arguments, error);
348
  this->BlockTimer.stop();
349 350 351 352 353 354 355 356

  // process any posted events. We call processEvents() so that any slots
  // connected using QueuedConnection also get handled.
  this->processEventsAndWait(EventPlaybackDelay);

  // We explicitly timeout timers that have been registered with us.
  processTimers();

357
  this->BlockTimer.stop();
358

359 360
  if (print_debug)
    {
361 362
    cout << QTime::currentTime().toString("hh:mm:ss").toStdString().c_str()
         << " : "
363 364
         << QString().fill(' ', 4*indent).toStdString().c_str()
         << local_counter << ": Done" << endl;
365
    }
366

367 368 369 370 371 372
  if (error)
    {
    this->PlayBackStatus  = false;
    this->PlayBackFinished = true;
    return;
    }
373

374 375
}

376
//-----------------------------------------------------------------------------
377
void pqEventDispatcher::processEventsAndWait(int ms)
378
{
379 380
  bool prev = pqEventDispatcher::DeferMenuTimeouts;
  pqEventDispatcher::DeferMenuTimeouts = true;
381 382
  if (ms > 0)
    {
383
//    ms = (ms < 100) ? 100 : ms;
384
    QApplication::processEvents();
385 386
    QEventLoop loop;
    QTimer::singleShot(ms, &loop, SLOT(quit()));
387
    loop.exec();
388
    }
389
  QApplication::processEvents();
390 391
  QApplication::sendPostedEvents();
  QApplication::processEvents();
392
  pqEventDispatcher::DeferMenuTimeouts = prev;
393
}
394 395 396 397 398 399 400 401 402

//-----------------------------------------------------------------------------
void pqEventDispatcher::processEvents(QEventLoop::ProcessEventsFlags flags)
{
  bool prev = pqEventDispatcher::DeferMenuTimeouts;
  pqEventDispatcher::DeferMenuTimeouts = true;
  QApplication::processEvents(flags);
  pqEventDispatcher::DeferMenuTimeouts = prev;
}