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