gtkfilechooserentry.c 32.3 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
2 3 4 5 6 7 8 9 10 11 12 13 14 15
 * 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
Javier Jardón's avatar
Javier Jardón committed
16
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
17 18
 */

19
#include "config.h"
20 21 22

#include "gtkfilechooserentry.h"

23 24
#include <string.h>

25 26
#include "gtkcelllayout.h"
#include "gtkcellrenderertext.h"
27
#include "gtkentry.h"
28
#include "gtkfilesystemmodel.h"
29
#include "gtklabel.h"
30
#include "gtkmain.h"
31
#include "gtksizerequest.h"
32
#include "gtkwindow.h"
33
#include "gtkintl.h"
34
#include "gtkmarshalers.h"
35
#include "gtkfilefilterprivate.h"
36

37 38 39 40 41 42 43 44 45 46 47 48 49 50 51
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;

52 53
  GtkFileChooserAction action;

54 55
  GFile *base_folder;
  GFile *current_folder_file;
56
  gchar *dir_part;
57 58
  gchar *file_part;

59
  GtkTreeModel *completion_store;
60
  GtkFileFilter *current_filter;
61

62
  guint current_folder_loaded : 1;
63
  guint complete_on_load : 1;
64
  guint eat_tabs       : 1;
65
  guint eat_escape     : 1;
66
  guint local_only     : 1;
67 68
};

69 70 71
enum
{
  DISPLAY_NAME_COLUMN,
72
  FULL_PATH_COLUMN,
73 74 75
  N_COLUMNS
};

76 77 78 79 80 81 82 83
enum
{
  HIDE_ENTRY,
  LAST_SIGNAL
};

static guint signals[LAST_SIGNAL] = { 0 };

84
static void     gtk_file_chooser_entry_finalize       (GObject          *object);
85
static void     gtk_file_chooser_entry_dispose        (GObject          *object);
86
static void     gtk_file_chooser_entry_grab_focus     (GtkWidget        *widget);
87 88
static gboolean gtk_file_chooser_entry_tab_handler    (GtkWidget *widget,
						       GdkEventKey *event);
89 90
static gboolean gtk_file_chooser_entry_focus_out_event (GtkWidget       *widget,
							GdkEventFocus   *event);
91 92 93 94 95 96 97 98 99 100 101 102 103

#ifdef G_OS_WIN32
static gint     insert_text_callback      (GtkFileChooserEntry *widget,
					   const gchar         *new_text,
					   gint                 new_text_length,
					   gint                *position,
					   gpointer             user_data);
static void     delete_text_callback      (GtkFileChooserEntry *widget,
					   gint                 start_pos,
					   gint                 end_pos,
					   gpointer             user_data);
#endif

104 105 106 107
static gboolean match_selected_callback   (GtkEntryCompletion  *completion,
					   GtkTreeModel        *model,
					   GtkTreeIter         *iter,
					   GtkFileChooserEntry *chooser_entry);
108

109 110
static void set_complete_on_load (GtkFileChooserEntry *chooser_entry,
                                  gboolean             complete_on_load);
111
static void refresh_current_folder_and_file_part (GtkFileChooserEntry *chooser_entry);
112
static void set_completion_folder (GtkFileChooserEntry *chooser_entry,
113 114
                                   GFile               *folder,
				   char                *dir_part);
115 116 117
static void finished_loading_cb (GtkFileSystemModel  *model,
                                 GError              *error,
		                 GtkFileChooserEntry *chooser_entry);
118

119 120
G_DEFINE_TYPE (GtkFileChooserEntry, _gtk_file_chooser_entry, GTK_TYPE_ENTRY)

121 122 123 124 125 126 127 128 129 130
static char *
gtk_file_chooser_entry_get_completion_text (GtkFileChooserEntry *chooser_entry)
{
  GtkEditable *editable = GTK_EDITABLE (chooser_entry);
  int start, end;

  gtk_editable_get_selection_bounds (editable, &start, &end);
  return gtk_editable_get_chars (editable, 0, MIN (start, end));
}

131 132 133 134 135 136 137 138 139 140
static void
gtk_file_chooser_entry_dispatch_properties_changed (GObject     *object,
                                                    guint        n_pspecs,
                                                    GParamSpec **pspecs)
{
  GtkFileChooserEntry *chooser_entry = GTK_FILE_CHOOSER_ENTRY (object);
  guint i;

  G_OBJECT_CLASS (_gtk_file_chooser_entry_parent_class)->dispatch_properties_changed (object, n_pspecs, pspecs);

141 142
  /* Don't do this during or after disposal */
  if (gtk_widget_get_parent (GTK_WIDGET (object)) != NULL)
143
    {
144 145 146 147
      /* What we are after: The text in front of the cursor was modified.
       * Unfortunately, there's no other way to catch this.
       */
      for (i = 0; i < n_pspecs; i++)
148
        {
149 150 151 152 153 154 155 156
          if (pspecs[i]->name == I_("cursor-position") ||
              pspecs[i]->name == I_("selection-bound") ||
              pspecs[i]->name == I_("text"))
            {
              set_complete_on_load (chooser_entry, FALSE);
              refresh_current_folder_and_file_part (chooser_entry);
              break;
            }
157 158 159
        }
    }
}
160 161

