5 // Lluis Sanchez Gual (lluis@ximian.com)
7 // (C) 2002, 2003 Ximian, Inc. http://www.ximian.com
11 // Permission is hereby granted, free of charge, to any person obtaining
12 // a copy of this software and associated documentation files (the
13 // "Software"), to deal in the Software without restriction, including
14 // without limitation the rights to use, copy, modify, merge, publish,
15 // distribute, sublicense, and/or sell copies of the Software, and to
16 // permit persons to whom the Software is furnished to do so, subject to
17 // the following conditions:
19 // The above copyright notice and this permission notice shall be
20 // included in all copies or substantial portions of the Software.
22 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
23 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
24 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
25 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
26 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
27 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
28 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
32 using System.Threading;
33 using System.Collections;
34 using System.Globalization;
36 using System.Reflection;
38 using System.Xml.Schema;
42 using System.CodeDom.Compiler;
43 using Microsoft.CSharp;
45 using System.Configuration;
46 using System.Security.Policy;
48 namespace System.Xml.Serialization
51 public class XmlSerializer
53 internal const string WsdlNamespace = "http://schemas.xmlsoap.org/wsdl/";
54 internal const string EncodingNamespace = "http://schemas.xmlsoap.org/soap/encoding/";
55 internal const string WsdlTypesNamespace = "http://microsoft.com/wsdl/types/";
56 static int generationThreshold;
57 static bool backgroundGeneration = true;
58 static bool deleteTempFiles = true;
59 static bool generatorFallback = true;
61 bool customSerializer;
62 XmlMapping typeMapping;
64 SerializerData serializerData;
66 static Hashtable serializerTypes = new Hashtable ();
68 internal class SerializerData
70 public int UsageCount;
71 public bool Generated;
72 public Type ReaderType;
73 public MethodInfo ReaderMethod;
74 public Type WriterType;
75 public MethodInfo WriterMethod;
76 public GenerationBatch Batch;
77 public XmlSerializerImplementation Implementation = null;
79 public XmlSerializationReader CreateReader () {
80 if (ReaderType != null)
81 return (XmlSerializationReader) Activator.CreateInstance (ReaderType);
82 else if (Implementation != null)
83 return Implementation.Reader;
88 public XmlSerializationWriter CreateWriter () {
89 if (WriterType != null)
90 return (XmlSerializationWriter) Activator.CreateInstance (WriterType);
91 else if (Implementation != null)
92 return Implementation.Writer;
98 internal class GenerationBatch
101 public XmlMapping[] Maps;
102 public SerializerData[] Datas;
105 static XmlSerializer ()
107 // The following options are available:
108 // MONO_XMLSERIALIZER_DEBUG: when set to something != "no", it will
109 // it will print the name of the generated file, and it won't
111 // MONO_XMLSERIALIZER_THS: The code generator threshold. It can be:
112 // no: does not use the generator, always the interpreter.
113 // 0: always use the generator, wait until the generation is done.
114 // any number: use the interpreted serializer until the specified
115 // number of serializations is reached. At this point the generation
116 // of the serializer will start in the background. The interpreter
117 // will be used while the serializer is being generated.
119 // XmlSerializer will fall back to the interpreted serializer if
120 // the code generation somehow fails. This can be avoided for
121 // debugging pourposes by adding the "nofallback" option.
122 // For example: MONO_XMLSERIALIZER_THS=0,nofallback
127 generationThreshold = -1;
128 backgroundGeneration = false;
130 string db = Environment.GetEnvironmentVariable ("MONO_XMLSERIALIZER_DEBUG");
131 string th = Environment.GetEnvironmentVariable ("MONO_XMLSERIALIZER_THS");
134 generationThreshold = 50;
135 backgroundGeneration = true;
137 int i = th.IndexOf (',');
139 if (th.Substring (i+1) == "nofallback")
140 generatorFallback = false;
141 th = th.Substring (0, i);
144 if (th.ToLower(CultureInfo.InvariantCulture) == "no")
145 generationThreshold = -1;
147 generationThreshold = int.Parse (th, CultureInfo.InvariantCulture);
148 backgroundGeneration = (generationThreshold != 0);
152 deleteTempFiles = (db == null || db == "no");
154 IDictionary table = (IDictionary) ConfigurationSettings.GetConfig("system.diagnostics");
157 table = (IDictionary) table["switches"];
160 string val = (string) table ["XmlSerialization.Compilation"];
161 if (val == "1") deleteTempFiles = false;
169 protected XmlSerializer ()
171 customSerializer = true;
174 public XmlSerializer (Type type)
175 : this (type, null, null, null, null)
179 public XmlSerializer (XmlTypeMapping xmlTypeMapping)
181 typeMapping = xmlTypeMapping;
184 internal XmlSerializer (XmlMapping mapping, SerializerData data)
186 typeMapping = mapping;
187 serializerData = data;
190 public XmlSerializer (Type type, string defaultNamespace)
191 : this (type, null, null, null, defaultNamespace)
195 public XmlSerializer (Type type, Type[] extraTypes)
196 : this (type, null, extraTypes, null, null)
200 public XmlSerializer (Type type, XmlAttributeOverrides overrides)
201 : this (type, overrides, null, null, null)
205 public XmlSerializer (Type type, XmlRootAttribute root)
206 : this (type, null, null, root, null)
210 public XmlSerializer (Type type,
211 XmlAttributeOverrides overrides,
213 XmlRootAttribute root,
214 string defaultNamespace)
217 throw new ArgumentNullException ("type");
219 XmlReflectionImporter importer = new XmlReflectionImporter (overrides, defaultNamespace);
221 if (extraTypes != null)
223 foreach (Type intype in extraTypes)
224 importer.IncludeType (intype);
227 typeMapping = importer.ImportTypeMapping (type, root, defaultNamespace);
230 internal XmlMapping Mapping
232 get { return typeMapping; }
237 public XmlSerializer (Type type,
238 XmlAttributeOverrides overrides,
240 XmlRootAttribute root,
241 string defaultNamespace,
247 #endregion // Constructors
250 private UnreferencedObjectEventHandler onUnreferencedObject;
251 private XmlAttributeEventHandler onUnknownAttribute;
252 private XmlElementEventHandler onUnknownElement;
253 private XmlNodeEventHandler onUnknownNode;
255 public event XmlAttributeEventHandler UnknownAttribute
257 add { onUnknownAttribute += value; } remove { onUnknownAttribute -= value; }
260 public event XmlElementEventHandler UnknownElement
262 add { onUnknownElement += value; } remove { onUnknownElement -= value; }
265 public event XmlNodeEventHandler UnknownNode
267 add { onUnknownNode += value; } remove { onUnknownNode -= value; }
271 internal virtual void OnUnknownAttribute (XmlAttributeEventArgs e)
273 if (onUnknownAttribute != null) onUnknownAttribute(this, e);
276 internal virtual void OnUnknownElement (XmlElementEventArgs e)
278 if (onUnknownElement != null) onUnknownElement(this, e);
281 internal virtual void OnUnknownNode (XmlNodeEventArgs e)
283 if (onUnknownNode != null) onUnknownNode(this, e);
286 internal virtual void OnUnreferencedObject (UnreferencedObjectEventArgs e)
288 if (onUnreferencedObject != null) onUnreferencedObject(this, e);
291 public event UnreferencedObjectEventHandler UnreferencedObject
293 add { onUnreferencedObject += value; } remove { onUnreferencedObject -= value; }
300 public virtual bool CanDeserialize (XmlReader xmlReader)
302 xmlReader.MoveToContent ();
303 if (typeMapping is XmlMembersMapping)
306 return ((XmlTypeMapping)typeMapping).ElementName == xmlReader.LocalName;
309 protected virtual XmlSerializationReader CreateReader ()
311 // Must be implemented in derived class
312 throw new NotImplementedException ();
315 protected virtual XmlSerializationWriter CreateWriter ()
317 // Must be implemented in derived class
318 throw new NotImplementedException ();
321 public object Deserialize (Stream stream)
323 XmlTextReader xmlReader = new XmlTextReader(stream);
324 xmlReader.Normalization = true;
325 xmlReader.WhitespaceHandling = WhitespaceHandling.Significant;
326 return Deserialize(xmlReader);
329 public object Deserialize (TextReader textReader)
331 XmlTextReader xmlReader = new XmlTextReader(textReader);
332 xmlReader.Normalization = true;
333 xmlReader.WhitespaceHandling = WhitespaceHandling.Significant;
334 return Deserialize(xmlReader);
337 public object Deserialize (XmlReader xmlReader)
339 XmlSerializationReader xsReader;
340 if (customSerializer)
341 xsReader = CreateReader ();
343 xsReader = CreateReader (typeMapping);
345 xsReader.Initialize (xmlReader, this);
346 return Deserialize (xsReader);
349 protected virtual object Deserialize (XmlSerializationReader reader)
351 if (customSerializer)
352 // Must be implemented in derived class
353 throw new NotImplementedException ();
356 if (reader is XmlSerializationReaderInterpreter)
357 return ((XmlSerializationReaderInterpreter) reader).ReadRoot ();
360 return serializerData.ReaderMethod.Invoke (reader, null);
361 } catch (TargetInvocationException ex) {
362 throw ex.InnerException;
365 } catch (Exception ex) {
366 if (ex is InvalidOperationException || ex is InvalidCastException)
367 throw new InvalidOperationException ("There is an error in"
368 + " XML document.", ex);
373 public static XmlSerializer [] FromMappings (XmlMapping [] mappings)
375 XmlSerializer[] sers = new XmlSerializer [mappings.Length];
376 SerializerData[] datas = new SerializerData [mappings.Length];
377 GenerationBatch batch = new GenerationBatch ();
378 batch.Maps = mappings;
381 for (int n=0; n<mappings.Length; n++)
383 if (mappings[n] != null)
385 SerializerData data = new SerializerData ();
387 sers[n] = new XmlSerializer (mappings[n], data);
395 public static XmlSerializer [] FromTypes (Type [] types)
397 XmlSerializer [] sers = new XmlSerializer [types.Length];
398 for (int n=0; n<types.Length; n++)
399 sers[n] = new XmlSerializer (types[n]);
403 protected virtual void Serialize (object o, XmlSerializationWriter writer)
405 if (customSerializer)
406 // Must be implemented in derived class
407 throw new NotImplementedException ();
409 if (writer is XmlSerializationWriterInterpreter)
410 ((XmlSerializationWriterInterpreter)writer).WriteRoot (o);
413 serializerData.WriterMethod.Invoke (writer, new object[] {o});
414 } catch (TargetInvocationException ex) {
415 throw ex.InnerException;
420 static Encoding DefaultEncoding = Encoding.Default;
422 public void Serialize (Stream stream, object o)
424 XmlTextWriter xmlWriter = new XmlTextWriter (stream, DefaultEncoding);
425 xmlWriter.Formatting = Formatting.Indented;
426 Serialize (xmlWriter, o, null);
429 public void Serialize (TextWriter textWriter, object o)
431 XmlTextWriter xmlWriter = new XmlTextWriter (textWriter);
432 xmlWriter.Formatting = Formatting.Indented;
433 Serialize (xmlWriter, o, null);
436 public void Serialize (XmlWriter xmlWriter, object o)
438 Serialize (xmlWriter, o, null);
441 public void Serialize (Stream stream, object o, XmlSerializerNamespaces namespaces)
443 XmlTextWriter xmlWriter = new XmlTextWriter (stream, DefaultEncoding);
444 xmlWriter.Formatting = Formatting.Indented;
445 Serialize (xmlWriter, o, namespaces);
448 public void Serialize (TextWriter textWriter, object o, XmlSerializerNamespaces namespaces)
450 XmlTextWriter xmlWriter = new XmlTextWriter (textWriter);
451 xmlWriter.Formatting = Formatting.Indented;
452 Serialize (xmlWriter, o, namespaces);
456 public void Serialize (XmlWriter xmlWriter, object o, XmlSerializerNamespaces namespaces)
458 XmlSerializationWriter xsWriter;
461 if (customSerializer)
462 xsWriter = CreateWriter ();
464 xsWriter = CreateWriter (typeMapping);
466 if (namespaces == null || namespaces.Count == 0) {
467 namespaces = new XmlSerializerNamespaces ();
468 namespaces.Add ("xsi", XmlSchema.InstanceNamespace);
469 namespaces.Add ("xsd", XmlSchema.Namespace);
472 xsWriter.Initialize (xmlWriter, namespaces);
473 Serialize (o, xsWriter);
475 } catch (Exception ex) {
476 if (ex is TargetInvocationException)
477 ex = ex.InnerException;
479 if (ex is InvalidOperationException || ex is InvalidCastException)
480 throw new InvalidOperationException ("There was an error generating" +
481 " the XML document.", ex);
488 public object Deserialize (XmlReader xmlReader, string encodingStyle, XmlDeserializationEvents events)
490 throw new NotImplementedException ();
494 public object Deserialize (XmlReader xmlReader, string encodingStyle)
496 throw new NotImplementedException ();
500 public object Deserialize (XmlReader xmlReader, XmlDeserializationEvents events)
502 throw new NotImplementedException ();
506 public static XmlSerializer[] FromMappings (XmlMapping[] mappings, Evidence evidence)
508 throw new NotImplementedException ();
512 public static XmlSerializer[] FromMappings (XmlMapping[] mappings, Type type)
514 throw new NotImplementedException ();
518 public static Assembly GenerateSerializer (Type[] types, XmlMapping[] mappings)
520 return GenerateSerializer (types, mappings, null);
524 public static Assembly GenerateSerializer (Type[] types, XmlMapping[] mappings, CompilerParameters parameters)
526 GenerationBatch batch = new GenerationBatch ();
527 batch.Maps = mappings;
528 batch.Datas = new SerializerData [mappings.Length];
530 for (int n=0; n<mappings.Length; n++) {
531 SerializerData data = new SerializerData ();
533 batch.Datas [n] = data;
536 return GenerateSerializers (batch, parameters);
540 public static string GetXmlSerializerAssemblyName (Type type)
542 return type.Assembly.GetName().Name + ".XmlSerializers";
545 public static string GetXmlSerializerAssemblyName (Type type, string defaultNamespace)
547 return GetXmlSerializerAssemblyName (type) + "." + defaultNamespace.GetHashCode ();
551 public void Serialize (XmlWriter xmlWriter, object o, XmlSerializerNamespaces namespaces, string encodingStyle)
553 throw new NotImplementedException ();
556 [MonoNotSupported("")]
557 public void Serialize (XmlWriter xmlWriter, Object o, XmlSerializerNamespaces namespaces, string encodingStyle, string id)
559 throw new NotImplementedException ();
562 XmlSerializationWriter CreateWriter (XmlMapping typeMapping)
564 XmlSerializationWriter writer;
567 if (serializerData != null) {
568 lock (serializerData) {
569 writer = serializerData.CreateWriter ();
571 if (writer != null) return writer;
576 if (!typeMapping.Source.CanBeGenerated || generationThreshold == -1)
577 return new XmlSerializationWriterInterpreter (typeMapping);
579 CheckGeneratedTypes (typeMapping);
582 lock (serializerData) {
583 writer = serializerData.CreateWriter ();
585 if (writer != null) return writer;
586 if (!generatorFallback)
587 throw new InvalidOperationException ("Error while generating serializer");
591 return new XmlSerializationWriterInterpreter (typeMapping);
594 XmlSerializationReader CreateReader (XmlMapping typeMapping)
597 XmlSerializationReader reader;
600 if (serializerData != null) {
601 lock (serializerData) {
602 reader = serializerData.CreateReader ();
604 if (reader != null) return reader;
608 if (!typeMapping.Source.CanBeGenerated || generationThreshold == -1)
609 return new XmlSerializationReaderInterpreter (typeMapping);
611 CheckGeneratedTypes (typeMapping);
614 lock (serializerData) {
615 reader = serializerData.CreateReader ();
617 if (reader != null) return reader;
618 if (!generatorFallback)
619 throw new InvalidOperationException ("Error while generating serializer");
623 return new XmlSerializationReaderInterpreter (typeMapping);
627 void CheckGeneratedTypes (XmlMapping typeMapping)
629 throw new NotImplementedException();
631 void GenerateSerializersAsync (GenerationBatch batch)
633 throw new NotImplementedException();
635 void RunSerializerGeneration (object obj)
637 throw new NotImplementedException();
640 void CheckGeneratedTypes (XmlMapping typeMapping)
644 if (serializerData == null)
646 lock (serializerTypes)
648 serializerData = (SerializerData) serializerTypes [typeMapping.Source];
649 if (serializerData == null) {
650 serializerData = new SerializerData();
651 serializerTypes [typeMapping.Source] = serializerData;
657 bool generate = false;
658 lock (serializerData)
660 if (serializerData.UsageCount >= generationThreshold && !serializerData.Generated)
661 serializerData.Generated = generate = true;
663 serializerData.UsageCount++;
668 if (serializerData.Batch != null)
669 GenerateSerializersAsync (serializerData.Batch);
672 GenerationBatch batch = new GenerationBatch ();
673 batch.Maps = new XmlMapping[] {typeMapping};
674 batch.Datas = new SerializerData[] {serializerData};
675 GenerateSerializersAsync (batch);
680 void GenerateSerializersAsync (GenerationBatch batch)
682 if (batch.Maps.Length != batch.Datas.Length)
683 throw new ArgumentException ("batch");
687 if (batch.Done) return;
691 if (backgroundGeneration)
692 ThreadPool.QueueUserWorkItem (new WaitCallback (RunSerializerGeneration), batch);
694 RunSerializerGeneration (batch);
697 void RunSerializerGeneration (object obj)
701 GenerationBatch batch = (GenerationBatch) obj;
702 batch = LoadFromSatelliteAssembly (batch);
705 GenerateSerializers (batch, null);
709 Console.WriteLine (ex);
713 static Assembly GenerateSerializers (GenerationBatch batch, CompilerParameters cp)
715 DateTime tim = DateTime.Now;
717 XmlMapping[] maps = batch.Maps;
720 cp = new CompilerParameters();
721 cp.IncludeDebugInformation = false;
722 cp.GenerateInMemory = true;
723 cp.TempFiles.KeepFiles = !deleteTempFiles;
726 string file = cp.TempFiles.AddExtension ("cs");
727 StreamWriter sw = new StreamWriter (file);
729 if (!deleteTempFiles)
730 Console.WriteLine ("Generating " + file);
732 SerializationCodeGenerator gen = new SerializationCodeGenerator (maps);
736 gen.GenerateSerializers (sw);
740 Console.WriteLine ("Serializer could not be generated");
741 Console.WriteLine (ex);
742 cp.TempFiles.Delete ();
747 CSharpCodeProvider provider = new CSharpCodeProvider();
748 ICodeCompiler comp = provider.CreateCompiler ();
750 cp.GenerateExecutable = false;
752 foreach (Type rtype in gen.ReferencedTypes)
754 string path = new Uri (rtype.Assembly.CodeBase).LocalPath;
755 if (!cp.ReferencedAssemblies.Contains (path))
756 cp.ReferencedAssemblies.Add (path);
759 if (!cp.ReferencedAssemblies.Contains ("System.dll"))
760 cp.ReferencedAssemblies.Add ("System.dll");
761 if (!cp.ReferencedAssemblies.Contains ("System.Xml"))
762 cp.ReferencedAssemblies.Add ("System.Xml");
763 if (!cp.ReferencedAssemblies.Contains ("System.Data"))
764 cp.ReferencedAssemblies.Add ("System.Data");
766 CompilerResults res = comp.CompileAssemblyFromFile (cp, file);
767 if (res.Errors.HasErrors || res.CompiledAssembly == null) {
768 Console.WriteLine ("Error while compiling generated serializer");
769 foreach (CompilerError error in res.Errors)
770 Console.WriteLine (error);
772 cp.TempFiles.Delete ();
776 GenerationResult[] results = gen.GenerationResults;
777 for (int n=0; n<results.Length; n++)
779 GenerationResult gres = results[n];
780 SerializerData sd = batch.Datas [n];
783 sd.WriterType = res.CompiledAssembly.GetType (gres.Namespace + "." + gres.WriterClassName);
784 sd.ReaderType = res.CompiledAssembly.GetType (gres.Namespace + "." + gres.ReaderClassName);
785 sd.WriterMethod = sd.WriterType.GetMethod (gres.WriteMethodName);
786 sd.ReaderMethod = sd.ReaderType.GetMethod (gres.ReadMethodName);
791 cp.TempFiles.Delete ();
793 if (!deleteTempFiles)
794 Console.WriteLine ("Generation finished - " + (DateTime.Now - tim).TotalMilliseconds + " ms");
796 return res.CompiledAssembly;
800 GenerationBatch LoadFromSatelliteAssembly (GenerationBatch batch)
805 #endregion // Methods