1 /* Gtk+ testing utilities
2 * Copyright (C) 2007 Imendio AB
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
25 #include "gtkspinbutton.h"
34 * @Short_description: Utilities for testing GTK+ applications
40 * @argcp: Address of the <parameter>argc</parameter> parameter of the
41 * main() function. Changed if any arguments were handled.
42 * @argvp: Address of the <parameter>argv</parameter> parameter of main().
43 * Any parameters understood by g_test_init() or gtk_init() are
44 * stripped before return.
45 * @Varargs: currently unused
47 * This function is used to initialize a GTK+ test program.
49 * It will in turn call g_test_init() and gtk_init() to properly
50 * initialize the testing framework and graphical toolkit. It'll
51 * also set the program's locale to "C" and prevent loading of rc
52 * files and Gtk+ modules. This is done to make tets program
53 * environments as deterministic as possible.
55 * Like gtk_init() and g_test_init(), any known arguments will be
56 * processed and stripped from @argc and @argv.
61 gtk_test_init (int *argcp,
65 g_test_init (argcp, argvp, NULL);
67 * - call g_test_init();
69 * - prevent RC files from loading;
70 * - prevent Gtk modules from loading;
71 * - supply mock object for GtkSettings
73 * - this function could install a mock object around GtkSettings
75 g_setenv ("GTK_MODULES", "", TRUE);
76 g_setenv ("GTK2_RC_FILES", "/dev/null", TRUE);
77 gtk_disable_setlocale();
78 setlocale (LC_ALL, "C");
79 g_test_bug_base ("http://bugzilla.gnome.org/show_bug.cgi?id=%s");
80 gtk_init (argcp, argvp);
84 test_find_widget_input_windows (GtkWidget *widget,
88 GList *node, *children;
89 GSList *matches = NULL;
92 window = gtk_widget_get_window (widget);
94 gdk_window_get_user_data (window, &udata);
95 if (udata == widget && (!input_only || (GDK_IS_WINDOW (window) && gdk_window_is_input_only (GDK_WINDOW (window)))))
96 matches = g_slist_prepend (matches, window);
97 children = gdk_window_get_children (gtk_widget_get_parent_window (widget));
98 for (node = children; node; node = node->next)
100 gdk_window_get_user_data (node->data, &udata);
101 if (udata == widget && (!input_only || (GDK_IS_WINDOW (node->data) && gdk_window_is_input_only (GDK_WINDOW (node->data)))))
102 matches = g_slist_prepend (matches, node->data);
104 return g_slist_reverse (matches);
108 * gtk_test_widget_send_key
109 * @widget: Widget to generate a key press and release on.
110 * @keyval: A Gdk keyboard value.
111 * @modifiers: Keyboard modifiers the event is setup with.
113 * This function will generate keyboard press and release events in
114 * the middle of the first GdkWindow found that belongs to @widget.
115 * For %GTK_NO_WINDOW widgets like GtkButton, this will often be an
116 * input-only event window. For other widgets, this is usually widget->window.
117 * Certain caveats should be considered when using this function, in
118 * particular because the mouse pointer is warped to the key press
119 * location, see gdk_test_simulate_key() for details.
121 * Returns: wether all actions neccessary for the key event simulation were carried out successfully.
126 gtk_test_widget_send_key (GtkWidget *widget,
128 GdkModifierType modifiers)
130 gboolean k1res, k2res;
131 GSList *iwindows = test_find_widget_input_windows (widget, FALSE);
133 iwindows = test_find_widget_input_windows (widget, TRUE);
136 k1res = gdk_test_simulate_key (iwindows->data, -1, -1, keyval, modifiers, GDK_KEY_PRESS);
137 k2res = gdk_test_simulate_key (iwindows->data, -1, -1, keyval, modifiers, GDK_KEY_RELEASE);
138 g_slist_free (iwindows);
139 return k1res && k2res;
143 * gtk_test_widget_click
144 * @widget: Widget to generate a button click on.
145 * @button: Number of the pointer button for the event, usually 1, 2 or 3.
146 * @modifiers: Keyboard modifiers the event is setup with.
148 * This function will generate a @button click (button press and button
149 * release event) in the middle of the first GdkWindow found that belongs
151 * For %GTK_NO_WINDOW widgets like GtkButton, this will often be an
152 * input-only event window. For other widgets, this is usually widget->window.
153 * Certain caveats should be considered when using this function, in
154 * particular because the mouse pointer is warped to the button click
155 * location, see gdk_test_simulate_button() for details.
157 * Returns: wether all actions neccessary for the button click simulation were carried out successfully.
162 gtk_test_widget_click (GtkWidget *widget,
164 GdkModifierType modifiers)
166 gboolean b1res, b2res;
167 GSList *iwindows = test_find_widget_input_windows (widget, FALSE);
169 iwindows = test_find_widget_input_windows (widget, TRUE);
172 b1res = gdk_test_simulate_button (iwindows->data, -1, -1, button, modifiers, GDK_BUTTON_PRESS);
173 b2res = gdk_test_simulate_button (iwindows->data, -1, -1, button, modifiers, GDK_BUTTON_RELEASE);
174 g_slist_free (iwindows);
175 return b1res && b2res;
179 * gtk_test_spin_button_click
180 * @spinner: valid GtkSpinButton widget.
181 * @button: Number of the pointer button for the event, usually 1, 2 or 3.
182 * @upwards: %TRUE for upwards arrow click, %FALSE for downwards arrow click.
184 * This function will generate a @button click in the upwards or downwards
185 * spin button arrow areas, usually leading to an increase or decrease of
186 * spin button's value.
188 * Returns: wether all actions neccessary for the button click simulation were carried out successfully.
193 gtk_test_spin_button_click (GtkSpinButton *spinner,
198 gboolean b1res = FALSE, b2res = FALSE;
200 panel = _gtk_spin_button_get_panel (spinner);
205 width = gdk_window_get_width (panel);
206 pos = upwards ? 0 : gdk_window_get_height (panel) - 1;
207 b1res = gdk_test_simulate_button (panel, width - 1, pos, button, 0, GDK_BUTTON_PRESS);
208 b2res = gdk_test_simulate_button (panel, width - 1, pos, button, 0, GDK_BUTTON_RELEASE);
210 return b1res && b2res;
214 * gtk_test_find_label
215 * @widget: Valid label or container widget.
216 * @label_pattern: Shell-glob pattern to match a label string.
218 * This function will search @widget and all its descendants for a GtkLabel
219 * widget with a text string matching @label_pattern.
220 * The @label_pattern may contain asterisks '*' and question marks '?' as
221 * placeholders, g_pattern_match() is used for the matching.
222 * Note that locales other than "C" tend to alter (translate" label strings,
223 * so this function is genrally only useful in test programs with
224 * predetermined locales, see gtk_test_init() for more details.
226 * Returns: a GtkLabel widget if any is found.
231 gtk_test_find_label (GtkWidget *widget,
232 const gchar *label_pattern)
234 if (GTK_IS_LABEL (widget))
236 const gchar *text = gtk_label_get_text (GTK_LABEL (widget));
237 if (g_pattern_match_simple (label_pattern, text))
240 if (GTK_IS_CONTAINER (widget))
242 GList *node, *list = gtk_container_get_children (GTK_CONTAINER (widget));
243 for (node = list; node; node = node->next)
245 GtkWidget *label = gtk_test_find_label (node->data, label_pattern);
255 test_list_descendants (GtkWidget *widget,
258 GList *results = NULL;
259 if (GTK_IS_CONTAINER (widget))
261 GList *node, *list = gtk_container_get_children (GTK_CONTAINER (widget));
262 for (node = list; node; node = node->next)
264 if (!widget_type || g_type_is_a (G_OBJECT_TYPE (node->data), widget_type))
265 results = g_list_prepend (results, node->data);
267 results = g_list_concat (results, test_list_descendants (node->data, widget_type));
275 widget_geo_dist (GtkWidget *a,
279 GtkAllocation allocation;
280 int ax0, ay0, ax1, ay1, bx0, by0, bx1, by1, xdist = 0, ydist = 0;
282 gtk_widget_get_allocation (a, &allocation);
283 if (!gtk_widget_translate_coordinates (a, base, 0, 0, &ax0, &ay0) ||
284 !gtk_widget_translate_coordinates (a, base, allocation.width, allocation.height, &ax1, &ay1))
287 gtk_widget_get_allocation (b, &allocation);
288 if (!gtk_widget_translate_coordinates (b, base, 0, 0, &bx0, &by0) ||
289 !gtk_widget_translate_coordinates (b, base, allocation.width, allocation.height, &bx1, &by1))
301 return xdist + ydist;
305 widget_geo_cmp (gconstpointer a,
309 gpointer *data = user_data;
310 GtkWidget *wa = (void*) a, *wb = (void*) b, *toplevel = data[0], *base_widget = data[1];
311 int adist = widget_geo_dist (wa, base_widget, toplevel);
312 int bdist = widget_geo_dist (wb, base_widget, toplevel);
313 return adist > bdist ? +1 : adist == bdist ? 0 : -1;
317 * gtk_test_find_sibling
318 * @base_widget: Valid widget, part of a widget hierarchy
319 * @widget_type: Type of a aearched for sibling widget
321 * This function will search siblings of @base_widget and siblings of its
322 * ancestors for all widgets matching @widget_type.
323 * Of the matching widgets, the one that is geometrically closest to
324 * @base_widget will be returned.
325 * The general purpose of this function is to find the most likely "action"
326 * widget, relative to another labeling widget. Such as finding a
327 * button or text entry widget, given it's corresponding label widget.
329 * Returns: a widget of type @widget_type if any is found.
334 gtk_test_find_sibling (GtkWidget *base_widget,
337 GList *siblings = NULL;
338 GtkWidget *tmpwidget = base_widget;
340 /* find all sibling candidates */
343 tmpwidget = gtk_widget_get_parent (tmpwidget);
344 siblings = g_list_concat (siblings, test_list_descendants (tmpwidget, widget_type));
346 /* sort them by distance to base_widget */
347 data[0] = gtk_widget_get_toplevel (base_widget);
348 data[1] = base_widget;
349 siblings = g_list_sort_with_data (siblings, widget_geo_cmp, data);
350 /* pick nearest != base_widget */
351 siblings = g_list_remove (siblings, base_widget);
352 tmpwidget = siblings ? siblings->data : NULL;
353 g_list_free (siblings);
358 * gtk_test_find_widget
359 * @widget: Container widget, usually a GtkWindow.
360 * @label_pattern: Shell-glob pattern to match a label string.
361 * @widget_type: Type of a aearched for label sibling widget.
363 * This function will search the descendants of @widget for a widget
364 * of type @widget_type that has a label matching @label_pattern next
365 * to it. This is most useful for automated GUI testing, e.g. to find
366 * the "OK" button in a dialog and synthesize clicks on it.
367 * However see gtk_test_find_label(), gtk_test_find_sibling() and
368 * gtk_test_widget_click() for possible caveats involving the search of
369 * such widgets and synthesizing widget events.
371 * Returns: a valid widget if any is found or %NULL.
376 gtk_test_find_widget (GtkWidget *widget,
377 const gchar *label_pattern,
380 GtkWidget *label = gtk_test_find_label (widget, label_pattern);
382 label = gtk_test_find_label (gtk_widget_get_toplevel (widget), label_pattern);
384 return gtk_test_find_sibling (label, widget_type);
389 * gtk_test_slider_set_perc
390 * @widget: valid widget pointer.
391 * @percentage: value between 0 and 100.
393 * This function will adjust the slider position of all GtkRange
394 * based widgets, such as scrollbars or scales, it'll also adjust
395 * spin buttons. The adjustment value of these widgets is set to
396 * a value between the lower and upper limits, according to the
397 * @percentage argument.
402 gtk_test_slider_set_perc (GtkWidget *widget,
405 GtkAdjustment *adjustment = NULL;
406 if (GTK_IS_RANGE (widget))
407 adjustment = gtk_range_get_adjustment (GTK_RANGE (widget));
408 else if (GTK_IS_SPIN_BUTTON (widget))
409 adjustment = gtk_spin_button_get_adjustment (GTK_SPIN_BUTTON (widget));
411 gtk_adjustment_set_value (adjustment, adjustment->lower + (adjustment->upper - adjustment->lower - adjustment->page_size) * percentage * 0.01);
415 * gtk_test_slider_get_value
416 * @widget: valid widget pointer.
418 * Retrive the literal adjustment value for GtkRange based
419 * widgets and spin buttons. Note that the value returned by
420 * this function is anything between the lower and upper bounds
421 * of the adjustment belonging to @widget, and is not a percentage
422 * as passed in to gtk_test_slider_set_perc().
424 * Returns: adjustment->value for an adjustment belonging to @widget.
429 gtk_test_slider_get_value (GtkWidget *widget)
431 GtkAdjustment *adjustment = NULL;
432 if (GTK_IS_RANGE (widget))
433 adjustment = gtk_range_get_adjustment (GTK_RANGE (widget));
434 else if (GTK_IS_SPIN_BUTTON (widget))
435 adjustment = gtk_spin_button_get_adjustment (GTK_SPIN_BUTTON (widget));
436 return adjustment ? adjustment->value : 0;
441 * @widget: valid widget pointer.
442 * @string: a 0-terminated C string
444 * Set the text string of @widget to @string if it is a GtkLabel,
445 * GtkEditable (entry and text widgets) or GtkTextView.
450 gtk_test_text_set (GtkWidget *widget,
453 if (GTK_IS_LABEL (widget))
454 gtk_label_set_text (GTK_LABEL (widget), string);
455 else if (GTK_IS_EDITABLE (widget))
458 gtk_editable_delete_text (GTK_EDITABLE (widget), 0, -1);
459 gtk_editable_insert_text (GTK_EDITABLE (widget), string, -1, &pos);
461 else if (GTK_IS_TEXT_VIEW (widget))
463 GtkTextBuffer *tbuffer = gtk_text_view_get_buffer (GTK_TEXT_VIEW (widget));
464 gtk_text_buffer_set_text (tbuffer, string, -1);
470 * @widget: valid widget pointer.
472 * Retrive the text string of @widget if it is a GtkLabel,
473 * GtkEditable (entry and text widgets) or GtkTextView.
475 * Returns: new 0-terminated C string, needs to be released with g_free().
480 gtk_test_text_get (GtkWidget *widget)
482 if (GTK_IS_LABEL (widget))
483 return g_strdup (gtk_label_get_text (GTK_LABEL (widget)));
484 else if (GTK_IS_EDITABLE (widget))
486 return g_strdup (gtk_editable_get_chars (GTK_EDITABLE (widget), 0, -1));
488 else if (GTK_IS_TEXT_VIEW (widget))
490 GtkTextBuffer *tbuffer = gtk_text_view_get_buffer (GTK_TEXT_VIEW (widget));
491 GtkTextIter start, end;
492 gtk_text_buffer_get_start_iter (tbuffer, &start);
493 gtk_text_buffer_get_end_iter (tbuffer, &end);
494 return gtk_text_buffer_get_text (tbuffer, &start, &end, FALSE);
500 * gtk_test_create_widget
501 * @widget_type: a valid widget type.
502 * @first_property_name: (allow-none): Name of first property to set or %NULL
503 * @Varargs: value to set the first property to, followed by more
504 * name-value pairs, terminated by %NULL
506 * This function wraps g_object_new() for widget types.
507 * It'll automatically show all created non window widgets, also
508 * g_object_ref_sink() them (to keep them alive across a running test)
509 * and set them up for destruction during the next test teardown phase.
511 * Returns: a newly created widget.
516 gtk_test_create_widget (GType widget_type,
517 const gchar *first_property_name,
522 g_return_val_if_fail (g_type_is_a (widget_type, GTK_TYPE_WIDGET), NULL);
523 va_start (var_args, first_property_name);
524 widget = (GtkWidget*) g_object_new_valist (widget_type, first_property_name, var_args);
528 if (!GTK_IS_WINDOW (widget))
529 gtk_widget_show (widget);
530 g_object_ref_sink (widget);
531 g_test_queue_unref (widget);
532 g_test_queue_destroy ((GDestroyNotify) gtk_widget_destroy, widget);
540 if (gtk_main_level())
545 test_increment_intp (int *intp)
549 return 1; /* TRUE in case we're connected to event signals */
553 * gtk_test_display_button_window
554 * @window_title: Title of the window to be displayed.
555 * @dialog_text: Text inside the window to be displayed.
556 * @...: %NULL terminated list of (const char *label, int *nump) pairs.
558 * Create a window with window title @window_title, text contents @dialog_text,
559 * and a number of buttons, according to the paired argument list given
560 * as @... parameters.
561 * Each button is created with a @label and a ::clicked signal handler that
562 * incremrents the integer stored in @nump.
563 * The window will be automatically shown with gtk_widget_show_now() after
564 * creation, so when this function returns it has already been mapped,
565 * resized and positioned on screen.
566 * The window will quit any running gtk_main()-loop when destroyed, and it
567 * will automatically be destroyed upon test function teardown.
569 * Returns: a widget pointer to the newly created GtkWindow.
574 gtk_test_display_button_window (const gchar *window_title,
575 const gchar *dialog_text,
576 ...) /* NULL terminated list of (label, &int) pairs */
579 GtkWidget *window = gtk_test_create_widget (GTK_TYPE_WINDOW, "title", window_title, NULL);
580 GtkWidget *vbox = gtk_test_create_widget (GTK_TYPE_VBOX, "parent", window, NULL);
582 gtk_test_create_widget (GTK_TYPE_LABEL, "label", dialog_text, "parent", vbox, NULL);
583 g_signal_connect (window, "destroy", G_CALLBACK (try_main_quit), NULL);
584 va_start (var_args, dialog_text);
585 arg1 = va_arg (var_args, const char*);
588 int *arg2 = va_arg (var_args, int*);
589 GtkWidget *button = gtk_test_create_widget (GTK_TYPE_BUTTON, "label", arg1, "parent", vbox, NULL);
590 g_signal_connect_swapped (button, "clicked", G_CALLBACK (test_increment_intp), arg2);
591 arg1 = va_arg (var_args, const char*);
594 gtk_widget_show_all (vbox);
595 gtk_widget_show_now (window);
596 while (gtk_events_pending ())
597 gtk_main_iteration ();
602 * gtk_test_create_simple_window
603 * @window_title: Title of the window to be displayed.
604 * @dialog_text: Text inside the window to be displayed.
606 * Create a simple window with window title @window_title and
607 * text contents @dialog_text.
608 * The window will quit any running gtk_main()-loop when destroyed, and it
609 * will automatically be destroyed upon test function teardown.
611 * Returns: a widget pointer to the newly created GtkWindow.
616 gtk_test_create_simple_window (const gchar *window_title,
617 const gchar *dialog_text)
619 GtkWidget *window = gtk_test_create_widget (GTK_TYPE_WINDOW, "title", window_title, NULL);
620 GtkWidget *vbox = gtk_test_create_widget (GTK_TYPE_VBOX, "parent", window, NULL);
621 gtk_test_create_widget (GTK_TYPE_LABEL, "label", dialog_text, "parent", vbox, NULL);
622 g_signal_connect (window, "destroy", G_CALLBACK (try_main_quit), NULL);
623 gtk_widget_show_all (vbox);
627 static GType *all_registered_types = NULL;
628 static guint n_all_registered_types = 0;
631 * gtk_test_list_all_types
632 * @n_types: location to store number of types
633 * @returns: 0-terminated array of type ids
635 * Return the type ids that have been registered after
636 * calling gtk_test_register_all_types().
641 gtk_test_list_all_types (guint *n_types)
644 *n_types = n_all_registered_types;
645 return all_registered_types;
649 * gtk_test_register_all_types
651 * Force registration of all core Gtk+ and Gdk object types.
652 * This allowes to refer to any of those object types via
653 * g_type_from_name() after calling this function.
658 gtk_test_register_all_types (void)
660 if (!all_registered_types)
662 const guint max_gtk_types = 999;
664 all_registered_types = g_new0 (GType, max_gtk_types);
665 tp = all_registered_types;
666 #include "gtktypefuncs.c"
667 n_all_registered_types = tp - all_registered_types;
668 g_assert (n_all_registered_types + 1 < max_gtk_types);