static void
Matthias Clasen's avatar
Matthias Clasen committed
162
_gtk_file_chooser_entry_class_init (GtkFileChooserEntryClass *class)
163 164 165 166 167
{
  GObjectClass *gobject_class = G_OBJECT_CLASS (class);
  GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);

  gobject_class->finalize = gtk_file_chooser_entry_finalize;
168
  gobject_class->dispose = gtk_file_chooser_entry_dispose;
169
  gobject_class->dispatch_properties_changed = gtk_file_chooser_entry_dispatch_properties_changed;
170

171
  widget_class->grab_focus = gtk_file_chooser_entry_grab_focus;
172
  widget_class->focus_out_event = gtk_file_chooser_entry_focus_out_event;
173 174 175 176 177 178 179

  signals[HIDE_ENTRY] =
    g_signal_new (I_("hide-entry"),
                  G_OBJECT_CLASS_TYPE (gobject_class),
                  G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
                  0,
                  NULL, NULL,
180
                  NULL,
181
                  G_TYPE_NONE, 0);
182 183
}

184 185 186 187 188 189 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
static gboolean
match_func (GtkEntryCompletion *compl,
            const gchar        *key,
            GtkTreeIter        *iter,
            gpointer            user_data)
{
  GtkFileChooserEntry *chooser_entry = user_data;

  /* If we arrive here, the GtkFileSystemModel's GtkFileFilter already filtered out all
   * files that don't start with the current prefix, so we manually apply the GtkFileChooser's
   * current file filter (e.g. just jpg files) here. */
  if (chooser_entry->current_filter != NULL)
    {
      char *mime_type = NULL;
      gboolean matches;
      GFile *file;
      GFileInfo *file_info;
      GtkFileFilterInfo filter_info;
      GtkFileFilterFlags needed_flags;

      file = _gtk_file_system_model_get_file (GTK_FILE_SYSTEM_MODEL (chooser_entry->completion_store),
                                              iter);
      file_info = _gtk_file_system_model_get_info (GTK_FILE_SYSTEM_MODEL (chooser_entry->completion_store),
                                                   iter);

      /* We always allow navigating into subfolders, so don't ever filter directories */
      if (g_file_info_get_file_type (file_info) != G_FILE_TYPE_REGULAR)
        return TRUE;

      needed_flags = gtk_file_filter_get_needed (chooser_entry->current_filter);

      filter_info.display_name = g_file_info_get_display_name (file_info);
216
      filter_info.contains = GTK_FILE_FILTER_DISPLAY_NAME;
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 247 248 249 250 251 252 253 254 255 256 257 258 259 260

      if (needed_flags & GTK_FILE_FILTER_MIME_TYPE)
        {
          const char *s = g_file_info_get_content_type (file_info);
          if (s != NULL)
            {
              mime_type = g_content_type_get_mime_type (s);
              if (mime_type != NULL)
                {
                  filter_info.mime_type = mime_type;
                  filter_info.contains |= GTK_FILE_FILTER_MIME_TYPE;
                }
            }
        }

      if (needed_flags & GTK_FILE_FILTER_FILENAME)
        {
          const char *path = g_file_get_path (file);
          if (path != NULL)
            {
              filter_info.filename = path;
              filter_info.contains |= GTK_FILE_FILTER_FILENAME;
            }
        }

      if (needed_flags & GTK_FILE_FILTER_URI)
        {
          const char *uri = g_file_get_uri (file);
          if (uri)
            {
              filter_info.uri = uri;
              filter_info.contains |= GTK_FILE_FILTER_URI;
            }
        }

      matches = gtk_file_filter_filter (chooser_entry->current_filter, &filter_info);

      g_free (mime_type);
      return matches;
    }

  return TRUE;
}

261
static void
Matthias Clasen's avatar
Matthias Clasen committed
262
_gtk_file_chooser_entry_init (GtkFileChooserEntry *chooser_entry)
263
{
264
  GtkEntryCompletion *comp;
265
  GtkCellRenderer *cell;
266

267 268
  chooser_entry->local_only = TRUE;

269 270
  g_object_set (chooser_entry, "truncate-multiline", TRUE, NULL);

271
  comp = gtk_entry_completion_new ();
272
  gtk_entry_completion_set_popup_single_match (comp, FALSE);
273
  gtk_entry_completion_set_minimum_key_length (comp, 0);
274 275
  /* see docs for gtk_entry_completion_set_text_column() */
  g_object_set (comp, "text-column", FULL_PATH_COLUMN, NULL);
276

277 278
  /* Need a match func here or entry completion uses a wrong one.
   * We do our own filtering after all. */
279
  gtk_entry_completion_set_match_func (comp,
280 281 282
                                       match_func,
                                       chooser_entry,
                                       NULL);
283 284 285 286 287 288

  cell = gtk_cell_renderer_text_new ();
  gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (comp),
                              cell, TRUE);
  gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT (comp),
                                 cell,
