core/systems/ForwardSys.cpp
author Borja Ferrer <faluco@alliedmods.net>
Fri Jan 12 23:56:02 2007 +0000 (2007-01-12)
changeset 288 d89bf250dac4
parent 282 cd7c334f7ae0
child 291 345d084ae151
permissions -rw-r--r--
Added new debugger logger
Added format errors
Paused plugins now have their forwards blocked
Fixed bug where pausing a plugin wouldnt make any effect
dvander@180
     1
#include <assert.h>
dvander@180
     2
#include "ForwardSys.h"
dvander@180
     3
#include "PluginSys.h"
dvander@180
     4
dvander@186
     5
CForwardManager g_Forwards;
dvander@186
     6
dvander@183
     7
/**
dvander@183
     8
 * Gensis turns to its source, reduction occurs stepwise although the essence is all one.
dvander@183
     9
 * End of line.  FTL system check.
dvander@183
    10
 *
dvander@282
    11
 * :TODO: WHAT NEEDS TO BE TESTED IN THIS BEAST
dvander@183
    12
 * VARARG FUNCTIONS:
dvander@183
    13
 * - Pushing no varargs
dvander@183
    14
 */
dvander@183
    15
faluco@226
    16
// :TODO: IMPORTANT!!! The result pointer arg in the execute function maybe invalid if the forward fails
faluco@226
    17
// so later evaluation of this result may cause problems on higher levels of abstraction. DOCUMENT OR FIX ALL FORWARDS!
faluco@226
    18
dvander@211
    19
void CForwardManager::OnSourceModAllInitialized()
dvander@211
    20
{
dvander@211
    21
	g_PluginSys.AddPluginsListener(this);
dvander@211
    22
}
dvander@211
    23
dvander@211
    24
void CForwardManager::OnSourceModShutdown()
dvander@211
    25
{
dvander@211
    26
	g_PluginSys.RemovePluginsListener(this);
dvander@211
    27
}
dvander@211
    28
dvander@186
    29
IForward *CForwardManager::CreateForward(const char *name, ExecType et, unsigned int num_params, ParamType *types, ...)
dvander@186
    30
{
dvander@186
    31
	CForward *fwd;
dvander@186
    32
	va_list ap;
dvander@186
    33
	va_start(ap, types);
dvander@186
    34
	
dvander@186
    35
	fwd = CForward::CreateForward(name, et, num_params, types, ap);
dvander@186
    36
dvander@186
    37
	va_end(ap);
dvander@186
    38
dvander@211
    39
	if (fwd)
dvander@211
    40
	{
dvander@211
    41
		m_managed.push_back(fwd);
dvander@211
    42
	}
dvander@211
    43
dvander@186
    44
	return fwd;
dvander@186
    45
}
dvander@186
    46
dvander@186
    47
IChangeableForward *CForwardManager::CreateForwardEx(const char *name, ExecType et, int num_params, ParamType *types, ...)
dvander@186
    48
{
dvander@186
    49
	CForward *fwd;
dvander@186
    50
	va_list ap;
dvander@186
    51
	va_start(ap, types);
dvander@186
    52
dvander@186
    53
	fwd = CForward::CreateForward(name, et, num_params, types, ap);
dvander@186
    54
dvander@186
    55
	va_end(ap);
dvander@186
    56
dvander@211
    57
	if (fwd)
dvander@211
    58
	{
dvander@211
    59
		m_unmanaged.push_back(fwd);
dvander@211
    60
	}
dvander@211
    61
dvander@186
    62
	return fwd;
dvander@186
    63
}
dvander@186
    64
dvander@211
    65
void CForwardManager::OnPluginLoaded(IPlugin *plugin)
dvander@211
    66
{
dvander@211
    67
	/* Attach any globally managed forwards */
dvander@211
    68
	List<CForward *>::iterator iter;
dvander@211
    69
	CForward *fwd;
dvander@211
    70
dvander@211
    71
	for (iter=m_managed.begin(); iter!=m_managed.end(); iter++)
dvander@211
    72
	{
dvander@211
    73
		fwd = (*iter);
dvander@211
    74
		IPluginFunction *pFunc = plugin->GetFunctionByName(fwd->GetForwardName());
dvander@211
    75
		if (pFunc)
dvander@211
    76
		{
dvander@211
    77
			fwd->AddFunction(pFunc);
dvander@211
    78
		}
dvander@211
    79
	}
dvander@211
    80
}
dvander@211
    81
