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 gtk_disable_setlocale();
77 setlocale (LC_ALL, "C");
78 g_test_bug_base ("http://bugzilla.gnome.org/show_bug.cgi?id=%s");
80 /* XSendEvent() doesn't work yet on XI2 events.
81 * So at the moment gdk_test_simulate_* can only
82 * send events that GTK+ understands if XI2 is
85 gdk_disable_multidevice ();
87 gtk_init (argcp, argvp);
91 test_find_widget_input_windows (GtkWidget *widget,
95 GList *node, *children;
96 GSList *matches = NULL;
99 window = gtk_widget_get_window (widget);
101 gdk_window_get_user_data (window, &udata);
102 if (udata == widget && (!input_only || (GDK_IS_WINDOW (window) && gdk_window_is_input_only (GDK_WINDOW (window)))))
103 matches = g_slist_prepend (matches, window);
104 children = gdk_window_get_children (gtk_widget_get_parent_window (widget));
105 for (node = children; node; node = node->next)
107 gdk_window_get_user_data (node->data, &udata);
108 if (udata == widget && (!input_only || (GDK_IS_WINDOW (node->data) && gdk_window_is_input_only (GDK_WINDOW (node->data)))))
109 matches = g_slist_prepend (matches, node->data);
111 return g_slist_reverse (matches);
115 * gtk_test_widget_send_key
116 * @widget: Widget to generate a key press and release on.
117 * @keyval: A Gdk keyboard value.
118 * @modifiers: Keyboard modifiers the event is setup with.
120 * This function will generate keyboard press and release events in
121 * the middle of the first GdkWindow found that belongs to @widget.
122 * For %GTK_NO_WINDOW widgets like GtkButton, this will often be an
123 * input-only event window. For other widgets, this is usually widget->window.
124 * Certain caveats should be considered when using this function, in
125 * particular because the mouse pointer is warped to the key press
126 * location, see gdk_test_simulate_key() for details.
128 * Returns: wether all actions neccessary for the key event simulation were carried out successfully.
133 gtk_test_widget_send_key (GtkWidget *widget,
135 GdkModifierType modifiers)
137 gboolean k1res, k2res;
138 GSList *iwindows = test_find_widget_input_windows (widget, FALSE);
140 iwindows = test_find_widget_input_windows (widget, TRUE);
143 k1res = gdk_test_simulate_key (iwindows->data, -1, -1, keyval, modifiers, GDK_KEY_PRESS);
144 k2res = gdk_test_simulate_key (iwindows->data, -1, -1, keyval, modifiers, GDK_KEY_RELEASE);
145 g_slist_free (iwindows);
146 return k1res && k2res;
150 * gtk_test_widget_click
151 * @widget: Widget to generate a button click on.
152 * @button: Number of the pointer button for the event, usually 1, 2 or 3.
153 * @modifiers: Keyboard modifiers the event is setup with.
155 * This function will generate a @button click (button press and button
156 * release event) in the middle of the first GdkWindow found that belongs
158 * For %GTK_NO_WINDOW widgets like GtkButton, this will often be an
159 * input-only event window. For other widgets, this is usually widget->window.
160 * Certain caveats should be considered when using this function, in
161 * particular because the mouse pointer is warped to the button click
162 * location, see gdk_test_simulate_button() for details.
164 * Returns: wether all actions neccessary for the button click simulation were carried out successfully.
169 gtk_test_widget_click (GtkWidget *widget,
171 GdkModifierType modifiers)
173 gboolean b1res, b2res;
174 GSList *iwindows = test_find_widget_input_windows (widget, FALSE);
176 iwindows = test_find_widget_input_windows (widget, TRUE);
179 b1res = gdk_test_simulate_button (iwindows->data, -1, -1, button, modifiers, GDK_BUTTON_PRESS);
180 b2res = gdk_test_simulate_button (iwindows->data, -1, -1, button, modifiers, GDK_BUTTON_RELEASE);
181 g_slist_free (iwindows);
182 return b1res && b2res;
186 * gtk_test_spin_button_click
187 * @spinner: valid GtkSpinButton widget.
188 * @button: Number of the pointer button for the event, usually 1, 2 or 3.
189 * @upwards: %TRUE for upwards arrow click, %FALSE for downwards arrow click.
191 * This function will generate a @button click in the upwards or downwards
192 * spin button arrow areas, usually leading to an increase or decrease of
193 * spin button's value.
195 * Returns: wether all actions neccessary for the button click simulation were carried out successfully.
200 gtk_test_spin_button_click (GtkSpinButton *spinner,
205 gboolean b1res = FALSE, b2res = FALSE;
207 panel = _gtk_spin_button_get_panel (spinner);
212 width = gdk_window_get_width (panel);
213 pos = upwards ? 0 : gdk_window_get_height (panel) - 1;
214 b1res = gdk_test_simulate_button (panel, width - 1, pos, button, 0, GDK_BUTTON_PRESS);
215 b2res = gdk_test_simulate_button (panel, width - 1, pos, button, 0, GDK_BUTTON_RELEASE);
217 return b1res && b2res;
221 * gtk_test_find_label
222 * @widget: Valid label or container widget.
223 * @label_pattern: Shell-glob pattern to match a label string.
225 * This function will search @widget and all its descendants for a GtkLabel
226 * widget with a text string matching @label_pattern.
227 * The @label_pattern may contain asterisks '*' and question marks '?' as
228 * placeholders, g_pattern_match() is used for the matching.
229 * Note that locales other than "C" tend to alter (translate" label strings,
230 * so this function is genrally only useful in test programs with
231 * predetermined locales, see gtk_test_init() for more details.
233 * Returns: a GtkLabel widget if any is found.
238 gtk_test_find_label (GtkWidget *widget,
239 const gchar *label_pattern)
241 if (GTK_IS_LABEL (widget))
243 const gchar *text = gtk_label_get_text (GTK_LABEL (widget));
244 if (g_pattern_match_simple (label_pattern, text))
247 if (GTK_IS_CONTAINER (widget))
249 GList *node, *list = gtk_container_get_children (GTK_CONTAINER (widget));
250 for (node = list; node; node = node->next)
252 GtkWidget *label = gtk_test_find_label (node->data, label_pattern);
262 test_list_descendants (GtkWidget *widget,
265 GList *results = NULL;
266 if (GTK_IS_CONTAINER (widget))
268 GList *node, *list = gtk_container_get_children (GTK_CONTAINER (widget));
269 for (node = list; node; node = node->next)
271 if (!widget_type || g_type_is_a (G_OBJECT_TYPE (node->data), widget_type))
272 results = g_list_prepend (results, node->data);
274 results = g_list_concat (results, test_list_descendants (node->data, widget_type));
282 widget_geo_dist (GtkWidget *a,
286 GtkAllocation allocation;
287 int ax0, ay0, ax1, ay1, bx0, by0, bx1, by1, xdist = 0, ydist = 0;
289 gtk_widget_get_allocation (a, &allocation);
290 if (!gtk_widget_translate_coordinates (a, base, 0, 0, &ax0, &ay0) ||
291 !gtk_widget_translate_coordinates (a, base, allocation.width, allocation.height, &ax1, &ay1))
294 gtk_widget_get_allocation (b, &allocation);
295 if (!gtk_widget_translate_coordinates (b, base, 0, 0, &bx0, &by0) ||
296 !gtk_widget_translate_coordinates (b, base, allocation.width, allocation.height, &bx1, &by1))
308 return xdist + ydist;
312 widget_geo_cmp (gconstpointer a,
316 gpointer *data = user_data;
317 GtkWidget *wa = (void*) a, *wb = (void*) b, *toplevel = data[0], *base_widget = data[1];
318 int adist = widget_geo_dist (wa, base_widget, toplevel);
319 int bdist = widget_geo_dist (wb, base_widget, toplevel);
320 return adist > bdist ? +1 : adist == bdist ? 0 : -1;
324 * gtk_test_find_sibling
325 * @base_widget: Valid widget, part of a widget hierarchy
326 * @widget_type: Type of a aearched for sibling widget
328 * This function will search siblings of @base_widget and siblings of its
329 * ancestors for all widgets matching @widget_type.
330 * Of the matching widgets, the one that is geometrically closest to
331 * @base_widget will be returned.
332 * The general purpose of this function is to find the most likely "action"
333 * widget, relative to another labeling widget. Such as finding a
334 * button or text entry widget, given it's corresponding label widget.
336 * Returns: a widget of type @widget_type if any is found.
341 gtk_test_find_sibling (GtkWidget *base_widget,
344 GList *siblings = NULL;
345 GtkWidget *tmpwidget = base_widget;
347 /* find all sibling candidates */
350 tmpwidget = gtk_widget_get_parent (tmpwidget);
351 siblings = g_list_concat (siblings, test_list_descendants (tmpwidget, widget_type));
353 /* sort them by distance to base_widget */
354 data[0] = gtk_widget_get_toplevel (base_widget);
355 data[1] = base_widget;
356 siblings = g_list_sort_with_data (siblings, widget_geo_cmp, data);
357 /* pick nearest != base_widget */
358 siblings = g_list_remove (siblings, base_widget);
359 tmpwidget = siblings ? siblings->data : NULL;
360 g_list_free (siblings);
365 * gtk_test_find_widget
366 * @widget: Container widget, usually a GtkWindow.
367 * @label_pattern: Shell-glob pattern to match a label string.
368 * @widget_type: Type of a aearched for label sibling widget.
370 * This function will search the descendants of @widget for a widget
371 * of type @widget_type that has a label matching @label_pattern next
372 * to it. This is most useful for automated GUI testing, e.g. to find
373 * the "OK" button in a dialog and synthesize clicks on it.
374 * However see gtk_test_find_label(), gtk_test_find_sibling() and
375 * gtk_test_widget_click() for possible caveats involving the search of
376 * such widgets and synthesizing widget events.
378 * Returns: a valid widget if any is found or %NULL.
383 gtk_test_find_widget (GtkWidget *widget,
384 const gchar *label_pattern,
387 GtkWidget *label = gtk_test_find_label (widget, label_pattern);
389 label = gtk_test_find_label (gtk_widget_get_toplevel (widget), label_pattern);
391 return gtk_test_find_sibling (label, widget_type);
396 * gtk_test_slider_set_perc
397 * @widget: valid widget pointer.
398 * @percentage: value between 0 and 100.
400 * This function will adjust the slider position of all GtkRange
401 * based widgets, such as scrollbars or scales, it'll also adjust
402 * spin buttons. The adjustment value of these widgets is set to
403 * a value between the lower and upper limits, according to the
404 * @percentage argument.
409 gtk_test_slider_set_perc (GtkWidget *widget,
412 GtkAdjustment *adjustment = NULL;
413 if (GTK_IS_RANGE (widget))
414 adjustment = gtk_range_get_adjustment (GTK_RANGE (widget));
415 else if (GTK_IS_SPIN_BUTTON (widget))
416 adjustment = gtk_spin_button_get_adjustment (GTK_SPIN_BUTTON (widget));
418 gtk_adjustment_set_value (adjustment, adjustment->lower + (adjustment->upper - adjustment->lower - adjustment->page_size) * percentage * 0.01);
422 * gtk_test_slider_get_value
423 * @widget: valid widget pointer.
425 * Retrive the literal adjustment value for GtkRange based
426 * widgets and spin buttons. Note that the value returned by
427 * this function is anything between the lower and upper bounds
428 * of the adjustment belonging to @widget, and is not a percentage
429 * as passed in to gtk_test_slider_set_perc().
431 * Returns: adjustment->value for an adjustment belonging to @widget.
436 gtk_test_slider_get_value (GtkWidget *widget)
438 GtkAdjustment *adjustment = NULL;
439 if (GTK_IS_RANGE (widget))
440 adjustment = gtk_range_get_adjustment (GTK_RANGE (widget));
441 else if (GTK_IS_SPIN_BUTTON (widget))
442 adjustment = gtk_spin_button_get_adjustment (GTK_SPIN_BUTTON (widget));
443 return adjustment ? adjustment->value : 0;
448 * @widget: valid widget pointer.
449 * @string: a 0-terminated C string
451 * Set the text string of @widget to @string if it is a GtkLabel,
452 * GtkEditable (entry and text widgets) or GtkTextView.
457 gtk_test_text_set (GtkWidget *widget,
460 if (GTK_IS_LABEL (widget))
461 gtk_label_set_text (GTK_LABEL (widget), string);
462 else if (GTK_IS_EDITABLE (widget))
465 gtk_editable_delete_text (GTK_EDITABLE (widget), 0, -1);
466 gtk_editable_insert_text (GTK_EDITABLE (widget), string, -1, &pos);
468 else if (GTK_IS_TEXT_VIEW (widget))
470 GtkTextBuffer *tbuffer = gtk_text_view_get_buffer (GTK_TEXT_VIEW (widget));
471 gtk_text_buffer_set_text (tbuffer, string, -1);
477 * @widget: valid widget pointer.
479 * Retrive the text string of @widget if it is a GtkLabel,
480 * GtkEditable (entry and text widgets) or GtkTextView.
482 * Returns: new 0-terminated C string, needs to be released with g_free().
487 gtk_test_text_get (GtkWidget *widget)
489 if (GTK_IS_LABEL (widget))
490 return g_strdup (gtk_label_get_text (GTK_LABEL (widget)));
491 else if (GTK_IS_EDITABLE (widget))
493 return g_strdup (gtk_editable_get_chars (GTK_EDITABLE (widget), 0, -1));
495 else if (GTK_IS_TEXT_VIEW (widget))
497 GtkTextBuffer *tbuffer = gtk_text_view_get_buffer (GTK_TEXT_VIEW (widget));
498 GtkTextIter start, end;
499 gtk_text_buffer_get_start_iter (tbuffer, &start);
500 gtk_text_buffer_get_end_iter (tbuffer, &end);
501 return gtk_text_buffer_get_text (tbuffer, &start, &end, FALSE);
507 * gtk_test_create_widget
508 * @widget_type: a valid widget type.
509 * @first_property_name: (allow-none): Name of first property to set or %NULL
510 * @Varargs: value to set the first property to, followed by more
511 * name-value pairs, terminated by %NULL
513 * This function wraps g_object_new() for widget types.
514 * It'll automatically show all created non window widgets, also
515 * g_object_ref_sink() them (to keep them alive across a running test)
516 * and set them up for destruction during the next test teardown phase.
518 * Returns: a newly created widget.
523 gtk_test_create_widget (GType widget_type,
524 const gchar *first_property_name,
529 g_return_val_if_fail (g_type_is_a (widget_type, GTK_TYPE_WIDGET), NULL);
530 va_start (var_args, first_property_name);
531 widget = (GtkWidget*) g_object_new_valist (widget_type, first_property_name, var_args);
535 if (!GTK_IS_WINDOW (widget))
536 gtk_widget_show (widget);
537 g_object_ref_sink (widget);
538 g_test_queue_unref (widget);
539 g_test_queue_destroy ((GDestroyNotify) gtk_widget_destroy, widget);
547 if (gtk_main_level())
552 test_increment_intp (int *intp)
556 return 1; /* TRUE in case we're connected to event signals */
560 * gtk_test_display_button_window
561 * @window_title: Title of the window to be displayed.
562 * @dialog_text: Text inside the window to be displayed.
563 * @...: %NULL terminated list of (const char *label, int *nump) pairs.
565 * Create a window with window title @window_title, text contents @dialog_text,
566 * and a number of buttons, according to the paired argument list given
567 * as @... parameters.
568 * Each button is created with a @label and a ::clicked signal handler that
569 * incremrents the integer stored in @nump.
570 * The window will be automatically shown with gtk_widget_show_now() after
571 * creation, so when this function returns it has already been mapped,
572 * resized and positioned on screen.
573 * The window will quit any running gtk_main()-loop when destroyed, and it
574 * will automatically be destroyed upon test function teardown.
576 * Returns: a widget pointer to the newly created GtkWindow.
581 gtk_test_display_button_window (const gchar *window_title,
582 const gchar *dialog_text,
583 ...) /* NULL terminated list of (label, &int) pairs */
586 GtkWidget *window = gtk_test_create_widget (GTK_TYPE_WINDOW, "title", window_title, NULL);
587 GtkWidget *vbox = gtk_test_create_widget (GTK_TYPE_VBOX, "parent", window, NULL);
589 gtk_test_create_widget (GTK_TYPE_LABEL, "label", dialog_text, "parent", vbox, NULL);
590 g_signal_connect (window, "destroy", G_CALLBACK (try_main_quit), NULL);
591 va_start (var_args, dialog_text);
592 arg1 = va_arg (var_args, const char*);
595 int *arg2 = va_arg (var_args, int*);
596 GtkWidget *button = gtk_test_create_widget (GTK_TYPE_BUTTON, "label", arg1, "parent", vbox, NULL);
597 g_signal_connect_swapped (button, "clicked", G_CALLBACK (test_increment_intp), arg2);
598 arg1 = va_arg (var_args, const char*);
601 gtk_widget_show_all (vbox);
602 gtk_widget_show_now (window);
603 while (gtk_events_pending ())
604 gtk_main_iteration ();
609 * gtk_test_create_simple_window
610 * @window_title: Title of the window to be displayed.
611 * @dialog_text: Text inside the window to be displayed.
613 * Create a simple window with window title @window_title and
614 * text contents @dialog_text.
615 * The window will quit any running gtk_main()-loop when destroyed, and it
616 * will automatically be destroyed upon test function teardown.
618 * Returns: a widget pointer to the newly created GtkWindow.
623 gtk_test_create_simple_window (const gchar *window_title,
624 const gchar *dialog_text)
626 GtkWidget *window = gtk_test_create_widget (GTK_TYPE_WINDOW, "title", window_title, NULL);
627 GtkWidget *vbox = gtk_test_create_widget (GTK_TYPE_VBOX, "parent", window, NULL);
628 gtk_test_create_widget (GTK_TYPE_LABEL, "label", dialog_text, "parent", vbox, NULL);
629 g_signal_connect (window, "destroy", G_CALLBACK (try_main_quit), NULL);
630 gtk_widget_show_all (vbox);
634 static GType *all_registered_types = NULL;
635 static guint n_all_registered_types = 0;
638 * gtk_test_list_all_types
639 * @n_types: location to store number of types
640 * @returns: 0-terminated array of type ids
642 * Return the type ids that have been registered after
643 * calling gtk_test_register_all_types().
648 gtk_test_list_all_types (guint *n_types)
651 *n_types = n_all_registered_types;
652 return all_registered_types;
656 * gtk_test_register_all_types
658 * Force registration of all core Gtk+ and Gdk object types.
659 * This allowes to refer to any of those object types via
660 * g_type_from_name() after calling this function.
665 gtk_test_register_all_types (void)
667 if (!all_registered_types)
669 const guint max_gtk_types = 999;
671 all_registered_types = g_new0 (GType, max_gtk_types);
672 tp = all_registered_types;
673 #include "gtktypefuncs.c"
674 n_all_registered_types = tp - all_registered_types;
675 g_assert (n_all_registered_types + 1 < max_gtk_types);