GFileDescriptorBased: New interface

New interface for file descriptor based io object. The interface
is only exported on unix based systems. See bug 604086.

diff --git a/gio/Makefile.am b/gio/Makefile.am
index 73cb00e..580db1a 100644 (file)
--- a/gio/Makefile.am
+++ b/gio/Makefile.am
@@ -157,6 +157,7 @@ unix_sources = \
 giounixincludedir=$(includedir)/gio-unix-2.0/gio
 giounixinclude_HEADERS = \
        gdesktopappinfo.h       \
+       gfiledescriptorbased.h  \
        gunixconnection.h       \
        gunixmounts.h           \
        gunixfdlist.h           \
@@ -210,6 +211,8 @@ libgio_2_0_la_SOURCES =             \
        gfile.c                 \
        gfileattribute.c        \
        gfileattribute-priv.h   \
+       gfiledescriptorbased.h  \
+       gfiledescriptorbased.c  \
        gfileenumerator.c       \
        gfileicon.c             \
        gfileinfo.c             \

diff --git a/gio/gfiledescriptorbased.c b/gio/gfiledescriptorbased.c
new file mode 100644 (file)
index 0000000..ebb19ef
--- /dev/null
+++ b/gio/gfiledescriptorbased.c
@@ -0,0 +1,72 @@
+/* GIO - GLib Input, Output and Streaming Library
+ *
+ * Copyright (C) 2010 Christian Kellner
+ *
+ * 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.
+ *
+ * Author: Christian Kellner <gicmo@gnome.org>
+ */
+
+#include "config.h"
+#include "gfiledescriptorbased.h"
+#include "glibintl.h"
+
+#include "gioalias.h"
+
+/**
+ * SECTION:gfile_descriptor_based
+ * @short_description: Stream seeking interface
+ * @include: gio/gio.h
+ * @see_also: #GInputStream, #GOutputStream
+ *
+ * #GFileDescriptorBased is implemented by streams (implementations of
+ * #GInputStream or #GOutputStream) that are based on file descriptors.
+ *
+ * Since: 2.24
+ *
+ **/
+
+typedef GFileDescriptorBasedIface GFileDescriptorBasedInterface;
+G_DEFINE_INTERFACE (GFileDescriptorBased, g_file_descriptor_based, G_TYPE_OBJECT)
+
+static void
+g_file_descriptor_based_default_init (GFileDescriptorBasedInterface *iface)
+{
+}
+
+/**
+ * g_file_descriptor_based_get_fd:
+ * @fd_based: a #GFileDescriptorBased.
+ *
+ * Gets the underlying file descriptor.
+ *
+ * Returns: The file descriptor
+ *
+ * Since: 2.24
+ **/
+int
+g_file_descriptor_based_get_fd (GFileDescriptorBased *fd_based)
+{
+  GFileDescriptorBasedIface *iface;
+
+  g_return_val_if_fail (G_IS_FILE_DESCRIPTOR_BASED (fd_based), 0);
+
+  iface = G_FILE_DESCRIPTOR_BASED_GET_IFACE (fd_based);
+
+  return (* iface->get_fd) (fd_based);
+}
+
+

diff --git a/gio/gfiledescriptorbased.h b/gio/gfiledescriptorbased.h
new file mode 100644 (file)
index 0000000..249d9ea
--- /dev/null
+++ b/gio/gfiledescriptorbased.h
@@ -0,0 +1,63 @@
+/* GIO - GLib Input, Output and Streaming Library
+ *
+ * Copyright (C) 2010 Christian Kellner
+ *
+ * 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.
+ *
+ * Author: Christian Kellner <gicmo@gnome.org>
+ */
+
+#ifndef __G_FILE_DESCRIPTOR_BASED_H__
+#define __G_FILE_DESCRIPTOR_BASED_H__
+
+#include <gio/giotypes.h>
+
+G_BEGIN_DECLS
+
+#define G_TYPE_FILE_DESCRIPTOR_BASED            (g_file_descriptor_based_get_type ())
+#define G_FILE_DESCRIPTOR_BASED(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_FILE_DESCRIPTOR_BASED, GFileDescriptorBased))
+#define G_IS_FILE_DESCRIPTOR_BASED(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_FILE_DESCRIPTOR_BASED))
+#define G_FILE_DESCRIPTOR_BASED_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_FILE_DESCRIPTOR_BASED, GFileDescriptorBasedIface))
+
+/**
+ * GFileDescriptorBased:
+ *
+ * An interface for file descriptor based io objects.
+ **/
+typedef struct _GFileDescriptorBasedIface   GFileDescriptorBasedIface;
+
+/**
+ * GFileDescriptorBasedIface:
+ * @g_iface: The parent interface.
+ *
+ **/
+struct _GFileDescriptorBasedIface
+{
+  GTypeInterface g_iface;
+
+  /* Virtual Table */
+  int (*get_fd) (GFileDescriptorBased *fd_based);
+};
+
+GType    g_file_descriptor_based_get_type     (void) G_GNUC_CONST;
+
+int      g_file_descriptor_based_get_fd       (GFileDescriptorBased *fd_based);
+
+G_END_DECLS
+
+
+#endif /* __G_FILE_DESCRIPTOR_BASED_H__ */
+

diff --git a/gio/giotypes.h b/gio/giotypes.h
index 298a03e..cd8f047 100644 (file)
--- a/gio/giotypes.h
+++ b/gio/giotypes.h
@@ -76,6 +76,7 @@ typedef struct _GFileInfo                     GFileInfo;
 typedef struct _GFileAttributeMatcher         GFileAttributeMatcher;
 typedef struct _GFileAttributeInfo            GFileAttributeInfo;
 typedef struct _GFileAttributeInfoList        GFileAttributeInfoList;
+typedef struct _GFileDescriptorBased          GFileDescriptorBased;
 typedef struct _GFileInputStream              GFileInputStream;
 typedef struct _GFileOutputStream             GFileOutputStream;
 typedef struct _GFileIOStream                 GFileIOStream;