dvander@211
    82
void CForwardManager::OnPluginUnloaded(IPlugin *plugin)
dvander@211
    83
{
dvander@211
    84
	List<CForward *>::iterator iter;
dvander@211
    85
	CForward *fwd;
dvander@211
    86
dvander@211
    87
	for (iter=m_managed.begin(); iter!=m_managed.end(); iter++)
dvander@211
    88
	{
dvander@211
    89
		fwd = (*iter);
dvander@211
    90
		fwd->RemoveFunctionsOfPlugin(plugin);
dvander@211
    91
	}
dvander@232
    92
dvander@232
    93
	for (iter=m_unmanaged.begin(); iter!=m_unmanaged.end(); iter++)
dvander@232
    94
	{
dvander@232
    95
		fwd = (*iter);
dvander@232
    96
		fwd->RemoveFunctionsOfPlugin(plugin);
dvander@232
    97
	}
dvander@211
    98
}
dvander@211
    99
dvander@186
   100
IForward *CForwardManager::FindForward(const char *name, IChangeableForward **ifchng)
dvander@186
   101
{
dvander@186
   102
	List<CForward *>::iterator iter;
dvander@186
   103
	CForward *fwd;
dvander@186
   104
dvander@186
   105
	for (iter=m_managed.begin(); iter!=m_managed.end(); iter++)
dvander@186
   106
	{
dvander@186
   107
		fwd = (*iter);
dvander@186
   108
		if (strcmp(fwd->GetForwardName(), name) == 0)
dvander@186
   109
		{
dvander@186
   110
			if (ifchng)
dvander@186
   111
			{
dvander@186
   112
				*ifchng = NULL;
dvander@186
   113
			}
dvander@186
   114
			return fwd;
dvander@186
   115
		}
dvander@186
   116
	}
dvander@186
   117
dvander@186
   118
	for (iter=m_unmanaged.begin(); iter!=m_unmanaged.end(); iter++)
dvander@186
   119
	{
dvander@186
   120
		fwd = (*iter);
dvander@186
   121
		if (strcmp(fwd->GetForwardName(), name) == 0)
dvander@186
   122
		{
dvander@186
   123
			if (ifchng)
dvander@186
   124
			{
dvander@186
   125
				*ifchng = fwd;
dvander@186
   126
			}
dvander@186
   127
			return fwd;
dvander@186
   128
		}
dvander@186
   129
	}
dvander@186
   130
dvander@186
   131
	if (ifchng)
dvander@186
   132
	{
dvander@186
   133
		*ifchng = NULL;
dvander@186
   134
	}
dvander@186
   135
dvander@186
   136
	return NULL;
dvander@186
   137
}
dvander@186
   138
dvander@186
   139
void CForwardManager::ReleaseForward(IForward *forward)
dvander@186
   140
{
dvander@186
   141
	ForwardFree(static_cast<CForward *>(forward));
dvander@186
   142
}
dvander@186
   143
dvander@186
   144
void CForwardManager::ForwardFree(CForward *fwd)
dvander@186
   145
{
dvander@186
   146
	m_FreeForwards.push(fwd);
dvander@186
   147
}
dvander@186
   148
dvander@186
   149
CForward *CForwardManager::ForwardMake()
dvander@186
   150
{
dvander@186
   151
	CForward *fwd;
dvander@186
   152
	if (m_FreeForwards.empty())
dvander@186
   153
	{
dvander@186
   154
		fwd = new CForward;
dvander@186
   155
	} else {
dvander@186
   156
		fwd = m_FreeForwards.front();
dvander@186
   157
		m_FreeForwards.pop();
dvander@186
   158
	}
dvander@186
   159
	return fwd;
dvander@186
   160
}
dvander@186
   161
