gmacros.h: add G_GNUC_*_IGNORE_DEPRECATIONS macros for clang
[platform/upstream/glib.git] / glib / giochannel.h
index b2ae71e..ed098ed 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/.
  */
 
 #ifndef __G_IOCHANNEL_H__
 #define __G_IOCHANNEL_H__
 
-#include <gtypes.h>
+#if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
+#error "Only <glib.h> can be included directly."
+#endif
+
+#include <glib/gconvert.h>
+#include <glib/gmain.h>
+#include <glib/gstring.h>
 
 G_BEGIN_DECLS
 
@@ -36,6 +40,7 @@ G_BEGIN_DECLS
 
 typedef struct _GIOChannel     GIOChannel;
 typedef struct _GIOFuncs        GIOFuncs;
+
 typedef enum
 {
   G_IO_ERROR_NONE,
@@ -43,27 +48,81 @@ typedef enum
   G_IO_ERROR_INVAL,
   G_IO_ERROR_UNKNOWN
 } GIOError;
+
+#define G_IO_CHANNEL_ERROR g_io_channel_error_quark()
+
+typedef enum
+{
+  /* Derived from errno */
+  G_IO_CHANNEL_ERROR_FBIG,
+  G_IO_CHANNEL_ERROR_INVAL,
+  G_IO_CHANNEL_ERROR_IO,
+  G_IO_CHANNEL_ERROR_ISDIR,
+  G_IO_CHANNEL_ERROR_NOSPC,
+  G_IO_CHANNEL_ERROR_NXIO,
+  G_IO_CHANNEL_ERROR_OVERFLOW,
+  G_IO_CHANNEL_ERROR_PIPE,
+  /* Other */
+  G_IO_CHANNEL_ERROR_FAILED
+} GIOChannelError;
+
+typedef enum
+{
+  G_IO_STATUS_ERROR,
+  G_IO_STATUS_NORMAL,
+  G_IO_STATUS_EOF,
+  G_IO_STATUS_AGAIN
+} GIOStatus;
+
 typedef enum
 {
   G_SEEK_CUR,
   G_SEEK_SET,
   G_SEEK_END
 } GSeekType;
