VirtualBox

source: vbox/trunk/include/iprt/dir.h@ 29276

Last change on this file since 29276 was 28800, checked in by vboxsync, 15 years ago

Automated rebranding to Oracle copyright/license strings via filemuncher

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 14.6 KB
Line 
1/** @file
2 * IPRT - Directory Manipulation.
3 */
4
5/*
6 * Copyright (C) 2006-2007 Oracle Corporation
7 *
8 * This file is part of VirtualBox Open Source Edition (OSE), as
9 * available from http://www.virtualbox.org. This file is free software;
10 * you can redistribute it and/or modify it under the terms of the GNU
11 * General Public License (GPL) as published by the Free Software
12 * Foundation, in version 2 as it comes in the "COPYING" file of the
13 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15 *
16 * The contents of this file may alternatively be used under the terms
17 * of the Common Development and Distribution License Version 1.0
18 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19 * VirtualBox OSE distribution, in which case the provisions of the
20 * CDDL are applicable instead of those of the GPL.
21 *
22 * You may elect to license modified versions of this file under the
23 * terms and conditions of either the GPL or the CDDL or both.
24 */
25
26#ifndef ___iprt_dir_h
27#define ___iprt_dir_h
28
29#include <iprt/cdefs.h>
30#include <iprt/types.h>
31#ifdef IN_RING3
32# include <iprt/fs.h>
33#endif
34
35
36RT_C_DECLS_BEGIN
37
38/** @defgroup grp_rt_dir RTDir - Directory Manipulation
39 * @ingroup grp_rt
40 * @{
41 */
42
43#ifdef IN_RING3
44
45/**
46 * Check for the existence of a directory.
47 *
48 * All symbolic links will be attemped resolved. If that is undesirable, please
49 * use RTPathQueryInfo instead.
50 *
51 * @returns true if exist and is a directory.
52 * @returns false if not exists or isn't a directory.
53 * @param pszPath Path to the directory.
54 */
55RTDECL(bool) RTDirExists(const char *pszPath);
56
57/**
58 * Creates a directory.
59 *
60 * @returns iprt status code.
61 * @param pszPath Path to the directory to create.
62 * @param fMode The mode of the new directory.
63 */
64RTDECL(int) RTDirCreate(const char *pszPath, RTFMODE fMode);
65
66/**
67 * Creates a directory including all parent directories in the path
68 * if they don't exist.
69 *
70 * @returns iprt status code.
71 * @param pszPath Path to the directory to create.
72 * @param fMode The mode of the new directories.
73 */
74RTDECL(int) RTDirCreateFullPath(const char *pszPath, RTFMODE fMode);
75
76/**
77 * Creates a new directory with a unique name using the given template.
78 *
79 * One or more trailing X'es in the template will be replaced by random alpha
80 * numeric characters until a RTDirCreate succeeds or we run out of patience.
81 * For instance:
82 * "/tmp/myprog-XXXXXX"
83 *
84 * As an alternative to trailing X'es, it
85 * is possible to put 3 or more X'es somewhere inside the directory name. In
86 * the following string only the last bunch of X'es will be modified:
87 * "/tmp/myprog-XXX-XXX.tmp"
88 *
89 * The directory is created with mode 0700.
90 *
91 * @returns iprt status code.
92 * @param pszTemplate The directory name template on input. The actual
93 * directory name on success. Empty string on failure.
94 */
95RTDECL(int) RTDirCreateTemp(char *pszTemplate);
96
97/**
98 * Removes a directory if empty.
99 *
100 * @returns iprt status code.
101 * @param pszPath Path to the directory to remove.
102 */
103RTDECL(int) RTDirRemove(const char *pszPath);
104
105/**
106 * Removes a directory tree recursively.
107 *
108 * @returns iprt status code.
109 * @param pszPath Path to the directory to remove recursively.
110 * @param fFlags Flags, see RTDIRRMREC_F_XXX.
111 *
112 * @remarks This will not work on a root directory.
113 */
114RTDECL(int) RTDirRemoveRecursive(const char *pszPath, uint32_t fFlags);
115
116/** @name RTDirRemoveRecursive flags.
117 * @{ */
118/** Only delete the content of the directory, omit the directory it self. */
119#define RTDIRRMREC_F_CONTENT_ONLY RT_BIT_32(0)
120/** Mask of valid flags. */
121#define RTDIRRMREC_F_VALID_MASK UINT32_C(0x00000001)
122/** @} */
123
124/**
125 * Flushes the specified directory.
126 *
127 * This API is not implemented on all systems. On some systems it may be
128 * unnecessary if you've already flushed the file. If you really care for your
129 * data and is entering dangerous territories, it doesn't hurt calling it after
130 * flushing and closing the file.
131 *
132 * @returns IPRT status code.
133 * @retval VERR_NOT_IMPLEMENTED must be expected.
134 * @retval VERR_NOT_SUPPORTED must be expected.
135 * @param pszPath Path to the directory.
136 */
137RTDECL(int) RTDirFlush(const char *pszPath);
138
139/**
140 * Flushes the parent directory of the specified file.
141 *
142 * This is just a wrapper around RTDirFlush.
143 *
144 * @returns IPRT status code, see RTDirFlush for details.
145 * @param pszChild Path to the file which parent should be flushed.
146 */
147RTDECL(int) RTDirFlushParent(const char *pszChild);
148
149
150/** Pointer to an open directory (sort of handle). */
151typedef struct RTDIR *PRTDIR;
152
153
154/**
155 * Filter option for RTDirOpenFiltered().
156 */
157typedef enum RTDIRFILTER
158{
159 /** The usual invalid 0 entry. */
160 RTDIRFILTER_INVALID = 0,
161 /** No filter should be applied (and none was specified). */
162 RTDIRFILTER_NONE,
163 /** The Windows NT filter.
164 * The following wildcard chars: *, ?, <, > and "
165 * The matching is done on the uppercased strings. */
166 RTDIRFILTER_WINNT,
167 /** The UNIX filter.
168 * The following wildcard chars: *, ?, [..]
169 * The matching is done on exact case. */
170 RTDIRFILTER_UNIX,
171 /** The UNIX filter, uppercased matching.
172 * Same as RTDIRFILTER_UNIX except that the strings are uppercased before comparing. */
173 RTDIRFILTER_UNIX_UPCASED,
174
175 /** The usual full 32-bit value. */
176 RTDIRFILTER_32BIT_HACK = 0x7fffffff
177} RTDIRFILTER;
178
179
180/**
181 * Directory entry type.
182 *
183 * This is the RTFS_TYPE_MASK stuff shifted down 12 bits and
184 * identical to the BSD/LINUX ABI.
185 */
186typedef enum RTDIRENTRYTYPE
187{
188 /** Unknown type (DT_UNKNOWN). */
189 RTDIRENTRYTYPE_UNKNOWN = 0,
190 /** Named pipe (fifo) (DT_FIFO). */
191 RTDIRENTRYTYPE_FIFO = 001,
192 /** Character device (DT_CHR). */
193 RTDIRENTRYTYPE_DEV_CHAR = 002,
194 /** Directory (DT_DIR). */
195 RTDIRENTRYTYPE_DIRECTORY = 004,
196 /** Block device (DT_BLK). */
197 RTDIRENTRYTYPE_DEV_BLOCK = 006,
198 /** Regular file (DT_REG). */
199 RTDIRENTRYTYPE_FILE = 010,
200 /** Symbolic link (DT_LNK). */
201 RTDIRENTRYTYPE_SYMLINK = 012,
202 /** Socket (DT_SOCK). */
203 RTDIRENTRYTYPE_SOCKET = 014,
204 /** Whiteout (DT_WHT). */
205 RTDIRENTRYTYPE_WHITEOUT = 016
206} RTDIRENTRYTYPE;
207
208
209/**
210 * Directory entry.
211 *
212 * This is inspired by the POSIX interfaces.
213 */
214#pragma pack(1)
215typedef struct RTDIRENTRY
216{
217 /** The unique identifier (within the file system) of this file system object (d_ino).
218 *
219 * Together with INodeIdDevice, this field can be used as a OS wide unique id
220 * when both their values are not 0. This field is 0 if the information is not
221 * available. */
222 RTINODE INodeId;
223 /** The entry type. (d_type)
224 * RTDIRENTRYTYPE_UNKNOWN is a common return value here since not all file
225 * systems (or Unixes) stores the type of a directory entry and instead
226 * expects the user to use stat() to get it. So, when you see this you
227 * should use RTPathQueryInfo to get the type, or if if you're lazy, use
228 * RTDirReadEx. */
229 RTDIRENTRYTYPE enmType;
230 /** The length of the filename, excluding the terminating nul character. */
231 uint16_t cbName;
232 /** The filename. (no path)
233 * Using the pcbDirEntry parameter of RTDirRead makes this field variable in size. */
234 char szName[260];
235} RTDIRENTRY;
236#pragma pack()
237/** Pointer to a directory entry. */
238typedef RTDIRENTRY *PRTDIRENTRY;
239
240
241/**
242 * Directory entry with extended information.
243 *
244 * This is inspired by the PC interfaces.
245 */
246#pragma pack(1)
247typedef struct RTDIRENTRYEX
248{
249 /** Full information about the object. */
250 RTFSOBJINFO Info;
251 /** The length of the short field (number of RTUTF16 entries (not chars)).
252 * It is 16-bit for reasons of alignment. */
253 uint16_t cwcShortName;
254 /** The short name for 8.3 compatability.
255 * Empty string if not available.
256 * Since the length is a bit tricky for a UTF-8 encoded name, and since this
257 * is practically speaking only a windows thing, it is encoded as UCS-2. */
258 RTUTF16 wszShortName[14];
259 /** The length of the filename. */
260 uint16_t cbName;
261 /** The filename. (no path)
262 * Using the pcbDirEntry parameter of RTDirReadEx makes this field variable in size. */
263 char szName[260];
264} RTDIRENTRYEX;
265#pragma pack()
266/** Pointer to a directory entry. */
267typedef RTDIRENTRYEX *PRTDIRENTRYEX;
268
269
270/**
271 * Opens a directory.
272 *
273 * @returns iprt status code.
274 * @param ppDir Where to store the open directory pointer.
275 * @param pszPath Path to the directory to open.
276 */
277RTDECL(int) RTDirOpen(PRTDIR *ppDir, const char *pszPath);
278
279/**
280 * Opens a directory filtering the entries using dos style wildcards.
281 *
282 * @returns iprt status code.
283 * @param ppDir Where to store the open directory pointer.
284 * @param pszPath Path to the directory to search, this must include wildcards.
285 * @param enmFilter The kind of filter to apply. Setting this to RTDIRFILTER_NONE makes
286 * this function behave like RTDirOpen.
287 */
288RTDECL(int) RTDirOpenFiltered(PRTDIR *ppDir, const char *pszPath, RTDIRFILTER enmFilter);
289
290/**
291 * Closes a directory.
292 *
293 * @returns iprt status code.
294 * @param pDir Pointer to open directory returned by RTDirOpen() or RTDirOpenFiltered().
295 */
296RTDECL(int) RTDirClose(PRTDIR pDir);
297
298/**
299 * Reads the next entry in the directory.
300 *
301 * @returns VINF_SUCCESS and data in pDirEntry on success.
302 * @returns VERR_NO_MORE_FILES when the end of the directory has been reached.
303 * @returns VERR_BUFFER_OVERFLOW if the buffer is too small to contain the filename. If
304 * pcbDirEntry is specified it will be updated with the required buffer size.
305 * @returns suitable iprt status code on other errors.
306 *
307 * @param pDir Pointer to the open directory.
308 * @param pDirEntry Where to store the information about the next
309 * directory entry on success.
310 * @param pcbDirEntry Optional parameter used for variable buffer size.
311 *
312 * On input the variable pointed to contains the size of the pDirEntry
313 * structure. This must be at least OFFSET(RTDIRENTRY, szName[2]) bytes.
314 *
315 * On successful output the field is updated to
316 * OFFSET(RTDIRENTRY, szName[pDirEntry->cbName + 1]).
317 *
318 * When the data doesn't fit in the buffer and VERR_BUFFER_OVERFLOW is
319 * returned, this field contains the required buffer size.
320 *
321 * The value is unchanged in all other cases.
322 */
323RTDECL(int) RTDirRead(PRTDIR pDir, PRTDIRENTRY pDirEntry, size_t *pcbDirEntry);
324
325/**
326 * Reads the next entry in the directory returning extended information.
327 *
328 * @returns VINF_SUCCESS and data in pDirEntry on success.
329 * @returns VERR_NO_MORE_FILES when the end of the directory has been reached.
330 * @returns VERR_BUFFER_OVERFLOW if the buffer is too small to contain the filename. If
331 * pcbDirEntry is specified it will be updated with the required buffer size.
332 * @returns suitable iprt status code on other errors.
333 *
334 * @param pDir Pointer to the open directory.
335 * @param pDirEntry Where to store the information about the next
336 * directory entry on success.
337 * @param pcbDirEntry Optional parameter used for variable buffer size.
338 *
339 * On input the variable pointed to contains the size of the pDirEntry
340 * structure. This must be at least OFFSET(RTDIRENTRYEX, szName[2]) bytes.
341 *
342 * On successful output the field is updated to
343 * OFFSET(RTDIRENTRYEX, szName[pDirEntry->cbName + 1]).
344 *
345 * When the data doesn't fit in the buffer and VERR_BUFFER_OVERFLOW is
346 * returned, this field contains the required buffer size.
347 *
348 * The value is unchanged in all other cases.
349 * @param enmAdditionalAttribs
350 * Which set of additional attributes to request.
351 * Use RTFSOBJATTRADD_NOTHING if this doesn't matter.
352 * @param fFlags RTPATH_F_ON_LINK or RTPATH_F_FOLLOW_LINK.
353 */
354RTDECL(int) RTDirReadEx(PRTDIR pDir, PRTDIRENTRYEX pDirEntry, size_t *pcbDirEntry, RTFSOBJATTRADD enmAdditionalAttribs, uint32_t fFlags);
355
356
357/**
358 * Renames a file.
359 *
360 * Identical to RTPathRename except that it will ensure that the source is a directory.
361 *
362 * @returns IPRT status code.
363 * @returns VERR_ALREADY_EXISTS if the destination file exists.
364 *
365 * @param pszSrc The path to the source file.
366 * @param pszDst The path to the destination file.
367 * This file will be created.
368 * @param fRename See RTPathRename.
369 */
370RTDECL(int) RTDirRename(const char *pszSrc, const char *pszDst, unsigned fRename);
371
372
373/**
374 * Query information about an open directory.
375 *
376 * @returns iprt status code.
377 *
378 * @param pDir Pointer to the open directory.
379 * @param pObjInfo Object information structure to be filled on successful return.
380 * @param enmAdditionalAttribs Which set of additional attributes to request.
381 * Use RTFSOBJATTRADD_NOTHING if this doesn't matter.
382 */
383RTR3DECL(int) RTDirQueryInfo(PRTDIR pDir, PRTFSOBJINFO pObjInfo, RTFSOBJATTRADD enmAdditionalAttribs);
384
385
386/**
387 * Changes one or more of the timestamps associated of file system object.
388 *
389 * @returns iprt status code.
390 * @returns VERR_NOT_SUPPORTED is returned if the operation isn't supported by the OS.
391 *
392 * @param pDir Pointer to the open directory.
393 * @param pAccessTime Pointer to the new access time. NULL if not to be changed.
394 * @param pModificationTime Pointer to the new modifcation time. NULL if not to be changed.
395 * @param pChangeTime Pointer to the new change time. NULL if not to be changed.
396 * @param pBirthTime Pointer to the new time of birth. NULL if not to be changed.
397 *
398 * @remark The file system might not implement all these time attributes,
399 * the API will ignore the ones which aren't supported.
400 *
401 * @remark The file system might not implement the time resolution
402 * employed by this interface, the time will be chopped to fit.
403 *
404 * @remark The file system may update the change time even if it's
405 * not specified.
406 *
407 * @remark POSIX can only set Access & Modification and will always set both.
408 */
409RTR3DECL(int) RTDirSetTimes(PRTDIR pDir, PCRTTIMESPEC pAccessTime, PCRTTIMESPEC pModificationTime,
410 PCRTTIMESPEC pChangeTime, PCRTTIMESPEC pBirthTime);
411
412#endif /* IN_RING3 */
413/** @} */
414
415RT_C_DECLS_END
416
417#endif
418
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette