gtkbindings.c 35.9 KB
Newer Older
Tim Janik's avatar
Tim Janik committed
1 2 3 4 5 6 7
/* GTK - The GIMP Toolkit
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * GtkBindingSet: Keybinding manager for GtkObjects.
 * 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 14
 * 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
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
Tim Janik's avatar
Tim Janik committed
18 19 20 21
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */
22 23

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

30
#include <config.h>
31
#include <string.h>
Tim Janik's avatar
Tim Janik committed
32
#include <stdarg.h>
33
#include <gdkkeysyms.h>
Tim Janik's avatar
Tim Janik committed
34
#include "gtkbindings.h"
35
#include "gtkkeyhash.h"
Tim Janik's avatar
Tim Janik committed
36
#include "gtkwidget.h"
37
#include "gtkrc.h"
38
#include "gtkalias.h"
Tim Janik's avatar
Tim Janik committed
39 40 41


/* --- defines --- */
42
#define	BINDING_MOD_MASK()	(gtk_accelerator_get_default_mod_mask () | GDK_RELEASE_MASK)
Tim Janik's avatar
Tim Janik committed
43 44


45 46 47 48 49 50 51 52
/* --- structures --- */
typedef struct {
  GPatternSpec *pspec;
  gpointer user_data;
  guint seq_id;
} PatternSpec;


Tim Janik's avatar
Tim Janik committed
53 54
/* --- variables --- */
static GHashTable	*binding_entry_hash_table = NULL;
55
static GSList           *binding_key_hashes = NULL;
Tim Janik's avatar
Tim Janik committed
56
static GSList		*binding_set_list = NULL;
57
static const gchar	 key_class_binding_set[] = "gtk-class-binding-set";
58
static GQuark		 key_id_class_binding_set = 0;
Tim Janik's avatar
Tim Janik committed
59 60 61 62 63 64 65 66 67


/* --- functions --- */
static GtkBindingSignal*
binding_signal_new (const gchar *signal_name,
		    guint	 n_args)
{
  GtkBindingSignal *signal;
  
68
  signal = (GtkBindingSignal *) g_malloc0 (sizeof (GtkBindingSignal) + (n_args > 0 ? n_args - 1 : 0) * sizeof (GtkBindingArg));
Tim Janik's avatar
Tim Janik committed
69
  signal->next = NULL;
70
  signal->signal_name = (gchar *)g_intern_string (signal_name);
Tim Janik's avatar
Tim Janik committed
71 72 73 74 75 76 77 78 79 80 81 82
  signal->n_args = n_args;
  
  return signal;
}

static void
binding_signal_free (GtkBindingSignal *sig)
{
  guint i;
  
  for (i = 0; i < sig->n_args; i++)
    {
Manish Singh's avatar
Manish Singh committed
83
      if (G_TYPE_FUNDAMENTAL (sig->args[i].arg_type) == G_TYPE_STRING)
Tim Janik's avatar
Tim Janik committed
84
	g_free (sig->args[i].d.string_data);
Tim Janik's avatar
Tim Janik committed
85 86 87 88 89
    }
  g_free (sig);
}

static guint
90
binding_entry_hash (gconstpointer  key)
Tim Janik's avatar
Tim Janik committed
91
{
Tim Janik's avatar
Tim Janik committed
92
  register const GtkBindingEntry *e = key;
Tim Janik's avatar
Tim Janik committed
93 94 95 96 97 98 99 100 101
  register guint h;

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

  return h;
}

static gint
102 103
binding_entries_compare (gconstpointer  a,
			 gconstpointer  b)
Tim Janik's avatar
Tim Janik committed
104
{
Tim Janik's avatar
Tim Janik committed
105 106
  register const GtkBindingEntry *ea = a;
  register const GtkBindingEntry *eb = b;
Tim Janik's avatar
Tim Janik committed
107 108 109 110

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

111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
static void
binding_key_hash_insert_entry (GtkKeyHash      *key_hash,
			       GtkBindingEntry *entry)
{
  guint keyval = entry->keyval;
  
  /* We store lowercased accelerators. To deal with this, if <Shift>
   * was specified, uppercase.
   */
  if (entry->modifiers & GDK_SHIFT_MASK)
    {
      if (keyval == GDK_Tab)
	keyval = GDK_ISO_Left_Tab;
      else
	keyval = gdk_keyval_to_upper (keyval);
    }
  
  _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;
  
  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,
			      gpointer value,
			      gpointer data)
{
  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");
  
  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)
	g_hash_table_foreach (binding_entry_hash_table,
			      insert_entries_into_key_hash,
			      key_hash);

      binding_key_hashes = g_slist_prepend (binding_key_hashes, key_hash);
    }

  return key_hash;
}


