gtkbindings.c 43.3 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
Tim Janik's avatar
Tim Janik committed
2 3
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
4
 * GtkBindingSet: Keybinding manager for GObjects.
Tim Janik's avatar
Tim Janik committed
5 6 7
 * Copyright (C) 1998 Tim Janik
 *
 * This library is free software; you can redistribute it and/or
8
 * modify it under the terms of the GNU Lesser General Public
Tim Janik's avatar
Tim Janik committed
9 10 11 12 13
 * 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
14
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15
 * Lesser General Public License for more details.
Tim Janik's avatar
Tim Janik committed
16
 *
17
 * You should have received a copy of the GNU Lesser General Public
Javier Jardón's avatar
Javier Jardón committed
18
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
Tim Janik's avatar
Tim Janik committed
19
 */
20 21

/*
22
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
23 24
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
25
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
26 27
 */

28
#include "config.h"
29
#include <string.h>
Tim Janik's avatar
Tim Janik committed
30
#include <stdarg.h>
31

32
#include "gtkbindingsprivate.h"
33
#include "gtkkeyhash.h"
34
#include "gtkstylecontext.h"
Tim Janik's avatar
Tim Janik committed
35
#include "gtkwidget.h"
36
#include "gtkintl.h"
Tim Janik's avatar
Tim Janik committed
37

38 39
/**
 * SECTION:gtkbindings
Matthias Clasen's avatar
Matthias Clasen committed
40
 * @Title: Bindings
41
 * @Short_description: Key bindings for individual widgets
Matthias Clasen's avatar
Matthias Clasen committed
42
 * @See_also: Keyboard Accelerators, Mnemonics, #GtkCssProvider
43
 *
Matthias Clasen's avatar
Matthias Clasen committed
44
 * #GtkBindingSet provides a mechanism for configuring GTK+ key bindings
45 46 47 48 49
 * through CSS files. This eases key binding adjustments for application
 * developers as well as users and provides GTK+ users or administrators
 * with high key  binding configurability which requires no application
 * or toolkit side changes.
 *
50
 * # Installing a key binding
51
 *
52
 * A CSS file binding consists of a “binding-set” definition and a match
53 54
 * statement to apply the binding set to specific widget types. Details
 * on the matching mechanism are described under
55
 * [Selectors][gtkcssprovider-selectors]
56 57 58 59
 * in the #GtkCssProvider documentation. Inside the binding set
 * definition, key combinations are bound to one or more specific
 * signal emissions on the target widget. Key combinations are strings
 * consisting of an optional #GdkModifierType name and
60
 * [key names][gdk3-Keyboard-Handling]
61
 * such as those defined in `gdk/gdkkeysyms.h`
62 63 64 65
 * or returned from gdk_keyval_name(), they have to be parsable by
 * gtk_accelerator_parse(). Specifications of signal emissions consist
 * of a string identifying the signal name, and a list of signal specific
 * arguments in parenthesis.
66
 *
67
 * For example for binding Control and the left or right cursor keys
68 69 70
 * of a #GtkEntry widget to the #GtkEntry::move-cursor signal (so
 * movement occurs in 3-character steps), the following binding can be
 * used:
71
 *
72
 * |[
Matthias Clasen's avatar
Matthias Clasen committed
73
 * @binding-set MoveCursor3
74
 * {
75 76
 *   bind "<Control>Right" { "move-cursor" (visual-positions, 3, 0) };
 *   bind "<Control>Left" { "move-cursor" (visual-positions, -3, 0) };
77
 * }
78 79
 * GtkEntry
 * {
80
 *   gtk-key-bindings: MoveCursor3;
81
 * }
82
 * ]|
83
 *
84
 * # Unbinding existing key bindings
85
 *
86 87 88 89
 * GTK+ already defines a number of useful bindings for the widgets
 * it provides. Because custom bindings set up in CSS files take
 * precedence over the default bindings shipped with GTK+, overriding
 * existing bindings as demonstrated in
90
 * [Installing a key binding][gtk-bindings-install]
91
 * works as expected. The same mechanism can not be used to “unbind”
92
 * existing bindings, however.
93
 *
94
 * |[
Matthias Clasen's avatar
Matthias Clasen committed
95
 * @binding-set MoveCursor3
96
 * {
97 98
 *   bind "<Control>Right" {  };
 *   bind "<Control>Left" {  };
99
 * }
100 101
 * GtkEntry
 * {
102
 *   gtk-key-bindings: MoveCursor3;
103
 * }
104
 * ]|
105
 *
106
 * The above example will not have the desired effect of causing
107 108 109 110 111 112 113 114 115
 * “<Control>Right” and “<Control>Left” key presses to be ignored by GTK+.
 * Instead, it just causes any existing bindings from the bindings set
 * “MoveCursor3” to be deleted, so when “<Control>Right” or
 * “<Control>Left” are pressed, no binding for these keys is found in
 * binding set “MoveCursor3”. GTK+ will thus continue to search for
 * matching key bindings, and will eventually lookup and find the default
 * GTK+ bindings for entries which implement word movement. To keep GTK+
 * from activating its default bindings, the “unbind” keyword can be used
 * like this:
116
 *
117
 * |[
Matthias Clasen's avatar
Matthias Clasen committed
118
 * @binding-set MoveCursor3
119
 * {
120 121
 *   unbind "<Control>Right";
 *   unbind "<Control>Left";
122
 * }
123 124
 * GtkEntry
 * {
125
 *   gtk-key-bindings: MoveCursor3;
126
 * }
127
 * ]|
128
 *
129 130 131 132 133
 * Now, GTK+ will find a match when looking up “<Control>Right” and
 * “<Control>Left” key presses before it resorts to its default bindings,
 * and the match instructs it to abort (“unbind”) the search, so the key
 * presses are not consumed by this widget. As usual, further processing
 * of the key presses, e.g. by an entry’s parent widget, is now possible.
134
 */
Matthias Clasen's avatar
Matthias Clasen committed
135

Tim Janik's avatar
Tim Janik committed
136
/* --- defines --- */
137 138 139 140
#define BINDING_MOD_MASK() (gtk_accelerator_get_default_mod_mask () | GDK_RELEASE_MASK)


#define GTK_TYPE_IDENTIFIER (gtk_identifier_get_type ())
141
_GDK_EXTERN
142
GType gtk_identifier_get_type (void) G_GNUC_CONST;
Tim Janik's avatar
Tim Janik committed
143 144


145
/* --- structures --- */
146 147 148 149
typedef enum {
  GTK_BINDING_TOKEN_BIND,
  GTK_BINDING_TOKEN_UNBIND
} GtkBindingTokens;
150

Tim Janik's avatar
Tim Janik committed
151
/* --- variables --- */
152
static GHashTable       *binding_entry_hash_table = NULL;
153
static GSList           *binding_key_hashes = NULL;
154 155 156
static GSList           *binding_set_list = NULL;
static const gchar       key_class_binding_set[] = "gtk-class-binding-set";
static GQuark            key_id_class_binding_set = 0;
Tim Janik's avatar
Tim Janik committed
157 158 159


/* --- functions --- */
160 161 162 163 164 165 166 167 168 169 170 171 172 173
GType
gtk_identifier_get_type (void)
{
  static GType our_type = 0;

  if (our_type == 0)
    {
      GTypeInfo tinfo = { 0, };
      our_type = g_type_register_static (G_TYPE_STRING, I_("GtkIdentifier"), &tinfo, 0);
    }

  return our_type;
}

