Uri.hpp

Go to the documentation of this file.

// @formatter:off
//
// Balau core C++ library
//
// Copyright (C) 2008 Bora Software (contact@borasoftware.com)
//
// Licensed under the Boost Software License - Version 1.0 - August 17th, 2003.
// See the LICENSE file for the full license text.
//


#ifndef COM_BORA_SOFTWARE__BALAU_RESOURCE__URI
#define COM_BORA_SOFTWARE__BALAU_RESOURCE__URI

#include <Balau/Dev/Assert.hpp>
#include <Balau/Resource/UriDispatcher.hpp>
#include <Balau/Type/StdTypes.hpp>

#include <memory>

namespace Balau::Resource {

class Uri;
class ByteReadResource;
class ByteWriteResource;
class Utf8To32ReadResource;
class Utf32To8WriteResource;

class RecursiveUriIterator {
    public: virtual bool hasNext() const = 0;

    public: virtual std::unique_ptr<Uri> next() = 0;

    public: virtual ~RecursiveUriIterator() = default;

//  public: virtual bool operator == (const RecursiveUriIterator & rhs) const = 0;

//  public: virtual RecursiveUriIterator operator ++(const RecursiveUriIterator & rhs) const = 0;

//  public: virtual bool operator == (const RecursiveUriIterator & rhs) const = 0;

};

class UriIterator {
    public: virtual bool hasNext() const = 0;

    public: virtual std::unique_ptr<Uri> next() = 0;

    public: virtual ~UriIterator() = default;

//  public: virtual bool operator == (const UriIterator & rhs) const = 0;

//  public: virtual RecursiveUriIterator operator ++(const UriIterator & rhs) const = 0;

//  public: virtual bool operator == (const UriIterator & rhs) const = 0;

};

class Uri {
    public: virtual std::unique_ptr<Uri> clone() const = 0;

    public: std::shared_ptr<Uri> cloneToShared() const {
        return clone();
    }

    public: virtual std::unique_ptr<Uri> append(const std::string & pathComponent) const = 0;

    public: virtual std::unique_ptr<Uri> resolve(std::string_view path) const = 0;

    public: virtual bool isRegularDirectory() const = 0;

    public: virtual bool isRegularFile() const = 0;

    public: virtual std::string toUriString() const = 0;

    public: virtual std::string toRawString() const = 0;

    public: virtual size_t hashcode() const noexcept = 0;

    public: virtual bool canReadFrom() const = 0;

    public: virtual bool canWriteTo() const = 0;

    public: virtual std::unique_ptr<ByteReadResource> byteReadResource() const = 0;

    public: virtual std::unique_ptr<Utf8To32ReadResource> utf8To32ReadResource() const = 0;

    public: virtual std::unique_ptr<ByteWriteResource> byteWriteResource() = 0;

    public: virtual std::unique_ptr<Utf32To8WriteResource> utf32To8WriteResource() = 0;

    public: virtual bool isRecursivelyIterable() const = 0;

    public: virtual bool isIterable() const = 0;

    public: virtual std::unique_ptr<RecursiveUriIterator> recursiveIterator() const = 0;

    public: virtual std::unique_ptr<UriIterator> iterator() const = 0;

    public: virtual bool operator == (const Uri & rhs) const = 0;

    public: virtual ~Uri() = default;

    public: virtual void dispatch(UriDispatcher & visitor) const = 0;
};

inline std::unique_ptr<Uri> operator / (const std::unique_ptr<Uri> & uri, const std::string & pathComponent) {
    return uri->append(pathComponent);
}

inline std::string toString(const Uri & uri) {
    return uri.toRawString();
}

void fromString(std::unique_ptr<Uri> & uri, std::string_view value);

inline void fromString(std::shared_ptr<Uri> & uri, std::string_view value) {
    std::unique_ptr<Uri> ptr;
    fromString(ptr, value);
    uri = std::shared_ptr<Uri>(std::move(ptr));
}

inline void fromString(std::shared_ptr<const Uri> & uri, std::string_view value) {
    std::unique_ptr<Uri> ptr;
    fromString(ptr, value);
    uri = std::shared_ptr<const Uri>(std::move(ptr));
}

} // namespace Balau::Resource

#endif // COM_BORA_SOFTWARE__BALAU_RESOURCE__URI