File: HostEnvironment.cs
Web Access
Project: src\src\Microsoft.Cci.Extensions\Microsoft.Cci.Extensions.csproj (Microsoft.Cci.Extensions)
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Diagnostics;
using System.Diagnostics.Contracts;
using System.IO;
using System.Linq;
using System.Net.Http.Headers;
using System.Reflection.PortableExecutable;
using Microsoft.Cci;
 
namespace Microsoft.Cci.Extensions
{
    public enum ErrorTreatment
    {
        Default,
        TreatAsWarning,
        Ignore
    }
 
    public class HostEnvironment : MetadataReaderHost
    {
        private PeReader _reader;
        private HashSet<UnresolvedReference<IUnit, AssemblyIdentity>> _unresolvedIdentities;
        private AssemblyIdentity _coreAssemblyIdentity;
 
        public HostEnvironment()
            : this(new NameTable(), new InternFactory())
        {
        }
 
        public HostEnvironment(INameTable nameTable)
            : this(nameTable, new InternFactory())
        {
        }
 
        public HostEnvironment(IInternFactory internFactory)
            : this(new NameTable(), internFactory)
        {
        }
 
        public HostEnvironment(INameTable nameTable, IInternFactory internFactory)
            : base(nameTable, internFactory, 0, null, false)
        {
            _reader = new PeReader(this);
            _unresolvedIdentities = new HashSet<UnresolvedReference<IUnit, AssemblyIdentity>>();
        }
 
        public bool UnifyToLibPath { get; set; }
 
        public ICollection<UnresolvedReference<IUnit, AssemblyIdentity>> UnresolvedIdentities { get { return _unresolvedIdentities; } }
 
        public bool ResolveInReferringUnitLocation { get; set; }
 
        public bool ResolveAgainstRunningFramework { get; set; }
 
        public event EventHandler<UnresolvedReference<IUnit, AssemblyIdentity>> UnableToResolve;
 
        public void AddLibPaths(IEnumerable<string> paths)
        {
            if (paths == null)
                return;
 
            foreach (var path in paths)
                AddLibPath(path);
        }
 
        public void Cleanup()
        {
            _reader = null;
        }
 
        public override IUnit LoadUnitFrom(string location)
        {
            IUnit unit = _reader.OpenModule(
                BinaryDocument.GetBinaryDocumentForFile(location, this));
 
            this.RegisterAsLatest(unit);
            return unit;
        }
 
        public IAssembly LoadAssemblyFrom(string location)
        {
            return LoadUnitFrom(location) as IAssembly;
        }
 
        /// <summary>
        /// Loads the unit from the given stream. The caller should dispose the
        /// stream after the API is called (the stream contents will have been copied
        /// to unmanaged memory already).
        /// </summary>
        /// <param name="location">The location to be exposed from IUnit</param>
        /// <param name="stream">The data to be used as the unit</param>
        public IUnit LoadUnitFrom(string location, Stream stream)
        {
            string fileName = Path.GetFileName(location);
            IName name = this.NameTable.GetNameFor(fileName);
            StreamDocument document = new StreamDocument(location, name, stream);
            IModule unit = _reader.OpenModule(document);
 
            this.RegisterAsLatest(unit);
            return unit;
        }
 
        public IAssembly LoadAssemblyFrom(string location, Stream stream)
        {
            return LoadUnitFrom(location, stream) as IAssembly;
        }
 
        public IAssembly LoadAssembly(string assemblyNameOrPath)
        {
            string path = assemblyNameOrPath;
 
            if (File.Exists(path))
                return this.LoadAssemblyFrom(path);
 
            foreach (var extension in s_probingExtensions)
            {
                path = ProbeLibPaths(assemblyNameOrPath + extension);
                if (path != null)
                {
                    var assembly = this.LoadAssembly(path);
                    if (assembly == null) continue;
                    return assembly;
                }
            }
 
            return null;
        }
 
        private AssemblyIdentity ProbeLibPaths(AssemblyIdentity identity)
        {
            foreach (var libPath in LibPaths)
            {
                AssemblyIdentity probedIdentity = this.Probe(libPath, identity);
                if (probedIdentity != null)
                    return probedIdentity;
            }
            return new AssemblyIdentity(identity, "");
        }
 
