aboutsummaryrefslogtreecommitdiffstats
path: root/widgets/table/e-table-memory-store.c
blob: 00a1ff17af7306b84b6a0c869c952ce4c8e73aaf (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* 
 * e-table-memory-store.c
 * Copyright 2000, 2001, Ximian, Inc.
 *
 * Authors:
 *   Chris Lahey <clahey@ximian.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License, version 2, as published by the Free Software Foundation.
 *
 * 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 * 02111-1307, USA.
 */

#include <config.h>

#include <string.h>

#include "e-util/e-util.h"

#include "e-table-memory-store.h"

#define STORE_LOCATOR(etms, col, row) (*((etms)->priv->store + (row) * (etms)->priv->col_count + (col)))

static ETableMemoryClass *parent_class;

struct _ETableMemoryStorePrivate {
    int col_count;
    ETableMemoryStoreColumnInfo *columns;
    void **store;
};

static void *
duplicate_value (ETableMemoryStore *etms, int col, const void *val)
{
    switch (etms->priv->columns[col].type) {
    case E_TABLE_MEMORY_STORE_COLUMN_TYPE_STRING:
        return g_strdup (val);
    case E_TABLE_MEMORY_STORE_COLUMN_TYPE_PIXBUF:
        if (val)
            gdk_pixbuf_ref ((void *) val);
        return (void *) val;
    case E_TABLE_MEMORY_STORE_COLUMN_TYPE_OBJECT:
        if (val)
            g_object_ref ((void *) val);
        return (void *) val;
    case E_TABLE_MEMORY_STORE_COLUMN_TYPE_CUSTOM:
        if (etms->priv->columns[col].custom.duplicate_value)
            return etms->priv->columns[col].custom.duplicate_value (E_TABLE_MODEL (etms), col, val, NULL);
        break;
    default:
        break;
    }
    return (void *) val;
}

static void
free_value (ETableMemoryStore *etms, int col, void *value)
{
    switch (etms->priv->columns[col].type) {
    case E_TABLE_MEMORY_STORE_COLUMN_TYPE_STRING:
        g_free (value);
        break;
    case E_TABLE_MEMORY_STORE_COLUMN_TYPE_PIXBUF:
        if (value)
            gdk_pixbuf_unref (value);
        break;
    case E_TABLE_MEMORY_STORE_COLUMN_TYPE_OBJECT:
        if (value)
            g_object_unref (value);
        break;
    case E_TABLE_MEMORY_STORE_COLUMN_TYPE_CUSTOM:
        if (etms->priv->columns[col].custom.free_value)
            etms->priv->columns[col].custom.free_value (E_TABLE_MODEL (etms), col, value, NULL);
        break;
    default:
        break;
    }
}


static int
etms_column_count (ETableModel *etm)
{
    ETableMemoryStore *etms = E_TABLE_MEMORY_STORE(etm);

    return etms->priv->col_count;
}

static void *
etms_value_at (ETableModel *etm, int col, int row)
{
    ETableMemoryStore *etms = E_TABLE_MEMORY_STORE(etm);

    return STORE_LOCATOR (etms, col, row);
}

static void
etms_set_value_at (ETableModel *etm, int col, int row, const void *val)
{
    ETableMemoryStore *etms = E_TABLE_MEMORY_STORE(etm);

    e_table_model_pre_change (etm);

    STORE_LOCATOR (etms, col, row) = duplicate_value (etms, col, val);

    e_table_model_cell_changed (etm, col, row);
}

static gboolean
etms_is_cell_editable (ETableModel *etm, int col, int row)
{
    ETableMemoryStore *etms = E_TABLE_MEMORY_STORE(etm);

    return etms->priv->columns[col].editable;
}

/* The default for etms_duplicate_value is to return the raw value. */
static void *
etms_duplicate_value (ETableModel *etm, int col, const void *value)
{
    ETableMemoryStore *etms = E_TABLE_MEMORY_STORE(etm);

    return duplicate_value (etms, col, value);
}

static void
etms_free_value (ETableModel *etm, int col, void *value)
{
    ETableMemoryStore *etms = E_TABLE_MEMORY_STORE(etm);

    free_value (etms, col, value);
}

static void *
etms_initialize_value (ETableModel *etm, int col)
{
    ETableMemoryStore *etms = E_TABLE_MEMORY_STORE(etm);
    
    switch (etms->priv->columns[col].type) {
    case E_TABLE_MEMORY_STORE_COLUMN_TYPE_STRING:
        return g_strdup ("");
    case E_TABLE_MEMORY_STORE_COLUMN_TYPE_PIXBUF:
        return NULL;
    case E_TABLE_MEMORY_STORE_COLUMN_TYPE_CUSTOM:
    case E_TABLE_MEMORY_STORE_COLUMN_TYPE_OBJECT:
        if (etms->priv->columns[col].custom.initialize_value)
            return etms->priv->columns[col].custom.initialize_value (E_TABLE_MODEL (etms), col, NULL);
        break;
    default:
        break;
    }
    return 0;
}

static gboolean
etms_value_is_empty (ETableModel *etm, int col, const void *value)
{
    ETableMemoryStore *etms = E_TABLE_MEMORY_STORE(etm);
    
    switch (etms->priv->columns[col].type) {
    case E_TABLE_MEMORY_STORE_COLUMN_TYPE_STRING:
        return !(value && *(char *) value);
    case E_TABLE_MEMORY_STORE_COLUMN_TYPE_PIXBUF:
        return value == NULL;
    case E_TABLE_MEMORY_STORE_COLUMN_TYPE_CUSTOM:
    case E_TABLE_MEMORY_STORE_COLUMN_TYPE_OBJECT:
        if (etms->priv->columns[col].custom.value_is_empty)
            return etms->priv->columns[col].custom.value_is_empty (E_TABLE_MODEL (etms), col, value, NULL);
        break;
    default:
        break;
    }
    return value == 0;
}

static char *
etms_value_to_string (ETableModel *etm, int col, const void *value)
{
    ETableMemoryStore *etms = E_TABLE_MEMORY_STORE(etm);
    
    switch (etms->priv->columns[col].type) {
    case E_TABLE_MEMORY_STORE_COLUMN_TYPE_STRING:
        return g_strdup (value);
    case E_TABLE_MEMORY_STORE_COLUMN_TYPE_PIXBUF:
        return g_strdup ("");
    case E_TABLE_MEMORY_STORE_COLUMN_TYPE_CUSTOM:
    case E_TABLE_MEMORY_STORE_COLUMN_TYPE_OBJECT:
        if (etms->priv->columns[col].custom.value_is_empty)
            return etms->priv->columns[col].custom.value_to_string (E_TABLE_MODEL (etms), col, value, NULL);
        break;
    default:
        break;
    }
    return g_strdup_printf ("%d", GPOINTER_TO_INT (value));
}

static void
etms_append_row (ETableModel *etm, ETableModel *source, int row)
{
    ETableMemoryStore *etms = E_TABLE_MEMORY_STORE(etm);
    void **new_data;
    int i;
    int row_count;

    new_data = g_new (void *, etms->priv->col_count);

    for (i = 0; i < etms->priv->col_count; i++) {
        new_data[i] = e_table_model_value_at (source, i, row);
    }

    row_count = e_table_model_row_count (E_TABLE_MODEL (etms));

    e_table_memory_store_insert_array (etms, row_count, new_data, NULL);
}

static void
etms_finalize (GObject *obj)
{
    ETableMemoryStore *etms = (ETableMemoryStore *) obj;

    if (etms->priv) {
        e_table_memory_store_clear (etms);

        g_free (etms->priv->columns);
        g_free (etms->priv->store);
        g_free (etms->priv);
    }

    if (G_OBJECT_CLASS (parent_class)->finalize)
        G_OBJECT_CLASS (parent_class)->finalize (obj);
}
    
static void
e_table_memory_store_init (ETableMemoryStore *etms)
{
    etms->priv            = g_new (ETableMemoryStorePrivate, 1);

    etms->priv->col_count = 0;
    etms->priv->columns   = NULL;
    etms->priv->store     = NULL;
}

static void
e_table_memory_store_class_init (GObjectClass *object_class)
{
    ETableModelClass *model_class = (ETableModelClass *) object_class;

    parent_class = g_type_class_peek_parent (object_class);

    object_class->finalize        = etms_finalize;

    model_class->column_count     = etms_column_count;
    model_class->value_at         = etms_value_at;
    model_class->set_value_at     = etms_set_value_at;
    model_class->is_cell_editable = etms_is_cell_editable;
    model_class->duplicate_value  = etms_duplicate_value;
    model_class->free_value       = etms_free_value;
    model_class->initialize_value = etms_initialize_value;
    model_class->value_is_empty   = etms_value_is_empty;
    model_class->value_to_string  = etms_value_to_string;
    model_class->append_row       = etms_append_row;
}

E_MAKE_TYPE(e_table_memory_store, "ETableMemoryStore", ETableMemoryStore, e_table_memory_store_class_init, e_table_memory_store_init, E_TABLE_MEMORY_TYPE)

/**
 * e_table_memory_store_new:
 * @col_count:
 * @value_at:
 * @set_value_at:
 * @is_cell_editable:
 * @duplicate_value:
 * @free_value:
 * @initialize_value:
 * @value_is_empty:
 * @value_to_string:
 * @data: closure pointer.
 *
 * This initializes a new ETableMemoryStoreModel object.  ETableMemoryStoreModel is
 * an implementaiton of the abstract class ETableModel.  The ETableMemoryStoreModel
 * is designed to allow people to easily create ETableModels without having
 * to create a new GtkType derived from ETableModel every time they need one.
 *
 * Instead, ETableMemoryStoreModel uses a setup based in callback functions, every
 * callback function signature mimics the signature of each ETableModel method
 * and passes the extra @data pointer to each one of the method to provide them
 * with any context they might want to use. 
 *
 * Returns: An ETableMemoryStoreModel object (which is also an ETableModel
 * object).
 */
ETableModel *
e_table_memory_store_new (ETableMemoryStoreColumnInfo *columns)
{
    ETableMemoryStore *et = g_object_new (E_TABLE_MEMORY_STORE_TYPE, NULL);

    if (e_table_memory_store_construct (et, columns)) {
        return (ETableModel *) et;
    } else {
        g_object_unref (et);
        return NULL;
    }
}

ETableModel *
e_table_memory_store_construct (ETableMemoryStore *etms, ETableMemoryStoreColumnInfo *columns)
{
    int i;
    for (i = 0; columns[i].type != E_TABLE_MEMORY_STORE_COLUMN_TYPE_TERMINATOR; i++)
        /* Intentionally blank */;
    etms->priv->col_count = i;

    etms->priv->columns = g_new (ETableMemoryStoreColumnInfo, etms->priv->col_count + 1);

    memcpy (etms->priv->columns, columns, (etms->priv->col_count + 1) * sizeof (ETableMemoryStoreColumnInfo));

    return E_TABLE_MODEL (etms);
}
                

void
e_table_memory_store_adopt_value_at (ETableMemoryStore *etms, int col, int row, void *value)
{
    e_table_model_pre_change (E_TABLE_MODEL (etms));

    STORE_LOCATOR (etms, col, row) = value;

    e_table_model_cell_changed (E_TABLE_MODEL (etms), col, row);
}

/* The size of these arrays is the number of columns. */
void
e_table_memory_store_insert_array (ETableMemoryStore *etms, int row, void **store, gpointer data)
{
    int row_count;
    int i;

    row_count = e_table_model_row_count (E_TABLE_MODEL (etms)) + 1;
    if (row == -1)
        row = row_count - 1;
    etms->priv->store = g_realloc (etms->priv->store, etms->priv->col_count * row_count * sizeof (void *));
    memmove (etms->priv->store + etms->priv->col_count * (row + 1),
         etms->priv->store + etms->priv->col_count * row,
         etms->priv->col_count * (row_count - row - 1) * sizeof (void *));

    for (i = 0; i < etms->priv->col_count; i++) {
        STORE_LOCATOR(etms, i, row) = duplicate_value(etms, i, store[i]);
    }

    e_table_memory_insert (E_TABLE_MEMORY (etms), row, data);
}

void
e_table_memory_store_insert (ETableMemoryStore *etms, int row, gpointer data, ...)
{
    void **store;
    va_list args;
    int i;

    store = g_new (void *, etms->priv->col_count + 1);

    va_start (args, data);
    for (i = 0; i < etms->priv->col_count; i++) {
        store[i] = va_arg (args, void *);
    }
    va_end (args);

    e_table_memory_store_insert_array (etms, row, store, data);

    g_free (store);
}

void
e_table_memory_store_insert_adopt_array (ETableMemoryStore *etms, int row, void **store, gpointer data)
{
    int row_count;
    int i;

    row_count = e_table_model_row_count (E_TABLE_MODEL (etms)) + 1;
    if (row == -1)
        row = row_count - 1;
    etms->priv->store = g_realloc (etms->priv->store, etms->priv->col_count * row_count * sizeof (void *));
    memmove (etms->priv->store + etms->priv->col_count * (row + 1),
         etms->priv->store + etms->priv->col_count * row,
         etms->priv->col_count * (row_count - row - 1) * sizeof (void *));

    for (i = 0; i < etms->priv->col_count; i++) {
        STORE_LOCATOR(etms, i, row) = store[i];
    }

    e_table_memory_insert (E_TABLE_MEMORY (etms), row, data);
}

void
e_table_memory_store_insert_adopt (ETableMemoryStore *etms, int row, gpointer data, ...)
{
    void **store;
    va_list args;
    int i;

    store = g_new (void *, etms->priv->col_count + 1);

    va_start (args, data);
    for (i = 0; i < etms->priv->col_count; i++) {
        store[i] = va_arg (args, void *);
    }
    va_end (args);

    e_table_memory_store_insert_adopt_array (etms, row, store, data);

    g_free (store);
}

/**
 * e_table_memory_store_change_array:
 * @etms: the ETabelMemoryStore.
 * @row:  the row we're changing.
 * @store: an array of new values to fill the row
 * @data: the new closure to associate with this row.
 *
 * frees existing values associated with a row and replaces them with
 * duplicates of the values in store.
 *
 */
void
e_table_memory_store_change_array (ETableMemoryStore *etms, int row, void **store, gpointer data)
{
    int i;

    g_return_if_fail (row >= 0 && row < e_table_model_row_count (E_TABLE_MODEL (etms)));

    e_table_model_pre_change (E_TABLE_MODEL (etms));

    for (i = 0; i < etms->priv->col_count; i++) {
        free_value (etms, i, STORE_LOCATOR(etms, i, row));
        STORE_LOCATOR(etms, i, row) = duplicate_value(etms, i, store[i]);
    }

    e_table_memory_set_data (E_TABLE_MEMORY (etms), row, data);
    e_table_model_row_changed (E_TABLE_MODEL (etms), row);
}

/**
 * e_table_memory_store_change:
 * @etms: the ETabelMemoryStore.
 * @row:  the row we're changing.
 * @data: the new closure to associate with this row.
 *
 * a varargs version of e_table_memory_store_change_array.  you must
 * pass in etms->col_count args.
 */
void
e_table_memory_store_change (ETableMemoryStore *etms, int row, gpointer data, ...)
{
    void **store;
    va_list args;
    int i;

    g_return_if_fail (row >= 0 && row < e_table_model_row_count (E_TABLE_MODEL (etms)));

    store = g_new0 (void *, etms->priv->col_count + 1);

    va_start (args, data);
    for (i = 0; i < etms->priv->col_count; i++) {
        store[i] = va_arg (args, void *);
    }
    va_end (args);

    e_table_memory_store_change_array (etms, row, store, data);

    g_free (store);
}

/**
 * e_table_memory_store_change_adopt_array:
 * @etms: the ETableMemoryStore
 * @row: the row we're changing.
 * @store: an array of new values to fill the row
 * @data: the new closure to associate with this row.
 *
 * frees existing values for the row and stores the values from store
 * into it.  This function differs from
 * e_table_memory_storage_change_adopt_array in that it does not
 * duplicate the data.
 */
void
e_table_memory_store_change_adopt_array (ETableMemoryStore *etms, int row, void **store, gpointer data)
{
    int i;

    g_return_if_fail (row >= 0 && row < e_table_model_row_count (E_TABLE_MODEL (etms)));

    for (i = 0; i < etms->priv->col_count; i++) {
        free_value (etms, i, STORE_LOCATOR(etms, i, row));
        STORE_LOCATOR(etms, i, row) = store[i];
    }

    e_table_memory_set_data (E_TABLE_MEMORY (etms), row, data);
    e_table_model_row_changed (E_TABLE_MODEL (etms), row);
}

/**
 * e_table_memory_store_change_adopt
 * @etms: the ETabelMemoryStore.
 * @row:  the row we're changing.
 * @data: the new closure to associate with this row.
 *
 * a varargs version of e_table_memory_store_change_adopt_array.  you
 * must pass in etms->col_count args.
 */
void
e_table_memory_store_change_adopt (ETableMemoryStore *etms, int row, gpointer data, ...)
{
    void **store;
    va_list args;
    int i;

    g_return_if_fail (row >= 0 && row < e_table_model_row_count (E_TABLE_MODEL (etms)));

    store = g_new0 (void *, etms->priv->col_count + 1);

    va_start (args, data);
    for (i = 0; i < etms->priv->col_count; i++) {
        store[i] = va_arg (args, void *);
    }
    va_end (args);

    e_table_memory_store_change_adopt_array (etms, row, store, data);

    g_free (store);
}

void
e_table_memory_store_remove (ETableMemoryStore *etms, int row)
{
    ETableModel *model;
    int column_count, row_count;
    int i;

    model = E_TABLE_MODEL (etms);
    column_count = e_table_model_column_count (model);

    for (i = 0; i < column_count; i ++)
        e_table_model_free_value (model, i, e_table_model_value_at (model, i, row));

    row_count = e_table_model_row_count (E_TABLE_MODEL (etms)) - 1;
    memmove (etms->priv->store + etms->priv->col_count * row,
         etms->priv->store + etms->priv->col_count * (row + 1),
         etms->priv->col_count * (row_count - row) * sizeof (void *));
    etms->priv->store = g_realloc (etms->priv->store, etms->priv->col_count * row_count * sizeof (void *));

    e_table_memory_remove (E_TABLE_MEMORY (etms), row);
}

void
e_table_memory_store_clear (ETableMemoryStore *etms)
{
    ETableModel *model;
    int row_count, column_count;
    int i, j;

    model = E_TABLE_MODEL (etms);
    row_count = e_table_model_row_count (model);
    column_count = e_table_model_column_count (model);

    for (i = 0; i < row_count; i ++) {
        for (j = 0; j < column_count; j ++) {
            e_table_model_free_value (model, j, e_table_model_value_at (model, j, i));
        }
    }

    e_table_memory_clear (E_TABLE_MEMORY (etms));

    g_free (etms->priv->store);
    etms->priv->store = NULL;
}