[kdbus] sync with kdbus (kdbus.h - commit: 5ae1ecac44cb)
[platform/upstream/glib.git] / glib / giounix.c
index fa54b86..bb773c3 100644 (file)
  * 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.
+ * License along with this library; if not, see <http://www.gnu.org/licenses/>.
  */
 
 /*
  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
  * file for a list of people on the GLib Team.  See the ChangeLog
  * files for a list of changes.  These files are distributed with
- * GLib at ftp://ftp.gtk.org/pub/gtk/. 
+ * GLib at ftp://ftp.gtk.org/pub/gtk/.
  */
 
-/* 
+/*
  * MT safe
  */
 
-#include "glib.h"
+#include "config.h"
+
+#define _POSIX_SOURCE          /* for SSIZE_MAX */
+
 #include <sys/types.h>
 #include <sys/stat.h>
 #include <stdio.h>
 #include <errno.h>
 #include <string.h>
 #include <fcntl.h>
+#include <glib/gstdio.h>
+
+#include "giochannel.h"
+
+#include "gerror.h"
+#include "gfileutils.h"
+#include "gstrfuncs.h"
+#include "gtestutils.h"
 
 /*
  * Unix IO Channels
@@ -59,7 +68,6 @@ struct _GIOUnixWatch
   GPollFD       pollfd;
   GIOChannel   *channel;
   GIOCondition  condition;
-  GIOFunc       callback;
 };
 
 
@@ -74,7 +82,7 @@ static GIOStatus      g_io_unix_write         (GIOChannel   *channel,
                                                 gsize        *bytes_written,
                                                 GError      **err);
 static GIOStatus       g_io_unix_seek          (GIOChannel   *channel,
-                                                glong         offset,
+                                                gint64        offset,
                                                 GSeekType     type,
                                                 GError      **err);
 static GIOStatus       g_io_unix_close         (GIOChannel   *channel,
@@ -95,7 +103,7 @@ static gboolean g_io_unix_dispatch (GSource     *source,
                                    gpointer     user_data);
 static void     g_io_unix_finalize (GSource     *source);
 
-GSourceFuncs unix_watch_funcs = {
+GSourceFuncs g_io_watch_funcs = {
   g_io_unix_prepare,
   g_io_unix_check,
   g_io_unix_dispatch,
@@ -185,9 +193,10 @@ g_io_unix_read (GIOChannel *channel,
 
   if (result < 0)
     {
+      int errsv = errno;
       *bytes_read = 0;
 
-      switch (errno)
+      switch (errsv)
         {
 #ifdef EINTR
           case EINTR:
@@ -198,9 +207,9 @@ g_io_unix_read (GIOChannel *channel,
             return G_IO_STATUS_AGAIN;
 #endif
           default:
-            g_set_error (err, G_IO_CHANNEL_ERROR,
-                         g_io_channel_error_from_errno (errno),
-                         strerror (errno));
+            g_set_error_literal (err, G_IO_CHANNEL_ERROR,
+                                 g_io_channel_error_from_errno (errsv),
+                                 g_strerror (errsv));
             return G_IO_STATUS_ERROR;
         }
     }
@@ -225,9 +234,10 @@ g_io_unix_write (GIOChannel  *channel,
 
   if (result < 0)
     {
+      int errsv = errno;
       *bytes_written = 0;
 
-      switch (errno)
+      switch (errsv)
         {
 #ifdef EINTR
           case EINTR:
@@ -238,9 +248,9 @@ g_io_unix_write (GIOChannel  *channel,
             return G_IO_STATUS_AGAIN;
 #endif
           default:
-            g_set_error (err, G_IO_CHANNEL_ERROR,
-                         g_io_channel_error_from_errno (errno),
-                         strerror (errno));
+            g_set_error_literal (err, G_IO_CHANNEL_ERROR,
+                                 g_io_channel_error_from_errno (errsv),
+                                 g_strerror (errsv));
             return G_IO_STATUS_ERROR;
         }
     }
@@ -252,12 +262,13 @@ g_io_unix_write (GIOChannel  *channel,
 
 static GIOStatus
 g_io_unix_seek (GIOChannel *channel,
-               glong       offset, 
+               gint64      offset, 
                GSeekType   type,
                 GError    **err)
 {
   GIOUnixChannel *unix_channel = (GIOUnixChannel *)channel;
   int whence;
+  off_t tmp_offset;
   off_t result;
 
   switch (type)
@@ -276,13 +287,23 @@ g_io_unix_seek (GIOChannel *channel,
       g_assert_not_reached ();
     }
 
-  result = lseek (unix_channel->fd, offset, whence);
+  tmp_offset = offset;
+  if (tmp_offset != offset)
+    {
+      g_set_error_literal (err, G_IO_CHANNEL_ERROR,
+                           g_io_channel_error_from_errno (EINVAL),
+                           g_strerror (EINVAL));
+      return G_IO_STATUS_ERROR;
+    }
+  
+  result = lseek (unix_channel->fd, tmp_offset, whence);
 
   if (result < 0)
     {
-      g_set_error (err, G_IO_CHANNEL_ERROR,
-                  g_io_channel_error_from_errno (errno),
-                  strerror (errno));
+      int errsv = errno;
+      g_set_error_literal (err, G_IO_CHANNEL_ERROR,
+                           g_io_channel_error_from_errno (errsv),
+                           g_strerror (errsv));
       return G_IO_STATUS_ERROR;
     }
 
@@ -298,9 +319,10 @@ g_io_unix_close (GIOChannel *channel,
 
   if (close (unix_channel->fd) < 0)
     {
-      g_set_error (err, G_IO_CHANNEL_ERROR,
-                  g_io_channel_error_from_errno (errno),
-                  strerror (errno));
+      int errsv = errno;
+      g_set_error_literal (err, G_IO_CHANNEL_ERROR,
+                           g_io_channel_error_from_errno (errsv),
+                           g_strerror (errsv));
       return G_IO_STATUS_ERROR;
     }
 
@@ -324,7 +346,8 @@ g_io_unix_create_watch (GIOChannel   *channel,
   GIOUnixWatch *watch;
 
 
-  source = g_source_new (&unix_watch_funcs, sizeof (GIOUnixWatch));
+  source = g_source_new (&g_io_watch_funcs, sizeof (GIOUnixWatch));
+  g_source_set_name (source, "GIOChannel (Unix)");
   watch = (GIOUnixWatch *)source;
   
   watch->channel = channel;
@@ -361,9 +384,10 @@ g_io_unix_set_flags (GIOChannel *channel,
 
   if (fcntl (unix_channel->fd, F_SETFL, fcntl_flags) == -1)
     {
-      g_set_error (err, G_IO_CHANNEL_ERROR,
-                  g_io_channel_error_from_errno (errno),
-                  g_strerror (errno));
+      int errsv = errno;
+      g_set_error_literal (err, G_IO_CHANNEL_ERROR,
+                           g_io_channel_error_from_errno (errsv),
+                           g_strerror (errsv));
       return G_IO_STATUS_ERROR;
     }
 
@@ -381,8 +405,9 @@ g_io_unix_get_flags (GIOChannel *channel)
 
   if (fcntl_flags == -1)
     {
+      int err = errno;
       g_warning (G_STRLOC "Error while getting flags for FD: %s (%d)\n",
-                g_strerror (errno), errno);
+                g_strerror (err), err);
       return 0;
     }
 
@@ -429,6 +454,9 @@ g_io_channel_new_file (const gchar *filename,
     MODE_W = 1 << 1,
     MODE_A = 1 << 2,
     MODE_PLUS = 1 << 3,
+    MODE_R_PLUS = MODE_R | MODE_PLUS,
+    MODE_W_PLUS = MODE_W | MODE_PLUS,
+    MODE_A_PLUS = MODE_A | MODE_PLUS
   } mode_num;
   struct stat buffer;
 
@@ -479,36 +507,40 @@ g_io_channel_new_file (const gchar *filename,
       case MODE_A:
         flags = O_WRONLY | O_APPEND | O_CREAT;
         break;
-      case MODE_R | MODE_PLUS:
+      case MODE_R_PLUS:
         flags = O_RDWR;
         break;
-      case MODE_W | MODE_PLUS:
+      case MODE_W_PLUS:
         flags = O_RDWR | O_TRUNC | O_CREAT;
         break;
-      case MODE_A | MODE_PLUS:
+      case MODE_A_PLUS:
         flags = O_RDWR | O_APPEND | O_CREAT;
         break;
+      case MODE_PLUS:
       default:
         g_assert_not_reached ();
         flags = 0;
     }
 
   create_mode = S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH | S_IWOTH;
-  fid = open (filename, flags, create_mode);
+
+  fid = g_open (filename, flags, create_mode);
   if (fid == -1)
     {
-      g_set_error (error, G_FILE_ERROR,
-                   g_file_error_from_errno (errno),
-                   strerror (errno));
+      int err = errno;
+      g_set_error_literal (error, G_FILE_ERROR,
+                           g_file_error_from_errno (err),
+                           g_strerror (err));
       return (GIOChannel *)NULL;
     }
 
   if (fstat (fid, &buffer) == -1) /* In case someone opens a FIFO */
     {
+      int err = errno;
       close (fid);
-      g_set_error (error, G_FILE_ERROR,
-                   g_file_error_from_errno (errno),
-                   strerror (errno));
+      g_set_error_literal (error, G_FILE_ERROR,
+                           g_file_error_from_errno (err),
+                           g_strerror (err));
       return (GIOChannel *)NULL;
     }
 
