gtktestutils.c 23 KB
Newer Older
1
/* Gtk+ testing utilities
2 3
 * Copyright (C) 2007 Imendio AB
 * Authors: Tim Janik
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */
20

21

22
#include "config.h"
23

Matthias Clasen's avatar
Matthias Clasen committed
24
#include <gtk/gtkx.h>
25
#include "gtkspinbutton.h"
26 27 28 29 30 31
#include "gtkmain.h"
#include "gtkbox.h"
#include "gtklabel.h"
#include "gtkbutton.h"
#include "gtktextview.h"
#include "gtkrange.h"
32 33 34 35 36 37

#include <locale.h>
#include <string.h>
#include <math.h>


38 39 40 41 42 43
/**
 * SECTION:gtktesting
 * @Short_description: Utilities for testing GTK+ applications
 * @Title: Testing
 */

44 45
/**
 * gtk_test_init:
Johan Dahlin's avatar
Johan Dahlin committed
46
 * @argcp: Address of the <parameter>argc</parameter> parameter of the
47
 *        main() function. Changed if any arguments were handled.
48 49
 * @argvp: (inout) (array length=argcp): Address of the 
 *        <parameter>argv</parameter> parameter of main().
50 51
 *        Any parameters understood by g_test_init() or gtk_init() are
 *        stripped before return.
Matthias Clasen's avatar
Matthias Clasen committed
52
 * @...: currently unused
Matthias Clasen's avatar
Matthias Clasen committed
53 54
 *
 * This function is used to initialize a GTK+ test program.
55 56
 *
 * It will in turn call g_test_init() and gtk_init() to properly
Matthias Clasen's avatar
Matthias Clasen committed
57 58 59
 * initialize the testing framework and graphical toolkit. It'll 
 * also set the program's locale to "C" and prevent loading of rc 
 * files and Gtk+ modules. This is done to make tets program
60
 * environments as deterministic as possible.
Matthias Clasen's avatar
Matthias Clasen committed
61
 *
62 63
 * Like gtk_init() and g_test_init(), any known arguments will be
 * processed and stripped from @argc and @argv.
Christian Dywan's avatar
Christian Dywan committed
64 65
 *
 * Since: 2.14
66 67 68 69 70 71
 **/
void
gtk_test_init (int    *argcp,
               char ***argvp,
               ...)
{
72
  g_test_init (argcp, argvp, NULL);
73 74 75 76 77 78 79 80 81
  /* - enter C locale
   * - call g_test_init();
   * - call gtk_init();
   * - prevent RC files from loading;
   * - prevent Gtk modules from loading;
   * - supply mock object for GtkSettings
   * FUTURE TODO:
   * - this function could install a mock object around GtkSettings
   */
82
  g_setenv ("GTK_MODULES", "", TRUE);
83 84
  gtk_disable_setlocale();
  setlocale (LC_ALL, "C");
85
  g_test_bug_base ("http://bugzilla.gnome.org/show_bug.cgi?id=%s");
86 87 88 89 90 91 92 93

  /* XSendEvent() doesn't work yet on XI2 events.
   * So at the moment gdk_test_simulate_* can only
   * send events that GTK+ understands if XI2 is
   * disabled, bummer.
   */
  gdk_disable_multidevice ();

94 95 96 97 98 99 100
  gtk_init (argcp, argvp);
}

static GSList*
test_find_widget_input_windows (GtkWidget *widget,
                                gboolean   input_only)
{
101
  GdkWindow *window;
102 103 104
  GList *node, *children;
  GSList *matches = NULL;
  gpointer udata;
105 106 107 108 109 110

  window = gtk_widget_get_window (widget);

  gdk_window_get_user_data (window, &udata);
  if (udata == widget && (!input_only || (GDK_IS_WINDOW (window) && gdk_window_is_input_only (GDK_WINDOW (window)))))
    matches = g_slist_prepend (matches, window);
111 112 113 114
  children = gdk_window_get_children (gtk_widget_get_parent_window (widget));
  for (node = children; node; node = node->next)
    {
      gdk_window_get_user_data (node->data, &udata);
115
      if (udata == widget && (!input_only || (GDK_IS_WINDOW (node->data) && gdk_window_is_input_only (GDK_WINDOW (node->data)))))
116 117 118 119 120 121
        matches = g_slist_prepend (matches, node->data);
    }
  return g_slist_reverse (matches);
}