+
 typedef enum
 {
-  G_IO_IN      GLIB_SYSDEF_POLLIN,
-  G_IO_OUT     GLIB_SYSDEF_POLLOUT,
-  G_IO_PRI     GLIB_SYSDEF_POLLPRI,
-  G_IO_ERR     GLIB_SYSDEF_POLLERR,
-  G_IO_HUP     GLIB_SYSDEF_POLLHUP,
-  G_IO_NVAL    GLIB_SYSDEF_POLLNVAL
-} GIOCondition;
+  G_IO_FLAG_APPEND = 1 << 0,
+  G_IO_FLAG_NONBLOCK = 1 << 1,
+  G_IO_FLAG_IS_READABLE = 1 << 2,      /* Read only flag */
+  G_IO_FLAG_IS_WRITABLE = 1 << 3,      /* Read only flag */
+  G_IO_FLAG_IS_WRITEABLE = 1 << 3,      /* Misspelling in 2.29.10 and earlier */
+  G_IO_FLAG_IS_SEEKABLE = 1 << 4,      /* Read only flag */
+  G_IO_FLAG_MASK = (1 << 5) - 1,
+  G_IO_FLAG_GET_MASK = G_IO_FLAG_MASK,
+  G_IO_FLAG_SET_MASK = G_IO_FLAG_APPEND | G_IO_FLAG_NONBLOCK
+} GIOFlags;
 
 struct _GIOChannel
 {
-  guint channel_flags;
-  guint ref_count;
+  /*< private >*/
+  gint ref_count;
   GIOFuncs *funcs;
+
+  gchar *encoding;
+  GIConv read_cd;
+  GIConv write_cd;
+  gchar *line_term;            /* String which indicates the end of a line of text */
+  guint line_term_len;         /* So we can have null in the line term */
+
+  gsize buf_size;
+  GString *read_buf;           /* Raw data from the channel */
+  GString *encoded_read_buf;    /* Channel data converted to UTF-8 */
+  GString *write_buf;          /* Data ready to be written to the file */
+  gchar partial_write_buf[6];  /* UTF-8 partial characters, null terminated */
+
+  /* Group the flags together, immediately after partial_write_buf, to save memory */
+
+  guint use_buffer     : 1;    /* The encoding uses the buffers */
+  guint do_encode      : 1;    /* The encoding uses the GIConv coverters */
+  guint close_on_unref : 1;    /* Close the channel on final unref */
+  guint is_readable    : 1;    /* Cached GIOFlag */
+  guint is_writeable   : 1;    /* ditto */
+  guint is_seekable    : 1;    /* ditto */
+
+  gpointer reserved1;  
+  gpointer reserved2;  
 };
 
 typedef gboolean (*GIOFunc) (GIOChannel   *source,
@@ -71,196 +130,283 @@ typedef gboolean (*GIOFunc) (GIOChannel   *source,
                             gpointer      data);
 struct _GIOFuncs
 {
-  GIOError (*io_read)   (GIOChannel    *channel, 
-                        gchar          *buf, 
-                        guint           count,
-                        guint          *bytes_read);
-  GIOError (*io_write)  (GIOChannel    *channel, 
-                        gchar          *buf, 
-                        guint           count,
-                        guint          *bytes_written);
-  GIOError (*io_seek)   (GIOChannel    *channel, 
-                        gint            offset, 
-                        GSeekType       type);
-  void (*io_close)      (GIOChannel    *channel);
-  guint (*io_add_watch) (GIOChannel     *channel,
-                        gint            priority,
-                        GIOCondition    condition,
-                        GIOFunc         func,
-                        gpointer        user_data,
-                        GDestroyNotify  notify);
-  void (*io_free)       (GIOChannel    *channel);
+  GIOStatus (*io_read)           (GIOChannel   *channel, 
+                                 gchar        *buf, 
+                                 gsize         count,
+                                 gsize        *bytes_read,
+                                 GError      **err);
+  GIOStatus (*io_write)          (GIOChannel   *channel, 
+                                 const gchar  *buf, 
+                                 gsize         count,
+                                 gsize        *bytes_written,
+                                 GError      **err);
+  GIOStatus (*io_seek)           (GIOChannel   *channel, 
+                                 gint64        offset, 
+                                 GSeekType     type,
+                                 GError      **err);
+  GIOStatus  (*io_close)         (GIOChannel   *channel,
+                                 GError      **err);
+  GSource*   (*io_create_watch)  (GIOChannel   *channel,
+                                 GIOCondition  condition);
+  void       (*io_free)          (GIOChannel   *channel);
+  GIOStatus  (*io_set_flags)     (GIOChannel   *channel,
+                                  GIOFlags      flags,
+                                 GError      **err);
+  GIOFlags   (*io_get_flags)     (GIOChannel   *channel);
 };
 
+GLIB_AVAILABLE_IN_ALL
 void        g_io_channel_init   (GIOChannel    *channel);
-void        g_io_channel_ref    (GIOChannel    *channel);
+GLIB_AVAILABLE_IN_ALL
+GIOChannel *g_io_channel_ref    (GIOChannel    *channel);
+GLIB_AVAILABLE_IN_ALL
 void        g_io_channel_unref  (GIOChannel    *channel);
-GIOError    g_io_channel_read   (GIOChannel    *channel, 
-                                gchar         *buf, 
-                                guint          count,
-                                guint         *bytes_read);
-GIOError  g_io_channel_write    (GIOChannel    *channel, 
-                                gchar         *buf, 
-                                guint          count,
-                                guint         *bytes_written);
+
+GLIB_DEPRECATED_FOR(g_io_channel_read_chars)
+GIOError    g_io_channel_read   (GIOChannel    *channel,
+                                 gchar         *buf,
+                                 gsize          count,
+                                 gsize         *bytes_read);
+
+GLIB_DEPRECATED_FOR(g_io_channel_write_chars)
+GIOError  g_io_channel_write    (GIOChannel    *channel,
+                                 const gchar   *buf,
+                                 gsize          count,
+                                 gsize         *bytes_written);
+
+GLIB_DEPRECATED_FOR(g_io_channel_seek_position)
 GIOError  g_io_channel_seek     (GIOChannel    *channel,
-                                gint           offset, 
-                                GSeekType      type);
+                                 gint64         offset,
+                                 GSeekType      type);
+
+GLIB_DEPRECATED_FOR(g_io_channel_shutdown)
 void      g_io_channel_close    (GIOChannel    *channel);