Tim Janik's avatar
Tim Janik committed
180
static GtkBindingEntry*
181 182 183
binding_entry_new (GtkBindingSet  *binding_set,
		   guint           keyval,
		   GdkModifierType modifiers)
Tim Janik's avatar
Tim Janik committed
184
{
185
  GSList *tmp_list;
Tim Janik's avatar
Tim Janik committed
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
  GtkBindingEntry *entry;
  
  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;
  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);
206 207 208 209 210 211

  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);
    }
Tim Janik's avatar
Tim Janik committed
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
  
  return entry;
}

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

  g_assert (entry->set_next == NULL &&
	    entry->hash_next == NULL &&
	    entry->in_emission == FALSE &&
	    entry->destroyed == TRUE);

  entry->destroyed = FALSE;
  
  sig = entry->signals;
  while (sig)
    {
      GtkBindingSignal *prev;
      
      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;
247
  GSList *tmp_list;
Tim Janik's avatar
Tim Janik committed
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 293 294

  /* unlink from binding set
   */
  last = NULL;
  tmp = entry->binding_set->entries;
  while (tmp)
    {
      if (tmp == entry)
	{
	  if (last)
	    last->set_next = entry->set_next;
	  else
	    entry->binding_set->entries = entry->set_next;
	  break;
	}
      last = tmp;
      tmp = last->set_next;
    }
  entry->set_next = NULL;
  
  o_entry = g_hash_table_lookup (binding_entry_hash_table, entry);
  begin = o_entry;
  last = NULL;
  tmp = begin;
  while (tmp)
    {
      if (tmp == entry)
	{
	  if (last)
	    last->hash_next = entry->hash_next;
	  else
	    begin = entry->hash_next;
	  break;
	}
      last = tmp;
      tmp = last->hash_next;
    }
  entry->hash_next = NULL;
  
  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);
    }

295 296 297 298 299 300
  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
301 302 303 304 305 306 307
  entry->destroyed = TRUE;

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

static GtkBindingEntry*
308 309 310
binding_ht_lookup_entry (GtkBindingSet  *set,
			 guint		 keyval,
			 GdkModifierType modifiers)
