Add ConsoleTable framework class for future uniform formatting of console output tables.

Still subject to change - if you use this be prepared to change your output code if/when the methods change.
Make new "attachments show" command use this.
0.7.3-extended
Justin Clark-Casey (justincc) 2012-05-10 23:47:39 +01:00
parent 53aa48b42c
commit 802488814f
2 changed files with 165 additions and 8 deletions

View File

@ -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 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.
*
* 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.Linq;
using System.Text;
namespace OpenSim.Framework.Console
{
/// <summary>
/// Used to generated a formatted table for the console.
/// </summary>
/// <remarks>
/// Currently subject to change. If you use this, be prepared to change your code when this class changes.
/// </remarks>
public class ConsoleTable
{
/// <summary>
/// Default number of spaces between table columns.
/// </summary>
public const int DefaultTableSpacing = 2;
/// <summary>
/// Table columns.
/// </summary>
public List<ConsoleTableColumn> Columns { get; private set; }
/// <summary>
/// Table rows
/// </summary>
public List<ConsoleTableRow> Rows { get; private set; }
/// <summary>
/// Number of spaces to indent the table.
/// </summary>
public int Indent { get; set; }
/// <summary>
/// Spacing between table columns
/// </summary>
public int TableSpacing { get; set; }
public ConsoleTable()
{
TableSpacing = DefaultTableSpacing;
Columns = new List<ConsoleTableColumn>();
Rows = new List<ConsoleTableRow>();
}
public override string ToString()
{
StringBuilder sb = new StringBuilder();
AddToStringBuilder(sb);
return sb.ToString();
}
public void AddToStringBuilder(StringBuilder sb)
{
string formatString = GetFormatString();
// System.Console.WriteLine("FORMAT STRING [{0}]", formatString);
// columns
sb.AppendFormat(formatString, Columns.ConvertAll(c => c.Header).ToArray());
// rows
foreach (ConsoleTableRow row in Rows)
sb.AppendFormat(formatString, row.Cells.ToArray());
}
/// <summary>
/// Gets the format string for the table.
/// </summary>
private string GetFormatString()
{
StringBuilder formatSb = new StringBuilder();
formatSb.Append(' ', Indent);
for (int i = 0; i < Columns.Count; i++)
{
formatSb.Append(' ', TableSpacing);
// Can only do left formatting for now
formatSb.AppendFormat("{{{0},-{1}}}", i, Columns[i].Width);
}
formatSb.Append('\n');
return formatSb.ToString();
}
}
public struct ConsoleTableColumn
{
public string Header { get; set; }
public int Width { get; set; }
public ConsoleTableColumn(string header, int width) : this()
{
Header = header;
Width = width;
}
}
public struct ConsoleTableRow
{
public List<string> Cells { get; private set; }
public ConsoleTableRow(List<string> cells) : this()
{
Cells = cells;
}
}
}

View File

@ -53,7 +53,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.Attachments
private List<Scene> m_scenes = new List<Scene>();
// private IAvatarFactoryModule m_avatarFactory;
public string Name { get { return "Attachments Command Module"; } }
public Type ReplaceableInterface { get { return null; } }
@ -145,9 +145,16 @@ namespace OpenSim.Region.OptionalModules.Avatar.Attachments
{
sb.AppendFormat("Attachments for {0}\n", sp.Name);
sb.AppendFormat(
" {0,-36} {1,-10} {2,-36} {3,-14} {4,-15}\n",
"Attachment Name", "Local ID", "Item ID", "Attach Point", "Position");
ConsoleTable ct = new ConsoleTable() { Indent = 2 };
ct.Columns.Add(new ConsoleTableColumn("Attachment Name", 36));
ct.Columns.Add(new ConsoleTableColumn("Local ID", 10));
ct.Columns.Add(new ConsoleTableColumn("Item ID", 36));
ct.Columns.Add(new ConsoleTableColumn("Attach Point", 14));
ct.Columns.Add(new ConsoleTableColumn("Position", 15));
// sb.AppendFormat(
// " {0,-36} {1,-10} {2,-36} {3,-14} {4,-15}\n",
// "Attachment Name", "Local ID", "Item ID", "Attach Point", "Position");
List<SceneObjectGroup> attachmentObjects = sp.GetAttachments();
foreach (SceneObjectGroup attachmentObject in attachmentObjects)
@ -164,13 +171,24 @@ namespace OpenSim.Region.OptionalModules.Avatar.Attachments
// }
// else
// {
sb.AppendFormat(
" {0,-36} {1,-10} {2,-36} {3,-14} {4,-15}\n",
attachmentObject.Name, attachmentObject.LocalId, attachmentObject.FromItemID,
(AttachmentPoint)attachmentObject.AttachmentPoint, attachmentObject.RootPart.AttachedPos);
// sb.AppendFormat(
// " {0,-36} {1,-10} {2,-36} {3,-14} {4,-15}\n",
// attachmentObject.Name, attachmentObject.LocalId, attachmentObject.FromItemID,
// (AttachmentPoint)attachmentObject.AttachmentPoint, attachmentObject.RootPart.AttachedPos);
ct.Rows.Add(
new ConsoleTableRow(
new List<string>()
{
attachmentObject.Name,
attachmentObject.LocalId.ToString(),
attachmentObject.FromItemID.ToString(),
((AttachmentPoint)attachmentObject.AttachmentPoint).ToString(),
attachmentObject.RootPart.AttachedPos.ToString()
}));
// }
}
ct.AddToStringBuilder(sb);
sb.Append("\n");
}
}