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 struct 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 public:
  72     fgEVENT( const string& desc,
  73              const fgCallback& cb,
  74              EventState _status,
  75              int _interval );
  76
  77     fgEVENT( const fgEVENT& evt );
  78
  79     ~fgEVENT();
  80
  81     void run();
  82
  83     void PrintStats() const;
  84
  85 public:
  86
  87     string description;
  88
  89     // The callback object.
  90     // We wrap it in an auto_ptr<> because deque<> calls our copy ctor
  91     // and dtor when inserting and removing.
  92     auto_ptr<fgCallback> event_cb;
  93
  94     EventState status;       // status flag
  95
  96     long interval;    // interval in ms between each iteration of this event
  97
  98     fg_timestamp last_run;
  99     fg_timestamp current;
 100     fg_timestamp next_run;
 101
 102     long cum_time;    // cumulative processor time of this event
 103     long min_time;    // time of quickest execution
 104     long max_time;    // time of slowest execution
 105     long count;       // number of times executed
 106 };
 107
 108
 109 class fgEVENT_MGR {
 110
 111     // Event table
 112     deque < fgEVENT > event_table;
 113
 114     // Run Queue
 115     list < fgEVENT * > run_queue;
 116
 117 public:
 118
 119     // Constructor
 120     fgEVENT_MGR ( void );
 121
 122     // Initialize the scheduling subsystem
 123     void Init( void );
 124
 125     // Register an event with the scheduler
 126     void Register( const string& desc, void (*event)( void ),
 127                    fgEVENT::EventState status, int interval) {
 128         Register( desc, fgFunctionCallback(event), status, interval );
 129     }
 130
 131     void Register( const string& desc,
 132                    const fgCallback& cb,
 133                    fgEVENT::EventState status,
 134                    int interval );
 135
 136     // Update the scheduling parameters for an event
 137     void Update( void );
 138
 139     // Delete a scheduled event
 140     void Delete( void );
 141
 142     // Temporarily suspend scheduling of an event
 143     void Suspend( void );
 144
 145     // Resume scheduling and event
 146     void Resume( void );
 147
 148     // Dump scheduling stats
 149     void PrintStats( void );
 150
 151     // Add pending jobs to the run queue and run the job at the front
 152     // of the queue
 153     void Process( void );
 154
 155     // Destructor
 156     ~fgEVENT_MGR ( void );
 157 };
 158
 159
 160 // Wrapper to dump scheduling stats
 161 void fgEventPrintStats( void );
 162
 163 extern fgEVENT_MGR global_events;
 164
 165
 166 #endif // _EVENT_HXX
 167
 168
 169 // $Log$
 170 // Revision 1.8  1998/08/29 13:11:32  curt
 171 // Bernie Bright writes:
 172 //   I've created some new classes to enable pointers-to-functions and
 173 //   pointers-to-class-methods to be treated like objects.  These objects
 174 //   can be registered with fgEVENT_MGR.
 175 //
 176 //   File "Include/fg_callback.hxx" contains the callback class defns.
 177 //
 178 //   Modified fgEVENT and fgEVENT_MGR to use the callback classes.  Also
 179 //   some minor tweaks to STL usage.
 180 //
 181 //   Added file "Include/fg_stl_config.h" to deal with STL portability
 182 //   issues.  I've added an initial config for egcs (and probably gcc-2.8.x).
 183 //   I don't have access to Visual C++ so I've left that for someone else.
 184 //   This file is influenced by the stl_config.h file delivered with egcs.
 185 //
 186 //   Added "Include/auto_ptr.hxx" which contains an implementation of the
 187 //   STL auto_ptr class which is not provided in all STL implementations
 188 //   and is needed to use the callback classes.
 189 //
 190 //   Deleted fgLightUpdate() which was just a wrapper to call
 191 //   fgLIGHT::Update().
 192 //
 193 //   Modified fg_init.cxx to register two method callbacks in place of the
 194 //   old wrapper functions.
 195 //
 196 // Revision 1.7  1998/07/30 23:48:54  curt
 197 // Sgi build tweaks.
 198 // Pause support.
 199 //
 200 // Revision 1.6  1998/07/24 21:42:25  curt
 201 // Output message tweaks.
 202 //
 203 // Revision 1.5  1998/07/13 21:02:07  curt
 204 // Wrote access functions for current fgOPTIONS.
 205 //
 206 // Revision 1.4  1998/06/12 00:59:52  curt
 207 // Build only static libraries.
 208 // Declare memmove/memset for Sloaris.
 209 // Rewrote fg_time.c routine to get LST start seconds to better handle
 210 //   Solaris, and be easier to port, and understand the GMT vs. local
 211 //   timezone issues.
 212 //
 213 // Revision 1.3  1998/06/03 00:48:12  curt
 214 // No .h for STL includes.
 215 //
 216 // Revision 1.2  1998/05/22 21:14:54  curt
 217 // Rewrote event.cxx in C++ as a class using STL for the internal event list
 218 // and run queue this removes the arbitrary list sizes and makes things much
 219 // more dynamic.  Because this is C++-classified we can now have multiple
 220 // event_tables if we'd ever want them.
 221 //
 222 // Revision 1.1  1998/04/24 00:52:26  curt
 223 // Wrapped "#include <config.h>" in "#ifdef HAVE_CONFIG_H"
 224 // Fog color fixes.
 225 // Separated out lighting calcs into their own file.
 226 //
 227 // Revision 1.4  1998/04/21 17:01:43  curt
 228 // Fixed a problems where a pointer to a function was being passed around.  In
 229 // one place this functions arguments were defined as ( void ) while in another
 230 // place they were defined as ( int ).  The correct answer was ( int ).
 231 //
 232 // Prepairing for C++ integration.
 233 //
 234 // Revision 1.3  1998/01/22 02:59:43  curt
 235 // Changed #ifdef FILE_H to #ifdef _FILE_H
 236 //
 237 // Revision 1.2  1998/01/19 18:40:39  curt
 238 // Tons of little changes to clean up the code and to remove fatal errors
 239 // when building with the c++ compiler.
 240 //
 241 // Revision 1.1  1997/12/30 04:19:22  curt
 242 // Initial revision.
 243