gio/giotypes.h

   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@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 __GIO_TYPES_H__
  28 #define __GIO_TYPES_H__
  29
  30 #include <gio/gioenums.h>
  31
  32 G_BEGIN_DECLS
  33
  34 typedef struct _GAppLaunchContext             GAppLaunchContext;
  35 typedef struct _GAppInfo                      GAppInfo; /* Dummy typedef */
  36 typedef struct _GAsyncResult                  GAsyncResult; /* Dummy typedef */
  37 typedef struct _GAsyncInitable                GAsyncInitable;
  38 typedef struct _GBufferedInputStream          GBufferedInputStream;
  39 typedef struct _GBufferedOutputStream         GBufferedOutputStream;
  40 typedef struct _GCancellable                  GCancellable;
  41 typedef struct _GCharsetConverter             GCharsetConverter;
  42 typedef struct _GConverter                    GConverter;
  43 typedef struct _GConverterInputStream         GConverterInputStream;
  44 typedef struct _GConverterOutputStream        GConverterOutputStream;
  45 typedef struct _GDataInputStream              GDataInputStream;
  46 typedef struct _GZlibCompressor               GZlibCompressor;
  47 typedef struct _GZlibDecompressor             GZlibDecompressor;
  48
  49 /**
  50  * GDrive:
  51  *
  52  * Opaque drive object.
  53  **/
  54 typedef struct _GDrive                        GDrive; /* Dummy typedef */
  55 typedef struct _GFileEnumerator               GFileEnumerator;
  56 typedef struct _GFileMonitor                  GFileMonitor;
  57 typedef struct _GFilterInputStream            GFilterInputStream;
  58 typedef struct _GFilterOutputStream           GFilterOutputStream;
  59
  60 /**
  61  * GFile:
  62  *
  63  * A handle to an object implementing the #GFileIface interface.
  64  * Generally stores a location within the file system. Handles do not
  65  * necessarily represent files or directories that currently exist.
  66  **/
  67 typedef struct _GFile                         GFile; /* Dummy typedef */
  68 typedef struct _GFileInfo                     GFileInfo;
  69
  70 /**
  71  * GFileAttributeMatcher:
  72  *
  73  * Determines if a string matches a file attribute.
  74  **/
  75 typedef struct _GFileAttributeMatcher         GFileAttributeMatcher;
  76 typedef struct _GFileAttributeInfo            GFileAttributeInfo;
  77 typedef struct _GFileAttributeInfoList        GFileAttributeInfoList;
  78 typedef struct _GFileInputStream              GFileInputStream;
  79 typedef struct _GFileOutputStream             GFileOutputStream;
  80 typedef struct _GFileIOStream                 GFileIOStream;
  81 typedef struct _GFileIcon                     GFileIcon;
  82 typedef struct _GFilenameCompleter            GFilenameCompleter;
  83
  84
  85 typedef struct _GIcon                         GIcon; /* Dummy typedef */
  86 typedef struct _GInetAddress                  GInetAddress;
  87 typedef struct _GInetSocketAddress            GInetSocketAddress;
  88 typedef struct _GInputStream                  GInputStream;
  89 typedef struct _GInitable                     GInitable;
  90 typedef struct _GIOModule                     GIOModule;
  91 typedef struct _GIOExtensionPoint             GIOExtensionPoint;
  92 typedef struct _GIOExtension                  GIOExtension;
  93
  94 /**
  95  * GIOSchedulerJob:
  96  *
  97  * Opaque class for definining and scheduling IO jobs.
  98  **/
  99 typedef struct _GIOSchedulerJob               GIOSchedulerJob;
 100 typedef struct _GLoadableIcon                 GLoadableIcon; /* Dummy typedef */
 101 typedef struct _GMemoryInputStream            GMemoryInputStream;
 102 typedef struct _GMemoryOutputStream           GMemoryOutputStream;
 103
 104 /**
 105  * GMount:
 106  *
 107  * A handle to an object implementing the #GMountIface interface.
 108  **/
 109 typedef struct _GMount                        GMount; /* Dummy typedef */
 110 typedef struct _GMountOperation               GMountOperation;
 111 typedef struct _GNetworkAddress               GNetworkAddress;
 112 typedef struct _GNetworkService               GNetworkService;
 113 typedef struct _GOutputStream                 GOutputStream;
 114 typedef struct _GIOStream                     GIOStream;
 115 typedef struct _GResolver                     GResolver;
 116 typedef struct _GSeekable                     GSeekable;
 117 typedef struct _GSimpleAsyncResult            GSimpleAsyncResult;
 118
 119 /**
 120  * GSocket:
 121  *
 122  * A lowlevel network socket object.
 123  *
 124  * Since: 2.22
 125  **/
 126 typedef struct _GSocket                       GSocket;
 127
 128 /**
 129  * GSocketControlMessage:
 130  *
 131  * Base class for socket-type specific control messages that can be sent and
 132  * received over #GSocket.
 133  **/
 134 typedef struct _GSocketControlMessage         GSocketControlMessage;
 135 /**
 136  * GSocketClient:
 137  *
 138  * A helper class for network clients to make connections.
 139  *
 140  * Since: 2.22
 141  **/
 142 typedef struct _GSocketClient                               GSocketClient;
 143 /**
 144  * GSocketConnection:
 145  *
 146  * A socket connection GIOStream object for connection-oriented sockets.
 147  *
 148  * Since: 2.22
 149  **/
 150 typedef struct _GSocketConnection                           GSocketConnection;
 151 /**
 152  * GSocketClient:
 153  *
 154  * A helper class for network servers to listen for and accept connections.
 155  *
 156  * Since: 2.22
 157  **/
 158 typedef struct _GSocketListener                             GSocketListener;
 159 /**
 160  * GSocketService:
 161  *
 162  * A helper class for handling accepting incomming connections in the
 163  * glib mainloop.
 164  *
 165  * Since: 2.22
 166  **/
 167 typedef struct _GSocketService                              GSocketService;
 168 typedef struct _GSocketAddress                GSocketAddress;
 169 typedef struct _GSocketAddressEnumerator      GSocketAddressEnumerator;
 170 typedef struct _GSocketConnectable            GSocketConnectable;
 171 typedef struct _GSrvTarget                    GSrvTarget;
 172 /**
 173  * GTcpConnection:
 174  *
 175  * A #GSocketConnection for TCP/IP connections.
 176  *
 177  * Since: 2.22
 178  **/
 179 typedef struct _GTcpConnection                              GTcpConnection;
 180 /**
 181  * GThreadedSocketService:
 182  *
 183  * A helper class for handling accepting incomming connections in the
 184  * glib mainloop and handling them in a thread.
 185  *
 186  * Since: 2.22
 187  **/
 188 typedef struct _GThreadedSocketService                      GThreadedSocketService;
 189 typedef struct _GThemedIcon                   GThemedIcon;
 190 typedef struct _GVfs                          GVfs; /* Dummy typedef */
 191
 192 /**
 193  * GVolume:
 194  *
 195  * Opaque mountable volume object.
 196  **/
 197 typedef struct _GVolume                       GVolume; /* Dummy typedef */
 198 typedef struct _GVolumeMonitor                GVolumeMonitor;
 199
 200 /**
 201  * GAsyncReadyCallback:
 202  * @source_object: the object the asynchronous operation was started with.
 203  * @res: a #GAsyncResult.
 204  * @user_data: user data passed to the callback.
 205  *
 206  * Type definition for a function that will be called back when an asynchronous
 207  * operation within GIO has been completed.
 208  **/
 209 typedef void (*GAsyncReadyCallback) (GObject *source_object,
 210                                      GAsyncResult *res,
 211                                      gpointer user_data);
 212
 213 /**
 214  * GFileProgressCallback:
 215  * @current_num_bytes: the current number of bytes in the operation.
 216  * @total_num_bytes: the total number of bytes in the operation.
 217  * @user_data: user data passed to the callback.
 218  *
 219  * When doing file operations that may take a while, such as moving
 220  * a file or copying a file, a progress callback is used to pass how
 221  * far along that operation is to the application.
 222  **/
 223 typedef void (*GFileProgressCallback) (goffset current_num_bytes,
 224                                        goffset total_num_bytes,
 225                                        gpointer user_data);
 226
 227 /**
 228  * GFileReadMoreCallback:
 229  * @file_contents: the data as currently read.
 230  * @file_size: the size of the data currently read.
 231  * @callback_data: data passed to the callback.
 232  *
 233  * When loading the partial contents of a file with g_file_load_partial_contents_async(),
 234  * it may become necessary to determine if any more data from the file should be loaded.
 235  * A #GFileReadMoreCallback function facilitates this by returning %TRUE if more data
 236  * should be read, or %FALSE otherwise.
 237  *
 238  * Returns: %TRUE if more data should be read back. %FALSE otherwise.
 239  **/
 240 typedef gboolean (* GFileReadMoreCallback) (const char *file_contents,
 241                                             goffset file_size,
 242                                             gpointer callback_data);
 243
 244
 245 /**
 246  * GIOSchedulerJobFunc:
 247  * @job: a #GIOSchedulerJob.
 248  * @cancellable: optional #GCancellable object, %NULL to ignore.
 249  * @user_data: the data to pass to callback function
 250  *
 251  * I/O Job function.
 252  *
 253  * Note that depending on whether threads are available, the
 254  * #GIOScheduler may run jobs in separate threads or in an idle
 255  * in the mainloop.
 256  *
 257  * Long-running jobs should periodically check the @cancellable
 258  * to see if they have been cancelled.
 259  *
 260  * Returns: %TRUE if this function should be called again to
 261  *    complete the job, %FALSE if the job is complete (or cancelled)
 262  **/
 263 typedef gboolean (*GIOSchedulerJobFunc) (GIOSchedulerJob *job,
 264                                          GCancellable    *cancellable,
 265                                          gpointer         user_data);
 266
 267 /**
 268  * GSimpleAsyncThreadFunc:
 269  * @res: a #GSimpleAsyncResult.
 270  * @object: a #GObject.
 271  * @cancellable: optional #GCancellable object, %NULL to ignore.
 272  *
 273  * Simple thread function that runs an asynchronous operation and
 274  * checks for cancellation.
 275  **/
 276 typedef void (*GSimpleAsyncThreadFunc) (GSimpleAsyncResult *res,
 277                                         GObject *object,
 278                                         GCancellable *cancellable);
 279
 280 /**
 281  * GSocketSourceFunc:
 282  * @socket: the #GSocket
 283  * @condition: the current condition at the source fired.
 284  * @user_data: data passed in by the user.
 285  *
 286  * This is the function type of the callback used for the #GSource
 287  * returned by g_socket_create_source().
 288  *
 289  * Returns: it should return %FALSE if the source should be removed.
 290  *
 291  * Since: 2.22
 292  */
 293 typedef gboolean (*GSocketSourceFunc) (GSocket *socket,
 294                                        GIOCondition condition,
 295                                        gpointer user_data);
 296
 297 /**
 298  * GInputVector:
 299  * @buffer: Pointer to a buffer where data will be written.
 300  * @size: the available size in @buffer.
 301  *
 302  * Structure used for scatter/gather data input.
 303  * You generally pass in an array of #GInputVector<!-- -->s
 304  * and the operation will store the read data starting in the
 305  * first buffer, switching to the next as needed.
 306  *
 307  * Since: 2.22
 308  */
 309 typedef struct _GInputVector GInputVector;
 310
 311 struct _GInputVector {
 312   gpointer buffer;
 313   gsize size;
 314 };
 315
 316 /**
 317  * GOutputVector:
 318  * @buffer: Pointer to a buffer of data to read.
 319  * @size: the size of @buffer.
 320  *
 321  * Structure used for scatter/gather data output.
 322  * You generally pass in an array of #GOutputVector<!-- -->s
 323  * and the operation will use all the buffers as if they were
 324  * one buffer.
 325  *
 326  * Since: 2.22
 327  */
 328 typedef struct _GOutputVector GOutputVector;
 329
 330 struct _GOutputVector {
 331   gconstpointer buffer;
 332   gsize size;
 333 };
 334
 335
 336 G_END_DECLS
 337
 338 #endif /* __GIO_TYPES_H__ */