gdata: Add GDataFileSystem::ReadDirectoryByPathAsync()

chrome/browser/chromeos/gdata/gdata_file_system.h

 // Copyright (c) 2012 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 CHROME_BROWSER_CHROMEOS_GDATA_GDATA_FILE_SYSTEM_H_
 #define CHROME_BROWSER_CHROMEOS_GDATA_GDATA_FILE_SYSTEM_H_
 #pragma once
 
 #include <sys/stat.h>
 
@@ skipping 57 matching lines @@
                             const std::string& mime_type,
                             GDataFileType file_type)>
     GetFileCallback;
 
 // Used to get file info from the file system.
 // If |error| is not PLATFORM_FILE_OK, |file_info| is set to NULL.
 typedef base::Callback<void(base::PlatformFileError error,
                             scoped_ptr<GDataFileProto> file_proto)>
     GetFileInfoCallback;
 
+// Used to read a directory from the file system.
+// If |error| is not PLATFORM_FILE_OK, |file_info| is set to NULL.
+typedef base::Callback<void(base::PlatformFileError error,
+                            scoped_ptr<GDataDirectoryProto> directory_proto)>
+    ReadDirectoryCallback;
+
 // Callback for SetMountedState.
 typedef base::Callback<void(base::PlatformFileError error,
                             const FilePath& file_path)>
     SetMountedStateCallback;
 
 // Used for file operations like removing files.
 typedef base::Callback<void(base::PlatformFileError error,
                             base::ListValue* feed_list)>
     GetJsonDocumentCallback;
 
@@ skipping 218 matching lines @@
   // Gets the cache state of file corresponding to |resource_id| and |md5| if it
   // exists on disk.
   // Initializes cache if it has not been initialized.
   // Upon completion, |callback| is invoked on the thread where this method was
   // called with the cache state if file exists in cache or CACHE_STATE_NONE
   // otherwise.
   virtual void GetCacheState(const std::string& resource_id,
                              const std::string& md5,
                              const GetCacheStateCallback& callback) = 0;
 
-  // Finds a file (not a directory) by |file_path| and returns its key
-  // |properties|.  Returns true if file was found.
+  // Finds a file (not a directory) by |file_path|. This call will also
+  // retrieve and refresh file system content from server and disk cache.
+  //
+  // Can be called from UI/IO thread. |callback| is run on the calling thread.
   virtual void GetFileInfoByPathAsync(const FilePath& file_path,
                                       const GetFileInfoCallback& callback) = 0;
 
+  // Finds and reads a directory by |file_path|. This call will also retrieve
+  // and refresh file system content from server and disk cache.
+  //
+  // Can be called from UI/IO thread. |callback| is run on the calling thread.
+  virtual void ReadDirectoryByPathAsync(
+      const FilePath& file_path,
+      const ReadDirectoryCallback& callback) = 0;
+
   // Finds a file (not a directory) by |file_path| and returns its key
   // |properties|.  Returns true if file was found.
   // TODO(satorux): Remove this: crosbug.com/30066.
   virtual bool GetFileInfoByPath(const FilePath& file_path,
                                  GDataFileProperties* properties) = 0;
 
   // Returns true if the given path is under gdata cache directory, i.e.
   // <user_profile_dir>/GCache/v1
   virtual bool IsUnderGDataCacheDirectory(const FilePath& path) const = 0;
 
@@ skipping 75 matching lines @@
       const std::string& resource_id,
       const GetFileCallback& get_file_callback,
       const GetDownloadDataCallback& get_download_data_callback) OVERRIDE;
   virtual GDataOperationRegistry* GetOperationRegistry() OVERRIDE;
   virtual void GetCacheState(const std::string& resource_id,
                              const std::string& md5,
                              const GetCacheStateCallback& callback) OVERRIDE;
   virtual void GetFileInfoByPathAsync(
       const FilePath& file_path,
       const GetFileInfoCallback& callback) OVERRIDE;