289
                                 "text", DISPLAY_NAME_COLUMN);
290

291
  g_signal_connect (comp, "match-selected",
292
		    G_CALLBACK (match_selected_callback), chooser_entry);
293 294

  gtk_entry_set_completion (GTK_ENTRY (chooser_entry), comp);
295
  g_object_unref (comp);
296 297 298 299
  /* NB: This needs to happen after the completion is set, so this handler
   * runs before the handler installed by entrycompletion */
  g_signal_connect (chooser_entry, "key-press-event",
                    G_CALLBACK (gtk_file_chooser_entry_tab_handler), NULL);
300

301
#ifdef G_OS_WIN32
302
  g_signal_connect (chooser_entry, "insert-text",
303
		    G_CALLBACK (insert_text_callback), NULL);
304
  g_signal_connect (chooser_entry, "delete-text",
305 306
		    G_CALLBACK (delete_text_callback), NULL);
#endif
307 308 309 310 311 312 313
}

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

314 315
  if (chooser_entry->base_folder)
    g_object_unref (chooser_entry->base_folder);
316 317 318 319

  if (chooser_entry->current_folder_file)
    g_object_unref (chooser_entry->current_folder_file);

320
  g_free (chooser_entry->dir_part);
321 322
  g_free (chooser_entry->file_part);

Matthias Clasen's avatar
Matthias Clasen committed
323
  G_OBJECT_CLASS (_gtk_file_chooser_entry_parent_class)->finalize (object);
324 325 326 327 328 329 330
}

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

331
  set_completion_folder (chooser_entry, NULL, NULL);
332

Matthias Clasen's avatar
Matthias Clasen committed
333
  G_OBJECT_CLASS (_gtk_file_chooser_entry_parent_class)->dispose (object);
334 335
}

336 337 338
/* Match functions for the GtkEntryCompletion */
static gboolean
match_selected_callback (GtkEntryCompletion  *completion,
339 340 341
                         GtkTreeModel        *model,
                         GtkTreeIter         *iter,
                         GtkFileChooserEntry *chooser_entry)
342
{
343
  char *path;
344 345
  gint pos;

346
  gtk_tree_model_get (model, iter,
347
                      FULL_PATH_COLUMN, &path,
348
                      -1);
349 350

  gtk_editable_delete_text (GTK_EDITABLE (chooser_entry),
351
                            0,
352
                            gtk_editable_get_position (GTK_EDITABLE (chooser_entry)));
353
  pos = 0;
354
  gtk_editable_insert_text (GTK_EDITABLE (chooser_entry),
355 356 357
                            path,
                            -1,
                            &pos);
358

359 360
  gtk_editable_set_position (GTK_EDITABLE (chooser_entry), pos);

361
  g_free (path);
362

363 364 365
  return TRUE;
}

366
static void
367 368
set_complete_on_load (GtkFileChooserEntry *chooser_entry,
                      gboolean             complete_on_load)
369
{
370
  /* a completion was triggered, but we couldn't do it.
Matthias Clasen's avatar
Matthias Clasen committed
371 372
   * So no text was inserted when pressing tab, so we beep
   */
373
  if (chooser_entry->complete_on_load && !complete_on_load)
374
    gtk_widget_error_bell (GTK_WIDGET (chooser_entry));
375 376

  chooser_entry->complete_on_load = complete_on_load;
377 378
}

379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
static gboolean
is_valid_scheme_character (char c)
{
  return g_ascii_isalnum (c) || c == '+' || c == '-' || c == '.';
}

static gboolean
has_uri_scheme (const char *str)
{
  const char *p;

  p = str;

  if (!is_valid_scheme_character (*p))
    return FALSE;

  do
    p++;
  while (is_valid_scheme_character (*p));

  return (strncmp (p, "://", 3) == 0);
}

402 403 404 405 406 407 408 409
static GFile *
gtk_file_chooser_get_file_for_text (GtkFileChooserEntry *chooser_entry,
                                    const gchar         *str)
{
  GFile *file;

  if (str[0] == '~' || g_path_is_absolute (str) || has_uri_scheme (str))
    file = g_file_parse_name (str);
410
  else if (chooser_entry->base_folder != NULL)
411
    file = g_file_resolve_relative_path (chooser_entry->base_folder, str);
412 413
  else
    file = NULL;
414 415 416 417

  return file;
}

