Initial commit

engines/ags/plugins/plugin_engine.h

@@ -0,0 +1,89 @@
+/* ScummVM - Graphic Adventure Engine
+ *
+ * ScummVM is the legal property of its developers, whose names
+ * are too numerous to list here. Please refer to the COPYRIGHT
+ * file distributed with this source distribution.
+ *
+ * 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 3 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, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+//=============================================================================
+//
+// Plugin system functions.
+//
+//=============================================================================
+
+#ifndef AGS_ENGINE_PLUGIN_PLUGIN_ENGINE_H
+#define AGS_ENGINE_PLUGIN_PLUGIN_ENGINE_H
+
+#include "common/std/vector.h"
+#include "ags/engine/ac/dynobj/cc_script_object.h"
+#include "ags/engine/game/game_init.h"
+#include "ags/shared/game/plugin_info.h"
+#include "ags/shared/util/string.h"
+
+namespace AGS3 {
+
+class IAGSEngine;
+namespace AGS {
+namespace Shared {
+class Stream;
+} // namespace Shared
+} // namespace AGS
+
+using namespace AGS; // FIXME later
+
+
+//
+// PluginObjectReader is a managed object unserializer registered by plugin.
+//
+struct PluginObjectReader {
+	const Shared::String Type;
+	ICCObjectReader *const Reader = nullptr;
+
+	PluginObjectReader(const Shared::String &type, ICCObjectReader *reader)
+		: Type(type), Reader(reader) {}
+};
+
+
+void pl_stop_plugins();
+void pl_startup_plugins();
+NumberPtr pl_run_plugin_hooks(int event, NumberPtr data);
+void pl_run_plugin_init_gfx_hooks(const char *driverName, void *data);
+int pl_run_plugin_debug_hooks(const char *scriptfile, int linenum);
+// Finds a plugin that wants this event, starting with pl_index;
+// returns TRUE on success and fills its index and name;
+// returns FALSE if no more suitable plugins found.
+bool pl_query_next_plugin_for_event(int event, uint32_t &pl_index, Shared::String &pl_name);
+// Runs event for a plugin identified by an index it was registered under.
+int pl_run_plugin_hook_by_index(uint32_t pl_index, int event, int data);
+// Runs event for a plugin identified by its name.
+int pl_run_plugin_hook_by_name(Shared::String &pl_name, int event, int data);
+
+// Tries to register plugins, either by loading dynamic libraries, or getting any kind of replacement
+Engine::GameInitError pl_register_plugins(const std::vector<Shared::PluginInfo> &infos);
+bool pl_is_plugin_loaded(const char *pl_name);
+
+//returns whether _any_ plugins want a particular event
+bool pl_any_want_hook(int event);
+
+void pl_set_file_handle(long data, AGS::Shared::Stream *stream);
+void pl_clear_file_handle();
+
+bool RegisterPluginStubs(const char* name);
+
+} // namespace AGS3
+
+#endif