sourcemm/CPlugin.cpp
changeset 7 8ef11f6189e4
child 9 01b8b7435e67
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/sourcemm/CPlugin.cpp	Sat Apr 16 19:59:26 2005 +0000
     1.3 @@ -0,0 +1,324 @@
     1.4 +/* ======== SourceMM ========
     1.5 +* Copyright (C) 2004-2005 SourceMM Development Team
     1.6 +* No warranties of any kind
     1.7 +*
     1.8 +* License: zlib/libpng
     1.9 +*
    1.10 +* Author(s): David "BAILOPAN" Anderson
    1.11 +* ============================
    1.12 +*/
    1.13 +
    1.14 +#include "CPlugin.h"
    1.15 +#include "CISmmAPI.h"
    1.16 +
    1.17 +/** 
    1.18 + * @brief Implements functions from CPlugin.h
    1.19 + * @file CPlugin.cpp
    1.20 + */
    1.21 +
    1.22 +using namespace SourceMM;
    1.23 +
    1.24 +CPluginManager g_PluginMngr;
    1.25 +
    1.26 +CPluginManager::CPluginManager()
    1.27 +{
    1.28 +	m_LastId = Pl_MinId;
    1.29 +}
    1.30 +
    1.31 +CPluginManager::~CPluginManager()
    1.32 +{
    1.33 +	if (m_Plugins.size())
    1.34 +	{
    1.35 +		UnloadAll();
    1.36 +		m_Plugins.clear();
    1.37 +	}
    1.38 +}
    1.39 +
    1.40 +CPluginManager::CPlugin::CPlugin() : m_Lib(NULL), m_API(NULL), m_Id(0), m_Source(0)
    1.41 +{
    1.42 +}
    1.43 +
    1.44 +PluginId CPluginManager::Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen)
    1.45 +{
    1.46 +	PluginIter i;
    1.47 +
    1.48 +	already = false;
    1.49 +	//Check if we're about to reload an old plugin
    1.50 +	for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
    1.51 +	{
    1.52 +		if ( (*i) && (*i)->m_File.compare(file)==0 )
    1.53 +		{
    1.54 +			if ( (*i)->m_Status < Pl_Paused )
    1.55 +			{
    1.56 +				//Attempt to load the plugin again
    1.57 +				already = true;
    1.58 +				i = m_Plugins.erase(i);
    1.59 +			} else {
    1.60 +				//No need to load it
    1.61 +				already = true;
    1.62 +				return (*i)->m_Id;
    1.63 +			}
    1.64 +		}
    1.65 +	}
    1.66 +
    1.67 +	CPlugin *pl = _Load(file, source, error, maxlen);
    1.68 +
    1.69 +	if (!pl)
    1.70 +		return Pl_BadLoad;
    1.71 +
    1.72 +	return pl->m_Id;
    1.73 +}
    1.74 +
    1.75 +CPluginManager::CPlugin *CPluginManager::FindById(PluginId id)
    1.76 +{
    1.77 +	PluginIter i;
    1.78 +
    1.79 +	for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
    1.80 +	{
    1.81 +		if ( (*i)->m_Id == id )
    1.82 +			return (*i);
    1.83 +	}
    1.84 +
    1.85 +	return NULL;
    1.86 +}
    1.87 +
    1.88 +bool CPluginManager::Pause(PluginId id, char *error, size_t maxlen)
    1.89 +{
    1.90 +	CPlugin *pl = FindById(id);
    1.91 +	
    1.92 +	if (!pl)
    1.93 +	{
    1.94 +		snprintf(error, maxlen, "Plugin id not found");
    1.95 +		return false;
    1.96 +	}
    1.97 +
    1.98 +	return _Pause(pl, error, maxlen);
    1.99 +}
   1.100 +
   1.101 +bool CPluginManager::Unpause(PluginId id, char *error, size_t maxlen)
   1.102 +{
   1.103 +	CPlugin *pl = FindById(id);
   1.104 +	
   1.105 +	if (!pl)
   1.106 +	{
   1.107 +		snprintf(error, maxlen, "Plugin id not found");
   1.108 +		return false;
   1.109 +	}
   1.110 +
   1.111 +	return _Unpause(pl, error, maxlen);
   1.112 +}
   1.113 +
   1.114 +bool CPluginManager::Unload(PluginId id, char *error, size_t maxlen)
   1.115 +{
   1.116 +	CPlugin *pl = FindById(id);
   1.117 +	
   1.118 +	if (!pl)
   1.119 +	{
   1.120 +		snprintf(error, maxlen, "Plugin id not found");
   1.121 +		return false;
   1.122 +	}
   1.123 +
   1.124 +	return _Unload(pl, error, maxlen);
   1.125 +}
   1.126 +
   1.127 +CPluginManager::CPlugin *CPluginManager::_Load(const char *file, PluginId source, char *error, size_t maxlen)
   1.128 +{
   1.129 +	FILE *fp;
   1.130 +	CPlugin *pl;
   1.131 +
   1.132 +	pl = new CPlugin();
   1.133 +	*error = '\0';
   1.134 +	
   1.135 +	//Add plugin to list
   1.136 +	pl->m_Id = m_LastId;
   1.137 +	pl->m_File.assign(file);
   1.138 +	m_Plugins.push_back(pl);
   1.139 +	m_LastId++;
   1.140 +
   1.141 +	//Check if the file even exists
   1.142 +	fp = fopen(file, "r");
   1.143 +	if (!fp)
   1.144 +	{
   1.145 +		if (error)
   1.146 +			snprintf(error, maxlen, "File not found: %s", file);
   1.147 +		pl->m_Status = Pl_NotFound;
   1.148 +	} else {
   1.149 +		fclose(fp);
   1.150 +		fp = NULL;
   1.151 +		
   1.152 +		//Load the file
   1.153 +		pl->m_Lib = dlmount(file);
   1.154 +		if (!pl->m_Lib)
   1.155 +		{
   1.156 +			if (error)
   1.157 +				snprintf(error, maxlen, "%s", dlerror());
   1.158 +			pl->m_Status = Pl_Error;
   1.159 +		} else {
   1.160 +			CreateInterfaceFn pfn = reinterpret_cast<CreateInterfaceFn>(dlsym(pl->m_Lib, PL_EXPOSURE_C));
   1.161 +			if (!pfn)
   1.162 +			{
   1.163 +				if (error)
   1.164 +					snprintf(error, maxlen, "Function %s not found", PL_EXPOSURE_C);
   1.165 +				pl->m_Status = Pl_Error;
   1.166 +			} else {
   1.167 +				pl->m_API = static_cast<ISmmPlugin *>((pfn)(PLAPI_NAME, NULL));
   1.168 +				if (!pl->m_API)
   1.169 +				{
   1.170 +					if (error)
   1.171 +						snprintf(error, maxlen, "Failed to get API");
   1.172 +					pl->m_Status = Pl_Error;
   1.173 +				} else {
   1.174 +					if (pl->m_API->GetApiVersion() < PLAPI_MIN_VERSION)
   1.175 +					{
   1.176 +						if (error)
   1.177 +							snprintf(error, maxlen, "Plugin API %d is out of date with required minimum (%d)", pl->m_API->GetApiVersion(), PLAPI_MIN_VERSION);
   1.178 +						pl->m_Status = Pl_Error;
   1.179 +					} else {
   1.180 +						if (pl->m_API->Load(pl->m_Id, static_cast<ISmmAPI *>(&g_SmmAPI), &(pl->fac_list), error, maxlen))
   1.181 +						{
   1.182 +							pl->m_Status = Pl_Running;
   1.183 +						} else {
   1.184 +							pl->m_Status = Pl_Refused;
   1.185 +						}
   1.186 +					}
   1.187 +				}
   1.188 +			}
   1.189 +		}
   1.190 +	}
   1.191 +
   1.192 +	if (pl->m_Lib && (pl->m_Status < Pl_Paused))
   1.193 +	{
   1.194 +		dlclose(pl->m_Lib);
   1.195 +		pl->m_Lib = NULL;
   1.196 +		pl->m_API = NULL;
   1.197 +	}
   1.198 +
   1.199 +	return pl;
   1.200 +}
   1.201 +
   1.202 +bool CPluginManager::_Unload(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
   1.203 +{
   1.204 +	if (error)
   1.205 +		*error = '\0';
   1.206 +	if (pl->m_API && pl->m_Lib)
   1.207 +	{
   1.208 +		if (pl->m_API->Unload(error, maxlen))
   1.209 +		{
   1.210 +			dlclose(pl->m_Lib);
   1.211 +			pl->m_Lib = NULL;
   1.212 +			pl->m_API = NULL;
   1.213 +
   1.214 +			//Remove the plugin from the list
   1.215 +			PluginIter i;
   1.216 +			for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
   1.217 +			{
   1.218 +				if ( (*i)->m_Id == pl->m_Id )
   1.219 +				{
   1.220 +					i = m_Plugins.erase(i);
   1.221 +					break;
   1.222 +				}
   1.223 +			}
   1.224 +			delete pl;
   1.225 +
   1.226 +			return true;
   1.227 +		}
   1.228 +	} else {
   1.229 +		//The plugin is not valid, and let's just remove it from the list anyway
   1.230 +		PluginIter i;
   1.231 +		for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
   1.232 +		{
   1.233 +			if ( (*i)->m_Id == pl->m_Id )
   1.234 +			{
   1.235 +				i = m_Plugins.erase(i);
   1.236 +				break;
   1.237 +			}
   1.238 +		}
   1.239 +		delete pl;
   1.240 +
   1.241 +		return true;
   1.242 +	}
   1.243 +
   1.244 +	return false;
   1.245 +}
   1.246 +
   1.247 +bool CPluginManager::_Pause(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
   1.248 +{
   1.249 +	if (error)
   1.250 +		*error = '\0';
   1.251 +	if (pl->m_Status != Pl_Running || !pl->m_API)
   1.252 +	{
   1.253 +		if (error)
   1.254 +			snprintf(error, maxlen, "Plugin cannot be paused");
   1.255 +	} else {
   1.256 +		return pl->m_API->Pause(error, maxlen);
   1.257 +	}
   1.258 +
   1.259 +	return false;
   1.260 +}
   1.261 +
   1.262 +bool CPluginManager::_Unpause(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
   1.263 +{
   1.264 +	if (error)
   1.265 +		*error = '\0';
   1.266 +
   1.267 +	if (pl->m_Status != Pl_Paused || !pl->m_API)
   1.268 +	{
   1.269 +		if (error)
   1.270 +			snprintf(error, maxlen, "Plugin cannot be unpaused");
   1.271 +	} else {
   1.272 +		return pl->m_API->Unpause(error, maxlen);
   1.273 +	}
   1.274 +
   1.275 +	return false;
   1.276 +}
   1.277 +
   1.278 +
   1.279 +bool CPluginManager::UnloadAll()
   1.280 +{
   1.281 +	PluginIter i;
   1.282 +	bool status = true;
   1.283 +
   1.284 +	for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
   1.285 +	{
   1.286 +		if ( (*i) )
   1.287 +		{
   1.288 +			if ( (*i)->m_API )
   1.289 +			{
   1.290 +				if ( (*i)->m_API->Unload(NULL, 0) )
   1.291 +					status = false;
   1.292 +
   1.293 +				dlclose( (*i)->m_Lib );
   1.294 +			}
   1.295 +			delete (*i);
   1.296 +		}
   1.297 +
   1.298 +		i = m_Plugins.erase(i);
   1.299 +	}
   1.300 +
   1.301 +	return status;
   1.302 +}
   1.303 +
   1.304 +bool CPluginManager::Query(PluginId id, const char *&file, factories *&list, Pl_Status &status, PluginId &source)
   1.305 +{
   1.306 +	CPlugin *pl = FindById(id);
   1.307 +
   1.308 +	if (!pl)
   1.309 +		return false;
   1.310 +
   1.311 +	file = pl->m_File.c_str();
   1.312 +	list = &(pl->fac_list);
   1.313 +	status = pl->m_Status;
   1.314 +	source = pl->m_Source;
   1.315 +
   1.316 +	return true;
   1.317 +}
   1.318 +
   1.319 +PluginIter CPluginManager::_begin()
   1.320 +{
   1.321 +	return m_Plugins.begin();
   1.322 +}
   1.323 +
   1.324 +PluginIter CPluginManager::_end()
   1.325 +{
   1.326 +	return m_Plugins.end();
   1.327 +}