Tim Janik's avatar
Tim Janik committed
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329
{
  GtkBindingEntry lookup_entry = { 0 };
  GtkBindingEntry *entry;
  
  if (!binding_entry_hash_table)
    return NULL;
  
  lookup_entry.keyval = keyval;
  lookup_entry.modifiers = modifiers;
  
  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
330 331
binding_compose_params (GtkObject       *object,
			GtkBindingArg	*args,
332
			GSignalQuery	*query,
333
			GValue	       **params_p)
Tim Janik's avatar
Tim Janik committed
334
{
335 336
  GValue *params;
  const GType *types;
Tim Janik's avatar
Tim Janik committed
337 338 339
  guint i;
  gboolean valid;
  
340
  params = g_new0 (GValue, query->n_params + 1);
Tim Janik's avatar
Tim Janik committed
341
  *params_p = params;
342 343 344 345 346 347

  /* 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++;
Tim Janik's avatar
Tim Janik committed
348
  
349
  types = query->param_types;
Tim Janik's avatar
Tim Janik committed
350
  valid = TRUE;
351
  for (i = 1; i < query->n_params + 1 && valid; i++)
Tim Janik's avatar
Tim Janik committed
352
    {
353
      GValue tmp_value = { 0, };
354

355 356 357
      g_value_init (params, *types);

      switch (G_TYPE_FUNDAMENTAL (args->arg_type))
Tim Janik's avatar
Tim Janik committed
358
	{
359 360 361
	case G_TYPE_DOUBLE:
	  g_value_init (&tmp_value, G_TYPE_DOUBLE);
	  g_value_set_double (&tmp_value, args->d.double_data);
Tim Janik's avatar
Tim Janik committed
362
	  break;
Manish Singh's avatar
Manish Singh committed
363
	case G_TYPE_LONG:
364 365
	  g_value_init (&tmp_value, G_TYPE_LONG);
	  g_value_set_long (&tmp_value, args->d.long_data);
Tim Janik's avatar
Tim Janik committed
366
	  break;
Manish Singh's avatar
Manish Singh committed
367
	case G_TYPE_STRING:
368 369 370 371
	  /* 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)
372
	    {
373 374 375 376 377 378 379 380 381 382 383 384
	      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)
		    {
385
		      g_value_init (&tmp_value, *types);
386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
		      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)
		    {
411
		      g_value_init (&tmp_value, *types);
412 413 414 415 416 417
		      g_value_set_flags (&tmp_value, flags_value->value);
		      valid = TRUE;
		    }
		}

	      g_type_class_unref (class);
418
	    }
419
	  else
420 421
	    {
	      g_value_init (&tmp_value, G_TYPE_STRING);
422
	      g_value_set_static_string (&tmp_value, args->d.string_data);
423
	    }
424
	  break;
Tim Janik's avatar
Tim Janik committed
425 426 427 428
	default:
	  valid = FALSE;
	  break;
	}
429

430 431 432 433
      if (valid)
	{
	  if (!g_value_transform (&tmp_value, params))
	    valid = FALSE;
434

435 436
	  g_value_unset (&tmp_value);
	}
437
      
Tim Janik's avatar
Tim Janik committed
438 439 440 441 442 443 444
      types++;
      params++;
      args++;
    }
  
  if (!valid)
    {
445 446 447 448 449
      guint j;

      for (j = 0; j < i; j++)
	g_value_unset (&(*params_p)[j]);
      
Tim Janik's avatar
Tim Janik committed
450 451 452 453 454 455 456
      g_free (*params_p);
      *params_p = NULL;
    }
  
  return valid;
}

457 458 459
static gboolean
gtk_binding_entry_activate (GtkBindingEntry *entry,
			    GtkObject	    *object)
Tim Janik's avatar
Tim Janik committed
460 461 462
{
  GtkBindingSignal *sig;
  gboolean old_emission;
463 464
  gboolean handled = FALSE;
  gint i;
Tim Janik's avatar
Tim Janik committed
465 466 467 468
  
  old_emission = entry->in_emission;
  entry->in_emission = TRUE;
  
469
  g_object_ref (object);
Tim Janik's avatar
Tim Janik committed
470 471 472
  
  for (sig = entry->signals; sig; sig = sig->next)
    {
473
      GSignalQuery query;
Tim Janik's avatar
Tim Janik committed
474
      guint signal_id;
475 476
      GValue *params = NULL;
      GValue return_val = { 0, };
477
      gchar *accelerator = NULL;
Tim Janik's avatar
Tim Janik committed
478
      
479
      signal_id = g_signal_lookup (sig->signal_name, G_OBJECT_TYPE (object));
Tim Janik's avatar
Tim Janik committed
480 481 482 483 484 485 486 487
      if (!signal_id)
	{
	  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,
488
		     g_type_name (G_OBJECT_TYPE (object)));
Tim Janik's avatar
Tim Janik committed
489 490 491 492
	  g_free (accelerator);
	  continue;
	}
      
493 494
      g_signal_query (signal_id, &query);
      if (query.n_params != sig->n_args ||
495 496
	  (query.return_type != G_TYPE_NONE && query.return_type != G_TYPE_BOOLEAN) || 
	  !binding_compose_params (object, sig->args, &query, &params))
Tim Janik's avatar
Tim Janik committed
497 498 499 500 501 502 503
	{
	  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,
504
		     g_type_name (G_OBJECT_TYPE (object)));
Tim Janik's avatar
Tim Janik committed
505
	}
Manish Singh's avatar
Manish Singh committed
506
      else if (!(query.signal_flags & G_SIGNAL_ACTION))
507 508 509 510 511 512 513
	{
	  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,
514
		     g_type_name (G_OBJECT_TYPE (object)));
515 516 517 518
	}
      g_free (accelerator);
      if (accelerator)
	continue;
Tim Janik's avatar
Tim Janik committed
519

520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
      if (query.return_type == G_TYPE_BOOLEAN)
	g_value_init (&return_val, G_TYPE_BOOLEAN);
      
      g_signal_emitv (params, signal_id, 0, &return_val);

      if (query.return_type == G_TYPE_BOOLEAN)
	{
	  if (g_value_get_boolean (&return_val))
	    handled = TRUE;
	  g_value_unset (&return_val);
	}
      else
	handled = TRUE;
      
      for (i = 0; i < query.n_params + 1; i++)
	g_value_unset (&params[i]);
Tim Janik's avatar
Tim Janik committed
536 537
      g_free (params);
      
538
      if (entry->destroyed)
Tim Janik's avatar
Tim Janik committed
539 540 541
	break;
    }
  
542
  g_object_unref (object);
Tim Janik's avatar
Tim Janik committed
543 544 545 546

  entry->in_emission = old_emission;
  if (entry->destroyed && !entry->in_emission)
    binding_entry_free (entry);
547 548

  return handled;
Tim Janik's avatar
Tim Janik committed
549 550 551 552 553 554 555 556 557 558
}

GtkBindingSet*
gtk_binding_set_new (const gchar    *set_name)
{
  GtkBindingSet *binding_set;
  
  g_return_val_if_fail (set_name != NULL, NULL);
  
  binding_set = g_new (GtkBindingSet, 1);
559
  binding_set->set_name = g_intern_string (set_name);
Tim Janik's avatar
Tim Janik committed
560 561 562 563 564
  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;
565
  binding_set->parsed = FALSE;
Tim Janik's avatar
Tim Janik committed
566
  
567
  binding_set_list = g_slist_prepend (binding_set_list, binding_set);
Tim Janik's avatar
Tim Janik committed
568 569 570 571 572 573 574 575 576 577 578 579 580
  
  return binding_set;
}

GtkBindingSet*
gtk_binding_set_by_class (gpointer object_class)
{
  GtkObjectClass *class = object_class;
  GtkBindingSet* binding_set;

  g_return_val_if_fail (GTK_IS_OBJECT_CLASS (class), NULL);

  if (!key_id_class_binding_set)
581
    key_id_class_binding_set = g_quark_from_static_string (key_class_binding_set);
Tim Janik's avatar
Tim Janik committed
582 583 584 585 586 587

  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
588
  binding_set = gtk_binding_set_new (g_type_name (G_OBJECT_CLASS_TYPE (class)));
Tim Janik's avatar
Tim Janik committed
589 590
  gtk_binding_set_add_path (binding_set,
			    GTK_PATH_CLASS,
Manish Singh's avatar
Manish Singh committed
591
			    g_type_name (G_OBJECT_CLASS_TYPE (class)),
Tim Janik's avatar
Tim Janik committed
592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618
			    GTK_PATH_PRIO_GTK);
  g_dataset_id_set_data (class, key_id_class_binding_set, binding_set);

  return binding_set;
}

GtkBindingSet*
gtk_binding_set_find (const gchar    *set_name)
{
  GSList *slist;
  
  g_return_val_if_fail (set_name != NULL, NULL);
  
  for (slist = binding_set_list; slist; slist = slist->next)
    {
      GtkBindingSet *binding_set;
      
      binding_set = slist->data;
      if (g_str_equal (binding_set->set_name, (gpointer) set_name))
	return binding_set;
    }
  return NULL;
}

gboolean
gtk_binding_set_activate (GtkBindingSet	 *binding_set,
			  guint		  keyval,
619
			  GdkModifierType modifiers,
Tim Janik's avatar
Tim Janik committed
620 621 622 623 624 625 626 627 628 629
			  GtkObject	 *object)
{
  GtkBindingEntry *entry;
  
  g_return_val_if_fail (binding_set != NULL, FALSE);
  g_return_val_if_fail (GTK_IS_OBJECT (object), FALSE);
  
  keyval = gdk_keyval_to_lower (keyval);
  modifiers = modifiers & BINDING_MOD_MASK ();
  
630 631
  entry = binding_ht_lookup_entry (binding_set, keyval, modifiers);
  if (entry)
632
    return gtk_binding_entry_activate (entry, object);
Tim Janik's avatar
Tim Janik committed
633 634 635 636 637 638 639
  
  return FALSE;
}

void
gtk_binding_entry_clear (GtkBindingSet	*binding_set,
			 guint		 keyval,
640
			 GdkModifierType modifiers)
Tim Janik's avatar
Tim Janik committed
641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658
{
  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);
}

void
gtk_binding_entry_remove (GtkBindingSet	 *binding_set,
			  guint		  keyval,
659
			  GdkModifierType modifiers)
Tim Janik's avatar
Tim Janik committed
660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675
{
  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);
}

void
gtk_binding_entry_add_signall (GtkBindingSet  *binding_set,
			       guint	       keyval,
676
			       GdkModifierType modifiers,
Tim Janik's avatar
Tim Janik committed
677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705
			       const gchar    *signal_name,
			       GSList	      *binding_args)
{
  GtkBindingEntry *entry;
  GtkBindingSignal *signal, **signal_p;
  GSList *slist;
  guint n = 0;
  GtkBindingArg *arg;
  
  g_return_if_fail (binding_set != NULL);
  g_return_if_fail (signal_name != NULL);
  
  keyval = gdk_keyval_to_lower (keyval);
  modifiers = modifiers & BINDING_MOD_MASK ();
  
  signal = binding_signal_new (signal_name, g_slist_length (binding_args));
  
  arg = signal->args;
  for (slist = binding_args; slist; slist = slist->next)
    {
      GtkBindingArg *tmp_arg;
      
      tmp_arg = slist->data;
      if (!tmp_arg)
	{
	  g_warning ("gtk_binding_entry_add_signall(): arg[%u] is `NULL'", n);
	  binding_signal_free (signal);
	  return;
	}
Manish Singh's avatar
Manish Singh committed
706
      switch (G_TYPE_FUNDAMENTAL (tmp_arg->arg_type))
Tim Janik's avatar
Tim Janik committed
707
	{
Manish Singh's avatar
Manish Singh committed
708 709
	case  G_TYPE_LONG:
	  arg->arg_type = G_TYPE_LONG;
Tim Janik's avatar
Tim Janik committed
710 711
	  arg->d.long_data = tmp_arg->d.long_data;
	  break;
Manish Singh's avatar
Manish Singh committed
712 713
	case  G_TYPE_DOUBLE:
	  arg->arg_type = G_TYPE_DOUBLE;
Tim Janik's avatar
Tim Janik committed
714 715
	  arg->d.double_data = tmp_arg->d.double_data;
	  break;
Manish Singh's avatar
Manish Singh committed
716
	case  G_TYPE_STRING:
717
          if (tmp_arg->arg_type != GTK_TYPE_IDENTIFIER)
Manish Singh's avatar
Manish Singh committed
718
	    arg->arg_type = G_TYPE_STRING;
719 720 721 722
	  else
	    arg->arg_type = GTK_TYPE_IDENTIFIER;
	  arg->d.string_data = g_strdup (tmp_arg->d.string_data);
	  if (!arg->d.string_data)
Tim Janik's avatar
Tim Janik committed
723 724 725 726 727 728 729 730
	    {
	      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]",
Manish Singh's avatar
Manish Singh committed
731
		     g_type_name (arg->arg_type), n);
Tim Janik's avatar
Tim Janik committed
732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753
	  binding_signal_free (signal);
	  return;
	}
      arg++;
      n++;
    }
  
  entry = binding_ht_lookup_entry (binding_set, keyval, modifiers);
  if (!entry)
    {
      gtk_binding_entry_add (binding_set, keyval, modifiers);
      entry = binding_ht_lookup_entry (binding_set, keyval, modifiers);
    }
  signal_p = &entry->signals;
  while (*signal_p)
    signal_p = &(*signal_p)->next;
  *signal_p = signal;
}

void
gtk_binding_entry_add_signal (GtkBindingSet  *binding_set,
			      guint           keyval,
754
			      GdkModifierType modifiers,
Tim Janik's avatar
Tim Janik committed
755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775
			      const gchar    *signal_name,
			      guint           n_args,
			      ...)
{
  GSList *slist, *free_slist;
  va_list args;
  guint i;

  g_return_if_fail (binding_set != NULL);
  g_return_if_fail (signal_name != NULL);
  
  va_start (args, n_args);
  slist = NULL;
  for (i = 0; i < n_args; i++)
    {
      GtkBindingArg *arg;

      arg = g_new0 (GtkBindingArg, 1);
      slist = g_slist_prepend (slist, arg);

      arg->arg_type = va_arg (args, GtkType);
Manish Singh's avatar
Manish Singh committed
776
      switch (G_TYPE_FUNDAMENTAL (arg->arg_type))
Tim Janik's avatar
Tim Janik committed
777
	{
Tim Janik's avatar
Tim Janik committed
778 779 780
	  /* for elaborated commenting about var args collection, take a look
	   * at gtk_arg_collect_value() in gtkargcollector.c
	   */
Manish Singh's avatar
Manish Singh committed
781 782 783 784 785 786 787 788
	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;
Tim Janik's avatar
Tim Janik committed
789 790
	  arg->d.long_data = va_arg (args, gint);
	  break;
Manish Singh's avatar
Manish Singh committed
791 792 793
	case G_TYPE_LONG:
	case G_TYPE_ULONG:
	  arg->arg_type = G_TYPE_LONG;
Tim Janik's avatar
Tim Janik committed
794 795
	  arg->d.long_data = va_arg (args, glong);
	  break;
Manish Singh's avatar
Manish Singh committed
796 797 798
	case G_TYPE_FLOAT:
	case G_TYPE_DOUBLE:
	  arg->arg_type = G_TYPE_DOUBLE;
Tim Janik's avatar
Tim Janik committed
799 800
	  arg->d.double_data = va_arg (args, gdouble);
	  break;
Manish Singh's avatar
Manish Singh committed
801
	case G_TYPE_STRING:
802
	  if (arg->arg_type != GTK_TYPE_IDENTIFIER)
Manish Singh's avatar
Manish Singh committed
803
	    arg->arg_type = G_TYPE_STRING;
Tim Janik's avatar
Tim Janik committed
804 805
	  arg->d.string_data = va_arg (args, gchar*);
	  if (!arg->d.string_data)
Tim Janik's avatar
Tim Janik committed
806
	    {
807
	      g_warning ("gtk_binding_entry_add_signal(): type `%s' arg[%u] is `NULL'",
Manish Singh's avatar
Manish Singh committed
808
			 g_type_name (arg->arg_type),
809
			 i);
810
	      i += n_args + 1;
Tim Janik's avatar
Tim Janik committed
811 812 813 814
	    }
	  break;
	default:
	  g_warning ("gtk_binding_entry_add_signal(): unsupported type `%s' for arg[%u]",
Manish Singh's avatar
Manish Singh committed
815
		     g_type_name (arg->arg_type), i);
816
	  i += n_args + 1;
Tim Janik's avatar
Tim Janik committed
817 818 819 820 821
	  break;
	}
    }
  va_end (args);