Tim Janik's avatar
Tim Janik committed
174 175
static GtkBindingSignal*
binding_signal_new (const gchar *signal_name,
176
                    guint        n_args)
Tim Janik's avatar
Tim Janik committed
177 178
{
  GtkBindingSignal *signal;
179

180
  signal = (GtkBindingSignal *) g_slice_alloc0 (sizeof (GtkBindingSignal) + n_args * sizeof (GtkBindingArg));
Tim Janik's avatar
Tim Janik committed
181
  signal->next = NULL;
182
  signal->signal_name = (gchar *)g_intern_string (signal_name);
Tim Janik's avatar
Tim Janik committed
183
  signal->n_args = n_args;
184
  signal->args = (GtkBindingArg *)(signal + 1);
185

Tim Janik's avatar
Tim Janik committed
186 187 188 189 190 191 192
  return signal;
}

static void
binding_signal_free (GtkBindingSignal *sig)
{
  guint i;
193

Tim Janik's avatar
Tim Janik committed
194 195
  for (i = 0; i < sig->n_args; i++)
    {
Manish Singh's avatar
Manish Singh committed
196
      if (G_TYPE_FUNDAMENTAL (sig->args[i].arg_type) == G_TYPE_STRING)
197
        g_free (sig->args[i].d.string_data);
Tim Janik's avatar
Tim Janik committed
198
    }
199
  g_slice_free1 (sizeof (GtkBindingSignal) + sig->n_args * sizeof (GtkBindingArg), sig);
Tim Janik's avatar
Tim Janik committed
200 201 202
}

static guint
203
binding_entry_hash (gconstpointer  key)
Tim Janik's avatar
Tim Janik committed
204
{
205
  register const GtkBindingEntry *e = key;
Tim Janik's avatar
Tim Janik committed
206 207 208 209 210 211 212 213 214
  register guint h;

  h = e->keyval;
  h ^= e->modifiers;

  return h;
}

static gint
215
binding_entries_compare (gconstpointer  a,
216
                         gconstpointer  b)
Tim Janik's avatar
Tim Janik committed
217
{
218 219
  register const GtkBindingEntry *ea = a;
  register const GtkBindingEntry *eb = b;
Tim Janik's avatar
Tim Janik committed
220 221 222 223

  return (ea->keyval == eb->keyval && ea->modifiers == eb->modifiers);
}

224 225
static void
binding_key_hash_insert_entry (GtkKeyHash      *key_hash,
226
                               GtkBindingEntry *entry)
227 228
{
  guint keyval = entry->keyval;
229

230 231 232 233 234
  /* We store lowercased accelerators. To deal with this, if <Shift>
   * was specified, uppercase.
   */
  if (entry->modifiers & GDK_SHIFT_MASK)
    {
235
      if (keyval == GDK_KEY_Tab)
236
        keyval = GDK_KEY_ISO_Left_Tab;
237
      else
238
        keyval = gdk_keyval_to_upper (keyval);
239
    }
240

241 242 243 244 245 246 247
  _gtk_key_hash_add_entry (key_hash, keyval, entry->modifiers & ~GDK_RELEASE_MASK, entry);
}

static void
binding_key_hash_destroy (gpointer data)
{
  GtkKeyHash *key_hash = data;
248

249 250 251 252 253 254
  binding_key_hashes = g_slist_remove (binding_key_hashes, key_hash);
  _gtk_key_hash_free (key_hash);
}

static void
insert_entries_into_key_hash (gpointer key,
255 256
                              gpointer value,
                              gpointer data)
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272
{
  GtkKeyHash *key_hash = data;
  GtkBindingEntry *entry = value;

  for (; entry; entry = entry->hash_next)
    binding_key_hash_insert_entry (key_hash, entry);
}

static GtkKeyHash *
binding_key_hash_for_keymap (GdkKeymap *keymap)
{
  static GQuark key_hash_quark = 0;
  GtkKeyHash *key_hash;

  if (!key_hash_quark)
    key_hash_quark = g_quark_from_static_string ("gtk-binding-key-hash");
273

274 275 276 277 278 279 280 281
  key_hash = g_object_get_qdata (G_OBJECT (keymap), key_hash_quark);

  if (!key_hash)
    {
      key_hash = _gtk_key_hash_new (keymap, NULL);
      g_object_set_qdata_full (G_OBJECT (keymap), key_hash_quark, key_hash, binding_key_hash_destroy);

      if (binding_entry_hash_table)
282 283 284
        g_hash_table_foreach (binding_entry_hash_table,
                              insert_entries_into_key_hash,
                              key_hash);
285 286 287 288 289 290 291 292

      binding_key_hashes = g_slist_prepend (binding_key_hashes, key_hash);
    }

  return key_hash;
}


Tim Janik's avatar
Tim Janik committed
293
static GtkBindingEntry*
294
binding_entry_new (GtkBindingSet  *binding_set,
295 296
                   guint           keyval,
                   GdkModifierType modifiers)
Tim Janik's avatar
Tim Janik committed
297
{
298
  GSList *tmp_list;
Tim Janik's avatar
Tim Janik committed
299
  GtkBindingEntry *entry;
300

Tim Janik's avatar
Tim Janik committed
301 302 303 304 305 306 307 308 309
  if (!binding_entry_hash_table)
    binding_entry_hash_table = g_hash_table_new (binding_entry_hash, binding_entries_compare);

  entry = g_new (GtkBindingEntry, 1);
  entry->keyval = keyval;
  entry->modifiers = modifiers;
  entry->binding_set = binding_set,
  entry->destroyed = FALSE;
  entry->in_emission = FALSE;
310
  entry->marks_unbound = FALSE;
Tim Janik's avatar
Tim Janik committed
311 312 313 314 315 316 317 318 319
  entry->signals = NULL;

  entry->set_next = binding_set->entries;
  binding_set->entries = entry;

  entry->hash_next = g_hash_table_lookup (binding_entry_hash_table, entry);
  if (entry->hash_next)
    g_hash_table_remove (binding_entry_hash_table, entry->hash_next);
  g_hash_table_insert (binding_entry_hash_table, entry, entry);
320 321 322 323 324 325

  for (tmp_list = binding_key_hashes; tmp_list; tmp_list = tmp_list->next)
    {
      GtkKeyHash *key_hash = tmp_list->data;
      binding_key_hash_insert_entry (key_hash, entry);
    }
326

Tim Janik's avatar
Tim Janik committed
327 328 329 330 331 332 333 334 335
  return entry;
}

static void
binding_entry_free (GtkBindingEntry *entry)
{
  GtkBindingSignal *sig;

  g_assert (entry->set_next == NULL &&
336 337 338
            entry->hash_next == NULL &&
            entry->in_emission == FALSE &&
            entry->destroyed == TRUE);
Tim Janik's avatar
Tim Janik committed
339 340

  entry->destroyed = FALSE;
341

Tim Janik's avatar
Tim Janik committed
342 343 344 345
  sig = entry->signals;
  while (sig)
    {
      GtkBindingSignal *prev;
346

Tim Janik's avatar
Tim Janik committed
347 348 349 350 351 352 353 354 355 356 357 358 359 360
      prev = sig;
      sig = prev->next;
      binding_signal_free (prev);
    }
  g_free (entry);
}