@@ -528,12 +560,13 @@ g_io_channel_new_file (const gchar *filename,
         channel->is_readable = FALSE;
         channel->is_writeable = TRUE;
         break;
-      case MODE_R | MODE_PLUS:
-      case MODE_W | MODE_PLUS:
-      case MODE_A | MODE_PLUS:
+      case MODE_R_PLUS:
+      case MODE_W_PLUS:
+      case MODE_A_PLUS:
         channel->is_readable = TRUE;
         channel->is_writeable = TRUE;
         break;
+      case MODE_PLUS:
       default:
         g_assert_not_reached ();
     }
@@ -546,6 +579,33 @@ g_io_channel_new_file (const gchar *filename,
   return channel;
 }
 
+/**
+ * g_io_channel_unix_new:
+ * @fd: a file descriptor.
+ *
+ * Creates a new #GIOChannel given a file descriptor. On UNIX systems
+ * this works for plain files, pipes, and sockets.
+ *
+ * The returned #GIOChannel has a reference count of 1.
+ *
+ * The default encoding for #GIOChannel is UTF-8. If your application
+ * is reading output from a command using via pipe, you may need to set
+ * the encoding to the encoding of the current locale (see
+ * g_get_charset()) with the g_io_channel_set_encoding() function.
+ *
+ * If you want to read raw binary data without interpretation, then
+ * call the g_io_channel_set_encoding() function with %NULL for the
+ * encoding argument.
+ *
+ * This function is available in GLib on Windows, too, but you should
+ * avoid using it on Windows. The domain of file descriptors and
+ * sockets overlap. There is no way for GLib to know which one you mean
+ * in case the argument you pass to this function happens to be both a
+ * valid file descriptor and socket. If that happens a warning is
+ * issued, and GLib assumes that it is the file descriptor you mean.
+ *
+ * Returns: a new #GIOChannel.
+ **/
 GIOChannel *
 g_io_channel_unix_new (gint fd)
 {
@@ -556,6 +616,8 @@ g_io_channel_unix_new (gint fd)
   g_io_channel_init (channel);
   channel->funcs = &unix_channel_funcs;
 
+  unix_channel->fd = fd;
+
   /* I'm not sure if fstat on a non-file (e.g., socket) works
    * it should be safe to say if it fails, the fd isn't seekable.
    */
@@ -568,13 +630,22 @@ g_io_channel_unix_new (gint fd)
   else /* Assume not seekable */
     channel->is_seekable = FALSE;
 
-  unix_channel->fd = fd;
-
   g_io_unix_get_flags (channel); /* Sets is_readable, is_writeable */
 
   return channel;
 }
 
+/**
+ * g_io_channel_unix_get_fd:
+ * @channel: a #GIOChannel, created with g_io_channel_unix_new().
+ *
+ * Returns the file descriptor of the #GIOChannel.
+ *
+ * On Windows this function returns the file descriptor or socket of
+ * the #GIOChannel.
+ *
+ * Returns: the file descriptor of the #GIOChannel.
+ **/
 gint
 g_io_channel_unix_get_fd (GIOChannel *channel)
 {