summaryrefslogtreecommitdiff
path: root/src/gsystem-file-utils.h
blob: 32fa0cc79496a966982a1b8edecab22ea02f1700 (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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*-
 *
 * Copyright (C) 2012 Colin Walters <walters@verbum.org>.
 *
 * 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 __GSYSTEM_FILE_UTILS_H__
#define __GSYSTEM_FILE_UTILS_H__

#include <gio/gio.h>
#include <sys/stat.h>

G_BEGIN_DECLS

const char *gs_file_get_path_cached (GFile *file);

const char *gs_file_get_basename_cached (GFile *file);

struct GSDirFdIterator {
  gboolean initialized;
  int fd;
  gpointer padding_data[4];
};

typedef struct GSDirFdIterator GSDirFdIterator;
gboolean gs_dirfd_iterator_init_at (int dfd, const char *path,
                                    gboolean follow,
                                    GSDirFdIterator *dfd_iter, GError **error);
gboolean gs_dirfd_iterator_init_take_fd (int dfd, GSDirFdIterator *dfd_iter, GError **error);
#ifndef __GI_SCANNER__
gboolean gs_dirfd_iterator_next_dent (GSDirFdIterator  *dfd_iter,
                                      struct dirent   **out_dent,
                                      GCancellable     *cancellable,
                                      GError          **error);
#endif
void gs_dirfd_iterator_clear (GSDirFdIterator *dfd_iter);

#define gs_dirfd_iterator_cleanup __attribute__((cleanup(gs_dirfd_iterator_clear)))


gboolean gs_file_enumerator_iterate (GFileEnumerator  *direnum,
                                     GFileInfo       **out_info,
                                     GFile           **out_child,
                                     GCancellable     *cancellable,
                                     GError          **error);

gboolean gs_file_openat_noatime (int            dfd,
                                 const char    *name,
                                 int           *ret_fd,
                                 GCancellable  *cancellable,
                                 GError       **error);

GInputStream *gs_file_read_noatime (GFile         *file,
                                    GCancellable  *cancellable,
                                    GError       **error);
GMappedFile *gs_file_map_noatime (GFile         *file,
                                  GCancellable  *cancellable,
                                  GError       **error);

#ifndef __GI_SCANNER__
gboolean gs_stream_fstat (GFileDescriptorBased *stream,
                          struct stat          *out_stbuf,
                          GCancellable         *cancellable,
                          GError              **error);

#endif

#if GLIB_CHECK_VERSION(2,34,0)
GBytes *gs_file_map_readonly (GFile         *file,
                              GCancellable  *cancellable,
                              GError       **error);
#endif

gboolean gs_file_sync_data (GFile          *file,
                            GCancellable   *cancellable,
                            GError        **error);

char * gs_fileutil_gen_tmp_name (const char *prefix,
                                 const char *suffix);

gboolean gs_file_open_dir_fd (GFile         *path,
                              int           *out_fd,
                              GCancellable  *cancellable,
                              GError       **error);

gboolean gs_file_open_dir_fd_at (int            parent_dfd,
                                 const char    *name,
                                 int           *out_fd,
                                 GCancellable  *cancellable,
                                 GError       **error);

int gs_opendirat_with_errno (int           dfd,
                             const char   *path,
                             gboolean      follow);
gboolean gs_opendirat (int             dfd,
                       const char     *path,
                       gboolean        follow,
                       int            *out_fd,
                       GError        **error);


gboolean gs_file_open_in_tmpdir_at (int                tmpdir_fd,
                                    int                mode,
                                    char             **out_name,
                                    GOutputStream    **out_stream,
                                    GCancellable      *cancellable,
                                    GError           **error);

gboolean gs_file_open_in_tmpdir (GFile             *tmpdir,
                                 int                mode,
                                 GFile            **out_file,
                                 GOutputStream    **out_stream,
                                 GCancellable      *cancellable,
                                 GError           **error);

gboolean gs_file_create (GFile          *file,
                         int             mode,
                         GOutputStream **out_stream,
                         GCancellable   *cancellable,
                         GError        **error);

gboolean gs_file_linkcopy (GFile          *src,
                           GFile          *dest,
                           GFileCopyFlags  flags,
                           GCancellable   *cancellable,
                           GError        **error);

gboolean gs_file_linkcopy_sync_data (GFile          *src,
                                     GFile          *dest,
                                     GFileCopyFlags  flags,
                                     GCancellable   *cancellable,
                                     GError        **error);

gboolean gs_file_rename (GFile          *from,
                         GFile          *to,
                         GCancellable   *cancellable,
                         GError        **error);

gboolean gs_file_unlink (GFile          *path,
                         GCancellable   *cancellable,
                         GError        **error);

gboolean gs_file_chown (GFile          *path,
                        guint32         owner,
                        guint32         group,
                        GCancellable   *cancellable,
                        GError        **error);

gboolean gs_file_lchown (GFile          *path,
                         guint32         owner,
                         guint32         group,
                         GCancellable   *cancellable,
                         GError        **error);

gboolean gs_file_chmod (GFile          *path,
                        guint           mode,
                        GCancellable   *cancellable,
                        GError        **error);

gboolean gs_file_ensure_directory (GFile          *dir,
                                   gboolean        with_parents,
                                   GCancellable   *cancellable,
                                   GError        **error);

gboolean gs_file_ensure_directory_mode (GFile          *dir,
                                        guint           mode,
                                        GCancellable   *cancellable,
                                        GError        **error);

gchar *gs_file_load_contents_utf8 (GFile         *file,
                                   GCancellable  *cancellable,
                                   GError       **error);

gchar *gs_file_get_relpath (GFile *one,
                            GFile *two);

GFile * gs_file_realpath (GFile *file);

gboolean gs_file_get_all_xattrs (GFile         *f,
                                 GVariant     **out_xattrs,
                                 GCancellable  *cancellable,
                                 GError       **error);

gboolean gs_dfd_and_name_get_all_xattrs (int            dfd,
                                         const char    *name,
                                         GVariant     **out_xattrs,
                                         GCancellable  *cancellable,
                                         GError       **error);

gboolean gs_fd_set_all_xattrs (int            fd,
                               GVariant      *xattrs,
                               GCancellable  *cancellable,
                               GError       **error);

gboolean gs_dfd_and_name_set_all_xattrs (int            dfd,
                                         const char    *name,
                                         GVariant      *xattrs,
                                         GCancellable  *cancellable,
                                         GError       **error);

gboolean gs_file_set_all_xattrs (GFile         *file,
                                 GVariant      *xattrs,
                                 GCancellable  *cancellable,
                                 GError       **error);


G_END_DECLS

#endif