File size: 17,069 Bytes
8c763fb | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System;
using System.Collections.Generic;
using System.Globalization;
using System.IO;
using System.Management.Automation;
using System.Xml;
namespace Microsoft.PowerShell.Commands
{
/// <summary>
/// Helper class for writing formatting directives to XML.
/// </summary>
internal sealed class FormatXmlWriter
{
private XmlWriter _writer;
private bool _exportScriptBlock;
private FormatXmlWriter() { }
/// <summary>
/// Writes a collection of format view definitions to XML file.
/// </summary>
/// <param name="typeDefinitions">Collection of PSTypeDefinition.</param>
/// <param name="filepath">Path to XML file.</param>
/// <param name="cmdlet">Cmdlet from which this si used.</param>
/// <param name="force">True - to force write the file.</param>
/// <param name="writeScriptBlock">True - to export scriptblocks.</param>
/// <param name="noclobber">True - do not overwrite the file.</param>
/// <param name="isLiteralPath">True - bypass wildcard expansion on the file name.</param>
internal static void WriteToPs1Xml(PSCmdlet cmdlet, List<ExtendedTypeDefinition> typeDefinitions,
string filepath, bool force, bool noclobber, bool writeScriptBlock, bool isLiteralPath)
{
StreamWriter streamWriter;
FileStream fileStream;
FileInfo fileInfo;
PathUtils.MasterStreamOpen(cmdlet, filepath, "ascii", true, false, force, noclobber,
out fileStream, out streamWriter, out fileInfo, isLiteralPath);
try
{
var settings = new XmlWriterSettings();
settings.Indent = true;
settings.IndentChars = " ";
settings.NewLineOnAttributes = true;
using (XmlWriter xmlWriter = XmlWriter.Create(streamWriter, settings))
{
var writer = new FormatXmlWriter
{
_writer = xmlWriter,
_exportScriptBlock = writeScriptBlock
};
writer.WriteToXml(typeDefinitions);
}
}
finally
{
streamWriter.Dispose();
fileStream.Dispose();
}
}
internal static void WriteToXml(XmlWriter writer, IEnumerable<ExtendedTypeDefinition> typeDefinitions, bool writeScriptBlock)
{
var formatXmlWriter = new FormatXmlWriter { _exportScriptBlock = writeScriptBlock, _writer = writer };
formatXmlWriter.WriteToXml(typeDefinitions);
}
internal void WriteToXml(IEnumerable<ExtendedTypeDefinition> typeDefinitions)
{
var views = new Dictionary<Guid, List<ExtendedTypeDefinition>>();
var formatdefs = new Dictionary<Guid, FormatViewDefinition>();
foreach (ExtendedTypeDefinition typedefinition in typeDefinitions)
{
foreach (FormatViewDefinition viewdefinition in typedefinition.FormatViewDefinition)
{
List<ExtendedTypeDefinition> viewList;
if (!views.TryGetValue(viewdefinition.InstanceId, out viewList))
{
viewList = new List<ExtendedTypeDefinition>();
views.Add(viewdefinition.InstanceId, viewList);
}
if (!formatdefs.ContainsKey(viewdefinition.InstanceId))
{
formatdefs.Add(viewdefinition.InstanceId, viewdefinition);
}
viewList.Add(typedefinition);
}
}
_writer.WriteStartElement("Configuration");
_writer.WriteStartElement("ViewDefinitions");
foreach (var pair in formatdefs)
{
Guid id = pair.Key;
FormatViewDefinition formatdef = pair.Value;
_writer.WriteStartElement("View");
_writer.WriteElementString("Name", formatdef.Name);
_writer.WriteStartElement("ViewSelectedBy");
foreach (ExtendedTypeDefinition definition in views[id])
{
_writer.WriteElementString("TypeName", definition.TypeName);
}
_writer.WriteEndElement(/*</ViewSelectedBy>*/);
var groupBy = formatdef.Control.GroupBy;
if (groupBy != null)
{
_writer.WriteStartElement("GroupBy");
WriteDisplayEntry(groupBy.Expression);
if (!string.IsNullOrEmpty(groupBy.Label))
{
_writer.WriteElementString("Label", groupBy.Label);
}
if (groupBy.CustomControl != null)
{
WriteCustomControl(groupBy.CustomControl);
}
_writer.WriteEndElement(/*</GroupBy>*/);
}
if (formatdef.Control.OutOfBand)
{
_writer.WriteElementString("OutOfBand", string.Empty);
}
formatdef.Control.WriteToXml(this);
_writer.WriteEndElement(/*</View>*/);
}
_writer.WriteEndElement(/*</ViewDefinitions>*/);
_writer.WriteEndElement(/*</Configuration>*/);
}
internal void WriteTableControl(TableControl tableControl)
{
_writer.WriteStartElement("TableControl");
if (tableControl.AutoSize)
{
_writer.WriteElementString("AutoSize", string.Empty);
}
if (tableControl.HideTableHeaders)
{
_writer.WriteElementString("HideTableHeaders", string.Empty);
}
_writer.WriteStartElement("TableHeaders");
foreach (TableControlColumnHeader columnheader in tableControl.Headers)
{
_writer.WriteStartElement("TableColumnHeader");
if (!string.IsNullOrEmpty(columnheader.Label))
{
_writer.WriteElementString("Label", columnheader.Label);
}
if (columnheader.Width > 0)
{
_writer.WriteElementString("Width", columnheader.Width.ToString(CultureInfo.InvariantCulture));
}
if (columnheader.Alignment != Alignment.Undefined)
{
_writer.WriteElementString("Alignment", columnheader.Alignment.ToString());
}
_writer.WriteEndElement(/*</TableColumnHeader>*/);
}
_writer.WriteEndElement(/*</TableHeaders>*/);
_writer.WriteStartElement("TableRowEntries");
foreach (TableControlRow row in tableControl.Rows)
{
_writer.WriteStartElement("TableRowEntry");
if (row.Wrap)
{
_writer.WriteStartElement("Wrap");
_writer.WriteEndElement(/*</Wrap>*/);
}
if (row.SelectedBy != null)
{
WriteEntrySelectedBy(row.SelectedBy);
}
_writer.WriteStartElement("TableColumnItems");
foreach (TableControlColumn coldefn in row.Columns)
{
_writer.WriteStartElement("TableColumnItem");
if (coldefn.Alignment != Alignment.Undefined)
{
_writer.WriteElementString("Alignment", coldefn.Alignment.ToString());
}
if (!string.IsNullOrEmpty(coldefn.FormatString))
{
_writer.WriteElementString("FormatString", coldefn.FormatString);
}
WriteDisplayEntry(coldefn.DisplayEntry);
_writer.WriteEndElement(/*</TableColumnItem>*/);
}
_writer.WriteEndElement(/*<TableColumnItems>*/);
_writer.WriteEndElement(/*<TableRowEntry>*/);
}
_writer.WriteEndElement(/*</TableRowEntries>*/);
_writer.WriteEndElement(/*</TableControl>*/);
}
internal void WriteListControl(ListControl listControl)
{
_writer.WriteStartElement("ListControl");
_writer.WriteStartElement("ListEntries");
// write the list entry's one by one
foreach (ListControlEntry entry in listControl.Entries)
{
_writer.WriteStartElement("ListEntry");
// write entry selected by if available
WriteEntrySelectedBy(entry.EntrySelectedBy);
if (entry.Items.Count > 0)
{
_writer.WriteStartElement("ListItems");
// write the list items
foreach (ListControlEntryItem item in entry.Items)
{
_writer.WriteStartElement("ListItem");
if (!string.IsNullOrEmpty(item.Label))
{
_writer.WriteElementString("Label", item.Label);
}
if (!string.IsNullOrEmpty(item.FormatString))
{
_writer.WriteElementString("FormatString", item.FormatString);
}
if (item.ItemSelectionCondition != null)
{
_writer.WriteStartElement("ItemSelectionCondition");
WriteDisplayEntry(item.ItemSelectionCondition);
_writer.WriteEndElement(/*</ItemSelectionCondition>*/);
}
// write the entry
WriteDisplayEntry(item.DisplayEntry);
_writer.WriteEndElement(/*</ListItem>*/);
}
_writer.WriteEndElement(/*</ListItems>*/);
}
_writer.WriteEndElement(/*</ListEntry>*/);
}
_writer.WriteEndElement(/*</ListEntries>*/);
_writer.WriteEndElement(/*</ListControl>*/);
}
private void WriteEntrySelectedBy(EntrySelectedBy entrySelectedBy)
{
if (entrySelectedBy != null &&
((entrySelectedBy.TypeNames != null && entrySelectedBy.TypeNames.Count > 0) ||
(entrySelectedBy.SelectionCondition != null && entrySelectedBy.SelectionCondition.Count > 0)))
{
_writer.WriteStartElement("EntrySelectedBy");
if (entrySelectedBy.TypeNames != null)
{
foreach (string typename in entrySelectedBy.TypeNames)
{
_writer.WriteElementString("TypeName", typename);
}
}
if (entrySelectedBy.SelectionCondition != null)
{
foreach (var condition in entrySelectedBy.SelectionCondition)
{
_writer.WriteStartElement("SelectionCondition");
WriteDisplayEntry(condition);
_writer.WriteEndElement(/*</SelectionCondition>*/);
}
}
_writer.WriteEndElement(/*</EntrySelectedBy>*/);
}
}
internal void WriteWideControl(WideControl wideControl)
{
_writer.WriteStartElement("WideControl");
if (wideControl.Columns > 0)
{
_writer.WriteElementString("ColumnNumber", wideControl.Columns.ToString(CultureInfo.InvariantCulture));
}
if (wideControl.AutoSize)
{
_writer.WriteElementString("AutoSize", string.Empty);
}
_writer.WriteStartElement("WideEntries");
foreach (WideControlEntryItem entry in wideControl.Entries)
{
_writer.WriteStartElement("WideEntry");
WriteEntrySelectedBy(entry.EntrySelectedBy);
_writer.WriteStartElement("WideItem");
WriteDisplayEntry(entry.DisplayEntry);
if (!string.IsNullOrEmpty(entry.FormatString))
{
_writer.WriteElementString("FormatString", entry.FormatString);
}
_writer.WriteEndElement(/*</WideItem>*/);
_writer.WriteEndElement(/*</WideEntry>*/);
}
_writer.WriteEndElement(/*</WideEntries>*/);
_writer.WriteEndElement(/*</WideControl>*/);
}
internal void WriteDisplayEntry(DisplayEntry displayEntry)
{
if (displayEntry.ValueType == DisplayEntryValueType.Property)
{
_writer.WriteElementString("PropertyName", displayEntry.Value);
}
else if (displayEntry.ValueType == DisplayEntryValueType.ScriptBlock)
{
_writer.WriteStartElement("ScriptBlock");
_writer.WriteValue(_exportScriptBlock ? displayEntry.Value : ";");
_writer.WriteEndElement(/*</ScriptBlock>*/);
}
}
internal void WriteCustomControl(CustomControl customControl)
{
_writer.WriteStartElement("CustomControl");
_writer.WriteStartElement("CustomEntries");
foreach (var entry in customControl.Entries)
{
_writer.WriteStartElement("CustomEntry");
WriteEntrySelectedBy(entry.SelectedBy);
_writer.WriteStartElement("CustomItem");
foreach (var item in entry.CustomItems)
{
WriteCustomItem(item);
}
_writer.WriteEndElement(/*</CustomItem>*/);
_writer.WriteEndElement(/*</CustomEntry>*/);
}
_writer.WriteEndElement(/*</CustomEntries>*/);
_writer.WriteEndElement(/*</CustomControl>*/);
}
internal void WriteCustomItem(CustomItemBase item)
{
if (item is CustomItemNewline newline)
{
for (int i = 0; i < newline.Count; i++)
{
_writer.WriteElementString("NewLine", string.Empty);
}
return;
}
if (item is CustomItemText text)
{
_writer.WriteElementString("Text", text.Text);
return;
}
if (item is CustomItemExpression expr)
{
_writer.WriteStartElement("ExpressionBinding");
if (expr.EnumerateCollection)
{
_writer.WriteElementString("EnumerateCollection", string.Empty);
}
if (expr.ItemSelectionCondition != null)
{
_writer.WriteStartElement("ItemSelectionCondition");
WriteDisplayEntry(expr.ItemSelectionCondition);
_writer.WriteEndElement(/*</ItemSelectionCondition>*/);
}
if (expr.Expression != null)
{
WriteDisplayEntry(expr.Expression);
}
if (expr.CustomControl != null)
{
WriteCustomControl(expr.CustomControl);
}
_writer.WriteEndElement(/*</ExpressionBinding>*/);
return;
}
var frame = (CustomItemFrame)item;
_writer.WriteStartElement("Frame");
if (frame.LeftIndent != 0)
_writer.WriteElementString("LeftIndent", frame.LeftIndent.ToString(CultureInfo.InvariantCulture));
if (frame.RightIndent != 0)
_writer.WriteElementString("RightIndent", frame.RightIndent.ToString(CultureInfo.InvariantCulture));
if (frame.FirstLineHanging != 0)
_writer.WriteElementString("FirstLineHanging", frame.FirstLineHanging.ToString(CultureInfo.InvariantCulture));
if (frame.FirstLineIndent != 0)
_writer.WriteElementString("FirstLineIndent", frame.FirstLineIndent.ToString(CultureInfo.InvariantCulture));
_writer.WriteStartElement("CustomItem");
foreach (var frameItem in frame.CustomItems)
{
WriteCustomItem(frameItem);
}
_writer.WriteEndElement(/*</CustomItem>*/);
_writer.WriteEndElement(/*</Frame>*/);
}
}
}
|