core/TimerSys.cpp
author David Anderson <dvander@alliedmods.net>
Wed Sep 12 22:46:00 2007 +0000 (2007-09-12)
changeset 1412 a2ca3d22dd71
parent 1410 8feec8371000
child 1414 bb258bffc7df
permissions -rw-r--r--
- moved gameframe hook to timersys
- rewrote simulation algorithm
- various internal improvements to timer
- removed the unused parameter to GetTickedTime()
dvander@592
     1
/**
ds@653
     2
 * vim: set ts=4 :
ds@1330
     3
 * =============================================================================
dvander@1231
     4
 * SourceMod
dvander@1231
     5
 * Copyright (C) 2004-2007 AlliedModders LLC.  All rights reserved.
ds@1330
     6
 * =============================================================================
ds@653
     7
 *
ds@1330
     8
 * This program is free software; you can redistribute it and/or modify it under
ds@1330
     9
 * the terms of the GNU General Public License, version 3.0, as published by the
ds@1330
    10
 * Free Software Foundation.
dvander@1231
    11
 * 
ds@1330
    12
 * This program is distributed in the hope that it will be useful, but WITHOUT
ds@1330
    13
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
ds@1330
    14
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
ds@1330
    15
 * details.
dvander@1231
    16
 *
ds@1330
    17
 * You should have received a copy of the GNU General Public License along with
ds@1330
    18
 * this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@1231
    19
 *
ds@1330
    20
 * As a special exception, AlliedModders LLC gives you permission to link the
ds@1330
    21
 * code of this program (as well as its derivative works) to "Half-Life 2," the
ds@1330
    22
 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
ds@1330
    23
 * by the Valve Corporation.  You must obey the GNU General Public License in
ds@1330
    24
 * all respects for all other code used.  Additionally, AlliedModders LLC grants
ds@1330
    25
 * this exception to all derivative works.  AlliedModders LLC defines further
ds@1330
    26
 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
ds@1330
    27
 * or <http://www.sourcemod.net/license.php>.
ds@653
    28
 *
ds@653
    29
 * Version: $Id$
ds@653
    30
 */
dvander@592
    31
dvander@1371
    32
#include <time.h>
dvander@592
    33
#include "TimerSys.h"
dvander@1412
    34
#include "ForwardSys.h"
dvander@1371
    35
#include "sourcemm_api.h"
dvander@1412
    36
#include "frame_hooks.h"
dvander@592
    37
dvander@616
    38
TimerSystem g_Timers;
dvander@1412
    39
float g_fUniversalTime = 0.0f;
dvander@1412
    40
const float *g_pUniversalTime = &g_fUniversalTime;
dvander@727
    41
dvander@1371
    42
ConVar sm_time_adjustment("sm_time_adjustment", "0", 0, "Adjusts the server time in seconds");
dvander@1371
    43
dvander@1412
    44
inline float GetSimulatedTime()
dvander@1412
    45
{
dvander@1412
    46
	return g_fUniversalTime;
dvander@1412
    47
}
dvander@1410
    48
dvander@1371
    49
time_t GetAdjustedTime(time_t *buf)
dvander@1371
    50
{
dvander@1371
    51
	time_t val = time(NULL) + sm_time_adjustment.GetInt();
dvander@1371
    52
	if (buf)
dvander@1371
    53
	{
dvander@1371
    54
		*buf = val;
dvander@1371
    55
	}
dvander@1371
    56
	return val;
dvander@1371
    57
}
dvander@1371
    58
dvander@592
    59
void ITimer::Initialize(ITimedEvent *pCallbacks, float fInterval, float fToExec, void *pData, int flags)
dvander@592
    60
{
dvander@592
    61
	m_Listener = pCallbacks;
dvander@592
    62
	m_Interval = fInterval;
dvander@592
    63
	m_ToExec = fToExec;
dvander@592
    64
	m_pData = pData;
dvander@592
    65
	m_Flags = flags;
dvander@592
    66
	m_InExec = false;
dvander@592
    67
	m_KillMe = false;
dvander@592
    68
}
dvander@592
    69
dvander@1408
    70
