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: (inout) (array length=argcp): Address of the
43 * <parameter>argv</parameter> parameter of main().
44 * Any parameters understood by g_test_init() or gtk_init() are
45 * stripped before return.
46 * @Varargs: currently unused
48 * This function is used to initialize a GTK+ test program.
50 * It will in turn call g_test_init() and gtk_init() to properly
51 * initialize the testing framework and graphical toolkit. It'll
52 * also set the program's locale to "C" and prevent loading of rc
53 * files and Gtk+ modules. This is done to make tets program
54 * environments as deterministic as possible.
56 * Like gtk_init() and g_test_init(), any known arguments will be
57 * processed and stripped from @argc and @argv.
62 gtk_test_init (int *argcp,
66 g_test_init (argcp, argvp, NULL);
68 * - call g_test_init();
70 * - prevent RC files from loading;
71 * - prevent Gtk modules from loading;
72 * - supply mock object for GtkSettings
74 * - this function could install a mock object around GtkSettings
76 g_setenv ("GTK_MODULES", "", TRUE);
77 gtk_disable_setlocale();
78 setlocale (LC_ALL, "C");
79 g_test_bug_base ("http://bugzilla.gnome.org/show_bug.cgi?id=%s");
81 /* XSendEvent() doesn't work yet on XI2 events.
82 * So at the moment gdk_test_simulate_* can only
83 * send events that GTK+ understands if XI2 is
86 gdk_disable_multidevice ();
88 gtk_init (argcp, argvp);
92 test_find_widget_input_windows (GtkWidget *widget,
96 GList *node, *children;
97 GSList *matches = NULL;
100 window = gtk_widget_get_window (widget);
102 gdk_window_get_user_data (window, &udata);
103 if (udata == widget && (!input_only || (GDK_IS_WINDOW (window) && gdk_window_is_input_only (GDK_WINDOW (window)))))
104 matches = g_slist_prepend (matches, window);
105 children = gdk_window_get_children (gtk_widget_get_parent_window (widget));
106 for (node = children; node; node = node->next)
108 gdk_window_get_user_data (node->data, &udata);
109 if (udata == widget && (!input_only || (GDK_IS_WINDOW (node->data) && gdk_window_is_input_only (GDK_WINDOW (node->data)))))
110 matches = g_slist_prepend (matches, node->data);
112 return g_slist_reverse (matches);
116 * gtk_test_widget_send_key:
117 * @widget: Widget to generate a key press and release on.
118 * @keyval: A Gdk keyboard value.
119 * @modifiers: Keyboard modifiers the event is setup with.
121 * This function will generate keyboard press and release events in
122 * the middle of the first GdkWindow found that belongs to @widget.
123 * For %GTK_NO_WINDOW widgets like GtkButton, this will often be an
124 * input-only event window. For other widgets, this is usually widget->window.
125 * Certain caveats should be considered when using this function, in
126 * particular because the mouse pointer is warped to the key press
127 * location, see gdk_test_simulate_key() for details.
129 * Returns: wether all actions neccessary for the key event simulation were carried out successfully.
134 gtk_test_widget_send_key (GtkWidget *widget,
136 GdkModifierType modifiers)
138 gboolean k1res, k2res;
139 GSList *iwindows = test_find_widget_input_windows (widget, FALSE);
141 iwindows = test_find_widget_input_windows (widget, TRUE);
144 k1res = gdk_test_simulate_key (iwindows->data, -1, -1, keyval, modifiers, GDK_KEY_PRESS);
145 k2res = gdk_test_simulate_key (iwindows->data, -1, -1, keyval, modifiers, GDK_KEY_RELEASE);
146 g_slist_free (iwindows);
147 return k1res && k2res;
151 * gtk_test_widget_click:
152 * @widget: Widget to generate a button click on.
153 * @button: Number of the pointer button for the event, usually 1, 2 or 3.
154 * @modifiers: Keyboard modifiers the event is setup with.
156 * This function will generate a @button click (button press and button
157 * release event) in the middle of the first GdkWindow found that belongs
159 * For %GTK_NO_WINDOW widgets like GtkButton, this will often be an
160 * input-only event window. For other widgets, this is usually widget->window.
161 * Certain caveats should be considered when using this function, in
162 * particular because the mouse pointer is warped to the button click
163 * location, see gdk_test_simulate_button() for details.
165 * Returns: wether all actions neccessary for the button click simulation were carried out successfully.
170 gtk_test_widget_click (GtkWidget *widget,
172 GdkModifierType modifiers)
174 gboolean b1res, b2res;
175 GSList *iwindows = test_find_widget_input_windows (widget, FALSE);
177 iwindows = test_find_widget_input_windows (widget, TRUE);
180 b1res = gdk_test_simulate_button (iwindows->data, -1, -1, button, modifiers, GDK_BUTTON_PRESS);
181 b2res = gdk_test_simulate_button (iwindows->data, -1, -1, button, modifiers, GDK_BUTTON_RELEASE);
182 g_slist_free (iwindows);
183 return b1res && b2res;
187 * gtk_test_spin_button_click:
188 * @spinner: valid GtkSpinButton widget.
189 * @button: Number of the pointer button for the event, usually 1, 2 or 3.
190 * @upwards: %TRUE for upwards arrow click, %FALSE for downwards arrow click.
192 * This function will generate a @button click in the upwards or downwards
193 * spin button arrow areas, usually leading to an increase or decrease of
194 * spin button's value.
196 * Returns: wether all actions neccessary for the button click simulation were carried out successfully.
201 gtk_test_spin_button_click (GtkSpinButton *spinner,
206 gboolean b1res = FALSE, b2res = FALSE;
208 panel = _gtk_spin_button_get_panel (spinner);
213 width = gdk_window_get_width (panel);
214 pos = upwards ? 0 : gdk_window_get_height (panel) - 1;
215 b1res = gdk_test_simulate_button (panel, width - 1, pos, button, 0, GDK_BUTTON_PRESS);
216 b2res = gdk_test_simulate_button (panel, width - 1, pos, button, 0, GDK_BUTTON_RELEASE);
218 return b1res && b2res;
222 * gtk_test_find_label:
223 * @widget: Valid label or container widget.
224 * @label_pattern: Shell-glob pattern to match a label string.
226 * This function will search @widget and all its descendants for a GtkLabel
227 * widget with a text string matching @label_pattern.
228 * The @label_pattern may contain asterisks '*' and question marks '?' as
229 * placeholders, g_pattern_match() is used for the matching.
230 * Note that locales other than "C" tend to alter (translate" label strings,
231 * so this function is genrally only useful in test programs with
232 * predetermined locales, see gtk_test_init() for more details.
234 * Returns: (transfer none): a GtkLabel widget if any is found.
239 gtk_test_find_label (GtkWidget *widget,
240 const gchar *label_pattern)
242 if (GTK_IS_LABEL (widget))
244 const gchar *text = gtk_label_get_text (GTK_LABEL (widget));
245 if (g_pattern_match_simple (label_pattern, text))
248 if (GTK_IS_CONTAINER (widget))
250 GList *node, *list = gtk_container_get_children (GTK_CONTAINER (widget));
251 for (node = list; node; node = node->next)
253 GtkWidget *label = gtk_test_find_label (node->data, label_pattern);
263 test_list_descendants (GtkWidget *widget,
266 GList *results = NULL;
267 if (GTK_IS_CONTAINER (widget))
269 GList *node, *list = gtk_container_get_children (GTK_CONTAINER (widget));
270 for (node = list; node; node = node->next)
272 if (!widget_type || g_type_is_a (G_OBJECT_TYPE (node->data), widget_type))
273 results = g_list_prepend (results, node->data);
275 results = g_list_concat (results, test_list_descendants (node->data, widget_type));
283 widget_geo_dist (GtkWidget *a,
287 GtkAllocation allocation;
288 int ax0, ay0, ax1, ay1, bx0, by0, bx1, by1, xdist = 0, ydist = 0;
290 gtk_widget_get_allocation (a, &allocation);
291 if (!gtk_widget_translate_coordinates (a, base, 0, 0, &ax0, &ay0) ||
292 !gtk_widget_translate_coordinates (a, base, allocation.width, allocation.height, &ax1, &ay1))
295 gtk_widget_get_allocation (b, &allocation);
296 if (!gtk_widget_translate_coordinates (b, base, 0, 0, &bx0, &by0) ||
297 !gtk_widget_translate_coordinates (b, base, allocation.width, allocation.height, &bx1, &by1))
309 return xdist + ydist;
313 widget_geo_cmp (gconstpointer a,
317 gpointer *data = user_data;
318 GtkWidget *wa = (void*) a, *wb = (void*) b, *toplevel = data[0], *base_widget = data[1];
319 int adist = widget_geo_dist (wa, base_widget, toplevel);
320 int bdist = widget_geo_dist (wb, base_widget, toplevel);
321 return adist > bdist ? +1 : adist == bdist ? 0 : -1;
325 * gtk_test_find_sibling:
326 * @base_widget: Valid widget, part of a widget hierarchy
327 * @widget_type: Type of a aearched for sibling widget
329 * This function will search siblings of @base_widget and siblings of its
330 * ancestors for all widgets matching @widget_type.
331 * Of the matching widgets, the one that is geometrically closest to
332 * @base_widget will be returned.
333 * The general purpose of this function is to find the most likely "action"
334 * widget, relative to another labeling widget. Such as finding a
335 * button or text entry widget, given its corresponding label widget.
337 * Returns: (transfer none): a widget of type @widget_type if any is found.
342 gtk_test_find_sibling (GtkWidget *base_widget,
345 GList *siblings = NULL;
346 GtkWidget *tmpwidget = base_widget;
348 /* find all sibling candidates */
351 tmpwidget = gtk_widget_get_parent (tmpwidget);
352 siblings = g_list_concat (siblings, test_list_descendants (tmpwidget, widget_type));
354 /* sort them by distance to base_widget */
355 data[0] = gtk_widget_get_toplevel (base_widget);
356 data[1] = base_widget;
357 siblings = g_list_sort_with_data (siblings, widget_geo_cmp, data);
358 /* pick nearest != base_widget */
359 siblings = g_list_remove (siblings, base_widget);
360 tmpwidget = siblings ? siblings->data : NULL;
361 g_list_free (siblings);
366 * gtk_test_find_widget:
367 * @widget: Container widget, usually a GtkWindow.
368 * @label_pattern: Shell-glob pattern to match a label string.
369 * @widget_type: Type of a aearched for label sibling widget.
371 * This function will search the descendants of @widget for a widget
372 * of type @widget_type that has a label matching @label_pattern next
373 * to it. This is most useful for automated GUI testing, e.g. to find
374 * the "OK" button in a dialog and synthesize clicks on it.
375 * However see gtk_test_find_label(), gtk_test_find_sibling() and
376 * gtk_test_widget_click() for possible caveats involving the search of
377 * such widgets and synthesizing widget events.
379 * Returns: (transfer none): a valid widget if any is found or %NULL.
384 gtk_test_find_widget (GtkWidget *widget,
385 const gchar *label_pattern,
388 GtkWidget *label = gtk_test_find_label (widget, label_pattern);
390 label = gtk_test_find_label (gtk_widget_get_toplevel (widget), label_pattern);
392 return gtk_test_find_sibling (label, widget_type);
397 * gtk_test_slider_set_perc:
398 * @widget: valid widget pointer.
399 * @percentage: value between 0 and 100.
401 * This function will adjust the slider position of all GtkRange
402 * based widgets, such as scrollbars or scales, it'll also adjust
403 * spin buttons. The adjustment value of these widgets is set to
404 * a value between the lower and upper limits, according to the
405 * @percentage argument.
410 gtk_test_slider_set_perc (GtkWidget *widget,
413 GtkAdjustment *adjustment = NULL;
414 if (GTK_IS_RANGE (widget))
415 adjustment = gtk_range_get_adjustment (GTK_RANGE (widget));
416 else if (GTK_IS_SPIN_BUTTON (widget))
417 adjustment = gtk_spin_button_get_adjustment (GTK_SPIN_BUTTON (widget));
419 gtk_adjustment_set_value (adjustment,
420 gtk_adjustment_get_lower (adjustment)
421 + (gtk_adjustment_get_upper (adjustment)
422 - gtk_adjustment_get_lower (adjustment)
423 - gtk_adjustment_get_page_size (adjustment))
424 * percentage * 0.01);
428 * gtk_test_slider_get_value:
429 * @widget: valid widget pointer.
431 * Retrive the literal adjustment value for GtkRange based
432 * widgets and spin buttons. Note that the value returned by
433 * this function is anything between the lower and upper bounds
434 * of the adjustment belonging to @widget, and is not a percentage
435 * as passed in to gtk_test_slider_set_perc().
437 * Returns: gtk_adjustment_get_value (adjustment) for an adjustment belonging to @widget.
442 gtk_test_slider_get_value (GtkWidget *widget)
444 GtkAdjustment *adjustment = NULL;
445 if (GTK_IS_RANGE (widget))
446 adjustment = gtk_range_get_adjustment (GTK_RANGE (widget));
447 else if (GTK_IS_SPIN_BUTTON (widget))
448 adjustment = gtk_spin_button_get_adjustment (GTK_SPIN_BUTTON (widget));
449 return adjustment ? gtk_adjustment_get_value (adjustment) : 0;
454 * @widget: valid widget pointer.
455 * @string: a 0-terminated C string
457 * Set the text string of @widget to @string if it is a GtkLabel,
458 * GtkEditable (entry and text widgets) or GtkTextView.
463 gtk_test_text_set (GtkWidget *widget,
466 if (GTK_IS_LABEL (widget))
467 gtk_label_set_text (GTK_LABEL (widget), string);
468 else if (GTK_IS_EDITABLE (widget))
471 gtk_editable_delete_text (GTK_EDITABLE (widget), 0, -1);
472 gtk_editable_insert_text (GTK_EDITABLE (widget), string, -1, &pos);
474 else if (GTK_IS_TEXT_VIEW (widget))
476 GtkTextBuffer *tbuffer = gtk_text_view_get_buffer (GTK_TEXT_VIEW (widget));
477 gtk_text_buffer_set_text (tbuffer, string, -1);
483 * @widget: valid widget pointer.
485 * Retrive the text string of @widget if it is a GtkLabel,
486 * GtkEditable (entry and text widgets) or GtkTextView.
488 * Returns: new 0-terminated C string, needs to be released with g_free().
493 gtk_test_text_get (GtkWidget *widget)
495 if (GTK_IS_LABEL (widget))
496 return g_strdup (gtk_label_get_text (GTK_LABEL (widget)));
497 else if (GTK_IS_EDITABLE (widget))
499 return g_strdup (gtk_editable_get_chars (GTK_EDITABLE (widget), 0, -1));
501 else if (GTK_IS_TEXT_VIEW (widget))
503 GtkTextBuffer *tbuffer = gtk_text_view_get_buffer (GTK_TEXT_VIEW (widget));
504 GtkTextIter start, end;
505 gtk_text_buffer_get_start_iter (tbuffer, &start);
506 gtk_text_buffer_get_end_iter (tbuffer, &end);
507 return gtk_text_buffer_get_text (tbuffer, &start, &end, FALSE);
513 * gtk_test_create_widget:
514 * @widget_type: a valid widget type.
515 * @first_property_name: (allow-none): Name of first property to set or %NULL
516 * @Varargs: value to set the first property to, followed by more
517 * name-value pairs, terminated by %NULL
519 * This function wraps g_object_new() for widget types.
520 * It'll automatically show all created non window widgets, also
521 * g_object_ref_sink() them (to keep them alive across a running test)
522 * and set them up for destruction during the next test teardown phase.
524 * Returns: (transfer none): a newly created widget.
529 gtk_test_create_widget (GType widget_type,
530 const gchar *first_property_name,
535 g_return_val_if_fail (g_type_is_a (widget_type, GTK_TYPE_WIDGET), NULL);
536 va_start (var_args, first_property_name);
537 widget = (GtkWidget*) g_object_new_valist (widget_type, first_property_name, var_args);
541 if (!GTK_IS_WINDOW (widget))
542 gtk_widget_show (widget);
543 g_object_ref_sink (widget);
544 g_test_queue_unref (widget);
545 g_test_queue_destroy ((GDestroyNotify) gtk_widget_destroy, widget);
553 if (gtk_main_level())
558 test_increment_intp (int *intp)
562 return 1; /* TRUE in case we're connected to event signals */
566 * gtk_test_display_button_window:
567 * @window_title: Title of the window to be displayed.
568 * @dialog_text: Text inside the window to be displayed.
569 * @...: %NULL terminated list of (const char *label, int *nump) pairs.
571 * Create a window with window title @window_title, text contents @dialog_text,
572 * and a number of buttons, according to the paired argument list given
573 * as @... parameters.
574 * Each button is created with a @label and a ::clicked signal handler that
575 * incremrents the integer stored in @nump.
576 * The window will be automatically shown with gtk_widget_show_now() after
577 * creation, so when this function returns it has already been mapped,
578 * resized and positioned on screen.
579 * The window will quit any running gtk_main()-loop when destroyed, and it
580 * will automatically be destroyed upon test function teardown.
582 * Returns: (transfer full): a widget pointer to the newly created GtkWindow.
587 gtk_test_display_button_window (const gchar *window_title,
588 const gchar *dialog_text,
589 ...) /* NULL terminated list of (label, &int) pairs */
592 GtkWidget *window = gtk_test_create_widget (GTK_TYPE_WINDOW, "title", window_title, NULL);
593 GtkWidget *vbox = gtk_test_create_widget (GTK_TYPE_BOX, "parent", window, "orientation", GTK_ORIENTATION_VERTICAL, NULL);
595 gtk_test_create_widget (GTK_TYPE_LABEL, "label", dialog_text, "parent", vbox, NULL);
596 g_signal_connect (window, "destroy", G_CALLBACK (try_main_quit), NULL);
597 va_start (var_args, dialog_text);
598 arg1 = va_arg (var_args, const char*);
601 int *arg2 = va_arg (var_args, int*);
602 GtkWidget *button = gtk_test_create_widget (GTK_TYPE_BUTTON, "label", arg1, "parent", vbox, NULL);
603 g_signal_connect_swapped (button, "clicked", G_CALLBACK (test_increment_intp), arg2);
604 arg1 = va_arg (var_args, const char*);
607 gtk_widget_show_all (vbox);
608 gtk_widget_show_now (window);
609 while (gtk_events_pending ())
610 gtk_main_iteration ();
615 * gtk_test_create_simple_window:
616 * @window_title: Title of the window to be displayed.
617 * @dialog_text: Text inside the window to be displayed.
619 * Create a simple window with window title @window_title and
620 * text contents @dialog_text.
621 * The window will quit any running gtk_main()-loop when destroyed, and it
622 * will automatically be destroyed upon test function teardown.
624 * Returns: (transfer none): a widget pointer to the newly created GtkWindow.
629 gtk_test_create_simple_window (const gchar *window_title,
630 const gchar *dialog_text)
632 GtkWidget *window = gtk_test_create_widget (GTK_TYPE_WINDOW, "title", window_title, NULL);
633 GtkWidget *vbox = gtk_test_create_widget (GTK_TYPE_BOX, "parent", window, "orientation", GTK_ORIENTATION_VERTICAL, NULL);
634 gtk_test_create_widget (GTK_TYPE_LABEL, "label", dialog_text, "parent", vbox, NULL);
635 g_signal_connect (window, "destroy", G_CALLBACK (try_main_quit), NULL);
636 gtk_widget_show_all (vbox);
640 static GType *all_registered_types = NULL;
641 static guint n_all_registered_types = 0;
644 * gtk_test_list_all_types:
645 * @n_types: location to store number of types
646 * @returns: (array length=n_types zero-terminated=1) (transfer none):
647 * 0-terminated array of type ids
649 * Return the type ids that have been registered after
650 * calling gtk_test_register_all_types().
655 gtk_test_list_all_types (guint *n_types)
658 *n_types = n_all_registered_types;
659 return all_registered_types;
663 * gtk_test_register_all_types:
665 * Force registration of all core Gtk+ and Gdk object types.
666 * This allowes to refer to any of those object types via
667 * g_type_from_name() after calling this function.
672 gtk_test_register_all_types (void)
674 if (!all_registered_types)
676 const guint max_gtk_types = 999;
678 all_registered_types = g_new0 (GType, max_gtk_types);
679 tp = all_registered_types;
680 #include "gtktypefuncs.c"
681 n_all_registered_types = tp - all_registered_types;
682 g_assert (n_all_registered_types + 1 < max_gtk_types);