/**
122
 * gtk_test_widget_send_key:
123 124 125 126 127 128 129 130 131 132
 * @widget: Widget to generate a key press and release on.
 * @keyval: A Gdk keyboard value.
 * @modifiers: Keyboard modifiers the event is setup with.
 *
 * This function will generate keyboard press and release events in
 * the middle of the first GdkWindow found that belongs to @widget.
 * For %GTK_NO_WINDOW widgets like GtkButton, this will often be an
 * input-only event window. For other widgets, this is usually widget->window.
 * Certain caveats should be considered when using this function, in
 * particular because the mouse pointer is warped to the key press
133
 * location, see gdk_test_simulate_key() for details.
134 135
 *
 * Returns: wether all actions neccessary for the key event simulation were carried out successfully.
Christian Dywan's avatar
Christian Dywan committed
136 137
 *
 * Since: 2.14
138 139 140 141 142 143 144 145 146 147 148 149
 **/
gboolean
gtk_test_widget_send_key (GtkWidget      *widget,
                          guint           keyval,
                          GdkModifierType modifiers)
{
  gboolean k1res, k2res;
  GSList *iwindows = test_find_widget_input_windows (widget, FALSE);
  if (!iwindows)
    iwindows = test_find_widget_input_windows (widget, TRUE);
  if (!iwindows)
    return FALSE;
150 151
  k1res = gdk_test_simulate_key (iwindows->data, -1, -1, keyval, modifiers, GDK_KEY_PRESS);
  k2res = gdk_test_simulate_key (iwindows->data, -1, -1, keyval, modifiers, GDK_KEY_RELEASE);
152 153 154 155 156
  g_slist_free (iwindows);
  return k1res && k2res;
}

/**
157
 * gtk_test_widget_click:
158 159 160 161 162 163 164 165 166 167 168
 * @widget: Widget to generate a button click on.
 * @button: Number of the pointer button for the event, usually 1, 2 or 3.
 * @modifiers: Keyboard modifiers the event is setup with.
 *
 * This function will generate a @button click (button press and button
 * release event) in the middle of the first GdkWindow found that belongs
 * to @widget.
 * For %GTK_NO_WINDOW widgets like GtkButton, this will often be an
 * input-only event window. For other widgets, this is usually widget->window.
 * Certain caveats should be considered when using this function, in
 * particular because the mouse pointer is warped to the button click
169
 * location, see gdk_test_simulate_button() for details.
170 171
 *
 * Returns: wether all actions neccessary for the button click simulation were carried out successfully.
Christian Dywan's avatar
Christian Dywan committed
172 173
 *
 * Since: 2.14
174 175 176 177 178 179 180 181 182 183 184 185
 **/
gboolean
gtk_test_widget_click (GtkWidget      *widget,
                       guint           button,
                       GdkModifierType modifiers)
{
  gboolean b1res, b2res;
  GSList *iwindows = test_find_widget_input_windows (widget, FALSE);
  if (!iwindows)
    iwindows = test_find_widget_input_windows (widget, TRUE);
  if (!iwindows)
    return FALSE;
186 187
  b1res = gdk_test_simulate_button (iwindows->data, -1, -1, button, modifiers, GDK_BUTTON_PRESS);
  b2res = gdk_test_simulate_button (iwindows->data, -1, -1, button, modifiers, GDK_BUTTON_RELEASE);
188 189 190 191 192
  g_slist_free (iwindows);
  return b1res && b2res;
}

/**
193
 * gtk_test_spin_button_click:
194 195 196 197 198 199 200 201 202
 * @spinner: valid GtkSpinButton widget.
 * @button:  Number of the pointer button for the event, usually 1, 2 or 3.
 * @upwards: %TRUE for upwards arrow click, %FALSE for downwards arrow click.
 *
 * This function will generate a @button click in the upwards or downwards
 * spin button arrow areas, usually leading to an increase or decrease of
 * spin button's value.
 *
 * Returns: wether all actions neccessary for the button click simulation were carried out successfully.
Christian Dywan's avatar
Christian Dywan committed
203 204
 *
 * Since: 2.14
205 206 207 208 209 210
 **/