-guint     g_io_add_watch_full   (GIOChannel    *channel,
-                                gint           priority,
-                                GIOCondition   condition,
-                                GIOFunc        func,
-                                gpointer       user_data,
-                                GDestroyNotify notify);
-guint    g_io_add_watch         (GIOChannel    *channel,
-                                GIOCondition   condition,
-                                GIOFunc        func,
-                                gpointer       user_data);
+
+GLIB_AVAILABLE_IN_ALL
+GIOStatus g_io_channel_shutdown (GIOChannel      *channel,
+                                gboolean         flush,
+                                GError         **err);
+GLIB_AVAILABLE_IN_ALL
+guint     g_io_add_watch_full   (GIOChannel      *channel,
+                                gint             priority,
+                                GIOCondition     condition,
+                                GIOFunc          func,
+                                gpointer         user_data,
+                                GDestroyNotify   notify);
+GLIB_AVAILABLE_IN_ALL
+GSource * g_io_create_watch     (GIOChannel      *channel,
+                                GIOCondition     condition);
+GLIB_AVAILABLE_IN_ALL
+guint     g_io_add_watch        (GIOChannel      *channel,
+                                GIOCondition     condition,
+                                GIOFunc          func,
+                                gpointer         user_data);
+
+/* character encoding conversion involved functions.
+ */
+
+GLIB_AVAILABLE_IN_ALL
+void                  g_io_channel_set_buffer_size      (GIOChannel   *channel,
+                                                        gsize         size);
+GLIB_AVAILABLE_IN_ALL
+gsize                 g_io_channel_get_buffer_size      (GIOChannel   *channel);
+GLIB_AVAILABLE_IN_ALL
+GIOCondition          g_io_channel_get_buffer_condition (GIOChannel   *channel);
+GLIB_AVAILABLE_IN_ALL
+GIOStatus             g_io_channel_set_flags            (GIOChannel   *channel,
+                                                        GIOFlags      flags,
+                                                        GError      **error);
+GLIB_AVAILABLE_IN_ALL
+GIOFlags              g_io_channel_get_flags            (GIOChannel   *channel);
+GLIB_AVAILABLE_IN_ALL
+void                  g_io_channel_set_line_term        (GIOChannel   *channel,
+                                                        const gchar  *line_term,
+                                                        gint          length);
+GLIB_AVAILABLE_IN_ALL
+const gchar *         g_io_channel_get_line_term        (GIOChannel   *channel,
+                                                        gint         *length);
+GLIB_AVAILABLE_IN_ALL
+void                 g_io_channel_set_buffered         (GIOChannel   *channel,
+                                                        gboolean      buffered);
+GLIB_AVAILABLE_IN_ALL
+gboolean             g_io_channel_get_buffered         (GIOChannel   *channel);
+GLIB_AVAILABLE_IN_ALL
+GIOStatus             g_io_channel_set_encoding         (GIOChannel   *channel,
+                                                        const gchar  *encoding,
+                                                        GError      **error);
+GLIB_AVAILABLE_IN_ALL
+const gchar *         g_io_channel_get_encoding         (GIOChannel   *channel);
+GLIB_AVAILABLE_IN_ALL
+void                  g_io_channel_set_close_on_unref  (GIOChannel   *channel,
+                                                        gboolean      do_close);
+GLIB_AVAILABLE_IN_ALL
+gboolean              g_io_channel_get_close_on_unref  (GIOChannel   *channel);
+
+
+GLIB_AVAILABLE_IN_ALL
+GIOStatus   g_io_channel_flush            (GIOChannel   *channel,
+                                          GError      **error);
+GLIB_AVAILABLE_IN_ALL
+GIOStatus   g_io_channel_read_line        (GIOChannel   *channel,
+                                          gchar       **str_return,
+                                          gsize        *length,
+                                          gsize        *terminator_pos,
+                                          GError      **error);
+GLIB_AVAILABLE_IN_ALL
+GIOStatus   g_io_channel_read_line_string (GIOChannel   *channel,
+                                          GString      *buffer,
+                                          gsize        *terminator_pos,
+                                          GError      **error);
+GLIB_AVAILABLE_IN_ALL
+GIOStatus   g_io_channel_read_to_end      (GIOChannel   *channel,
+                                          gchar       **str_return,
+                                          gsize        *length,
+                                          GError      **error);
+GLIB_AVAILABLE_IN_ALL
+GIOStatus   g_io_channel_read_chars       (GIOChannel   *channel,
+                                          gchar        *buf,
+                                          gsize         count,
+                                          gsize        *bytes_read,
+                                          GError      **error);
+GLIB_AVAILABLE_IN_ALL
+GIOStatus   g_io_channel_read_unichar     (GIOChannel   *channel,
+                                          gunichar     *thechar,
+                                          GError      **error);
+GLIB_AVAILABLE_IN_ALL
+GIOStatus   g_io_channel_write_chars      (GIOChannel   *channel,
+                                          const gchar  *buf,
+                                          gssize        count,
+                                          gsize        *bytes_written,
+                                          GError      **error);
+GLIB_AVAILABLE_IN_ALL
+GIOStatus   g_io_channel_write_unichar    (GIOChannel   *channel,
+                                          gunichar      thechar,
+                                          GError      **error);
+GLIB_AVAILABLE_IN_ALL
+GIOStatus   g_io_channel_seek_position    (GIOChannel   *channel,
+                                          gint64        offset,
+                                          GSeekType     type,
+                                          GError      **error);
+GLIB_AVAILABLE_IN_ALL
+GIOChannel* g_io_channel_new_file         (const gchar  *filename,
+                                          const gchar  *mode,
+                                          GError      **error);
+
+/* Error handling */
+
+GLIB_AVAILABLE_IN_ALL
+GQuark          g_io_channel_error_quark      (void);
+GLIB_AVAILABLE_IN_ALL
+GIOChannelError g_io_channel_error_from_errno (gint en);
 
 /* On Unix, IO channels created with this function for any file
  * descriptor or socket.
  *
- * On Win32, use this only for files opened with the MSVCRT (the
- * Microsoft run-time C library) _open() or _pipe, including file
- * descriptors 0, 1 and 2 (corresponding to stdin, stdout and stderr).
+ * On Win32, this can be used either for files opened with the MSVCRT
+ * (the Microsoft run-time C library) _open() or _pipe, including file
+ * descriptors 0, 1 and 2 (corresponding to stdin, stdout and stderr),
+ * or for Winsock SOCKETs. If the parameter is a legal file
+ * descriptor, it is assumed to be such, otherwise it should be a
+ * SOCKET. This relies on SOCKETs and file descriptors not
+ * overlapping. If you want to be certain, call either
+ * g_io_channel_win32_new_fd() or g_io_channel_win32_new_socket()
+ * instead as appropriate.
  *
  * The term file descriptor as used in the context of Win32 refers to
  * the emulated Unix-like file descriptors MSVCRT provides. The native
  * corresponding concept is file HANDLE. There isn't as of yet a way to
- * get GIOChannels for file HANDLEs.
+ * get GIOChannels for Win32 file HANDLEs.
  */