        private string ProbeLibPaths(string assemblyPath)
        {
            if (File.Exists(assemblyPath))
                return assemblyPath;
 
            foreach (var libPath in LibPaths)
            {
                string combinedPath = Path.Combine(libPath, assemblyPath);
                if (File.Exists(combinedPath))
                    return combinedPath;
            }
            return null;
        }
 
        // Potential way to unify assemblies based on the current runtime
        //public override void ResolvingAssemblyReference(IUnit referringUnit, AssemblyIdentity referencedAssembly)
        //{
        //    IAssemblyReference asmRef = referringUnit.UnitReferences.OfType<IAssemblyReference>()
        //        .FirstOrDefault(a => referencedAssembly.Equals(a.UnifiedAssemblyIdentity));
 
        //    if (asmRef != null && asmRef.IsRetargetable)
        //    {
        //        string strongName = UnitHelper.StrongName(asmRef);
        //        string retargetedName = AppDomain.CurrentDomain.ApplyPolicy(strongName);
        //        if (strongName != retargetedName)
        //        {
        //            System.Reflection.AssemblyName name = new System.Reflection.AssemblyName(retargetedName);
 
        //            referencedAssembly = new AssemblyIdentity(this.NameTable.GetNameFor(name.Name),
        //                name.CultureInfo != null ? name.CultureInfo.Name : "", name.Version, name.GetPublicKeyToken(), "");
        //        }
        //    }
        //    base.ResolvingAssemblyReference(referringUnit, referencedAssembly);
        //}
 
        private static string[] s_probingExtensions = new string[]
        {
            ".dll",
            ".ildll",
            ".ni.dll",
            ".winmd",
            ".exe",
            ".ilexe",
            //".ni.exe" Do these actually exist?
        };
 
        protected override AssemblyIdentity Probe(string probeDir, AssemblyIdentity referencedAssembly)
        {
            Contract.Requires(probeDir != null);
            Contract.Requires(referencedAssembly != null);
 
            string path = null;
            foreach (var extension in s_probingExtensions)
            {
                path = Path.Combine(probeDir, referencedAssembly.Name.Value + extension);
                if (File.Exists(path))
                {
                    // Possible that we might find an assembly with a matching extension but without a match identity
                    // or possibly be a native version of the assembly so if that fails we should try other extensions.
                    var assembly = this.LoadUnitFrom(path) as IAssembly;
                    if (assembly == null) continue;
 
                    if (this.UnifyToLibPath)
                    {
                        // If Unifying to LibPath then we only verify the assembly name matches.
                        if (assembly.AssemblyIdentity.Name.UniqueKeyIgnoringCase != referencedAssembly.Name.UniqueKeyIgnoringCase) continue;
                    }
                    else
                    {
                        if (!assembly.AssemblyIdentity.Equals(referencedAssembly)) continue;
                    }
                    return assembly.AssemblyIdentity;
                }
            }
            return null;
        }
 
        protected override AssemblyIdentity GetCoreAssemblySymbolicIdentity()
        {
            // If explicitly set return that identity
            if (_coreAssemblyIdentity != null)
                return _coreAssemblyIdentity;
 
            IAssembly[] loadedAssemblies = this.LoadedUnits.OfType<IAssembly>().ToArray();
 
            foreach (var assembly in loadedAssemblies)
            {
                AssemblyIdentity coreIdentity = ResolveCoreAssemblyIdentity(assembly);
 
                if (coreIdentity != null)
                {
                    return coreIdentity;
                }
            }
 
            // Otherwise fallback to CCI's default core assembly loading logic.
            return base.GetCoreAssemblySymbolicIdentity();
        }
 