822
  if (i == n_args || i == 0)
Tim Janik's avatar
Tim Janik committed
823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842
    {
      slist = g_slist_reverse (slist);
      gtk_binding_entry_add_signall (binding_set, keyval, modifiers, signal_name, slist);
    }

  free_slist = slist;
  while (slist)
    {
      g_free (slist->data);
      slist = slist->next;
    }
  g_slist_free (free_slist);
}

void
gtk_binding_set_add_path (GtkBindingSet	     *binding_set,
			  GtkPathType	      path_type,
			  const gchar	     *path_pattern,
			  GtkPathPriorityType priority)
{
843
  PatternSpec *pspec;
Tim Janik's avatar
Tim Janik committed
844 845 846 847 848
  GSList **slist_p, *slist;
  static guint seq_id = 0;
  
  g_return_if_fail (binding_set != NULL);
  g_return_if_fail (path_pattern != NULL);
849
  g_return_if_fail (priority <= GTK_PATH_PRIO_MASK);
Tim Janik's avatar
Tim Janik committed
850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869

  priority &= GTK_PATH_PRIO_MASK;
  
  switch (path_type)
    {
    case  GTK_PATH_WIDGET:
      slist_p = &binding_set->widget_path_pspecs;
      break;
    case  GTK_PATH_WIDGET_CLASS:
      slist_p = &binding_set->widget_class_pspecs;
      break;
    case  GTK_PATH_CLASS:
      slist_p = &binding_set->class_branch_pspecs;
      break;
    default:
      g_assert_not_reached ();
      slist_p = NULL;
      break;
    }
  
870 871
  pspec = g_new (PatternSpec, 1);
  pspec->pspec = g_pattern_spec_new (path_pattern);
872
  pspec->seq_id = priority << 28;
Tim Janik's avatar
Tim Janik committed
873 874 875 876 877
  pspec->user_data = binding_set;
  
  slist = *slist_p;
  while (slist)
    {
878
      PatternSpec *tmp_pspec;
Tim Janik's avatar
Tim Janik committed
879 880 881 882
      
      tmp_pspec = slist->data;
      slist = slist->next;
      
883
      if (g_pattern_spec_equal (tmp_pspec->pspec, pspec->pspec))
Tim Janik's avatar
Tim Janik committed
884
	{
885 886
	  GtkPathPriorityType lprio = tmp_pspec->seq_id >> 28;

887
	  g_pattern_spec_free (pspec->pspec);
Tim Janik's avatar
Tim Janik committed
888 889
	  g_free (pspec);
	  pspec = NULL;
890 891 892 893 894
	  if (lprio < priority)
	    {
	      tmp_pspec->seq_id &= 0x0fffffff;
	      tmp_pspec->seq_id |= priority << 28;
	    }
895
	  break;
Tim Janik's avatar
Tim Janik committed
896 897 898
	}
    }
  if (pspec)
899 900 901 902
    {
      pspec->seq_id |= seq_id++ & 0x0fffffff;
      *slist_p = g_slist_prepend (*slist_p, pspec);
    }
Tim Janik's avatar
Tim Janik committed
903 904
}

