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