clockwerk-opensim – Blame information for rev 1

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