        private AssemblyIdentity ResolveCoreAssemblyIdentity(IAssembly assembly)
        {
            AssemblyIdentity coreIdentity = assembly.CoreAssemblySymbolicIdentity;
            HashSet<AssemblyIdentity> consideredIdentities = new HashSet<AssemblyIdentity>();
 
            // Try to find the assembly which believes itself is the core assembly
            while (!assembly.AssemblyIdentity.Equals(coreIdentity))
            {
                // CCI may not be able to identify the core assembly if no types are referenced
                if (coreIdentity == Dummy.AssemblyIdentity)
                {
                    // try the first referenced assembly we haven't already checked and walk down from there.
                    coreIdentity = assembly.AssemblyReferences
                        .Select(ar => ar.AssemblyIdentity)
                        .FirstOrDefault(ai => !consideredIdentities.Contains(ai));
                }
 
                // if we couldn't find a new identity to try, or we've already tried this identity, give up
                if (coreIdentity == null || consideredIdentities.Contains(coreIdentity))
                {
                    return null;
                }
 
                // track all considered identities, this will prevent us from entering a cycle
                consideredIdentities.Add(coreIdentity);
 
                // unify to the version of the identify found in our paths
                coreIdentity = ProbeLibPaths(coreIdentity);
 
                // load it to see which assembly it believes to be the core
                assembly = LoadAssembly(coreIdentity);
 
                if (assembly == null || assembly == Dummy.Assembly)
                {
                    return null;
                }
 
                coreIdentity = assembly.CoreAssemblySymbolicIdentity;
            }
 
            return coreIdentity;
        }
 
        public void SetCoreAssembly(AssemblyIdentity coreAssembly)
        {
            if (_coreAssemblyIdentity != null)
            {
                throw new InvalidOperationException("The Core Assembly can only be set once.");
            }
            // Lets ignore this if someone passes dummy as nothing good can come from it. We considered making it an error 
            // but in some logical cases (i.e. facades) the CoreAssembly might be dummy and we don't want to start throwing 
            // in a bunch of cases where if we let it go the right thing will happen.
            if (coreAssembly == Dummy.AssemblyIdentity)
                return;
 
            _coreAssemblyIdentity = coreAssembly;
        }
 
        private AssemblyIdentity FindUnifiedAssemblyIdentity(AssemblyIdentity identity)
        {
            Contract.Assert(this.UnifyToLibPath);
 
            // Find exact assembly match
            IAssembly asm = this.FindAssembly(identity);
 
            if (asm != null && !(asm is Dummy))
                return asm.AssemblyIdentity;
 
            // Find assembly match based on simple name only. (It might be worth caching these results if we find them to be too expensive)
            foreach (var loadedAssembly in this.LoadedUnits.OfType<IAssembly>())
            {
                if (loadedAssembly.AssemblyIdentity.Name.UniqueKeyIgnoringCase == identity.Name.UniqueKeyIgnoringCase)
                    return loadedAssembly.AssemblyIdentity;
            }
 
            AssemblyIdentity probedIdentity = this.ProbeLibPaths(identity);
            if (probedIdentity != null)
                return probedIdentity;
 
            return new AssemblyIdentity(identity, "");
        }
 
        /// <summary>
        /// Default implementation of UnifyAssembly. Override this method to change the behavior.
        /// </summary>
        public override AssemblyIdentity UnifyAssembly(AssemblyIdentity assemblyIdentity)
        {
            if (ShouldUnifyToCoreAssembly(assemblyIdentity))
                return this.CoreAssemblySymbolicIdentity;
 
 
            if (this.UnifyToLibPath)
                assemblyIdentity = this.FindUnifiedAssemblyIdentity(assemblyIdentity);
 
            return assemblyIdentity;
        }
 