TimerSystem::TimerSystem()
dvander@1408
    71
{
dvander@1408
    72
	m_fnTimeLeft = NULL;
dvander@1412
    73
	m_bHasMapTickedYet = false;
dvander@1412
    74
	m_fLastTickedTime = 0.0f;
dvander@1412
    75
	m_LastExecTime = 0.0f;
dvander@1408
    76
}
dvander@1408
    77
faluco@641
    78
TimerSystem::~TimerSystem()
faluco@641
    79
{
faluco@641
    80
	CStack<ITimer *>::iterator iter;
faluco@641
    81
	for (iter=m_FreeTimers.begin(); iter!=m_FreeTimers.end(); iter++)
faluco@641
    82
	{
faluco@641
    83
		delete (*iter);
faluco@641
    84
	}
faluco@641
    85
	m_FreeTimers.popall();
faluco@641
    86
}
faluco@641
    87
dvander@616
    88
void TimerSystem::OnSourceModAllInitialized()
dvander@592
    89
{
dvander@592
    90
	g_ShareSys.AddInterface(NULL, this);
dvander@1412
    91
	m_pOnGameFrame = g_Forwards.CreateForward("OnGameFrame", ET_Ignore, 0, NULL);
dvander@1412
    92
}
dvander@1412
    93
dvander@1412
    94
void TimerSystem::OnSourceModShutdown()
dvander@1412
    95
{
dvander@1412
    96
	g_Forwards.ReleaseForward(m_pOnGameFrame);
dvander@592
    97
}
dvander@592
    98
dvander@673
    99
void TimerSystem::OnSourceModLevelChange(const char *mapName)
dvander@673
   100
{
dvander@1142
   101
	MapChange(true);
dvander@673
   102
}
dvander@673
   103
dvander@1412
   104
void TimerSystem::OnSourceModLevelEnd()
dvander@1412
   105
{
dvander@1412
   106
	m_bHasMapTickedYet = false;
dvander@1412
   107
}
dvander@1412
   108
dvander@1412
   109
void TimerSystem::GameFrame(bool simulating)
dvander@1412
   110
{
dvander@1412
   111
	if (simulating && m_bHasMapTickedYet)
dvander@1412
   112
	{
dvander@1412
   113
		g_fUniversalTime += gpGlobals->curtime - m_fLastTickedTime;
dvander@1412
   114
	}
dvander@1412
   115
	else 
dvander@1412
   116
	{
dvander@1412
   117
		g_fUniversalTime += gpGlobals->interval_per_tick;
dvander@1412
   118
	}
dvander@1412
   119
dvander@1412
   120
	m_fLastTickedTime = gpGlobals->curtime;
dvander@1412
   121
	m_bHasMapTickedYet = true;
dvander@1412
   122
dvander@1412
   123
	if (g_fUniversalTime - m_LastExecTime >= 0.1)
dvander@1412
   124
	{
dvander@1412
   125
		RunFrame();
dvander@1412
   126
	}
dvander@1412
   127
dvander@1412
   128
	RunFrameHooks();
dvander@1412
   129
dvander@1412
   130
	if (m_pOnGameFrame->GetFunctionCount())
dvander@1412
   131
	{
dvander@1412
   132
		m_pOnGameFrame->Execute(NULL);
dvander@1412
   133
	}
dvander@1412
   134
}
dvander@1412
   135
dvander@616
   136