905
static gboolean
Tim Janik's avatar
Tim Janik committed
906 907 908
binding_match_activate (GSList          *pspec_list,
			GtkObject	*object,
			guint	         path_length,
Owen Taylor's avatar
Owen Taylor committed
909 910
			const gchar     *path,
			const gchar     *path_reversed)
Tim Janik's avatar
Tim Janik committed
911 912 913 914 915
{
  GSList *slist;

  for (slist = pspec_list; slist; slist = slist->next)
    {
916
      PatternSpec *pspec;
Tim Janik's avatar
Tim Janik committed
917 918

      pspec = slist->data;
919
      if (g_pattern_match (pspec->pspec, path_length, path, path_reversed))
Tim Janik's avatar
Tim Janik committed
920 921 922 923 924
	{
	  GtkBindingSet *binding_set;

	  binding_set = pspec->user_data;

925 926
	  if (gtk_binding_entry_activate (binding_set->current, object))
	    return TRUE;
Tim Janik's avatar
Tim Janik committed
927 928 929 930 931 932 933
	}
    }

  return FALSE;
}

static gint
934 935
gtk_binding_pattern_compare (gconstpointer new_pattern,
			     gconstpointer existing_pattern)
Tim Janik's avatar
Tim Janik committed
936
{
937 938
  register const PatternSpec *np  = new_pattern;
  register const PatternSpec *ep  = existing_pattern;
Tim Janik's avatar
Tim Janik committed
939

940 941 942 943 944
  /* walk the list as long as the existing patterns have
   * higher priorities.
   */

  return np->seq_id < ep->seq_id;
Tim Janik's avatar
Tim Janik committed
945 946
}

