core/TimerSys.cpp
author David Anderson <dvander@alliedmods.net>
Thu Sep 13 00:33:56 2007 +0000 (2007-09-13)
changeset 1414 bb258bffc7df
parent 1412 a2ca3d22dd71
child 1415 edf4efe5707c
permissions -rw-r--r--
overhaul of the map timer idea -- function is now an interface, and the timer flag is removed
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@1414
    38
SH_DECL_HOOK2_void(ICvar, CallGlobalChangeCallback, SH_NOATTRIB, false, ConVar *, const char *);
dvander@1414
    39
dvander@616
    40
TimerSystem g_Timers;
dvander@1412
    41
float g_fUniversalTime = 0.0f;
dvander@1414
    42
float g_fMapStartTime = 0.0f;
dvander@1412
    43
const float *g_pUniversalTime = &g_fUniversalTime;
dvander@1414
    44
ConVar *mp_timelimit = NULL;
dvander@727
    45
dvander@1371
    46
ConVar sm_time_adjustment("sm_time_adjustment", "0", 0, "Adjusts the server time in seconds");
dvander@1371
    47
dvander@1412
    48
inline float GetSimulatedTime()
dvander@1412
    49
{
dvander@1412
    50
	return g_fUniversalTime;
dvander@1412
    51
}
dvander@1410
    52
dvander@1371
    53
time_t GetAdjustedTime(time_t *buf)
dvander@1371
    54
{
dvander@1371
    55
	time_t val = time(NULL) + sm_time_adjustment.GetInt();
dvander@1371
    56
	if (buf)
dvander@1371
    57
	{
dvander@1371
    58
		*buf = val;
dvander@1371
    59
	}
dvander@1371
    60
	return val;
dvander@1371
    61
}
dvander@1371
    62
dvander@1414
    63
class DefaultMapTimer : 
dvander@1414
    64
	public IMapTimer,
dvander@1414
    65
	public SMGlobalClass
dvander@1414
    66
{
dvander@1414
    67
public:
dvander@1414
    68
	DefaultMapTimer()
dvander@1414
    69
	{
dvander@1414
    70
		m_bInUse = false;
dvander@1414
    71
	}
dvander@1414
    72
dvander@1414
    73
	int GetMapTimeLimit()
dvander@1414
    74
	{
dvander@1414
    75
		return mp_timelimit->GetInt();
dvander@1414
    76
	}
dvander@1414
    77
dvander@1414
    78
	void SetMapTimerStatus(bool enabled)
dvander@1414
    79
	{
dvander@1414
    80
		if (enabled && !m_bInUse)
dvander@1414
    81
		{
dvander@1414
    82
			Enable();
dvander@1414
    83
		} 
dvander@1414
    84
		else if (!enabled && m_bInUse)
dvander@1414
    85
		{
dvander@1414
    86
			Disable();
dvander@1414
    87
		}
dvander@1414
    88
		m_bInUse = enabled;
dvander@1414
    89
	}
dvander@1414
    90
dvander@1414
    91
	 bool GetMapTimeLeft(int *time_left)
dvander@1414
    92
	{
dvander@1414
    93
		if (GetMapTimeLimit() == 0)
dvander@1414
    94
		{
dvander@1414
    95
			return false;
dvander@1414
    96
		}
dvander@1414
    97
dvander@1414
    98
		*time_left = (int)((g_fMapStartTime + mp_timelimit->GetInt() * 60.0f) - g_fUniversalTime);
dvander@1414
    99
dvander@1414
   100
		return true;
dvander@1414
   101
	}
dvander@1414
   102
dvander@1414
   103
	void ExtendMapTimeLimit(int extra_time)
dvander@1414
   104
	{
dvander@1414
   105
		extra_time /= 60;
dvander@1414
   106
dvander@1414
   107
		if (extra_time == 0)
dvander@1414
   108
		{
dvander@1414
   109
			mp_timelimit->SetValue(0);
dvander@1414
   110
			return;
dvander@1414
   111
		}
dvander@1414
   112
dvander@1414
   113
		mp_timelimit->SetValue(mp_timelimit->GetInt() + extra_time);
dvander@1414
   114
	}
dvander@1414
   115
dvander@1414
   116
	void GlobalChangeCallback(ConVar *pVar, const char *old_value)
dvander@1414
   117
	{
dvander@1414
   118
		if (pVar != mp_timelimit)
dvander@1414
   119
		{
dvander@1414
   120
			return;
dvander@1414
   121
		}
dvander@1414
   122
dvander@1414
   123
		g_Timers.MapTimeLimitExtended(atoi(old_value) * 60, pVar->GetInt() * 60);
dvander@1414
   124
	}
dvander@1414
   125
dvander@1414
   126
private:
dvander@1414
   127
	void Enable()
dvander@1414
   128
	{
dvander@1414
   129
		SH_ADD_HOOK_MEMFUNC(ICvar, CallGlobalChangeCallback, icvar, this, &DefaultMapTimer::GlobalChangeCallback, false);
dvander@1414
   130
	}
dvander@1414
   131
dvander@1414
   132
	void Disable()
dvander@1414
   133
	{
dvander@1414
   134
		SH_REMOVE_HOOK_MEMFUNC(ICvar, CallGlobalChangeCallback, icvar, this, &DefaultMapTimer::GlobalChangeCallback, false);
dvander@1414
   135
	}
dvander@1414
   136
dvander@1414
   137
private:
dvander@1414
   138
	bool m_bInUse;
dvander@1414
   139
} s_DefaultMapTimer;
dvander@1414
   140
