src/backgroundsupr.h

   1 /*****************************************************************************
   2 ** FILE IDENTIFICATION
   3 **
   4 **   Name:          backgroundsupr.h
   5 **   Purpose:       Header file for background supervisors
   6 **   Programmer:    Kevin Rosenberg
   7 **   Date Started:  February 2001
   8 **
   9 **  This is part of the CTSim program
  10 **  Copyright (C) 1983-2001 Kevin Rosenberg
  11 **
  12 **  $Id: backgroundsupr.h,v 1.8 2001/03/04 22:30:19 kevin Exp $
  13 **
  14 **  This program is free software; you can redistribute it and/or modify
  15 **  it under the terms of the GNU General Public License (version 2) as
  16 **  published by the Free Software Foundation.
  17 **
  18 **  This program is distributed in the hope that it will be useful,
  19 **  but WITHOUT ANY WARRANTY; without even the implied warranty of
  20 **  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21 **  GNU General Public License for more details.
  22 **
  23 **  You should have received a copy of the GNU General Public License
  24 **  along with this program; if not, write to the Free Software
  25 **  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  26 ******************************************************************************/
  27
  28 #ifndef _BACKGROUNDSUPR_H
  29 #define _BACKGROUNDSUPR_H
  30
  31 #include <vector>
  32 #include <wx/thread.h>
  33 #include <wx/progdlg.h>
  34 #include "timer.h"
  35
  36 // This thread creates a SupervisorTask event handler object
  37 // The thread is detached and terminates when SupervisorTask terminates
  38 class SupervisorThread : public wxThread {
  39 private:
  40
  41 public:
  42   SupervisorThread()
  43     : wxThread(wxTHREAD_DETACHED)
  44   {}
  45
  46 };
  47
  48
  49 // Pure virtual class for BackgroundSupervisor that can communication
  50 // with BackgroundManager via messages
  51 class BackgroundWorkerThread;
  52
  53 class BackgroundSupervisor : public wxEvtHandler {
  54 private:
  55   DECLARE_DYNAMIC_CLASS(BackgroundSupervisor)
  56
  57   SupervisorThread* m_pMyThread;
  58   wxFrame* m_pParentFrame;
  59   wxDocument* m_pDocument;
  60   const std::string m_strProcessTitle;
  61
  62   const unsigned int m_iTotalUnits;
  63   int m_iNumThreads;
  64   bool m_bDone;
  65   volatile bool m_bFail;
  66   std::string m_strFailMessage;
  67   bool m_bCancelled;
  68   volatile int m_iRunning;
  69   unsigned int m_iUnitsDone;
  70   Timer* m_pTimer;
  71   bool m_bBackgroundTaskAdded;
  72   bool m_bWorkersDeleted;
  73
  74   typedef std::vector<BackgroundWorkerThread*> ThreadContainer;
  75   ThreadContainer m_vecpThreads;
  76   wxCriticalSection m_critsectThreads;
  77
  78
  79 public:
  80   enum {
  81     MSG_BACKGROUND_SUPERVISOR_ADD = 7500, // sends to BackgroundManager and Document
  82     MSG_BACKGROUND_SUPERVISOR_REMOVE = 7501, // sends to BackgroundManager and Document
  83     MSG_BACKGROUND_SUPERVISOR_UNIT_TICK = 7502,  // sends to BackgroundManager for progress bars
  84     MSG_BACKGROUND_SUPERVISOR_CANCEL = 7503,   // *sent* to Supervisor to cancel process
  85     MSG_DOCUMENT_ACK_REMOVE = 7504,
  86
  87     MSG_WORKER_THREAD_UNIT_TICK = 7505,
  88     MSG_WORKER_THREAD_DONE = 7506,
  89     MSG_WORKER_THREAD_FAIL = 7507,   // sent by workers when they fail
  90   };
  91
  92   BackgroundSupervisor (SupervisorThread* pMyThread, wxFrame* pParentFrame, wxDocument* pDocument, const char* const pszProcessTitle,
  93     int iTotalUnits);
  94
  95   BackgroundSupervisor ()
  96     : wxEvtHandler(), m_iTotalUnits(0)
  97   {}
  98
  99   virtual ~BackgroundSupervisor();
 100
 101   virtual BackgroundWorkerThread* createWorker (int iThread, int iStartUnit, int iNumUnits)
 102   { return NULL; }
 103
 104   bool start();
 105   virtual void onDone() {};
 106
 107   virtual void onCancel();
 108   virtual void onAckDocumentRemove();
 109
 110   virtual void onWorkerFail(int iThread, std::string strFailMessage);
 111   virtual void onWorkerUnitTick();
 112   virtual void onWorkerDone(int iThread);
 113
 114   void deleteWorkers();
 115   bool workersDone() const { return m_iRunning == 0; }
 116   bool workersDeleted() const { return m_bWorkersDeleted; }
 117   bool isDone() const {return m_bDone;}
 118   void setDone() { m_bDone = true; }
 119   bool fail() const {return m_bFail;}
 120   const std::string& getFailMessage() const { return m_strFailMessage; }
 121   bool cancelled() const {return m_bCancelled;}
 122
 123   int getNumWorkers() const { return m_iNumThreads; }
 124   double getTimerEnd() { return m_pTimer->timerEnd(); }
 125
 126   DECLARE_EVENT_TABLE()
 127 };
 128
 129
 130 class BackgroundWorkerThread : public wxThread {
 131 protected:
 132   BackgroundSupervisor* m_pSupervisor;
 133   const int m_iThread;
 134   const int m_iStartUnit;
 135   const int m_iNumUnits;
 136
 137 public:
 138   BackgroundWorkerThread (BackgroundSupervisor* pSupervisor, int iThread, int iStartUnit, int iNumUnits)
 139     : wxThread (wxTHREAD_DETACHED), m_pSupervisor(pSupervisor), m_iThread(iThread), m_iStartUnit(iStartUnit), m_iNumUnits(iNumUnits)
 140   {}
 141 };
 142
 143 #endif  // _BACKGROUNDSUPR_H_