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