418 419 420 421 422 423 424 425
static gboolean
is_directory_shortcut (const char *text)
{
  return strcmp (text, ".") == 0 ||
         strcmp (text, "..") == 0 ||
         strcmp (text, "~" ) == 0;
}

426 427 428 429 430 431 432 433
static GFile *
gtk_file_chooser_get_directory_for_text (GtkFileChooserEntry *chooser_entry,
                                         const char *         text)
{
  GFile *file, *parent;

  file = gtk_file_chooser_get_file_for_text (chooser_entry, text);

434 435 436
  if (file == NULL)
    return NULL;

437 438
  if (text[0] == 0 || text[strlen (text) - 1] == G_DIR_SEPARATOR ||
      is_directory_shortcut (text))
439 440 441 442 443 444 445 446
    return file;

  parent = g_file_get_parent (file);
  g_object_unref (file);

  return parent;
}

447 448 449
/* Finds a common prefix based on the contents of the entry
 * and mandatorily appends it
 */
450 451
static void
explicitly_complete (GtkFileChooserEntry *chooser_entry)
452
{
453
  chooser_entry->complete_on_load = FALSE;
454

455
  if (chooser_entry->completion_store)
456
    {
457 458
      char *completion, *text;
      gsize completion_len, text_len;
459

460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476
      text = gtk_file_chooser_entry_get_completion_text (chooser_entry);
      text_len = strlen (text);
      completion = gtk_entry_completion_compute_prefix (gtk_entry_get_completion (GTK_ENTRY (chooser_entry)), text);
      completion_len = completion ? strlen (completion) : 0;

      if (completion_len > text_len)
        {
          GtkEditable *editable = GTK_EDITABLE (chooser_entry);
          int pos = gtk_editable_get_position (editable);

          gtk_editable_insert_text (editable,
                                    completion + text_len,
                                    completion_len - text_len,
                                    &pos);
          gtk_editable_set_position (editable, pos);
          return;
        }
477
    }
478

479
  gtk_widget_error_bell (GTK_WIDGET (chooser_entry));
480 481
}

482 483 484 485 486 487 488
static void
gtk_file_chooser_entry_grab_focus (GtkWidget *widget)
{
  GTK_WIDGET_CLASS (_gtk_file_chooser_entry_parent_class)->grab_focus (widget);
  _gtk_file_chooser_entry_select_filename (GTK_FILE_CHOOSER_ENTRY (widget));
}

489 490 491
static void
start_explicit_completion (GtkFileChooserEntry *chooser_entry)
{
492 493 494
  if (chooser_entry->current_folder_loaded)
    explicitly_complete (chooser_entry);
  else
495
    set_complete_on_load (chooser_entry, TRUE);
496 497
}

498
static gboolean
499 500
gtk_file_chooser_entry_tab_handler (GtkWidget *widget,
				    GdkEventKey *event)
501
{
502 503
  GtkFileChooserEntry *chooser_entry;
  GtkEditable *editable;
504
  GdkModifierType state;
505
  gint start, end;
506 507 508

  chooser_entry = GTK_FILE_CHOOSER_ENTRY (widget);
  editable = GTK_EDITABLE (widget);
509

510 511 512 513 514 515 516
  if (event->keyval == GDK_KEY_Escape &&
      chooser_entry->eat_escape)
    {
      g_signal_emit (widget, signals[HIDE_ENTRY], 0);
      return TRUE;
    }

517
  if (!chooser_entry->eat_tabs)
518
    return FALSE;
519

520 521
  if (event->keyval != GDK_KEY_Tab)
    return FALSE;
522

523 524 525
  if (gtk_get_current_event_state (&state) &&
      (state & GDK_CONTROL_MASK) == GDK_CONTROL_MASK)
    return FALSE;
526 527 528

  /* This is a bit evil -- it makes Tab never leave the entry. It basically
   * makes it 'safe' for people to hit. */
529
  gtk_editable_get_selection_bounds (editable, &start, &end);
530
      
531 532 533 534
  if (start != end)
    gtk_editable_set_position (editable, MAX (start, end));
  else
    start_explicit_completion (chooser_entry);
535

536
  return TRUE;
537 538
}

539 540 541 542 543 544
static gboolean
gtk_file_chooser_entry_focus_out_event (GtkWidget     *widget,
					GdkEventFocus *event)
{
  GtkFileChooserEntry *chooser_entry = GTK_FILE_CHOOSER_ENTRY (widget);

545
  set_complete_on_load (chooser_entry, FALSE);
546 547 548 549
 
  return GTK_WIDGET_CLASS (_gtk_file_chooser_entry_parent_class)->focus_out_event (widget, event);
}