dvander@186
   162
/*************************************
dvander@186
   163
 * ACTUAL FORWARD API IMPLEMENTATION *
dvander@186
   164
 *************************************/
dvander@186
   165
dvander@180
   166
CForward *CForward::CreateForward(const char *name, ExecType et, unsigned int num_params, ParamType *types, va_list ap)
dvander@180
   167
{
dvander@180
   168
	ParamType _types[SP_MAX_EXEC_PARAMS];
dvander@180
   169
dvander@180
   170
	if (num_params > SP_MAX_EXEC_PARAMS)
dvander@180
   171
	{
dvander@180
   172
		return NULL;
dvander@180
   173
	}
dvander@180
   174
	
dvander@180
   175
	if (types == NULL && num_params)
dvander@180
   176
	{
dvander@180
   177
		for (unsigned int i=0; i<num_params; i++)
dvander@180
   178
		{
dvander@180
   179
			_types[i] = va_arg(ap, ParamType);
dvander@180
   180
			if (_types[i] == Param_VarArgs && (i != num_params - 1))
dvander@180
   181
			{
dvander@180
   182
				return NULL;
dvander@180
   183
			}
dvander@180
   184
		}
dvander@180
   185
		types = _types;
dvander@180
   186
	} else {
dvander@180
   187
		for (unsigned int i=0; i<num_params; i++)
dvander@180
   188
		{
dvander@180
   189
			if (types[i] == Param_VarArgs && (i != num_params - 1))
dvander@180
   190
			{
dvander@180
   191
				return NULL;
dvander@180
   192
			}
dvander@180
   193
		}
dvander@180
   194
	}
dvander@180
   195
dvander@180
   196
	/* First parameter can never be varargs */
dvander@180
   197
	if (types[0] == Param_VarArgs)
dvander@180
   198
	{
dvander@180
   199
		return NULL;
dvander@180
   200
	}
dvander@180
   201
dvander@186
   202
	CForward *pForward = g_Forwards.ForwardMake();
dvander@180
   203
	pForward->m_curparam = 0;
dvander@180
   204
	pForward->m_ExecType = et;
dvander@180
   205
	snprintf(pForward->m_name, FORWARDS_NAME_MAX, "%s", name ? name : "");
dvander@180
   206
	
dvander@180
   207
	for (unsigned int i=0; i<num_params; i++)
dvander@180
   208
	{
dvander@180
   209
		pForward->m_types[i] = types[i];
dvander@180
   210
	}
dvander@180
   211
dvander@180
   212
	if (num_params && types[num_params-1] == Param_VarArgs)
dvander@180
   213
	{
dvander@183
   214
		pForward->m_varargs = num_params--;
dvander@180
   215
	} else {
dvander@180
   216
		pForward->m_varargs = false;
dvander@180
   217
	}
dvander@180
   218
dvander@180
   219
	pForward->m_numparams = num_params;
dvander@180
   220
	pForward->m_errstate = SP_ERROR_NONE;
dvander@180
   221
dvander@180
   222
	return pForward;
dvander@180
   223
}
dvander@180
   224
dvander@180
   225