void TimerSystem::RunFrame()
dvander@592
   137
{
dvander@592
   138
	ITimer *pTimer;
dvander@592
   139
	TimerIter iter;
dvander@592
   140
dvander@727
   141
	float curtime = GetSimulatedTime();
dvander@592
   142
	for (iter=m_SingleTimers.begin(); iter!=m_SingleTimers.end(); )
dvander@592
   143
	{
dvander@592
   144
		pTimer = (*iter);
dvander@727
   145
		if (curtime >= pTimer->m_ToExec)
dvander@592
   146
		{
dvander@592
   147
			pTimer->m_InExec = true;
dvander@592
   148
			pTimer->m_Listener->OnTimer(pTimer, pTimer->m_pData);
faluco@612
   149
			pTimer->m_Listener->OnTimerEnd(pTimer, pTimer->m_pData);
dvander@592
   150
			iter = m_SingleTimers.erase(iter);
dvander@592
   151
			m_FreeTimers.push(pTimer);
dvander@592
   152
		} else {
dvander@592
   153
			break;
dvander@592
   154
		}
dvander@592
   155
	}
dvander@592
   156
dvander@1407
   157
	if (m_fnTimeLeft != NULL && m_MapEndTimers.size())
dvander@1407
   158
	{
dvander@1407
   159
		float time_left = m_fnTimeLeft();
dvander@1407
   160
		for (iter=m_MapEndTimers.begin(); iter!=m_MapEndTimers.end();)
dvander@1407
   161
		{
dvander@1407
   162
			pTimer = (*iter);
dvander@1407
   163
			if ((*iter)->m_Interval < time_left)
dvander@1407
   164
			{
dvander@1407
   165
				pTimer->m_InExec = true;
dvander@1407
   166
				pTimer->m_Listener->OnTimer(pTimer, pTimer->m_pData);
dvander@1407
   167
				pTimer->m_Listener->OnTimerEnd(pTimer, pTimer->m_pData);
dvander@1407
   168
				iter = m_MapEndTimers.erase(iter);
dvander@1407
   169
				m_FreeTimers.push(pTimer);
dvander@1407
   170
			} else {
dvander@1407
   171
				break;
dvander@1407
   172
			}
dvander@1407
   173
		}
dvander@1407
   174
	}
dvander@1407
   175
dvander@592
   176
	ResultType res;
dvander@592
   177
	for (iter=m_LoopTimers.begin(); iter!=m_LoopTimers.end(); )
dvander@592
   178
	{
dvander@592
   179
		pTimer = (*iter);
dvander@727
   180
		if (curtime >= pTimer->m_ToExec)
dvander@592
   181
		{
dvander@592
   182
			pTimer->m_InExec = true;
dvander@592
   183
			res = pTimer->m_Listener->OnTimer(pTimer, pTimer->m_pData);
dvander@592
   184
			if (pTimer->m_KillMe || (res == Pl_Stop))
dvander@592
   185
			{
dvander@592
   186
				pTimer->m_Listener->OnTimerEnd(pTimer, pTimer->m_pData);
dvander@592
   187
				iter = m_LoopTimers.erase(iter);
dvander@592
   188
				m_FreeTimers.push(pTimer);
dvander@592
   189
				continue;
dvander@592
   190
			}
dvander@592
   191
			pTimer->m_InExec = false;
dvander@727
   192
			pTimer->m_ToExec = curtime + pTimer->m_Interval;
dvander@592
   193
		}
dvander@592
   194
		iter++;
dvander@592
   195
	}
dvander@592
   196
dvander@727
   197
	m_LastExecTime = curtime;
dvander@592
   198
}
dvander@592
   199
dvander@616
   200
