summaryrefslogtreecommitdiff
path: root/libnautilus-extensions/nautilus-directory-private.h
blob: 7c2f4d351fe55fa440c85424ceaf5b352df6d672 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*-

   nautilus-directory.c: Nautilus directory model.
 
   Copyright (C) 1999, 2000 Eazel, Inc.
  
   This program is free software; you can redistribute it and/or
   modify it under the terms of the GNU General Public License as
   published by the Free Software Foundation; either version 2 of the
   License, or (at your option) any later version.
  
   This program 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
   General Public License for more details.
  
   You should have received a copy of the GNU General Public
   License along with this program; if not, write to the
   Free Software Foundation, Inc., 59 Temple Place - Suite 330,
   Boston, MA 02111-1307, USA.
  
   Author: Darin Adler <darin@eazel.com>
*/

#include "nautilus-directory.h"

#include <libgnomevfs/gnome-vfs-types.h>
#include <libgnomevfs/gnome-vfs-uri.h>
#include <libgnomevfs/gnome-vfs-file-info.h>

#include <tree.h>

#include "nautilus-file.h"

#define METADATA_NODE_NAME_FOR_FILE_NAME "NAME"

typedef struct MetafileReadState MetafileReadState;
typedef struct MetafileWriteState MetafileWriteState;
typedef struct TopLeftTextReadState TopLeftTextReadState;

struct NautilusDirectoryDetails
{
	char *uri_text;
	GnomeVFSURI *uri;
	GnomeVFSURI *metafile_uri;
	GnomeVFSURI *alternate_metafile_uri;

	GList *files;

	xmlDoc *metafile;

	gboolean metafile_read;
	gboolean use_alternate_metafile;
	MetafileReadState *metafile_read_state;

	guint write_metafile_idle_id;
	MetafileWriteState *metafile_write_state;

	/* These lists are going to be pretty short.  If we think they
	 * are going to get big, we can use hash tables instead.
	 */
	GList *call_when_ready_list;
	GList *monitor_list;

	gboolean file_list_monitored;
	gboolean directory_loaded;
	GnomeVFSAsyncHandle *directory_load_in_progress;
	GnomeVFSDirectoryListPosition directory_load_list_last_handled;

	GList *pending_file_info; /* list of GnomeVFSFileInfo's that are pending */
        guint dequeue_pending_idle_id;

	GList *get_file_infos_in_progress; /* list of GnomeVFSAsyncHandle* */

	GnomeVFSAsyncHandle *count_in_progress;
	NautilusFile *count_file;

	TopLeftTextReadState *top_left_read_state;
};

typedef struct {
	char *from_uri;
	char *to_uri;
} URIPair;

/* Almost-public change notification calls */
void          nautilus_directory_notify_files_added        (GList                     *uris);
void          nautilus_directory_notify_files_moved        (GList                     *uri_pairs);
void          nautilus_directory_notify_files_removed      (GList                     *uris);

/* async. interface */
void          nautilus_directory_call_when_ready_internal  (NautilusDirectory         *directory,
							    NautilusFile              *file,
							    GList                     *directory_metadata_keys,
							    GList                     *file_attributes,
							    GList                     *file_metadata_keys,
							    NautilusDirectoryCallback  directory_callback,
							    NautilusFileCallback       file_callback,
							    gpointer                   callback_data);
void          nautilus_directory_cancel_callback_internal  (NautilusDirectory         *directory,
							    NautilusFile              *file,
							    NautilusDirectoryCallback  directory_callback,
							    NautilusFileCallback       file_callback,
							    gpointer                   callback_data);
void          nautilus_directory_monitor_add_internal      (NautilusDirectory         *directory,
							    NautilusFile              *file,
							    gconstpointer              client,
							    GList                     *directory_metadata_keys,
							    GList                     *attributes,
							    GList                     *metadata_keys,
							    NautilusDirectoryCallback  callback,
							    gpointer                   callback_data);
void          nautilus_directory_monitor_remove_internal   (NautilusDirectory         *directory,
							    NautilusFile              *file,
							    gconstpointer              client);
void          nautilus_directory_get_info_for_new_files    (NautilusDirectory         *directory,
							    GList                     *vfs_uris);
gboolean      nautilus_directory_is_file_list_monitored    (NautilusDirectory         *directory);
void          nautilus_directory_remove_file_monitor_link  (NautilusDirectory         *directory,
							    GList                     *link);
void          nautilus_directory_request_read_metafile     (NautilusDirectory         *directory);
void          nautilus_directory_request_write_metafile    (NautilusDirectory         *directory);
void          nautilus_directory_schedule_dequeue_pending  (NautilusDirectory         *directory);
void          nautilus_directory_stop_monitoring_file_list (NautilusDirectory         *directory);
void          nautilus_metafile_read_cancel                (NautilusDirectory         *directory);
void          nautilus_metafile_write_start                (NautilusDirectory         *directory);
void          nautilus_async_destroying_file               (NautilusFile              *file);

/* Calls shared between directory, file, and async. code. */
NautilusFile *nautilus_directory_find_file                 (NautilusDirectory         *directory,
							    const char                *file_name);
char *        nautilus_directory_get_file_metadata         (NautilusDirectory         *directory,
							    const char                *file_name,
							    const char                *key,
							    const char                *default_metadata);
GList *       nautilus_directory_get_file_metadata_list    (NautilusDirectory         *directory,
							    const char                *file_name,
							    const char                *list_key,
							    const char                *list_subkey,
							    GList                     *default_metadata_list);

gboolean      nautilus_directory_set_file_metadata         (NautilusDirectory         *directory,
							    const char                *file_name,
							    const char                *key,
							    const char                *default_metadata,
							    const char                *metadata);
xmlNode *     nautilus_directory_get_file_metadata_node    (NautilusDirectory         *directory,
							    const char                *file_name,
							    gboolean                   create);
void          nautilus_directory_emit_metadata_changed     (NautilusDirectory         *directory);
void          nautilus_directory_emit_files_added          (NautilusDirectory         *directory,
							    GList                     *added_files);
void          nautilus_directory_emit_files_changed        (NautilusDirectory         *directory,
							    GList                     *changed_files);

/* debugging functions */
int           nautilus_directory_number_outstanding        (void);

/* Shared functions not directly related to NautilusDirectory/File. */
int           nautilus_compare_file_with_name              (gconstpointer              a,
							    gconstpointer              b);