aboutsummaryrefslogtreecommitdiffstats
path: root/ServiceBasedPlugins/src/pluginsupport/UPluginManager.pas
blob: 6c7f5056a57719fb25228ca540ec1df5158b6764 (plain) (blame)
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
{* UltraStar Deluxe - Karaoke Game
 *
 * UltraStar Deluxe is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program 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.
 *
 * This program 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 this program; see the file COPYING. If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 *
 * $URL: https://ultrastardx.svn.sourceforge.net/svnroot/ultrastardx/trunk/src/base/UMain.pas $
 * $Id: UMain.pas 1629 2009-03-07 22:30:04Z k-m_schindler $
 *}
unit UPluginManager;

{ this class manages all loaded plugins }

interface

{$IFDEF FPC}
  {$MODE Delphi}
{$ENDIF}

{$I switches.inc}

uses Classes, UPluginDefines;

type
  TPluginManager = class
    private
      NextHandle: TUS_Handle;

      Plugins: TInterfaceList;
      Events: TInterfaceList;
      Interfaces: TInterfaceList;

    public
      constructor Create;

      //returns a unique handle to use e.g. w/ a pluginloader
      function GetHandle: TUS_Handle;

      //returns the plugin w/ the specified handle
      function GetPluginbyHandle(Handle: TUS_Handle): IUS_Plugin;

      //just adds a plugin to the pluginlist
      //it will be inited on next call of init
      function AddPlugin(Plugin: IInterface): TUS_Handle;

      procedure Init;   //< inits all plugins w/ status psWaitingInit
      procedure DeInit; //< deinits all plugins w/ status psInited

      //called by plugins if they change to status psError
      //removes all saved data and callbacks by this handle
      procedure ReportError(Handle: TUS_Handle);

      destructor Destroy;
  end;

var
  PluginManager: TPluginManager;

implementation
uses SysUtils;

constructor TPluginManager.Create;
begin
  NextHandle := US_HANDLE_CORE + 1;

  Plugins := TInterfaceList.Create;
  Events := TInterfaceList.Create;
  Interfaces := TInterfaceList.Create;
end;

destructor TPluginManager.Destroy;
begin
  DeInit;

  Plugins.Destroy;
  Events.Destroy;
  Interfaces.Destroy;
end;

// returns a unique handle to use e.g. w/ a pluginloader
function TPluginManager.GetHandle: TUS_Handle;
begin
  Result := NextHandle;
  Inc(NextHandle);
end;

//returns the plugin w/ the specified handle
function TPluginManager.GetPluginbyHandle(Handle: TUS_Handle): IUS_Plugin; 
  var
    I: integer;
    Plugin: IUS_Plugin;
begin
  Result := nil;
  for I := 0 to Plugins.Count-1 do
  begin
    Plugin := IUS_Plugin(Plugins.Items[I]);
    If (Plugin.GetHandle = Handle) then
    begin
      Result := Plugin;
      Exit;
    end;
  end;
end;

// just adds a plugin to the pluginlist
// it will be inited on next call of init
function TPluginManager.AddPlugin(Plugin: IInterface): TUS_Handle;
begin
  If Supports(Plugin, IUS_Plugin) then
    Plugins.Add(Plugin);
end;

// inits all plugins w/ status psWaitingInit
procedure TPluginManager.Init;
  var
    I: integer;
    Plugin: IUS_Plugin;
begin
  for I := 0 to Plugins.Count-1 do
  begin
    Plugin := IUS_Plugin(Plugins.Items[I]);
    If (Plugin.GetStatus = psWaitingInit) then
    begin
      Plugin.Init;
    end;
  end;
end;

// deinits all plugins w/ status psInited
procedure TPluginManager.DeInit;
  var
    I: integer;
    Plugin: IUS_Plugin;
begin
  for I := 0 to Plugins.Count-1 do
  begin
    Plugin := IUS_Plugin(Plugins.Items[I]);
    If (Plugin.GetStatus = psInited) then
    begin
      Plugin.DeInit;
    end;
  end;
end;

//called by plugins if they change to errorstate
//removes all saved data and callbacks by this handle
procedure TPluginManager.ReportError(Handle: TUS_Handle);
  var
    I: integer;
    Event: IUS_HookableEvent;
begin
  for I := 0 to Events.Count-1 do
  begin
    Event := IUS_HookableEvent(Events.Items[I]);
    Event.UnHookbyParent(Handle);
  end;
end;

end.