ITimer *TimerSystem::CreateTimer(ITimedEvent *pCallbacks, float fInterval, void *pData, int flags)
dvander@592
   201
{
dvander@592
   202
	ITimer *pTimer;
dvander@592
   203
	TimerIter iter;
dvander@727
   204
	float to_exec = GetSimulatedTime() + fInterval;
dvander@592
   205
dvander@1409
   206
	if ((flags & TIMER_FLAG_BEFORE_MAP_END)
dvander@1409
   207
		&& m_fnTimeLeft == NULL)
dvander@1409
   208
	{
dvander@1409
   209
		return NULL;
dvander@1409
   210
	}
dvander@1409
   211
dvander@592
   212
	if (m_FreeTimers.empty())
dvander@592
   213
	{
dvander@592
   214
		pTimer = new ITimer;
dvander@592
   215
	} else {
dvander@592
   216
		pTimer = m_FreeTimers.front();
dvander@592
   217
		m_FreeTimers.pop();
dvander@592
   218
	}
dvander@592
   219
dvander@592
   220
	pTimer->Initialize(pCallbacks, fInterval, to_exec, pData, flags);
dvander@592
   221
dvander@592
   222
	if (flags & TIMER_FLAG_REPEAT)
dvander@592
   223
	{
dvander@592
   224
		m_LoopTimers.push_back(pTimer);
dvander@592
   225
		goto return_timer;
dvander@592
   226
	}
dvander@592
   227
dvander@1407
   228
	if (flags & TIMER_FLAG_BEFORE_MAP_END)
dvander@592
   229
	{
dvander@1407
   230
		for (iter=m_MapEndTimers.begin(); iter!=m_MapEndTimers.end(); iter++)
dvander@592
   231
		{
dvander@1407
   232
			if (fInterval >= (*iter)->m_Interval)
dvander@1407
   233
			{
dvander@1407
   234
				m_MapEndTimers.insert(iter, pTimer);
dvander@1407
   235
				goto return_timer;
dvander@1407
   236
			}
dvander@592
   237
		}
dvander@592
   238
dvander@1407
   239
		m_MapEndTimers.push_back(pTimer);
dvander@1407
   240
	} else {
dvander@1407
   241
		if (m_SingleTimers.size() >= 1)
dvander@592
   242
		{
dvander@1407
   243
			iter = --m_SingleTimers.end();
dvander@1407
   244
			if ((*iter)->m_ToExec <= to_exec)
dvander@1407
   245
			{
dvander@1407
   246
				goto normal_insert_end;
dvander@1407
   247
			}
dvander@592
   248
		}
dvander@1407
   249
	
dvander@1407
   250
		for (iter=m_SingleTimers.begin(); iter!=m_SingleTimers.end(); iter++)
dvander@1407
   251
		{
dvander@1407
   252
			if ((*iter)->m_ToExec >= to_exec)
dvander@1407
   253
			{
dvander@1407
   254
				m_SingleTimers.insert(iter, pTimer);
dvander@1407
   255
				goto return_timer;
dvander@1407
   256
			}
dvander@1407
   257
		}
dvander@1407
   258
dvander@1407
   259
normal_insert_end:
dvander@1407
   260
		m_SingleTimers.push_back(pTimer);
dvander@592
   261
	}
dvander@592
   262
dvander@592
   263
return_timer:
dvander@592
   264
	return pTimer;
dvander@592
   265
}
dvander@592
   266
dvander@616
   267
void TimerSystem::FireTimerOnce(ITimer *pTimer, bool delayExec)
dvander@592
   268
{
dvander@592
   269
	ResultType res;
dvander@592
   270
dvander@592
   271
	if (pTimer->m_InExec)
dvander@592
   272
	{
dvander@592
   273
		return;
dvander@592
   274
	}
dvander@592
   275
dvander@592
   276
	pTimer->m_InExec = true;
dvander@592
   277
	res = pTimer->m_Listener->OnTimer(pTimer, pTimer->m_pData);
dvander@592
   278
dvander@592
   279
	if (!(pTimer->m_Flags & TIMER_FLAG_REPEAT))
dvander@592
   280
	{
dvander@592
   281
		pTimer->m_Listener->OnTimerEnd(pTimer, pTimer->m_pData);
dvander@1407
   282
		if (pTimer->m_Flags & TIMER_FLAG_BEFORE_MAP_END)
dvander@1407
   283
		{
dvander@1407
   284
			m_MapEndTimers.remove(pTimer);
dvander@1407
   285
		} else {
dvander@1407
   286
			m_SingleTimers.remove(pTimer);
dvander@1407
   287
		}
dvander@592
   288
		m_FreeTimers.push(pTimer);
dvander@592
   289
	} else {
faluco@612
   290
		if ((res != Pl_Stop) && !pTimer->m_KillMe)
dvander@592
   291
		{
faluco@612
   292
			if (delayExec)
faluco@612
   293
			{
dvander@727
   294
				pTimer->m_ToExec = GetSimulatedTime() + pTimer->m_Interval;
faluco@612
   295
			}
dvander@592
   296
			pTimer->m_InExec = false;
dvander@592
   297
			return;
dvander@592
   298
		}
dvander@592
   299
		pTimer->m_Listener->OnTimerEnd(pTimer, pTimer->m_pData);
dvander@592
   300
		m_LoopTimers.remove(pTimer);
dvander@592
   301
		m_FreeTimers.push(pTimer);
dvander@592
   302
	}
dvander@592
   303
}
dvander@592
   304
