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