HGKeeper

pidgin/pidgin

Fix several leaks in tests

14 months ago, Elliott Sales de Andrade

4e1bf25f5575

Fix several leaks in tests

All of these are specific to tests, not the library code.

For the moment, `protocol_xfer` still leaks connections (and anything they hold on to) because it is very difficult to disentangle them from the connection manager in the partially implemented state they are in.

This fixes leaks of options in the account option test (these two leaks occur for every test since they all leak the option):
```
61 (48 direct, 13 indirect) bytes in 1 blocks are definitely lost in loss record 133 of 276
at 0x4848464: calloc (vg_replace_malloc.c:1340)
by 0x49F75F0: g_malloc0 (gmem.c:163)
by 0x48C3B2E: purple_account_option_new (purpleaccountoption.c:78)
by 0x4014AF: test_purple_account_option_copy_int (test_account_option.c:67)
by 0x4A1CC7D: UnknownInlinedFun (gtestutils.c:2933)
by 0x4A1CC7D: g_test_run_suite_internal (gtestutils.c:3021)
by 0x4A1C9E4: g_test_run_suite_internal (gtestutils.c:3038)
by 0x4A1C9E4: g_test_run_suite_internal (gtestutils.c:3038)
by 0x4A1D181: g_test_run_suite (gtestutils.c:3115)
by 0x4A156EC: UnknownInlinedFun (gtestutils.c:2234)
by 0x4A156EC: g_test_run (gtestutils.c:2221)
by 0x401721: main (test_account_option.c:157)

61 (48 direct, 13 indirect) bytes in 1 blocks are definitely lost in loss record 134 of 276
at 0x4848464: calloc (vg_replace_malloc.c:1340)
by 0x49F75F0: g_malloc0 (gmem.c:163)
by 0x48C3BC7: purple_account_option_copy (purpleaccountoption.c:93)
by 0x4014BF: test_purple_account_option_copy_int (test_account_option.c:68)
by 0x4A1CC7D: UnknownInlinedFun (gtestutils.c:2933)
by 0x4A1CC7D: g_test_run_suite_internal (gtestutils.c:3021)
by 0x4A1C9E4: g_test_run_suite_internal (gtestutils.c:3038)
by 0x4A1C9E4: g_test_run_suite_internal (gtestutils.c:3038)
by 0x4A1D181: g_test_run_suite (gtestutils.c:3115)
by 0x4A156EC: UnknownInlinedFun (gtestutils.c:2234)
by 0x4A156EC: g_test_run (gtestutils.c:2221)
by 0x401721: main (test_account_option.c:157)
```
leaks in the credential manager test (times 3 for read/write/cancel tests):
```
69 (16 direct, 53 indirect) bytes in 1 blocks are definitely lost in loss record 2,427 of 3,503
at 0x484386F: malloc (vg_replace_malloc.c:393)
by 0x4A58168: g_malloc (gmem.c:130)
by 0x4A6FAB5: g_slice_alloc (gslice.c:1074)
by 0x4A700EC: g_slice_alloc0 (gslice.c:1100)
by 0x4A3BECB: g_error_allocate (gerror.c:710)
by 0x4A3C93F: UnknownInlinedFun (gerror.c:724)
by 0x4A3C93F: g_error_new_valist (gerror.c:766)
by 0x4BEE558: g_task_return_new_error (gtask.c:1941)
by 0x48D82C0: purple_credential_manager_read_password_async (purplecredentialmanager.c:492)
by 0x403634: test_purple_credential_manager_no_provider_read_password_idle (test_credential_manager.c:329)
by 0x4A4ECB1: g_idle_dispatch (gmain.c:6124)
by 0x4A4FCBE: UnknownInlinedFun (gmain.c:3444)
by 0x4A4FCBE: g_main_context_dispatch (gmain.c:4162)
by 0x4AA5597: g_main_context_iterate.constprop.0 (gmain.c:4238)
by 0x4A4F28E: g_main_loop_run (gmain.c:4438)
by 0x40369F: test_purple_credential_manager_no_provider_read_password_async (test_credential_manager.c:345)
by 0x4A7DC7D: UnknownInlinedFun (gtestutils.c:2933)
by 0x4A7DC7D: g_test_run_suite_internal (gtestutils.c:3021)
by 0x4A7D9E4: g_test_run_suite_internal (gtestutils.c:3038)
by 0x4A7D9E4: g_test_run_suite_internal (gtestutils.c:3038)
by 0x4A7E181: g_test_run_suite (gtestutils.c:3115)
by 0x4A766EC: UnknownInlinedFun (gtestutils.c:2234)
by 0x4A766EC: g_test_run (gtestutils.c:2221)
by 0x4048F6: main (test_credential_manager.c:695)
```
a leak in the image test:
```
161 bytes in 1 blocks are definitely lost in loss record 260 of 274
at 0x484386F: malloc (vg_replace_malloc.c:393)
by 0x4A55363: g_try_malloc (gmem.c:286)
by 0x4A3D630: UnknownInlinedFun (gfileutils.c:819)
by 0x4A3D630: UnknownInlinedFun (gfileutils.c:924)
by 0x4A3D630: g_file_get_contents (gfileutils.c:1027)
by 0x401890: test_image_new_from_file (test_image.c:144)
by 0x4A7DC7D: UnknownInlinedFun (gtestutils.c:2933)
by 0x4A7DC7D: g_test_run_suite_internal (gtestutils.c:3021)
by 0x4A7D9E4: g_test_run_suite_internal (gtestutils.c:3038)
by 0x4A7E181: g_test_run_suite (gtestutils.c:3115)
by 0x4A766EC: UnknownInlinedFun (gtestutils.c:2234)
by 0x4A766EC: g_test_run (gtestutils.c:2221)
by 0x40195D: main (test_image.c:172)
```
a leak in queued output stream test:
```
72 (40 direct, 32 indirect) bytes in 1 blocks are definitely lost in loss record 219 of 396
at 0x49D51EF: g_type_create_instance (gtype.c:1909)
by 0x49BAC1F: g_object_new_internal (gobject.c:2228)
by 0x49BC247: g_object_new_with_properties (gobject.c:2391)
by 0x49BCFF0: g_object_new (gobject.c:2037)
by 0x402003: test_queued_output_stream_push_bytes_async_error (test_queued_output_stream.c:219)
by 0x4A7DC7D: UnknownInlinedFun (gtestutils.c:2933)
by 0x4A7DC7D: g_test_run_suite_internal (gtestutils.c:3021)
by 0x4A7D9E4: g_test_run_suite_internal (gtestutils.c:3038)
by 0x4A7E181: g_test_run_suite (gtestutils.c:3115)
by 0x4A766EC: UnknownInlinedFun (gtestutils.c:2234)
by 0x4A766EC: g_test_run (gtestutils.c:2221)
by 0x402429: main (test_queued_output_stream.c:280)
```
and protocol xfer tests (times 3 for each test that creates a test protocol object):
```
112 (48 direct, 64 indirect) bytes in 1 blocks are definitely lost in loss record 3,430 of 3,698
at 0x49D51EF: g_type_create_instance (gtype.c:1909)
by 0x49BAC1F: g_object_new_internal (gobject.c:2228)
by 0x49BC247: g_object_new_with_properties (gobject.c:2391)
by 0x49BCFF0: g_object_new (gobject.c:2037)
by 0x40291C: test_purple_protocol_xfer_send_file_func (test_protocol_xfer.c:146)
by 0x4A7DC7D: UnknownInlinedFun (gtestutils.c:2933)
by 0x4A7DC7D: g_test_run_suite_internal (gtestutils.c:3021)
by 0x4A7D9E4: g_test_run_suite_internal (gtestutils.c:3038)
by 0x4A7E181: g_test_run_suite (gtestutils.c:3115)
by 0x4A766EC: UnknownInlinedFun (gtestutils.c:2234)
by 0x4A766EC: g_test_run (gtestutils.c:2221)
by 0x402B64: main (test_protocol_xfer.c:195)
```
and util tests (times 3 for each call to `purple_text_strip_mnemonic` in the test):
```
5 bytes in 1 blocks are definitely lost in loss record 5 of 247
at 0x484386F: malloc (vg_replace_malloc.c:393)
by 0x49F7168: g_malloc (gmem.c:130)
by 0x491975B: purple_text_strip_mnemonic (util.c:895)
by 0x4015B0: test_util_text_strip_mnemonic (test_util.c:49)
by 0x4A1CC7D: UnknownInlinedFun (gtestutils.c:2933)
by 0x4A1CC7D: g_test_run_suite_internal (gtestutils.c:3021)
by 0x4A1C9E4: g_test_run_suite_internal (gtestutils.c:3038)
by 0x4A1C9E4: g_test_run_suite_internal (gtestutils.c:3038)
by 0x4A1D181: g_test_run_suite (gtestutils.c:3115)
by 0x4A156EC: UnknownInlinedFun (gtestutils.c:2234)
by 0x4A156EC: g_test_run (gtestutils.c:2221)
by 0x401901: main (test_util.c:224)
```
and these leaks in any test that initializes the test UI:
```
4,104 bytes in 1 blocks are possibly lost in loss record 3,451 of 3,457
at 0x484386F: malloc (vg_replace_malloc.c:393)
by 0x5235B67: sqlite3MemMalloc.lto_priv.0 (sqlite3.c:25493)
by 0x5232797: UnknownInlinedFun (sqlite3.c:29181)
by 0x5232797: UnknownInlinedFun (sqlite3.c:29227)
by 0x5232797: sqlite3Malloc.lto_priv.0 (sqlite3.c:29221)
by 0x523BD8B: pcache1Alloc.lto_priv.0 (sqlite3.c:53546)
by 0x5249A8B: UnknownInlinedFun (sqlite3.c:53675)
by 0x5249A8B: allocateTempSpace (sqlite3.c:70848)
by 0x52625A6: sqlite3VdbeExec.lto_priv.0 (sqlite3.c:93857)
by 0x525CBEE: UnknownInlinedFun (sqlite3.c:87995)
by 0x525CBEE: UnknownInlinedFun (sqlite3.c:88056)
by 0x525CBEE: sqlite3_step (sqlite3.c:88045)
by 0x529B324: sqlite3_exec (sqlite3.c:131002)
by 0x48FD558: purple_sqlite3_run_migration (purplesqlite3.c:37)
by 0x48FDBB4: purple_sqlite3_run_migrations_from_resources (purplesqlite3.c:195)
by 0x48FDED9: purple_sqlite_history_adapter_run_migrations (purplesqlitehistoryadapter.c:69)
by 0x48FE7F0: purple_sqlite_history_adapter_activate (purplesqlitehistoryadapter.c:287)
by 0x48DB656: purple_history_adapter_activate (purplehistoryadapter.c:181)
by 0x48DC9BC: purple_history_manager_set_active (purplehistorymanager.c:308)
by 0x402BA8: test_ui_init_history (test_ui.c:132)
by 0x402C80: test_ui_purple_init (test_ui.c:167)
by 0x4027BB: main (test_contact.c:88)

4,368 bytes in 1 blocks are possibly lost in loss record 3,453 of 3,457
at 0x484386F: malloc (vg_replace_malloc.c:393)
by 0x5235B67: sqlite3MemMalloc.lto_priv.0 (sqlite3.c:25493)
by 0x5232797: UnknownInlinedFun (sqlite3.c:29181)
by 0x5232797: UnknownInlinedFun (sqlite3.c:29227)
by 0x5232797: sqlite3Malloc.lto_priv.0 (sqlite3.c:29221)
by 0x523BD8B: pcache1Alloc.lto_priv.0 (sqlite3.c:53546)
by 0x5240077: UnknownInlinedFun (sqlite3.c:53634)
by 0x5240077: pcache1FetchStage2 (sqlite3.c:54104)
by 0x5243E9C: UnknownInlinedFun (sqlite3.c:52671)
by 0x5243E9C: getPageNormal.lto_priv.0 (sqlite3.c:60628)
by 0x524A510: UnknownInlinedFun (sqlite3.c:60805)
by 0x524A510: btreeGetPage.lto_priv.0 (sqlite3.c:70289)
by 0x524C2F6: UnknownInlinedFun (sqlite3.c:71257)
by 0x524C2F6: sqlite3BtreeBeginTrans.lto_priv.0 (sqlite3.c:71647)
by 0x5266B3A: sqlite3VdbeExec.lto_priv.0 (sqlite3.c:93532)
by 0x525CBEE: UnknownInlinedFun (sqlite3.c:87995)
by 0x525CBEE: UnknownInlinedFun (sqlite3.c:88056)
by 0x525CBEE: sqlite3_step (sqlite3.c:88045)
by 0x48FD715: purple_sqlite3_get_schema_version (purplesqlite3.c:79)
by 0x48FD9DD: purple_sqlite3_run_migrations_from_resources (purplesqlite3.c:146)
by 0x48FDED9: purple_sqlite_history_adapter_run_migrations (purplesqlitehistoryadapter.c:69)
by 0x48FE7F0: purple_sqlite_history_adapter_activate (purplesqlitehistoryadapter.c:287)
by 0x48DB656: purple_history_adapter_activate (purplehistoryadapter.c:181)
by 0x48DC9BC: purple_history_manager_set_active (purplehistorymanager.c:308)
by 0x402BA8: test_ui_init_history (test_ui.c:132)
by 0x402C80: test_ui_purple_init (test_ui.c:167)
by 0x4027BB: main (test_contact.c:88)

4,368 bytes in 1 blocks are possibly lost in loss record 3,454 of 3,457
at 0x484386F: malloc (vg_replace_malloc.c:393)
by 0x5235B67: sqlite3MemMalloc.lto_priv.0 (sqlite3.c:25493)
by 0x5232797: UnknownInlinedFun (sqlite3.c:29181)
by 0x5232797: UnknownInlinedFun (sqlite3.c:29227)
by 0x5232797: sqlite3Malloc.lto_priv.0 (sqlite3.c:29221)
by 0x523BD8B: pcache1Alloc.lto_priv.0 (sqlite3.c:53546)
by 0x5240077: UnknownInlinedFun (sqlite3.c:53634)
by 0x5240077: pcache1FetchStage2 (sqlite3.c:54104)
by 0x5243E9C: UnknownInlinedFun (sqlite3.c:52671)
by 0x5243E9C: getPageNormal.lto_priv.0 (sqlite3.c:60628)
by 0x52499BC: UnknownInlinedFun (sqlite3.c:60805)
by 0x52499BC: UnknownInlinedFun (sqlite3.c:70289)
by 0x52499BC: btreeGetUnusedPage (sqlite3.c:70432)
by 0x524F504: allocateBtreePage.lto_priv.0 (sqlite3.c:74604)
by 0x5256209: btreeCreateTable.lto_priv.0 (sqlite3.c:77830)
by 0x5265EB2: UnknownInlinedFun (sqlite3.c:77849)
by 0x5265EB2: sqlite3VdbeExec.lto_priv.0 (sqlite3.c:96382)
by 0x525CBEE: UnknownInlinedFun (sqlite3.c:87995)
by 0x525CBEE: UnknownInlinedFun (sqlite3.c:88056)
by 0x525CBEE: sqlite3_step (sqlite3.c:88045)
by 0x529B324: sqlite3_exec (sqlite3.c:131002)
by 0x48FD558: purple_sqlite3_run_migration (purplesqlite3.c:37)
by 0x48FDBB4: purple_sqlite3_run_migrations_from_resources (purplesqlite3.c:195)
by 0x48FDED9: purple_sqlite_history_adapter_run_migrations (purplesqlitehistoryadapter.c:69)
by 0x48FE7F0: purple_sqlite_history_adapter_activate (purplesqlitehistoryadapter.c:287)
by 0x48DB656: purple_history_adapter_activate (purplehistoryadapter.c:181)
by 0x48DC9BC: purple_history_manager_set_active (purplehistorymanager.c:308)
by 0x402BA8: test_ui_init_history (test_ui.c:132)
by 0x402C80: test_ui_purple_init (test_ui.c:167)
by 0x4027BB: main (test_contact.c:88)
```