static void
binding_entry_destroy (GtkBindingEntry *entry)
{
  GtkBindingEntry *o_entry;
  register GtkBindingEntry *tmp;
  GtkBindingEntry *begin;
  register GtkBindingEntry *last;
361
  GSList *tmp_list;
Tim Janik's avatar
Tim Janik committed
362 363 364 365 366 367 368 369

  /* unlink from binding set
   */
  last = NULL;
  tmp = entry->binding_set->entries;
  while (tmp)
    {
      if (tmp == entry)
370 371 372 373 374 375 376
        {
          if (last)
            last->set_next = entry->set_next;
          else
            entry->binding_set->entries = entry->set_next;
          break;
        }
Tim Janik's avatar
Tim Janik committed
377 378 379 380
      last = tmp;
      tmp = last->set_next;
    }
  entry->set_next = NULL;
381

Tim Janik's avatar
Tim Janik committed
382 383 384 385 386 387 388
  o_entry = g_hash_table_lookup (binding_entry_hash_table, entry);
  begin = o_entry;
  last = NULL;
  tmp = begin;
  while (tmp)
    {
      if (tmp == entry)
389 390 391 392 393 394 395
        {
          if (last)
            last->hash_next = entry->hash_next;
          else
            begin = entry->hash_next;
          break;
        }
Tim Janik's avatar
Tim Janik committed
396 397 398 399
      last = tmp;
      tmp = last->hash_next;
    }
  entry->hash_next = NULL;
400

Tim Janik's avatar
Tim Janik committed
401 402 403 404 405 406 407 408
  if (!begin)
    g_hash_table_remove (binding_entry_hash_table, entry);
  else if (begin != o_entry)
    {
      g_hash_table_remove (binding_entry_hash_table, entry);
      g_hash_table_insert (binding_entry_hash_table, begin, begin);
    }

409 410 411 412 413 414
  for (tmp_list = binding_key_hashes; tmp_list; tmp_list = tmp_list->next)
    {
      GtkKeyHash *key_hash = tmp_list->data;
      _gtk_key_hash_remove_entry (key_hash, entry);
    }

Tim Janik's avatar
Tim Janik committed
415 416 417 418 419 420 421
  entry->destroyed = TRUE;

  if (!entry->in_emission)
    binding_entry_free (entry);
}

static GtkBindingEntry*
422
binding_ht_lookup_entry (GtkBindingSet  *set,
423 424
                         guint           keyval,
                         GdkModifierType modifiers)
Tim Janik's avatar
Tim Janik committed
425 426 427
{
  GtkBindingEntry lookup_entry = { 0 };
  GtkBindingEntry *entry;
428

Tim Janik's avatar
Tim Janik committed
429 430
  if (!binding_entry_hash_table)
    return NULL;
431

Tim Janik's avatar
Tim Janik committed
432 433
  lookup_entry.keyval = keyval;
  lookup_entry.modifiers = modifiers;
434

Tim Janik's avatar
Tim Janik committed
435 436 437 438 439 440 441 442 443
  entry = g_hash_table_lookup (binding_entry_hash_table, &lookup_entry);
  for (; entry; entry = entry->hash_next)
    if (entry->binding_set == set)
      return entry;

  return NULL;
}

static gboolean
444
binding_compose_params (GObject         *object,
445 446 447
                        GtkBindingArg   *args,
                        GSignalQuery    *query,
                        GValue         **params_p)
Tim Janik's avatar
Tim Janik committed
448
{
449 450
  GValue *params;
  const GType *types;
Tim Janik's avatar
Tim Janik committed
451 452
  guint i;
  gboolean valid;
453

454
  params = g_new0 (GValue, query->n_params + 1);
Tim Janik's avatar
Tim Janik committed
455
  *params_p = params;
456 457 458 459 460 461

  /* The instance we emit on is the first object in the array
   */
  g_value_init (params, G_TYPE_OBJECT);
  g_value_set_object (params, G_OBJECT (object));
  params++;
462

463
  types = query->param_types;
Tim Janik's avatar
Tim Janik committed
464
  valid = TRUE;
465
  for (i = 1; i < query->n_params + 1 && valid; i++)
Tim Janik's avatar
Tim Janik committed
466
    {
Javier Jardón's avatar
Javier Jardón committed
467
      GValue tmp_value = G_VALUE_INIT;
468

469 470 471
      g_value_init (params, *types);

      switch (G_TYPE_FUNDAMENTAL (args->arg_type))
472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542
        {
        case G_TYPE_DOUBLE:
          g_value_init (&tmp_value, G_TYPE_DOUBLE);
          g_value_set_double (&tmp_value, args->d.double_data);
          break;
        case G_TYPE_LONG:
          g_value_init (&tmp_value, G_TYPE_LONG);
          g_value_set_long (&tmp_value, args->d.long_data);
          break;
        case G_TYPE_STRING:
          /* gtk_rc_parse_flags/enum() has fancier parsing for this; we can't call
           * that since we don't have a GParamSpec, so just do something simple
           */
          if (G_TYPE_FUNDAMENTAL (*types) == G_TYPE_ENUM)
            {
              GEnumClass *class = G_ENUM_CLASS (g_type_class_ref (*types));

              valid = FALSE;

              if (args->arg_type == GTK_TYPE_IDENTIFIER)
                {
                  GEnumValue *enum_value = NULL;
                  enum_value = g_enum_get_value_by_name (class, args->d.string_data);
                  if (!enum_value)
                    enum_value = g_enum_get_value_by_nick (class, args->d.string_data);
                  if (enum_value)
                    {
                      g_value_init (&tmp_value, *types);
                      g_value_set_enum (&tmp_value, enum_value->value);
                      valid = TRUE;
                    }
                }

              g_type_class_unref (class);
            }
          /* This is just a hack for compatibility with GTK+-1.2 where a string
           * could be used for a single flag value / without the support for multiple
           * values in gtk_rc_parse_flags(), this isn't very useful.
           */
          else if (G_TYPE_FUNDAMENTAL (*types) == G_TYPE_FLAGS)
            {
              GFlagsClass *class = G_FLAGS_CLASS (g_type_class_ref (*types));

              valid = FALSE;

              if (args->arg_type == GTK_TYPE_IDENTIFIER)
                {
                  GFlagsValue *flags_value = NULL;
                  flags_value = g_flags_get_value_by_name (class, args->d.string_data);
                  if (!flags_value)
                    flags_value = g_flags_get_value_by_nick (class, args->d.string_data);
                  if (flags_value)
                    {
                      g_value_init (&tmp_value, *types);
                      g_value_set_flags (&tmp_value, flags_value->value);
                      valid = TRUE;
                    }
                }

              g_type_class_unref (class);
            }
          else
            {
              g_value_init (&tmp_value, G_TYPE_STRING);
              g_value_set_static_string (&tmp_value, args->d.string_data);
            }
          break;
        default:
          valid = FALSE;
          break;
        }
543

544
      if (valid)
545 546 547
        {
          if (!g_value_transform (&tmp_value, params))
            valid = FALSE;
548

549 550
          g_value_unset (&tmp_value);
        }
551

Tim Janik's avatar
Tim Janik committed
552 553 554 555
      types++;
      params++;
      args++;
    }
556

Tim Janik's avatar
Tim Janik committed
557 558
  if (!valid)
    {
559 560 561
      guint j;

      for (j = 0; j < i; j++)
562
        g_value_unset (&(*params_p)[j]);
563

Tim Janik's avatar
Tim Janik committed
564 565 566
      g_free (*params_p);
      *params_p = NULL;
    }
567

Tim Janik's avatar
Tim Janik committed
568 569 570
  return valid;
}

