summaryrefslogtreecommitdiff
path: root/eel/eel-glib-extensions.c
blob: 5fd24055d2af71a8b6a312dc7fc74c0f5432df7f (plain)
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
/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */

/* eel-glib-extensions.c - implementation of new functions that conceptually
                                belong in glib. Perhaps some of these will be
                                actually rolled into glib someday.

   Copyright (C) 2000 Eazel, Inc.

   The Mate Library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public License as
   published by the Free Software Foundation; either version 2 of the
   License, or (at your option) any later version.

   The Mate 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 the Mate Library; see the file COPYING.LIB.  If not,
   write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
   Boston, MA 02110-1301, USA.

   Authors: John Sullivan <sullivan@eazel.com>
*/

#include <config.h>
#include "eel-glib-extensions.h"

#include "eel-debug.h"
#include "eel-lib-self-check-functions.h"
#include "eel-string.h"
#include <glib-object.h>
#include <math.h>
#include <stdlib.h>
#include <sys/time.h>
#include <sys/utsname.h>
#include <time.h>
#include <locale.h>

/* Legal conversion specifiers, as specified in the C standard. */
#define C_STANDARD_STRFTIME_CHARACTERS "aAbBcdHIjmMpSUwWxXyYZ"
#define C_STANDARD_NUMERIC_STRFTIME_CHARACTERS "dHIjmMSUwWyY"
#define SUS_EXTENDED_STRFTIME_MODIFIERS "EO"

#define SAFE_SHELL_CHARACTERS "-_0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"

typedef struct
{
    GHashTable *hash_table;
    char *display_name;
    gboolean keys_known_to_be_strings;
} HashTableToFree;

static GList *hash_tables_to_free_at_exit;

/**
 * eel_g_date_new_tm:
 *
 * Get a new GDate * for the date represented by a tm struct.
 * The caller is responsible for g_free-ing the result.
 * @time_pieces: Pointer to a tm struct representing the date to be converted.
 *
 * Returns: Newly allocated date.
 *
 **/
GDate *
eel_g_date_new_tm (struct tm *time_pieces)
{
    /* tm uses 0-based months; GDate uses 1-based months.
     * tm_year needs 1900 added to get the full year.
     */
    return g_date_new_dmy (time_pieces->tm_mday,
                           time_pieces->tm_mon + 1,
                           time_pieces->tm_year + 1900);
}

/**
 * eel_strdup_strftime:
 *
 * Cover for standard date-and-time-formatting routine strftime that returns
 * a newly-allocated string of the correct size. The caller is responsible
 * for g_free-ing the returned string.
 *
 * Besides the buffer management, there are two differences between this
 * and the library strftime:
 *
 *   1) The modifiers "-" and "_" between a "%" and a numeric directive
 *      are defined as for the GNU version of strftime. "-" means "do not
 *      pad the field" and "_" means "pad with spaces instead of zeroes".
 *   2) Non-ANSI extensions to strftime are flagged at runtime with a
 *      warning, so it's easy to notice use of the extensions without
 *      testing with multiple versions of the library.
 *
 * @format: format string to pass to strftime. See strftime documentation
 * for details.
 * @time_pieces: date/time, in struct format.
 *
 * Return value: Newly allocated string containing the formatted time.
 **/
