OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
MockConsole.cs
Go to the documentation of this file.
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.Threading;
30 using System.Collections.Generic;
31 using System.Text;
32 using System.Xml;
33 
34 namespace OpenSim.Framework.Console
35 {
42  {
43 #pragma warning disable 0067
44  public event OnOutputDelegate OnOutput;
45 #pragma warning restore 0067
46 
47  private MockCommands m_commands = new MockCommands();
48 
49  public ICommands Commands { get { return m_commands; } }
50 
51  public string DefaultPrompt { get; set; }
52 
53  public void Prompt() {}
54 
55  public void RunCommand(string cmd) {}
56 
57  public string ReadLine(string p, bool isCommand, bool e) { return ""; }
58 
59  public object ConsoleScene {
60  get { return null; }
61  set {}
62  }
63 
64  public void Output(string text, string level) {}
65  public void Output(string text) {}
66  public void OutputFormat(string format, params object[] components) {}
67 
68  public string CmdPrompt(string p) { return ""; }
69  public string CmdPrompt(string p, string def) { return ""; }
70  public string CmdPrompt(string p, List<char> excludedCharacters) { return ""; }
71  public string CmdPrompt(string p, string def, List<char> excludedCharacters) { return ""; }
72 
73  public string CmdPrompt(string prompt, string defaultresponse, List<string> options) { return ""; }
74 
75  public string PasswdPrompt(string p) { return ""; }
76  }
77 
78  public class MockCommands : ICommands
79  {
80  public void FromXml(XmlElement root, CommandDelegate fn) {}
81  public List<string> GetHelp(string[] cmd) { return null; }
82  public void AddCommand(string module, bool shared, string command, string help, string longhelp, CommandDelegate fn) {}
83  public void AddCommand(string module, bool shared, string command, string help, string longhelp, string descriptivehelp, CommandDelegate fn) {}
84  public string[] FindNextOption(string[] cmd, bool term) { return null; }
85  public bool HasCommand(string cmd) { return false; }
86  public string[] Resolve(string[] cmd) { return null; }
87  public XmlElement GetXml(XmlDocument doc) { return null; }
88  }
89 }
void AddCommand(string module, bool shared, string command, string help, string longhelp, string descriptivehelp, CommandDelegate fn)
Add a command to those which can be invoked from the console.
Definition: MockConsole.cs:83
string CmdPrompt(string p, string def)
Definition: MockConsole.cs:69
void FromXml(XmlElement root, CommandDelegate fn)
Definition: MockConsole.cs:80
string[] Resolve(string[] cmd)
Definition: MockConsole.cs:86
delegate void CommandDelegate(string module, string[] cmd)
string CmdPrompt(string prompt, string defaultresponse, List< string > options)
Definition: MockConsole.cs:73
string CmdPrompt(string p, string def, List< char > excludedCharacters)
Definition: MockConsole.cs:71
string CmdPrompt(string p, List< char > excludedCharacters)
Definition: MockConsole.cs:70
void Prompt()
Display a command prompt on the console and wait for user input
Definition: MockConsole.cs:53
void OutputFormat(string format, params object[] components)
Definition: MockConsole.cs:66
delegate void OnOutputDelegate(string message)
string ReadLine(string p, bool isCommand, bool e)
Definition: MockConsole.cs:57
XmlElement GetXml(XmlDocument doc)
Definition: MockConsole.cs:87
void Output(string text, string level)
Definition: MockConsole.cs:64
This is a Fake console that's used when setting up the Scene in Unit Tests Don't use this except for ...
Definition: MockConsole.cs:41
string[] FindNextOption(string[] cmd, bool term)
Definition: MockConsole.cs:84
List< string > GetHelp(string[] cmd)
Get help for the given help string
Definition: MockConsole.cs:81
bool HasCommand(string cmd)
Has the given command already been registered?
Definition: MockConsole.cs:85
void AddCommand(string module, bool shared, string command, string help, string longhelp, CommandDelegate fn)
Add a command to those which can be invoked from the console.
Definition: MockConsole.cs:82