aboutsummaryrefslogtreecommitdiff
path: root/lib/Plugins.Runtime/src/IPluginAssemblyLoader.cs
blob: 2d047033d116e02272424e9191637f970cdb1ac2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
/*
* Copyright (c) 2023 Vaughn Nugent
* 
* Library: VNLib
* Package: VNLib.Plugins.Runtime
* File: IPluginAssemblyLoader.cs 
*
* IPluginAssemblyLoader.cs is part of VNLib.Plugins.Runtime which is 
* part of the larger VNLib collection of libraries and utilities.
*
* VNLib.Plugins.Runtime is free software: you can redistribute it and/or modify 
* it under the terms of the GNU General Public License as published
* by the Free Software Foundation, either version 2 of the License,
* or (at your option) any later version.
*
* VNLib.Plugins.Runtime is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License 
* along with VNLib.Plugins.Runtime. If not, see http://www.gnu.org/licenses/.
*/

using System;
using System.Reflection;

namespace VNLib.Plugins.Runtime
{
    /// <summary>
    /// Represents the bare assembly loader that gets a main assembly for a plugin and handles
    /// type resolution, while providing loading/unloading
    /// </summary>
    public interface IPluginAssemblyLoader : IDisposable
    {
        /// <summary>
        /// Gets the plugin's configuration information
        /// </summary>
        IPluginConfig Config { get; }

        /// <summary>
        /// Unloads the assembly loader if Config.Unloadable is true, otherwise does nothing
        /// </summary>
        void Unload();

        /// <summary>
        /// Prepares the loader for use
        /// </summary>
        void Load();

        /// <summary>
        /// Begins the loading process and recovers the default assembly
        /// </summary>
        /// <returns>The main assembly from the assembly file</returns>
        Assembly GetAssembly();
    }
}