        // Managed WinMDs: Their 'BCL' reference looks like this:
        // .assembly extern mscorlib
        // {
        //   .publickeytoken = (B7 7A 5C 56 19 34 E0 89 )
        //   .ver 255:255:255:255
        // }
        private static readonly byte[] s_ecmaKey = { 0xb7, 0x7a, 0x5c, 0x56, 0x19, 0x34, 0xe0, 0x89 };
        private static readonly Version s_winmdBclVersion = new Version(255, 255, 255, 255);
        public bool ShouldUnifyToCoreAssembly(AssemblyIdentity assemblyIdentity)
        {
            // Unify any other potential versions of this core assembly to itself. 
            if (assemblyIdentity.Name.UniqueKeyIgnoringCase == this.CoreAssemblySymbolicIdentity.Name.UniqueKeyIgnoringCase)
            {
                if (assemblyIdentity.PublicKeyToken == null ||
                   !assemblyIdentity.PublicKeyToken.SequenceEqual(this.CoreAssemblySymbolicIdentity.PublicKeyToken))
                    return false;
 
                return true;
            }
 
            // Unify the mscorlib 255.255.255.255 used by winmds back to corefx to avoid the need for yet 
            // another facade.
            if (assemblyIdentity.Name.Value == "mscorlib")
            {
                if (assemblyIdentity.PublicKeyToken == null || !assemblyIdentity.PublicKeyToken.SequenceEqual(s_ecmaKey))
                    return false;
                if (!(assemblyIdentity.Version.Equals(s_winmdBclVersion)))
                    return false;
 
                return true;
            }
 
            return false;
        }
 
        /// <summary>
        ///  Override ProbeAssemblyReference to ensure we only look in the LibPaths for resolving assemblies and 
        ///  we don't accidentally find some in the GAC or in the framework directory. 
        /// </summary>
        public override AssemblyIdentity ProbeAssemblyReference(IUnit referringUnit, AssemblyIdentity referencedAssembly)
        {
            // We need to ensure the core assembly is being unified and in some code paths, such as from GetCoreAssemblySymbolicIdentity
            // it doesn't get properly unified before calling ProbeAssemblyReference
            if (this.CoreAssemblySymbolicIdentity.Equals(referencedAssembly))
                referencedAssembly = UnifyAssembly(referencedAssembly);
 
            AssemblyIdentity result = null;
 
            if (this.ResolveInReferringUnitLocation)
            {
                // NOTE: When probing for the core assembly, the referring unit is a dummy unit and thus does not have
                //       a location.
 
                string referringDir = string.IsNullOrEmpty(referringUnit.Location) ? null
                                     : Path.GetDirectoryName(Path.GetFullPath(referringUnit.Location));
 
                result = string.IsNullOrEmpty(referringDir) ? null
                       : this.Probe(referringDir, referencedAssembly);
 
                if (result != null) return result;
            }
 
            // Probe in the libPaths directories
            foreach (string libPath in this.LibPaths)
            {
                result = this.Probe(libPath, referencedAssembly);
                if (result != null) return result;
            }
 
            if (this.ResolveAgainstRunningFramework)
            {
                // Call base probe which has logic to check the frameworks installed on the machine
                result = base.ProbeAssemblyReference(referringUnit, referencedAssembly);
 
                if (result != null && result.Location != null && !result.Location.StartsWith("unknown"))
                    return result;
            }
 
            var unresolved = new UnresolvedReference<IUnit, AssemblyIdentity>(referringUnit, referencedAssembly);
 
            OnUnableToResolve(unresolved);
 
            // Give up
            return new AssemblyIdentity(referencedAssembly, "unknown://location");
        }
 
        protected virtual void OnUnableToResolve(UnresolvedReference<IUnit, AssemblyIdentity> unresolved)
        {
            var unableToResolve = this.UnableToResolve;
            if (unableToResolve != null)
                unableToResolve(this, unresolved);
 
            this.UnresolvedIdentities.Add(unresolved);
        }
 
        // Overriding this method allows us to read the binaries without blocking the files. The default
        // implementation will use a memory mapped file (MMF) which causes the files to be locked. That
        // means you can delete them, but you can't overwrite them in-place, which is especially painful
        // when reading binaries directly from a build output folder.
        //
        // Measuring indicated that performance implications are negligible. That's why we decided to
        // make this the default and not exposing any (more) options to our ctor.
        public override IBinaryDocumentMemoryBlock OpenBinaryDocument(IBinaryDocument sourceDocument)
        {
            // First let's see whether the document is a stream-based document. In that case, we'll
            // call the overload that processes the stream.
            var streamDocument = sourceDocument as StreamDocument;
            if (streamDocument != null)
                return UnmanagedBinaryMemoryBlock.CreateUnmanagedBinaryMemoryBlock(streamDocument.Stream, sourceDocument);
 
            // Otherwise we assume that we can load the data from the location of sourceDocument.
            try
            {
                var memoryBlock = UnmanagedBinaryMemoryBlock.CreateUnmanagedBinaryMemoryBlock(sourceDocument.Location, sourceDocument);
                disposableObjectAllocatedByThisHost.Add(memoryBlock);
                return memoryBlock;
            }
            catch (IOException)
            {
                return null;
            }
        }
 