571 572
static gboolean
gtk_binding_entry_activate (GtkBindingEntry *entry,
573
                            GObject         *object)
Tim Janik's avatar
Tim Janik committed
574 575 576
{
  GtkBindingSignal *sig;
  gboolean old_emission;
577 578
  gboolean handled = FALSE;
  gint i;
579

Tim Janik's avatar
Tim Janik committed
580 581
  old_emission = entry->in_emission;
  entry->in_emission = TRUE;
582

583
  g_object_ref (object);
584

Tim Janik's avatar
Tim Janik committed
585 586
  for (sig = entry->signals; sig; sig = sig->next)
    {
587
      GSignalQuery query;
Tim Janik's avatar
Tim Janik committed
588
      guint signal_id;
589
      GValue *params = NULL;
Javier Jardón's avatar
Javier Jardón committed
590
      GValue return_val = G_VALUE_INIT;
591
      gchar *accelerator = NULL;
592

593
      signal_id = g_signal_lookup (sig->signal_name, G_OBJECT_TYPE (object));
Tim Janik's avatar
Tim Janik committed
594
      if (!signal_id)
595 596 597 598 599 600 601 602 603 604 605 606
        {
          accelerator = gtk_accelerator_name (entry->keyval, entry->modifiers);
          g_warning ("gtk_binding_entry_activate(): binding \"%s::%s\": "
                     "could not find signal \"%s\" in the `%s' class ancestry",
                     entry->binding_set->set_name,
                     accelerator,
                     sig->signal_name,
                     g_type_name (G_OBJECT_TYPE (object)));
          g_free (accelerator);
          continue;
        }

607 608
      g_signal_query (signal_id, &query);
      if (query.n_params != sig->n_args ||
609 610 611 612 613 614 615 616 617 618 619
          (query.return_type != G_TYPE_NONE && query.return_type != G_TYPE_BOOLEAN) ||
          !binding_compose_params (object, sig->args, &query, &params))
        {
          accelerator = gtk_accelerator_name (entry->keyval, entry->modifiers);
          g_warning ("gtk_binding_entry_activate(): binding \"%s::%s\": "
                     "signature mismatch for signal \"%s\" in the `%s' class ancestry",
                     entry->binding_set->set_name,
                     accelerator,
                     sig->signal_name,
                     g_type_name (G_OBJECT_TYPE (object)));
        }
Manish Singh's avatar
Manish Singh committed
620
      else if (!(query.signal_flags & G_SIGNAL_ACTION))
621 622 623 624 625 626 627 628 629
        {
          accelerator = gtk_accelerator_name (entry->keyval, entry->modifiers);
          g_warning ("gtk_binding_entry_activate(): binding \"%s::%s\": "
                     "signal \"%s\" in the `%s' class ancestry cannot be used for action emissions",
                     entry->binding_set->set_name,
                     accelerator,
                     sig->signal_name,
                     g_type_name (G_OBJECT_TYPE (object)));
        }
630 631
      g_free (accelerator);
      if (accelerator)
632
        continue;
Tim Janik's avatar
Tim Janik committed
633

634
      if (query.return_type == G_TYPE_BOOLEAN)
635
        g_value_init (&return_val, G_TYPE_BOOLEAN);
636

637 638 639
      g_signal_emitv (params, signal_id, 0, &return_val);

      if (query.return_type == G_TYPE_BOOLEAN)
640 641 642 643 644
        {
          if (g_value_get_boolean (&return_val))
            handled = TRUE;
          g_value_unset (&return_val);
        }
645
      else
646
        handled = TRUE;
647

648
      for (i = 0; i < query.n_params + 1; i++)
649
        g_value_unset (&params[i]);
Tim Janik's avatar
Tim Janik committed
650
      g_free (params);
651

652
      if (entry->destroyed)
653
        break;
Tim Janik's avatar
Tim Janik committed
654
    }
655

656
  g_object_unref (object);
Tim Janik's avatar
Tim Janik committed
657 658 659 660

  entry->in_emission = old_emission;
  if (entry->destroyed && !entry->in_emission)
    binding_entry_free (entry);
661 662

  return handled;
Tim Janik's avatar
Tim Janik committed
663 664
}

665
/**
666
 * gtk_binding_set_new: (skip)
667 668
 * @set_name: unique name of this binding set
 *
Matthias Clasen's avatar
Matthias Clasen committed
669
 * GTK+ maintains a global list of binding sets. Each binding set has
670 671
 * a unique name which needs to be specified upon creation.
 *
672
 * Returns: (transfer none): new binding set
Matthias Clasen's avatar
Matthias Clasen committed
673
 */
Tim Janik's avatar
Tim Janik committed
674
GtkBindingSet*
675
gtk_binding_set_new (const gchar *set_name)
Tim Janik's avatar
Tim Janik committed
676 677
{
  GtkBindingSet *binding_set;
678

Tim Janik's avatar
Tim Janik committed
679
  g_return_val_if_fail (set_name != NULL, NULL);
680

Tim Janik's avatar
Tim Janik committed
681
  binding_set = g_new (GtkBindingSet, 1);
682
  binding_set->set_name = (gchar *) g_intern_string (set_name);
Tim Janik's avatar
Tim Janik committed
683 684 685 686 687
  binding_set->widget_path_pspecs = NULL;
  binding_set->widget_class_pspecs = NULL;
  binding_set->class_branch_pspecs = NULL;
  binding_set->entries = NULL;
  binding_set->current = NULL;
688
  binding_set->parsed = FALSE;
689

690
  binding_set_list = g_slist_prepend (binding_set_list, binding_set);
691

Tim Janik's avatar
Tim Janik committed
692 693 694
  return binding_set;
}

695
/**
696
 * gtk_binding_set_by_class: (skip)
697
 * @object_class: a valid #GObject class
698 699 700 701 702
 *
 * This function returns the binding set named after the type name of
 * the passed in class structure. New binding sets are created on
 * demand by this function.
 *
703
 * Returns: (transfer none): the binding set corresponding to
704
 *     @object_class
Matthias Clasen's avatar
Matthias Clasen committed
705
 */
Tim Janik's avatar
Tim Janik committed
706 707 708
GtkBindingSet*
gtk_binding_set_by_class (gpointer object_class)
{
709
  GObjectClass *class = object_class;
Tim Janik's avatar
Tim Janik committed
710 711
  GtkBindingSet* binding_set;

712
  g_return_val_if_fail (G_IS_OBJECT_CLASS (class), NULL);
Tim Janik's avatar
Tim Janik committed
713 714

  if (!key_id_class_binding_set)
715
    key_id_class_binding_set = g_quark_from_static_string (key_class_binding_set);
Tim Janik's avatar
Tim Janik committed
716 717 718 719 720 721

  binding_set = g_dataset_id_get_data (class, key_id_class_binding_set);

  if (binding_set)
    return binding_set;

Manish Singh's avatar
Manish Singh committed
722
  binding_set = gtk_binding_set_new (g_type_name (G_OBJECT_CLASS_TYPE (class)));
Tim Janik's avatar
Tim Janik committed
723 724 725 726 727
  g_dataset_id_set_data (class, key_id_class_binding_set, binding_set);

  return binding_set;
}