char *
eel_strdup_strftime (const char *format, struct tm *time_pieces)
{
    GString *string;
    const char *remainder, *percent;
    char code[4], buffer[512];
    char *piece, *result, *converted;
    size_t string_length;
    gboolean strip_leading_zeros, turn_leading_zeros_to_spaces;
    char modifier;
    int i;

    /* Format could be translated, and contain UTF-8 chars,
     * so convert to locale encoding which strftime uses */
    converted = g_locale_from_utf8 (format, -1, NULL, NULL, NULL);
    g_return_val_if_fail (converted != NULL, NULL);

    string = g_string_new ("");
    remainder = converted;

    /* Walk from % character to % character. */
    for (;;)
    {
        percent = strchr (remainder, '%');
        if (percent == NULL)
        {
            g_string_append (string, remainder);
            break;
        }
        g_string_append_len (string, remainder,
                             percent - remainder);

        /* Handle the "%" character. */
        remainder = percent + 1;
        switch (*remainder)
        {
        case '-':
            strip_leading_zeros = TRUE;
            turn_leading_zeros_to_spaces = FALSE;
            remainder++;
            break;
        case '_':
            strip_leading_zeros = FALSE;
            turn_leading_zeros_to_spaces = TRUE;
            remainder++;
            break;
        case '%':
            g_string_append_c (string, '%');
            remainder++;
            continue;
        case '\0':
            g_warning ("Trailing %% passed to eel_strdup_strftime");
            g_string_append_c (string, '%');
            continue;
        default:
            strip_leading_zeros = FALSE;
            turn_leading_zeros_to_spaces = FALSE;
            break;
        }

        modifier = 0;
        if (strchr (SUS_EXTENDED_STRFTIME_MODIFIERS, *remainder) != NULL)
        {
            modifier = *remainder;
            remainder++;

            if (*remainder == 0)
            {
                g_warning ("Unfinished %%%c modifier passed to eel_strdup_strftime", modifier);
                break;
            }
        }

        if (strchr (C_STANDARD_STRFTIME_CHARACTERS, *remainder) == NULL)
        {
            g_warning ("eel_strdup_strftime does not support "
                       "non-standard escape code %%%c",
                       *remainder);
        }

        /* Convert code to strftime format. We have a fixed
         * limit here that each code can expand to a maximum
         * of 512 bytes, which is probably OK. There's no
         * limit on the total size of the result string.
         */
        i = 0;
        code[i++] = '%';
        if (modifier != 0)
        {
#ifdef HAVE_STRFTIME_EXTENSION
            code[i++] = modifier;
#endif
        }
        code[i++] = *remainder;
        code[i++] = '\0';
        string_length = strftime (buffer, sizeof (buffer),
                                  code, time_pieces);
        if (string_length == 0)
        {
            /* We could put a warning here, but there's no
             * way to tell a successful conversion to
             * empty string from a failure.
             */
            buffer[0] = '\0';
        }

        /* Strip leading zeros if requested. */
        piece = buffer;
        if (strip_leading_zeros || turn_leading_zeros_to_spaces)
        {
            if (strchr (C_STANDARD_NUMERIC_STRFTIME_CHARACTERS, *remainder) == NULL)
            {
                g_warning ("eel_strdup_strftime does not support "
                           "modifier for non-numeric escape code %%%c%c",
                           remainder[-1],
                           *remainder);
            }
            if (*piece == '0')
            {
                do
                {
                    piece++;
                }
                while (*piece == '0');
                if (!g_ascii_isdigit (*piece))
                {
                    piece--;
                }
            }
            if (turn_leading_zeros_to_spaces)
            {
                memset (buffer, ' ', piece - buffer);
                piece = buffer;
            }
        }
        remainder++;

        /* Add this piece. */
        g_string_append (string, piece);
    }

    /* Convert the string back into utf-8. */
    result = g_locale_to_utf8 (string->str, -1, NULL, NULL, NULL);

    g_string_free (string, TRUE);
    g_free (converted);

    return result;
}

/**
 * eel_g_list_exactly_one_item
 *
 * Like g_list_length (list) == 1, only O(1) instead of O(n).
 * @list: List.
 *
 * Return value: TRUE if the list has exactly one item.
 **/
gboolean
eel_g_list_exactly_one_item (GList *list)
{
    return list != NULL && list->next == NULL;
}

/**
 * eel_g_list_more_than_one_item
 *
 * Like g_list_length (list) > 1, only O(1) instead of O(n).
 * @list: List.
 *
 * Return value: TRUE if the list has more than one item.
 **/
