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