dvander@592
   141
void ITimer::Initialize(ITimedEvent *pCallbacks, float fInterval, float fToExec, void *pData, int flags)
dvander@592
   142
{
dvander@592
   143
	m_Listener = pCallbacks;
dvander@592
   144
	m_Interval = fInterval;
dvander@592
   145
	m_ToExec = fToExec;
dvander@592
   146
	m_pData = pData;
dvander@592
   147
	m_Flags = flags;
dvander@592
   148
	m_InExec = false;
dvander@592
   149
	m_KillMe = false;
dvander@592
   150
}
dvander@592
   151
dvander@1408
   152
TimerSystem::TimerSystem()
dvander@1408
   153
{
dvander@1414
   154
	m_pMapTimer = NULL;
dvander@1412
   155
	m_bHasMapTickedYet = false;
dvander@1412
   156
	m_fLastTickedTime = 0.0f;
dvander@1412
   157
	m_LastExecTime = 0.0f;
dvander@1408
   158
}
dvander@1408
   159
faluco@641
   160
TimerSystem::~TimerSystem()
faluco@641
   161
{
faluco@641
   162
	CStack<ITimer *>::iterator iter;
faluco@641
   163
	for (iter=m_FreeTimers.begin(); iter!=m_FreeTimers.end(); iter++)
faluco@641
   164
	{
faluco@641
   165
		delete (*iter);
faluco@641
   166
	}
faluco@641
   167
	m_FreeTimers.popall();
faluco@641
   168
}
faluco@641
   169
dvander@616
   170
void TimerSystem::OnSourceModAllInitialized()
dvander@592
   171
{
dvander@592
   172
	g_ShareSys.AddInterface(NULL, this);
dvander@1412
   173
	m_pOnGameFrame = g_Forwards.CreateForward("OnGameFrame", ET_Ignore, 0, NULL);
dvander@1412
   174
}
dvander@1412
   175
dvander@1414
   176
void TimerSystem::OnSourceModGameInitialized()
dvander@1414
   177
{
dvander@1414
   178
	mp_timelimit = icvar->FindVar("mp_timelimit");
dvander@1414
   179
dvander@1414
   180
	if (m_pMapTimer == NULL && mp_timelimit != NULL)
dvander@1414
   181
	{
dvander@1414
   182
		SetMapTimer(&s_DefaultMapTimer);
dvander@1414
   183
	}
dvander@1414
   184
}
dvander@1414
   185
dvander@1412
   186
void TimerSystem::OnSourceModShutdown()
dvander@1412
   187
{
dvander@1414
   188
	SetMapTimer(NULL);
dvander@1412
   189
	g_Forwards.ReleaseForward(m_pOnGameFrame);
dvander@592
   190
}
dvander@592
   191
dvander@673
   192
void TimerSystem::OnSourceModLevelChange(const char *mapName)
dvander@673
   193
{
dvander@1142
   194
	MapChange(true);
dvander@673
   195
}
dvander@673
   196
