core/vm/sp_vm_basecontext.h
author David Anderson <dvander@alliedmods.net>
Thu Jan 25 22:39:12 2007 +0000 (2007-01-25)
changeset 371 71b0caa3aaa8
parent 348 b30ce8321295
child 502 4530ea065a8b
permissions -rw-r--r--
renamed relevant areas to SorucePawn
dvander@371
     1
/**
dvander@371
     2
 * ================================================================
dvander@371
     3
 * SourcePawn (C)2004-2007 AlliedModders LLC.  All rights reserved.
dvander@371
     4
 * ================================================================
dvander@371
     5
 *
dvander@371
     6
 * This file is not open source and may not be copied without explicit
dvander@371
     7
 * written permission of AlliedModders LLC.  This file may not be redistributed 
dvander@371
     8
 * in whole or significant part.
dvander@371
     9
 * For information, see LICENSE.txt or http://www.sourcemod.net/license.php
dvander@371
    10
 *
dvander@371
    11
 * Version: $Id$
dvander@371
    12
 */
dvander@371
    13
dvander@159
    14
#ifndef _INCLUDE_SOURCEPAWN_BASECONTEXT_H_
dvander@159
    15
#define _INCLUDE_SOURCEPAWN_BASECONTEXT_H_
dvander@159
    16
dvander@159
    17
#include "sp_vm_api.h"
dvander@327
    18
#include "sp_vm_function.h"
dvander@327
    19
dvander@327
    20
/**
dvander@327
    21
 * :TODO: Make functions allocate as a lump instead of individual allocations!
dvander@327
    22
 */
dvander@159
    23
dvander@159
    24
namespace SourcePawn
dvander@159
    25
{
dvander@159
    26
	class BaseContext : 
dvander@159
    27
		public IPluginContext,
dvander@159
    28
		public IPluginDebugInfo
dvander@159
    29
	{
dvander@159
    30
	public:
dvander@159
    31
		BaseContext(sp_context_t *ctx);
dvander@327
    32
		~BaseContext();
dvander@159
    33
	public: //IPluginContext
dvander@159
    34
		IVirtualMachine *GetVirtualMachine();
dvander@159
    35
		sp_context_t *GetContext();
dvander@159
    36
		bool IsDebugging();
dvander@159
    37
		int SetDebugBreak(SPVM_DEBUGBREAK newpfn, SPVM_DEBUGBREAK *oldpfn);
dvander@159
    38
		IPluginDebugInfo *GetDebugInfo();
dvander@159
    39
		virtual int HeapAlloc(unsigned int cells, cell_t *local_addr, cell_t **phys_addr);
dvander@159
    40
		virtual int HeapPop(cell_t local_addr);
dvander@159
    41
		virtual int HeapRelease(cell_t local_addr);
dvander@159
    42
		virtual int FindNativeByName(const char *name, uint32_t *index);
dvander@159
    43
		virtual int GetNativeByIndex(uint32_t index, sp_native_t **native);
dvander@159
    44
		virtual uint32_t GetNativesNum();
dvander@159
    45
		virtual int FindPublicByName(const char *name, uint32_t *index);
dvander@159
    46
		virtual int GetPublicByIndex(uint32_t index, sp_public_t **publicptr);
dvander@159
    47
		virtual uint32_t GetPublicsNum();
dvander@159
    48
		virtual int GetPubvarByIndex(uint32_t index, sp_pubvar_t **pubvar);
dvander@159
    49
		virtual int FindPubvarByName(const char *name, uint32_t *index);
dvander@159
    50
		virtual int GetPubvarAddrs(uint32_t index, cell_t *local_addr, cell_t **phys_addr);
dvander@159
    51
		virtual uint32_t GetPubVarsNum();
dvander@159
    52
		virtual int LocalToPhysAddr(cell_t local_addr, cell_t **phys_addr);
dvander@159
    53
		virtual int LocalToString(cell_t local_addr, char **addr);
dvander@159
    54
		virtual int StringToLocal(cell_t local_addr, size_t chars, const char *source);
faluco@179
    55
		virtual int StringToLocalUTF8(cell_t local_addr, size_t maxbytes, const char *source, size_t *wrtnbytes);
dvander@159
    56
		virtual int PushCell(cell_t value);
dvander@159
    57
		virtual int PushCellArray(cell_t *local_addr, cell_t **phys_addr, cell_t array[], unsigned int numcells);
faluco@179
    58
		virtual int PushString(cell_t *local_addr, char **phys_addr, const char *string);
dvander@159
    59
		virtual int PushCellsFromArray(cell_t array[], unsigned int numcells);
dvander@313
    60
		virtual int BindNatives(const sp_nativeinfo_t *natives, unsigned int num, int overwrite);
dvander@313
    61
		virtual int BindNative(const sp_nativeinfo_t *native);
dvander@159
    62
		virtual int BindNativeToAny(SPVM_NATIVE_FUNC native);
dvander@348
    63
		virtual int Execute(uint32_t code_addr, cell_t *result);
dvander@240
    64
		virtual void ThrowNativeErrorEx(int error, const char *msg, ...);
dvander@240
    65
		virtual cell_t ThrowNativeError(const char *msg, ...);
dvander@327
    66
		virtual IPluginFunction *GetFunctionByName(const char *public_name);
dvander@327
    67
		virtual IPluginFunction *GetFunctionById(funcid_t func_id);
dvander@262
    68
#if defined SOURCEMOD_BUILD
dvander@262
    69
		virtual SourceMod::IdentityToken_t *GetIdentity();
dvander@262
    70
		void SetIdentity(SourceMod::IdentityToken_t *token);
dvander@327
    71
		bool IsRunnable();
dvander@327
    72
		void SetRunnable(bool runnable);
dvander@262
    73
#endif
dvander@159
    74
	public: //IPluginDebugInfo
dvander@159
    75
		virtual int LookupFile(ucell_t addr, const char **filename);
dvander@159
    76
		virtual int LookupFunction(ucell_t addr, const char **name);
dvander@159
    77
		virtual int LookupLine(ucell_t addr, uint32_t *line);
faluco@290
    78
	public:
faluco@290
    79
		void SetContext(sp_context_t *_ctx);
dvander@159
    80
	private:
dvander@240
    81
		void SetErrorMessage(const char *msg, va_list ap);
dvander@327
    82
		void FlushFunctionCache();
dvander@240
    83
	private:
dvander@159
    84
		sp_context_t *ctx;
dvander@262
    85
#if defined SOURCEMOD_BUILD
dvander@262
    86
		SourceMod::IdentityToken_t *m_pToken;
dvander@262
    87
#endif
dvander@240
    88
		char m_MsgCache[1024];
dvander@240
    89
		bool m_CustomMsg;
dvander@240
    90
		bool m_InExec;
dvander@327
    91
		bool m_Runnable;
dvander@327
    92
		unsigned int m_funcsnum;
dvander@327
    93
		CFunction **m_priv_funcs;
dvander@327
    94
		CFunction **m_pub_funcs;
dvander@159
    95
	};
dvander@159
    96
};
dvander@159
    97
dvander@159
    98
#endif //_INCLUDE_SOURCEPAWN_BASECONTEXT_H_