947 948 949 950
static GSList*
gtk_binding_entries_sort_patterns (GSList      *entries,
				   GtkPathType  path_id,
				   gboolean     is_release)
Tim Janik's avatar
Tim Janik committed
951 952
{
  GSList *patterns;
953
  GSList *tmp_list;
Tim Janik's avatar
Tim Janik committed
954 955

  patterns = NULL;
956 957 958 959 960 961 962 963 964
  for (tmp_list = entries; tmp_list; tmp_list = tmp_list->next)
    {
      GtkBindingEntry *entry = tmp_list->data;
      GtkBindingSet *binding_set;

      binding_set = entry->binding_set;
      binding_set->current = NULL;
    }
  
965
  for (; entries; entries = entries->next)
Tim Janik's avatar
Tim Janik committed
966
    {
967 968
      GtkBindingEntry *entry = entries->data;
      GtkBindingSet *binding_set;
Tim Janik's avatar
Tim Janik committed
969 970
      GSList *slist = NULL;

971 972 973 974
      if (is_release != ((entry->modifiers & GDK_RELEASE_MASK) != 0))
	continue;

      binding_set = entry->binding_set;
975 976 977

      if (binding_set->current)
	continue;
978
      binding_set->current = entry;
Tim Janik's avatar
Tim Janik committed
979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994

      switch (path_id)
	{
	case GTK_PATH_WIDGET:
	  slist = binding_set->widget_path_pspecs;
	  break;
	case GTK_PATH_WIDGET_CLASS:
	  slist = binding_set->widget_class_pspecs;
	  break;
	case GTK_PATH_CLASS:
	  slist = binding_set->class_branch_pspecs;
	  break;
	}

      for (; slist; slist = slist->next)
	{
995
	  PatternSpec *pspec;
Tim Janik's avatar
Tim Janik committed
996 997 998 999 1000 1001 1002 1003 1004

	  pspec = slist->data;
	  patterns = g_slist_insert_sorted (patterns, pspec, gtk_binding_pattern_compare);
	}
    }

  return patterns;
}

