From 65448cd02d2b07ef04a87678dd685d443f4eb836 Mon Sep 17 00:00:00 2001 From: Justin Clarke Casey Date: Thu, 5 Feb 2009 19:34:23 +0000 Subject: * refactor: Split out module Command class into a separate file --- .../Framework/InterfaceCommander/Command.cs | 204 +++++++++++++++++++++ .../Framework/InterfaceCommander/Commander.cs | 171 ----------------- 2 files changed, 204 insertions(+), 171 deletions(-) create mode 100644 OpenSim/Region/Environment/Modules/Framework/InterfaceCommander/Command.cs (limited to 'OpenSim/Region/Environment/Modules/Framework/InterfaceCommander') diff --git a/OpenSim/Region/Environment/Modules/Framework/InterfaceCommander/Command.cs b/OpenSim/Region/Environment/Modules/Framework/InterfaceCommander/Command.cs new file mode 100644 index 0000000..6642bdc --- /dev/null +++ b/OpenSim/Region/Environment/Modules/Framework/InterfaceCommander/Command.cs @@ -0,0 +1,204 @@ +/* + * Copyright (c) Contributors, http://opensimulator.org/ + * See CONTRIBUTORS.TXT for a full list of copyright holders. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * * Neither the name of the OpenSim Project nor the + * names of its contributors may be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY + * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY + * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * 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 + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +using System; +using System.Collections.Generic; +using OpenSim.Region.Environment.Interfaces; + +namespace OpenSim.Region.Environment.Modules.Framework.InterfaceCommander +{ + /// + /// 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 + /// + public class Command : ICommand + { + //private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType); + private List m_args = new List(); + + private Action m_command; + private string m_help; + private string m_name; + private CommandIntentions m_intentions; //A permission type system could implement this and know what a command intends on doing. + + public Command(string name, CommandIntentions intention, Action command, string help) + { + m_name = name; + m_command = command; + m_help = help; + m_intentions = intention; + } + + #region ICommand Members + + public void AddArgument(string name, string helptext, string type) + { + m_args.Add(new CommandArgument(name, helptext, type)); + } + + public string Name + { + get { return m_name; } + } + + public CommandIntentions Intentions + { + get { return m_intentions; } + } + + public string Help + { + get { return m_help; } + } + + public Dictionary Arguments + { + get + { + Dictionary tmp = new Dictionary(); + foreach (CommandArgument arg in m_args) + { + tmp.Add(arg.Name, arg.ArgumentType); + } + return tmp; + } + } + + public void ShowConsoleHelp() + { + Console.WriteLine("== " + Name + " =="); + Console.WriteLine(m_help); + Console.WriteLine("= Parameters ="); + foreach (CommandArgument arg in m_args) + { + Console.WriteLine("* " + arg.Name + " (" + arg.ArgumentType + ")"); + Console.WriteLine("\t" + arg.HelpText); + } + } + + public void Run(Object[] args) + { + Object[] cleanArgs = new Object[m_args.Count]; + + if (args.Length < cleanArgs.Length) + { + Console.WriteLine("ERROR: Missing " + (cleanArgs.Length - args.Length) + " argument(s)"); + ShowConsoleHelp(); + return; + } + if (args.Length > cleanArgs.Length) + { + Console.WriteLine("ERROR: Too many arguments for this command. Type ' help' for help."); + return; + } + + int i = 0; + foreach (Object arg in args) + { + if (string.IsNullOrEmpty(arg.ToString())) + { + Console.WriteLine("ERROR: Empty arguments are not allowed"); + return; + } + try + { + switch (m_args[i].ArgumentType) + { + case "String": + m_args[i].ArgumentValue = arg.ToString(); + break; + case "Integer": + m_args[i].ArgumentValue = Int32.Parse(arg.ToString()); + break; + case "Double": + m_args[i].ArgumentValue = Double.Parse(arg.ToString()); + break; + case "Boolean": + m_args[i].ArgumentValue = Boolean.Parse(arg.ToString()); + break; + default: + Console.WriteLine("ERROR: Unknown desired type for argument " + m_args[i].Name + " on command " + m_name); + break; + } + } + catch (FormatException) + { + Console.WriteLine("ERROR: Argument number " + (i + 1) + + " (" + m_args[i].Name + ") must be a valid " + + m_args[i].ArgumentType.ToLower() + "."); + return; + } + cleanArgs[i] = m_args[i].ArgumentValue; + + i++; + } + + m_command.Invoke(cleanArgs); + } + + #endregion + } + + /// + /// A single command argument, contains name, type and at runtime, value. + /// + public class CommandArgument + { + private string m_help; + private string m_name; + private string m_type; + private Object m_val; + + public CommandArgument(string name, string help, string type) + { + m_name = name; + m_help = help; + m_type = type; + } + + public string Name + { + get { return m_name; } + } + + public string HelpText + { + get { return m_help; } + } + + public string ArgumentType + { + get { return m_type; } + } + + public Object ArgumentValue + { + get { return m_val; } + set { m_val = value; } + } + } +} diff --git a/OpenSim/Region/Environment/Modules/Framework/InterfaceCommander/Commander.cs b/OpenSim/Region/Environment/Modules/Framework/InterfaceCommander/Commander.cs index ae34d37..8b19043 100644 --- a/OpenSim/Region/Environment/Modules/Framework/InterfaceCommander/Commander.cs +++ b/OpenSim/Region/Environment/Modules/Framework/InterfaceCommander/Commander.cs @@ -36,177 +36,6 @@ using OpenSim.Region.Environment.Interfaces; namespace OpenSim.Region.Environment.Modules.Framework.InterfaceCommander { /// - /// 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 - /// - public class Command : ICommand - { - //private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType); - private List m_args = new List(); - - private Action m_command; - private string m_help; - private string m_name; - private CommandIntentions m_intentions; //A permission type system could implement this and know what a command intends on doing. - - public Command(string name, CommandIntentions intention, Action command, string help) - { - m_name = name; - m_command = command; - m_help = help; - m_intentions = intention; - } - - #region ICommand Members - - public void AddArgument(string name, string helptext, string type) - { - m_args.Add(new CommandArgument(name, helptext, type)); - } - - public string Name - { - get { return m_name; } - } - - public CommandIntentions Intentions - { - get { return m_intentions; } - } - - public string Help - { - get { return m_help; } - } - - public Dictionary Arguments - { - get - { - Dictionary tmp = new Dictionary(); - foreach (CommandArgument arg in m_args) - { - tmp.Add(arg.Name, arg.ArgumentType); - } - return tmp; - } - } - - public void ShowConsoleHelp() - { - Console.WriteLine("== " + Name + " =="); - Console.WriteLine(m_help); - Console.WriteLine("= Parameters ="); - foreach (CommandArgument arg in m_args) - { - Console.WriteLine("* " + arg.Name + " (" + arg.ArgumentType + ")"); - Console.WriteLine("\t" + arg.HelpText); - } - } - - public void Run(Object[] args) - { - Object[] cleanArgs = new Object[m_args.Count]; - - if (args.Length < cleanArgs.Length) - { - Console.WriteLine("ERROR: Missing " + (cleanArgs.Length - args.Length) + " argument(s)"); - ShowConsoleHelp(); - return; - } - if (args.Length > cleanArgs.Length) - { - Console.WriteLine("ERROR: Too many arguments for this command. Type ' help' for help."); - return; - } - - int i = 0; - foreach (Object arg in args) - { - if (string.IsNullOrEmpty(arg.ToString())) - { - Console.WriteLine("ERROR: Empty arguments are not allowed"); - return; - } - try - { - switch (m_args[i].ArgumentType) - { - case "String": - m_args[i].ArgumentValue = arg.ToString(); - break; - case "Integer": - m_args[i].ArgumentValue = Int32.Parse(arg.ToString()); - break; - case "Double": - m_args[i].ArgumentValue = Double.Parse(arg.ToString()); - break; - case "Boolean": - m_args[i].ArgumentValue = Boolean.Parse(arg.ToString()); - break; - default: - Console.WriteLine("ERROR: Unknown desired type for argument " + m_args[i].Name + " on command " + m_name); - break; - } - } - catch (FormatException) - { - Console.WriteLine("ERROR: Argument number " + (i + 1) + - " (" + m_args[i].Name + ") must be a valid " + - m_args[i].ArgumentType.ToLower() + "."); - return; - } - cleanArgs[i] = m_args[i].ArgumentValue; - - i++; - } - - m_command.Invoke(cleanArgs); - } - - #endregion - } - - /// - /// A single command argument, contains name, type and at runtime, value. - /// - public class CommandArgument - { - private string m_help; - private string m_name; - private string m_type; - private Object m_val; - - public CommandArgument(string name, string help, string type) - { - m_name = name; - m_help = help; - m_type = type; - } - - public string Name - { - get { return m_name; } - } - - public string HelpText - { - get { return m_help; } - } - - public string ArgumentType - { - get { return m_type; } - } - - public Object ArgumentValue - { - get { return m_val; } - set { m_val = value; } - } - } - - /// /// A class to enable modules to register console and script commands, which enforces typing and valid input. /// public class Commander : ICommander -- cgit v1.1