Matthias Clasen's avatar
Matthias Clasen committed
728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744
static GtkBindingSet*
gtk_binding_set_find_interned (const gchar *set_name)
{
  GSList *slist;

  for (slist = binding_set_list; slist; slist = slist->next)
    {
      GtkBindingSet *binding_set;

      binding_set = slist->data;
      if (binding_set->set_name == set_name)
        return binding_set;
    }

  return NULL;
}

745 746 747 748
/**
 * gtk_binding_set_find:
 * @set_name: unique binding set name
 *
749 750 751 752
 * Find a binding set by its globally unique name.
 *
 * The @set_name can either be a name used for gtk_binding_set_new()
 * or the type name of a class used in gtk_binding_set_by_class().
753
 *
754
 * Returns: (transfer none): %NULL or the specified binding set
Matthias Clasen's avatar
Matthias Clasen committed
755
 */
Tim Janik's avatar
Tim Janik committed
756
GtkBindingSet*
757
gtk_binding_set_find (const gchar *set_name)
Tim Janik's avatar
Tim Janik committed
758 759
{
  g_return_val_if_fail (set_name != NULL, NULL);
760

Matthias Clasen's avatar
Matthias Clasen committed
761
  return gtk_binding_set_find_interned (g_intern_string (set_name));
Tim Janik's avatar
Tim Janik committed
762 763
}

764 765
/**
 * gtk_binding_set_activate:
Matthias Clasen's avatar
Matthias Clasen committed
766
 * @binding_set: a #GtkBindingSet set to activate
767 768 769 770 771 772 773
 * @keyval:      key value of the binding
 * @modifiers:   key modifier of the binding
 * @object:      object to activate when binding found
 *
 * Find a key binding matching @keyval and @modifiers within
 * @binding_set and activate the binding on @object.
 *
774
 * Returns: %TRUE if a binding was found and activated
Matthias Clasen's avatar
Matthias Clasen committed
775
 */
Tim Janik's avatar
Tim Janik committed
776
gboolean
777 778 779 780
gtk_binding_set_activate (GtkBindingSet  *binding_set,
                          guint           keyval,
                          GdkModifierType modifiers,
                          GObject        *object)
Tim Janik's avatar
Tim Janik committed
781 782
{
  GtkBindingEntry *entry;
783

Tim Janik's avatar
Tim Janik committed
784
  g_return_val_if_fail (binding_set != NULL, FALSE);
785
  g_return_val_if_fail (G_IS_OBJECT (object), FALSE);
786

Tim Janik's avatar
Tim Janik committed
787 788
  keyval = gdk_keyval_to_lower (keyval);
  modifiers = modifiers & BINDING_MOD_MASK ();
789

790 791
  entry = binding_ht_lookup_entry (binding_set, keyval, modifiers);
  if (entry)
792
    return gtk_binding_entry_activate (entry, object);
793

Tim Janik's avatar
Tim Janik committed
794 795 796
  return FALSE;
}

797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813
static void
gtk_binding_entry_clear_internal (GtkBindingSet  *binding_set,
                                  guint           keyval,
                                  GdkModifierType modifiers)
{
  GtkBindingEntry *entry;

  keyval = gdk_keyval_to_lower (keyval);
  modifiers = modifiers & BINDING_MOD_MASK ();

  entry = binding_ht_lookup_entry (binding_set, keyval, modifiers);
  if (entry)
    binding_entry_destroy (entry);

  entry = binding_entry_new (binding_set, keyval, modifiers);
}

814 815
/**
 * gtk_binding_entry_skip:
Matthias Clasen's avatar
Matthias Clasen committed
816
 * @binding_set: a #GtkBindingSet to skip an entry of
817 818 819
 * @keyval:      key value of binding to skip
 * @modifiers:   key modifier of binding to skip
 *
820 821 822
 * Install a binding on @binding_set which causes key lookups
 * to be aborted, to prevent bindings from lower priority sets
 * to be activated.
Matthias Clasen's avatar
Matthias Clasen committed
823 824
 *
 * Since: 2.12
Matthias Clasen's avatar
Matthias Clasen committed
825
 */
826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845
void
gtk_binding_entry_skip (GtkBindingSet  *binding_set,
                        guint           keyval,
                        GdkModifierType modifiers)
{
  GtkBindingEntry *entry;

  g_return_if_fail (binding_set != NULL);

  keyval = gdk_keyval_to_lower (keyval);
  modifiers = modifiers & BINDING_MOD_MASK ();

  entry = binding_ht_lookup_entry (binding_set, keyval, modifiers);
  if (entry)
    binding_entry_destroy (entry);

  entry = binding_entry_new (binding_set, keyval, modifiers);
  entry->marks_unbound = TRUE;
}

846 847
/**
 * gtk_binding_entry_remove:
Matthias Clasen's avatar
Matthias Clasen committed
848
 * @binding_set: a #GtkBindingSet to remove an entry of
849 850 851 852 853
 * @keyval:      key value of binding to remove
 * @modifiers:   key modifier of binding to remove
 *
 * Remove a binding previously installed via
 * gtk_binding_entry_add_signal() on @binding_set.
Matthias Clasen's avatar
Matthias Clasen committed
854
 */
Tim Janik's avatar
Tim Janik committed
855
void
856 857 858
gtk_binding_entry_remove (GtkBindingSet  *binding_set,
                          guint           keyval,
                          GdkModifierType modifiers)
Tim Janik's avatar
Tim Janik committed
859 860
{
  GtkBindingEntry *entry;
861

Tim Janik's avatar
Tim Janik committed
862
  g_return_if_fail (binding_set != NULL);
863

Tim Janik's avatar
Tim Janik committed
864 865
  keyval = gdk_keyval_to_lower (keyval);
  modifiers = modifiers & BINDING_MOD_MASK ();
866

Tim Janik's avatar
Tim Janik committed
867 868 869 870 871
  entry = binding_ht_lookup_entry (binding_set, keyval, modifiers);
  if (entry)
    binding_entry_destroy (entry);
}

872 873
/**
 * gtk_binding_entry_add_signall:
Matthias Clasen's avatar
Matthias Clasen committed
874
 * @binding_set:  a #GtkBindingSet to add a signal to
875 876 877
 * @keyval:       key value
 * @modifiers:    key modifier
 * @signal_name:  signal name to be bound
878 879
 * @binding_args: (transfer none) (element-type GtkBindingArg):
 *     list of #GtkBindingArg signal arguments
880
 *
881 882
 * Override or install a new key binding for @keyval with @modifiers on
 * @binding_set.
Matthias Clasen's avatar
Matthias Clasen committed
883
 */
Tim Janik's avatar
Tim Janik committed
884 885
void
gtk_binding_entry_add_signall (GtkBindingSet  *binding_set,
886
                               guint           keyval,
887 888
                               GdkModifierType modifiers,
                               const gchar    *signal_name,
889
                               GSList         *binding_args)
890 891 892 893 894 895 896 897
{
  _gtk_binding_entry_add_signall (binding_set,
                                  keyval, modifiers,
                                  signal_name, binding_args);
}

void
_gtk_binding_entry_add_signall (GtkBindingSet  *binding_set,
898
                                guint          keyval,
899 900
                                GdkModifierType modifiers,
                                const gchar    *signal_name,
901
                                GSList        *binding_args)
