dvander@180: #include dvander@180: #include "ForwardSys.h" dvander@180: #include "PluginSys.h" dvander@180: dvander@186: CForwardManager g_Forwards; dvander@186: dvander@183: /** dvander@183: * Gensis turns to its source, reduction occurs stepwise although the essence is all one. dvander@183: * End of line. FTL system check. dvander@183: * dvander@282: * :TODO: WHAT NEEDS TO BE TESTED IN THIS BEAST dvander@183: * VARARG FUNCTIONS: dvander@183: * - Pushing no varargs dvander@183: */ dvander@183: faluco@226: // :TODO: IMPORTANT!!! The result pointer arg in the execute function maybe invalid if the forward fails faluco@226: // so later evaluation of this result may cause problems on higher levels of abstraction. DOCUMENT OR FIX ALL FORWARDS! faluco@226: dvander@211: void CForwardManager::OnSourceModAllInitialized() dvander@211: { dvander@211: g_PluginSys.AddPluginsListener(this); dvander@211: } dvander@211: dvander@211: void CForwardManager::OnSourceModShutdown() dvander@211: { dvander@211: g_PluginSys.RemovePluginsListener(this); dvander@211: } dvander@211: dvander@186: IForward *CForwardManager::CreateForward(const char *name, ExecType et, unsigned int num_params, ParamType *types, ...) dvander@186: { dvander@186: CForward *fwd; dvander@186: va_list ap; dvander@186: va_start(ap, types); dvander@186: dvander@186: fwd = CForward::CreateForward(name, et, num_params, types, ap); dvander@186: dvander@186: va_end(ap); dvander@186: dvander@211: if (fwd) dvander@211: { dvander@211: m_managed.push_back(fwd); dvander@211: } dvander@211: dvander@186: return fwd; dvander@186: } dvander@186: dvander@186: IChangeableForward *CForwardManager::CreateForwardEx(const char *name, ExecType et, int num_params, ParamType *types, ...) dvander@186: { dvander@186: CForward *fwd; dvander@186: va_list ap; dvander@186: va_start(ap, types); dvander@186: dvander@186: fwd = CForward::CreateForward(name, et, num_params, types, ap); dvander@186: dvander@186: va_end(ap); dvander@186: dvander@211: if (fwd) dvander@211: { dvander@211: m_unmanaged.push_back(fwd); dvander@211: } dvander@211: dvander@186: return fwd; dvander@186: } dvander@186: dvander@211: void CForwardManager::OnPluginLoaded(IPlugin *plugin) dvander@211: { dvander@211: /* Attach any globally managed forwards */ dvander@211: List::iterator iter; dvander@211: CForward *fwd; dvander@211: dvander@211: for (iter=m_managed.begin(); iter!=m_managed.end(); iter++) dvander@211: { dvander@211: fwd = (*iter); dvander@211: IPluginFunction *pFunc = plugin->GetFunctionByName(fwd->GetForwardName()); dvander@211: if (pFunc) dvander@211: { dvander@211: fwd->AddFunction(pFunc); dvander@211: } dvander@211: } dvander@211: } dvander@211: dvander@211: void CForwardManager::OnPluginUnloaded(IPlugin *plugin) dvander@211: { dvander@211: List::iterator iter; dvander@211: CForward *fwd; dvander@211: dvander@211: for (iter=m_managed.begin(); iter!=m_managed.end(); iter++) dvander@211: { dvander@211: fwd = (*iter); dvander@211: fwd->RemoveFunctionsOfPlugin(plugin); dvander@211: } dvander@232: dvander@232: for (iter=m_unmanaged.begin(); iter!=m_unmanaged.end(); iter++) dvander@232: { dvander@232: fwd = (*iter); dvander@232: fwd->RemoveFunctionsOfPlugin(plugin); dvander@232: } dvander@211: } dvander@211: dvander@186: IForward *CForwardManager::FindForward(const char *name, IChangeableForward **ifchng) dvander@186: { dvander@186: List::iterator iter; dvander@186: CForward *fwd; dvander@186: dvander@186: for (iter=m_managed.begin(); iter!=m_managed.end(); iter++) dvander@186: { dvander@186: fwd = (*iter); dvander@186: if (strcmp(fwd->GetForwardName(), name) == 0) dvander@186: { dvander@186: if (ifchng) dvander@186: { dvander@186: *ifchng = NULL; dvander@186: } dvander@186: return fwd; dvander@186: } dvander@186: } dvander@186: dvander@186: for (iter=m_unmanaged.begin(); iter!=m_unmanaged.end(); iter++) dvander@186: { dvander@186: fwd = (*iter); dvander@186: if (strcmp(fwd->GetForwardName(), name) == 0) dvander@186: { dvander@186: if (ifchng) dvander@186: { dvander@186: *ifchng = fwd; dvander@186: } dvander@186: return fwd; dvander@186: } dvander@186: } dvander@186: dvander@186: if (ifchng) dvander@186: { dvander@186: *ifchng = NULL; dvander@186: } dvander@186: dvander@186: return NULL; dvander@186: } dvander@186: dvander@186: void CForwardManager::ReleaseForward(IForward *forward) dvander@186: { dvander@186: ForwardFree(static_cast(forward)); dvander@186: } dvander@186: dvander@186: void CForwardManager::ForwardFree(CForward *fwd) dvander@186: { dvander@186: m_FreeForwards.push(fwd); faluco@291: m_managed.remove(fwd); dvander@186: } dvander@186: dvander@186: CForward *CForwardManager::ForwardMake() dvander@186: { dvander@186: CForward *fwd; dvander@186: if (m_FreeForwards.empty()) dvander@186: { dvander@186: fwd = new CForward; dvander@186: } else { dvander@186: fwd = m_FreeForwards.front(); dvander@186: m_FreeForwards.pop(); dvander@186: } dvander@186: return fwd; dvander@186: } dvander@186: dvander@186: /************************************* dvander@186: * ACTUAL FORWARD API IMPLEMENTATION * dvander@186: *************************************/ dvander@186: dvander@180: CForward *CForward::CreateForward(const char *name, ExecType et, unsigned int num_params, ParamType *types, va_list ap) dvander@180: { dvander@180: ParamType _types[SP_MAX_EXEC_PARAMS]; dvander@180: dvander@180: if (num_params > SP_MAX_EXEC_PARAMS) dvander@180: { dvander@180: return NULL; dvander@180: } dvander@180: dvander@180: if (types == NULL && num_params) dvander@180: { dvander@180: for (unsigned int i=0; im_curparam = 0; dvander@180: pForward->m_ExecType = et; dvander@180: snprintf(pForward->m_name, FORWARDS_NAME_MAX, "%s", name ? name : ""); dvander@180: dvander@180: for (unsigned int i=0; im_types[i] = types[i]; dvander@180: } dvander@180: dvander@180: if (num_params && types[num_params-1] == Param_VarArgs) dvander@180: { dvander@183: pForward->m_varargs = num_params--; dvander@180: } else { dvander@180: pForward->m_varargs = false; dvander@180: } dvander@180: dvander@180: pForward->m_numparams = num_params; dvander@180: pForward->m_errstate = SP_ERROR_NONE; dvander@180: dvander@180: return pForward; dvander@180: } dvander@180: dvander@180: int CForward::Execute(cell_t *result, IForwardFilter *filter) dvander@180: { dvander@180: if (m_errstate) dvander@180: { dvander@180: int err = m_errstate; dvander@180: Cancel(); dvander@180: return err; dvander@180: } dvander@180: dvander@180: if (filter) dvander@180: { dvander@180: filter->OnExecuteBegin(); dvander@180: } dvander@180: dvander@180: FuncIter iter = m_functions.begin(); dvander@180: IPluginFunction *func; dvander@180: cell_t cur_result = 0; dvander@180: cell_t high_result = 0; dvander@180: int err; dvander@180: unsigned int failed=0, success=0; dvander@180: unsigned int save_numcopy = 0; dvander@183: unsigned int num_params = m_curparam; dvander@183: FwdParamInfo temp_info[SP_MAX_EXEC_PARAMS]; dvander@183: FwdParamInfo *param; dvander@183: ParamType type; dvander@180: dvander@183: /* Save local, reset */ dvander@183: memcpy(temp_info, m_params, sizeof(m_params)); dvander@183: m_curparam = 0; dvander@183: dvander@180: for (iter=m_functions.begin(); iter!=m_functions.end(); iter++) dvander@180: { dvander@180: func = (*iter); faluco@288: if (func->GetParentPlugin()->GetStatus() == Plugin_Paused) faluco@288: { faluco@288: continue; faluco@288: } dvander@183: dvander@183: for (unsigned int i=0; i= m_numparams || m_types[i] == Param_Any) dvander@183: { dvander@183: type = param->pushedas; dvander@183: } else { dvander@183: type = m_types[i]; dvander@183: } dvander@183: if ((i >= m_numparams) || (type & SP_PARAMFLAG_BYREF)) dvander@180: { dvander@183: /* If we're byref or we're vararg, we always push everything by ref. dvander@183: * Even if they're byval, we must push them byref. dvander@183: */ faluco@192: if (type == Param_String) dvander@180: { faluco@192: func->PushStringEx((char *)param->byref.orig_addr, param->byref.cells, param->byref.sz_flags, param->byref.flags); dvander@183: } else if (type == Param_Float || type == Param_Cell) { dvander@183: func->PushCellByRef(¶m->val, 0); dvander@183: } else { dvander@183: func->PushArray(param->byref.orig_addr, param->byref.cells, NULL, param->byref.flags); dvander@183: assert(type == Param_Array || type == Param_FloatByRef || type == Param_CellByRef); dvander@180: } dvander@183: } else { dvander@183: /* If we're not byref or not vararg, our job is a bit easier. */ dvander@183: assert(type == Param_Cell || type == Param_Float); dvander@183: func->PushCell(param->val); dvander@180: } dvander@180: } dvander@183: dvander@211: /* Call the function and deal with the return value. */ dvander@183: if ((err=func->Execute(&cur_result)) != SP_ERROR_NONE) dvander@180: { dvander@180: bool handled = false; dvander@180: if (filter) dvander@180: { dvander@180: handled = filter->OnErrorReport(this, func, err); dvander@180: } dvander@180: if (!handled) dvander@180: { dvander@180: /* :TODO: invoke global error reporting here */ dvander@180: } dvander@180: failed++; dvander@180: } else { dvander@180: success++; dvander@180: switch (m_ExecType) dvander@180: { dvander@180: case ET_Event: dvander@180: { dvander@180: if (cur_result > high_result) dvander@180: { dvander@180: high_result = cur_result; dvander@180: } dvander@180: break; dvander@180: } dvander@180: case ET_Hook: dvander@180: { dvander@180: if (cur_result > high_result) dvander@180: { dvander@180: high_result = cur_result; dvander@180: if ((ResultType)high_result == Pl_Stop) dvander@180: { dvander@180: iter = m_functions.end(); dvander@180: break; dvander@180: } dvander@180: } dvander@180: break; dvander@180: } dvander@180: case ET_Custom: dvander@180: { dvander@180: if (filter) dvander@180: { dvander@180: if (filter->OnFunctionReturn(this, func, &cur_result) == Pl_Stop) dvander@180: { dvander@180: iter = m_functions.end(); dvander@180: } dvander@180: } dvander@180: break; dvander@180: } dvander@180: } dvander@180: } dvander@180: } dvander@180: dvander@180: if (m_ExecType == ET_Event || m_ExecType == ET_Hook) dvander@180: { dvander@180: cur_result = high_result; dvander@180: } else if (m_ExecType == ET_Ignore) { dvander@180: cur_result = 0; dvander@180: } dvander@180: dvander@180: *result = cur_result; dvander@180: dvander@180: if (filter) dvander@180: { dvander@180: filter->OnExecuteEnd(&cur_result, success, failed); dvander@180: } dvander@180: dvander@180: return SP_ERROR_NONE; dvander@180: } dvander@180: dvander@180: int CForward::PushCell(cell_t cell) dvander@180: { dvander@180: if (m_curparam < m_numparams) dvander@180: { dvander@183: if (m_types[m_curparam] == Param_Any) dvander@180: { dvander@183: m_params[m_curparam].pushedas = Param_Cell; dvander@183: } else if (m_types[m_curparam] != Param_Cell) { dvander@180: return SetError(SP_ERROR_PARAM); dvander@180: } dvander@180: } else { dvander@180: if (!m_varargs || m_numparams > SP_MAX_EXEC_PARAMS) dvander@180: { dvander@180: return SetError(SP_ERROR_PARAMS_MAX); dvander@180: } dvander@183: m_params[m_curparam].pushedas = Param_Cell; dvander@180: } dvander@180: dvander@183: m_params[m_curparam++].val = cell; dvander@180: dvander@180: return SP_ERROR_NONE; dvander@180: } dvander@180: dvander@180: int CForward::PushFloat(float number) dvander@180: { dvander@180: if (m_curparam < m_numparams) dvander@180: { dvander@183: if (m_types[m_curparam] == Param_Any) dvander@180: { dvander@183: m_params[m_curparam].pushedas = Param_Float; dvander@183: } else if (m_types[m_curparam] != Param_Float) { dvander@180: return SetError(SP_ERROR_PARAM); dvander@180: } dvander@180: } else { dvander@180: if (!m_varargs || m_numparams > SP_MAX_EXEC_PARAMS) dvander@180: { dvander@180: return SetError(SP_ERROR_PARAMS_MAX); dvander@180: } dvander@183: m_params[m_curparam].pushedas = Param_Float; dvander@180: } dvander@180: dvander@183: m_params[m_curparam++].val = *(cell_t *)&number; dvander@180: dvander@180: return SP_ERROR_NONE; dvander@180: } dvander@180: dvander@180: int CForward::PushCellByRef(cell_t *cell, int flags) dvander@180: { dvander@180: if (m_curparam < m_numparams) dvander@180: { faluco@192: if (m_types[m_curparam] == Param_Any) dvander@180: { faluco@192: m_params[m_curparam].pushedas = Param_CellByRef; faluco@192: } else if (m_types[m_curparam] != Param_CellByRef) { dvander@180: return SetError(SP_ERROR_PARAM); dvander@180: } dvander@180: } else { dvander@180: if (!m_varargs || m_numparams > SP_MAX_EXEC_PARAMS) dvander@180: { dvander@180: return SetError(SP_ERROR_PARAMS_MAX); dvander@180: } faluco@192: m_params[m_curparam].pushedas = Param_CellByRef; dvander@180: } dvander@180: dvander@183: _Int_PushArray(cell, 1, flags); dvander@180: m_curparam++; dvander@180: dvander@180: return SP_ERROR_NONE; dvander@180: } dvander@180: dvander@180: int CForward::PushFloatByRef(float *num, int flags) dvander@180: { dvander@180: if (m_curparam < m_numparams) dvander@180: { faluco@192: if (m_types[m_curparam] == Param_Any) dvander@180: { faluco@192: m_params[m_curparam].pushedas = Param_FloatByRef; faluco@192: } else if (m_types[m_curparam] != Param_FloatByRef) { dvander@180: return SetError(SP_ERROR_PARAM); dvander@180: } dvander@180: } else { dvander@180: if (!m_varargs || m_numparams > SP_MAX_EXEC_PARAMS) dvander@180: { dvander@180: return SetError(SP_ERROR_PARAMS_MAX); dvander@180: } faluco@192: m_params[m_curparam].pushedas = Param_FloatByRef; dvander@180: } dvander@180: dvander@183: _Int_PushArray((cell_t *)num, 1, flags); dvander@180: m_curparam++; dvander@180: dvander@180: return SP_ERROR_NONE; dvander@180: } dvander@180: dvander@180: void CForward::_Int_PushArray(cell_t *inarray, unsigned int cells, int flags) dvander@180: { dvander@183: m_params[m_curparam].byref.cells = cells; dvander@183: m_params[m_curparam].byref.flags = flags; dvander@183: m_params[m_curparam].byref.orig_addr = inarray; dvander@180: } dvander@180: dvander@180: int CForward::PushArray(cell_t *inarray, unsigned int cells, cell_t **phys_addr, int flags) dvander@180: { dvander@180: /* We don't allow this here */ dvander@180: if (!inarray) dvander@180: { dvander@180: return SetError(SP_ERROR_PARAM); dvander@180: } dvander@180: dvander@180: if (m_curparam < m_numparams) dvander@180: { dvander@183: if (m_types[m_curparam] == Param_Any) dvander@180: { dvander@183: m_params[m_curparam].pushedas = Param_Array; dvander@183: } else if (m_types[m_curparam] != Param_Array) { dvander@180: return SetError(SP_ERROR_PARAM); dvander@180: } dvander@180: } else { dvander@180: if (!m_varargs || m_curparam > SP_MAX_EXEC_PARAMS) dvander@180: { dvander@180: return SetError(SP_ERROR_PARAMS_MAX); dvander@180: } dvander@183: m_params[m_curparam].pushedas = Param_Array; dvander@180: } dvander@180: dvander@180: if (phys_addr) dvander@180: { dvander@180: *phys_addr = NULL; dvander@180: } dvander@180: dvander@180: _Int_PushArray(inarray, cells, flags); dvander@180: dvander@180: m_curparam++; dvander@180: dvander@180: return SP_ERROR_NONE; dvander@180: } dvander@180: faluco@192: void CForward::_Int_PushString(cell_t *inarray, unsigned int cells, int sz_flags, int cp_flags) faluco@192: { faluco@192: m_params[m_curparam].byref.cells = cells; /* Notice this contains the char count not cell count */ faluco@192: m_params[m_curparam].byref.flags = cp_flags; faluco@192: m_params[m_curparam].byref.orig_addr = inarray; faluco@192: m_params[m_curparam].byref.sz_flags = sz_flags; faluco@192: } faluco@192: dvander@180: int CForward::PushString(const char *string) dvander@180: { dvander@180: if (m_curparam < m_numparams) dvander@180: { dvander@183: if (m_types[m_curparam] == Param_Any) dvander@180: { dvander@183: m_params[m_curparam].pushedas = Param_String; faluco@188: } else if (m_types[m_curparam] != Param_String) { dvander@180: return SetError(SP_ERROR_PARAM); dvander@180: } dvander@180: } else { dvander@180: if (!m_varargs || m_curparam > SP_MAX_EXEC_PARAMS) dvander@180: { dvander@180: return SetError(SP_ERROR_PARAMS_MAX); dvander@180: } dvander@183: m_params[m_curparam].pushedas = Param_String; dvander@180: } dvander@180: dvander@211: _Int_PushString((cell_t *)string, strlen(string)+1, SM_PARAM_STRING_COPY, 0); dvander@180: m_curparam++; dvander@180: dvander@180: return SP_ERROR_NONE; dvander@180: } dvander@180: faluco@192: int CForward::PushStringEx(char *buffer, size_t length, int sz_flags, int cp_flags) dvander@180: { dvander@180: if (m_curparam < m_numparams) dvander@180: { dvander@183: if (m_types[m_curparam] == Param_Any) dvander@180: { dvander@183: m_params[m_curparam].pushedas = Param_String; faluco@188: } else if (m_types[m_curparam] != Param_String) { dvander@180: return SetError(SP_ERROR_PARAM); dvander@180: } dvander@180: } else { dvander@180: if (!m_varargs || m_curparam > SP_MAX_EXEC_PARAMS) dvander@180: { dvander@180: return SetError(SP_ERROR_PARAMS_MAX); dvander@180: } dvander@183: m_params[m_curparam].pushedas = Param_String; dvander@180: } dvander@180: faluco@192: _Int_PushString((cell_t *)buffer, length, sz_flags, cp_flags); dvander@180: m_curparam++; dvander@180: dvander@180: return SP_ERROR_NONE; dvander@180: } dvander@180: dvander@180: void CForward::Cancel() dvander@180: { dvander@180: if (!m_curparam) dvander@180: { dvander@180: return; dvander@180: } dvander@180: dvander@183: m_curparam = 0; dvander@180: m_errstate = SP_ERROR_NONE; dvander@180: } dvander@180: dvander@180: bool CForward::AddFunction(sp_context_t *ctx, funcid_t index) dvander@180: { dvander@211: IPlugin *pPlugin = g_PluginSys.FindPluginByContext(ctx); dvander@180: if (!pPlugin) dvander@180: { dvander@180: return false; dvander@180: } dvander@180: dvander@180: IPluginFunction *pFunc = pPlugin->GetFunctionById(index); dvander@180: if (!pFunc) dvander@180: { dvander@180: return false; dvander@180: } dvander@180: dvander@180: return AddFunction(pFunc); dvander@180: } dvander@180: dvander@180: bool CForward::RemoveFunction(IPluginFunction *func) dvander@180: { dvander@180: bool found = false; dvander@180: FuncIter iter; dvander@180: IPluginFunction *pNext = NULL; dvander@180: dvander@180: for (iter=m_functions.begin(); iter!=m_functions.end();) dvander@180: { dvander@180: if ((*iter) == func) dvander@180: { dvander@180: found = true; dvander@180: /* If this iterator is being used, swap in a new one !*/ dvander@180: iter = m_functions.erase(iter); dvander@180: } else { dvander@180: iter++; dvander@180: } dvander@180: } dvander@180: dvander@180: /* Cancel a call, if any */ dvander@183: if (found || m_curparam) dvander@180: { dvander@180: func->Cancel(); dvander@180: } dvander@180: dvander@180: return found; dvander@180: } dvander@180: dvander@180: unsigned int CForward::RemoveFunctionsOfPlugin(IPlugin *plugin) dvander@180: { dvander@180: FuncIter iter; dvander@180: IPluginFunction *func; dvander@180: unsigned int removed = 0; dvander@180: for (iter=m_functions.begin(); iter!=m_functions.end();) dvander@180: { dvander@180: func = (*iter); dvander@180: if (func->GetParentPlugin() == plugin) dvander@180: { dvander@180: iter = m_functions.erase(iter); dvander@180: removed++; dvander@180: } else { dvander@180: iter++; dvander@180: } dvander@180: } dvander@180: dvander@180: return removed; dvander@180: } dvander@180: dvander@180: bool CForward::AddFunction(IPluginFunction *func) dvander@180: { dvander@180: if (m_curparam) dvander@180: { dvander@180: return false; dvander@180: } dvander@180: dvander@282: //:IDEA: eventually we will tell the plugin we're using it [?] dvander@183: m_functions.push_back(func); dvander@180: dvander@180: return true; dvander@180: } dvander@180: dvander@180: const char *CForward::GetForwardName() dvander@180: { dvander@180: return m_name; dvander@180: } dvander@180: dvander@180: unsigned int CForward::GetFunctionCount() dvander@180: { dvander@180: return m_functions.size(); dvander@180: } dvander@180: dvander@180: ExecType CForward::GetExecType() dvander@180: { dvander@180: return m_ExecType; dvander@180: }