550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573
static void
update_inline_completion (GtkFileChooserEntry *chooser_entry)
{
  GtkEntryCompletion *completion = gtk_entry_get_completion (GTK_ENTRY (chooser_entry));

  if (!chooser_entry->current_folder_loaded)
    {
      gtk_entry_completion_set_inline_completion (completion, FALSE);
      return;
    }

  switch (chooser_entry->action)
    {
    case GTK_FILE_CHOOSER_ACTION_OPEN:
    case GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER:
      gtk_entry_completion_set_inline_completion (completion, TRUE);
      break;
    case GTK_FILE_CHOOSER_ACTION_SAVE:
    case GTK_FILE_CHOOSER_ACTION_CREATE_FOLDER:
      gtk_entry_completion_set_inline_completion (completion, FALSE);
      break;
    }
}

574 575 576 577 578 579 580
static void
discard_completion_store (GtkFileChooserEntry *chooser_entry)
{
  if (!chooser_entry->completion_store)
    return;

  gtk_entry_completion_set_model (gtk_entry_get_completion (GTK_ENTRY (chooser_entry)), NULL);
581
  update_inline_completion (chooser_entry);
582 583 584 585
  g_object_unref (chooser_entry->completion_store);
  chooser_entry->completion_store = NULL;
}

586 587 588 589 590 591 592 593
static gboolean
completion_store_set (GtkFileSystemModel  *model,
                      GFile               *file,
                      GFileInfo           *info,
                      int                  column,
                      GValue              *value,
                      gpointer             data)
{
594 595 596 597 598
  GtkFileChooserEntry *chooser_entry = data;

  const char *prefix = "";
  const char *suffix = "";

599 600
  switch (column)
    {
601 602 603
    case FULL_PATH_COLUMN:
      prefix = chooser_entry->dir_part;
      /* fall through */
604 605
    case DISPLAY_NAME_COLUMN:
      if (_gtk_file_info_consider_as_directory (info))
606 607
        suffix = G_DIR_SEPARATOR_S;

608 609 610 611 612
      g_value_take_string (value,
			   g_strconcat (prefix,
					g_file_info_get_display_name (info),
					suffix,
					NULL));
613 614 615 616 617 618 619 620 621
      break;
    default:
      g_assert_not_reached ();
      break;
    }

  return TRUE;
}

622 623 624 625
/* Fills the completion store from the contents of the current folder */
static void
populate_completion_store (GtkFileChooserEntry *chooser_entry)
{
626 627
  chooser_entry->completion_store = GTK_TREE_MODEL (
      _gtk_file_system_model_new_for_directory (chooser_entry->current_folder_file,
628 629
                                                "standard::name,standard::display-name,standard::type,"
                                                "standard::content-type",
630 631 632 633
                                                completion_store_set,
                                                chooser_entry,
                                                N_COLUMNS,
                                                G_TYPE_STRING,
634
                                                G_TYPE_STRING));
635 636
  g_signal_connect (chooser_entry->completion_store, "finished-loading",
		    G_CALLBACK (finished_loading_cb), chooser_entry);
637

638 639
  _gtk_file_system_model_set_filter_folders (GTK_FILE_SYSTEM_MODEL (chooser_entry->completion_store),
                                             TRUE);
640 641 642
  _gtk_file_system_model_set_show_files (GTK_FILE_SYSTEM_MODEL (chooser_entry->completion_store),
                                         chooser_entry->action == GTK_FILE_CHOOSER_ACTION_OPEN ||
                                         chooser_entry->action == GTK_FILE_CHOOSER_ACTION_SAVE);
643 644
  gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (chooser_entry->completion_store),
					DISPLAY_NAME_COLUMN, GTK_SORT_ASCENDING);
645 646

  gtk_entry_completion_set_model (gtk_entry_get_completion (GTK_ENTRY (chooser_entry)),
647
				  chooser_entry->completion_store);
648 649 650 651
}

/* Callback when the current folder finishes loading */
static void
652 653 654
finished_loading_cb (GtkFileSystemModel  *model,
                     GError              *error,
		     GtkFileChooserEntry *chooser_entry)
655
{
656 657
  GtkEntryCompletion *completion;

658
  chooser_entry->current_folder_loaded = TRUE;
659

660 661
  if (error)
    {
662
      discard_completion_store (chooser_entry);
663
      set_complete_on_load (chooser_entry, FALSE);
664 665
      return;
    }
666

667 668
  if (chooser_entry->complete_on_load)
    explicitly_complete (chooser_entry);
669 670

  gtk_widget_set_tooltip_text (GTK_WIDGET (chooser_entry), NULL);
671 672

  completion = gtk_entry_get_completion (GTK_ENTRY (chooser_entry));
673
  update_inline_completion (chooser_entry);
674 675 676 677 678 679

  if (gtk_widget_has_focus (GTK_WIDGET (chooser_entry)))
    {
      gtk_entry_completion_complete (completion);
      gtk_entry_completion_insert_prefix (completion);
    }
680 681
}

682 683
static void
set_completion_folder (GtkFileChooserEntry *chooser_entry,
684 685
                       GFile               *folder_file,
		       char                *dir_part)
