From 94da334adaafa4444fb278991aa01cce58d9f758 Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Sat, 26 Oct 2019 13:35:15 -0700 Subject: Rename Output to WindowsInstallerData --- src/WixToolset.Data/WindowsInstaller/Field.cs | 2 +- .../WindowsInstaller/ObjectField.cs | 2 +- src/WixToolset.Data/WindowsInstaller/Output.cs | 262 -------------------- src/WixToolset.Data/WindowsInstaller/Row.cs | 2 +- src/WixToolset.Data/WindowsInstaller/SubStorage.cs | 12 +- src/WixToolset.Data/WindowsInstaller/Table.cs | 2 +- .../WindowsInstaller/WindowsInstallerData.cs | 264 +++++++++++++++++++++ src/WixToolset.Data/WindowsInstaller/Xsd/data.xsd | 66 ++++++ .../WindowsInstaller/Xsd/outputs.xsd | 66 ------ src/WixToolset.Data/WindowsInstaller/Xsd/pdbs.xsd | 32 --- 10 files changed, 340 insertions(+), 370 deletions(-) delete mode 100644 src/WixToolset.Data/WindowsInstaller/Output.cs create mode 100644 src/WixToolset.Data/WindowsInstaller/WindowsInstallerData.cs create mode 100644 src/WixToolset.Data/WindowsInstaller/Xsd/data.xsd delete mode 100644 src/WixToolset.Data/WindowsInstaller/Xsd/outputs.xsd delete mode 100644 src/WixToolset.Data/WindowsInstaller/Xsd/pdbs.xsd diff --git a/src/WixToolset.Data/WindowsInstaller/Field.cs b/src/WixToolset.Data/WindowsInstaller/Field.cs index ac8df9a4..84e8d543 100644 --- a/src/WixToolset.Data/WindowsInstaller/Field.cs +++ b/src/WixToolset.Data/WindowsInstaller/Field.cs @@ -275,7 +275,7 @@ namespace WixToolset.Data.WindowsInstaller /// XmlWriter where the Field should persist itself as XML. internal virtual void Write(XmlWriter writer) { - writer.WriteStartElement("field", Output.XmlNamespaceUri); + writer.WriteStartElement("field", WindowsInstallerData.XmlNamespaceUri); if (this.Modified) { diff --git a/src/WixToolset.Data/WindowsInstaller/ObjectField.cs b/src/WixToolset.Data/WindowsInstaller/ObjectField.cs index 4e654dde..f10837c1 100644 --- a/src/WixToolset.Data/WindowsInstaller/ObjectField.cs +++ b/src/WixToolset.Data/WindowsInstaller/ObjectField.cs @@ -130,7 +130,7 @@ namespace WixToolset.Data.WindowsInstaller /// XmlWriter where the Field should persist itself as XML. internal override void Write(XmlWriter writer) { - writer.WriteStartElement("field", Output.XmlNamespaceUri); + writer.WriteStartElement("field", WindowsInstallerData.XmlNamespaceUri); if (this.EmbeddedFileIndex.HasValue) { diff --git a/src/WixToolset.Data/WindowsInstaller/Output.cs b/src/WixToolset.Data/WindowsInstaller/Output.cs deleted file mode 100644 index ee46c159..00000000 --- a/src/WixToolset.Data/WindowsInstaller/Output.cs +++ /dev/null @@ -1,262 +0,0 @@ -// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information. - -namespace WixToolset.Data.WindowsInstaller -{ - using System; - using System.Collections.Generic; - using System.Globalization; - using System.Linq; - using System.Xml; - - /// - /// Output is generated by the linker. - /// - public sealed class Output - { - public const string XmlNamespaceUri = "http://wixtoolset.org/schemas/v4/wixout"; - private static readonly Version CurrentVersion = new Version("4.0.0.0"); - private const string WixOutputStreamName = "wix-wi.xml"; - - /// - /// Creates a new empty output object. - /// - /// The source line information for the output. - public Output(SourceLineNumber sourceLineNumbers) - { - this.SourceLineNumbers = sourceLineNumbers; - this.SubStorages = new List(); - this.Tables = new TableIndexedCollection(); - } - - /// - /// Gets the type of the output. - /// - /// Type of the output. - public OutputType Type { get; set; } - - /// - /// Gets or sets the codepage for this output. - /// - /// Codepage of the output. - public int Codepage { get; set; } - - /// - /// Gets the source line information for this output. - /// - /// The source line information for this output. - public SourceLineNumber SourceLineNumbers { get; private set; } - - /// - /// Gets the substorages in this output. - /// - /// The substorages in this output. - public ICollection SubStorages { get; private set; } - - /// - /// Gets the tables contained in this output. - /// - /// Collection of tables. - public TableIndexedCollection Tables { get; private set; } - - /// - /// Loads an output from a path on disk. - /// - /// Path to output file saved on disk. - /// Suppresses wix.dll version mismatch check. - /// Output object. - public static Output Load(string path, bool suppressVersionCheck) - { - using (var wixout = WixOutput.Read(path)) - using (var stream = wixout.GetDataStream(WixOutputStreamName)) - using (var reader = XmlReader.Create(stream, null, wixout.Uri.AbsoluteUri)) - { - try - { - reader.MoveToContent(); - return Output.Read(reader, suppressVersionCheck); - } - catch (XmlException xe) - { - throw new WixCorruptFileException(path, "wixout", xe); - } - } - } - - /// - /// Saves an output to a WixOutput container. - /// - /// Container to save to. - public void Save(WixOutput wixout) - { - using (var writer = XmlWriter.Create(wixout.CreateDataStream(WixOutputStreamName))) - { - writer.WriteStartDocument(); - this.Write(writer); - writer.WriteEndDocument(); - } - } - - /// - /// Processes an XmlReader and builds up the output object. - /// - /// Reader to get data from. - /// Suppresses wix.dll version mismatch check. - /// The Output represented by the Xml. - internal static Output Read(XmlReader reader, bool suppressVersionCheck) - { - if (!reader.LocalName.Equals("wixOutput")) - { - throw new XmlException(); - } - - var empty = reader.IsEmptyElement; - var output = new Output(SourceLineNumber.CreateFromUri(reader.BaseURI)); - Version version = null; - - while (reader.MoveToNextAttribute()) - { - switch (reader.LocalName) - { - case "codepage": - output.Codepage = Convert.ToInt32(reader.Value, CultureInfo.InvariantCulture.NumberFormat); - break; - case "type": - switch (reader.Value) - { - case "Bundle": - output.Type = OutputType.Bundle; - break; - case "Module": - output.Type = OutputType.Module; - break; - case "Patch": - output.Type = OutputType.Patch; - break; - case "PatchCreation": - output.Type = OutputType.PatchCreation; - break; - case "Product": - output.Type = OutputType.Product; - break; - case "Transform": - output.Type = OutputType.Transform; - break; - default: - throw new XmlException(); - } - break; - case "version": - version = new Version(reader.Value); - break; - } - } - - if (!suppressVersionCheck && null != version && !Output.CurrentVersion.Equals(version)) - { - throw new WixException(ErrorMessages.VersionMismatch(SourceLineNumber.CreateFromUri(reader.BaseURI), "wixOutput", version.ToString(), Output.CurrentVersion.ToString())); - } - - // loop through the rest of the xml building up the Output object - TableDefinitionCollection tableDefinitions = null; - var tables = new List(); - if (!empty) - { - var done = false; - - // loop through all the fields in a row - while (!done && reader.Read()) - { - switch (reader.NodeType) - { - case XmlNodeType.Element: - switch (reader.LocalName) - { - case "subStorage": - output.SubStorages.Add(SubStorage.Read(reader)); - break; - case "table": - if (null == tableDefinitions) - { - throw new XmlException(); - } - tables.Add(Table.Read(reader, tableDefinitions)); - break; - case "tableDefinitions": - tableDefinitions = TableDefinitionCollection.Read(reader); - break; - default: - throw new XmlException(); - } - break; - case XmlNodeType.EndElement: - done = true; - break; - } - } - - if (!done) - { - throw new XmlException(); - } - } - - output.Tables = new TableIndexedCollection(tables); - return output; - } - - /// - /// Ensure this output contains a particular table. - /// - /// Definition of the table that should exist. - /// Optional section to use for the table. If one is not provided, the entry section will be used. - /// The table in this output. - public Table EnsureTable(TableDefinition tableDefinition) - { - if (!this.Tables.TryGetTable(tableDefinition.Name, out var table)) - { - table = new Table(tableDefinition); - this.Tables.Add(table); - } - - return table; - } - - /// - /// Persists an output in an XML format. - /// - /// XmlWriter where the Output should persist itself as XML. - internal void Write(XmlWriter writer) - { - writer.WriteStartElement("wixOutput", XmlNamespaceUri); - - writer.WriteAttributeString("type", this.Type.ToString()); - - if (0 != this.Codepage) - { - writer.WriteAttributeString("codepage", this.Codepage.ToString(CultureInfo.InvariantCulture)); - } - - writer.WriteAttributeString("version", Output.CurrentVersion.ToString()); - - // Collect all the table definitions and write them. - var tableDefinitions = new TableDefinitionCollection(); - foreach (var table in this.Tables) - { - tableDefinitions.Add(table.Definition); - } - tableDefinitions.Write(writer); - - foreach (var table in this.Tables.OrderBy(t => t.Name)) - { - table.Write(writer); - } - - foreach (var subStorage in this.SubStorages) - { - subStorage.Write(writer); - } - - writer.WriteEndElement(); - } - } -} diff --git a/src/WixToolset.Data/WindowsInstaller/Row.cs b/src/WixToolset.Data/WindowsInstaller/Row.cs index a267f04b..a7a63d58 100644 --- a/src/WixToolset.Data/WindowsInstaller/Row.cs +++ b/src/WixToolset.Data/WindowsInstaller/Row.cs @@ -354,7 +354,7 @@ namespace WixToolset.Data.WindowsInstaller /// XmlWriter where the Row should persist itself as XML. internal void Write(XmlWriter writer) { - writer.WriteStartElement("row", Output.XmlNamespaceUri); + writer.WriteStartElement("row", WindowsInstallerData.XmlNamespaceUri); if (RowOperation.None != this.Operation) { diff --git a/src/WixToolset.Data/WindowsInstaller/SubStorage.cs b/src/WixToolset.Data/WindowsInstaller/SubStorage.cs index c1981f1b..6aae1dd8 100644 --- a/src/WixToolset.Data/WindowsInstaller/SubStorage.cs +++ b/src/WixToolset.Data/WindowsInstaller/SubStorage.cs @@ -14,7 +14,7 @@ namespace WixToolset.Data.WindowsInstaller /// /// The substorage name. /// The substorage data. - public SubStorage(string name, Output data) + public SubStorage(string name, WindowsInstallerData data) { this.Name = name; this.Data = data; @@ -30,7 +30,7 @@ namespace WixToolset.Data.WindowsInstaller /// Gets the substorage data. /// /// The substorage data. - public Output Data { get; } + public WindowsInstallerData Data { get; } /// /// Creates a SubStorage from the XmlReader. @@ -44,7 +44,7 @@ namespace WixToolset.Data.WindowsInstaller throw new XmlException(); } - Output data = null; + WindowsInstallerData data = null; bool empty = reader.IsEmptyElement; string name = null; @@ -69,8 +69,8 @@ namespace WixToolset.Data.WindowsInstaller case XmlNodeType.Element: switch (reader.LocalName) { - case "wixOutput": - data = Output.Read(reader, true); + case WindowsInstallerData.XmlElementName: + data = WindowsInstallerData.Read(reader, true); break; default: throw new XmlException(); @@ -97,7 +97,7 @@ namespace WixToolset.Data.WindowsInstaller /// XmlWriter where the SubStorage should persist itself as XML. internal void Write(XmlWriter writer) { - writer.WriteStartElement("subStorage", Output.XmlNamespaceUri); + writer.WriteStartElement("subStorage", WindowsInstallerData.XmlNamespaceUri); writer.WriteAttributeString("name", this.Name); diff --git a/src/WixToolset.Data/WindowsInstaller/Table.cs b/src/WixToolset.Data/WindowsInstaller/Table.cs index c7f2c8f2..3325dd8b 100644 --- a/src/WixToolset.Data/WindowsInstaller/Table.cs +++ b/src/WixToolset.Data/WindowsInstaller/Table.cs @@ -291,7 +291,7 @@ namespace WixToolset.Data.WindowsInstaller throw new ArgumentNullException("writer"); } - writer.WriteStartElement("table", Output.XmlNamespaceUri); + writer.WriteStartElement("table", WindowsInstallerData.XmlNamespaceUri); writer.WriteAttributeString("name", this.Name); if (TableOperation.None != this.Operation) diff --git a/src/WixToolset.Data/WindowsInstaller/WindowsInstallerData.cs b/src/WixToolset.Data/WindowsInstaller/WindowsInstallerData.cs new file mode 100644 index 00000000..0855997c --- /dev/null +++ b/src/WixToolset.Data/WindowsInstaller/WindowsInstallerData.cs @@ -0,0 +1,264 @@ +// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information. + +namespace WixToolset.Data.WindowsInstaller +{ + using System; + using System.Collections.Generic; + using System.Globalization; + using System.Linq; + using System.Xml; + + /// + /// Output is generated by the linker. + /// + public sealed class WindowsInstallerData + { + internal const string XmlNamespaceUri = "http://wixtoolset.org/schemas/v4/windowsinstallerdata"; + internal const string XmlElementName = "windowsInstallerData"; + + private static readonly Version CurrentVersion = new Version("4.0.0.0"); + private const string WixOutputStreamName = "wix-wid.xml"; + + /// + /// Creates a new empty output object. + /// + /// The source line information for the output. + public WindowsInstallerData(SourceLineNumber sourceLineNumbers) + { + this.SourceLineNumbers = sourceLineNumbers; + this.SubStorages = new List(); + this.Tables = new TableIndexedCollection(); + } + + /// + /// Gets the type of the output. + /// + /// Type of the output. + public OutputType Type { get; set; } + + /// + /// Gets or sets the codepage for this output. + /// + /// Codepage of the output. + public int Codepage { get; set; } + + /// + /// Gets the source line information for this output. + /// + /// The source line information for this output. + public SourceLineNumber SourceLineNumbers { get; private set; } + + /// + /// Gets the substorages in this output. + /// + /// The substorages in this output. + public ICollection SubStorages { get; private set; } + + /// + /// Gets the tables contained in this output. + /// + /// Collection of tables. + public TableIndexedCollection Tables { get; private set; } + + /// + /// Loads an output from a path on disk. + /// + /// Path to output file saved on disk. + /// Suppresses wix.dll version mismatch check. + /// Output object. + public static WindowsInstallerData Load(string path, bool suppressVersionCheck) + { + using (var wixout = WixOutput.Read(path)) + using (var stream = wixout.GetDataStream(WixOutputStreamName)) + using (var reader = XmlReader.Create(stream, null, wixout.Uri.AbsoluteUri)) + { + try + { + reader.MoveToContent(); + return WindowsInstallerData.Read(reader, suppressVersionCheck); + } + catch (XmlException xe) + { + throw new WixCorruptFileException(path, "wixout", xe); + } + } + } + + /// + /// Saves an output to a WixOutput container. + /// + /// Container to save to. + public void Save(WixOutput wixout) + { + using (var writer = XmlWriter.Create(wixout.CreateDataStream(WixOutputStreamName))) + { + writer.WriteStartDocument(); + this.Write(writer); + writer.WriteEndDocument(); + } + } + + /// + /// Processes an XmlReader and builds up the output object. + /// + /// Reader to get data from. + /// Suppresses wix.dll version mismatch check. + /// The Output represented by the Xml. + internal static WindowsInstallerData Read(XmlReader reader, bool suppressVersionCheck) + { + if (!reader.LocalName.Equals(WindowsInstallerData.XmlElementName)) + { + throw new XmlException(); + } + + var empty = reader.IsEmptyElement; + var output = new WindowsInstallerData(SourceLineNumber.CreateFromUri(reader.BaseURI)); + Version version = null; + + while (reader.MoveToNextAttribute()) + { + switch (reader.LocalName) + { + case "codepage": + output.Codepage = Convert.ToInt32(reader.Value, CultureInfo.InvariantCulture.NumberFormat); + break; + case "type": + switch (reader.Value) + { + case "Bundle": + output.Type = OutputType.Bundle; + break; + case "Module": + output.Type = OutputType.Module; + break; + case "Patch": + output.Type = OutputType.Patch; + break; + case "PatchCreation": + output.Type = OutputType.PatchCreation; + break; + case "Product": + output.Type = OutputType.Product; + break; + case "Transform": + output.Type = OutputType.Transform; + break; + default: + throw new XmlException(); + } + break; + case "version": + version = new Version(reader.Value); + break; + } + } + + if (!suppressVersionCheck && null != version && !WindowsInstallerData.CurrentVersion.Equals(version)) + { + throw new WixException(ErrorMessages.VersionMismatch(SourceLineNumber.CreateFromUri(reader.BaseURI), WindowsInstallerData.XmlElementName, version.ToString(), WindowsInstallerData.CurrentVersion.ToString())); + } + + // loop through the rest of the xml building up the Output object + TableDefinitionCollection tableDefinitions = null; + var tables = new List
(); + if (!empty) + { + var done = false; + + // loop through all the fields in a row + while (!done && reader.Read()) + { + switch (reader.NodeType) + { + case XmlNodeType.Element: + switch (reader.LocalName) + { + case "subStorage": + output.SubStorages.Add(SubStorage.Read(reader)); + break; + case "table": + if (null == tableDefinitions) + { + throw new XmlException(); + } + tables.Add(Table.Read(reader, tableDefinitions)); + break; + case "tableDefinitions": + tableDefinitions = TableDefinitionCollection.Read(reader); + break; + default: + throw new XmlException(); + } + break; + case XmlNodeType.EndElement: + done = true; + break; + } + } + + if (!done) + { + throw new XmlException(); + } + } + + output.Tables = new TableIndexedCollection(tables); + return output; + } + + /// + /// Ensure this output contains a particular table. + /// + /// Definition of the table that should exist. + /// Optional section to use for the table. If one is not provided, the entry section will be used. + /// The table in this output. + public Table EnsureTable(TableDefinition tableDefinition) + { + if (!this.Tables.TryGetTable(tableDefinition.Name, out var table)) + { + table = new Table(tableDefinition); + this.Tables.Add(table); + } + + return table; + } + + /// + /// Persists an output in an XML format. + /// + /// XmlWriter where the Output should persist itself as XML. + internal void Write(XmlWriter writer) + { + writer.WriteStartElement(WindowsInstallerData.XmlElementName, XmlNamespaceUri); + + writer.WriteAttributeString("type", this.Type.ToString()); + + if (0 != this.Codepage) + { + writer.WriteAttributeString("codepage", this.Codepage.ToString(CultureInfo.InvariantCulture)); + } + + writer.WriteAttributeString("version", WindowsInstallerData.CurrentVersion.ToString()); + + // Collect all the table definitions and write them. + var tableDefinitions = new TableDefinitionCollection(); + foreach (var table in this.Tables) + { + tableDefinitions.Add(table.Definition); + } + tableDefinitions.Write(writer); + + foreach (var table in this.Tables.OrderBy(t => t.Name)) + { + table.Write(writer); + } + + foreach (var subStorage in this.SubStorages) + { + subStorage.Write(writer); + } + + writer.WriteEndElement(); + } + } +} diff --git a/src/WixToolset.Data/WindowsInstaller/Xsd/data.xsd b/src/WixToolset.Data/WindowsInstaller/Xsd/data.xsd new file mode 100644 index 00000000..a3dc7e2b --- /dev/null +++ b/src/WixToolset.Data/WindowsInstaller/Xsd/data.xsd @@ -0,0 +1,66 @@ + + + + + + + + Schema for describing WiX Windows Installer Data files. + + + + + + + + + + + + + + + + Codepage of the output. + + + + + Type of the output. + + + + + + + + + + + + + + + Version of WiX used to create this output file. + + + + + + + + + + + + + Name of the substorage. + + + + + diff --git a/src/WixToolset.Data/WindowsInstaller/Xsd/outputs.xsd b/src/WixToolset.Data/WindowsInstaller/Xsd/outputs.xsd deleted file mode 100644 index 00e20f12..00000000 --- a/src/WixToolset.Data/WindowsInstaller/Xsd/outputs.xsd +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - - Schema for describing WiX Output files (.wixout). - - - - - - - - - - - - - - - - Codepage of the output. - - - - - Type of the output. - - - - - - - - - - - - - - - Version of WiX used to create this output file. - - - - - - - - - - - - - Name of the substorage. - - - - - diff --git a/src/WixToolset.Data/WindowsInstaller/Xsd/pdbs.xsd b/src/WixToolset.Data/WindowsInstaller/Xsd/pdbs.xsd deleted file mode 100644 index c1d1756d..00000000 --- a/src/WixToolset.Data/WindowsInstaller/Xsd/pdbs.xsd +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - - Schema for describing WiX Pdb files (.wixpdb). - - - - - - - - - - - - - - - - Version of WiX used to create this pdb file - - - - - -- cgit v1.2.3-55-g6feb