+GLIB_AVAILABLE_IN_ALL
 GIOChannel* g_io_channel_unix_new    (int         fd);
+GLIB_AVAILABLE_IN_ALL
 gint        g_io_channel_unix_get_fd (GIOChannel *channel);
 
+
+/* Hook for GClosure / GSource integration. Don't touch */
+GLIB_VAR GSourceFuncs g_io_watch_funcs;
+
 #ifdef G_OS_WIN32
 
+/* You can use this "pseudo file descriptor" in a GPollFD to add
+ * polling for Windows messages. GTK applications should not do that.
+ */
+
 #define G_WIN32_MSG_HANDLE 19981206
 
 /* Use this to get a GPollFD from a GIOChannel, so that you can call
  * g_io_channel_win32_poll(). After calling this you should only use
  * g_io_channel_read() to read from the GIOChannel, i.e. never read()
- * or recv() from the underlying file descriptor or SOCKET.
+ * from the underlying file descriptor. For SOCKETs, it is possible to call
+ * recv().
  */
+GLIB_AVAILABLE_IN_ALL
 void        g_io_channel_win32_make_pollfd (GIOChannel   *channel,
                                            GIOCondition  condition,
                                            GPollFD      *fd);
 
 /* This can be used to wait a until at least one of the channels is readable.
  * On Unix you would do a select() on the file descriptors of the channels.
- * This should probably be available for all platforms?
  */
