gtkfilesystem.h 12 KB
Newer Older
Owen Taylor's avatar
Owen Taylor committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
/* GTK - The GIMP Toolkit
 * gtkfilesystem.h: Abstract file system interfaces
 * Copyright (C) 2003, Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

#ifndef __GTK_FILE_SYSTEM_H__
#define __GTK_FILE_SYSTEM_H__

24 25 26 27 28 29 30 31
/* This is a "semi-private" header; it is meant only for
 * alternate GtkFileChooser backend modules; no stability guarantees 
 * are made at this point
 */
#ifndef GTK_FILE_SYSTEM_ENABLE_UNSUPPORTED
#error "GtkFileSystem is not supported API for general use"
#endif

Owen Taylor's avatar
Owen Taylor committed
32
#include <glib-object.h>
Owen Taylor's avatar
Owen Taylor committed
33
#include <gtk/gtkwidget.h>	/* For icon handling */
Owen Taylor's avatar
Owen Taylor committed
34 35 36 37 38 39 40 41 42 43 44

G_BEGIN_DECLS

typedef gint64 GtkFileTime;

typedef struct _GtkFileFolder      GtkFileFolder;
typedef struct _GtkFileFolderIface GtkFileFolderIface;
typedef struct _GtkFileInfo        GtkFileInfo;
typedef struct _GtkFileSystem      GtkFileSystem;
typedef struct _GtkFileSystemIface GtkFileSystemIface;

45 46
typedef struct _GtkFilePath        GtkFilePath;

Owen Taylor's avatar
Owen Taylor committed
47 48 49 50 51 52 53 54 55 56
/* Mask of information about a file, for monitoring and
 * gtk_file_system_get_info()
 */
typedef enum {
  GTK_FILE_INFO_DISPLAY_NAME      = 1 << 0,
  GTK_FILE_INFO_IS_FOLDER         = 1 << 1,
  GTK_FILE_INFO_IS_HIDDEN         = 1 << 2,
  GTK_FILE_INFO_MIME_TYPE         = 1 << 3,
  GTK_FILE_INFO_MODIFICATION_TIME = 1 << 4,
  GTK_FILE_INFO_SIZE              = 1 << 5,
57 58
  GTK_FILE_INFO_ICON              = 1 << 6,
  GTK_FILE_INFO_ALL               = (1 << 7) - 1
Owen Taylor's avatar
Owen Taylor committed
59 60
} GtkFileInfoType;

Owen Taylor's avatar
Owen Taylor committed
61 62 63 64 65 66 67 68 69 70 71 72 73
/* Icon type, supplemented by MIME type
 */
typedef enum {
  GTK_FILE_ICON_REGULAR,	/* Use mime type for icon */
  GTK_FILE_ICON_BLOCK_DEVICE,
  GTK_FILE_ICON_BROKEN_SYMBOLIC_LINK,
  GTK_FILE_ICON_CHARACTER_DEVICE,
  GTK_FILE_ICON_DIRECTORY,
  GTK_FILE_ICON_EXECUTABLE,
  GTK_FILE_ICON_FIFO,
  GTK_FILE_ICON_SOCKET
} GtkFileIconType;

Owen Taylor's avatar
Owen Taylor committed
74 75 76 77 78 79 80
/* GError enumeration for GtkFileSystem
 */

#define GTK_FILE_SYSTEM_ERROR (gtk_file_system_error_quark ())

typedef enum
{
81
  GTK_FILE_SYSTEM_ERROR_NONEXISTENT,
Owen Taylor's avatar
Owen Taylor committed
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
  GTK_FILE_SYSTEM_ERROR_NOT_FOLDER,
  GTK_FILE_SYSTEM_ERROR_INVALID_URI,
  GTK_FILE_SYSTEM_ERROR_BAD_FILENAME,
  GTK_FILE_SYSTEM_ERROR_FAILED,
} GtkFileSystemError;

