libgnomevfs/gnome-vfs-context.h

   1 /* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */
   2 /* gnome-vfs-context.h - context VFS modules can use to communicate with gnome-vfs proper
   3
   4    Copyright (C) 1999, 2001 Free Software Foundation
   5
   6    The Gnome Library is free software; you can redistribute it and/or
   7    modify it under the terms of the GNU Library General Public License as
   8    published by the Free Software Foundation; either version 2 of the
   9    License, or (at your option) any later version.
  10
  11    The Gnome Library is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14    Library General Public License for more details.
  15
  16    You should have received a copy of the GNU Library General Public
  17    License along with the Gnome Library; see the file COPYING.LIB.  If not,
  18    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19    Boston, MA 02111-1307, USA.
  20
  21    Author: Havoc Pennington <hp@redhat.com>
  22            Seth Nickell <snickell@stanford.edu>
  23 */
  24
  25 #ifndef GNOME_VFS_CONTEXT_H
  26 #define GNOME_VFS_CONTEXT_H
  27
  28 #include <libgnomevfs/gnome-vfs-cancellation.h>
  29
  30 G_BEGIN_DECLS
  31
  32 typedef struct GnomeVFSContext GnomeVFSContext;
  33
  34 GnomeVFSContext* gnome_vfs_context_new                   (void);
  35 void             gnome_vfs_context_free                  (GnomeVFSContext *ctx);
  36
  37 /* To be really thread-safe, these need to return objects with an increased
  38    refcount; however they don't, only one thread at a time
  39    can use GnomeVFSContext */
  40
  41 GnomeVFSCancellation*
  42                  gnome_vfs_context_get_cancellation      (const GnomeVFSContext *ctx);
  43
  44 /* Convenience - both of these accept a NULL context object */
  45 #define          gnome_vfs_context_check_cancellation(x) (gnome_vfs_cancellation_check((x) ? gnome_vfs_context_get_cancellation((x)) : NULL))
  46
  47 const GnomeVFSContext *gnome_vfs_context_peek_current     (void);
  48 gboolean               gnome_vfs_context_check_cancellation_current (void);
  49
  50 G_END_DECLS
  51
  52 #endif /* GNOME_VFS_CONTEXT_H */