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