core/systems/ExtensionSys.h
author David Anderson <dvander@alliedmods.net>
Wed Aug 01 02:12:47 2007 +0000 (2007-08-01)
changeset 1231 17badaf66ce4
parent 1150 2d97459b4972
child 1330 ab94316bb52b
permissions -rw-r--r--
updated more header files (mostly internal now)
dvander@370
     1
/**
ds@653
     2
 * vim: set ts=4 :
dvander@1231
     3
 * ================================================================
dvander@1231
     4
 * SourceMod
dvander@1231
     5
 * Copyright (C) 2004-2007 AlliedModders LLC.  All rights reserved.
dvander@1231
     6
 * ================================================================
dvander@370
     7
 *
dvander@1231
     8
 * This program is free software; you can redistribute it and/or 
dvander@1231
     9
 * modify it under the terms of the GNU General Public License, 
dvander@1231
    10
 * version 3.0, as published by the Free Software Foundation.
dvander@1231
    11
 * 
dvander@1231
    12
 * This program is distributed in the hope that it will be useful,
dvander@1231
    13
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
dvander@1231
    14
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
dvander@1231
    15
 * GNU General Public License for more details.
dvander@1231
    16
 *
dvander@1231
    17
 * You should have received a copy of the GNU General Public License
dvander@1231
    18
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@1231
    19
 *
dvander@1231
    20
 * As a special exception, AlliedModders LLC gives you permission to 
dvander@1231
    21
 * link the code of this program (as well as its derivative works) to 
dvander@1231
    22
 * "Half-Life 2," the "Source Engine," the "SourcePawn JIT," and any 
dvander@1231
    23
 * Game MODs that run on software by the Valve Corporation.  You must 
dvander@1231
    24
 * obey the GNU General Public License in all respects for all other 
dvander@1231
    25
 * code used. Additionally, AlliedModders LLC grants this exception 
dvander@1231
    26
 * to all derivative works. AlliedModders LLC defines further 
dvander@1231
    27
 * exceptions, found in LICENSE.txt (as of this writing, version 
dvander@1231
    28
 * JULY-31-2007), or <http://www.sourcemod.net/license.php>.
dvander@370
    29
 *
dvander@370
    30
 * Version: $Id$
dvander@370
    31
 */
dvander@370
    32
dvander@298
    33
#ifndef _INCLUDE_SOURCEMOD_EXTENSION_SYSTEM_H_
dvander@298
    34
#define _INCLUDE_SOURCEMOD_EXTENSION_SYSTEM_H_
dvander@298
    35
dvander@298
    36
#include <IExtensionSys.h>
dvander@298
    37
#include <ILibrarySys.h>
dvander@298
    38
#include <sh_list.h>
dvander@298
    39
#include <sh_string.h>
dvander@298
    40
#include "sm_globals.h"
dvander@304
    41
#include "ShareSys.h"
dvander@304
    42
#include <ISmmAPI.h>
dvander@305
    43
#include <IPluginSys.h>
dvander@310
    44
#include <IRootConsoleMenu.h>
faluco@1112
    45
#include "PluginSys.h"
dvander@298
    46
dvander@298
    47
using namespace SourceMod;
dvander@298
    48
using namespace SourceHook;
dvander@298
    49
dvander@298
    50
