/*
* 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 System.Diagnostics;
using System.Reflection;
using System.Text;
using System.Threading;
using log4net;
namespace OpenSim.Framework.Console
{
public class ConsoleBase
{
// private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
protected string prompt = "# ";
public object ConsoleScene = null;
///
/// The default prompt text.
///
public string DefaultPrompt
{
set { m_defaultPrompt = value + "# "; }
get { return m_defaultPrompt; }
}
protected string m_defaultPrompt;
public ConsoleBase(string defaultPrompt)
{
DefaultPrompt = defaultPrompt;
}
///
/// derive an ansi color from a string, ignoring the darker colors.
/// This is used to help automatically bin component tags with colors
/// in various print functions.
///
/// arbitrary string for input
/// an ansii color
protected virtual ConsoleColor DeriveColor(string input)
{
return ConsoleColor.White;
}
///
/// Sends a warning to the current console output
///
/// The message to send
/// WriteLine-style message arguments
public void Warn(string format, params object[] args)
{
WriteNewLine(ConsoleColor.Yellow, format, args);
}
///
/// Sends a warning to the current console output
///
/// The module that sent this message
/// The message to send
/// WriteLine-style message arguments
public void Warn(string sender, string format, params object[] args)
{
WriteNewLine(DeriveColor(sender), sender, ConsoleColor.Yellow, format, args);
}
///
/// Sends a notice to the current console output
///
/// The message to send
/// WriteLine-style message arguments
public void Notice(string format, params object[] args)
{
WriteNewLine(ConsoleColor.White, format, args);
}
///
/// Sends a notice to the current console output
///
/// The module that sent this message
/// The message to send
/// WriteLine-style message arguments
public void Notice(string sender, string format, params object[] args)
{
WriteNewLine(DeriveColor(sender), sender, ConsoleColor.White, format, args);
}
///
/// Sends an error to the current console output
///
/// The message to send
/// WriteLine-style message arguments
public void Error(string format, params object[] args)
{
WriteNewLine(ConsoleColor.Red, format, args);
}
///
/// Sends an error to the current console output
///
/// The module that sent this message
/// The message to send
/// WriteLine-style message arguments
public void Error(string sender, string format, params object[] args)
{
WriteNewLine(DeriveColor(sender), sender, ConsoleColor.Red, format, args);
}
///
/// Sends a status message to the current console output
///
/// The message to send
/// WriteLine-style message arguments
public void Status(string format, params object[] args)
{
WriteNewLine(ConsoleColor.Blue, format, args);
}
///
/// Sends a status message to the current console output
///
/// The module that sent this message
/// The message to send
/// WriteLine-style message arguments
public void Status(string sender, string format, params object[] args)
{
WriteNewLine(DeriveColor(sender), sender, ConsoleColor.Blue, format, args);
}
[Conditional("DEBUG")]
public void Debug(string format, params object[] args)
{
WriteNewLine(ConsoleColor.Gray, format, args);
}
[Conditional("DEBUG")]
public void Debug(string sender, string format, params object[] args)
{
WriteNewLine(DeriveColor(sender), sender, ConsoleColor.Gray, format, args);
}
protected virtual void WriteNewLine(ConsoleColor senderColor, string sender, ConsoleColor color, string format, params object[] args)
{
WritePrefixLine(senderColor, sender);
WriteConsoleLine(color, format, args);
}
protected virtual void WriteNewLine(ConsoleColor color, string format, params object[] args)
{
WriteConsoleLine(color, format, args);
}
protected virtual void WriteConsoleLine(ConsoleColor color, string format, params object[] args)
{
try
{
System.Console.WriteLine(format, args);
}
catch (ObjectDisposedException)
{
}
}
protected virtual void WritePrefixLine(ConsoleColor color, string sender)
{
try
{
sender = sender.ToUpper();
System.Console.WriteLine("[" + sender + "] ");
System.Console.Write("[");
System.Console.Write(sender);
System.Console.Write("] \t");
}
catch (ObjectDisposedException)
{
}
}
public virtual void LockOutput()
{
}
public virtual void UnlockOutput()
{
}
public virtual void Output(string text)
{
System.Console.WriteLine(text);
}
public string CmdPrompt(string p)
{
return ReadLine(String.Format("{0}: ", p), false, true);
}
public string CmdPrompt(string p, string def)
{
string ret = ReadLine(String.Format("{0} [{1}]: ", p, def), false, true);
if (ret == String.Empty)
ret = def;
return ret;
}
// Displays a command prompt and returns a default value, user may only enter 1 of 2 options
public string CmdPrompt(string prompt, string defaultresponse, List options)
{
bool itisdone = false;
string optstr = String.Empty;
foreach (string s in options)
optstr += " " + s;
string temp = CmdPrompt(prompt, defaultresponse);
while (itisdone == false)
{
if (options.Contains(temp))
{
itisdone = true;
}
else
{
System.Console.WriteLine("Valid options are" + optstr);
temp = CmdPrompt(prompt, defaultresponse);
}
}
return temp;
}
// Displays a prompt and waits for the user to enter a string, then returns that string
// (Done with no echo and suitable for passwords)
public string PasswdPrompt(string p)
{
return ReadLine(p, false, false);
}
public virtual string ReadLine(string p, bool isCommand, bool e)
{
System.Console.Write("{0}", prompt);
string cmdinput = System.Console.ReadLine();
return cmdinput;
}
}
}