        #region Assembly Set and Path Helpers
 
        public static string[] SplitPaths(string pathSet)
        {
            if (pathSet == null)
                return new string[0];
 
            return pathSet.Split(new char[] { ',', ';' }, StringSplitOptions.RemoveEmptyEntries);
        }
 
        public static IEnumerable<IAssembly> LoadAssemblySet(params string[] paths)
        {
            HostEnvironment host = new HostEnvironment();
            return host.LoadAssemblies(paths);
        }
 
        private string GetCoreAssemblyFile(string coreAssemblySimpleName, IEnumerable<string> contractSet)
        {
            var coreAssemblyFile = contractSet.FirstOrDefault(c => Path.GetFileNameWithoutExtension(c).EndsWith(coreAssemblySimpleName, StringComparison.OrdinalIgnoreCase) == true);
            if (string.IsNullOrEmpty(coreAssemblyFile))
            {
                throw new InvalidOperationException(string.Format("Could not find core assembly '{0}' in the list of contracts.", coreAssemblySimpleName));
            }
 
            return coreAssemblyFile;
        }
 
        public ReadOnlyCollection<IAssembly> LoadAssemblies(string unsplitContractSet)
        {
            return LoadAssemblies(unsplitContractSet, string.Empty);
        }
 
        public ReadOnlyCollection<IAssembly> LoadAssemblies(string unsplitContractSet, string coreAssemblySimpleName)
        {
            List<string> contractSet = new List<string>(GetFilePathsAndAddResolvedDirectoriesToLibPaths(SplitPaths(unsplitContractSet)));
            string coreAssemblyFile = null;
 
            if (!string.IsNullOrEmpty(coreAssemblySimpleName))
            {
                // Otherwise, rearrange the list such that the specified coreAssembly is the first one in the list.
                coreAssemblyFile = GetCoreAssemblyFile(coreAssemblySimpleName, contractSet);
 
                contractSet.Remove(coreAssemblyFile);
                contractSet.Insert(0, coreAssemblyFile);
            }
 
            ReadOnlyCollection<IAssembly> assemblies = LoadAssemblies(contractSet);
 
            // Explicitly set the core assembly
            if (coreAssemblyFile != null && assemblies.Count > 0)
                SetCoreAssembly(assemblies[0].AssemblyIdentity);
 
            return assemblies;
        }
 
        public ErrorTreatment LoadErrorTreatment
        {
            get;
            set;
        }
 
        // False by default for backwards compatibility with tools that wire in their own custom handlers.
        private bool _traceResolutionErrorsAsLoadErrors;
        public bool TraceResolutionErrorsAsLoadErrors
        {
            get
            {
                return _traceResolutionErrorsAsLoadErrors;
            }
            set
            {
                if (value != _traceResolutionErrorsAsLoadErrors)
                {
                    if (value)
                    {
                        this.UnableToResolve += TraceResolveErrorAsLoadError;
                    }
                    else
                    {
                        this.UnableToResolve -= TraceResolveErrorAsLoadError;
                    }
 
                    _traceResolutionErrorsAsLoadErrors = value;
                }
            }
        }
 
        private void TraceResolveErrorAsLoadError(object sender, UnresolvedReference<IUnit, AssemblyIdentity> e)
        {
            TraceLoadError("Unable to resolve reference to {0}.", e.Unresolved);
        }
 
        public void TraceLoadError(string format, params object[] arguments)
        {
            switch (LoadErrorTreatment)
            {
                case ErrorTreatment.Default:
                default:
                    Trace.TraceError(format, arguments);
                    break;
 
                case ErrorTreatment.TreatAsWarning:
                    Trace.TraceWarning(format, arguments);
                    break;
 
                case ErrorTreatment.Ignore:
                    break;
            }
        }
 