1005 1006 1007 1008
static gboolean
gtk_bindings_activate_list (GtkObject *object,
			    GSList    *entries,
			    gboolean   is_release)
Tim Janik's avatar
Tim Janik committed
1009
{
1010
  GtkWidget *widget = GTK_WIDGET (object);
Tim Janik's avatar
Tim Janik committed
1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
  gboolean handled = FALSE;

  if (!entries)
    return FALSE;

  if (!handled)
    {
      guint path_length;
      gchar *path, *path_reversed;
      GSList *patterns;

      gtk_widget_path (widget, &path_length, &path, &path_reversed);
1023
      patterns = gtk_binding_entries_sort_patterns (entries, GTK_PATH_WIDGET, is_release);
Tim Janik's avatar
Tim Janik committed
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
      handled = binding_match_activate (patterns, object, path_length, path, path_reversed);
      g_slist_free (patterns);
      g_free (path);
      g_free (path_reversed);
    }

  if (!handled)
    {
      guint path_length;
      gchar *path, *path_reversed;
      GSList *patterns;

      gtk_widget_class_path (widget, &path_length, &path, &path_reversed);
1037
      patterns = gtk_binding_entries_sort_patterns (entries, GTK_PATH_WIDGET_CLASS, is_release);
Tim Janik's avatar
Tim Janik committed
1038 1039 1040 1041 1042 1043 1044 1045 1046
      handled = binding_match_activate (patterns, object, path_length, path, path_reversed);
      g_slist_free (patterns);
      g_free (path);
      g_free (path_reversed);
    }

  if (!handled)
    {
      GSList *patterns;
Manish Singh's avatar
Manish Singh committed
1047
      GType class_type;
Tim Janik's avatar
Tim Janik committed
1048
      
1049
      patterns = gtk_binding_entries_sort_patterns (entries, GTK_PATH_CLASS, is_release);
Manish Singh's avatar
Manish Singh committed
1050
      class_type = G_TYPE_FROM_INSTANCE (object);
Tim Janik's avatar
Tim Janik committed
1051 1052 1053
      while (class_type && !handled)
	{
	  guint path_length;
Owen Taylor's avatar
Owen Taylor committed
1054 1055
	  const gchar *path;
	  gchar *path_reversed;
Tim Janik's avatar
Tim Janik committed
1056
	  
Manish Singh's avatar
Manish Singh committed
1057
	  path = g_type_name (class_type);
Tim Janik's avatar
Tim Janik committed
1058 1059 1060 1061 1062 1063
	  path_reversed = g_strdup (path);
	  g_strreverse (path_reversed);
	  path_length = strlen (path);
	  handled = binding_match_activate (patterns, object, path_length, path, path_reversed);
	  g_free (path_reversed);

Manish Singh's avatar
Manish Singh committed
1064
	  class_type = g_type_parent (class_type);
Tim Janik's avatar
Tim Janik committed
1065 1066 1067 1068 1069 1070 1071
	}
      g_slist_free (patterns);
    }

  return handled;
}

