Home | History | Annotate | Download | only in gio
      1 /* GIO - GLib Input, Output and Streaming Library
      2  *
      3  * Copyright (C) 2006-2007 Red Hat, Inc.
      4  *
      5  * This library is free software; you can redistribute it and/or
      6  * modify it under the terms of the GNU Lesser General Public
      7  * License as published by the Free Software Foundation; either
      8  * version 2 of the License, or (at your option) any later version.
      9  *
     10  * This library is distributed in the hope that it will be useful,
     11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
     12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     13  * Lesser General Public License for more details.
     14  *
     15  * You should have received a copy of the GNU Lesser General
     16  * Public License along with this library; if not, write to the
     17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
     18  * Boston, MA 02111-1307, USA.
     19  *
     20  * Author: Alexander Larsson <alexl (at) redhat.com>
     21  */
     22 
     23 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
     24 #error "Only <gio/gio.h> can be included directly."
     25 #endif
     26 
     27 #ifndef __G_DATA_INPUT_STREAM_H__
     28 #define __G_DATA_INPUT_STREAM_H__
     29 
     30 #include <gio/gbufferedinputstream.h>
     31 
     32 G_BEGIN_DECLS
     33 
     34 #define G_TYPE_DATA_INPUT_STREAM         (g_data_input_stream_get_type ())
     35 #define G_DATA_INPUT_STREAM(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_DATA_INPUT_STREAM, GDataInputStream))
     36 #define G_DATA_INPUT_STREAM_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_DATA_INPUT_STREAM, GDataInputStreamClass))
     37 #define G_IS_DATA_INPUT_STREAM(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_DATA_INPUT_STREAM))
     38 #define G_IS_DATA_INPUT_STREAM_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_DATA_INPUT_STREAM))
     39 #define G_DATA_INPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_DATA_INPUT_STREAM, GDataInputStreamClass))
     40 
     41 /**
     42  * GDataInputStream:
     43  * @parent: a #GBufferedInputStream.
     44  *
     45  * An implementation of #GBufferedInputStream that allows for high-level
     46  * data manipulation of arbitrary data (including binary operations).
     47  **/
     48 typedef struct _GDataInputStreamClass    GDataInputStreamClass;
     49 typedef struct _GDataInputStreamPrivate  GDataInputStreamPrivate;
     50 
     51 struct _GDataInputStream
     52 {
     53   GBufferedInputStream parent_instance;
     54 
     55   /*< private >*/
     56   GDataInputStreamPrivate *priv;
     57 };
     58 
     59 struct _GDataInputStreamClass
     60 {
     61   GBufferedInputStreamClass parent_class;
     62 
     63   /*< private >*/
     64   /* Padding for future expansion */
     65   void (*_g_reserved1) (void);
     66   void (*_g_reserved2) (void);
     67   void (*_g_reserved3) (void);
     68   void (*_g_reserved4) (void);
     69   void (*_g_reserved5) (void);
     70 };
     71 
     72 GType                  g_data_input_stream_get_type             (void) G_GNUC_CONST;
     73 GDataInputStream *     g_data_input_stream_new                  (GInputStream            *base_stream);
     74 
     75 void                   g_data_input_stream_set_byte_order       (GDataInputStream        *stream,
     76 							         GDataStreamByteOrder     order);
     77 GDataStreamByteOrder   g_data_input_stream_get_byte_order       (GDataInputStream        *stream);
     78 void                   g_data_input_stream_set_newline_type     (GDataInputStream        *stream,
     79 							         GDataStreamNewlineType   type);
     80 GDataStreamNewlineType g_data_input_stream_get_newline_type     (GDataInputStream        *stream);
     81 guchar                 g_data_input_stream_read_byte            (GDataInputStream        *stream,
     82 							         GCancellable            *cancellable,
     83 							         GError                 **error);
     84 gint16                 g_data_input_stream_read_int16           (GDataInputStream        *stream,
     85 							         GCancellable            *cancellable,
     86 							         GError                 **error);
     87 guint16                g_data_input_stream_read_uint16          (GDataInputStream        *stream,
     88 							         GCancellable            *cancellable,
     89 							         GError                 **error);
     90 gint32                 g_data_input_stream_read_int32           (GDataInputStream        *stream,
     91 							         GCancellable            *cancellable,
     92 							         GError                 **error);
     93 guint32                g_data_input_stream_read_uint32          (GDataInputStream        *stream,
     94 							         GCancellable            *cancellable,
     95 							         GError                 **error);
     96 gint64                 g_data_input_stream_read_int64           (GDataInputStream        *stream,
     97 							         GCancellable            *cancellable,
     98 							         GError                 **error);
     99 guint64                g_data_input_stream_read_uint64          (GDataInputStream        *stream,
    100 							         GCancellable            *cancellable,
    101 							         GError                 **error);
    102 char *                 g_data_input_stream_read_line            (GDataInputStream        *stream,
    103 							         gsize                   *length,
    104 							         GCancellable            *cancellable,
    105 							         GError                 **error);
    106 void                   g_data_input_stream_read_line_async      (GDataInputStream        *stream,
    107                                                                  gint                     io_priority,
    108                                                                  GCancellable            *cancellable,
    109                                                                  GAsyncReadyCallback      callback,
    110                                                                  gpointer                 user_data);
    111 char *                 g_data_input_stream_read_line_finish     (GDataInputStream        *stream,
    112                                                                  GAsyncResult            *result,
    113                                                                  gsize                   *length,
    114                                                                  GError                 **error);
    115 char *                 g_data_input_stream_read_until           (GDataInputStream        *stream,
    116 							         const gchar             *stop_chars,
    117 							         gsize                   *length,
    118 							         GCancellable            *cancellable,
    119 							         GError                 **error);
    120 void                   g_data_input_stream_read_until_async     (GDataInputStream        *stream,
    121 							         const gchar             *stop_chars,
    122                                                                  gint                     io_priority,
    123                                                                  GCancellable            *cancellable,
    124                                                                  GAsyncReadyCallback      callback,
    125                                                                  gpointer                 user_data);
    126 char *                 g_data_input_stream_read_until_finish    (GDataInputStream        *stream,
    127                                                                  GAsyncResult            *result,
    128                                                                  gsize                   *length,
    129                                                                  GError                 **error);
    130 
    131 G_END_DECLS
    132 
    133 #endif /* __G_DATA_INPUT_STREAM_H__ */
    134