core/TimerSys.cpp
author David Anderson <dvander@alliedmods.net>
Tue Sep 11 18:02:59 2007 +0000 (2007-09-11)
changeset 1407 bb6516a50eea
parent 1371 d207f0e17532
child 1408 2fd63cc4bd9c
permissions -rw-r--r--
removed tick simulator and added api to help with mapchanges
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@1371
    34
#include "sourcemm_api.h"
dvander@592
    35
dvander@616
    36
TimerSystem g_Timers;
dvander@727
    37
dvander@1371
    38
ConVar sm_time_adjustment("sm_time_adjustment", "0", 0, "Adjusts the server time in seconds");
dvander@1371
    39
dvander@1371
    40
time_t GetAdjustedTime(time_t *buf)
dvander@1371
    41
{
dvander@1371
    42
	time_t val = time(NULL) + sm_time_adjustment.GetInt();
dvander@1371
    43
	if (buf)
dvander@1371
    44
	{
dvander@1371
    45
		*buf = val;
dvander@1371
    46
	}
dvander@1371
    47
	return val;
dvander@1371
    48
}
dvander@1371
    49
dvander@727
    50
inline float GetSimulatedTime()
dvander@727
    51
{
dvander@1407
    52
	return engine->Time();
dvander@727
    53
}
dvander@592
    54
dvander@592
    55
void ITimer::Initialize(ITimedEvent *pCallbacks, float fInterval, float fToExec, void *pData, int flags)
dvander@592
    56
{
dvander@592
    57
	m_Listener = pCallbacks;
dvander@592
    58
	m_Interval = fInterval;
dvander@592
    59
	m_ToExec = fToExec;
dvander@592
    60
	m_pData = pData;
dvander@592
    61
	m_Flags = flags;
dvander@592
    62
	m_InExec = false;
dvander@592
    63
	m_KillMe = false;
dvander@592
    64
}
dvander@592
    65
faluco@641
    66
TimerSystem::~TimerSystem()
faluco@641
    67
{
faluco@641
    68
	CStack<ITimer *>::iterator iter;
faluco@641
    69
	for (iter=m_FreeTimers.begin(); iter!=m_FreeTimers.end(); iter++)
faluco@641
    70
	{
faluco@641
    71
		delete (*iter);
faluco@641
    72
	}
faluco@641
    73
	m_FreeTimers.popall();
faluco@641
    74
}
faluco@641
    75
dvander@616
    76
void TimerSystem::OnSourceModAllInitialized()
dvander@592
    77
{
dvander@592
    78
	g_ShareSys.AddInterface(NULL, this);
dvander@592
    79
}
dvander@592
    80
dvander@673
    81
void TimerSystem::OnSourceModLevelChange(const char *mapName)
dvander@673
    82
{
dvander@1142
    83
	MapChange(true);
dvander@673
    84
}
dvander@673
    85
dvander@616
    86
