Changeset 67186 in vbox for trunk/include

Timestamp:

Jun 1, 2017 6:39:08 AM (8 years ago)

Author:

vboxsync

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

115863

Message:

IPRT: Added RTVfsFsStrmToNormalDir, RTVfsFsStrmToDirUndo, RTVfsDirOpenFileAsIoStream, and RTVfsFsStreamToPrivate.

Location:

trunk/include/iprt

Files:

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

trunk/include/iprt/mangling.h

@@ -2311 +2311 @@
 # define RTVfsDirOpenDir                                RT_MANGLER(RTVfsDirOpenDir)
 # define RTVfsDirOpenFile                               RT_MANGLER(RTVfsDirOpenFile)
+# define RTVfsDirOpenFileAsIoStream                     RT_MANGLER(RTVfsDirOpenFileAsIoStream)
 # define RTVfsDirQueryPathInfo                          RT_MANGLER(RTVfsDirQueryPathInfo)
 # define RTVfsDirReadEx                                 RT_MANGLER(RTVfsDirReadEx)
@@ -2333 +2334 @@
 # define RTVfsFileWrite                                 RT_MANGLER(RTVfsFileWrite)
 # define RTVfsFileWriteAt                               RT_MANGLER(RTVfsFileWriteAt)
+# define RTVfsFsStreamToPrivate                         RT_MANGLER(RTVfsFsStreamToPrivate)
 # define RTVfsFsStrmAdd                                 RT_MANGLER(RTVfsFsStrmAdd)
 # define RTVfsFsStrmEnd                                 RT_MANGLER(RTVfsFsStrmEnd)
@@ -2341 +2343 @@
 # define RTVfsFsStrmRetain                              RT_MANGLER(RTVfsFsStrmRetain)
 # define RTVfsFsStrmRetainDebug                         RT_MANGLER(RTVfsFsStrmRetainDebug)
+# define RTVfsFsStrmToDir                               RT_MANGLER(RTVfsFsStrmToDir)
+# define RTVfsFsStrmToNormalDir                         RT_MANGLER(RTVfsFsStrmToNormalDir)
+# define RTVfsFsStrmToDirUndo                           RT_MANGLER(RTVfsFsStrmToDirUndo)
 # define RTVfsIoStreamToPrivate                         RT_MANGLER(RTVfsIoStreamToPrivate)
 # define RTVfsIoStrmFlush                               RT_MANGLER(RTVfsIoStrmFlush)

trunk/include/iprt/vfs.h

@@ -448 +448 @@
  * @param   fOpen           RTFILE_O_XXX flags.
  * @param   phVfsFile       Where to return the file.
+ * @sa      RTVfsDirOpenFileAsIoStream
  */
 RTDECL(int) RTVfsDirOpenFile(RTVFSDIR hVfsDir, const char *pszPath, uint64_t fOpen, PRTVFSFILE phVfsFile);
+
+/**
+ * Convenience wrapper around RTVfsDirOpenFile that returns an I/O stream.
+ *
+ * @returns IPRT status code.
+ * @param   hVfsDir         The VFS directory start walking the @a pszPath
+ *                          relative to.
+ * @param   pszPath         Path to the file.
+ * @param   fOpen           RTFILE_O_XXX flags.
+ * @param   phVfsIos        Where to return the I/O stream handle of the file.
+ * @sa      RTVfsDirOpenFile
+ */
+RTDECL(int) RTVfsDirOpenFileAsIoStream(RTVFSDIR hVfsDir, const char *pszPath, uint64_t fOpen, PRTVFSIOSTREAM phVfsIos);
 
 /**
@@ -1315 +1329 @@
                                         PRTVFSFILE phVfsFile);
 
+
+/**
+ * Create a file system stream for writing to a directory.
+ *
+ * This is just supposed to be a drop in replacement for the TAR creator stream
+ * that instead puts the files and stuff in a directory instead of a TAR
+ * archive.  In addition, it has an undo feature for simplying cleaning up after
+ * a botched run
+ *
+ * @returns IPRT status code.
+ * @param   hVfsBaseDir The base directory.
+ * @param   fFlags      RTVFSFSS2DIR_F_XXX
+ * @param   phVfsFss    Where to return the FSS handle.
+ * @sa      RTVfsFsStrmToNormalDir, RTVfsFsStrmToDirUndo
+ */
+RTDECL(int) RTVfsFsStrmToDir(RTVFSDIR hVfsBaseDir, uint32_t fFlags, PRTVFSFSSTREAM phVfsFss);
+
+/**
+ * Create a file system stream for writing to a normal directory.
+ *
+ * This is just supposed to be a drop in replacement for the TAR creator stream
+ * that instead puts the files and stuff in a directory instead of a TAR
+ * archive.  In addition, it has an undo feature for simplying cleaning up after
+ * a botched run
+ *
+ * @returns IPRT status code.
+ * @param   pszBaseDir  The base directory.  Must exist.
+ * @param   fFlags      RTVFSFSS2DIR_F_XXX
+ * @param   phVfsFss    Where to return the FSS handle.
+ * @sa      RTVfsFsStrmToDir, RTVfsFsStrmToDirUndo
+ */
+RTDECL(int) RTVfsFsStrmToNormalDir(const char *pszBaseDir, uint32_t fFlags, PRTVFSFSSTREAM phVfsFss);
+
+/** @name RTVFSFSS2DIR_F_XXX - Flags for RTVfsFsStrmToNormalDir
+ * @{ */
+/** Overwrite existing files (default is to not overwrite anything). */
+#define RTVFSFSS2DIR_F_OVERWRITE_FILES      RT_BIT_32(0)
+/** Valid bits.   */
+#define RTVFSFSS2DIR_F_VALID_MASK           UINT32_C(0x00000001)
+/** @} */
+
+/**
+ * Deletes files, directories, symlinks and stuff created by a FSS returned by
+ * RTVfsFsStrmToNormalDir or RTVfsFsStrmToDir.
+ *
+ * @returns IPRT status code.
+ * @param   hVfsFss     The write-to-directory FSS handle.
+ */
+RTDECL(int) RTVfsFsStrmToDirUndo(RTVFSFSSTREAM hVfsFss);
+
+
+
 /** @}  */
 

trunk/include/iprt/vfslowlevel.h

@@ -490 +490 @@
 RTDECL(int) RTVfsNewFsStream(PCRTVFSFSSTREAMOPS pFsStreamOps, size_t cbInstance, RTVFS hVfs, RTVFSLOCK hLock, bool fReadOnly,
                              PRTVFSFSSTREAM phVfsFss, void **ppvInstance);
+
+/**
+ * Gets the private data of an filesystem stream.
+ *
+ * @returns Pointer to the private data.  NULL if the handle is invalid in some
+ *          way.
+ * @param   hVfsFss             The FS stream handle.
+ * @param   pFsStreamOps        The FS stream operations.  This servers as a
+ *                              sort of password.
+ */
+RTDECL(void *) RTVfsFsStreamToPrivate(RTVFSFSSTREAM hVfsFss, PCRTVFSFSSTREAMOPS pFsStreamOps);