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