686
{
687 688
  if (folder_file &&
      chooser_entry->local_only
689
      && !_gtk_file_has_native_path (folder_file))
690
    folder_file = NULL;
691

692 693 694 695 696 697 698 699
  if (((chooser_entry->current_folder_file
	&& folder_file
	&& g_file_equal (folder_file, chooser_entry->current_folder_file))
       || chooser_entry->current_folder_file == folder_file)
      && g_strcmp0 (dir_part, chooser_entry->dir_part) == 0)
    {
      return;
    }
700

701
  if (chooser_entry->current_folder_file)
702
    {
703 704
      g_object_unref (chooser_entry->current_folder_file);
      chooser_entry->current_folder_file = NULL;
705
    }
706 707 708

  g_free (chooser_entry->dir_part);
  chooser_entry->dir_part = g_strdup (dir_part);
709
  
710
  chooser_entry->current_folder_loaded = FALSE;
711

712
  discard_completion_store (chooser_entry);
713

714 715 716 717 718
  if (folder_file)
    {
      chooser_entry->current_folder_file = g_object_ref (folder_file);
      populate_completion_store (chooser_entry);
    }
719 720
}

721 722
static void
refresh_current_folder_and_file_part (GtkFileChooserEntry *chooser_entry)
723
{
724
  GFile *folder_file;
725
  char *text, *last_slash, *old_file_part;
726
  char *dir_part;
727

728
  old_file_part = chooser_entry->file_part;
729

730
  text = gtk_file_chooser_entry_get_completion_text (chooser_entry);
Federico Mena Quintero's avatar
Federico Mena Quintero committed
731

732 733
  last_slash = strrchr (text, G_DIR_SEPARATOR);
  if (last_slash)
734
    {
735
      dir_part = g_strndup (text, last_slash - text + 1);
736
      chooser_entry->file_part = g_strdup (last_slash + 1);
737 738 739
    }
  else
    {
740
      dir_part = g_strdup ("");
741
      chooser_entry->file_part = g_strdup (text);
742
    }
743

744
  folder_file = gtk_file_chooser_get_directory_for_text (chooser_entry, text);
745 746 747

  set_completion_folder (chooser_entry, folder_file, dir_part);

748 749
  if (folder_file)
    g_object_unref (folder_file);
750

751 752
  g_free (dir_part);

753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769
  if (chooser_entry->completion_store &&
      (g_strcmp0 (old_file_part, chooser_entry->file_part) != 0))
    {
      GtkFileFilter *filter;
      char *pattern;

      filter = gtk_file_filter_new ();
      pattern = g_strconcat (chooser_entry->file_part, "*", NULL);
      gtk_file_filter_add_pattern (filter, pattern);

      _gtk_file_system_model_set_filter (GTK_FILE_SYSTEM_MODEL (chooser_entry->completion_store),
                                         filter);

      g_free (pattern);
      g_object_unref (filter);
    }

770
  g_free (text);
771
  g_free (old_file_part);
772 773
}

774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804
#ifdef G_OS_WIN32
static gint
insert_text_callback (GtkFileChooserEntry *chooser_entry,
		      const gchar	  *new_text,
		      gint       	   new_text_length,
		      gint       	  *position,
		      gpointer   	   user_data)
{
  const gchar *colon = memchr (new_text, ':', new_text_length);
  gint i;

  /* Disallow these characters altogether */
  for (i = 0; i < new_text_length; i++)
    {
      if (new_text[i] == '<' ||
	  new_text[i] == '>' ||
	  new_text[i] == '"' ||
	  new_text[i] == '|' ||
	  new_text[i] == '*' ||
	  new_text[i] == '?')
	break;
    }

  if (i < new_text_length ||
      /* Disallow entering text that would cause a colon to be anywhere except
       * after a drive letter.
       */
      (colon != NULL &&
       *position + (colon - new_text) != 1) ||
      (new_text_length > 0 &&
       *position <= 1 &&
Tor Lillqvist's avatar
Tor Lillqvist committed
805
       gtk_entry_get_text_length (GTK_ENTRY (chooser_entry)) >= 2 &&
806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823
       gtk_entry_get_text (GTK_ENTRY (chooser_entry))[1] == ':'))
    {
      gtk_widget_error_bell (GTK_WIDGET (chooser_entry));
      g_signal_stop_emission_by_name (chooser_entry, "insert_text");
      return FALSE;
    }

  return TRUE;
}

