path_help.h

/*
**  UICore
**  Copyright (c) 1997-2015 The UICore Team
**
**  This software is provided 'as-is', without any express or implied
**  warranty.  In no event will the authors be held liable for any damages
**  arising from the use of this software.
**
**  Permission is granted to anyone to use this software for any purpose,
**  including commercial applications, and to alter it and redistribute it
**  freely, subject to the following restrictions:
**
**  1. The origin of this software must not be misrepresented; you must not
**     claim that you wrote the original software. If you use this software
**     in a product, an acknowledgment in the product documentation would be
**     appreciated but is not required.
**  2. Altered source versions must be plainly marked as such, and must not be
**     misrepresented as being the original software.
**  3. This notice may not be removed or altered from any source distribution.
**
**  Note: Some of the libraries UICore may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Magnus Norddahl
*/

#pragma once

#include <vector>

namespace uicore
{
    enum class FilePathType
    {
        file_system,

        slashes
    };

    class FilePath
    {
    public:
        static std::string make_absolute(const std::string &base_path, const std::string &relative_path, FilePathType path_type = FilePathType::file_system);

        static std::string make_relative(const std::string &base_path, const std::string &absolute_path, FilePathType path_type = FilePathType::file_system);

        static std::string absolute_path(std::string path);

        static std::string location(const std::string &path);

        static bool is_absolute(const std::string &path, FilePathType path_type = FilePathType::file_system);

        static bool is_relative(const std::string &path, FilePathType path_type = FilePathType::file_system);

        static std::string normalize(const std::string &path, FilePathType path_type = FilePathType::file_system);

        static std::string add_trailing_slash(const std::string &path, FilePathType path_type = FilePathType::file_system);

        static std::string remove_trailing_slash(const std::string &path);

        static std::string basepath(const std::string &path, FilePathType path_type = FilePathType::file_system);

        static std::string filename(const std::string &path, FilePathType path_type = FilePathType::file_system);

        static std::string extension(const std::string &path, FilePathType path_type = FilePathType::file_system);

        static std::string filename_without_extension(const std::string &path, FilePathType path_type = FilePathType::file_system);

        static bool has_extension(const std::string &path, const std::string &extension, FilePathType path_type = FilePathType::file_system);

        static std::string combine(const std::string &part1, const std::string &part2, FilePathType path_type = FilePathType::file_system);
    };
}