int CForward::Execute(cell_t *result, IForwardFilter *filter)
dvander@180
   226
{
dvander@180
   227
	if (m_errstate)
dvander@180
   228
	{
dvander@180
   229
		int err = m_errstate;
dvander@180
   230
		Cancel();
dvander@180
   231
		return err;
dvander@180
   232
	}
dvander@180
   233
dvander@180
   234
	if (filter)
dvander@180
   235
	{
dvander@180
   236
		filter->OnExecuteBegin();
dvander@180
   237
	}
dvander@180
   238
dvander@180
   239
	FuncIter iter = m_functions.begin();
dvander@180
   240
	IPluginFunction *func;
dvander@180
   241
	cell_t cur_result = 0;
dvander@180
   242
	cell_t high_result = 0;
dvander@180
   243
	int err;
dvander@180
   244
	unsigned int failed=0, success=0;
dvander@180
   245
	unsigned int save_numcopy = 0;
dvander@183
   246
	unsigned int num_params = m_curparam;
dvander@183
   247
	FwdParamInfo temp_info[SP_MAX_EXEC_PARAMS];
dvander@183
   248
	FwdParamInfo *param;
dvander@183
   249
	ParamType type;
dvander@180
   250
dvander@183
   251
	/* Save local, reset */
dvander@183
   252
	memcpy(temp_info, m_params, sizeof(m_params));
dvander@183
   253
	m_curparam = 0;
dvander@183
   254
dvander@180
   255
	for (iter=m_functions.begin(); iter!=m_functions.end(); iter++)
dvander@180
   256
	{
dvander@180
   257
		func = (*iter);
faluco@288
   258
		if (func->GetParentPlugin()->GetStatus() == Plugin_Paused)
faluco@288
   259
		{
faluco@288
   260
			continue;
faluco@288
   261
		}
dvander@183
   262
dvander@183
   263
		for (unsigned int i=0; i<num_params; i++)
dvander@180
   264
		{
dvander@183
   265
			param = &temp_info[i];
dvander@183
   266
			if (i >= m_numparams || m_types[i] == Param_Any)
dvander@183
   267
			{
dvander@183
   268
				type = param->pushedas;
dvander@183
   269
			} else {
dvander@183
   270
				type = m_types[i];
dvander@183
   271
			}
dvander@183
   272
			if ((i >= m_numparams) || (type & SP_PARAMFLAG_BYREF))
dvander@180
   273
			{
dvander@183
   274
				/* If we're byref or we're vararg, we always push everything by ref.
dvander@183
   275
				 * Even if they're byval, we must push them byref.
dvander@183
   276
				 */
faluco@192
   277
				if (type == Param_String)
dvander@180
   278
				{
faluco@192
   279
					func->PushStringEx((char *)param->byref.orig_addr, param->byref.cells, param->byref.sz_flags, param->byref.flags);
dvander@183
   280
				} else if (type == Param_Float || type == Param_Cell) {
dvander@183
   281
					func->PushCellByRef(&param->val, 0); 
dvander@183
   282
				} else {
dvander@183
   283
					func->PushArray(param->byref.orig_addr, param->byref.cells, NULL, param->byref.flags);
dvander@183
   284
					assert(type == Param_Array || type == Param_FloatByRef || type == Param_CellByRef);
dvander@180
   285
				}
dvander@183
   286
			} else {
dvander@183
   287
				/* If we're not byref or not vararg, our job is a bit easier. */
dvander@183
   288
				assert(type == Param_Cell || type == Param_Float);
dvander@183
   289
				func->PushCell(param->val);
dvander@180
   290
			}
dvander@180
   291
		}
dvander@183
   292
		
dvander@211
   293
		/* Call the function and deal with the return value. */
dvander@183
   294
		if ((err=func->Execute(&cur_result)) != SP_ERROR_NONE)
dvander@180
   295
		{
dvander@180
   296
			bool handled = false;
dvander@180
   297
			if (filter)
dvander@180
   298
			{
dvander@180
   299
				handled = filter->OnErrorReport(this, func, err);
dvander@180
   300
			}
dvander@180
   301
			if (!handled)
dvander@180
   302
			{
dvander@180
   303
				/* :TODO: invoke global error reporting here */
dvander@180
   304
			}
dvander@180
   305
			failed++;
dvander@180
   306
		} else {
dvander@180
   307
			success++;
dvander@180
   308
			switch (m_ExecType)
dvander@180
   309
			{
dvander@180
   310
			case ET_Event:
dvander@180
   311
				{
dvander@180
   312
					if (cur_result > high_result)
dvander@180
   313
					{
dvander@180
   314
						high_result = cur_result;
dvander@180
   315
					}
dvander@180
   316
					break;
dvander@180
   317
				}
dvander@180
   318
			case ET_Hook:
dvander@180
   319
				{
dvander@180
   320
					if (cur_result > high_result)
dvander@180
   321
					{
dvander@180
   322
						high_result = cur_result;
dvander@180
   323
						if ((ResultType)high_result == Pl_Stop)
dvander@180
   324
						{
dvander@180
   325
							iter = m_functions.end();
dvander@180
   326
							break;
dvander@180
   327
						}
dvander@180
   328
					}
dvander@180
   329
					break;
dvander@180
   330
				}
dvander@180
   331
			case ET_Custom:
dvander@180
   332
				{
dvander@180
   333
					if (filter)
dvander@180
   334
					{
dvander@180
   335
						if (filter->OnFunctionReturn(this, func, &cur_result) == Pl_Stop)
dvander@180
   336
						{
dvander@180
   337
							iter = m_functions.end();
dvander@180
   338
						}
dvander@180
   339
					}
dvander@180
   340
					break;
dvander@180
   341
				}
dvander@180
   342
			}
dvander@180
   343
		}
dvander@180
   344
	}
dvander@180
   345
dvander@180
   346
	if (m_ExecType == ET_Event || m_ExecType == ET_Hook)
dvander@180
   347
	{
dvander@180
   348
		cur_result = high_result;
dvander@180
   349
	} else if (m_ExecType == ET_Ignore) {
dvander@180
   350
		cur_result = 0;
dvander@180
   351
	}
dvander@180
   352
dvander@180
   353
	*result = cur_result;
dvander@180
   354
dvander@180
   355
	if (filter)
dvander@180
   356
	{
dvander@180
   357
		filter->OnExecuteEnd(&cur_result, success, failed);
dvander@180
   358
	}
dvander@180
   359
dvander@180
   360
	return SP_ERROR_NONE;
dvander@180
   361
}
dvander@180
   362
