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 _GBufferedInputStream          GBufferedInputStream;
  38 typedef struct _GBufferedOutputStream         GBufferedOutputStream;
  39 typedef struct _GCancellable                  GCancellable;
  40 typedef struct _GDataInputStream              GDataInputStream;
  41
  42 /**
  43  * GDrive:
  44  *
  45  * Opaque drive object.
  46  **/
  47 typedef struct _GDrive                        GDrive; /* Dummy typedef */
  48 typedef struct _GFileEnumerator               GFileEnumerator;
  49 typedef struct _GFileMonitor                  GFileMonitor;
  50 typedef struct _GFilterInputStream            GFilterInputStream;
  51 typedef struct _GFilterOutputStream           GFilterOutputStream;
  52
  53 /**
  54  * GFile:
  55  *
  56  * A handle to an object implementing the #GFileIface interface.
  57  * Generally stores a location within the file system. Handles do not
  58  * necessarily represent files or directories that currently exist.
  59  **/
  60 typedef struct _GFile                         GFile; /* Dummy typedef */
  61 typedef struct _GFileInfo                     GFileInfo;
  62
  63 /**
  64  * GFileAttributeMatcher:
  65  *
  66  * Determines if a string matches a file attribute.
  67  **/
  68 typedef struct _GFileAttributeMatcher         GFileAttributeMatcher;
  69 typedef struct _GFileAttributeInfo            GFileAttributeInfo;
  70 typedef struct _GFileAttributeInfoList        GFileAttributeInfoList;
  71 typedef struct _GFileInputStream              GFileInputStream;
  72 typedef struct _GFileOutputStream             GFileOutputStream;
  73 typedef struct _GFileIcon                     GFileIcon;
  74 typedef struct _GFilenameCompleter            GFilenameCompleter;
  75
  76
  77 typedef struct _GIcon                         GIcon; /* Dummy typedef */
  78 typedef struct _GInetAddress                  GInetAddress;
  79 typedef struct _GInetSocketAddress            GInetSocketAddress;
  80 typedef struct _GInputStream                  GInputStream;
  81 typedef struct _GIOModule                     GIOModule;
  82 typedef struct _GIOExtensionPoint             GIOExtensionPoint;
  83 typedef struct _GIOExtension                  GIOExtension;
  84
  85 /**
  86  * GIOSchedulerJob:
  87  *
  88  * Opaque class for definining and scheduling IO jobs.
  89  **/
  90 typedef struct _GIOSchedulerJob               GIOSchedulerJob;
  91 typedef struct _GLoadableIcon                 GLoadableIcon; /* Dummy typedef */
  92 typedef struct _GMemoryInputStream            GMemoryInputStream;
  93 typedef struct _GMemoryOutputStream           GMemoryOutputStream;
  94
  95 /**
  96  * GMount:
  97  *
  98  * A handle to an object implementing the #GMountIface interface.
  99  **/
 100 typedef struct _GMount                        GMount; /* Dummy typedef */
 101 typedef struct _GMountOperation               GMountOperation;
 102 typedef struct _GNetworkAddress               GNetworkAddress;
 103 typedef struct _GNetworkService               GNetworkService;
 104 typedef struct _GOutputStream                 GOutputStream;
 105 typedef struct _GResolver                     GResolver;
 106 typedef struct _GSeekable                     GSeekable;
 107 typedef struct _GSimpleAsyncResult            GSimpleAsyncResult;
 108 typedef struct _GSocketAddress                GSocketAddress;
 109 typedef struct _GSocketAddressEnumerator      GSocketAddressEnumerator;
 110 typedef struct _GSocketConnectable            GSocketConnectable;
 111 typedef struct _GSrvTarget                    GSrvTarget;
 112 typedef struct _GThemedIcon                   GThemedIcon;
 113 typedef struct _GVfs                          GVfs; /* Dummy typedef */
 114
 115 /**
 116  * GVolume:
 117  *
 118  * Opaque mountable volume object.
 119  **/
 120 typedef struct _GVolume                       GVolume; /* Dummy typedef */
 121 typedef struct _GVolumeMonitor                GVolumeMonitor;
 122
 123 /**
 124  * GAsyncReadyCallback:
 125  * @source_object: the object the asynchronous operation was started with.
 126  * @res: a #GAsyncResult.
 127  * @user_data: user data passed to the callback.
 128  *
 129  * Type definition for a function that will be called back when an asynchronous
 130  * operation within GIO has been completed.
 131  **/
 132 typedef void (*GAsyncReadyCallback) (GObject *source_object,
 133                                      GAsyncResult *res,
 134                                      gpointer user_data);
 135
 136 /**
 137  * GFileProgressCallback:
 138  * @current_num_bytes: the current number of bytes in the operation.
 139  * @total_num_bytes: the total number of bytes in the operation.
 140  * @user_data: user data passed to the callback.
 141  *
 142  * When doing file operations that may take a while, such as moving
 143  * a file or copying a file, a progress callback is used to pass how
 144  * far along that operation is to the application.
 145  **/
 146 typedef void (*GFileProgressCallback) (goffset current_num_bytes,
 147                                        goffset total_num_bytes,
 148                                        gpointer user_data);
 149
 150 /**
 151  * GFileReadMoreCallback:
 152  * @file_contents: the data as currently read.
 153  * @file_size: the size of the data currently read.
 154  * @callback_data: data passed to the callback.
 155  *
 156  * When loading the partial contents of a file with g_file_load_partial_contents_async(),
 157  * it may become necessary to determine if any more data from the file should be loaded.
 158  * A #GFileReadMoreCallback function facilitates this by returning %TRUE if more data
 159  * should be read, or %FALSE otherwise.
 160  *
 161  * Returns: %TRUE if more data should be read back. %FALSE otherwise.
 162  **/
 163 typedef gboolean (* GFileReadMoreCallback) (const char *file_contents,
 164                                             goffset file_size,
 165                                             gpointer callback_data);
 166
 167
 168 /**
 169  * GIOSchedulerJobFunc:
 170  * @job: a #GIOSchedulerJob.
 171  * @cancellable: optional #GCancellable object, %NULL to ignore.
 172  * @user_data: the data to pass to callback function
 173  *
 174  * I/O Job function.
 175  *
 176  * Note that depending on whether threads are available, the
 177  * #GIOScheduler may run jobs in separate threads or in an idle
 178  * in the mainloop.
 179  *
 180  * Long-running jobs should periodically check the @cancellable
 181  * to see if they have been cancelled.
 182  *
 183  * Returns: %TRUE if this function should be called again to
 184  *    complete the job, %FALSE if the job is complete (or cancelled)
 185  **/
 186 typedef gboolean (*GIOSchedulerJobFunc) (GIOSchedulerJob *job,
 187                                          GCancellable    *cancellable,
 188                                          gpointer         user_data);
 189
 190 /**
 191  * GSimpleAsyncThreadFunc:
 192  * @res: a #GSimpleAsyncResult.
 193  * @object: a #GObject.
 194  * @cancellable: optional #GCancellable object, %NULL to ignore.
 195  *
 196  * Simple thread function that runs an asynchronous operation and
 197  * checks for cancellation.
 198  **/
 199 typedef void (*GSimpleAsyncThreadFunc) (GSimpleAsyncResult *res,
 200                                         GObject *object,
 201                                         GCancellable *cancellable);
 202
 203 G_END_DECLS
 204
 205 #endif /* __GIO_TYPES_H__ */