core/systems/CFunction.cpp
author David Anderson <dvander@alliedmods.net>
Sat Nov 11 11:10:24 2006 +0000 (2006-11-11)
changeset 177 d29ade52d953
child 180 fe406c5f2aeb
permissions -rw-r--r--
Fleshed out forward system and extensively documented its design considerations
Implemented and did basic tests on new IPluginFunction type
Split function types into a separate file
dvander@177
     1
#include <stdio.h>
dvander@177
     2
#include "PluginSys.h"
dvander@177
     3
dvander@177
     4
/********************
dvander@177
     5
* FUNCTION CALLING *
dvander@177
     6
********************/
dvander@177
     7
dvander@177
     8
void CFunction::Set(funcid_t funcid, CPlugin *plugin)
dvander@177
     9
{
dvander@177
    10
	m_funcid = funcid;
dvander@177
    11
	m_pPlugin = plugin;
dvander@177
    12
	m_curparam = 0;
dvander@177
    13
	m_errorstate = SP_ERROR_NONE;
dvander@177
    14
}
dvander@177
    15
dvander@177
    16
int CFunction::CallFunction(const cell_t *params, unsigned int num_params, cell_t *result)
dvander@177
    17
{
dvander@177
    18
	IPluginContext *ctx = m_pPlugin->m_ctx_current.base;
dvander@177
    19
dvander@177
    20
	while (num_params--)
dvander@177
    21
	{
dvander@177
    22
		ctx->PushCell(params[num_params]);
dvander@177
    23
	}
dvander@177
    24
dvander@177
    25
	return ctx->Execute(m_funcid, result);
dvander@177
    26
}
dvander@177
    27
dvander@177
    28
IPlugin *CFunction::GetParentPlugin()
dvander@177
    29
{
dvander@177
    30
	return m_pPlugin;
dvander@177
    31
}
dvander@177
    32
dvander@177
    33
CFunction::CFunction(funcid_t funcid, CPlugin *plugin) : 
dvander@177
    34
	m_funcid(funcid), m_pPlugin(plugin), m_curparam(0), 
dvander@177
    35
	m_errorstate(SP_ERROR_NONE)
dvander@177
    36
{
dvander@177
    37
}
dvander@177
    38
dvander@177
    39
int CFunction::PushCell(cell_t cell)
dvander@177
    40
{
dvander@177
    41
	if (m_curparam >= SP_MAX_EXEC_PARAMS)
dvander@177
    42
	{
dvander@177
    43
		return SetError(SP_ERROR_PARAMS_MAX);
dvander@177
    44
	}
dvander@177
    45
dvander@177
    46
	m_info[m_curparam].marked = false;
dvander@177
    47
	m_params[m_curparam] = cell;
dvander@177
    48
	m_curparam++;
dvander@177
    49
dvander@177
    50
	return SP_ERROR_NONE;
dvander@177
    51
}
dvander@177
    52
dvander@177
    53
int CFunction::PushCellByRef(cell_t *cell, int flags)
dvander@177
    54
{
dvander@177
    55
	if (m_curparam >= SP_MAX_EXEC_PARAMS)
dvander@177
    56
	{
dvander@177
    57
		return SetError(SP_ERROR_PARAMS_MAX);
dvander@177
    58
	}
dvander@177
    59
dvander@177
    60
	return PushArray(cell, 1, NULL, flags);
dvander@177
    61
}
dvander@177
    62
dvander@177
    63
int CFunction::PushFloat(float number)
dvander@177
    64
{
dvander@177
    65
	cell_t val = *(cell_t *)&number;
dvander@177
    66
dvander@177
    67
	return PushCell(val);
dvander@177
    68
}
dvander@177
    69
dvander@177
    70
int CFunction::PushFloatByRef(float *number, int flags)
dvander@177
    71
{
dvander@177
    72
	return PushCellByRef((cell_t *)number, flags);
dvander@177
    73
}
dvander@177
    74
dvander@177
    75
int CFunction::PushCells(cell_t array[], unsigned int numcells, bool each)
dvander@177
    76
{
dvander@177
    77
	if (!each)
dvander@177
    78
	{
dvander@177
    79
		return PushArray(array, numcells, NULL, SMFUNC_COPYBACK_NONE);
dvander@177
    80
	} else {
dvander@177
    81
		int err;
dvander@177
    82
		for (unsigned int i=0; i<numcells; i++)
dvander@177
    83
		{
dvander@177
    84
			if ((err=PushCell(array[i])) != SP_ERROR_NONE)
dvander@177
    85
			{
dvander@177
    86
				return SetError(err);
dvander@177
    87
			}
dvander@177
    88
		}
dvander@177
    89
		return SP_ERROR_NONE;
dvander@177
    90
	}
dvander@177
    91
}
dvander@177
    92
