#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_SEVENZIP_SEVENZIPREADER_H
#define NUCLEX_STORAGE_FILESYSTEM_SEVENZIP_SEVENZIPREADER_H

#include "Nuclex/Storage/Config.h"
#include "../../Helpers/StreamingCacheContext.h"
#include "SevenZippedFile.h"
#include "SevenZipArchive.h"

namespace Nuclex { namespace Storage { namespace FileSystem { namespace SevenZip {

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

  /// <summary>Reads data from 7-Zip archives</summary>
  class SevenZipReader : public Helpers::Cache<std::size_t> {

    /// <summary>Initializes a new 7-Zip compressed data reader</summary>
    /// <param name="sevenZipArchive">7-Zip archive the reader will extract from</param>
    public: SevenZipReader(const std::shared_ptr<SevenZipArchive> &sevenZipArchive);

    /// <summary>Frees all memory used by the 7-Zip reader</summary>
    public: virtual ~SevenZipReader() {}

    /// <summary>Reads the specified number of bytes from the file</summary>
    /// <param name="metaData">Meta data about the file being accessed</param>
    /// <param name="position">Absolute file position the data will be read from</param>
    /// <param name="buffer">Buffer into which the data will be read</param>
    /// <param name="count">Number of bytes that will be read</param>
    public: void ReadAt(
      const SevenZippedFile::MetaData &metaData,
      std::uint64_t position, void *buffer, std::size_t count
    );

    /// <summary>Creates a new context storing the state of a decompressor</summary>
    /// <param name="solidBlockIndex">
    ///   Index of the solid block for which a decompression context will be created
    /// </param>
    /// <returns>The new context</returns>
    protected: virtual Context *CreateContext(const std::size_t &solidBlockIndex);

    /// <summary>Creates a context using a single coder to decompress data</summary>
    private: Context *SevenZipReader::createSingleCoderContext(
      CSzCoderInfo &coder, std::size_t solidBlockIndex
    );

    private: SevenZipReader(const SevenZipReader &);
    private: SevenZipReader &operator =(const SevenZipReader &);

    /// <summary>7-Zip archive that will be extracted</summary>
    private: std::shared_ptr<SevenZipArchive> sevenZipArchive;

  };

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

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

#endif // NUCLEX_STORAGE_FILESYSTEM_SEVENZIP_SEVENZIPREADER_H