Adds asynchronous unzip functions to ZipReader

third_party/zlib/google/zip_reader.h

 // Copyright (c) 2011 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
-
 #ifndef THIRD_PARTY_ZLIB_GOOGLE_ZIP_READER_H_
 #define THIRD_PARTY_ZLIB_GOOGLE_ZIP_READER_H_
 
 #include <string>
 
 #include "base/basictypes.h"
 #include "base/file_util.h"
 #include "base/files/file_path.h"
 #include "base/memory/scoped_ptr.h"
+#include "base/memory/weak_ptr.h"
 #include "base/platform_file.h"
 #include "base/time/time.h"
 
 #if defined(USE_SYSTEM_MINIZIP)
 #include <minizip/unzip.h>
 #else
 #include "third_party/zlib/contrib/minizip/unzip.h"
 #endif
 
 namespace zip {
@@ skipping 99 matching lines @@
   bool LocateAndOpenEntry(const base::FilePath& path_in_zip);
 
   // Extracts the current entry to the given output file path. If the
   // current file is a directory, just creates a directory
   // instead. Returns true on success. OpenCurrentEntryInZip() must be
   // called beforehand.
   //
   // This function does not preserve the timestamp of the original entry.
   bool ExtractCurrentEntryToFilePath(const base::FilePath& output_file_path);
 
+  // Asynchronously extracts the current entry to the given output file path.
+  // If the current entry is a directory it just creates the directory
+  // synchronously instead.  OpenCurrentEntryInZip() must be called beforehand.

[satorux1, 2013/12/11 06:45:11]

Please document callback parameters.

[Drew Haven, 2013/12/11 18:20:53]

I ended up with split documentation between the typedefs and the function.  I
think it's a logical split, but please advise if you disagree.

+  void ExtractCurrentEntryToFilePathAsync(
+      const base::FilePath& output_file_path,
+      base::Closure success_callback,
+      base::Closure failure_Callback,

[satorux1, 2013/12/11 06:45:11]

failure_callback

[Drew Haven, 2013/12/11 18:20:53]

Done.

+      base::Callback<void(int64)> progress_callback);

[satorux1, 2013/12/11 06:45:11]

Let's typedef this:

typedef base::Callback<void(int64 progress)> ProgressCallback;

Please document about progress.

[Drew Haven, 2013/12/11 18:20:53]

Done.

+
   // Extracts the current entry to the given output directory path using
   // ExtractCurrentEntryToFilePath(). Sub directories are created as needed
   // based on the file path of the current entry. For example, if the file
   // path in zip is "foo/bar.txt", and the output directory is "output",
   // "output/foo/bar.txt" will be created.
   //
   // Returns true on success. OpenCurrentEntryInZip() must be called
   // beforehand.
   bool ExtractCurrentEntryIntoDirectory(
       const base::FilePath& output_directory_path);
@@ skipping 14 matching lines @@
   // Open() must be called beforehand.
   int num_entries() const { return num_entries_; }
 
  private:
   // Common code used both in Open and OpenFromFd.
   bool OpenInternal();
 
   // Resets the internal state.
   void Reset();
 
+  // Unzip loop for asynchronous code.

[satorux1, 2013/12/11 06:45:11]

Function comments should usually start from a verb like "Iterates".

[Drew Haven, 2013/12/11 18:20:53]

Done.

+  void ExtractChunk(base::PlatformFile target_file,
+                    base::Closure success_callback,
+                    base::Closure failure_callback,
+                    base::Callback<void(int64)> progress_callback,
+                    const int64 offset);
+
   unzFile zip_file_;
   int num_entries_;
   bool reached_end_;
   scoped_ptr<EntryInfo> current_entry_info_;
 
+  base::WeakPtrFactory<ZipReader> weak_factory_;

[satorux1, 2013/12/11 06:45:11]

nit: weak_ptr_factory_ 

[Drew Haven, 2013/12/11 18:20:53]

I thought that was weird too.  But it happens to be a convention in our code:

https://code.google.com/p/chromium/codesearch#search/&sq=package:chromium&typ...

Anyway, changed because I like your version better too.

+
   DISALLOW_COPY_AND_ASSIGN(ZipReader);
 };
 
 }  // namespace zip
 
 #endif  // THIRD_PARTY_ZLIB_GOOGLE_ZIP_READER_H_