1072 1073 1074 1075 1076 1077
gboolean
gtk_bindings_activate (GtkObject      *object,
		       guint	       keyval,
		       GdkModifierType modifiers)
{
  GSList *entries = NULL;
1078
  GdkDisplay *display;
1079 1080 1081 1082 1083 1084 1085 1086 1087
  GtkKeyHash *key_hash;
  gboolean handled = FALSE;
  gboolean is_release;

  g_return_val_if_fail (GTK_IS_OBJECT (object), FALSE);

  if (!GTK_IS_WIDGET (object))
    return FALSE;

1088
  is_release = (modifiers & GDK_RELEASE_MASK) != 0;
1089 1090
  modifiers = modifiers & BINDING_MOD_MASK () & ~GDK_RELEASE_MASK;

1091 1092 1093
  display = gtk_widget_get_display (GTK_WIDGET (object));
  key_hash = binding_key_hash_for_keymap (gdk_keymap_get_for_display (display));
  
1094 1095 1096 1097 1098 1099 1100 1101 1102 1103
  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;
}

/**
1104
 * gtk_bindings_activate_event:
1105 1106 1107 1108 1109 1110 1111 1112 1113
 * @object: a #GtkObject (generally must be a widget)
 * @event: a #GdkEventKey
 * 
 * Looks up key bindings for @object to find one matching
 * @event, and if one was found, activate it.
 * 
 * Return value: %TRUE if a matching key binding was found
 **/
gboolean
1114 1115
gtk_bindings_activate_event (GtkObject      *object,
                             GdkEventKey    *event)
1116 1117
{
  GSList *entries = NULL;
1118
  GdkDisplay *display;
1119 1120 1121 1122 1123 1124 1125 1126
  GtkKeyHash *key_hash;
  gboolean handled = FALSE;

  g_return_val_if_fail (GTK_IS_OBJECT (object), FALSE);

  if (!GTK_IS_WIDGET (object))
    return FALSE;

1127 1128 1129
  display = gtk_widget_get_display (GTK_WIDGET (object));
  key_hash = binding_key_hash_for_keymap (gdk_keymap_get_for_display (display));

1130 1131
  entries = _gtk_key_hash_lookup (key_hash,
				  event->hardware_keycode,
1132 1133
				  event->state,
				  BINDING_MOD_MASK () & ~GDK_RELEASE_MASK,
1134 1135 1136 1137 1138 1139 1140 1141 1142 1143
				  event->group);
  
  handled = gtk_bindings_activate_list (object, entries,
					event->type == GDK_KEY_RELEASE);

  g_slist_free (entries);

  return handled;
}

1144 1145 1146 1147
static guint
gtk_binding_parse_signal (GScanner       *scanner,
			  GtkBindingSet  *binding_set,
			  guint		  keyval,
1148
			  GdkModifierType modifiers)
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
{
  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
    {
      if (need_arg)
	expected_token = G_TOKEN_INT;
      else
	expected_token = ')';
      g_scanner_get_next_token (scanner);
      switch (scanner->token)
	{
	  GtkBindingArg *arg;

	case G_TOKEN_FLOAT:
	  if (need_arg)
	    {
	      need_arg = FALSE;
	      arg = g_new (GtkBindingArg, 1);
Manish Singh's avatar
Manish Singh committed
1195
	      arg->arg_type = G_TYPE_DOUBLE;
1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211
	      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);
Manish Singh's avatar
Manish Singh committed
1212
	      arg->arg_type = G_TYPE_LONG;
1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228
	      arg->d.long_data = scanner->value.v_int;
	      if (negate)
		{
		  arg->d.long_data = - arg->d.long_data;
		  negate