aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Region/Framework
diff options
context:
space:
mode:
authorHomer Horwitz2009-04-05 17:08:11 +0000
committerHomer Horwitz2009-04-05 17:08:11 +0000
commit648452dd91e07be4ec0e81793807e86bd48362c4 (patch)
tree4c1e7f1e48381fd9049efd5eda6440f885af86a4 /OpenSim/Region/Framework
parent- Move IWindModule to OpenSim.Region.Framework.Interfaces (diff)
downloadopensim-SC_OLD-648452dd91e07be4ec0e81793807e86bd48362c4.zip
opensim-SC_OLD-648452dd91e07be4ec0e81793807e86bd48362c4.tar.gz
opensim-SC_OLD-648452dd91e07be4ec0e81793807e86bd48362c4.tar.bz2
opensim-SC_OLD-648452dd91e07be4ec0e81793807e86bd48362c4.tar.xz
- Add new RegionModulesControllerPlugin to the application modules
- Change several classes to use the new plugin for handling of region-modules (NOTE: No regionmodule is using this yet) - Add necessary prebuild parts (don't forget to runprebuild) Attention: Work in progress. This shouldn't break anything, but you never know...
Diffstat (limited to 'OpenSim/Region/Framework')
-rw-r--r--OpenSim/Region/Framework/Interfaces/INonSharedRegionModule.cs35
-rw-r--r--OpenSim/Region/Framework/Interfaces/IRegionModuleBase.cs76
-rw-r--r--OpenSim/Region/Framework/Interfaces/IRegionModulesController.cs38
-rw-r--r--OpenSim/Region/Framework/Interfaces/ISharedRegionModule.cs40
-rw-r--r--OpenSim/Region/Framework/Scenes/SceneBase.cs65
5 files changed, 247 insertions, 7 deletions
diff --git a/OpenSim/Region/Framework/Interfaces/INonSharedRegionModule.cs b/OpenSim/Region/Framework/Interfaces/INonSharedRegionModule.cs
new file mode 100644
index 0000000..b8af866
--- /dev/null
+++ b/OpenSim/Region/Framework/Interfaces/INonSharedRegionModule.cs
@@ -0,0 +1,35 @@
1/*
2 * Copyright (c) Contributors, http://opensimulator.org/
3 * See CONTRIBUTORS.TXT for a full list of copyright holders.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of the OpenSim Project nor the
13 * names of its contributors may be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
17 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28using System;
29
30namespace OpenSim.Region.Framework.Interfaces
31{
32 public interface INonSharedRegionModule : IRegionModuleBase
33 {
34 }
35}
diff --git a/OpenSim/Region/Framework/Interfaces/IRegionModuleBase.cs b/OpenSim/Region/Framework/Interfaces/IRegionModuleBase.cs
new file mode 100644
index 0000000..265b464
--- /dev/null
+++ b/OpenSim/Region/Framework/Interfaces/IRegionModuleBase.cs
@@ -0,0 +1,76 @@
1/*
2 * Copyright (c) Contributors, http://opensimulator.org/
3 * See CONTRIBUTORS.TXT for a full list of copyright holders.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of the OpenSim Project nor the
13 * names of its contributors may be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
17 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28using System;
29using Mono.Addins;
30using Nini.Config;
31using OpenSim.Region.Framework.Scenes;
32
33namespace OpenSim.Region.Framework.Interfaces
34{
35 public interface IRegionModuleBase
36 {
37 /// <value>
38 /// The name of the module
39 /// </value>
40 string Name { get; }
41
42 /// <summary>
43 /// This is called to initialize the region module. For shared modules, this is called
44 /// exactly once, after creating the single (shared) instance. For non-shared modules,
45 /// this is called once on each instance, after the instace for the region has been created.
46 /// </summary>
47 /// <param name="source">
48 /// A <see cref="IConfigSource"/>
49 /// </param>
50 void Initialise(IConfigSource source);
51
52 /// <summary>
53 /// This is the inverse to <see cref="Initialise"/>. After a Close(), this instance won't be usable anymore.
54 /// </summary>
55 void Close();
56
57 /// <summary>
58 /// This is called whenever a <see cref="Scene"/> is added. For shared modules, this can happen several times.
59 /// For non-shared modules, this happens exactly once, after <see cref="Initialise"/> has been called.
60 /// </summary>
61 /// <param name="scene">
62 /// A <see cref="Scene"/>
63 /// </param>
64 void AddRegion(Scene scene);
65
66 /// <summary>
67 /// This is called whenever a <see cref="Scene"/> is removed. For shared modules, this can happen several times.
68 /// For non-shared modules, this happens exactly once, if the scene this instance is associated with is removed.
69 /// </summary>
70 /// <param name="scene">
71 /// A <see cref="Scene"/>
72 /// </param>
73 void RemoveRegion(Scene scene);
74 }
75
76}
diff --git a/OpenSim/Region/Framework/Interfaces/IRegionModulesController.cs b/OpenSim/Region/Framework/Interfaces/IRegionModulesController.cs
new file mode 100644
index 0000000..d38c962
--- /dev/null
+++ b/OpenSim/Region/Framework/Interfaces/IRegionModulesController.cs
@@ -0,0 +1,38 @@
1/*
2 * Copyright (c) Contributors, http://opensimulator.org/
3 * See CONTRIBUTORS.TXT for a full list of copyright holders.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of the OpenSim Project nor the
13 * names of its contributors may be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
17 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28using System;
29using OpenSim.Region.Framework.Scenes;
30
31namespace OpenSim.Region.Framework.Interfaces
32{
33 public interface IRegionModulesController
34 {
35 void AddRegionToModules(Scene scene);
36 void RemoveRegionFromModules (Scene scene);
37 }
38}
diff --git a/OpenSim/Region/Framework/Interfaces/ISharedRegionModule.cs b/OpenSim/Region/Framework/Interfaces/ISharedRegionModule.cs
new file mode 100644
index 0000000..d0b6ecc
--- /dev/null
+++ b/OpenSim/Region/Framework/Interfaces/ISharedRegionModule.cs
@@ -0,0 +1,40 @@
1/*
2 * Copyright (c) Contributors, http://opensimulator.org/
3 * See CONTRIBUTORS.TXT for a full list of copyright holders.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of the OpenSim Project nor the
13 * names of its contributors may be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
17 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28using System;
29
30namespace OpenSim.Region.Framework.Interfaces
31{
32 public interface ISharedRegionModule : IRegionModuleBase
33 {
34 /// <summary>
35 /// This is called exactly once after all the shared region-modules have been instanciated and
36 /// <see cref="IRegionModuleBase.Initialise"/>d.
37 /// </summary>
38 void PostInitialise();
39 }
40}
diff --git a/OpenSim/Region/Framework/Scenes/SceneBase.cs b/OpenSim/Region/Framework/Scenes/SceneBase.cs
index 3695b21..42f3d97 100644
--- a/OpenSim/Region/Framework/Scenes/SceneBase.cs
+++ b/OpenSim/Region/Framework/Scenes/SceneBase.cs
@@ -59,13 +59,19 @@ namespace OpenSim.Region.Framework.Scenes
59 } 59 }
60 protected Dictionary<string, IRegionModule> m_modules = new Dictionary<string, IRegionModule>(); 60 protected Dictionary<string, IRegionModule> m_modules = new Dictionary<string, IRegionModule>();
61 61
62 public Dictionary<string, IRegionModuleBase> RegionModules
63 {
64 get { return m_regionModules; }
65 }
66 private Dictionary<string, IRegionModuleBase> m_regionModules = new Dictionary<string, IRegionModuleBase>();
67
62 /// <value> 68 /// <value>
63 /// The module interfaces available from this scene. 69 /// The module interfaces available from this scene.
64 /// </value> 70 /// </value>
65 protected Dictionary<Type, List<object>> ModuleInterfaces = new Dictionary<Type, List<object>>(); 71 protected Dictionary<Type, List<object>> ModuleInterfaces = new Dictionary<Type, List<object>>();
66 72
67 protected Dictionary<string, object> ModuleAPIMethods = new Dictionary<string, object>(); 73 protected Dictionary<string, object> ModuleAPIMethods = new Dictionary<string, object>();
68 74
69 /// <value> 75 /// <value>
70 /// The module commanders available from this scene 76 /// The module commanders available from this scene
71 /// </value> 77 /// </value>
@@ -235,7 +241,7 @@ namespace OpenSim.Region.Framework.Scenes
235 } 241 }
236 } 242 }
237 Modules.Clear(); 243 Modules.Clear();
238 244
239 try 245 try
240 { 246 {
241 EventManager.TriggerShutdown(); 247 EventManager.TriggerShutdown();
@@ -279,6 +285,24 @@ namespace OpenSim.Region.Framework.Scenes
279 } 285 }
280 286
281 /// <summary> 287 /// <summary>
288 /// Add a region-module to this scene. TODO: This will replace AddModule in the future.
289 /// </summary>
290 /// <param name="name"></param>
291 /// <param name="module"></param>
292 public void AddRegionModule(string name, IRegionModuleBase module)
293 {
294 if (!RegionModules.ContainsKey(name))
295 {
296 RegionModules.Add(name, module);
297 }
298 }
299
300 public void RemoveRegionModule(string name)
301 {
302 RegionModules.Remove(name);
303 }
304
305 /// <summary>
282 /// Register a module commander. 306 /// Register a module commander.
283 /// </summary> 307 /// </summary>
284 /// <param name="commander"></param> 308 /// <param name="commander"></param>
@@ -368,6 +392,25 @@ namespace OpenSim.Region.Framework.Scenes
368 } 392 }
369 } 393 }
370 394
395 public void UnregisterModuleInterface<M>(M mod)
396 {
397 List<Object> l;
398 if (ModuleInterfaces.TryGetValue(typeof(M), out l))
399 {
400 if (l.Remove(mod))
401 {
402 if (mod is IEntityCreator)
403 {
404 IEntityCreator entityCreator = (IEntityCreator)mod;
405 foreach (PCode pcode in entityCreator.CreationCapabilities)
406 {
407 m_entityCreators[pcode] = null;
408 }
409 }
410 }
411 }
412 }
413
371 public void StackModuleInterface<M>(M mod) 414 public void StackModuleInterface<M>(M mod)
372 { 415 {
373 List<Object> l; 416 List<Object> l;
@@ -462,11 +505,19 @@ namespace OpenSim.Region.Framework.Scenes
462 505
463 if (mod != null) 506 if (mod != null)
464 { 507 {
465 if (!(mod is IRegionModule)) 508 if (mod is IRegionModule)
466 throw new Exception("AddCommand module parameter must be IRegionModule"); 509 {
467 IRegionModule module = (IRegionModule)mod; 510 IRegionModule module = (IRegionModule)mod;
468 modulename = module.Name; 511 modulename = module.Name;
469 shared = module.IsSharedModule; 512 shared = module.IsSharedModule;
513 }
514 else if (mod is IRegionModuleBase)
515 {
516 IRegionModuleBase module = (IRegionModuleBase)mod;
517 modulename = module.Name;
518 shared = mod is ISharedRegionModule;
519 }
520 else throw new Exception("AddCommand module parameter must be IRegionModule or IRegionModuleBase");
470 } 521 }
471 522
472 MainConsole.Instance.Commands.AddCommand(modulename, shared, command, shorthelp, longhelp, callback); 523 MainConsole.Instance.Commands.AddCommand(modulename, shared, command, shorthelp, longhelp, callback);