Tim Janik's avatar
Tim Janik committed
902 903 904 905 906 907
{
  GtkBindingEntry *entry;
  GtkBindingSignal *signal, **signal_p;
  GSList *slist;
  guint n = 0;
  GtkBindingArg *arg;
908

Tim Janik's avatar
Tim Janik committed
909 910
  g_return_if_fail (binding_set != NULL);
  g_return_if_fail (signal_name != NULL);
911

Tim Janik's avatar
Tim Janik committed
912 913
  keyval = gdk_keyval_to_lower (keyval);
  modifiers = modifiers & BINDING_MOD_MASK ();
914

Tim Janik's avatar
Tim Janik committed
915
  signal = binding_signal_new (signal_name, g_slist_length (binding_args));
916

Tim Janik's avatar
Tim Janik committed
917 918 919 920
  arg = signal->args;
  for (slist = binding_args; slist; slist = slist->next)
    {
      GtkBindingArg *tmp_arg;
921

Tim Janik's avatar
Tim Janik committed
922 923
      tmp_arg = slist->data;
      if (!tmp_arg)
924 925 926 927 928
        {
          g_warning ("gtk_binding_entry_add_signall(): arg[%u] is `NULL'", n);
          binding_signal_free (signal);
          return;
        }
Manish Singh's avatar
Manish Singh committed
929
      switch (G_TYPE_FUNDAMENTAL (tmp_arg->arg_type))
930 931 932 933 934 935 936 937 938 939
        {
        case  G_TYPE_LONG:
          arg->arg_type = G_TYPE_LONG;
          arg->d.long_data = tmp_arg->d.long_data;
          break;
        case  G_TYPE_DOUBLE:
          arg->arg_type = G_TYPE_DOUBLE;
          arg->d.double_data = tmp_arg->d.double_data;
          break;
        case  G_TYPE_STRING:
940
          if (tmp_arg->arg_type != GTK_TYPE_IDENTIFIER)
941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957
            arg->arg_type = G_TYPE_STRING;
          else
            arg->arg_type = GTK_TYPE_IDENTIFIER;
          arg->d.string_data = g_strdup (tmp_arg->d.string_data);
          if (!arg->d.string_data)
            {
              g_warning ("gtk_binding_entry_add_signall(): value of `string' arg[%u] is `NULL'", n);
              binding_signal_free (signal);
              return;
            }
          break;
        default:
          g_warning ("gtk_binding_entry_add_signall(): unsupported type `%s' for arg[%u]",
                     g_type_name (arg->arg_type), n);
          binding_signal_free (signal);
          return;
        }
Tim Janik's avatar
Tim Janik committed
958 959 960
      arg++;
      n++;
    }
961

Tim Janik's avatar
Tim Janik committed
962 963 964
  entry = binding_ht_lookup_entry (binding_set, keyval, modifiers);
  if (!entry)
    {
965
      gtk_binding_entry_clear_internal (binding_set, keyval, modifiers);
Tim Janik's avatar
Tim Janik committed
966 967 968 969 970 971 972 973
      entry = binding_ht_lookup_entry (binding_set, keyval, modifiers);
    }
  signal_p = &entry->signals;
  while (*signal_p)
    signal_p = &(*signal_p)->next;
  *signal_p = signal;
}

974 975
/**
 * gtk_binding_entry_add_signal:
Matthias Clasen's avatar
Matthias Clasen committed
976
 * @binding_set: a #GtkBindingSet to install an entry for
977 978 979 980
 * @keyval:      key value of binding to install
 * @modifiers:   key modifier of binding to install
 * @signal_name: signal to execute upon activation
 * @n_args:      number of arguments to @signal_name
Matthias Clasen's avatar
Matthias Clasen committed
981
 * @...:         arguments to @signal_name
982 983
 *
 * Override or install a new key binding for @keyval with @modifiers on
Matthias Clasen's avatar
Matthias Clasen committed
984
 * @binding_set. When the binding is activated, @signal_name will be
985 986
 * emitted on the target widget, with @n_args @Varargs used as
 * arguments.
Matthias Clasen's avatar
Matthias Clasen committed
987
 */
Tim Janik's avatar
Tim Janik committed
988 989
void
gtk_binding_entry_add_signal (GtkBindingSet  *binding_set,
990 991 992 993 994
                              guint           keyval,
                              GdkModifierType modifiers,
                              const gchar    *signal_name,
                              guint           n_args,
                              ...)
Tim Janik's avatar
Tim Janik committed
995 996 997 998 999 1000 1001
{
  GSList *slist, *free_slist;
  va_list args;
  guint i;

  g_return_if_fail (binding_set != NULL);
  g_return_if_fail (signal_name != NULL);
1002

Tim Janik's avatar
Tim Janik committed
1003 1004 1005 1006 1007 1008
  va_start (args, n_args);
  slist = NULL;
  for (i = 0; i < n_args; i++)
    {
      GtkBindingArg *arg;

1009
      arg = g_slice_new0 (GtkBindingArg);
Tim Janik's avatar
Tim Janik committed
1010 1011
      slist = g_slist_prepend (slist, arg);

Michael Natterer's avatar
Michael Natterer committed
1012
      arg->arg_type = va_arg (args, GType);
Manish Singh's avatar
Manish Singh committed
1013
      switch (G_TYPE_FUNDAMENTAL (arg->arg_type))
1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
        {
        case G_TYPE_CHAR:
        case G_TYPE_UCHAR:
        case G_TYPE_INT:
        case G_TYPE_UINT:
        case G_TYPE_BOOLEAN:
        case G_TYPE_ENUM:
        case G_TYPE_FLAGS:
          arg->arg_type = G_TYPE_LONG;
          arg->d.long_data = va_arg (args, gint);
          break;
        case G_TYPE_LONG:
        case G_TYPE_ULONG:
          arg->arg_type = G_TYPE_LONG;
          arg->d.long_data = va_arg (args, glong);
          break;
        case G_TYPE_FLOAT:
        case G_TYPE_DOUBLE:
          arg->arg_type = G_TYPE_DOUBLE;
          arg->d.double_data = va_arg (args, gdouble);
          break;
        case G_TYPE_STRING:
          if (arg->arg_type != GTK_TYPE_IDENTIFIER)
            arg->arg_type = G_TYPE_STRING;
          arg->d.string_data = va_arg (args, gchar*);
          if (!arg->d.string_data)
            {
              g_warning ("gtk_binding_entry_add_signal(): type `%s' arg[%u] is `NULL'",
                         g_type_name (arg->arg_type),
                         i);
              i += n_args + 1;
            }
          break;
        default:
          g_warning ("gtk_binding_entry_add_signal(): unsupported type `%s' for arg[%u]",
                     g_type_name (arg->arg_type), i);
          i += n_args + 1;
          break;
        }
Tim Janik's avatar
Tim Janik committed
1053 1054 1055
    }
  va_end (args);

1056
  if (i == n_args || i == 0)
Tim Janik's avatar
Tim Janik committed
1057 1058
    {
      slist = g_slist_reverse (slist);
1059
      _gtk_binding_entry_add_signall (binding_set, keyval, modifiers, signal_name, slist);
Tim Janik's avatar
Tim Janik committed
1060 1061 1062 1063 1064
    }

  free_slist = slist;
  while (slist)
    {
1065
      g_slice_free (GtkBindingArg, slist->data);
Tim Janik's avatar
Tim Janik committed
1066 1067 1068 1069 1070
      slist = slist->next;
    }
  g_slist_free (free_slist);
}

