1 // Permission is hereby granted, free of charge, to any person obtaining
2 // a copy of this software and associated documentation files (the
3 // "Software"), to deal in the Software without restriction, including
4 // without limitation the rights to use, copy, modify, merge, publish,
5 // distribute, sublicense, and/or sell copies of the Software, and to
6 // permit persons to whom the Software is furnished to do so, subject to
7 // the following conditions:
9 // The above copyright notice and this permission notice shall be
10 // included in all copies or substantial portions of the Software.
12 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
13 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
14 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
15 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
16 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
17 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
18 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
20 // Copyright (c) 2004-2005 Novell, Inc.
23 // Duncan Mak duncan@ximian.com
24 // Gonzalo Paniagua Javier gonzalo@ximian.com
25 // Peter Bartok pbartok@novell.com
30 using System.ComponentModel;
32 using System.Runtime.Serialization.Formatters.Binary;
36 namespace System.Resources
38 public class ResXResourceWriter : IResourceWriter, IDisposable
40 #region Local Variables
41 private string filename;
42 private Stream stream;
43 private TextWriter textwriter;
44 private XmlTextWriter writer;
46 #endregion // Local Variables
49 public static readonly string BinSerializedObjectMimeType = "application/x-microsoft.net.object.binary.base64";
50 public static readonly string ByteArraySerializedObjectMimeType = "application/x-microsoft.net.object.bytearray.base64";
51 public static readonly string DefaultSerializedObjectMimeType = BinSerializedObjectMimeType;
52 public static readonly string ResMimeType = "text/microsoft-resx";
53 public static readonly string ResourceSchema = schema;
\r
54 public static readonly string SoapSerializedObjectMimeType = "application/x-microsoft.net.object.soap.base64";
55 public static readonly string Version = "1.3";
56 #endregion // Static Fields
58 #region Constructors & Destructor
59 public ResXResourceWriter (Stream stream)
62 throw new ArgumentNullException ("stream");
64 if (stream.CanWrite == false)
65 throw new ArgumentException ("stream is not writable.", "stream");
70 public ResXResourceWriter (TextWriter textwriter)
72 if (textwriter == null)
73 throw new ArgumentNullException ("textwriter");
75 this.textwriter = textwriter;
78 public ResXResourceWriter (string fileName)
81 throw new ArgumentNullException ("fileName");
83 this.filename = fileName;
86 ~ResXResourceWriter() {
89 #endregion // Constructors & Destructor
94 stream = File.OpenWrite (filename);
95 if (textwriter == null)
96 textwriter = new StreamWriter (stream, Encoding.UTF8);
98 writer = new XmlTextWriter (textwriter);
99 writer.Formatting = Formatting.Indented;
100 writer.WriteStartDocument ();
101 writer.WriteStartElement ("root");
102 writer.WriteRaw (schema);
103 WriteHeader ("resmimetype", "text/microsoft-resx");
104 WriteHeader ("version", "1.3");
105 WriteHeader ("reader", typeof (ResXResourceReader).AssemblyQualifiedName);
106 WriteHeader ("writer", typeof (ResXResourceWriter).AssemblyQualifiedName);
109 void WriteHeader (string name, string value)
111 writer.WriteStartElement ("resheader");
112 writer.WriteAttributeString ("name", name);
113 writer.WriteStartElement ("value");
114 writer.WriteString (value);
115 writer.WriteEndElement ();
116 writer.WriteEndElement ();
119 void WriteNiceBase64(byte[] value, int offset, int length) {
126 b64 = Convert.ToBase64String(value, offset, length);
128 // Wild guess; two extra newlines, and one newline/tab pair for every 80 chars
129 sb = new StringBuilder(b64, b64.Length + ((b64.Length + 160) / 80) * 3);
131 inc = 80 + Environment.NewLine.Length + 1;
132 ins = Environment.NewLine + "\t";
133 while (pos < sb.Length) {
137 sb.Insert(sb.Length, Environment.NewLine);
138 writer.WriteString(sb.ToString());
141 void WriteBytes (string name, Type type, byte [] value, int offset, int length)
143 writer.WriteStartElement ("data");
144 writer.WriteAttributeString ("name", name);
147 writer.WriteAttributeString ("type", type.AssemblyQualifiedName);
148 // byte[] should never get a mimetype, otherwise MS.NET won't be able
149 // to parse the data.
150 if (type != typeof (byte[]))
151 writer.WriteAttributeString ("mimetype", ByteArraySerializedObjectMimeType);
152 writer.WriteStartElement ("value");
153 WriteNiceBase64(value, offset, length);
155 writer.WriteAttributeString ("mimetype", BinSerializedObjectMimeType);
156 writer.WriteStartElement ("value");
157 writer.WriteBase64 (value, offset, length);
160 writer.WriteEndElement ();
161 writer.WriteEndElement ();
164 void WriteBytes (string name, Type type, byte [] value)
166 WriteBytes (name, type, value, 0, value.Length);
169 void WriteString (string name, string value)
171 WriteString (name, value, null);
174 void WriteString (string name, string value, Type type)
176 writer.WriteStartElement ("data");
177 writer.WriteAttributeString ("name", name);
179 writer.WriteAttributeString ("type", type.AssemblyQualifiedName);
180 writer.WriteStartElement ("value");
181 writer.WriteString (value);
182 writer.WriteEndElement ();
183 writer.WriteEndElement ();
184 writer.WriteWhitespace ("\n ");
187 public void AddResource (string name, byte [] value)
190 throw new ArgumentNullException ("name");
193 throw new ArgumentNullException ("value");
196 throw new InvalidOperationException ("The resource is already generated.");
201 WriteBytes (name, value.GetType (), value);
204 public void AddResource (string name, object value)
206 if (value is string) {
207 AddResource (name, (string) value);
211 if (value is byte[]) {
212 AddResource (name, (byte[]) value);
217 throw new ArgumentNullException ("name");
220 throw new ArgumentNullException ("value");
222 if (!value.GetType ().IsSerializable)
223 throw new InvalidOperationException (String.Format ("The element '{0}' of type '{1}' is not serializable.", name, value.GetType ().Name));
226 throw new InvalidOperationException ("The resource is already generated.");
231 TypeConverter converter = TypeDescriptor.GetConverter (value);
232 if (converter != null && converter.CanConvertTo (typeof (string)) && converter.CanConvertFrom (typeof (string))) {
233 string str = (string) converter.ConvertToInvariantString (value);
234 WriteString (name, str, value.GetType ());
238 if (converter != null && converter.CanConvertTo (typeof (byte[])) && converter.CanConvertFrom (typeof (byte[]))) {
239 byte[] b = (byte[]) converter.ConvertTo (value, typeof (byte[]));
240 WriteBytes (name, value.GetType (), b);
244 MemoryStream ms = new MemoryStream ();
245 BinaryFormatter fmt = new BinaryFormatter ();
247 fmt.Serialize (ms, value);
248 } catch (Exception e) {
249 throw new InvalidOperationException ("Cannot add a " + value.GetType () +
250 "because it cannot be serialized: " +
254 WriteBytes (name, null, ms.GetBuffer (), 0, (int) ms.Length);
258 public void AddResource (string name, string value)
261 throw new ArgumentNullException ("name");
264 throw new ArgumentNullException ("value");
267 throw new InvalidOperationException ("The resource is already generated.");
272 WriteString (name, value);
281 if (writer != null) {
289 public virtual void Dispose ()
292 GC.SuppressFinalize(this);
295 public void Generate ()
298 throw new InvalidOperationException ("The resource is already generated.");
301 writer.WriteEndElement ();
305 protected virtual void Dispose(bool disposing) {
311 static string schema = @"
312 <xsd:schema id='root' xmlns='' xmlns:xsd='http://www.w3.org/2001/XMLSchema' xmlns:msdata='urn:schemas-microsoft-com:xml-msdata'>
313 <xsd:element name='root' msdata:IsDataSet='true'>
315 <xsd:choice maxOccurs='unbounded'>
316 <xsd:element name='data'>
319 <xsd:element name='value' type='xsd:string' minOccurs='0' msdata:Ordinal='1' />
320 <xsd:element name='comment' type='xsd:string' minOccurs='0' msdata:Ordinal='2' />
322 <xsd:attribute name='name' type='xsd:string' msdata:Ordinal='1' />
323 <xsd:attribute name='type' type='xsd:string' msdata:Ordinal='3' />
324 <xsd:attribute name='mimetype' type='xsd:string' msdata:Ordinal='4' />
327 <xsd:element name='resheader'>
330 <xsd:element name='value' type='xsd:string' minOccurs='0' msdata:Ordinal='1' />
332 <xsd:attribute name='name' type='xsd:string' use='required' />
339 ".Replace ("'", "\"");