core/smn_timers.cpp
author Matt Woodrow <pred@alliedmods.net>
Tue Mar 11 23:52:56 2008 +0000 (2008-03-11)
changeset 1921 f993e100e5a3
parent 1894 e6efc8ffa47a
child 1947 e73a1e51833b
permissions -rw-r--r--
Fixed bug in GetAdjustedTime()
faluco@612
     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
 */
faluco@612
    31
faluco@612
    32
#include "HandleSys.h"
faluco@612
    33
#include "TimerSys.h"
faluco@1674
    34
#include "PluginSys.h"
faluco@612
    35
#include "Logger.h"
faluco@1894
    36
#include "DebugReporter.h"
faluco@612
    37
faluco@612
    38
#define TIMER_HNDL_CLOSE	(1<<9)
faluco@612
    39
faluco@612
    40
HandleType_t g_TimerType;
faluco@612
    41
faluco@612
    42
struct TimerInfo 
faluco@612
    43
{
faluco@612
    44
	ITimer *Timer;
faluco@612
    45
	IPluginFunction *Hook;
faluco@612
    46
	IPluginContext *pContext;
faluco@612
    47
	Handle_t TimerHandle;
faluco@612
    48
	int UserData;
faluco@612
    49
	int Flags;
faluco@612
    50
};
faluco@612
    51
faluco@612
    52
class TimerNatives :
faluco@612
    53
	public SMGlobalClass,
faluco@612
    54
	public IHandleTypeDispatch,
faluco@612
    55
	public ITimedEvent
faluco@612
    56
{
faluco@641
    57
public:
faluco@641
    58
	~TimerNatives();
faluco@612
    59
public: //ITimedEvent
faluco@612
    60
	ResultType OnTimer(ITimer *pTimer, void *pData);
faluco@612
    61
	void OnTimerEnd(ITimer *pTimer, void *pData);
faluco@612
    62
public: //IHandleTypeDispatch
faluco@612
    63
	void OnHandleDestroy(HandleType_t type, void *object);
faluco@612
    64
public: //SMGlobalClass
faluco@612
    65
	void OnSourceModAllInitialized();
faluco@612
    66
	void OnSourceModShutdown();
faluco@612
    67
public:
faluco@612
    68
	TimerInfo *CreateTimerInfo();
faluco@612
    69
	void DeleteTimerInfo(TimerInfo *pInfo);
faluco@612
    70
private:
faluco@612
    71
	CStack<TimerInfo *> m_FreeTimers;
faluco@612
    72
};
faluco@612
    73
faluco@641
    74
TimerNatives::~TimerNatives()
faluco@641
    75
{
faluco@641
    76
	CStack<TimerInfo *>::iterator iter;
faluco@641
    77
	for (iter=m_FreeTimers.begin(); iter!=m_FreeTimers.end(); iter++)
faluco@641
    78
	{
faluco@641
    79
		delete (*iter);
faluco@641
    80
	}
faluco@641
    81
	m_FreeTimers.popall();
faluco@641
    82
}
faluco@641
    83
faluco@612
    84
void TimerNatives::OnSourceModAllInitialized()
faluco@612
    85
{
faluco@612
    86
	HandleAccess sec;
faluco@1397
    87
faluco@1397
    88
	g_HandleSys.InitAccessDefaults(NULL, &sec);
faluco@1397
    89
	sec.access[HandleAccess_Clone] = HANDLE_RESTRICT_IDENTITY;
faluco@612
    90
faluco@612
    91
	g_TimerType = g_HandleSys.CreateType("Timer", this, 0, NULL, &sec, g_pCoreIdent, NULL);
faluco@612
    92
}
faluco@612
    93
faluco@612
    94
void TimerNatives::OnSourceModShutdown()
faluco@612
    95
{
faluco@612
    96
	g_HandleSys.RemoveType(g_TimerType, g_pCoreIdent);
faluco@612
    97
	g_TimerType = 0;
faluco@612
    98
}
faluco@612
    99
faluco@612
   100
void TimerNatives::OnHandleDestroy(HandleType_t type, void *object)
faluco@612
   101
{
faluco@612
   102
	TimerInfo *pTimer = reinterpret_cast<TimerInfo *>(object);
faluco@612
   103
faluco@612
   104
	g_Timers.KillTimer(pTimer->Timer);
faluco@612
   105
}
faluco@612
   106
faluco@612
   107