+  virtual void ReadDirectoryByPathAsync(
+      const FilePath& file_path,
+      const ReadDirectoryCallback& callback) OVERRIDE;
   virtual bool GetFileInfoByPath(const FilePath& file_path,
                                  GDataFileProperties* properties) OVERRIDE;
   virtual bool IsUnderGDataCacheDirectory(const FilePath& path) const OVERRIDE;
   virtual FilePath GetCacheDirectoryPath(
       GDataRootDirectory::CacheSubDirectoryType sub_dir_type) const OVERRIDE;
   virtual FilePath GetCacheFilePath(
       const std::string& resource_id,
       const std::string& md5,
       GDataRootDirectory::CacheSubDirectoryType sub_dir_type,
       CachedFileOrigin file_orign) const OVERRIDE;
@@ skipping 778 matching lines @@
                               base::PlatformFileError error,
                               const std::string& resource_id,
                               const std::string& md5);
 
   // Changes state of hosted documents visibility, triggers directory refresh.
   void SetHideHostedDocuments(bool hide);
 
   // Initializes preference change observer.
   void InitializePreferenceObserver();
 
-  // Called when an entry is found for GetFileInfoByPath().
-  void OnEntryFound(const GetFileInfoCallback& callback,
-                    base::PlatformFileError error,
-                    const FilePath& directory_path,
-                    GDataEntry* entry);
+  // Called when an entry is found for GetFileInfoByPathAsync().
+  void OnGetFileInfo(const GetFileInfoCallback& callback,
+                     base::PlatformFileError error,
+                     const FilePath& directory_path,
+                     GDataEntry* entry);
+
+  // Called when an entry is found for ReadDirectoryByPathAsync().
+  void OnReadDirectory(const ReadDirectoryCallback& callback,
+                       base::PlatformFileError error,
+                       const FilePath& directory_path,
+                       GDataEntry* entry);
 
   // The following functions are used to forward calls to asynchronous public
   // member functions to UI thread.
   void FindEntryByPathAsyncOnUIThread(const FilePath& search_file_path,
                                       const FindEntryCallback& callback);
   void CopyOnUIThread(const FilePath& src_file_path,
                       const FilePath& dest_file_path,
                       const FileOperationCallback& callback);
   void MoveOnUIThread(const FilePath& src_file_path,
                       const FilePath& dest_file_path,
                       const FileOperationCallback& callback);
   void RemoveOnUIThread(const FilePath& file_path,
                         bool is_recursive,
                         const FileOperationCallback& callback);
   void CreateDirectoryOnUIThread(const FilePath& directory_path,
                                  bool is_exclusive,
                                  bool is_recursive,
                                  const FileOperationCallback& callback);
   void GetFileByPathOnUIThread(
       const FilePath& file_path,
       const GetFileCallback& get_file_callback,
       const GetDownloadDataCallback& get_download_data_callback);
   void GetFileByResourceIdOnUIThread(
       const std::string& resource_id,
       const GetFileCallback& get_file_callback,
       const GetDownloadDataCallback& get_download_data_callback);
   void GetFileInfoByPathAsyncOnUIThread(
       const FilePath& file_path,
       const GetFileInfoCallback& callback);
+  void ReadDirectoryByPathAsyncOnUIThread(
+      const FilePath& file_path,
+      const ReadDirectoryCallback& callback);
   void GetCacheStateOnUIThread(const std::string& resource_id,
                                const std::string& md5,
                                const GetCacheStateCallback& callback);
   void GetAvailableSpaceOnUIThread(const GetAvailableSpaceCallback& callback);
   void SetPinStateOnUIThread(const FilePath& file_path, bool to_pin,
                              const FileOperationCallback& callback);
   void SetMountedStateOnUIThread(
       const FilePath& file_path,
       bool to_mount,
       const SetMountedStateCallback& callback);
@@ skipping 59 matching lines @@
 };
 
 // Sets the free disk space getter for testing.
 // The existing getter is deleted.
 void SetFreeDiskSpaceGetterForTesting(
     FreeDiskSpaceGetterInterface* getter);
 
 }  // namespace gdata
 
 #endif  // CHROME_BROWSER_CHROMEOS_GDATA_GDATA_FILE_SYSTEM_H_