gboolean
gtk_test_spin_button_click (GtkSpinButton  *spinner,
                            guint           button,
                            gboolean        upwards)
{
211
  GdkWindow *down_panel = NULL, *up_panel = NULL, *panel;
212
  gboolean b1res = FALSE, b2res = FALSE;
213

214 215 216
  _gtk_spin_button_get_panels (spinner, &down_panel, &up_panel);

  panel = (upwards) ? up_panel : down_panel;
217 218

  if (panel)
219
    {
220 221 222
      gint width = gdk_window_get_width (panel);
      b1res = gdk_test_simulate_button (panel, width - 1, 1, button, 0, GDK_BUTTON_PRESS);
      b2res = gdk_test_simulate_button (panel, width - 1, 1, button, 0, GDK_BUTTON_RELEASE);
223 224 225 226 227
    }
  return b1res && b2res;
}

/**
228
 * gtk_test_find_label:
229 230 231 232 233 234 235 236 237 238 239
 * @widget:        Valid label or container widget.
 * @label_pattern: Shell-glob pattern to match a label string.
 *
 * This function will search @widget and all its descendants for a GtkLabel
 * widget with a text string matching @label_pattern.
 * The @label_pattern may contain asterisks '*' and question marks '?' as
 * placeholders, g_pattern_match() is used for the matching.
 * Note that locales other than "C" tend to alter (translate" label strings,
 * so this function is genrally only useful in test programs with
 * predetermined locales, see gtk_test_init() for more details.
 *
240
 * Returns: (transfer none): a GtkLabel widget if any is found.
Christian Dywan's avatar
Christian Dywan committed
241 242
 *
 * Since: 2.14
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
 **/
GtkWidget*
gtk_test_find_label (GtkWidget    *widget,
                     const gchar  *label_pattern)
{
  if (GTK_IS_LABEL (widget))
    {
      const gchar *text = gtk_label_get_text (GTK_LABEL (widget));
      if (g_pattern_match_simple (label_pattern, text))
        return widget;
    }
  if (GTK_IS_CONTAINER (widget))
    {
      GList *node, *list = gtk_container_get_children (GTK_CONTAINER (widget));
      for (node = list; node; node = node->next)
        {
          GtkWidget *label = gtk_test_find_label (node->data, label_pattern);
          if (label)
            return label;
        }
      g_list_free (list);
    }
  return NULL;
}

static GList*
test_list_descendants (GtkWidget *widget,
                       GType      widget_type)
{
  GList *results = NULL;
  if (GTK_IS_CONTAINER (widget))
    {
      GList *node, *list = gtk_container_get_children (GTK_CONTAINER (widget));
      for (node = list; node; node = node->next)
        {
          if (!widget_type || g_type_is_a (G_OBJECT_TYPE (node->data), widget_type))
            results = g_list_prepend (results, node->data);
          else
            results = g_list_concat (results, test_list_descendants (node->data, widget_type));
        }
      g_list_free (list);
    }
  return results;
}

static int
widget_geo_dist (GtkWidget *a,
                 GtkWidget *b,
                 GtkWidget *base)
{
293
  GtkAllocation allocation;
294
  int ax0, ay0, ax1, ay1, bx0, by0, bx1, by1, xdist = 0, ydist = 0;
295 296

  gtk_widget_get_allocation (a, &allocation);
297
  if (!gtk_widget_translate_coordinates (a, base, 0, 0, &ax0, &ay0) ||
298
      !gtk_widget_translate_coordinates (a, base, allocation.width, allocation.height, &ax1, &ay1))
299
    return -G_MAXINT;
300 301

  gtk_widget_get_allocation (b, &allocation);
302
  if (!gtk_widget_translate_coordinates (b, base, 0, 0, &bx0, &by0) ||
303
      !gtk_widget_translate_coordinates (b, base, allocation.width, allocation.height, &bx1, &by1))
304
    return +G_MAXINT;
305

306 307 308 309 310 311 312 313
  if (bx0 >= ax1)
    xdist = bx0 - ax1;
  else if (ax0 >= bx1)
    xdist = ax0 - bx1;
  if (by0 >= ay1)
    ydist = by0 - ay1;
  else if (ay0 >= by1)
    ydist = ay0 - by1;
314

315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330
  return xdist + ydist;
}