Testing Done:
Ran tests in valgrind, and all above leaks were gone except for noted `protocol_xfer` issues, and a bunch of leaks of the `PurpleBuddy`-`PurpleContact` compatibility bindings, which will go away in their entirety eventually.

Reviewed at https://reviews.imfreedom.org/r/2385/

/* 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 "request-datasheet.h"

#include "debug.h"

#include "signals.h"

struct _PurpleRequestDatasheet

{

guint col_count;

GArray *col_types;

GArray *col_titles;

GList *actions;

GList *record_list;

GHashTable *record_li_by_key;

GHashTable *marked_for_rem;

};

struct _PurpleRequestDatasheetRecord

{

PurpleRequestDatasheet *sheet;

gpointer key;

gchar **data; /* at this point, there is only string data possible */

};

struct _PurpleRequestDatasheetAction

{

gchar *label;

PurpleRequestDatasheetActionCb cb;

gpointer cb_data;

PurpleRequestDatasheetActionCheckCb sens_cb;

gpointer sens_data;

};

static void

purple_request_datasheet_record_free(PurpleRequestDatasheetRecord *rec);

/***** Datasheet API **********************************************************/

PurpleRequestDatasheet *

purple_request_datasheet_new(void)

{

PurpleRequestDatasheet *sheet;

sheet = g_new0(PurpleRequestDatasheet, 1);

sheet->col_types = g_array_new(FALSE, FALSE,

sizeof(PurpleRequestDatasheetColumnType));

sheet->col_titles = g_array_new(FALSE, FALSE, sizeof(gchar *));

/* XXX: use g_array_set_clear_func when we depend on Glib 2.32 */

sheet->record_li_by_key = g_hash_table_new(g_direct_hash, g_direct_equal);

purple_signal_register(sheet, "record-changed",

purple_marshal_VOID__POINTER_POINTER, G_TYPE_NONE, 2,

G_TYPE_POINTER, /* (PurpleRequestDatasheet *) */

G_TYPE_POINTER); /* NULL for all */

purple_signal_register(sheet, "destroy",

purple_marshal_VOID__POINTER, G_TYPE_NONE, 1,

G_TYPE_POINTER); /* (PurpleRequestDatasheet *) */

return sheet;

}

