aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Framework/Console/ConsoleDisplayTable.cs
diff options
context:
space:
mode:
Diffstat (limited to 'OpenSim/Framework/Console/ConsoleDisplayTable.cs')
-rw-r--r--OpenSim/Framework/Console/ConsoleDisplayTable.cs154
1 files changed, 154 insertions, 0 deletions
diff --git a/OpenSim/Framework/Console/ConsoleDisplayTable.cs b/OpenSim/Framework/Console/ConsoleDisplayTable.cs
new file mode 100644
index 0000000..c620dfe
--- /dev/null
+++ b/OpenSim/Framework/Console/ConsoleDisplayTable.cs
@@ -0,0 +1,154 @@
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
28using System;
29using System.Collections.Generic;
30using System.Linq;
31using System.Text;
32
33namespace OpenSim.Framework.Console
34{
35 /// <summary>
36 /// Used to generated a formatted table for the console.
37 /// </summary>
38 /// <remarks>
39 /// Currently subject to change. If you use this, be prepared to change your code when this class changes.
40 /// </remarks>
41 public class ConsoleDisplayTable
42 {
43 /// <summary>
44 /// Default number of spaces between table columns.
45 /// </summary>
46 public const int DefaultTableSpacing = 2;
47
48 /// <summary>
49 /// Table columns.
50 /// </summary>
51 public List<ConsoleDisplayTableColumn> Columns { get; private set; }
52
53 /// <summary>
54 /// Table rows
55 /// </summary>
56 public List<ConsoleDisplayTableRow> Rows { get; private set; }
57
58 /// <summary>
59 /// Number of spaces to indent the table.
60 /// </summary>
61 public int Indent { get; set; }
62
63 /// <summary>
64 /// Spacing between table columns
65 /// </summary>
66 public int TableSpacing { get; set; }
67
68 public ConsoleDisplayTable()
69 {
70 TableSpacing = DefaultTableSpacing;
71 Columns = new List<ConsoleDisplayTableColumn>();
72 Rows = new List<ConsoleDisplayTableRow>();
73 }
74
75 public override string ToString()
76 {
77 StringBuilder sb = new StringBuilder();
78 AddToStringBuilder(sb);
79 return sb.ToString();
80 }
81
82 public void AddColumn(string name, int width)
83 {
84 Columns.Add(new ConsoleDisplayTableColumn(name, width));
85 }
86
87 public void AddRow(params string[] cells)
88 {
89 Rows.Add(new ConsoleDisplayTableRow(cells));
90 }
91
92 public void AddToStringBuilder(StringBuilder sb)
93 {
94 string formatString = GetFormatString();
95// System.Console.WriteLine("FORMAT STRING [{0}]", formatString);
96
97 // columns
98 sb.AppendFormat(formatString, Columns.ConvertAll(c => c.Header).ToArray());
99
100 // rows
101 foreach (ConsoleDisplayTableRow row in Rows)
102 sb.AppendFormat(formatString, row.Cells.ToArray());
103 }
104
105 /// <summary>
106 /// Gets the format string for the table.
107 /// </summary>
108 private string GetFormatString()
109 {
110 StringBuilder formatSb = new StringBuilder();
111
112 formatSb.Append(' ', Indent);
113
114 for (int i = 0; i < Columns.Count; i++)
115 {
116 formatSb.Append(' ', TableSpacing);
117
118 // Can only do left formatting for now
119 formatSb.AppendFormat("{{{0},-{1}}}", i, Columns[i].Width);
120 }
121
122 formatSb.Append('\n');
123
124 return formatSb.ToString();
125 }
126 }
127
128 public struct ConsoleDisplayTableColumn
129 {
130 public string Header { get; set; }
131 public int Width { get; set; }
132
133 public ConsoleDisplayTableColumn(string header, int width) : this()
134 {
135 Header = header;
136 Width = width;
137 }
138 }
139
140 public struct ConsoleDisplayTableRow
141 {
142 public List<string> Cells { get; private set; }
143
144 public ConsoleDisplayTableRow(List<string> cells) : this()
145 {
146 Cells = cells;
147 }
148
149 public ConsoleDisplayTableRow(params string[] cells) : this()
150 {
151 Cells = new List<string>(cells);
152 }
153 }
154} \ No newline at end of file