pidgin/pidgin

Add a protocol actions interface

21 months ago, Elliott Sales de Andrade
05ac40f0e0c4
Parents 179b2daaeb98
Children 86beaec0fa35
Add a protocol actions interface

Testing Done:
Compile only, for this part by itself.

Reviewed at https://reviews.imfreedom.org/r/1511/
--- a/libpurple/meson.build Thu Jun 23 23:06:18 2022 -0500
+++ b/libpurple/meson.build Tue Jun 28 16:04:47 2022 -0500
@@ -68,6 +68,7 @@
'purpleplugininfo.c',
'purplepresence.c',
'purpleprotocol.c',
+ 'purpleprotocolactions.c',
'purpleprotocolchat.c',
'purpleprotocolclient.c',
'purpleprotocolfactory.c',
@@ -167,6 +168,7 @@
'purpleplugininfo.h',
'purplepresence.h',
'purpleprotocol.h',
+ 'purpleprotocolactions.h',
'purpleprotocolchat.h',
'purpleprotocolclient.h',
'purpleprotocolfactory.h',
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/libpurple/purpleprotocolactions.c Tue Jun 28 16:04:47 2022 -0500
@@ -0,0 +1,68 @@
+/*
+ * Purple - Internet Messaging Library
+ * Copyright (C) Pidgin Developers <devel@pidgin.im>
+ *
+ * Purple 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 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, see <https://www.gnu.org/licenses/>.
+ */
+
+#include "purpleprotocolactions.h"
+
+/******************************************************************************
+ * GObject Implementation
+ *****************************************************************************/
+G_DEFINE_INTERFACE(PurpleProtocolActions, purple_protocol_actions,
+ PURPLE_TYPE_PROTOCOL)
+
+static void
+purple_protocol_actions_default_init(PurpleProtocolActionsInterface *iface) {
+}
+
+/******************************************************************************
+ * Public API
+ *****************************************************************************/
+GActionGroup *
+purple_protocol_actions_get_action_group(PurpleProtocolActions *actions,
+ PurpleConnection *connection)
+{
+ PurpleProtocolActionsInterface *iface = NULL;
+
+ g_return_val_if_fail(PURPLE_IS_PROTOCOL_ACTIONS(actions), NULL);
+ g_return_val_if_fail(PURPLE_IS_CONNECTION(connection), NULL);
+
+ iface = PURPLE_PROTOCOL_ACTIONS_GET_IFACE(actions);
+ if(iface != NULL && iface->get_action_group != NULL) {
+ return iface->get_action_group(actions, connection);
+ }
+
+ return NULL;
+}
+
+GMenu *
+purple_protocol_actions_get_menu(PurpleProtocolActions *actions)
+{
+ PurpleProtocolActionsInterface *iface = NULL;
+
+ g_return_val_if_fail(PURPLE_IS_PROTOCOL_ACTIONS(actions), NULL);
+
+ iface = PURPLE_PROTOCOL_ACTIONS_GET_IFACE(actions);
+ if(iface != NULL && iface->get_menu != NULL) {
+ return iface->get_menu(actions);
+ }
+
+ return NULL;
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/libpurple/purpleprotocolactions.h Tue Jun 28 16:04:47 2022 -0500
@@ -0,0 +1,107 @@
+/*
+ * Purple - Internet Messaging Library
+ * Copyright (C) Pidgin Developers <devel@pidgin.im>
+ *
+ * Purple 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 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, see <https://www.gnu.org/licenses/>.
+ */
+
+#if !defined(PURPLE_GLOBAL_HEADER_INSIDE) && !defined(PURPLE_COMPILATION)
+# error "only <purple.h> may be included directly"
+#endif
+
+#ifndef PURPLE_PROTOCOL_ACTIONS_H
+#define PURPLE_PROTOCOL_ACTIONS_H
+
+#include <glib.h>
+#include <glib-object.h>
+
+#include <libpurple/connection.h>
+#include <libpurple/purpleprotocol.h>
+
+#define PURPLE_TYPE_PROTOCOL_ACTIONS (purple_protocol_actions_get_type())
+G_DECLARE_INTERFACE(PurpleProtocolActions, purple_protocol_actions, PURPLE,
+ PROTOCOL_ACTIONS, PurpleProtocol)
+
+/**
+ * PurpleProtocolActions:
+ *
+ * The #PurpleProtocolActions interface defines the behavior of a protocol's
+ * actions interface.
+ *
+ * Since: 3.0.0
+ */
+
+/**
+ * PurpleProtocolActionsInterface:
+ * @get_action_group: Returns the actions the protocol can perform. If actions
+ * depend on connectivity, connect to the relevant signals
+ * on the @connection and signal the action has changed with
+ * [iface@GLib.ActionGroup] signals.
+ * @get_menu: Get the menu used to display protocol actions. In Pidgin, these
+ * will show up in the Accounts menu, under a submenu with the name
+ * of the account.
+ *
+ * The protocol actions interface.
+ *
+ * This interface provides a gateway between purple and the protocol.
+ *
+ * Since: 3.0.0
+ */
+struct _PurpleProtocolActionsInterface {
+ /*< private >*/
+ GTypeInterface parent;
+
+ /*< public >*/
+ GActionGroup *(*get_action_group)(PurpleProtocolActions *actions, PurpleConnection *connection);
+
+ GMenu *(*get_menu)(PurpleProtocolActions *actions);
+
+ /*< private >*/
+ gpointer reserved[4];
+};
+
+G_BEGIN_DECLS
+
+/**
+ * purple_protocol_actions_get_action_group:
+ * @actions: The PurpleProtocolActions instance.
+ * @connection: The [class@Connection] instance.
+ *
+ * Gets a group of actions for @connection.
+ *
+ * Returns: (transfer full): The group of actions for @connection.
+ *
+ * Since: 3.0.0
+ */
+GActionGroup *purple_protocol_actions_get_action_group(PurpleProtocolActions *actions, PurpleConnection *connection);
+
+/**
+ * purple_protocol_actions_get_menu:
+ * @actions: The [iface@ProtocolActions] instance.
+ *
+ * Gets the menu used to display the protocol actions.
+ *
+ * Returns: (transfer full): The menu to display or %NULL.
+ *
+ * Since: 3.0.0
+ */
+GMenu *purple_protocol_actions_get_menu(PurpleProtocolActions *actions);
+
+G_END_DECLS
+
+#endif /* PURPLE_PROTOCOL_ACTIONS_H */