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>.
34 #include "sp_vm_function.h"
35 #include "BaseRuntime.h"
41 void CFunction::Set(uint32_t code_addr, BaseRuntime *runtime, funcid_t fnid, uint32_t pub_id)
43 m_codeaddr = code_addr;
46 m_errorstate = SP_ERROR_NONE;
51 bool CFunction::IsRunnable()
53 return !m_pRuntime->IsPaused();
56 int CFunction::CallFunction(const cell_t *params, unsigned int num_params, cell_t *result)
58 return CallFunction(m_pRuntime->GetDefaultContext(), params, num_params, result);
61 int CFunction::CallFunction(IPluginContext *pContext, const cell_t *params, unsigned int num_params, cell_t *result)
63 return pContext->Execute(this, params, num_params, result);
66 IPluginContext *CFunction::GetParentContext()
68 return m_pRuntime->GetDefaultContext();
71 CFunction::CFunction(uint32_t code_addr, BaseRuntime *runtime, funcid_t id, uint32_t pub_id) :
72 m_codeaddr(code_addr), m_curparam(0), m_errorstate(SP_ERROR_NONE), m_FnId(id)
78 int CFunction::PushCell(cell_t cell)
80 if (m_curparam >= SP_MAX_EXEC_PARAMS)
82 return SetError(SP_ERROR_PARAMS_MAX);
85 m_info[m_curparam].marked = false;
86 m_params[m_curparam] = cell;
92 int CFunction::PushCellByRef(cell_t *cell, int flags)
94 return PushArray(cell, 1, flags);
97 int CFunction::PushFloat(float number)
99 cell_t val = *(cell_t *)&number;
101 return PushCell(val);
104 int CFunction::PushFloatByRef(float *number, int flags)
106 return PushCellByRef((cell_t *)number, flags);
109 int CFunction::PushArray(cell_t *inarray, unsigned int cells, int copyback)
111 if (m_curparam >= SP_MAX_EXEC_PARAMS)
113 return SetError(SP_ERROR_PARAMS_MAX);
116 ParamInfo *info = &m_info[m_curparam];
118 info->flags = inarray ? copyback : 0;
121 info->str.is_sz = false;
122 info->orig_addr = inarray;
126 return SP_ERROR_NONE;
129 int CFunction::PushString(const char *string)
131 return _PushString(string, SM_PARAM_STRING_COPY, 0, strlen(string)+1);
134 int CFunction::PushStringEx(char *buffer, size_t length, int sz_flags, int cp_flags)
136 return _PushString(buffer, sz_flags, cp_flags, length);
139 int CFunction::_PushString(const char *string, int sz_flags, int cp_flags, size_t len)
141 if (m_curparam >= SP_MAX_EXEC_PARAMS)
143 return SetError(SP_ERROR_PARAMS_MAX);
146 ParamInfo *info = &m_info[m_curparam];
149 info->orig_addr = (cell_t *)string;
150 info->flags = cp_flags;
152 info->str.sz_flags = sz_flags;
153 info->str.is_sz = true;
157 return SP_ERROR_NONE;
160 void CFunction::Cancel()
167 m_errorstate = SP_ERROR_NONE;
171 int CFunction::Execute(cell_t *result)
173 return Execute(m_pRuntime->GetDefaultContext(), result);
176 int CFunction::Execute(IPluginContext *ctx, cell_t *result)
178 int err = SP_ERROR_NONE;
182 m_errorstate = SP_ERROR_NOT_RUNNABLE;
185 if (m_errorstate != SP_ERROR_NONE)
192 //This is for re-entrancy!
193 cell_t temp_params[SP_MAX_EXEC_PARAMS];
194 ParamInfo temp_info[SP_MAX_EXEC_PARAMS];
195 unsigned int numparams = m_curparam;
197 bool docopies = true;
201 //Save the info locally, then reset it for re-entrant calls.
202 memcpy(temp_info, m_info, numparams * sizeof(ParamInfo));
206 /* Browse the parameters and build arrays */
207 for (i=0; i<numparams; i++)
209 /* Is this marked as an array? */
210 if (temp_info[i].marked)
212 if (!temp_info[i].str.is_sz)
214 /* Allocate a normal/generic array */
215 if ((err=ctx->HeapAlloc(temp_info[i].size,
216 &(temp_info[i].local_addr),
217 &(temp_info[i].phys_addr)))
222 if (temp_info[i].orig_addr)
224 memcpy(temp_info[i].phys_addr, temp_info[i].orig_addr, sizeof(cell_t) * temp_info[i].size);
229 /* Calculate cells required for the string */
230 size_t cells = (temp_info[i].size + sizeof(cell_t) - 1) / sizeof(cell_t);
232 /* Allocate the buffer */
233 if ((err=ctx->HeapAlloc(cells,
234 &(temp_info[i].local_addr),
235 &(temp_info[i].phys_addr)))
240 /* Copy original string if necessary */
241 if ((temp_info[i].str.sz_flags & SM_PARAM_STRING_COPY) && (temp_info[i].orig_addr != NULL))
243 /* Cut off UTF-8 properly */
244 if (temp_info[i].str.sz_flags & SM_PARAM_STRING_UTF8)
246 if ((err=ctx->StringToLocalUTF8(temp_info[i].local_addr,
248 (const char *)temp_info[i].orig_addr,
255 /* Copy a binary blob */
256 else if (temp_info[i].str.sz_flags & SM_PARAM_STRING_BINARY)
258 memmove(temp_info[i].phys_addr, temp_info[i].orig_addr, temp_info[i].size);
260 /* Copy ASCII characters */
263 if ((err=ctx->StringToLocal(temp_info[i].local_addr,
265 (const char *)temp_info[i].orig_addr))
272 } /* End array/string calculation */
273 /* Update the pushed parameter with the byref local address */
274 temp_params[i] = temp_info[i].local_addr;
278 /* Just copy the value normally */
279 temp_params[i] = m_params[i];
283 /* Make the call if we can */
284 if (err == SP_ERROR_NONE)
286 if ((err = CallFunction(ctx, temp_params, numparams, result)) != SP_ERROR_NONE)
296 /* i should be equal to the last valid parameter + 1 */
299 if (!temp_info[i].marked)
304 if (docopies && (temp_info[i].flags & SM_PARAM_COPYBACK))
306 if (temp_info[i].orig_addr)
308 if (temp_info[i].str.is_sz)
310 memcpy(temp_info[i].orig_addr, temp_info[i].phys_addr, temp_info[i].size);
315 if (temp_info[i].size == 1)
317 *temp_info[i].orig_addr = *(temp_info[i].phys_addr);
321 memcpy(temp_info[i].orig_addr,
322 temp_info[i].phys_addr,
323 temp_info[i].size * sizeof(cell_t));
329 if ((err=ctx->HeapPop(temp_info[i].local_addr)) != SP_ERROR_NONE)
338 funcid_t CFunction::GetFunctionID()
343 int CFunction::SetError(int err)
350 bool CFunction::IsInvalidated()