Move Shared::Module and Shared::World to shared directory.

git-svn-id: http://svn.drobilla.net/lad/trunk/ingen@3147 a436a847-0d15-0410-975c-d299462d15a1

4 files changed, 472 insertions, 0 deletions

diff --git a/src/shared/Module.hpp b/src/shared/Module.hpp
new file mode 100644
index 00000000..af5732af
--- /dev/null
+++ b/src/shared/Module.hpp
@@ -0,0 +1,49 @@
+/* This file is part of Ingen.
+ * Copyright (C) 2007-2009 David Robillard <http://drobilla.net>
+ *
+ * Ingen 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.
+ *
+ * Ingen 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 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 St, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+#ifndef INGEN_MODULE_MODULE_HPP
+#define INGEN_MODULE_MODULE_HPP
+
+#include <glibmm/module.h>
+
+#include "raul/log.hpp"
+#include "raul/SharedPtr.hpp"
+
+namespace Ingen {
+namespace Shared {
+
+class World;
+
+/** A dynamically loaded Ingen module.
+ *
+ * All components of Ingen reside in one of these.
+ */
+struct Module {
+	virtual ~Module() {
+		Raul::info << "[Module] Unloading " << library->get_name() << std::endl;
+	}
+
+	virtual void load(Ingen::Shared::World* world) = 0;
+
+	SharedPtr<Glib::Module> library;
+};
+
+
+} // namespace Shared
+} // namespace Ingen
+
+#endif // INGEN_MODULE_MODULE_HPP
diff --git a/src/shared/World.cpp b/src/shared/World.cpp
new file mode 100644
index 00000000..6667cb9f
--- /dev/null
+++ b/src/shared/World.cpp
@@ -0,0 +1,302 @@
+/* This file is part of Ingen.
+ * Copyright (C) 2007-2009 David Robillard <http://drobilla.net>
+ *
+ * Ingen 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.
+ *
+ * Ingen 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 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 St, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+#include "ingen-config.h"
+#include <boost/utility.hpp>
+#include <glibmm/module.h>
+#include <glibmm/miscutils.h>
+#include <glibmm/fileutils.h>
+#ifdef HAVE_SLV2
+#include "slv2/slv2.h"
+#endif
+#include "raul/log.hpp"
+#include "sord/sordmm.hpp"
+#include "shared/runtime_paths.hpp"
+#include "shared/LV2Features.hpp"
+#include "shared/LV2URIMap.hpp"
+#include "World.hpp"
+#include "Module.hpp"
+
+#define LOG(s) s << "[Module] "
+
+using namespace std;
+using namespace Raul;
+
+namespace Ingen {
+namespace Shared {
+
+/** Load a dynamic module from the default path.
+ *
+ * This will check in the directories specified in the environment variable
+ * INGEN_MODULE_PATH (typical colon delimited format), then the default module
+ * installation directory (ie /usr/local/lib/ingen), in that order.
+ *
+ * \param name The base name of the module, e.g. "ingen_serialisation"
+ */
+static SharedPtr<Glib::Module>
+load_module(const string& name)
+{
+	Glib::Module* module = NULL;
+
+	// Search INGEN_MODULE_PATH first
+	bool module_path_found;
+	string module_path = Glib::getenv("INGEN_MODULE_PATH", module_path_found);
+	if (module_path_found) {
+		string dir;
+		istringstream iss(module_path);
+		while (getline(iss, dir, ':')) {
+			string filename = Shared::module_path(name, dir);
+			if (Glib::file_test(filename, Glib::FILE_TEST_EXISTS)) {
+				module = new Glib::Module(filename, Glib::MODULE_BIND_LAZY);
+				if (*module) {
+					LOG(info) << "Loading " << filename << endl;
+					return SharedPtr<Glib::Module>(module);
+				} else {
+					delete module;
+					error << Glib::Module::get_last_error() << endl;
+				}
+			}
+		}
+	}
+
+	// Try default directory if not found
+	module = new Glib::Module(Shared::module_path(name), Glib::MODULE_BIND_LAZY);
+	
+	// FIXME: SEGV on exit without this
+	module->make_resident();
+
+	if (*module) {
+		LOG(info) << "Loading " << Shared::module_path(name) << endl;
+		return SharedPtr<Glib::Module>(module);
+	} else if (!module_path_found) {
+		LOG(error) << "Unable to find " << name
+			<< " (" << Glib::Module::get_last_error() << ")" << endl;
+		return SharedPtr<Glib::Module>();
+	} else {
+		LOG(error) << "Unable to load " << name << " from " << module_path
+			<< " (" << Glib::Module::get_last_error() << ")" << endl;
+		LOG(error) << "Is Ingen installed?" << endl;
+		return SharedPtr<Glib::Module>();
+	}
+}
+
+
+class WorldImpl : public boost::noncopyable {
+public:
+	WorldImpl(Raul::Configuration* conf, int& a_argc, char**& a_argv)
+		: argc(a_argc)
+		, argv(a_argv)
+		, conf(conf)
+		, lv2_features(NULL)
+		, rdf_world(new Sord::World())
+		, uris(new Shared::LV2URIMap())
+#ifdef HAVE_SLV2
+		, slv2_world(slv2_world_new())
+#else
+		, slv2_world(NULL)
+#endif
+	{
+#ifdef HAVE_SLV2
+		lv2_features = new Ingen::Shared::LV2Features();
+		lv2_features->add_feature(LV2_URI_MAP_URI, uris);
+		lv2_features->add_feature(LV2_URI_UNMAP_URI, uris->unmap_feature());
+		slv2_world_load_all(slv2_world);
+#endif
+
+		// Set up RDF namespaces
+		rdf_world->add_prefix("dc",      "http://purl.org/dc/elements/1.1/");
+		rdf_world->add_prefix("doap",    "http://usefulinc.com/ns/doap#");
+		rdf_world->add_prefix("ingen",   "http://drobilla.net/ns/ingen#");
+		rdf_world->add_prefix("ingenui", "http://drobilla.net/ns/ingenuity#");
+		rdf_world->add_prefix("lv2",     "http://lv2plug.in/ns/lv2core#");
+		rdf_world->add_prefix("lv2ev",   "http://lv2plug.in/ns/ext/event#");
+		rdf_world->add_prefix("ctx",     "http://lv2plug.in/ns/ext/contexts#");
+		rdf_world->add_prefix("lv2midi", "http://lv2plug.in/ns/ext/midi#");
+		rdf_world->add_prefix("midi",    "http://drobilla.net/ns/ext/midi#");
+		rdf_world->add_prefix("owl",     "http://www.w3.org/2002/07/owl#");
+		rdf_world->add_prefix("rdfs",    "http://www.w3.org/2000/01/rdf-schema#");
+		rdf_world->add_prefix("xsd",     "http://www.w3.org/2001/XMLSchema#");
+		rdf_world->add_prefix("atom",    "http://lv2plug.in/ns/ext/atom#");
+		rdf_world->add_prefix("xsd",     "http://www.w3.org/2001/XMLSchema#");
+	}
+
+	virtual ~WorldImpl()
+	{
+		local_engine.reset();
+
+		modules.clear();
+		interface_factories.clear();
+		script_runners.clear();
+
+#ifdef HAVE_SLV2
+		slv2_world_free(slv2_world);
+		slv2_world = NULL;
+#endif
+
+		delete rdf_world;
+		rdf_world = NULL;
+
+		delete lv2_features;
+		lv2_features = NULL;
+
+		uris.reset();
+	}
+
+	typedef std::map< const std::string, SharedPtr<Module> > Modules;
+	Modules modules;
+
+	typedef std::map<const std::string, World::InterfaceFactory> InterfaceFactories;
+	InterfaceFactories interface_factories;
+
+	typedef bool (*ScriptRunner)(World* world, const char* filename);
+	typedef std::map<const std::string, ScriptRunner> ScriptRunners;
+	ScriptRunners script_runners;
+
+	int&                                 argc;
+	char**&                              argv;
+	Raul::Configuration*                 conf;
+	LV2Features*                         lv2_features;
+	Sord::World*                         rdf_world;
+	SharedPtr<LV2URIMap>                 uris;
+    SharedPtr<EngineInterface>           engine;
+	SharedPtr<Engine>                    local_engine;
+    SharedPtr<Serialisation::Serialiser> serialiser;
+    SharedPtr<Serialisation::Parser>     parser;
+    SharedPtr<Store>                     store;
+    SLV2World                            slv2_world;
+	std::string                          jack_uuid;
+};
+
+
+World::World(Raul::Configuration* conf, int& argc, char**& argv)
+	: _impl(new WorldImpl(conf, argc, argv))
+{
+}
+
+
+World::~World()
+{
+	unload_all();
+	delete _impl;
+}
+
+void World::set_local_engine(SharedPtr<Engine> e)                  { _impl->local_engine = e; }
+void World::set_engine(SharedPtr<EngineInterface> e)               { _impl->engine = e; }
+void World::set_serialiser(SharedPtr<Serialisation::Serialiser> s) { _impl->serialiser = s; }
+void World::set_parser(SharedPtr<Serialisation::Parser> p)         { _impl->parser = p; }
+void World::set_store(SharedPtr<Store> s)                          { _impl->store = s; }
+void World::set_conf(Raul::Configuration* c)                       { _impl->conf = c; }
+
+int&                                 World::argc()         { return _impl->argc; }
+char**&                              World::argv()         { return _impl->argv; }
+SharedPtr<Engine>                    World::local_engine() { return _impl->local_engine; }
+SharedPtr<EngineInterface>           World::engine()       { return _impl->engine; }
+SharedPtr<Serialisation::Serialiser> World::serialiser()   { return _impl->serialiser; }
+SharedPtr<Serialisation::Parser>     World::parser()       { return _impl->parser; }
+SharedPtr<Store>                     World::store()        { return _impl->store; }
+Raul::Configuration*                 World::conf()         { return _impl->conf; }
+LV2Features*                         World::lv2_features() { return _impl->lv2_features; }
+
+#ifdef HAVE_SLV2
+SLV2World            World::slv2_world() { return _impl->slv2_world; }
+#endif
+Sord::World*         World::rdf_world() { return _impl->rdf_world; }
+SharedPtr<LV2URIMap> World::uris()      { return _impl->uris; }
+
+
+/** Load an Ingen module.
+ * @return true on success, false on failure
+ */
+bool
+World::load(const char* name)
+{
+	SharedPtr<Glib::Module> lib = load_module(name);
+	Ingen::Shared::Module* (*module_load)() = NULL;
+	if (lib && lib->get_symbol("ingen_module_load", (void*&)module_load)) {
+		Module* module = module_load();
+		module->library = lib;
+		module->load(this);
+		_impl->modules.insert(make_pair(string(name), module));
+		return true;
+	} else {
+		LOG(error) << "Failed to load module `" << name << "'" << endl;
+		return false;
+	}
+}
+
+
+/** Unload all loaded Ingen modules.
+ */
+void
+World::unload_all()
+{
+	_impl->modules.clear();
+}
+
+
+/** Get an interface for a remote engine at @a url
+ */
+SharedPtr<Ingen::Shared::EngineInterface>
+World::interface(const std::string& url)
+{
+	const string scheme = url.substr(0, url.find(":"));
+	const WorldImpl::InterfaceFactories::const_iterator i = _impl->interface_factories.find(scheme);
+	if (i == _impl->interface_factories.end()) {
+		warn << "Unknown URI scheme `" << scheme << "'" << endl;
+		return SharedPtr<Ingen::Shared::EngineInterface>();
+	}
+
+	return i->second(this, url);
+}
+
+
+/** Run a script of type @a mime_type at filename @a filename */
+bool
+World::run(const std::string& mime_type, const std::string& filename)
+{
+	const WorldImpl::ScriptRunners::const_iterator i = _impl->script_runners.find(mime_type);
+	if (i == _impl->script_runners.end()) {
+		warn << "Unknown script MIME type `" << mime_type << "'" << endl;
+		return false;
+	}
+
+	return i->second(this, filename.c_str());
+}
+
+void
+World::add_interface_factory(const std::string& scheme, InterfaceFactory factory)
+{
+	_impl->interface_factories.insert(make_pair(scheme, factory));
+}
+
+
+void
+World::set_jack_uuid(const std::string& uuid)
+{
+	_impl->jack_uuid = uuid;
+}
+
+
+std::string
+World::jack_uuid()
+{
+	return _impl->jack_uuid;
+}
+
+
+} // namespace Shared
+} // namespace Ingen
diff --git a/src/shared/World.hpp b/src/shared/World.hpp
new file mode 100644
index 00000000..29d904b2
--- /dev/null
+++ b/src/shared/World.hpp
@@ -0,0 +1,120 @@
+/* This file is part of Ingen.
+ * Copyright (C) 2007-2009 David Robillard <http://drobilla.net>
+ *
+ * Ingen 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.
+ *
+ * Ingen 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 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 St, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+#ifndef INGEN_MODULE_WORLD_HPP
+#define INGEN_MODULE_WORLD_HPP
+
+#include <map>
+#include <string>
+
+#include <boost/shared_ptr.hpp>
+#include <boost/utility.hpp>
+
+#include <glibmm/module.h>
+
+#include "raul/Configuration.hpp"
+#include "raul/SharedPtr.hpp"
+
+#include "ingen-config.h"
+
+#ifdef HAVE_SLV2
+typedef struct _SLV2World* SLV2World;
+#endif
+
+namespace Sord { class World; }
+
+namespace Ingen {
+
+class Engine;
+
+namespace Serialisation { class Serialiser; class Parser; }
+
+namespace Shared {
+
+class EngineInterface;
+class LV2Features;
+class LV2URIMap;
+class Store;
+class WorldImpl;
+
+
+/** The "world" all Ingen modules may share.
+ *
+ * All loaded components of Ingen, as well as things requiring shared access
+ * and/or locking (e.g. Sord, SLV2).
+ *
+ * Ingen modules are shared libraries which modify the World when loaded
+ * using World::load, e.g. loading the "ingen_serialisation" module will
+ * set World::serialiser and World::parser to valid objects.
+ */
+class World : public boost::noncopyable {
+public:
+	World(Raul::Configuration* conf, int& argc, char**& argv);
+	virtual ~World();
+
+	virtual bool load(const char* name);
+	virtual void unload_all();
+
+	typedef SharedPtr<Ingen::Shared::EngineInterface> (*InterfaceFactory)(
+			World* world, const std::string& engine_url);
+
+	virtual void add_interface_factory(const std::string& scheme,
+	                                   InterfaceFactory   factory);
+	
+	virtual SharedPtr<Ingen::Shared::EngineInterface> interface(
+		const std::string& engine_url);
+
+	virtual bool run(const std::string& mime_type,
+	                 const std::string& filename);
+
+	virtual void set_local_engine(SharedPtr<Engine> e);
+	virtual void set_engine(SharedPtr<EngineInterface> e);
+	virtual void set_serialiser(SharedPtr<Serialisation::Serialiser> s);
+	virtual void set_parser(SharedPtr<Serialisation::Parser> p);
+	virtual void set_store(SharedPtr<Store> s);
+
+	virtual SharedPtr<Engine>                    local_engine();
+	virtual SharedPtr<EngineInterface>           engine();
+	virtual SharedPtr<Serialisation::Serialiser> serialiser();
+	virtual SharedPtr<Serialisation::Parser>     parser();
+	virtual SharedPtr<Store>                     store();
+
+	virtual Sord::World*         rdf_world();
+	virtual SharedPtr<LV2URIMap> uris();
+
+	virtual int&    argc();
+	virtual char**& argv();
+
+	virtual Raul::Configuration* conf();
+	virtual void set_conf(Raul::Configuration* c);
+
+	virtual LV2Features* lv2_features();
+
+	virtual SLV2World slv2_world();
+
+	virtual void        set_jack_uuid(const std::string& uuid);
+	virtual std::string jack_uuid();
+
+private:
+	WorldImpl* _impl;
+};
+
+
+} // namespace Shared
+} // namespace Ingen
+
+#endif // INGEN_MODULE_WORLD_HPP
diff --git a/src/shared/wscript b/src/shared/wscript
index 811ed45e..4f03cf28 100644
--- a/src/shared/wscript
+++ b/src/shared/wscript
@@ -15,6 +15,7 @@ def build(bld):
 		LV2URIMap.cpp
 		ResourceImpl.cpp
 		Store.cpp
+		World.cpp
 		runtime_paths.cpp
 	'''
 	if bld.is_defined('HAVE_LIBLO'):