pidgin/pidgin

Route GLib debug logging directly to the Finch debug window

2021-10-18, Elliott Sales de Andrade
1896a80ff8e3
Route GLib debug logging directly to the Finch debug window

Instead of flowing through purple debug, this merges some bits of the existing GLib log handler, and the purple debug printer.

Testing Done:
Open the Debug window an see some `GLib-*` outputs.

Reviewed at https://reviews.imfreedom.org/r/1057/
/* 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
*/
#if !defined(PIDGIN_GLOBAL_HEADER_INSIDE) && !defined(PIDGIN_COMPILATION)
# error "only <pidgin.h> may be included directly"
#endif
#ifndef _PIDGIN_CONVERSATION_H_
#define _PIDGIN_CONVERSATION_H_
/**
* SECTION:gtkconv
* @section_id: pidgin-gtkconv
* @short_description: <filename>gtkconv.h</filename>
* @title: Conversation API
* @see_also: <link linkend="chapter-signals-gtkconv">Conversation signals</link>
*/
typedef struct _PidginImPane PidginImPane;
typedef struct _PidginChatPane PidginChatPane;
typedef struct _PidginConversation PidginConversation;
/**
* PidginUnseenState:
* @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.
*
* Unseen text states.
*/
typedef enum
{
PIDGIN_UNSEEN_NONE,
PIDGIN_UNSEEN_EVENT,
PIDGIN_UNSEEN_NO_LOG,
PIDGIN_UNSEEN_TEXT,
PIDGIN_UNSEEN_NICK
} 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_NAME_COLUMN,
CHAT_USERS_COLUMNS
};
#define PIDGIN_CONVERSATION(conv) \
((PidginConversation *)g_object_get_data(G_OBJECT(conv), "pidgin"))
#define PIDGIN_IS_PIDGIN_CONVERSATION(conv) \
(purple_conversation_get_ui_ops(conv) == \
pidgin_conversations_get_conv_ui_ops())
#include <purple.h>
#include "gtkconvwin.h"
/**************************************************************************
* Structures
**************************************************************************/
/**
* PidginConversation:
*
* A GTK conversation pane.
*/
struct _PidginConversation
{
PurpleConversation *active_conv;
GList *convs;
GList *send_history;
PidginConvWindow *win;
GtkWidget *tab_cont;
GtkWidget *tabby;
GtkWidget *menu_tabby;
PurpleMessageFlags last_flags;
GtkWidget *history_sw;
GtkWidget *history;
GtkWidget *editor;
GtkWidget *entry;
GtkWidget *close; /* "x" on the tab */
GtkWidget *icon;
GtkWidget *tab_label;
GtkWidget *menu_icon;
GtkWidget *menu_label;
PidginUnseenState unseen_state;
guint unseen_count;
union
{
PidginImPane *im;
PidginChatPane *chat;
} u;
time_t newday;
GtkWidget *infopane;
/* Used when attaching a PidginConversation to a PurpleConversation
* with message history */
int attach_timer;
GList *attach_current;
};
G_BEGIN_DECLS
/**************************************************************************
* GTK Conversation API
**************************************************************************/
/**
* pidgin_conversations_get_conv_ui_ops:
*
* Returns the UI operations structure for GTK conversations.
*
* Returns: The GTK conversation operations structure.
*/
PurpleConversationUiOps *pidgin_conversations_get_conv_ui_ops(void);
/**
* pidgin_conv_switch_active_conversation:
* @conv: The conversation
*
* Sets the active conversation within a GTK-conversation.
*/
void pidgin_conv_switch_active_conversation(PurpleConversation *conv);
/**
* pidgin_conv_update_buttons_by_protocol:
* @conv: The conversation.
*
* Updates conversation buttons by protocol.
*/
void pidgin_conv_update_buttons_by_protocol(PurpleConversation *conv);
/**
* pidgin_conversations_get_unseen_all:
* @min_state: The minimum unseen state.
* @max_count: Maximum number of conversations to return, or 0 for
* no maximum.
*
* Returns a list of conversations of any 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.
*
* Returns: (transfer container) (element-type PurpleConversation): List of PurpleConversation matching criteria, or %NULL.
*/
GList *
pidgin_conversations_get_unseen_all(PidginUnseenState min_state, guint max_count);
/**
* pidgin_conversations_fill_menu:
* @menu: Menu widget to add items to.
* @convs: (element-type PurpleConversation): List of PurpleConversation to add to menu.
*
* Fill a menu with a list of conversations. Clicking the conversation
* menu item will present that conversation to the user.
*
* Returns: Number of conversations added to menu.
*/
guint
pidgin_conversations_fill_menu(GtkWidget *menu, GList *convs);
/**
* pidgin_conv_present_conversation:
* @conv: The conversation.
*
* Presents a purple conversation to the user.
*/
void pidgin_conv_present_conversation(PurpleConversation *conv);
/**
* pidgin_conv_attach_to_conversation:
* @conv: The conversation.
*
* Reattach Pidgin UI to a conversation.
*
* Returns: Whether Pidgin UI was successfully attached.
*/
gboolean pidgin_conv_attach_to_conversation(PurpleConversation *conv);
/**
* pidgin_conv_get_window:
* @gtkconv: The GTK conversation.
*
* Returns: The window the conversation belongs to.
*/
PidginConvWindow *pidgin_conv_get_window(PidginConversation *gtkconv);
/**
* pidgin_conv_new:
* @conv: The conversation.
*
* Creates a new GTK conversation for a given #PurpleConversation.
*/
void pidgin_conv_new(PurpleConversation *conv);
/**
* pidgin_conv_get_tab_at_xy:
* @win: The conversation window.
* @x: X-coordinate to look up.
* @y: Y-coordinate to look up.
* @to_right: (out): Return address for a boolean which will be %TRUE if the
* coordinates are on the right side of the tab (or bottom in case of
* a vertical notebook), %FALSE otherwise.
*
* Returns: The tab index of a conversation in @win at (@x, @y).
*/
int pidgin_conv_get_tab_at_xy(PidginConvWindow *win, int x, int y, gboolean *to_right);
/**************************************************************************/
/* GTK Conversations Subsystem */
/**************************************************************************/
/**
* pidgin_conversations_get_handle:
*
* Returns the gtk conversations subsystem handle.
*
* Returns: The conversations subsystem handle.
*/
void *pidgin_conversations_get_handle(void);
/**
* pidgin_conversations_init:
*
* Initializes the GTK conversations subsystem.
*/
void pidgin_conversations_init(void);
/**
* pidgin_conversations_uninit:
*
* Uninitialized the GTK conversation subsystem.
*/
void pidgin_conversations_uninit(void);
G_END_DECLS
#endif /* _PIDGIN_CONVERSATION_H_ */