From 451c3d1dd7bd7fc64e741882040ae44f8c47518f Mon Sep 17 00:00:00 2001 From: Justin Clarke Casey Date: Sat, 12 Jul 2008 19:29:49 +0000 Subject: * Hive off ConsolePluginCommand into its own framework class --- OpenSim/Framework/Console/ConsolePluginCommand.cs | 139 ++++++++++++++++++++++ 1 file changed, 139 insertions(+) create mode 100644 OpenSim/Framework/Console/ConsolePluginCommand.cs (limited to 'OpenSim/Framework/Console/ConsolePluginCommand.cs') diff --git a/OpenSim/Framework/Console/ConsolePluginCommand.cs b/OpenSim/Framework/Console/ConsolePluginCommand.cs new file mode 100644 index 0000000..b3f1c93 --- /dev/null +++ b/OpenSim/Framework/Console/ConsolePluginCommand.cs @@ -0,0 +1,139 @@ +/* + * 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; + +namespace OpenSim.Framework.Console +{ + public delegate void ConsoleCommand(string[] comParams); + + /// + /// Holder object for a new console plugin command + /// + /// Override the methods like Run and IsHelpfull (but the defaults might work ok.) + /// + public class ConsolePluginCommand + { + /// + /// command delegate used in running + /// + private ConsoleCommand m_commandDelegate; + /// + /// help text displayed + /// + private string m_helpText; + /// + /// command in the form of "showme new commands" + /// + private string[] m_cmdText; + + /// + /// Construct a new ConsolePluginCommand + /// + /// for use with OpenSim.RegisterConsolePluginCommand(myCmd); + /// + /// + /// in the form of "showme new commands" + /// ommand delegate used in running + /// the text displayed in "help showme new commands" + public ConsolePluginCommand(string command, ConsoleCommand dlg, string help) + { + m_cmdText = command.Split(new char[] { ' ' }); + m_commandDelegate = dlg; + m_helpText = help; + } + + /// + /// Returns the match length this command has upon the 'cmdWithParams' + /// At least a higher number for "show plugin status" then "show" would return + /// This is used to have multi length command verbs + /// + /// @see OopenSim.RunPluginCommands + /// It will only run the one with the highest number + /// + /// + public int matchLength(string cmdWithParams) + { + // QUESTION: have a case insensitive flag? + cmdWithParams = cmdWithParams.ToLower().Trim(); + string matchText = String.Join(" ",m_cmdText).ToLower().Trim(); + if (cmdWithParams.StartsWith(matchText)) + { + // QUESTION Instead return cmdText.Length; ? + return matchText.Length; + } + return 0; + } + + /// + /// Run the delegate the incomming string may contain the command, if so, it is chopped off the cmdParams[] + /// + public void Run(string cmd, string[] cmdParams) + { + int skipParams = 0; + if (m_cmdText.Length > 1) + { + int currentParam = 1; + while (currentParam < m_cmdText.Length) + { + if (cmdParams[skipParams].ToLower().Equals(m_cmdText[currentParam].ToLower())) + { + skipParams++; + } + currentParam++; + } + + } + string[] sendCmdParams = cmdParams; + if (skipParams > 0) + { + sendCmdParams = new string[cmdParams.Length-skipParams]; + for (int i=0;i + /// Shows help information on the console's Notice method + /// + public void ShowHelp(ConsoleBase console) + { + console.Notice(String.Join(" ", m_cmdText) + " - " + m_helpText); + } + + /// + /// return true if the ShowHelp(..) method might be helpfull + /// + public bool IsHelpfull(string cmdWithParams) + { + cmdWithParams = cmdWithParams.ToLower(); + return cmdWithParams.Contains(String.Join(" ", m_cmdText).ToLower()) || m_helpText.ToLower().Contains(cmdWithParams); + } + } +} -- cgit v1.1 From 6ef9d4da901a346c232458317cca6268da888e2e Mon Sep 17 00:00:00 2001 From: Jeff Ames Date: Mon, 18 Aug 2008 00:39:10 +0000 Subject: Formatting cleanup. --- OpenSim/Framework/Console/ConsolePluginCommand.cs | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) (limited to 'OpenSim/Framework/Console/ConsolePluginCommand.cs') diff --git a/OpenSim/Framework/Console/ConsolePluginCommand.cs b/OpenSim/Framework/Console/ConsolePluginCommand.cs index b3f1c93..bf70645 100644 --- a/OpenSim/Framework/Console/ConsolePluginCommand.cs +++ b/OpenSim/Framework/Console/ConsolePluginCommand.cs @@ -30,10 +30,10 @@ using System; namespace OpenSim.Framework.Console { public delegate void ConsoleCommand(string[] comParams); - + /// /// Holder object for a new console plugin command - /// + /// /// Override the methods like Run and IsHelpfull (but the defaults might work ok.) /// public class ConsolePluginCommand @@ -52,10 +52,10 @@ namespace OpenSim.Framework.Console private string[] m_cmdText; /// - /// Construct a new ConsolePluginCommand - /// + /// Construct a new ConsolePluginCommand + /// /// for use with OpenSim.RegisterConsolePluginCommand(myCmd); - /// + /// /// /// in the form of "showme new commands" /// ommand delegate used in running @@ -68,13 +68,13 @@ namespace OpenSim.Framework.Console } /// - /// Returns the match length this command has upon the 'cmdWithParams' + /// Returns the match length this command has upon the 'cmdWithParams' /// At least a higher number for "show plugin status" then "show" would return /// This is used to have multi length command verbs - /// + /// /// @see OopenSim.RunPluginCommands /// It will only run the one with the highest number - /// + /// /// public int matchLength(string cmdWithParams) { @@ -106,8 +106,8 @@ namespace OpenSim.Framework.Console } currentParam++; } - - } + + } string[] sendCmdParams = cmdParams; if (skipParams > 0) { -- cgit v1.1 From 4065ebff15e228d7227500f3a2275025f5d16966 Mon Sep 17 00:00:00 2001 From: Melanie Thielker Date: Wed, 20 May 2009 13:50:33 +0000 Subject: Remove the pre-log4net, discrete output methods from the consoles --- OpenSim/Framework/Console/ConsolePluginCommand.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'OpenSim/Framework/Console/ConsolePluginCommand.cs') diff --git a/OpenSim/Framework/Console/ConsolePluginCommand.cs b/OpenSim/Framework/Console/ConsolePluginCommand.cs index bf70645..8b87239 100644 --- a/OpenSim/Framework/Console/ConsolePluginCommand.cs +++ b/OpenSim/Framework/Console/ConsolePluginCommand.cs @@ -124,7 +124,7 @@ namespace OpenSim.Framework.Console /// public void ShowHelp(ConsoleBase console) { - console.Notice(String.Join(" ", m_cmdText) + " - " + m_helpText); + console.Output(String.Join(" ", m_cmdText) + " - " + m_helpText); } /// -- cgit v1.1 From 840de6c036570d559ec6924cd8405d3f34a99fdd Mon Sep 17 00:00:00 2001 From: Jeff Ames Date: Mon, 1 Jun 2009 06:37:14 +0000 Subject: Minor: Change OpenSim to OpenSimulator in older copyright headers and LICENSE.txt. --- OpenSim/Framework/Console/ConsolePluginCommand.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'OpenSim/Framework/Console/ConsolePluginCommand.cs') diff --git a/OpenSim/Framework/Console/ConsolePluginCommand.cs b/OpenSim/Framework/Console/ConsolePluginCommand.cs index 8b87239..a2f31ea 100644 --- a/OpenSim/Framework/Console/ConsolePluginCommand.cs +++ b/OpenSim/Framework/Console/ConsolePluginCommand.cs @@ -9,7 +9,7 @@ * * 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 + * * Neither the name of the OpenSimulator Project nor the * names of its contributors may be used to endorse or promote products * derived from this software without specific prior written permission. * -- cgit v1.1 From c211a120a5045c4b1ccaac7bfe7db13f75804cc3 Mon Sep 17 00:00:00 2001 From: mbowman Date: Tue, 19 Jan 2010 15:50:30 -0800 Subject: Console output no longer requires loglevel to be set to info; you can run the simulator with log level WARN or ERROR and see the output of console commands Signed-off-by: Melanie --- OpenSim/Framework/Console/ConsolePluginCommand.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) mode change 100644 => 100755 OpenSim/Framework/Console/ConsolePluginCommand.cs (limited to 'OpenSim/Framework/Console/ConsolePluginCommand.cs') diff --git a/OpenSim/Framework/Console/ConsolePluginCommand.cs b/OpenSim/Framework/Console/ConsolePluginCommand.cs old mode 100644 new mode 100755 index a2f31ea..f4d3687 --- a/OpenSim/Framework/Console/ConsolePluginCommand.cs +++ b/OpenSim/Framework/Console/ConsolePluginCommand.cs @@ -124,7 +124,7 @@ namespace OpenSim.Framework.Console /// public void ShowHelp(ConsoleBase console) { - console.Output(String.Join(" ", m_cmdText) + " - " + m_helpText); + console.Output(String.Join(" ", m_cmdText) + " - " + m_helpText + "\n"); } /// -- cgit v1.1