pqThreadedEventSource.h 3.46 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);
Clinton Stimpson's avatar
 
Clinton Stimpson committed
50 51 52 53 54 55 56
  ~pqThreadedEventSource();

  /** Called by the dispatcher on the GUI thread.
    Retrieves the next available event.  Returns true if an event was
    returned, false if there are no more events. 
    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. */
Clinton Stimpson's avatar
 
Clinton Stimpson committed
57
  virtual int getNextEvent(
Clinton Stimpson's avatar
 
Clinton Stimpson committed
58 59 60 61 62
    QString& object,
    QString& command,
    QString& arguments);
  
  /** The testing thread may post an event for the GUI to process.
Clinton Stimpson's avatar
 
Clinton Stimpson committed
63 64 65 66
      This function blocks until there are no previously queued 
      events to play.
      If the event plays successfully, true is returned. */
  bool postNextEvent(const QString& object,
Clinton Stimpson's avatar
 
Clinton Stimpson committed
67 68
                     const QString& command,
                     const QString& argument);
Clinton Stimpson's avatar
 
Clinton Stimpson committed
69 70

  /** tell this source to stop */
71
  virtual void stop();
Clinton Stimpson's avatar
 
Clinton Stimpson committed
72 73 74 75 76 77

  /** Wait for the GUI thread to acknowledge an event.
      A previously locked mutex must be passed in.
      For use by the testing thread.
      If return value is false, an error occurred and 
      the testing thread should terminate. */
78
  bool waitForGUI();
Clinton Stimpson's avatar
 
Clinton Stimpson committed
79 80 81 82

  /** Give the testing thread an acknowledgement.
      For use by the GUI thread */
  void guiAcknowledge();
83 84 85

  // helper method to sleep.
  static void msleep(int msecs);
Clinton Stimpson's avatar
 
Clinton Stimpson committed
86
  
87
private slots:
Clinton Stimpson's avatar
 
Clinton Stimpson committed
88

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

91
protected:
Clinton Stimpson's avatar
 
Clinton Stimpson committed
92
  // start the thread
93
  virtual void start();
Clinton Stimpson's avatar
 
Clinton Stimpson committed
94 95

  // called by the testing thread to signify it is done
Clinton Stimpson's avatar
 
Clinton Stimpson committed
96 97
  // pass in zero for success, non-zero for failure
  void done(int);
Clinton Stimpson's avatar
 
Clinton Stimpson committed
98 99 100 101 102 103 104

  // run the thread, return 
  virtual void run() = 0;

private:
  class pqInternal;
  pqInternal* Internal;
105
  friend class pqInternal;
Clinton Stimpson's avatar
 
Clinton Stimpson committed
106 107 108 109 110

};

#endif // !_pqThreadedEventSource_h