gio/glocalfilemonitor.h

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2006-2007 Red Hat, Inc.
   4  *
   5  * SPDX-License-Identifier: LGPL-2.1-or-later
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General
  18  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
  19  *
  20  * Author: Alexander Larsson <alexl@redhat.com>
  21  */
  22
  23 #ifndef __G_LOCAL_FILE_MONITOR_H__
  24 #define __G_LOCAL_FILE_MONITOR_H__
  25
  26 #include <gio/gfilemonitor.h>
  27 #include "gunixmounts.h"
  28
  29 G_BEGIN_DECLS
  30
  31 #define G_TYPE_LOCAL_FILE_MONITOR               (g_local_file_monitor_get_type ())
  32 #define G_LOCAL_FILE_MONITOR(o)                 (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_LOCAL_FILE_MONITOR, GLocalFileMonitor))
  33 #define G_LOCAL_FILE_MONITOR_CLASS(k)           (G_TYPE_CHECK_CLASS_CAST ((k), G_TYPE_LOCAL_FILE_MONITOR, GLocalFileMonitorClass))
  34 #define G_IS_LOCAL_FILE_MONITOR(o)              (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_LOCAL_FILE_MONITOR))
  35 #define G_IS_LOCAL_FILE_MONITOR_CLASS(k)        (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_LOCAL_FILE_MONITOR))
  36 #define G_LOCAL_FILE_MONITOR_GET_CLASS(o)       (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_LOCAL_FILE_MONITOR, GLocalFileMonitorClass))
  37
  38 #define G_LOCAL_FILE_MONITOR_EXTENSION_POINT_NAME "gio-local-file-monitor"
  39 #define G_NFS_FILE_MONITOR_EXTENSION_POINT_NAME   "gio-nfs-file-monitor"
  40
  41 typedef struct _GLocalFileMonitor      GLocalFileMonitor;
  42 typedef struct _GLocalFileMonitorClass GLocalFileMonitorClass;
  43 typedef struct _GFileMonitorSource     GFileMonitorSource;
  44
  45 struct _GLocalFileMonitor
  46 {
  47   GFileMonitor parent_instance;
  48
  49   GFileMonitorSource *source;
  50   GUnixMountMonitor  *mount_monitor;
  51   gboolean            was_mounted;
  52 };
  53
  54 struct _GLocalFileMonitorClass
  55 {
  56   GFileMonitorClass parent_class;
  57
  58   gboolean (* is_supported) (void);
  59   void     (* start)        (GLocalFileMonitor *local_monitor,
  60                              const gchar *dirname,
  61                              const gchar *basename,
  62                              const gchar *filename,
  63                              GFileMonitorSource *source);
  64
  65   gboolean mount_notify;
  66 };
  67
  68 #ifdef G_OS_UNIX
  69 GIO_AVAILABLE_IN_ALL
  70 #endif
  71 GType           g_local_file_monitor_get_type (void) G_GNUC_CONST;
  72
  73 /* for glocalfile.c */
  74 GFileMonitor *
  75 g_local_file_monitor_new_for_path (const gchar        *pathname,
  76                                    gboolean            is_directory,
  77                                    GFileMonitorFlags   flags,
  78                                    GError            **error);
  79
  80 /* for various users in glib */
  81 typedef void (* GFileMonitorCallback) (GFileMonitor      *monitor,
  82                                        GFile             *child,
  83                                        GFile             *other,
  84                                        GFileMonitorEvent  event,
  85                                        gpointer           user_data);
  86 GFileMonitor *
  87 g_local_file_monitor_new_in_worker (const gchar           *pathname,
  88                                     gboolean               is_directory,
  89                                     GFileMonitorFlags      flags,
  90                                     GFileMonitorCallback   callback,
  91                                     gpointer               user_data,
  92                                     GClosureNotify         destroy_user_data,
  93                                     GError               **error);
  94
  95 /* for implementations of GLocalFileMonitor */
  96 GIO_AVAILABLE_IN_2_44
  97 gboolean
  98 g_file_monitor_source_handle_event (GFileMonitorSource *fms,
  99                                     GFileMonitorEvent   event_type,
 100                                     const gchar        *child,
 101                                     const gchar        *rename_to,
 102                                     GFile              *other,
 103                                     gint64              event_time);
 104
 105
 106 G_END_DECLS
 107
 108 #endif /* __G_LOCAL_FILE_MONITOR_H__ */