file_util_icu.h revision 5821806d5e7f356e8fa4b058a389a808ea183019 
1// Copyright (c) 2012 The Chromium Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5#ifndef BASE_I18N_FILE_UTIL_ICU_H_
6#define BASE_I18N_FILE_UTIL_ICU_H_
7
8// File utilities that use the ICU library go in this file.
9
10#include "base/file_path.h"
11#include "base/i18n/base_i18n_export.h"
12#include "base/string16.h"
13
14namespace file_util {
15
16// Returns true if file_name does not have any illegal character. The input
17// param has the same restriction as that for ReplaceIllegalCharacters.
18BASE_I18N_EXPORT bool IsFilenameLegal(const string16& file_name);
19
20// Replaces characters in 'file_name' that are illegal for file names with
21// 'replace_char'. 'file_name' must not be a full or relative path, but just the
22// file name component (since slashes are considered illegal). Any leading or
23// trailing whitespace in 'file_name' is removed.
24// Example:
25//   file_name == "bad:file*name?.txt", changed to: "bad-file-name-.txt" when
26//   'replace_char' is '-'.
27BASE_I18N_EXPORT void ReplaceIllegalCharactersInPath(
28    FilePath::StringType* file_name,
29    char replace_char);
30
31// Compares two filenames using the current locale information. This can be
32// used to sort directory listings. It behaves like "operator<" for use in
33// std::sort.
34BASE_I18N_EXPORT bool LocaleAwareCompareFilenames(const FilePath& a,
35                                                  const FilePath& b);
36
37// Calculates the canonical file-system representation of |file_name| base name.
38// Modifies |file_name| in place. No-op if not on ChromeOS.
39BASE_I18N_EXPORT void NormalizeFileNameEncoding(FilePath* file_name);
40
41}  // namespace file_util
42
43#endif  // BASE_I18N_FILE_UTIL_ICU_H_
44