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