dvander@1412
   197
void TimerSystem::OnSourceModLevelEnd()
dvander@1412
   198
{
dvander@1412
   199
	m_bHasMapTickedYet = false;
dvander@1412
   200
}
dvander@1412
   201
dvander@1412
   202
void TimerSystem::GameFrame(bool simulating)
dvander@1412
   203
{
dvander@1412
   204
	if (simulating && m_bHasMapTickedYet)
dvander@1412
   205
	{
dvander@1412
   206
		g_fUniversalTime += gpGlobals->curtime - m_fLastTickedTime;
dvander@1412
   207
	}
dvander@1412
   208
	else 
dvander@1412
   209
	{
dvander@1412
   210
		g_fUniversalTime += gpGlobals->interval_per_tick;
dvander@1412
   211
	}
dvander@1412
   212
dvander@1412
   213
	m_fLastTickedTime = gpGlobals->curtime;
dvander@1414
   214
	if (!m_bHasMapTickedYet)
dvander@1414
   215
	{
dvander@1414
   216
		g_fMapStartTime = g_fUniversalTime;
dvander@1414
   217
		m_bHasMapTickedYet = true;
dvander@1414
   218
	}
dvander@1412
   219
dvander@1412
   220
	if (g_fUniversalTime - m_LastExecTime >= 0.1)
dvander@1412
   221
	{
dvander@1412
   222
		RunFrame();
dvander@1412
   223
	}
dvander@1412
   224
dvander@1412
   225
	RunFrameHooks();
dvander@1412
   226
dvander@1412
   227
	if (m_pOnGameFrame->GetFunctionCount())
dvander@1412
   228
	{
dvander@1412
   229
		m_pOnGameFrame->Execute(NULL);
dvander@1412
   230
	}
dvander@1412
   231
}
dvander@1412
   232
dvander@616
   233
void TimerSystem::RunFrame()
dvander@592
   234
{
dvander@592
   235
	ITimer *pTimer;
dvander@592
   236
	TimerIter iter;
dvander@592
   237
dvander@727
   238
	float curtime = GetSimulatedTime();
dvander@592
   239
	for (iter=m_SingleTimers.begin(); iter!=m_SingleTimers.end(); )
dvander@592
   240
	{
dvander@592
   241
		pTimer = (*iter);
dvander@727
   242
		if (curtime >= pTimer->m_ToExec)
dvander@592
   243
		{
dvander@592
   244
			pTimer->m_InExec = true;
dvander@592
   245
			pTimer->m_Listener->OnTimer(pTimer, pTimer->m_pData);
faluco@612
   246
			pTimer->m_Listener->OnTimerEnd(pTimer, pTimer->m_pData);
dvander@592
   247
			iter = m_SingleTimers.erase(iter);
dvander@592
   248
			m_FreeTimers.push(pTimer);
dvander@592
   249
		} else {
dvander@592
   250
			break;
dvander@592
   251
		}
dvander@592
   252
	}
dvander@592
   253
dvander@592
   254
	ResultType res;
dvander@592
   255
	for (iter=m_LoopTimers.begin(); iter!=m_LoopTimers.end(); )
dvander@592
   256
	{
dvander@592
   257
		pTimer = (*iter);
dvander@727
   258
		if (curtime >= pTimer->m_ToExec)
dvander@592
   259
		{
dvander@592
   260
			pTimer->m_InExec = true;
dvander@592
   261
			res = pTimer->m_Listener->OnTimer(pTimer, pTimer->m_pData);
dvander@592
   262
			if (pTimer->m_KillMe || (res == Pl_Stop))
dvander@592
   263
			{
dvander@592
   264
				pTimer->m_Listener->OnTimerEnd(pTimer, pTimer->m_pData);
dvander@592
   265
				iter = m_LoopTimers.erase(iter);
dvander@592
   266
				m_FreeTimers.push(pTimer);
dvander@592
   267
				continue;
dvander@592
   268
			}
dvander@592
   269
			pTimer->m_InExec = false;
dvander@727
   270
			pTimer->m_ToExec = curtime + pTimer->m_Interval;
dvander@592
   271
		}
dvander@592
   272
		iter++;
dvander@592
   273
	}
dvander@592
   274
dvander@727
   275
	m_LastExecTime = curtime;
dvander@592
   276
}
dvander@592
   277