static int
widget_geo_cmp (gconstpointer a,
                gconstpointer b,
                gpointer      user_data)
{
  gpointer *data = user_data;
  GtkWidget *wa = (void*) a, *wb = (void*) b, *toplevel = data[0], *base_widget = data[1];
  int adist = widget_geo_dist (wa, base_widget, toplevel);
  int bdist = widget_geo_dist (wb, base_widget, toplevel);
  return adist > bdist ? +1 : adist == bdist ? 0 : -1;
}

/**
331
 * gtk_test_find_sibling:
332 333 334 335 336 337 338 339 340
 * @base_widget:        Valid widget, part of a widget hierarchy
 * @widget_type:        Type of a aearched for sibling widget
 *
 * This function will search siblings of @base_widget and siblings of its
 * ancestors for all widgets matching @widget_type.
 * Of the matching widgets, the one that is geometrically closest to
 * @base_widget will be returned.
 * The general purpose of this function is to find the most likely "action"
 * widget, relative to another labeling widget. Such as finding a
341
 * button or text entry widget, given its corresponding label widget.
342
 *
343
 * Returns: (transfer none): a widget of type @widget_type if any is found.
Christian Dywan's avatar
Christian Dywan committed
344 345
 *
 * Since: 2.14
346 347 348 349 350 351 352 353 354 355 356
 **/
GtkWidget*
gtk_test_find_sibling (GtkWidget *base_widget,
                       GType      widget_type)
{
  GList *siblings = NULL;
  GtkWidget *tmpwidget = base_widget;
  gpointer data[2];
  /* find all sibling candidates */
  while (tmpwidget)
    {
357
      tmpwidget = gtk_widget_get_parent (tmpwidget);
358 359 360 361 362 363 364 365 366 367 368 369 370 371
      siblings = g_list_concat (siblings, test_list_descendants (tmpwidget, widget_type));
    }
  /* sort them by distance to base_widget */
  data[0] = gtk_widget_get_toplevel (base_widget);
  data[1] = base_widget;
  siblings = g_list_sort_with_data (siblings, widget_geo_cmp, data);
  /* pick nearest != base_widget */
  siblings = g_list_remove (siblings, base_widget);
  tmpwidget = siblings ? siblings->data : NULL;
  g_list_free (siblings);
  return tmpwidget;
}

/**
372
 * gtk_test_find_widget:
373 374 375 376 377 378 379 380 381 382 383 384
 * @widget:        Container widget, usually a GtkWindow.
 * @label_pattern: Shell-glob pattern to match a label string.
 * @widget_type:   Type of a aearched for label sibling widget.
 *
 * This function will search the descendants of @widget for a widget
 * of type @widget_type that has a label matching @label_pattern next
 * to it. This is most useful for automated GUI testing, e.g. to find
 * the "OK" button in a dialog and synthesize clicks on it.
 * However see gtk_test_find_label(), gtk_test_find_sibling() and
 * gtk_test_widget_click() for possible caveats involving the search of
 * such widgets and synthesizing widget events.
 *
385
 * Returns: (transfer none): a valid widget if any is found or %NULL.
Christian Dywan's avatar
Christian Dywan committed
386 387
 *
 * Since: 2.14
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
 **/
GtkWidget*
gtk_test_find_widget (GtkWidget    *widget,
                      const gchar  *label_pattern,
                      GType         widget_type)
{
  GtkWidget *label = gtk_test_find_label (widget, label_pattern);
  if (!label)
    label = gtk_test_find_label (gtk_widget_get_toplevel (widget), label_pattern);
  if (label)
    return gtk_test_find_sibling (label, widget_type);
  return NULL;
}

