ICommandConsole.cs 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899
  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 OpenSimulator 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. using System;
  28. using System.Collections.Generic;
  29. using System.Xml;
  30. namespace OpenSim.Framework
  31. {
  32. public delegate void CommandDelegate(string module, string[] cmd);
  33. public interface ICommands
  34. {
  35. void FromXml(XmlElement root, CommandDelegate fn);
  36. /// <summary>
  37. /// Get help for the given help string
  38. /// </summary>
  39. /// <param name="cmd">Parsed parts of the help string. If empty then general help is returned.</param>
  40. /// <returns></returns>
  41. List<string> GetHelp(string[] cmd);
  42. /// <summary>
  43. /// Add a command to those which can be invoked from the console.
  44. /// </summary>
  45. /// <param name="module"></param>
  46. /// <param name="command"></param>
  47. /// <param name="help"></param>
  48. /// <param name="longhelp"></param>
  49. /// <param name="fn"></param>
  50. void AddCommand(string module, bool shared, string command, string help, string longhelp, CommandDelegate fn);
  51. /// <summary>
  52. /// Add a command to those which can be invoked from the console.
  53. /// </summary>
  54. /// <param name="module"></param>
  55. /// <param name="command"></param>
  56. /// <param name="help"></param>
  57. /// <param name="longhelp"></param>
  58. /// <param name="descriptivehelp"></param>
  59. /// <param name="fn"></param>
  60. void AddCommand(string module, bool shared, string command,
  61. string help, string longhelp, string descriptivehelp,
  62. CommandDelegate fn);
  63. string[] FindNextOption(string[] cmd, bool term);
  64. string[] Resolve(string[] cmd);
  65. XmlElement GetXml(XmlDocument doc);
  66. }
  67. public delegate void OnOutputDelegate(string message);
  68. public interface ICommandConsole : IConsole
  69. {
  70. event OnOutputDelegate OnOutput;
  71. ICommands Commands { get; }
  72. /// <summary>
  73. /// The default prompt text.
  74. /// </summary>
  75. string DefaultPrompt { get; set; }
  76. /// <summary>
  77. /// Display a command prompt on the console and wait for user input
  78. /// </summary>
  79. void Prompt();
  80. void RunCommand(string cmd);
  81. string ReadLine(string p, bool isCommand, bool e);
  82. }
  83. }