diff options
author | Justin Clark-Casey (justincc) | 2012-05-10 23:47:39 +0100 |
---|---|---|
committer | Justin Clark-Casey (justincc) | 2012-05-10 23:47:39 +0100 |
commit | 903cff9264ce405d00eab2739fcfb461749b4772 (patch) | |
tree | 6ae0a9ade5785470b67a5cadd40d2c034fdea13d /OpenSim/Framework/Console | |
parent | Merge branch 'master' of ssh://opensimulator.org/var/git/opensim (diff) | |
download | opensim-SC_OLD-903cff9264ce405d00eab2739fcfb461749b4772.zip opensim-SC_OLD-903cff9264ce405d00eab2739fcfb461749b4772.tar.gz opensim-SC_OLD-903cff9264ce405d00eab2739fcfb461749b4772.tar.bz2 opensim-SC_OLD-903cff9264ce405d00eab2739fcfb461749b4772.tar.xz |
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.
Diffstat (limited to '')
-rw-r--r-- | OpenSim/Framework/Console/ConsoleTable.cs | 139 |
1 files changed, 139 insertions, 0 deletions
diff --git a/OpenSim/Framework/Console/ConsoleTable.cs b/OpenSim/Framework/Console/ConsoleTable.cs new file mode 100644 index 0000000..be3025b --- /dev/null +++ b/OpenSim/Framework/Console/ConsoleTable.cs | |||
@@ -0,0 +1,139 @@ | |||
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.Linq; | ||
31 | using System.Text; | ||
32 | |||
33 | namespace 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 ConsoleTable | ||
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<ConsoleTableColumn> Columns { get; private set; } | ||
52 | |||
53 | /// <summary> | ||
54 | /// Table rows | ||
55 | /// </summary> | ||
56 | public List<ConsoleTableRow> 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 ConsoleTable() | ||
69 | { | ||
70 | TableSpacing = DefaultTableSpacing; | ||
71 | Columns = new List<ConsoleTableColumn>(); | ||
72 | Rows = new List<ConsoleTableRow>(); | ||
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 AddToStringBuilder(StringBuilder sb) | ||
83 | { | ||
84 | string formatString = GetFormatString(); | ||
85 | // System.Console.WriteLine("FORMAT STRING [{0}]", formatString); | ||
86 | |||
87 | // columns | ||
88 | sb.AppendFormat(formatString, Columns.ConvertAll(c => c.Header).ToArray()); | ||
89 | |||
90 | // rows | ||
91 | foreach (ConsoleTableRow row in Rows) | ||
92 | sb.AppendFormat(formatString, row.Cells.ToArray()); | ||
93 | } | ||
94 | |||
95 | /// <summary> | ||
96 | /// Gets the format string for the table. | ||
97 | /// </summary> | ||
98 | private string GetFormatString() | ||
99 | { | ||
100 | StringBuilder formatSb = new StringBuilder(); | ||
101 | |||
102 | formatSb.Append(' ', Indent); | ||
103 | |||
104 | for (int i = 0; i < Columns.Count; i++) | ||
105 | { | ||
106 | formatSb.Append(' ', TableSpacing); | ||
107 | |||
108 | // Can only do left formatting for now | ||
109 | formatSb.AppendFormat("{{{0},-{1}}}", i, Columns[i].Width); | ||
110 | } | ||
111 | |||
112 | formatSb.Append('\n'); | ||
113 | |||
114 | return formatSb.ToString(); | ||
115 | } | ||
116 | } | ||
117 | |||
118 | public struct ConsoleTableColumn | ||
119 | { | ||
120 | public string Header { get; set; } | ||
121 | public int Width { get; set; } | ||
122 | |||
123 | public ConsoleTableColumn(string header, int width) : this() | ||
124 | { | ||
125 | Header = header; | ||
126 | Width = width; | ||
127 | } | ||
128 | } | ||
129 | |||
130 | public struct ConsoleTableRow | ||
131 | { | ||
132 | public List<string> Cells { get; private set; } | ||
133 | |||
134 | public ConsoleTableRow(List<string> cells) : this() | ||
135 | { | ||
136 | Cells = cells; | ||
137 | } | ||
138 | } | ||
139 | } \ No newline at end of file | ||