gboolean
eel_g_list_more_than_one_item (GList *list)
{
    return list != NULL && list->next != NULL;
}

/**
 * eel_g_list_equal
 *
 * Compares two lists to see if they are equal.
 * @list_a: First list.
 * @list_b: Second list.
 *
 * Return value: TRUE if the lists are the same length with the same elements.
 **/
gboolean
eel_g_list_equal (GList *list_a, GList *list_b)
{
    GList *p, *q;

    for (p = list_a, q = list_b; p != NULL && q != NULL; p = p->next, q = q->next)
    {
        if (p->data != q->data)
        {
            return FALSE;
        }
    }
    return p == NULL && q == NULL;
}

/**
 * eel_g_str_list_equal
 *
 * Compares two lists of C strings to see if they are equal.
 * @list_a: First list.
 * @list_b: Second list.
 *
 * Return value: TRUE if the lists contain the same strings.
 **/
gboolean
eel_g_str_list_equal (GList *list_a, GList *list_b)
{
    GList *p, *q;

    for (p = list_a, q = list_b; p != NULL && q != NULL; p = p->next, q = q->next)
    {
        if (eel_strcmp (p->data, q->data) != 0)
        {
            return FALSE;
        }
    }
    return p == NULL && q == NULL;
}

/**
 * eel_g_str_list_alphabetize
 *
 * Sort a list of strings using locale-sensitive rules.
 *
 * @list: List of strings and/or NULLs.
 *
 * Return value: @list, sorted.
 **/
GList *
eel_g_str_list_alphabetize (GList *list)
{
    return g_list_sort (list, (GCompareFunc) g_utf8_collate);
}

int
eel_g_str_list_index (GList *str_list,
                      const char *str)
{
    int i;
    GList *l;
    for (i = 0, l = str_list; l != NULL; l = l->next, i++)
    {
        if (!strcmp (str, (const char*)l->data))
        {
            return i;
        }
    }
    return -1;
}

/**
 * eel_g_list_free_deep
 *
 * Frees the elements of a list and then the list.
 * @list: List of elements that can be freed with g_free.
 **/
void
eel_g_list_free_deep (GList *list)
{
	g_list_free_full (list, (GDestroyNotify) g_free);
}

/**
 * eel_g_strv_find
 *
 * Get index of string in array of strings.
 *
 * @strv: NULL-terminated array of strings.
 * @find_me: string to search for.
 *
 * Return value: index of array entry in @strv that
 * matches @find_me, or -1 if no matching entry.
 */
int
eel_g_strv_find (char **strv, const char *find_me)
{
    int index;

    g_return_val_if_fail (find_me != NULL, -1);

    for (index = 0; strv[index] != NULL; ++index)
    {
        if (strcmp (strv[index], find_me) == 0)
        {
            return index;
        }
    }

    return -1;
}

gboolean
eel_g_strv_equal (char **a, char **b)
{
    int i;

    if (g_strv_length (a) != g_strv_length (b))
    {
        return FALSE;
    }

    for (i = 0; a[i] != NULL; i++)
    {
        if (strcmp (a[i], b[i]) != 0)
        {
            return FALSE;
        }
    }
    return TRUE;
}

static int
compare_pointers (gconstpointer pointer_1, gconstpointer pointer_2)
{
    if ((const char *) pointer_1 < (const char *) pointer_2)
    {
        return -1;
    }
    if ((const char *) pointer_1 > (const char *) pointer_2)
    {
        return +1;
    }
    return 0;
}

gboolean
eel_g_lists_sort_and_check_for_intersection (GList **list_1,
        GList **list_2)

