[Scummvm-cvs-logs] SF.net SVN: scummvm: [24149] scummvm/trunk/backends/plugins

fingolfin at users.sourceforge.net fingolfin at users.sourceforge.net
Sat Oct 7 02:31:46 CEST 2006


Revision: 24149
          http://svn.sourceforge.net/scummvm/?rev=24149&view=rev
Author:   fingolfin
Date:     2006-10-06 17:31:33 -0700 (Fri, 06 Oct 2006)

Log Message:
-----------
Added plugin providers for Win32 and DC

Modified Paths:
--------------
    scummvm/trunk/backends/plugins/posix/posix-provider.cpp
    scummvm/trunk/backends/plugins/posix/posix-provider.h

Added Paths:
-----------
    scummvm/trunk/backends/plugins/dc/
    scummvm/trunk/backends/plugins/dc/dc-provider.cpp
    scummvm/trunk/backends/plugins/dc/dc-provider.h
    scummvm/trunk/backends/plugins/win32/
    scummvm/trunk/backends/plugins/win32/win32-provider.cpp
    scummvm/trunk/backends/plugins/win32/win32-provider.h


Property changes on: scummvm/trunk/backends/plugins/dc
___________________________________________________________________
Name: svn:ignore
   + .deps
*.o
lib*.a


Added: scummvm/trunk/backends/plugins/dc/dc-provider.cpp
===================================================================
--- scummvm/trunk/backends/plugins/dc/dc-provider.cpp	                        (rev 0)
+++ scummvm/trunk/backends/plugins/dc/dc-provider.cpp	2006-10-07 00:31:33 UTC (rev 24149)
@@ -0,0 +1,130 @@
+/* ScummVM - Scumm Interpreter
+ * Copyright (C) 2001  Ludvig Strigeus
+ * Copyright (C) 2001-2006 The ScummVM project
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * $URL$
+ * $Id$
+ *
+ */
+
+#if defined(DYNAMIC_MODULES) && defined(__DC__)
+
+#include "backends/plugins/dc/dc-provider.h"
+#include "backends/plugins/dynamic-plugin.h"
+#include "common/fs.h"
+
+#include "dcloader.h"
+#define PLUGIN_DIRECTORY	"/"
+#define PLUGIN_PREFIX		""
+#define PLUGIN_SUFFIX		".PLG"
+
+
+class DCPlugin : public DynamicPlugin {
+protected:
+	void *_dlHandle;
+	Common::String _filename;
+
+	virtual VoidFunc findSymbol(const char *symbol) {
+		void *func = dlsym(_dlHandle, symbol);
+		if (!func)
+			warning("Failed loading symbol '%s' from plugin '%s' (%s)", symbol, _filename.c_str(), dlerror());
+	
+		// FIXME HACK: This is a HACK to circumvent a clash between the ISO C++
+		// standard and POSIX: ISO C++ disallows casting between function pointers
+		// and data pointers, but dlsym always returns a void pointer. For details,
+		// see e.g. <http://www.trilithium.com/johan/2004/12/problem-with-dlsym/>.
+		assert(sizeof(VoidFunc) == sizeof(func));
+		VoidFunc tmp;
+		memcpy(&tmp, &func, sizeof(VoidFunc));
+		return tmp;
+	}
+
+public:
+	DCPlugin(const Common::String &filename)
+		: _dlHandle(0), _filename(filename) {}
+
+	bool loadPlugin() {
+		assert(!_dlHandle);
+		_dlHandle = dlopen(_filename.c_str(), RTLD_LAZY);
+	
+		if (!_dlHandle) {
+			warning("Failed loading plugin '%s' (%s)", _filename.c_str(), dlerror());
+			return false;
+		}
+	
+		bool ret = DynamicPlugin::loadPlugin();
+		
+		if (ret)
+			dlforgetsyms(_dlHandle);
+
+		return ret;
+	}
+	void unloadPlugin() {
+		if (_dlHandle) {
+			if (dlclose(_dlHandle) != 0)
+				warning("Failed unloading plugin '%s' (%s)", _filename.c_str(), dlerror());
+		}
+	}
+};
+
+
+DCPluginProvider::DCPluginProvider() {
+}
+
+DCPluginProvider::~DCPluginProvider() {
+}
+
+PluginList DCPluginProvider::getPlugins() {
+	PluginList pl;
+	
+	
+	// Load dynamic plugins
+	// TODO... this is right now just a nasty hack.
+	// This should search one or multiple directories for all plugins it can
+	// find (to this end, we maybe should use a special prefix/suffix; e.g.
+	// instead of libscumm.so, use scumm.engine or scumm.plugin etc.).
+	//
+	// The list of directories to search could be e.g.:
+	// User specified (via config file), ".", "./plugins", "$(prefix)/lib".
+	//
+	// We also need to add code which ensures what we are looking at is
+	// a) a ScummVM engine and b) matches the version of the executable.
+	// Hence one more symbol should be exported by plugins which returns
+	// the "ABI" version the plugin was built for, and we can compare that
+	// to the ABI version of the executable.
+
+	// Load all plugins.
+	// Scan for all plugins in this directory
+	FilesystemNode dir(PLUGIN_DIRECTORY);
+	FSList files;
+	if (!dir.listDir(files, FilesystemNode::kListFilesOnly)) {
+		error("Couldn't open plugin directory '%s'", PLUGIN_DIRECTORY);
+	}
+
+	for (FSList::const_iterator i = files.begin(); i != files.end(); ++i) {
+		Common::String name(i->name());
+		if (name.hasPrefix(PLUGIN_PREFIX) && name.hasSuffix(PLUGIN_SUFFIX)) {
+			pl.push_back(new DCPlugin(i->path()));
+		}
+	}
+	
+	
+	return pl;
+}
+
+
+#endif // defined(DYNAMIC_MODULES) && defined(__DC__)


