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;
40 #if !TARGET_JVM && !NET_2_1
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 Type ReaderType;
72 public MethodInfo ReaderMethod;
73 public Type WriterType;
74 public MethodInfo WriterMethod;
75 public GenerationBatch Batch;
76 public XmlSerializerImplementation Implementation = null;
78 public XmlSerializationReader CreateReader () {
79 if (ReaderType != null)
80 return (XmlSerializationReader) Activator.CreateInstance (ReaderType);
81 else if (Implementation != null)
82 return Implementation.Reader;
87 public XmlSerializationWriter CreateWriter () {
88 if (WriterType != null)
89 return (XmlSerializationWriter) Activator.CreateInstance (WriterType);
90 else if (Implementation != null)
91 return Implementation.Writer;
97 internal class GenerationBatch
100 public XmlMapping[] Maps;
101 public SerializerData[] Datas;
104 static XmlSerializer ()
106 // The following options are available:
107 // MONO_XMLSERIALIZER_DEBUG: when set to something != "no", it will
108 // it will print the name of the generated file, and it won't
110 // MONO_XMLSERIALIZER_THS: The code generator threshold. It can be:
111 // no: does not use the generator, always the interpreter.
112 // 0: always use the generator, wait until the generation is done.
113 // any number: use the interpreted serializer until the specified
114 // number of serializations is reached. At this point the generation
115 // of the serializer will start in the background. The interpreter
116 // will be used while the serializer is being generated.
118 // XmlSerializer will fall back to the interpreted serializer if
119 // the code generation somehow fails. This can be avoided for
120 // debugging pourposes by adding the "nofallback" option.
121 // For example: MONO_XMLSERIALIZER_THS=0,nofallback
123 #if TARGET_JVM || NET_2_1
126 generationThreshold = -1;
127 backgroundGeneration = false;
129 string db = Environment.GetEnvironmentVariable ("MONO_XMLSERIALIZER_DEBUG");
130 string th = Environment.GetEnvironmentVariable ("MONO_XMLSERIALIZER_THS");
133 generationThreshold = 50;
134 backgroundGeneration = true;
136 int i = th.IndexOf (',');
138 if (th.Substring (i+1) == "nofallback")
139 generatorFallback = false;
140 th = th.Substring (0, i);
143 if (th.ToLower(CultureInfo.InvariantCulture) == "no")
144 generationThreshold = -1;
146 generationThreshold = int.Parse (th, CultureInfo.InvariantCulture);
147 backgroundGeneration = (generationThreshold != 0);
148 if (generationThreshold < 1) generationThreshold = 1;
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; }
238 public XmlSerializer (Type type,
239 XmlAttributeOverrides overrides,
241 XmlRootAttribute root,
242 string defaultNamespace,
249 #endregion // Constructors
252 private UnreferencedObjectEventHandler onUnreferencedObject;
254 private XmlAttributeEventHandler onUnknownAttribute;
255 private XmlElementEventHandler onUnknownElement;
256 private XmlNodeEventHandler onUnknownNode;
258 public event XmlAttributeEventHandler UnknownAttribute
260 add { onUnknownAttribute += value; } remove { onUnknownAttribute -= value; }
263 public event XmlElementEventHandler UnknownElement
265 add { onUnknownElement += value; } remove { onUnknownElement -= value; }
268 public event XmlNodeEventHandler UnknownNode
270 add { onUnknownNode += value; } remove { onUnknownNode -= value; }
274 internal virtual void OnUnknownAttribute (XmlAttributeEventArgs e)
276 if (onUnknownAttribute != null) onUnknownAttribute(this, e);
279 internal virtual void OnUnknownElement (XmlElementEventArgs e)
281 if (onUnknownElement != null) onUnknownElement(this, e);
284 internal virtual void OnUnknownNode (XmlNodeEventArgs e)
286 if (onUnknownNode != null) onUnknownNode(this, e);
291 internal virtual void OnUnreferencedObject (UnreferencedObjectEventArgs e)
293 if (onUnreferencedObject != null) onUnreferencedObject(this, e);
296 public event UnreferencedObjectEventHandler UnreferencedObject
298 add { onUnreferencedObject += value; } remove { onUnreferencedObject -= value; }
305 public virtual bool CanDeserialize (XmlReader xmlReader)
307 xmlReader.MoveToContent ();
308 if (typeMapping is XmlMembersMapping)
311 return ((XmlTypeMapping)typeMapping).ElementName == xmlReader.LocalName;
314 protected virtual XmlSerializationReader CreateReader ()
316 // Must be implemented in derived class
317 throw new NotImplementedException ();
320 protected virtual XmlSerializationWriter CreateWriter ()
322 // Must be implemented in derived class
323 throw new NotImplementedException ();
326 public object Deserialize (Stream stream)
328 XmlTextReader xmlReader = new XmlTextReader(stream);
329 xmlReader.Normalization = true;
330 xmlReader.WhitespaceHandling = WhitespaceHandling.Significant;
331 return Deserialize(xmlReader);
334 public object Deserialize (TextReader textReader)
336 XmlTextReader xmlReader = new XmlTextReader(textReader);
337 xmlReader.Normalization = true;
338 xmlReader.WhitespaceHandling = WhitespaceHandling.Significant;
339 return Deserialize(xmlReader);
342 public object Deserialize (XmlReader xmlReader)
344 XmlSerializationReader xsReader;
345 if (customSerializer)
346 xsReader = CreateReader ();
348 xsReader = CreateReader (typeMapping);
350 xsReader.Initialize (xmlReader, this);
351 return Deserialize (xsReader);
354 protected virtual object Deserialize (XmlSerializationReader reader)
356 if (customSerializer)
357 // Must be implemented in derived class
358 throw new NotImplementedException ();
361 if (reader is XmlSerializationReaderInterpreter)
362 return ((XmlSerializationReaderInterpreter) reader).ReadRoot ();
365 return serializerData.ReaderMethod.Invoke (reader, null);
366 } catch (TargetInvocationException ex) {
367 throw ex.InnerException;
370 } catch (Exception ex) {
371 if (ex is InvalidOperationException || ex is InvalidCastException)
372 throw new InvalidOperationException ("There is an error in"
373 + " XML document.", ex);
378 public static XmlSerializer [] FromMappings (XmlMapping [] mappings)
380 XmlSerializer[] sers = new XmlSerializer [mappings.Length];
381 SerializerData[] datas = new SerializerData [mappings.Length];
382 GenerationBatch batch = new GenerationBatch ();
383 batch.Maps = mappings;
386 for (int n=0; n<mappings.Length; n++)
388 if (mappings[n] != null)
390 SerializerData data = new SerializerData ();
392 sers[n] = new XmlSerializer (mappings[n], data);
400 public static XmlSerializer [] FromTypes (Type [] mappings)
402 XmlSerializer [] sers = new XmlSerializer [mappings.Length];
403 for (int n=0; n<mappings.Length; n++)
404 sers[n] = new XmlSerializer (mappings[n]);
408 protected virtual void Serialize (object o, XmlSerializationWriter writer)
410 if (customSerializer)
411 // Must be implemented in derived class
412 throw new NotImplementedException ();
414 if (writer is XmlSerializationWriterInterpreter)
415 ((XmlSerializationWriterInterpreter)writer).WriteRoot (o);
418 serializerData.WriterMethod.Invoke (writer, new object[] {o});
419 } catch (TargetInvocationException ex) {
420 throw ex.InnerException;
426 static Encoding DefaultEncoding = Encoding.UTF8;
428 static Encoding DefaultEncoding = Encoding.Default;
431 public void Serialize (Stream stream, object o)
433 XmlTextWriter xmlWriter = new XmlTextWriter (stream, DefaultEncoding);
434 xmlWriter.Formatting = Formatting.Indented;
435 Serialize (xmlWriter, o, null);
438 public void Serialize (TextWriter textWriter, object o)
440 XmlTextWriter xmlWriter = new XmlTextWriter (textWriter);
441 xmlWriter.Formatting = Formatting.Indented;
442 Serialize (xmlWriter, o, null);
445 public void Serialize (XmlWriter xmlWriter, object o)
447 Serialize (xmlWriter, o, null);
450 public void Serialize (Stream stream, object o, XmlSerializerNamespaces namespaces)
452 XmlTextWriter xmlWriter = new XmlTextWriter (stream, DefaultEncoding);
453 xmlWriter.Formatting = Formatting.Indented;
454 Serialize (xmlWriter, o, namespaces);
457 public void Serialize (TextWriter textWriter, object o, XmlSerializerNamespaces namespaces)
459 XmlTextWriter xmlWriter = new XmlTextWriter (textWriter);
460 xmlWriter.Formatting = Formatting.Indented;
461 Serialize (xmlWriter, o, namespaces);
465 public void Serialize (XmlWriter writer, object o, XmlSerializerNamespaces namespaces)
467 XmlSerializationWriter xsWriter;
470 if (customSerializer)
471 xsWriter = CreateWriter ();
473 xsWriter = CreateWriter (typeMapping);
475 if (namespaces == null || namespaces.Count == 0) {
476 namespaces = new XmlSerializerNamespaces ();
478 namespaces.Add ("xsi", XmlSchema.InstanceNamespace);
479 namespaces.Add ("xsd", XmlSchema.Namespace);
481 namespaces.Add ("xsd", XmlSchema.Namespace);
482 namespaces.Add ("xsi", XmlSchema.InstanceNamespace);
486 xsWriter.Initialize (writer, namespaces);
487 Serialize (o, xsWriter);
489 } catch (Exception ex) {
490 if (ex is TargetInvocationException)
491 ex = ex.InnerException;
493 if (ex is InvalidOperationException || ex is InvalidCastException)
494 throw new InvalidOperationException ("There was an error generating" +
495 " the XML document.", ex);
504 public object Deserialize (XmlReader xmlReader, string encodingStyle, XmlDeserializationEvents events)
506 throw new NotImplementedException ();
510 public object Deserialize (XmlReader xmlReader, string encodingStyle)
512 throw new NotImplementedException ();
516 public object Deserialize (XmlReader xmlReader, XmlDeserializationEvents events)
518 throw new NotImplementedException ();
522 public static XmlSerializer[] FromMappings (XmlMapping[] mappings, Evidence evidence)
524 throw new NotImplementedException ();
528 public static XmlSerializer[] FromMappings (XmlMapping[] mappings, Type type)
530 throw new NotImplementedException ();
533 #if !TARGET_JVM && !MOBILE
534 public static Assembly GenerateSerializer (Type[] types, XmlMapping[] mappings)
536 return GenerateSerializer (types, mappings, null);
540 public static Assembly GenerateSerializer (Type[] types, XmlMapping[] mappings, CompilerParameters parameters)
542 GenerationBatch batch = new GenerationBatch ();
543 batch.Maps = mappings;
544 batch.Datas = new SerializerData [mappings.Length];
546 for (int n=0; n<mappings.Length; n++) {
547 SerializerData data = new SerializerData ();
549 batch.Datas [n] = data;
552 return GenerateSerializers (batch, parameters);
556 public static string GetXmlSerializerAssemblyName (Type type)
558 return type.Assembly.GetName().Name + ".XmlSerializers";
561 public static string GetXmlSerializerAssemblyName (Type type, string defaultNamespace)
563 return GetXmlSerializerAssemblyName (type) + "." + defaultNamespace.GetHashCode ();
567 public void Serialize (XmlWriter xmlWriter, object o, XmlSerializerNamespaces namespaces, string encodingStyle)
569 throw new NotImplementedException ();
572 [MonoNotSupported("")]
573 public void Serialize (XmlWriter xmlWriter, Object o, XmlSerializerNamespaces namespaces, string encodingStyle, string id)
575 throw new NotImplementedException ();
579 XmlSerializationWriter CreateWriter (XmlMapping typeMapping)
581 XmlSerializationWriter writer;
584 if (serializerData != null) {
585 lock (serializerData) {
586 writer = serializerData.CreateWriter ();
588 if (writer != null) return writer;
593 if (!typeMapping.Source.CanBeGenerated || generationThreshold == -1)
594 return new XmlSerializationWriterInterpreter (typeMapping);
596 CheckGeneratedTypes (typeMapping);
599 lock (serializerData) {
600 writer = serializerData.CreateWriter ();
602 if (writer != null) return writer;
603 if (!generatorFallback)
604 throw new InvalidOperationException ("Error while generating serializer");
608 return new XmlSerializationWriterInterpreter (typeMapping);
611 XmlSerializationReader CreateReader (XmlMapping typeMapping)
614 XmlSerializationReader reader;
617 if (serializerData != null) {
618 lock (serializerData) {
619 reader = serializerData.CreateReader ();
621 if (reader != null) return reader;
625 if (!typeMapping.Source.CanBeGenerated || generationThreshold == -1)
626 return new XmlSerializationReaderInterpreter (typeMapping);
628 CheckGeneratedTypes (typeMapping);
631 lock (serializerData) {
632 reader = serializerData.CreateReader ();
634 if (reader != null) return reader;
635 if (!generatorFallback)
636 throw new InvalidOperationException ("Error while generating serializer");
640 return new XmlSerializationReaderInterpreter (typeMapping);
643 #if TARGET_JVM || NET_2_1
644 void CheckGeneratedTypes (XmlMapping typeMapping)
646 throw new NotImplementedException();
648 void GenerateSerializersAsync (GenerationBatch batch)
650 throw new NotImplementedException();
652 void RunSerializerGeneration (object obj)
654 throw new NotImplementedException();
657 void CheckGeneratedTypes (XmlMapping typeMapping)
661 if (serializerData == null)
663 lock (serializerTypes)
665 serializerData = (SerializerData) serializerTypes [typeMapping.Source];
666 if (serializerData == null) {
667 serializerData = new SerializerData();
668 serializerTypes [typeMapping.Source] = serializerData;
674 bool generate = false;
675 lock (serializerData)
677 generate = (++serializerData.UsageCount == generationThreshold);
682 if (serializerData.Batch != null)
683 GenerateSerializersAsync (serializerData.Batch);
686 GenerationBatch batch = new GenerationBatch ();
687 batch.Maps = new XmlMapping[] {typeMapping};
688 batch.Datas = new SerializerData[] {serializerData};
689 GenerateSerializersAsync (batch);
694 void GenerateSerializersAsync (GenerationBatch batch)
696 if (batch.Maps.Length != batch.Datas.Length)
697 throw new ArgumentException ("batch");
701 if (batch.Done) return;
705 if (backgroundGeneration)
706 ThreadPool.QueueUserWorkItem (new WaitCallback (RunSerializerGeneration), batch);
708 RunSerializerGeneration (batch);
711 void RunSerializerGeneration (object obj)
715 GenerationBatch batch = (GenerationBatch) obj;
716 batch = LoadFromSatelliteAssembly (batch);
719 GenerateSerializers (batch, null);
723 Console.WriteLine (ex);
727 static Assembly GenerateSerializers (GenerationBatch batch, CompilerParameters cp)
729 DateTime tim = DateTime.Now;
731 XmlMapping[] maps = batch.Maps;
734 cp = new CompilerParameters();
735 cp.IncludeDebugInformation = false;
736 cp.GenerateInMemory = true;
737 cp.TempFiles.KeepFiles = !deleteTempFiles;
740 string file = cp.TempFiles.AddExtension ("cs");
741 StreamWriter sw = new StreamWriter (file);
743 if (!deleteTempFiles)
744 Console.WriteLine ("Generating " + file);
746 SerializationCodeGenerator gen = new SerializationCodeGenerator (maps);
750 gen.GenerateSerializers (sw);
754 Console.WriteLine ("Serializer could not be generated");
755 Console.WriteLine (ex);
756 cp.TempFiles.Delete ();
761 CSharpCodeProvider provider = new CSharpCodeProvider();
762 ICodeCompiler comp = provider.CreateCompiler ();
764 cp.GenerateExecutable = false;
766 foreach (Type rtype in gen.ReferencedTypes)
768 string path = new Uri (rtype.Assembly.CodeBase).LocalPath;
769 if (!cp.ReferencedAssemblies.Contains (path))
770 cp.ReferencedAssemblies.Add (path);
773 if (!cp.ReferencedAssemblies.Contains ("System.dll"))
774 cp.ReferencedAssemblies.Add ("System.dll");
775 if (!cp.ReferencedAssemblies.Contains ("System.Xml"))
776 cp.ReferencedAssemblies.Add ("System.Xml");
777 if (!cp.ReferencedAssemblies.Contains ("System.Data"))
778 cp.ReferencedAssemblies.Add ("System.Data");
780 CompilerResults res = comp.CompileAssemblyFromFile (cp, file);
781 if (res.Errors.HasErrors || res.CompiledAssembly == null) {
782 Console.WriteLine ("Error while compiling generated serializer");
783 foreach (CompilerError error in res.Errors)
784 Console.WriteLine (error);
786 cp.TempFiles.Delete ();
790 GenerationResult[] results = gen.GenerationResults;
791 for (int n=0; n<results.Length; n++)
793 GenerationResult gres = results[n];
794 SerializerData sd = batch.Datas [n];
797 sd.WriterType = res.CompiledAssembly.GetType (gres.Namespace + "." + gres.WriterClassName);
798 sd.ReaderType = res.CompiledAssembly.GetType (gres.Namespace + "." + gres.ReaderClassName);
799 sd.WriterMethod = sd.WriterType.GetMethod (gres.WriteMethodName);
800 sd.ReaderMethod = sd.ReaderType.GetMethod (gres.ReadMethodName);
805 cp.TempFiles.Delete ();
807 if (!deleteTempFiles)
808 Console.WriteLine ("Generation finished - " + (DateTime.Now - tim).TotalMilliseconds + " ms");
810 return res.CompiledAssembly;
815 GenerationBatch LoadFromSatelliteAssembly (GenerationBatch batch)
820 GenerationBatch LoadFromSatelliteAssembly (GenerationBatch batch)
826 #endregion // Methods