neo/framework/EventLoop.h

   1 /*
   2 ===========================================================================
   3
   4 Doom 3 GPL Source Code
   5 Copyright (C) 1999-2011 id Software LLC, a ZeniMax Media company.
   6
   7 This file is part of the Doom 3 GPL Source Code (?Doom 3 Source Code?).
   8
   9 Doom 3 Source Code is free software: you can redistribute it and/or modify
  10 it under the terms of the GNU General Public License as published by
  11 the Free Software Foundation, either version 3 of the License, or
  12 (at your option) any later version.
  13
  14 Doom 3 Source Code is distributed in the hope that it will be useful,
  15 but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 GNU General Public License for more details.
  18
  19 You should have received a copy of the GNU General Public License
  20 along with Doom 3 Source Code.  If not, see <http://www.gnu.org/licenses/>.
  21
  22 In addition, the Doom 3 Source Code is also subject to certain additional terms. You should have received a copy of these additional terms immediately following the terms and conditions of the GNU General Public License which accompanied the Doom 3 Source Code.  If not, please request a copy in writing from id Software at the address below.
  23
  24 If you have questions concerning this license or the applicable additional terms, you may contact in writing id Software LLC, c/o ZeniMax Media Inc., Suite 120, Rockville, Maryland 20850 USA.
  25
  26 ===========================================================================
  27 */
  28
  29 #ifndef __EVENTLOOP_H__
  30 #define __EVENTLOOP_H__
  31
  32 /*
  33 ===============================================================================
  34
  35         The event loop receives events from the system and dispatches them to
  36         the various parts of the engine. The event loop also handles journaling.
  37         The file system copies .cfg files to the journaled file.
  38
  39 ===============================================================================
  40 */
  41
  42 const int MAX_PUSHED_EVENTS =   64;
  43
  44 class idEventLoop {
  45 public:
  46                                         idEventLoop( void );
  47                                         ~idEventLoop( void );
  48
  49         void                    Init( void );
  50
  51                                         // Closes the journal file if needed.
  52         void                    Shutdown( void );
  53
  54                                         // It is possible to get an event at the beginning of a frame that
  55                                         // has a time stamp lower than the last event from the previous frame.
  56         sysEvent_t              GetEvent( void );
  57
  58                                         // Dispatches all pending events and returns the current time.
  59         int                             RunEventLoop( bool commandExecution = true );
  60
  61                                         // Gets the current time in a way that will be journaled properly,
  62                                         // as opposed to Sys_Milliseconds(), which always reads a real timer.
  63         int                             Milliseconds( void );
  64
  65                                         // Returns the journal level, 1 = record, 2 = play back.
  66         int                             JournalLevel( void ) const;
  67
  68                                         // Journal file.
  69         idFile *                com_journalFile;
  70         idFile *                com_journalDataFile;
  71
  72 private:
  73                                         // all events will have this subtracted from their time
  74         int                             initialTimeOffset;
  75
  76         int                             com_pushedEventsHead, com_pushedEventsTail;
  77         sysEvent_t              com_pushedEvents[MAX_PUSHED_EVENTS];
  78
  79         static idCVar   com_journal;
  80
  81         sysEvent_t              GetRealEvent( void );
  82         void                    ProcessEvent( sysEvent_t ev );
  83         void                    PushEvent( sysEvent_t *event );
  84 };
  85
  86 extern  idEventLoop     *eventLoop;
  87
  88 #endif /* !__EVENTLOOP_H__ */