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