initial import
[vuplus_webkit] / Source / WebCore / fileapi / DOMFilePath.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 DOMFilePath_h
32 #define DOMFilePath_h
33
34 #include "PlatformString.h"
35 #include <wtf/PassRefPtr.h>
36 #include <wtf/RefCounted.h>
37
38 namespace WebCore {
39
40 // DOMFileSystem path utilities. All methods in this class are static.
41 class DOMFilePath {
42 public:
43     static const char separator;
44     static const char root[];
45
46     // Returns the name part from the given path.
47     static String getName(const String& path);
48
49     // Returns the parent directory path of the given path.
50     static String getDirectory(const String& path);
51
52     // Checks if a given path is a parent of mayBeChild. This method assumes given paths are absolute and do not have extra references to a parent (i.e. "../").
53     static bool isParentOf(const String& path, const String& mayBeChild);
54
55     // Appends the separator at the end of the path if it's not there already.
56     static String ensureDirectoryPath(const String& path);
57
58     // Returns a new path by appending a separator and the supplied path component to the path.
59     static String append(const String& path, const String& component);
60
61     static bool isAbsolute(const String& path)
62     {
63         return path.startsWith(DOMFilePath::root);
64     }
65
66     static bool endsWithSeparator(const String& path)
67     {
68         return path[path.length() - 1] == DOMFilePath::separator;
69     }
70
71     // Evaluates all "../" and "./" segments.  Note that "/../" expands to "/", so you can't ever refer to anything above the root directory.
72     static String removeExtraParentReferences(const String& path);
73
74     // Checks if the given path follows the FileSystem API naming restrictions.
75     static bool isValidPath(const String& path);
76
77     // Checks if the given name follows the FileSystem API naming restrictions.
78     static bool isValidName(const String& name);
79
80 private:
81     DOMFilePath() { }
82 };
83
84 } // namespace WebCore
85
86 #endif // DOMFilePath_h