void

purple_request_datasheet_free(PurpleRequestDatasheet *sheet)

{

guint i;

g_return_if_fail(sheet != NULL);

purple_signal_emit(sheet, "destroy", sheet);

purple_signals_unregister_by_instance(sheet);

for (i = 0; i < sheet->col_titles->len; i++)

g_free(g_array_index(sheet->col_titles, gchar *, i));

g_array_free(sheet->col_titles, TRUE);

g_array_free(sheet->col_types, TRUE);

g_list_free_full(sheet->actions,

(GDestroyNotify)purple_request_datasheet_action_free);

g_hash_table_destroy(sheet->record_li_by_key);

g_list_free_full(sheet->record_list,

(GDestroyNotify)purple_request_datasheet_record_free);

g_clear_pointer(&sheet->marked_for_rem, g_hash_table_destroy);

g_free(sheet);

}

void

purple_request_datasheet_add_column(PurpleRequestDatasheet *sheet,

PurpleRequestDatasheetColumnType type, const gchar *title)

{

gchar *title_clone;

g_return_if_fail(sheet != NULL);

if (sheet->record_list != NULL) {

purple_debug_error("request-datasheet", "Cannot modify model "

"when there is already some data");

return;

}

title_clone = g_strdup(title);

sheet->col_count++;

g_array_append_val(sheet->col_types, type);

g_array_append_val(sheet->col_titles, title_clone);

}