static void
delete_text_callback (GtkFileChooserEntry *chooser_entry,
		      gint                 start_pos,
		      gint                 end_pos,
		      gpointer             user_data)
{
  /* If deleting a drive letter, delete the colon, too */
  if (start_pos == 0 && end_pos == 1 &&
Tor Lillqvist's avatar
Tor Lillqvist committed
824
      gtk_entry_get_text_length (GTK_ENTRY (chooser_entry)) >= 2 &&
825 826 827 828 829 830 831 832 833 834 835 836 837
      gtk_entry_get_text (GTK_ENTRY (chooser_entry))[1] == ':')
    {
      g_signal_handlers_block_by_func (chooser_entry,
				       G_CALLBACK (delete_text_callback),
				       user_data);
      gtk_editable_delete_text (GTK_EDITABLE (chooser_entry), 0, 1);
      g_signal_handlers_unblock_by_func (chooser_entry,
					 G_CALLBACK (delete_text_callback),
					 user_data);
    }
}
#endif

838 839
/**
 * _gtk_file_chooser_entry_new:
840
 * @eat_tabs: If %FALSE, allow focus navigation with the tab key.
841
 * @eat_escape: If %TRUE, capture Escape key presses and emit ::hide-entry
842
 *
843 844 845 846
 * 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.
847
 *
848
 * Returns: the newly created #GtkFileChooserEntry
849 850
 **/
GtkWidget *
851 852
_gtk_file_chooser_entry_new (gboolean eat_tabs,
                             gboolean eat_escape)
853
{
854 855 856 857
  GtkFileChooserEntry *chooser_entry;

  chooser_entry = g_object_new (GTK_TYPE_FILE_CHOOSER_ENTRY, NULL);
  chooser_entry->eat_tabs = (eat_tabs != FALSE);
858
  chooser_entry->eat_escape = (eat_escape != FALSE);
859 860

  return GTK_WIDGET (chooser_entry);
861 862 863 864 865
}

/**
 * _gtk_file_chooser_entry_set_base_folder:
 * @chooser_entry: a #GtkFileChooserEntry
866
 * @file: file for a folder in the chooser entries current file system.
867 868 869 870 871
 *
 * Sets the folder with respect to which completions occur.
 **/
void
_gtk_file_chooser_entry_set_base_folder (GtkFileChooserEntry *chooser_entry,
872
					 GFile               *file)
873
{
874 875 876 877 878 879 880 881
  g_return_if_fail (GTK_IS_FILE_CHOOSER_ENTRY (chooser_entry));
  g_return_if_fail (file == NULL || G_IS_FILE (file));

  if (chooser_entry->base_folder == file ||
      (file != NULL && chooser_entry->base_folder != NULL 
       && g_file_equal (chooser_entry->base_folder, file)))
    return;

882 883 884
  if (file)
    g_object_ref (file);

885
  if (chooser_entry->base_folder)
886 887 888
    g_object_unref (chooser_entry->base_folder);

  chooser_entry->base_folder = file;
889

890
  refresh_current_folder_and_file_part (chooser_entry);
891 892 893 894 895
}

/**
 * _gtk_file_chooser_entry_get_current_folder:
 * @chooser_entry: a #GtkFileChooserEntry
896
 *
897
 * Gets the current folder for the #GtkFileChooserEntry. If the
898
 * user has only entered a filename, this will be in the base folder
899 900
 * (see _gtk_file_chooser_entry_set_base_folder()), but if the
 * user has entered a relative or absolute path, then it will
901 902
 * be different.  If the user has entered unparsable text, or text which
 * the entry cannot handle, this will return %NULL.
903
 *
904
 * Returns: the file for the current folder - you must g_object_unref()
905
 *   the value after use.
906
 **/
907
GFile *
908 909
_gtk_file_chooser_entry_get_current_folder (GtkFileChooserEntry *chooser_entry)
{
910 911 912 913
  g_return_val_if_fail (GTK_IS_FILE_CHOOSER_ENTRY (chooser_entry), NULL);

  return gtk_file_chooser_get_directory_for_text (chooser_entry,
                                                  gtk_entry_get_text (GTK_ENTRY (chooser_entry)));
914 915 916 917 918
}

/**
 * _gtk_file_chooser_entry_get_file_part:
 * @chooser_entry: a #GtkFileChooserEntry
919
 *
920 921
 * Gets the non-folder portion of whatever the user has entered
 * into the file selector. What is returned is a UTF-8 string,
922
 * and if a filename path is needed, g_file_get_child_for_display_name()
923
 * must be used
924
  *
925
 * Returns: the entered filename - this value is owned by the
926 927 928 929 930
 *  chooser entry and must not be modified or freed.
 **/
const gchar *
_gtk_file_chooser_entry_get_file_part (GtkFileChooserEntry *chooser_entry)
{
931 932 933 934 935 936 937 938
  const char *last_slash, *text;

  g_return_val_if_fail (GTK_IS_FILE_CHOOSER_ENTRY (chooser_entry), NULL);

  text = gtk_entry_get_text (GTK_ENTRY (chooser_entry));
  last_slash = strrchr (text, G_DIR_SEPARATOR);
  if (last_slash)
    return last_slash + 1;
939 940
  else if (is_directory_shortcut (text))
    return "";
941 942
  else
    return text;
943 944
}

