initial
This commit is contained in:
Perberos
632
gedit/gedit-history-entry.c
Executable file
632
gedit/gedit-history-entry.c
Executable file
@@ -0,0 +1,632 @@
|
||||
/*
|
||||
* gedit-history-entry.c
|
||||
* This file is part of gedit
|
||||
*
|
||||
* Copyright (C) 2006 - Paolo Borelli
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation; either version 2 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program 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 General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with this program; if not, write to the Free Software
|
||||
* Foundation, Inc., 59 Temple Place, Suite 330,
|
||||
* Boston, MA 02111-1307, USA.
|
||||
*/
|
||||
|
||||
/*
|
||||
* Modified by the gedit Team, 2006. See the AUTHORS file for a
|
||||
* list of people on the gedit Team.
|
||||
* See the ChangeLog files for a list of changes.
|
||||
*
|
||||
* $Id$
|
||||
*/
|
||||
|
||||
#ifdef HAVE_CONFIG_H
|
||||
#include <config.h>
|
||||
#endif
|
||||
|
||||
#include <string.h>
|
||||
#include <glib/gi18n.h>
|
||||
#include <gtk/gtk.h>
|
||||
#include <mateconf/mateconf-client.h>
|
||||
|
||||
#include "gedit-history-entry.h"
|
||||
|
||||
enum {
|
||||
PROP_0,
|
||||
PROP_HISTORY_ID,
|
||||
PROP_HISTORY_LENGTH
|
||||
};
|
||||
|
||||
#define MIN_ITEM_LEN 3
|
||||
|
||||
#define GEDIT_HISTORY_ENTRY_HISTORY_LENGTH_DEFAULT 10
|
||||
|
||||
#define GEDIT_HISTORY_ENTRY_GET_PRIVATE(object)(G_TYPE_INSTANCE_GET_PRIVATE ((object), \
|
||||
GEDIT_TYPE_HISTORY_ENTRY, \
|
||||
GeditHistoryEntryPrivate))
|
||||
|
||||
struct _GeditHistoryEntryPrivate
|
||||
{
|
||||
gchar *history_id;
|
||||
guint history_length;
|
||||
|
||||
GtkEntryCompletion *completion;
|
||||
|
||||
MateConfClient *mateconf_client;
|
||||
};
|
||||
|
||||
G_DEFINE_TYPE(GeditHistoryEntry, gedit_history_entry, GTK_TYPE_COMBO_BOX_ENTRY)
|
||||
|
||||
static void
|
||||
gedit_history_entry_set_property (GObject *object,
|
||||
guint prop_id,
|
||||
const GValue *value,
|
||||
GParamSpec *spec)
|
||||
{
|
||||
GeditHistoryEntry *entry;
|
||||
|
||||
g_return_if_fail (GEDIT_IS_HISTORY_ENTRY (object));
|
||||
|
||||
entry = GEDIT_HISTORY_ENTRY (object);
|
||||
|
||||
switch (prop_id) {
|
||||
case PROP_HISTORY_ID:
|
||||
entry->priv->history_id = g_value_dup_string (value);
|
||||
break;
|
||||
case PROP_HISTORY_LENGTH:
|
||||
gedit_history_entry_set_history_length (entry,
|
||||
g_value_get_uint (value));
|
||||
break;
|
||||
default:
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
static void
|
||||
gedit_history_entry_get_property (GObject *object,
|
||||
guint prop_id,
|
||||
GValue *value,
|
||||
GParamSpec *spec)
|
||||
{
|
||||
GeditHistoryEntryPrivate *priv;
|
||||
|
||||
g_return_if_fail (GEDIT_IS_HISTORY_ENTRY (object));
|
||||
|
||||
priv = GEDIT_HISTORY_ENTRY (object)->priv;
|
||||
|
||||
switch (prop_id) {
|
||||
case PROP_HISTORY_ID:
|
||||
g_value_set_string (value, priv->history_id);
|
||||
break;
|
||||
case PROP_HISTORY_LENGTH:
|
||||
g_value_set_uint (value, priv->history_length);
|
||||
break;
|
||||
default:
|
||||
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, spec);
|
||||
}
|
||||
}
|
||||
|
||||
static void
|
||||
gedit_history_entry_destroy (GtkObject *object)
|
||||
{
|
||||
gedit_history_entry_set_enable_completion (GEDIT_HISTORY_ENTRY (object),
|
||||
FALSE);
|
||||
|
||||
GTK_OBJECT_CLASS (gedit_history_entry_parent_class)->destroy (object);
|
||||
}
|
||||
|
||||
static void
|
||||
gedit_history_entry_finalize (GObject *object)
|
||||
{
|
||||
GeditHistoryEntryPrivate *priv;
|
||||
|
||||
priv = GEDIT_HISTORY_ENTRY (object)->priv;
|
||||
|
||||
g_free (priv->history_id);
|
||||
|
||||
if (priv->mateconf_client != NULL)
|
||||
{
|
||||
g_object_unref (G_OBJECT (priv->mateconf_client));
|
||||
priv->mateconf_client = NULL;
|
||||
}
|
||||
|
||||
G_OBJECT_CLASS (gedit_history_entry_parent_class)->finalize (object);
|
||||
}
|
||||
|
||||
static void
|
||||
gedit_history_entry_class_init (GeditHistoryEntryClass *klass)
|
||||
{
|
||||
GObjectClass *object_class = G_OBJECT_CLASS (klass);
|
||||
GtkObjectClass *gtkobject_class = GTK_OBJECT_CLASS (klass);
|
||||
|
||||
object_class->set_property = gedit_history_entry_set_property;
|
||||
object_class->get_property = gedit_history_entry_get_property;
|
||||
object_class->finalize = gedit_history_entry_finalize;
|
||||
gtkobject_class->destroy = gedit_history_entry_destroy;
|
||||
|
||||
g_object_class_install_property (object_class,
|
||||
PROP_HISTORY_ID,
|
||||
g_param_spec_string ("history-id",
|
||||
"History ID",
|
||||
"History ID",
|
||||
NULL,
|
||||
G_PARAM_READWRITE |
|
||||
G_PARAM_STATIC_STRINGS));
|
||||
|
||||
g_object_class_install_property (object_class,
|
||||
PROP_HISTORY_LENGTH,
|
||||
g_param_spec_uint ("history-length",
|
||||
"Max History Length",
|
||||
"Max History Length",
|
||||
0,
|
||||
G_MAXUINT,
|
||||
GEDIT_HISTORY_ENTRY_HISTORY_LENGTH_DEFAULT,
|
||||
G_PARAM_READWRITE |
|
||||
G_PARAM_STATIC_STRINGS));
|
||||
|
||||
/* TODO: Add enable-completion property */
|
||||
|
||||
g_type_class_add_private (object_class, sizeof(GeditHistoryEntryPrivate));
|
||||
}
|
||||
|
||||
static GtkListStore *
|
||||
get_history_store (GeditHistoryEntry *entry)
|
||||
{
|
||||
GtkTreeModel *store;
|
||||
|
||||
store = gtk_combo_box_get_model (GTK_COMBO_BOX (entry));
|
||||
g_return_val_if_fail (GTK_IS_LIST_STORE (store), NULL);
|
||||
|
||||
return (GtkListStore *) store;
|
||||
}
|
||||
|
||||
static char *
|
||||
get_history_key (GeditHistoryEntry *entry)
|
||||
{
|
||||
gchar *tmp;
|
||||
gchar *key;
|
||||
|
||||
/*
|
||||
* We store the data under /apps/mate-settings/
|
||||
* like the old MateEntry did. Maybe we should
|
||||
* consider moving it to the /gedit MateConf prefix...
|
||||
* Or maybe we should just switch away from MateConf.
|
||||
*/
|
||||
|
||||
tmp = mateconf_escape_key (entry->priv->history_id, -1);
|
||||
key = g_strconcat ("/apps/mate-settings/",
|
||||
"gedit",
|
||||
"/history-",
|
||||
tmp,
|
||||
NULL);
|
||||
g_free (tmp);
|
||||
|
||||
return key;
|
||||
}
|
||||
|
||||
static GSList *
|
||||
get_history_list (GeditHistoryEntry *entry)
|
||||
{
|
||||
GtkListStore *store;
|
||||
GtkTreeIter iter;
|
||||
gboolean valid;
|
||||
GSList *list = NULL;
|
||||
|
||||
store = get_history_store (entry);
|
||||
|
||||
valid = gtk_tree_model_get_iter_first (GTK_TREE_MODEL (store),
|
||||
&iter);
|
||||
|
||||
while (valid)
|
||||
{
|
||||
gchar *str;
|
||||
|
||||
gtk_tree_model_get (GTK_TREE_MODEL (store),
|
||||
&iter,
|
||||
0, &str,
|
||||
-1);
|
||||
|
||||
list = g_slist_prepend (list, str);
|
||||
|
||||
valid = gtk_tree_model_iter_next (GTK_TREE_MODEL (store),
|
||||
&iter);
|
||||
}
|
||||
|
||||
return g_slist_reverse (list);
|
||||
}
|
||||
|
||||
static void
|
||||
gedit_history_entry_save_history (GeditHistoryEntry *entry)
|
||||
{
|
||||
GSList *mateconf_items;
|
||||
gchar *key;
|
||||
|
||||
g_return_if_fail (GEDIT_IS_HISTORY_ENTRY (entry));
|
||||
|
||||
mateconf_items = get_history_list (entry);
|
||||
key = get_history_key (entry);
|
||||
|
||||
mateconf_client_set_list (entry->priv->mateconf_client,
|
||||
key,
|
||||
MATECONF_VALUE_STRING,
|
||||
mateconf_items,
|
||||
NULL);
|
||||
|
||||
g_slist_foreach (mateconf_items, (GFunc) g_free, NULL);
|
||||
g_slist_free (mateconf_items);
|
||||
g_free (key);
|
||||
}
|
||||
|
||||
static gboolean
|
||||
remove_item (GtkListStore *store,
|
||||
const gchar *text)
|
||||
{
|
||||
GtkTreeIter iter;
|
||||
|
||||
g_return_val_if_fail (text != NULL, FALSE);
|
||||
|
||||
if (!gtk_tree_model_get_iter_first (GTK_TREE_MODEL (store), &iter))
|
||||
return FALSE;
|
||||
|
||||
do
|
||||
{
|
||||
gchar *item_text;
|
||||
|
||||
gtk_tree_model_get (GTK_TREE_MODEL (store),
|
||||
&iter,
|
||||
0,
|
||||
&item_text,
|
||||
-1);
|
||||
|
||||
if (item_text != NULL &&
|
||||
strcmp (item_text, text) == 0)
|
||||
{
|
||||
gtk_list_store_remove (store, &iter);
|
||||
g_free (item_text);
|
||||
return TRUE;
|
||||
}
|
||||
|
||||
g_free (item_text);
|
||||
|
||||
} while (gtk_tree_model_iter_next (GTK_TREE_MODEL (store), &iter));
|
||||
|
||||
return FALSE;
|
||||
}
|
||||
|
||||
static void
|
||||
clamp_list_store (GtkListStore *store,
|
||||
guint max)
|
||||
{
|
||||
GtkTreePath *path;
|
||||
GtkTreeIter iter;
|
||||
|
||||
/* -1 because TreePath counts from 0 */
|
||||
path = gtk_tree_path_new_from_indices (max - 1, -1);
|
||||
|
||||
if (gtk_tree_model_get_iter (GTK_TREE_MODEL (store), &iter, path))
|
||||
{
|
||||
while (1)
|
||||
{
|
||||
if (!gtk_list_store_remove (store, &iter))
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
gtk_tree_path_free (path);
|
||||
}
|
||||
|
||||
static void
|
||||
insert_history_item (GeditHistoryEntry *entry,
|
||||
const gchar *text,
|
||||
gboolean prepend)
|
||||
{
|
||||
GtkListStore *store;
|
||||
GtkTreeIter iter;
|
||||
|
||||
if (g_utf8_strlen (text, -1) <= MIN_ITEM_LEN)
|
||||
return;
|
||||
|
||||
store = get_history_store (entry);
|
||||
|
||||
/* remove the text from the store if it was already
|
||||
* present. If it wasn't, clamp to max history - 1
|
||||
* before inserting the new row, otherwise appending
|
||||
* would not work */
|
||||
|
||||
if (!remove_item (store, text))
|
||||
clamp_list_store (store,
|
||||
entry->priv->history_length - 1);
|
||||
|
||||
if (prepend)
|
||||
gtk_list_store_insert (store, &iter, 0);
|
||||
else
|
||||
gtk_list_store_append (store, &iter);
|
||||
|
||||
gtk_list_store_set (store,
|
||||
&iter,
|
||||
0,
|
||||
text,
|
||||
-1);
|
||||
|
||||
gedit_history_entry_save_history (entry);
|
||||
}
|
||||
|
||||
void
|
||||
gedit_history_entry_prepend_text (GeditHistoryEntry *entry,
|
||||
const gchar *text)
|
||||
{
|
||||
g_return_if_fail (GEDIT_IS_HISTORY_ENTRY (entry));
|
||||
g_return_if_fail (text != NULL);
|
||||
|
||||
insert_history_item (entry, text, TRUE);
|
||||
}
|
||||
|
||||
void
|
||||
gedit_history_entry_append_text (GeditHistoryEntry *entry,
|
||||
const gchar *text)
|
||||
{
|
||||
g_return_if_fail (GEDIT_IS_HISTORY_ENTRY (entry));
|
||||
g_return_if_fail (text != NULL);
|
||||
|
||||
insert_history_item (entry, text, FALSE);
|
||||
}
|
||||
|
||||
static void
|
||||
gedit_history_entry_load_history (GeditHistoryEntry *entry)
|
||||
{
|
||||
GSList *mateconf_items, *l;
|
||||
GtkListStore *store;
|
||||
GtkTreeIter iter;
|
||||
gchar *key;
|
||||
guint i;
|
||||
|
||||
g_return_if_fail (GEDIT_IS_HISTORY_ENTRY (entry));
|
||||
|
||||
store = get_history_store (entry);
|
||||
key = get_history_key (entry);
|
||||
|
||||
mateconf_items = mateconf_client_get_list (entry->priv->mateconf_client,
|
||||
key,
|
||||
MATECONF_VALUE_STRING,
|
||||
NULL);
|
||||
|
||||
gtk_list_store_clear (store);
|
||||
|
||||
for (l = mateconf_items, i = 0;
|
||||
l != NULL && i < entry->priv->history_length;
|
||||
l = l->next, i++)
|
||||
{
|
||||
gtk_list_store_append (store, &iter);
|
||||
gtk_list_store_set (store,
|
||||
&iter,
|
||||
0,
|
||||
l->data,
|
||||
-1);
|
||||
}
|
||||
|
||||
g_slist_foreach (mateconf_items, (GFunc) g_free, NULL);
|
||||
g_slist_free (mateconf_items);
|
||||
g_free (key);
|
||||
}
|
||||
|
||||
void
|
||||
gedit_history_entry_clear (GeditHistoryEntry *entry)
|
||||
{
|
||||
GtkListStore *store;
|
||||
|
||||
g_return_if_fail (GEDIT_IS_HISTORY_ENTRY (entry));
|
||||
|
||||
store = get_history_store (entry);
|
||||
gtk_list_store_clear (store);
|
||||
|
||||
gedit_history_entry_save_history (entry);
|
||||
}
|
||||
|
||||
static void
|
||||
gedit_history_entry_init (GeditHistoryEntry *entry)
|
||||
{
|
||||
GeditHistoryEntryPrivate *priv;
|
||||
|
||||
priv = GEDIT_HISTORY_ENTRY_GET_PRIVATE (entry);
|
||||
entry->priv = priv;
|
||||
|
||||
priv->history_id = NULL;
|
||||
priv->history_length = GEDIT_HISTORY_ENTRY_HISTORY_LENGTH_DEFAULT;
|
||||
|
||||
priv->completion = NULL;
|
||||
|
||||
priv->mateconf_client = mateconf_client_get_default ();
|
||||
}
|
||||
|
||||
void
|
||||
gedit_history_entry_set_history_length (GeditHistoryEntry *entry,
|
||||
guint history_length)
|
||||
{
|
||||
g_return_if_fail (GEDIT_IS_HISTORY_ENTRY (entry));
|
||||
g_return_if_fail (history_length > 0);
|
||||
|
||||
entry->priv->history_length = history_length;
|
||||
|
||||
/* TODO: update if we currently have more items than max */
|
||||
}
|
||||
|
||||
guint
|
||||
gedit_history_entry_get_history_length (GeditHistoryEntry *entry)
|
||||
{
|
||||
g_return_val_if_fail (GEDIT_IS_HISTORY_ENTRY (entry), 0);
|
||||
|
||||
return entry->priv->history_length;
|
||||
}
|
||||
|
||||
gchar *
|
||||
gedit_history_entry_get_history_id (GeditHistoryEntry *entry)
|
||||
{
|
||||
g_return_val_if_fail (GEDIT_IS_HISTORY_ENTRY (entry), NULL);
|
||||
|
||||
return g_strdup (entry->priv->history_id);
|
||||
}
|
||||
|
||||
void
|
||||
gedit_history_entry_set_enable_completion (GeditHistoryEntry *entry,
|
||||
gboolean enable)
|
||||
{
|
||||
g_return_if_fail (GEDIT_IS_HISTORY_ENTRY (entry));
|
||||
|
||||
if (enable)
|
||||
{
|
||||
if (entry->priv->completion != NULL)
|
||||
return;
|
||||
|
||||
entry->priv->completion = gtk_entry_completion_new ();
|
||||
gtk_entry_completion_set_model (entry->priv->completion,
|
||||
GTK_TREE_MODEL (get_history_store (entry)));
|
||||
|
||||
/* Use model column 0 as the text column */
|
||||
gtk_entry_completion_set_text_column (entry->priv->completion, 0);
|
||||
|
||||
gtk_entry_completion_set_minimum_key_length (entry->priv->completion,
|
||||
MIN_ITEM_LEN);
|
||||
|
||||
gtk_entry_completion_set_popup_completion (entry->priv->completion, FALSE);
|
||||
gtk_entry_completion_set_inline_completion (entry->priv->completion, TRUE);
|
||||
|
||||
/* Assign the completion to the entry */
|
||||
gtk_entry_set_completion (GTK_ENTRY (gedit_history_entry_get_entry(entry)),
|
||||
entry->priv->completion);
|
||||
}
|
||||
else
|
||||
{
|
||||
if (entry->priv->completion == NULL)
|
||||
return;
|
||||
|
||||
gtk_entry_set_completion (GTK_ENTRY (gedit_history_entry_get_entry (entry)),
|
||||
NULL);
|
||||
|
||||
g_object_unref (entry->priv->completion);
|
||||
|
||||
entry->priv->completion = NULL;
|
||||
}
|
||||
}
|
||||
|
||||
gboolean
|
||||
gedit_history_entry_get_enable_completion (GeditHistoryEntry *entry)
|
||||
{
|
||||
g_return_val_if_fail (GEDIT_IS_HISTORY_ENTRY (entry), FALSE);
|
||||
|
||||
return entry->priv->completion != NULL;
|
||||
}
|
||||
|
||||
GtkWidget *
|
||||
gedit_history_entry_new (const gchar *history_id,
|
||||
gboolean enable_completion)
|
||||
{
|
||||
GtkWidget *ret;
|
||||
GtkListStore *store;
|
||||
|
||||
g_return_val_if_fail (history_id != NULL, NULL);
|
||||
|
||||
/* Note that we are setting the model, so
|
||||
* user must be careful to always manipulate
|
||||
* data in the history through gedit_history_entry_
|
||||
* functions.
|
||||
*/
|
||||
|
||||
store = gtk_list_store_new (1, G_TYPE_STRING);
|
||||
|
||||
ret = g_object_new (GEDIT_TYPE_HISTORY_ENTRY,
|
||||
"history-id", history_id,
|
||||
"model", store,
|
||||
"text-column", 0,
|
||||
NULL);
|
||||
|
||||
g_object_unref (store);
|
||||
|
||||
/* loading has to happen after the model
|
||||
* has been set. However the model is not a
|
||||
* G_PARAM_CONSTRUCT property of GtkComboBox
|
||||
* so we cannot do this in the constructor.
|
||||
* For now we simply do here since this widget is
|
||||
* not bound to other programming languages.
|
||||
* A maybe better alternative is to override the
|
||||
* model property of combobox and mark CONTRUCT_ONLY.
|
||||
* This would also ensure that the model cannot be
|
||||
* set explicitely at a later time.
|
||||
*/
|
||||
gedit_history_entry_load_history (GEDIT_HISTORY_ENTRY (ret));
|
||||
|
||||
gedit_history_entry_set_enable_completion (GEDIT_HISTORY_ENTRY (ret),
|
||||
enable_completion);
|
||||
|
||||
return ret;
|
||||
}
|
||||
|
||||
/*
|
||||
* Utility function to get the editable text entry internal widget.
|
||||
* I would prefer to not expose this implementation detail and
|
||||
* simply make the GeditHistoryEntry widget implement the
|
||||
* GtkEditable interface. Unfortunately both GtkEditable and
|
||||
* GtkComboBox have a "changed" signal and I am not sure how to
|
||||
* handle the conflict.
|
||||
*/
|
||||
GtkWidget *
|
||||
gedit_history_entry_get_entry (GeditHistoryEntry *entry)
|
||||
{
|
||||
g_return_val_if_fail (GEDIT_IS_HISTORY_ENTRY (entry), NULL);
|
||||
|
||||
return gtk_bin_get_child (GTK_BIN (entry));
|
||||
}
|
||||
|
||||
static void
|
||||
escape_cell_data_func (GtkTreeViewColumn *col,
|
||||
GtkCellRenderer *renderer,
|
||||
GtkTreeModel *model,
|
||||
GtkTreeIter *iter,
|
||||
GeditHistoryEntryEscapeFunc escape_func)
|
||||
{
|
||||
gchar *str;
|
||||
gchar *escaped;
|
||||
|
||||
gtk_tree_model_get (model, iter, 0, &str, -1);
|
||||
escaped = escape_func (str);
|
||||
g_object_set (renderer, "text", escaped, NULL);
|
||||
|
||||
g_free (str);
|
||||
g_free (escaped);
|
||||
}
|
||||
|
||||
void
|
||||
gedit_history_entry_set_escape_func (GeditHistoryEntry *entry,
|
||||
GeditHistoryEntryEscapeFunc escape_func)
|
||||
{
|
||||
GList *cells;
|
||||
|
||||
g_return_if_fail (GEDIT_IS_HISTORY_ENTRY (entry));
|
||||
|
||||
cells = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (entry));
|
||||
|
||||
/* We only have one cell renderer */
|
||||
g_return_if_fail (cells->data != NULL && cells->next == NULL);
|
||||
|
||||
if (escape_func != NULL)
|
||||
gtk_cell_layout_set_cell_data_func (GTK_CELL_LAYOUT (entry),
|
||||
GTK_CELL_RENDERER (cells->data),
|
||||
(GtkCellLayoutDataFunc) escape_cell_data_func,
|
||||
escape_func,
|
||||
NULL);
|
||||
else
|
||||
gtk_cell_layout_set_cell_data_func (GTK_CELL_LAYOUT (entry),
|
||||
GTK_CELL_RENDERER (cells->data),
|
||||
NULL,
|
||||
NULL,
|
||||
NULL);
|
||||
|
||||
g_list_free (cells);
|
||||
}
|
||||
Reference in New Issue
Block a user