guint

purple_request_datasheet_get_column_count(PurpleRequestDatasheet *sheet)

{

g_return_val_if_fail(sheet != NULL, 0);

return sheet->col_count;

/*return sheet->col_types->len;*/

}

PurpleRequestDatasheetColumnType

purple_request_datasheet_get_column_type(PurpleRequestDatasheet *sheet,

guint col_no)

{

g_return_val_if_fail(sheet != NULL, 0);

return g_array_index(sheet->col_types,

PurpleRequestDatasheetColumnType, col_no);

}

const gchar *

purple_request_datasheet_get_column_title(PurpleRequestDatasheet *sheet,

guint col_no)

{

g_return_val_if_fail(sheet != NULL, 0);

return g_array_index(sheet->col_titles, gchar *, col_no);

}

const GList *

purple_request_datasheet_get_records(PurpleRequestDatasheet *sheet)

{

g_return_val_if_fail(sheet != NULL, NULL);

return sheet->record_list;

}

void

purple_request_datasheet_add_action(PurpleRequestDatasheet *sheet,

PurpleRequestDatasheetAction *action)

{

g_return_if_fail(sheet != NULL);

g_return_if_fail(action != NULL);

sheet->actions = g_list_append(sheet->actions, action);

}

const GList *

purple_request_datasheet_get_actions(PurpleRequestDatasheet *sheet)

