Move DirectoryReader::ReadEntries to FileRef::ReadDirectoryEntries

ppapi/cpp/file_ref.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 PPAPI_CPP_FILE_REF_H_
 #define PPAPI_CPP_FILE_REF_H_
 
 #include "ppapi/c/pp_file_info.h"
 #include "ppapi/c/pp_stdint.h"
 #include "ppapi/c/ppb_file_ref.h"
 #include "ppapi/cpp/resource.h"
 #include "ppapi/cpp/var.h"
 
 /// @file
 /// This file defines the API to create a file reference or "weak pointer" to a
 /// file in a file system.
 
 namespace pp {
 
+class DirectoryEntry;
 class FileSystem;
 class CompletionCallback;
 template <typename T> class CompletionCallbackWithOutput;
 
 /// The <code>FileRef</code> class represents a "weak pointer" to a file in
 /// a file system.
 class FileRef : public Resource {
  public:
   /// Default constructor for creating an is_null() <code>FileRef</code>
   /// object.
@@ skipping 109 matching lines @@
   /// rename a file in the external file system.
   ///
   /// @param[in] new_file_ref A <code>FileRef</code> corresponding to a new
   /// file reference.
   /// @param[in] cc A <code>CompletionCallback</code> to be called upon
   /// completion of Rename().
   ///
   /// @return An int32_t containing an error code from <code>pp_errors.h</code>.
   int32_t Rename(const FileRef& new_file_ref, const CompletionCallback& cc);
 
-  ///
   /// Query() queries info about a file or directory. You must have access to
   /// read this file or directory if it exists in the external filesystem.
   ///
   /// @param[in] callback A <code>CompletionCallbackWithOutput</code>
   /// to be called upon completion of Query().
   ///
   /// @return An int32_t containing an error code from <code>pp_errors.h</code>.
   int32_t Query(const CompletionCallbackWithOutput<PP_FileInfo>& callback);
+
+  /// ReadEntries() Reads all entries in the directory.
+  ///
+  /// @param[in] cc A <code>CompletionCallbackWithOutput</code> to be called
+  /// upon completion of ReadEntries(). On success, the directory entries will
+  /// be passed to the given function.
+  ///
+  /// Normally you would use a CompletionCallbackFactory to allow callbacks to
+  /// be bound to your class. See completion_callback_factory.h for more
+  /// discussion on how to use this. Your callback will generally look like:
+  ///
+  /// @code
+  ///   void OnReadEntries(int32_t result,
+  ///                      const std::vector<DirectoryEntry>& entries) {
+  ///     if (result == PP_OK)
+  ///       // use entries...
+  ///   }
+  /// @endcode
+  ///
+  /// @return An int32_t containing an error code from <code>pp_errors.h</code>.
+  int32_t ReadEntries(
+      const CompletionCallbackWithOutput< std::vector<DirectoryEntry> >&

[palmer, 2013/05/03 00:07:24]

Style nit: No space between < std

[hamaji, 2013/05/03 01:10:34]

Done.

+          callback);
 };
 
 }  // namespace pp
 
 #endif  // PPAPI_CPP_FILE_REF_H_