aboutsummaryrefslogtreecommitdiffstats
path: root/widgets/table/e-table-specification.c
blob: 99213ad5012d1d2905e1a24264d5d4fc1b04e60e (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
/*
 * 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)
 *
 */

#include <config.h>

#include <stdlib.h>
#include <string.h>

#include <glib.h>
#include <glib/gstdio.h>
#include <libxml/parser.h>
#include <libxml/xmlmemory.h>

#include <libedataserver/e-xml-utils.h>

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

#include "e-table-specification.h"

/* workaround for avoiding API breakage */
#define etsp_get_type e_table_specification_get_type
G_DEFINE_TYPE (ETableSpecification, etsp, G_TYPE_OBJECT)

static void
etsp_finalize (GObject *object)
{
    ETableSpecification *etsp = E_TABLE_SPECIFICATION (object);
    gint i;

    if (etsp->columns) {
        for (i = 0; etsp->columns[i]; i++) {
            g_object_unref (etsp->columns[i]);
        }
        g_free (etsp->columns);
        etsp->columns = NULL;
    }

    if (etsp->state)
        g_object_unref (etsp->state);
    etsp->state                = NULL;

    g_free (etsp->click_to_add_message);
    etsp->click_to_add_message = NULL;

    g_free (etsp->domain);
    etsp->domain           = NULL;

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

static void
etsp_class_init (ETableSpecificationClass *class)
{
    GObjectClass *object_class = G_OBJECT_CLASS (class);

    object_class->finalize = etsp_finalize;
}

static void
etsp_init (ETableSpecification *etsp)
{
    etsp->columns                = NULL;
    etsp->state                  = NULL;

    etsp->alternating_row_colors = TRUE;
    etsp->no_headers             = FALSE;
    etsp->click_to_add           = FALSE;
    etsp->click_to_add_end       = FALSE;
    etsp->horizontal_draw_grid   = FALSE;
    etsp->vertical_draw_grid     = FALSE;
    etsp->draw_focus             = TRUE;
    etsp->horizontal_scrolling   = FALSE;
    etsp->horizontal_resize      = FALSE;
    etsp->allow_grouping         = TRUE;

    etsp->cursor_mode            = E_CURSOR_SIMPLE;
    etsp->selection_mode         = GTK_SELECTION_MULTIPLE;

    etsp->click_to_add_message   = NULL;
    etsp->domain                 = NULL;
}

/**
 * e_table_specification_new:
 *
 * Creates a new %ETableSpecification object.   This object is used to hold the
 * information about the rendering information for ETable.
 *
 * Returns: a newly created %ETableSpecification object.
 */
ETableSpecification *
e_table_specification_new (void)
{
    ETableSpecification *etsp = g_object_new (E_TYPE_TABLE_SPECIFICATION, NULL);

    return (ETableSpecification *) etsp;
}

/**
 * e_table_specification_load_from_file:
 * @specification: An ETableSpecification that you want to modify
 * @filename: a filename that contains an ETableSpecification
 *
 * This routine modifies @specification to reflect the state described
 * by the file @filename.
 *
 * Returns: TRUE on success, FALSE on failure.
 */
gboolean
e_table_specification_load_from_file (ETableSpecification *specification,
                      const gchar          *filename)
{
    xmlDoc *doc;

    doc = e_xml_parse_file (filename);
    if (doc) {
        xmlNode *node = xmlDocGetRootElement (doc);
        e_table_specification_load_from_node (specification, node);
        xmlFreeDoc (doc);
        return TRUE;
    }
    return FALSE;
}

/**
 * e_table_specification_load_from_string:
 * @specification: An ETableSpecification that you want to modify
 * @xml: a stringified representation of an ETableSpecification description.
 *
 * This routine modifies @specification to reflect the state described
 * by @xml.  @xml is typically returned by e_table_specification_save_to_string
 * or it can be embedded in your source code.
 *
 * Returns: TRUE on success, FALSE on failure.
 */
gboolean
e_table_specification_load_from_string (ETableSpecification *specification,
                    const gchar          *xml)
{
    xmlDoc *doc;
    doc = xmlParseMemory ( (gchar *) xml, strlen (xml));
    if (doc) {
        xmlNode *node = xmlDocGetRootElement (doc);
        e_table_specification_load_from_node (specification, node);
        xmlFreeDoc (doc);
        return TRUE;
    }

    return FALSE;
}

/**
 * e_table_specification_load_from_node:
 * @specification: An ETableSpecification that you want to modify
 * @node: an xmlNode with an XML ETableSpecification description.
 *
 * This routine modifies @specification to reflect the state described
 * by @node.
 */
void
e_table_specification_load_from_node (ETableSpecification *specification,
                      const xmlNode       *node)
{
    gchar *temp;
    xmlNode *children;
    GList *list = NULL, *list2;
    gint i;

    specification->no_headers = e_xml_get_bool_prop_by_name (node, (const guchar *)"no-headers");
    specification->click_to_add = e_xml_get_bool_prop_by_name (node, (const guchar *)"click-to-add");
    specification->click_to_add_end = e_xml_get_bool_prop_by_name (node, (const guchar *)"click-to-add-end") && specification->click_to_add;
    specification->alternating_row_colors = e_xml_get_bool_prop_by_name_with_default (node, (const guchar *)"alternating-row-colors", TRUE);
    specification->horizontal_draw_grid = e_xml_get_bool_prop_by_name (node, (const guchar *)"horizontal-draw-grid");
    specification->vertical_draw_grid = e_xml_get_bool_prop_by_name (node, (const guchar *)"vertical-draw-grid");
    if (e_xml_get_bool_prop_by_name_with_default(node, (const guchar *)"draw-grid", TRUE) ==
        e_xml_get_bool_prop_by_name_with_default(node, (const guchar *)"draw-grid", FALSE)) {
        specification->horizontal_draw_grid =
            specification->vertical_draw_grid = e_xml_get_bool_prop_by_name (node, (const guchar *)"draw-grid");
    }
    specification->draw_focus = e_xml_get_bool_prop_by_name_with_default (node, (const guchar *)"draw-focus", TRUE);
    specification->horizontal_scrolling = e_xml_get_bool_prop_by_name_with_default (node, (const guchar *)"horizontal-scrolling", FALSE);
    specification->horizontal_resize = e_xml_get_bool_prop_by_name_with_default (node, (const guchar *)"horizontal-resize", FALSE);
    specification->allow_grouping = e_xml_get_bool_prop_by_name_with_default (node, (const guchar *)"allow-grouping", TRUE);

    specification->selection_mode = GTK_SELECTION_MULTIPLE;
    temp = e_xml_get_string_prop_by_name (node, (const guchar *)"selection-mode");
    if (temp && !g_ascii_strcasecmp (temp, "single")) {
        specification->selection_mode = GTK_SELECTION_SINGLE;
    } else if (temp && !g_ascii_strcasecmp (temp, "browse")) {
        specification->selection_mode = GTK_SELECTION_BROWSE;
    } else if (temp && !g_ascii_strcasecmp (temp, "extended")) {
        specification->selection_mode = GTK_SELECTION_EXTENDED;
    }
    g_free (temp);

    specification->cursor_mode = E_CURSOR_SIMPLE;
    temp = e_xml_get_string_prop_by_name (node, (const guchar *)"cursor-mode");
    if (temp && !g_ascii_strcasecmp (temp, "line")) {
        specification->cursor_mode = E_CURSOR_LINE;
    } else  if (temp && !g_ascii_strcasecmp (temp, "spreadsheet")) {
        specification->cursor_mode = E_CURSOR_SPREADSHEET;
    }
    g_free (temp);

    g_free (specification->click_to_add_message);
    specification->click_to_add_message =
        e_xml_get_string_prop_by_name (
            node, (const guchar *)"_click-to-add-message");

    g_free (specification->domain);
    specification->domain =
        e_xml_get_string_prop_by_name (
            node, (const guchar *)"gettext-domain");
    if (specification->domain && !*specification->domain) {
        g_free (specification->domain);
        specification->domain = NULL;
    }

    if (specification->state)
        g_object_unref (specification->state);
    specification->state = NULL;
    if (specification->columns) {
        for (i = 0; specification->columns[i]; i++) {
            g_object_unref (specification->columns[i]);
        }
        g_free (specification->columns);
    }
    specification->columns = NULL;

    for (children = node->xmlChildrenNode; children; children = children->next) {
        if (!strcmp ((gchar *)children->name, "ETableColumn")) {
            ETableColumnSpecification *col_spec = e_table_column_specification_new ();

            e_table_column_specification_load_from_node (col_spec, children);
            list = g_list_append (list, col_spec);
        } else if (specification->state == NULL && !strcmp ((gchar *)children->name, "ETableState")) {
            specification->state = e_table_state_new ();
            e_table_state_load_from_node (specification->state, children);
            e_table_sort_info_set_can_group (specification->state->sort_info, specification->allow_grouping);
        }
    }

    if (specification->state == NULL) {
        /* Make the default state.  */
        specification->state = e_table_state_vanilla (g_list_length (list));
    }

    specification->columns = g_new (ETableColumnSpecification *, g_list_length (list) + 1);
    for (list2 = list, i = 0; list2; list2 = g_list_next (list2), i++) {
        specification->columns[i] = list2->data;
    }
    specification->columns[i] = NULL;
    g_list_free (list);
}

/**
 * e_table_specification_save_to_file:
 * @specification: An %ETableSpecification that you want to save
 * @filename: a file name to store the specification.
 *
 * This routine stores the @specification into @filename.
 *
 * Returns: 0 on success or -1 on error.
 */
gint
e_table_specification_save_to_file (ETableSpecification *specification,
                    const gchar          *filename)
{
    xmlDoc *doc;
    gint ret;

    g_return_val_if_fail (specification != NULL, -1);
    g_return_val_if_fail (filename != NULL, -1);
    g_return_val_if_fail (E_IS_TABLE_SPECIFICATION (specification), -1);

    if ((doc = xmlNewDoc ((const guchar *)"1.0")) == NULL)
        return -1;

    xmlDocSetRootElement (doc, e_table_specification_save_to_node (specification, doc));

    ret = e_xml_save_file (filename, doc);

    xmlFreeDoc (doc);

    return ret;
}

/**
 * e_table_specification_save_to_string:
 * @specification: An %ETableSpecification that you want to stringify
 *
 * Saves the state of @specification to a string.
 *
 * Returns: an g_alloc() allocated string containing the stringified
 * representation of @specification.  This stringified representation
 * uses XML as a convenience.
 */
gchar *
e_table_specification_save_to_string (ETableSpecification *specification)
{
    gchar *ret_val;
    xmlChar *string;
    gint length;
    xmlDoc *doc;

    g_return_val_if_fail (specification != NULL, NULL);
    g_return_val_if_fail (E_IS_TABLE_SPECIFICATION (specification), NULL);

    doc = xmlNewDoc ((const guchar *)"1.0");
    xmlDocSetRootElement (doc, e_table_specification_save_to_node (specification, doc));
    xmlDocDumpMemory (doc, &string, &length);

    ret_val = g_strdup ((gchar *)string);
    xmlFree (string);
    return ret_val;
}

/**
 * e_table_specification_save_to_node:
 * @specification: An ETableSpecification that you want to store.
 * @doc: Node where the specification is saved
 *
 * This routine saves the %ETableSpecification state in the object @specification
 * into the xmlDoc represented by @doc.
 *
 * Returns: The node that has been attached to @doc with the contents
 * of the ETableSpecification.
 */
xmlNode *
e_table_specification_save_to_node (ETableSpecification *specification,
                    xmlDoc              *doc)
{
    xmlNode *node;
    const gchar *s;

    g_return_val_if_fail (doc != NULL, NULL);
    g_return_val_if_fail (specification != NULL, NULL);
    g_return_val_if_fail (E_IS_TABLE_SPECIFICATION (specification), NULL);

    node = xmlNewNode (NULL, (const guchar *)"ETableSpecification");
    e_xml_set_bool_prop_by_name (node, (const guchar *)"no-headers", specification->no_headers);
    e_xml_set_bool_prop_by_name (node, (const guchar *)"click-to-add", specification->click_to_add);
    e_xml_set_bool_prop_by_name (node, (const guchar *)"click-to-add-end", specification->click_to_add_end && specification->click_to_add);
    e_xml_set_bool_prop_by_name (node, (const guchar *)"alternating-row-colors", specification->alternating_row_colors);
    e_xml_set_bool_prop_by_name (node, (const guchar *)"horizontal-draw-grid", specification->horizontal_draw_grid);
    e_xml_set_bool_prop_by_name (node, (const guchar *)"vertical-draw-grid", specification->vertical_draw_grid);
    e_xml_set_bool_prop_by_name (node, (const guchar *)"draw-focus", specification->draw_focus);
    e_xml_set_bool_prop_by_name (node, (const guchar *)"horizontal-scrolling", specification->horizontal_scrolling);
    e_xml_set_bool_prop_by_name (node, (const guchar *)"horizontal-resize", specification->horizontal_resize);
    e_xml_set_bool_prop_by_name (node, (const guchar *)"allow-grouping", specification->allow_grouping);

    switch (specification->selection_mode) {
    case GTK_SELECTION_SINGLE:
        s = "single";
        break;
    case GTK_SELECTION_BROWSE:
        s = "browse";
        break;
    default:
    case GTK_SELECTION_EXTENDED:
        s = "extended";
    }
    xmlSetProp (node, (const guchar *)"selection-mode", (guchar *)s);
    if (specification->cursor_mode == E_CURSOR_LINE)
        s = "line";
    else
        s = "cell";
    xmlSetProp (node, (const guchar *)"cursor-mode", (guchar *)s);

    xmlSetProp (node, (const guchar *)"_click-to-add-message", (guchar *)specification->click_to_add_message);
    xmlSetProp (node, (const guchar *)"gettext-domain", (guchar *)specification->domain);

    if (specification->columns) {
        gint i;

        for (i = 0; specification->columns[i]; i++)
            e_table_column_specification_save_to_node (
                specification->columns[i],
                node);
    }

    if (specification->state)
        e_table_state_save_to_node (specification->state, node);

    return node;
}

/**
 * e_table_specification_duplicate:
 * @spec: specification to duplicate
 *
 * This creates a copy of the %ETableSpecification @spec
 *
 * Returns: The duplicated %ETableSpecification.
 */
ETableSpecification *
e_table_specification_duplicate (ETableSpecification *spec)
{
    ETableSpecification *new_spec;
    gchar *spec_str;

    g_return_val_if_fail (spec != NULL, NULL);
    g_return_val_if_fail (E_IS_TABLE_SPECIFICATION (spec), NULL);

    new_spec = e_table_specification_new ();
    spec_str = e_table_specification_save_to_string (spec);
    if (!e_table_specification_load_from_string (new_spec, spec_str)) {
        g_warning ("Unable to duplicate ETable specification");
        g_object_unref (new_spec);
        new_spec = NULL;
    }
    g_free (spec_str);

    return new_spec;
}