2 * Copyright (C) 2011 Red Hat Inc.
5 * Benjamin Otte <otte@redhat.com>
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Library General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Library General Public License for more details.
17 * You should have received a copy of the GNU Library General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
26 #include <glib/gstdio.h>
29 #define DEPTH_INCREMENT 2
32 get_test_file (const char *test_file,
33 const char *extension,
36 GString *file = g_string_new (NULL);
38 if (g_str_has_suffix (test_file, ".ui"))
39 g_string_append_len (file, test_file, strlen (test_file) - strlen (".ui"));
41 g_string_append (file, test_file);
43 g_string_append (file, extension);
46 !g_file_test (file->str, G_FILE_TEST_EXISTS))
48 g_string_free (file, TRUE);
52 return g_string_free (file, FALSE);
56 diff_with_file (const char *file1,
61 const char *command[] = { "diff", "-u", file1, NULL, NULL };
70 /* write the text buffer to a temporary file */
71 fd = g_file_open_tmp (NULL, &tmpfile, error);
75 if (write (fd, text, len) != (int) len)
79 G_FILE_ERROR, G_FILE_ERROR_FAILED,
80 "Could not write data to temporary file '%s'", tmpfile);
86 /* run diff command */
103 static int unnamed_object_count;
108 unnamed_object_count = 0;
112 get_name (AtkObject *accessible)
116 name = g_object_get_data (G_OBJECT (accessible), "gtk-accessibility-dump-name");
120 if (GTK_IS_ACCESSIBLE (accessible))
122 GtkWidget *widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (accessible));
124 name = g_strdup (gtk_buildable_get_name (GTK_BUILDABLE (widget)));
127 if (name == NULL && ATK_IS_TEXT (accessible))
129 name = atk_text_get_text (ATK_TEXT (accessible), 0, -1);
134 /* Generate a unique, repeatable name */
135 name = g_strdup_printf ("unnamed-%s-%d", G_OBJECT_TYPE_NAME (accessible), unnamed_object_count++);
138 g_object_set_data_full (G_OBJECT (accessible), "gtk-accessibility-dump-name", name, g_free);
143 dump_relation (GString *string,
145 AtkRelation *relation)
151 targets = atk_relation_get_target (relation);
152 if (targets == NULL || targets->len == 0)
155 name = atk_relation_type_get_name (atk_relation_get_relation_type (relation));
156 g_string_append_printf (string, "%*s%s: %s\n", depth, "", name, get_name (g_ptr_array_index (targets, 0)));
157 depth += strlen (name) + 2;
159 for (i = 1; i < targets->len; i++)
161 g_string_append_printf (string, "%*s%s\n", depth, "", get_name (g_ptr_array_index (targets, i)));
166 dump_relation_set (GString *string,
175 for (i = 0; i < atk_relation_set_get_n_relations (set); i++)
177 AtkRelation *relation;
179 relation = atk_relation_set_get_relation (set, i);
181 dump_relation (string, depth, relation);
184 g_object_unref (set);
188 dump_state_set (GString *string,
197 if (!atk_state_set_is_empty (set))
199 g_string_append_printf (string, "%*sstate:", depth, "");
200 for (i = 0; i < ATK_STATE_LAST_DEFINED; i++)
202 if (atk_state_set_contains_state (set, i))
203 g_string_append_printf (string, " %s", atk_state_type_get_name (i));
205 g_string_append_c (string, '\n');
208 g_object_unref (set);
212 dump_attribute (GString *string,
214 AtkAttribute *attribute)
216 g_string_append_printf (string, "%*s%s: %s\n", depth, "", attribute->name, attribute->value);
220 dump_attribute_set (GString *string,
222 AtkAttributeSet *set)
225 AtkAttribute *attribute;
227 for (l = set; l; l = l->next)
231 dump_attribute (string, depth, attribute);
236 compare_attr (gconstpointer a, gconstpointer b)
238 const AtkAttribute *aattr = a;
239 const AtkAttribute *battr = b;
241 return strcmp (aattr->name, battr->name);
245 dump_text_attributes (GString *string,
248 AtkAttributeSet *attributes)
254 if (attributes == NULL)
257 attributes = g_slist_sort (attributes, compare_attr);
259 for (l = attributes; l; l = l->next)
262 /* don't dump values that depend on the environment */
263 if (strcmp (attr->name, "family-name") == 0 ||
264 strcmp (attr->name, "size") == 0 ||
265 strcmp (attr->name, "weight") == 0 ||
266 strcmp (attr->name, "stretch") == 0 ||
267 strcmp (attr->name, "variant") == 0 ||
268 strcmp (attr->name, "style") == 0 ||
269 strcmp (attr->name, "language") == 0 ||
270 strcmp (attr->name, "fg-color") == 0 ||
271 strcmp (attr->name, "bg-color") == 0 ||
272 strcmp (attr->name, "direction") == 0)
279 /* first time this loop is run */
280 g_string_append_printf (string, "%*s%s: %s: %s\n", depth, "", name, attr->name, value);
281 depth += strlen (name) + 2;
286 /* every other time */
287 g_string_append_printf (string, "%*s%s: %s\n", depth, "", attr->name, value);
291 atk_attribute_set_free (attributes);
294 extern GType atk_layer_get_type (void);
297 layer_name (AtkLayer layer)
302 class = g_type_class_ref (atk_layer_get_type ());
303 value = g_enum_get_value (class, layer);
304 g_type_class_unref (class);
306 return value->value_nick;
310 dump_atk_component (AtkComponent *atk_component,
316 g_string_append_printf (string, "%*s<AtkComponent>\n", depth, "");
318 layer = atk_component_get_layer (atk_component);
319 g_string_append_printf (string, "%*slayer: %s\n", depth, "", layer_name (layer));
321 g_string_append_printf (string, "%*salpha: %g\n", depth, "", atk_component_get_alpha (atk_component));
325 dump_atk_text (AtkText *atk_text,
332 g_string_append_printf (string, "%*s<AtkText>\n", depth, "");
334 text = atk_text_get_text (atk_text, 0, -1);
335 g_string_append_printf (string, "%*stext: %s\n", depth, "", text);
338 g_string_append_printf (string, "%*scharacter count: %d\n", depth, "", atk_text_get_character_count (atk_text));
340 g_string_append_printf (string, "%*scaret offset: %d\n", depth, "", atk_text_get_caret_offset (atk_text));
342 for (i = 0; i < atk_text_get_n_selections (atk_text); i++)
344 text = atk_text_get_selection (atk_text, i, &start, &end);
346 g_string_append_printf (string, "%*sselection %d: (%d, %d) %s\n", depth, "", i, start, end, text);
350 dump_text_attributes (string, depth, "default attributes", atk_text_get_default_attributes (atk_text));
354 dump_atk_image (AtkImage *atk_image,
360 g_string_append_printf (string, "%*s<AtkImage>\n", depth, "");
362 atk_image_get_image_size (atk_image, &width, &height);
363 g_string_append_printf (string, "%*simage size: %d x %d\n", depth, "", width, height);
365 g_string_append_printf (string, "%*simage description: %s\n", depth, "", atk_image_get_image_description (atk_image));
369 dump_atk_action (AtkAction *atk_action,
375 g_string_append_printf (string, "%*s<AtkAction>\n", depth, "");
377 for (i = 0; i < atk_action_get_n_actions (atk_action); i++)
379 if (atk_action_get_name (atk_action, i))
380 g_string_append_printf (string, "%*saction %d name: %s\n", depth, "", i, atk_action_get_name (atk_action, i));
381 if (atk_action_get_description (atk_action, i))
382 g_string_append_printf (string, "%*saction %d description: %s\n", depth, "", i, atk_action_get_description (atk_action, i));
383 if (atk_action_get_keybinding (atk_action, i))
384 g_string_append_printf (string, "%*saction %d keybinding: %s\n", depth, "", i, atk_action_get_keybinding (atk_action, i));
389 dump_atk_selection (AtkSelection *atk_selection,
393 guint n_selections, n_counted_selections;
396 n_selections = atk_selection_get_selection_count (atk_selection);
397 g_string_append_printf (string, "%*s<AtkSelection>\n", depth, "");
398 g_string_append_printf (string, "%*sselection count: %d\n", depth, "", n_selections);
400 n_counted_selections = 0;
401 for (i = 0; i < atk_object_get_n_accessible_children (ATK_OBJECT (atk_selection)); i++)
403 if (atk_selection_is_child_selected (atk_selection, i))
405 AtkObject *object = atk_object_ref_accessible_child (ATK_OBJECT (atk_selection), i);
409 if (n_counted_selections == 0)
411 g_string_append_printf (string, "%*sselected children: %s\n", depth, "", get_name (object));
412 depth += strlen ("selected children: ");
415 g_string_append_printf (string, "%*s%s\n", depth, "", get_name (object));
416 n_counted_selections++;
420 g_assert_cmpint (n_selections, ==, n_counted_selections);
424 dump_atk_value (AtkValue *atk_value,
428 GValue value = { 0, };
429 GValue svalue = { 0, };
431 g_string_append_printf (string, "%*s<AtkValue>\n", depth, "");
433 g_value_init (&value, G_TYPE_DOUBLE);
434 g_value_init (&svalue, G_TYPE_STRING);
436 atk_value_get_minimum_value (atk_value, &value);
437 if (g_value_transform (&value, &svalue))
438 g_string_append_printf (string, "%*sminimum value: %s\n", depth, "", g_value_get_string (&svalue));
440 g_string_append_printf (string, "%*sminimum value: <%s>\n", depth, "", G_VALUE_TYPE_NAME (&value));
442 g_value_reset (&value);
443 g_value_reset (&svalue);
445 atk_value_get_maximum_value (atk_value, &value);
446 if (g_value_transform (&value, &svalue))
447 g_string_append_printf (string, "%*smaximum value: %s\n", depth, "", g_value_get_string (&svalue));
449 g_string_append_printf (string, "%*smaximum value: <%s>\n", depth, "", G_VALUE_TYPE_NAME (&value));
451 g_value_reset (&value);
452 g_value_reset (&svalue);
454 atk_value_get_current_value (atk_value, &value);
455 if (g_value_transform (&value, &svalue))
456 g_string_append_printf (string, "%*scurrent value: %s\n", depth, "", g_value_get_string (&svalue));
458 g_string_append_printf (string, "%*scurrent value: %s\n", depth, "", G_VALUE_TYPE_NAME (&value));
460 g_value_reset (&value);
461 g_value_reset (&svalue);
463 atk_value_get_minimum_increment (atk_value, &value);
464 if (g_value_transform (&value, &svalue))
465 g_string_append_printf (string, "%*sminimum increment: %s\n", depth, "", g_value_get_string (&svalue));
467 g_string_append_printf (string, "%*sminimum increment: %s\n", depth, "", G_VALUE_TYPE_NAME (&value));
469 g_value_reset (&value);
470 g_value_reset (&svalue);
474 dump_atk_hyperlink_impl (AtkHyperlinkImpl *impl,
478 AtkHyperlink *atk_link;
481 g_string_append_printf (string, "%*s<AtkHyperlinkImpl>\n", depth, "");
483 atk_link = atk_hyperlink_impl_get_hyperlink (impl);
485 g_string_append_printf (string, "%*sanchors:", depth, "");
487 for (i = 0; i < atk_hyperlink_get_n_anchors (atk_link); i++)
491 uri = atk_hyperlink_get_uri (atk_link, i);
492 g_string_append_printf (string, " %s", uri);
495 g_string_append_c (string, '\n');
497 g_object_unref (atk_link);
501 dump_atk_streamable_content (AtkStreamableContent *content,
507 g_string_append_printf (string, "%*s<AtkStreamableContent>\n", depth, "");
509 g_string_append_printf (string, "%*smime types:", depth, "");
510 for (i = 0; i < atk_streamable_content_get_n_mime_types (content); i++)
511 g_string_append_printf (string, " %s", atk_streamable_content_get_mime_type (content, i));
512 g_string_append_c (string, '\n');
515 static void dump_accessible (AtkObject *accessible,
520 dump_atk_table (AtkTable *table,
530 g_string_append_printf (string, "%*s<AtkTable>\n", depth, "");
532 obj = atk_table_get_summary (table);
535 g_string_append_printf (string, "%*s<summary>\n", depth, "");
536 dump_accessible (obj, depth, string);
539 obj = atk_table_get_caption (table);
542 g_string_append_printf (string, "%*s<caption>\n", depth, "");
543 dump_accessible (obj, depth, string);
546 g_string_append_printf (string, "%*srows: %d\n", depth, "", atk_table_get_n_rows (table));
547 g_string_append_printf (string, "%*scolumns: %d\n", depth, "", atk_table_get_n_columns (table));
550 n_selected = atk_table_get_selected_rows (table, &selected);
553 g_string_append_printf (string, "%*sselected rows:", depth, "");
554 for (i = 0; i < n_selected; i++)
555 g_string_append_printf (string, " %d", selected[i]);
556 g_string_append_c (string, '\n');
561 n_selected = atk_table_get_selected_columns (table, &selected);
564 g_string_append_printf (string, "%*sselected columns:", depth, "");
565 for (i = 0; i < n_selected; i++)
566 g_string_append_printf (string, " %d", selected[i]);
567 g_string_append_c (string, '\n');
572 for (i = 0; i < atk_table_get_n_columns (table); i++)
574 desc = atk_table_get_column_description (table, i);
576 g_string_append_printf (string, "%*scolumn %d description: %s\n", depth, "", i, desc);
577 obj = atk_table_get_column_header (table, i);
580 g_string_append_printf (string, "%*s<column %d header>\n", depth, "", i);
581 dump_accessible (obj, depth, string);
585 for (i = 0; i < atk_table_get_n_rows (table); i++)
587 desc = atk_table_get_row_description (table, i);
589 g_string_append_printf (string, "%*srow %d description: %s\n", depth, "", i, desc);
590 obj = atk_table_get_row_header (table, i);
593 g_string_append_printf (string, "%*s<row %d header>\n", depth, "", i);
594 dump_accessible (obj, depth, string);
600 dump_accessible (AtkObject *accessible,
606 g_string_append_printf (string, "%*s%s\n", depth, "", get_name (accessible));
607 depth += DEPTH_INCREMENT;
609 g_string_append_printf (string, "%*s\"%s\"\n", depth, "", atk_role_get_name (atk_object_get_role (accessible)));
610 if (GTK_IS_ACCESSIBLE (atk_object_get_parent (accessible)))
611 g_string_append_printf (string, "%*sparent: %s\n", depth, "", get_name (atk_object_get_parent (accessible)));
612 if (atk_object_get_index_in_parent (accessible) != -1)
613 g_string_append_printf (string, "%*sindex: %d\n", depth, "", atk_object_get_index_in_parent (accessible));
614 if (atk_object_get_name (accessible))
615 g_string_append_printf (string, "%*sname: %s\n", depth, "", atk_object_get_name (accessible));
616 if (atk_object_get_description (accessible))
617 g_string_append_printf (string, "%*sdescription: %s\n", depth, "", atk_object_get_description (accessible));
618 dump_relation_set (string, depth, atk_object_ref_relation_set (accessible));
619 dump_state_set (string, depth, atk_object_ref_state_set (accessible));
620 dump_attribute_set (string, depth, atk_object_get_attributes (accessible));
622 if (ATK_IS_COMPONENT (accessible))
623 dump_atk_component (ATK_COMPONENT (accessible), depth, string);
625 if (ATK_IS_TEXT (accessible))
626 dump_atk_text (ATK_TEXT (accessible), depth, string);
628 if (ATK_IS_IMAGE (accessible))
629 dump_atk_image (ATK_IMAGE (accessible), depth, string);
631 if (ATK_IS_ACTION (accessible))
632 dump_atk_action (ATK_ACTION (accessible), depth, string);
634 if (ATK_IS_SELECTION (accessible))
635 dump_atk_selection (ATK_SELECTION (accessible), depth, string);
637 if (ATK_IS_VALUE (accessible))
638 dump_atk_value (ATK_VALUE (accessible), depth, string);
640 if (ATK_IS_HYPERLINK_IMPL (accessible))
641 dump_atk_hyperlink_impl (ATK_HYPERLINK_IMPL (accessible), depth, string);
643 if (ATK_IS_STREAMABLE_CONTENT (accessible))
644 dump_atk_streamable_content (ATK_STREAMABLE_CONTENT (accessible), depth, string);
646 if (ATK_IS_TABLE (accessible))
647 dump_atk_table (ATK_TABLE (accessible), depth, string);
649 for (i = 0; i < atk_object_get_n_accessible_children (accessible); i++)
651 AtkObject *child = atk_object_ref_accessible_child (accessible, i);
652 dump_accessible (child, depth, string);
653 g_object_unref (child);
658 builder_get_toplevel (GtkBuilder *builder)
661 GtkWidget *window = NULL;
663 list = gtk_builder_get_objects (builder);
664 for (walk = list; walk; walk = walk->next)
666 if (GTK_IS_WINDOW (walk->data) &&
667 gtk_widget_get_parent (walk->data) == NULL)
680 dump_ui_file (const char *ui_file,
685 GError *error = NULL;
687 builder = gtk_builder_new ();
688 gtk_builder_add_from_file (builder, ui_file, &error);
689 g_assert_no_error (error);
690 window = builder_get_toplevel (builder);
691 g_object_unref (builder);
694 gtk_widget_show (window);
696 dump_accessible (gtk_widget_get_accessible (window), 0, string);
697 gtk_widget_destroy (window);
701 dump_to_stdout (GFile *file)
706 ui_file = g_file_get_path (file);
707 dump = g_string_new ("");
709 dump_ui_file (ui_file, dump);
710 g_print ("%s", dump->str);
712 g_string_free (dump, TRUE);
717 test_ui_file (GFile *file)
719 char *ui_file, *a11y_file;
721 GError *error = NULL;
723 ui_file = g_file_get_path (file);
724 a11y_file = get_test_file (ui_file, ".txt", TRUE);
725 dump = g_string_new ("");
727 dump_ui_file (ui_file, dump);
731 char *diff = diff_with_file (a11y_file, dump->str, dump->len, &error);
732 g_assert_no_error (error);
736 g_test_message ("Contents don't match expected contents:\n%s", diff);
741 else if (dump->str[0])
743 g_test_message ("Expected a reference file:\n%s", dump->str);
747 g_string_free (dump, TRUE);
753 add_test_for_file (GFile *file)
755 g_test_add_vtable (g_file_get_path (file),
758 (GTestFixtureFunc) setup_test,
759 (GTestFixtureFunc) test_ui_file,
760 (GTestFixtureFunc) g_object_unref);
764 compare_files (gconstpointer a, gconstpointer b)
766 GFile *file1 = G_FILE (a);
767 GFile *file2 = G_FILE (b);
771 path1 = g_file_get_path (file1);
772 path2 = g_file_get_path (file2);
774 result = strcmp (path1, path2);
783 add_tests_for_files_in_directory (GFile *dir)
785 GFileEnumerator *enumerator;
788 GError *error = NULL;
790 enumerator = g_file_enumerate_children (dir, G_FILE_ATTRIBUTE_STANDARD_NAME, 0, NULL, &error);
791 g_assert_no_error (error);
794 while ((info = g_file_enumerator_next_file (enumerator, NULL, &error)))
796 const char *filename;
798 filename = g_file_info_get_name (info);
800 if (!g_str_has_suffix (filename, ".ui"))
802 g_object_unref (info);
806 files = g_list_prepend (files, g_file_get_child (dir, filename));
808 g_object_unref (info);
811 g_assert_no_error (error);
812 g_object_unref (enumerator);
814 files = g_list_sort (files, compare_files);
815 g_list_foreach (files, (GFunc) add_test_for_file, NULL);
816 g_list_free_full (files, g_object_unref);
820 main (int argc, char **argv)
822 gtk_test_init (&argc, &argv);
829 if (g_getenv ("srcdir"))
830 basedir = g_getenv ("srcdir");
834 dir = g_file_new_for_path (basedir);
836 add_tests_for_files_in_directory (dir);
838 g_object_unref (dir);
840 else if (argc == 3 && strcmp (argv[1], "--generate") == 0)
842 GFile *file = g_file_new_for_commandline_arg (argv[2]);
844 dump_to_stdout (file);
846 g_object_unref (file);
854 for (i = 1; i < argc; i++)
856 GFile *file = g_file_new_for_commandline_arg (argv[i]);
858 add_test_for_file (file);
860 g_object_unref (file);
864 return g_test_run ();