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/files/file_path.h"
11#include "base/i18n/base_i18n_export.h"
12#include "base/strings/string16.h"
13
14namespace base {
15namespace i18n {
16
17// Returns true if file_name does not have any illegal character. The input
18// param has the same restriction as that for ReplaceIllegalCharacters.
19BASE_I18N_EXPORT bool IsFilenameLegal(const string16& file_name);
20
21// Replaces characters in 'file_name' that are illegal for file names with
22// 'replace_char'. 'file_name' must not be a full or relative path, but just the
23// file name component (since slashes are considered illegal). Any leading or
24// trailing whitespace in 'file_name' is removed.
25// Example:
26//   file_name == "bad:file*name?.txt", changed to: "bad-file-name-.txt" when
27//   'replace_char' is '-'.
28BASE_I18N_EXPORT void ReplaceIllegalCharactersInPath(
29    FilePath::StringType* file_name,
30    char replace_char);
31
32// Compares two filenames using the current locale information. This can be
33// used to sort directory listings. It behaves like "operator<" for use in
34// std::sort.
35BASE_I18N_EXPORT bool LocaleAwareCompareFilenames(const FilePath& a,
36                                                  const FilePath& b);
37
38// Calculates the canonical file-system representation of |file_name| base name.
39// Modifies |file_name| in place. No-op if not on ChromeOS.
40BASE_I18N_EXPORT void NormalizeFileNameEncoding(FilePath* file_name);
41
42}  // namespace i18n
43}  // namespace base
44
45#endif  // BASE_I18N_FILE_UTIL_ICU_H_
46