Move doc comments inline.
[glib.git] / tests / keyfile-test.c
blob9b2559f337edac2b4feaf50348398640e9296735
1 #include <glib.h>
2 #include <locale.h>
3 #include <string.h>
4 #include <stdlib.h>
6 static GKeyFile *
7 load_data (const gchar *data,
8 GKeyFileFlags flags)
10 GKeyFile *keyfile;
11 GError *error = NULL;
13 keyfile = g_key_file_new ();
14 g_key_file_load_from_data (keyfile, data, -1, flags, &error);
15 if (error)
17 g_print ("Could not load data: %s\n", error->message);
18 exit (1);
21 return keyfile;
24 static void
25 check_error (GError **error,
26 GQuark domain,
27 gint code)
29 if (*error == NULL)
31 g_print ("Missing an error\n");
32 exit (1);
35 if ((*error)->domain != domain)
37 g_print ("Wrong error domain: got %s, expected %s\n",
38 g_quark_to_string ((*error)->domain),
39 g_quark_to_string (domain));
40 exit (1);
43 if ((*error)->code != code)
45 g_print ("Wrong error code: got %d, expected %d\n",
46 (*error)->code, code);
47 exit (1);
50 g_error_free (*error);
51 *error = NULL;
54 static void
55 check_no_error (GError **error)
57 if (*error != NULL)
59 g_print ("Unexpected error: (%s, %d) %s\n",
60 g_quark_to_string ((*error)->domain),
61 (*error)->code, (*error)->message);
62 exit (1);
66 static void
67 check_string_value (GKeyFile *keyfile,
68 const gchar *group,
69 const gchar *key,
70 const gchar *expected)
72 GError *error = NULL;
73 gchar *value;
75 value = g_key_file_get_string (keyfile, group, key, &error);
76 check_no_error (&error);
77 g_assert (value != NULL);
79 if (strcmp (value, expected) != 0)
81 g_print ("Group %s key %s: "
82 "expected string value '%s', actual value '%s'\n",
83 group, key, expected, value);
84 exit (1);
87 g_free (value);
90 static void
91 check_locale_string_value (GKeyFile *keyfile,
92 const gchar *group,
93 const gchar *key,
94 const gchar *locale,
95 const gchar *expected)
97 GError *error = NULL;
98 gchar *value;
100 value = g_key_file_get_locale_string (keyfile, group, key, locale, &error);
101 check_no_error (&error);
102 g_assert (value != NULL);
104 if (strcmp (value, expected) != 0)
106 g_print ("Group %s key %s locale %s: "
107 "expected string value '%s', actual value '%s'\n",
108 group, key, locale, expected, value);
109 exit (1);
112 g_free (value);
115 static void
116 check_string_list_value (GKeyFile *keyfile,
117 const gchar *group,
118 const gchar *key,
119 ...)
121 gint i;
122 gchar *v, **value;
123 va_list args;
124 gsize len;
125 GError *error = NULL;
127 value = g_key_file_get_string_list (keyfile, group, key, &len, &error);
128 check_no_error (&error);
129 g_assert (value != NULL);
131 va_start (args, key);
132 i = 0;
133 v = va_arg (args, gchar*);
134 while (v)
136 if (value[i] == NULL)
138 g_print ("Group %s key %s: list too short (%d)\n",
139 group, key, i);
140 exit (1);
142 if (strcmp (v, value[i]) != 0)
144 g_print ("Group %s key %s: mismatch at %d, expected %s, got %s\n",
145 group, key, i, v, value[i]);
146 exit (1);
149 i++;
150 v = va_arg (args, gchar*);
153 va_end (args);
155 g_strfreev (value);
158 static void
159 check_integer_list_value (GKeyFile *keyfile,
160 const gchar *group,
161 const gchar *key,
162 ...)
164 gint i;
165 gint v, *value;
166 va_list args;
167 gsize len;
168 GError *error = NULL;
170 value = g_key_file_get_integer_list (keyfile, group, key, &len, &error);
171 check_no_error (&error);
172 g_assert (value != NULL);
174 va_start (args, key);
175 i = 0;
176 v = va_arg (args, gint);
177 while (v != -100)
179 if (i == len)
181 g_print ("Group %s key %s: list too short (%d)\n",
182 group, key, i);
183 exit (1);
185 if (value[i] != v)
187 g_print ("Group %s key %s: mismatch at %d, expected %d, got %d\n",
188 group, key, i, v, value[i]);
189 exit (1);
192 i++;
193 v = va_arg (args, gint);
196 va_end (args);
198 g_free (value);
201 static void
202 check_boolean_list_value (GKeyFile *keyfile,
203 const gchar *group,
204 const gchar *key,
205 ...)
207 gint i;
208 gboolean v, *value;
209 va_list args;
210 gsize len;
211 GError *error = NULL;
213 value = g_key_file_get_boolean_list (keyfile, group, key, &len, &error);
214 check_no_error (&error);
215 g_assert (value != NULL);
217 va_start (args, key);
218 i = 0;
219 v = va_arg (args, gboolean);
220 while (v != -100)
222 if (i == len)
224 g_print ("Group %s key %s: list too short (%d)\n",
225 group, key, i);
226 exit (1);
228 if (value[i] != v)
230 g_print ("Group %s key %s: mismatch at %d, expected %d, got %d\n",
231 group, key, i, v, value[i]);
232 exit (1);
235 i++;
236 v = va_arg (args, gboolean);
239 va_end (args);
241 g_free (value);
244 static void
245 check_boolean_value (GKeyFile *keyfile,
246 const gchar *group,
247 const gchar *key,
248 gboolean expected)
250 GError *error = NULL;
251 gboolean value;
253 value = g_key_file_get_boolean (keyfile, group, key, &error);
254 check_no_error (&error);
256 if (value != expected)
258 g_print ("Group %s key %s: "
259 "expected boolean value '%s', actual value '%s'\n",
260 group, key,
261 expected ? "true" : "false",
262 value ? "true" : "false");
263 exit (1);
267 static void
268 check_integer_value (GKeyFile *keyfile,
269 const gchar *group,
270 const gchar *key,
271 gint expected)
273 GError *error = NULL;
274 gint value;
276 value = g_key_file_get_integer (keyfile, group, key, &error);
277 check_no_error (&error);
279 if (value != expected)
281 g_print ("Group %s key %s: "
282 "expected integer value %d, actual value %d\n",
283 group, key, expected, value);
284 exit (1);
288 static void
289 check_name (const gchar *what,
290 const gchar *value,
291 const gchar *expected,
292 gint position)
294 if (strcmp (expected, value) != 0)
296 g_print ("Wrong %s returned: got %s at %d, expected %s\n",
297 what, value, position, expected);
298 exit (1);
302 static void
303 check_length (const gchar *what,
304 gint n_items,
305 gint length,
306 gint expected)
308 if (n_items != length || length != expected)
310 g_print ("Wrong number of %s returned: got %d items, length %d, expected %d\n",
311 what, n_items, length, expected);
312 exit (1);
317 /* check that both \n and \r\n are accepted as line ends,
318 * and that stray \r are passed through
320 static void
321 test_line_ends (void)
323 GKeyFile *keyfile;
325 const gchar *data =
326 "[group1]\n"
327 "key1=value1\n"
328 "key2=value2\r\n"
329 "[group2]\r\n"
330 "key3=value3\r\r\n"
331 "key4=value4\n";
333 keyfile = load_data (data, 0);
335 check_string_value (keyfile, "group1", "key1", "value1");
336 check_string_value (keyfile, "group1", "key2", "value2");
337 check_string_value (keyfile, "group2", "key3", "value3\r");
338 check_string_value (keyfile, "group2", "key4", "value4");
340 g_key_file_free (keyfile);
343 /* check handling of whitespace
345 static void
346 test_whitespace (void)
348 GKeyFile *keyfile;
350 const gchar *data =
351 "[group1]\n"
352 "key1 = value1\n"
353 "key2\t=\tvalue2\n"
354 " [ group2 ] \n"
355 "key3 = value3 \n"
356 "key4 = value \t4\n"
357 " key5 = value5\n";
359 keyfile = load_data (data, 0);
361 check_string_value (keyfile, "group1", "key1", "value1");
362 check_string_value (keyfile, "group1", "key2", "value2");
363 check_string_value (keyfile, " group2 ", "key3", "value3 ");
364 check_string_value (keyfile, " group2 ", "key4", "value \t4");
365 check_string_value (keyfile, " group2 ", "key5", "value5");
367 g_key_file_free (keyfile);
370 /* check key and group listing */
371 static void
372 test_listing (void)
374 GKeyFile *keyfile;
375 gchar **names;
376 gsize len;
377 gchar *start;
378 GError *error = NULL;
380 const gchar *data =
381 "[group1]\n"
382 "key1=value1\n"
383 "key2=value2\n"
384 "[group2]\n"
385 "key3=value3\n"
386 "key4=value4\n";
388 keyfile = load_data (data, 0);
390 names = g_key_file_get_groups (keyfile, &len);
391 if (names == NULL)
393 g_print ("Error listing groups\n");
394 exit (1);
397 check_length ("groups", g_strv_length (names), len, 2);
398 check_name ("group name", names[0], "group1", 0);
399 check_name ("group name", names[1], "group2", 1);
401 g_strfreev (names);
403 names = g_key_file_get_keys (keyfile, "group1", &len, &error);
404 check_no_error (&error);
406 check_length ("keys", g_strv_length (names), len, 2);
407 check_name ("key", names[0], "key1", 0);
408 check_name ("key", names[1], "key2", 1);
410 g_strfreev (names);
412 names = g_key_file_get_keys (keyfile, "no-such-group", &len, &error);
413 check_error (&error, G_KEY_FILE_ERROR, G_KEY_FILE_ERROR_GROUP_NOT_FOUND);
415 g_strfreev (names);
417 if (!g_key_file_has_group (keyfile, "group1") ||
418 !g_key_file_has_group (keyfile, "group2") ||
419 g_key_file_has_group (keyfile, "group10") ||
420 g_key_file_has_group (keyfile, "group2 "))
422 g_print ("Group finding trouble\n");
423 exit (1);
426 start = g_key_file_get_start_group (keyfile);
427 if (!start || strcmp (start, "group1") != 0)
429 g_print ("Start group finding trouble\n");
430 exit (1);
432 g_free (start);
434 if (!g_key_file_has_key (keyfile, "group1", "key1", &error) ||
435 !g_key_file_has_key (keyfile, "group2", "key3", &error) ||
436 g_key_file_has_key (keyfile, "group2", "no-such-key", &error))
438 g_print ("Key finding trouble\n");
439 exit (1);
441 check_no_error (&error);
443 g_key_file_has_key (keyfile, "no-such-group", "key", &error);
444 check_error (&error, G_KEY_FILE_ERROR, G_KEY_FILE_ERROR_GROUP_NOT_FOUND);
446 g_key_file_free (keyfile);
449 /* check parsing of string values */
450 static void
451 test_string (void)
453 GKeyFile *keyfile;
454 GError *error = NULL;
455 gchar *value;
457 const gchar *data =
458 "[valid]\n"
459 "key1=\\s\\n\\t\\r\\\\\n"
460 "key2=\"quoted\"\n"
461 "key3='quoted'\n"
462 "key4=\xe2\x89\xa0\xe2\x89\xa0\n"
463 "[invalid]\n"
464 "key1=\\a\\b\\0800xff\n"
465 "key2=blabla\\\n";
467 keyfile = load_data (data, 0);
469 check_string_value (keyfile, "valid", "key1", " \n\t\r\\");
470 check_string_value (keyfile, "valid", "key2", "\"quoted\"");
471 check_string_value (keyfile, "valid", "key3", "'quoted'");
472 check_string_value (keyfile, "valid", "key4", "\xe2\x89\xa0\xe2\x89\xa0");
474 value = g_key_file_get_string (keyfile, "invalid", "key1", &error);
475 check_error (&error, G_KEY_FILE_ERROR, G_KEY_FILE_ERROR_INVALID_VALUE);
476 g_free (value);
478 value = g_key_file_get_string (keyfile, "invalid", "key2", &error);
479 check_error (&error, G_KEY_FILE_ERROR, G_KEY_FILE_ERROR_INVALID_VALUE);
480 g_free (value);
482 g_key_file_free (keyfile);
485 /* check parsing of boolean values */
486 static void
487 test_boolean (void)
489 GKeyFile *keyfile;
490 GError *error = NULL;
492 const gchar *data =
493 "[valid]\n"
494 "key1=true\n"
495 "key2=false\n"
496 "key3=1\n"
497 "key4=0\n"
498 "[invalid]\n"
499 "key1=t\n"
500 "key2=f\n"
501 "key3=yes\n"
502 "key4=no\n";
504 keyfile = load_data (data, 0);
506 check_boolean_value (keyfile, "valid", "key1", TRUE);
507 check_boolean_value (keyfile, "valid", "key2", FALSE);
508 check_boolean_value (keyfile, "valid", "key3", TRUE);
509 check_boolean_value (keyfile, "valid", "key4", FALSE);
511 g_key_file_get_boolean (keyfile, "invalid", "key1", &error);
512 check_error (&error, G_KEY_FILE_ERROR, G_KEY_FILE_ERROR_INVALID_VALUE);
514 g_key_file_get_boolean (keyfile, "invalid", "key2", &error);
515 check_error (&error, G_KEY_FILE_ERROR, G_KEY_FILE_ERROR_INVALID_VALUE);
517 g_key_file_get_boolean (keyfile, "invalid", "key3", &error);
518 check_error (&error, G_KEY_FILE_ERROR, G_KEY_FILE_ERROR_INVALID_VALUE);
520 g_key_file_get_boolean (keyfile, "invalid", "key4", &error);
521 check_error (&error, G_KEY_FILE_ERROR, G_KEY_FILE_ERROR_INVALID_VALUE);
523 g_key_file_free (keyfile);
526 /* check parsing of integer values */
527 static void
528 test_integer (void)
530 GKeyFile *keyfile;
531 GError *error = NULL;
533 const gchar *data =
534 "[valid]\n"
535 "key1=0\n"
536 "key2=1\n"
537 "key3=-1\n"
538 "key4=2324431\n"
539 "key5=-2324431\n"
540 "key6=000111\n"
541 "[invalid]\n"
542 "key1=0xffff\n"
543 "key2=0.5\n"
544 "key3=1e37\n"
545 "key4=ten\n";
547 keyfile = load_data (data, 0);
549 check_integer_value (keyfile, "valid", "key1", 0);
550 check_integer_value (keyfile, "valid", "key2", 1);
551 check_integer_value (keyfile, "valid", "key3", -1);
552 check_integer_value (keyfile, "valid", "key4", 2324431);
553 check_integer_value (keyfile, "valid", "key5", -2324431);
554 check_integer_value (keyfile, "valid", "key6", 111);
556 g_key_file_get_integer (keyfile, "invalid", "key1", &error);
557 check_error (&error, G_KEY_FILE_ERROR, G_KEY_FILE_ERROR_INVALID_VALUE);
559 g_key_file_get_integer (keyfile, "invalid", "key2", &error);
560 check_error (&error, G_KEY_FILE_ERROR, G_KEY_FILE_ERROR_INVALID_VALUE);
562 g_key_file_get_integer (keyfile, "invalid", "key3", &error);
563 check_error (&error, G_KEY_FILE_ERROR, G_KEY_FILE_ERROR_INVALID_VALUE);
565 g_key_file_get_integer (keyfile, "invalid", "key4", &error);
566 check_error (&error, G_KEY_FILE_ERROR, G_KEY_FILE_ERROR_INVALID_VALUE);
568 g_key_file_free (keyfile);
571 /* check handling of translated strings */
572 static void
573 test_locale_string (void)
575 GKeyFile *keyfile;
576 GError *error = NULL;
577 gchar *value;
579 const gchar *data =
580 "[valid]\n"
581 "key1=v1\n"
582 "key1[de]=v1-de\n"
583 "key1[de_DE]=v1-de_DE\n"
584 "key1[de_DE.UTF8]=v1-de_DE.UTF8\n"
585 "key1[fr]=v1-fr\n"
586 "key1[en] =v1-en\n"
587 "[invalid]\n"
588 "key1[de=v1\n"
589 "key1[fr]]=v2\n"
590 "key1 [en]=v3\n";
592 keyfile = load_data (data, G_KEY_FILE_KEEP_TRANSLATIONS);
594 check_locale_string_value (keyfile, "valid", "key1", "it", "v1");
595 check_locale_string_value (keyfile, "valid", "key1", "de", "v1-de");
596 check_locale_string_value (keyfile, "valid", "key1", "de_DE", "v1-de_DE");
597 check_locale_string_value (keyfile, "valid", "key1", "de_DE.UTF8", "v1-de_DE.UTF8");
598 check_locale_string_value (keyfile, "valid", "key1", "fr", "v1-fr");
599 check_locale_string_value (keyfile, "valid", "key1", "fr_FR", "v1-fr");
600 check_locale_string_value (keyfile, "valid", "key1", "en", "v1-en");
602 value = g_key_file_get_locale_string (keyfile, "invalid", "key1", "de", &error);
603 check_error (&error, G_KEY_FILE_ERROR, G_KEY_FILE_ERROR_KEY_NOT_FOUND);
604 g_free (value);
606 value = g_key_file_get_locale_string (keyfile, "invalid", "key1", "fr", &error);
607 check_error (&error, G_KEY_FILE_ERROR, G_KEY_FILE_ERROR_KEY_NOT_FOUND);
608 g_free (value);
610 value = g_key_file_get_locale_string (keyfile, "invalid", "key1", "en", &error);
611 check_error (&error, G_KEY_FILE_ERROR, G_KEY_FILE_ERROR_KEY_NOT_FOUND);
612 g_free (value);
614 g_key_file_free (keyfile);
616 /* now test that translations are thrown away */
618 g_setenv ("LC_ALL", "de", TRUE);
619 setlocale (LC_ALL, "");
621 keyfile = load_data (data, 0);
623 check_locale_string_value (keyfile, "valid", "key1", "it", "v1");
624 check_locale_string_value (keyfile, "valid", "key1", "de", "v1-de");
625 check_locale_string_value (keyfile, "valid", "key1", "de_DE", "v1-de");
626 check_locale_string_value (keyfile, "valid", "key1", "de_DE.UTF8", "v1-de");
627 check_locale_string_value (keyfile, "valid", "key1", "fr", "v1");
628 check_locale_string_value (keyfile, "valid", "key1", "fr_FR", "v1");
629 check_locale_string_value (keyfile, "valid", "key1", "en", "v1");
631 g_key_file_free (keyfile);
634 static void
635 test_lists (void)
637 GKeyFile *keyfile;
639 const gchar *data =
640 "[valid]\n"
641 "key1=v1;v2\n"
642 "key2=v1;v2;\n"
643 "key3=v1,v2\n"
644 "key4=v1\\;v2\n"
645 "key5=true;false\n"
646 "key6=1;0;-1\n"
647 "key7= 1 ; 0 ; -1 \n"
648 "key8=v1\\,v2\n";
650 keyfile = load_data (data, 0);
652 check_string_list_value (keyfile, "valid", "key1", "v1", "v2", NULL);
653 check_string_list_value (keyfile, "valid", "key2", "v1", "v2", NULL);
654 check_string_list_value (keyfile, "valid", "key3", "v1,v2", NULL);
655 check_string_list_value (keyfile, "valid", "key4", "v1;v2", NULL);
656 check_boolean_list_value (keyfile, "valid", "key5", TRUE, FALSE, -100);
657 check_integer_list_value (keyfile, "valid", "key6", 1, 0, -1, -100);
658 /* maybe these should be valid */
659 /* check_integer_list_value (keyfile, "valid", "key7", 1, 0, -1, -100);*/
660 /* check_string_list_value (keyfile, "valid", "key8", "v1\\,v2", NULL);*/
662 g_key_file_free (keyfile);
664 /* Now check an alternate separator */
666 keyfile = load_data (data, 0);
667 g_key_file_set_list_separator (keyfile, ',');
669 check_string_list_value (keyfile, "valid", "key1", "v1;v2", NULL);
670 check_string_list_value (keyfile, "valid", "key2", "v1;v2;", NULL);
671 check_string_list_value (keyfile, "valid", "key3", "v1", "v2", NULL);
673 g_key_file_free (keyfile);
676 /* http://bugzilla.gnome.org/show_bug.cgi?id=165887 */
677 static void
678 test_group_remove (void)
680 GKeyFile *keyfile;
681 gchar **names;
682 gsize len;
683 GError *error = NULL;
685 const gchar *data =
686 "[group1]\n"
687 "[group2]\n"
688 "key1=bla\n"
689 "key2=bla\n"
690 "[group3]\n"
691 "key1=bla\n"
692 "key2=bla\n";
694 keyfile = load_data (data, 0);
696 names = g_key_file_get_groups (keyfile, &len);
697 if (names == NULL)
699 g_print ("Error listing groups\n");
700 exit (1);
703 check_length ("groups", g_strv_length (names), len, 3);
704 check_name ("group name", names[0], "group1", 0);
705 check_name ("group name", names[1], "group2", 1);
706 check_name ("group name", names[2], "group3", 2);
708 g_key_file_remove_group (keyfile, "group1", &error);
709 check_no_error (&error);
711 names = g_key_file_get_groups (keyfile, &len);
712 if (names == NULL)
714 g_print ("Error listing groups\n");
715 exit (1);
718 check_length ("groups", g_strv_length (names), len, 2);
719 check_name ("group name", names[0], "group2", 0);
720 check_name ("group name", names[1], "group3", 1);
722 g_key_file_remove_group (keyfile, "group2", &error);
723 check_no_error (&error);
725 names = g_key_file_get_groups (keyfile, &len);
726 if (names == NULL)
728 g_print ("Error listing groups\n");
729 exit (1);
732 check_length ("groups", g_strv_length (names), len, 1);
733 check_name ("group name", names[0], "group3", 0);
735 g_key_file_remove_group (keyfile, "no such group", &error);
736 check_error (&error, G_KEY_FILE_ERROR, G_KEY_FILE_ERROR_GROUP_NOT_FOUND);
738 g_key_file_free (keyfile);
741 /* http://bugzilla.gnome.org/show_bug.cgi?id=165980 */
742 static void
743 test_key_remove (void)
745 GKeyFile *keyfile;
746 gchar *value;
747 GError *error = NULL;
749 const gchar *data =
750 "[group1]\n"
751 "key1=bla\n"
752 "key2=bla\n";
754 keyfile = load_data (data, 0);
756 check_string_value (keyfile, "group1", "key1", "bla");
758 g_key_file_remove_key (keyfile, "group1", "key1", &error);
759 check_no_error (&error);
761 value = g_key_file_get_string (keyfile, "group1", "key1", &error);
762 check_error (&error, G_KEY_FILE_ERROR, G_KEY_FILE_ERROR_KEY_NOT_FOUND);
763 g_free (value);
765 g_key_file_remove_key (keyfile, "group1", "key1", &error);
766 check_error (&error, G_KEY_FILE_ERROR, G_KEY_FILE_ERROR_KEY_NOT_FOUND);
768 g_key_file_remove_key (keyfile, "no such group", "key1", &error);
769 check_error (&error, G_KEY_FILE_ERROR, G_KEY_FILE_ERROR_GROUP_NOT_FOUND);
771 g_key_file_free (keyfile);
776 main (int argc, char *argv[])
778 test_line_ends ();
779 test_whitespace ();
780 test_listing ();
781 test_string ();
782 test_boolean ();
783 test_integer ();
784 test_locale_string ();
785 test_lists ();
786 test_group_remove ();
787 test_key_remove ();
789 return 0;