dvander@180
   363
int CForward::PushCell(cell_t cell)
dvander@180
   364
{
dvander@180
   365
	if (m_curparam < m_numparams)
dvander@180
   366
	{
dvander@183
   367
		if (m_types[m_curparam] == Param_Any)
dvander@180
   368
		{
dvander@183
   369
			m_params[m_curparam].pushedas = Param_Cell;
dvander@183
   370
		} else if (m_types[m_curparam] != Param_Cell) {
dvander@180
   371
			return SetError(SP_ERROR_PARAM);
dvander@180
   372
		}
dvander@180
   373
	} else {
dvander@180
   374
		if (!m_varargs || m_numparams > SP_MAX_EXEC_PARAMS)
dvander@180
   375
		{
dvander@180
   376
			return SetError(SP_ERROR_PARAMS_MAX);
dvander@180
   377
		}
dvander@183
   378
		m_params[m_curparam].pushedas = Param_Cell;
dvander@180
   379
	}
dvander@180
   380
dvander@183
   381
	m_params[m_curparam++].val = cell;
dvander@180
   382
dvander@180
   383
	return SP_ERROR_NONE;
dvander@180
   384
}
dvander@180
   385
dvander@180
   386
int CForward::PushFloat(float number)
dvander@180
   387
{
dvander@180
   388
	if (m_curparam < m_numparams)
dvander@180
   389
	{
dvander@183
   390
		if (m_types[m_curparam] == Param_Any)
dvander@180
   391
		{
dvander@183
   392
			m_params[m_curparam].pushedas = Param_Float;
dvander@183
   393
		} else if (m_types[m_curparam] != Param_Float) {
dvander@180
   394
			return SetError(SP_ERROR_PARAM);
dvander@180
   395
		}
dvander@180
   396
	} else {
dvander@180
   397
		if (!m_varargs || m_numparams > SP_MAX_EXEC_PARAMS)
dvander@180
   398
		{
dvander@180
   399
			return SetError(SP_ERROR_PARAMS_MAX);
dvander@180
   400
		}
dvander@183
   401
		m_params[m_curparam].pushedas = Param_Float;
dvander@180
   402
	}
dvander@180
   403
dvander@183
   404
	m_params[m_curparam++].val = *(cell_t *)&number;
dvander@180
   405
dvander@180
   406
	return SP_ERROR_NONE;
dvander@180
   407
}
dvander@180
   408
dvander@180
   409
