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

#include <string.h>

23 24
#include "gtkcelllayout.h"
#include "gtkcellrenderertext.h"
25 26 27
#include "gtkentry.h"
#include "gtkfilechooserentry.h"

28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
typedef struct _GtkFileChooserEntryClass GtkFileChooserEntryClass;

#define GTK_FILE_CHOOSER_ENTRY_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_FILE_CHOOSER_ENTRY, GtkFileChooserEntryClass))
#define GTK_IS_FILE_CHOOSER_ENTRY_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_FILE_CHOOSER_ENTRY))
#define GTK_FILE_CHOOSER_ENTRY_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_FILE_CHOOSER_ENTRY, GtkFileChooserEntryClass))

struct _GtkFileChooserEntryClass
{
  GtkEntryClass parent_class;
};

struct _GtkFileChooserEntry
{
  GtkEntry parent_instance;

  GtkFileSystem *file_system;
44 45
  GtkFilePath *base_folder;
  GtkFilePath *current_folder_path;
46 47 48 49 50
  gchar *file_part;
  GSource *completion_idle;

  GtkFileFolder *current_folder;

51 52
  GtkListStore *completion_store;

53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
  guint in_change : 1;
  guint has_completion : 1;
};

static void gtk_file_chooser_entry_class_init (GtkFileChooserEntryClass *class);
static void gtk_file_chooser_entry_iface_init (GtkEditableClass         *iface);
static void gtk_file_chooser_entry_init       (GtkFileChooserEntry      *chooser_entry);

static void     gtk_file_chooser_entry_finalize       (GObject          *object);
static gboolean gtk_file_chooser_entry_focus          (GtkWidget        *widget,
						       GtkDirectionType  direction);
static void     gtk_file_chooser_entry_changed        (GtkEditable      *editable);
static void     gtk_file_chooser_entry_do_insert_text (GtkEditable      *editable,
						       const gchar      *new_text,
						       gint              new_text_length,
						       gint             *position);

static void clear_completion_callback (GtkFileChooserEntry *chooser_entry,
				       GParamSpec          *pspec);

73 74 75 76 77
static gboolean completion_match_func (GtkEntryCompletion *comp,
				       const char         *key,
				       GtkTreeIter        *iter,
				       gpointer            data);

Owen Taylor's avatar
Owen Taylor committed
78 79
static GObjectClass *parent_class;
static GtkEditableClass *parent_editable_iface;
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 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

GType
_gtk_file_chooser_entry_get_type (void)
{
  static GType file_chooser_entry_type = 0;

  if (!file_chooser_entry_type)
    {
      static const GTypeInfo file_chooser_entry_info =
      {
	sizeof (GtkFileChooserEntryClass),
	NULL,		/* base_init */
	NULL,		/* base_finalize */
	(GClassInitFunc) gtk_file_chooser_entry_class_init,
	NULL,		/* class_finalize */
	NULL,		/* class_data */
	sizeof (GtkFileChooserEntry),
	0,		/* n_preallocs */
	(GInstanceInitFunc) gtk_file_chooser_entry_init,
      };

      static const GInterfaceInfo editable_info =
      {
	(GInterfaceInitFunc) gtk_file_chooser_entry_iface_init, /* interface_init */
	NULL,			                              /* interface_finalize */
	NULL			                              /* interface_data */
      };

      
      file_chooser_entry_type = g_type_register_static (GTK_TYPE_ENTRY, "GtkFileChooserEntry",
							&file_chooser_entry_info, 0);
      g_type_add_interface_static (file_chooser_entry_type,
				   GTK_TYPE_EDITABLE,
				   &editable_info);
    }


  return file_chooser_entry_type;
}

static void
gtk_file_chooser_entry_class_init (GtkFileChooserEntryClass *class)
{
  GObjectClass *gobject_class = G_OBJECT_CLASS (class);
  GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);

  parent_class = g_type_class_peek_parent (class);

  gobject_class->finalize = gtk_file_chooser_entry_finalize;

  widget_class->focus = gtk_file_chooser_entry_focus;
}