dvander@177
    93
int CFunction::PushArray(cell_t *inarray, unsigned int cells, cell_t **phys_addr, int copyback)
dvander@177
    94
{
dvander@177
    95
	if (m_curparam >= SP_MAX_EXEC_PARAMS)
dvander@177
    96
	{
dvander@177
    97
		return SetError(SP_ERROR_PARAMS_MAX);
dvander@177
    98
	}
dvander@177
    99
dvander@177
   100
	IPluginContext *ctx = m_pPlugin->m_ctx_current.base;
dvander@177
   101
	ParamInfo *info = &m_info[m_curparam];
dvander@177
   102
	int err;
dvander@177
   103
dvander@177
   104
	if ((err=ctx->HeapAlloc(cells, &info->local_addr, &info->phys_addr)) != SP_ERROR_NONE)
dvander@177
   105
	{
dvander@177
   106
		return SetError(err);
dvander@177
   107
	}
dvander@177
   108
dvander@177
   109
	info->flags = inarray ? copyback : SMFUNC_COPYBACK_NONE;
dvander@177
   110
	info->marked = true;
dvander@177
   111
	info->size = cells;
dvander@177
   112
	m_params[m_curparam] = info->local_addr;
dvander@177
   113
	m_curparam++;
dvander@177
   114
dvander@177
   115
	if (inarray)
dvander@177
   116
	{
dvander@177
   117
		memcpy(info->phys_addr, inarray, sizeof(cell_t) * cells);
dvander@177
   118
		info->orig_addr = inarray;
dvander@177
   119
	} else {
dvander@177
   120
		info->orig_addr = info->phys_addr;
dvander@177
   121
	}
dvander@177
   122
dvander@177
   123
	if (phys_addr)
dvander@177
   124
	{
dvander@177
   125
		*phys_addr = info->phys_addr;
dvander@177
   126
	}
dvander@177
   127
dvander@177
   128
	return true;
dvander@177
   129
}
dvander@177
   130
dvander@177
   131
int CFunction::PushString(const char *string)
dvander@177
   132
{
dvander@177
   133
	return _PushString(string, SMFUNC_COPYBACK_NONE);
dvander@177
   134
}
dvander@177
   135
dvander@177
   136
int CFunction::PushStringByRef(char *string, int flags)
dvander@177
   137
{
dvander@177
   138
	return _PushString(string, flags);
dvander@177
   139
}
dvander@177
   140
dvander@177
   141
int CFunction::_PushString(const char *string, int flags)
dvander@177
   142
{
dvander@177
   143
	if (m_curparam >= SP_MAX_EXEC_PARAMS)
dvander@177
   144
	{
dvander@177
   145
		return SetError(SP_ERROR_PARAMS_MAX);
dvander@177
   146
	}
dvander@177
   147
dvander@177
   148
	IPluginContext *base = m_pPlugin->m_ctx_current.base;
dvander@177
   149
	ParamInfo *info = &m_info[m_curparam];
dvander@177
   150
	size_t len = strlen(string);
dvander@177
   151
	size_t cells = (len + sizeof(cell_t) - 1) / sizeof(cell_t);
dvander@177
   152
	int err;
dvander@177
   153
dvander@177
   154
	if ((err=base->HeapAlloc(cells, &info->local_addr, &info->phys_addr)) != SP_ERROR_NONE)
dvander@177
   155
	{
dvander@177
   156
		return SetError(err);
dvander@177
   157
	}
dvander@177
   158
dvander@177
   159
	info->marked = true;
dvander@177
   160
	m_params[m_curparam] = info->local_addr;
dvander@177
   161
	m_curparam++;	/* Prevent a leak */
dvander@177
   162
dvander@177
   163
	//:TODO: Use UTF-8 version
dvander@177
   164
	if ((err=base->StringToLocal(info->local_addr, len, string)) != SP_ERROR_NONE)
dvander@177
   165
	{
dvander@177
   166
		return SetError(err);
dvander@177
   167
	}
dvander@177
   168
dvander@177
   169
	info->flags = flags;
dvander@177
   170
	info->orig_addr = (cell_t *)string;
dvander@177
   171
	info->size = cells;
dvander@177
   172
dvander@177
   173
	return SP_ERROR_NONE;
dvander@177
   174
}
dvander@177
   175
dvander@177
   176
