Time/event.hxx

   1 // event.hxx -- Flight Gear periodic event scheduler
   2 //
   3 // Written by Curtis Olson, started December 1997.
   4 //
   5 // Copyright (C) 1997  Curtis L. Olson  - curt@infoplane.com
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 //
  21 // $Id$
  22 // (Log is kept at end of this file)
  23
  24
  25 #ifndef _EVENT_HXX
  26 #define _EVENT_HXX
  27
  28
  29 #ifndef __cplusplus
  30 # error This library requires C++
  31 #endif
  32
  33
  34 #if defined ( __sun__ ) || defined ( __sgi )
  35 extern "C" void *memmove(void *, const void *, size_t);
  36 extern "C" void *memset(void *, int, size_t);
  37 #endif
  38
  39
  40 #include <deque>        // STL double ended queue
  41 #include <list>         // STL list
  42 #include <string>
  43
  44 #include "Include/fg_stl_config.h"
  45
  46 #ifdef _FG_NEED_AUTO_PTR
  47 #  include "Include/auto_ptr.hxx"
  48 #else
  49 #  include <memory>
  50 #endif
  51
  52 #include "Include/fg_callback.hxx"
  53
  54 #ifdef NEEDNAMESPACESTD
  55 using namespace std;
  56 #endif
  57
  58 #include "fg_time.hxx"
  59
  60
  61 class fgEVENT
  62 {
  63 public:
  64     enum EventState
  65     {
  66         FG_EVENT_SUSP   = 0,
  67         FG_EVENT_READY  = 1,
  68         FG_EVENT_QUEUED = 2
  69     };
  70
  71     fgEVENT(); // Required by deque<>.
  72
  73     fgEVENT( const string& desc,
  74              const fgCallback& cb,
  75              EventState _status,
  76              int _interval );
  77
  78     fgEVENT( const fgEVENT& evt );
  79
  80     ~fgEVENT();
  81
  82     void run();
  83
  84     void PrintStats() const;
  85
  86 public:
  87
  88     string description;
  89
  90     // The callback object.
  91     // We wrap it in an auto_ptr<> because deque<> calls our copy ctor
  92     // and dtor when inserting and removing.
  93     auto_ptr<fgCallback> event_cb;
  94
  95     EventState status;       // status flag
  96
  97     long interval;    // interval in ms between each iteration of this event
  98
  99     fg_timestamp last_run;
 100     fg_timestamp current;
 101     fg_timestamp next_run;
 102
 103     long cum_time;    // cumulative processor time of this event
 104     long min_time;    // time of quickest execution
 105     long max_time;    // time of slowest execution
 106     long count;       // number of times executed
 107 };
 108
 109
 110 class fgEVENT_MGR {
 111
 112     // Event table
 113     deque < fgEVENT > event_table;
 114
 115     // Run Queue
 116     list < fgEVENT * > run_queue;
 117
 118 public:
 119
 120     // Constructor
 121     fgEVENT_MGR ( void );
 122
 123     // Initialize the scheduling subsystem
 124     void Init( void );
 125
 126     // Register an event with the scheduler
 127     void Register( const string& desc, void (*event)( void ),
 128                    fgEVENT::EventState status, int interval) {
 129         Register( desc, fgFunctionCallback(event), status, interval );
 130     }
 131
 132     void Register( const string& desc,
 133                    const fgCallback& cb,
 134                    fgEVENT::EventState status,
 135                    int interval );
 136
 137     // Update the scheduling parameters for an event
 138     void Update( void );
 139
 140     // Delete a scheduled event
 141     void Delete( void );
 142
 143     // Temporarily suspend scheduling of an event
 144     void Suspend( void );
 145
 146     // Resume scheduling and event
 147     void Resume( void );
 148
 149     // Dump scheduling stats
 150     void PrintStats( void );
 151
 152     // Add pending jobs to the run queue and run the job at the front
 153     // of the queue
 154     void Process( void );
 155
 156     // Destructor
 157     ~fgEVENT_MGR ( void );
 158 };
 159
 160
 161 // Wrapper to dump scheduling stats
 162 void fgEventPrintStats( void );
 163
 164 extern fgEVENT_MGR global_events;
 165
 166
 167 #endif // _EVENT_HXX
 168
 169
 170 // $Log$
 171 // Revision 1.10  1998/09/08 21:41:06  curt
 172 // Added constructor for fgEVENT.
 173 //
 174 // Revision 1.9  1998/09/02 14:37:45  curt
 175 // Renamed struct -> class.
 176 //
 177 // Revision 1.8  1998/08/29 13:11:32  curt
 178 // Bernie Bright writes:
 179 //   I've created some new classes to enable pointers-to-functions and
 180 //   pointers-to-class-methods to be treated like objects.  These objects
 181 //   can be registered with fgEVENT_MGR.
 182 //
 183 //   File "Include/fg_callback.hxx" contains the callback class defns.
 184 //
 185 //   Modified fgEVENT and fgEVENT_MGR to use the callback classes.  Also
 186 //   some minor tweaks to STL usage.
 187 //
 188 //   Added file "Include/fg_stl_config.h" to deal with STL portability
 189 //   issues.  I've added an initial config for egcs (and probably gcc-2.8.x).
 190 //   I don't have access to Visual C++ so I've left that for someone else.
 191 //   This file is influenced by the stl_config.h file delivered with egcs.
 192 //
 193 //   Added "Include/auto_ptr.hxx" which contains an implementation of the
 194 //   STL auto_ptr class which is not provided in all STL implementations
 195 //   and is needed to use the callback classes.
 196 //
 197 //   Deleted fgLightUpdate() which was just a wrapper to call
 198 //   fgLIGHT::Update().
 199 //
 200 //   Modified fg_init.cxx to register two method callbacks in place of the
 201 //   old wrapper functions.
 202 //
 203 // Revision 1.7  1998/07/30 23:48:54  curt
 204 // Sgi build tweaks.
 205 // Pause support.
 206 //
 207 // Revision 1.6  1998/07/24 21:42:25  curt
 208 // Output message tweaks.
 209 //
 210 // Revision 1.5  1998/07/13 21:02:07  curt
 211 // Wrote access functions for current fgOPTIONS.
 212 //
 213 // Revision 1.4  1998/06/12 00:59:52  curt
 214 // Build only static libraries.
 215 // Declare memmove/memset for Sloaris.
 216 // Rewrote fg_time.c routine to get LST start seconds to better handle
 217 //   Solaris, and be easier to port, and understand the GMT vs. local
 218 //   timezone issues.
 219 //
 220 // Revision 1.3  1998/06/03 00:48:12  curt
 221 // No .h for STL includes.
 222 //
 223 // Revision 1.2  1998/05/22 21:14:54  curt
 224 // Rewrote event.cxx in C++ as a class using STL for the internal event list
 225 // and run queue this removes the arbitrary list sizes and makes things much
 226 // more dynamic.  Because this is C++-classified we can now have multiple
 227 // event_tables if we'd ever want them.
 228 //
 229 // Revision 1.1  1998/04/24 00:52:26  curt
 230 // Wrapped "#include <config.h>" in "#ifdef HAVE_CONFIG_H"
 231 // Fog color fixes.
 232 // Separated out lighting calcs into their own file.
 233 //
 234 // Revision 1.4  1998/04/21 17:01:43  curt
 235 // Fixed a problems where a pointer to a function was being passed around.  In
 236 // one place this functions arguments were defined as ( void ) while in another
 237 // place they were defined as ( int ).  The correct answer was ( int ).
 238 //
 239 // Prepairing for C++ integration.
 240 //
 241 // Revision 1.3  1998/01/22 02:59:43  curt
 242 // Changed #ifdef FILE_H to #ifdef _FILE_H
 243 //
 244 // Revision 1.2  1998/01/19 18:40:39  curt
 245 // Tons of little changes to clean up the code and to remove fatal errors
 246 // when building with the c++ compiler.
 247 //
 248 // Revision 1.1  1997/12/30 04:19:22  curt
 249 // Initial revision.
 250