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-
/*
* Markerline - Draw a line to indicate new messages in a conversation.
* Copyright (C) 2006
*
* 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.
*/
#include "internal.h"
#define PLUGIN_ID "gtk-plugin_pack-markerline"
#define PLUGIN_NAME N_("Markerline")
#define PLUGIN_STATIC_NAME Markerline
#define PLUGIN_SUMMARY N_("Draw a line to indicate new messages in a conversation.")
#define PLUGIN_DESCRIPTION N_("Draw a line to indicate new messages in a conversation.")
#define PLUGIN_AUTHOR "Sadrul H Chowdhury <sadrul@users.sourceforge.net>"
/* System headers */
#include <gdk/gdk.h>
#include <glib.h>
#include <gtk/gtk.h>
/* Purple headers */
#include <gtkconv.h>
#include <gtkimhtml.h>
#include <gtkplugin.h>
#include <version.h>
#define PREF_PREFIX "/plugins/gtk/" PLUGIN_ID
#define PREF_IMS PREF_PREFIX "/ims"
#define PREF_CHATS PREF_PREFIX "/chats"
static int
imhtml_expose_cb(GtkWidget *widget, GdkEventExpose *event, PidginConversation *gtkconv)
{
int y, last_y, offset;
GdkRectangle visible_rect;
GtkTextIter iter;
GdkRectangle buf;
int pad;
PurpleConversation *conv = gtkconv->active_conv;
PurpleConversationType type = purple_conversation_get_type(conv);
if ((type == PURPLE_CONV_TYPE_CHAT && !purple_prefs_get_bool(PREF_CHATS)) ||
(type == PURPLE_CONV_TYPE_IM && !purple_prefs_get_bool(PREF_IMS)))
return FALSE;
gtk_text_view_get_visible_rect(GTK_TEXT_VIEW(widget), &visible_rect);
offset = GPOINTER_TO_INT(g_object_get_data(G_OBJECT(widget), "markerline"));
if (offset)
{
gtk_text_buffer_get_iter_at_offset(gtk_text_view_get_buffer(GTK_TEXT_VIEW(widget)),
&iter, offset);
gtk_text_view_get_iter_location(GTK_TEXT_VIEW(widget), &iter, &buf);
last_y = buf.y + buf.height;
pad = (gtk_text_view_get_pixels_below_lines(GTK_TEXT_VIEW(widget)) +
gtk_text_view_get_pixels_above_lines(GTK_TEXT_VIEW(widget))) / 2;
last_y += pad;
}
else
last_y = 0;
gtk_text_view_buffer_to_window_coords(GTK_TEXT_VIEW(widget), GTK_TEXT_WINDOW_TEXT,
0, last_y, 0, &y);
if (y >= event->area.y)
{
GdkColor red = {0, 0xffff, 0, 0};
cairo_t *cr = gdk_cairo_create(GDK_DRAWABLE(event->window));
gdk_cairo_set_source_color(cr, &red);
cairo_move_to(cr, 0.0, y + 0.5);
cairo_rel_line_to(cr, visible_rect.width, 0.0);
cairo_set_line_width(cr, 1.0);
cairo_stroke(cr);
cairo_destroy(cr);
}
return FALSE;
}
static void
update_marker_for_gtkconv(PidginConversation *gtkconv)
{
GtkTextIter iter;
GtkTextBuffer *buffer;
g_return_if_fail(gtkconv != NULL);
buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(gtkconv->imhtml));
if (!gtk_text_buffer_get_char_count(buffer))
return;
gtk_text_buffer_get_end_iter(buffer, &iter);
g_object_set_data(G_OBJECT(gtkconv->imhtml), "markerline",
GINT_TO_POINTER(gtk_text_iter_get_offset(&iter)));
gtk_widget_queue_draw(gtkconv->imhtml);
}
static gboolean
focus_removed(GtkWidget *widget, GdkEventVisibility *event, PidginWindow *win)
{
PurpleConversation *conv;
PidginConversation *gtkconv;
conv = pidgin_conv_window_get_active_conversation(win);
g_return_val_if_fail(conv != NULL, FALSE);
gtkconv = PIDGIN_CONVERSATION(conv);
update_marker_for_gtkconv(gtkconv);
return FALSE;
}
#if 0
static gboolean
window_resized(GtkWidget *w, GdkEventConfigure *event, PidginWindow *win)
{
GList *list;
list = pidgin_conv_window_get_gtkconvs(win);
for (; list; list = list->next)
update_marker_for_gtkconv(list->data);
return FALSE;
}
static gboolean
imhtml_resize_cb(GtkWidget *w, GtkAllocation *allocation, PidginConversation *gtkconv)
{
gtk_widget_queue_draw(w);
return FALSE;
}
#endif
static void
page_switched(GtkWidget *widget, GtkWidget *page, gint num, PidginWindow *win)
{
focus_removed(NULL, NULL, win);
}
static void
detach_from_gtkconv(PidginConversation *gtkconv, gpointer null)
{
g_signal_handlers_disconnect_by_func(G_OBJECT(gtkconv->imhtml), imhtml_expose_cb, gtkconv);
}
static void
detach_from_pidgin_window(PidginWindow *win, gpointer null)
{
g_list_foreach(pidgin_conv_window_get_gtkconvs(win), (GFunc)detach_from_gtkconv, NULL);
g_signal_handlers_disconnect_by_func(G_OBJECT(win->notebook), page_switched, win);
g_signal_handlers_disconnect_by_func(G_OBJECT(win->window), focus_removed, win);
gtk_widget_queue_draw(win->window);
}
static void
attach_to_gtkconv(PidginConversation *gtkconv, gpointer null)
{
detach_from_gtkconv(gtkconv, NULL);
g_signal_connect(G_OBJECT(gtkconv->imhtml), "expose_event",
G_CALLBACK(imhtml_expose_cb), gtkconv);
}
static void
attach_to_pidgin_window(PidginWindow *win, gpointer null)
{
g_list_foreach(pidgin_conv_window_get_gtkconvs(win), (GFunc)attach_to_gtkconv, NULL);
g_signal_connect(G_OBJECT(win->window), "focus_out_event",
G_CALLBACK(focus_removed), win);
g_signal_connect(G_OBJECT(win->notebook), "switch_page",
G_CALLBACK(page_switched), win);
gtk_widget_queue_draw(win->window);
}
static void
detach_from_all_windows(void)
{
g_list_foreach(pidgin_conv_windows_get_list(), (GFunc)detach_from_pidgin_window, NULL);
}
static void
attach_to_all_windows(void)
{
g_list_foreach(pidgin_conv_windows_get_list(), (GFunc)attach_to_pidgin_window, NULL);
}
static void
conv_created(PidginConversation *gtkconv, gpointer null)
{
PidginWindow *win;
win = pidgin_conv_get_window(gtkconv);
if (!win)
return;
detach_from_pidgin_window(win, NULL);
attach_to_pidgin_window(win, NULL);
}
static void
jump_to_markerline(PurpleConversation *conv, gpointer null)
{
PidginConversation *gtkconv = PIDGIN_CONVERSATION(conv);
int offset;
GtkTextIter iter;
if (!gtkconv)
return;
offset = GPOINTER_TO_INT(g_object_get_data(G_OBJECT(gtkconv->imhtml), "markerline"));
gtk_text_buffer_get_iter_at_offset(GTK_IMHTML(gtkconv->imhtml)->text_buffer, &iter, offset);
gtk_text_view_scroll_to_iter(GTK_TEXT_VIEW(gtkconv->imhtml), &iter, 0, TRUE, 0, 0);
}
static void
conv_menu_cb(PurpleConversation *conv, GList **list)
{
PurpleConversationType type = purple_conversation_get_type(conv);
gboolean enabled = ((type == PURPLE_CONV_TYPE_IM && purple_prefs_get_bool(PREF_IMS)) ||
(type == PURPLE_CONV_TYPE_CHAT && purple_prefs_get_bool(PREF_CHATS)));
PurpleMenuAction *action = purple_menu_action_new(_("Jump to markerline"),
enabled ? PURPLE_CALLBACK(jump_to_markerline) : NULL, NULL, NULL);
*list = g_list_append(*list, action);
}
static gboolean
plugin_load(PurplePlugin *plugin)
{
attach_to_all_windows();
purple_signal_connect(pidgin_conversations_get_handle(), "conversation-displayed",
plugin, PURPLE_CALLBACK(conv_created), NULL);
purple_signal_connect(purple_conversations_get_handle(), "conversation-extended-menu",
plugin, PURPLE_CALLBACK(conv_menu_cb), NULL);
return TRUE;
}
static gboolean
plugin_unload(PurplePlugin *plugin)
{
detach_from_all_windows();
return TRUE;
}
static PurplePluginPrefFrame *
get_plugin_pref_frame(PurplePlugin *plugin)
{
PurplePluginPrefFrame *frame;
PurplePluginPref *pref;
frame = purple_plugin_pref_frame_new();
pref = purple_plugin_pref_new_with_label(_("Draw Markerline in "));
purple_plugin_pref_frame_add(frame, pref);
pref = purple_plugin_pref_new_with_name_and_label(PREF_IMS,
_("_IM windows"));
purple_plugin_pref_frame_add(frame, pref);
pref = purple_plugin_pref_new_with_name_and_label(PREF_CHATS,
_("C_hat windows"));
purple_plugin_pref_frame_add(frame, pref);
return frame;
}
static PurplePluginUiInfo prefs_info = {
get_plugin_pref_frame,
0,
NULL,
/* padding */
NULL,
NULL,
NULL,
NULL
};
static PurplePluginInfo info = {
PURPLE_PLUGIN_MAGIC, /* Magic */
PURPLE_MAJOR_VERSION, /* Purple Major Version */
PURPLE_MINOR_VERSION, /* Purple Minor Version */
PURPLE_PLUGIN_STANDARD, /* plugin type */
PIDGIN_PLUGIN_TYPE, /* ui requirement */
0, /* flags */
NULL, /* dependencies */
PURPLE_PRIORITY_DEFAULT, /* priority */
PLUGIN_ID, /* plugin id */
PLUGIN_NAME, /* name */
DISPLAY_VERSION, /* version */
PLUGIN_SUMMARY, /* summary */
PLUGIN_DESCRIPTION, /* description */
PLUGIN_AUTHOR, /* author */
PURPLE_WEBSITE, /* website */
plugin_load, /* load */
plugin_unload, /* unload */
NULL, /* destroy */
NULL, /* ui_info */
NULL, /* extra_info */
&prefs_info, /* prefs_info */
NULL, /* actions */
/* padding */
NULL,
NULL,
NULL,
NULL
};
static void
init_plugin(PurplePlugin *plugin)
{
purple_prefs_add_none(PREF_PREFIX);
purple_prefs_add_bool(PREF_IMS, FALSE);
purple_prefs_add_bool(PREF_CHATS, TRUE);
}
PURPLE_INIT_PLUGIN(PLUGIN_STATIC_NAME, init_plugin, info)