gio/gseekable.h

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2006-2007 Red Hat, Inc.
   4  *
   5  * SPDX-License-Identifier: LGPL-2.1-or-later
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General
  18  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
  19  *
  20  * Author: Alexander Larsson <alexl@redhat.com>
  21  */
  22
  23 #ifndef __G_SEEKABLE_H__
  24 #define __G_SEEKABLE_H__
  25
  26 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  27 #error "Only <gio/gio.h> can be included directly."
  28 #endif
  29
  30 #include <gio/giotypes.h>
  31
  32 G_BEGIN_DECLS
  33
  34 #define G_TYPE_SEEKABLE            (g_seekable_get_type ())
  35 #define G_SEEKABLE(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_SEEKABLE, GSeekable))
  36 #define G_IS_SEEKABLE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_SEEKABLE))
  37 #define G_SEEKABLE_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_SEEKABLE, GSeekableIface))
  38
  39 /**
  40  * GSeekable:
  41  *
  42  * Seek object for streaming operations.
  43  **/
  44 typedef struct _GSeekableIface   GSeekableIface;
  45
  46 /**
  47  * GSeekableIface:
  48  * @g_iface: The parent interface.
  49  * @tell: Tells the current location within a stream.
  50  * @can_seek: Checks if seeking is supported by the stream.
  51  * @seek: Seeks to a location within a stream.
  52  * @can_truncate: Checks if truncation is supported by the stream.
  53  * @truncate_fn: Truncates a stream.
  54  *
  55  * Provides an interface for implementing seekable functionality on I/O Streams.
  56  **/
  57 struct _GSeekableIface
  58 {
  59   GTypeInterface g_iface;
  60
  61   /* Virtual Table */
  62
  63   goffset     (* tell)           (GSeekable    *seekable);
  64
  65   gboolean    (* can_seek)       (GSeekable    *seekable);
  66   gboolean    (* seek)           (GSeekable    *seekable,
  67                                   goffset       offset,
  68                                   GSeekType     type,
  69                                   GCancellable *cancellable,
  70                                   GError      **error);
  71
  72   gboolean    (* can_truncate)   (GSeekable    *seekable);
  73   gboolean    (* truncate_fn)    (GSeekable    *seekable,
  74                                   goffset       offset,
  75                                   GCancellable *cancellable,
  76                                   GError       **error);
  77
  78   /* TODO: Async seek/truncate */
  79 };
  80
  81 GIO_AVAILABLE_IN_ALL
  82 GType    g_seekable_get_type     (void) G_GNUC_CONST;
  83
  84 GIO_AVAILABLE_IN_ALL
  85 goffset  g_seekable_tell         (GSeekable     *seekable);
  86 GIO_AVAILABLE_IN_ALL
  87 gboolean g_seekable_can_seek     (GSeekable     *seekable);
  88 GIO_AVAILABLE_IN_ALL
  89 gboolean g_seekable_seek         (GSeekable     *seekable,
  90                                   goffset        offset,
  91                                   GSeekType      type,
  92                                   GCancellable  *cancellable,
  93                                   GError       **error);
  94 GIO_AVAILABLE_IN_ALL
  95 gboolean g_seekable_can_truncate (GSeekable     *seekable);
  96 GIO_AVAILABLE_IN_ALL
  97 gboolean g_seekable_truncate     (GSeekable     *seekable,
  98                                   goffset        offset,
  99                                   GCancellable  *cancellable,
 100                                   GError       **error);
 101
 102 G_END_DECLS
 103
 104
 105 #endif /* __G_SEEKABLE_H__ */