static void
gtk_file_chooser_entry_iface_init (GtkEditableClass *iface)
{
  parent_editable_iface = g_type_interface_peek_parent (iface);

  iface->do_insert_text = gtk_file_chooser_entry_do_insert_text;
  iface->changed = gtk_file_chooser_entry_changed;
}

static void
gtk_file_chooser_entry_init (GtkFileChooserEntry *chooser_entry)
{
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
  GtkEntryCompletion *comp;
  GtkCellRenderer *renderer;

  chooser_entry->completion_store = gtk_list_store_new (1, G_TYPE_STRING);

  comp = gtk_entry_completion_new ();
  gtk_entry_completion_set_model (comp, GTK_TREE_MODEL (chooser_entry->completion_store));
  gtk_entry_completion_set_match_func (comp,
				       completion_match_func,
				       chooser_entry,
				       NULL);

  renderer = gtk_cell_renderer_text_new ();
  gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (comp), renderer, TRUE);
  gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT (comp), renderer, "text", 0);

  gtk_entry_set_completion (GTK_ENTRY (chooser_entry), comp);

163 164 165 166 167 168 169 170 171 172 173
  g_signal_connect (chooser_entry, "notify::cursor-position",
		    G_CALLBACK (clear_completion_callback), NULL);
  g_signal_connect (chooser_entry, "notify::selection-bound",
		    G_CALLBACK (clear_completion_callback), NULL);
}

static void
gtk_file_chooser_entry_finalize (GObject *object)
{
  GtkFileChooserEntry *chooser_entry = GTK_FILE_CHOOSER_ENTRY (object);

174 175 176
  if (chooser_entry->completion_store)
    g_object_unref (chooser_entry->completion_store);

177 178 179 180 181 182
  if (chooser_entry->current_folder)
    g_object_unref (chooser_entry->current_folder);
  
  if (chooser_entry->file_system)
    g_object_unref (chooser_entry->file_system);
  
183 184
  gtk_file_path_free (chooser_entry->base_folder);
  gtk_file_path_free (chooser_entry->current_folder_path);
185 186 187 188 189
  g_free (chooser_entry->file_part);

  parent_class->finalize (object);
}

190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 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
/* Match function for the GtkEntryCompletion */
static gboolean
completion_match_func (GtkEntryCompletion *comp,
		       const char         *key,
		       GtkTreeIter        *iter,
		       gpointer            data)
{
  GtkFileChooserEntry *chooser_entry;
  char *name;
  gboolean result;

  chooser_entry = GTK_FILE_CHOOSER_ENTRY (data);

  gtk_tree_model_get (GTK_TREE_MODEL (chooser_entry->completion_store), iter, 0, &name, -1);
  if (!name)
    return FALSE; /* Uninitialized row, ugh */

  /* We ignore the key because it is the contents of the entry.  Instead, we
   * just use our precomputed file_part.
   */

  if (chooser_entry->file_part)
    {
      char *norm_file_part;
      char *norm_name;

      norm_file_part = g_utf8_normalize (chooser_entry->file_part, -1, G_NORMALIZE_ALL);
      norm_name = g_utf8_normalize (name, -1, G_NORMALIZE_ALL);

      result = (strncmp (norm_file_part, norm_name, strlen (norm_file_part)) == 0);

      /* FIXME: Owen suggests first doing a case-folded comparison, then a
       * non-case-folded one if the first one yielded more than one match.
       */

      g_free (norm_file_part);
      g_free (norm_name);
    }
  else
    result = FALSE;
  

  result = (strncmp (key, name, strlen (key)) == 0);

  g_free (name);
  return result;
}

