[gedit] GeditDocument: add property use-gvfs-metadata
- From: Sébastien Wilmet <swilmet src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gedit] GeditDocument: add property use-gvfs-metadata
- Date: Sat, 2 May 2015 19:15:02 +0000 (UTC)
commit 7e16e551ba1a25888ddc9be22007e8d2bcda360d
Author: Sébastien Wilmet <swilmet gnome org>
Date: Wed Apr 29 14:25:51 2015 +0200
GeditDocument: add property use-gvfs-metadata
The goal is to make the gedit-document code reusable for other apps.
Later, it'll be easier if we don't depend too much on config.h.
From config.h, only ENABLE_GVFS_METADATA is used in gedit-document.
Create a property for that setting, and configure it at only one place,
in gedit_document_new().
In the future, a new subclass of GtkSourceBuffer can be created, e.g.
GcodeDocument, and GeditDocument can be a subclass of GcodeDocument.
GcodeDocument should not depend on config.h, so that the code can be
copied more easily in other apps without the need to add build time
configuration.
gedit/Makefile.am | 10 +--
gedit/gedit-document.c | 183 +++++++++++++++++++++++++++++------------------
2 files changed, 115 insertions(+), 78 deletions(-)
---
diff --git a/gedit/Makefile.am b/gedit/Makefile.am
index 995207d..b084493 100644
--- a/gedit/Makefile.am
+++ b/gedit/Makefile.am
@@ -116,6 +116,7 @@ gedit_NOINST_H_FILES = \
gedit/gedit-history-entry.h \
gedit/gedit-io-error-info-bar.h \
gedit/gedit-menu-stack-switcher.h \
+ gedit/gedit-metadata-manager.h \
gedit/gedit-multi-notebook.h \
gedit/gedit-notebook.h \
gedit/gedit-notebook-popup-menu.h \
@@ -154,10 +155,6 @@ gedit_INST_H_FILES = \
gedit/gedit-window.h \
gedit/gedit-window-activatable.h
-if !ENABLE_GVFS_METADATA
-gedit_NOINST_H_FILES += gedit/gedit-metadata-manager.h
-endif
-
gedit_headerdir = $(prefix)/include/gedit-$(GEDIT_API_VERSION)/gedit
gedit_header_HEADERS = $(gedit_INST_H_FILES)
@@ -195,6 +192,7 @@ gedit_libgedit_c_files = \
gedit/gedit-menu-stack-switcher.c \
gedit/gedit-message-bus.c \
gedit/gedit-message.c \
+ gedit/gedit-metadata-manager.c \
gedit/gedit-multi-notebook.c \
gedit/gedit-notebook.c \
gedit/gedit-notebook-popup-menu.c \
@@ -224,10 +222,6 @@ gedit_libgedit_la_SOURCES = \
$(gedit_NOINST_H_FILES) \
$(gedit_INST_H_FILES)
-if !ENABLE_GVFS_METADATA
-gedit_libgedit_la_SOURCES += gedit/gedit-metadata-manager.c
-endif
-
gedit_ENUM_TYPES = \
gedit/gedit-notebook.h \
$(gedit_INST_H_FILES)
diff --git a/gedit/gedit-document.c b/gedit/gedit-document.c
index 8956623..b92ffae 100644
--- a/gedit/gedit-document.c
+++ b/gedit/gedit-document.c
@@ -5,7 +5,7 @@
* Copyright (C) 1998, 1999 Alex Roberts, Evan Lawrence
* Copyright (C) 2000, 2001 Chema Celorio, Paolo Maggi
* Copyright (C) 2002-2005 Paolo Maggi
- * Copyright (C) 2014 Sébastien Wilmet
+ * Copyright (C) 2014-2015 Sébastien Wilmet
*
* 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
@@ -34,12 +34,9 @@
#include "gedit-settings.h"
#include "gedit-debug.h"
#include "gedit-utils.h"
-
-#ifndef ENABLE_GVFS_METADATA
#include "gedit-metadata-manager.h"
-#else
+
#define METADATA_QUERY "metadata::*"
-#endif
#define NO_LANGUAGE_NAME "_NORMAL_"
@@ -75,6 +72,7 @@ typedef struct
guint deleted : 1;
guint language_set_by_user : 1;
guint mtime_set : 1;
+ guint use_gvfs_metadata : 1;
/* The search is empty if there is no search context, or if the
* search text is empty. It is used for the sensitivity of some menu
@@ -95,7 +93,8 @@ enum
PROP_CONTENT_TYPE,
PROP_MIME_TYPE,
PROP_READ_ONLY,
- PROP_EMPTY_SEARCH
+ PROP_EMPTY_SEARCH,
+ PROP_USE_GVFS_METADATA
};
enum
@@ -272,6 +271,10 @@ gedit_document_get_property (GObject *object,
g_value_set_boolean (value, priv->empty_search);
break;
+ case PROP_USE_GVFS_METADATA:
+ g_value_set_boolean (value, priv->use_gvfs_metadata);
+ break;
+
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
@@ -285,6 +288,7 @@ gedit_document_set_property (GObject *object,
GParamSpec *pspec)
{
GeditDocument *doc = GEDIT_DOCUMENT (object);
+ GeditDocumentPrivate *priv = gedit_document_get_instance_private (doc);
switch (prop_id)
{
@@ -296,6 +300,10 @@ gedit_document_set_property (GObject *object,
gedit_document_set_content_type (doc, g_value_get_string (value));
break;
+ case PROP_USE_GVFS_METADATA:
+ priv->use_gvfs_metadata = g_value_get_boolean (value);
+ break;
+
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
@@ -447,6 +455,27 @@ gedit_document_class_init (GeditDocumentClass *klass)
G_PARAM_READABLE |
G_PARAM_STATIC_STRINGS));
+ /**
+ * GeditDocument:use-gvfs-metadata:
+ *
+ * Whether to use GVFS metadata. If %FALSE, use the gedit metadata
+ * manager that stores the metadata in an XML file in the user cache
+ * directory.
+ *
+ * <warning>
+ * The property is used internally by gedit. It must not be used in a
+ * gedit plugin. The property can be modified or removed at any time.
+ * </warning>
+ */
+ g_object_class_install_property (object_class, PROP_USE_GVFS_METADATA,
+ g_param_spec_boolean ("use-gvfs-metadata",
+ "Use GVFS metadata",
+ "",
+ TRUE,
+ G_PARAM_READWRITE |
+ G_PARAM_CONSTRUCT_ONLY |
+ G_PARAM_STATIC_STRINGS));
+
/* This signal is used to update the cursor position in the statusbar,
* it's emitted either when the insert mark is moved explicitely or
* when the buffer changes (insert/delete).
@@ -747,13 +776,11 @@ on_location_changed (GtkSourceFile *file,
g_object_notify (G_OBJECT (doc), "shortname");
}
-#ifdef ENABLE_GVFS_METADATA
-
- /* load metadata for this location: we load sync since metadata is
+ /* Load metadata for this location: we load sync since metadata is
* always local so it should be fast and we need the information
* right after the location was set.
*/
- if (location != NULL)
+ if (priv->use_gvfs_metadata && location != NULL)
{
GError *error = NULL;
@@ -784,7 +811,6 @@ on_location_changed (GtkSourceFile *file,
g_error_free (error);
}
}
-#endif
}
static void
@@ -841,7 +867,17 @@ gedit_document_init (GeditDocument *doc)
GeditDocument *
gedit_document_new (void)
{
- return g_object_new (GEDIT_TYPE_DOCUMENT, NULL);
+ gboolean use_gvfs_metadata;
+
+#ifdef ENABLE_GVFS_METADATA
+ use_gvfs_metadata = TRUE;
+#else
+ use_gvfs_metadata = FALSE;
+#endif
+
+ return g_object_new (GEDIT_TYPE_DOCUMENT,
+ "use-gvfs-metadata", use_gvfs_metadata,
+ NULL);
}
static gchar *
@@ -1688,17 +1724,13 @@ gedit_document_get_compression_type (GeditDocument *doc)
return gtk_source_file_get_compression_type (priv->file);
}
-#ifndef ENABLE_GVFS_METADATA
-gchar *
-gedit_document_get_metadata (GeditDocument *doc,
- const gchar *key)
+static gchar *
+get_metadata_from_metadata_manager (GeditDocument *doc,
+ const gchar *key)
{
GeditDocumentPrivate *priv;
GFile *location;
- g_return_val_if_fail (GEDIT_IS_DOCUMENT (doc), NULL);
- g_return_val_if_fail (key != NULL, NULL);
-
priv = gedit_document_get_instance_private (doc);
location = gtk_source_file_get_location (priv->file);
@@ -1711,43 +1743,54 @@ gedit_document_get_metadata (GeditDocument *doc,
return NULL;
}
-void
-gedit_document_set_metadata (GeditDocument *doc,
- const gchar *first_key,
- ...)
+static gchar *
+get_metadata_from_gvfs (GeditDocument *doc,
+ const gchar *key)
{
GeditDocumentPrivate *priv;
- GFile *location;
- const gchar *key;
- const gchar *value;
- va_list var_args;
-
- g_return_if_fail (GEDIT_IS_DOCUMENT (doc));
- g_return_if_fail (first_key != NULL);
priv = gedit_document_get_instance_private (doc);
- location = gtk_source_file_get_location (priv->file);
-
- if (location == NULL)
+ if (priv->metadata_info != NULL &&
+ g_file_info_has_attribute (priv->metadata_info, key))
{
- /* Can't set metadata for untitled documents */
- return;
+ return g_strdup (g_file_info_get_attribute_string (priv->metadata_info, key));
}
- va_start (var_args, first_key);
+ return NULL;
+}
- for (key = first_key; key; key = va_arg (var_args, const gchar *))
+static void
+set_gvfs_metadata (GeditDocument *doc,
+ GFileInfo *info,
+ const gchar *key,
+ const gchar *value)
+{
+ GeditDocumentPrivate *priv;
+
+ priv = gedit_document_get_instance_private (doc);
+
+ if (value != NULL)
{
- value = va_arg (var_args, const gchar *);
- gedit_metadata_manager_set (location, key, value);
+ g_file_info_set_attribute_string (info, key, value);
+
+ if (priv->metadata_info != NULL)
+ {
+ g_file_info_set_attribute_string (priv->metadata_info, key, value);
+ }
}
+ else
+ {
+ /* Unset the key */
+ g_file_info_remove_attribute (info, key);
- va_end (var_args);
+ if (priv->metadata_info != NULL)
+ {
+ g_file_info_remove_attribute (priv->metadata_info, key);
+ }
+ }
}
-#else
-
/**
* gedit_document_get_metadata:
* @doc: a #GeditDocument
@@ -1768,13 +1811,12 @@ gedit_document_get_metadata (GeditDocument *doc,
priv = gedit_document_get_instance_private (doc);
- if (priv->metadata_info != NULL &&
- g_file_info_has_attribute (priv->metadata_info, key))
+ if (priv->use_gvfs_metadata)
{
- return g_strdup (g_file_info_get_attribute_string (priv->metadata_info, key));
+ return get_metadata_from_gvfs (doc, key);
}
- return NULL;
+ return get_metadata_from_metadata_manager (doc, key);
}
/**
@@ -1792,51 +1834,53 @@ gedit_document_set_metadata (GeditDocument *doc,
...)
{
GeditDocumentPrivate *priv;
+ GFile *location;
const gchar *key;
- const gchar *value;
va_list var_args;
- GFileInfo *info;
- GFile *location;
+ GFileInfo *info = NULL;
g_return_if_fail (GEDIT_IS_DOCUMENT (doc));
g_return_if_fail (first_key != NULL);
priv = gedit_document_get_instance_private (doc);
- info = g_file_info_new ();
+ location = gtk_source_file_get_location (priv->file);
+
+ /* With the metadata manager, can't set metadata for untitled documents.
+ * With GVFS metadata, if the location is NULL the metadata is stored in
+ * priv->metadata_info, so that it can be saved later if the document is
+ * saved.
+ */
+ if (!priv->use_gvfs_metadata && location == NULL)
+ {
+ return;
+ }
+
+ if (priv->use_gvfs_metadata)
+ {
+ info = g_file_info_new ();
+ }
va_start (var_args, first_key);
for (key = first_key; key; key = va_arg (var_args, const gchar *))
{
- value = va_arg (var_args, const gchar *);
+ const gchar *value = va_arg (var_args, const gchar *);
- if (value != NULL)
+ if (priv->use_gvfs_metadata)
{
- g_file_info_set_attribute_string (info, key, value);
-
- if (priv->metadata_info != NULL)
- {
- g_file_info_set_attribute_string (priv->metadata_info, key, value);
- }
+ /* Collect the metadata into @info. */
+ set_gvfs_metadata (doc, info, key, value);
}
else
{
- /* Unset the key */
- g_file_info_remove_attribute (info, key);
-
- if (priv->metadata_info != NULL)
- {
- g_file_info_remove_attribute (priv->metadata_info, key);
- }
+ gedit_metadata_manager_set (location, key, value);
}
}
va_end (var_args);
- location = gtk_source_file_get_location (priv->file);
-
- if (location != NULL)
+ if (priv->use_gvfs_metadata && location != NULL)
{
GError *error = NULL;
@@ -1867,9 +1911,8 @@ gedit_document_set_metadata (GeditDocument *doc,
}
}
- g_object_unref (info);
+ g_clear_object (&info);
}
-#endif
static void
update_empty_search (GeditDocument *doc)
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
