pqEventDispatcher.cxx 11.1 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.

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

Clinton Stimpson's avatar
 
Clinton Stimpson committed
33 34
#include "pqEventDispatcher.h"

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

#include <QAbstractEventDispatcher>
#include <QtDebug>
Clinton Stimpson's avatar
 
Clinton Stimpson committed
40
#include <QApplication>
Clinton Stimpson's avatar
 
Clinton Stimpson committed
41
#include <QEventLoop>
Clinton Stimpson's avatar
 
Clinton Stimpson committed
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 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
namespace
{
  static QList<QPointer<QTimer> > RegisteredTimers;
  
  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;
};

71
bool pqEventDispatcher::DeferMenuTimeouts = false;
72 73 74
//-----------------------------------------------------------------------------
pqEventDispatcher::pqEventDispatcher(QObject* parentObject) :
  Superclass(parentObject)
75
{
76 77
  this->ActiveSource = NULL;
  this->ActivePlayer = NULL;
78 79 80 81

  this->PlayingBlockingEvent = false;

  this->PlayBackStatus = true;
82
  this->PlayBackFinished = false;
83 84 85 86
  this->PlayBackPaused = false;
  this->PlayBackOneStep = false;
  this->PlayBackStoped = false;
  this->TimeStep = 1;
87

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

98
//-----------------------------------------------------------------------------
99 100 101 102
pqEventDispatcher::~pqEventDispatcher()
{
}

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

//-----------------------------------------------------------------------------
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);
    }
}

125 126 127
//-----------------------------------------------------------------------------
void pqEventDispatcher::aboutToBlock()
{
128
  // if (!pqEventDispatcher::DeferMenuTimeouts)
129 130 131
    {
    if (!this->BlockTimer.isActive())
      {
132
      // cout << "aboutToBlock" << endl;
133 134 135 136 137 138 139 140 141
      // Request a delayed playback for an event.
      this->BlockTimer.start();
      }
    }
}

//-----------------------------------------------------------------------------
void pqEventDispatcher::awake()
{
142 143 144 145 146
  //if (!pqEventDispatcher::DeferMenuTimeouts)
  //  {
  //  // cout << "awake" << endl;
  //  // this->BlockTimer.stop();
  //  }
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
//-----------------------------------------------------------------------------
void pqEventDispatcher::setTimeStep(int value)
{
  this->TimeStep = value;
}

//-----------------------------------------------------------------------------
void pqEventDispatcher::pause()
{
  this->PlayBackPaused = true;
  emit this->paused();
}

//-----------------------------------------------------------------------------
void pqEventDispatcher::restart()
{
  this->PlayBackPaused = false;
  emit this->restarted();
}

//-----------------------------------------------------------------------------
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;
}

194
//-----------------------------------------------------------------------------
195
bool pqEventDispatcher::playEvents(pqEventSource& source, pqEventPlayer& player)
196
{
197
  if (this->ActiveSource || this->ActivePlayer)
198 199
    {
    qCritical() << "Event dispatcher is already playing";
200
    return false;
201 202
    }

203 204 205
  this->ActiveSource = &source;
  this->ActivePlayer = &player;

206
  QApplication::setEffectEnabled(Qt::UI_General, false);
Clinton Stimpson's avatar
 
Clinton Stimpson committed
207

208 209 210 211 212
  QObject::connect(QAbstractEventDispatcher::instance(), SIGNAL(aboutToBlock()),
                   this, SLOT(aboutToBlock()));
  QObject::connect(QAbstractEventDispatcher::instance(), SIGNAL(awake()),
                   this, SLOT(awake()));

213 214 215 216 217 218 219 220 221 222 223
  // 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.
224 225
  this->PlayBackStatus = true; // success.
  this->PlayBackFinished = false;
226 227
  while (!this->PlayBackFinished)
    {
228
//    qDebug() << "while Loop";
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
    if(!this->PlayBackPaused)
      {
      this->playEvent();
      }
    else
      {
      if (this->PlayBackOneStep)
        {
        this->PlayBackOneStep = false;
        this->playEvent();
        }
      else
        {
        this->processEventsAndWait(100);
        }
      }
245
    }
246 247
  this->ActiveSource = NULL;
  this->ActivePlayer = NULL;
248 249 250 251 252 253

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

254
  qDebug() << "About to Stop Dispatcher";
255
  return this->PlayBackStatus;
256
}
Clinton Stimpson's avatar
 
