pidgin/pidgin

Remove PurpleProtocol->login and ->close as they're no longer necessary

2 months ago, Gary Kramlich
a3d036e859b1
Remove PurpleProtocol->login and ->close as they're no longer necessary

These were left around for the old protocols and the replacement code used them
as a fallback.

Testing Done:
Ran with the turtles.

Reviewed at https://reviews.imfreedom.org/r/3081/
/*
* 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 library 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 library 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 library; 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_CLIENT_H
#define PURPLE_PROTOCOL_CLIENT_H
#include <glib.h>
#include <glib-object.h>
#include "connection.h"
#include "purpleaccount.h"
#include "purpleconversation.h"
#include "purpleprotocol.h"
#include "purpleversion.h"
#define PURPLE_TYPE_PROTOCOL_CLIENT (purple_protocol_client_get_type())
PURPLE_AVAILABLE_IN_3_0
G_DECLARE_INTERFACE(PurpleProtocolClient, purple_protocol_client, PURPLE,
PROTOCOL_CLIENT, PurpleProtocol)
/**
* PurpleProtocolClient:
*
* #PurpleProtocolClient interface defines the behavior of a typical chat
* service's client interface.
*
* Since: 3.0
*/
struct _PurpleProtocolClientInterface {
/*< private >*/
GTypeInterface parent;
/*< public >*/
const gchar *(*list_emblem)(PurpleProtocolClient *client, PurpleBuddy *buddy);
GList *(*blist_node_menu)(PurpleProtocolClient *client, PurpleBlistNode *node);
void (*buddy_free)(PurpleProtocolClient *client, PurpleBuddy *buddy);
void (*convo_closed)(PurpleProtocolClient *client, PurpleConnection *connection, const gchar *who);
const gchar *(*normalize)(PurpleProtocolClient *client, PurpleAccount *account, const gchar *who);
PurpleChat *(*find_blist_chat)(PurpleProtocolClient *client, PurpleAccount *account, const gchar *name);
gboolean (*offline_message)(PurpleProtocolClient *client, PurpleBuddy *buddy);
GHashTable *(*get_account_text_table)(PurpleProtocolClient *client, PurpleAccount *account);
gssize (*get_max_message_size)(PurpleProtocolClient *client, PurpleConversation *conv);
/*< private >*/
gpointer reserved[4];
};
G_BEGIN_DECLS
/**
* purple_protocol_client_list_emblem:
* @client: The #PurpleProtocolClient instance.
* @buddy: The #PurpleBuddy instance.
*
* Gets the icon name of the emblem that should be used for @buddy.
*
* Returns: The icon name of the emblem or %NULL.
*
* Since: 3.0
*/
PURPLE_AVAILABLE_IN_3_0
const gchar *purple_protocol_client_list_emblem(PurpleProtocolClient *client, PurpleBuddy *buddy);
/**
* purple_protocol_client_blist_node_menu:
* @client: The #PurpleProtocolClient instance.
* @node: The #PurpleBlistNode instance.
*
* Gets a list of #PurpleActionMenu structs, which represent extra actions to
* be shown in (for example) the right-click menu for @node.
*
* Returns: (transfer full) (element-type PurpleActionMenu): The list of
* #PurpleActionMenu structs to display for @node.
*
* Since: 3.0
*/
PURPLE_AVAILABLE_IN_3_0
GList *purple_protocol_client_blist_node_menu(PurpleProtocolClient *client, PurpleBlistNode *node);
/**
* purple_protocol_client_buddy_free:
* @client: The #PurpleProtocolClient instance.
* @buddy: A #PurpleBuddy instance.
*
* Cleans up any protocol specific data for @buddy.
*
* Since: 3.0
*/
PURPLE_AVAILABLE_IN_3_0
void purple_protocol_client_buddy_free(PurpleProtocolClient *client, PurpleBuddy *buddy);
/**
* purple_protocol_client_convo_closed:
* @client: The #PurpleProtocolClient instance.
* @connection: A #PurpleConnection instance.
* @who: The name of the conversation to close.
*
* Closes the conversation named @who on connection @connection.
*
* Since: 3.0
*/
PURPLE_AVAILABLE_IN_3_0
void purple_protocol_client_convo_closed(PurpleProtocolClient *client, PurpleConnection *connection, const gchar *who);
/**
* purple_protocol_client_normalize:
* @client: The #PurpleProtocolClient instance.
* @account: (nullable): A #PurpleAccount instance.
* @who: The name to normalize.
*
* Normalizes a @who to the canonical form for the protocol. For example, many
* protocols only support all lower case, but might have display version where
* there are capital letters.
*
* Returns: The normalized version of @who for @account.
*
* Since: 3.0
*
* Deprecated: 3.0: This should use purple_protocol_client_normalize_name when
* it is created which will return an allocated value.
*/
PURPLE_DEPRECATED
const gchar *purple_protocol_client_normalize(PurpleProtocolClient *client, PurpleAccount *account, const gchar *who);
/**
* purple_protocol_client_find_blist_chat:
* @client: The #PurpleProtocolClient instance.
* @account: A #PurpleAccount instance.
* @name: The name of the chat to find.
*
* Looks for a chat named @name in the contact list of @account.
*
* Returns: (transfer none): The #PurpleChat instance or %NULL if no chat could
* be found.
*
* Since: 3.0
*/
PURPLE_AVAILABLE_IN_3_0
PurpleChat *purple_protocol_client_find_blist_chat(PurpleProtocolClient *client, PurpleAccount *account, const gchar *name);
/**
* purple_protocol_client_offline_message:
* @client: The #PurpleProtocolClient instance.
* @buddy: A #PurpleBuddy instance.
*
* Checks whether offline messages to @buddy are supported.
*
* Returns: %TRUE if @buddy supports offline messages, otherwise %FALSE.
*
* Since: 3.0
*/
PURPLE_AVAILABLE_IN_3_0
gboolean purple_protocol_client_offline_message(PurpleProtocolClient *client, PurpleBuddy *buddy);
/**
* purple_protocol_client_get_account_text_table:
* @client: The #PurpleProtocolClient instance.
* @account: (nullable): A #PurpleAccount instance.
*
* Gets the account text table which allows protocols to specify additional
* strings to be used for various purposes. The idea is to stuff a bunch of
* strings in this hash table instead of expanding the struct for every
* addition.
*
* Returns: (transfer full): The newly allocated text table.
*
* Since: 3.0
*
* Deprecated: 3.0: This is a premature optimization. Right now this is only
* used by GaduGadu for a single item and should be replaced.
*/
PURPLE_DEPRECATED
GHashTable *purple_protocol_client_get_account_text_table(PurpleProtocolClient *client, PurpleAccount *account);
/**
* purple_protocol_client_get_max_message_size:
* @client: The #PurpleProtocolClient instance.
* @conv: A #PurpleConversation instance.
*
* Gets the maximum number of characters per message for @conv.
*
* Returns: The maximum number of characters per message for @conv or -1 for no
* limit.
*
* Since: 3.0
*/
PURPLE_AVAILABLE_IN_3_0
gssize purple_protocol_client_get_max_message_size(PurpleProtocolClient *client, PurpleConversation *conv);
G_END_DECLS
#endif /* PURPLE_PROTOCOL_CLIENT_H */