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, see <http://www.gnu.org/licenses/>.
  17  *
  18  * Author: Alexander Larsson <alexl@redhat.com>
  19  */
  20
  21 #ifndef __GIO_TYPES_H__
  22 #define __GIO_TYPES_H__
  23
  24 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  25 #error "Only <gio/gio.h> can be included directly."
  26 #endif
  27
  28 #include <gio/gioenums.h>
  29
  30 G_BEGIN_DECLS
  31
  32 typedef struct _GAppLaunchContext             GAppLaunchContext;
  33 typedef struct _GAppInfo                      GAppInfo; /* Dummy typedef */
  34 typedef struct _GAsyncResult                  GAsyncResult; /* Dummy typedef */
  35 typedef struct _GAsyncInitable                GAsyncInitable;
  36 typedef struct _GBufferedInputStream          GBufferedInputStream;
  37 typedef struct _GBufferedOutputStream         GBufferedOutputStream;
  38 typedef struct _GCancellable                  GCancellable;
  39 typedef struct _GCharsetConverter             GCharsetConverter;
  40 typedef struct _GConverter                    GConverter;
  41 typedef struct _GConverterInputStream         GConverterInputStream;
  42 typedef struct _GConverterOutputStream        GConverterOutputStream;
  43 typedef struct _GDataInputStream              GDataInputStream;
  44 typedef struct _GSimplePermission             GSimplePermission;
  45 typedef struct _GZlibCompressor               GZlibCompressor;
  46 typedef struct _GZlibDecompressor             GZlibDecompressor;
  47
  48 typedef struct _GSimpleActionGroup            GSimpleActionGroup;
  49 typedef struct _GRemoteActionGroup            GRemoteActionGroup;
  50 typedef struct _GDBusActionGroup              GDBusActionGroup;
  51 typedef struct _GActionMap                    GActionMap;
  52 typedef struct _GActionGroup                  GActionGroup;
  53 typedef struct _GPropertyAction               GPropertyAction;
  54 typedef struct _GSimpleAction                 GSimpleAction;
  55 typedef struct _GAction                       GAction;
  56 typedef struct _GApplication                  GApplication;
  57 typedef struct _GApplicationCommandLine       GApplicationCommandLine;
  58 typedef struct _GSettingsBackend              GSettingsBackend;
  59 typedef struct _GSettings                     GSettings;
  60 typedef struct _GPermission                   GPermission;
  61
  62 typedef struct _GMenuModel                    GMenuModel;
  63 typedef struct _GNotification                 GNotification;
  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 /**
 141  * GResource:
 142  *
 143  * A resource bundle.
 144  *
 145  * Since: 2.32
 146  */
 147 typedef struct _GResource                     GResource;
 148 typedef struct _GSeekable                     GSeekable;
 149 typedef struct _GSimpleAsyncResult            GSimpleAsyncResult;
 150
 151 /**
 152  * GSocket:
 153  *
 154  * A lowlevel network socket object.
 155  *
 156  * Since: 2.22
 157  **/
 158 typedef struct _GSocket                       GSocket;
 159
 160 /**
 161  * GSocketControlMessage:
 162  *
 163  * Base class for socket-type specific control messages that can be sent and
 164  * received over #GSocket.
 165  **/
 166 typedef struct _GSocketControlMessage         GSocketControlMessage;
 167 /**
 168  * GSocketClient:
 169  *
 170  * A helper class for network clients to make connections.
 171  *
 172  * Since: 2.22
 173  **/
 174 typedef struct _GSocketClient                               GSocketClient;
 175 /**
 176  * GSocketConnection:
 177  *
 178  * A socket connection GIOStream object for connection-oriented sockets.
 179  *
 180  * Since: 2.22
 181  **/
 182 typedef struct _GSocketConnection                           GSocketConnection;
 183 /**
 184  * GSocketListener:
 185  *
 186  * A helper class for network servers to listen for and accept connections.
 187  *
 188  * Since: 2.22
 189  **/
 190 typedef struct _GSocketListener                             GSocketListener;
 191 /**
 192  * GSocketService:
 193  *
 194  * A helper class for handling accepting incomming connections in the
 195  * glib mainloop.
 196  *
 197  * Since: 2.22
 198  **/
 199 typedef struct _GSocketService                              GSocketService;
 200 typedef struct _GSocketAddress                GSocketAddress;
 201 typedef struct _GSocketAddressEnumerator      GSocketAddressEnumerator;
 202 typedef struct _GSocketConnectable            GSocketConnectable;
 203 typedef struct _GSrvTarget                    GSrvTarget;
 204 typedef struct _GTask                         GTask;
 205 /**
 206  * GTcpConnection:
 207  *
 208  * A #GSocketConnection for TCP/IP connections.
 209  *
 210  * Since: 2.22
 211  **/
 212 typedef struct _GTcpConnection                              GTcpConnection;
 213 typedef struct _GTcpWrapperConnection                       GTcpWrapperConnection;
 214 /**
 215  * GThreadedSocketService:
 216  *
 217  * A helper class for handling accepting incoming connections in the
 218  * glib mainloop and handling them in a thread.
 219  *
 220  * Since: 2.22
 221  **/
 222 typedef struct _GThreadedSocketService                      GThreadedSocketService;
 223 typedef struct _GThemedIcon                   GThemedIcon;
 224 typedef struct _GTlsCertificate               GTlsCertificate;
 225 typedef struct _GTlsClientConnection          GTlsClientConnection; /* Dummy typedef */
 226 typedef struct _GTlsConnection                GTlsConnection;
 227 typedef struct _GTlsDatabase                  GTlsDatabase;
 228 typedef struct _GTlsFileDatabase              GTlsFileDatabase;
 229 typedef struct _GTlsInteraction               GTlsInteraction;
 230 typedef struct _GTlsPassword                  GTlsPassword;
 231 typedef struct _GTlsServerConnection          GTlsServerConnection; /* Dummy typedef */
 232 typedef struct _GVfs                          GVfs; /* Dummy typedef */
 233
 234 /**
 235  * GProxyResolver:
 236  *
 237  * A helper class to enumerate proxies base on URI.
 238  *
 239  * Since: 2.26
 240  **/
 241 typedef struct _GProxyResolver                GProxyResolver;
 242 typedef struct _GProxy                        GProxy;
 243 typedef struct _GProxyAddress                 GProxyAddress;
 244 typedef struct _GProxyAddressEnumerator       GProxyAddressEnumerator;
 245
 246 /**
 247  * GVolume:
 248  *
 249  * Opaque mountable volume object.
 250  **/
 251 typedef struct _GVolume                       GVolume; /* Dummy typedef */
 252 typedef struct _GVolumeMonitor                GVolumeMonitor;
 253
 254 /**
 255  * GAsyncReadyCallback:
 256  * @source_object: the object the asynchronous operation was started with.
 257  * @res: a #GAsyncResult.
 258  * @user_data: user data passed to the callback.
 259  *
 260  * Type definition for a function that will be called back when an asynchronous
 261  * operation within GIO has been completed.
 262  **/
 263 typedef void (*GAsyncReadyCallback) (GObject *source_object,
 264                                      GAsyncResult *res,
 265                                      gpointer user_data);
 266
 267 /**
 268  * GFileProgressCallback:
 269  * @current_num_bytes: the current number of bytes in the operation.
 270  * @total_num_bytes: the total number of bytes in the operation.
 271  * @user_data: user data passed to the callback.
 272  *
 273  * When doing file operations that may take a while, such as moving
 274  * a file or copying a file, a progress callback is used to pass how
 275  * far along that operation is to the application.
 276  **/
 277 typedef void (*GFileProgressCallback) (goffset current_num_bytes,
 278                                        goffset total_num_bytes,
 279                                        gpointer user_data);
 280
 281 /**
 282  * GFileReadMoreCallback:
 283  * @file_contents: the data as currently read.
 284  * @file_size: the size of the data currently read.
 285  * @callback_data: data passed to the callback.
 286  *
 287  * When loading the partial contents of a file with g_file_load_partial_contents_async(),
 288  * it may become necessary to determine if any more data from the file should be loaded.
 289  * A #GFileReadMoreCallback function facilitates this by returning %TRUE if more data
 290  * should be read, or %FALSE otherwise.
 291  *
 292  * Returns: %TRUE if more data should be read back. %FALSE otherwise.
 293  **/
 294 typedef gboolean (* GFileReadMoreCallback) (const char *file_contents,
 295                                             goffset file_size,
 296                                             gpointer callback_data);
 297
 298 /**
 299  * GFileMeasureProgressCallback:
 300  * @reporting: %TRUE if more reports will come
 301  * @current_size: the current cumulative size measurement
 302  * @num_dirs: the number of directories visited so far
 303  * @num_files: the number of non-directory files encountered
 304  * @user_data: the data passed to the original request for this callback
 305  *
 306  * This callback type is used by g_file_measure_disk_usage() to make
 307  * periodic progress reports when measuring the amount of disk spaced
 308  * used by a directory.
 309  *
 310  * These calls are made on a best-effort basis and not all types of
 311  * #GFile will support them.  At the minimum, however, one call will
 312  * always be made immediately.
 313  *
 314  * In the case that there is no support, @reporting will be set to
 315  * %FALSE (and the other values undefined) and no further calls will be
 316  * made.  Otherwise, the @reporting will be %TRUE and the other values
 317  * all-zeros during the first (immediate) call.  In this way, you can
 318  * know which type of progress UI to show without a delay.
 319  *
 320  * For g_file_measure_disk_usage() the callback is made directly.  For
 321  * g_file_measure_disk_usage_async() the callback is made via the
 322  * default main context of the calling thread (ie: the same way that the
 323  * final async result would be reported).
 324  *
 325  * @current_size is in the same units as requested by the operation (see
 326  * %G_FILE_DISK_USAGE_APPARENT_SIZE).
 327  *
 328  * The frequency of the updates is implementation defined, but is
 329  * ideally about once every 200ms.
 330  *
 331  * The last progress callback may or may not be equal to the final
 332  * result.  Always check the async result to get the final value.
 333  *
 334  * Since: 2.38
 335  **/
 336 typedef void (* GFileMeasureProgressCallback) (gboolean reporting,
 337                                                guint64  current_size,
 338                                                guint64  num_dirs,
 339                                                guint64  num_files,
 340                                                gpointer user_data);
 341
 342 /**
 343  * GIOSchedulerJobFunc:
 344  * @job: a #GIOSchedulerJob.
 345  * @cancellable: optional #GCancellable object, %NULL to ignore.
 346  * @user_data: the data to pass to callback function
 347  *
 348  * I/O Job function.
 349  *
 350  * Long-running jobs should periodically check the @cancellable
 351  * to see if they have been cancelled.
 352  *
 353  * Returns: %TRUE if this function should be called again to
 354  *    complete the job, %FALSE if the job is complete (or cancelled)
 355  **/
 356 typedef gboolean (*GIOSchedulerJobFunc) (GIOSchedulerJob *job,
 357                                          GCancellable    *cancellable,
 358                                          gpointer         user_data);
 359
 360 /**
 361  * GSimpleAsyncThreadFunc:
 362  * @res: a #GSimpleAsyncResult.
 363  * @object: a #GObject.
 364  * @cancellable: optional #GCancellable object, %NULL to ignore.
 365  *
 366  * Simple thread function that runs an asynchronous operation and
 367  * checks for cancellation.
 368  **/
 369 typedef void (*GSimpleAsyncThreadFunc) (GSimpleAsyncResult *res,
 370                                         GObject *object,
 371                                         GCancellable *cancellable);
 372
 373 /**
 374  * GSocketSourceFunc:
 375  * @socket: the #GSocket
 376  * @condition: the current condition at the source fired.
 377  * @user_data: data passed in by the user.
 378  *
 379  * This is the function type of the callback used for the #GSource
 380  * returned by g_socket_create_source().
 381  *
 382  * Returns: it should return %FALSE if the source should be removed.
 383  *
 384  * Since: 2.22
 385  */
 386 typedef gboolean (*GSocketSourceFunc) (GSocket *socket,
 387                                        GIOCondition condition,
 388                                        gpointer user_data);
 389
 390 /**
 391  * GInputVector:
 392  * @buffer: Pointer to a buffer where data will be written.
 393  * @size: the available size in @buffer.
 394  *
 395  * Structure used for scatter/gather data input.
 396  * You generally pass in an array of #GInputVectors
 397  * and the operation will store the read data starting in the
 398  * first buffer, switching to the next as needed.
 399  *
 400  * Since: 2.22
 401  */
 402 typedef struct _GInputVector GInputVector;
 403
 404 struct _GInputVector {
 405   gpointer buffer;
 406   gsize size;
 407 };
 408
 409 /**
 410  * GOutputVector:
 411  * @buffer: Pointer to a buffer of data to read.
 412  * @size: the size of @buffer.
 413  *
 414  * Structure used for scatter/gather data output.
 415  * You generally pass in an array of #GOutputVectors
 416  * and the operation will use all the buffers as if they were
 417  * one buffer.
 418  *
 419  * Since: 2.22
 420  */
 421 typedef struct _GOutputVector GOutputVector;
 422
 423 struct _GOutputVector {
 424   gconstpointer buffer;
 425   gsize size;
 426 };
 427
 428 typedef struct _GCredentials                  GCredentials;
 429 typedef struct _GUnixCredentialsMessage       GUnixCredentialsMessage;
 430 typedef struct _GUnixFDList                   GUnixFDList;
 431 typedef struct _GDBusMessage                  GDBusMessage;
 432 typedef struct _GDBusConnection               GDBusConnection;
 433 typedef struct _GDBusProxy                    GDBusProxy;
 434 typedef struct _GDBusMethodInvocation         GDBusMethodInvocation;
 435 typedef struct _GDBusServer                   GDBusServer;
 436 typedef struct _GDBusAuthObserver             GDBusAuthObserver;
 437 typedef struct _GDBusErrorEntry               GDBusErrorEntry;
 438 typedef struct _GDBusInterfaceVTable          GDBusInterfaceVTable;
 439 typedef struct _GDBusSubtreeVTable            GDBusSubtreeVTable;
 440 typedef struct _GDBusAnnotationInfo           GDBusAnnotationInfo;
 441 typedef struct _GDBusArgInfo                  GDBusArgInfo;
 442 typedef struct _GDBusMethodInfo               GDBusMethodInfo;
 443 typedef struct _GDBusSignalInfo               GDBusSignalInfo;
 444 typedef struct _GDBusPropertyInfo             GDBusPropertyInfo;
 445 typedef struct _GDBusInterfaceInfo            GDBusInterfaceInfo;
 446 typedef struct _GDBusNodeInfo                 GDBusNodeInfo;
 447
 448 /**
 449  * GCancellableSourceFunc:
 450  * @cancellable: the #GCancellable
 451  * @user_data: data passed in by the user.
 452  *
 453  * This is the function type of the callback used for the #GSource
 454  * returned by g_cancellable_source_new().
 455  *
 456  * Returns: it should return %FALSE if the source should be removed.
 457  *
 458  * Since: 2.28
 459  */
 460 typedef gboolean (*GCancellableSourceFunc) (GCancellable *cancellable,
 461                                             gpointer      user_data);
 462
 463 /**
 464  * GPollableSourceFunc:
 465  * @pollable_stream: the #GPollableInputStream or #GPollableOutputStream
 466  * @user_data: data passed in by the user.
 467  *
 468  * This is the function type of the callback used for the #GSource
 469  * returned by g_pollable_input_stream_create_source() and
 470  * g_pollable_output_stream_create_source().
 471  *
 472  * Returns: it should return %FALSE if the source should be removed.
 473  *
 474  * Since: 2.28
 475  */
 476 typedef gboolean (*GPollableSourceFunc) (GObject  *pollable_stream,
 477                                          gpointer  user_data);
 478
 479 typedef struct _GDBusInterface              GDBusInterface; /* Dummy typedef */
 480 typedef struct _GDBusInterfaceSkeleton      GDBusInterfaceSkeleton;
 481 typedef struct _GDBusObject                 GDBusObject;  /* Dummy typedef */
 482 typedef struct _GDBusObjectSkeleton         GDBusObjectSkeleton;
 483 typedef struct _GDBusObjectProxy            GDBusObjectProxy;
 484 typedef struct _GDBusObjectManager          GDBusObjectManager;  /* Dummy typedef */
 485 typedef struct _GDBusObjectManagerClient    GDBusObjectManagerClient;
 486 typedef struct _GDBusObjectManagerServer    GDBusObjectManagerServer;
 487
 488 /**
 489  * GDBusProxyTypeFunc:
 490  * @manager: A #GDBusObjectManagerClient.
 491  * @object_path: The object path of the remote object.
 492  * @interface_name: (allow-none): The interface name of the remote object or %NULL if a #GDBusObjectProxy #GType is requested.
 493  * @user_data: User data.
 494  *
 495  * Function signature for a function used to determine the #GType to
 496  * use for an interface proxy (if @interface_name is not %NULL) or
 497  * object proxy (if @interface_name is %NULL).
 498  *
 499  * This function is called in the
 500  * [thread-default main loop][g-main-context-push-thread-default]
 501  * that @manager was constructed in.
 502  *
 503  * Returns: A #GType to use for the remote object. The returned type
 504  *   must be a #GDBusProxy<!-- -->- or #GDBusObjectProxy<!-- -->-derived
 505  *   type.
 506  *
 507  * Since: 2.30
 508  */
 509 typedef GType (*GDBusProxyTypeFunc) (GDBusObjectManagerClient   *manager,
 510                                      const gchar                *object_path,
 511                                      const gchar                *interface_name,
 512                                      gpointer                    user_data);
 513
 514 typedef struct _GTestDBus GTestDBus;
 515
 516 /**
 517  * GSubprocess:
 518  *
 519  * A child process.
 520  *
 521  * Since: 2.40
 522  */
 523 typedef struct _GSubprocess                   GSubprocess;
 524 /**
 525  * GSubprocessLauncher:
 526  *
 527  * Options for launching a child process.
 528  *
 529  * Since: 2.40
 530  */
 531 typedef struct _GSubprocessLauncher           GSubprocessLauncher;
 532
 533 G_END_DECLS
 534
 535 #endif /* __GIO_TYPES_H__ */