+GLIB_AVAILABLE_IN_ALL
 gint        g_io_channel_win32_poll   (GPollFD    *fds,
                                       gint        n_fds,
-                                      gint        timeout);
+                                      gint        timeout_);
 
-/* This is used to add polling for Windows messages. GDK (GTk+) programs
- * should *not* use this.
+/* Create an IO channel for Windows messages for window handle hwnd. */
+#if GLIB_SIZEOF_VOID_P == 8
+/* We use gsize here so that it is still an integer type and not a
+ * pointer, like the guint in the traditional prototype. We can't use
+ * intptr_t as that is not portable enough.
  */
-void        g_main_poll_win32_msg_add (gint        priority,
-                                      GPollFD    *fd,
-                                      guint       hwnd);
-
-/* An IO channel for Windows messages for window handle hwnd. */
+GLIB_AVAILABLE_IN_ALL
+GIOChannel *g_io_channel_win32_new_messages (gsize hwnd);
+#else
+GLIB_AVAILABLE_IN_ALL
 GIOChannel *g_io_channel_win32_new_messages (guint hwnd);
+#endif
 
-/* An IO channel for C runtime (emulated Unix-like) file
- * descriptors. Identical to g_io_channel_unix_new above.
- * After calling g_io_add_watch() on a IO channel returned
- * by this function, you shouldn't call read() on the file
- * descriptor.
+/* Create an IO channel for C runtime (emulated Unix-like) file
+ * descriptors. After calling g_io_add_watch() on a IO channel
+ * returned by this function, you shouldn't call read() on the file
+ * descriptor. This is because adding polling for a file descriptor is
+ * implemented on Win32 by starting a thread that sits blocked in a
+ * read() from the file descriptor most of the time. All reads from
+ * the file descriptor should be done by this internal GLib
+ * thread. Your code should call only g_io_channel_read_chars().
  */
-GIOChannel* g_io_channel_win32_new_fd (int         fd);
+GLIB_AVAILABLE_IN_ALL
+GIOChannel* g_io_channel_win32_new_fd (gint         fd);
 
 /* Get the C runtime file descriptor of a channel. */
+GLIB_AVAILABLE_IN_ALL
 gint        g_io_channel_win32_get_fd (GIOChannel *channel);
 
-/* An IO channel for a SOCK_STREAM winsock socket. The parameter
- * should be a SOCKET. After calling g_io_add_watch() on a IO channel
- * returned by this function, you shouldn't call recv() on the SOCKET.
+/* Create an IO channel for a winsock socket. The parameter should be
+ * a SOCKET. Contrary to IO channels for file descriptors (on *Win32),
+ * you can use normal recv() or recvfrom() on sockets even if GLib
+ * is polling them.
  */
