dir.h@ 69844

Last change on this file since 69844 was 69761, checked in by vboxsync, 7 years ago
iprt/dir.h,iprt/types.h: Moved the RTDIR type to types.h
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 32.5 KB

Line
1	/** @file
2	* IPRT - Directory Manipulation.
3	*/
4
5	/*
6	* Copyright (C) 2006-2017 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	#include <iprt/fs.h>
32	#include <iprt/symlink.h>
33
34
35	RT_C_DECLS_BEGIN
36
37	/** @defgroup grp_rt_dir RTDir - Directory Manipulation
38	* @ingroup grp_rt
39	* @{
40	*/
41
42	/**
43	* Check for the existence of a directory.
44	*
45	* All symbolic links will be attemped resolved. If that is undesirable, please
46	* use RTPathQueryInfo instead.
47	*
48	* @returns true if exist and is a directory.
49	* @returns false if not exists or isn't a directory.
50	* @param pszPath Path to the directory.
51	*/
52	RTDECL(bool) RTDirExists(const char *pszPath);
53
54	/** @name RTDirCreate flags.
55	* @{ */
56	/** Don't allow symbolic links as part of the path.
57	* @remarks this flag is currently not implemented and will be ignored. */
58	#define RTDIRCREATE_FLAGS_NO_SYMLINKS RT_BIT(0)
59	/** Set the not-content-indexed flag (default). Windows only atm. */
60	#define RTDIRCREATE_FLAGS_NOT_CONTENT_INDEXED_DONT_SET RT_BIT(1)
61	/** Do not set the not-content-indexed flag. Windows only atm. */
62	#define RTDIRCREATE_FLAGS_NOT_CONTENT_INDEXED_SET UINT32_C(0)
63	/** Ignore errors setting the not-content-indexed flag. Windows only atm. */
64	#define RTDIRCREATE_FLAGS_NOT_CONTENT_INDEXED_NOT_CRITICAL RT_BIT(2)
65	/** Valid mask. */
66	#define RTDIRCREATE_FLAGS_VALID_MASK UINT32_C(0x00000007)
67	/** @} */
68
69	/**
70	* Creates a directory.
71	*
72	* @returns iprt status code.
73	* @param pszPath Path to the directory to create.
74	* @param fMode The mode of the new directory.
75	* @param fCreate Create flags, RTDIRCREATE_FLAGS_*.
76	*/
77	RTDECL(int) RTDirCreate(const char *pszPath, RTFMODE fMode, uint32_t fCreate);
78
79	/**
80	* Creates a directory including all parent directories in the path
81	* if they don't exist.
82	*
83	* @returns iprt status code.
84	* @param pszPath Path to the directory to create.
85	* @param fMode The mode of the new directories.
86	*/
87	RTDECL(int) RTDirCreateFullPath(const char *pszPath, RTFMODE fMode);
88
89	/**
90	* Creates a new directory with a unique name using the given template.
91	*
92	* One or more trailing X'es in the template will be replaced by random alpha
93	* numeric characters until a RTDirCreate succeeds or we run out of patience.
94	* For instance:
95	* "/tmp/myprog-XXXXXX"
96	*
97	* As an alternative to trailing X'es, it
98	* is possible to put 3 or more X'es somewhere inside the directory name. In
99	* the following string only the last bunch of X'es will be modified:
100	* "/tmp/myprog-XXX-XXX.tmp"
101	*
102	* @returns iprt status code.
103	* @param pszTemplate The directory name template on input. The actual
104	* directory name on success. Empty string on failure.
105	* @param fMode The mode to create the directory with. Use 0700
106	* unless you have reason not to.
107	*/
108	RTDECL(int) RTDirCreateTemp(char *pszTemplate, RTFMODE fMode);
109
110	/**
111	* Secure version of @a RTDirCreateTemp with a fixed mode of 0700.
112	*
113	* This function behaves in the same way as @a RTDirCreateTemp with two
114	* additional points. Firstly the mode is fixed to 0700. Secondly it will
115	* fail if it is not possible to perform the operation securely. Possible
116	* reasons include that the directory could be removed by another unprivileged
117	* user before it is used (e.g. if is created in a non-sticky /tmp directory)
118	* or that the path contains symbolic links which another unprivileged user
119	* could manipulate; however the exact criteria will be specified on a
120	* platform-by-platform basis as platform support is added.
121	* @see RTPathIsSecure for the current list of criteria.
122	* @returns iprt status code.
123	* @returns VERR_NOT_SUPPORTED if the interface can not be supported on the
124	* current platform at this time.
125	* @returns VERR_INSECURE if the directory could not be created securely.
126	* @param pszTemplate The directory name template on input. The
127	* actual directory name on success. Empty string
128	* on failure.
129	*/
130	RTDECL(int) RTDirCreateTempSecure(char *pszTemplate);
131
132	/**
133	* Creates a new directory with a unique name by appending a number.
134	*
135	* This API differs from RTDirCreateTemp & RTDirCreateTempSecure in that it
136	* first tries to create the directory without any random bits, thus the best
137	* case result will be prettier. It also differs in that it does not take a
138	* template, but is instead given a template description, and will only use
139	* digits for the filling.
140	*
141	* For sake of convenience and debugging , the current implementation
142	* starts at 0 and will increment sequentally for a while before switching to
143	* random numbers.
144	*
145	* On success @a pszPath contains the path created.
146	*
147	* @returns iprt status code.
148	* @param pszPath The path to the directory. On input the base template
149	* name. On successful return, the unique directory we
150	* created.
151	* @param cbSize The size of the pszPath buffer. Needs enough space for
152	* holding the digits and the optional separator.
153	* @param fMode The mode of the new directory.
154	* @param cchDigits How many digits should the number have (zero padded).
155	* @param chSep The separator used between the path and the number. Can
156	* be zero. (optional)
157	*/
158	RTDECL(int) RTDirCreateUniqueNumbered(char *pszPath, size_t cbSize, RTFMODE fMode, size_t cchDigits, char chSep);
159
160	/**
161	* Removes a directory if empty.
162	*
163	* @returns iprt status code.
164	* @param pszPath Path to the directory to remove.
165	*/
166	RTDECL(int) RTDirRemove(const char *pszPath);
167
168	/**
169	* Removes a directory tree recursively.
170	*
171	* @returns iprt status code.
172	* @param pszPath Path to the directory to remove recursively.
173	* @param fFlags Flags, see RTDIRRMREC_F_XXX.
174	*
175	* @remarks This will not work on a root directory.
176	*/
177	RTDECL(int) RTDirRemoveRecursive(const char *pszPath, uint32_t fFlags);
178
179	/** @name RTDirRemoveRecursive flags.
180	* @{ */
181	/** Delete the content of the directory and the directory itself. */
182	#define RTDIRRMREC_F_CONTENT_AND_DIR UINT32_C(0)
183	/** Only delete the content of the directory, omit the directory it self. */
184	#define RTDIRRMREC_F_CONTENT_ONLY RT_BIT_32(0)
185	/** Mask of valid flags. */
186	#define RTDIRRMREC_F_VALID_MASK UINT32_C(0x00000001)
187	/** @} */
188
189	/**
190	* Flushes the specified directory.
191	*
192	* This API is not implemented on all systems. On some systems it may be
193	* unnecessary if you've already flushed the file. If you really care for your
194	* data and is entering dangerous territories, it doesn't hurt calling it after
195	* flushing and closing the file.
196	*
197	* @returns IPRT status code.
198	* @retval VERR_NOT_IMPLEMENTED must be expected.
199	* @retval VERR_NOT_SUPPORTED must be expected.
200	* @param pszPath Path to the directory.
201	*/
202	RTDECL(int) RTDirFlush(const char *pszPath);
203
204	/**
205	* Flushes the parent directory of the specified file.
206	*
207	* This is just a wrapper around RTDirFlush.
208	*
209	* @returns IPRT status code, see RTDirFlush for details.
210	* @param pszChild Path to the file which parent should be flushed.
211	*/
212	RTDECL(int) RTDirFlushParent(const char *pszChild);
213
214
215
216	/**
217	* Filter option for RTDirOpenFiltered().
218	*/
219	typedef enum RTDIRFILTER
220	{
221	/** The usual invalid 0 entry. */
222	RTDIRFILTER_INVALID = 0,
223	/** No filter should be applied (and none was specified). */
224	RTDIRFILTER_NONE,
225	/** The Windows NT filter.
226	* The following wildcard chars: *, ?, <, > and "
227	* The matching is done on the uppercased strings. */
228	RTDIRFILTER_WINNT,
229	/** The UNIX filter.
230	* The following wildcard chars: *, ?, [..]
231	* The matching is done on exact case. */
232	RTDIRFILTER_UNIX,
233	/** The UNIX filter, uppercased matching.
234	* Same as RTDIRFILTER_UNIX except that the strings are uppercased before comparing. */
235	RTDIRFILTER_UNIX_UPCASED,
236
237	/** The usual full 32-bit value. */
238	RTDIRFILTER_32BIT_HACK = 0x7fffffff
239	} RTDIRFILTER;
240
241
242	/**
243	* Directory entry type.
244	*
245	* This is the RTFS_TYPE_MASK stuff shifted down 12 bits and
246	* identical to the BSD/LINUX ABI. See RTFS_TYPE_DIRENTRYTYPE_SHIFT.
247	*/
248	typedef enum RTDIRENTRYTYPE
249	{
250	/** Unknown type (DT_UNKNOWN). */
251	RTDIRENTRYTYPE_UNKNOWN = 0,
252	/** Named pipe (fifo) (DT_FIFO). */
253	RTDIRENTRYTYPE_FIFO = 001,
254	/** Character device (DT_CHR). */
255	RTDIRENTRYTYPE_DEV_CHAR = 002,
256	/** Directory (DT_DIR). */
257	RTDIRENTRYTYPE_DIRECTORY = 004,
258	/** Block device (DT_BLK). */
259	RTDIRENTRYTYPE_DEV_BLOCK = 006,
260	/** Regular file (DT_REG). */
261	RTDIRENTRYTYPE_FILE = 010,
262	/** Symbolic link (DT_LNK). */
263	RTDIRENTRYTYPE_SYMLINK = 012,
264	/** Socket (DT_SOCK). */
265	RTDIRENTRYTYPE_SOCKET = 014,
266	/** Whiteout (DT_WHT). */
267	RTDIRENTRYTYPE_WHITEOUT = 016
268	} RTDIRENTRYTYPE;
269
270
271	/**
272	* Directory entry.
273	*
274	* This is inspired by the POSIX interfaces.
275	*/
276	#pragma pack(1)
277	typedef struct RTDIRENTRY
278	{
279	/** The unique identifier (within the file system) of this file system object (d_ino).
280	*
281	* Together with INodeIdDevice, this field can be used as a OS wide unique id
282	* when both their values are not 0. This field is 0 if the information is not
283	* available. */
284	RTINODE INodeId;
285	/** The entry type. (d_type)
286	*
287	* @warning RTDIRENTRYTYPE_UNKNOWN is a common return value here since not all
288	* file systems (or Unixes) stores the type of a directory entry and
289	* instead expects the user to use stat() to get it. So, when you see
290	* this you should use RTDirQueryUnknownType or RTDirQueryUnknownTypeEx
291	* to get the type, or if if you're lazy, use RTDirReadEx.
292	*/
293	RTDIRENTRYTYPE enmType;
294	/** The length of the filename, excluding the terminating nul character. */
295	uint16_t cbName;
296	/** The filename. (no path)
297	* Using the pcbDirEntry parameter of RTDirRead makes this field variable in size. */
298	char szName[260];
299	} RTDIRENTRY;
300	#pragma pack()
301	/** Pointer to a directory entry. */
302	typedef RTDIRENTRY *PRTDIRENTRY;
303	/** Pointer to a const directory entry. */
304	typedef RTDIRENTRY const *PCRTDIRENTRY;
305
306
307	/**
308	* Directory entry with extended information.
309	*
310	* This is inspired by the PC interfaces.
311	*/
312	#pragma pack(1)
313	typedef struct RTDIRENTRYEX
314	{
315	/** Full information about the object. */
316	RTFSOBJINFO Info;
317	/** The length of the short field (number of RTUTF16 entries (not chars)).
318	* It is 16-bit for reasons of alignment. */
319	uint16_t cwcShortName;
320	/** The short name for 8.3 compatibility.
321	* Empty string if not available.
322	* Since the length is a bit tricky for a UTF-8 encoded name, and since this
323	* is practically speaking only a windows thing, it is encoded as UCS-2. */
324	RTUTF16 wszShortName[14];
325	/** The length of the filename. */
326	uint16_t cbName;
327	/** The filename. (no path)
328	* Using the pcbDirEntry parameter of RTDirReadEx makes this field variable in size. */
329	char szName[260];
330	} RTDIRENTRYEX;
331	#pragma pack()
332	/** Pointer to a directory entry. */
333	typedef RTDIRENTRYEX *PRTDIRENTRYEX;
334	/** Pointer to a const directory entry. */
335	typedef RTDIRENTRYEX const *PCRTDIRENTRYEX;
336
337
338	/**
339	* Opens a directory.
340	*
341	* @returns iprt status code.
342	* @param phDir Where to store the open directory handle.
343	* @param pszPath Path to the directory to open.
344	*/
345	RTDECL(int) RTDirOpen(RTDIR phDir, const char pszPath);
346
347	/** @name RTDIR_F_XXX - RTDirOpenFiltered flags.
348	* @{ */
349	/** Don't allow symbolic links as part of the path.
350	* @remarks this flag is currently not implemented and will be ignored. */
351	#define RTDIR_F_NO_SYMLINKS RT_BIT_32(0)
352	/** Deny relative opening of anything above this directory. */
353	#define RTDIR_F_DENY_ASCENT RT_BIT_32(1)
354	/** Valid flag mask. */
355	#define RTDIR_F_VALID_MASK UINT32_C(0x00000003)
356	/** @} */
357
358	/**
359	* Opens a directory with flags and optional filtering.
360	*
361	* @returns iprt status code.
362	* @param phDir Where to store the open directory handle.
363	* @param pszPath Path to the directory to search, this must include wildcards.
364	* @param enmFilter The kind of filter to apply. Setting this to RTDIRFILTER_NONE makes
365	* this function behave like RTDirOpen.
366	* @param fFlags Open flags, RTDIR_F_XXX.
367	*/
368	RTDECL(int) RTDirOpenFiltered(RTDIR phDir, const char pszPath, RTDIRFILTER enmFilter, uint32_t fFlags);
369
370	/**
371	* Closes a directory.
372	*
373	* @returns iprt status code.
374	* @param hDir Handle to open directory returned by RTDirOpen() or
375	* RTDirOpenFiltered().
376	*/
377	RTDECL(int) RTDirClose(RTDIR hDir);
378
379	/**
380	* Checks if the supplied directory handle is valid.
381	*
382	* @returns true if valid.
383	* @returns false if invalid.
384	* @param hDir The directory handle.
385	*/
386	RTDECL(bool) RTDirIsValid(RTDIR hDir);
387
388	/**
389	* Reads the next entry in the directory.
390	*
391	* @returns VINF_SUCCESS and data in pDirEntry on success.
392	* @returns VERR_NO_MORE_FILES when the end of the directory has been reached.
393	* @returns VERR_BUFFER_OVERFLOW if the buffer is too small to contain the filename. If
394	* pcbDirEntry is specified it will be updated with the required buffer size.
395	* @returns suitable iprt status code on other errors.
396	*
397	* @param hDir Handle to the open directory.
398	* @param pDirEntry Where to store the information about the next
399	* directory entry on success.
400	* @param pcbDirEntry Optional parameter used for variable buffer size.
401	*
402	* On input the variable pointed to contains the size of the pDirEntry
403	* structure. This must be at least OFFSET(RTDIRENTRY, szName[2]) bytes.
404	*
405	* On successful output the field is updated to
406	* OFFSET(RTDIRENTRY, szName[pDirEntry->cbName + 1]).
407	*
408	* When the data doesn't fit in the buffer and VERR_BUFFER_OVERFLOW is
409	* returned, this field contains the required buffer size.
410	*
411	* The value is unchanged in all other cases.
412	*/
413	RTDECL(int) RTDirRead(RTDIR hDir, PRTDIRENTRY pDirEntry, size_t *pcbDirEntry);
414
415	/**
416	* Reads the next entry in the directory returning extended information.
417	*
418	* @returns VINF_SUCCESS and data in pDirEntry on success.
419	* @returns VERR_NO_MORE_FILES when the end of the directory has been reached.
420	* @returns VERR_BUFFER_OVERFLOW if the buffer is too small to contain the filename. If
421	* pcbDirEntry is specified it will be updated with the required buffer size.
422	* @returns suitable iprt status code on other errors.
423	*
424	* @param hDir Handle to the open directory.
425	* @param pDirEntry Where to store the information about the next
426	* directory entry on success.
427	* @param pcbDirEntry Optional parameter used for variable buffer size.
428	*
429	* On input the variable pointed to contains the size of the pDirEntry
430	* structure. This must be at least OFFSET(RTDIRENTRYEX, szName[2]) bytes.
431	*
432	* On successful output the field is updated to
433	* OFFSET(RTDIRENTRYEX, szName[pDirEntry->cbName + 1]).
434	*
435	* When the data doesn't fit in the buffer and VERR_BUFFER_OVERFLOW is
436	* returned, this field contains the required buffer size.
437	*
438	* The value is unchanged in all other cases.
439	* @param enmAdditionalAttribs
440	* Which set of additional attributes to request.
441	* Use RTFSOBJATTRADD_NOTHING if this doesn't matter.
442	* @param fFlags RTPATH_F_ON_LINK or RTPATH_F_FOLLOW_LINK.
443	*/
444	RTDECL(int) RTDirReadEx(RTDIR hDir, PRTDIRENTRYEX pDirEntry, size_t *pcbDirEntry, RTFSOBJATTRADD enmAdditionalAttribs, uint32_t fFlags);
445
446	/**
447	* Wrapper around RTDirReadEx that does the directory entry buffer handling.
448	*
449	* Call RTDirReadExAFree to free the buffers allocated by this function.
450	*
451	* @returns IPRT status code, see RTDirReadEx() for details.
452	*
453	* @param hDir Handle to the open directory.
454	* @param ppDirEntry Pointer to the directory entry pointer. Initialize this
455	* to NULL before the first call.
456	* @param pcbDirEntry Where the API caches the allocation size. Set this to
457	* zero before the first call.
458	* @param enmAddAttr See RTDirReadEx.
459	* @param fFlags See RTDirReadEx.
460	*/
461	RTDECL(int) RTDirReadExA(RTDIR hDir, PRTDIRENTRYEX ppDirEntry, size_t pcbDirEntry, RTFSOBJATTRADD enmAddAttr, uint32_t fFlags);
462
463	/**
464	* Frees the buffer allocated by RTDirReadExA.
465	*
466	* @param ppDirEntry Pointer to the directory entry pointer.
467	* @param pcbDirEntry Where the API caches the allocation size.
468	*/
469	RTDECL(void) RTDirReadExAFree(PRTDIRENTRYEX ppDirEntry, size_t pcbDirEntry);
470
471	/**
472	* Resolves RTDIRENTRYTYPE_UNKNOWN values returned by RTDirRead.
473	*
474	* @returns IPRT status code (see RTPathQueryInfo).
475	* @param pszComposedName The path to the directory entry. The caller must
476	* compose this, it's NOT sufficient to pass
477	* RTDIRENTRY::szName!
478	* @param fFollowSymlinks Whether to follow symbolic links or not.
479	* @param penmType Pointer to the RTDIRENTRY::enmType member. If this
480	* is not RTDIRENTRYTYPE_UNKNOWN and, if
481	* @a fFollowSymlinks is false, not
482	* RTDIRENTRYTYPE_SYMLINK, the function will return
483	* immediately without doing anything. Otherwise it
484	* will use RTPathQueryInfo to try figure out the
485	* correct value. On failure, this will be unchanged.
486	*/
487	RTDECL(int) RTDirQueryUnknownType(const char pszComposedName, bool fFollowSymlinks, RTDIRENTRYTYPE penmType);
488
489	/**
490	* Resolves RTDIRENTRYTYPE_UNKNOWN values returned by RTDirRead, extended
491	* version.
492	*
493	* @returns IPRT status code (see RTPathQueryInfo).
494	* @param pszComposedName The path to the directory entry. The caller must
495	* compose this, it's NOT sufficient to pass
496	* RTDIRENTRY::szName!
497	* @param fFollowSymlinks Whether to follow symbolic links or not.
498	* @param penmType Pointer to the RTDIRENTRY::enmType member or
499	* similar. Will NOT be checked on input.
500	* @param pObjInfo The object info buffer to use with RTPathQueryInfo.
501	*/
502	RTDECL(int) RTDirQueryUnknownTypeEx(const char pszComposedName, bool fFollowSymlinks, RTDIRENTRYTYPE penmType, PRTFSOBJINFO pObjInfo);
503
504	/**
505	* Checks if the directory entry returned by RTDirRead is '.', '..' or similar.
506	*
507	* @returns true / false.
508	* @param pDirEntry The directory entry to check.
509	*/
510	RTDECL(bool) RTDirEntryIsStdDotLink(PRTDIRENTRY pDirEntry);
511
512	/**
513	* Checks if the directory entry returned by RTDirReadEx is '.', '..' or
514	* similar.
515	*
516	* @returns true / false.
517	* @param pDirEntryEx The extended directory entry to check.
518	*/
519	RTDECL(bool) RTDirEntryExIsStdDotLink(PCRTDIRENTRYEX pDirEntryEx);
520
521	/**
522	* Renames a file.
523	*
524	* Identical to RTPathRename except that it will ensure that the source is a directory.
525	*
526	* @returns IPRT status code.
527	* @returns VERR_ALREADY_EXISTS if the destination file exists.
528	*
529	* @param pszSrc The path to the source file.
530	* @param pszDst The path to the destination file.
531	* This file will be created.
532	* @param fRename See RTPathRename.
533	*/
534	RTDECL(int) RTDirRename(const char pszSrc, const char pszDst, unsigned fRename);
535
536
537	/**
538	* Query information about an open directory.
539	*
540	* @returns iprt status code.
541	*
542	* @param hDir Handle to the open directory.
543	* @param pObjInfo Object information structure to be filled on successful return.
544	* @param enmAdditionalAttribs Which set of additional attributes to request.
545	* Use RTFSOBJATTRADD_NOTHING if this doesn't matter.
546	*/
547	RTR3DECL(int) RTDirQueryInfo(RTDIR hDir, PRTFSOBJINFO pObjInfo, RTFSOBJATTRADD enmAdditionalAttribs);
548
549
550	/**
551	* Changes one or more of the timestamps associated of file system object.
552	*
553	* @returns iprt status code.
554	* @returns VERR_NOT_SUPPORTED is returned if the operation isn't supported by the OS.
555	*
556	* @param hDir Handle to the open directory.
557	* @param pAccessTime Pointer to the new access time. NULL if not to be changed.
558	* @param pModificationTime Pointer to the new modifcation time. NULL if not to be changed.
559	* @param pChangeTime Pointer to the new change time. NULL if not to be changed.
560	* @param pBirthTime Pointer to the new time of birth. NULL if not to be changed.
561	*
562	* @remark The file system might not implement all these time attributes,
563	* the API will ignore the ones which aren't supported.
564	*
565	* @remark The file system might not implement the time resolution
566	* employed by this interface, the time will be chopped to fit.
567	*
568	* @remark The file system may update the change time even if it's
569	* not specified.
570	*
571	* @remark POSIX can only set Access & Modification and will always set both.
572	*/
573	RTR3DECL(int) RTDirSetTimes(RTDIR hDir, PCRTTIMESPEC pAccessTime, PCRTTIMESPEC pModificationTime,
574	PCRTTIMESPEC pChangeTime, PCRTTIMESPEC pBirthTime);
575
576
577	/** @defgroup grp_rt_dir_rel Directory relative APIs
578	*
579	* This group of APIs allows working with paths that are relative to an open
580	* directory, therebye eliminating some classic path related race conditions on
581	* systems with native support for these kinds of operations.
582	*
583	* On NT (Windows) there is native support for addressing files, directories and
584	* stuff _below_ the open directory. It is not possible to go upwards
585	* (hDir:../../grandparent), at least not with NTFS, forcing us to use the
586	* directory path as a fallback and opening us to potential races.
587	*
588	* On most unix-like systems here is now native support for all of this.
589	*
590	* @{ */
591
592	/**
593	* Open a file relative to @a hDir.
594	*
595	* @returns IPRT status code.
596	* @param hDir The directory to open relative to.
597	* @param pszRelFilename The relative path to the file.
598	* @param fOpen Open flags, i.e a combination of the RTFILE_O_XXX
599	* defines. The ACCESS, ACTION and DENY flags are
600	* mandatory!
601	* @param phFile Where to store the handle to the opened file.
602	*
603	* @sa RTFileOpen
604	*/
605	RTDECL(int) RTDirRelFileOpen(RTDIR hDir, const char *pszRelFilename, uint64_t fOpen, PRTFILE phFile);
606
607
608
609	/**
610	* Opens a directory relative to @a hDir.
611	*
612	* @returns IPRT status code.
613	* @param hDir The directory to open relative to.
614	* @param pszDir The relative path to the directory to open.
615	* @param phDir Where to store the directory handle.
616	*
617	* @sa RTDirOpen
618	*/
619	RTDECL(int) RTDirRelDirOpen(RTDIR hDir, const char pszDir, RTDIR phDir);
620
621	/**
622	* Opens a directory relative to @a hDir, with flags and optional filtering.
623	*
624	* @returns IPRT status code.
625	* @param hDir The directory to open relative to.
626	* @param pszDirAndFilter The relative path to the directory to search, this
627	* must include wildcards.
628	* @param enmFilter The kind of filter to apply. Setting this to
629	* RTDIRFILTER_NONE makes this function behave like
630	* RTDirOpen.
631	* @param fFlags Open flags, RTDIR_F_XXX.
632	* @param phDir Where to store the directory handle.
633	*
634	* @sa RTDirOpenFiltered
635	*/
636	RTDECL(int) RTDirRelDirOpenFiltered(RTDIR hDir, const char *pszDirAndFilter, RTDIRFILTER enmFilter,
637	uint32_t fFlags, RTDIR *phDir);
638
639	/**
640	* Creates a directory relative to @a hDir.
641	*
642	* @returns IPRT status code.
643	* @param hDir The directory @a pszRelPath is relative to.
644	* @param pszRelPath The relative path to the directory to create.
645	* @param fMode The mode of the new directory.
646	* @param fCreate Create flags, RTDIRCREATE_FLAGS_XXX.
647	* @param phSubDir Where to return the handle of the created directory.
648	* Optional.
649	*
650	* @sa RTDirCreate
651	*/
652	RTDECL(int) RTDirRelDirCreate(RTDIR hDir, const char pszRelPath, RTFMODE fMode, uint32_t fCreate, RTDIR phSubDir);
653
654	/**
655	* Removes a directory relative to @a hDir if empty.
656	*
657	* @returns IPRT status code.
658	* @param hDir The directory @a pszRelPath is relative to.
659	* @param pszRelPath The relative path to the directory to remove.
660	*
661	* @sa RTDirRemove
662	*/
663	RTDECL(int) RTDirRelDirRemove(RTDIR hDir, const char *pszRelPath);
664
665
666	/**
667	* Query information about a file system object relative to @a hDir.
668	*
669	* @returns IPRT status code.
670	* @retval VINF_SUCCESS if the object exists, information returned.
671	* @retval VERR_PATH_NOT_FOUND if any but the last component in the specified
672	* path was not found or was not a directory.
673	* @retval VERR_FILE_NOT_FOUND if the object does not exist (but path to the
674	* parent directory exists).
675	*
676	* @param hDir The directory @a pszRelPath is relative to.
677	* @param pszRelPath The relative path to the file system object.
678	* @param pObjInfo Object information structure to be filled on successful
679	* return.
680	* @param enmAddAttr Which set of additional attributes to request.
681	* Use RTFSOBJATTRADD_NOTHING if this doesn't matter.
682	* @param fFlags RTPATH_F_ON_LINK or RTPATH_F_FOLLOW_LINK.
683	*
684	* @sa RTPathQueryInfoEx
685	*/
686	RTDECL(int) RTDirRelPathQueryInfo(RTDIR hDir, const char *pszRelPath, PRTFSOBJINFO pObjInfo,
687	RTFSOBJATTRADD enmAddAttr, uint32_t fFlags);
688
689	/**
690	* Changes the mode flags of a file system object relative to @a hDir.
691	*
692	* The API requires at least one of the mode flag sets (Unix/Dos) to
693	* be set. The type is ignored.
694	*
695	* @returns IPRT status code.
696	* @param hDir The directory @a pszRelPath is relative to.
697	* @param pszRelPath The relative path to the file system object.
698	* @param fMode The new file mode, see @ref grp_rt_fs for details.
699	* @param fFlags RTPATH_F_ON_LINK or RTPATH_F_FOLLOW_LINK.
700	*
701	* @sa RTPathSetMode
702	*/
703	RTDECL(int) RTDirRelPathSetMode(RTDIR hDir, const char *pszRelPath, RTFMODE fMode, uint32_t fFlags);
704
705	/**
706	* Changes one or more of the timestamps associated of file system object
707	* relative to @a hDir.
708	*
709	* @returns IPRT status code.
710	* @param hDir The directory @a pszRelPath is relative to.
711	* @param pszRelPath The relative path to the file system object.
712	* @param pAccessTime Pointer to the new access time.
713	* @param pModificationTime Pointer to the new modification time.
714	* @param pChangeTime Pointer to the new change time. NULL if not to be changed.
715	* @param pBirthTime Pointer to the new time of birth. NULL if not to be changed.
716	* @param fFlags RTPATH_F_ON_LINK or RTPATH_F_FOLLOW_LINK.
717	*
718	* @remark The file system might not implement all these time attributes,
719	* the API will ignore the ones which aren't supported.
720	*
721	* @remark The file system might not implement the time resolution
722	* employed by this interface, the time will be chopped to fit.
723	*
724	* @remark The file system may update the change time even if it's
725	* not specified.
726	*
727	* @remark POSIX can only set Access & Modification and will always set both.
728	*
729	* @sa RTPathSetTimesEx
730	*/
731	RTDECL(int) RTDirRelPathSetTimes(RTDIR hDir, const char *pszRelPath, PCRTTIMESPEC pAccessTime, PCRTTIMESPEC pModificationTime,
732	PCRTTIMESPEC pChangeTime, PCRTTIMESPEC pBirthTime, uint32_t fFlags);
733
734	/**
735	* Changes the owner and/or group of a file system object relative to @a hDir.
736	*
737	* @returns IPRT status code.
738	* @param hDir The directory @a pszRelPath is relative to.
739	* @param pszRelPath The relative path to the file system object.
740	* @param uid The new file owner user id. Pass NIL_RTUID to leave
741	* this unchanged.
742	* @param gid The new group id. Pass NIL_RTGID to leave this
743	* unchanged.
744	* @param fFlags RTPATH_F_ON_LINK or RTPATH_F_FOLLOW_LINK.
745	*
746	* @sa RTPathSetOwnerEx
747	*/
748	RTDECL(int) RTDirRelPathSetOwner(RTDIR hDir, const char *pszRelPath, uint32_t uid, uint32_t gid, uint32_t fFlags);
749
750	/**
751	* Renames a directory relative path within a filesystem.
752	*
753	* This will rename symbolic links. If RTPATHRENAME_FLAGS_REPLACE is used and
754	* pszDst is a symbolic link, it will be replaced and not its target.
755	*
756	* @returns IPRT status code.
757	* @param hDirSrc The directory the source path is relative to.
758	* @param pszSrc The source path, relative to @a hDirSrc.
759	* @param hDirDst The directory the destination path is relative to.
760	* @param pszDst The destination path, relative to @a hDirDst.
761	* @param fRename Rename flags, RTPATHRENAME_FLAGS_XXX.
762	*
763	* @sa RTPathRename
764	*/
765	RTDECL(int) RTDirRelPathRename(RTDIR hDirSrc, const char pszSrc, RTDIR hDirDst, const char pszDst, unsigned fRename);
766
767	/**
768	* Removes the last component of the directory relative path.
769	*
770	* @returns IPRT status code.
771	* @param hDir The directory @a pszRelPath is relative to.
772	* @param pszRelPath The relative path to the file system object.
773	* @param fUnlink Unlink flags, RTPATHUNLINK_FLAGS_XXX.
774	*
775	* @sa RTPathUnlink
776	*/
777	RTDECL(int) RTDirRelPathUnlink(RTDIR hDir, const char *pszRelPath, uint32_t fUnlink);
778
779
780
781	/**
782	* Creates a symbolic link (@a pszSymlink) relative to @a hDir targeting @a
783	* pszTarget.
784	*
785	* @returns IPRT status code.
786	* @param hDir The directory @a pszSymlink is relative to.
787	* @param pszSymlink The relative path of the symbolic link.
788	* @param pszTarget The path to the symbolic link target. This is
789	* relative to @a pszSymlink or an absolute path.
790	* @param enmType The symbolic link type. For Windows compatability
791	* it is very important to set this correctly. When
792	* RTSYMLINKTYPE_UNKNOWN is used, the API will try
793	* make a guess and may attempt query information
794	* about @a pszTarget in the process.
795	* @param fCreate Create flags, RTSYMLINKCREATE_FLAGS_XXX.
796	*
797	* @sa RTSymlinkCreate
798	*/
799	RTDECL(int) RTDirRelSymlinkCreate(RTDIR hDir, const char pszSymlink, const char pszTarget,
800	RTSYMLINKTYPE enmType, uint32_t fCreate);
801
802	/**
803	* Read the symlink target relative to @a hDir.
804	*
805	* @returns IPRT status code.
806	* @retval VERR_NOT_SYMLINK if @a pszSymlink does not specify a symbolic link.
807	* @retval VERR_BUFFER_OVERFLOW if the link is larger than @a cbTarget. The
808	* buffer will contain what all we managed to read, fully terminated
809	* if @a cbTarget > 0.
810	*
811	* @param hDir The directory @a pszSymlink is relative to.
812	* @param pszSymlink The relative path to the symbolic link that should
813	* be read.
814	* @param pszTarget The target buffer.
815	* @param cbTarget The size of the target buffer.
816	* @param fRead Read flags, RTSYMLINKREAD_FLAGS_XXX.
817	*
818	* @sa RTSymlinkRead
819	*/
820	RTDECL(int) RTDirRelSymlinkRead(RTDIR hDir, const char pszSymlink, char pszTarget, size_t cbTarget, uint32_t fRead);
821
822	/** @} */
823
824
825	/** @} */
826
827	RT_C_DECLS_END
828
829	#endif
830

Note: See TracBrowser for help on using the repository browser.

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

Download in other formats: