pqThreadedEventSource.h 3.41 KB
Newer Older
Clinton Stimpson's avatar
 
Clinton Stimpson committed
1 2 3 4 5
/*=========================================================================

   Program: ParaView
   Module:    pqThreadedEventSource.h

6
   Copyright (c) 2005-2008 Sandia Corporation, Kitware Inc.
Clinton Stimpson's avatar
 
Clinton Stimpson committed
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.
Clinton Stimpson's avatar
 
Clinton Stimpson committed
11

12
   See License_v1.2.txt for the full ParaView license.
Clinton Stimpson's avatar
 
Clinton Stimpson committed
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
   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.

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

#ifndef _pqThreadedEventSource_h
#define _pqThreadedEventSource_h

#include "QtTestingExport.h"
#include "pqEventSource.h"

class QString;
Clinton Stimpson's avatar
 
Clinton Stimpson committed
40
class QMutex;
Clinton Stimpson's avatar
 
Clinton Stimpson committed
41 42 43 44 45 46 47 48

/// Abstract interface for objects that can supply high-level testing events
/// on a separte thread.  This class is derived from, and run() is
/// implemented.
class QTTESTING_EXPORT pqThreadedEventSource : public pqEventSource
{
  Q_OBJECT
public:
Clinton Stimpson's avatar
 
Clinton Stimpson committed
49
  pqThreadedEventSource(QObject* p);
Ben Boeckel's avatar
Ben Boeckel committed
50
  ~pqThreadedEventSource() override;
Clinton Stimpson's avatar
 
Clinton Stimpson committed
51 52 53

  /** Called by the dispatcher on the GUI thread.
    Retrieves the next available event.  Returns true if an event was
54
    returned, false if there are no more events.
Clinton Stimpson's avatar
 
Clinton Stimpson committed
55 56
    In the case of a threaded event source, this function is called by the GUI
    thread and waits for the other thread to pos and event. */
57 58
  virtual int getNextEvent(QString& object, QString& command, QString& arguments);

Clinton Stimpson's avatar
 
Clinton Stimpson committed
59
  /** The testing thread may post an event for the GUI to process.
60
      This function blocks until there are no previously queued
Clinton Stimpson's avatar
 
Clinton Stimpson committed
61 62
      events to play.
      If the event plays successfully, true is returned. */
63
  bool postNextEvent(const QString& object, const QString& command, const QString& argument);
Clinton Stimpson's avatar
 
Clinton Stimpson committed
64 65

  /** tell this source to stop */
Ben Boeckel's avatar
Ben Boeckel committed
66
  void stop() override;
Clinton Stimpson's avatar
 
Clinton Stimpson committed
67 68 69 70

  /** Wait for the GUI thread to acknowledge an event.
      A previously locked mutex must be passed in.
      For use by the testing thread.
71
      If return value is false, an error occurred and
Clinton Stimpson's avatar
 
Clinton Stimpson committed
72
      the testing thread should terminate. */
73
  bool waitForGUI();
Clinton Stimpson's avatar
 
Clinton Stimpson committed
74 75 76 77

  /** Give the testing thread an acknowledgement.
      For use by the GUI thread */
  void guiAcknowledge();
78 79 80

  // helper method to sleep.
  static void msleep(int msecs);
81

82
private slots:
Clinton Stimpson's avatar
 
Clinton Stimpson committed
83

84
  void relayEvent(QString object, QString command, QString arguments);
Clinton Stimpson's avatar
 
Clinton Stimpson committed
85

86
protected:
Clinton Stimpson's avatar
 
Clinton Stimpson committed
87
  // start the thread
88
  virtual void start();
Clinton Stimpson's avatar
 
Clinton Stimpson committed
89 90

  // called by the testing thread to signify it is done
Clinton Stimpson's avatar
 
Clinton Stimpson committed
91 92
  // pass in zero for success, non-zero for failure
  void done(int);
Clinton Stimpson's avatar
 
Clinton Stimpson committed
93

94
  // run the thread, return
Clinton Stimpson's avatar
 
Clinton Stimpson committed
95 96 97 98 99
  virtual void run() = 0;

private:
  class pqInternal;
  pqInternal* Internal;
100
  friend class pqInternal;
Clinton Stimpson's avatar
 
Clinton Stimpson committed
101 102 103
};

#endif // !_pqThreadedEventSource_h