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