TimerInfo *TimerNatives::CreateTimerInfo()
faluco@612
   108
{
faluco@612
   109
	TimerInfo *pInfo;
faluco@612
   110
faluco@612
   111
	if (m_FreeTimers.empty())
faluco@612
   112
	{
faluco@612
   113
		pInfo = new TimerInfo;
faluco@612
   114
	} else {
faluco@612
   115
		pInfo = m_FreeTimers.front();
faluco@612
   116
		m_FreeTimers.pop();
faluco@612
   117
	}
faluco@612
   118
faluco@612
   119
	return pInfo;
faluco@612
   120
}
faluco@612
   121
faluco@612
   122
void TimerNatives::DeleteTimerInfo(TimerInfo *pInfo)
faluco@612
   123
{
faluco@612
   124
	m_FreeTimers.push(pInfo);
faluco@612
   125
}
faluco@612
   126
faluco@612
   127
ResultType TimerNatives::OnTimer(ITimer *pTimer, void *pData)
faluco@612
   128
{
faluco@612
   129
	TimerInfo *pInfo = reinterpret_cast<TimerInfo *>(pData);
faluco@612
   130
	IPluginFunction *pFunc = pInfo->Hook;
faluco@612
   131
	cell_t res = static_cast<ResultType>(Pl_Continue);
faluco@612
   132
faluco@612
   133
	pFunc->PushCell(pInfo->TimerHandle);
faluco@612
   134
	pFunc->PushCell(pInfo->UserData);
faluco@612
   135
	pFunc->Execute(&res);
faluco@612
   136
faluco@612
   137
	return static_cast<ResultType>(res);
faluco@612
   138
}
faluco@612
   139
faluco@612
   140
void TimerNatives::OnTimerEnd(ITimer *pTimer, void *pData)
faluco@612
   141
{
faluco@612
   142
	HandleSecurity sec;
faluco@612
   143
	HandleError herr;
faluco@612
   144
	TimerInfo *pInfo = reinterpret_cast<TimerInfo *>(pData);
faluco@612
   145
	Handle_t usrhndl = static_cast<Handle_t>(pInfo->UserData);
faluco@612
   146
faluco@612
   147
	sec.pOwner = pInfo->pContext->GetIdentity();
faluco@612
   148
	sec.pIdentity = g_pCoreIdent;
faluco@612
   149
faluco@612
   150
	if (pInfo->Flags & TIMER_HNDL_CLOSE)
faluco@612
   151
	{
faluco@612
   152
		if ((herr=g_HandleSys.FreeHandle(usrhndl, &sec)) != HandleError_None)
faluco@612
   153
		{
faluco@1894
   154
			g_DbgReporter.GenerateError(pInfo->pContext,
faluco@1894
   155
										pInfo->Hook->GetFunctionID(), 
faluco@1894
   156
										SP_ERROR_NATIVE, 
faluco@1894
   157
										"Invalid data handle %x (error %d) passed during timer end",
faluco@1894
   158
										usrhndl, 
faluco@1894
   159
										herr);
faluco@612
   160
		}
faluco@612
   161
	}
faluco@612
   162
faluco@1674
   163
	if ((herr=g_HandleSys.FreeHandle(pInfo->TimerHandle, &sec)) != HandleError_None)
faluco@1674
   164
	{
faluco@1894
   165
		g_DbgReporter.GenerateError(pInfo->pContext, 
faluco@1894
   166
									pInfo->Hook->GetFunctionID(), 
faluco@1894
   167
									SP_ERROR_NATIVE, 
faluco@1894
   168
									"Invalid timer handle %x (error %d) during timer end, displayed function is timer callback, not the stack trace", 
faluco@1894
   169
									pInfo->TimerHandle, 
faluco@1894
   170
									herr);
faluco@1674
   171
		return;
faluco@1674
   172
	}
faluco@613
   173
	DeleteTimerInfo(pInfo);
faluco@612
   174
}
faluco@612
   175
faluco@612
   176
/*******************************
faluco@612
   177
*                              *
faluco@612
   178
* TIMER NATIVE IMPLEMENTATIONS *
faluco@612
   179
*                              *
faluco@612
   180
********************************/
faluco@612
   181
faluco@612
   182
static TimerNatives s_TimerNatives;
faluco@612
   183
faluco@612
   184