1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342
static guint
gtk_binding_parse_signal (GScanner       *scanner,
                          GtkBindingSet  *binding_set,
                          guint           keyval,
                          GdkModifierType modifiers)
{
  gchar *signal;
  guint expected_token = 0;
  GSList *args;
  GSList *slist;
  gboolean done;
  gboolean negate;
  gboolean need_arg;
  gboolean seen_comma;

  g_return_val_if_fail (scanner != NULL, G_TOKEN_ERROR);

  g_scanner_get_next_token (scanner);

  if (scanner->token != G_TOKEN_STRING)
    return G_TOKEN_STRING;

  g_scanner_peek_next_token (scanner);

  if (scanner->next_token != '(')
    {
      g_scanner_get_next_token (scanner);
      return '(';
    }

  signal = g_strdup (scanner->value.v_string);
  g_scanner_get_next_token (scanner);

  negate = FALSE;
  args = NULL;
  done = FALSE;
  need_arg = TRUE;
  seen_comma = FALSE;
  scanner->config->scan_symbols = FALSE;

  do
    {
      GtkBindingArg *arg;

      if (need_arg)
        expected_token = G_TOKEN_INT;
      else
        expected_token = ')';

      g_scanner_get_next_token (scanner);

      switch ((guint) scanner->token)
        {
        case G_TOKEN_FLOAT:
          if (need_arg)
            {
              need_arg = FALSE;
              arg = g_new (GtkBindingArg, 1);
              arg->arg_type = G_TYPE_DOUBLE;
              arg->d.double_data = scanner->value.v_float;

              if (negate)
                {
                  arg->d.double_data = - arg->d.double_data;
                  negate = FALSE;
                }
              args = g_slist_prepend (args, arg);
            }
          else
            done = TRUE;

          break;
        case G_TOKEN_INT:
          if (need_arg)
            {
              need_arg = FALSE;
              arg = g_new (GtkBindingArg, 1);
              arg->arg_type = G_TYPE_LONG;
              arg->d.long_data = scanner->value.v_int;

              if (negate)
                {
                  arg->d.long_data = - arg->d.long_data;
                  negate = FALSE;
                }
              args = g_slist_prepend (args, arg);
            }
          else
            done = TRUE;
          break;
        case G_TOKEN_STRING:
          if (need_arg && !negate)
            {
              need_arg = FALSE;
              arg = g_new (GtkBindingArg, 1);
              arg->arg_type = G_TYPE_STRING;
              arg->d.string_data = g_strdup (scanner->value.v_string);
              args = g_slist_prepend (args, arg);
            }
          else
            done = TRUE;

          break;
        case G_TOKEN_IDENTIFIER:
          if (need_arg && !negate)
            {
              need_arg = FALSE;
              arg = g_new (GtkBindingArg, 1);
              arg->arg_type = GTK_TYPE_IDENTIFIER;
              arg->d.string_data = g_strdup (scanner->value.v_identifier);
              args = g_slist_prepend (args, arg);
            }
          else
            done = TRUE;

          break;
        case '-':
          if (!need_arg)
            done = TRUE;
          else if (negate)
            {
              expected_token = G_TOKEN_INT;
              done = TRUE;
            }
          else
            negate = TRUE;

          break;
        case ',':
          seen_comma = TRUE;
          if (need_arg)
            done = TRUE;
          else
            need_arg = TRUE;

          break;
        case ')':
          if (!(need_arg && seen_comma) && !negate)
            {
              args = g_slist_reverse (args);
              _gtk_binding_entry_add_signall (binding_set,
                                              keyval,
                                              modifiers,
                                              signal,
                                              args);
              expected_token = G_TOKEN_NONE;
            }

          done = TRUE;
          break;
        default:
          done = TRUE;
          break;
        }
    }
  while (!done);

  scanner->config->scan_symbols = TRUE;

  for (slist = args; slist; slist = slist->next)
    {
      GtkBindingArg *arg;

      arg = slist->data;

      if (G_TYPE_FUNDAMENTAL (arg->arg_type) == G_TYPE_STRING)
        g_free (arg->d.string_data);
      g_free (arg);
    }

  g_slist_free (args);
  g_free (signal);

  return expected_token;
}

static inline guint
gtk_binding_parse_bind (GScanner       *scanner,
                        GtkBindingSet  *binding_set)
{
  guint keyval = 0;
  GdkModifierType modifiers = 0;
  gboolean unbind = FALSE;

  g_return_val_if_fail (scanner != NULL, G_TOKEN_ERROR);

  g_scanner_get_next_token (scanner);

  if (scanner->token != G_TOKEN_SYMBOL)
    return G_TOKEN_SYMBOL;

  if (scanner->value.v_symbol != GUINT_TO_POINTER (GTK_BINDING_TOKEN_BIND) &&
      scanner->value.v_symbol != GUINT_TO_POINTER (GTK_BINDING_TOKEN_UNBIND))
    return G_TOKEN_SYMBOL;

  unbind = (scanner->value.v_symbol == GUINT_TO_POINTER (GTK_BINDING_TOKEN_UNBIND));
  g_scanner_get_next_token (scanner);

  if (scanner->token != (guint) G_TOKEN_STRING)
    return G_TOKEN_STRING;

  gtk_accelerator_parse (scanner->value.v_string, &keyval, &modifiers);
  modifiers &= BINDING_MOD_MASK ();

  if (keyval == 0)
    return G_TOKEN_STRING;

  if (unbind)
    {
      gtk_binding_entry_skip (binding_set, keyval, modifiers);
      return G_TOKEN_NONE;
    }

  g_scanner_get_next_token (scanner);

  if (scanner->token != '{')
    return '{';

  gtk_binding_entry_clear_internal (binding_set, keyval, modifiers);
  g_scanner_peek_next_token (scanner);

  while (scanner->next_token != '}')
    {
      guint expected_token;

      switch (scanner->next_token)
        {
        case G_TOKEN_STRING:
          expected_token = gtk_binding_parse_signal (scanner,
                                                     binding_set,
                                                     keyval,
                                                     modifiers);
          if (expected_token != G_TOKEN_NONE)
            return expected_token;
          break;
        default:
          g_scanner_get_next_token (scanner);
          return '}';
        }

      g_scanner_peek_next_token (scanner);
    }

  g_scanner_get_next_token (scanner);

  return G_TOKEN_NONE;
}

static GScanner *
create_signal_scanner (void)
{
  GScanner *scanner;

  scanner = g_scanner_new (NULL);
  scanner->config->cset_identifier_nth = G_CSET_a_2_z G_CSET_A_2_Z G_CSET_DIGITS "-_";

  g_scanner_scope_add_symbol (scanner, 0, "bind", GUINT_TO_POINTER (GTK_BINDING_TOKEN_BIND));
  g_scanner_scope_add_symbol (scanner, 0, "unbind", GUINT_TO_POINTER (GTK_BINDING_TOKEN_UNBIND));

  g_scanner_set_scope (scanner, 0);

  return scanner;
}

