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 debug.c Debug API
* @ingroup core
*/
/* purple
*
* 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, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
#include "internal.h"
#include "debug.h"
#include "prefs.h"
#include "util.h"
static PurpleDebugUiOps *debug_ui_ops = NULL;
/*
* This determines whether debug info should be written to the
* console or not.
*
* It doesn't make sense to make this a normal Purple preference
* because it's a command line option. This will always be FALSE,
* unless the user explicitly started the UI with the -d flag.
* It doesn't matter what this value was the last time Purple was
* started, so it doesn't make sense to save it in prefs.
*/
static gboolean debug_enabled = FALSE;
/*
* These determine whether verbose or unsafe debugging are desired. I
* don't want to make these purple preferences because their values should
* not be remembered across instances of the UI.
*/
static gboolean debug_verbose = FALSE;
static gboolean debug_unsafe = FALSE;
static void
purple_debug_vargs(PurpleDebugLevel level, const char *category,
const char *format, va_list args)
{
PurpleDebugUiOps *ops;
char *arg_s = NULL;
g_return_if_fail(level != PURPLE_DEBUG_ALL);
g_return_if_fail(format != NULL);
ops = purple_debug_get_ui_ops();
if (!debug_enabled && ((ops == NULL) || (ops->print == NULL) ||
(ops->is_enabled && !ops->is_enabled(level, category))))
return;
arg_s = g_strdup_vprintf(format, args);
if (debug_enabled) {
gchar *ts_s;
const char *mdate;
time_t mtime = time(NULL);
mdate = purple_utf8_strftime("%H:%M:%S", localtime(&mtime));
ts_s = g_strdup_printf("(%s) ", mdate);
if (category == NULL)
g_print("%s%s", ts_s, arg_s);
else
g_print("%s%s: %s", ts_s, category, arg_s);
g_free(ts_s);
}
if (ops != NULL && ops->print != NULL)
ops->print(level, category, arg_s);
g_free(arg_s);
}
void
purple_debug(PurpleDebugLevel level, const char *category,
const char *format, ...)
{
va_list args;
g_return_if_fail(level != PURPLE_DEBUG_ALL);
g_return_if_fail(format != NULL);
va_start(args, format);
purple_debug_vargs(level, category, format, args);
va_end(args);
}
void
purple_debug_misc(const char *category, const char *format, ...)
{
va_list args;
g_return_if_fail(format != NULL);
va_start(args, format);
purple_debug_vargs(PURPLE_DEBUG_MISC, category, format, args);
va_end(args);
}
void
purple_debug_info(const char *category, const char *format, ...)
{
va_list args;
g_return_if_fail(format != NULL);
va_start(args, format);
purple_debug_vargs(PURPLE_DEBUG_INFO, category, format, args);
va_end(args);
}
void
purple_debug_warning(const char *category, const char *format, ...)
{
va_list args;
g_return_if_fail(format != NULL);
va_start(args, format);
purple_debug_vargs(PURPLE_DEBUG_WARNING, category, format, args);
va_end(args);
}
void
purple_debug_error(const char *category, const char *format, ...)
{
va_list args;
g_return_if_fail(format != NULL);
va_start(args, format);
purple_debug_vargs(PURPLE_DEBUG_ERROR, category, format, args);
va_end(args);
}
void
purple_debug_fatal(const char *category, const char *format, ...)
{
va_list args;
g_return_if_fail(format != NULL);
va_start(args, format);
purple_debug_vargs(PURPLE_DEBUG_FATAL, category, format, args);
va_end(args);
}
void
purple_debug_set_enabled(gboolean enabled)
{
debug_enabled = enabled;
}
gboolean
purple_debug_is_enabled()
{
return debug_enabled;
}
void
purple_debug_set_ui_ops(PurpleDebugUiOps *ops)
{
debug_ui_ops = ops;
}
gboolean
purple_debug_is_verbose()
{
return debug_verbose;
}
void
purple_debug_set_verbose(gboolean verbose)
{
debug_verbose = verbose;
}
gboolean
purple_debug_is_unsafe()
{
return debug_unsafe;
}
void
purple_debug_set_unsafe(gboolean unsafe)
{
debug_unsafe = unsafe;
}
PurpleDebugUiOps *
purple_debug_get_ui_ops(void)
{
return debug_ui_ops;
}
void
purple_debug_init(void)
{
/* Read environment variables once per init */
if(g_getenv("PURPLE_UNSAFE_DEBUG"))
purple_debug_set_unsafe(TRUE);
if(g_getenv("PURPLE_VERBOSE_DEBUG"))
purple_debug_set_verbose(TRUE);
purple_prefs_add_none("/purple/debug");
/*
* This pref is obsolete and no longer referenced anywhere. It only
* survives here because it would be an API break if we removed it.
* Remove this when we get to 3.0.0 :)
*/
purple_prefs_add_bool("/purple/debug/timestamps", TRUE);
}