int CForward::PushCellByRef(cell_t *cell, int flags)
dvander@180
   410
{
dvander@180
   411
	if (m_curparam < m_numparams)
dvander@180
   412
	{
faluco@192
   413
		if (m_types[m_curparam] == Param_Any)
dvander@180
   414
		{
faluco@192
   415
			m_params[m_curparam].pushedas = Param_CellByRef;
faluco@192
   416
		} else if (m_types[m_curparam] != Param_CellByRef) {
dvander@180
   417
			return SetError(SP_ERROR_PARAM);
dvander@180
   418
		}
dvander@180
   419
	} else {
dvander@180
   420
		if (!m_varargs || m_numparams > SP_MAX_EXEC_PARAMS)
dvander@180
   421
		{
dvander@180
   422
			return SetError(SP_ERROR_PARAMS_MAX);
dvander@180
   423
		}
faluco@192
   424
		m_params[m_curparam].pushedas = Param_CellByRef;
dvander@180
   425
	}
dvander@180
   426
dvander@183
   427
	_Int_PushArray(cell, 1, flags);
dvander@180
   428
	m_curparam++;
dvander@180
   429
dvander@180
   430
	return SP_ERROR_NONE;
dvander@180
   431
}
dvander@180
   432
dvander@180
   433
int CForward::PushFloatByRef(float *num, int flags)
dvander@180
   434
{
dvander@180
   435
	if (m_curparam < m_numparams)
dvander@180
   436
	{
faluco@192
   437
		if (m_types[m_curparam] == Param_Any)
dvander@180
   438
		{
faluco@192
   439
			m_params[m_curparam].pushedas = Param_FloatByRef;
faluco@192
   440
		} else if (m_types[m_curparam] != Param_FloatByRef) {
dvander@180
   441
			return SetError(SP_ERROR_PARAM);
dvander@180
   442
		}
dvander@180
   443
	} else {
dvander@180
   444
		if (!m_varargs || m_numparams > SP_MAX_EXEC_PARAMS)
dvander@180
   445
		{
dvander@180
   446
			return SetError(SP_ERROR_PARAMS_MAX);
dvander@180
   447
		}
faluco@192
   448
		m_params[m_curparam].pushedas = Param_FloatByRef;
dvander@180
   449
	}
dvander@180
   450
dvander@183
   451
	_Int_PushArray((cell_t *)num, 1, flags);
dvander@180
   452
	m_curparam++;
dvander@180
   453
dvander@180
   454
	return SP_ERROR_NONE;
dvander@180
   455
}
dvander@180
   456
dvander@180
   457
void CForward::_Int_PushArray(cell_t *inarray, unsigned int cells, int flags)
dvander@180
   458
{
dvander@183
   459
	m_params[m_curparam].byref.cells = cells;
dvander@183
   460
	m_params[m_curparam].byref.flags = flags;
dvander@183
   461
	m_params[m_curparam].byref.orig_addr = inarray;
dvander@180
   462
}
dvander@180
   463
dvander@180
   464
int CForward::PushArray(cell_t *inarray, unsigned int cells, cell_t **phys_addr, int flags)
dvander@180
   465
{
dvander@180
   466
	/* We don't allow this here */
dvander@180
   467
	if (!inarray)
dvander@180
   468
	{
dvander@180
   469
		return SetError(SP_ERROR_PARAM);
dvander@180
   470
	}
dvander@180
   471
dvander@180
   472
	if (m_curparam < m_numparams)
dvander@180
   473
	{
dvander@183
   474
		if (m_types[m_curparam] == Param_Any)
dvander@180
   475
		{
dvander@183
   476
			m_params[m_curparam].pushedas = Param_Array;
dvander@183
   477
		} else if (m_types[m_curparam] != Param_Array) {
dvander@180
   478
			return SetError(SP_ERROR_PARAM);
dvander@180
   479
		}
dvander@180
   480
	} else {
dvander@180
   481
		if (!m_varargs || m_curparam > SP_MAX_EXEC_PARAMS)
dvander@180
   482
		{
dvander@180
   483
			return SetError(SP_ERROR_PARAMS_MAX);
dvander@180
   484
		}
dvander@183
   485
		m_params[m_curparam].pushedas = Param_Array;
dvander@180
   486
	}
dvander@180
   487
dvander@180
   488
	if (phys_addr)
dvander@180
   489
	{
dvander@180
   490
		*phys_addr = NULL;
dvander@180
   491
	}
dvander@180
   492
dvander@180
   493
	_Int_PushArray(inarray, cells, flags);
dvander@180
   494
dvander@180
   495
	m_curparam++;
dvander@180
   496
dvander@180
   497
	return SP_ERROR_NONE;
dvander@180
   498
}
dvander@180
   499