/**
 * gtk_binding_entry_add_signal_from_string:
 * @binding_set: a #GtkBindingSet
 * @signal_desc: a signal description
 *
 * Parses a signal description from @signal_desc and incorporates
 * it into @binding_set.
 *
Matthias Clasen's avatar
Matthias Clasen committed
1343
 * Signal descriptions may either bind a key combination to
1344
 * one or more signals:
1345
 * |[
Matthias Clasen's avatar
Matthias Clasen committed
1346 1347
 *   bind "key" {
 *     "signalname" (param, ...)
1348 1349
 *     ...
 *   }
1350
 * ]|
1351 1352
 *
 * Or they may also unbind a key combination:
1353
 * |[
Matthias Clasen's avatar
Matthias Clasen committed
1354
 *   unbind "key"
1355
 * ]|
1356 1357 1358 1359
 *
 * Key combinations must be in a format that can be parsed by
 * gtk_accelerator_parse().
 *
1360 1361 1362
 * Returns: %G_TOKEN_NONE if the signal was successfully parsed and added,
 *     the expected token otherwise
 *
1363
 * Since: 3.0
1364 1365
 */
GTokenType
1366
gtk_binding_entry_add_signal_from_string (GtkBindingSet *binding_set,
1367
                                          const gchar   *signal_desc)
1368 1369 1370 1371
{
  static GScanner *scanner = NULL;
  GTokenType ret;

1372 1373
  g_return_val_if_fail (binding_set != NULL, G_TOKEN_NONE);
  g_return_val_if_fail (signal_desc != NULL, G_TOKEN_NONE);
1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384

  if (G_UNLIKELY (!scanner))
    scanner = create_signal_scanner ();

  g_scanner_input_text (scanner, signal_desc,
                        (guint) strlen (signal_desc));

  ret = gtk_binding_parse_bind (scanner, binding_set);

  /* Reset for next use */
  g_scanner_set_scope (scanner, 0);
1385 1386

  return ret;
1387 1388
}

1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428
static gint
find_entry_with_binding (GtkBindingEntry *entry,
                         GtkBindingSet   *binding_set)
{
  return (entry->binding_set == binding_set) ? 0 : 1;
}

static gboolean
binding_activate (GtkBindingSet *binding_set,
                  GSList        *entries,
                  GObject       *object,
                  gboolean       is_release,
                  gboolean      *unbound)
{
  GtkBindingEntry *entry;
  GSList *elem;

  elem = g_slist_find_custom (entries, binding_set,
                              (GCompareFunc) find_entry_with_binding);

  if (!elem)
    return FALSE;

  entry = elem->data;

  if (is_release != ((entry->modifiers & GDK_RELEASE_MASK) != 0))
    return FALSE;

  if (entry->marks_unbound)
    {
      *unbound = TRUE;
      return FALSE;
    }

  if (gtk_binding_entry_activate (entry, object))
    return TRUE;

  return FALSE;
}

1429
static gboolean
1430 1431 1432
gtk_bindings_activate_list (GObject  *object,
                            GSList   *entries,
                            gboolean  is_release)
Tim Janik's avatar
Tim Janik committed
1433
{
1434 1435 1436
  GtkStyleContext *context;
  GtkBindingSet *binding_set;
  GtkStateFlags state;
Tim Janik's avatar
Tim Janik committed
1437
  gboolean handled = FALSE;
1438 1439
  gboolean unbound = FALSE;
  GPtrArray *array;
Tim Janik's avatar
Tim Janik committed
1440 1441 1442 1443

  if (!entries)
    return FALSE;

1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459
  context = gtk_widget_get_style_context (GTK_WIDGET (object));
  state = gtk_widget_get_state_flags (GTK_WIDGET (object));

  gtk_style_context_get (context, state,
                         "gtk-key-bindings", &array,
                         NULL);
  if (array)
    {
      gint i;

      for (i = 0; i < array->len; i++)
        {
          binding_set = g_ptr_array_index (array, i);
          handled = binding_activate (binding_set, entries,
                                      object, is_release,
                                      &unbound);
1460
          if (handled || unbound)
1461 1462 1463 1464 1465 1466 1467 1468
            break;
        }

      g_ptr_array_unref (array);

      if (unbound)
        return FALSE;
    }
Tim Janik's avatar
Tim Janik committed
1469 1470 1471

  if (!handled)
    {
Manish Singh's avatar
Manish Singh committed
1472
      GType class_type;
1473

Manish Singh's avatar
Manish Singh committed
1474
      class_type = G_TYPE_FROM_INSTANCE (object);
1475

Tim Janik's avatar
Tim Janik committed
1476
      while (class_type && !handled)
1477
        {
Matthias Clasen's avatar
Matthias Clasen committed
1478
          binding_set = gtk_binding_set_find_interned (g_type_name (class_type));
1479
          class_type = g_type_parent (class_type);
1480 1481 1482 1483 1484 1485 1486

          if (!binding_set)
            continue;

          handled = binding_activate (binding_set, entries,
                                      object, is_release,
                                      &unbound);
1487 1488
          if (unbound)
            break;
1489
        }
1490 1491 1492

      if (unbound)
        return FALSE;
Tim Janik's avatar
Tim Janik committed
1493 1494 1495 1496 1497
    }

  return handled;
}

1498 1499 1500 1501 1502 1503 1504 1505 1506
/**
 * gtk_bindings_activate:
 * @object: object to activate when binding found
 * @keyval: key value of the binding
 * @modifiers: key modifier of the binding
 *
 * Find a key binding matching @keyval and @modifiers and activate the
 * binding on @object.
 *
1507
 * Returns: %TRUE if a binding was found and activated
Matthias Clasen's avatar
Matthias Clasen committed
1508
 */
1509
gboolean
1510
gtk_bindings_activate (GObject         *object,
1511 1512
                       guint            keyval,
                       GdkModifierType  modifiers)
1513 1514
{
  GSList *entries = NULL;
1515
  GdkDisplay *display;
1516 1517 1518 1519 1520 1521 1522
  GtkKeyHash *key_hash;
  gboolean handled = FALSE;
  gboolean is_release;

  if (!GTK_IS_WIDGET (object))
    return FALSE;

1523
  is_release = (modifiers & GDK_RELEASE_MASK) != 0;
1524 1525
  modifiers = modifiers & BINDING_MOD_MASK () & ~GDK_RELEASE_MASK;

1526 1527
  display = gtk_widget_get_display (GTK_WIDGET (object));
  key_hash = binding_key_hash_for_keymap (gdk_keymap_get_for_display (display));
1528

1529 1530 1531 1532 1533 1534 1535 1536 1537 1538
  entries = _gtk_key_hash_lookup_keyval (key_hash, keyval, modifiers);

  handled = gtk_bindings_activate_list (object, entries, is_release);

  g_slist_free (entries);

  return handled;
}

/**
1539
 * gtk_bindings_activate_event:
1540
 * @object: a #GObject (generally must be a widget)
1541
 * @event: a #GdkEventKey
1542
 *
1543 1544
 * Looks up key bindings for @object to find one matching
 * @event, and if one was found, activate it.
1545
 *
1546
 * Returns: %TRUE if a matching key binding was found
1547 1548
 *
 * Since: 2.4
Matthias Clasen's avatar
Matthias Clasen committed
1549
 */
1550
gboolean
1551
gtk_bindings_activate_event (GObject     *object,
Matthias Clasen's avatar
Matthias Clasen committed
1552
                             GdkEventKey *event)
1553 1554
{
  GSList *entries = NULL;
1555
  GdkDisplay *display;
1556 1557 1558 1559 1560 1561
  GtkKeyHash *key_hash;
  gboolean handled = FALSE;

  if (!GTK_IS_WIDGET (object))
    return FALSE;

1562 1563 1564
  display = gtk_widget_get_display (