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