faluco@192
   500
void CForward::_Int_PushString(cell_t *inarray, unsigned int cells, int sz_flags, int cp_flags)
faluco@192
   501
{
faluco@192
   502
	m_params[m_curparam].byref.cells = cells;	/* Notice this contains the char count not cell count */
faluco@192
   503
	m_params[m_curparam].byref.flags = cp_flags;
faluco@192
   504
	m_params[m_curparam].byref.orig_addr = inarray;
faluco@192
   505
	m_params[m_curparam].byref.sz_flags = sz_flags;
faluco@192
   506
}
faluco@192
   507
dvander@180
   508
int CForward::PushString(const char *string)
dvander@180
   509
{
dvander@180
   510
	if (m_curparam < m_numparams)
dvander@180
   511
	{
dvander@183
   512
		if (m_types[m_curparam] == Param_Any)
dvander@180
   513
		{
dvander@183
   514
			m_params[m_curparam].pushedas = Param_String;
faluco@188
   515
		} else if (m_types[m_curparam] != Param_String) {
dvander@180
   516
			return SetError(SP_ERROR_PARAM);
dvander@180
   517
		}
dvander@180
   518
	} else {
dvander@180
   519
		if (!m_varargs || m_curparam > SP_MAX_EXEC_PARAMS)
dvander@180
   520
		{
dvander@180
   521
			return SetError(SP_ERROR_PARAMS_MAX);
dvander@180
   522
		}
dvander@183
   523
		m_params[m_curparam].pushedas = Param_String;
dvander@180
   524
	}
dvander@180
   525
dvander@211
   526
	_Int_PushString((cell_t *)string, strlen(string)+1, SM_PARAM_STRING_COPY, 0);
dvander@180
   527
	m_curparam++;
dvander@180
   528
dvander@180
   529
	return SP_ERROR_NONE;
dvander@180
   530
}
dvander@180
   531
faluco@192
   532
int CForward::PushStringEx(char *buffer, size_t length, int sz_flags, int cp_flags)
dvander@180
   533
{
dvander@180
   534
	if (m_curparam < m_numparams)
dvander@180
   535
	{
dvander@183
   536
		if (m_types[m_curparam] == Param_Any)
dvander@180
   537
		{
dvander@183
   538
			m_params[m_curparam].pushedas = Param_String;
faluco@188
   539
		} else if (m_types[m_curparam] != Param_String) {
dvander@180
   540
			return SetError(SP_ERROR_PARAM);
dvander@180
   541
		}
dvander@180
   542
	} else {
dvander@180
   543
		if (!m_varargs || m_curparam > SP_MAX_EXEC_PARAMS)
dvander@180
   544
		{
dvander@180
   545
			return SetError(SP_ERROR_PARAMS_MAX);
dvander@180
   546
		}
dvander@183
   547
		m_params[m_curparam].pushedas = Param_String;
dvander@180
   548
	}
dvander@180
   549
faluco@192
   550
	_Int_PushString((cell_t *)buffer, length, sz_flags, cp_flags);
dvander@180
   551
	m_curparam++;
dvander@180
   552
dvander@180
   553
	return SP_ERROR_NONE;
dvander@180
   554
}
dvander@180
   555
dvander@180
   556
void CForward::Cancel()
dvander@180
   557
{
dvander@180
   558
	if (!m_curparam)
dvander@180
   559
	{
dvander@180
   560
		return;
dvander@180
   561
	}
dvander@180
   562
dvander@183
   563
	m_curparam = 0;
dvander@180
   564
	m_errstate = SP_ERROR_NONE;
dvander@180
   565
}
dvander@180
   566
