aboutsummaryrefslogtreecommitdiffstats
path: root/e-util/e-table-sort-info.c
blob: 0dce87b329a767b86d9006204864e83af595af8d (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
/*
 * This program 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) version 3.
 *
 * 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with the program; if not, see <http://www.gnu.org/licenses/>
 *
 *
 * Authors:
 *      Chris Lahey <clahey@ximian.com>
 *
 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
 *
 */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include "e-table-sort-info.h"

#include <string.h>

#include "e-xml-utils.h"

#define ETM_CLASS(e) (E_TABLE_SORT_INFO_GET_CLASS (e))

G_DEFINE_TYPE (ETableSortInfo , e_table_sort_info, G_TYPE_OBJECT)

enum {
    SORT_INFO_CHANGED,
    GROUP_INFO_CHANGED,
    LAST_SIGNAL
};

static guint e_table_sort_info_signals[LAST_SIGNAL] = { 0, };

static void
etsi_finalize (GObject *object)
{
    ETableSortInfo *etsi = E_TABLE_SORT_INFO (object);

    if (etsi->groupings)
        g_free (etsi->groupings);
    etsi->groupings = NULL;

    if (etsi->sortings)
        g_free (etsi->sortings);
    etsi->sortings = NULL;

    G_OBJECT_CLASS (e_table_sort_info_parent_class)->finalize (object);
}

static void
e_table_sort_info_init (ETableSortInfo *info)
{
    info->group_count = 0;
    info->groupings = NULL;
    info->sort_count = 0;
    info->sortings = NULL;
    info->frozen = 0;
    info->sort_info_changed = 0;
    info->group_info_changed = 0;
    info->can_group = 1;
}

static void
e_table_sort_info_class_init (ETableSortInfoClass *class)
{
    GObjectClass * object_class = G_OBJECT_CLASS (class);

    object_class->finalize = etsi_finalize;

    e_table_sort_info_signals[SORT_INFO_CHANGED] = g_signal_new (
        "sort_info_changed",
        G_TYPE_FROM_CLASS (object_class),
        G_SIGNAL_RUN_LAST,
        G_STRUCT_OFFSET (ETableSortInfoClass, sort_info_changed),
        (GSignalAccumulator) NULL, NULL,
        g_cclosure_marshal_VOID__VOID,
        G_TYPE_NONE, 0);

    e_table_sort_info_signals[GROUP_INFO_CHANGED] = g_signal_new (
        "group_info_changed",
        G_TYPE_FROM_CLASS (object_class),
        G_SIGNAL_RUN_LAST,
        G_STRUCT_OFFSET (ETableSortInfoClass, group_info_changed),
        (GSignalAccumulator) NULL, NULL,
        g_cclosure_marshal_VOID__VOID,
        G_TYPE_NONE, 0);

    class->sort_info_changed = NULL;
    class->group_info_changed = NULL;
}

static void
e_table_sort_info_sort_info_changed (ETableSortInfo *info)
{
    g_return_if_fail (info != NULL);
    g_return_if_fail (E_IS_TABLE_SORT_INFO (info));

    if (info->frozen) {
        info->sort_info_changed = 1;
    } else {
        g_signal_emit (info, e_table_sort_info_signals[SORT_INFO_CHANGED], 0);
    }
}

static void
e_table_sort_info_group_info_changed (ETableSortInfo *info)
{
    g_return_if_fail (info != NULL);
    g_return_if_fail (E_IS_TABLE_SORT_INFO (info));

    if (info->frozen) {
        info->group_info_changed = 1;
    } else {
        g_signal_emit (info, e_table_sort_info_signals[GROUP_INFO_CHANGED], 0);
    }
}

/**
 * e_table_sort_info_freeze:
 * @info: The ETableSortInfo object
 *
 * This functions allows the programmer to cluster various changes to the
 * ETableSortInfo (grouping and sorting) without having the object emit
 * "group_info_changed" or "sort_info_changed" signals on each change.
 *
 * To thaw, invoke the e_table_sort_info_thaw() function, which will
 * trigger any signals that might have been queued.
 */
void
e_table_sort_info_freeze (ETableSortInfo *info)
{
    info->frozen++;
}

/**
 * e_table_sort_info_thaw:
 * @info: The ETableSortInfo object
 *
 * This functions allows the programmer to cluster various changes to the
 * ETableSortInfo (grouping and sorting) without having the object emit
 * "group_info_changed" or "sort_info_changed" signals on each change.
 *
 * This function will flush any pending signals that might be emited by
 * this object.
 */
void
e_table_sort_info_thaw (ETableSortInfo *info)
{
    info->frozen--;
    if (info->frozen != 0)
        return;

    if (info->sort_info_changed) {
        info->sort_info_changed = 0;
        e_table_sort_info_sort_info_changed (info);
    }
    if (info->group_info_changed) {
        info->group_info_changed = 0;
        e_table_sort_info_group_info_changed (info);
    }
}

/**
 * e_table_sort_info_grouping_get_count:
 * @info: The ETableSortInfo object
 *
 * Returns: the number of grouping criteria in the object.
 */
guint
e_table_sort_info_grouping_get_count (ETableSortInfo *info)
{
    if (info->can_group)
        return info->group_count;
    else
        return 0;
}

static void
e_table_sort_info_grouping_real_truncate (ETableSortInfo *info,
                                          gint length)
{
    if (length < info->group_count) {
        info->group_count = length;
    }
    if (length > info->group_count) {
        info->groupings = g_realloc (info->groupings, length * sizeof (ETableSortColumn));
        info->group_count = length;
    }
}

/**
 * e_table_sort_info_grouping_truncate:
 * @info: The ETableSortInfo object
 * @length: position where the truncation happens.
 *
 * This routine can be used to reduce or grow the number of grouping
 * criteria in the object.
 */
void
e_table_sort_info_grouping_truncate (ETableSortInfo *info,
                                     gint length)
{
    e_table_sort_info_grouping_real_truncate (info, length);
    e_table_sort_info_group_info_changed (info);
}

/**
 * e_table_sort_info_grouping_get_nth:
 * @info: The ETableSortInfo object
 * @n: Item information to fetch.
 *
 * Returns: the description of the @n-th grouping criteria in the @info object.
 */
ETableSortColumn
e_table_sort_info_grouping_get_nth (ETableSortInfo *info,
                                    gint n)
{
    if (info->can_group && n < info->group_count) {
        return info->groupings[n];
    } else {
        ETableSortColumn fake = {0, 0};
        return fake;
    }
}

/**
 * e_table_sort_info_grouping_set_nth:
 * @info: The ETableSortInfo object
 * @n: Item information to fetch.
 * @column: new values for the grouping
 *
 * Sets the grouping criteria for index @n to be given by @column (a column number and
 * whether it is ascending or descending).
 */
void
e_table_sort_info_grouping_set_nth (ETableSortInfo *info,
                                    gint n,
                                    ETableSortColumn column)
{
    if (n >= info->group_count) {
        e_table_sort_info_grouping_real_truncate (info, n + 1);
    }
    info->groupings[n] = column;
    e_table_sort_info_group_info_changed (info);
}

/**
 * e_table_sort_info_get_count:
 * @info: The ETableSortInfo object
 *
 * Returns: the number of sorting criteria in the object.
 */
guint
e_table_sort_info_sorting_get_count (ETableSortInfo *info)
{
    return info->sort_count;
}

static void
e_table_sort_info_sorting_real_truncate (ETableSortInfo *info,
                                         gint length)
{
    if (length < info->sort_count) {
        info->sort_count = length;
    }
    if (length > info->sort_count) {
        info->sortings = g_realloc (info->sortings, length * sizeof (ETableSortColumn));
        info->sort_count = length;
    }
}

/**
 * e_table_sort_info_sorting_truncate:
 * @info: The ETableSortInfo object
 * @length: position where the truncation happens.
 *
 * This routine can be used to reduce or grow the number of sort
 * criteria in the object.
 */
void
e_table_sort_info_sorting_truncate (ETableSortInfo *info,
                                    gint length)
{
    e_table_sort_info_sorting_real_truncate  (info, length);
    e_table_sort_info_sort_info_changed (info);
}

/**
 * e_table_sort_info_sorting_get_nth:
 * @info: The ETableSortInfo object
 * @n: Item information to fetch.
 *
 * Returns: the description of the @n-th grouping criteria in the @info object.
 */
ETableSortColumn
e_table_sort_info_sorting_get_nth (ETableSortInfo *info,
                                   gint n)
{
    if (n < info->sort_count) {
        return info->sortings[n];
    } else {
        ETableSortColumn fake = {0, 0};
        return fake;
    }
}

/**
 * e_table_sort_info_sorting_set_nth:
 * @info: The ETableSortInfo object
 * @n: Item information to fetch.
 * @column: new values for the sorting
 *
 * Sets the sorting criteria for index @n to be given by @column (a
 * column number and whether it is ascending or descending).
 */
void
e_table_sort_info_sorting_set_nth (ETableSortInfo *info,
                                   gint n,
                                   ETableSortColumn column)
{
    if (n >= info->sort_count) {
        e_table_sort_info_sorting_real_truncate (info, n + 1);
    }
    info->sortings[n] = column;
    e_table_sort_info_sort_info_changed (info);
}

/**
 * e_table_sort_info_new:
 *
 * This creates a new e_table_sort_info object that contains no
 * grouping and no sorting defined as of yet.  This object is used
 * to keep track of multi-level sorting and multi-level grouping of
 * the ETable.
 *
 * Returns: A new %ETableSortInfo object
 */
ETableSortInfo *
e_table_sort_info_new (void)
{
    return g_object_new (E_TYPE_TABLE_SORT_INFO, NULL);
}

/**
 * e_table_sort_info_load_from_node:
 * @info: The ETableSortInfo object
 * @node: pointer to the xmlNode that describes the sorting and grouping information
 * @state_version:
 *
 * This loads the state for the %ETableSortInfo object @info from the
 * xml node @node.
 */
void
e_table_sort_info_load_from_node (ETableSortInfo *info,
                                  xmlNode *node,
                                  gdouble state_version)
{
    gint i;
    xmlNode *grouping;

    if (state_version <= 0.05) {
        i = 0;
        for (grouping = node->xmlChildrenNode; grouping && !strcmp ((gchar *) grouping->name, "group"); grouping = grouping->xmlChildrenNode) {
            ETableSortColumn column;
            column.column = e_xml_get_integer_prop_by_name (grouping, (const guchar *)"column");
            column.ascending = e_xml_get_bool_prop_by_name (grouping, (const guchar *)"ascending");
            e_table_sort_info_grouping_set_nth (info, i++, column);
        }
        i = 0;
        for (; grouping && !strcmp ((gchar *) grouping->name, "leaf"); grouping = grouping->xmlChildrenNode) {
            ETableSortColumn column;
            column.column = e_xml_get_integer_prop_by_name (grouping, (const guchar *)"column");
            column.ascending = e_xml_get_bool_prop_by_name (grouping, (const guchar *)"ascending");
            e_table_sort_info_sorting_set_nth (info, i++, column);
        }
    } else {
        gint gcnt = 0;
        gint scnt = 0;
        for (grouping = node->children; grouping; grouping = grouping->next) {
            ETableSortColumn column;

            if (grouping->type != XML_ELEMENT_NODE)
                continue;

            if (!strcmp ((gchar *) grouping->name, "group")) {
                column.column = e_xml_get_integer_prop_by_name (grouping, (const guchar *)"column");
                column.ascending = e_xml_get_bool_prop_by_name (grouping, (const guchar *)"ascending");
                e_table_sort_info_grouping_set_nth (info, gcnt++, column);
            } else if (!strcmp ((gchar *) grouping->name, "leaf")) {
                column.column = e_xml_get_integer_prop_by_name (grouping, (const guchar *)"column");
                column.ascending = e_xml_get_bool_prop_by_name (grouping, (const guchar *)"ascending");
                e_table_sort_info_sorting_set_nth (info, scnt++, column);
            }
        }
    }
    g_signal_emit (info, e_table_sort_info_signals[SORT_INFO_CHANGED], 0);
}

/**
 * e_table_sort_info_save_to_node:
 * @info: The ETableSortInfo object
 * @parent: xmlNode that will be hosting the saved state of the @info object.
 *
 * This function is used
 *
 * Returns: the node that has been appended to @parent as a child containing
 * the sorting and grouping information for this ETableSortInfo object.
 */
xmlNode *
e_table_sort_info_save_to_node (ETableSortInfo *info,
                                xmlNode *parent)
{
    xmlNode *grouping;
    gint i;
    const gint sort_count = e_table_sort_info_sorting_get_count (info);
    const gint group_count = e_table_sort_info_grouping_get_count (info);

    grouping = xmlNewChild (parent, NULL, (const guchar *)"grouping", NULL);

    for (i = 0; i < group_count; i++) {
        ETableSortColumn column = e_table_sort_info_grouping_get_nth (info, i);
        xmlNode *new_node = xmlNewChild (grouping, NULL, (const guchar *)"group", NULL);

        e_xml_set_integer_prop_by_name (new_node, (const guchar *)"column", column.column);
        e_xml_set_bool_prop_by_name (new_node, (const guchar *)"ascending", column.ascending);
    }

    for (i = 0; i < sort_count; i++) {
        ETableSortColumn column = e_table_sort_info_sorting_get_nth (info, i);
        xmlNode *new_node = xmlNewChild (grouping, NULL, (const guchar *)"leaf", NULL);

        e_xml_set_integer_prop_by_name (new_node, (const guchar *)"column", column.column);
        e_xml_set_bool_prop_by_name (new_node, (const guchar *)"ascending", column.ascending);
    }

    return grouping;
}

ETableSortInfo *
e_table_sort_info_duplicate (ETableSortInfo *info)
{
    ETableSortInfo *new_info;

    new_info = e_table_sort_info_new ();

    new_info->group_count = info->group_count;
    new_info->groupings = g_new (ETableSortColumn, new_info->group_count);
    memmove (new_info->groupings, info->groupings, sizeof (ETableSortColumn) * new_info->group_count);

    new_info->sort_count = info->sort_count;
    new_info->sortings = g_new (ETableSortColumn, new_info->sort_count);
    memmove (new_info->sortings, info->sortings, sizeof (ETableSortColumn) * new_info->sort_count);

    new_info->can_group = info->can_group;

    return new_info;
}

void
e_table_sort_info_set_can_group (ETableSortInfo *info,
                                 gboolean can_group)
{
    info->can_group = can_group;
}

gboolean
e_table_sort_info_get_can_group (ETableSortInfo *info)
{
    return info->can_group;
}