Worms2server/src/library/Syroot.Worms.Armageddon/GeneratedMap.cs

using System.IO;
using System.Text;
using Syroot.BinaryData;
using Syroot.Worms.Core.IO;

namespace Syroot.Worms.Armageddon
{
    /// <summary>
    /// Represents <see cref="MapGeneratorSettings"/> stored in a LEV file.
    /// Used by WA and WWP. S. https://worms2d.info/Monochrome_map_(.bit,_.lev).
    /// </summary>
    public class GeneratedMap : ILoadableFile, ISaveableFile
    {
        // ---- CONSTRUCTORS & DESTRUCTOR ------------------------------------------------------------------------------

        /// <summary>
        /// Initializes a new instance of the <see cref="GeneratedMap"/> class.
        /// </summary>
        public GeneratedMap() { }

        /// <summary>
        /// Initializes a new instance of the <see cref="GeneratedMap"/> class, loading the data from the given
        /// <see cref="Stream"/>.
        /// </summary>
        /// <param name="stream">The <see cref="Stream"/> to load the data from.</param>
        public GeneratedMap(Stream stream) => Load(stream);

        /// <summary>
        /// Initializes a new instance of the <see cref="GeneratedMap"/> class, loading the data from the given file.
        /// </summary>
        /// <param name="fileName">The name of the file to load the data from.</param>
        public GeneratedMap(string fileName) => Load(fileName);

        // ---- PROPERTIES ---------------------------------------------------------------------------------------------

        /// <summary>
        /// Gets or sets the <see cref="MapGeneratorSettings"/>.
        /// </summary>
        public MapGeneratorSettings Settings { get; set; }

        // ---- METHODS (PUBLIC) ---------------------------------------------------------------------------------------

        /// <summary>
        /// Loads the data from the given <see cref="Stream"/>.
        /// </summary>
        /// <param name="stream">The <see cref="Stream"/> to load the data from.</param>
        public void Load(Stream stream)
        {
            using BinaryStream reader = new BinaryStream(stream, encoding: Encoding.ASCII, leaveOpen: true);
            Settings = reader.ReadStruct<MapGeneratorSettings>();
        }

        /// <summary>
        /// Loads the data from the given file.
        /// </summary>
        /// <param name="fileName">The name of the file to load the data from.</param>
        public void Load(string fileName)
        {
            using FileStream stream = new FileStream(fileName, FileMode.Open, FileAccess.Read, FileShare.Read);
            Load(stream);
        }

        /// <summary>
        /// Saves the data into the given <paramref name="stream"/>.
        /// </summary>
        /// <param name="stream">The <see cref="Stream"/> to save the data to.</param>
        public void Save(Stream stream)
        {
            using BinaryStream writer = new BinaryStream(stream, encoding: Encoding.ASCII);
            writer.WriteStruct(Settings);
        }

        /// <summary>
        /// Saves the data in the given file.
        /// </summary>
        /// <param name="fileName">The name of the file to save the data in.</param>
        public void Save(string fileName)
        {
            using FileStream stream = new FileStream(fileName, FileMode.Create, FileAccess.Write, FileShare.None);
            Save(stream);
        }
    }
}