WebKit/chromium/public/WebFileUtilities.h

   1 /*
   2  * Copyright (C) 2010 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef WebFileUtilities_h
  32 #define WebFileUtilities_h
  33
  34 #include "WebCommon.h"
  35 #include "WebString.h"
  36 #include "WebURL.h"
  37
  38 #ifdef WIN32
  39 typedef void *HANDLE;
  40 #endif
  41
  42 namespace WebKit {
  43
  44 class WebFileUtilities {
  45 public:
  46 #ifdef WIN32
  47     typedef HANDLE FileHandle;
  48 #else
  49     typedef int FileHandle;
  50 #endif
  51     virtual void revealFolderInOS(const WebString& path) { }
  52     virtual bool fileExists(const WebString& path) { return false; }
  53     virtual bool deleteFile(const WebString& path) { return false; }
  54     virtual bool deleteEmptyDirectory(const WebString& path) { return false; }
  55     virtual bool getFileSize(const WebString& path, long long& result) { return false; }
  56     virtual bool getFileModificationTime(const WebString& path, double& result) { return false; }
  57     virtual WebString directoryName(const WebString& path)  { return WebString(); }
  58     virtual WebString pathByAppendingComponent(const WebString& path, const WebString& component)  { return WebString(); }
  59     virtual bool makeAllDirectories(const WebString& path) { return false; }
  60     virtual WebString getAbsolutePath(const WebString& path)  { return WebString(); }
  61     virtual bool isDirectory(const WebString& path) { return false; }
  62     virtual WebURL filePathToURL(const WebString& path)  { return WebURL(); }
  63     virtual FileHandle openFile(const WebString& path, int mode)  { return FileHandle(); }
  64     // Should set the FileHandle to a invalid value if the file is closed successfully.
  65     virtual void closeFile(FileHandle&) { }
  66     virtual long long seekFile(FileHandle, long long offset, int origin) { return 0; }
  67     virtual bool truncateFile(FileHandle, long long offset) { return false; }
  68     virtual int readFromFile(FileHandle, char* data, int length) { return 0; }
  69     virtual int writeToFile(FileHandle, const char* data, int length) { return 0; }
  70
  71 protected:
  72     ~WebFileUtilities() {}
  73 };
  74
  75 } // namespace WebKit
  76
  77 #endif