Changeset 31623 in vbox for trunk/include/iprt

Timestamp:

Aug 13, 2010 12:24:14 AM (14 years ago)

Author:

vboxsync

Message:

Runtime: add progress callback support to the tar backend

File:

• trunk/include/iprt/tar.h (modified) (4 diffs)

trunk/include/iprt/tar.h

@@ -4 +4 @@
 
 /*
- * Copyright (C) 2009 Oracle Corporation
+ * Copyright (C) 2009-2010 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -76 +76 @@
  * (The matching is case sensitive.)
  *
- * @note    Currently only regular files are supported. Also some of the heade
+ * @note    Currently only regular files are supported. Also some of the header
  *          fields are not used (uid, gid, uname, gname, mtime).
  *
  * @returns iprt status code.
  *
- * @param   pszTarFile      Tar file to extract files from.
- * @param   pszOutputDir    Where to store the extracted files. Must exist.
- * @param   papszFiles      Which files should be extracted.
- * @param   cFiles          The number of files in papszFiles.
+ * @param   pszTarFile           Tar file to extract files from.
+ * @param   pszOutputDir         Where to store the extracted files. Must exist.
+ * @param   papszFiles           Which files should be extracted.
+ * @param   cFiles               The number of files in papszFiles.
+ * @param   pfnProgressCallback  Progress callback function. Optional.
+ * @param   pvUser               User defined data for the progress
+ *                               callback. Optional.
  */
-RTR3DECL(int) RTTarExtractFiles(const char *pszTarFile, const char *pszOutputDir, const char * const *papszFiles, size_t cFiles);
+RTR3DECL(int) RTTarExtractFiles(const char *pszTarFile, const char *pszOutputDir, const char * const *papszFiles, size_t cFiles, PFNRTPROGRESS pfnProgressCallback, void *pvUser);
 
 /**
@@ -97 +100 @@
  * @retval  VERR_FILE_NOT_FOUND when the index isn't valid.
  *
- * @param   pszTarFile      Tar file to extract the file from.
- * @param   pszOutputDir    Where to store the extracted file. Must exist.
- * @param   iIndex          Which file should be extracted, 0 based.
- * @param   ppszFileName    On success the filename of the extracted file. Must
- *                          be freed with RTStrFree.
+ * @param   pszTarFile           Tar file to extract the file from.
+ * @param   pszOutputDir         Where to store the extracted file. Must exist.
+ * @param   iIndex               Which file should be extracted, 0 based.
+ * @param   ppszFileName         On success the filename of the extracted file. Must
+ *                               be freed with RTStrFree.
+ * @param   pfnProgressCallback  Progress callback function. Optional.
+ * @param   pvUser               User defined data for the progress
+ *                               callback. Optional.
  */
-RTR3DECL(int) RTTarExtractByIndex(const char *pszTarFile, const char *pszOutputDir, size_t iIndex, char **ppszFileName);
+RTR3DECL(int) RTTarExtractByIndex(const char *pszTarFile, const char *pszOutputDir, size_t iIndex, char **ppszFileName, PFNRTPROGRESS pfnProgressCallback, void *pvUser);
+
+/**
+ * Extract all files of the archive.
+ *
+ * @note    Currently only regular files are supported. Also some of the header
+ *          fields are not used (uid, gid, uname, gname, mtime).
+ *
+ * @returns iprt status code.
+ *
+ * @param   pszTarFile           Tar file to extract the files from.
+ * @param   pszOutputDir         Where to store the extracted files. Must exist.
+ * @param   pfnProgressCallback  Progress callback function. Optional.
+ * @param   pvUser               User defined data for the progress
+ *                               callback. Optional.
+ */
+RTR3DECL(int) RTTarExtractAll(const char *pszTarFile, const char *pszOutputDir, PFNRTPROGRESS pfnProgressCallback, void *pvUser);
 
 /**
@@ -112 +134 @@
  * @returns iprt status code.
  *
- * @param   pszTarFile      Where to create the Tar archive.
- * @param   papszFiles      Which files should be included.
- * @param   cFiles          The number of files in papszFiles.
+ * @param   pszTarFile           Where to create the Tar archive.
+ * @param   papszFiles           Which files should be included.
+ * @param   cFiles               The number of files in papszFiles.
+ * @param   pfnProgressCallback  Progress callback function. Optional.
+ * @param   pvUser               User defined data for the progress
+ *                               callback. Optional.
  */
-RTR3DECL(int) RTTarCreate(const char *pszTarFile, const char * const *papszFiles, size_t cFiles);
+RTR3DECL(int) RTTarCreate(const char *pszTarFile, const char * const *papszFiles, size_t cFiles, PFNRTPROGRESS pfnProgressCallback, void *pvUser);
 
 /** @} */