dvander@370: /**
dvander@370:  * ===============================================================
dvander@370:  * SourceMod (C)2004-2007 AlliedModders LLC.  All rights reserved.
dvander@370:  * ===============================================================
dvander@370:  *
dvander@370:  * This file is not open source and may not be copied without explicit
dvander@370:  * written permission of AlliedModders LLC.  This file may not be redistributed 
dvander@370:  * in whole or significant part.
dvander@370:  * For information, see LICENSE.txt or http://www.sourcemod.net/license.php
dvander@370:  *
dvander@370:  * Version: $Id$
dvander@370:  */
dvander@370: 
dvander@180: #ifndef _INCLUDE_SOURCEMOD_FORWARDSYSTEM_H_
dvander@180: #define _INCLUDE_SOURCEMOD_FORWARDSYSTEM_H_
dvander@180: 
dvander@180: #include <IForwardSys.h>
dvander@180: #include <IPluginSys.h>
dvander@180: #include "sm_globals.h"
dvander@180: #include <sh_list.h>
dvander@180: #include <sh_stack.h>
dvander@211: #include "sourcemod.h"
dvander@180: 
dvander@180: using namespace SourceHook;
dvander@180: 
dvander@180: typedef List<IPluginFunction *>::iterator FuncIter;
dvander@180: 
dvander@180: //:TODO: a global name max define for sourcepawn, should mirror compiler's sNAMEMAX
dvander@180: #define FORWARDS_NAME_MAX		64
dvander@180: 
dvander@183: struct ByrefInfo
dvander@180: {
dvander@183: 	unsigned int cells;
dvander@183: 	cell_t *orig_addr;
dvander@183: 	int flags;
faluco@192: 	int sz_flags;
dvander@180: };
dvander@180: 
dvander@183: struct FwdParamInfo
dvander@183: {
dvander@183: 	cell_t val;
dvander@183: 	ByrefInfo byref;
dvander@183: 	ParamType pushedas;
dvander@183: };
dvander@183: 
dvander@183: class CForward : public IChangeableForward
dvander@180: {
dvander@180: public: //ICallable
dvander@180: 	virtual int PushCell(cell_t cell);
dvander@180: 	virtual int PushCellByRef(cell_t *cell, int flags);
dvander@180: 	virtual int PushFloat(float number);
dvander@180: 	virtual int PushFloatByRef(float *number, int flags);
dvander@180: 	virtual int PushArray(cell_t *inarray, unsigned int cells, cell_t **phys_addr, int flags);
dvander@180: 	virtual int PushString(const char *string);
faluco@192: 	virtual int PushStringEx(char *buffer, size_t length, int sz_flags, int cp_flags);
dvander@180: 	virtual void Cancel();
dvander@180: public: //IForward
faluco@430: 	virtual const char *GetForwardName() const;
faluco@430: 	virtual unsigned int GetFunctionCount() const;
faluco@430: 	virtual ExecType GetExecType() const;
dvander@180: 	virtual int Execute(cell_t *result, IForwardFilter *filter);
dvander@180: public: //IChangeableForward
dvander@180: 	virtual bool RemoveFunction(IPluginFunction *func);
dvander@180: 	virtual unsigned int RemoveFunctionsOfPlugin(IPlugin *plugin);
dvander@180: 	virtual bool AddFunction(IPluginFunction *func);
dvander@327: 	virtual bool AddFunction(IPluginContext *ctx, funcid_t index);
dvander@180: public:
dvander@180: 	static CForward *CreateForward(const char *name, 
dvander@180: 								   ExecType et, 
dvander@180: 								   unsigned int num_params, 
dvander@180: 								   ParamType *types, 
dvander@180: 								   va_list ap);
dvander@180: private:
dvander@180: 	void _Int_PushArray(cell_t *inarray, unsigned int cells, int flags);
faluco@192: 	void _Int_PushString(cell_t *inarray, unsigned int cells, int sz_flags, int cp_flags);
dvander@180: 	inline int SetError(int err)
dvander@180: 	{
dvander@180: 		m_errstate = err;
dvander@180: 		return err;
dvander@180: 	}
dvander@180: protected:
dvander@180: 	/* :TODO: I want a caching list type here.
dvander@180: 	 * Destroying these things and using new/delete for their members feels bad.
dvander@180: 	 */
dvander@464: 	mutable List<IPluginFunction *> m_functions;
dvander@180: 
dvander@180: 	/* Type and name information */
dvander@183: 	FwdParamInfo m_params[SP_MAX_EXEC_PARAMS];
dvander@180: 	ParamType m_types[SP_MAX_EXEC_PARAMS];
dvander@180: 	char m_name[FORWARDS_NAME_MAX+1];
dvander@180: 	unsigned int m_numparams;
dvander@183: 	unsigned int m_varargs;
dvander@180: 	ExecType m_ExecType;
dvander@180: 
dvander@180: 	/* State information */
dvander@180: 	unsigned int m_curparam;
dvander@180: 	int m_errstate;
dvander@180: };
dvander@180: 
dvander@211: class CForwardManager : 
dvander@211: 	public IForwardManager,
dvander@211: 	public IPluginsListener,
dvander@211: 	public SMGlobalClass
dvander@186: {
dvander@186: 	friend class CForward;
dvander@211: public: //IForwardManager
faluco@430: 	IForward *CreateForward(const char *name, 
dvander@186: 		ExecType et, 
dvander@186: 		unsigned int num_params, 
dvander@186: 		ParamType *types, 
dvander@186: 		...);
faluco@430: 	IChangeableForward *CreateForwardEx(const char *name, 
dvander@186: 		ExecType et, 
dvander@186: 		int num_params, 
dvander@186: 		ParamType *types, 
dvander@186: 		...);
faluco@430: 	IForward *FindForward(const char *name, IChangeableForward **ifchng);
faluco@430: 	void ReleaseForward(IForward *forward);
dvander@211: public: //IPluginsListener
faluco@430: 	void OnPluginLoaded(IPlugin *plugin);
faluco@430: 	void OnPluginUnloaded(IPlugin *plugin);
faluco@430: 	void OnPluginPauseChange(IPlugin *plugin, bool paused);
dvander@211: public: //SMGlobalClass
faluco@430: 	void OnSourceModAllInitialized();
faluco@430: 	void OnSourceModShutdown();
dvander@186: protected:
dvander@186: 	CForward *ForwardMake();
dvander@186: 	void ForwardFree(CForward *fwd);
dvander@186: private:
dvander@186: 	CStack<CForward *> m_FreeForwards;
dvander@186: 	List<CForward *> m_managed;
dvander@186: 	List<CForward *> m_unmanaged;
dvander@186: };
dvander@186: 
dvander@186: extern CForwardManager g_Forwards;
dvander@186: 
dvander@180: #endif //_INCLUDE_SOURCEMOD_FORWARDSYSTEM_H_