static cell_t smn_CreateTimer(IPluginContext *pCtx, const cell_t *params)
faluco@612
   185
{
faluco@612
   186
	IPluginFunction *pFunc;
faluco@612
   187
	TimerInfo *pInfo;
faluco@612
   188
	ITimer *pTimer;
faluco@612
   189
	Handle_t hndl;
faluco@612
   190
	int flags = params[4];
faluco@612
   191
faluco@612
   192
	pFunc = pCtx->GetFunctionById(params[2]);
faluco@612
   193
	if (!pFunc)
faluco@612
   194
	{
faluco@612
   195
		return pCtx->ThrowNativeError("Invalid function id (%X)", params[2]);
faluco@612
   196
	}
faluco@612
   197
faluco@612
   198
	pInfo = s_TimerNatives.CreateTimerInfo();
faluco@612
   199
	pTimer = g_Timers.CreateTimer(&s_TimerNatives, sp_ctof(params[1]), pInfo, flags);
dvander@1409
   200
dvander@1409
   201
	if (!pTimer)
dvander@1409
   202
	{
dvander@1409
   203
		s_TimerNatives.DeleteTimerInfo(pInfo);
dvander@1409
   204
		return 0;
dvander@1409
   205
	}
dvander@1409
   206
faluco@612
   207
	hndl = g_HandleSys.CreateHandle(g_TimerType, pInfo, pCtx->GetIdentity(), g_pCoreIdent, NULL);
faluco@612
   208
faluco@612
   209
	pInfo->UserData = params[3];
faluco@612
   210
	pInfo->Flags = flags;
faluco@612
   211
	pInfo->TimerHandle = hndl;
faluco@612
   212
	pInfo->Hook = pFunc;
faluco@612
   213
	pInfo->Timer = pTimer;
faluco@612
   214
	pInfo->pContext = pCtx;
faluco@612
   215
faluco@612
   216
	return hndl;
faluco@612
   217
}
faluco@612
   218
faluco@612
   219
static cell_t smn_KillTimer(IPluginContext *pCtx, const cell_t *params)
faluco@612
   220
{
faluco@612
   221
	Handle_t hndl = static_cast<Handle_t>(params[1]);
faluco@612
   222
	HandleError herr;
faluco@612
   223
	HandleSecurity sec;
faluco@612
   224
	TimerInfo *pInfo;
faluco@612
   225
dvander@1008
   226
	sec.pOwner = pCtx->GetIdentity();
faluco@612
   227
	sec.pIdentity = g_pCoreIdent;
faluco@612
   228
faluco@612
   229
	if ((herr=g_HandleSys.ReadHandle(hndl, g_TimerType, &sec, (void **)&pInfo))
faluco@612
   230
		!= HandleError_None)
faluco@612
   231
	{
faluco@612
   232
		return pCtx->ThrowNativeError("Invalid timer handle %x (error %d)", hndl, herr);
faluco@612
   233
	}
faluco@612
   234
faluco@612
   235
	g_Timers.KillTimer(pInfo->Timer);
faluco@612
   236
faluco@612
   237
	if (params[2] && !(pInfo->Flags & TIMER_HNDL_CLOSE))
faluco@612
   238
	{
faluco@612
   239
		sec.pOwner = pInfo->pContext->GetIdentity();
faluco@612
   240
		sec.pIdentity = g_pCoreIdent;
faluco@612
   241
faluco@612
   242
		if ((herr=g_HandleSys.FreeHandle(static_cast<Handle_t>(pInfo->UserData), &sec)) != HandleError_None)
faluco@612
   243
		{
faluco@612
   244
			return pCtx->ThrowNativeError("Invalid data handle %x (error %d)", hndl, herr);
faluco@612
   245
		}
faluco@612
   246
	}
faluco@612
   247
faluco@612
   248
	return 1;
faluco@612
   249
}
faluco@612
   250
faluco@612
   251