dvander@616
   305
void TimerSystem::KillTimer(ITimer *pTimer)
dvander@592
   306
{
dvander@592
   307
	if (pTimer->m_KillMe)
dvander@592
   308
	{
dvander@592
   309
		return;
dvander@592
   310
	}
dvander@592
   311
dvander@592
   312
	if (pTimer->m_InExec)
dvander@592
   313
	{
dvander@592
   314
		pTimer->m_KillMe = true;
dvander@592
   315
		return;
dvander@592
   316
	}
dvander@592
   317
dvander@592
   318
	pTimer->m_InExec = true; /* The timer it's not really executed but this check needs to be done */
dvander@592
   319
	pTimer->m_Listener->OnTimerEnd(pTimer, pTimer->m_pData);
dvander@592
   320
dvander@1407
   321
	if (pTimer->m_Flags & TIMER_FLAG_REPEAT)
dvander@1407
   322
	{
dvander@1407
   323
		m_LoopTimers.remove(pTimer);
dvander@1407
   324
	} else if (pTimer->m_Flags & TIMER_FLAG_BEFORE_MAP_END) {
dvander@1407
   325
		m_MapEndTimers.remove(pTimer);
dvander@1407
   326
	} else {
dvander@1407
   327
		m_SingleTimers.remove(pTimer);
dvander@1407
   328
	}
dvander@592
   329
dvander@592
   330
	m_FreeTimers.push(pTimer);
dvander@592
   331
}
dvander@592
   332
dvander@1108
   333
CStack<ITimer *> s_tokill;
dvander@1142
   334
void TimerSystem::MapChange(bool real_mapchange)
dvander@592
   335
{
dvander@592
   336
	ITimer *pTimer;
dvander@592
   337
	TimerIter iter;
dvander@592
   338
dvander@592
   339
	for (iter=m_SingleTimers.begin(); iter!=m_SingleTimers.end(); iter++)
dvander@592
   340
	{
dvander@592
   341
		pTimer = (*iter);
dvander@1142
   342
		if (real_mapchange && (pTimer->m_Flags & TIMER_FLAG_NO_MAPCHANGE))
dvander@1108
   343
		{
dvander@1108
   344
			s_tokill.push(pTimer);
dvander@1108
   345
		}
dvander@592
   346
	}
dvander@592
   347
dvander@592
   348
	for (iter=m_LoopTimers.begin(); iter!=m_LoopTimers.end(); iter++)
dvander@592
   349
	{
dvander@592
   350
		pTimer = (*iter);
dvander@1142
   351
		if (real_mapchange && (pTimer->m_Flags & TIMER_FLAG_NO_MAPCHANGE))
dvander@1108
   352
		{
dvander@1108
   353
			s_tokill.push(pTimer);
dvander@1108
   354
		}
dvander@1108
   355
	}
dvander@1108
   356
dvander@1407
   357
	if (real_mapchange)
dvander@1407
   358
	{
dvander@1407
   359
		for (iter=m_MapEndTimers.begin(); iter!=m_MapEndTimers.end(); iter++)
dvander@1407
   360
		{
dvander@1407
   361
			pTimer = (*iter);
dvander@1407
   362
			s_tokill.push(pTimer);
dvander@1407
   363
		}
dvander@1407
   364
	}
dvander@1407
   365
dvander@1108
   366
	while (!s_tokill.empty())
dvander@1108
   367
	{
dvander@1108
   368
		KillTimer(s_tokill.front());
dvander@1108
   369
		s_tokill.pop();
dvander@592
   370
	}
dvander@592
   371
}
dvander@1407
   372
dvander@1407
   373
SM_TIMELEFT_FUNCTION TimerSystem::SetTimeLeftFunction(SM_TIMELEFT_FUNCTION fn)
dvander@1407
   374
{
dvander@1407
   375
	SM_TIMELEFT_FUNCTION old = m_fnTimeLeft;
dvander@1407
   376
	m_fnTimeLeft = fn;
dvander@1407
   377
	return old;
dvander@1407
   378
}
dvander@1407
   379