Clinton Stimpson committed
257

258
//-----------------------------------------------------------------------------
259
void pqEventDispatcher::playEventOnBlocking()
Clinton Stimpson's avatar
 
Clinton Stimpson committed
260
{
261 262 263 264 265 266
//  if(this->PlayingBlockingEvent)
//    {
//    qDebug() << "Event blocking already playing ....";
//    return;
//    }

267 268 269 270 271 272
  if (pqEventDispatcher::DeferMenuTimeouts)
    {
    this->BlockTimer.start();
    return;
    }

273 274
  //cout << "---blocked event: " << endl;
  // if needed for debugging, I can print blocking annotation here.
275
  this->playEvent(1);
276

277 278 279 280
  //if (!this->BlockTimer.isActive())
  //  {
  //  this->BlockTimer.start();
  //  }
281
  this->PlayingBlockingEvent = false;
282
}
Clinton Stimpson's avatar
 
Clinton Stimpson committed
283

284
//-----------------------------------------------------------------------------
285
void pqEventDispatcher::playEvent(int indent)
286 287
{
  this->BlockTimer.stop();
288
  if (this->PlayBackFinished)
Clinton Stimpson's avatar
 
Clinton Stimpson committed
289
    {
290
    return;
Clinton Stimpson's avatar
 
Clinton Stimpson committed
291
    }
292

293
  if (!this->ActiveSource)
Clinton Stimpson's avatar
 
Clinton Stimpson committed
294
    {
295 296 297
    this->PlayBackFinished = true;
    this->PlayBackStatus = false; // failure.
    qCritical("Internal error: playEvent called without a valid event source.");
Clinton Stimpson's avatar
 
Clinton Stimpson committed
298 299 300
    return;
    }

301 302 303
  QString object;
  QString command;
  QString arguments;
Clinton Stimpson's avatar
 
Clinton Stimpson committed
304
  
305 306
  int result = this->ActiveSource->getNextEvent(object, command, arguments);
  if (result == pqEventSource::DONE)
307
    {
308
    this->PlayBackFinished = true;
309 310
    return;
    }
Clinton Stimpson's avatar
 
Clinton Stimpson committed
311 312
  else if(result == pqEventSource::FAILURE)
    {
313 314
    this->PlayBackFinished = true;
    this->PlayBackStatus = false; // failure.
Clinton Stimpson's avatar
 
Clinton Stimpson committed
315 316
    return;
    }
317
    
318 319 320 321 322
  QApplication::syncX();
  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;
323
#if defined(WIN32) || defined(__APPLE__) // temporary debugging on both platforms.
324 325
  print_debug = true;
#endif
326 327
  if (print_debug)
    {
328 329
    cout <<  QTime::currentTime().toString("hh:mm:ss").toStdString().c_str()
         << " : "
330 331 332 333 334
         << 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;
335 336
    }

337
  bool error = false;
338
  this->ActivePlayer->playEvent(object, command, arguments, error);
339
  this->BlockTimer.stop();
340 341 342 343 344 345 346 347

  // 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();

348
  this->BlockTimer.stop();
349

350 351
  if (print_debug)
    {
352 353
    cout << QTime::currentTime().toString("hh:mm:ss").toStdString().c_str()
         << " : "
354 355
         << QString().fill(' ', 4*indent).toStdString().c_str()
         << local_counter << ": Done" << endl;
356
    }
357

358 359 360 361 362 363
  if (error)
    {
    this->PlayBackStatus  = false;
    this->PlayBackFinished = true;
    return;
    }
364

365 366
}

367
//-----------------------------------------------------------------------------
368
void pqEventDispatcher::processEventsAndWait(int ms)
369
{
370 371
  bool prev = pqEventDispatcher::DeferMenuTimeouts;
  pqEventDispatcher::DeferMenuTimeouts = true;
372 373
  if (ms > 0)
    {
374
//    ms = (ms < 100) ? 100 : ms;
375
    QApplication::processEvents();
376 377
    QEventLoop loop;
    QTimer::singleShot(ms, &loop, SLOT(quit()));
378
    loop.exec();
379
    }
380
  QApplication::processEvents();
381 382
  QApplication::sendPostedEvents();
  QApplication::processEvents();
383
  pqEventDispatcher::DeferMenuTimeouts = prev;
384
}
385 386 387 388 389 390 391 392 393

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