void TimerSystem::RunFrame()
dvander@592
    87
{
dvander@592
    88
	ITimer *pTimer;
dvander@592
    89
	TimerIter iter;
dvander@592
    90
dvander@727
    91
	float curtime = GetSimulatedTime();
dvander@592
    92
	for (iter=m_SingleTimers.begin(); iter!=m_SingleTimers.end(); )
dvander@592
    93
	{
dvander@592
    94
		pTimer = (*iter);
dvander@727
    95
		if (curtime >= pTimer->m_ToExec)
dvander@592
    96
		{
dvander@592
    97
			pTimer->m_InExec = true;
dvander@592
    98
			pTimer->m_Listener->OnTimer(pTimer, pTimer->m_pData);
faluco@612
    99
			pTimer->m_Listener->OnTimerEnd(pTimer, pTimer->m_pData);
dvander@592
   100
			iter = m_SingleTimers.erase(iter);
dvander@592
   101
			m_FreeTimers.push(pTimer);
dvander@592
   102
		} else {
dvander@592
   103
			break;
dvander@592
   104
		}
dvander@592
   105
	}
dvander@592
   106
dvander@1407
   107
	if (m_fnTimeLeft != NULL && m_MapEndTimers.size())
dvander@1407
   108
	{
dvander@1407
   109
		float time_left = m_fnTimeLeft();
dvander@1407
   110
		for (iter=m_MapEndTimers.begin(); iter!=m_MapEndTimers.end();)
dvander@1407
   111
		{
dvander@1407
   112
			pTimer = (*iter);
dvander@1407
   113
			if ((*iter)->m_Interval < time_left)
dvander@1407
   114
			{
dvander@1407
   115
				pTimer->m_InExec = true;
dvander@1407
   116
				pTimer->m_Listener->OnTimer(pTimer, pTimer->m_pData);
dvander@1407
   117
				pTimer->m_Listener->OnTimerEnd(pTimer, pTimer->m_pData);
dvander@1407
   118
				iter = m_MapEndTimers.erase(iter);
dvander@1407
   119
				m_FreeTimers.push(pTimer);
dvander@1407
   120
			} else {
dvander@1407
   121
				break;
dvander@1407
   122
			}
dvander@1407
   123
		}
dvander@1407
   124
	}
dvander@1407
   125
dvander@592
   126
	ResultType res;
dvander@592
   127
	for (iter=m_LoopTimers.begin(); iter!=m_LoopTimers.end(); )
dvander@592
   128
	{
dvander@592
   129
		pTimer = (*iter);
dvander@727
   130
		if (curtime >= pTimer->m_ToExec)
dvander@592
   131
		{
dvander@592
   132
			pTimer->m_InExec = true;
dvander@592
   133
			res = pTimer->m_Listener->OnTimer(pTimer, pTimer->m_pData);
dvander@592
   134
			if (pTimer->m_KillMe || (res == Pl_Stop))
dvander@592
   135
			{
dvander@592
   136
				pTimer->m_Listener->OnTimerEnd(pTimer, pTimer->m_pData);
dvander@592
   137
				iter = m_LoopTimers.erase(iter);
dvander@592
   138
				m_FreeTimers.push(pTimer);
dvander@592
   139
				continue;
dvander@592
   140
			}
dvander@592
   141
			pTimer->m_InExec = false;
dvander@727
   142
			pTimer->m_ToExec = curtime + pTimer->m_Interval;
dvander@592
   143
		}
dvander@592
   144
		iter++;
dvander@592
   145
	}
dvander@592
   146
dvander@727
   147
	m_LastExecTime = curtime;
dvander@592
   148
}
dvander@592
   149
dvander@616
   150
ITimer *TimerSystem::CreateTimer(ITimedEvent *pCallbacks, float fInterval, void *pData, int flags)
dvander@592
   151
{
dvander@592
   152
	ITimer *pTimer;
dvander@592
   153
	TimerIter iter;
dvander@727
   154
	float to_exec = GetSimulatedTime() + fInterval;
dvander@592
   155
dvander@592
   156
	if (m_FreeTimers.empty())
dvander@592
   157
	{
dvander@592
   158
		pTimer = new ITimer;
dvander@592
   159
	} else {
dvander@592
   160
		pTimer = m_FreeTimers.front();
dvander@592
   161
		m_FreeTimers.pop();
dvander@592
   162
	}
dvander@592
   163
dvander@592
   164
	pTimer->Initialize(pCallbacks, fInterval, to_exec, pData, flags);
dvander@592
   165
dvander@592
   166
	if (flags & TIMER_FLAG_REPEAT)
dvander@592
   167
	{
dvander@592
   168
		m_LoopTimers.push_back(pTimer);
dvander@592
   169
		goto return_timer;
dvander@592
   170
	}
dvander@592
   171
dvander@1407
   172
	if (flags & TIMER_FLAG_BEFORE_MAP_END)
dvander@592
   173
	{
dvander@1407
   174
		for (iter=m_MapEndTimers.begin(); iter!=m_MapEndTimers.end(); iter++)
dvander@592
   175
		{
dvander@1407
   176
			if (fInterval >= (*iter)->m_Interval)
dvander@1407
   177
			{
dvander@1407
   178
				m_MapEndTimers.insert(iter, pTimer);
dvander@1407
   179
				goto return_timer;
dvander@1407
   180
			}
dvander@592
   181
		}
dvander@592
   182
dvander@1407
   183
		m_MapEndTimers.push_back(pTimer);
dvander@1407
   184
	} else {
dvander@1407
   185
		if (m_SingleTimers.size() >= 1)
dvander@592
   186
		{
dvander@1407
   187
			iter = --m_SingleTimers.end();
dvander@1407
   188
			if ((*iter)->m_ToExec <= to_exec)
dvander@1407
   189
			{
dvander@1407
   190
				goto normal_insert_end;
dvander@1407
   191
			}
dvander@592
   192
		}
dvander@1407
   193
	
dvander@1407
   194
		for (iter=m_SingleTimers.begin(); iter!=m_SingleTimers.end(); iter++)
dvander@1407
   195
		{
dvander@1407
   196
			if ((*iter)->m_ToExec >= to_exec)
dvander@1407
   197
			{
dvander@1407
   198
				m_SingleTimers.insert(iter, pTimer);
dvander@1407
   199
				goto return_timer;
dvander@1407
   200
			}
dvander@1407
   201
		}
dvander@1407
   202
dvander@1407
   203
normal_insert_end:
dvander@1407
   204
		m_SingleTimers.push_back(pTimer);
dvander@592
   205
	}
dvander@592
   206
dvander@592
   207
return_timer:
dvander@592
   208
	return pTimer;
dvander@592
   209
}
dvander@592
   210
