aboutsummaryrefslogtreecommitdiffstats
path: root/e-util/e-util.c
blob: 4b47f64918bbe789263d3472f3315851d9c99a24 (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
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
/*
 * 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)
 *
 */

/**
 * SECTION: e-util
 * @include: e-util/e-util.h
 **/

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

#include <stdlib.h>
#include <stdio.h>
#include <errno.h>
#include <unistd.h>
#include <ctype.h>
#include <math.h>
#include <string.h>
#include <locale.h>
#include <time.h>
#include <sys/stat.h>
#include <fcntl.h>

#include <gio/gio.h>
#include <gtk/gtk.h>
#include <glib/gi18n.h>
#include <glib/gstdio.h>

#ifdef G_OS_WIN32
#include <windows.h>
#endif

#include <camel/camel.h>
#include <libedataserver/e-data-server-util.h>
#include <libedataserver/e-categories.h>
#include <libedataserver/e-source-list.h>

#include "filter/e-filter-option.h"

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

/**
 * e_get_accels_filename:
 *
 * Returns the name of the user data file containing custom keyboard
 * accelerator specifications.
 *
 * Returns: filename for accelerator specifications
 **/
const gchar *
e_get_accels_filename (void)
{
    static gchar *filename = NULL;

    if (G_UNLIKELY (filename == NULL)) {
        const gchar *config_dir = e_get_user_config_dir ();
        filename = g_build_filename (config_dir, "accels", NULL);
    }

    return filename;
}

/**
 * e_show_uri:
 * @parent: a parent #GtkWindow or %NULL
 * @uri: the URI to show
 *
 * Launches the default application to show the given URI.  The URI must
 * be of a form understood by GIO.  If the URI cannot be shown, it presents
 * a dialog describing the error.  The dialog is set as transient to @parent
 * if @parent is non-%NULL.
 **/
void
e_show_uri (GtkWindow *parent,
            const gchar *uri)
{
    GtkWidget *dialog;
    GdkScreen *screen = NULL;
    GError *error = NULL;
    guint32 timestamp;

    g_return_if_fail (uri != NULL);

    timestamp = gtk_get_current_event_time ();

    if (parent != NULL)
        screen = gtk_widget_get_screen (GTK_WIDGET (parent));

    if (gtk_show_uri (screen, uri, timestamp, &error))
        return;

    dialog = gtk_message_dialog_new_with_markup (
        parent, GTK_DIALOG_DESTROY_WITH_PARENT,
        GTK_MESSAGE_ERROR, GTK_BUTTONS_OK,
        "<big><b>%s</b></big>",
        _("Could not open the link."));

    gtk_message_dialog_format_secondary_text (
        GTK_MESSAGE_DIALOG (dialog), "%s", error->message);

    gtk_dialog_run (GTK_DIALOG (dialog));

    gtk_widget_destroy (dialog);
    g_error_free (error);
}

/**
 * e_display_help:
 * @parent: a parent #GtkWindow or %NULL
 * @link_id: help section to present or %NULL
 *
 * Opens the user documentation to the section given by @link_id, or to the
 * table of contents if @link_id is %NULL.  If the user documentation cannot
 * be opened, it presents a dialog describing the error.  The dialog is set
 * as transient to @parent if @parent is non-%NULL.
 **/
void
e_display_help (GtkWindow *parent,
                const gchar *link_id)
{
    GString *uri;
    GtkWidget *dialog;
    GdkScreen *screen = NULL;
    GError *error = NULL;
    guint32 timestamp;

    uri = g_string_new ("ghelp:" PACKAGE);
    timestamp = gtk_get_current_event_time ();

    if (parent != NULL)
        screen = gtk_widget_get_screen (GTK_WIDGET (parent));

    if (link_id != NULL)
        g_string_append_printf (uri, "?%s", link_id);

    if (gtk_show_uri (screen, uri->str, timestamp, &error))
        goto exit;

    dialog = gtk_message_dialog_new_with_markup (
        parent, GTK_DIALOG_DESTROY_WITH_PARENT,
        GTK_MESSAGE_ERROR, GTK_BUTTONS_OK,
        "<big><b>%s</b></big>",
        _("Could not display help for Evolution."));

    gtk_message_dialog_format_secondary_text (
        GTK_MESSAGE_DIALOG (dialog), "%s", error->message);

    gtk_dialog_run (GTK_DIALOG (dialog));

    gtk_widget_destroy (dialog);
    g_error_free (error);

exit:
    g_string_free (uri, TRUE);
}

/**
 * e_lookup_action:
 * @ui_manager: a #GtkUIManager
 * @action_name: the name of an action
 *
 * Returns the first #GtkAction named @action_name by traversing the
 * list of action groups in @ui_manager.  If no such action exists, the
 * function emits a critical warning before returning %NULL, since this
 * probably indicates a programming error and most code is not prepared
 * to deal with lookup failures.
 *
 * Returns: the first #GtkAction named @action_name
 **/
GtkAction *
e_lookup_action (GtkUIManager *ui_manager,
                 const gchar *action_name)
{
    GtkAction *action = NULL;
    GList *iter;

    g_return_val_if_fail (GTK_IS_UI_MANAGER (ui_manager), NULL);
    g_return_val_if_fail (action_name != NULL, NULL);

    iter = gtk_ui_manager_get_action_groups (ui_manager);

    while (iter != NULL) {
        GtkActionGroup *action_group = iter->data;

        action = gtk_action_group_get_action (
            action_group, action_name);
        if (action != NULL)
            return action;

        iter = g_list_next (iter);
    }

    g_critical ("%s: action '%s' not found", G_STRFUNC, action_name);

    return NULL;
}

/**
 * e_lookup_action_group:
 * @ui_manager: a #GtkUIManager
 * @group_name: the name of an action group
 *
 * Returns the #GtkActionGroup in @ui_manager named @group_name.  If no
 * such action group exists, the function emits a critical warnings before
 * returning %NULL, since this probably indicates a programming error and
 * most code is not prepared to deal with lookup failures.
 *
 * Returns: the #GtkActionGroup named @group_name
 **/
GtkActionGroup *
e_lookup_action_group (GtkUIManager *ui_manager,
                       const gchar *group_name)
{
    GList *iter;

    g_return_val_if_fail (GTK_IS_UI_MANAGER (ui_manager), NULL);
    g_return_val_if_fail (group_name != NULL, NULL);

    iter = gtk_ui_manager_get_action_groups (ui_manager);

    while (iter != NULL) {
        GtkActionGroup *action_group = iter->data;
        const gchar *name;

        name = gtk_action_group_get_name (action_group);
        if (strcmp (name, group_name) == 0)
            return action_group;

        iter = g_list_next (iter);
    }

    g_critical ("%s: action group '%s' not found", G_STRFUNC, group_name);

    return NULL;
}

/**
 * e_builder_get_widget:
 * @builder: a #GtkBuilder
 * @widget_name: name of a widget in @builder
 *
 * Gets the widget named @widget_name.  Note that this function does not
 * increment the reference count of the returned widget.  If @widget_name
 * could not be found in the @builder<!-- -->'s object tree, a run-time
 * warning is emitted since this usually indicates a programming error.
 *
 * This is a convenience function to work around the awkwardness of
 * #GtkBuilder returning #GObject pointers, when the vast majority of
 * the time you want a #GtkWidget pointer.
 *
 * If you need something from @builder other than a #GtkWidget, or you
 * want to test for the existence of some widget name without incurring
 * a run-time warning, use gtk_builder_get_object().
 *
 * Returns: the widget named @widget_name, or %NULL
 **/
GtkWidget *
e_builder_get_widget (GtkBuilder *builder,
                      const gchar *widget_name)
{
    GObject *object;

    g_return_val_if_fail (GTK_IS_BUILDER (builder), NULL);
    g_return_val_if_fail (widget_name != NULL, NULL);

    object = gtk_builder_get_object (builder, widget_name);
    if (object == NULL) {
        g_warning ("Could not find widget '%s'", widget_name);
        return NULL;
    }

    return GTK_WIDGET (object);
}

/**
 * e_load_ui_builder_definition:
 * @builder: a #GtkBuilder
 * @basename: basename of the UI definition file
 *
 * Loads a UI definition into @builder from Evolution's UI directory.
 * Failure here is fatal, since the application can't function without
 * its UI definitions.
 **/
void
e_load_ui_builder_definition (GtkBuilder *builder,
                              const gchar *basename)
{
    gchar *filename;
    GError *error = NULL;

    g_return_if_fail (GTK_IS_BUILDER (builder));
    g_return_if_fail (basename != NULL);

    filename = g_build_filename (EVOLUTION_UIDIR, basename, NULL);
    gtk_builder_add_from_file (builder, filename, &error);
    g_free (filename);

    if (error != NULL) {
        g_error ("%s: %s", basename, error->message);
        g_assert_not_reached ();
    }
}

/**
 * e_action_compare_by_label:
 * @action1: a #GtkAction
 * @action2: a #GtkAction
 *
 * Compares the labels for @action1 and @action2 using g_utf8_collate().
 *
 * Returns: &lt; 0 if @action1 compares before @action2, 0 if they
 *          compare equal, &gt; 0 if @action1 compares after @action2
 **/
gint
e_action_compare_by_label (GtkAction *action1,
                           GtkAction *action2)
{
    gchar *label1;
    gchar *label2;
    gint result;

    /* XXX This is horribly inefficient but will generally only be
     *     used on short lists of actions during UI construction. */

    if (action1 == action2)
        return 0;

    g_object_get (action1, "label", &label1, NULL);
    g_object_get (action2, "label", &label2, NULL);

    result = g_utf8_collate (label1, label2);

    g_free (label1);
    g_free (label2);

    return result;
}

/**
 * e_action_group_remove_all_actions:
 * @action_group: a #GtkActionGroup
 *
 * Removes all actions from the action group.
 **/
void
e_action_group_remove_all_actions (GtkActionGroup *action_group)
{
    GList *list, *iter;

    /* XXX I've proposed this function for inclusion in GTK+.
     *     GtkActionGroup stores actions in an internal hash
     *     table and can do this more efficiently by calling
     *     g_hash_table_remove_all().
     *
     *     http://bugzilla.gnome.org/show_bug.cgi?id=550485 */

    g_return_if_fail (GTK_IS_ACTION_GROUP (action_group));

    list = gtk_action_group_list_actions (action_group);
    for (iter = list; iter != NULL; iter = iter->next)
        gtk_action_group_remove_action (action_group, iter->data);
    g_list_free (list);
}

/**
 * e_radio_action_get_current_action:
 * @radio_action: a #GtkRadioAction
 *
 * Returns the currently active member of the group to which @radio_action
 * belongs.
 *
 * Returns: the currently active group member
 **/
GtkRadioAction *
e_radio_action_get_current_action (GtkRadioAction *radio_action)
{
    GSList *group;
    gint current_value;

    g_return_val_if_fail (GTK_IS_RADIO_ACTION (radio_action), NULL);

    group = gtk_radio_action_get_group (radio_action);
    current_value = gtk_radio_action_get_current_value (radio_action);

    while (group != NULL) {
        gint value;

        radio_action = GTK_RADIO_ACTION (group->data);
        g_object_get (radio_action, "value", &value, NULL);

        if (value == current_value)
            return radio_action;

        group = g_slist_next (group);
    }

    return NULL;
}

/* Helper for e_categories_add_change_hook() */
static void
categories_changed_cb (GObject *useless_opaque_object,
                       GHookList *hook_list)
{
    /* e_categories_register_change_listener() is broken because
     * it requires callbacks to allow for some opaque GObject as
     * the first argument (not does it document this). */
    g_hook_list_invoke (hook_list, FALSE);
}

/* Helper for e_categories_add_change_hook() */
static void
categories_weak_notify_cb (GHookList *hook_list,
                           gpointer where_the_object_was)
{
    GHook *hook;

    /* This should not happen, but if we fail to find the hook for
     * some reason, g_hook_destroy_link() will warn about the NULL
     * pointer, which is all we would do anyway so no need to test
     * for it ourselves. */
    hook = g_hook_find_data (hook_list, TRUE, where_the_object_was);
    g_hook_destroy_link (hook_list, hook);
}

/**
 * e_categories_add_change_hook:
 * @func: a hook function
 * @object: a #GObject to be passed to @func, or %NULL
 *
 * A saner alternative to e_categories_register_change_listener().
 *
 * Adds a hook function to be called when a category is added, removed or
 * modified.  If @object is not %NULL, the hook function is automatically
 * removed when @object is finalized.
 **/
void
e_categories_add_change_hook (GHookFunc func,
                              gpointer object)
{
    static gboolean initialized = FALSE;
    static GHookList hook_list;
    GHook *hook;

    g_return_if_fail (func != NULL);

    if (object != NULL)
        g_return_if_fail (G_IS_OBJECT (object));

    if (!initialized) {
        g_hook_list_init (&hook_list, sizeof (GHook));
        e_categories_register_change_listener (
            G_CALLBACK (categories_changed_cb), &hook_list);
        initialized = TRUE;
    }

    hook = g_hook_alloc (&hook_list);

    hook->func = func;
    hook->data = object;

    if (object != NULL)
        g_object_weak_ref (
            G_OBJECT (object), (GWeakNotify)
            categories_weak_notify_cb, &hook_list);

    g_hook_append (&hook_list, hook);
}

/**
 * e_type_traverse:
 * @parent_type: the root #GType to traverse from
 * @func: the function to call for each visited #GType
 * @user_data: user data to pass to the function
 *
 * Calls @func for all instantiable subtypes of @parent_type.
 *
 * This is often useful for extending functionality by way of #EModule.
 * A module may register a subtype of @parent_type in its e_module_load()
 * function.  Then later on the application will call e_type_traverse()
 * to instantiate all registered subtypes of @parent_type.
 **/
void
e_type_traverse (GType parent_type,
                 ETypeFunc func,
                 gpointer user_data)
{
    GType *children;
    guint n_children, ii;

    g_return_if_fail (func != NULL);

    children = g_type_children (parent_type, &n_children);

    for (ii = 0; ii < n_children; ii++) {
        GType type = children[ii];

        /* Recurse over the child's children. */
        e_type_traverse (type, func, user_data);

        /* Skip abstract types. */
        if (G_TYPE_IS_ABSTRACT (type))
            continue;

        func (type, user_data);
    }

    g_free (children);
}

/**
 * e_str_without_underscores:
 * @string: the string to strip underscores from
 *
 * Strips underscores from a string in the same way
 * @gtk_label_new_with_mnemonics does.  The returned string should be freed
 * using g_free().
 *
 * Returns: a newly-allocated string without underscores
 */
gchar *
e_str_without_underscores (const gchar *string)
{
    gchar *new_string;
    const gchar *sp;
    gchar *dp;

    new_string = g_malloc (strlen (string) + 1);

    dp = new_string;
    for (sp = string; *sp != '\0'; sp++) {
        if (*sp != '_') {
            *dp = *sp;
            dp++;
        } else if (sp[1] == '_') {
            /* Translate "__" in "_".  */
            *dp = '_';
            dp++;
            sp++;
        }
    }
    *dp = 0;

    return new_string;
}

gint
e_str_compare (gconstpointer x, gconstpointer y)
{
    if (x == NULL || y == NULL) {
        if (x == y)
            return 0;
        else
            return x ? -1 : 1;
    }

    return strcmp (x, y);
}

gint
e_str_case_compare (gconstpointer x, gconstpointer y)
{
    gchar *cx, *cy;
    gint res;

    if (x == NULL || y == NULL) {
        if (x == y)
            return 0;
        else
            return x ? -1 : 1;
    }

    cx = g_utf8_casefold (x, -1);
    cy = g_utf8_casefold (y, -1);

    res = g_utf8_collate (cx, cy);

    g_free (cx);
    g_free (cy);

    return res;
}

gint
e_collate_compare (gconstpointer x, gconstpointer y)
{
    if (x == NULL || y == NULL) {
        if (x == y)
            return 0;
        else
            return x ? -1 : 1;
    }

    return g_utf8_collate (x, y);
}

gint
e_int_compare (gconstpointer x, gconstpointer y)
{
    gint nx = GPOINTER_TO_INT (x);
    gint ny = GPOINTER_TO_INT (y);

    return (nx == ny) ? 0 : (nx < ny) ? -1 : 1;
}

/**
 * e_color_to_value:
 * @color: a #GdkColor
 *
 * Converts a #GdkColor to a 24-bit RGB color value.
 *
 * Returns: a 24-bit color value
 **/
guint32
e_color_to_value (GdkColor *color)
{
    guint16 red;
    guint16 green;
    guint16 blue;

    g_return_val_if_fail (color != NULL, 0);

    red = color->red >> 8;
    green = color->green >> 8;
    blue = color->blue >> 8;

    return (guint32) (((red << 16) | (green << 8) | blue) & 0xffffff);
}

static gint
epow10 (gint number)
{
    gint value = 1;

    while (number-- > 0)
        value *= 10;

    return value;
}

gchar *
e_format_number (gint number)
{
    GList *iterator, *list = NULL;
    struct lconv *locality;
    gint char_length = 0;
    gint group_count = 0;
    gchar *grouping;
    gint last_count = 3;
    gint divider;
    gchar *value;
    gchar *value_iterator;

    locality = localeconv ();
    grouping = locality->grouping;
    while (number) {
        gchar *group;
        switch (*grouping) {
        default:
            last_count = *grouping;
            grouping++;
        case 0:
            divider = epow10 (last_count);
            if (number >= divider) {
                group = g_strdup_printf (
                    "%0*d", last_count, number % divider);
            } else {
                group = g_strdup_printf (
                    "%d", number % divider);
            }
            number /= divider;
            break;
        case CHAR_MAX:
            group = g_strdup_printf("%d", number);
            number = 0;
            break;
        }
        char_length += strlen (group);
        list = g_list_prepend (list, group);
        group_count++;
    }

    if (list) {
        value = g_new (
            gchar, 1 + char_length + (group_count - 1) *
            strlen (locality->thousands_sep));

        iterator = list;
        value_iterator = value;

        strcpy (value_iterator, iterator->data);
        value_iterator += strlen (iterator->data);
        for (iterator = iterator->next; iterator; iterator = iterator->next) {
            strcpy (value_iterator, locality->thousands_sep);
            value_iterator += strlen (locality->thousands_sep);

            strcpy (value_iterator, iterator->data);
            value_iterator += strlen (iterator->data);
        }
        g_list_foreach (list, (GFunc) g_free, NULL);
        g_list_free (list);
        return value;
    } else {
        return g_strdup("0");
    }
}

/* Perform a binary search for key in base which has nmemb elements
   of size bytes each.  The comparisons are done by (*compare)().  */
void
e_bsearch (gconstpointer key,
           gconstpointer base,
           gsize nmemb,
           gsize size,
       ESortCompareFunc compare,
           gpointer closure,
           gsize *start,
           gsize *end)
{
    gsize l, u, idx;
    gconstpointer p;
    gint comparison;
    if (!(start || end))
        return;

    l = 0;
    u = nmemb;
    while (l < u) {
        idx = (l + u) / 2;
        p = (((const gchar *) base) + (idx * size));
        comparison = (*compare) (key, p, closure);
        if (comparison < 0)
            u = idx;
        else if (comparison > 0)
            l = idx + 1;
        else {
            gsize lsave, usave;
            lsave = l;
            usave = u;
            if (start) {
                while (l < u) {
                    idx = (l + u) / 2;
                    p = (((const gchar *) base) + (idx * size));
                    comparison = (*compare) (key, p, closure);
                    if (comparison <= 0)
                        u = idx;
                    else
                        l = idx + 1;
                }
                *start = l;

                l = lsave;
                u = usave;
            }
            if (end) {
                while (l < u) {
                    idx = (l + u) / 2;
                    p = (((const gchar *) base) + (idx * size));
                    comparison = (*compare) (key, p, closure);
                    if (comparison < 0)
                        u = idx;
                    else
                        l = idx + 1;
                }
                *end = l;
            }
            return;
        }
    }

    if (start)
        *start = l;
    if (end)
        *end = l;
}

/* Function to do a last minute fixup of the AM/PM stuff if the locale
 * and gettext haven't done it right. Most English speaking countries
 * except the USA use the 24 hour clock (UK, Australia etc). However
 * since they are English nobody bothers to write a language
 * translation (gettext) file. So the locale turns off the AM/PM, but
 * gettext does not turn on the 24 hour clock. Leaving a mess.
 *
 * This routine checks if AM/PM are defined in the locale, if not it
 * forces the use of the 24 hour clock.
 *
 * The function itself is a front end on strftime and takes exactly
 * the same arguments.
 *
 * TODO: Actually remove the '%p' from the fixed up string so that
 * there isn't a stray space.
 */

gsize
e_strftime_fix_am_pm (gchar *str, gsize max, const gchar *fmt,
                      const struct tm *tm)
{
    gchar buf[10];
    gchar *sp;
    gchar *ffmt;
    gsize ret;

    if (strstr(fmt, "%p")==NULL && strstr(fmt, "%P")==NULL) {
        /* No AM/PM involved - can use the fmt string directly */
        ret=e_strftime (str, max, fmt, tm);
    } else {
        /* Get the AM/PM symbol from the locale */
        e_strftime (buf, 10, "%p", tm);

        if (buf[0]) {
            /* AM/PM have been defined in the locale
             * so we can use the fmt string directly. */
            ret=e_strftime (str, max, fmt, tm);
        } else {
            /* No AM/PM defined by locale
             * must change to 24 hour clock. */
            ffmt=g_strdup (fmt);
            for (sp=ffmt; (sp=strstr(sp, "%l")); sp++) {
                /* Maybe this should be 'k', but I have never
                 * seen a 24 clock actually use that format. */
                sp[1]='H';
            }
            for (sp=ffmt; (sp=strstr(sp, "%I")); sp++) {
                sp[1]='H';
            }
            ret=e_strftime (str, max, ffmt, tm);
            g_free (ffmt);
        }
    }

    return (ret);
}

gsize
e_utf8_strftime_fix_am_pm (gchar *str, gsize max, const gchar *fmt,
                           const struct tm *tm)
{
    gsize sz, ret;
    gchar *locale_fmt, *buf;

    locale_fmt = g_locale_from_utf8 (fmt, -1, NULL, &sz, NULL);
    if (!locale_fmt)
        return 0;

    ret = e_strftime_fix_am_pm (str, max, locale_fmt, tm);
    if (!ret) {
        g_free (locale_fmt);
        return 0;
    }

    buf = g_locale_to_utf8 (str, ret, NULL, &sz, NULL);
    if (!buf) {
        g_free (locale_fmt);
        return 0;
    }

    if (sz >= max) {
        gchar *tmp = buf + max - 1;
        tmp = g_utf8_find_prev_char (buf, tmp);
        if (tmp)
            sz = tmp - buf;
        else
            sz = 0;
    }
    memcpy (str, buf, sz);
    str[sz] = '\0';
    g_free (locale_fmt);
    g_free (buf);
    return sz;
}

/**
 * e_get_month_name:
 * @month: month index
 * @abbreviated: if %TRUE, abbreviate the month name
 *
 * Returns the localized name for @month.  If @abbreviated is %TRUE,
 * returns the locale's abbreviated month name.
 *
 * Returns: localized month name
 **/
const gchar *
e_get_month_name (GDateMonth month,
                  gboolean abbreviated)
{
    /* Make the indices correspond to the enum values. */
    static const gchar *abbr_names[G_DATE_DECEMBER + 1];
    static const gchar *full_names[G_DATE_DECEMBER + 1];
    static gboolean first_time = TRUE;

    g_return_val_if_fail (month >= G_DATE_JANUARY, NULL);
    g_return_val_if_fail (month <= G_DATE_DECEMBER, NULL);

    if (G_UNLIKELY (first_time)) {
        gchar buffer[256];
        GDateMonth ii;
        GDate date;

        memset (abbr_names, 0, sizeof (abbr_names));
        memset (full_names, 0, sizeof (full_names));

        /* First Julian day was in January. */
        g_date_set_julian (&date, 1);

        for (ii = G_DATE_JANUARY; ii <= G_DATE_DECEMBER; ii++) {
            g_date_strftime (buffer, sizeof (buffer), "%b", &date);
            abbr_names[ii] = g_intern_string (buffer);
            g_date_strftime (buffer, sizeof (buffer), "%B", &date);
            full_names[ii] = g_intern_string (buffer);
            g_date_add_months (&date, 1);
        }

        first_time = FALSE;
    }

    return abbreviated ? abbr_names[month] : full_names[month];
}

/**
 * e_get_weekday_name:
 * @weekday: weekday index
 * @abbreviated: if %TRUE, abbreviate the weekday name
 *
 * Returns the localized name for @weekday.  If @abbreviated is %TRUE,
 * returns the locale's abbreviated weekday name.
 *
 * Returns: localized weekday name
 **/
const gchar *
e_get_weekday_name (GDateWeekday weekday,
                    gboolean abbreviated)
{
    /* Make the indices correspond to the enum values. */
    static const gchar *abbr_names[G_DATE_SUNDAY + 1];
    static const gchar *full_names[G_DATE_SUNDAY + 1];
    static gboolean first_time = TRUE;

    g_return_val_if_fail (weekday >= G_DATE_MONDAY, NULL);
    g_return_val_if_fail (weekday <= G_DATE_SUNDAY, NULL);

    if (G_UNLIKELY (first_time)) {
        gchar buffer[256];
        GDateWeekday ii;
        GDate date;

        memset (abbr_names, 0, sizeof (abbr_names));
        memset (full_names, 0, sizeof (full_names));

        /* First Julian day was a Monday. */
        g_date_set_julian (&date, 1);

        for (ii = G_DATE_MONDAY; ii <= G_DATE_SUNDAY; ii++) {
            g_date_strftime (buffer, sizeof (buffer), "%a", &date);
            abbr_names[ii] = g_intern_string (buffer);
            g_date_strftime (buffer, sizeof (buffer), "%A", &date);
            full_names[ii] = g_intern_string (buffer);
            g_date_add_days (&date, 1);
        }

        first_time = FALSE;
    }

    return abbreviated ? abbr_names[weekday] : full_names[weekday];
}

/**
 * e_flexible_strtod:
 * @nptr:    the string to convert to a numeric value.
 * @endptr:  if non-NULL, it returns the character after
 *           the last character used in the conversion.
 *
 * Converts a string to a gdouble value.  This function detects
 * strings either in the standard C locale or in the current locale.
 *
 * This function is typically used when reading configuration files or
 * other non-user input that should not be locale dependent, but may
 * have been in the past.  To handle input from the user you should
 * normally use the locale-sensitive system strtod function.
 *
 * To convert from a double to a string in a locale-insensitive way, use
 * @g_ascii_dtostr.
 *
 * Returns: the gdouble value
 **/
gdouble
e_flexible_strtod (const gchar *nptr, gchar **endptr)
{
    gchar *fail_pos;
    gdouble val;
    struct lconv *locale_data;
    const gchar *decimal_point;
    gint decimal_point_len;
    const gchar *p, *decimal_point_pos;
    const gchar *end = NULL; /* Silence gcc */
    gchar *copy, *c;

    g_return_val_if_fail (nptr != NULL, 0);

    fail_pos = NULL;

    locale_data = localeconv ();
    decimal_point = locale_data->decimal_point;
    decimal_point_len = strlen (decimal_point);

    g_return_val_if_fail (decimal_point_len != 0, 0);

    decimal_point_pos = NULL;
    if (!strcmp (decimal_point, "."))
        return strtod (nptr, endptr);

    p = nptr;

    /* Skip leading space */
    while (isspace ((guchar)*p))
        p++;

    /* Skip leading optional sign */
    if (*p == '+' || *p == '-')
        p++;

    if (p[0] == '0' &&
        (p[1] == 'x' || p[1] == 'X')) {
        p += 2;
        /* HEX - find the (optional) decimal point */

        while (isxdigit ((guchar)*p))
            p++;

        if (*p == '.') {
            decimal_point_pos = p++;

            while (isxdigit ((guchar)*p))
                p++;

            if (*p == 'p' || *p == 'P')
                p++;
            if (*p == '+' || *p == '-')
                p++;
            while (isdigit ((guchar)*p))
                p++;
            end = p;
        } else if (strncmp (p, decimal_point, decimal_point_len) == 0) {
            return strtod (nptr, endptr);
        }
    } else {
        while (isdigit ((guchar)*p))
            p++;

        if (*p == '.') {
            decimal_point_pos = p++;

            while (isdigit ((guchar)*p))
                p++;

            if (*p == 'e' || *p == 'E')
                p++;
            if (*p == '+' || *p == '-')
                p++;
            while (isdigit ((guchar)*p))
                p++;
            end = p;
        } else if (strncmp (p, decimal_point, decimal_point_len) == 0) {
            return strtod (nptr, endptr);
        }
    }
    /* For the other cases, we need not convert the decimal point */

    if (!decimal_point_pos)
        return strtod (nptr, endptr);

    /* We need to convert the '.' to the locale specific decimal point */
    copy = g_malloc (end - nptr + 1 + decimal_point_len);

    c = copy;
    memcpy (c, nptr, decimal_point_pos - nptr);
    c += decimal_point_pos - nptr;
    memcpy (c, decimal_point, decimal_point_len);
    c += decimal_point_len;
    memcpy (c, decimal_point_pos + 1, end - (decimal_point_pos + 1));
    c += end - (decimal_point_pos + 1);
    *c = 0;

    val = strtod (copy, &fail_pos);

    if (fail_pos) {
        if (fail_pos > decimal_point_pos)
            fail_pos =
                (gchar *) nptr + (fail_pos - copy) -
                (decimal_point_len - 1);
        else
            fail_pos = (gchar *) nptr + (fail_pos - copy);
    }

    g_free (copy);

    if (endptr)
        *endptr = fail_pos;

    return val;
}

/**
 * e_ascii_dtostr:
 * @buffer: A buffer to place the resulting string in
 * @buf_len: The length of the buffer.
 * @format: The printf-style format to use for the
 *          code to use for converting.
 * @d: The double to convert
 *
 * Converts a double to a string, using the '.' as
 * decimal_point. To format the number you pass in
 * a printf-style formating string. Allowed conversion
 * specifiers are eEfFgG.
 *
 * If you want to generates enough precision that converting
 * the string back using @g_strtod gives the same machine-number
 * (on machines with IEEE compatible 64bit doubles) use the format
 * string "%.17g". If you do this it is guaranteed that the size
 * of the resulting string will never be larger than
 * @G_ASCII_DTOSTR_BUF_SIZE bytes.
 *
 * Returns: the pointer to the buffer with the converted string
 **/
gchar *
e_ascii_dtostr (gchar *buffer, gint buf_len, const gchar *format, gdouble d)
{
    struct lconv *locale_data;
    const gchar *decimal_point;
    gint decimal_point_len;
    gchar *p;
    gint rest_len;
    gchar format_char;

    g_return_val_if_fail (buffer != NULL, NULL);
    g_return_val_if_fail (format[0] == '%', NULL);
    g_return_val_if_fail (strpbrk (format + 1, "'l%") == NULL, NULL);

    format_char = format[strlen (format) - 1];

    g_return_val_if_fail (format_char == 'e' || format_char == 'E' ||
                  format_char == 'f' || format_char == 'F' ||
                  format_char == 'g' || format_char == 'G',
                  NULL);

    if (format[0] != '%')
        return NULL;

    if (strpbrk (format + 1, "'l%"))
        return NULL;

    if (!(format_char == 'e' || format_char == 'E' ||
          format_char == 'f' || format_char == 'F' ||
          format_char == 'g' || format_char == 'G'))
        return NULL;

    g_snprintf (buffer, buf_len, format, d);

    locale_data = localeconv ();
    decimal_point = locale_data->decimal_point;
    decimal_point_len = strlen (decimal_point);

    g_return_val_if_fail (decimal_point_len != 0, NULL);

    if (strcmp (decimal_point, ".")) {
        p = buffer;

        if (*p == '+' || *p == '-')
            p++;

        while (isdigit ((guchar)*p))
            p++;

        if (strncmp (p, decimal_point, decimal_point_len) == 0) {
            *p = '.';
            p++;
            if (decimal_point_len > 1) {
                rest_len = strlen (p + (decimal_point_len-1));
                memmove (p, p + (decimal_point_len-1),
                     rest_len);
                p[rest_len] = 0;
            }
        }
    }

    return buffer;
}

/* Evolution Locks for crash recovery */

static const gchar *
get_lock_filename (void)
{
    static gchar *filename = NULL;

    if (G_UNLIKELY (filename == NULL))
        filename = g_build_filename (
            e_get_user_config_dir (), ".running", NULL);

    return filename;
}

gboolean
e_file_lock_create (void)
{
    const gchar *filename = get_lock_filename ();
    gboolean status = FALSE;
    FILE *file;

    file = g_fopen (filename, "w");
    if (file != NULL) {
        /* The lock file also serves as a PID file. */
        g_fprintf (
            file, "%" G_GINT64_FORMAT "\n",
            (gint64) getpid ());
        fclose (file);
        status = TRUE;
    } else {
        const gchar *errmsg = g_strerror (errno);
        g_warning ("Lock file creation failed: %s", errmsg);
    }

    return status;
}

void
e_file_lock_destroy (void)
{
    const gchar *filename = get_lock_filename ();

    if (g_unlink (filename) == -1) {
        const gchar *errmsg = g_strerror (errno);
        g_warning ("Lock file deletion failed: %s", errmsg);
    }
}

gboolean
e_file_lock_exists (void)
{
    const gchar *filename = get_lock_filename ();

    return g_file_test (filename, G_FILE_TEST_EXISTS);
}

/**
 * e_util_guess_mime_type:
 * @filename: a local file name, or URI
 * @localfile: %TRUE to check the file content, FALSE to check only the name
 *
 * Tries to determine the MIME type for @filename.  Free the returned
 * string with g_free().
 *
 * Returns: the MIME type of @filename, or %NULL if the the MIME type could
 *          not be determined
 **/
gchar *
e_util_guess_mime_type (const gchar *filename, gboolean localfile)
{
    gchar *mime_type = NULL;

    g_return_val_if_fail (filename != NULL, NULL);

    if (localfile) {
        GFile *file;
        GFileInfo *fi;

        if (strstr (filename, "://"))
            file = g_file_new_for_uri (filename);
        else
            file = g_file_new_for_path (filename);

        fi = g_file_query_info (
            file, G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE,
            G_FILE_QUERY_INFO_NONE, NULL, NULL);
        if (fi) {
            mime_type = g_content_type_get_mime_type (
                g_file_info_get_content_type (fi));
            g_object_unref (fi);
        }

        g_object_unref (file);
    }

    if (!mime_type) {
        /* file doesn't exists locally, thus guess based on the filename */
        gboolean uncertain = FALSE;
        gchar *content_type;

        content_type = g_content_type_guess (filename, NULL, 0, &uncertain);
        if (content_type) {
            mime_type = g_content_type_get_mime_type (content_type);
            g_free (content_type);
        }
    }

    return mime_type;
}

/* XXX: Should e-util/ really depend on filter/ ?? */
GSList *
e_util_get_category_filter_options (void)
{
    GSList *res = NULL;
    GList *clist, *l;

    clist = e_categories_get_list ();
    for (l = clist; l; l = l->next) {
        const gchar *cname = l->data;
        struct _filter_option *fo;

        if (!e_categories_is_searchable (cname))
            continue;

        fo = g_new0 (struct _filter_option, 1);

        fo->title = g_strdup (cname);
        fo->value = g_strdup (cname);
        res = g_slist_prepend (res, fo);
    }

    g_list_free (clist);

    return g_slist_reverse (res);
}

/**
 * e_util_get_searchable_categories:
 *
 * Returns list of searchable categories only. The list should
 * be freed with g_list_free() when done with it, but the items
 * are internal strings, names of categories, which should not
 * be touched in other than read-only way, in other words the same
 * restrictions as for e_categories_get_list() applies here too.
 **/
GList *
e_util_get_searchable_categories (void)
{
    GList *res = NULL, *all_categories, *l;

    all_categories = e_categories_get_list ();
    for (l = all_categories; l; l = l->next) {
        const gchar *cname = l->data;

        if (e_categories_is_searchable (cname))
            res = g_list_prepend (res, (gpointer) cname);
    }

    g_list_free (all_categories);

    return g_list_reverse (res);
}

/**
 * e_util_set_source_combo_box_list:
 * @source_combo_box: an #ESourceComboBox
 * @source_gconf_path: GConf path with sources to use in an #ESourceList
 *
 * Sets an #ESourceList of a given GConf path to an #ESourceComboBox.
 **/
void
e_util_set_source_combo_box_list (GtkWidget *source_combo_box,
                                  const gchar *source_gconf_path)
{
    ESourceList *source_list;
    GConfClient *gconf_client;

    g_return_if_fail (source_combo_box != NULL);
    g_return_if_fail (source_gconf_path != NULL);

    gconf_client = gconf_client_get_default ();
    source_list = e_source_list_new_for_gconf (
        gconf_client, source_gconf_path);
    g_object_set (source_combo_box, "source-list", source_list, NULL);
    g_object_unref (source_list);
    g_object_unref (gconf_client);
}

/**
 * e_binding_transform_color_to_string:
 * @binding: a #GBinding
 * @source_value: a #GValue of type #GDK_TYPE_COLOR
 * @target_value: a #GValue of type #G_TYPE_STRING
 * @not_used: not used
 *
 * Transforms a #GdkColor value to a color string specification.
 *
 * Returns: %TRUE always
 **/
gboolean
e_binding_transform_color_to_string (GBinding *binding,
                                     const GValue *source_value,
                                     GValue *target_value,
                                     gpointer not_used)
{
    const GdkColor *color;
    gchar *string;

    g_return_val_if_fail (G_IS_BINDING (binding), FALSE);

    color = g_value_get_boxed (source_value);
    string = gdk_color_to_string (color);
    g_value_set_string (target_value, string);
    g_free (string);

    return TRUE;
}

/**
 * e_binding_transform_string_to_color:
 * @binding: a #GBinding
 * @source_value: a #GValue of type #G_TYPE_STRING
 * @target_value: a #GValue of type #GDK_TYPE_COLOR
 * @not_used: not used
 *
 * Transforms a color string specification to a #GdkColor.
 *
 * Returns: %TRUE if color string specification was valid
 **/
gboolean
e_binding_transform_string_to_color (GBinding *binding,
                                     const GValue *source_value,
                                     GValue *target_value,
                                     gpointer not_used)
{
    GdkColor color;
    const gchar *string;
    gboolean success = FALSE;

    g_return_val_if_fail (G_IS_BINDING (binding), FALSE);

    string = g_value_get_string (source_value);
    if (gdk_color_parse (string, &color)) {
        g_value_set_boxed (target_value, &color);
        success = TRUE;
    }

    return success;
}

/**
 * e_binding_transform_enum_value_to_nick:
 * @binding: a #GBinding
 * @source_value: a #GValue whose type is derived from #G_TYPE_ENUM
 * @target_value: a #GValue of type #G_TYPE_STRING
 * @not_used: not used
 *
 * Transforms an enumeration value to its corresponding nickname.
 *
 * Returns: %TRUE if the enum value has a corresponding nickname
 **/
gboolean
e_binding_transform_enum_value_to_nick (GBinding *binding,
                                        const GValue *source_value,
                                        GValue *target_value,
                                        gpointer not_used)
{
    GEnumClass *enum_class;
    GEnumValue *enum_value;
    gint value;
    gboolean success = FALSE;

    g_return_val_if_fail (G_IS_BINDING (binding), FALSE);

    enum_class = g_type_class_peek (G_VALUE_TYPE (source_value));
    g_return_val_if_fail (G_IS_ENUM_CLASS (enum_class), FALSE);

    value = g_value_get_enum (source_value);
    enum_value = g_enum_get_value (enum_class, value);
    if (enum_value != NULL) {
        g_value_set_string (target_value, enum_value->value_nick);
        success = TRUE;
    }

    return success;
}

/**
 * e_binding_transform_enum_nick_to_value:
 * @binding: a #GBinding
 * @source_value: a #GValue of type #G_TYPE_STRING
 * @target_value: a #GValue whose type is derived from #G_TYPE_ENUM
 * @not_used: not_used
 *
 * Transforms an enumeration nickname to its corresponding value.
 *
 * Returns: %TRUE if the enum nickname has a corresponding value
 **/
gboolean
e_binding_transform_enum_nick_to_value (GBinding *binding,
                                        const GValue *source_value,
                                        GValue *target_value,
                                        gpointer not_used)
{
    GEnumClass *enum_class;
    GEnumValue *enum_value;
    const gchar *string;
    gboolean success = FALSE;

    g_return_val_if_fail (G_IS_BINDING (binding), FALSE);

    enum_class = g_type_class_peek (G_VALUE_TYPE (target_value));
    g_return_val_if_fail (G_IS_ENUM_CLASS (enum_class), FALSE);

    string = g_value_get_string (source_value);
    enum_value = g_enum_get_value_by_nick (enum_class, string);
    if (enum_value != NULL) {
        g_value_set_enum (target_value, enum_value->value);
        success = TRUE;
    }

    return success;
}

/**
 * e_binding_transform_source_to_uid:
 * @binding: a #GBinding
 * @source_value: a #GValue of type #E_TYPE_SOURCE
 * @target_value: a #GValue of type #G_TYPE_STRING
 * @source_list: an #ESourceList
 *
 * Transforms an #ESource object to its UID string.
 *
 * Returns: %TRUE if @source_value was an #ESource object
 **/
gboolean
e_binding_transform_source_to_uid (GBinding *binding,
                                   const GValue *source_value,
                                   GValue *target_value,
                                   ESourceList *source_list)
{
    ESource *source;
    const gchar *string;
    gboolean success = FALSE;

    g_return_val_if_fail (G_IS_BINDING (binding), FALSE);
    g_return_val_if_fail (E_IS_SOURCE_LIST (source_list), FALSE);

    source = g_value_get_object (source_value);
    if (E_IS_SOURCE (source)) {
        string = e_source_peek_uid (source);
        g_value_set_string (target_value, string);
        success = TRUE;
    }

    return success;
}

/**
 * e_binding_transform_uid_to_source:
 * @binding: a #GBinding
 * @source_value: a #GValue of type #G_TYPE_STRING
 * @target_value: a #GValue of type #E_TYPE_SOURCe
 * @source_list: an #ESourceList
 *
 * Transforms an #ESource UID string to the corresponding #ESource object
 * in @source_list.
 *
 * Returns: %TRUE if @source_list had an #ESource object with a matching
 *          UID string
 **/
gboolean
e_binding_transform_uid_to_source (GBinding *binding,
                                   const GValue *source_value,
                                   GValue *target_value,
                                   ESourceList *source_list)
{
    ESource *source;
    const gchar *string;
    gboolean success = FALSE;

    g_return_val_if_fail (G_IS_BINDING (binding), FALSE);
    g_return_val_if_fail (E_IS_SOURCE_LIST (source_list), FALSE);

    string = g_value_get_string (source_value);
    if (string == NULL || *string == '\0')
        return FALSE;

    source = e_source_list_peek_source_by_uid (source_list, string);
    if (source != NULL) {
        g_value_set_object (target_value, source);
        success = TRUE;
    }

    return success;
}