xref: /external/chromium_org/webkit/browser/fileapi/native_file_util.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 WEBKIT_BROWSER_FILEAPI_NATIVE_FILE_UTIL_H_
#define WEBKIT_BROWSER_FILEAPI_NATIVE_FILE_UTIL_H_

#include "base/files/file_path.h"
#include "base/files/file_util_proxy.h"
#include "base/memory/scoped_ptr.h"
#include "base/platform_file.h"
#include "webkit/browser/fileapi/file_system_file_util.h"
#include "webkit/browser/webkit_storage_browser_export.h"

namespace base {
class Time;
}

namespace fileapi {

// A thin wrapper class for accessing the OS native filesystem.
// This performs common error checks necessary to implement FileUtil family
// in addition to perform native filesystem operations.
//
// For the error checks it performs please see the comment for
// FileSystemFileUtil interface
// (webkit/browser/fileapi/file_system_file_util.h).
//
// Note that all the methods of this class are static and this does NOT
// inherit from FileSystemFileUtil.
class WEBKIT_STORAGE_BROWSER_EXPORT_PRIVATE NativeFileUtil {
 public:
  enum CopyOrMoveMode {
    COPY_NOSYNC,
    COPY_SYNC,
    MOVE
  };
  static CopyOrMoveMode CopyOrMoveModeForDestination(
      const FileSystemURL& dest_url, bool copy);

  static base::PlatformFileError CreateOrOpen(
      const base::FilePath& path,
      int file_flags,
      base::PlatformFile* file_handle,
      bool* created);
  static base::PlatformFileError Close(base::PlatformFile file);
  static base::PlatformFileError EnsureFileExists(const base::FilePath& path,
                                                  bool* created);
  static base::PlatformFileError CreateDirectory(const base::FilePath& path,
                                                 bool exclusive,
                                                 bool recursive);
  static base::PlatformFileError GetFileInfo(const base::FilePath& path,
                                             base::PlatformFileInfo* file_info);
  static scoped_ptr<FileSystemFileUtil::AbstractFileEnumerator>
      CreateFileEnumerator(const base::FilePath& root_path,
                           bool recursive);
  static base::PlatformFileError Touch(const base::FilePath& path,
                                       const base::Time& last_access_time,
                                       const base::Time& last_modified_time);
  static base::PlatformFileError Truncate(const base::FilePath& path,
                                          int64 length);
  static bool PathExists(const base::FilePath& path);
  static bool DirectoryExists(const base::FilePath& path);
  static base::PlatformFileError CopyOrMoveFile(
      const base::FilePath& src_path,
      const base::FilePath& dest_path,
      FileSystemOperation::CopyOrMoveOption option,
      CopyOrMoveMode mode);
  static base::PlatformFileError DeleteFile(const base::FilePath& path);
  static base::PlatformFileError DeleteDirectory(const base::FilePath& path);

 private:
  DISALLOW_IMPLICIT_CONSTRUCTORS(NativeFileUtil);
};

}  // namespace fileapi

#endif  // WEBKIT_BROWSER_FILEAPI_NATIVE_FILE_UTIL_H_