/**
403
 * gtk_test_slider_set_perc:
404 405 406
 * @widget:     valid widget pointer.
 * @percentage: value between 0 and 100.
 *
407
 * This function will adjust the slider position of all GtkRange
408
 * based widgets, such as scrollbars or scales, it'll also adjust
409
 * spin buttons. The adjustment value of these widgets is set to
410 411
 * a value between the lower and upper limits, according to the
 * @percentage argument.
Christian Dywan's avatar
Christian Dywan committed
412 413
 *
 * Since: 2.14
414 415 416 417 418 419 420 421 422 423 424
 **/
void
gtk_test_slider_set_perc (GtkWidget      *widget,
                          double          percentage)
{
  GtkAdjustment *adjustment = NULL;
  if (GTK_IS_RANGE (widget))
    adjustment = gtk_range_get_adjustment (GTK_RANGE (widget));
  else if (GTK_IS_SPIN_BUTTON (widget))
    adjustment = gtk_spin_button_get_adjustment (GTK_SPIN_BUTTON (widget));
  if (adjustment)
425 426 427 428 429 430
    gtk_adjustment_set_value (adjustment, 
                              gtk_adjustment_get_lower (adjustment) 
                              + (gtk_adjustment_get_upper (adjustment) 
                                 - gtk_adjustment_get_lower (adjustment) 
                                 - gtk_adjustment_get_page_size (adjustment))
                                * percentage * 0.01);
431 432 433
}

/**
434
 * gtk_test_slider_get_value:
435 436 437 438 439 440 441 442
 * @widget:     valid widget pointer.
 *
 * Retrive the literal adjustment value for GtkRange based
 * widgets and spin buttons. Note that the value returned by
 * this function is anything between the lower and upper bounds
 * of the adjustment belonging to @widget, and is not a percentage
 * as passed in to gtk_test_slider_set_perc().
 *
443
 * Returns: gtk_adjustment_get_value (adjustment) for an adjustment belonging to @widget.
Christian Dywan's avatar
Christian Dywan committed
444 445
 *
 * Since: 2.14
446 447 448 449 450 451 452 453 454
 **/
double
gtk_test_slider_get_value (GtkWidget *widget)
{
  GtkAdjustment *adjustment = NULL;
  if (GTK_IS_RANGE (widget))
    adjustment = gtk_range_get_adjustment (GTK_RANGE (widget));
  else if (GTK_IS_SPIN_BUTTON (widget))
    adjustment = gtk_spin_button_get_adjustment (GTK_SPIN_BUTTON (widget));
455
  return adjustment ? gtk_adjustment_get_value (adjustment) : 0;
456 457 458
}

/**
459
 * gtk_test_text_set:
460 461 462 463 464
 * @widget:     valid widget pointer.
 * @string:     a 0-terminated C string
 *
 * Set the text string of @widget to @string if it is a GtkLabel,
 * GtkEditable (entry and text widgets) or GtkTextView.
Christian Dywan's avatar
Christian Dywan committed
465 466
 *
 * Since: 2.14
467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
 **/
void
gtk_test_text_set (GtkWidget   *widget,
                   const gchar *string)
{
  if (GTK_IS_LABEL (widget))
    gtk_label_set_text (GTK_LABEL (widget), string);
  else if (GTK_IS_EDITABLE (widget))
    {
      int pos = 0;
      gtk_editable_delete_text (GTK_EDITABLE (widget), 0, -1);
      gtk_editable_insert_text (GTK_EDITABLE (widget), string, -1, &pos);
    }
  else if (GTK_IS_TEXT_VIEW (widget))
    {
      GtkTextBuffer *tbuffer = gtk_text_view_get_buffer (GTK_TEXT_VIEW (widget));
      gtk_text_buffer_set_text (tbuffer, string, -1);
    }
}

/**
488
 * gtk_test_text_get:
489 490 491 492 493
 * @widget:     valid widget pointer.
 *
 * Retrive the text string of @widget if it is a GtkLabel,
 * GtkEditable (entry and text widgets) or GtkTextView.
 *
494
 * Returns: new 0-terminated C string, needs to be released with g_free().
Christian Dywan's avatar
Christian Dywan committed
495 496
 *
 * Since: 2.14
497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518
 **/
