Moving away from shell api to support long path names on windows for filesystem.

base/file_util.h

 // Copyright (c) 2010 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.
 
 // This file contains utility functions for dealing with the local
 // filesystem.
 
 #ifndef BASE_FILE_UTIL_H_
 #define BASE_FILE_UTIL_H_
 #pragma once
@@ skipping 82 matching lines @@
                        const FilePath::StringType& pattern);
 
 // Deletes the given path, whether it's a file or a directory.
 // If it's a directory, it's perfectly happy to delete all of the
 // directory's contents.  Passing true to recursive deletes
 // subdirectories and their contents as well.
 // Returns true if successful, false otherwise.
 //
 // WARNING: USING THIS WITH recursive==true IS EQUIVALENT
 //          TO "rm -rf", SO USE WITH CAUTION.
+// Safe to pass extended-path to this method on Windows.

[Erik does not do reviews, 2010/12/23 17:57:27]

It seems better to mark all of the ones that are unsafe and add a TODO / bug #
to all of those so that they can be fixed.

 bool Delete(const FilePath& path, bool recursive);
 
 #if defined(OS_WIN)
 // Schedules to delete the given path, whether it's a file or a directory, until
 // the operating system is restarted.
 // Note:
 // 1) The file/directory to be deleted should exist in a temp folder.
 // 2) The directory to be deleted must be empty.
 bool DeleteAfterReboot(const FilePath& path);
 #endif
 
 // Moves the given path, whether it's a file or a directory.
 // If a simple rename is not possible, such as in the case where the paths are
 // on different volumes, this will attempt to copy and delete. Returns
 // true for success.
+// Safe to pass extended paths on Windows.
 bool Move(const FilePath& from_path, const FilePath& to_path);
 
 // Renames file |from_path| to |to_path|. Both paths must be on the same
 // volume, or the function will fail. Destination file will be created
 // if it doesn't exist. Prefer this function over Move when dealing with
 // temporary files. On Windows it preserves attributes of the target file.
 // Returns true on success.
 bool ReplaceFile(const FilePath& from_path, const FilePath& to_path);
 
 // Copies a single file. Use CopyDirectory to copy directories.
+// Safe to pass extended-path to this method on Windows.
 bool CopyFile(const FilePath& from_path, const FilePath& to_path);
 
 // Copies the given path, and optionally all subdirectories and their contents
 // as well.
 // If there are files existing under to_path, always overwrite.
 // Returns true if successful, false otherwise.
 // Don't use wildcards on the names, it may stop working without notice.
 //
 // If you only need to copy a file use CopyFile, it's faster.
+// Safe to pass extended-path to this method on Windows.
 bool CopyDirectory(const FilePath& from_path, const FilePath& to_path,
                    bool recursive);
 
 // Returns true if the given path exists on the local filesystem,
 // false otherwise.
+// Safe to use extended path on Windows.
 bool PathExists(const FilePath& path);
 
 // Returns true if the given path is writable by the user, false otherwise.
 bool PathIsWritable(const FilePath& path);
 
 // Returns true if the given path exists and is a directory, false otherwise.
+// Safe to use extended path on Windows.
 bool DirectoryExists(const FilePath& path);
 
 #if defined(OS_WIN)
 // Gets the creation time of the given file (expressed in the local timezone),
 // and returns it via the creation_time parameter.  Returns true if successful,
 // false otherwise.
 bool GetFileCreationLocalTime(const std::wstring& filename,
                               LPSYSTEMTIME creation_time);
 
 // Same as above, but takes a previously-opened file handle instead of a name.
@@ skipping 73 matching lines @@
 bool TaskbarUnpinShortcutLink(const wchar_t* shortcut);
 
 // Copy from_path to to_path recursively and then delete from_path recursively.
 // Returns true if all operations succeed.
 // This function simulates Move(), but unlike Move() it works across volumes.
 // This fuction is not transactional.
 bool CopyAndDeleteDirectory(const FilePath& from_path,
                             const FilePath& to_path);
 #endif  // defined(OS_WIN)
 
-// Return true if the given directory is empty
+// Return true if the given directory is empty.
+// Safe to pass extended-path to this method on Windows.
 bool IsDirectoryEmpty(const FilePath& dir_path);
 
 // Get the temporary directory provided by the system.
 // WARNING: DON'T USE THIS. If you want to create a temporary file, use one of
 // the functions below.
 bool GetTempDir(FilePath* path);
 // Get a temporary directory for shared memory files.
 // Only useful on POSIX; redirects to GetTempDir() on Windows.
 bool GetShmemTempDir(FilePath* path);
 
@@ skipping 28 matching lines @@
 // Create a directory within another directory.
 // Extra characters will be appended to |prefix| to ensure that the
 // new directory does not have the same name as an existing directory.
 bool CreateTemporaryDirInDir(const FilePath& base_dir,
                              const FilePath::StringType& prefix,
                              FilePath* new_dir);
 
 // Creates a directory, as well as creating any parent directories, if they
 // don't exist. Returns 'true' on successful creation, or if the directory
 // already exists.  The directory is only readable by the current user.
+// Safe to pass extended path on Windows.
 bool CreateDirectory(const FilePath& full_path);
 
 // Returns the file size. Returns true on success.
 bool GetFileSize(const FilePath& file_path, int64* file_size);
 
 // Returns true if the given path's base name is ".".
 bool IsDot(const FilePath& path);
 
 // Returns true if the given path's base name is "..".
 bool IsDotDot(const FilePath& path);
 
 // Sets |real_path| to |path| with symbolic links and junctions expanded.
 // On windows, make sure the path starts with a lettered drive.
 // |path| must reference a file.  Function will fail if |path| points to
 // a directory or to a nonexistent path.  On windows, this function will
 // fail if |path| is a junction or symlink that points to an empty file,
 // or if |real_path| would be longer than MAX_PATH characters.
 bool NormalizeFilePath(const FilePath& path, FilePath* real_path);
 
 #if defined(OS_WIN)
 // Given an existing file in |path|, it returns in |real_path| the path
 // in the native NT format, of the form "\Device\HarddiskVolumeXX\..".
 // Returns false it it fails. Empty files cannot be resolved with this
 // function.
 bool NormalizeToNativeFilePath(const FilePath& path, FilePath* nt_path);
 #endif
 
 // Returns information about the given file path.
+// Safe to use extended path on Windows.
 bool GetFileInfo(const FilePath& file_path, base::PlatformFileInfo* info);
 
 // Sets the time of the last access and the time of the last modification.
 bool TouchFile(const FilePath& path,
                const base::Time& last_accessed,
                const base::Time& last_modified);
 
 // Set the time of the last modification. Useful for unit tests.
 bool SetLastModifiedTime(const FilePath& path,
                          const base::Time& last_modified);
@@ skipping 296 matching lines @@
 bool GetFileSystemType(const FilePath& path, FileSystemType* type);
 #endif
 
 }  // namespace file_util
 
 // Deprecated functions have been moved to this separate header file,
 // which must be included last after all the above definitions.
 #include "base/file_util_deprecated.h"
 
 #endif  // BASE_FILE_UTIL_H_