238 239 240 241
static gboolean
completion_idle_callback (GtkFileChooserEntry *chooser_entry)
{
  GtkEditable *editable = GTK_EDITABLE (chooser_entry);
242
  GSList *child_paths = NULL;
243 244
  GSList *tmp_list;
  gchar *common_prefix = NULL;
245
  GtkFilePath *unique_path = NULL;
246

247 248
  g_print ("completion_idle_callback()\n");

249 250
  chooser_entry->completion_idle = NULL;

251 252 253
  if (strcmp (chooser_entry->file_part, "") == 0)
    return FALSE;

254 255
  if (!chooser_entry->current_folder &&
      chooser_entry->file_system &&
256
      chooser_entry->current_folder_path)
257
    chooser_entry->current_folder = gtk_file_system_get_folder (chooser_entry->file_system,
258
								chooser_entry->current_folder_path,
259 260 261 262
								GTK_FILE_INFO_DISPLAY_NAME | GTK_FILE_INFO_IS_FOLDER,
								NULL); /* NULL-GError */
  if (chooser_entry->current_folder)
    gtk_file_folder_list_children (chooser_entry->current_folder,
263
				   &child_paths,
264
				   NULL); /* NULL-GError */
Owen Taylor's avatar
Owen Taylor committed
265

266 267 268 269
  chooser_entry->in_change = TRUE;
  g_print ("Clearing list and filling it\n");
  gtk_list_store_clear (chooser_entry->completion_store);

270
  for (tmp_list = child_paths; tmp_list; tmp_list = tmp_list->next)
271 272
    {
      GtkFileInfo *info;
273 274 275
      GtkFilePath *path;

      path = tmp_list->data;
276 277
      
      info = gtk_file_folder_get_info (chooser_entry->current_folder,
278
				       path,
279 280 281 282
				       NULL); /* NULL-GError */
      if (info)
	{
	  const gchar *display_name = gtk_file_info_get_display_name (info);
283 284 285 286 287 288 289
	  GtkTreeIter iter;

	  gtk_list_store_append (chooser_entry->completion_store, &iter);
	  gtk_list_store_set (chooser_entry->completion_store, &iter,
			      0, display_name,
			      -1);

290 291 292 293 294
	  if (g_str_has_prefix (display_name, chooser_entry->file_part))
	    {
	      if (!common_prefix)
		{
		  common_prefix = g_strdup (display_name);
295
		  unique_path = gtk_file_path_copy (path);
296 297 298 299 300 301 302 303 304 305 306 307 308 309
		}
	      else
		{
		  gchar *p = common_prefix;
		  const gchar *q = display_name;
		  
		  while (*p && *p == *q)
		    {
		      p++;
		      q++;
		    }
		  
		  *p = '\0';

310 311
		  gtk_file_path_free (unique_path);
		  unique_path = NULL;
312 313 314 315 316 317
		}
	    }
	  
	  gtk_file_info_free (info);
	}
    }
318 319
  g_print ("List filled\n");
  chooser_entry->in_change = FALSE;
320

321
  if (unique_path)
322 323 324 325
    {
      GtkFileInfo *info;
	    
      info = gtk_file_folder_get_info (chooser_entry->current_folder,
326
				       unique_path,
327 328 329 330 331 332 333 334 335 336 337 338 339 340
				       NULL); /* NULL-GError */

      if (info)
	{
	  if (gtk_file_info_get_is_folder (info))
	    {
	      gchar *tmp = common_prefix;
	      common_prefix = g_strconcat (tmp, "/", NULL);
	      g_free (tmp);
	    }
	  
	  gtk_file_info_free (info);
	}

341
      gtk_file_path_free (unique_path);
342 343
    }
  
344
  gtk_file_paths_free (child_paths);
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387

  if (common_prefix)
    {
      gint total_len;
      gint file_part_len;
      gint common_prefix_len;
      gint pos;

      total_len = g_utf8_strlen (gtk_entry_get_text (GTK_ENTRY (chooser_entry)), -1);
      file_part_len = g_utf8_strlen (chooser_entry->file_part, -1);
      common_prefix_len = g_utf8_strlen (common_prefix, -1);

      if (common_prefix_len > file_part_len)
	{
	  chooser_entry->in_change = TRUE;
	  
	  pos = total_len - file_part_len;
	  gtk_editable_delete_text (editable,
				    pos, -1);
	  gtk_editable_insert_text (editable,
				    common_prefix, -1, 
				    &pos);
	  gtk_editable_select_region (editable,
				      total_len,
				      total_len - file_part_len + common_prefix_len);
	  
	  chooser_entry->in_change = FALSE;
	  chooser_entry->has_completion = TRUE;
	}
	  
      g_free (common_prefix);
    }
  
  return FALSE;
}

