Home | History | Annotate | Download | only in base
      1 /*
      2  * libjingle
      3  * Copyright 2004--2006, Google Inc.
      4  *
      5  * Redistribution and use in source and binary forms, with or without
      6  * modification, are permitted provided that the following conditions are met:
      7  *
      8  *  1. Redistributions of source code must retain the above copyright notice,
      9  *     this list of conditions and the following disclaimer.
     10  *  2. Redistributions in binary form must reproduce the above copyright notice,
     11  *     this list of conditions and the following disclaimer in the documentation
     12  *     and/or other materials provided with the distribution.
     13  *  3. The name of the author may not be used to endorse or promote products
     14  *     derived from this software without specific prior written permission.
     15  *
     16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
     17  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
     18  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
     19  * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     20  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
     21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
     22  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
     23  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
     24  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
     25  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     26  */
     27 
     28 #ifndef _TALK_BASE_WIN32FILESYSTEM_H__
     29 #define _TALK_BASE_WIN32FILESYSTEM_H__
     30 
     31 #include "fileutils.h"
     32 
     33 namespace talk_base {
     34 
     35 class Win32Filesystem : public FilesystemInterface {
     36  public:
     37   // Opens a file. Returns an open StreamInterface if function succeeds. Otherwise,
     38   // returns NULL.
     39   virtual FileStream *OpenFile(const Pathname &filename,
     40                                const std::string &mode);
     41 
     42   // Atomically creates an empty file accessible only to the current user if one
     43   // does not already exist at the given path, otherwise fails.
     44   virtual bool CreatePrivateFile(const Pathname &filename);
     45 
     46   // This will attempt to delete the path located at filename.
     47   // If the path points to a folder, it will fail with VERIFY
     48   virtual bool DeleteFile(const Pathname &filename);
     49 
     50   // This will attempt to delete an empty folder. If the path does not point to
     51   // a folder, it fails with VERIFY. If the folder is not empty, it fails normally
     52   virtual bool DeleteEmptyFolder(const Pathname &folder);
     53 
     54   // Creates a directory. This will call itself recursively to create /foo/bar even if
     55   // /foo does not exist.
     56   // Returns TRUE if function succeeds
     57   virtual bool CreateFolder(const Pathname &pathname);
     58 
     59   // This moves a file from old_path to new_path. If the new path is on a
     60   // different volume than the old, it will attempt to copy and then delete
     61   // the folder
     62   // Returns true if the file is successfully moved
     63   virtual bool MoveFile(const Pathname &old_path, const Pathname &new_path);
     64 
     65   // Moves a folder from old_path to new_path. If the new path is on a different
     66   // volume from the old, it will attempt to Copy and then Delete the folder
     67   // Returns true if the folder is successfully moved
     68   virtual bool MoveFolder(const Pathname &old_path, const Pathname &new_path);
     69 
     70   // This copies a file from old_path to _new_path
     71   // Returns true if function succeeds
     72   virtual bool CopyFile(const Pathname &old_path, const Pathname &new_path);
     73 
     74   // Returns true if a pathname is a directory
     75   virtual bool IsFolder(const Pathname& pathname);
     76 
     77   // Returns true if a file exists at path
     78   virtual bool IsFile(const Pathname &path);
     79 
     80   // Returns true if pathname refers to no filesystem object, every parent
     81   // directory either exists, or is also absent.
     82   virtual bool IsAbsent(const Pathname& pathname);
     83 
     84   // Returns true if pathname represents a temporary location on the system.
     85   virtual bool IsTemporaryPath(const Pathname& pathname);
     86 
     87   // All of the following functions set pathname and return true if successful.
     88   // Returned paths always include a trailing backslash.
     89   // If create is true, the path will be recursively created.
     90   // If append is non-NULL, it will be appended (and possibly created).
     91 
     92   virtual std::string TempFilename(const Pathname &dir, const std::string &prefix);
     93 
     94   virtual bool GetFileSize(const Pathname& path, size_t* size);
     95   virtual bool GetFileTime(const Pathname& path, FileTimeType which,
     96                            time_t* time);
     97 
     98   // A folder appropriate for storing temporary files (Contents are
     99   // automatically deleted when the program exists)
    100   virtual bool GetTemporaryFolder(Pathname &path, bool create,
    101                                  const std::string *append);
    102 
    103   // Returns the path to the running application.
    104   virtual bool GetAppPathname(Pathname* path);
    105 
    106   virtual bool GetAppDataFolder(Pathname* path, bool per_user);
    107 
    108   // Get a temporary folder that is unique to the current user and application.
    109   virtual bool GetAppTempFolder(Pathname* path);
    110 
    111   virtual bool GetDiskFreeSpace(const Pathname& path, int64 *freebytes);
    112 
    113   virtual Pathname GetCurrentDirectory();
    114 };
    115 
    116 }  // namespace talk_base
    117 
    118 #endif  // _WIN32FILESYSTEM_H__
    119