GQuark     gtk_file_system_error_quark      (void);

/* Boxed-type for gtk_file_folder_get_info() results
 */
#define GTK_TYPE_FILE_INFO (gtk_file_info_get_type ())

GType       gtk_file_info_get_type (void);

GtkFileInfo *gtk_file_info_new  (void);
GtkFileInfo *gtk_file_info_copy (GtkFileInfo *info);
void         gtk_file_info_free (GtkFileInfo *info);


G_CONST_RETURN gchar *gtk_file_info_get_display_name      (const GtkFileInfo *info);
Owen Taylor's avatar
Owen Taylor committed
102
G_CONST_RETURN gchar *gtk_file_info_get_display_key       (const GtkFileInfo *info);
Owen Taylor's avatar
Owen Taylor committed
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
void                  gtk_file_info_set_display_name      (GtkFileInfo       *info,
							   const gchar       *display_name);
gboolean              gtk_file_info_get_is_folder         (const GtkFileInfo *info);
void                  gtk_file_info_set_is_folder         (GtkFileInfo       *info,
							   gboolean           is_folder);
gboolean              gtk_file_info_get_is_hidden         (const GtkFileInfo *info);
void                  gtk_file_info_set_is_hidden         (GtkFileInfo       *info,
							   gboolean           is_hidden);
G_CONST_RETURN gchar *gtk_file_info_get_mime_type         (const GtkFileInfo *info);
void                  gtk_file_info_set_mime_type         (GtkFileInfo       *info,
							   const gchar       *mime_type);
GtkFileTime           gtk_file_info_get_modification_time (const GtkFileInfo *info);
void                  gtk_file_info_set_modification_time (GtkFileInfo       *info,
							   GtkFileTime        modification_time);
gint64                gtk_file_info_get_size              (const GtkFileInfo *info);
void                  gtk_file_info_set_size              (GtkFileInfo       *info,
							   gint64             size);
Owen Taylor's avatar
Owen Taylor committed
120 121 122 123 124 125
void                  gtk_file_info_set_icon_type         (GtkFileInfo       *info,
							   GtkFileIconType    icon_type);
GtkFileIconType       gtk_file_info_get_icon_type         (const GtkFileInfo *info);
GdkPixbuf *           gtk_file_info_render_icon           (const GtkFileInfo *info,
							   GtkWidget         *widget,
							   gint               pixel_size);
Owen Taylor's avatar
Owen Taylor committed
126 127 128 129 130 131 132 133 134 135 136 137 138 139

/* The base GtkFileSystem interface
 */
#define GTK_TYPE_FILE_SYSTEM             (gtk_file_system_get_type ())
#define GTK_FILE_SYSTEM(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_FILE_SYSTEM, GtkFileSystem))
#define GTK_IS_FILE_SYSTEM(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_FILE_SYSTEM))
#define GTK_FILE_SYSTEM_GET_IFACE(inst)  (G_TYPE_INSTANCE_GET_INTERFACE ((inst), GTK_TYPE_FILE_SYSTEM, GtkFileSystemIface))

struct _GtkFileSystemIface
{
  GTypeInterface base_iface;

  /* Methods
   */
140
  GSList *           (*list_roots)     (GtkFileSystem     *file_system);
Owen Taylor's avatar
Owen Taylor committed
141

142 143 144 145
  GtkFileInfo *      (*get_root_info)  (GtkFileSystem     *file_system,
					const GtkFilePath *path,
					GtkFileInfoType    types,
				        GError           **error);
146

147 148 149 150 151 152 153 154 155
  GtkFileFolder *    (*get_folder)     (GtkFileSystem     *file_system,
					const GtkFilePath *path,
					GtkFileInfoType    types,
				        GError           **error);
  gboolean           (*create_folder)  (GtkFileSystem     *file_system,
					const GtkFilePath *path,
			                GError           **error);

