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