Changeset 46008 in vbox

Timestamp:

May 13, 2013 11:05:55 AM (12 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

85671

Message:

iprt/dir.h,++: Added RTDirQueryUnknownType, RTDirQueryUnknownTypeEx, RTDirEntryIsStdDotLink and RTDirEntryExIsStdDotLink to simplify directory enumeration.

Location:

trunk

Files:

• include/iprt/dir.h (modified) (4 diffs)
• include/iprt/mangling.h (modified) (2 diffs)
• src/VBox/Runtime/r3/dir.cpp (modified) (1 diff)
• src/VBox/Runtime/r3/win/fs-win.cpp (modified) (1 diff)

trunk/include/iprt/dir.h

@@ -273 +273 @@
      * systems (or Unixes) stores the type of a directory entry and instead
      * expects the user to use stat() to get it.  So, when you see this you
-     * should use RTPathQueryInfo to get the type, or if if you're lazy, use
-     * RTDirReadEx. */
+     * should use RTDirQueryUnknownType or RTDirQueryUnknownTypeEx to get the type,
+     * or if if you're lazy, use RTDirReadEx. */
     RTDIRENTRYTYPE  enmType;
     /** The length of the filename, excluding the terminating nul character. */
@@ -285 +285 @@
 /** Pointer to a directory entry. */
 typedef RTDIRENTRY *PRTDIRENTRY;
+/** Pointer to a const directory entry. */
+typedef RTDIRENTRY const *PCRTDIRENTRY;
 
 
@@ -314 +316 @@
 /** Pointer to a directory entry. */
 typedef RTDIRENTRYEX *PRTDIRENTRYEX;
+/** Pointer to a const directory entry. */
+typedef RTDIRENTRYEX const *PCRTDIRENTRYEX;
 
 
@@ -410 +414 @@
 RTDECL(int) RTDirReadEx(PRTDIR pDir, PRTDIRENTRYEX pDirEntry, size_t *pcbDirEntry, RTFSOBJATTRADD enmAdditionalAttribs, uint32_t fFlags);
 
+/**
+ * Resolves RTDIRENTRYTYPE_UNKNOWN values returned by RTDirRead.
+ *
+ * @returns IPRT status code (see RTPathQueryInfo).
+ * @param   pszComposedName The path to the directory entry. The caller must
+ *                          compose this, it's NOT sufficient to pass
+ *                          RTDIRENTRY::szName!
+ * @param   penmType        Pointer to the RTDIRENTRY::enmType member.  If this
+ *                          is not RTDIRENTRYTYPE_UNKNOWN, the function will
+ *                          return immediately without doing anything.  If it
+ *                          is, it will use RTPathQueryInfo to try figure out
+ *                          the correct value.  On failure, this will be
+ *                          unchanged.
+ */
+RTDECL(int) RTDirQueryUnknownType(const char *pszComposedName, RTDIRENTRYTYPE *penmType);
+
+/**
+ * Resolves RTDIRENTRYTYPE_UNKNOWN values returned by RTDirRead, extended
+ * version.
+ *
+ * @returns IPRT status code (see RTPathQueryInfo).
+ * @param   pszComposedName The path to the directory entry. The caller must
+ *                          compose this, it's NOT sufficient to pass
+ *                          RTDIRENTRY::szName!
+ * @param   penmType        Pointer to the RTDIRENTRY::enmType member or
+ *                          similar.  Will NOT be checked on input.
+ * @param   pObjInfo        The object info buffer to use with RTPathQueryInfo.
+ */
+RTDECL(int) RTDirQueryUnknownTypeEx(const char *pszComposedName, RTDIRENTRYTYPE *penmType, PRTFSOBJINFO pObjInfo);
+
+/**
+ * Checks if the directory entry returned by RTDirRead is '.', '..' or similar.
+ *
+ * @returns true / false.
+ * @param   pDirEntry       The directory entry to check.
+ */
+RTDECL(bool) RTDirEntryIsStdDotLink(PRTDIRENTRY pDirEntry);
+
+/**
+ * Checks if the directory entry returned by RTDirReadEx is '.', '..' or
+ * similar.
+ *
+ * @returns true / false.
+ * @param   pDirEntryEx     The extended directory entry to check.
+ */
+RTDECL(bool) RTDirEntryExIsStdDotLink(PCRTDIRENTRYEX pDirEntryEx);
 
 /**

trunk/include/iprt/mangling.h

@@ -426 +426 @@
 # define RTDirCreateTempSecure                          RT_MANGLER(RTDirCreateTempSecure)
 # define RTDirCreateUniqueNumbered                      RT_MANGLER(RTDirCreateUniqueNumbered)
+# define RTDirEntryIsStdDotLink                         RT_MANGLER(RTDirEntryIsStdDotLink)
+# define RTDirEntryExIsStdDotLink                       RT_MANGLER(RTDirEntryExIsStdDotLink)
 # define RTDirExists                                    RT_MANGLER(RTDirExists)
 # define RTDirFlush                                     RT_MANGLER(RTDirFlush)
@@ -432 +434 @@
 # define RTDirOpenFiltered                              RT_MANGLER(RTDirOpenFiltered)
 # define RTDirQueryInfo                                 RT_MANGLER(RTDirQueryInfo)
+# define RTDirQueryUnknownType                          RT_MANGLER(RTDirQueryUnknownType)
+# define RTDirQueryUnknownTypeEx                        RT_MANGLER(RTDirQueryUnknownTypeEx)
 # define RTDirRead                                      RT_MANGLER(RTDirRead)
 # define RTDirReadEx                                    RT_MANGLER(RTDirReadEx)

trunk/src/VBox/Runtime/r3/dir.cpp

@@ -731 +731 @@
 }
 
+
+RTDECL(int) RTDirQueryUnknownTypeEx(const char *pszComposedName, RTDIRENTRYTYPE *penmType, PRTFSOBJINFO pObjInfo)
+{
+    int rc = RTPathQueryInfoEx(pszComposedName, pObjInfo, RTFSOBJATTRADD_NOTHING, RTPATH_F_ON_LINK);
+    if (RT_FAILURE(rc))
+        return rc;
+
+    if (RTFS_IS_DIRECTORY(pObjInfo->Attr.fMode))
+        *penmType = RTDIRENTRYTYPE_DIRECTORY;
+    else if (RTFS_IS_FILE(pObjInfo->Attr.fMode))
+        *penmType = RTDIRENTRYTYPE_FILE;
+    else if (RTFS_IS_SYMLINK(pObjInfo->Attr.fMode))
+        *penmType = RTDIRENTRYTYPE_SYMLINK;
+    else if (RTFS_IS_FIFO(pObjInfo->Attr.fMode))
+        *penmType = RTDIRENTRYTYPE_FIFO;
+    else if (RTFS_IS_DEV_CHAR(pObjInfo->Attr.fMode))
+        *penmType = RTDIRENTRYTYPE_DEV_CHAR;
+    else if (RTFS_IS_DEV_BLOCK(pObjInfo->Attr.fMode))
+        *penmType = RTDIRENTRYTYPE_DEV_BLOCK;
+    else if (RTFS_IS_SOCKET(pObjInfo->Attr.fMode))
+        *penmType = RTDIRENTRYTYPE_SOCKET;
+    else if (RTFS_IS_WHITEOUT(pObjInfo->Attr.fMode))
+        *penmType = RTDIRENTRYTYPE_WHITEOUT;
+    else
+        *penmType = RTDIRENTRYTYPE_UNKNOWN;
+
+    return VINF_SUCCESS;
+}
+
+
+RTDECL(int) RTDirQueryUnknownType(const char *pszComposedName, RTDIRENTRYTYPE *penmType)
+{
+    if (*penmType != RTDIRENTRYTYPE_UNKNOWN)
+        return VINF_SUCCESS;
+
+    RTFSOBJINFO ObjInfo;
+    return RTDirQueryUnknownTypeEx(pszComposedName, penmType, &ObjInfo);
+}
+
+
+RTDECL(bool) RTDirEntryIsStdDotLink(PRTDIRENTRY pDirEntry)
+{
+    if (pDirEntry->szName[0] != '.')
+        return false;
+    if (pDirEntry->cbName == 1)
+        return true;
+    if (pDirEntry->cbName != 2)
+        return false;
+    return pDirEntry->szName[1] == '.';
+}
+
+
+RTDECL(bool) RTDirEntryExIsStdDotLink(PCRTDIRENTRYEX pDirEntryEx)
+{
+    if (pDirEntryEx->szName[0] != '.')
+        return false;
+    if (pDirEntryEx->cbName == 1)
+        return true;
+    if (pDirEntryEx->cbName != 2)
+        return false;
+    return pDirEntryEx->szName[1] == '.';
+}
+

trunk/src/VBox/Runtime/r3/win/fs-win.cpp

@@ -320 +320 @@
         pProperties->fSupportsUnicode = !!(dwFlags & FILE_UNICODE_ON_DISK);
         pProperties->fCaseSensitive   = false;    /* win32 is case preserving only */
+        /** @todo r=bird: What about FILE_CASE_SENSITIVE_SEARCH ?  Is this set for NTFS
+         *        as well perchance?  If so, better mention it instead of just setting
+         *        fCaseSensitive to false. */
         pProperties->fRemote          = false;    /* no idea yet */
     }