Property changes on: scummvm/trunk/backends/plugins/dc/dc-provider.cpp
___________________________________________________________________
Name: svn:mime-type
   + text/plain
Name: svn:keywords
   + Date Rev Author URL Id
Name: svn:eol-style
   + native

Added: scummvm/trunk/backends/plugins/dc/dc-provider.h
===================================================================
--- scummvm/trunk/backends/plugins/dc/dc-provider.h	                        (rev 0)
+++ scummvm/trunk/backends/plugins/dc/dc-provider.h	2006-10-07 00:31:33 UTC (rev 24149)
@@ -0,0 +1,42 @@
+/* ScummVM - Scumm Interpreter
+ * Copyright (C) 2001  Ludvig Strigeus
+ * Copyright (C) 2001-2006 The ScummVM project
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * $URL$
+ * $Id$
+ *
+ */
+
+#ifndef BACKENDS_PLUGINS_DC_H
+#define BACKENDS_PLUGINS_DC_H
+
+#include "common/stdafx.h"
+#include "base/plugins.h"
+
+#if defined(DYNAMIC_MODULES) && defined(__DC__)
+
+class DCPluginProvider : public PluginProvider {
+public:
+	DCPluginProvider();
+	~DCPluginProvider();
+
+	virtual PluginList getPlugins();
+};
+
+#endif // defined(DYNAMIC_MODULES) && defined(__DC__)
+
+#endif


Property changes on: scummvm/trunk/backends/plugins/dc/dc-provider.h
___________________________________________________________________
Name: svn:mime-type
   + text/plain
Name: svn:keywords
   + Date Rev Author URL Id
Name: svn:eol-style
   + native

Modified: scummvm/trunk/backends/plugins/posix/posix-provider.cpp
===================================================================
--- scummvm/trunk/backends/plugins/posix/posix-provider.cpp	2006-10-07 00:22:48 UTC (rev 24148)
+++ scummvm/trunk/backends/plugins/posix/posix-provider.cpp	2006-10-07 00:31:33 UTC (rev 24149)
@@ -21,53 +21,25 @@
  *
  */
 
-#ifdef DYNAMIC_MODULES
+#if defined(DYNAMIC_MODULES) && defined(UNIX)
 
 #include "backends/plugins/posix/posix-provider.h"
 #include "backends/plugins/dynamic-plugin.h"
 #include "common/fs.h"
-#include "common/util.h"
 
-#if defined(UNIX)
-
 #include <dlfcn.h>
 #define PLUGIN_DIRECTORY	"plugins/"
 
-#elif defined(__DC__)
-#include "dcloader.h"
-#define PLUGIN_DIRECTORY	"/"
-#define PLUGIN_PREFIX		""
-#define PLUGIN_SUFFIX		".PLG"
 
