#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_ZIP_ZIPCONTAINERFILECODEC_H
#define NUCLEX_STORAGE_FILESYSTEM_ZIP_ZIPCONTAINERFILECODEC_H

#include "Nuclex/Storage/Config.h"

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

namespace Nuclex { namespace Storage { namespace FileSystem { namespace Zip {

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

  /// <summary>Allows zip files to be opened as containers</summary>
  class ZipContainerFileCodec : public ContainerFileCodec {

    /// <summary>Tries to open the specified file as a container</summary>
    /// <param name="registeredCodecs">
    ///   Codecs that have been registered to the file manager, enabling codec
    ///   implementations to access nested container files if so desired
    /// </param>
    /// <param name="file">File the codec should attempt to open as a container</param>
    /// <param name="openedContainer">
    ///   Output parameter that should receive the opened container if successful
    /// </param>
    /// <returns>
    ///   True if the file was successfully opened as a container, false otherwise
    /// </returns>
    public: bool TryOpenAsContainer(
      const std::shared_ptr<ContainerFileCodec> &registeredCodecs,
      const std::shared_ptr<File> &file,
      std::shared_ptr<Container> &openedContainer
    );

    /// <summary>
    ///   Determines whether the codec is able to open the specified file as a container
    /// </summary>
    /// <param name="file">File the codec should check</param>
    /// <returns>True if the file can be opened as a container, false otherwise</returns>
    public: bool CanOpenAsContainer(const std::shared_ptr<File> &file);

  };

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

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

#endif // NUCLEX_STORAGE_FILESYSTEM_ZIP_ZIPCONTAINERFILECODEC_H