path_help.h

Go to the documentation of this file.

/*
**  ClanLib SDK
**  Copyright (c) 1997-2009 The ClanLib 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 ClanLib may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Magnus Norddahl
*/


#pragma once

#include "../api_core.h"
#include <vector>

class CL_API_CORE CL_PathHelp
{

public:
        enum PathType
        {
                path_type_file,

                path_type_virtual
        };

        static CL_String make_absolute(
                const CL_String &base_path,
                const CL_String &relative_path,
                PathType path_type = path_type_file);

        static CL_String make_relative(
                const CL_String &base_path,
                const CL_String &absolute_path,
                PathType path_type = path_type_file);

        static bool is_absolute(
                const CL_String &path,
                PathType path_type = path_type_file);

        static bool is_relative(
                const CL_String &path,
                PathType path_type = path_type_file);

        static CL_String normalize(
                const CL_String &path,
                PathType path_type = path_type_file);

        static CL_String add_trailing_slash(
                const CL_String &path,
                PathType path_type = path_type_file);

        static CL_String remove_trailing_slash(
                const CL_String &path,
                PathType path_type = path_type_file);

        static CL_String get_location(
                const CL_String &fullname,
                PathType path_type = path_type_file);

        static CL_String get_basepath(
                const CL_String &fullname,
                PathType path_type = path_type_file);


        static std::vector<CL_String> split_basepath(
                const CL_String &fullname,
                PathType path_type = path_type_file);


        static CL_String get_fullpath(
                const CL_String &fullname,
                PathType path_type = path_type_file);


        static CL_String get_filename(
                const CL_String &fullname,
                PathType path_type = path_type_file);


        static CL_String get_basename(
                const CL_String &fullname,
                PathType path_type = path_type_file);


        static CL_String get_extension(
                const CL_String &fullname,
                PathType path_type = path_type_file);


        static CL_String get_fullname(
                const CL_String &fullpath,
                const CL_String &filename,
                PathType path_type = path_type_file);


        static CL_String get_fullname(
                const CL_String &fullpath,
                const CL_String &filename,
                const CL_String &extension,
                PathType path_type = path_type_file);


        static CL_String get_fullname(
                const CL_String &location,
                const CL_String &basepath,
                const CL_String &filename,
                const CL_String &extension,
                PathType path_type = path_type_file);
};

---