static void
gtk_file_chooser_entry_do_insert_text (GtkEditable *editable,
				       const gchar *new_text,
				       gint         new_text_length,
				       gint        *position)
{
  GtkFileChooserEntry *chooser_entry = GTK_FILE_CHOOSER_ENTRY (editable);
388 389 390 391 392
  char *tmp;

  tmp = g_strndup (new_text, new_text_length);
  g_print ("gtk_file_chooser_entry_do_insert_text (%s)\n", tmp);
  g_free (tmp);
393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431
  
  parent_editable_iface->do_insert_text (editable, new_text, new_text_length, position);

  if (!chooser_entry->in_change &&
      *position == GTK_ENTRY (editable)->text_length &&
      !chooser_entry->completion_idle)
    {
      chooser_entry->completion_idle = g_idle_source_new ();
      g_source_set_priority (chooser_entry->completion_idle, G_PRIORITY_HIGH);
      g_source_set_closure (chooser_entry->completion_idle,
			    g_cclosure_new_object (G_CALLBACK (completion_idle_callback),
						   G_OBJECT (chooser_entry)));
      g_source_attach (chooser_entry->completion_idle, NULL);
    }
}

static gboolean
gtk_file_chooser_entry_focus (GtkWidget        *widget,
			      GtkDirectionType  direction)
{
  GtkFileChooserEntry *chooser_entry = GTK_FILE_CHOOSER_ENTRY (widget);
  
  if (direction == GTK_DIR_TAB_FORWARD &&
      GTK_WIDGET_HAS_FOCUS (widget) &&
      chooser_entry->has_completion)
    {
      gtk_editable_set_position (GTK_EDITABLE (widget),
				 GTK_ENTRY (widget)->text_length);
      return TRUE;
    }
  else
    return GTK_WIDGET_CLASS (parent_class)->focus (widget, direction);
}

static void
gtk_file_chooser_entry_changed (GtkEditable *editable)
{
  GtkFileChooserEntry *chooser_entry = GTK_FILE_CHOOSER_ENTRY (editable);
  const gchar *text;
432
  GtkFilePath *folder_path;
433 434
  gchar *file_part;

435 436
  g_print ("gtk_file_chooser_entry_changed ()\n");

437 438 439 440 441 442
  text = gtk_entry_get_text (GTK_ENTRY (editable));

  if (!chooser_entry->file_system ||
      !chooser_entry->base_folder ||
      !gtk_file_system_parse (chooser_entry->file_system,
			      chooser_entry->base_folder, text,
443
			      &folder_path, &file_part, NULL)) /* NULL-GError */
444
    {
445
      folder_path = gtk_file_path_copy (chooser_entry->base_folder);
446 447 448
      file_part = g_strdup ("");
    }

449
  if (chooser_entry->current_folder_path)
450
    {
451
      if (gtk_file_path_compare (folder_path, chooser_entry->current_folder_path) != 0)
452
	{
453 454 455 456 457
	  if (chooser_entry->current_folder)
	    {
	      g_object_unref (chooser_entry->current_folder);
	      chooser_entry->current_folder = NULL;
	    }
458
	}
459 460
      
      gtk_file_path_free (chooser_entry->current_folder_path);
461 462
    }
  
463
  chooser_entry->current_folder_path = folder_path;
464 465 466 467 468 469 470 471 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

  if (chooser_entry->file_part)
    g_free (chooser_entry->file_part);

  chooser_entry->file_part = file_part;
}

static void
clear_completion_callback (GtkFileChooserEntry *chooser_entry,
			   GParamSpec          *pspec)
{
  chooser_entry->has_completion = FALSE;
}

/**
 * _gtk_file_chooser_entry_new:
 * 
 * Creates a new #GtkFileChooserEntry object. #GtkFileChooserEntry
 * is an internal implementation widget for the GTK+ file chooser
 * which is an entry with completion with respect to a
 * #GtkFileSystem object.
 * 
 * Return value: the newly created #GtkFileChooserEntry
 **/
