#pragma region CPL License
/*
Nuclex Native Framework
Copyright (C) 2002-2013 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_LINUXFILE_H
#define NUCLEX_STORAGE_FILESYSTEM_LINUXFILE_H

#include "Nuclex/Storage/Config.h"

#if defined(NUCLEX_STORAGE_LINUX)

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

#include <string>
#include <boost/thread/mutex.hpp>

namespace Nuclex { namespace Storage { namespace FileSystem {

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

  /// <summary>File on a Linux system</summary>
  class LinuxFile : public File {

    /// <summary>Accesses a file on Linux</summary>
    /// <param name="path">Path of the file that will be opened or created</param>
    public: LinuxFile(const std::string &path);

    /// <summary>Frees all resources owned by the instance</summary>
    public: virtual ~LinuxFile();

    /// <summary>Determines the size of the file</summary>
    /// <returns>The size of the file in bytes</returns>
    public: std::uint64_t GetSize() const;

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

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

    /// <summary>Reads raw data from the file</summary>
    /// <param name="location">Absolute file position data will be read from</param>
    /// <param name="buffer">Buffer into which data will be read</param>
    /// <param name="count">Number of bytes that will be read</param>
    public: void ReadAt(
      std::uint64_t location, void *buffer, std::size_t count
    ) const;

    /// <summary>Writes raw data into the file</summary>
    /// <param name="location">Absolute file position data will be written to</param>
    /// <param name="buffer">Buffer from which data will be taken</param>
    /// <param name="count">Number of bytes that will be written</param>
    public: void WriteAt(
      std::uint64_t location, const void *buffer, std::size_t count
    );

    /// <summary>Ensures changes to the file have been written to disk</summary>
    public: void Flush();

    /// <summary>Closes the file</summary>
    private: void close();

    /// <summary>Handle of the opened file for Windows' file functions</summary>
    private: mutable int fileHandle;
    /// <summary>Synchronize file accesses from multiple threads</summary>
    /// <remarks> 
    ///   This is required because the Windows file implementation still forces
    ///   a file cursor upon us. Opening multiple file handles would only inrease
    ///   complexity when the underlying hardware cannot do parallel reads anyway.
    /// </remarks>
    private: mutable std::mutex mutex;
    /// <summary>Whether the file is currently opened for writing</summary>
    private: mutable bool isOpenedWritable;
    /// <summary>Absolute path of the file</summary>
    private: std::string path;
    /// <summary>The file's name</summary>
    private: std::string name;

  };

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

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

#endif // defined(NUCLEX_STORAGE_LINUX)
#endif // NUCLEX_STORAGE_FILESYSTEM_GENERICWINDOWSFILE_H