pidgin/pidgin

Remove a parameter from a doc comment on purple_presence_set_idle which was missed
default tip
7 hours ago, Gary Kramlich
efc29eab5d95
Remove a parameter from a doc comment on purple_presence_set_idle which was missed

Testing Done:
Had the turtles do their thing. Also verified the warning was gone.

Reviewed at https://reviews.imfreedom.org/r/3159/
/*
* Purple - Internet Messaging Library
* Copyright (C) Pidgin Developers <devel@pidgin.im>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, see <https://www.gnu.org/licenses/>.
*/
#include <glib.h>
#include <purple.h>
#include "test_ui.h"
#define PURPLE_GLOBAL_HEADER_INSIDE
#include "../purpleprivate.h"
#undef PURPLE_GLOBAL_HEADER_INSIDE
/******************************************************************************
* TestPurpleHistoryAdapter
*****************************************************************************/
#define TEST_PURPLE_TYPE_HISTORY_ADAPTER \
(test_purple_history_adapter_get_type())
G_DECLARE_FINAL_TYPE(TestPurpleHistoryAdapter,
test_purple_history_adapter,
TEST_PURPLE, HISTORY_ADAPTER,
PurpleHistoryAdapter)
struct _TestPurpleHistoryAdapter {
PurpleHistoryAdapter parent;
gboolean activate;
gboolean deactivate;
gboolean query;
gboolean remove;
gboolean write;
};
G_DEFINE_FINAL_TYPE(TestPurpleHistoryAdapter,
test_purple_history_adapter,
PURPLE_TYPE_HISTORY_ADAPTER)
static gboolean
test_purple_history_adapter_activate(PurpleHistoryAdapter *a,
G_GNUC_UNUSED GError **error)
{
TestPurpleHistoryAdapter *adapter = TEST_PURPLE_HISTORY_ADAPTER(a);
adapter->activate = TRUE;
return TRUE;
}
static gboolean
test_purple_history_adapter_deactivate(PurpleHistoryAdapter *a,
G_GNUC_UNUSED GError **error)
{
TestPurpleHistoryAdapter *adapter = TEST_PURPLE_HISTORY_ADAPTER(a);
adapter->deactivate = TRUE;
return TRUE;
}
static GList *
test_purple_history_adapter_query(PurpleHistoryAdapter *a,
G_GNUC_UNUSED const gchar *query,
G_GNUC_UNUSED GError **error)
{
TestPurpleHistoryAdapter *adapter = TEST_PURPLE_HISTORY_ADAPTER(a);
GList *list = NULL;
adapter->query = TRUE;
list = g_list_append(list, GINT_TO_POINTER(1));
return list;
}
static gboolean
test_purple_history_adapter_remove(PurpleHistoryAdapter *a,
G_GNUC_UNUSED const gchar *query,
G_GNUC_UNUSED GError **error)
{
TestPurpleHistoryAdapter *adapter = TEST_PURPLE_HISTORY_ADAPTER(a);
adapter->remove = TRUE;
return TRUE;
}
static gboolean
test_purple_history_adapter_write(PurpleHistoryAdapter *a,
G_GNUC_UNUSED PurpleConversation *conversation,
G_GNUC_UNUSED PurpleMessage *message,
G_GNUC_UNUSED GError **error)
{
TestPurpleHistoryAdapter *adapter = TEST_PURPLE_HISTORY_ADAPTER(a);
adapter->write = TRUE;
return TRUE;
}
static void
test_purple_history_adapter_init(G_GNUC_UNUSED TestPurpleHistoryAdapter *adapter) {
}
static void
test_purple_history_adapter_class_init(TestPurpleHistoryAdapterClass *klass) {
PurpleHistoryAdapterClass *adapter_class = NULL;
adapter_class = PURPLE_HISTORY_ADAPTER_CLASS(klass);
adapter_class->activate = test_purple_history_adapter_activate;
adapter_class->deactivate = test_purple_history_adapter_deactivate;
adapter_class->query = test_purple_history_adapter_query;
adapter_class->remove = test_purple_history_adapter_remove;
adapter_class->write = test_purple_history_adapter_write;
}
static PurpleHistoryAdapter *
test_purple_history_adapter_new(void) {
return g_object_new(
TEST_PURPLE_TYPE_HISTORY_ADAPTER,
"id", "test-adapter",
"name", "Test Adapter",
NULL);
}
/******************************************************************************
* Tests
*****************************************************************************/
static void
test_purple_history_adapter_test_properties(void) {
PurpleHistoryAdapter *adapter = test_purple_history_adapter_new();
g_assert_cmpstr(purple_history_adapter_get_id(adapter),
==,
"test-adapter");
g_assert_cmpstr(purple_history_adapter_get_name(adapter),
==,
"Test Adapter");
g_clear_object(&adapter);
}
static void
test_purple_history_adapter_test_activate(void) {
PurpleHistoryAdapter *adapter = test_purple_history_adapter_new();
TestPurpleHistoryAdapter *ta = TEST_PURPLE_HISTORY_ADAPTER(adapter);
GError *error = NULL;
gboolean result = FALSE;
result = purple_history_adapter_activate(adapter, &error);
g_assert_no_error(error);
g_assert_true(result);
g_assert_true(ta->activate);
g_assert_false(ta->deactivate);
g_assert_false(ta->query);
g_assert_false(ta->remove);
g_assert_false(ta->write);
g_clear_object(&adapter);
}
static void
test_purple_history_adapter_test_deactivate(void) {
PurpleHistoryAdapter *adapter = test_purple_history_adapter_new();
TestPurpleHistoryAdapter *ta = TEST_PURPLE_HISTORY_ADAPTER(adapter);
GError *error = NULL;
gboolean result = FALSE;
result = purple_history_adapter_deactivate(adapter, &error);
g_assert_no_error(error);
g_assert_true(result);
g_assert_false(ta->activate);
g_assert_true(ta->deactivate);
g_assert_false(ta->query);
g_assert_false(ta->remove);
g_assert_false(ta->write);
g_clear_object(&adapter);
}
static void
test_purple_history_adapter_test_query(void) {
PurpleHistoryAdapter *adapter = test_purple_history_adapter_new();
TestPurpleHistoryAdapter *ta = TEST_PURPLE_HISTORY_ADAPTER(adapter);
GError *error = NULL;
GList *result = NULL;
result = purple_history_adapter_query(adapter, "query", &error);
g_assert_no_error(error);
g_assert_nonnull(result);
g_assert_false(ta->activate);
g_assert_false(ta->deactivate);
g_assert_true(ta->query);
g_assert_false(ta->remove);
g_assert_false(ta->write);
g_list_free(result);
g_clear_object(&adapter);
}
static void
test_purple_history_adapter_test_remove(void) {
PurpleHistoryAdapter *adapter = test_purple_history_adapter_new();
TestPurpleHistoryAdapter *ta = TEST_PURPLE_HISTORY_ADAPTER(adapter);
GError *error = NULL;
gboolean result = FALSE;
result = purple_history_adapter_remove(adapter, "query", &error);
g_assert_no_error(error);
g_assert_true(result);
g_assert_false(ta->activate);
g_assert_false(ta->deactivate);
g_assert_false(ta->query);
g_assert_true(ta->remove);
g_assert_false(ta->write);
g_clear_object(&adapter);
}
static void
test_purple_history_adapter_test_write(void) {
PurpleAccount *account = NULL;
PurpleConversation *conversation = NULL;
PurpleConversationManager *conversation_manager = NULL;
PurpleHistoryAdapter *adapter = test_purple_history_adapter_new();
PurpleMessage *message = NULL;
TestPurpleHistoryAdapter *ta = TEST_PURPLE_HISTORY_ADAPTER(adapter);
GError *error = NULL;
gboolean result = FALSE;
message = g_object_new(PURPLE_TYPE_MESSAGE, NULL);
account = purple_account_new("test", "test");
conversation = g_object_new(PURPLE_TYPE_CONVERSATION,
"account", account,
"name", "pidgy",
"type", PURPLE_CONVERSATION_TYPE_DM,
NULL);
result = purple_history_adapter_write(adapter, conversation, message,
&error);
g_assert_no_error(error);
g_assert_true(result);
g_assert_false(ta->activate);
g_assert_false(ta->deactivate);
g_assert_false(ta->query);
g_assert_false(ta->remove);
g_assert_true(ta->write);
g_clear_object(&adapter);
g_clear_object(&message);
/* TODO: Conversations are automatically registered on construction for
* legacy reasons, so we need to explicitly unregister to clean them up,
* but this can go away once that stops happening. */
conversation_manager = purple_conversation_manager_get_default();
purple_conversation_manager_unregister(conversation_manager, conversation);
g_clear_object(&conversation);
g_clear_object(&account);
}
/******************************************************************************
* Main
*****************************************************************************/
gint
main(gint argc, gchar *argv[]) {
gint ret = 0;
g_test_init(&argc, &argv, NULL);
test_ui_purple_init();
g_test_add_func("/history-adapter/properties",
test_purple_history_adapter_test_properties);
g_test_add_func("/history-adapter/activate",
test_purple_history_adapter_test_activate);
g_test_add_func("/history-adapter/deactivate",
test_purple_history_adapter_test_deactivate);
g_test_add_func("/history-adapter/query",
test_purple_history_adapter_test_query);
g_test_add_func("/history-adapter/remove",
test_purple_history_adapter_test_remove);
g_test_add_func("/history-adapter/write",
test_purple_history_adapter_test_write);
ret = g_test_run();
test_ui_purple_uninit();
return ret;
}