filepath.h

Go to the documentation of this file.

/* xoreos - A reimplementation of BioWare's Aurora engine
 *
 * xoreos is the legal property of its developers, whose names
 * can be found in the AUTHORS file distributed with this source
 * distribution.
 *
 * xoreos is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version.
 *
 * xoreos is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with xoreos. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef COMMON_FILEPATH_H
#define COMMON_FILEPATH_H

#include <list>

#include "src/common/types.h"
#include "src/common/ustring.h"

namespace Common {

static const size_t kFileInvalid = SIZE_MAX;

class FilePath {
public:
    static bool isRegularFile(const UString &p);

    static bool isDirectory(const UString &p);

    static size_t getFileSize(const UString &p);

    static UString getFile(const UString &p);

    static UString getStem(const UString &p);

    static UString getExtension(const UString &p);

    static UString changeExtension(const UString &p, const UString &ext = "");

    static UString getDirectory(const UString &p);

    static bool isAbsolute(const UString &p);

    static UString absolutize(const UString &p);

    static UString relativize(const UString &basePath, const UString &path);

    static UString normalize(const UString &p, bool resolveSymLinks = true);

    static UString canonicalize(const UString &p, bool resolveSymLinks = true);

    static UString findSubDirectory(const UString &directory, const UString &subDirectory,
                                    bool caseInsensitive = false);

    static bool getSubDirectories(const UString &directory, std::list<UString> &subDirectories);

    static bool createDirectories(const UString &path);

    static UString escapeStringLiteral(const UString &str);

    static UString getHumanReadableSize(size_t size);

    static UString getHomeDirectory();

    static UString getConfigDirectory();

    static UString getUserDataDirectory();

    static UString getUserDataFile(UString file);
};

} // End of namespace Common

#endif // COMMON_FILEPATH_H