pidgin/pidgin

Replace PurpleIdleUiOps with the PurpleIdleUi Interface

2021-10-22, Gary Kramlich
5397330041d6
Replace PurpleIdleUiOps with the PurpleIdleUi Interface

This continues our path down replacing the UiOps with Interfaces so that
developers can write user interfaces in other languages using gobject
introspection.

Testing Done:
Ran pidgin3 and set it to auto idle after 1 minute of system idle time. This attempted to query xscreen saver, but something didn't work there, but that's been happening before this change. Not sure if it's my system or the code just needs fixing.

Ran finch3 set idle time to 1 minute and verified that it set me to away after that minute.

I also used the libpurple idle time for both pidgin3 and finch3 and verified they continued to work as well.

Reviewed at https://reviews.imfreedom.org/r/1091/
/*
* 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_IM_H
#define PURPLE_PROTOCOL_IM_H
/**
* SECTION:purpleprotocolim
* @section_id: libpurple-purpleprotocolim
* @title: ProtocolIM Interface
* @short_description: Protocol Instant Message Interface
*
* #PurpleProtocolIM describes the API that protocols need to implement for
* handling one on one conversations.
*/
#include <glib.h>
#include <glib-object.h>
#include <libpurple/connection.h>
#include <libpurple/protocol.h>
/**
* PURPLE_TYPE_PROTOCOL_IM:
*
* The standard _TYPE_ macro for #PurpleProtocolIM.
*
* Since: 3.0.0
*/
#define PURPLE_TYPE_PROTOCOL_IM (purple_protocol_im_get_type())
/**
* purple_protocol_im_get_type:
*
* Gets the #GType for #PurpleProtocolIM.
*
* Returns: The #GType for #PurpleProtocolIM.
*
* Since: 3.0.0
*/
/**
* PurpleProtocolIM:
*
* An opaque data structure that represents and object that implements
* #PurpleProtocolIMInterface.
*
* Since: 3.0.0
*/
G_DECLARE_INTERFACE(PurpleProtocolIM, purple_protocol_im, PURPLE, PROTOCOL_IM,
PurpleProtocol)
/**
* PurpleProtocolIMInterface:
* @send: This protocol function should return a positive value on
* success. If the message is too big to be sent, return
* <literal>-E2BIG</literal>. If the account is not connected,
* return <literal>-ENOTCONN</literal>. If the protocol is unable
* to send the message for another reason, return some other
* negative value. You can use one of the valid #errno values, or
* just big something. If the message should not be echoed to the
* conversation window, return 0.
* @send_typing: If this protocol requires the #PURPLE_IM_TYPING message to be
* sent repeatedly to signify that the user is still typing, then
* the protocol should return the number of seconds to wait before
* sending a subsequent notification. Otherwise the protocol
* should return 0.
*
* The protocol IM interface that needs to be implemented to send one to one
* messages.
*/
struct _PurpleProtocolIMInterface {
/*< private >*/
GTypeInterface parent;
/*< public >*/
gint (*send)(PurpleProtocolIM *im, PurpleConnection *connection,
PurpleMessage *msg);
guint (*send_typing)(PurpleProtocolIM *im, PurpleConnection *connection,
const gchar *name, PurpleIMTypingState state);
/*< private >*/
gpointer reserved[4];
};
G_BEGIN_DECLS
/**
* purple_protocol_im_send:
* @im: The #PurpleProtocolIM instance.
* @connection: The #PurpleConnection to use.
* @msg: The #PurpleMessage to send.
*
* Sends @msg out over @connection.
*
* Returns: >= 0 on success, or < 0 on error. If 0 is returned the message
* should not be output locally.
*/
gint purple_protocol_im_send(PurpleProtocolIM *im,
PurpleConnection *connection,
PurpleMessage *msg);
/**
* purple_protocol_im_send_typing:
* @im: The #PurpleProtocolIM instance.
* @connection: The #PurpleConversation to use.
* @name: The name of the user to send a typing notification to.
* @state: The #PurpleIMTypingState Value.
*
* If this protocol requires the #PURPLE_IM_TYPING message to be sent
* repeatedly to signify that the user is still typing, then the protocol
* should return the number of seconds to wait before sending a subsequent
* notification. Otherwise the protocol should return 0.
*
* Returns: A quiet-period, specified in seconds, where Purple will not send
* any additional typing notification messages. Most protocols should
* return 0, which means that no additional #PURPLE_IM_TYPING messages
* need to be sent. If this is 5, for example, then Purple will wait
* five seconds, and if the Purple user is still typing then Purple
* will send another #PURPLE_IM_TYPING message.
*/
guint purple_protocol_im_send_typing(PurpleProtocolIM *im,
PurpleConnection *connection,
const gchar *name,
PurpleIMTypingState state);
G_END_DECLS
#endif /* PURPLE_PROTOCOL_IM_H */