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  * GProxyResolver:
 203  *
 204  * A helper class to enumerate proxies base on URI.
 205  *
 206  * Since: 2.26
 207  **/
 208 typedef struct _GProxyResolver                GProxyResolver;
 209
 210 /**
 211  * GVolume:
 212  *
 213  * Opaque mountable volume object.
 214  **/
 215 typedef struct _GVolume                       GVolume; /* Dummy typedef */
 216 typedef struct _GVolumeMonitor                GVolumeMonitor;
 217
 218 /**
 219  * GAsyncReadyCallback:
 220  * @source_object: the object the asynchronous operation was started with.
 221  * @res: a #GAsyncResult.
 222  * @user_data: user data passed to the callback.
 223  *
 224  * Type definition for a function that will be called back when an asynchronous
 225  * operation within GIO has been completed.
 226  **/
 227 typedef void (*GAsyncReadyCallback) (GObject *source_object,
 228                                      GAsyncResult *res,
 229                                      gpointer user_data);
 230
 231 /**
 232  * GFileProgressCallback:
 233  * @current_num_bytes: the current number of bytes in the operation.
 234  * @total_num_bytes: the total number of bytes in the operation.
 235  * @user_data: user data passed to the callback.
 236  *
 237  * When doing file operations that may take a while, such as moving
 238  * a file or copying a file, a progress callback is used to pass how
 239  * far along that operation is to the application.
 240  **/
 241 typedef void (*GFileProgressCallback) (goffset current_num_bytes,
 242                                        goffset total_num_bytes,
 243                                        gpointer user_data);
 244
 245 /**
 246  * GFileReadMoreCallback:
 247  * @file_contents: the data as currently read.
 248  * @file_size: the size of the data currently read.
 249  * @callback_data: data passed to the callback.
 250  *
 251  * When loading the partial contents of a file with g_file_load_partial_contents_async(),
 252  * it may become necessary to determine if any more data from the file should be loaded.
 253  * A #GFileReadMoreCallback function facilitates this by returning %TRUE if more data
 254  * should be read, or %FALSE otherwise.
 255  *
 256  * Returns: %TRUE if more data should be read back. %FALSE otherwise.
 257  **/
 258 typedef gboolean (* GFileReadMoreCallback) (const char *file_contents,
 259                                             goffset file_size,
 260                                             gpointer callback_data);
 261
 262
 263 /**
 264  * GIOSchedulerJobFunc:
 265  * @job: a #GIOSchedulerJob.
 266  * @cancellable: optional #GCancellable object, %NULL to ignore.
 267  * @user_data: the data to pass to callback function
 268  *
 269  * I/O Job function.
 270  *
 271  * Note that depending on whether threads are available, the
 272  * #GIOScheduler may run jobs in separate threads or in an idle
 273  * in the mainloop.
 274  *
 275  * Long-running jobs should periodically check the @cancellable
 276  * to see if they have been cancelled.
 277  *
 278  * Returns: %TRUE if this function should be called again to
 279  *    complete the job, %FALSE if the job is complete (or cancelled)
 280  **/
 281 typedef gboolean (*GIOSchedulerJobFunc) (GIOSchedulerJob *job,
 282                                          GCancellable    *cancellable,
 283                                          gpointer         user_data);
 284
 285 /**
 286  * GSimpleAsyncThreadFunc:
 287  * @res: a #GSimpleAsyncResult.
 288  * @object: a #GObject.
 289  * @cancellable: optional #GCancellable object, %NULL to ignore.
 290  *
 291  * Simple thread function that runs an asynchronous operation and
 292  * checks for cancellation.
 293  **/
 294 typedef void (*GSimpleAsyncThreadFunc) (GSimpleAsyncResult *res,
 295                                         GObject *object,
 296                                         GCancellable *cancellable);
 297
 298 /**
 299  * GSocketSourceFunc:
 300  * @socket: the #GSocket
 301  * @condition: the current condition at the source fired.
 302  * @user_data: data passed in by the user.
 303  *
 304  * This is the function type of the callback used for the #GSource
 305  * returned by g_socket_create_source().
 306  *
 307  * Returns: it should return %FALSE if the source should be removed.
 308  *
 309  * Since: 2.22
 310  */
 311 typedef gboolean (*GSocketSourceFunc) (GSocket *socket,
 312                                        GIOCondition condition,
 313                                        gpointer user_data);
 314
 315 /**
 316  * GInputVector:
 317  * @buffer: Pointer to a buffer where data will be written.
 318  * @size: the available size in @buffer.
 319  *
 320  * Structure used for scatter/gather data input.
 321  * You generally pass in an array of #GInputVector<!-- -->s
 322  * and the operation will store the read data starting in the
 323  * first buffer, switching to the next as needed.
 324  *
 325  * Since: 2.22
 326  */
 327 typedef struct _GInputVector GInputVector;
 328
 329 struct _GInputVector {
 330   gpointer buffer;
 331   gsize size;
 332 };
 333
 334 /**
 335  * GOutputVector:
 336  * @buffer: Pointer to a buffer of data to read.
 337  * @size: the size of @buffer.
 338  *
 339  * Structure used for scatter/gather data output.
 340  * You generally pass in an array of #GOutputVector<!-- -->s
 341  * and the operation will use all the buffers as if they were
 342  * one buffer.
 343  *
 344  * Since: 2.22
 345  */
 346 typedef struct _GOutputVector GOutputVector;
 347
 348 struct _GOutputVector {
 349   gconstpointer buffer;
 350   gsize size;
 351 };
 352
 353 typedef struct _GCredentials                  GCredentials;
 354 typedef struct _GUnixCredentialsMessage       GUnixCredentialsMessage;
 355 typedef struct _GUnixFDList                   GUnixFDList;
 356 typedef struct _GDBusMessage                  GDBusMessage;
 357 typedef struct _GDBusConnection               GDBusConnection;
 358 typedef struct _GDBusProxy                    GDBusProxy;
 359 typedef struct _GDBusMethodInvocation         GDBusMethodInvocation;
 360 typedef struct _GDBusServer                   GDBusServer;
 361 typedef struct _GDBusAuthObserver             GDBusAuthObserver;
 362 typedef struct _GDBusErrorEntry               GDBusErrorEntry;
 363 typedef struct _GDBusInterfaceVTable          GDBusInterfaceVTable;
 364 typedef struct _GDBusSubtreeVTable            GDBusSubtreeVTable;
 365 typedef struct _GDBusAnnotationInfo           GDBusAnnotationInfo;
 366 typedef struct _GDBusArgInfo                  GDBusArgInfo;
 367 typedef struct _GDBusMethodInfo               GDBusMethodInfo;
 368 typedef struct _GDBusSignalInfo               GDBusSignalInfo;
 369 typedef struct _GDBusPropertyInfo             GDBusPropertyInfo;
 370 typedef struct _GDBusInterfaceInfo            GDBusInterfaceInfo;
 371 typedef struct _GDBusNodeInfo                 GDBusNodeInfo;
 372
 373 G_END_DECLS
 374
 375 #endif /* __GIO_TYPES_H__ */