gchar*
gtk_test_text_get (GtkWidget *widget)
{
  if (GTK_IS_LABEL (widget))
    return g_strdup (gtk_label_get_text (GTK_LABEL (widget)));
  else if (GTK_IS_EDITABLE (widget))
    {
      return g_strdup (gtk_editable_get_chars (GTK_EDITABLE (widget), 0, -1));
    }
  else if (GTK_IS_TEXT_VIEW (widget))
    {
      GtkTextBuffer *tbuffer = gtk_text_view_get_buffer (GTK_TEXT_VIEW (widget));
      GtkTextIter start, end;
      gtk_text_buffer_get_start_iter (tbuffer, &start);
      gtk_text_buffer_get_end_iter (tbuffer, &end);
      return gtk_text_buffer_get_text (tbuffer, &start, &end, FALSE);
    }
  return NULL;
}

/**
519
 * gtk_test_create_widget:
Matthias Clasen's avatar
Matthias Clasen committed
520
 * @widget_type: a valid widget type.
521
 * @first_property_name: (allow-none): Name of first property to set or %NULL
Matthias Clasen's avatar
Matthias Clasen committed
522
 * @...: value to set the first property to, followed by more
Matthias Clasen's avatar
Matthias Clasen committed
523
 *    name-value pairs, terminated by %NULL
524 525 526 527
 *
 * This function wraps g_object_new() for widget types.
 * It'll automatically show all created non window widgets, also
 * g_object_ref_sink() them (to keep them alive across a running test)
528
 * and set them up for destruction during the next test teardown phase.
529
 *
530
 * Returns: (transfer none): a newly created widget.
Christian Dywan's avatar
Christian Dywan committed
531 532
 *
 * Since: 2.14
533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
 */
GtkWidget*
gtk_test_create_widget (GType        widget_type,
                        const gchar *first_property_name,
                        ...)
{
  GtkWidget *widget;
  va_list var_args;
  g_return_val_if_fail (g_type_is_a (widget_type, GTK_TYPE_WIDGET), NULL);
  va_start (var_args, first_property_name);
  widget = (GtkWidget*) g_object_new_valist (widget_type, first_property_name, var_args);
  va_end (var_args);
  if (widget)
    {
      if (!GTK_IS_WINDOW (widget))
        gtk_widget_show (widget);
      g_object_ref_sink (widget);
      g_test_queue_unref (widget);
      g_test_queue_destroy ((GDestroyNotify) gtk_widget_destroy, widget);
    }
  return widget;
}

static void
try_main_quit (void)
{
  if (gtk_main_level())
    gtk_main_quit();
}

static int
test_increment_intp (int *intp)
{
566 567
  if (intp != NULL)
    *intp += 1;
568 569 570 571
  return 1; /* TRUE in case we're connected to event signals */
}

/**
572
 * gtk_test_display_button_window:
573 574 575 576 577 578 579 580 581 582 583 584 585 586 587
 * @window_title:       Title of the window to be displayed.
 * @dialog_text:        Text inside the window to be displayed.
 * @...:                %NULL terminated list of (const char *label, int *nump) pairs.
 *
 * Create a window with window title @window_title, text contents @dialog_text,
 * and a number of buttons, according to the paired argument list given
 * as @... parameters.
 * Each button is created with a @label and a ::clicked signal handler that
 * incremrents the integer stored in @nump.
 * The window will be automatically shown with gtk_widget_show_now() after
 * creation, so when this function returns it has already been mapped,
 * resized and positioned on screen.
 * The window will quit any running gtk_main()-loop when destroyed, and it
 * will automatically be destroyed upon test function teardown.
 *
588
 * Returns: (transfer full): a widget pointer to the newly created GtkWindow.
Christian Dywan's avatar
Christian Dywan committed
589 590
 *
 * Since: 2.14
591 592 593 594 595 596 597 598
 **/
