Fixed crash when TF2 extension couldn't load.
3 * =============================================================================
5 * Copyright (C) 2004-2008 AlliedModders LLC. All rights reserved.
6 * =============================================================================
8 * This program is free software; you can redistribute it and/or modify it under
9 * the terms of the GNU General Public License, version 3.0, as published by the
10 * Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but WITHOUT
13 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
14 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
17 * You should have received a copy of the GNU General Public License along with
18 * this program. If not, see <http://www.gnu.org/licenses/>.
20 * As a special exception, AlliedModders LLC gives you permission to link the
21 * code of this program (as well as its derivative works) to "Half-Life 2," the
22 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
23 * by the Valve Corporation. You must obey the GNU General Public License in
24 * all respects for all other code used. Additionally, AlliedModders LLC grants
25 * this exception to all derivative works. AlliedModders LLC defines further
26 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
27 * or <http://www.sourcemod.net/license.php>.
35 #include "ForwardSys.h"
36 #include "PluginSys.h"
38 #include "DebugReporter.h"
40 CForwardManager g_Forwards;
43 * Genesis turns to its source, reduction occurs stepwise although the essence is all one.
44 * End of line. FTL system check.
46 * :TODO: WHAT NEEDS TO BE TESTED IN THIS BEAST
48 * - Pushing no varargs
51 // :TODO: IMPORTANT!!! The result pointer arg in the execute function maybe invalid if the forward fails
52 // so later evaluation of this result may cause problems on higher levels of abstraction. DOCUMENT OR FIX ALL FORWARDS!
54 CForwardManager::~CForwardManager()
56 CStack<CForward *>::iterator iter;
57 for (iter=m_FreeForwards.begin(); iter!=m_FreeForwards.end(); iter++)
61 m_FreeForwards.popall();
64 void CForwardManager::OnSourceModAllInitialized()
66 g_PluginSys.AddPluginsListener(this);
67 g_ShareSys.AddInterface(NULL, this);
70 IForward *CForwardManager::CreateForward(const char *name, ExecType et, unsigned int num_params, const ParamType *types, ...)
76 fwd = CForward::CreateForward(name, et, num_params, types, ap);
82 g_PluginSys.AddFunctionsToForward(name, fwd);
84 m_managed.push_back(fwd);
90 IChangeableForward *CForwardManager::CreateForwardEx(const char *name, ExecType et, int num_params, const ParamType *types, ...)
96 fwd = CForward::CreateForward(name, et, num_params, types, ap);
102 m_unmanaged.push_back(fwd);
108 void CForwardManager::OnPluginLoaded(IPlugin *plugin)
110 /* Attach any globally managed forwards */
111 List<CForward *>::iterator iter;
114 for (iter=m_managed.begin(); iter!=m_managed.end(); iter++)
117 IPluginFunction *pFunc = plugin->GetBaseContext()->GetFunctionByName(fwd->GetForwardName());
120 fwd->AddFunction(pFunc);
125 void CForwardManager::OnPluginUnloaded(IPlugin *plugin)
127 List<CForward *>::iterator iter;
130 for (iter=m_managed.begin(); iter!=m_managed.end(); iter++)
133 fwd->RemoveFunctionsOfPlugin(plugin);
136 for (iter=m_unmanaged.begin(); iter!=m_unmanaged.end(); iter++)
139 fwd->RemoveFunctionsOfPlugin(plugin);
143 IForward *CForwardManager::FindForward(const char *name, IChangeableForward **ifchng)
145 List<CForward *>::iterator iter;
148 for (iter=m_managed.begin(); iter!=m_managed.end(); iter++)
151 if (strcmp(fwd->GetForwardName(), name) == 0)
161 for (iter=m_unmanaged.begin(); iter!=m_unmanaged.end(); iter++)
164 if (strcmp(fwd->GetForwardName(), name) == 0)
182 void CForwardManager::ReleaseForward(IForward *forward)
184 ForwardFree(static_cast<CForward *>(forward));
187 void CForwardManager::ForwardFree(CForward *fwd)
194 m_FreeForwards.push(fwd);
195 m_managed.remove(fwd);
198 CForward *CForwardManager::ForwardMake()
201 if (m_FreeForwards.empty())
205 fwd = m_FreeForwards.front();
206 m_FreeForwards.pop();
211 void CForwardManager::OnPluginPauseChange(IPlugin *plugin, bool paused)
216 /*************************************
217 * ACTUAL FORWARD API IMPLEMENTATION *
218 *************************************/
220 CForward *CForward::CreateForward(const char *name, ExecType et, unsigned int num_params, const ParamType *types, va_list ap)
222 ParamType _types[SP_MAX_EXEC_PARAMS];
224 if (num_params > SP_MAX_EXEC_PARAMS)
229 if (types == NULL && num_params)
231 for (unsigned int i=0; i<num_params; i++)
233 _types[i] = (ParamType)va_arg(ap, int);
234 if (_types[i] == Param_VarArgs && (i != num_params - 1))
241 for (unsigned int i=0; i<num_params; i++)
243 _types[i] = types[i];
244 if (types[i] == Param_VarArgs && (i != num_params - 1))
251 /* First parameter can never be varargs */
252 if (num_params && _types[0] == Param_VarArgs)
257 CForward *pForward = g_Forwards.ForwardMake();
258 pForward->m_curparam = 0;
259 pForward->m_ExecType = et;
260 snprintf(pForward->m_name, FORWARDS_NAME_MAX, "%s", name ? name : "");
262 for (unsigned int i=0; i<num_params; i++)
264 pForward->m_types[i] = _types[i];
267 if (num_params && _types[num_params-1] == Param_VarArgs)
269 pForward->m_varargs = num_params--;
271 pForward->m_varargs = false;
274 pForward->m_numparams = num_params;
275 pForward->m_errstate = SP_ERROR_NONE;
277 pForward->m_functions.clear();
282 int CForward::Execute(cell_t *result, IForwardFilter *filter)
286 int err = m_errstate;
291 FuncIter iter = m_functions.begin();
292 IPluginFunction *func;
293 cell_t cur_result = 0;
294 cell_t high_result = 0;
295 cell_t low_result = 0;
297 unsigned int failed=0, success=0;
298 unsigned int num_params = m_curparam;
299 FwdParamInfo temp_info[SP_MAX_EXEC_PARAMS];
303 /* Save local, reset */
304 memcpy(temp_info, m_params, sizeof(m_params));
307 for (iter=m_functions.begin(); iter!=m_functions.end(); iter++)
311 for (unsigned int i=0; i<num_params; i++)
313 int err = SP_ERROR_PARAM;
314 param = &temp_info[i];
316 if (i >= m_numparams || m_types[i] == Param_Any)
318 type = param->pushedas;
325 if ((i >= m_numparams) || (type & SP_PARAMFLAG_BYREF))
327 /* If we're byref or we're vararg, we always push everything by ref.
328 * Even if they're byval, we must push them byref.
330 if (type == Param_String)
332 err = func->PushStringEx((char *)param->byref.orig_addr, param->byref.cells, param->byref.sz_flags, param->byref.flags);
334 else if (type == Param_Float || type == Param_Cell)
336 err = func->PushCellByRef(¶m->val);
340 err = func->PushArray(param->byref.orig_addr, param->byref.cells, param->byref.flags);
341 assert(type == Param_Array || type == Param_FloatByRef || type == Param_CellByRef);
346 /* If we're not byref or not vararg, our job is a bit easier. */
347 assert(type == Param_Cell || type == Param_Float);
348 err = func->PushCell(param->val);
351 if (err != SP_ERROR_NONE)
353 g_DbgReporter.GenerateError(func->GetParentContext(),
354 func->GetFunctionID(),
356 "Failed to push parameter while executing forward");
361 /* Call the function and deal with the return value. */
362 if ((err=func->Execute(&cur_result)) != SP_ERROR_NONE)
373 if (cur_result > high_result)
375 high_result = cur_result;
381 if (cur_result > high_result)
383 high_result = cur_result;
384 if ((ResultType)high_result == Pl_Stop)
393 /* Check if the current result is the lowest so far (or if it's the first result) */
394 if (cur_result < low_result || success == 1)
396 low_result = cur_result;
422 cur_result = high_result;
427 cur_result = low_result;
438 *result = cur_result;
442 return SP_ERROR_NONE;
445 int CForward::PushCell(cell_t cell)
447 if (m_curparam < m_numparams)
449 if (m_types[m_curparam] == Param_Any)
451 m_params[m_curparam].pushedas = Param_Cell;
452 } else if (m_types[m_curparam] != Param_Cell) {
453 return SetError(SP_ERROR_PARAM);
456 if (!m_varargs || m_numparams > SP_MAX_EXEC_PARAMS)
458 return SetError(SP_ERROR_PARAMS_MAX);
460 m_params[m_curparam].pushedas = Param_Cell;
463 m_params[m_curparam++].val = cell;
465 return SP_ERROR_NONE;
468 int CForward::PushFloat(float number)
470 if (m_curparam < m_numparams)
472 if (m_types[m_curparam] == Param_Any)
474 m_params[m_curparam].pushedas = Param_Float;
475 } else if (m_types[m_curparam] != Param_Float) {
476 return SetError(SP_ERROR_PARAM);
479 if (!m_varargs || m_numparams > SP_MAX_EXEC_PARAMS)
481 return SetError(SP_ERROR_PARAMS_MAX);
483 m_params[m_curparam].pushedas = Param_Float;
486 m_params[m_curparam++].val = *(cell_t *)&number;
488 return SP_ERROR_NONE;
491 int CForward::PushCellByRef(cell_t *cell, int flags)
493 if (m_curparam < m_numparams)
495 if (m_types[m_curparam] == Param_Any)
497 m_params[m_curparam].pushedas = Param_CellByRef;
498 } else if (m_types[m_curparam] != Param_CellByRef) {
499 return SetError(SP_ERROR_PARAM);
502 if (!m_varargs || m_numparams > SP_MAX_EXEC_PARAMS)
504 return SetError(SP_ERROR_PARAMS_MAX);
506 m_params[m_curparam].pushedas = Param_CellByRef;
509 _Int_PushArray(cell, 1, flags);
512 return SP_ERROR_NONE;
515 int CForward::PushFloatByRef(float *num, int flags)
517 if (m_curparam < m_numparams)
519 if (m_types[m_curparam] == Param_Any)
521 m_params[m_curparam].pushedas = Param_FloatByRef;
522 } else if (m_types[m_curparam] != Param_FloatByRef) {
523 return SetError(SP_ERROR_PARAM);
526 if (!m_varargs || m_numparams > SP_MAX_EXEC_PARAMS)
528 return SetError(SP_ERROR_PARAMS_MAX);
530 m_params[m_curparam].pushedas = Param_FloatByRef;
533 _Int_PushArray((cell_t *)num, 1, flags);
536 return SP_ERROR_NONE;
539 void CForward::_Int_PushArray(cell_t *inarray, unsigned int cells, int flags)
541 m_params[m_curparam].byref.cells = cells;
542 m_params[m_curparam].byref.flags = flags;
543 m_params[m_curparam].byref.orig_addr = inarray;
546 int CForward::PushArray(cell_t *inarray, unsigned int cells, int flags)
548 /* We don't allow this here */
551 return SetError(SP_ERROR_PARAM);
554 if (m_curparam < m_numparams)
556 if (m_types[m_curparam] == Param_Any)
558 m_params[m_curparam].pushedas = Param_Array;
559 } else if (m_types[m_curparam] != Param_Array) {
560 return SetError(SP_ERROR_PARAM);
563 if (!m_varargs || m_curparam > SP_MAX_EXEC_PARAMS)
565 return SetError(SP_ERROR_PARAMS_MAX);
567 m_params[m_curparam].pushedas = Param_Array;
570 _Int_PushArray(inarray, cells, flags);
574 return SP_ERROR_NONE;
577 void CForward::_Int_PushString(cell_t *inarray, unsigned int cells, int sz_flags, int cp_flags)
579 m_params[m_curparam].byref.cells = cells; /* Notice this contains the char count not cell count */
580 m_params[m_curparam].byref.flags = cp_flags;
581 m_params[m_curparam].byref.orig_addr = inarray;
582 m_params[m_curparam].byref.sz_flags = sz_flags;
585 int CForward::PushString(const char *string)
587 if (m_curparam < m_numparams)
589 if (m_types[m_curparam] == Param_Any)
591 m_params[m_curparam].pushedas = Param_String;
592 } else if (m_types[m_curparam] != Param_String) {
593 return SetError(SP_ERROR_PARAM);
596 if (!m_varargs || m_curparam > SP_MAX_EXEC_PARAMS)
598 return SetError(SP_ERROR_PARAMS_MAX);
600 m_params[m_curparam].pushedas = Param_String;
603 _Int_PushString((cell_t *)string, strlen(string)+1, SM_PARAM_STRING_COPY, 0);
606 return SP_ERROR_NONE;
609 int CForward::PushStringEx(char *buffer, size_t length, int sz_flags, int cp_flags)
611 if (m_curparam < m_numparams)
613 if (m_types[m_curparam] == Param_Any)
615 m_params[m_curparam].pushedas = Param_String;
616 } else if (m_types[m_curparam] != Param_String) {
617 return SetError(SP_ERROR_PARAM);
620 if (!m_varargs || m_curparam > SP_MAX_EXEC_PARAMS)
622 return SetError(SP_ERROR_PARAMS_MAX);
624 m_params[m_curparam].pushedas = Param_String;
627 _Int_PushString((cell_t *)buffer, length, sz_flags, cp_flags);
630 return SP_ERROR_NONE;
633 void CForward::Cancel()
641 m_errstate = SP_ERROR_NONE;
644 bool CForward::AddFunction(IPluginContext *pContext, funcid_t index)
646 IPluginFunction *pFunc = pContext->GetFunctionById(index);
653 return AddFunction(pFunc);
656 bool CForward::RemoveFunction(IPluginContext *pContext, funcid_t index)
658 IPluginFunction *pFunc = pContext->GetFunctionById(index);
665 return RemoveFunction(pFunc);
668 bool CForward::RemoveFunction(IPluginFunction *func)
672 List<IPluginFunction *> *lst;
674 if (func->IsRunnable())
681 for (iter=m_functions.begin(); iter!=m_functions.end(); iter++)
691 /* Cancel a call, if any */
692 if (found || m_curparam)
700 unsigned int CForward::RemoveFunctionsOfPlugin(IPlugin *plugin)
703 IPluginFunction *func;
704 unsigned int removed = 0;
705 IPluginContext *pContext = plugin->GetBaseContext();
706 for (iter=m_functions.begin(); iter!=m_functions.end();)
709 if (func->GetParentContext() == pContext)
711 iter = m_functions.erase(iter);
721 bool CForward::AddFunction(IPluginFunction *func)
728 if (func->IsRunnable())
730 m_functions.push_back(func);
732 m_paused.push_back(func);
738 const char *CForward::GetForwardName()
743 unsigned int CForward::GetFunctionCount()
745 return m_functions.size();
748 ExecType CForward::GetExecType()