csharptest | 2b86884 | 2011-06-10 14:41:47 -0500 | [diff] [blame] | 1 | using System;
|
csharptest | 74c5e0c | 2011-07-14 13:06:22 -0500 | [diff] [blame] | 2 | using System.Collections;
|
csharptest | 2b86884 | 2011-06-10 14:41:47 -0500 | [diff] [blame] | 3 | using System.IO;
|
csharptest | 7fc785c | 2011-06-10 23:54:53 -0500 | [diff] [blame] | 4 | using System.Text;
|
csharptest | 2b86884 | 2011-06-10 14:41:47 -0500 | [diff] [blame] | 5 | using System.Xml;
|
| 6 | using Google.ProtocolBuffers.Descriptors;
|
| 7 |
|
| 8 | namespace Google.ProtocolBuffers.Serialization
|
| 9 | {
|
| 10 | /// <summary>
|
| 11 | /// Writes a proto buffer to an XML document or fragment. .NET 3.5 users may also
|
| 12 | /// use this class to produce Json by setting the options to support Json and providing
|
| 13 | /// an XmlWriter obtained from <see cref="System.Runtime.Serialization.Json.JsonReaderWriterFactory"/>.
|
| 14 | /// </summary>
|
| 15 | public class XmlFormatWriter : AbstractTextWriter
|
| 16 | {
|
| 17 | public const string DefaultRootElementName = "root";
|
| 18 | private const int NestedArrayFlag = 0x0001;
|
| 19 | private readonly XmlWriter _output;
|
| 20 | private string _rootElementName;
|
| 21 |
|
csharptest | 74c5e0c | 2011-07-14 13:06:22 -0500 | [diff] [blame] | 22 | private static XmlWriterSettings DefaultSettings(Encoding encoding)
|
csharptest | 2b86884 | 2011-06-10 14:41:47 -0500 | [diff] [blame] | 23 | {
|
csharptest | 74c5e0c | 2011-07-14 13:06:22 -0500 | [diff] [blame] | 24 | return new XmlWriterSettings()
|
| 25 | {
|
| 26 | CheckCharacters = false,
|
| 27 | NewLineHandling = NewLineHandling.Entitize,
|
| 28 | OmitXmlDeclaration = true,
|
| 29 | Encoding = encoding,
|
| 30 | };
|
csharptest | 2b86884 | 2011-06-10 14:41:47 -0500 | [diff] [blame] | 31 | }
|
| 32 |
|
| 33 | /// <summary>
|
| 34 | /// Constructs the XmlFormatWriter to write to the given TextWriter
|
| 35 | /// </summary>
|
csharptest | 74c5e0c | 2011-07-14 13:06:22 -0500 | [diff] [blame] | 36 | public static XmlFormatWriter CreateInstance(TextWriter output)
|
| 37 | {
|
| 38 | return new XmlFormatWriter(XmlWriter.Create(output, DefaultSettings(output.Encoding)));
|
| 39 | }
|
| 40 |
|
csharptest | 2b86884 | 2011-06-10 14:41:47 -0500 | [diff] [blame] | 41 | /// <summary>
|
| 42 | /// Constructs the XmlFormatWriter to write to the given stream
|
| 43 | /// </summary>
|
csharptest | 74c5e0c | 2011-07-14 13:06:22 -0500 | [diff] [blame] | 44 | public static XmlFormatWriter CreateInstance(Stream output)
|
| 45 | {
|
| 46 | return new XmlFormatWriter(XmlWriter.Create(output, DefaultSettings(Encoding.UTF8)));
|
| 47 | }
|
| 48 |
|
csharptest | 7fc785c | 2011-06-10 23:54:53 -0500 | [diff] [blame] | 49 | /// <summary>
|
| 50 | /// Constructs the XmlFormatWriter to write to the given stream
|
| 51 | /// </summary>
|
csharptest | 74c5e0c | 2011-07-14 13:06:22 -0500 | [diff] [blame] | 52 | public static XmlFormatWriter CreateInstance(Stream output, Encoding encoding)
|
| 53 | {
|
| 54 | return new XmlFormatWriter(XmlWriter.Create(output, DefaultSettings(encoding)));
|
| 55 | }
|
| 56 |
|
csharptest | 2b86884 | 2011-06-10 14:41:47 -0500 | [diff] [blame] | 57 | /// <summary>
|
| 58 | /// Constructs the XmlFormatWriter to write to the given XmlWriter
|
| 59 | /// </summary>
|
csharptest | 74c5e0c | 2011-07-14 13:06:22 -0500 | [diff] [blame] | 60 | public static XmlFormatWriter CreateInstance(XmlWriter output)
|
| 61 | {
|
| 62 | return new XmlFormatWriter(output);
|
| 63 | }
|
csharptest | 7fc785c | 2011-06-10 23:54:53 -0500 | [diff] [blame] | 64 |
|
| 65 | protected XmlFormatWriter(XmlWriter output)
|
csharptest | 2b86884 | 2011-06-10 14:41:47 -0500 | [diff] [blame] | 66 | {
|
| 67 | _output = output;
|
| 68 | _rootElementName = DefaultRootElementName;
|
| 69 | }
|
| 70 |
|
| 71 | /// <summary>
|
| 72 | /// Closes the underlying XmlTextWriter
|
| 73 | /// </summary>
|
| 74 | protected override void Dispose(bool disposing)
|
| 75 | {
|
csharptest | 74c5e0c | 2011-07-14 13:06:22 -0500 | [diff] [blame] | 76 | if (disposing)
|
| 77 | {
|
csharptest | 2b86884 | 2011-06-10 14:41:47 -0500 | [diff] [blame] | 78 | _output.Close();
|
csharptest | 74c5e0c | 2011-07-14 13:06:22 -0500 | [diff] [blame] | 79 | }
|
csharptest | 2b86884 | 2011-06-10 14:41:47 -0500 | [diff] [blame] | 80 | }
|
| 81 |
|
| 82 | /// <summary>
|
| 83 | /// Gets or sets the default element name to use when using the Merge<TBuilder>()
|
| 84 | /// </summary>
|
| 85 | public string RootElementName
|
| 86 | {
|
| 87 | get { return _rootElementName; }
|
csharptest | 74c5e0c | 2011-07-14 13:06:22 -0500 | [diff] [blame] | 88 | set
|
| 89 | {
|
| 90 | ThrowHelper.ThrowIfNull(value, "RootElementName");
|
| 91 | _rootElementName = value;
|
| 92 | }
|
csharptest | 2b86884 | 2011-06-10 14:41:47 -0500 | [diff] [blame] | 93 | }
|
| 94 |
|
| 95 | /// <summary>
|
| 96 | /// Gets or sets the options to use while generating the XML
|
| 97 | /// </summary>
|
| 98 | public XmlWriterOptions Options { get; set; }
|
csharptest | 74c5e0c | 2011-07-14 13:06:22 -0500 | [diff] [blame] | 99 |
|
csharptest | 7fc785c | 2011-06-10 23:54:53 -0500 | [diff] [blame] | 100 | /// <summary>
|
| 101 | /// Sets the options to use while generating the XML
|
| 102 | /// </summary>
|
csharptest | 74c5e0c | 2011-07-14 13:06:22 -0500 | [diff] [blame] | 103 | public XmlFormatWriter SetOptions(XmlWriterOptions options)
|
| 104 | {
|
| 105 | Options = options;
|
| 106 | return this;
|
| 107 | }
|
csharptest | 2b86884 | 2011-06-10 14:41:47 -0500 | [diff] [blame] | 108 |
|
csharptest | 74c5e0c | 2011-07-14 13:06:22 -0500 | [diff] [blame] | 109 | private bool TestOption(XmlWriterOptions option)
|
| 110 | {
|
| 111 | return (Options & option) != 0;
|
| 112 | }
|
csharptest | 2b86884 | 2011-06-10 14:41:47 -0500 | [diff] [blame] | 113 |
|
| 114 | /// <summary>
|
| 115 | /// Writes a message as an element using the name defined in <see cref="RootElementName"/>
|
| 116 | /// </summary>
|
| 117 | public override void WriteMessage(IMessageLite message)
|
csharptest | 74c5e0c | 2011-07-14 13:06:22 -0500 | [diff] [blame] | 118 | {
|
| 119 | WriteMessage(_rootElementName, message);
|
| 120 | }
|
csharptest | 2b86884 | 2011-06-10 14:41:47 -0500 | [diff] [blame] | 121 |
|
| 122 | /// <summary>
|
| 123 | /// Writes a message as an element with the given name
|
| 124 | /// </summary>
|
csharptest | 4dc0dfb | 2011-06-10 18:01:34 -0500 | [diff] [blame] | 125 | public void WriteMessage(string elementName, IMessageLite message)
|
csharptest | 2b86884 | 2011-06-10 14:41:47 -0500 | [diff] [blame] | 126 | {
|
| 127 | if (TestOption(XmlWriterOptions.OutputJsonTypes))
|
| 128 | {
|
| 129 | _output.WriteStartElement("root"); // json requires this is the root-element
|
| 130 | _output.WriteAttributeString("type", "object");
|
| 131 | }
|
| 132 | else
|
csharptest | 74c5e0c | 2011-07-14 13:06:22 -0500 | [diff] [blame] | 133 | {
|
csharptest | 2b86884 | 2011-06-10 14:41:47 -0500 | [diff] [blame] | 134 | _output.WriteStartElement(elementName);
|
csharptest | 74c5e0c | 2011-07-14 13:06:22 -0500 | [diff] [blame] | 135 | }
|
csharptest | 2b86884 | 2011-06-10 14:41:47 -0500 | [diff] [blame] | 136 |
|
| 137 | message.WriteTo(this);
|
| 138 | _output.WriteEndElement();
|
| 139 | _output.Flush();
|
| 140 | }
|
| 141 |
|
| 142 | /// <summary>
|
| 143 | /// Writes a message
|
| 144 | /// </summary>
|
| 145 | protected override void WriteMessageOrGroup(string field, IMessageLite message)
|
| 146 | {
|
| 147 | _output.WriteStartElement(field);
|
| 148 |
|
| 149 | if (TestOption(XmlWriterOptions.OutputJsonTypes))
|
csharptest | 74c5e0c | 2011-07-14 13:06:22 -0500 | [diff] [blame] | 150 | {
|
csharptest | 2b86884 | 2011-06-10 14:41:47 -0500 | [diff] [blame] | 151 | _output.WriteAttributeString("type", "object");
|
csharptest | 74c5e0c | 2011-07-14 13:06:22 -0500 | [diff] [blame] | 152 | }
|
csharptest | 2b86884 | 2011-06-10 14:41:47 -0500 | [diff] [blame] | 153 |
|
| 154 | message.WriteTo(this);
|
| 155 | _output.WriteEndElement();
|
| 156 | }
|
| 157 |
|
| 158 | /// <summary>
|
| 159 | /// Writes a String value
|
| 160 | /// </summary>
|
| 161 | protected override void WriteAsText(string field, string textValue, object typedValue)
|
| 162 | {
|
| 163 | _output.WriteStartElement(field);
|
| 164 |
|
| 165 | if (TestOption(XmlWriterOptions.OutputJsonTypes))
|
| 166 | {
|
csharptest | 74c5e0c | 2011-07-14 13:06:22 -0500 | [diff] [blame] | 167 | if (typedValue is int || typedValue is uint || typedValue is long || typedValue is ulong ||
|
| 168 | typedValue is double || typedValue is float)
|
| 169 | {
|
csharptest | 2b86884 | 2011-06-10 14:41:47 -0500 | [diff] [blame] | 170 | _output.WriteAttributeString("type", "number");
|
csharptest | 74c5e0c | 2011-07-14 13:06:22 -0500 | [diff] [blame] | 171 | }
|
csharptest | 2b86884 | 2011-06-10 14:41:47 -0500 | [diff] [blame] | 172 | else if (typedValue is bool)
|
csharptest | 74c5e0c | 2011-07-14 13:06:22 -0500 | [diff] [blame] | 173 | {
|
csharptest | 2b86884 | 2011-06-10 14:41:47 -0500 | [diff] [blame] | 174 | _output.WriteAttributeString("type", "boolean");
|
csharptest | 74c5e0c | 2011-07-14 13:06:22 -0500 | [diff] [blame] | 175 | }
|
csharptest | 2b86884 | 2011-06-10 14:41:47 -0500 | [diff] [blame] | 176 | }
|
| 177 | _output.WriteString(textValue);
|
| 178 |
|
| 179 | //Empty strings should not be written as empty elements '<item/>', rather as '<item></item>'
|
| 180 | if (_output.WriteState == WriteState.Element)
|
csharptest | 74c5e0c | 2011-07-14 13:06:22 -0500 | [diff] [blame] | 181 | {
|
csharptest | 2b86884 | 2011-06-10 14:41:47 -0500 | [diff] [blame] | 182 | _output.WriteRaw("");
|
csharptest | 74c5e0c | 2011-07-14 13:06:22 -0500 | [diff] [blame] | 183 | }
|
csharptest | 2b86884 | 2011-06-10 14:41:47 -0500 | [diff] [blame] | 184 |
|
| 185 | _output.WriteEndElement();
|
| 186 | }
|
| 187 |
|
| 188 | /// <summary>
|
| 189 | /// Writes an array of field values
|
| 190 | /// </summary>
|
csharptest | 74c5e0c | 2011-07-14 13:06:22 -0500 | [diff] [blame] | 191 | protected override void WriteArray(FieldType fieldType, string field, IEnumerable items)
|
csharptest | 2b86884 | 2011-06-10 14:41:47 -0500 | [diff] [blame] | 192 | {
|
| 193 | //see if it's empty
|
csharptest | 74c5e0c | 2011-07-14 13:06:22 -0500 | [diff] [blame] | 194 | IEnumerator eitems = items.GetEnumerator();
|
| 195 | try
|
| 196 | {
|
| 197 | if (!eitems.MoveNext())
|
| 198 | {
|
| 199 | return;
|
| 200 | }
|
| 201 | }
|
csharptest | 2b86884 | 2011-06-10 14:41:47 -0500 | [diff] [blame] | 202 | finally
|
csharptest | 74c5e0c | 2011-07-14 13:06:22 -0500 | [diff] [blame] | 203 | {
|
| 204 | if (eitems is IDisposable)
|
| 205 | {
|
| 206 | ((IDisposable) eitems).Dispose();
|
| 207 | }
|
| 208 | }
|
csharptest | 2b86884 | 2011-06-10 14:41:47 -0500 | [diff] [blame] | 209 |
|
| 210 | if (TestOption(XmlWriterOptions.OutputNestedArrays | XmlWriterOptions.OutputJsonTypes))
|
| 211 | {
|
| 212 | _output.WriteStartElement(field);
|
| 213 | if (TestOption(XmlWriterOptions.OutputJsonTypes))
|
csharptest | 74c5e0c | 2011-07-14 13:06:22 -0500 | [diff] [blame] | 214 | {
|
csharptest | 2b86884 | 2011-06-10 14:41:47 -0500 | [diff] [blame] | 215 | _output.WriteAttributeString("type", "array");
|
csharptest | 74c5e0c | 2011-07-14 13:06:22 -0500 | [diff] [blame] | 216 | }
|
csharptest | 2b86884 | 2011-06-10 14:41:47 -0500 | [diff] [blame] | 217 |
|
| 218 | base.WriteArray(fieldType, "item", items);
|
| 219 | _output.WriteEndElement();
|
| 220 | }
|
| 221 | else
|
csharptest | 74c5e0c | 2011-07-14 13:06:22 -0500 | [diff] [blame] | 222 | {
|
csharptest | 2b86884 | 2011-06-10 14:41:47 -0500 | [diff] [blame] | 223 | base.WriteArray(fieldType, field, items);
|
csharptest | 74c5e0c | 2011-07-14 13:06:22 -0500 | [diff] [blame] | 224 | }
|
csharptest | 2b86884 | 2011-06-10 14:41:47 -0500 | [diff] [blame] | 225 | }
|
| 226 |
|
| 227 | /// <summary>
|
| 228 | /// Writes a System.Enum by the numeric and textual value
|
| 229 | /// </summary>
|
| 230 | protected override void WriteEnum(string field, int number, string name)
|
| 231 | {
|
| 232 | _output.WriteStartElement(field);
|
| 233 |
|
| 234 | if (!TestOption(XmlWriterOptions.OutputJsonTypes) && TestOption(XmlWriterOptions.OutputEnumValues))
|
csharptest | 74c5e0c | 2011-07-14 13:06:22 -0500 | [diff] [blame] | 235 | {
|
csharptest | 2b86884 | 2011-06-10 14:41:47 -0500 | [diff] [blame] | 236 | _output.WriteAttributeString("value", XmlConvert.ToString(number));
|
csharptest | 74c5e0c | 2011-07-14 13:06:22 -0500 | [diff] [blame] | 237 | }
|
csharptest | 2b86884 | 2011-06-10 14:41:47 -0500 | [diff] [blame] | 238 |
|
| 239 | _output.WriteString(name);
|
| 240 | _output.WriteEndElement();
|
| 241 | }
|
| 242 | }
|
csharptest | 74c5e0c | 2011-07-14 13:06:22 -0500 | [diff] [blame] | 243 | } |