945 946 947 948 949 950 951 952 953 954 955 956 957 958 959
/**
 * _gtk_file_chooser_entry_set_action:
 * @chooser_entry: a #GtkFileChooserEntry
 * @action: the action which is performed by the file selector using this entry
 *
 * Sets action which is performed by the file selector using this entry. 
 * The #GtkFileChooserEntry will use different completion strategies for 
 * different actions.
 **/
void
_gtk_file_chooser_entry_set_action (GtkFileChooserEntry *chooser_entry,
				    GtkFileChooserAction action)
{
  g_return_if_fail (GTK_IS_FILE_CHOOSER_ENTRY (chooser_entry));
  
960
  if (chooser_entry->action != action)
961
    {
962 963
      GtkEntryCompletion *comp;

964
      chooser_entry->action = action;
965 966 967

      comp = gtk_entry_get_completion (GTK_ENTRY (chooser_entry));

Federico Mena Quintero's avatar
Federico Mena Quintero committed
968 969
      /* FIXME: do we need to actually set the following? */

970 971 972 973 974 975 976 977 978 979 980
      switch (action)
	{
	case GTK_FILE_CHOOSER_ACTION_OPEN:
	case GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER:
	  gtk_entry_completion_set_popup_single_match (comp, FALSE);
	  break;
	case GTK_FILE_CHOOSER_ACTION_SAVE:
	case GTK_FILE_CHOOSER_ACTION_CREATE_FOLDER:
	  gtk_entry_completion_set_popup_single_match (comp, TRUE);
	  break;
	}
981 982 983 984 985

      if (chooser_entry->completion_store)
        _gtk_file_system_model_set_show_files (GTK_FILE_SYSTEM_MODEL (chooser_entry->completion_store),
                                               action == GTK_FILE_CHOOSER_ACTION_OPEN ||
                                               action == GTK_FILE_CHOOSER_ACTION_SAVE);
986 987

      update_inline_completion (chooser_entry);
988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007
    }
}


/**
 * _gtk_file_chooser_entry_get_action:
 * @chooser_entry: a #GtkFileChooserEntry
 *
 * Gets the action for this entry. 
 *
 * Returns: the action
 **/
GtkFileChooserAction
_gtk_file_chooser_entry_get_action (GtkFileChooserEntry *chooser_entry)
{
  g_return_val_if_fail (GTK_IS_FILE_CHOOSER_ENTRY (chooser_entry),
			GTK_FILE_CHOOSER_ACTION_OPEN);
  
  return chooser_entry->action;
}
1008

1009 1010
gboolean
_gtk_file_chooser_entry_get_is_folder (GtkFileChooserEntry *chooser_entry,
1011
				       GFile               *file)
1012
{
1013 1014
  GtkTreeIter iter;
  GFileInfo *info;
1015

1016 1017 1018 1019 1020
  if (chooser_entry->completion_store == NULL ||
      !_gtk_file_system_model_get_iter_for_file (GTK_FILE_SYSTEM_MODEL (chooser_entry->completion_store),
                                                 &iter,
                                                 file))
    return FALSE;
1021

1022 1023
  info = _gtk_file_system_model_get_info (GTK_FILE_SYSTEM_MODEL (chooser_entry->completion_store),
                                          &iter);
1024

1025
  return _gtk_file_info_consider_as_directory (info);
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


/*
 * _gtk_file_chooser_entry_select_filename:
 * @chooser_entry: a #GtkFileChooserEntry
 *
 * Selects the filename (without the extension) for user edition.
 */
void
_gtk_file_chooser_entry_select_filename (GtkFileChooserEntry *chooser_entry)
{
  const gchar *str, *ext;
  glong len = -1;

  if (chooser_entry->action == GTK_FILE_CHOOSER_ACTION_SAVE)
    {
      str = gtk_entry_get_text (GTK_ENTRY (chooser_entry));
      ext = g_strrstr (str, ".");

      if (ext)
       len = g_utf8_pointer_to_offset (str, ext);
    }

  gtk_editable_select_region (GTK_EDITABLE (chooser_entry), 0, (gint) len);
}

1053 1054 1055 1056 1057
void
_gtk_file_chooser_entry_set_local_only (GtkFileChooserEntry *chooser_entry,
                                        gboolean             local_only)
{
  chooser_entry->local_only = local_only;
1058
  refresh_current_folder_and_file_part (chooser_entry);
1059 1060 1061 1062 1063 1064 1065
}

gboolean
_gtk_file_chooser_entry_get_local_only (GtkFileChooserEntry *chooser_entry)
{
  return chooser_entry->local_only;
}
1066 1067 1068 1069 1070 1071 1072

void
_gtk_file_chooser_entry_set_file_filter (GtkFileChooserEntry *chooser_entry,
                                         GtkFileFilter       *filter)
{
  chooser_entry->current_filter = filter;
}