mcs/class/System.XML/System.Xml.Serialization/SoapCodeExporter.cs

   1 //
   2 // System.Xml.Serialization.SoapCodeExporter
   3 //
   4 // Author:
   5 //   Tim Coleman (tim@timcoleman.com)
   6 //   Lluis Sanchez Gual (lluis@ximian.com)
   7 //
   8 // Copyright (C) Tim Coleman, 2002
   9 //
  10
  11 //
  12 // Permission is hereby granted, free of charge, to any person obtaining
  13 // a copy of this software and associated documentation files (the
  14 // "Software"), to deal in the Software without restriction, including
  15 // without limitation the rights to use, copy, modify, merge, publish,
  16 // distribute, sublicense, and/or sell copies of the Software, and to
  17 // permit persons to whom the Software is furnished to do so, subject to
  18 // the following conditions:
  19 //
  20 // The above copyright notice and this permission notice shall be
  21 // included in all copies or substantial portions of the Software.
  22 //
  23 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  24 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  25 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  26 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  27 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  28 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  29 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  30 //
  31
  32 using System.CodeDom;
  33 using System.CodeDom.Compiler;
  34 using System.Collections;
  35
  36 namespace System.Xml.Serialization
  37 {
  38         public class SoapCodeExporter
  39 #if NET_2_0
  40                 : CodeExporter
  41 #endif
  42         {
  43                 #region Fields
  44
  45                 CodeNamespace codeNamespace;
  46                 CodeCompileUnit codeCompileUnit;
  47 #if !NET_2_0
  48                 SoapMapCodeGenerator codeGenerator;
  49 #endif
  50
  51                 #endregion
  52
  53                 #region Constructors
  54
  55                 public SoapCodeExporter (CodeNamespace codeNamespace): this (codeNamespace, null)
  56                 {
  57                 }
  58
  59                 public SoapCodeExporter (CodeNamespace codeNamespace, CodeCompileUnit codeCompileUnit)
  60                 {
  61                         this.codeCompileUnit = codeCompileUnit;
  62                         this.codeNamespace = codeNamespace;
  63
  64                         codeGenerator = new SoapMapCodeGenerator (codeNamespace, codeCompileUnit);
  65                 }
  66
  67 #if NET_2_0
  68
  69                 public SoapCodeExporter (CodeNamespace codeNamespace,
  70                                                                 CodeCompileUnit codeCompileUnit,
  71                                                                 CodeGenerationOptions options)
  72                 : this (codeNamespace, codeCompileUnit, null, options, null)
  73                 {
  74                 }
  75
  76                 public SoapCodeExporter (CodeNamespace codeNamespace,
  77                                                                 CodeCompileUnit codeCompileUnit,
  78                                                                 CodeGenerationOptions options,
  79                                                                 Hashtable mappings)
  80                 : this (codeNamespace, codeCompileUnit, null, options, mappings)
  81                 {
  82
  83                 }
  84
  85                 [MonoTODO ("mappings?")]
  86                 public SoapCodeExporter (CodeNamespace codeNamespace,
  87                                                                 CodeCompileUnit codeCompileUnit,
  88                                                                 ICodeGenerator codeGen,
  89                                                                 CodeGenerationOptions options,
  90                                                                 Hashtable mappings)
  91                 {
  92                         this.codeCompileUnit = codeCompileUnit;
  93                         this.codeNamespace = codeNamespace;
  94
  95                         codeGenerator = new SoapMapCodeGenerator (codeNamespace, codeCompileUnit, codeGen, options, mappings);
  96                 }
  97
  98 #endif
  99
 100 #endregion // Constructors
 101
 102                 #region Properties
 103
 104 #if !NET_2_0
 105                 public CodeAttributeDeclarationCollection IncludeMetadata {
 106                         get { return codeGenerator.IncludeMetadata; }
 107                 }
 108 #endif
 109
 110                 #endregion // Properties
 111
 112                 #region Methods
 113
 114                 public void AddMappingMetadata (CodeAttributeDeclarationCollection metadata, XmlMemberMapping member)
 115                 {
 116                         AddMappingMetadata (metadata, member, false);
 117                 }
 118
 119                 public void AddMappingMetadata (CodeAttributeDeclarationCollection metadata, XmlMemberMapping member, bool forceUseMemberName)
 120                 {
 121                         TypeData memType = member.TypeMapMember.TypeData;
 122
 123                         CodeAttributeDeclaration att = new CodeAttributeDeclaration ("System.Xml.Serialization.SoapElement");
 124                         if (forceUseMemberName || (member.ElementName != member.MemberName))
 125                                 att.Arguments.Add (new CodeAttributeArgument (new CodePrimitiveExpression(member.ElementName)));
 126                         if (!TypeTranslator.IsDefaultPrimitiveTpeData (memType))
 127                                 att.Arguments.Add (new CodeAttributeArgument ("DataType", new CodePrimitiveExpression(member.TypeName)));
 128
 129                         if (att.Arguments.Count > 0)
 130                                 metadata.Add (att);
 131                 }
 132
 133                 public void ExportMembersMapping (XmlMembersMapping xmlMembersMapping)
 134                 {
 135                         codeGenerator.ExportMembersMapping (xmlMembersMapping);
 136                 }
 137
 138                 public void ExportTypeMapping (XmlTypeMapping xmlTypeMapping)
 139                 {
 140                         codeGenerator.ExportTypeMapping (xmlTypeMapping);
 141                 }
 142
 143
 144                 #endregion // Methods
 145         }
 146
 147         class SoapMapCodeGenerator : MapCodeGenerator
 148         {
 149                 public SoapMapCodeGenerator (CodeNamespace codeNamespace, CodeCompileUnit codeCompileUnit)
 150                 : base (codeNamespace, codeCompileUnit)
 151                 {
 152                         includeArrayTypes = true;
 153                 }
 154
 155                 public SoapMapCodeGenerator (CodeNamespace codeNamespace, CodeCompileUnit codeCompileUnit, ICodeGenerator codeGen, CodeGenerationOptions options, Hashtable mappings)
 156                 : base (codeNamespace, codeCompileUnit, codeGen, options, mappings)
 157                 {
 158                 }
 159
 160                 protected override void GenerateClass (XmlTypeMapping map, CodeTypeDeclaration codeClass)
 161                 {
 162                         CodeAttributeDeclaration att = new CodeAttributeDeclaration ("System.Xml.Serialization.SoapType");
 163                         if (map.XmlType != map.TypeData.TypeName) att.Arguments.Add (GetArg (map.XmlType));
 164                         if (map.XmlTypeNamespace != "") att.Arguments.Add (GetArg ("Namespace", map.XmlTypeNamespace));
 165                         AddCustomAttribute (codeClass, att, false);
 166                 }
 167
 168                 protected override void GenerateClassInclude (CodeAttributeDeclarationCollection attributes, XmlTypeMapping map)
 169                 {
 170                         CodeAttributeDeclaration iatt = new CodeAttributeDeclaration ("System.Xml.Serialization.SoapInclude");
 171                         iatt.Arguments.Add (new CodeAttributeArgument (new CodeTypeOfExpression(map.TypeData.FullTypeName)));
 172                         attributes.Add (iatt);
 173                 }
 174
 175                 protected override void GenerateAttributeMember (CodeAttributeDeclarationCollection attributes, XmlTypeMapMemberAttribute attinfo, string defaultNamespace, bool forceUseMemberName)
 176                 {
 177                         CodeAttributeDeclaration att = new CodeAttributeDeclaration ("System.Xml.Serialization.SoapAttribute");
 178                         if (attinfo.Name != attinfo.AttributeName) att.Arguments.Add (GetArg (attinfo.AttributeName));
 179                         if (attinfo.Namespace != defaultNamespace) att.Arguments.Add (GetArg ("Namespace", attinfo.Namespace));
 180                         if (!TypeTranslator.IsDefaultPrimitiveTpeData(attinfo.TypeData)) att.Arguments.Add (GetArg ("DataType",attinfo.TypeData.XmlType));
 181                         attributes.Add (att);
 182                 }
 183
 184                 protected override void GenerateElementInfoMember (CodeAttributeDeclarationCollection attributes, XmlTypeMapMemberElement member, XmlTypeMapElementInfo einfo, TypeData defaultType, string defaultNamespace, bool addAlwaysAttr, bool forceUseMemberName)
 185                 {
 186                         CodeAttributeDeclaration att = new CodeAttributeDeclaration ("System.Xml.Serialization.SoapElement");
 187                         if (forceUseMemberName || einfo.ElementName != member.Name) att.Arguments.Add (GetArg (einfo.ElementName));
 188 //                      if (einfo.IsNullable) att.Arguments.Add (GetArg ("IsNullable", true));  MS seems to ignore this
 189                         if (!TypeTranslator.IsDefaultPrimitiveTpeData(einfo.TypeData)) att.Arguments.Add (GetArg ("DataType",einfo.TypeData.XmlType));
 190                         if (addAlwaysAttr || att.Arguments.Count > 0) attributes.Add (att);
 191                 }
 192
 193                 protected override void GenerateEnum (XmlTypeMapping map, CodeTypeDeclaration codeEnum)
 194                 {
 195                         CodeAttributeDeclaration att = new CodeAttributeDeclaration ("System.Xml.Serialization.SoapType");
 196                         if (map.XmlType != map.TypeData.TypeName) att.Arguments.Add (GetArg (map.XmlType));
 197                         if (map.XmlTypeNamespace != "") att.Arguments.Add (GetArg ("Namespace", map.XmlTypeNamespace));
 198                         AddCustomAttribute (codeEnum, att, false);
 199                 }
 200
 201                 protected override void GenerateEnumItem (CodeMemberField codeField, EnumMap.EnumMapMember emem)
 202                 {
 203                         if (emem.EnumName != emem.XmlName)
 204                         {
 205                                 CodeAttributeDeclaration xatt = new CodeAttributeDeclaration ("System.Xml.Serialization.SoapEnum");
 206                                 xatt.Arguments.Add (GetArg ("Name", emem.XmlName));
 207                                 AddCustomAttribute (codeField, xatt, true);
 208                         }
 209                 }
 210
 211                 protected override void GenerateSpecifierMember (CodeTypeMember codeField)
 212                 {
 213                         AddCustomAttribute (codeField, "System.Xml.Serialization.SoapIgnore");
 214                 }
 215         }
 216 }