        public ReadOnlyCollection<IAssembly> LoadAssemblies(IEnumerable<string> paths)
        {
            List<IAssembly> assemblySet = new List<IAssembly>();
            IAssembly assembly = null;
 
            foreach (string file in GetFilePathsAndAddResolvedDirectoriesToLibPaths(paths))
            {
                string filePath = ProbeLibPaths(file);
                if (filePath == null)
                {
                    TraceLoadError("File does not exist {0}", file);
                    continue;
                }
 
                assembly = this.LoadAssembly(filePath);
                if (assembly == null)
                {
                    TraceLoadError("Failed to load assembly {0}", filePath);
                    continue;
                }
 
                assemblySet.Add(assembly);
            }
 
            if (assemblySet.Count == 0)
            {
                TraceLoadError("No assemblies loaded for {0}", string.Join(", ", paths));
            }
 
            return new ReadOnlyCollection<IAssembly>(assemblySet);
        }
 
        public ReadOnlyCollection<IAssembly> LoadAssemblies(IEnumerable<string> paths, string coreAssemblySimpleName)
        {
            // Re-arrange the list of paths so that the coreAssembly is the first one in the list.
            if (!string.IsNullOrEmpty(coreAssemblySimpleName))
            {
                var coreAssemblyFile = GetCoreAssemblyFile(coreAssemblySimpleName, paths);
 
                paths = Enumerable.Concat(new List<string>() { coreAssemblyFile }, paths.Where(ai => !StringComparer.OrdinalIgnoreCase.Equals(ai, coreAssemblyFile)));
            }
 
            return LoadAssemblies(paths);
        }
 
        public IEnumerable<IAssembly> LoadAssemblies(IEnumerable<AssemblyIdentity> identities)
        {
            return LoadAssemblies(identities, false);
        }
 
        public IEnumerable<IAssembly> LoadAssemblies(IEnumerable<AssemblyIdentity> identities, bool warnOnVersionMismatch)
        {
            List<IAssembly> matchingAssemblies = new List<IAssembly>();
            foreach (var unmappedIdentity in identities)
            {
                // Remap the name and clear the location.
                AssemblyIdentity identity = new AssemblyIdentity(this.NameTable.GetNameFor(unmappedIdentity.Name.Value),
                    unmappedIdentity.Culture, unmappedIdentity.Version, unmappedIdentity.PublicKeyToken, "");
 
                AssemblyIdentity matchingIdentity = this.ProbeLibPaths(identity);
 
                var matchingAssembly = this.LoadAssembly(matchingIdentity);
                if (matchingAssembly == null || matchingAssembly == Dummy.Assembly)
                {
                    TraceLoadError("Failed to find or load matching assembly '{0}'.", identity.Name.Value);
                    continue;
                }
 
                if (warnOnVersionMismatch && !identity.Version.Equals(matchingAssembly.Version))
                {
                    Trace.TraceWarning("Found '{0}' with version '{1}' instead of '{2}'.",
                        identity.Name.Value, matchingAssembly.Version, identity.Version);
                }
 
                string idPKT = identity.GetPublicKeyToken();
                string matchingPKT = matchingAssembly.GetPublicKeyToken();
 
                if (!idPKT.Equals(matchingPKT))
                {
                    Trace.TraceWarning("Found '{0}' with PublicKeyToken '{1}' instead of '{2}'.",
                        identity.Name.Value, matchingPKT, idPKT);
                }
 
                matchingAssemblies.Add(matchingAssembly);
            }
 
            return matchingAssemblies;
        }
 
        public IEnumerable<IAssembly> LoadAssemblies(IEnumerable<AssemblyIdentity> identities, bool warnOnVersionMismatch, string coreAssemblySimpleName)
        {
            // Re-arrange the list of identities so that the coreIdentity is the first one in the list.
            if (!string.IsNullOrEmpty(coreAssemblySimpleName))
            {
                var coreIdentity = identities.FirstOrDefault(ai => StringComparer.OrdinalIgnoreCase.Equals(ai.Name.Value, coreAssemblySimpleName));
 
                if (coreIdentity == null)
                {
                    throw new InvalidOperationException(String.Format("Could not find core assembly '{0}' in the list of identities.", coreAssemblySimpleName));
                }
 
                identities = Enumerable.Concat(new List<AssemblyIdentity>() { coreIdentity }, identities.Where(ai => ai != coreIdentity));
            }
 
            return LoadAssemblies(identities, warnOnVersionMismatch);
        }
 