dvander@616
   211
void TimerSystem::FireTimerOnce(ITimer *pTimer, bool delayExec)
dvander@592
   212
{
dvander@592
   213
	ResultType res;
dvander@592
   214
dvander@592
   215
	if (pTimer->m_InExec)
dvander@592
   216
	{
dvander@592
   217
		return;
dvander@592
   218
	}
dvander@592
   219
dvander@592
   220
	pTimer->m_InExec = true;
dvander@592
   221
	res = pTimer->m_Listener->OnTimer(pTimer, pTimer->m_pData);
dvander@592
   222
dvander@592
   223
	if (!(pTimer->m_Flags & TIMER_FLAG_REPEAT))
dvander@592
   224
	{
dvander@592
   225
		pTimer->m_Listener->OnTimerEnd(pTimer, pTimer->m_pData);
dvander@1407
   226
		if (pTimer->m_Flags & TIMER_FLAG_BEFORE_MAP_END)
dvander@1407
   227
		{
dvander@1407
   228
			m_MapEndTimers.remove(pTimer);
dvander@1407
   229
		} else {
dvander@1407
   230
			m_SingleTimers.remove(pTimer);
dvander@1407
   231
		}
dvander@592
   232
		m_FreeTimers.push(pTimer);
dvander@592
   233
	} else {
faluco@612
   234
		if ((res != Pl_Stop) && !pTimer->m_KillMe)
dvander@592
   235
		{
faluco@612
   236
			if (delayExec)
faluco@612
   237
			{
dvander@727
   238
				pTimer->m_ToExec = GetSimulatedTime() + pTimer->m_Interval;
faluco@612
   239
			}
dvander@592
   240
			pTimer->m_InExec = false;
dvander@592
   241
			return;
dvander@592
   242
		}
dvander@592
   243
		pTimer->m_Listener->OnTimerEnd(pTimer, pTimer->m_pData);
dvander@592
   244
		m_LoopTimers.remove(pTimer);
dvander@592
   245
		m_FreeTimers.push(pTimer);
dvander@592
   246
	}
dvander@592
   247
}
dvander@592
   248
dvander@616
   249
