* Updating some file locations.

0.6.0-stable
Adam Frisby 2008-05-04 19:21:14 +00:00
parent ddb3a9bdf8
commit 07098978b9
4 changed files with 402 additions and 396 deletions

View File

@ -1,308 +1,313 @@
/* /*
* Copyright (c) Contributors, http://opensimulator.org/ * Copyright (c) Contributors, http://opensimulator.org/
* See CONTRIBUTORS.TXT for a full list of copyright holders. * See CONTRIBUTORS.TXT for a full list of copyright holders.
* *
* Redistribution and use in source and binary forms, with or without * Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met: * modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright * * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer. * notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright * * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the * notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution. * documentation and/or other materials provided with the distribution.
* * Neither the name of the OpenSim Project nor the * * Neither the name of the OpenSim Project nor the
* names of its contributors may be used to endorse or promote products * names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission. * derived from this software without specific prior written permission.
* *
* THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/ */
using System; using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.Reflection; using System.Reflection;
using System.Text; using System.Text;
using log4net; using log4net;
using OpenSim.Framework; using OpenSim.Framework;
using OpenSim.Region.Environment.Interfaces; using OpenSim.Region.Environment.Interfaces;
namespace OpenSim.Region.Environment.Modules.Framework namespace OpenSim.Region.Environment.Modules.Framework.InterfaceCommander
{ {
/// <summary> /// <summary>
/// A single function call encapsulated in a class which enforces arguments when passing around as Object[]'s. /// A single function call encapsulated in a class which enforces arguments when passing around as Object[]'s.
/// Used for console commands and script API generation /// Used for console commands and script API generation
/// </summary> /// </summary>
public class Command : ICommand public class Command : ICommand
{ {
private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType); private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
private List<CommandArgument> m_args = new List<CommandArgument>(); private List<CommandArgument> m_args = new List<CommandArgument>();
private Action<object[]> m_command; private Action<object[]> m_command;
private string m_help; private string m_help;
private string m_name; private string m_name;
public Command(string name, Action<Object[]> command, string help) public Command(string name, Action<Object[]> command, string help)
{ {
m_name = name; m_name = name;
m_command = command; m_command = command;
m_help = help; m_help = help;
} }
#region ICommand Members #region ICommand Members
public void AddArgument(string name, string helptext, string type) public void AddArgument(string name, string helptext, string type)
{ {
m_args.Add(new CommandArgument(name, helptext, type)); m_args.Add(new CommandArgument(name, helptext, type));
} }
public string Name public string Name
{ {
get { return m_name; } get { return m_name; }
} }
public string Help public string Help
{ {
get { return m_help; } get { return m_help; }
} }
public Dictionary<string, string> Arguments public Dictionary<string, string> Arguments
{ {
get get
{ {
Dictionary<string, string> tmp = new Dictionary<string, string>(); Dictionary<string, string> tmp = new Dictionary<string, string>();
foreach (CommandArgument arg in m_args) foreach (CommandArgument arg in m_args)
{ {
tmp.Add(arg.Name, arg.ArgumentType); tmp.Add(arg.Name, arg.ArgumentType);
} }
return tmp; return tmp;
} }
} }
public void ShowConsoleHelp() public void ShowConsoleHelp()
{ {
m_log.Info("== " + Name + " =="); m_log.Info("== " + Name + " ==");
m_log.Info(m_help); m_log.Info(m_help);
m_log.Info("= Parameters ="); m_log.Info("= Parameters =");
foreach (CommandArgument arg in m_args) foreach (CommandArgument arg in m_args)
{ {
m_log.Info("* " + arg.Name + " (" + arg.ArgumentType + ")"); m_log.Info("* " + arg.Name + " (" + arg.ArgumentType + ")");
m_log.Info("\t" + arg.HelpText); m_log.Info("\t" + arg.HelpText);
} }
} }
public void Run(Object[] args) public void Run(Object[] args)
{ {
Object[] cleanArgs = new Object[m_args.Count]; Object[] cleanArgs = new Object[m_args.Count];
if (args.Length < cleanArgs.Length) if (args.Length < cleanArgs.Length)
{ {
m_log.Error("Missing " + (cleanArgs.Length - args.Length) + " argument(s)"); m_log.Error("Missing " + (cleanArgs.Length - args.Length) + " argument(s)");
ShowConsoleHelp(); ShowConsoleHelp();
return; return;
} }
if (args.Length > cleanArgs.Length) if (args.Length > cleanArgs.Length)
{ {
m_log.Error("Too many arguments for this command. Type '<module> <command> help' for help."); m_log.Error("Too many arguments for this command. Type '<module> <command> help' for help.");
return; return;
} }
int i = 0; int i = 0;
foreach (Object arg in args) foreach (Object arg in args)
{ {
if (string.IsNullOrEmpty(arg.ToString())) if (string.IsNullOrEmpty(arg.ToString()))
{ {
m_log.Error("Empty arguments are not allowed"); m_log.Error("Empty arguments are not allowed");
return; return;
} }
try try
{ {
switch (m_args[i].ArgumentType) switch (m_args[i].ArgumentType)
{ {
case "String": case "String":
m_args[i].ArgumentValue = arg.ToString(); m_args[i].ArgumentValue = arg.ToString();
break; break;
case "Integer": case "Integer":
m_args[i].ArgumentValue = Int32.Parse(arg.ToString()); m_args[i].ArgumentValue = Int32.Parse(arg.ToString());
break; break;
case "Double": case "Double":
m_args[i].ArgumentValue = Double.Parse(arg.ToString()); m_args[i].ArgumentValue = Double.Parse(arg.ToString());
break; break;
case "Boolean": case "Boolean":
m_args[i].ArgumentValue = Boolean.Parse(arg.ToString()); m_args[i].ArgumentValue = Boolean.Parse(arg.ToString());
break; break;
default: default:
m_log.Error("Unknown desired type for argument " + m_args[i].Name + " on command " + m_name); m_log.Error("Unknown desired type for argument " + m_args[i].Name + " on command " + m_name);
break; break;
} }
} }
catch (FormatException) catch (FormatException)
{ {
m_log.Error("Argument number " + (i + 1) + m_log.Error("Argument number " + (i + 1) +
" (" + m_args[i].Name + ") must be a valid " + " (" + m_args[i].Name + ") must be a valid " +
m_args[i].ArgumentType.ToLower() + "."); m_args[i].ArgumentType.ToLower() + ".");
} }
cleanArgs[i] = m_args[i].ArgumentValue; cleanArgs[i] = m_args[i].ArgumentValue;
i++; i++;
} }
m_command.Invoke(cleanArgs); m_command.Invoke(cleanArgs);
} }
#endregion #endregion
} }
/// <summary> /// <summary>
/// A single command argument, contains name, type and at runtime, value. /// A single command argument, contains name, type and at runtime, value.
/// </summary> /// </summary>
public class CommandArgument public class CommandArgument
{ {
private string m_help; private string m_help;
private string m_name; private string m_name;
private string m_type; private string m_type;
private Object m_val; private Object m_val;
public CommandArgument(string name, string help, string type) public CommandArgument(string name, string help, string type)
{ {
m_name = name; m_name = name;
m_help = help; m_help = help;
m_type = type; m_type = type;
} }
public string Name public string Name
{ {
get { return m_name; } get { return m_name; }
} }
public string HelpText public string HelpText
{ {
get { return m_help; } get { return m_help; }
} }
public string ArgumentType public string ArgumentType
{ {
get { return m_type; } get { return m_type; }
} }
public Object ArgumentValue public Object ArgumentValue
{ {
get { return m_val; } get { return m_val; }
set { m_val = value; } set { m_val = value; }
} }
} }
/// <summary> /// <summary>
/// A class to enable modules to register console and script commands, which enforces typing and valid input. /// A class to enable modules to register console and script commands, which enforces typing and valid input.
/// </summary> /// </summary>
public class Commander : ICommander public class Commander : ICommander
{ {
private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType); private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
private Dictionary<string, ICommand> m_commands = new Dictionary<string, ICommand>(); private Dictionary<string, ICommand> m_commands = new Dictionary<string, ICommand>();
private string m_name; private string m_name;
public Commander(string name) public Commander(string name)
{ {
m_name = name; m_name = name;
} }
#region ICommander Members public Dictionary<string, ICommand> Commands
{
public void RegisterCommand(string commandName, ICommand command) get { return m_commands; }
{ }
m_commands[commandName] = command;
} #region ICommander Members
/// <summary> public void RegisterCommand(string commandName, ICommand command)
/// Generates a runtime C# class which can be compiled and inserted via reflection to enable modules to register new script commands {
/// </summary> m_commands[commandName] = command;
/// <returns>Returns C# source code to create a binding</returns> }
public string GenerateRuntimeAPI()
{ /// <summary>
string classSrc = "\n\tpublic class " + m_name + " {\n"; /// Generates a runtime C# class which can be compiled and inserted via reflection to enable modules to register new script commands
foreach (ICommand com in m_commands.Values) /// </summary>
{ /// <returns>Returns C# source code to create a binding</returns>
classSrc += "\tpublic void " + EscapeRuntimeAPICommand(com.Name) + "( "; public string GenerateRuntimeAPI()
foreach (KeyValuePair<string, string> arg in com.Arguments) {
{ string classSrc = "\n\tpublic class " + m_name + " {\n";
classSrc += arg.Value + " " + Util.Md5Hash(arg.Key) + ","; foreach (ICommand com in m_commands.Values)
} {
classSrc = classSrc.Remove(classSrc.Length - 1); // Delete the last comma classSrc += "\tpublic void " + EscapeRuntimeAPICommand(com.Name) + "( ";
classSrc += " )\n\t{\n"; foreach (KeyValuePair<string, string> arg in com.Arguments)
classSrc += "\t\tObject[] args = new Object[" + com.Arguments.Count.ToString() + "];\n"; {
int i = 0; classSrc += arg.Value + " " + Util.Md5Hash(arg.Key) + ",";
foreach (KeyValuePair<string, string> arg in com.Arguments) }
{ classSrc = classSrc.Remove(classSrc.Length - 1); // Delete the last comma
classSrc += "\t\targs[" + i.ToString() + "] = " + Util.Md5Hash(arg.Key) + " " + ";\n"; classSrc += " )\n\t{\n";
i++; classSrc += "\t\tObject[] args = new Object[" + com.Arguments.Count.ToString() + "];\n";
} int i = 0;
classSrc += "\t\tGetCommander(\"" + m_name + "\").Run(\"" + com.Name + "\", args);\n"; foreach (KeyValuePair<string, string> arg in com.Arguments)
classSrc += "\t}\n"; {
} classSrc += "\t\targs[" + i.ToString() + "] = " + Util.Md5Hash(arg.Key) + " " + ";\n";
classSrc += "}\n"; i++;
}
return classSrc; classSrc += "\t\tGetCommander(\"" + m_name + "\").Run(\"" + com.Name + "\", args);\n";
} classSrc += "\t}\n";
}
/// <summary> classSrc += "}\n";
/// Runs a specified function with attached arguments
/// *** <b>DO NOT CALL DIRECTLY.</b> *** return classSrc;
/// Call ProcessConsoleCommand instead if handling human input. }
/// </summary>
/// <param name="function">The function name to call</param> /// <summary>
/// <param name="args">The function parameters</param> /// Runs a specified function with attached arguments
public void Run(string function, object[] args) /// *** <b>DO NOT CALL DIRECTLY.</b> ***
{ /// Call ProcessConsoleCommand instead if handling human input.
m_commands[function].Run(args); /// </summary>
} /// <param name="function">The function name to call</param>
/// <param name="args">The function parameters</param>
public void ProcessConsoleCommand(string function, string[] args) public void Run(string function, object[] args)
{ {
if (m_commands.ContainsKey(function)) m_commands[function].Run(args);
{ }
if (args.Length > 0 && args[0] == "help")
{ public void ProcessConsoleCommand(string function, string[] args)
m_commands[function].ShowConsoleHelp(); {
} if (m_commands.ContainsKey(function))
else {
{ if (args.Length > 0 && args[0] == "help")
m_commands[function].Run(args); {
} m_commands[function].ShowConsoleHelp();
} }
else else
{ {
if (function != "help") m_commands[function].Run(args);
m_log.Error("Invalid command - No such command exists"); }
if (function == "api") }
m_log.Info(GenerateRuntimeAPI()); else
ShowConsoleHelp(); {
} if (function != "help")
} m_log.Error("Invalid command - No such command exists");
if (function == "api")
#endregion m_log.Info(GenerateRuntimeAPI());
ShowConsoleHelp();
private void ShowConsoleHelp() }
{ }
m_log.Info("===" + m_name + "===");
foreach (ICommand com in m_commands.Values) #endregion
{
m_log.Info("* " + com.Name + " - " + com.Help); private void ShowConsoleHelp()
} {
} m_log.Info("===" + m_name + "===");
foreach (ICommand com in m_commands.Values)
private string EscapeRuntimeAPICommand(string command) {
{ m_log.Info("* " + com.Name + " - " + com.Help);
command = command.Replace('-', '_'); }
StringBuilder tmp = new StringBuilder(command); }
tmp[0] = tmp[0].ToString().ToUpper().ToCharArray()[0];
private string EscapeRuntimeAPICommand(string command)
return tmp.ToString(); {
} command = command.Replace('-', '_');
} StringBuilder tmp = new StringBuilder(command);
tmp[0] = tmp[0].ToString().ToUpper().ToCharArray()[0];
return tmp.ToString();
}
}
} }