dvander@616
   278
ITimer *TimerSystem::CreateTimer(ITimedEvent *pCallbacks, float fInterval, void *pData, int flags)
dvander@592
   279
{
dvander@592
   280
	ITimer *pTimer;
dvander@592
   281
	TimerIter iter;
dvander@727
   282
	float to_exec = GetSimulatedTime() + fInterval;
dvander@592
   283
dvander@592
   284
	if (m_FreeTimers.empty())
dvander@592
   285
	{
dvander@592
   286
		pTimer = new ITimer;
dvander@592
   287
	} else {
dvander@592
   288
		pTimer = m_FreeTimers.front();
dvander@592
   289
		m_FreeTimers.pop();
dvander@592
   290
	}
dvander@592
   291
dvander@592
   292
	pTimer->Initialize(pCallbacks, fInterval, to_exec, pData, flags);
dvander@592
   293
dvander@592
   294
	if (flags & TIMER_FLAG_REPEAT)
dvander@592
   295
	{
dvander@592
   296
		m_LoopTimers.push_back(pTimer);
dvander@592
   297
		goto return_timer;
dvander@592
   298
	}
dvander@592
   299
dvander@1414
   300
	if (m_SingleTimers.size() >= 1)
dvander@592
   301
	{
dvander@1414
   302
		iter = --m_SingleTimers.end();
dvander@1414
   303
		if ((*iter)->m_ToExec <= to_exec)
dvander@592
   304
		{
dvander@1414
   305
			goto normal_insert_end;
dvander@592
   306
		}
dvander@1414
   307
	}
dvander@1414
   308
dvander@1414
   309
	for (iter=m_SingleTimers.begin(); iter!=m_SingleTimers.end(); iter++)
dvander@1414
   310
	{
dvander@1414
   311
		if ((*iter)->m_ToExec >= to_exec)
dvander@1407
   312
		{
dvander@1414
   313
			m_SingleTimers.insert(iter, pTimer);
dvander@1414
   314
			goto return_timer;
dvander@1407
   315
		}
dvander@1414
   316
	}
dvander@1407
   317
dvander@1407
   318
normal_insert_end:
dvander@1414
   319
	m_SingleTimers.push_back(pTimer);
dvander@592
   320
dvander@592
   321
return_timer:
dvander@592
   322
	return pTimer;
dvander@592
   323
}
dvander@592
   324
dvander@616
   325
void TimerSystem::FireTimerOnce(ITimer *pTimer, bool delayExec)
dvander@592
   326
{
dvander@592
   327
	ResultType res;
dvander@592
   328
dvander@592
   329
	if (pTimer->m_InExec)
dvander@592
   330
	{
dvander@592
   331
		return;
dvander@592
   332
	}
dvander@592
   333
dvander@592
   334
	pTimer->m_InExec = true;
dvander@592
   335
	res = pTimer->m_Listener->OnTimer(pTimer, pTimer->m_pData);
dvander@592
   336
dvander@592
   337
	if (!(pTimer->m_Flags & TIMER_FLAG_REPEAT))
dvander@592
   338
	{
dvander@592
   339
		pTimer->m_Listener->OnTimerEnd(pTimer, pTimer->m_pData);
dvander@1414
   340
		m_SingleTimers.remove(pTimer);
dvander@592
   341
		m_FreeTimers.push(pTimer);
dvander@592
   342
	} else {
faluco@612
   343
		if ((res != Pl_Stop) && !pTimer->m_KillMe)
dvander@592
   344
		{
faluco@612
   345
			if (delayExec)
faluco@612
   346
			{
dvander@727
   347
				pTimer->m_ToExec = GetSimulatedTime() + pTimer->m_Interval;
faluco@612
   348
			}
dvander@592
   349
			pTimer->m_InExec = false;
dvander@592
   350
			return;
dvander@592
   351
		}
dvander@592
   352
		pTimer->m_Listener->OnTimerEnd(pTimer, pTimer->m_pData);
dvander@592
   353
		m_LoopTimers.remove(pTimer);
dvander@592
   354
		m_FreeTimers.push(pTimer);
dvander@592
   355
	}
dvander@592
   356
}
dvander@592
   357
dvander@616
   358