-#elif defined(_WIN32)
-#define PLUGIN_DIRECTORY	""
-#define PLUGIN_PREFIX		""
-#define PLUGIN_SUFFIX		".dll"
-#else
-#error No support for loading plugins on non-unix systems at this point!
-#endif
-
-
-
 class POSIXPlugin : public DynamicPlugin {
 protected:
 	void *_dlHandle;
 	Common::String _filename;
 
 	virtual VoidFunc findSymbol(const char *symbol) {
-	#if defined(UNIX) || defined(__DC__)
 		void *func = dlsym(_dlHandle, symbol);
 		if (!func)
 			warning("Failed loading symbol '%s' from plugin '%s' (%s)", symbol, _filename.c_str(), dlerror());
-	#else
-	#if defined(_WIN32)
-		void *func = (void *)GetProcAddress((HMODULE)_dlHandle, symbol);
-		if (!func)
-			warning("Failed loading symbol '%s' from plugin '%s'", symbol, _filename.c_str());
-	#else
-	#error TODO
-	#endif
-	#endif
 	
 		// FIXME HACK: This is a HACK to circumvent a clash between the ISO C++
 		// standard and POSIX: ISO C++ disallows casting between function pointers
@@ -85,46 +57,19 @@
 
 	bool loadPlugin() {
 		assert(!_dlHandle);
-	#if defined(UNIX) || defined(__DC__)
 		_dlHandle = dlopen(_filename.c_str(), RTLD_LAZY);
 	
 		if (!_dlHandle) {
 			warning("Failed loading plugin '%s' (%s)", _filename.c_str(), dlerror());
 			return false;
 		}
-	#else
-	#if defined(_WIN32)
-		_dlHandle = LoadLibrary(_filename.c_str());
 	
-		if (!_dlHandle) {
-			warning("Failed loading plugin '%s'", _filename.c_str());
-			return false;
-		}
-	#else
-	#error TODO
-	#endif
-	#endif
-	
-		bool ret = DynamicPlugin::loadPlugin();
-		
-	#ifdef __DC__
-		if (ret)
-			dlforgetsyms(_dlHandle);
-	#endif
-
-		return ret;
+		return DynamicPlugin::loadPlugin();
 	}
 	void unloadPlugin() {
 		if (_dlHandle) {
-	#if defined(UNIX) || defined(__DC__)
 			if (dlclose(_dlHandle) != 0)
 				warning("Failed unloading plugin '%s' (%s)", _filename.c_str(), dlerror());
-	#elif defined(_WIN32)
-			if (!FreeLibrary((HMODULE)_dlHandle))
-				warning("Failed unloading plugin '%s'", _filename.c_str());
-	#else
-	#error TODO
-	#endif
 		}
 	}
 };
@@ -175,4 +120,4 @@
 }
 
 
-#endif // DYNAMIC_MODULES
+#endif // defined(DYNAMIC_MODULES) && defined(UNIX)

Modified: scummvm/trunk/backends/plugins/posix/posix-provider.h
===================================================================
--- scummvm/trunk/backends/plugins/posix/posix-provider.h	2006-10-07 00:22:48 UTC (rev 24148)
+++ scummvm/trunk/backends/plugins/posix/posix-provider.h	2006-10-07 00:31:33 UTC (rev 24149)
@@ -27,7 +27,7 @@
 #include "common/stdafx.h"
 #include "base/plugins.h"
 
-#ifdef DYNAMIC_MODULES
+#if defined(DYNAMIC_MODULES) && defined(UNIX)
 
 class POSIXPluginProvider : public PluginProvider {
 public:
@@ -37,6 +37,6 @@
 	virtual PluginList getPlugins();
 };
 
-#endif
+#endif // defined(DYNAMIC_MODULES) && defined(UNIX)
 
 #endif


Property changes on: scummvm/trunk/backends/plugins/win32
___________________________________________________________________
Name: svn:ignore
   + .deps
*.o
lib*.a


