path.hpp

// Copyright (c) 2014-2022 Thomas Fussell
// Copyright (c) 2024-2026 xlnt-community
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE
//
// @license: http://www.opensource.org/licenses/mit-license.php
// @author: see AUTHORS file

#pragma once

#include <string>
#include <utility>
#include <vector>

#include <xlnt/xlnt_config.hpp>
#include <xlnt/internal/features.hpp>

#if XLNT_HAS_INCLUDE(<string_view>) && XLNT_HAS_FEATURE(U8_STRING_VIEW)
  #include <string_view>
#endif

namespace xlnt {

class XLNT_API path
{
public:
    static char system_separator();

    path();

    explicit path(const std::string &path_string);

    path(const std::string &path_string, char sep);

#if XLNT_HAS_FEATURE(U8_STRING_VIEW)
    explicit path(std::u8string_view path_string);

    path(std::u8string_view path_string, char sep);
#endif

    // general attributes

    bool is_relative() const;

    bool is_absolute() const;

    bool is_root() const;

    path parent() const;

    std::string filename() const;

    std::string extension() const;

    std::pair<std::string, std::string> split_extension() const;

    // conversion

    std::vector<std::string> split() const;

    const std::string &string() const;

#ifdef _MSC_VER
    std::wstring wstring() const;
#endif

    path resolve(const path &base_path) const;

    path relative_to(const path &base_path) const;

    // filesystem attributes

    bool exists() const;

    bool is_directory() const;

    bool is_file() const;

    // filesystem

    std::string read_contents() const;

    // mutators

    path append(const std::string &to_append) const;

#if XLNT_HAS_FEATURE(U8_STRING_VIEW)
    path append(std::u8string_view to_append) const;
#endif

    path append(const path &to_append) const;

    bool operator==(const path &other) const;

    bool operator!=(const path &other) const;

private:
    char guess_separator() const;

    std::string internal_;
};

} // namespace xlnt

namespace std {

template <>
struct hash<xlnt::path>
{
    size_t operator()(const xlnt::path &p) const
    {
        static hash<string> hasher;
        return hasher(p.string());
    }
};

} // namespace std