{
    GList *node_1, *node_2;
    int compare_result;

    *list_1 = g_list_sort (*list_1, compare_pointers);
    *list_2 = g_list_sort (*list_2, compare_pointers);

    node_1 = *list_1;
    node_2 = *list_2;

    while (node_1 != NULL && node_2 != NULL)
    {
        compare_result = compare_pointers (node_1->data, node_2->data);
        if (compare_result == 0)
        {
            return TRUE;
        }
        if (compare_result <= 0)
        {
            node_1 = node_1->next;
        }
        if (compare_result >= 0)
        {
            node_2 = node_2->next;
        }
    }

    return FALSE;
}


/**
 * eel_g_list_partition
 *
 * Parition a list into two parts depending on whether the data
 * elements satisfy a provided predicate. Order is preserved in both
 * of the resulting lists, and the original list is consumed. A list
 * of the items that satisfy the predicate is returned, and the list
 * of items not satisfying the predicate is returned via the failed
 * out argument.
 *
 * @list: List to partition.
 * @predicate: Function to call on each element.
 * @user_data: Data to pass to function.
 * @failed: The GList * variable pointed to by this argument will be
 * set to the list of elements for which the predicate returned
 * false. */

GList *
eel_g_list_partition (GList *list,
                      EelPredicateFunction  predicate,
                      gpointer user_data,
                      GList **failed)
{
    GList *predicate_true;
    GList *predicate_false;
    GList *reverse;
    GList *p;
    GList *next;

    predicate_true = NULL;
    predicate_false = NULL;

    reverse = g_list_reverse (list);

    for (p = reverse; p != NULL; p = next)
    {
        next = p->next;

        if (next != NULL)
        {
            next->prev = NULL;
        }

        if (predicate (p->data, user_data))
        {
            p->next = predicate_true;
            if (predicate_true != NULL)
            {
                predicate_true->prev = p;
            }
            predicate_true = p;
        }
        else
        {
            p->next = predicate_false;
            if (predicate_false != NULL)
            {
                predicate_false->prev = p;
            }
            predicate_false = p;
        }
    }

    *failed = predicate_false;
    return predicate_true;
}

/**
 * eel_get_system_time
 *
 * Return value: number of microseconds since the machine was turned on
 */
gint64
eel_get_system_time (void)
{
    struct timeval tmp;

    gettimeofday (&tmp, NULL);
    return (gint64)tmp.tv_usec + (gint64)tmp.tv_sec * G_GINT64_CONSTANT (1000000);
}

static void
print_key_string (gpointer key, gpointer value, gpointer callback_data)
{
    g_assert (callback_data == NULL);

    g_print ("--> %s\n", (char *) key);
}

static void
free_hash_tables_at_exit (void)
{
    GList *p;
    HashTableToFree *hash_table_to_free;
    guint size;

    for (p = hash_tables_to_free_at_exit; p != NULL; p = p->next)
    {
        hash_table_to_free = p->data;

        size = g_hash_table_size (hash_table_to_free->hash_table);
        if (size != 0)
        {
            if (hash_table_to_free->keys_known_to_be_strings)
            {
                g_print ("\n--- Hash table keys for warning below:\n");
                g_hash_table_foreach (hash_table_to_free->hash_table,
                                      print_key_string,
                                      NULL);
            }
            g_warning ("\"%s\" hash table still has %u element%s at quit time%s",
                       hash_table_to_free->display_name, size,
                       size == 1 ? "" : "s",
                       hash_table_to_free->keys_known_to_be_strings
                       ? " (keys above)" : "");
        }

        g_hash_table_destroy (hash_table_to_free->hash_table);
        g_free (hash_table_to_free->display_name);
        g_free (hash_table_to_free);
    }
    g_list_free (hash_tables_to_free_at_exit);
    hash_tables_to_free_at_exit = NULL;
}