  /* Path Manipulation
Owen Taylor's avatar
Owen Taylor committed
156
   */
157 158 159 160 161 162 163
  gboolean      (*get_parent)      (GtkFileSystem      *file_system,
				    const GtkFilePath  *path,
				    GtkFilePath       **parent,
				    GError            **error);
  GtkFilePath * (*make_path)        (GtkFileSystem     *file_system,
				     const GtkFilePath *base_path,
				     const gchar       *display_name,
164
				     GError           **error);
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
  gboolean      (*parse)            (GtkFileSystem     *file_system,
				     const GtkFilePath *base_path,
				     const gchar       *str,
				     GtkFilePath      **folder,
				     gchar            **file_part,
				     GError           **error);
  gchar *      (*path_to_uri)      (GtkFileSystem      *file_system,
				    const GtkFilePath  *path);
  gchar *      (*path_to_filename) (GtkFileSystem      *file_system,
				    const GtkFilePath  *path);
  GtkFilePath *(*uri_to_path)      (GtkFileSystem      *file_system,
				    const gchar        *uri);
  GtkFilePath *(*filename_to_path) (GtkFileSystem      *file_system,
				    const gchar        *path);

180 181
  /* Bookmarks */

182 183 184 185 186 187
  gboolean       (*add_bookmark)           (GtkFileSystem     *file_system,
					    const GtkFilePath *path,
					    GError           **error);
  gboolean       (*remove_bookmark)        (GtkFileSystem     *file_system,
					    const GtkFilePath *path,
					    GError           **error);
188 189
  GSList *       (*list_bookmarks)         (GtkFileSystem *file_system);

Owen Taylor's avatar
Owen Taylor committed
190 191
  /* Signals
   */
192 193
  void (*roots_changed)     (GtkFileSystem *file_system);
  void (*bookmarks_changed) (GtkFileSystem *file_system);
Owen Taylor's avatar
Owen Taylor committed
194 195 196 197
};

GType             gtk_file_system_get_type       (void);

198 199 200 201 202
GSList *          gtk_file_system_list_roots     (GtkFileSystem     *file_system);
GtkFileInfo *     gtk_file_system_get_root_info  (GtkFileSystem     *file_system,
						  const GtkFilePath *path,
						  GtkFileInfoType    types,
						  GError           **error);
203

204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
gboolean          gtk_file_system_get_parent     (GtkFileSystem     *file_system,
						  const GtkFilePath *path,
						  GtkFilePath      **parent,
						  GError           **error);
GtkFileFolder    *gtk_file_system_get_folder     (GtkFileSystem     *file_system,
						  const GtkFilePath *path,
						  GtkFileInfoType    types,
						  GError           **error);
gboolean          gtk_file_system_create_folder  (GtkFileSystem     *file_system,
						  const GtkFilePath *path,
						  GError           **error);
GtkFilePath *     gtk_file_system_make_path      (GtkFileSystem     *file_system,
						  const GtkFilePath *base_path,
						  const gchar       *display_name,
						  GError           **error);
gboolean          gtk_file_system_parse          (GtkFileSystem     *file_system,
						  const GtkFilePath *base_path,
						  const gchar       *str,
						  GtkFilePath      **folder,
						  gchar            **file_part,
						  GError           **error);

gchar *      gtk_file_system_path_to_uri      (GtkFileSystem     *file_system,
					       const GtkFilePath *path);
gchar *      gtk_file_system_path_to_filename (GtkFileSystem     *file_system,
					       const GtkFilePath *path);
GtkFilePath *gtk_file_system_uri_to_path      (GtkFileSystem     *file_system,
					       const gchar       *uri);
GtkFilePath *gtk_file_system_filename_to_path (GtkFileSystem     *file_system,
					       const gchar       *filename);

235 236 237 238 239 240 241
gboolean gtk_file_system_add_bookmark    (GtkFileSystem     *file_system,
					  const GtkFilePath *path,
					  GError           **error);