void TimerSystem::KillTimer(ITimer *pTimer)
dvander@592
   250
{
dvander@592
   251
	TimerList *pList;
dvander@592
   252
dvander@592
   253
	if (pTimer->m_KillMe)
dvander@592
   254
	{
dvander@592
   255
		return;
dvander@592
   256
	}
dvander@592
   257
dvander@592
   258
	if (pTimer->m_InExec)
dvander@592
   259
	{
dvander@592
   260
		pTimer->m_KillMe = true;
dvander@592
   261
		return;
dvander@592
   262
	}
dvander@592
   263
dvander@592
   264
	pTimer->m_InExec = true; /* The timer it's not really executed but this check needs to be done */
dvander@592
   265
	pTimer->m_Listener->OnTimerEnd(pTimer, pTimer->m_pData);
dvander@592
   266
dvander@1407
   267
	if (pTimer->m_Flags & TIMER_FLAG_REPEAT)
dvander@1407
   268
	{
dvander@1407
   269
		m_LoopTimers.remove(pTimer);
dvander@1407
   270
	} else if (pTimer->m_Flags & TIMER_FLAG_BEFORE_MAP_END) {
dvander@1407
   271
		m_MapEndTimers.remove(pTimer);
dvander@1407
   272
	} else {
dvander@1407
   273
		m_SingleTimers.remove(pTimer);
dvander@1407
   274
	}
dvander@592
   275
dvander@592
   276
	pList->remove(pTimer);
dvander@592
   277
	m_FreeTimers.push(pTimer);
dvander@592
   278
}
dvander@592
   279
dvander@1108
   280
CStack<ITimer *> s_tokill;
dvander@1142
   281
void TimerSystem::MapChange(bool real_mapchange)
dvander@592
   282
{
dvander@592
   283
	ITimer *pTimer;
dvander@592
   284
	TimerIter iter;
dvander@592
   285
dvander@592
   286
	for (iter=m_SingleTimers.begin(); iter!=m_SingleTimers.end(); iter++)
dvander@592
   287
	{
dvander@592
   288
		pTimer = (*iter);
dvander@1142
   289
		if (real_mapchange && (pTimer->m_Flags & TIMER_FLAG_NO_MAPCHANGE))
dvander@1108
   290
		{
dvander@1108
   291
			s_tokill.push(pTimer);
dvander@1108
   292
		} else {
dvander@1108
   293
			pTimer->m_ToExec = pTimer->m_ToExec - m_LastExecTime + GetSimulatedTime();
dvander@1108
   294
		}
dvander@592
   295
	}
dvander@592
   296
dvander@592
   297
	for (iter=m_LoopTimers.begin(); iter!=m_LoopTimers.end(); iter++)
dvander@592
   298
	{
dvander@592
   299
		pTimer = (*iter);
dvander@1142
   300
		if (real_mapchange && (pTimer->m_Flags & TIMER_FLAG_NO_MAPCHANGE))
dvander@1108
   301
		{
dvander@1108
   302
			s_tokill.push(pTimer);
dvander@1108
   303
		} else {
dvander@1108
   304
			pTimer->m_ToExec = pTimer->m_ToExec - m_LastExecTime + GetSimulatedTime();
dvander@1108
   305
		}
dvander@1108
   306
	}
dvander@1108
   307
dvander@1407
   308
	if (real_mapchange)
dvander@1407
   309
	{
dvander@1407
   310
		for (iter=m_MapEndTimers.begin(); iter!=m_MapEndTimers.end(); iter++)
dvander@1407
   311
		{
dvander@1407
   312
			pTimer = (*iter);
dvander@1407
   313
			s_tokill.push(pTimer);
dvander@1407
   314
		}
dvander@1407
   315
	}
dvander@1407
   316
dvander@1108
   317
	while (!s_tokill.empty())
dvander@1108
   318
	{
dvander@1108
   319
		KillTimer(s_tokill.front());
dvander@1108
   320
		s_tokill.pop();
dvander@592
   321
	}
dvander@727
   322
dvander@727
   323
	m_LastExecTime = GetSimulatedTime();
dvander@592
   324
}
dvander@1407
   325
dvander@1407
   326
SM_TIMELEFT_FUNCTION TimerSystem::SetTimeLeftFunction(SM_TIMELEFT_FUNCTION fn)
dvander@1407
   327
{
dvander@1407
   328
	SM_TIMELEFT_FUNCTION old = m_fnTimeLeft;
dvander@1407
   329
	m_fnTimeLeft = fn;
dvander@1407
   330
	return old;
dvander@1407
   331
}
dvander@1407
   332