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