Add optional DOCTYPE writing to XmlSerializer

This commit is contained in:
Matt Nadareski
2023-07-31 11:08:08 -04:00
parent b45258f8fc
commit 2b19129118

View File

@@ -15,8 +15,13 @@ namespace SabreTools.Serialization
/// </summary> /// </summary>
/// <param name="obj">Data to serialize</param> /// <param name="obj">Data to serialize</param>
/// <param name="path">Path to the file to serialize to</param> /// <param name="path">Path to the file to serialize to</param>
/// <param name="obj">Data to serialize</param>
/// <param name="name">Optional DOCTYPE name</param>
/// <param name="pubid">Optional DOCTYPE pubid</param>
/// <param name="sysid">Optional DOCTYPE sysid</param>
/// <param name="subset">Optional DOCTYPE name</param>
/// <returns>True on successful serialization, false otherwise</returns> /// <returns>True on successful serialization, false otherwise</returns>
public static bool SerializeToFile(T? obj, string path) public static bool SerializeToFile(T? obj, string path, string? name = null, string? pubid = null, string? sysid = null, string? subset = null)
{ {
using var stream = SerializeToStream(obj); using var stream = SerializeToStream(obj);
if (stream == null) if (stream == null)
@@ -31,8 +36,12 @@ namespace SabreTools.Serialization
/// Serializes the defined type to a stream /// Serializes the defined type to a stream
/// </summary> /// </summary>
/// <param name="obj">Data to serialize</param> /// <param name="obj">Data to serialize</param>
/// <param name="name">Optional DOCTYPE name</param>
/// <param name="pubid">Optional DOCTYPE pubid</param>
/// <param name="sysid">Optional DOCTYPE sysid</param>
/// <param name="subset">Optional DOCTYPE name</param>
/// <returns>Stream containing serialized data on success, null otherwise</returns> /// <returns>Stream containing serialized data on success, null otherwise</returns>
public static Stream? SerializeToStream(T? obj) public static Stream? SerializeToStream(T? obj, string? name = null, string? pubid = null, string? sysid = null, string? subset = null)
{ {
// If the object is null // If the object is null
if (obj == null) if (obj == null)
@@ -52,6 +61,10 @@ namespace SabreTools.Serialization
var streamWriter = new StreamWriter(stream); var streamWriter = new StreamWriter(stream);
var xmlWriter = XmlWriter.Create(streamWriter, settings); var xmlWriter = XmlWriter.Create(streamWriter, settings);
// Write the doctype if provided
if (!string.IsNullOrWhiteSpace(name))
xmlWriter.WriteDocType(name, pubid, sysid, subset);
// Perform the deserialization and return // Perform the deserialization and return
serializer.Serialize(xmlWriter, obj); serializer.Serialize(xmlWriter, obj);
stream.Seek(0, SeekOrigin.Begin); stream.Seek(0, SeekOrigin.Begin);