gtk2/gtk/gtkfilechooserentry.c
Federico Mena Quintero f47227adde Beep if there are no matches for explicit completion
Signed-off-by: Federico Mena Quintero <federico@gnu.org>

svn path=/trunk/; revision=19838
2008-03-13 00:41:58 +00:00

1591 lines
45 KiB
C

/* 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 <config.h>
#include <string.h>
#include "gtkcelllayout.h"
#include "gtkcellrenderertext.h"
#include "gtkentry.h"
#include "gtkfilechooserentry.h"
#include "gtkmain.h"
#include "gtkintl.h"
#include "gtkalias.h"
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;
};
/* Action to take when the current folder finishes loading (for explicit or automatic completion) */
typedef enum {
LOAD_COMPLETE_NOTHING,
LOAD_COMPLETE_AUTOCOMPLETE,
LOAD_COMPLETE_EXPLICIT_COMPLETION
} LoadCompleteAction;
struct _GtkFileChooserEntry
{
GtkEntry parent_instance;
GtkFileChooserAction action;
GtkFileSystem *file_system;
GtkFilePath *base_folder;
gchar *file_part;
gint file_part_pos;
/* Folder being loaded or already loaded */
GtkFilePath *current_folder_path;
GtkFileFolder *current_folder;
GtkFileSystemHandle *load_folder_handle;
LoadCompleteAction load_complete_action;
GtkListStore *completion_store;
guint start_autocompletion_idle_id;
guint has_completion : 1;
guint in_change : 1;
guint eat_tabs : 1;
};
enum
{
DISPLAY_NAME_COLUMN,
PATH_COLUMN,
N_COLUMNS
};
static void gtk_file_chooser_entry_iface_init (GtkEditableClass *iface);
static void gtk_file_chooser_entry_finalize (GObject *object);
static void gtk_file_chooser_entry_dispose (GObject *object);
static void gtk_file_chooser_entry_grab_focus (GtkWidget *widget);
static gboolean gtk_file_chooser_entry_focus (GtkWidget *widget,
GtkDirectionType direction);
static gboolean gtk_file_chooser_entry_focus_out_event (GtkWidget *widget,
GdkEventFocus *event);
static void gtk_file_chooser_entry_activate (GtkEntry *entry);
static void gtk_file_chooser_entry_do_insert_text (GtkEditable *editable,
const gchar *new_text,
gint new_text_length,
gint *position);
static void gtk_file_chooser_entry_do_delete_text (GtkEditable *editable,
gint start_pos,
gint end_pos);
static void gtk_file_chooser_entry_set_position (GtkEditable *editable,
gint position);
static void gtk_file_chooser_entry_set_selection_bounds (GtkEditable *editable,
gint start_pos,
gint end_pos);
#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
static gboolean match_selected_callback (GtkEntryCompletion *completion,
GtkTreeModel *model,
GtkTreeIter *iter,
GtkFileChooserEntry *chooser_entry);
static gboolean completion_match_func (GtkEntryCompletion *comp,
const char *key,
GtkTreeIter *iter,
gpointer data);
static char *maybe_append_separator_to_path (GtkFileChooserEntry *chooser_entry,
GtkFilePath *path,
gchar *display_name);
typedef enum {
REFRESH_UP_TO_CURSOR_POSITION,
REFRESH_WHOLE_TEXT
} RefreshMode;
static void refresh_current_folder_and_file_part (GtkFileChooserEntry *chooser_entry,
RefreshMode refresh_mode);
static void finished_loading_cb (GtkFileFolder *folder,
gpointer data);
static void autocomplete (GtkFileChooserEntry *chooser_entry);
static void install_start_autocompletion_idle (GtkFileChooserEntry *chooser_entry);
static GtkEditableClass *parent_editable_iface;
G_DEFINE_TYPE_WITH_CODE (GtkFileChooserEntry, _gtk_file_chooser_entry, GTK_TYPE_ENTRY,
G_IMPLEMENT_INTERFACE (GTK_TYPE_EDITABLE,
gtk_file_chooser_entry_iface_init))
static void
_gtk_file_chooser_entry_class_init (GtkFileChooserEntryClass *class)
{
GObjectClass *gobject_class = G_OBJECT_CLASS (class);
GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);
GtkEntryClass *entry_class = GTK_ENTRY_CLASS (class);
gobject_class->finalize = gtk_file_chooser_entry_finalize;
gobject_class->dispose = gtk_file_chooser_entry_dispose;
widget_class->grab_focus = gtk_file_chooser_entry_grab_focus;
widget_class->focus = gtk_file_chooser_entry_focus;
widget_class->focus_out_event = gtk_file_chooser_entry_focus_out_event;
entry_class->activate = gtk_file_chooser_entry_activate;
}
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->do_delete_text = gtk_file_chooser_entry_do_delete_text;
iface->set_position = gtk_file_chooser_entry_set_position;
iface->set_selection_bounds = gtk_file_chooser_entry_set_selection_bounds;
}
static void
_gtk_file_chooser_entry_init (GtkFileChooserEntry *chooser_entry)
{
GtkEntryCompletion *comp;
GtkCellRenderer *cell;
g_object_set (chooser_entry, "truncate-multiline", TRUE, NULL);
comp = gtk_entry_completion_new ();
gtk_entry_completion_set_popup_single_match (comp, FALSE);
gtk_entry_completion_set_match_func (comp,
completion_match_func,
chooser_entry,
NULL);
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,
"text", 0);
g_signal_connect (comp, "match_selected",
G_CALLBACK (match_selected_callback), chooser_entry);
gtk_entry_set_completion (GTK_ENTRY (chooser_entry), comp);
g_object_unref (comp);
#ifdef G_OS_WIN32
g_signal_connect (chooser_entry, "insert_text",
G_CALLBACK (insert_text_callback), NULL);
g_signal_connect (chooser_entry, "delete_text",
G_CALLBACK (delete_text_callback), NULL);
#endif
}
static void
gtk_file_chooser_entry_finalize (GObject *object)
{
GtkFileChooserEntry *chooser_entry = GTK_FILE_CHOOSER_ENTRY (object);
gtk_file_path_free (chooser_entry->base_folder);
gtk_file_path_free (chooser_entry->current_folder_path);
g_free (chooser_entry->file_part);
G_OBJECT_CLASS (_gtk_file_chooser_entry_parent_class)->finalize (object);
}
static void
gtk_file_chooser_entry_dispose (GObject *object)
{
GtkFileChooserEntry *chooser_entry = GTK_FILE_CHOOSER_ENTRY (object);
if (chooser_entry->start_autocompletion_idle_id != 0)
{
g_source_remove (chooser_entry->start_autocompletion_idle_id);
chooser_entry->start_autocompletion_idle_id = 0;
}
if (chooser_entry->completion_store)
{
g_object_unref (chooser_entry->completion_store);
chooser_entry->completion_store = NULL;
}
if (chooser_entry->load_folder_handle)
{
gtk_file_system_cancel_operation (chooser_entry->load_folder_handle);
chooser_entry->load_folder_handle = NULL;
}
if (chooser_entry->current_folder)
{
g_signal_handlers_disconnect_by_func (chooser_entry->current_folder,
G_CALLBACK (finished_loading_cb), chooser_entry);
g_object_unref (chooser_entry->current_folder);
chooser_entry->current_folder = NULL;
}
if (chooser_entry->file_system)
{
g_object_unref (chooser_entry->file_system);
chooser_entry->file_system = NULL;
}
G_OBJECT_CLASS (_gtk_file_chooser_entry_parent_class)->dispose (object);
}
/* Match functions for the GtkEntryCompletion */
static gboolean
match_selected_callback (GtkEntryCompletion *completion,
GtkTreeModel *model,
GtkTreeIter *iter,
GtkFileChooserEntry *chooser_entry)
{
char *display_name;
GtkFilePath *path;
gint pos;
gtk_tree_model_get (model, iter,
DISPLAY_NAME_COLUMN, &display_name,
PATH_COLUMN, &path,
-1);
if (!display_name || !path)
{
/* these shouldn't complain if passed NULL */
gtk_file_path_free (path);
g_free (display_name);
return FALSE;
}
display_name = maybe_append_separator_to_path (chooser_entry, path, display_name);
pos = chooser_entry->file_part_pos;
/* We don't set in_change here as we want to update the current_folder
* variable */
gtk_editable_delete_text (GTK_EDITABLE (chooser_entry),
pos, -1);
gtk_editable_insert_text (GTK_EDITABLE (chooser_entry),
display_name, -1,
&pos);
gtk_editable_set_position (GTK_EDITABLE (chooser_entry), -1);
gtk_file_path_free (path);
g_free (display_name);
return TRUE;
}
/* Match function for the GtkEntryCompletion */
static gboolean
completion_match_func (GtkEntryCompletion *comp,
const char *key_unused,
GtkTreeIter *iter,
gpointer data)
{
GtkFileChooserEntry *chooser_entry;
char *name;
gboolean result;
char *norm_file_part;
char *norm_name;
chooser_entry = GTK_FILE_CHOOSER_ENTRY (data);
/* 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)
{
return FALSE;
}
gtk_tree_model_get (GTK_TREE_MODEL (chooser_entry->completion_store), iter, DISPLAY_NAME_COLUMN, &name, -1);
if (!name)
{
return FALSE; /* Uninitialized row, ugh */
}
/* If we have an empty file_part, then we're at the root of a directory. In
* that case, we want to match all non-dot files. We might want to match
* dot_files too if show_hidden is TRUE on the fileselector in the future.
*/
/* Additionally, support for gnome .hidden files would be sweet, too */
if (chooser_entry->file_part[0] == '\000')
{
if (name[0] == '.')
result = FALSE;
else
result = TRUE;
g_free (name);
return result;
}
norm_file_part = g_utf8_normalize (chooser_entry->file_part, -1, G_NORMALIZE_ALL);
norm_name = g_utf8_normalize (name, -1, G_NORMALIZE_ALL);
#ifdef G_PLATFORM_WIN32
{
gchar *temp;
temp = norm_file_part;
norm_file_part = g_utf8_casefold (norm_file_part, -1);
g_free (temp);
temp = norm_name;
norm_name = g_utf8_casefold (norm_name, -1);
g_free (temp);
}
#endif
result = (strncmp (norm_file_part, norm_name, strlen (norm_file_part)) == 0);
g_free (norm_file_part);
g_free (norm_name);
g_free (name);
return result;
}
static void
clear_completions (GtkFileChooserEntry *chooser_entry)
{
chooser_entry->has_completion = FALSE;
chooser_entry->load_complete_action = LOAD_COMPLETE_NOTHING;
}
static void
beep (GtkFileChooserEntry *chooser_entry)
{
gdk_display_beep (gtk_widget_get_display (GTK_WIDGET (chooser_entry)));
}
/* This function will append a directory separator to paths to
* display_name iff the path associated with it is a directory.
* maybe_append_separator_to_path will g_free the display_name and
* return a new one if needed. Otherwise, it will return the old one.
* You should be safe calling
*
* display_name = maybe_append_separator_to_path (entry, path, display_name);
* ...
* g_free (display_name);
*/
static char *
maybe_append_separator_to_path (GtkFileChooserEntry *chooser_entry,
GtkFilePath *path,
gchar *display_name)
{
if (!g_str_has_suffix (display_name, G_DIR_SEPARATOR_S) && path)
{
GtkFileInfo *info;
info = gtk_file_folder_get_info (chooser_entry->current_folder,
path, NULL); /* NULL-GError */
if (info)
{
if (gtk_file_info_get_is_folder (info))
{
gchar *tmp = display_name;
display_name = g_strconcat (tmp, G_DIR_SEPARATOR_S, NULL);
g_free (tmp);
}
gtk_file_info_free (info);
}
}
return display_name;
}
/* Determines if the completion model has entries with a common prefix relative
* to the current contents of the entry. Also, if there's one and only one such
* path, stores it in unique_path_ret.
*/
static gboolean
find_common_prefix (GtkFileChooserEntry *chooser_entry,
gchar **common_prefix_ret,
GtkFilePath **unique_path_ret,
gboolean *is_complete_not_unique_ret,
GError **error)
{
GtkEditable *editable;
GtkTreeIter iter;
gboolean parsed;
gboolean valid;
char *text_up_to_cursor;
GtkFilePath *parsed_folder_path;
char *parsed_file_part;
*common_prefix_ret = NULL;
*unique_path_ret = NULL;
*is_complete_not_unique_ret = FALSE;
editable = GTK_EDITABLE (chooser_entry);
text_up_to_cursor = gtk_editable_get_chars (editable, 0, gtk_editable_get_position (editable));
parsed = gtk_file_system_parse (chooser_entry->file_system,
chooser_entry->base_folder,
text_up_to_cursor,
&parsed_folder_path,
&parsed_file_part,
error);
printf ("Text up to cursor: \"%s\"\n", text_up_to_cursor);
printf ("parsed_folder_path: \"%s\"\nparsed_file_part: \"%s\"\n",
parsed_folder_path ? (char *) parsed_folder_path : "<NONE>",
parsed_file_part ? parsed_file_part : "<NONE>");
g_free (text_up_to_cursor);
if (!parsed)
return FALSE;
g_assert (parsed_folder_path != NULL
&& chooser_entry->current_folder_path != NULL
&& gtk_file_path_compare (parsed_folder_path, chooser_entry->current_folder_path) == 0);
gtk_file_path_free (parsed_folder_path);
/* First pass: find the common prefix */
valid = gtk_tree_model_get_iter_first (GTK_TREE_MODEL (chooser_entry->completion_store), &iter);
while (valid)
{
gchar *display_name;
GtkFilePath *path;
gtk_tree_model_get (GTK_TREE_MODEL (chooser_entry->completion_store),
&iter,
DISPLAY_NAME_COLUMN, &display_name,
PATH_COLUMN, &path,
-1);
if (g_str_has_prefix (display_name, parsed_file_part))
{
if (!*common_prefix_ret)
{
*common_prefix_ret = g_strdup (display_name);
*unique_path_ret = gtk_file_path_copy (path);
}
else
{
gchar *p = *common_prefix_ret;
const gchar *q = display_name;
while (*p && *p == *q)
{
p++;
q++;
}
*p = '\0';
gtk_file_path_free (*unique_path_ret);
*unique_path_ret = NULL;
}
}
g_free (display_name);
gtk_file_path_free (path);
valid = gtk_tree_model_iter_next (GTK_TREE_MODEL (chooser_entry->completion_store), &iter);
}
/* Second pass: see if the prefix we found is a complete match */
if (*common_prefix_ret != NULL)
{
valid = gtk_tree_model_get_iter_first (GTK_TREE_MODEL (chooser_entry->completion_store), &iter);
while (valid)
{
gchar *display_name;
int len;
gtk_tree_model_get (GTK_TREE_MODEL (chooser_entry->completion_store),
&iter,
DISPLAY_NAME_COLUMN, &display_name,
-1);
len = strlen (display_name);
g_assert (len > 0);
if (G_IS_DIR_SEPARATOR (display_name[len - 1]))
len--;
if (strncmp (*common_prefix_ret, display_name, len) == 0)
*is_complete_not_unique_ret = TRUE;
g_free (display_name);
valid = gtk_tree_model_iter_next (GTK_TREE_MODEL (chooser_entry->completion_store), &iter);
}
}
g_free (parsed_file_part);
return TRUE;
}
typedef enum {
INVALID_INPUT,
NO_MATCH,
COMPLETED,
COMPLETED_UNIQUE,
COMPLETE_BUT_NOT_UNIQUE
} CommonPrefixResult;
/* Finds a common prefix based on the contents of the entry and mandatorily appends it */
static CommonPrefixResult
append_common_prefix (GtkFileChooserEntry *chooser_entry,
gboolean highlight,
gboolean show_errors)
{
gchar *common_prefix;
GtkFilePath *unique_path;
gboolean is_complete_not_unique;
GError *error;
CommonPrefixResult result;
gboolean have_result;
clear_completions (chooser_entry);
if (chooser_entry->completion_store == NULL)
return NO_MATCH;
error = NULL;
if (!find_common_prefix (chooser_entry, &common_prefix, &unique_path, &is_complete_not_unique, &error))
{
if (show_errors)
{
beep (chooser_entry);
/* FIXME: display the error somehow */
}
g_error_free (error);
return INVALID_INPUT;
}
have_result = FALSE;
if (unique_path)
{
common_prefix = maybe_append_separator_to_path (chooser_entry,
unique_path,
common_prefix);
gtk_file_path_free (unique_path);
if (common_prefix)
result = COMPLETED_UNIQUE;
else
result = INVALID_INPUT;
have_result = TRUE;
}
else
{
if (is_complete_not_unique)
{
result = COMPLETE_BUT_NOT_UNIQUE;
have_result = TRUE;
}
}
printf ("common prefix: \"%s\"\n",
common_prefix ? common_prefix : "<NONE>");
if (common_prefix)
{
gint cursor_pos;
gint common_prefix_len;
gint pos;
cursor_pos = gtk_editable_get_position (GTK_EDITABLE (chooser_entry));
common_prefix_len = g_utf8_strlen (common_prefix, -1);
pos = chooser_entry->file_part_pos;
chooser_entry->in_change = TRUE;
printf ("Deleting range (%d, %d)\n", pos, cursor_pos);
gtk_editable_delete_text (GTK_EDITABLE (chooser_entry),
pos, cursor_pos);
printf ("Inserting common prefix at %d\n", pos);
gtk_editable_insert_text (GTK_EDITABLE (chooser_entry),
common_prefix, -1,
&pos);
chooser_entry->in_change = FALSE;
if (highlight)
{
printf ("Selecting range (%d, %d)\n", cursor_pos, pos);
gtk_editable_select_region (GTK_EDITABLE (chooser_entry),
cursor_pos,
pos); /* cursor_pos + common_prefix_len); */
chooser_entry->has_completion = TRUE;
}
else
gtk_editable_set_position (GTK_EDITABLE (chooser_entry), pos);
g_free (common_prefix);
if (have_result)
return result;
else
return COMPLETED;
}
else
{
if (have_result)
return result;
else
return NO_MATCH;
}
}
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);
gint old_text_len;
gint insert_pos;
old_text_len = GTK_ENTRY (chooser_entry)->text_length;
insert_pos = *position;
parent_editable_iface->do_insert_text (editable, new_text, new_text_length, position);
if (chooser_entry->in_change)
return;
if ((chooser_entry->action == GTK_FILE_CHOOSER_ACTION_OPEN
|| chooser_entry->action == GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER)
&& insert_pos == old_text_len)
install_start_autocompletion_idle (chooser_entry);
}
static void
clear_completions_if_not_in_change (GtkFileChooserEntry *chooser_entry)
{
if (chooser_entry->in_change)
return;
clear_completions (chooser_entry);
}
static void
gtk_file_chooser_entry_do_delete_text (GtkEditable *editable,
gint start_pos,
gint end_pos)
{
GtkFileChooserEntry *chooser_entry = GTK_FILE_CHOOSER_ENTRY (editable);
parent_editable_iface->do_delete_text (editable, start_pos, end_pos);
clear_completions_if_not_in_change (chooser_entry);
}
static void
gtk_file_chooser_entry_set_position (GtkEditable *editable,
gint position)
{
GtkFileChooserEntry *chooser_entry = GTK_FILE_CHOOSER_ENTRY (editable);
parent_editable_iface->set_position (editable, position);
clear_completions_if_not_in_change (chooser_entry);
}
static void
gtk_file_chooser_entry_set_selection_bounds (GtkEditable *editable,
gint start_pos,
gint end_pos)
{
GtkFileChooserEntry *chooser_entry = GTK_FILE_CHOOSER_ENTRY (editable);
parent_editable_iface->set_selection_bounds (editable, start_pos, end_pos);
clear_completions_if_not_in_change (chooser_entry);
}
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));
}
static void
pop_up_completion_feedback (GtkFileChooserEntry *chooser_entry,
const gchar *feedback)
{
/* FIXME: use a popup window of some sort */
printf ("COMPLETION: %s\n", feedback);
}
static void
explicitly_complete (GtkFileChooserEntry *chooser_entry)
{
CommonPrefixResult result;
g_assert (chooser_entry->current_folder != NULL);
g_assert (gtk_file_folder_is_finished_loading (chooser_entry->current_folder));
/* FIXME: see what Emacs does in case there is no common prefix, or there is more than one match:
*
* - If there is a common prefix, insert it
* - If there is no common prefix, pop up the suggestion window
* - If there are no matches at all, beep and bring up a tooltip
* - If the suggestion window is already up, scroll it
*/
result = append_common_prefix (chooser_entry, FALSE, TRUE);
switch (result)
{
case INVALID_INPUT:
/* We already beeped in append_common_prefix(); do nothing here */
break;
case NO_MATCH:
beep (chooser_entry);
pop_up_completion_feedback (chooser_entry, _("No match"));
break;
case COMPLETED:
/* Nothing to do */
break;
case COMPLETED_UNIQUE:
/* Nothing to do */
break;
case COMPLETE_BUT_NOT_UNIQUE:
/* FIXME: pop up the suggestion window */
pop_up_completion_feedback (chooser_entry, _("Complete, but not unique"));
break;
default:
g_assert_not_reached ();
}
/* FIXME: this bit of code is commented out for reference; this is how we used to force the suggestion window to pop up
*
* Trigger the completion window to pop up again by a
* zero-length insertion, a bit of a hack.
*
* gtk_editable_insert_text (editable, "", -1, &pos);
*/
}
static void
start_explicit_completion (GtkFileChooserEntry *chooser_entry)
{
printf ("Starting explicit completion - refreshing current folder\n");
refresh_current_folder_and_file_part (chooser_entry, REFRESH_UP_TO_CURSOR_POSITION);
if (!chooser_entry->current_folder_path)
{
/* Here, no folder path means we couldn't parse what the user typed. */
printf ("We don't have a current_folder_path - means the user typed something bogus\n");
beep (chooser_entry);
/* FIXME: present a tooltip to tell the user that his folder is invalid */
chooser_entry->load_complete_action = LOAD_COMPLETE_NOTHING;
return;
}
if (chooser_entry->current_folder
&& gtk_file_folder_is_finished_loading (chooser_entry->current_folder))
{
printf ("File folder is finished loading, doing explicit completion immediately\n");
explicitly_complete (chooser_entry);
}
else
{
printf ("File folder is not yet loaded; will do explicit completion later\n");
chooser_entry->load_complete_action = LOAD_COMPLETE_EXPLICIT_COMPLETION;
/* FIXME: here, Emacs would say, "Making completion list..." */
}
}
static gboolean
gtk_file_chooser_entry_focus (GtkWidget *widget,
GtkDirectionType direction)
{
GtkFileChooserEntry *chooser_entry;
GtkEditable *editable;
GtkEntry *entry;
GdkModifierType state;
gboolean control_pressed;
chooser_entry = GTK_FILE_CHOOSER_ENTRY (widget);
editable = GTK_EDITABLE (widget);
entry = GTK_ENTRY (widget);
if (!chooser_entry->eat_tabs)
return GTK_WIDGET_CLASS (_gtk_file_chooser_entry_parent_class)->focus (widget, direction);
control_pressed = FALSE;
if (gtk_get_current_event_state (&state))
{
if ((state & GDK_CONTROL_MASK) == GDK_CONTROL_MASK)
control_pressed = TRUE;
}
/* This is a bit evil -- it makes Tab never leave the entry. It basically
* makes it 'safe' for people to hit. */
if ((direction == GTK_DIR_TAB_FORWARD) &&
(GTK_WIDGET_HAS_FOCUS (widget)) &&
(! control_pressed))
{
if (chooser_entry->has_completion)
{
gboolean has_selection;
gint sel_end;
printf ("Hit Tab, and we have a completion! Will unselect it\n");
has_selection = gtk_editable_get_selection_bounds (editable, NULL, &sel_end);
g_assert (has_selection && sel_end == GTK_ENTRY (entry)->text_length);
gtk_editable_set_position (editable, sel_end);
}
else
{
printf ("Hit Tab, we don't have a selected completion. Will start explicit completion\n");
start_explicit_completion (chooser_entry);
}
return TRUE;
}
else
return GTK_WIDGET_CLASS (_gtk_file_chooser_entry_parent_class)->focus (widget, direction);
}
static gboolean
gtk_file_chooser_entry_focus_out_event (GtkWidget *widget,
GdkEventFocus *event)
{
GtkFileChooserEntry *chooser_entry = GTK_FILE_CHOOSER_ENTRY (widget);
chooser_entry->load_complete_action = LOAD_COMPLETE_NOTHING;
return GTK_WIDGET_CLASS (_gtk_file_chooser_entry_parent_class)->focus_out_event (widget, event);
}
static void
gtk_file_chooser_entry_activate (GtkEntry *entry)
{
GtkFileChooserEntry *chooser_entry = GTK_FILE_CHOOSER_ENTRY (entry);
if (chooser_entry->has_completion)
{
gtk_editable_set_position (GTK_EDITABLE (entry),
entry->text_length);
}
refresh_current_folder_and_file_part (chooser_entry, REFRESH_WHOLE_TEXT);
GTK_ENTRY_CLASS (_gtk_file_chooser_entry_parent_class)->activate (entry);
}
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);
g_object_unref (chooser_entry->completion_store);
chooser_entry->completion_store = NULL;
}
/* Fills the completion store from the contents of the current folder */
static void
populate_completion_store (GtkFileChooserEntry *chooser_entry)
{
GSList *paths;
GSList *tmp_list;
printf ("Populating completion store\n");
if (!gtk_file_folder_list_children (chooser_entry->current_folder, &paths, NULL)) /* NULL-GError */
return;
discard_completion_store (chooser_entry);
chooser_entry->completion_store = gtk_list_store_new (N_COLUMNS,
G_TYPE_STRING,
GTK_TYPE_FILE_PATH);
for (tmp_list = paths; tmp_list; tmp_list = tmp_list->next)
{
GtkFileInfo *info;
GtkFilePath *path;
path = tmp_list->data;
info = gtk_file_folder_get_info (chooser_entry->current_folder,
path,
NULL); /* NULL-GError */
if (info)
{
gchar *display_name = g_strdup (gtk_file_info_get_display_name (info));
GtkTreeIter iter;
display_name = maybe_append_separator_to_path (chooser_entry, path, display_name);
gtk_list_store_append (chooser_entry->completion_store, &iter);
gtk_list_store_set (chooser_entry->completion_store, &iter,
DISPLAY_NAME_COLUMN, display_name,
PATH_COLUMN, path,
-1);
gtk_file_info_free (info);
g_free (display_name);
}
}
gtk_file_paths_free (paths);
gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (chooser_entry->completion_store),
DISPLAY_NAME_COLUMN, GTK_SORT_ASCENDING);
gtk_entry_completion_set_model (gtk_entry_get_completion (GTK_ENTRY (chooser_entry)),
GTK_TREE_MODEL (chooser_entry->completion_store));
}
/* When we finish loading the current folder, this function should get called to
* perform the deferred autocompletion or explicit completion.
*/
static void
perform_load_complete_action (GtkFileChooserEntry *chooser_entry)
{
switch (chooser_entry->load_complete_action)
{
case LOAD_COMPLETE_NOTHING:
break;
case LOAD_COMPLETE_AUTOCOMPLETE:
printf ("Load is complete; will autocomplete immediately\n");
autocomplete (chooser_entry);
break;
case LOAD_COMPLETE_EXPLICIT_COMPLETION:
printf ("Load is complete; will do explicit completion\n");
explicitly_complete (chooser_entry);
break;
default:
g_assert_not_reached ();
}
chooser_entry->load_complete_action = LOAD_COMPLETE_NOTHING;
}
static void
finish_folder_load (GtkFileChooserEntry *chooser_entry)
{
populate_completion_store (chooser_entry);
perform_load_complete_action (chooser_entry);
gtk_widget_set_tooltip_text (GTK_WIDGET (chooser_entry), NULL);
}
/* Callback when the current folder finishes loading */
static void
finished_loading_cb (GtkFileFolder *folder,
gpointer data)
{
GtkFileChooserEntry *chooser_entry = GTK_FILE_CHOOSER_ENTRY (data);
printf ("Folder finished loading asynchronously! Will populate the completion store\n");
finish_folder_load (chooser_entry);
}
/* Callback when the current folder's handle gets obtained (not necessarily loaded completely) */
static void
load_directory_get_folder_callback (GtkFileSystemHandle *handle,
GtkFileFolder *folder,
const GError *error,
gpointer data)
{
gboolean cancelled = handle->cancelled;
GtkFileChooserEntry *chooser_entry = data;
if (handle != chooser_entry->load_folder_handle)
goto out;
chooser_entry->load_folder_handle = NULL;
/* FIXME: if there was an error *AND* we had a pending explicit completion, beep and pop up a
* tooltip to say that the folder could not be loaded.
*/
/* FIXME: if error, remove the current tooltip ("making completion list") */
if (cancelled || error)
goto out;
g_assert (folder != NULL);
chooser_entry->current_folder = folder;
printf ("Got folder asynchronously!\n");
discard_completion_store (chooser_entry);
if (gtk_file_folder_is_finished_loading (chooser_entry->current_folder))
{
printf ("And the folder is already finished loading. Will populate the completion store.\n");
finish_folder_load (chooser_entry);
}
else
{
printf ("Folder is not yet completely loaded. Will load it asynchronously...\n");
g_signal_connect (chooser_entry->current_folder, "finished-loading",
G_CALLBACK (finished_loading_cb), chooser_entry);
}
out:
g_object_unref (chooser_entry);
g_object_unref (handle);
}
static void
start_loading_current_folder (GtkFileChooserEntry *chooser_entry)
{
if (chooser_entry->current_folder_path == NULL ||
chooser_entry->file_system == NULL)
return;
g_assert (chooser_entry->current_folder == NULL);
g_assert (chooser_entry->load_folder_handle == NULL);
printf ("Starting async load of folder %s\n", (char *) chooser_entry->current_folder_path);
chooser_entry->load_folder_handle =
gtk_file_system_get_folder (chooser_entry->file_system,
chooser_entry->current_folder_path,
GTK_FILE_INFO_DISPLAY_NAME | GTK_FILE_INFO_IS_FOLDER,
load_directory_get_folder_callback,
g_object_ref (chooser_entry));
}
static void
reload_current_folder (GtkFileChooserEntry *chooser_entry,
GtkFilePath *folder_path,
gboolean force_reload)
{
gboolean reload = FALSE;
if (chooser_entry->current_folder_path)
{
if ((folder_path && gtk_file_path_compare (folder_path, chooser_entry->current_folder_path) != 0)
|| force_reload)
{
reload = TRUE;
/* We changed our current directory. We need to clear out the old
* directory information.
*/
if (chooser_entry->current_folder)
{
if (chooser_entry->load_folder_handle)
{
printf ("Cancelling folder load\n");
gtk_file_system_cancel_operation (chooser_entry->load_folder_handle);
chooser_entry->load_folder_handle = NULL;
}
g_object_unref (chooser_entry->current_folder);
chooser_entry->current_folder = NULL;
}
gtk_file_path_free (chooser_entry->current_folder_path);
chooser_entry->current_folder_path = gtk_file_path_copy (folder_path);
}
}
else
{
chooser_entry->current_folder_path = gtk_file_path_copy (folder_path);
reload = TRUE;
}
if (reload)
start_loading_current_folder (chooser_entry);
}
static void
refresh_current_folder_and_file_part (GtkFileChooserEntry *chooser_entry,
RefreshMode refresh_mode)
{
GtkEditable *editable;
gint end_pos;
gchar *text;
GtkFilePath *folder_path;
gchar *file_part;
gsize total_len, file_part_len;
gint file_part_pos;
editable = GTK_EDITABLE (chooser_entry);
switch (refresh_mode)
{
case REFRESH_UP_TO_CURSOR_POSITION:
end_pos = gtk_editable_get_position (editable);
break;
case REFRESH_WHOLE_TEXT:
end_pos = GTK_ENTRY (chooser_entry)->text_length;
break;
default:
g_assert_not_reached ();
return;
}
text = gtk_editable_get_chars (editable, 0, end_pos);
if (!chooser_entry->file_system ||
!chooser_entry->base_folder ||
!gtk_file_system_parse (chooser_entry->file_system,
chooser_entry->base_folder, text,
&folder_path, &file_part, NULL)) /* NULL-GError */
{
folder_path = gtk_file_path_copy (chooser_entry->base_folder);
file_part = g_strdup ("");
file_part_pos = -1;
}
else
{
file_part_len = strlen (file_part);
total_len = strlen (text);
if (total_len > file_part_len)
file_part_pos = g_utf8_strlen (text, total_len - file_part_len);
else
file_part_pos = 0;
}
printf ("Parsed text \"%s\", file_part=\"%s\", file_part_pos=%d, folder_path=\"%s\"\n",
text,
file_part,
file_part_pos,
folder_path ? (char *) folder_path : "(NULL)");
g_free (text);
g_free (chooser_entry->file_part);
chooser_entry->file_part = file_part;
chooser_entry->file_part_pos = file_part_pos;
reload_current_folder (chooser_entry, folder_path, file_part_pos == -1);
gtk_file_path_free (folder_path);
}
static void
autocomplete (GtkFileChooserEntry *chooser_entry)
{
g_assert (chooser_entry->current_folder != NULL);
g_assert (gtk_file_folder_is_finished_loading (chooser_entry->current_folder));
g_assert (gtk_editable_get_position (GTK_EDITABLE (chooser_entry)) == GTK_ENTRY (chooser_entry)->text_length);
printf ("Doing autocompletion since our folder is finished loading\n");
append_common_prefix (chooser_entry, TRUE, FALSE);
}
static void
start_autocompletion (GtkFileChooserEntry *chooser_entry)
{
printf ("Starting autocompletion\n");
refresh_current_folder_and_file_part (chooser_entry, REFRESH_UP_TO_CURSOR_POSITION);
if (!chooser_entry->current_folder)
{
/* We don't beep or anything, since this is autocompletion - the user
* didn't request any action explicitly.
*/
printf ("No current_folder; not doing autocompletion after all\n");
return;
}
if (gtk_file_folder_is_finished_loading (chooser_entry->current_folder))
{
printf ("File folder is finished loading; doing autocompletion immediately\n");
autocomplete (chooser_entry);
}
else
{
printf ("File folder is not yet loaded; will do autocompletion later\n");
chooser_entry->load_complete_action = LOAD_COMPLETE_AUTOCOMPLETE;
}
}
static gboolean
start_autocompletion_idle_handler (gpointer data)
{
GtkFileChooserEntry *chooser_entry = GTK_FILE_CHOOSER_ENTRY (data);
start_autocompletion (chooser_entry);
chooser_entry->start_autocompletion_idle_id = 0;
return FALSE;
}
static void
install_start_autocompletion_idle (GtkFileChooserEntry *chooser_entry)
{
if (chooser_entry->start_autocompletion_idle_id != 0)
return;
chooser_entry->start_autocompletion_idle_id = g_idle_add (start_autocompletion_idle_handler, chooser_entry);
}
#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 &&
GTK_ENTRY (chooser_entry)->text_length >= 2 &&
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 &&
GTK_ENTRY (chooser_entry)->text_length >= 2 &&
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
/**
* _gtk_file_chooser_entry_new:
* @eat_tabs: If %FALSE, allow focus navigation with the tab key.
*
* 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 (gboolean eat_tabs)
{
GtkFileChooserEntry *chooser_entry;
chooser_entry = g_object_new (GTK_TYPE_FILE_CHOOSER_ENTRY, NULL);
chooser_entry->eat_tabs = (eat_tabs != FALSE);
return GTK_WIDGET (chooser_entry);
}
/**
* _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
* @path: path of a folder in the chooser entries current file system.
*
* Sets the folder with respect to which completions occur.
**/
void
_gtk_file_chooser_entry_set_base_folder (GtkFileChooserEntry *chooser_entry,
const GtkFilePath *path)
{
if (chooser_entry->base_folder)
gtk_file_path_free (chooser_entry->base_folder);
chooser_entry->base_folder = gtk_file_path_copy (path);
clear_completions (chooser_entry);
_gtk_file_chooser_entry_select_filename (chooser_entry);
}
/**
* _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.
*
* Return value: the path of current folder - this value is owned by the
* chooser entry and must not be modified or freed.
**/
const GtkFilePath *
_gtk_file_chooser_entry_get_current_folder (GtkFileChooserEntry *chooser_entry)
{
if (chooser_entry->has_completion)
{
gtk_editable_set_position (GTK_EDITABLE (chooser_entry),
GTK_ENTRY (chooser_entry)->text_length);
}
return chooser_entry->current_folder_path;
}
/**
* _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,
* and if a filename path is needed, gtk_file_system_make_path()
* 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)
{
if (chooser_entry->has_completion)
{
gtk_editable_set_position (GTK_EDITABLE (chooser_entry),
GTK_ENTRY (chooser_entry)->text_length);
}
refresh_current_folder_and_file_part (chooser_entry, REFRESH_WHOLE_TEXT);
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;
clear_completions (chooser_entry);
gtk_entry_set_text (GTK_ENTRY (chooser_entry), file_part);
chooser_entry->in_change = FALSE;
}
/**
* _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));
if (chooser_entry->action != action)
{
GtkEntryCompletion *comp;
chooser_entry->action = action;
comp = gtk_entry_get_completion (GTK_ENTRY (chooser_entry));
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;
}
}
}
/**
* _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;
}
gboolean
_gtk_file_chooser_entry_get_is_folder (GtkFileChooserEntry *chooser_entry,
const GtkFilePath *path)
{
gboolean retval = FALSE;
if (chooser_entry->current_folder)
{
GtkFileInfo *file_info;
file_info = gtk_file_folder_get_info (chooser_entry->current_folder,
path, NULL);
if (file_info)
{
retval = gtk_file_info_get_is_folder (file_info);
gtk_file_info_free (file_info);
}
}
return retval;
}
/*
* _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);
}