gboolean gtk_file_system_remove_bookmark (GtkFileSystem     *file_system,
					  const GtkFilePath *path,
					  GError           **error);
GSList  *gtk_file_system_list_bookmarks  (GtkFileSystem     *file_system);
242 243


Owen Taylor's avatar
Owen Taylor committed
244 245 246 247 248 249 250 251 252 253 254 255 256 257
/*
 * Detailed information about a particular folder
 */
#define GTK_TYPE_FILE_FOLDER             (gtk_file_folder_get_type ())
#define GTK_FILE_FOLDER(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_FILE_FOLDER, GtkFileFolder))
#define GTK_IS_FILE_FOLDER(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_FILE_FOLDER))
#define GTK_FILE_FOLDER_GET_IFACE(inst)  (G_TYPE_INSTANCE_GET_INTERFACE ((inst), GTK_TYPE_FILE_FOLDER, GtkFileFolderIface))

struct _GtkFileFolderIface
{
  GTypeInterface base_iface;

  /* Methods
   */
258 259 260 261 262 263
  GtkFileInfo *      (*get_info)       (GtkFileFolder     *folder,
					const GtkFilePath *path,
				        GError           **error);
  gboolean           (*list_children)  (GtkFileFolder     *folder,
				        GSList           **children,
				        GError           **error);
Owen Taylor's avatar
Owen Taylor committed
264 265 266 267 268

  /* ??? refresh() ??? */

  /* Signals
   */
269
  void (*deleted)       (GtkFileFolder *monitor);
Owen Taylor's avatar
Owen Taylor committed
270
  void (*files_added)   (GtkFileFolder *monitor,
271
			 GSList        *paths);
272
  void (*files_changed) (GtkFileFolder *monitor,
273
			 GSList        *paths);
274
  void (*files_removed) (GtkFileFolder *monitor,
275
			 GSList        *paths);
Owen Taylor's avatar
Owen Taylor committed
276 277 278
};

GType        gtk_file_folder_get_type      (void);
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
gboolean     gtk_file_folder_list_children (GtkFileFolder      *folder,
					    GSList            **children,
					    GError            **error);
GtkFileInfo *gtk_file_folder_get_info      (GtkFileFolder      *folder,
					    const GtkFilePath  *path,
					    GError            **error);

#ifdef __GNUC__
#define gtk_file_path_new_dup(str) \
 ({ const gchar *__s = (str); (GtkFilePath *)g_strdup(__s); })
#define gtk_file_path_new_steal(str) \
 ({ gchar *__s = (str); (GtkFilePath *)__s; })
#define gtk_file_path_get_string(path) \
 ({ const GtkFilePath *__p = (path); (const gchar *)__p; })
#define gtk_file_path_free(path) \
 ({ GtkFilePath *__p = (path); g_free (__p); })
#else /* __GNUC__ */
#define gtk_file_path_new_dup(str)     ((GtkFilePath *)g_strdup(str))
#define gtk_file_path_new_steal(str)   ((GtkFilePath *)(str))
298
#define gtk_file_path_get_string(str) ((const gchar *)(str))
299 300 301 302 303 304 305 306
#define gtk_file_path_free(path)       g_free (path)
#endif/* __GNUC__ */

#define gtk_file_path_copy(path)       gtk_file_path_new_dup (gtk_file_path_get_string(path))
#define gtk_file_path_compare(path1,path2) strcmp (gtk_file_path_get_string (path1), \
						   gtk_file_path_get_string (path2))

GSList *gtk_file_paths_sort (GSList *paths);
307
GSList *gtk_file_paths_copy (GSList *paths);
308
void    gtk_file_paths_free (GSList *paths);
Owen Taylor's avatar
Owen Taylor committed
309 310 311 312

G_END_DECLS

#endif /* __GTK_FILE_SYSTEM_H__ */