        public static IEnumerable<string> GetFilePaths(IEnumerable<string> paths, SearchOption searchOption)
        {
            if (searchOption == SearchOption.TopDirectoryOnly)
                return GetFilePaths(paths);
 
            // expand the path into a list of paths that contains all the subdirectories
            Stack<string> unexpandedPaths = new Stack<string>(paths);
 
            HashSet<string> allPaths = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
 
            foreach (var path in paths)
            {
                allPaths.Add(path);
 
                // if the path did not point to a directory, continue
                if (!Directory.Exists(path))
                    continue;
 
                foreach (var dir in Directory.EnumerateDirectories(path, "*.*", SearchOption.AllDirectories))
                {
                    allPaths.Add(dir);
                }
            }
 
            // make sure we remove any duplicated folders (ie. if the user specified both a root folder and a leaf one)
            return GetFilePaths(allPaths);
        }
 
        public static IEnumerable<string> GetFilePaths(IEnumerable<string> paths)
        {
            return GetFilePaths(paths, (resolvedPath) => { });
        }
 
        private IEnumerable<string> GetFilePathsAndAddResolvedDirectoriesToLibPaths(IEnumerable<string> paths)
        {
            return GetFilePaths(paths, (resolvedPath) => this.LibPaths.Add(resolvedPath));
        }
 
        private static IEnumerable<string> GetFilePaths(IEnumerable<string> paths, Action<string> perResolvedPathAction, bool recursive = false)
        {
            foreach (var path in paths)
            {
                if (path == null)
                    continue;
 
                string resolvedPath = Environment.ExpandEnvironmentVariables(path);
 
                if (Directory.Exists(resolvedPath))
                {
                    perResolvedPathAction(resolvedPath);
 
                    for (int extIndex = 0; extIndex < s_probingExtensions.Length; extIndex++)
                    {
                        var searchPattern = "*" + s_probingExtensions[extIndex];
                        foreach (var file in Directory.EnumerateFiles(resolvedPath, searchPattern))
                        {
                            yield return file;
                        }
                    }
                    if (recursive)
                    {
                        //recursively do the same for sub-folders
                        foreach (var file in GetFilePaths(Directory.EnumerateDirectories(resolvedPath), perResolvedPathAction, recursive))
                        {
                            yield return file;
                        }
                    }
                }
                else if (Path.GetFileName(resolvedPath).Contains('*'))
                {
                    IEnumerable<string> files;
 
                    // Cannot yield a value in the body of a try-catch with catch clause.
                    try
                    {
                        files = Directory.EnumerateFiles(Path.GetDirectoryName(resolvedPath), Path.GetFileName(resolvedPath));
                    }
                    catch (ArgumentException)
                    {
                        files = new[] { resolvedPath };
                    }
 
                    foreach (var file in files)
                        yield return file;
                }
                else
                {
                    yield return resolvedPath;
                }
            }
        }
 
        #endregion
 
        private sealed class StreamDocument : IBinaryDocument
        {
            private readonly string _location;
            private readonly IName _name;
            private readonly Stream _stream;
 
            public StreamDocument(string location, IName name, Stream stream)
            {
                _stream = stream;
                _location = location;
                _name = name;
            }
 
            public string Location
            {
                get { return _location; }
            }
 
            public IName Name
            {
                get { return _name; }
            }
 
            public Stream Stream
            {
                get { return _stream; }
            }
 
            public uint Length
            {
                get { return (uint)_stream.Length; }
            }
        }
    }
 
    public class UnresolvedReference<TReferrer, TUnresolved> : EventArgs
    {
        public UnresolvedReference(TReferrer referrer, TUnresolved unresolvedReference)
        {
            this.Referrer = referrer;
            this.Unresolved = unresolvedReference;
        }
 
        public TReferrer Referrer { get; private set; }
        public TUnresolved Unresolved { get; private set; }
    }
}