static cell_t smn_TriggerTimer(IPluginContext *pCtx, const cell_t *params)
faluco@612
   252
{
faluco@612
   253
	Handle_t hndl = static_cast<Handle_t>(params[1]);
faluco@612
   254
	HandleError herr;
faluco@612
   255
	HandleSecurity sec;
faluco@612
   256
	TimerInfo *pInfo;
faluco@612
   257
faluco@1397
   258
	sec.pOwner = pCtx->GetIdentity();
faluco@612
   259
	sec.pIdentity = g_pCoreIdent;
faluco@612
   260
faluco@612
   261
	if ((herr=g_HandleSys.ReadHandle(hndl, g_TimerType, &sec, (void **)&pInfo))
faluco@612
   262
		!= HandleError_None)
faluco@612
   263
	{
faluco@612
   264
		return pCtx->ThrowNativeError("Invalid timer handle %x (error %d)", hndl, herr);
faluco@612
   265
	}
faluco@612
   266
faluco@612
   267
	g_Timers.FireTimerOnce(pInfo->Timer, params[2] ? true : false);
faluco@612
   268
faluco@612
   269
	return 1;
faluco@612
   270
}
faluco@612
   271
dvander@822
   272
static cell_t smn_GetTickedTime(IPluginContext *pContext, const cell_t *params)
dvander@822
   273
{
dvander@1412
   274
	return sp_ftoc(*g_pUniversalTime);
dvander@822
   275
}
dvander@822
   276
dvander@1415
   277
static cell_t smn_GetMapTimeLeft(IPluginContext *pContext, const cell_t *params)
dvander@1415
   278
{
dvander@1459
   279
	float time_left;
dvander@1459
   280
	if (!g_Timers.GetMapTimeLeft(&time_left))
dvander@1415
   281
	{
dvander@1462
   282
		return 0;
dvander@1415
   283
	}
dvander@1415
   284
dvander@1462
   285
	cell_t *addr;
dvander@1462
   286
	pContext->LocalToPhysAddr(params[1], &addr);
dvander@1462
   287
	*addr = (int)time_left;
dvander@1415
   288
dvander@1462
   289
	return 1;
dvander@1415
   290
}
dvander@1415
   291
dvander@1415
   292
static cell_t smn_GetMapTimeLimit(IPluginContext *pContext, const cell_t *params)
dvander@1415
   293
{
dvander@1415
   294
	IMapTimer *pMapTimer = g_Timers.GetMapTimer();
dvander@1415
   295
dvander@1415
   296
	if (!pMapTimer)
dvander@1415
   297
	{
dvander@1415
   298
		return 0;
dvander@1415
   299
	}
dvander@1415
   300
dvander@1415
   301
	cell_t *addr;
dvander@1415
   302
	pContext->LocalToPhysAddr(params[1], &addr);
dvander@1415
   303
dvander@1415
   304
	*addr = pMapTimer->GetMapTimeLimit();
dvander@1415
   305
dvander@1415
   306
	return 1;
dvander@1415
   307
}
dvander@1415
   308
dvander@1415
   309
static cell_t smn_ExtendMapTimeLimit(IPluginContext *pContext, const cell_t *params)
dvander@1415
   310
{
dvander@1415
   311
	IMapTimer *pMapTimer = g_Timers.GetMapTimer();
dvander@1415
   312
dvander@1415
   313
	if (!pMapTimer)
dvander@1415
   314
	{
dvander@1415
   315
		return 0;
dvander@1415
   316
	}
dvander@1415
   317
dvander@1415
   318
	pMapTimer->ExtendMapTimeLimit(params[1]);
dvander@1415
   319
dvander@1415
   320
	return 1;
dvander@1415
   321
}
dvander@1415
   322
dvander@1461
   323
static cell_t smn_IsServerProcessing(IPluginContext *pContext, const cell_t *params)
dvander@1459
   324
{
dvander@1459
   325
	return (gpGlobals->frametime > 0.0f) ? 1 : 0;
dvander@1459
   326
}
dvander@1459
   327
faluco@612
   328
REGISTER_NATIVES(timernatives)
faluco@612
   329
{
faluco@612
   330
	{"CreateTimer",				smn_CreateTimer},
faluco@612
   331
	{"KillTimer",				smn_KillTimer},
faluco@612
   332
	{"TriggerTimer",			smn_TriggerTimer},
dvander@822
   333
	{"GetTickedTime",			smn_GetTickedTime},
dvander@1415
   334
	{"GetMapTimeLeft",			smn_GetMapTimeLeft},
dvander@1415
   335
	{"GetMapTimeLimit",			smn_GetMapTimeLimit},
dvander@1415
   336
	{"ExtendMapTimeLimit",		smn_ExtendMapTimeLimit},
dvander@1461
   337
	{"IsServerProcessing",		smn_IsServerProcessing},
faluco@612
   338
	{NULL,						NULL}
faluco@612
   339
};