{

g_return_val_if_fail(sheet != NULL, NULL);

return sheet->actions;

}

/***** Datasheet actions API **************************************************/

PurpleRequestDatasheetAction *

purple_request_datasheet_action_new(void)

{

return g_new0(PurpleRequestDatasheetAction, 1);

}

void

purple_request_datasheet_action_free(PurpleRequestDatasheetAction *act)

{

g_return_if_fail(act != NULL);

g_free(act->label);

g_free(act);

}

void

purple_request_datasheet_action_set_label(PurpleRequestDatasheetAction *act,

const gchar *label)

{

gchar *new_label;

g_return_if_fail(act != NULL);

new_label = g_strdup(label);

g_free(act->label);

act->label = new_label;

}

const gchar*

purple_request_datasheet_action_get_label(PurpleRequestDatasheetAction *act)

{

g_return_val_if_fail(act != NULL, NULL);

return act->label;

}

void

purple_request_datasheet_action_set_cb(PurpleRequestDatasheetAction *act,

PurpleRequestDatasheetActionCb cb, gpointer user_data)

{

g_return_if_fail(act != NULL);

act->cb = cb;

act->cb_data = user_data;

}

void

purple_request_datasheet_action_call(PurpleRequestDatasheetAction *act,

PurpleRequestDatasheetRecord *rec)