void CFunction::Cancel()
dvander@177
   177
{
dvander@177
   178
	if (!m_curparam)
dvander@177
   179
	{
dvander@177
   180
		return;
dvander@177
   181
	}
dvander@177
   182
dvander@177
   183
	IPluginContext *base = m_pPlugin->m_ctx_current.base;
dvander@177
   184
dvander@177
   185
	while (m_curparam--)
dvander@177
   186
	{
dvander@177
   187
		if (m_info[m_curparam].marked)
dvander@177
   188
		{
dvander@177
   189
			base->HeapRelease(m_info[m_curparam].local_addr);
dvander@177
   190
			m_info[m_curparam].marked = false;
dvander@177
   191
		}
dvander@177
   192
	}
dvander@177
   193
dvander@177
   194
	m_errorstate = SP_ERROR_NONE;
dvander@177
   195
}
dvander@177
   196
dvander@177
   197
int CFunction::Execute(cell_t *result, IFunctionCopybackReader *reader)
dvander@177
   198
{
dvander@177
   199
	int err;
dvander@177
   200
	if (m_errorstate != SP_ERROR_NONE)
dvander@177
   201
	{
dvander@177
   202
		err = m_errorstate;
dvander@177
   203
		Cancel();
dvander@177
   204
		return err;
dvander@177
   205
	}
dvander@177
   206
dvander@177
   207
	//This is for re-entrancy!
dvander@177
   208
	cell_t temp_params[SP_MAX_EXEC_PARAMS];
dvander@177
   209
	ParamInfo temp_info[SP_MAX_EXEC_PARAMS];
dvander@177
   210
	unsigned int numparams = m_curparam;
dvander@177
   211
	bool docopies = true;
dvander@177
   212
dvander@177
   213
	if (numparams)
dvander@177
   214
	{
dvander@177
   215
		//Save the info locally, then reset it for re-entrant calls.
dvander@177
   216
		memcpy(temp_params, m_params, numparams * sizeof(cell_t));
dvander@177
   217
		memcpy(temp_info, m_info, numparams * sizeof(ParamInfo));
dvander@177
   218
	}
dvander@177
   219
	m_curparam = 0;
dvander@177
   220
dvander@177
   221
	if ((err = CallFunction(temp_params, numparams, result)) != SP_ERROR_NONE)
dvander@177
   222
	{
dvander@177
   223
		docopies = false;
dvander@177
   224
	}
dvander@177
   225
dvander@177
   226
	IPluginContext *base = m_pPlugin->m_ctx_current.base;
dvander@177
   227
dvander@177
   228
	while (numparams--)
dvander@177
   229
	{
dvander@177
   230
		if (!temp_info[numparams].marked)
dvander@177
   231
		{
dvander@177
   232
			continue;
dvander@177
   233
		}
dvander@177
   234
		if (docopies && temp_info[numparams].flags)
dvander@177
   235
		{
dvander@177
   236
			if (reader)
dvander@177
   237
			{
dvander@177
   238
				if (!reader->OnCopybackArray(numparams, 
dvander@177
   239
										temp_info[numparams].size, 
dvander@177
   240
										temp_info[numparams].phys_addr,
dvander@177
   241
										temp_info[numparams].orig_addr,
dvander@177
   242
										temp_info[numparams].flags))
dvander@177
   243
				{
dvander@177
   244
					goto _skipcopy;
dvander@177
   245
				}
dvander@177
   246
			}
dvander@177
   247
			if (temp_info[numparams].orig_addr)
dvander@177
   248
			{
dvander@177
   249
				memcpy(temp_info[numparams].orig_addr, 
dvander@177
   250
						temp_info[numparams].phys_addr, 
dvander@177
   251
						temp_info[numparams].size * sizeof(cell_t));
dvander@177
   252
			}
dvander@177
   253
		}
dvander@177
   254
_skipcopy:
dvander@177
   255
		base->HeapRelease(temp_info[numparams].local_addr);
dvander@177
   256
		temp_info[numparams].marked = false;
dvander@177
   257
	}
dvander@177
   258
dvander@177
   259
	return err;
dvander@177
   260
}
dvander@177
   261
dvander@177
   262
cell_t *CFunction::GetAddressOfPushedParam(unsigned int param)
dvander@177
   263
{
dvander@177
   264
	if (m_errorstate != SP_ERROR_NONE
dvander@177
   265
		|| param >= m_curparam
dvander@177
   266
		|| !m_info[param].marked)
dvander@177
   267
	{
dvander@177
   268
		return NULL;
dvander@177
   269
	}
dvander@177
   270
dvander@177
   271
	return m_info[param].phys_addr;
dvander@177
   272
}