APath.h

/*
 * AUI Framework - Declarative UI toolkit for modern C++20
 * Copyright (C) 2020-2024 Alex2772 and Contributors
 *
 * SPDX-License-Identifier: MPL-2.0
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
 
#pragma once
 
#include <iterator>
#include "AUI/Reflect/AEnumerate.h"
#include <AUI/Common/AString.h>
#include <AUI/Common/ADeque.h>
#include <AUI/Common/AVector.h>
#include <AUI/Traits/serializable.h>
 
AUI_ENUM_FLAG(APathFinder) {
    NONE,
 
    USE_SYSTEM_PATHS = 1 << 0,
 
    RECURSIVE = 1 << 1,
 
    SINGLE = 1 << 2
};
 
AUI_ENUM_FLAG(AFileListFlags) {
    NONE = 0,
 
    DONT_IGNORE_DOTS = 1 << 0,
 
    DIRS = 1 << 1,
 
    REGULAR_FILES = 1 << 2,
 
    RECURSIVE = 1 << 3,
 
    DEFAULT_FLAGS = AFileListFlags::DIRS | AFileListFlags::REGULAR_FILES
};
 
class API_AUI_CORE APath final: public AString {
private:
    APath ensureSlashEnding() const;
    APath ensureNonSlashEnding() const;
 
    void removeBackSlashes();
 
 
#if AUI_PLATFORM_WIN
    struct _stat64 stat() const;
#else
    struct stat stat() const;
#endif
 
public:
    APath() = default;
    APath(AString&& other) noexcept: AString(std::move(other)) {
        removeBackSlashes();
    }
    APath(const AString& other) noexcept: AString(other) {
        removeBackSlashes();
    }
    APath(const char* utf8) noexcept: AString(utf8) {
        removeBackSlashes();
    }
 
    // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-pointer-arithmetic)
    APath(const char* utf8, std::size_t length) noexcept: AString(utf8, utf8 + length) {
        removeBackSlashes();
    }
    APath(const char16_t * str) noexcept: AString(str) {
        removeBackSlashes();
    }
 
    APath(const char16_t * str, std::size_t length) noexcept: AString(str, str + length) {
        removeBackSlashes();
    }
 
    const APath& touch() const;
 
    AString systemSlashDirection() const;
 
    APath absolute() const;
 
    ADeque<APath> listDir(AFileListFlags f = AFileListFlags::DEFAULT_FLAGS) const;
 
    [[nodiscard]] APath parent() const;
 
    [[nodiscard]] APath file(const AString& fileName) const;
 
    [[nodiscard]] APath filename() const;
 
    [[nodiscard]] APath filenameWithoutExtension() const;
 
    [[nodiscard]] APath withoutUppermostFolder() const;
 
    bool exists() const;
 
 
    bool isRegularFileExists() const;
 
    bool isDirectoryExists() const;
 
    const APath& removeFile() const;
 
    const APath& removeFileRecursive() const;
 
    const APath& makeDir() const;
 
    const APath& makeDirs() const;
 
    AString relativelyTo(const APath& dir) const;
 
    APath extensionChanged(const AString& newExtension) const;
 
    bool isAbsolute() const;
    bool isRelative() const {
        return !isAbsolute();
    }
 
    time_t fileModifyTime() const;
    size_t fileSize() const;
 
    const APath& chmod(int newMode) const;
 
    enum DefaultPath {
        APPDATA,
 
        TEMP,
 
        HOME,
    };
 
    static APath getDefaultPath(DefaultPath path);
 
    static void copy(const APath& source, const APath& destination);
 
    static void move(const APath& source, const APath& destination);
 
    static APath workingDir();
 
 
    static AVector<APath> find(const AString& filename, const AVector<APath>& locations, APathFinder flags = APathFinder::NONE);
 
    [[nodiscard]]
    APath operator/(const AString& filename) const {
        return file(filename);
    }
 
};
 
 
inline APath operator""_path(const char* str, std::size_t length) {
    return APath(str, length);
}
 
template<>
struct ASerializable<APath>: ASerializable<AString> {};