dvander@180
   567
bool CForward::AddFunction(sp_context_t *ctx, funcid_t index)
dvander@180
   568
{
dvander@211
   569
	IPlugin *pPlugin = g_PluginSys.FindPluginByContext(ctx);
dvander@180
   570
	if (!pPlugin)
dvander@180
   571
	{
dvander@180
   572
		return false;
dvander@180
   573
	}
dvander@180
   574
dvander@180
   575
	IPluginFunction *pFunc = pPlugin->GetFunctionById(index);
dvander@180
   576
	if (!pFunc)
dvander@180
   577
	{
dvander@180
   578
		return false;
dvander@180
   579
	}
dvander@180
   580
dvander@180
   581
	return AddFunction(pFunc);
dvander@180
   582
}
dvander@180
   583
dvander@180
   584
bool CForward::RemoveFunction(IPluginFunction *func)
dvander@180
   585
{
dvander@180
   586
	bool found = false;
dvander@180
   587
	FuncIter iter;
dvander@180
   588
	IPluginFunction *pNext = NULL;
dvander@180
   589
dvander@180
   590
	for (iter=m_functions.begin(); iter!=m_functions.end();)
dvander@180
   591
	{
dvander@180
   592
		if ((*iter) == func)
dvander@180
   593
		{
dvander@180
   594
			found = true;
dvander@180
   595
			/* If this iterator is being used, swap in a new one !*/
dvander@180
   596
			iter = m_functions.erase(iter);
dvander@180
   597
		} else {
dvander@180
   598
			iter++;
dvander@180
   599
		}
dvander@180
   600
	}
dvander@180
   601
dvander@180
   602
	/* Cancel a call, if any */
dvander@183
   603
	if (found || m_curparam)
dvander@180
   604
	{
dvander@180
   605
		func->Cancel();
dvander@180
   606
	}
dvander@180
   607
dvander@180
   608
	return found;
dvander@180
   609
}
dvander@180
   610
dvander@180
   611
unsigned int CForward::RemoveFunctionsOfPlugin(IPlugin *plugin)
dvander@180
   612
{
dvander@180
   613
	FuncIter iter;
dvander@180
   614
	IPluginFunction *func;
dvander@180
   615
	unsigned int removed = 0;
dvander@180
   616
	for (iter=m_functions.begin(); iter!=m_functions.end();)
dvander@180
   617
	{
dvander@180
   618
		func = (*iter);
dvander@180
   619
		if (func->GetParentPlugin() == plugin)
dvander@180
   620
		{
dvander@180
   621
			iter = m_functions.erase(iter);
dvander@180
   622
			removed++;
dvander@180
   623
		} else {
dvander@180
   624
			iter++;
dvander@180
   625
		}
dvander@180
   626
	}
dvander@180
   627
dvander@180
   628
	return removed;
dvander@180
   629
}
dvander@180
   630
dvander@180
   631
bool CForward::AddFunction(IPluginFunction *func)
dvander@180
   632
{
dvander@180
   633
	if (m_curparam)
dvander@180
   634
	{
dvander@180
   635
		return false;
dvander@180
   636
	}
dvander@180
   637
dvander@282
   638
	//:IDEA: eventually we will tell the plugin we're using it [?]
dvander@183
   639
	m_functions.push_back(func);
dvander@180
   640
dvander@180
   641
	return true;
dvander@180
   642
}
dvander@180
   643
dvander@180
   644
const char *CForward::GetForwardName()
dvander@180
   645
{
dvander@180
   646
	return m_name;
dvander@180
   647
}
dvander@180
   648
dvander@180
   649
unsigned int CForward::GetFunctionCount()
dvander@180
   650
{
dvander@180
   651
	return m_functions.size();
dvander@180
   652
}
dvander@180
   653
dvander@180
   654
ExecType CForward::GetExecType()
dvander@180
   655
{
dvander@180
   656
	return m_ExecType;
dvander@180
   657
}