pidgin/pidgin

Make PurplePluginProtocolInfo definitions consistent
release-2.x.y
2020-05-20, David Woodhouse
159344ba2a49
Make PurplePluginProtocolInfo definitions consistent

Since we can't use C99 structure initialisers, we have to manually add
new NULL fields to all protocols whenever we extend the structure.

Make it slightly easier to script that, by making the current last
field (get_cb_alias) consistent in all cases. In particular, there's
no reason *not* to have the trailing comma, as most already do.

Now I can add a new field to the PRPL by doing something like this...

PROTOFILES=`grep -rl '[A-Za-z_][A-Za-z0-9_]*,[[:space:]]*/\* get_cb_alias \*/' libpurple/protocols/ `
sed '/\/\* get_cb_alias \*\//{p;s/[A-Za-z_][A-Za-
/**
* @file gtkconv.h GTK+ Conversation API
* @ingroup pidgin
* @see @ref gtkconv-signals
*/
/* pidgin
*
* Pidgin 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, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
#ifndef _PIDGIN_CONVERSATION_H_
#define _PIDGIN_CONVERSATION_H_
typedef struct _PidginImPane PidginImPane;
typedef struct _PidginChatPane PidginChatPane;
typedef struct _PidginConversation PidginConversation;
/**
* Unseen text states.
*/
typedef enum
{
PIDGIN_UNSEEN_NONE, /**< No unseen text in the conversation. */
PIDGIN_UNSEEN_EVENT, /**< Unseen events in the conversation. */
PIDGIN_UNSEEN_NO_LOG, /**< Unseen text with NO_LOG flag. */
PIDGIN_UNSEEN_TEXT, /**< Unseen text in the conversation. */
PIDGIN_UNSEEN_NICK /**< Unseen text and the nick was said. */
} PidginUnseenState;
enum {
CHAT_USERS_ICON_COLUMN,
CHAT_USERS_ALIAS_COLUMN,
CHAT_USERS_ALIAS_KEY_COLUMN,
CHAT_USERS_NAME_COLUMN,
CHAT_USERS_FLAGS_COLUMN,
CHAT_USERS_COLOR_COLUMN,
CHAT_USERS_WEIGHT_COLUMN,
CHAT_USERS_ICON_STOCK_COLUMN, /** @since 2.6.0 */
CHAT_USERS_COLUMNS
};
#define PIDGIN_CONVERSATION(conv) \
((PidginConversation *)(conv)->ui_data)
#define PIDGIN_IS_PIDGIN_CONVERSATION(conv) \
(purple_conversation_get_ui_ops(conv) == \
pidgin_conversations_get_conv_ui_ops())
#include "pidgin.h"
#include "conversation.h"
#include "gtkconvwin.h"
/**************************************************************************
* @name Structures
**************************************************************************/
/*@{*/
/**
* A GTK+ representation of a graphical window containing one or more
* conversations.
*/
/**
* A GTK+ Instant Message pane.
*/
struct _PidginImPane
{
GtkWidget *block;
GtkWidget *send_file;
GtkWidget *sep1;
GtkWidget *sep2;
GtkWidget *check;
GtkWidget *progress;
guint32 typing_timer;
/* Buddy icon stuff */
GtkWidget *icon_container;
GtkWidget *icon;
gboolean show_icon;
gboolean animate;
GdkPixbufAnimation *anim;
GdkPixbufAnimationIter *iter;
guint32 icon_timer;
};
/**
* GTK+ Chat panes.
*/
struct _PidginChatPane
{
GtkWidget *count;
GtkWidget *list;
GtkWidget *topic_text;
};
/**
* A GTK+ conversation pane.
*/
struct _PidginConversation
{
PurpleConversation *active_conv;
GList *convs;
GList *send_history;
PidginWindow *win;
gboolean make_sound;
GtkTooltips *tooltips;
GtkWidget *tab_cont;
GtkWidget *tabby;
GtkWidget *menu_tabby;
GtkWidget *imhtml;
GtkTextBuffer *entry_buffer;
GtkWidget *entry;
gboolean auto_resize; /* this is set to TRUE if the conversation
* is being resized by a non-user-initiated
* event, such as the buddy icon appearing
*/
gboolean entry_growing; /* True if the size of the entry was set
* automatically by typing too much to fit
* in one line */
GtkWidget *close; /* "x" on the tab */
GtkWidget *icon;
GtkWidget *tab_label;
GtkWidget *menu_icon;
GtkWidget *menu_label;
#if !(defined PIDGIN_DISABLE_DEPRECATED) || (defined _PIDGIN_GTKCONV_C_)
/** @deprecated */
GtkSizeGroup *sg;
#else
gpointer depr1;
#endif
GtkWidget *lower_hbox;
GtkWidget *toolbar;
PidginUnseenState unseen_state;
guint unseen_count;
union
{
PidginImPane *im;
PidginChatPane *chat;
} u;
time_t newday;
GtkWidget *infopane_hbox;
GtkWidget *infopane;
GtkListStore *infopane_model;
GtkTreeIter infopane_iter;
/* Used when attaching a PidginConversation to a PurpleConversation
* with message history */
struct {
int timer;
GList *current;
} attach;
/**
* Quick Find.
*
* @since 2.7.0
*/
struct {
GtkWidget *entry;
GtkWidget *container;
} quickfind;
};
/*@}*/
/**************************************************************************
* @name GTK+ Conversation API
**************************************************************************/
/*@{*/
/**
* Returns the UI operations structure for GTK+ conversations.
*
* @return The GTK+ conversation operations structure.
*/
PurpleConversationUiOps *pidgin_conversations_get_conv_ui_ops(void);
/**
* Updates the buddy icon on a conversation.
*
* @param conv The conversation.
*/
void pidgin_conv_update_buddy_icon(PurpleConversation *conv);
/**
* Sets the active conversation within a GTK-conversation.
*
* @param conv The conversation
*/
void pidgin_conv_switch_active_conversation(PurpleConversation *conv);
/**
* Updates conversation buttons by protocol.
*
* @param conv The conversation.
*/
void pidgin_conv_update_buttons_by_protocol(PurpleConversation *conv);
/**
* Returns a list of conversations of the given type which have an unseen
* state greater than or equal to the specified minimum state. Using the
* hidden_only parameter, this search can be limited to hidden
* conversations. The max_count parameter will limit the total number of
* converations returned if greater than zero. The returned list should
* be freed by the caller.
*
* @param type The type of conversation.
* @param min_state The minimum unseen state.
* @param hidden_only If TRUE, only consider hidden conversations.
* @param max_count Maximum number of conversations to return, or 0 for
* no maximum.
* @return List of PurpleConversation matching criteria, or NULL.
*/
GList *
pidgin_conversations_find_unseen_list(PurpleConversationType type,
PidginUnseenState min_state,
gboolean hidden_only,
guint max_count);
/**
* Fill a menu with a list of conversations. Clicking the conversation
* menu item will present that conversation to the user.
*
* @param menu Menu widget to add items to.
* @param convs List of PurpleConversation to add to menu.
* @return Number of conversations added to menu.
*/
guint
pidgin_conversations_fill_menu(GtkWidget *menu, GList *convs);
/**
* Presents a purple conversation to the user.
*
* @param conv The conversation.
*/
void pidgin_conv_present_conversation(PurpleConversation *conv);
/**
* Reattach Pidgin UI to a conversation.
*
* @param conv The conversation.
*
* @return Wheter Pidgin UI was successfully attached.
*
* @since 2.2.0
*/
gboolean pidgin_conv_attach_to_conversation(PurpleConversation *conv);
PidginWindow *pidgin_conv_get_window(PidginConversation *gtkconv);
GdkPixbuf *pidgin_conv_get_tab_icon(PurpleConversation *conv, gboolean small_icon);
void pidgin_conv_new(PurpleConversation *conv);
int pidgin_conv_get_tab_at_xy(PidginWindow *win, int x, int y, gboolean *to_right);
gboolean pidgin_conv_is_hidden(PidginConversation *gtkconv);
/*@}*/
/**************************************************************************/
/** @name GTK+ Conversations Subsystem */
/**************************************************************************/
/*@{*/
/**
* Returns the gtk conversations subsystem handle.
*
* @return The conversations subsystem handle.
*/
void *pidgin_conversations_get_handle(void);
/**
* Initializes the GTK+ conversations subsystem.
*/
void pidgin_conversations_init(void);
/**
* Uninitialized the GTK+ conversation subsystem.
*/
void pidgin_conversations_uninit(void);
/*@}*/
#endif /* _PIDGIN_CONVERSATION_H_ */