GHashTable *
eel_g_hash_table_new_free_at_exit (GHashFunc hash_func,
                                   GCompareFunc key_compare_func,
                                   const char *display_name)
{
    GHashTable *hash_table;
    HashTableToFree *hash_table_to_free;

    /* FIXME: We can take out the CAJA_DEBUG check once we
     * have fixed more of the leaks. For now, it's a bit too noisy
     * for the general public.
     */
    if (hash_tables_to_free_at_exit == NULL)
    {
        eel_debug_call_at_shutdown (free_hash_tables_at_exit);
    }

    hash_table = g_hash_table_new (hash_func, key_compare_func);

    hash_table_to_free = g_new (HashTableToFree, 1);
    hash_table_to_free->hash_table = hash_table;
    hash_table_to_free->display_name = g_strdup (display_name);
    hash_table_to_free->keys_known_to_be_strings =
        hash_func == g_str_hash;

    hash_tables_to_free_at_exit = g_list_prepend
                                  (hash_tables_to_free_at_exit, hash_table_to_free);

    return hash_table;
}

typedef struct
{
    GList *keys;
    GList *values;
} FlattenedHashTable;

static void
flatten_hash_table_element (gpointer key, gpointer value, gpointer callback_data)
{
    FlattenedHashTable *flattened_table;

    flattened_table = callback_data;
    flattened_table->keys = g_list_prepend
                            (flattened_table->keys, key);
    flattened_table->values = g_list_prepend
                              (flattened_table->values, value);
}

void
eel_g_hash_table_safe_for_each (GHashTable *hash_table,
                                GHFunc callback,
                                gpointer callback_data)
{
    FlattenedHashTable flattened;
    GList *p, *q;

    flattened.keys = NULL;
    flattened.values = NULL;

    g_hash_table_foreach (hash_table,
                          flatten_hash_table_element,
                          &flattened);

    for (p = flattened.keys, q = flattened.values;
            p != NULL;
            p = p->next, q = q->next)
    {
        (* callback) (p->data, q->data, callback_data);
    }

    g_list_free (flattened.keys);
    g_list_free (flattened.values);
}

int
eel_round (double d)
{
    double val;

    val = floor (d + .5);

    /* The tests are needed because the result of floating-point to integral
     * conversion is undefined if the floating point value is not representable
     * in the new type. E.g. the magnititude is too large or a negative
     * floating-point value being converted to an unsigned.
     */
    g_return_val_if_fail (val <= INT_MAX, INT_MAX);
    g_return_val_if_fail (val >= INT_MIN, INT_MIN);

    return val;
}

/**
 * eel_add_weak_pointer
 *
 * Nulls out a saved reference to an object when the object gets destroyed.
 *
 * @pointer_location: Address of the saved pointer.
 **/
void
eel_add_weak_pointer (gpointer pointer_location)
{
    gpointer *object_location;

    g_return_if_fail (pointer_location != NULL);

    object_location = (gpointer *) pointer_location;
    if (*object_location == NULL)
    {
        /* The reference is NULL, nothing to do. */
        return;
    }

    g_return_if_fail (G_IS_OBJECT (*object_location));

    g_object_add_weak_pointer (G_OBJECT (*object_location),
                               object_location);
}

/**
 * eel_remove_weak_pointer
 *
 * Removes the weak pointer that was added by eel_add_weak_pointer.
 * Also nulls out the pointer.
 *
 * @pointer_location: Pointer that was passed to eel_add_weak_pointer.
 **/
void
eel_remove_weak_pointer (gpointer pointer_location)
{
    gpointer *object_location;

    g_return_if_fail (pointer_location != NULL);

    object_location = (gpointer *) pointer_location;
    if (*object_location == NULL)
    {
        /* The object was already destroyed and the reference
         * nulled out, nothing to do.
         */
        return;
    }

    g_return_if_fail (G_IS_OBJECT (*object_location));

    g_object_remove_weak_pointer (G_OBJECT (*object_location),
                                  object_location);

    *object_location = NULL;
}

static void
update_auto_boolean (GSettings   *settings,
                     const gchar *key,
                     gpointer     user_data)
{
    int *storage = user_data;

    *storage = g_settings_get_boolean (settings, key);
}

