Changeset 69716 in vbox for trunk/include/iprt

Timestamp:

Nov 16, 2017 2:31:25 PM (7 years ago)

Author:

vboxsync

Message:

IPRT: More work on directory relative APIs (NT mainly) and VFS; introducing RTMkDir (test) tool.

• Added RTVfsDirCreateDir
• Added RTVfsChainOpenParentDir and RTVfsChainSplitOffFinalPath.
• Added new tool for testing this called RTMkDir.
• Fixed directory traversal problem with stddir by making it okay to return VERR_FILE_NOT_FOUND as well.

Location:

trunk/include/iprt

Files:

• dir.h (modified) (1 diff)
• err.h (modified) (1 diff)
• mangling.h (modified) (3 diffs)
• vfs.h (modified) (3 diffs)
• vfslowlevel.h (modified) (1 diff)

trunk/include/iprt/dir.h

@@ -620 +620 @@
  * @param   fMode           The mode of the new directory.
  * @param   fCreate         Create flags, RTDIRCREATE_FLAGS_XXX.
+ * @param   phSubDir        Where to return the handle of the created directory.
+ *                          Optional.
  *
  * @sa      RTDirCreate
  */
-RTDECL(int) RTDirRelDirCreate(PRTDIR hDir, const char *pszRelPath, RTFMODE fMode, uint32_t fCreate);
+RTDECL(int) RTDirRelDirCreate(PRTDIR hDir, const char *pszRelPath, RTFMODE fMode, uint32_t fCreate, PRTDIR *phSubDir);
 
 /**

trunk/include/iprt/err.h

@@ -2079 +2079 @@
 /** VFS chain doesn't end with a path only element. */
 #define VERR_VFS_CHAIN_NOT_PATH_ONLY                (-22157)
+/** The path only element at the end of the VFS chain is too short to make out
+ *  the parent directory. */
+#define VERR_VFS_CHAIN_TOO_SHORT_FOR_PARENT         (-22158)
 /** @} */
 

trunk/include/iprt/mangling.h

@@ -2418 +2418 @@
 # define RTVfsChainMsgErrorExitFailure                  RT_MANGLER(RTVfsChainMsgErrorExitFailure)
 # define RTVfsChainOpenDir                              RT_MANGLER(RTVfsChainOpenDir)
+# define RTVfsChainOpenParentDir                        RT_MANGLER(RTVfsChainOpenParentDir)
 # define RTVfsChainOpenFile                             RT_MANGLER(RTVfsChainOpenFile)
 # define RTVfsChainOpenIoStream                         RT_MANGLER(RTVfsChainOpenIoStream)
@@ -2425 +2426 @@
 # define RTVfsChainSpecFree                             RT_MANGLER(RTVfsChainSpecFree)
 # define RTVfsChainSpecParse                            RT_MANGLER(RTVfsChainSpecParse)
+# define RTVfsChainSplitOffFinalPath                    RT_MANGLER(RTVfsChainSplitOffFinalPath)
 # define RTVfsChainValidateOpenFileOrIoStream           RT_MANGLER(RTVfsChainValidateOpenFileOrIoStream)
 # define RTVfsDirRelease                                RT_MANGLER(RTVfsDirRelease)
@@ -2431 +2433 @@
 # define RTVfsDirOpen                                   RT_MANGLER(RTVfsDirOpen)
 # define RTVfsDirOpenDir                                RT_MANGLER(RTVfsDirOpenDir)
+# define RTVfsDirCreateDir                              RT_MANGLER(RTVfsDirCreateDir)
 # define RTVfsDirOpenFile                               RT_MANGLER(RTVfsDirOpenFile)
 # define RTVfsDirOpenFileAsIoStream                     RT_MANGLER(RTVfsDirOpenFileAsIoStream)

trunk/include/iprt/vfs.h

@@ -478 +478 @@
 
 /**
+ * Creates a directory relative to @a hVfsDir.
+ *
+ * @returns IPRT status code
+ * @param   hVfsDir             The directory the path is relative to.
+ * @param   pszRelPath          The relative path to the new directory.
+ * @param   fMode               The file mode for the new directory.
+ * @param   fFlags              Directory creation flags, RTDIRCREATE_FLAGS_XXX.
+ * @param   phVfsDir            Where to return the handle to the newly created
+ *                              directory.  Optional.
+ * @sa      RTDirCreate, RTDirRelDirCreate
+ */
+RTDECL(int) RTVfsDirCreateDir(RTVFSDIR hVfsDir, const char *pszRelPath, RTFMODE fMode, uint32_t fFlags, PRTVFSDIR phVfsDir);
+
+/**
  * Create a VFS directory handle from a standard IPRT directory handle (PRTDIR).
  *
@@ -1535 +1549 @@
 RTDECL(int) RTVfsChainOpenFsStream(const char *pszSpec, PRTVFSFSSTREAM  phVfsFss, uint32_t *poffError, PRTERRINFO pErrInfo);
 RTDECL(int) RTVfsChainOpenDir(const char *pszSpec, uint32_t fOpen, PRTVFSDIR phVfsDir, uint32_t *poffError, PRTERRINFO pErrInfo);
+RTDECL(int) RTVfsChainOpenParentDir(const char *pszSpec, uint32_t fOpen, PRTVFSDIR phVfsDir, const char **ppszChild,
+                                    uint32_t *poffError, PRTERRINFO pErrInfo);
 RTDECL(int) RTVfsChainOpenFile(const char *pszSpec, uint64_t fOpen, PRTVFSFILE phVfsFile, uint32_t *poffError, PRTERRINFO pErrInfo);
 RTDECL(int) RTVfsChainOpenIoStream(const char *pszSpec, uint64_t fOpen, PRTVFSIOSTREAM phVfsIos, uint32_t *poffError, PRTERRINFO pErrInfo);
@@ -1566 +1582 @@
 
 /**
+ * Splits the given chain spec into a final path and the preceeding spec.
+ *
+ * This works on plain paths too.
+ *
+ * @returns IPRT status code.
+ * @param   pszSpec         The chain spec to split.  This will be modified!
+ * @param   ppszSpec        Where to return the pointer to the chain spec part.
+ *                          This is set to NULL if it's a plain path or a chain
+ *                          spec with only a final-path element.
+ * @param   ppszFinalPath   Where to return the pointer to the final path.  This
+ *                          is set to NULL if no final path.
+ * @param   poffError       Where to on error return an offset into @a pszSpec
+ *                          of what cause the error.  Optional.
+ */
+RTDECL(int) RTVfsChainSplitOffFinalPath(char *pszSpec, char **ppszSpec, char **ppszFinalPath, uint32_t *poffError);
+
+/**
  * Common code for reporting errors of a RTVfsChainOpen* API.
  *

trunk/include/iprt/vfslowlevel.h

@@ -566 +566 @@
      * @param   fFlags      RTDIR_F_XXX.
      * @param   phVfsDir    Where to return the handle to the opened directory.
+     *                      Optional.
      * @sa      RTDirOpen.
      */