// /***************************************************************************
// The Disc Image Chef
// ----------------------------------------------------------------------------
//
// Filename       : IWritableImage.cs
// Author(s)      : Natalia Portillo <claunia@claunia.com>
//
// Component      : Disc image plugins.
//
// --[ Description ] ----------------------------------------------------------
//
//     Defines interface to be implemented by writable image plugins.
//
// --[ License ] --------------------------------------------------------------
//
//     This library is free software; you can redistribute it and/or modify
//     it under the terms of the GNU Lesser General Public License as
//     published by the Free Software Foundation; either version 2.1 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 GNU
//     Lesser General Public License for more details.
//
//     You should have received a copy of the GNU Lesser General Public
//     License along with this library; if not, see <http://www.gnu.org/licenses/>.
//
// ----------------------------------------------------------------------------
// Copyright © 2011-2018 Natalia Portillo
// ****************************************************************************/

using System;
using System.Collections.Generic;
using DiscImageChef.CommonTypes;

namespace DiscImageChef.DiscImages
{
    /// <summary>
    ///     Abstract class to implement disk image writing plugins.
    ///     TODO: This interface is subject to change until notice.
    /// </summary>
    public interface IWritableImage : IMediaImage
    {
        /// <summary>
        ///     Gets a list of <see cref="MediaTagType" /> that are supported by the media image format
        /// </summary>
        IEnumerable<MediaTagType> SupportedMediaTags { get; }
        /// <summary>
        ///     Gets a list of <see cref="SectorTagType" /> that are supported by the media image format
        /// </summary>
        IEnumerable<SectorTagType> SupportedSectorTags { get; }
        /// <summary>
        ///     Gets a list of <see cref="MediaType" /> that are supported by the media image format
        /// </summary>
        IEnumerable<MediaType> SupportedMediaTypes { get; }
        /// <summary>
        ///     Retrieves a list of options supported by the filesystem, with name, type and description
        /// </summary>
        IEnumerable<(string name, Type type, string description)> SupportedOptions { get; }
        /// <summary>
        ///     Gets a list of known extensions for format auto-chosing
        /// </summary>
        IEnumerable<string> KnownExtensions { get; }

        bool IsWriting { get; }
        string ErrorMessage { get; }
        
        /// <summary>
        ///     Creates a new image in the specified path, for the specified <see cref="MediaType" />, with the
        ///     specified options to hold a media with the specified number of sectors
        /// </summary>
        /// <param name="path">Path to the new image, with extension</param>
        /// <param name="mediaType"><see cref="MediaType" /> that will be written in the image</param>
        /// <param name="options">Options to be used when creating new image</param>
        /// <param name="sectors">How many sectors the media has.</param>
        /// <returns><c>true</c> if operating completed successfully, <c>false</c> otherwise</returns>
        bool Create(string path, MediaType mediaType, Dictionary<string, string> options, ulong sectors);

        /// <summary>
        ///     Writes a media tag to the image
        /// </summary>
        /// <param name="data">Media tag</param>
        /// <param name="tag">
        ///     <see cref="MediaTagType" />
        /// </param>
        /// <returns><c>true</c> if operating completed successfully, <c>false</c> otherwise</returns>
        bool WriteMediaTag(byte[] data, MediaTagType tag);

        /// <summary>
        ///     Writes a sector to the image
        /// </summary>
        /// <param name="data">Sector data</param>
        /// <param name="sectorAddress">Sector address</param>
        /// <returns><c>true</c> if operating completed successfully, <c>false</c> otherwise</returns>
        bool WriteSector(byte[] data, ulong sectorAddress);

        /// <summary>
        ///     Writes several sectors to the image
        /// </summary>
        /// <param name="data">Sectors data</param>
        /// <param name="sectorAddress">Sector starting address</param>
        /// <param name="length">How many sectors to write</param>
        /// <returns><c>true</c> if operating completed successfully, <c>false</c> otherwise</returns>
        bool WriteSectors(byte[] data, ulong sectorAddress, uint length);

        /// <summary>
        ///     Writes a sector to the image with tags attached
        /// </summary>
        /// <param name="data">Sector data with its tags attached</param>
        /// <param name="sectorAddress">Sector address</param>
        /// <returns><c>true</c> if operating completed successfully, <c>false</c> otherwise</returns>
        bool WriteSectorLong(byte[] data, ulong sectorAddress);

        /// <summary>
        ///     Writes several sectors to the image
        /// </summary>
        /// <param name="data">Sector data with their tags attached</param>
        /// <param name="sectorAddress">Sector starting address</param>
        /// <param name="length">How many sectors to write</param>
        /// <returns><c>true</c> if operating completed successfully, <c>false</c> otherwise</returns>
        bool WriteSectorsLong(byte[] data, ulong sectorAddress, uint length);

        /// <summary>
        ///     Sets tracks for optical media
        /// </summary>
        /// <param name="tracks">List of tracks</param>
        /// <returns><c>true</c> if operating completed successfully, <c>false</c> otherwise</returns>
        bool SetTracks(List<Track> tracks);

        /// <summary>
        ///     Closes and flushes to disk the image
        /// </summary>
        /// <returns><c>true</c> if operating completed successfully, <c>false</c> otherwise</returns>
        bool Close();

        /// <summary>
        ///     Sets image metadata
        /// </summary>
        /// <param name="metadata"><see cref="ImageInfo"/> containing image metadata</param>
        /// <returns><c>true</c> if operating completed successfully, <c>false</c> otherwise</returns>
        bool SetMetadata(ImageInfo metadata);
    }
}