void
eel_g_settings_add_auto_boolean (GSettings *settings,
                 const char *key,
                 gboolean *storage)
{
    char *signal;

    *storage = g_settings_get_boolean (settings, key);
    signal = g_strconcat ("changed::", key, NULL);
    g_signal_connect (settings, signal,
              G_CALLBACK(update_auto_boolean),
              storage);

    g_free (signal);
}

static void
update_auto_int (GSettings   *settings,
                 const gchar *key,
                 gpointer     user_data)
{
    int *storage = user_data;

    *storage = g_settings_get_int (settings, key);
}

void
eel_g_settings_add_auto_int (GSettings *settings,
                             const char *key,
                             int *storage)
{
    char *signal;

    *storage = g_settings_get_int (settings, key);
    signal = g_strconcat ("changed::", key, NULL);
    g_signal_connect (settings, signal,
              G_CALLBACK(update_auto_int),
              storage);

    g_free (signal);
}

static void
update_auto_enum (GSettings   *settings,
                  const gchar *key,
                  gpointer     user_data)
{
    int *storage = user_data;

    *storage = g_settings_get_enum (settings, key);
}

void
eel_g_settings_add_auto_enum (GSettings *settings,
                              const char *key,
                              int *storage)
{
    char *signal;

    *storage = g_settings_get_enum (settings, key);
    signal = g_strconcat ("changed::", key, NULL);
    g_signal_connect (settings, signal,
                      G_CALLBACK(update_auto_enum),
                      storage);

    g_free (signal);
}

static void
update_auto_strv_as_quarks (GSettings   *settings,
                            const gchar *key,
                            gpointer     user_data)
{
    GQuark **storage = user_data;
    int i = 0;
    char **value;

    value = g_settings_get_strv (settings, key);

    g_free (*storage);
    *storage = g_new (GQuark, g_strv_length (value) + 1);

    for (i = 0; value[i] != NULL; ++i) {
        (*storage)[i] = g_quark_from_string (value[i]);
    }
    (*storage)[i] = 0;

    g_strfreev (value);
}

static void
update_auto_strv (GSettings   *settings,
          const gchar *key,
          gpointer     user_data)
{
    char ***storage = user_data;

    g_free (*storage);
    *storage = g_settings_get_strv (settings, key);
}

void
eel_g_settings_add_auto_strv (GSettings *settings,
                  const char *key,
                  char ***storage)
{
    char *signal;

    *storage = NULL;
    update_auto_strv (settings, key, storage);
    signal = g_strconcat ("changed::", key, NULL);
    g_signal_connect (settings, signal,
              G_CALLBACK(update_auto_strv),
              storage);

    g_free (signal);
}

void
eel_g_settings_add_auto_strv_as_quarks (GSettings *settings,
                                        const char *key,
                                        GQuark **storage)
{
    char *signal;

    *storage = NULL;
    update_auto_strv_as_quarks (settings, key, storage);
    signal = g_strconcat ("changed::", key, NULL);
    g_signal_connect (settings, signal,
              G_CALLBACK(update_auto_strv_as_quarks),
              storage);

    g_free (signal);
}

#if !defined (EEL_OMIT_SELF_CHECK)

static void
check_tm_to_g_date (time_t time)
{
    struct tm *before_conversion;
    struct tm after_conversion;
    GDate *date;

    before_conversion = localtime (&time);
    date = eel_g_date_new_tm (before_conversion);

    g_date_to_struct_tm (date, &after_conversion);

    g_date_free (date);

    EEL_CHECK_INTEGER_RESULT (after_conversion.tm_mday,
                              before_conversion->tm_mday);
    EEL_CHECK_INTEGER_RESULT (after_conversion.tm_mon,
                              before_conversion->tm_mon);
    EEL_CHECK_INTEGER_RESULT (after_conversion.tm_year,
                              before_conversion->tm_year);
}

