source: branches/CodeEditor/HeuristicLab.ExtLibs/HeuristicLab.NRefactory/5.5.0/NRefactory-5.5.0/TypeSystem/AssemblyLoader.cs @ 11700

//
// AssemblyLoader.cs
//
// Author:
//       Mike KrÃŒger <mkrueger@xamarin.com>
//
// Copyright (c) 2013 Xamarin Inc. (http://xamarin.com)
//
// 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.Reflection;
using System.Threading;
using ICSharpCode.NRefactory.Documentation;
using ICSharpCode.NRefactory.TypeSystem;
using ICSharpCode.NRefactory.TypeSystem.Implementation;

namespace ICSharpCode.NRefactory.TypeSystem
{
  public enum AssemblyLoaderBackend {
    Auto,
    Cecil,
    IKVM
  }

  public abstract class AssemblyLoader
  {
    public static AssemblyLoader Create ()
    {
      return Create (AssemblyLoaderBackend.Auto);
    }
    
    public static AssemblyLoader Create (AssemblyLoaderBackend backend)
    {
      switch (backend) {
        case AssemblyLoaderBackend.Auto:
        case AssemblyLoaderBackend.Cecil:
          return (AssemblyLoader)Assembly.Load ("ICSharpCode.NRefactory.Cecil").CreateInstance ("ICSharpCode.NRefactory.TypeSystem.CecilLoader");
        case AssemblyLoaderBackend.IKVM:
          return (AssemblyLoader)Assembly.Load ("ICSharpCode.NRefactory.IKVM").CreateInstance ("ICSharpCode.NRefactory.TypeSystem.IkvmLoader");
        default:
          throw new ArgumentOutOfRangeException ();
      }
    }

    /// <summary>
    /// Specifies whether to include internal members. The default is false.
    /// </summary>
    public bool IncludeInternalMembers { get; set; }
    
    /// <summary>
    /// Gets/Sets the cancellation token used by the assembly loader.
    /// </summary>
    public CancellationToken CancellationToken { get; set; }
    
    /// <summary>
    /// Gets/Sets the documentation provider that is used to retrieve the XML documentation for all members.
    /// </summary>
    public IDocumentationProvider DocumentationProvider { get; set; }

    [CLSCompliant(false)]
    protected InterningProvider interningProvider = new SimpleInterningProvider();

    /// <summary>
    /// Gets/Sets the interning provider.
    /// </summary>
    public InterningProvider InterningProvider {
      get { return interningProvider; }
      set {
        if (value == null)
          throw new ArgumentNullException();
        interningProvider = value;
      }
    }
    
    public abstract IUnresolvedAssembly LoadAssemblyFile(string fileName);
  }
}