#pragma region CPL License
/*
Nuclex Native Framework
Copyright (C) 2002-2021 Nuclex Development Labs

This library is free software; you can redistribute it and/or
modify it under the terms of the IBM Common Public License as
published by the IBM Corporation; either version 1.0 of the
License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
IBM Common Public License for more details.

You should have received a copy of the IBM Common Public
License along with this library
*/
#pragma endregion // CPL License

#ifndef NUCLEX_STORAGE_FILESYSTEM_LINUX_LINUXDIRECTORYCONTAINER_H
#define NUCLEX_STORAGE_FILESYSTEM_LINUX_LINUXDIRECTORYCONTAINER_H

#include "Nuclex/Storage/Config.h"

#if defined(NUCLEX_STORAGE_LINUX)

#include "Nuclex/Storage/FileSystem/Container.h"

namespace Nuclex { namespace Storage { namespace FileSystem { namespace Linux {

  // ------------------------------------------------------------------------------------------- //

  /// <summary>Container that represents a real directory in the file system</summary>
  class LinuxDirectoryContainer : public Container {

    /// <summary>Initializes a new container for a file system directory</summary>
    /// <param name="absolutePath">Absolute path to the directory in the file system</param>
    public: LinuxDirectoryContainer(const std::string &absolutePath);

    /// <summary>Frees all resources owned by the directory container</summary>
    public: virtual ~LinuxDirectoryContainer() = default;

    /// <summary>Returns the name of the container</summary>
    /// <returns>The container's name</returns>
    public: const std::string &GetName() const override { return this->name; }

    /// <summary>Returns the path the container is stored at in the native format</summary>
    /// <returns>The container's absolute path in the native OS format</returns>
    public: virtual const std::string &GetNativePath() const override {
      return this->absolutePath;
    }

    /// <summary>Creates a list of all directories below this directory</summary>
    /// <param name="wildcard">Wild card by which to filter the enumerated directories</param>
    /// <returns>A list of all directories below this one</returns>
    public: std::vector<std::string> EnumerateContainers(
      const std::string &wildcard = u8"*"
    ) const override;

    /// <summary>Creates a list of all files in this directory</summary>
    /// <param name="wildcard">Wild card by which to filter the enumerated files</param>
    /// <returns>A list of all files in this directory</returns>
    public: std::vector<std::string> EnumerateFiles(
      const std::string &wildcard = u8"*"
    ) const override;

    /// <summary>Accesses a sub-container within this container</summary>
    /// <param name="name">Name of the sub-container that will be accessed</param>
    /// <returns>The sub-container with the specified name</returns>
    public: std::shared_ptr<Container> AccessContainer(const std::string &name) override;

    /// <summary>Accesses a sub-container within this container</summary>
    /// <param name="name">Name of the sub-container that will be accessed</param>
    /// <returns>The sub-container with the specified name</returns>
    public: std::shared_ptr<const Container> AccessContainer(
      const std::string &name
    ) const override;

    /// <summary>Absolute path of the directory in the actual file system</summary>
    private: std::string absolutePath;
    /// <summary>Name of the container</summary>
    private: mutable std::string name;

  };

  // ------------------------------------------------------------------------------------------- //

}}}} // namespace Nuclex::Storage::FileSystem::Linux

#endif // defined(NUCLEX_STORAGE_LINUX)

#endif // NUCLEX_STORAGE_FILESYSTEM_LINUX_LINUXDIRECTORYCONTAINER_H