-GIOChannel *g_io_channel_win32_new_stream_socket (int socket);
+GLIB_AVAILABLE_IN_ALL
+GIOChannel *g_io_channel_win32_new_socket (gint socket);
 
-#endif
+GLIB_DEPRECATED_FOR(g_io_channel_win32_new_socket)
+GIOChannel *g_io_channel_win32_new_stream_socket (gint socket);
 
-/* Windows emulation stubs for common Unix functions
- */
-#ifdef G_OS_WIN32
-#  define MAXPATHLEN 1024
+GLIB_AVAILABLE_IN_ALL
+void        g_io_channel_win32_set_debug (GIOChannel *channel,
+                                          gboolean    flag);
 
-#ifdef _MSC_VER
-typedef int pid_t;
 #endif
 
-/*
- * To get prototypes for the following POSIXish functions, you have to
- * include the indicated non-POSIX headers. The functions are defined
- * in OLDNAMES.LIB (MSVC) or -lmoldname-msvc (mingw32).
- *
- * getcwd: <direct.h> (MSVC), <io.h> (mingw32)
- * getpid: <process.h>
- * access: <io.h>
- * unlink: <stdio.h> or <io.h>
- * open, read, write, lseek, close: <io.h>
- * rmdir: <direct.h>
- * pipe: <direct.h>
- */
-
-/* pipe is not in OLDNAMES.LIB or -lmoldname-msvc. */
-#define pipe(phandles) _pipe (phandles, 4096, _O_BINARY)
-
-/* For some POSIX functions that are not provided by the MS runtime,
- * we provide emulators in glib, which are prefixed with g_win32_.
- */
-#    define ftruncate(fd, size)        g_win32_ftruncate (fd, size)
-
-/* -lmingw32 also has emulations for these, but we need our own
- * for MSVC anyhow, so we might aswell use them always.
- */
-#    define opendir            g_win32_opendir
-#    define readdir            g_win32_readdir
-#    define rewinddir          g_win32_rewinddir
-#    define closedir           g_win32_closedir
-#    define NAME_MAX 255
-
-struct dirent
-{
-  gchar  d_name[NAME_MAX + 1];
-};
-
-struct DIR
-{
-  gchar        *dir_name;
-  gboolean     just_opened;
-  guint        find_file_handle;
-  gpointer     find_file_data;
-  struct dirent readdir_result;
-};
-typedef struct DIR DIR;
-
-/* emulation functions */
-extern int     g_win32_ftruncate       (gint            f,
-                                        guint           size);
-DIR*           g_win32_opendir         (const gchar    *dirname);
-struct dirent* g_win32_readdir         (DIR            *dir);
-void           g_win32_rewinddir       (DIR            *dir);
-gint           g_win32_closedir        (DIR            *dir);
-
-/* The MS setlocale uses locale names of the form "English_United
- * States.1252" etc. We want the Unixish standard form "en", "zh_TW"
- * etc. This function gets the current thread locale from Windows and
- * returns it as a string of the above form for use in forming file
- * names etc. The returned string should be deallocated with g_free().
- */
-gchar *                g_win32_getlocale  (void);
-
-/* Translate a Win32 error code (as returned by GetLastError()) into
- * the corresponding message. The returned string should be deallocated
- * with g_free().
- */
-gchar *         g_win32_error_message (gint error);
+#ifdef G_OS_WIN32
+#define g_io_channel_new_file g_io_channel_new_file_utf8
 
-#endif  /* G_OS_WIN32 */
+GLIB_AVAILABLE_IN_ALL
+GIOChannel *g_io_channel_new_file_utf8 (const gchar  *filename,
+                                        const gchar  *mode,
+                                        GError      **error);
+#endif
 
 G_END_DECLS