gseekable.h 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100
  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. #ifndef __G_SEEKABLE_H__
  23. #define __G_SEEKABLE_H__
  24. #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  25. #error "Only <gio/gio.h> can be included directly."
  26. #endif
  27. #include <gio/giotypes.h>
  28. G_BEGIN_DECLS
  29. #define G_TYPE_SEEKABLE (g_seekable_get_type ())
  30. #define G_SEEKABLE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_SEEKABLE, GSeekable))
  31. #define G_IS_SEEKABLE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_SEEKABLE))
  32. #define G_SEEKABLE_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_SEEKABLE, GSeekableIface))
  33. typedef struct _GSeekableIface GSeekableIface;
  34. /**
  35. * GSeekableIface:
  36. * @g_iface: The parent interface.
  37. * @tell: Tells the current location within a stream.
  38. * @can_seek: Checks if seeking is supported by the stream.
  39. * @seek: Seeks to a location within a stream.
  40. * @can_truncate: Checks if truncation is supported by the stream.
  41. * @truncate_fn: Truncates a stream.
  42. *
  43. * Provides an interface for implementing seekable functionality on I/O Streams.
  44. **/
  45. struct _GSeekableIface
  46. {
  47. GTypeInterface g_iface;
  48. /* Virtual Table */
  49. goffset (* tell) (GSeekable *seekable);
  50. gboolean (* can_seek) (GSeekable *seekable);
  51. gboolean (* seek) (GSeekable *seekable,
  52. goffset offset,
  53. GSeekType type,
  54. GCancellable *cancellable,
  55. GError **error);
  56. gboolean (* can_truncate) (GSeekable *seekable);
  57. gboolean (* truncate_fn) (GSeekable *seekable,
  58. goffset offset,
  59. GCancellable *cancellable,
  60. GError **error);
  61. /* TODO: Async seek/truncate */
  62. };
  63. GIO_AVAILABLE_IN_ALL
  64. GType g_seekable_get_type (void) G_GNUC_CONST;
  65. GIO_AVAILABLE_IN_ALL
  66. goffset g_seekable_tell (GSeekable *seekable);
  67. GIO_AVAILABLE_IN_ALL
  68. gboolean g_seekable_can_seek (GSeekable *seekable);
  69. GIO_AVAILABLE_IN_ALL
  70. gboolean g_seekable_seek (GSeekable *seekable,
  71. goffset offset,
  72. GSeekType type,
  73. GCancellable *cancellable,
  74. GError **error);
  75. GIO_AVAILABLE_IN_ALL
  76. gboolean g_seekable_can_truncate (GSeekable *seekable);
  77. GIO_AVAILABLE_IN_ALL
  78. gboolean g_seekable_truncate (GSeekable *seekable,
  79. goffset offset,
  80. GCancellable *cancellable,
  81. GError **error);
  82. G_END_DECLS
  83. #endif /* __G_SEEKABLE_H__ */