{

g_return_if_fail(act != NULL);

if (!act->cb)

return;

if (!purple_request_datasheet_action_is_sensitive(act, rec)) {

purple_debug_warning("request-datasheet",

"Action is disabled for this record");

return;

}

act->cb(rec, act->cb_data);

}

void

purple_request_datasheet_action_set_sens_cb(

PurpleRequestDatasheetAction *act,

PurpleRequestDatasheetActionCheckCb cb, gpointer user_data)

{

g_return_if_fail(act != NULL);

act->sens_cb = cb;

act->sens_data = user_data;

}

gboolean

purple_request_datasheet_action_is_sensitive(PurpleRequestDatasheetAction *act,

PurpleRequestDatasheetRecord *rec)

{

g_return_val_if_fail(act != NULL, FALSE);

if (!act->sens_cb)

return (rec != NULL);

return act->sens_cb(rec, act->sens_data);

}

/***** Datasheet record API ***************************************************/

static PurpleRequestDatasheetRecord *

purple_request_datasheet_record_new(void)

{

return g_new0(PurpleRequestDatasheetRecord, 1);

}

static void

purple_request_datasheet_record_free(PurpleRequestDatasheetRecord *rec)

{

g_strfreev(rec->data);

g_free(rec);

}

gpointer

purple_request_datasheet_record_get_key(const PurpleRequestDatasheetRecord *rec)

{

g_return_val_if_fail(rec != NULL, NULL);

return rec->key;

}

PurpleRequestDatasheet *

purple_request_datasheet_record_get_datasheet(

PurpleRequestDatasheetRecord *rec)

{

g_return_val_if_fail(rec != NULL, NULL);

return rec->sheet;

}

PurpleRequestDatasheetRecord *

purple_request_datasheet_record_find(PurpleRequestDatasheet *sheet,

gpointer key)

{

GList *it;

g_return_val_if_fail(sheet != NULL, NULL);

it = g_hash_table_lookup(sheet->record_li_by_key, key);

if (!it)

return NULL;

return it->data;

}

PurpleRequestDatasheetRecord *

purple_request_datasheet_record_add(PurpleRequestDatasheet *sheet,

gpointer key)

{

PurpleRequestDatasheetRecord *rec;

g_return_val_if_fail(sheet != NULL, NULL);

rec = purple_request_datasheet_record_find(sheet, key);

if (rec != NULL) {

if (sheet->marked_for_rem != NULL)

g_hash_table_remove(sheet->marked_for_rem, key);

return rec;

}

rec = purple_request_datasheet_record_new();

rec->sheet = sheet;

rec->key = key;

/* We don't allow modifying column count when datasheet contains any

* records. */

rec->data = g_new0(gchar*,

purple_request_datasheet_get_column_count(sheet) + 1);

sheet->record_list = g_list_append(sheet->record_list, rec);

g_hash_table_insert(sheet->record_li_by_key, key,

g_list_find(sheet->record_list, rec));

purple_signal_emit(sheet, "record-changed", sheet, key);

return rec;

}

void

purple_request_datasheet_record_remove(PurpleRequestDatasheet *sheet,

gpointer key)

{

GList *it;

g_return_if_fail(sheet != NULL);

it = g_hash_table_lookup(sheet->record_li_by_key, key);

if (it == NULL)

return;

purple_request_datasheet_record_free(it->data);

sheet->record_list = g_list_delete_link(sheet->record_list, it);

g_hash_table_remove(sheet->record_li_by_key, key);

purple_signal_emit(sheet, "record-changed", sheet, key);

}

