//! \file ArchiveFormat.cs //! \date Sun Dec 04 15:19:21 2016 //! \brief Abstract base class representing archive resource. // // Copyright (C) 2014-2016 by morkt // // Permission is hereby granted, free of charge, to any person obtaining a copy // of this software and associated documentation files (the "Software"), to // deal in the Software without restriction, including without limitation the // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or // sell copies of the Software, and to permit persons to whom the Software is // furnished to do so, subject to the following conditions: // // The above copyright notice and this permission notice shall be included in // all copies or substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS // IN THE SOFTWARE. // using System; using System.Collections.Generic; using System.IO; namespace GameRes { /// /// Abstract base class for archive resource implementations. /// public abstract class ArchiveFormat : IResource { public override string Type { get { return "archive"; } } /// /// Whether archive file system could contain subdirectories. /// public abstract bool IsHierarchic { get; } public abstract ArcFile TryOpen (ArcView view); /// /// Extract file referenced by into current directory. /// public void Extract (ArcFile file, Entry entry) { using (var input = OpenEntry (file, entry)) using (var output = PhysicalFileSystem.CreateFile (entry.Name)) input.CopyTo (output); } /// /// Open file referenced by as Stream. /// public virtual Stream OpenEntry (ArcFile arc, Entry entry) { return arc.File.CreateStream (entry.Offset, entry.Size, entry.Name); } /// /// Open as image. Throws InvalidFormatException if entry is not an image. /// public virtual IImageDecoder OpenImage (ArcFile arc, Entry entry) { var input = arc.OpenBinaryEntry (entry); return ImageFormatDecoder.Create (input); } /// /// Create resource within stream containing entries from the /// supplied and applying necessary . /// public virtual void Create (Stream file, IEnumerable list, ResourceOptions options = null, EntryCallback callback = null) { throw new NotImplementedException ("ArchiveFormat.Create is not implemented"); } /// /// Whether represents legit number of files in archive. /// public static bool IsSaneCount (int count) { return count > 0 && count < 0x40000; } /// /// Whether represents a valid archive entry name. /// public static bool IsValidEntryName (string name) { return !string.IsNullOrWhiteSpace (name) && !Path.IsPathRooted (name); } } public enum ArchiveOperation { Abort, Skip, Continue, } public delegate ArchiveOperation EntryCallback (int num, Entry entry, string description); }