GtkWidget*
gtk_test_display_button_window (const gchar *window_title,
                                const gchar *dialog_text,
                                ...) /* NULL terminated list of (label, &int) pairs */
{
  va_list var_args;
  GtkWidget *window = gtk_test_create_widget (GTK_TYPE_WINDOW, "title", window_title, NULL);
599
  GtkWidget *vbox = gtk_test_create_widget (GTK_TYPE_BOX, "parent", window, "orientation", GTK_ORIENTATION_VERTICAL, NULL);
600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620
  const char *arg1;
  gtk_test_create_widget (GTK_TYPE_LABEL, "label", dialog_text, "parent", vbox, NULL);
  g_signal_connect (window, "destroy", G_CALLBACK (try_main_quit), NULL);
  va_start (var_args, dialog_text);
  arg1 = va_arg (var_args, const char*);
  while (arg1)
    {
      int *arg2 = va_arg (var_args, int*);
      GtkWidget *button = gtk_test_create_widget (GTK_TYPE_BUTTON, "label", arg1, "parent", vbox, NULL);
      g_signal_connect_swapped (button, "clicked", G_CALLBACK (test_increment_intp), arg2);
      arg1 = va_arg (var_args, const char*);
    }
  va_end (var_args);
  gtk_widget_show_all (vbox);
  gtk_widget_show_now (window);
  while (gtk_events_pending ())
    gtk_main_iteration ();
  return window;
}

/**
621
 * gtk_test_create_simple_window:
622 623 624 625 626 627 628 629
 * @window_title:       Title of the window to be displayed.
 * @dialog_text:        Text inside the window to be displayed.
 *
 * Create a simple window with window title @window_title and
 * text contents @dialog_text.
 * The window will quit any running gtk_main()-loop when destroyed, and it
 * will automatically be destroyed upon test function teardown.
 *
630
 * Returns: (transfer none): a widget pointer to the newly created GtkWindow.
Christian Dywan's avatar
Christian Dywan committed
631 632
 *
 * Since: 2.14
633 634 635 636 637 638
 **/
GtkWidget*
gtk_test_create_simple_window (const gchar *window_title,
                               const gchar *dialog_text)
{
  GtkWidget *window = gtk_test_create_widget (GTK_TYPE_WINDOW, "title", window_title, NULL);
639
  GtkWidget *vbox = gtk_test_create_widget (GTK_TYPE_BOX, "parent", window, "orientation", GTK_ORIENTATION_VERTICAL, NULL);
640 641 642 643 644 645
  gtk_test_create_widget (GTK_TYPE_LABEL, "label", dialog_text, "parent", vbox, NULL);
  g_signal_connect (window, "destroy", G_CALLBACK (try_main_quit), NULL);
  gtk_widget_show_all (vbox);
  return window;
}

646 647 648 649
static GType *all_registered_types = NULL;
static guint  n_all_registered_types = 0;

/**
650
 * gtk_test_list_all_types:
651 652 653 654
 * @n_types: location to store number of types
 *
 * Return the type ids that have been registered after
 * calling gtk_test_register_all_types().
Christian Dywan's avatar
Christian Dywan committed
655
 *
Matthias Clasen's avatar
Matthias Clasen committed
656 657 658
 * Returns: (array length=n_types zero-terminated=1) (transfer none):
 *    0-terminated array of type ids
 *
Christian Dywan's avatar
Christian Dywan committed
659
 * Since: 2.14
Matthias Clasen's avatar
Matthias Clasen committed
660
 */
661 662 663 664 665 666 667 668
const GType*
gtk_test_list_all_types (guint *n_types)
{
  if (n_types)
    *n_types = n_all_registered_types;
  return all_registered_types;
}

669
/**
670
 * gtk_test_register_all_types:
671 672 673 674
 *
 * Force registration of all core Gtk+ and Gdk object types.
 * This allowes to refer to any of those object types via
 * g_type_from_name() after calling this function.
Christian Dywan's avatar
Christian Dywan committed
675 676
 *
 * Since: 2.14
677 678 679 680
 **/
void
gtk_test_register_all_types (void)
{
681 682 683 684 685 686
  if (!all_registered_types)
    {
      const guint max_gtk_types = 999;
      GType *tp;
      all_registered_types = g_new0 (GType, max_gtk_types);
      tp = all_registered_types;
687
#include "gtktypefuncs.c"
688 689 690 691
      n_all_registered_types = tp - all_registered_types;
      g_assert (n_all_registered_types + 1 < max_gtk_types);
      *tp = 0;
    }
692
}