Added: scummvm/trunk/backends/plugins/win32/win32-provider.cpp
===================================================================
--- scummvm/trunk/backends/plugins/win32/win32-provider.cpp	                        (rev 0)
+++ scummvm/trunk/backends/plugins/win32/win32-provider.cpp	2006-10-07 00:31:33 UTC (rev 24149)
@@ -0,0 +1,124 @@
+/* ScummVM - Scumm Interpreter
+ * Copyright (C) 2001  Ludvig Strigeus
+ * Copyright (C) 2001-2006 The ScummVM project
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * $URL$
+ * $Id$
+ *
+ */
+
+#ifdef DYNAMIC_MODULES
+
+#include "backends/plugins/win32/win32-provider.h"
+#include "backends/plugins/dynamic-plugin.h"
+#include "common/fs.h"
+
+#define PLUGIN_DIRECTORY	""
+#define PLUGIN_PREFIX		""
+#define PLUGIN_SUFFIX		".dll"
+
+
+class Win32Plugin : public DynamicPlugin {
+protected:
+	void *_dlHandle;
+	Common::String _filename;
+
+	virtual VoidFunc findSymbol(const char *symbol) {
+		void *func = (void *)GetProcAddress((HMODULE)_dlHandle, symbol);
+		if (!func)
+			warning("Failed loading symbol '%s' from plugin '%s'", symbol, _filename.c_str());
+	
+		// FIXME HACK: This is a HACK to circumvent a clash between the ISO C++
+		// standard and POSIX: ISO C++ disallows casting between function pointers
+		// and data pointers, but dlsym always returns a void pointer. For details,
+		// see e.g. <http://www.trilithium.com/johan/2004/12/problem-with-dlsym/>.
+		assert(sizeof(VoidFunc) == sizeof(func));
+		VoidFunc tmp;
+		memcpy(&tmp, &func, sizeof(VoidFunc));
+		return tmp;
+	}
+
+public:
+	Win32Plugin(const Common::String &filename)
+		: _dlHandle(0), _filename(filename) {}
+
+	bool loadPlugin() {
+		assert(!_dlHandle);
+		_dlHandle = LoadLibrary(_filename.c_str());
+	
+		if (!_dlHandle) {
+			warning("Failed loading plugin '%s'", _filename.c_str());
+			return false;
+		}
+
+		return DynamicPlugin::loadPlugin();
+	}
+	void unloadPlugin() {
+		if (_dlHandle) {
+			if (!FreeLibrary((HMODULE)_dlHandle))
+				warning("Failed unloading plugin '%s'", _filename.c_str());
+		}
+	}
+};
+
+
+Win32PluginProvider::Win32PluginProvider() {
+}
+
+Win32PluginProvider::~Win32PluginProvider() {
+}
+
+PluginList Win32PluginProvider::getPlugins() {
+	PluginList pl;
+	
+	
+	// Load dynamic plugins
+	// TODO... this is right now just a nasty hack.
+	// This should search one or multiple directories for all plugins it can
+	// find (to this end, we maybe should use a special prefix/suffix; e.g.
+	// instead of libscumm.so, use scumm.engine or scumm.plugin etc.).
+	//
+	// The list of directories to search could be e.g.:
+	// User specified (via config file), ".", "./plugins", "$(prefix)/lib".
+	//
+	// We also need to add code which ensures what we are looking at is
+	// a) a ScummVM engine and b) matches the version of the executable.
+	// Hence one more symbol should be exported by plugins which returns
+	// the "ABI" version the plugin was built for, and we can compare that
+	// to the ABI version of the executable.
+
+	// Load all plugins.
+	// Scan for all plugins in this directory
+	FilesystemNode dir(PLUGIN_DIRECTORY);
+	FSList files;
+	if (!dir.listDir(files, FilesystemNode::kListFilesOnly)) {
+		error("Couldn't open plugin directory '%s'", PLUGIN_DIRECTORY);
+	}
+
+	for (FSList::const_iterator i = files.begin(); i != files.end(); ++i) {
+		Common::String name(i->name());
+		if (name.hasPrefix(PLUGIN_PREFIX) && name.hasSuffix(PLUGIN_SUFFIX)) {
+			pl.push_back(new Win32Plugin(i->path()));
+		}
+	}
+	
+	
+	return pl;
+}
+
+
+#endif // DYNAMIC_MODULES


Property changes on: scummvm/trunk/backends/plugins/win32/win32-provider.cpp
___________________________________________________________________
Name: svn:mime-type
   + text/plain
Name: svn:keywords
   + Date Rev Author URL Id
Name: svn:eol-style
   + native

Added: scummvm/trunk/backends/plugins/win32/win32-provider.h
===================================================================
--- scummvm/trunk/backends/plugins/win32/win32-provider.h	                        (rev 0)
+++ scummvm/trunk/backends/plugins/win32/win32-provider.h	2006-10-07 00:31:33 UTC (rev 24149)
@@ -0,0 +1,42 @@
+/* ScummVM - Scumm Interpreter
+ * Copyright (C) 2001  Ludvig Strigeus
+ * Copyright (C) 2001-2006 The ScummVM project
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * $URL$
+ * $Id$
+ *
+ */
+
+#ifndef BACKENDS_PLUGINS_WIN32_H
+#define BACKENDS_PLUGINS_WIN32_H
+
+#include "common/stdafx.h"
+#include "base/plugins.h"
+
+#if defined(DYNAMIC_MODULES) && defined(_WIN32)
+
+class Win32PluginProvider : public PluginProvider {
+public:
+	Win32PluginProvider();
+	~Win32PluginProvider();
+
+	virtual PluginList getPlugins();
+};
+
+#endif // defined(DYNAMIC_MODULES) && defined(_WIN32)
+
+#endif


Property changes on: scummvm/trunk/backends/plugins/win32/win32-provider.h
___________________________________________________________________
Name: svn:mime-type
   + text/plain
Name: svn:keywords
   + Date Rev Author URL Id
Name: svn:eol-style
   + native


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.




More information about the Scummvm-git-logs mailing list