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