GtkWidget *
_gtk_file_chooser_entry_new (void)
{
  return g_object_new (GTK_TYPE_FILE_CHOOSER_ENTRY, NULL);
}

/**
 * _gtk_file_chooser_entry_set_file_system:
 * @chooser_entry: a #GtkFileChooser
 * @file_system: an object implementing #GtkFileSystem
 * 
 * Sets the file system for @chooser_entry.
 **/
void
_gtk_file_chooser_entry_set_file_system (GtkFileChooserEntry *chooser_entry,
					 GtkFileSystem       *file_system)
{
  g_return_if_fail (GTK_IS_FILE_CHOOSER_ENTRY (chooser_entry));
  g_return_if_fail (GTK_IS_FILE_SYSTEM (file_system));
  
  if (file_system != chooser_entry->file_system)
    {
      if (chooser_entry->file_system)
	g_object_unref (chooser_entry->file_system);

      chooser_entry->file_system = g_object_ref (file_system);
    }
}

/**
 * _gtk_file_chooser_entry_set_base_folder:
 * @chooser_entry: a #GtkFileChooserEntry
520
 * @path: path of a folder in the chooser entries current file system.
521 522 523 524 525
 *
 * Sets the folder with respect to which completions occur.
 **/
void
_gtk_file_chooser_entry_set_base_folder (GtkFileChooserEntry *chooser_entry,
526
					 const GtkFilePath   *path)
527 528
{
  if (chooser_entry->base_folder)
529
    gtk_file_path_free (chooser_entry->base_folder);
530

531
  chooser_entry->base_folder = gtk_file_path_copy (path);
532
  gtk_file_chooser_entry_changed (GTK_EDITABLE (chooser_entry));
533 534 535 536 537 538 539 540 541 542 543 544 545 546
}

/**
 * _gtk_file_chooser_entry_get_current_folder:
 * @chooser_entry: a #GtkFileChooserEntry
 * 
 * Gets the current folder for the #GtkFileChooserEntry. If the
 * user has only entered a filename, this will be the base folder
 * (see _gtk_file_chooser_entry_set_base_folder()), but if the
 * user has entered a relative or absolute path, then it will
 * be different. If the user has entered a relative or absolute
 * path that doesn't point to a folder in the file system, it will
 * be %NULL.
 * 
547
 * Return value: the path of current folder - this value is owned by the
548 549
 *  chooser entry and must not be modified or freed.
 **/
550
const GtkFilePath *
551 552
_gtk_file_chooser_entry_get_current_folder (GtkFileChooserEntry *chooser_entry)
{
553
  return chooser_entry->current_folder_path;
554 555 556 557 558 559 560 561
}

/**
 * _gtk_file_chooser_entry_get_file_part:
 * @chooser_entry: a #GtkFileChooserEntry
 * 
 * Gets the non-folder portion of whatever the user has entered
 * into the file selector. What is returned is a UTF-8 string,
562
 * and if a filename path is needed, gtk_file_system_make_path()
563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590
 * must be used
  * 
 * Return value: the entered filename - this value is owned by the
 *  chooser entry and must not be modified or freed.
 **/
const gchar *
_gtk_file_chooser_entry_get_file_part (GtkFileChooserEntry *chooser_entry)
{
  return chooser_entry->file_part;
}

/**
 * _gtk_file_chooser_entry_set_file_part:
 * @chooser_entry: a #GtkFileChooserEntry
 * @file_part: text to display in the entry, in UTF-8
 * 
 * Sets the current text shown in the file chooser entry.
 **/
void
_gtk_file_chooser_entry_set_file_part (GtkFileChooserEntry *chooser_entry,
				       const gchar         *file_part)
{
  g_return_if_fail (GTK_IS_FILE_CHOOSER_ENTRY (chooser_entry));

  chooser_entry->in_change = TRUE;
  gtk_entry_set_text (GTK_ENTRY (chooser_entry), file_part);
  chooser_entry->in_change = FALSE;
}