View File

@ -1,88 +1,89 @@
/* /*
* Copyright (c) Contributors, http://opensimulator.org/ * Copyright (c) Contributors, http://opensimulator.org/
* See CONTRIBUTORS.TXT for a full list of copyright holders. * See CONTRIBUTORS.TXT for a full list of copyright holders.
* *
* Redistribution and use in source and binary forms, with or without * Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met: * modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright * * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer. * notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright * * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the * notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution. * documentation and/or other materials provided with the distribution.
* * Neither the name of the OpenSim Project nor the * * Neither the name of the OpenSim Project nor the
* names of its contributors may be used to endorse or promote products * names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission. * derived from this software without specific prior written permission.
* *
* THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/ */
using System; using System;
using Nini.Config; using Nini.Config;
using OpenSim.Region.Environment.Interfaces; using OpenSim.Region.Environment.Interfaces;
using OpenSim.Region.Environment.Scenes; using OpenSim.Region.Environment.Modules.Framework.InterfaceCommander;
using OpenSim.Region.Environment.Scenes;
namespace OpenSim.Region.Environment.Modules.Framework
{ namespace OpenSim.Region.Environment.Modules.Framework.InterfaceCommander
public class CommanderTestModule : IRegionModule, ICommandableModule {
{ public class CommanderTestModule : IRegionModule, ICommandableModule
private Commander m_commander = new Commander("CommanderTest"); {
private Scene m_scene; private readonly Commander m_commander = new Commander("CommanderTest");
private Scene m_scene;
#region ICommandableModule Members
#region ICommandableModule Members
public ICommander CommandInterface
{ public ICommander CommandInterface
get { throw new NotImplementedException(); } {
} get { throw new NotImplementedException(); }
}
#endregion
#endregion
#region IRegionModule Members
#region IRegionModule Members
public void Initialise(Scene scene, IConfigSource source)
{ public void Initialise(Scene scene, IConfigSource source)
m_scene = scene; {
} m_scene = scene;
}
public void PostInitialise()
{ public void PostInitialise()
Command testCommand = new Command("hello", InterfaceHelloWorld, "Says a simple debugging test string"); {
testCommand.AddArgument("world", "Write world here", "string"); Command testCommand = new Command("hello", InterfaceHelloWorld, "Says a simple debugging test string");
testCommand.AddArgument("world", "Write world here", "string");
m_commander.RegisterCommand("hello", testCommand);
m_commander.RegisterCommand("hello", testCommand);
// Register me
m_scene.RegisterModuleCommander("commandertest", m_commander); // Register me
} m_scene.RegisterModuleCommander("commandertest", m_commander);
}
public void Close()
{ public void Close()
} {
}
public string Name
{ public string Name
get { return "CommanderTestModule"; } {
} get { return "CommanderTestModule"; }
}
public bool IsSharedModule
{ public bool IsSharedModule
get { return false; } {
} get { return false; }
}
#endregion
#endregion
private void InterfaceHelloWorld(Object[] args)
{ private void InterfaceHelloWorld(Object[] args)
Console.WriteLine("Hello World"); {
} Console.WriteLine("Hello World");
} }
}
} }