static gboolean
eel_test_predicate (gpointer data,
                    gpointer callback_data)
{
    return g_ascii_strcasecmp (data, callback_data) <= 0;
}

static char *
test_strftime (const char *format,
               int year,
               int month,
               int day,
               int hour,
               int minute,
               int second)
{
    struct tm time_pieces;

    time_pieces.tm_sec = second;
    time_pieces.tm_min = minute;
    time_pieces.tm_hour = hour;
    time_pieces.tm_mday = day;
    time_pieces.tm_mon = month - 1;
    time_pieces.tm_year = year - 1900;
    time_pieces.tm_isdst = -1;
    mktime (&time_pieces);

    return eel_strdup_strftime (format, &time_pieces);
}

void
eel_self_check_glib_extensions (void)
{
    char **strv;
    GList *compare_list_1;
    GList *compare_list_2;
    GList *compare_list_3;
    GList *compare_list_4;
    GList *compare_list_5;
    gint64 time1, time2;
    GList *list_to_partition;
    GList *expected_passed;
    GList *expected_failed;
    GList *actual_passed;
    GList *actual_failed;
    char *huge_string;

    check_tm_to_g_date (0);			/* lower limit */
    check_tm_to_g_date ((time_t) -1);	/* upper limit */
    check_tm_to_g_date (time (NULL));	/* current time */

    strv = g_strsplit ("zero|one|two|three|four", "|", 0);
    EEL_CHECK_INTEGER_RESULT (eel_g_strv_find (strv, "zero"), 0);
    EEL_CHECK_INTEGER_RESULT (eel_g_strv_find (strv, "one"), 1);
    EEL_CHECK_INTEGER_RESULT (eel_g_strv_find (strv, "four"), 4);
    EEL_CHECK_INTEGER_RESULT (eel_g_strv_find (strv, "five"), -1);
    EEL_CHECK_INTEGER_RESULT (eel_g_strv_find (strv, ""), -1);
    EEL_CHECK_INTEGER_RESULT (eel_g_strv_find (strv, "o"), -1);
    g_strfreev (strv);

    /* eel_get_system_time */
    time1 = eel_get_system_time ();
    time2 = eel_get_system_time ();
    EEL_CHECK_BOOLEAN_RESULT (time1 - time2 > -1000, TRUE);
    EEL_CHECK_BOOLEAN_RESULT (time1 - time2 <= 0, TRUE);

    /* eel_g_str_list_equal */

    /* We g_strdup because identical string constants can be shared. */

    compare_list_1 = NULL;
    compare_list_1 = g_list_append (compare_list_1, g_strdup ("Apple"));
    compare_list_1 = g_list_append (compare_list_1, g_strdup ("zebra"));
    compare_list_1 = g_list_append (compare_list_1, g_strdup ("!@#!@$#@$!"));

    compare_list_2 = NULL;
    compare_list_2 = g_list_append (compare_list_2, g_strdup ("Apple"));
    compare_list_2 = g_list_append (compare_list_2, g_strdup ("zebra"));
    compare_list_2 = g_list_append (compare_list_2, g_strdup ("!@#!@$#@$!"));

    compare_list_3 = NULL;
    compare_list_3 = g_list_append (compare_list_3, g_strdup ("Apple"));
    compare_list_3 = g_list_append (compare_list_3, g_strdup ("zebra"));

    compare_list_4 = NULL;
    compare_list_4 = g_list_append (compare_list_4, g_strdup ("Apple"));
    compare_list_4 = g_list_append (compare_list_4, g_strdup ("zebra"));
    compare_list_4 = g_list_append (compare_list_4, g_strdup ("!@#!@$#@$!"));
    compare_list_4 = g_list_append (compare_list_4, g_strdup ("foobar"));

    compare_list_5 = NULL;
    compare_list_5 = g_list_append (compare_list_5, g_strdup ("Apple"));
    compare_list_5 = g_list_append (compare_list_5, g_strdup ("zzzzzebraaaaaa"));
    compare_list_5 = g_list_append (compare_list_5, g_strdup ("!@#!@$#@$!"));

    EEL_CHECK_BOOLEAN_RESULT (eel_g_str_list_equal (compare_list_1, compare_list_2), TRUE);
    EEL_CHECK_BOOLEAN_RESULT (eel_g_str_list_equal (compare_list_1, compare_list_3), FALSE);
    EEL_CHECK_BOOLEAN_RESULT (eel_g_str_list_equal (compare_list_1, compare_list_4), FALSE);
    EEL_CHECK_BOOLEAN_RESULT (eel_g_str_list_equal (compare_list_1, compare_list_5), FALSE);

    g_list_free_full (compare_list_1, g_free);
    g_list_free_full (compare_list_2, g_free);
    g_list_free_full (compare_list_3, g_free);
    g_list_free_full (compare_list_4, g_free);
    g_list_free_full (compare_list_5, g_free);

    /* eel_g_list_partition */

    list_to_partition = NULL;
    list_to_partition = g_list_append (list_to_partition, "Cadillac");
    list_to_partition = g_list_append (list_to_partition, "Pontiac");
    list_to_partition = g_list_append (list_to_partition, "Ford");
    list_to_partition = g_list_append (list_to_partition, "Range Rover");

    expected_passed = NULL;
    expected_passed = g_list_append (expected_passed, "Cadillac");
    expected_passed = g_list_append (expected_passed, "Ford");

    expected_failed = NULL;
    expected_failed = g_list_append (expected_failed, "Pontiac");
    expected_failed = g_list_append (expected_failed, "Range Rover");

    actual_passed = eel_g_list_partition (list_to_partition,
                                          eel_test_predicate,
                                          "m",
                                          &actual_failed);

    EEL_CHECK_BOOLEAN_RESULT (eel_g_str_list_equal (expected_passed, actual_passed), TRUE);
    EEL_CHECK_BOOLEAN_RESULT (eel_g_str_list_equal (expected_failed, actual_failed), TRUE);

    /* Don't free "list_to_partition", since it is consumed
     * by eel_g_list_partition.
     */

    g_list_free (expected_passed);
    g_list_free (actual_passed);
    g_list_free (expected_failed);
    g_list_free (actual_failed);

    /* eel_strdup_strftime */
    huge_string = g_new (char, 10000+1);
    memset (huge_string, 'a', 10000);
    huge_string[10000] = '\0';

    setlocale (LC_TIME, "C");

    EEL_CHECK_STRING_RESULT (test_strftime ("", 2000, 1, 1, 0, 0, 0), "");
    EEL_CHECK_STRING_RESULT (test_strftime (huge_string, 2000, 1, 1, 0, 0, 0), huge_string);
    EEL_CHECK_STRING_RESULT (test_strftime ("%%", 2000, 1, 1, 1, 0, 0), "%");
    EEL_CHECK_STRING_RESULT (test_strftime ("%%%%", 2000, 1, 1, 1, 0, 0), "%%");
    EEL_CHECK_STRING_RESULT (test_strftime ("%m/%d/%y, %I:%M %p", 2000, 1, 1, 1, 0, 0), "01/01/00, 01:00 AM");
    EEL_CHECK_STRING_RESULT (test_strftime ("%-m/%-d/%y, %-I:%M %p", 2000, 1, 1, 1, 0, 0), "1/1/00, 1:00 AM");
    EEL_CHECK_STRING_RESULT (test_strftime ("%_m/%_d/%y, %_I:%M %p", 2000, 1, 1, 1, 0, 0), " 1/ 1/00,  1:00 AM");

    setlocale (LC_TIME, "");

    g_free (huge_string);
}

#endif /* !EEL_OMIT_SELF_CHECK */