glib/gio/gfileinputstream.h

/* GIO - GLib Input, Output and Streaming Library
 * 
 * Copyright (C) 2006-2007 Red Hat, Inc.
 *
 * 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: Alexander Larsson <alexl@redhat.com>
 */

#ifndef __G_FILE_INPUT_STREAM_H__
#define __G_FILE_INPUT_STREAM_H__

#include <gio/ginputstream.h>
#include <gio/gfileinfo.h>

G_BEGIN_DECLS

#define G_TYPE_FILE_INPUT_STREAM         (g_file_input_stream_get_type ())
#define G_FILE_INPUT_STREAM(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_FILE_INPUT_STREAM, GFileInputStream))
#define G_FILE_INPUT_STREAM_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_FILE_INPUT_STREAM, GFileInputStreamClass))
#define G_IS_FILE_INPUT_STREAM(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_FILE_INPUT_STREAM))
#define G_IS_FILE_INPUT_STREAM_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_FILE_INPUT_STREAM))
#define G_FILE_INPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_FILE_INPUT_STREAM, GFileInputStreamClass))

/**
 * GFileInputStream:
 * 
 * A subclass of GInputStream for opened files. This adds
 * a few file-specific operations and seeking.
 *
 * #GFileInputStream implements #GSeekable.
 **/
typedef struct _GFileInputStream         GFileInputStream;
typedef struct _GFileInputStreamClass    GFileInputStreamClass;
typedef struct _GFileInputStreamPrivate  GFileInputStreamPrivate;

struct _GFileInputStream
{
  GInputStream parent_instance;

  /*< private >*/
  GFileInputStreamPrivate *priv;
};

struct _GFileInputStreamClass
{
  GInputStreamClass parent_class;

  goffset    (*tell)          (GFileInputStream     *stream);
  gboolean   (*can_seek)      (GFileInputStream     *stream);
  gboolean   (*seek)	      (GFileInputStream     *stream,
			       goffset               offset,
			       GSeekType             type,
			       GCancellable         *cancellable,
			       GError              **error);
  GFileInfo *(*query_info)    (GFileInputStream     *stream,
			       char                 *attributes,
			       GCancellable         *cancellable,
			       GError              **error);
  void       (*query_info_async)  (GFileInputStream     *stream,
				   char                 *attributes,
				   int                   io_priority,
				   GCancellable         *cancellable,
				   GAsyncReadyCallback   callback,
				   gpointer              user_data);
  GFileInfo *(*query_info_finish) (GFileInputStream     *stream,
				   GAsyncResult         *res,
				   GError              **error);
  /*< private >*/
  /* Padding for future expansion */
  void (*_g_reserved1) (void);
  void (*_g_reserved2) (void);
  void (*_g_reserved3) (void);
  void (*_g_reserved4) (void);
  void (*_g_reserved5) (void);
};

GType g_file_input_stream_get_type (void) G_GNUC_CONST;

GFileInfo *g_file_input_stream_query_info        (GFileInputStream     *stream,
						  char                 *attributes,
						  GCancellable         *cancellable,
						  GError              **error);
void       g_file_input_stream_query_info_async  (GFileInputStream     *stream,
						  char                 *attributes,
						  int                   io_priority,
						  GCancellable         *cancellable,
						  GAsyncReadyCallback   callback,
						  gpointer              user_data);
GFileInfo *g_file_input_stream_query_info_finish (GFileInputStream     *stream,
						  GAsyncResult         *result,
						  GError              **error);
goffset    g_file_input_stream_tell              (GFileInputStream     *stream);
gboolean   g_file_input_stream_can_seek          (GFileInputStream     *stream);
gboolean   g_file_input_stream_seek              (GFileInputStream     *stream,
						  goffset               offset,
						  GSeekType             type,
						  GCancellable         *cancellable,
						  GError              **error);



G_END_DECLS

#endif /* __G_FILE_FILE_INPUT_STREAM_H__ */