GNOME.org
 

[gnome-builder: 60/139] buffer-monitor: add buffer-monitor plugin

commit 5139777a97c4caf37d8a7fff08ddfcc0e016ead2
Author: Christian Hergert <chergert redhat com>
Date:   Wed Jan 9 17:03:22 2019 -0800

    buffer-monitor: add buffer-monitor plugin
    
    The buffer-monitor code was extracted from the buffer-manager to track
    when the buffer has been modified on disk outside the control of Builder.

 src/plugins/buffer-monitor/buffer-monitor-plugin.c |  36 +++
 .../buffer-monitor/buffer-monitor.gresource.xml    |   6 +
 src/plugins/buffer-monitor/buffer-monitor.plugin   |  10 +
 .../gbp-buffer-monitor-buffer-addin.c              | 277 +++++++++++++++++++++
 .../gbp-buffer-monitor-buffer-addin.h              |  31 +++
 src/plugins/buffer-monitor/meson.build             |  12 +
 6 files changed, 372 insertions(+)
---
diff --git a/src/plugins/buffer-monitor/buffer-monitor-plugin.c 
b/src/plugins/buffer-monitor/buffer-monitor-plugin.c
new file mode 100644
index 000000000..b5509a40d
--- /dev/null
+++ b/src/plugins/buffer-monitor/buffer-monitor-plugin.c
@@ -0,0 +1,36 @@
+/* buffer-monitor-plugin.c
+ *
+ * Copyright 2018-2019 Christian Hergert <chergert redhat com>
+ *
+ * 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 3 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, see <http://www.gnu.org/licenses/>.
+ *
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ */
+
+#define G_LOG_DOMAIN "buffer-monitor-plugin"
+
+#include "config.h"
+
+#include <libpeas/peas.h>
+#include <libide-code.h>
+
+#include "gbp-buffer-monitor-buffer-addin.h"
+
+_IDE_EXTERN void
+_gbp_buffer_monitor_register_types (PeasObjectModule *module)
+{
+  peas_object_module_register_extension_type (module,
+                                              IDE_TYPE_BUFFER_ADDIN,
+                                              GBP_TYPE_BUFFER_MONITOR_BUFFER_ADDIN);
+}
diff --git a/src/plugins/buffer-monitor/buffer-monitor.gresource.xml 
b/src/plugins/buffer-monitor/buffer-monitor.gresource.xml
new file mode 100644
index 000000000..24ebf6a43
--- /dev/null
+++ b/src/plugins/buffer-monitor/buffer-monitor.gresource.xml
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<gresources>
+  <gresource prefix="/plugins/buffer-monitor">
+    <file>buffer-monitor.plugin</file>
+  </gresource>
+</gresources>
diff --git a/src/plugins/buffer-monitor/buffer-monitor.plugin 
b/src/plugins/buffer-monitor/buffer-monitor.plugin
new file mode 100644
index 000000000..e03a533a4
--- /dev/null
+++ b/src/plugins/buffer-monitor/buffer-monitor.plugin
@@ -0,0 +1,10 @@
+[Plugin]
+Authors=Christian Hergert <christian hergert me>
+Builtin=true
+Copyright=Copyright © 2018 Christian Hergert
+Depends=editor;
+Description=Watches buffers for changes on disk
+Embedded=_gbp_buffer_monitor_register_types
+Hidden=true
+Module=buffer-monitor
+Name=Buffer Monitor
diff --git a/src/plugins/buffer-monitor/gbp-buffer-monitor-buffer-addin.c 
b/src/plugins/buffer-monitor/gbp-buffer-monitor-buffer-addin.c
new file mode 100644
index 000000000..71edf3c16
--- /dev/null
+++ b/src/plugins/buffer-monitor/gbp-buffer-monitor-buffer-addin.c
@@ -0,0 +1,277 @@
+/* gbp-buffer-monitor-buffer-addin.c
+ *
+ * Copyright 2018-2019 Christian Hergert <chergert redhat com>
+ *
+ * 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 3 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, see <http://www.gnu.org/licenses/>.
+ *
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ */
+
+#define G_LOG_DOMAIN "gbp-buffer-monitor-buffer-addin"
+
+#include "config.h"
+
+#include <libide-code.h>
+#include <string.h>
+
+#include "ide-buffer-private.h"
+
+#include "gbp-buffer-monitor-buffer-addin.h"
+
+struct _GbpBufferMonitorBufferAddin
+{
+  GObject       parent_instance;
+
+  IdeBuffer    *buffer;
+  GFileMonitor *monitor;
+
+  GTimeVal      mtime;
+  guint         mtime_set : 1;
+};
+
+static void
+gbp_buffer_monitor_buffer_addin_check_for_change (GbpBufferMonitorBufferAddin *self,
+                                                  GFile                       *file)
+{
+  g_autoptr(GFileInfo) info = NULL;
+
+  g_assert (GBP_IS_BUFFER_MONITOR_BUFFER_ADDIN (self));
+  g_assert (IDE_IS_BUFFER (self->buffer));
+  g_assert (G_IS_FILE (file));
+
+  info = g_file_query_info (file,
+                            G_FILE_ATTRIBUTE_TIME_MODIFIED,
+                            G_FILE_QUERY_INFO_NONE,
+                            NULL,
+                            NULL);
+
+  if (info == NULL)
+    {
+      GtkTextIter iter;
+
+      /* If we get here, the file likely does not exist on disk. We might have
+       * a situation where the file was moved out from under the user. If so,
+       * then we should mark the buffer as modified so that the user can save
+       * it going forward.
+       */
+
+      gtk_text_buffer_get_end_iter (GTK_TEXT_BUFFER (self->buffer), &iter);
+      if (gtk_text_iter_get_offset (&iter) != 0)
+        gtk_text_buffer_set_modified (GTK_TEXT_BUFFER (self->buffer), TRUE);
+    }
+
+  if (!self->mtime_set)
+    return;
+
+  if (g_file_info_has_attribute (info, G_FILE_ATTRIBUTE_TIME_MODIFIED))
+    {
+      GTimeVal mtime;
+
+      g_file_info_get_modification_time (info, &mtime);
+
+      if (memcmp (&mtime, &self->mtime, sizeof mtime) != 0)
+        {
+          self->mtime_set = FALSE;
+
+          /* Cancel any further requests from being delivered, we don't care
+           * until the file has been re-loaded or saved again.
+           */
+          if (self->monitor != NULL)
+            {
+              g_file_monitor_cancel (self->monitor);
+              g_clear_object (&self->monitor);
+            }
+
+          /* Let the buffer propagate the status to the UI */
+          _ide_buffer_set_changed_on_volume (self->buffer, TRUE);
+        }
+    }
+}
+
+static void
+gbp_buffer_monitor_buffer_addin_file_changed_cb (GbpBufferMonitorBufferAddin *self,
+                                                 GFile                       *file,
+                                                 GFile                       *other_file,
+                                                 GFileMonitorEvent            event,
+                                                 GFileMonitor                *monitor)
+{
+  GFile *expected;
+
+  g_assert (GBP_IS_BUFFER_MONITOR_BUFFER_ADDIN (self));
+  g_assert (G_IS_FILE (file));
+  g_assert (!other_file || G_IS_FILE (other_file));
+  g_assert (G_IS_FILE_MONITOR (monitor));
+  g_assert (IDE_IS_BUFFER (self->buffer));
+
+  if (g_file_monitor_is_cancelled (monitor))
+    return;
+
+  expected = ide_buffer_get_file (self->buffer);
+  if (!g_file_equal (expected, file))
+    return;
+
+  if (event == G_FILE_MONITOR_EVENT_CHANGED ||
+      event == G_FILE_MONITOR_EVENT_DELETED)
+    gbp_buffer_monitor_buffer_addin_check_for_change (self, file);
+}
+
+static void
+gbp_buffer_monitor_buffer_addin_setup_monitor (GbpBufferMonitorBufferAddin *self,
+                                               GFile                       *file)
+{
+  g_assert (GBP_IS_BUFFER_MONITOR_BUFFER_ADDIN (self));
+  g_assert (!file || G_IS_FILE (file));
+
+  if (self->monitor != NULL)
+    {
+      g_file_monitor_cancel (self->monitor);
+      g_clear_object (&self->monitor);
+    }
+
+  if (file != NULL)
+    {
+      g_autoptr(GFileInfo) info = NULL;
+
+      info = g_file_query_info (file,
+                                G_FILE_ATTRIBUTE_TIME_MODIFIED","
+                                G_FILE_ATTRIBUTE_ACCESS_CAN_WRITE,
+                                G_FILE_QUERY_INFO_NONE,
+                                NULL,
+                                NULL);
+
+      self->mtime_set = FALSE;
+
+      if (info != NULL)
+        {
+          if (g_file_info_has_attribute (info, G_FILE_ATTRIBUTE_ACCESS_CAN_WRITE))
+            _ide_buffer_set_read_only (self->buffer,
+                                       !g_file_info_get_attribute_boolean (info, 
G_FILE_ATTRIBUTE_ACCESS_CAN_WRITE));
+
+          if (g_file_info_has_attribute (info, G_FILE_ATTRIBUTE_TIME_MODIFIED))
+            {
+              g_file_info_get_modification_time (info, &self->mtime);
+              self->mtime_set = TRUE;
+            }
+        }
+
+      self->monitor = g_file_monitor_file (file,
+                                           G_FILE_MONITOR_NONE,
+                                           NULL,
+                                           NULL);
+
+      if (self->monitor != NULL)
+        {
+          g_file_monitor_set_rate_limit (self->monitor, 500);
+          g_signal_connect_object (self->monitor,
+                                   "changed",
+                                   G_CALLBACK (gbp_buffer_monitor_buffer_addin_file_changed_cb),
+                                   self,
+                                   G_CONNECT_SWAPPED);
+        }
+    }
+}
+
+static void
+gbp_buffer_monitor_buffer_addin_load (IdeBufferAddin *addin,
+                                      IdeBuffer      *buffer)
+{
+  GbpBufferMonitorBufferAddin *self = (GbpBufferMonitorBufferAddin *)addin;
+  GFile *file;
+
+  g_assert (GBP_IS_BUFFER_MONITOR_BUFFER_ADDIN (self));
+  g_assert (IDE_IS_BUFFER (buffer));
+
+  self->buffer = buffer;
+
+  file = ide_buffer_get_file (buffer);
+  gbp_buffer_monitor_buffer_addin_setup_monitor (self, file);
+}
+
+static void
+gbp_buffer_monitor_buffer_addin_unload (IdeBufferAddin *addin,
+                                        IdeBuffer      *buffer)
+{
+  GbpBufferMonitorBufferAddin *self = (GbpBufferMonitorBufferAddin *)addin;
+
+  g_assert (GBP_IS_BUFFER_MONITOR_BUFFER_ADDIN (self));
+  g_assert (IDE_IS_BUFFER (buffer));
+
+  gbp_buffer_monitor_buffer_addin_setup_monitor (self, NULL);
+
+  self->buffer = NULL;
+}
+
+static void
+gbp_buffer_monitor_buffer_addin_save_file (IdeBufferAddin *addin,
+                                           IdeBuffer      *buffer,
+                                           GFile          *file)
+{
+  GbpBufferMonitorBufferAddin *self = (GbpBufferMonitorBufferAddin *)addin;
+  GFile *current;
+
+  g_assert (IDE_IS_BUFFER_ADDIN (addin));
+  g_assert (IDE_IS_BUFFER (buffer));
+  g_assert (G_IS_FILE (file));
+
+  current = ide_buffer_get_file (buffer);
+
+  if (!g_file_equal (file, current))
+    return;
+
+  /* Disable monitors while saving */
+  gbp_buffer_monitor_buffer_addin_setup_monitor (self, NULL);
+}
+
+static void
+gbp_buffer_monitor_buffer_addin_file_saved (IdeBufferAddin *addin,
+                                            IdeBuffer      *buffer,
+                                            GFile          *file)
+{
+  GbpBufferMonitorBufferAddin *self = (GbpBufferMonitorBufferAddin *)addin;
+  GFile *current;
+
+  g_assert (IDE_IS_BUFFER_ADDIN (addin));
+  g_assert (IDE_IS_BUFFER (buffer));
+  g_assert (G_IS_FILE (file));
+
+  current = ide_buffer_get_file (buffer);
+
+  if (!g_file_equal (file, current))
+    return;
+
+  /* Restore any file monitors */
+  gbp_buffer_monitor_buffer_addin_setup_monitor (self, current);
+}
+
+static void
+buffer_addin_iface_init (IdeBufferAddinInterface *iface)
+{
+  iface->load = gbp_buffer_monitor_buffer_addin_load;
+  iface->unload = gbp_buffer_monitor_buffer_addin_unload;
+  iface->save_file = gbp_buffer_monitor_buffer_addin_save_file;
+  iface->file_saved = gbp_buffer_monitor_buffer_addin_file_saved;
+}
+
+G_DEFINE_TYPE_WITH_CODE (GbpBufferMonitorBufferAddin, gbp_buffer_monitor_buffer_addin, G_TYPE_OBJECT,
+                         G_IMPLEMENT_INTERFACE (IDE_TYPE_BUFFER_ADDIN, buffer_addin_iface_init))
+
+static void
+gbp_buffer_monitor_buffer_addin_class_init (GbpBufferMonitorBufferAddinClass *klass)
+{
+}
+
+static void
+gbp_buffer_monitor_buffer_addin_init (GbpBufferMonitorBufferAddin *self)
+{
+}
diff --git a/src/plugins/buffer-monitor/gbp-buffer-monitor-buffer-addin.h 
b/src/plugins/buffer-monitor/gbp-buffer-monitor-buffer-addin.h
new file mode 100644
index 000000000..227ac336c
--- /dev/null
+++ b/src/plugins/buffer-monitor/gbp-buffer-monitor-buffer-addin.h
@@ -0,0 +1,31 @@
+/* gbp-buffer-monitor-buffer-addin.h
+ *
+ * Copyright 2018-2019 Christian Hergert <chergert redhat com>
+ *
+ * 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 3 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, see <http://www.gnu.org/licenses/>.
+ *
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ */
+
+#pragma once
+
+#include <glib-object.h>
+
+G_BEGIN_DECLS
+
+#define GBP_TYPE_BUFFER_MONITOR_BUFFER_ADDIN (gbp_buffer_monitor_buffer_addin_get_type())
+
+G_DECLARE_FINAL_TYPE (GbpBufferMonitorBufferAddin, gbp_buffer_monitor_buffer_addin, GBP, 
BUFFER_MONITOR_BUFFER_ADDIN, GObject)
+
+G_END_DECLS
diff --git a/src/plugins/buffer-monitor/meson.build b/src/plugins/buffer-monitor/meson.build
new file mode 100644
index 000000000..e4669de4c
--- /dev/null
+++ b/src/plugins/buffer-monitor/meson.build
@@ -0,0 +1,12 @@
+plugins_sources += files([
+  'buffer-monitor-plugin.c',
+  'gbp-buffer-monitor-buffer-addin.c',
+])
+
+plugin_buffer_monitor_resources = gnome.compile_resources(
+  'gbp-buffer-monitor-resources',
+  'buffer-monitor.gresource.xml',
+  c_name: 'gbp_buffer_monitor',
+)
+
+plugins_sources += plugin_buffer_monitor_resources[0]
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]