void

purple_request_datasheet_record_remove_all(PurpleRequestDatasheet *sheet)

{

g_return_if_fail(sheet != NULL);

g_clear_list(&sheet->record_list,

(GDestroyNotify)purple_request_datasheet_record_free);

g_hash_table_remove_all(sheet->record_li_by_key);

purple_signal_emit(sheet, "record-changed", sheet, NULL);

}

void

purple_request_datasheet_record_mark_all_for_rem(PurpleRequestDatasheet *sheet)

{

const GList *it;

g_clear_pointer(&sheet->marked_for_rem, g_hash_table_destroy);

sheet->marked_for_rem = g_hash_table_new(g_direct_hash, g_direct_equal);

it = purple_request_datasheet_get_records(sheet);

for (; it != NULL; it = g_list_next(it)) {

PurpleRequestDatasheetRecord *rec = it->data;

gpointer key = purple_request_datasheet_record_get_key(rec);

g_hash_table_insert(sheet->marked_for_rem, key, key);

}

void

purple_request_datasheet_record_remove_marked(PurpleRequestDatasheet *sheet)

{

GHashTableIter it;

gpointer key;

GHashTable *rem;

if (sheet->marked_for_rem == NULL)

return;

rem = sheet->marked_for_rem;

sheet->marked_for_rem = NULL;

g_hash_table_iter_init(&it, rem);

while (g_hash_table_iter_next(&it, &key, NULL))

purple_request_datasheet_record_remove(sheet, key);

g_hash_table_destroy(rem);

}

static void

purple_request_datasheet_record_set_common_data(

PurpleRequestDatasheetRecord *rec, guint col_no, const gchar *data)

{

g_return_if_fail(rec != NULL);

g_return_if_fail(

purple_request_datasheet_get_column_count(rec->sheet) > col_no);

if (g_strcmp0(rec->data[col_no], data) == 0)

return;

/* we assume, model hasn't changed */

g_free(rec->data[col_no]);

rec->data[col_no] = g_strdup(data);

purple_signal_emit(rec->sheet, "record-changed", rec->sheet, rec->key);

}

void

purple_request_datasheet_record_set_string_data(

PurpleRequestDatasheetRecord *rec, guint col_no, const gchar *data)

{

g_return_if_fail(rec != NULL);

g_return_if_fail(purple_request_datasheet_get_column_type(rec->sheet,

col_no) == PURPLE_REQUEST_DATASHEET_COLUMN_STRING);

purple_request_datasheet_record_set_common_data(rec, col_no, data);

}

void

purple_request_datasheet_record_set_image_data(

PurpleRequestDatasheetRecord *rec, guint col_no, const gchar *stock_id)

{

g_return_if_fail(rec != NULL);

g_return_if_fail(purple_request_datasheet_get_column_type(rec->sheet,

col_no) == PURPLE_REQUEST_DATASHEET_COLUMN_IMAGE);

purple_request_datasheet_record_set_common_data(rec, col_no, stock_id);

}

static const gchar *

purple_request_datasheet_record_get_common_data(

const PurpleRequestDatasheetRecord *rec, guint col_no)

{

g_return_val_if_fail(rec != NULL, NULL);

g_return_val_if_fail(

purple_request_datasheet_get_column_count(rec->sheet) > col_no,

NULL);

return rec->data[col_no];

}

const gchar *

purple_request_datasheet_record_get_string_data(

const PurpleRequestDatasheetRecord *rec, guint col_no)

{

g_return_val_if_fail(rec != NULL, NULL);

g_return_val_if_fail(purple_request_datasheet_get_column_type(

rec->sheet, col_no) == PURPLE_REQUEST_DATASHEET_COLUMN_STRING,

NULL);

return purple_request_datasheet_record_get_common_data(rec, col_no);

}

const gchar *

purple_request_datasheet_record_get_image_data(

const PurpleRequestDatasheetRecord *rec, guint col_no)

{

g_return_val_if_fail(rec != NULL, NULL);

g_return_val_if_fail(purple_request_datasheet_get_column_type(

rec->sheet, col_no) == PURPLE_REQUEST_DATASHEET_COLUMN_IMAGE,

NULL);

return purple_request_datasheet_record_get_common_data(rec, col_no);

}