View File

@ -30,7 +30,7 @@ using System.Collections.Generic;
using System.IO; using System.IO;
using Nini.Config; using Nini.Config;
using OpenSim.Region.Environment.Interfaces; using OpenSim.Region.Environment.Interfaces;
using OpenSim.Region.Environment.Modules.Framework; using OpenSim.Region.Environment.Modules.Framework.InterfaceCommander;
using OpenSim.Region.Environment.Scenes; using OpenSim.Region.Environment.Scenes;
namespace OpenSim.Region.Environment.Modules.World.Serialiser namespace OpenSim.Region.Environment.Modules.World.Serialiser

View File

@ -34,7 +34,7 @@ using log4net;
using Nini.Config; using Nini.Config;
using OpenSim.Framework; using OpenSim.Framework;
using OpenSim.Region.Environment.Interfaces; using OpenSim.Region.Environment.Interfaces;
using OpenSim.Region.Environment.Modules.Framework; using OpenSim.Region.Environment.Modules.Framework.InterfaceCommander;
using OpenSim.Region.Environment.Modules.World.Terrain.FileLoaders; using OpenSim.Region.Environment.Modules.World.Terrain.FileLoaders;
using OpenSim.Region.Environment.Modules.World.Terrain.FloodBrushes; using OpenSim.Region.Environment.Modules.World.Terrain.FloodBrushes;
using OpenSim.Region.Environment.Modules.World.Terrain.PaintBrushes; using OpenSim.Region.Environment.Modules.World.Terrain.PaintBrushes;