using System.IO;
using System.Linq;
using Chernobyl.Collections.Generic.Event;

namespace Chernobyl.IO
{
    /// <summary>
    /// This class is used to search a set of search paths or directory paths 
    /// for a specific file. When found, the FileSearchStream can be read from
    /// just like a FileStream.
    /// </summary>
    public class FileSearchStream : FileStream
    {
        /// <summary>
        /// Constructor.
        /// </summary>
        /// <param name="services">The services object that contains a 
        /// SearchPath instance. This SearchPath will be used to find the
        /// specified file.</param>
        /// <param name="file">The file path to the file that is contained 
        /// within at least one of the search paths specified by the
        /// <see cref="ISearchPaths"/> in the <paramref name="services"/>
        /// instance.</param>
        /// <param name="fileMode">How the operating system should open the file.</param>
        public FileSearchStream(IEventCollection<object> services, string file, FileMode fileMode)
            : this(services.OfType<ISearchPaths>().First(), file, fileMode)
        {
        }

        /// <summary>
        /// Constructor.
        /// </summary>
        /// <param name="services">The services object that contains a 
        /// SearchPath instance. This SearchPath will be used to find the
        /// specified file.</param>
        /// <param name="file">The file path to the file that is contained 
        /// within at least one of the search paths specified by the
        /// <see cref="ISearchPaths"/> in the <paramref name="services"/>
        /// instance.</param>
        /// <param name="fileMode">How the operating system should open the file.</param>
        /// <param name="fileAccess">How the file will be accessed</param>
        public FileSearchStream(IEventCollection<object> services, string file, FileMode fileMode, FileAccess fileAccess)
            : this(services.OfType<ISearchPaths>().First(), file, fileMode, fileAccess)
        {
        }

        /// <summary>
        /// Constructor.
        /// </summary>
        /// <param name="searchPaths">The search path instance that contains the
        /// search paths that should be searched for the specified file.</param>
        /// <param name="file">The file path to the file that is contained 
        /// within at least one of the search paths specified by 
        /// <paramref name="searchPaths"/>.</param>
        /// <param name="fileMode">How the operating system should open the file.</param>
        public FileSearchStream(ISearchPaths searchPaths, string file, FileMode fileMode)
            : base(searchPaths.FilePaths(file).First(), fileMode)
        {
        }

        /// <summary>
        /// Constructor.
        /// </summary>
        /// <param name="searchPaths">The search path instance that contains the
        /// search paths that should be searched for the specified file.</param>
        /// <param name="file">The file path to the file that is contained 
        /// within at least one of the search paths specified by 
        /// <paramref name="searchPaths"/>.</param>
        /// <param name="fileMode">How the operating system should open the file.</param>
        /// <param name="fileAccess">How the file will be accessed</param>
        public FileSearchStream(ISearchPaths searchPaths, string file, FileMode fileMode, FileAccess fileAccess) 
            : base(searchPaths.FilePaths(file).First(), fileMode, fileAccess)
        {
        }
    }
}