void TimerSystem::KillTimer(ITimer *pTimer)
dvander@592
   359
{
dvander@592
   360
	if (pTimer->m_KillMe)
dvander@592
   361
	{
dvander@592
   362
		return;
dvander@592
   363
	}
dvander@592
   364
dvander@592
   365
	if (pTimer->m_InExec)
dvander@592
   366
	{
dvander@592
   367
		pTimer->m_KillMe = true;
dvander@592
   368
		return;
dvander@592
   369
	}
dvander@592
   370
dvander@592
   371
	pTimer->m_InExec = true; /* The timer it's not really executed but this check needs to be done */
dvander@592
   372
	pTimer->m_Listener->OnTimerEnd(pTimer, pTimer->m_pData);
dvander@592
   373
dvander@1407
   374
	if (pTimer->m_Flags & TIMER_FLAG_REPEAT)
dvander@1407
   375
	{
dvander@1407
   376
		m_LoopTimers.remove(pTimer);
dvander@1407
   377
	} else {
dvander@1407
   378
		m_SingleTimers.remove(pTimer);
dvander@1407
   379
	}
dvander@592
   380
dvander@592
   381
	m_FreeTimers.push(pTimer);
dvander@592
   382
}
dvander@592
   383
dvander@1108
   384
CStack<ITimer *> s_tokill;
dvander@1142
   385
void TimerSystem::MapChange(bool real_mapchange)
dvander@592
   386
{
dvander@592
   387
	ITimer *pTimer;
dvander@592
   388
	TimerIter iter;
dvander@592
   389
dvander@592
   390
	for (iter=m_SingleTimers.begin(); iter!=m_SingleTimers.end(); iter++)
dvander@592
   391
	{
dvander@592
   392
		pTimer = (*iter);
dvander@1142
   393
		if (real_mapchange && (pTimer->m_Flags & TIMER_FLAG_NO_MAPCHANGE))
dvander@1108
   394
		{
dvander@1108
   395
			s_tokill.push(pTimer);
dvander@1108
   396
		}
dvander@592
   397
	}
dvander@592
   398
dvander@592
   399
	for (iter=m_LoopTimers.begin(); iter!=m_LoopTimers.end(); iter++)
dvander@592
   400
	{
dvander@592
   401
		pTimer = (*iter);
dvander@1142
   402
		if (real_mapchange && (pTimer->m_Flags & TIMER_FLAG_NO_MAPCHANGE))
dvander@1108
   403
		{
dvander@1108
   404
			s_tokill.push(pTimer);
dvander@1108
   405
		}
dvander@1108
   406
	}
dvander@1108
   407
dvander@1108
   408
	while (!s_tokill.empty())
dvander@1108
   409
	{
dvander@1108
   410
		KillTimer(s_tokill.front());
dvander@1108
   411
		s_tokill.pop();
dvander@592
   412
	}
dvander@592
   413
}
dvander@1407
   414
dvander@1414
   415
IMapTimer *TimerSystem::SetMapTimer(IMapTimer *pTimer)
dvander@1407
   416
{
dvander@1414
   417
	IMapTimer *old = m_pMapTimer;
dvander@1414
   418
dvander@1414
   419
	m_pMapTimer = pTimer;
dvander@1414
   420
dvander@1414
   421
	if (m_pMapTimer)
dvander@1414
   422
	{
dvander@1414
   423
		m_pMapTimer->SetMapTimerStatus(true);
dvander@1414
   424
	}
dvander@1414
   425
dvander@1414
   426
	if (old)
dvander@1414
   427
	{
dvander@1414
   428
		old->SetMapTimerStatus(false);
dvander@1414
   429
	}
dvander@1414
   430
dvander@1407
   431
	return old;
dvander@1407
   432
}
dvander@1407
   433
dvander@1414
   434
IMapTimer *TimerSystem::GetMapTimer()
dvander@1414
   435
{
dvander@1414
   436
	return m_pMapTimer;
dvander@1414
   437
}
dvander@1414
   438
dvander@1414
   439
void TimerSystem::MapTimeLimitExtended(int old_limit, int new_limit)
dvander@1414
   440
{
dvander@1414
   441
	if (old_limit == new_limit)
dvander@1414
   442
	{
dvander@1414
   443
		return;
dvander@1414
   444
	}
dvander@1414
   445
}