class CExtension : public IExtension
dvander@298
    51
{
dvander@304
    52
	friend class CExtensionManager;
dvander@298
    53
public:
dvander@298
    54
	CExtension(const char *filename, char *error, size_t maxlen);
dvander@298
    55
	~CExtension();
dvander@298
    56
public: //IExtension
dvander@298
    57
	IExtensionInterface *GetAPI();
dvander@298
    58
	const char *GetFilename();
dvander@298
    59
	IdentityToken_t *GetIdentity();
dvander@298
    60
	bool IsLoaded();
dvander@304
    61
	ITERATOR *FindFirstDependency(IExtension **pOwner, SMInterface **pInterface);
dvander@304
    62
	bool FindNextDependency(ITERATOR *iter, IExtension **pOwner, SMInterface **pInterface);
dvander@304
    63
	void FreeDependencyIterator(ITERATOR *iter);
dvander@315
    64
	bool IsRunning(char *error, size_t maxlength);
dvander@298
    65
public:
dvander@298
    66
	void SetError(const char *error);
dvander@304
    67
	void AddDependency(IfaceInfo *pInfo);
dvander@1150
    68
	void AddChildDependent(CExtension *pOther, SMInterface *iface);
dvander@304
    69
	void AddInterface(SMInterface *pInterface);
dvander@305
    70
	void AddPlugin(IPlugin *pPlugin);
dvander@305
    71
	void RemovePlugin(IPlugin *pPlugin);
dvander@315
    72
	void MarkAllLoaded();
dvander@298
    73
private:
dvander@941
    74
	bool Load(char *error, size_t maxlength);
dvander@941
    75
private:
dvander@298
    76
	IdentityToken_t *m_pIdentToken;
dvander@298
    77
	IExtensionInterface *m_pAPI;
dvander@298
    78
	String m_File;
dvander@941
    79
	String m_Path;
dvander@298
    80
	ILibrary *m_pLib;
dvander@298
    81
	String m_Error;
dvander@1150
    82
	List<IfaceInfo> m_Deps;			/** Dependencies */
dvander@1150
    83
	List<IfaceInfo> m_ChildDeps;	/** Children who might depend on us */
dvander@304
    84
	List<SMInterface *> m_Interfaces;
dvander@305
    85
	List<IPlugin *> m_Plugins;
dvander@315
    86
	List<const sp_nativeinfo_t *> m_Natives;
dvander@1121
    87
	List<WeakNative> m_WeakNatives;
dvander@304
    88
	PluginId m_PlId;
dvander@311
    89
	unsigned int unload_code;
dvander@315
    90
	bool m_FullyLoaded;
dvander@298
    91
};
dvander@298
    92
dvander@298
    93
class CExtensionManager : 
dvander@298
    94
	public IExtensionManager,
dvander@305
    95
	public SMGlobalClass,
dvander@310
    96
	public IPluginsListener,
dvander@310
    97
	public IRootConsoleCommand
dvander@298
    98
{
dvander@298
    99
public: //SMGlobalClass
dvander@298
   100
	void OnSourceModAllInitialized();
dvander@298
   101
	void OnSourceModShutdown();
dvander@298
   102
public: //IExtensionManager
dvander@298
   103
	IExtension *LoadExtension(const char *path, 
dvander@298
   104
		ExtensionLifetime lifetime, 
dvander@298
   105
		char *error,
ds@755
   106
		size_t maxlength);
dvander@298
   107
	bool UnloadExtension(IExtension *pExt);
dvander@298
   108
	IExtension *FindExtensionByFile(const char *file);
dvander@298
   109
	IExtension *FindExtensionByName(const char *ext);
dvander@305
   110
public: //IPluginsListener
dvander@305
   111
	void OnPluginDestroyed(IPlugin *plugin);
dvander@310
   112
public: //IRootConsoleCommand
dvander@310
   113
	void OnRootConsoleCommand(const char *cmd, unsigned int argcount);
dvander@298
   114
public:
dvander@298
   115
	IExtension *LoadAutoExtension(const char *path);
dvander@304
   116
	void BindDependency(IExtension *pOwner, IfaceInfo *pInfo);
dvander@304
   117
	void AddInterface(IExtension *pOwner, SMInterface *pInterface);
dvander@305
   118
	void BindChildPlugin(IExtension *pParent, IPlugin *pPlugin);
dvander@315
   119
	void AddNatives(IExtension *pOwner, const sp_nativeinfo_t *natives);
dvander@315
   120
	void BindAllNativesToPlugin(IPlugin *pPlugin);
dvander@315
   121
	void MarkAllLoaded();
dvander@324
   122
	void AddDependency(IExtension *pSource, const char *file, bool required, bool autoload);
dvander@397
   123
	void TryAutoload();
dvander@868
   124
public:
dvander@868
   125
	CExtension *GetExtensionFromIdent(IdentityToken_t *ptr);
dvander@1018
   126
	void Shutdown();
dvander@298
   127
private:
dvander@311
   128
	CExtension *FindByOrder(unsigned int num);
dvander@311
   129
private:
dvander@298
   130
	List<CExtension *> m_Libs;
dvander@298
   131
};
dvander@298
   132
dvander@298
   133
extern CExtensionManager g_Extensions;
dvander@298
   134
dvander@298
   135
#endif //_INCLUDE_SOURCEMOD_EXTENSION_SYSTEM_H_